Data Sets
Shop-specific imports require a specified shop ID, ensuring that all related tasks are replicated exclusively for that particular shop. The other category, general, includes data sets that are not tied to any specific shop. These general data sets can be replicated alongside shop-specific ones, allowing for a flexible and comprehensive data replication process.
The replication strategy for each task is predetermined, ensuring that all necessary IDs, which may be used by clients, remain consistent between the source and target environments. For example, an attribute_group with an ID of 123 in the source environment will retain the same ID in the target environment, although sub-relations not used by clients may change.
Existing master categories in the target environment must be a subset of the source environment. If this is not the case, the import will fail.
| Included | Excluded |
|---|
- Categories
- attribute_group_categories
- translation_categories
- product_groups
| |
| Pre-Replication State | Post-Replication State |
|---|
| Master category exists based on the path | updated |
| Master category exists not based on the path | newly created |
| Attribute Groups assigned to a master category do not exist in the target environment | the relation is not added to the attribute_group_categories table (Attribute Group is identified by name) |
| Default or disabled Attribute Groups are missing in the target environment | skipped and not added to the attribute_groups_categories table |
| Attribute Groups attached to a master category in the target environment that are not attached to that very master category in the source environment | deleted |
| Master category and Attribute Group connection already exists in the target environment | connection is updated.
At the end of the import the automatic state evaluation is triggered to reevaluate product states based on the updated master categories |
| Translations already exist | translations are updated |
| Translations not present | translations added |
| Category attributes (stored in the attributes table) | replicated |
| Category attributes (stored in the attributes table) identifiers | updated based on the new IDs of the master category they are assigned to in the target environment |
During replication Attribute Groups are either newly created on the target environment or, identical attribute groups are overwritten with the information of the source.
- Attribute groups are considered as identical when they have matching values for all the following identifiers:
attribute_groups.id attribute_groups.name attribute_groups.multiselect attribute_groups.is_advanced attribute_groups.levelattribute_groups.type
- Attributes are considered as identical when they have matching values for the following identifiers:
attributes.id and attributes.identifier .
When selecting the Attribute Group data set, the Attribute group configurations data set is automatically selected. It contains Attribute Group configurations that are stored in a different place. This means you can replicate all Attribute Group configurations from one environment to another by selecting both data sets.
Data replication of attribute groups will preserve their ids from source to target, therefore collision pre-checks are running on import. Please check the #data-state-transition-1 table to learn more about possible collisions and the outcome of the data replication of attribute groups.
| Included | Excluded |
|---|
- Attribute Groups
- Attribute values
- Attribute Group Translations
- Attribute values Translations
| - System Attribute Groups including their values: 551 (category), 550 (brand), 553 (product name)
- Relations
- Attribute Mappings
- Attribute Group Locks
- Attribute-Relations like
attribute_products
|
| Pre-Replication State | Post-Replication State |
|---|
- All existing attribute groups on source and target environment are identical
- Source environment has more attribute groups than the target
- Source environment has more attributes than the target
| - Existing attribute groups are updated in the target environment
- Attribute groups that don't exist in the target environment are created
- Attributes that don't exist in the target environment are created
|
- All existing attribute groups on source and target environment are identical
- Source environment has the same or more attributes than the target environment
- Source environment has more / different translations for attribute groups and or attributes than the target environment
| - Existing translations are updated
- New translations are added in the target environment
|
- Target environment has more attribute groups than the soure environment
| |
- Similar attribute groups are set up in the source and target environment but they have different values for either
attribute_groups.id or attribute_groups.name
| |
- Similar attribute groups are set up in the source and target environment that have matching values for
attribute_groups.id and attribute_groups.name but differ in their values for attribute_groups.multiselect , attribute_groups.is_advanced , attribute_groups.level and/ or attribute_groups.type
| |
The Attribute Group identifier, the Attribute Group name and the category path are used to identify the entities for which translations are replicated in the target environment.
| Included | Excluded |
|---|
- Translations of simple Attribute Groups
- Translation of advanced Attribute Groups
- Translation of Master Categories
| - Translation of Default Filters
- Translation of Custom Data
|
| Pre-Replication State | Post-Replication State |
|---|
| There is already a language translation for one of the entities | updated |
| A translation does not exist based on the category path + locale / the the Attribute Group name + locale / the Attribute Group identifier + locale | created |
This dataset replicates roles set up on a source environment and the permissions associated with those roles. The IDs of the roles will not persist but the name of the role will. IDs and names of existing permissions will retained. New permission names will be inserted.
| Included | Excluded |
|---|
- Roles
- Permissions
- Role has permissions
| - User has roles (users in the target environment might have a different role than in the source environment!)
- Permissions related to Add-ons
|
This data set replicates all shop category trees, along with their related entities, from the source environment. The IDs of shop categories will be preserved. All shop category trees, along with their related entities, will be removed or replaced in target environment. The IDs of the related entities will not be preserved.
| Included | Excluded |
|---|
- Shop Categories
- Shop Category Configurations
- Shop Category Product Sets
- Shop Category properties
- Shop (Country) Category custom data
| - |
- Global shops are considered as "identical" in source and target environment when they have matching values for the following identifiers:
shop_id, prefix, company name and tree_id - Shop countries are considered as "identical" in source and target environment when they have matching values for the following identifiers:
shop_id, prefix, countryCode, tree_id and language locale - Shop Categories are considered as "identical" in source and target environment when they have the same
ID
| Pre-Replication State | Post-Replication State |
|---|
- Identical global shops and shop countries in source and target environment
- Identical configuration for shop category custom data and shop country category custom data
- No shop categories set up in the target environment
| - Shop categories are created
- Included product configurations are replicated (included/ excluded product IDs, product sets.)
- Product ids that don't exist in the target are skipped
- Attribute Groups and Attributes that don't exist on the target are skipped
- Filters are replicated
- State is replicated (visible/ invisible/ active/ inactive)
|
- Identical global shops and shop countries in source and target environment
- Identical configuration for shop category custom data and shop country category custom data
- Shop Categories are set up in source and target environment that have matching ids but differ in configuration (name, filters, product sets, status(
| - Shop categories are overwritten
- Included product configuration is removed from the target categories and updated with configuration of source categories (product ids, attribute groups and attributes that don't exist on the target are skipped)
- Filters are removed from the target categories and updated with filters of source categories
- State is updated according to the state of the source categories
|
- Identical global shops in source and target environment
- Identical configuration for shop category custom data and shop country category custom data
- Shop countries exist in the target environment that do not exist in the source environment
| - Shop categories are created or overwritten for the shop (countries) that are identical on source and target environment
- Shop categories will be removed from the shop country that exist in the target but not in the source
|
- Identical global shops and shop countries in source and target environment
- Identical configuration for shop category custom data and shop country category custom data
- Shop countries exist in the source that do not exist in the target
| - Data Replication will fail
|
- Similar shops are set up in source and target environment that match in id and shop prefix but differ in company name or tree id
| - Data Replication will fail
|
- Similar shop countries are set up in source and target environment that match in id and name but differ in shop prefix, company name or tree id
| - Data Replication will fail
|
- Identical global shops and shop countries in source and target environment
- Custom data configuration differs for shop categories and/ or shop country categories
| - Data Replication will fail
|
All shop countries for the selected shop are replicated. Identical shop countries will be updated with the information of the source environment. Non existing shop countries will be created.
- Shop countries are considered as identical when the global shop they are assigned to have matching values in the source and target environment for the following identifiers:
application.id , application.tree_id , application.prefix , application.company_id AND the country itself has matching values in the source and target environment for the following identifiers: application.id , application.name (e.g. DE, GB, FR,...), application.shop_id (id of the parent shop), application.language_id , application.tree_id , application.prefix
| Included | Excluded |
|---|
- Country
- Currency
- Default language
- Link (URL)
- Currency
- Custom data values
- Assortment
| - Synonyms for Navigation Items
|
| Pre-Replication State | Post-Replication State |
|---|
- The selected shop is identical on source and target environment
- The countries set up in source and target environment are identical but have different values for e.g. URL, currency, custom data values, assortment
- The source environment has additional countries set up for the shop selected that are not set up in the target
- Custom data configurations are identical for shop countries
| - Existing countries in the target are updated based on the country set up in the source
- Countries that are only existing in the source are created in the target
|
- The selected shop is identical on source and target environment
- The countries set up in source and target environment are identical
- Custom data configurations are identical for shop countries
- Assortment configured in the source environment refers to merchants, products, master categories or attribute groups that do not exist in the target environment
| - Merchants, products, master cateogires and attribute groups that do not exist in the target environment are skipped during the replication
|
- The selected shop has identical values for the
application.id in source and target environment but has different values for application.tree_id , application.prefix and/ or application.company_id
| - Data Replication will fail
|
- Similar countries are set up on source and target environment that have matching values for
application.id , application.name but differerent values for application.shop_id , application.language_id , application.tree_id and/ or application.prefix
| - Data Replication will fail
|
- The selected shop is identical on source and target environment
- The countries assigned to the selected shop are identical on source and target environment
- Different shop country custom data are configured in source and target environment
| - Data Replication will fail
|
Search Configurations are stored on the shop country level. Since the Data Replication feature only allows selecting a global shop for shop-specific Data Sets, it is ensured that the Search Configurations are replicated for all countries assigned to the selected global shop.
| Included | Excluded |
|---|
- Searchable attributes
- Synonyms (words, attributes, categories)
- Search Settings (Typo Tolerance)
- Stop words
| - Synonyms for Navigation Items
|
The replication removes all existing Search Configurations set up for the target instance.
Pages are replicated based on their IDs. If identical IDs exist on the source and target environment, the page on the target environment will be updated. New Pages will be added, existing Pages on the target environment will not be removed.
| Included | Excluded |
|---|
- Pages and their translations
| - |
| Pre-Replication State | Post-Replication State |
|---|
| A page already exists based on its ID | The page is overwritten with the page of the source |
| A page does not yet exist based on its ID | The page is added. Existing pages remain and won't be removed |
Redirects are replicated based on their IDs. If identical IDs exist on the source and target environment, the redirect on the target environment will be updated. New Redirects will be added, existing Redirects on the target environment will not be removed.
| Included | Excluded |
|---|
- Default Filter Configurations
| - |
| Pre-Replication State | Post-Replication State |
|---|
| A default filter already exists based on its ID | The default filter is overwritten with the default filter of the source |
| A default filter does not yet exist based on its ID | The default filter is added. Existing default filters remain and won't be removed |
| Included | Excluded |
|---|
- Navigation Menus
- Navigation Items
- Country-specific settings (such as translations and custom visibility)
| - Navigation item assets will not be replicated.
- When replicating Navigations custom data is not copied.
|
| Pre-Replication State | Post-Replication State |
|---|
| A navigation menu already exists based on its ID | The menu is overwritten with the navigation menu of the source |
| A navigation item already exists based in its ID | The navigation item is overwritten with the navigation item of the source |
| A navigation menu or item does not yet exist based on its ID | The navigation menu or item is added. Existing navigation menues and items remain and won't be removed |
