How to perform Exchange V1 to V2 upgrade?

  • 3 minute(s) read
Prev

Prerequisites

To successfully upgrade the V1 App to V2, the following are the prerequisites in the PIM and Syndication modules and the Exchange tenant:

Note:

The V1 App must be available in the PIM tenant, with the required attribute mappings to ensure a successful data syndication.

PIM Module
After you observe the data syndication is successful in the V1 App, perform the following:

  1. Unsubscribe from the V1 app.

  2. Unsubscribe from the addon-app-connector-syndication App.

  3. Delete the syndication service configurations and syndication mapping configurations of the rs-cxh channel.

  4. Deploy the V2 App.

  5. Ensure that you have the required data model information.

  6. Perform the following configurations:

    a. Configure Data Model Synchronization.
    b. Configure PIM to Syndication Data Flow.
    c. BR Configurations to Unlink Entity Relationships in Packaging Hierarchy.
    d. BR Configurations to Synchronize Publication Status using Workflow.

Syndication Module

  1. A Syndication account must be set up.
  2. A Customer Vocabulary that matches with the syndication mapping file of PIM must be available in the Syndication Account.

Set up Exchange tenant

  1. Ensure to set up and configure the Exchange tenant.
  2. Update the Exchange tenant configurations:
    • Set identifiers to IDs generated on entity schema.
    • Set mapping for entities (like Product) to IDs generated for corresponding schemas.

Run Migration Tool

The Migration tool helps the conversion of attribute mappings from V1 to V2. You can run the Migration tool against the tenant that needs to be migrated from V1 to V2.

Note:

Before running the Migration tool, all the attributes at the Exchange layer will be displayed as Not Mapped.
Overview of attribute mapping for EDS and CES accounts in a data model.

Run the migration tool. For more information on how to run the migration tool, see Exchange Upgrade Process.

Exchange Upgrade Process

Note:

This section is intended only for Implementation Engineers.

After ensuring that the prerequisites conditions are satisfied, run the following API request in Postman to initiate the upgrade process:

API Request: GET

https://cxhapi-<<TENANT>>.com/api/enterprisedataplatform/MigrationTool/3ff16c73-69c4-4130-8fee-f0097d29f135/ExecuteDataModelTransform?isSourceEds=true&customerVocabularyId=9f0f33df-96b9-4994-b7a6-8c90ef4d8fab&cesEntityType=Product&edsTenantId=qa1cxh&edsMappingId=qa1cxh_cxh_inbound_product_static_mappings&edsEntityType=item&whatIf=true](https://cxhapi-<<TENANT>>.com/api/enterprisedataplatform/MigrationTool/3ff16c73-69c4-4130-8fee-f0097d29f135/ExecuteDataModelTransform?isSourceEds=true&customerVocabularyId=9f0f33df-96b9-4994-b7a6-8c90ef4d8fab&cesEntityType=Product&edsTenantId=qa1cxh&edsMappingId=qa1cxh_cxh_inbound_product_static_mappings&edsEntityType=item&whatIf=true)

The following screenshot depicts the API GET call in Postman:
API call details for Migration Platform, including parameters and authentication information.

API Response:
The following is a sample EntitySchemaToRequirementSetsMetadata API response which contains the required Syndication mapping within the Exchange.

edcsmigrationg2Output.json

The following table represents the parameters used in the API request:

Parameter Description
tenantId Indicates the tenant ID for which the upgrade process is performed.
isSourceEds It is a flag that indicates if the PIM attributes are set as the source in the syndication mapping file of PIM.
customerVocabularyId Indicates the customer vocabulary ID that has the relevant Syndication alias to the Syndication attribute lookup.
cesEntityType Indicates the type of Syndication entity for which the relevant lookup is retrieved from the vocabulary.
edsTenantId Indicates the required PIM tenant ID.
edsMappingId Indicates the PIM configuration mapping ID that has the relevant PIM attribute to the Syndication alias lookup.
edsEntityType Indicates the PIM entity type used to retrieve the PIM mapping in the Exchange, EntityManagedModelToEntitySchemaMetadata.
whatIf It is a flag that determines whether the result of the upgrade process should be saved or not.
Notes:

  • The response to this API request might also contain an output error because the attributes might not contain information such as the mapping file, vocabulary, or data model.
    The following is a sample log of the error file:

    "DataLossIssues": [
        "Unable to resolve attribute IDs from the descriptor(s); CES Attribute Descriptor - [@simpleAttr(Root Item)]; EDS Attribute Descriptor - [@attr(Isrootitem)]",
        "Unable to resolve attribute IDs from the descriptor(s); CES Attribute Descriptor - [@multiValues(PIM Consumable Identifier)]; EDS Attribute Descriptor - [@attr(copyableidentifier)]",
        "Unable to resolve attribute IDs from the descriptor(s); CES Attribute Descriptor - [@path(CorrelationId)]; EDS Attribute Descriptor - [@attr(correlationId)]",
        "Unable to resolve attribute IDs from the descriptor(s); CES Attribute Descriptor - [@path(inboundUpdatedOn)]; EDS Attribute Descriptor - [@attr(inboundUpdatedOn)]",
        "Unable to resolve attribute IDs from the descriptor(s); CES Attribute Descriptor - [@simpleAttr(targetMarketCountryCode)]; EDS Attribute Descriptor - [@attr(targetMarketCountryCode)]",
        "Unable to resolve attribute IDs from the descriptor(s); CES Attribute Descriptor - [@simpleAttr(Sales Rep Email, itemRequestValues)]; EDS Attribute Descriptor - [@attr(itmReqSalesRepEmail)]",
        "Unable to resolve attribute IDs from the descriptor(s); CES Attribute Descriptor - [@simpleAttr(Duplicate Needed, itemRequestValues)]; EDS Attribute Descriptor - [@attr(duplicateneeded)]",

  • If a requirement set is already set up, then the upgrade process ensures that the attributes in the requirement set are automatically mapped to the relevant Section.

    Section labeled 'Dimensions' in the GDSN packaging attributes interface.

  • If a requirement set is not set up, then you must manually map the attributes in Section.
    Form fields for GDSN packaging attributes with an error indication and selection options.

Post-Upgrade Configurations

After the upgrade process is successfully completed, perform the following:

  • Delete the following configuration files from V1:

    • Attribute mapping configuration
    • Profile configuration
    • Classification mapping configuration
    • UI configurations
    • Connector channel access configuration for the rs-cxh channel

  • Perform the following if it is an inbound operation:

    • Delete all the added entries from the Azure table. For more information, see the third point in prerequisites of Legacy Exchange Setup (V1).
    • Restart the connector service import-export topology.