Product Data Flow

Prev Next

Configure PIM to Syndication Data Flow

To syndicate data from PIM to Syndication, the following configurations are required:

Prerequisites

The following are the prerequisites that must be satisfied to syndicate data from PIM to Syndication:

  1. The data models must be synced between PIM and Syndication. For more information, see Configure Data Model Synchronization.
  2. To access the channel information based on the user roles and syndicate entities via the configured channels, appropriate permissions must be configured.
    The following is a sample admin_connectorchannelaccessconfig.json file that contains channel information in which read and syndicate permissions are set for the admin role. For more information, see Configure Role-based Channel Access.
    Note:

    The admin_connectorchannelaccessconfig.json file must be configured by administrators only.

    {
      "id": "admin_connectorchannelaccessconfig",
      "name": "admin_connectorchannelaccessconfig",
      "type": "connectorchannelaccessconfig",
      "data": {
        "jsonData": {
          "eds-csl": {
            "syndicatePermission": true,
            "readPermission": true
          }
        }
      }
    }
    
    Upload the updated configuration file to the respective tenant. For more information on how to upload the configuration file, see Upload Tenant Seed Data in System Administrator's documentation.

Profile Configuration

If a GDSN customer requires to syndicate product hierarchy information from PIM to Syndication, upload the following override_syndicate_product_data_ces.json file to the respective tenant:

{
  "metaInfo": {
    "dataIndex": "config",
    "collectionName": "configObjects",
    "responseObjectName": "response"
  },
  "configObjects": [
    {
      "id": "override_syndicate_product_data_ces",
      "type": "integrationprofile",
      "data": {
        "contexts": [
          {
            "context": {
              "app": "Connector",
              "channel": "EDS-CES",
              "format": "JSON",
              "order": "10",
              "role": "admin",
              "service": "ENTITY_EXPORT",
              "source": "internal",
              "subtype": "System",
              "user": "system"
            },
            "jsonData": {
              "statusEventEnabled": "true",
              "integrationType": "System",
              "profileType": "extended",
              "isEnabled": "true",
              "isMergeableWithCustom": true,
              "taskSubType": "SYNDICATE",
              "extendedBaseProfileName": "sys_syndicate_product_data_ces_base",
              "collect": {
                "filter": {
                  "include": {
                    "{{EntityType}}": {
                      "queryFields": {
                        "relationships": [
                          "haschild",
                          "hasimages",
                          "hasdocuments",
                          "hasvideos",
                          "hasaudios"
                        ]
                      }
                    },
                    "typesCriterion": {
                      "{{EntityType}}": {
                        "queryFields": {
                          "relatedEntitiesRelationships": [
                            "haschild",
                            "hasimages",
                            "hasdocuments",
                            "hasvideos",
                            "hasaudios"
                          ],
                          "attributes": [
                            "_ALL"
                          ]
                        }
                      }
                    }
                  },
                  "exclude": {
                    "typesCriterion": {
                      "queryFilters": {},
                      "_ALL": {
                        "queryFields": {
                          "relationships": [
                            "belongsto",
                            "belongstotaxonomy",
                            "belongstoroot",
                            "allowedlocales"
                          ]
                        }
                      }
                    }
                  }
                },
                "isBinaryStreamPersistent": "true",
                "channel": [
                  {
                    "settings": {
                      "includeMatchingAttributes": true,
                      "includeEnhancerAttributes": true,
                      "includeRelatedEntities": true,
                      "includeEntityIds": true,
                      "includeRelatedEntitiesRecursive": true,
                      "version": "1.1",
                      "includeRelatedEntityExternalIds": true
                    },
                    "type": "rdpConnector"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ]
}
Note:

By default, out of the box (OOTB) non-GDSN use case profile will be uploaded to PIM.

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.

Syndication Service Configuration

To syndicate data from PIM to Syndiation, upload the following eds-csl_syndicationserviceconfig.json file to the respective tenant:

{
  "metaInfo": {
    "dataIndex": "config",
    "collectionName": "configObjects",
    "responseObjectName": "response"
  },
  "configObjects": [
    {
      "id": "eds-csl_syndicationserviceconfig",
      "name": "Syndigo Syndication",
      "type": "syndicationserviceconfig",
      "properties": {
        "hub": "rshub",
        "isEnabled": true,
        "supportContext": true
      },
      "data": {
        "jsonData": {
          "settings": {},
          "actions": [
            {
              "syndicate": {
                "endpoint": "syndicate",
                "isScheduled": false,
                "title": "Sync",
                "allowedEntityTypes": ["item"]
              }
            }
          ],
          "profilecontexts": [
            {
              "syndicate": {
                "app": "Connector",
                "role": "admin",
                "subtype": "System",
                "service": "ENTITY_EXPORT",
                "channel": "EDS-CES",
                "format": "JSON",
                "source": "internal",
                "user": "system",
                "order": "10"
              }
            }
          ]
        }
      }
    }
  ]
}

Properties

The following table describes the JSON key that must be specified under the properties object.

JSON key Description
supportContext
  • true: supports viewing the syndication status in Syndication Dashboard for multiple contexts.
  • false: does not support viewing the syndication status in Syndication Dashboard for multiple contexts.
  • Note: The default value of supportContext is set to false.

    Actions

    The following table describes the JSON key that must be specified under the actions object.

    JSON key Description
    allowedEntityTypes Holds information about the type of entity that you can configure to syndicate data from PIM to Syndication.
    Note: You are allowed to configure only one entity type at a time. For example, item.
    Notes:
    • An administrator, partner, or implementation team will upload the eds-csl_syndicationserviceconfig.json file to the respective tenant.

    • Ensure to not modify the file when uploading to the tenant.

    Syndication Mapping Configuration

    The syndication mapping configurations are used to map the entity types between PIM and Syndication.Upload the following eds-csl_syndicationmappingconfig.json file to the respective tenant:

    {
      "metaInfo": {
        "dataIndex": "config",
        "collectionName": "configObjects",
        "responseObjectName": "response"
      },
      "configObjects": [
        {
          "id": "eds-csl_syndicationmappingconfig",
          "name": "Syndigo Syndication",
          "type": "syndicationmappingconfig",
          "data": {
            "jsonData": {
            }
          }
        }
      ]
    }
    
    Note:

    Ensure to not modify the file when uploading to the tenant.