Data Model Sync UI

Configure Data Model Synchronization

Notes:

This article is intended only for Administrators and System Administrators roles.
The data model synchronization operation is supported only from PIM to Syndication.

To synchronize data model information between PIM and Syndication and view the synchronization status by object type such as attributes, classifications, and reference values, perform the following:

Configure Authentication Settings

To synchronize data model information from PIM to Syndication, an authentication process must be initially completed. You must upload the cslIntegration_appconfig.json file to the respective tenant in PIM.

Configuration file details:
Under the configObject.data.jsonData.settings object, enter the value for:
- environment: Indicates the type of environment that you want to configure in. It can be QA, UAT or PROD environment.
- enabled: If the value of enabled is set to true, it indicates that you can synchronize the data models from PIM to Syndication. The default value of enabled is set to false. It indicates that you cannot synchronize the data from PIM to Syndication.
- stateObjectGroomingPeriodInDays: Indicates the time required to set up the data model synchronization objects. The default value is 60 days.
- restClientTimeoutMs: Indicates the response time after you send an API request. The default value is 60 sec or 60000ms.

The following is the sample cslIntegration_appconfig.json file:

{
  "configObject": {
    "id": "cslIntegration_appconfig",
    "name": "EDS <-> CSL integration configuration",
    "type": "appconfig",
    "version": "1.0",
    "properties": {
      "app": "ces-integration"
    },
    "data": {
      "jsonData": {
        "settings": {
          "enabled": true,
          "environment": "{{ENVIRONMENT}}",
          "stateObjectGroomingPeriodInDays": 60,
          "restClientTimeoutMs": 60000
        }
      }
    }
  }
}

Note:

The value of configObject.id must be cslIntegration_appconfig. Ensure that you do not modify the value.

Upload the updated configuration files to the respective tenant. For more information on how to upload the configuration file, see Upload Tenant Seed Data in System Administrator's documentation. After successfully uploading the configuration file, log in to the PIM application by using the appropriate user credentials.

Configure Data Model Synchronization from UI

The PIM module allows Administrators and System Administrators to manage data exchange between PIM and Syndication. Through PIM UI, you can set up, edit, and view the configurations for synchronizing data models and data. This makes it easier to perform the synchronization tasks.

Set up data model synchronization via UI

To enable the data models to be synchronized from PIM to Syndication (Brand), you must perform the following configurations in UI:

From the navigation menu, click Configurations > Data Model Sync.

Result: The Data Model Sync page is displayed.
Click the Settings tab.
Select the required use-case from the Type of Usecase drop-down list according to the business requirement. Here, we have selected Brand.

Select the required values for the displayed attributes and then click Save. For more information, see the Settings Attributes table.

Result: The configured settings for the data model synchronization operation from PIM to Syndication are saved.

DMSync_Settings_Saved

Note:

After saving the configuration settings, you can still modify the settings according to the business requirements.

Settings Attributes

The following table indicates the different attributes used to configure the data model synchronization between PIM and Syndication in UI:

Type of Usecase	Attributes	Description
Brand	Data Locales	Allows you to select the available locales to configure the data model synchronization operation. For example, German-Germany
	Strict Mode	When TRUE, the data model synchronization operation is performed only with valid data models. For example, valid data types, valid reference data, and so on When FALSE, data model synchronization operation is performed even with invalid data models. For example, invalid data types, invalid reference data, and so on
	Entity Type	Allows you to select the type of entity used to configure the data model synchronization operation. For example, Item Note: Entity Type is a mandatory attribute
	Context Type	Allows you to select the type of context that is used to configure the data model synchronization operation. For example, Channel or Country
	Contexts	Allows you to select the available contexts for the selected context type. For example, Germany Note: You must select a context type before selecting a context
	Match Attributes	Allows you to select the attributes that are used to identify an entity ID in PIM. For example, GTIN can be used to identify the entity ID of Item
Retailer	Data Locales	Allows you to select the available locales to configure the data model synchronization operation. For example, French-France
	Strict Mode	When TRUE, the data model synchronization operation is performed only with valid data models. For example, valid data types, valid reference data, and so on When FALSE, data model synchronization operation is performed even with invalid data models. For example, invalid data types, invalid reference data, and so on
	Entity Type	Allows you to select the type of entity used to configure the data model synchronization operation. For example, Item Note: Entity Type is a mandatory attribute
	Role	Allows you to select the user who performs the data model synchronization operation. For example, Administrator or System Administrator Note: Role is a mandatory attribute
	Match Attributes	Allows you to select the attributes that are used to identify an entity ID in PIM. For example, GTIN can be used to identify the entity ID of Item

Advanced Settings

In an exceptional scenario, the data model changes are synchronized successfully but some updates are not reflecting in Syndication.
To perform the Sync Now again, the system does not enable this until any additional data model changes are observed. As a workaround, the application provides you the below mentioned property in Advanced Settings of the Settings page:

Property	Description
Reset Data Model Change Tracker	For the selected settings, when this property is set True, the application will synchronize all the data models in the next Data Model Sync operation. When False, the application synchronizes only the data model changes since the last data model sync. Note: By default, this property is set to FALSE.

Sample screenshot with Advanced Settings:
DMSync_Settings_Selected

Notes:

• This is an expensive operation and is recommended to use only when necessary.
• After the Settings is saved with Reset Data Model Change Tracker property value: TRUE, the system disables it until the next Data Model Sync operation. The button is restored to its default behaviour (value: FALSE) after the sync.

Data Model Requirements

To synchronize the taxonomies and classifications, you must perform the required settings in the data models:

Note:

The models attached here considers item as an entity type and has the required settings associated with it. You must modify the settings based on your needs in consideration with the entity types.

Model	Sample File Details	Description
Thing Domain Model	DataModelSync_ThingDomainModel.xlsx	You must define the required entity types, its classification attributes, required mappings, and IS Syndicatable flag to TRUE.
Taxonomy Model	DataModelSync_TaxonomyModel.xlsx	The taxonomies that need to be synchronized must be defined.