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 |
Attribute Groups are identified by attribute_groups.name. Attributes are identified by attributes.identifier and Attribute Group. 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
- Attribute Group configurations
| - Advanced Attribute Groups
- 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 |
|---|
An Attribute Group already exists based on it's ID and it matches the following fields: - name
- multi-select
- is_advanced
- level
- advanced_structure
- attribute_type
| updated |
An Attribute Group already exists based on it's ID and it does not match one of the following fields: - name
- multi-select
- is_advanced
- level
- advanced_structure
- attribute_type
| import will fail |
| An Attribute Group does not exist in the based on it's ID, but one can be found in target with the same name | import will fail |
| An Attribute Group does not exist in the target based on it's ID or it's name | created |
| An Attribute Group exists in the target but not in the source environment, based on it's ID or it's name. | remains |
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 source environment. The IDs of shop categories will be preserved. All shop category trees, along with their related entities, will be removed 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
| - |
| Pre-Replication State | Post-Replication State |
|---|
| Destination and source do not have a single matching country set up for the selected shop | Data Replication will fail |
| There is not a matching Shop Category Tree ID within the matching countries between source and destination | Data Replication will fail |
| Source and country environment have at least one matching country within the selected shop. This country has at least one matching shop category tree ID | The shop category of the affected tree ID will be truncated in the target environment. The shop categories are replicated from the source to the target. The IDs of the shop categories will remain |
| Either source or target environment have custom data configurations set up that do not match in both environments | Since Custom Data Configurations are not replicated, it's a requirement that these configurations match. If this is not the case, the 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 |
