collapseMultipleProducts
- Description
- This transaction collapses multiple products, making them inactive, and then creates a new product based on externalized rules of survivorship.
- Web Services
- Operation name: collapseMultipleProducts
- Example
- There are three usage scenarios for this transaction, as illustrated
by the following examples.
Usage 1:
Given a specific product, find all 'Exact Match' suspect matches in the database and collapse the products according to survivorship rules.
Usage 2:
Given multiple products, collapse them according to survivorship rules.
Usage 3:
Given multiple products to be collapsed, plus a new product definition, collapse the products and create the new product as per the new supplied product definition (rather than using the 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 collapseMultipleParty transaction addresses the situation of multiple distinct products that all represent the same single product. This situation could result from insufficient or incorrect information about the products so that InfoSphere MDM cannot identify the products as the same, or as a result of suspect processing (a configurable option) being turned off when the products were initially added to the database.
The input to this transaction is a list of source products to be collapsed (ProductListBObj) and an optional target product. 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- Level 0 - returns category information plus category entity spec use.
- 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 transaction performs the following tasks:
- inactivates any products that were collapsed
- deletes the suspect records for the collapsed products
- for traceability purposes, creates links between the inactivated original source products and the new target product
The default implementation of the externalized rule of data survivorship navigates through all data associate with the source product and the 'Exact Match' (usage 1) or specified (usage 2) suspect products, and copies all unique data to the new product, based on the business key.
If common data is found in 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), the data from the source product is copied to the new product.
- Request message
- <TCRMTxType> collapseMultipleProducts
<TCRMTxObject> ConsolidatedProductBObj
<TCRMObject> ConsolidatedProductBObj
with:- ProductRequestBObj (inquiry levels)
- the target ProductBObj
- ProductListBObj (the products to be collapsed)
- Response objects
- ConsolidatedProductBObj
- Special note
- By default, when two or more products are collapsed in InfoSphere MDM, their corresponding product-party roles survive in the newly created product.