Ucommerce Connector

Overview

Data synchronization from Perfion to Ucommerce depends on how both systems are set up. In order to synchronize data the Ucommerce should be set prior synchronization starts and ECommerce Mappings configuration in Perfion should match configuration in Ucommerce. Ucommerce Connector will not synchronize any configurations. It will use existing configurations and will transfer only the data, e.g. products, categories, variants and other data related to these entities. The following configurations will not be updated by Ucommerce Connector and must be manually configured from Ucommerce GUI:

  • Product Catalog Groups (also known as Stores), including their definitions

  • Product Catalogs, including their definitions

  • Category Definitions

  • Product Definitions

  • Price Groups (definitions)

  • Product Relations (definitions)

  • Languages

  • Any other data, which is not directly related to Ucommerce Connector, e.g. campaigns, order related data, etc.

Prerequisites

Before running the Ucommerce Connector one must install Ucommerce version 7.16.1.18134 or newer. Note that support of newer version depends on introduced changes by Ucommerce. If newer version has breaking changes related to Ucommerce Connector, then it may not work correctly. The list of Ucommerce Connector versions:

Ucommerce Connector version

Ucommerce version

Ucommerce API version

Perfion Connector App version

Perfion Ucommerce Cache Manager version

v0.94

v7.16.1.18134

v7.17.0.18149

-

-

v1.0

v8.0.0.18352

v7.17.0.18149

-

-

v1.2

v8.0.0.18352

v8.0.1.19053

v1.0

-

v1.4*

v8.0.0.18352

v8.0.1.19053

v1.0

v1.0

v1.5

v9.3.1.20275

v8.0.1.19053

v1.1

v1.1

NOTE: If updating from the older version of Ucommerce Connector then it has to be updated including all its add-ons.

It is recommended to always use the newest version, because each version have various bug fixes and only the newest version is supported.

Multilingual Data Handling

Multilingual data in Ucommerce can be defined for various definitions (product, category), fixed parameters (e.g. Display Name, Description, etc.) and one can also create multilingual type custom parameters. Multilingual data setup in Ucommerce will depend on languages defined for its parent CMS system. In order to correctly synchronize multilingual data from Perfion to Ucommerce, one must configure Ucommerce Connector to use languages in ECommerce Settings, and those languages must match languages defined in Ucommerce. Language matching is done via culture codes.

The handling of multilingual data in Ucommerce is loosely coupled. Ucommerce data does not use fixed references to culture codes defined in the system and instead allows to create any number of multilingual data, even if it is not defined in its parent CMS. However, Ucommerce GUI will show only that multilingual data, which match system defined languages. For example, it is possible to have data in Ucommerce for five different languages, but if system has only two languages, then GUI will show only data for those two languages. Moreover, if any of the system languages will not match one of existing languages in Ucommerce database, then no data for those missing languages will be shown in GUI, but such data state is acceptable by Ucommerce, e.g. not an error.

Based on this loosely coupled approach, Ucommerce Connector will synchronize all multilingual data to Ucommerce as it is defined in ECommerce Settings without checking which languages it actually have as system languages. Moreover, Ucommerce does not allow to get the list of system languages via their API, so all language related configurations must be manually configured by users, e.g. Ucommerce Connector cannot do any validation regarding missing or mismatching language configurations.

Data Handling for Multiple Stores

Multiple stores in Ucommerce can be set up using Product Catalog Groups. Ucommerce has product data, which is common for all stores, and then it allows to manage various product related parameters by using configuration of Product Catalog Group, Product Catalog and Category data. The product may belong to different stores if it is related to several categories, where each of those categories may belong to different Product Catalog Groups (via Product Catalogs).

To control product relations to multiple stores in Ucommerce Connector, one will have to use a single channel ECommerce setup. That means that by setting up a single channel in ECommerce, one can synchronize data for multiple stores. Product relation to one or another store will be controlled by assigning products in Perfion to categories, where they can belong to different Ucommerce stores. To define if a category belongs to one or another store, one will have to define correct Product Catalog Group and Product Catalog definitions for each category.

Perfion Connector App in Ucommerce

Ucommerce Connector can be used together with Perfion Connector App in Ucommerce. Perfion Connector App allows starting and stopping the Ucommerce Connector installed as Windows service and also to monitor its logs.

In order to install the Perfion Connector App one has to install it in Ucommerce back-end and also install an extra web service. Refer to Perfion Connector App Setup for more information.

Perfion Ucommerce Cache Manager

The Perfion Ucommerce Cache Manager is a pipeline task service in Ucommerce which allows resetting the cache in Ucommerce for the entities which were handled by Perfion Ucommerce Connector. The Cache Manager is an independent application which is not needed for Perfion Ucommerce Connector to work, but it can be useful if data synchronized with Perfion is not correctly refreshed in Ucommerce or cause other issues.

In order to install the Perfion Ucommerce Cache Manager one has to install it in Ucommerce back-end. Refer to Perfion Ucommerce Cache Manager Setup for more information.

Â