comparativePreviewCollapseMultipleProducts

Description
This transaction can be used to preview the source product and multiple suspect products along with the new, surviving collapsed product.
Web Services
Operation name: comparativePreviewCollapseMultipleProducts
Service name: ProductService
Example
There are two usage scenarios for this service, as illustrated by the following examples.

Usage 1: Given a specific product, find all 'Exact Match' suspect matches on the database and collapse the products according to survivorship rules.

Usage 2: Given multiple products, collapse them according to survivorship rules.

Usage information
InfoSphere® MDM provides a number of transactions and processes to manage the integrity of a single correct version of a product.

The comparativePreviewCollapseMultipleProducts transaction can be used to preview the source and suspect products along with the collapsed (new) product.

The input to this transaction is a list of source products to be collapsed (ProductListBObj). The level of product information to be collapsed depends on the configured inquiry levels. The level of product information to be returned depends on the optional inquiry levels specified in the request.

Note: Only active products can be collapsed.
Preconditions
The specified products must exist.
Mandatory input
  • ProductId
Inquiry levels
Optionally, inquiry levels can be provided in the transaction request. The inquiry levels control the type and extent of information returned for the consolidated product details. If the inquiry levels are not provided in the request, then the transaction response returns all consolidated product information that was collapsed.

ProductInquiryLevel: The ProductInquiryLevel determines the type and extent of information returned for the consolidated product details.

  • Level 0 - returns product information.
  • Level 1 - returns level 0 data plus product spec values details, optionally filtered by SpecId.
  • Level 2 - returns level 1 data plus product identifiers.
  • Level 3 - returns level 2 data plus product relationships and product category associations.
    Note: Category information is based on the category inquiry level.
  • Level 4 - returns level 3 data plus product term conditions.
Note: If the ProductInquiryLevel is 1, 2, 3, or 4, then the product spec values data that is returned is filtered based on the SpecId provided in the request. If SpecId is not specified, then the transaction response returns all product spec value data.
CategoryInquiryLevel:
Note: CategoryInquiryLevel is only applicable when the ProductInquiryLevel >= 3.
  • Level 0 - returns category information.
  • Level 1 - returns level 0 data plus category relationships.

RelatedProductInquiryLevel:

  • Level 0 - returns Product data of the related products and, if applicable, product relationships between each related product and the requested product.
    • If the requested product is a bundle (a product with a product structure type of Bundle), then each of the bundle components and their product relationships with the bundle are returned.
    • If the requested product is a stand-alone root product (a product with the VariantAllowedIndicator not set to N), then the variant products are returned.
    • If the requested product is a root product and it is also a bundle, then the product's bundle components and variant products are returned along with the appropriate product relationships.
    • In addition, the system recursively retrieves closely related products for each related bundle or variant product that it returns. So if the product is a bundle, the system returns all of its bundle components, and if the related product is a variant, then the system returns its root product. However, if the related product is a root product, its variants are not returned. Variants are returned only if the main requested product is a root product and the RelatedProductInquiryLevel is 0 or greater.
  • Level 1 - returns level 0 data plus all product spec value data for each related product. If spec IDs are provided in the request, they are only filtered for the main requested product. The spec IDs in the request are not filtered for the returned related products.
  • Level 2 - returns level 1 data plus product identifier data for each related product.
  • Level 3 - returns level 2 data plus product relationship data and product category association data for each related product. Additional category information is returned based on the CategoryInquiryLevel.
  • Level 4 - returns level 3 data plus product term condition data for each related product.
Attention: A customized inquiry level must be used to return product equivalency information.
Filter values
Not applicable
Transaction behavior
This is a non-persistent transaction. Therefore, it does not persist the collapsing of records or inactivate the given suspect products, nor does it add a newly consolidated product.

The default implementation of the externalized rule of data survivorship navigates through all data associated with the source product and the 'Exact Match' (usage 1) or specified (usage 2) suspect products, and then copies all unique data to the new product, based on business key.

If common data is found on the source and suspect products, then the business object with the latest LastUpdateDate is copied to the new product. If the LastUpdateDate is the same for the 'Exact Match' or specified suspect products (such as if the data was directly loaded into the database), then the data from the source product is copied to the new product.

Request message
<TCRMTxType> comparativePreviewCollapseMultipleProducts

<TCRMTxObject> ConsolidatedProductBObj

<TCRMObject> ConsolidatedProductBObj

with:
Response objects
ConsolidatedProductBObj
Special note
Not applicable