Manage the ETL mappings

An ETL attribute set mapping is used to extract the data from a source attribute set, transform it according to a specified method defined by the extension, and load it into a destination attribute set.

You can create mappings, edit existing mappings and rerun mappings.

Create an ETL attribute set mapping

Create an ETL attribute set mapping to map the attributes of the source attribute set to the attributes of the destination attribute set. The mapping allows to convert the attributes from the source set to fit the attributes required by the destination set.

Prerequisites

At least two attribute sets have been created, see Create an attribute set.

Procedure

DataHub > ETL > Tab MAPPINGS

Attribute set mappings

  1. Click the Add (Add) button in the bottom right corner.
    The Create ETL attribute set mapping window is displayed.

    Create ETL attribute set mapping

  2. Select a source attribute set in the Source attribute set drop-down list. All active attribute sets are displayed in the drop-down list.

  3. Select a destination attribute set in the Destination attribute set drop-down list. All active attribute sets are displayed in the drop-down list.
    If any attribute set mapping with the selected destination attribute set already exists, the Copy ETL attribute set mapping drop-down list is unlocked.

  4. Select a language in the Language drop-down list. All active languages are displayed in the drop-down list.

    The selected language defines the language from which the value of a multi-language attribute is taken when mapping it to a single language attribute.

  5. Select a scope in the Scope drop-down list. All active scopes are displayed in the drop-down list.

    The selected scope defines the scope from which the value of a multi-scope attribute is taken when mapping it to a single scope attribute.

  6. If desired, select an existing ETL attribute set mapping in the Copy ETL attribute set mapping drop-down list. All attribute set mappings whose destination attribute set matches or has inheritance relations to the selected destination attribute set are displayed in the drop-down list.

    If you select an ETL attribute set mapping in the drop-down list, all matching attribute mappings are applied to the new ETL attribute set mapping.

  7. Click the [SAVE] button in the bottom right corner.
    The new attribute set mapping has been saved and is displayed in the list of attribute set mappings. The Create ETL attribute set mapping window is closed.

Edit an ETL attribute set mapping

After you have created an attribute set mapping, you can edit it. You can edit the attribute mappings within an attribute set mapping, add a custom mapping for a certain destination attribute, delete an existing attribute mapping or rerun a single or all attribute mappings within an attribute set mapping.

Edit the ETL attribute mappings

When editing an ETL attribute mapping, you can create a mapping to an unmapped destination attribute, change the source attribute or the change tracking mode of an existing mapping.

The change tracking mode determines the way the data is synchronized between the mapped attributes when a value is changed. This can take place manually, automatically, semi-automatically, or after the approval of another user.

Prerequisites

At least one ETL attribute set mapping has been created, see Create an ETL attribute set mapping.

Procedure

DataHub > ETL > Tab MAPPINGS

Attribute set mappings

  1. Click the attribute set mapping you want to edit in the list of attribute set mappings.
    The Mapping from "Source attribute set name" to "Destination attribute set name" view is displayed.

    Mapping

  2. Click the row of the attribute you want to map on the left side.
    The Settings section is displayed on the right side.

    Mapping settings

    Depending on the selected row, the fields displayed in the Settings section differ:

    • If the selected row contains only a destination attribute, the destination attribute as well as the Extension and Override change tracking mode drop-down lists are displayed.
    • If the selected row contains an attribute mapping with source, destination attribute and the extension, the destination attribute as well as the Source attribute, Extension and Override change tracking mode drop-down lists are displayed. The Source attribute, Extension and Override change tracking mode drop-down lists are preset. If the selected extension requires further configuration settings, the Configuration section is displayed below the Settings section.

  3. Select the appropriate option in the Extension drop-down list in the Settings section. All extensions that are matching the data type of the destination attribute are displayed in the drop-down list.
    If the selected extension requires further configuration settings, the Configuration section is displayed below the Settings section.

    For detailed information about the data types, see Data type list.
    For detailed information about the ETL extensions, see ETL extensions list.

  4. Select the appropriate tracking mode in the Override change tracking mode drop-down list. By default, the Use default option is preselected. The following options are available:

    • Use default
      The mapping configured in the dependency of the specific entities is applied.
    • 0 - Manual
      The initial mapping is automatically applied. Afterwards, the changes in the mapping must be triggered manually to be applied.
    • 1 - Semiautomatic
      The initial mapping is automatically applied. Values changes or reruns are applied after confirmation.
    • 2 - Automatic
      The initial mapping is automatically applied. All value changes or reruns are applied automatically in the mapping.
    • 3 - Semiautomatic, changes must be confirmed by another user
      The initial mapping as well as values changes or reruns are applied after confirmation by another user.

  5. Select the appropriate attribute that you want to assign to the destination attribute in the Source attribute drop-down list. All attributes with a data type that matches the selected ETL extension are displayed in the drop-down list.

  6. If required, select or enter the corresponding configuration settings in the Configuration section.

  7. Click the [SAVE] button in the upper right corner.
    The changes have been saved. The Settings section is hidden.

    Be aware that you have to rerun the mapping to apply the changes made to the attribute, see Rerun an ETL mapping.

  8. Repeat the steps 2 to 7 for all attributes you want to map.

Add a custom mapping for a destination attribute

When creating an ETL attribute set mapping, you define the language and the scope from which the values are taken for multi-language and multi-scope source attributes. Within an attribute set mapping, you can define custom scope and language attribute mappings for multi-language and multi-scope destination attributes.

Prerequisites

Procedure

DataHub > ETL > Tab MAPPINGS

Attribute set mappings

  1. Click the attribute set mapping to which you want to add a custom language or scope attribute mapping for a certain destination attribute.
    The Mapping from "Source attribute set name" to "Destination attribute set name" view is displayed.

    Mapping

  2. Select the checkbox of the attribute mapping to which you want to add a custom mapping for another language or scope. The editing toolbar is displayed above the attribute mappings.

    Mapping selected

  3. Click the [CUSTOM DESTINATION ATTRIBUTE SCOPE AND LANGUAGE] button in the editing toolbar. This button is only displayed if the destination attribute of the selected mapping is multi-language or multi-scope. The Settings section is displayed on the right side.

    Custom mapping

    Depending on the destination attribute, the additional drop-down lists displayed in the Settings section differ:

    • If the destination attribute is multi-language, the Language drop-down list is displayed additionally below the destination attribute.
    • If the destination attribute is multi-scope, the Scope drop-down list is displayed additionally below the destination attribute.
    • If the destination attribute is multi-language and multi-scope, the Language and the Scope drop-down lists are additionally displayed below the destination attribute.

  4. Select the appropriate language in the Language and/or the appropriate scope in the Scope drop-down list in the Settings section. In the Language drop-down list, all active languages are displayed. In the Scope drop-down list, all active scopes are displayed.

  5. Select the appropriate option in the Extension drop-down list in the Settings section. All extensions that are matching the data type of the destination attribute are displayed in the drop-down list.
    If the selected extension requires further configuration settings, the Configuration section is displayed below the Settings section.

    For detailed information about the data types, see Data type list.
    For detailed information about the ETL extensions, see ETL extensions list.

  6. Select the appropriate tracking mode in the drop-down list Override change tracking mode. By default, the Use default option is preselected. The following modes are available:

    • Use default
      The mapping configured in the dependency of the specific entities is applied.
    • 0 - Manual
      The initial mapping is automatically applied. Afterwards, the changes in the mapping must be triggered manually to be applied.
    • 1 - Semiautomatic
      The initial mapping is automatically applied. Values changes or reruns are applied after confirmation.
    • 2 - Automatic
      The initial mapping is automatically applied. All value changes or reruns are applied automatically in the mapping.
    • 3 - Semiautomatic, changes must be confirmed by another user
      The initial mapping as well as values changes or reruns are applied after confirmation by another user.

  7. Select the appropriate attribute that you want to assign to the destination attribute in the Source attribute drop-down list. All attributes with a data type that matches the selected ETL extension are displayed in the drop-down list.

  8. If required, select or enter the corresponding configuration settings in the Configuration section.

  9. Click the [SAVE] button in the upper right corner.
    The mapping has been created and is added to the list of attribute mappings on the left side. The selected language and/or scope is indicated in brackets behind the destination attribute. The Settings section is hidden.

Delete an ETL attribute mapping

Delete an attribute mapping to cancel the transfer of data to the destination attribute of the selected mapping.

Prerequisites

At least one ETL attribute set mapping has been created, see Create an ETL attribute set mapping.

Procedure

DataHub > ETL > Tab MAPPINGS

Attribute set mappings

  1. Click the attribute set mapping in which you want to delete an attribute mapping.
    The Mapping from "Source attribute set name" to "Destination attribute set name" view is displayed.

    Mapping

  2. Select the checkbox of the attribute mapping you want to delete.
    The editing toolbar is displayed above the attribute mappings.

    Mapping selected

  3. Click the Delete (Delete) button in the editing toolbar.
    The attribute mapping has been deleted from the list.

    When deleting an attribute mapping, the mapping to the destination attribute, but not the destination attribute itself, is deleted from the attribute mapping list. The destination attribute is only deleted if the attribute mapping was a custom language or scope mapping. In this case, the original destination attribute without customized language or scope is still available in the list of attribute mappings.

  4. Repeat the steps 2 and 3 for all attributes you want to delete.

    Be aware that you have to rerun the mapping to apply the changes made to the attribute, see Rerun an ETL mapping.

Rerun an ETL mapping

After having created or changed an attribute mapping within an ETL attribute set mapping, the new mapping is not automatically applied. The mapping is only applied when either a value in the source attribute changes or when you rerun the respective attribute mapping or all mappings within an ETL attribute set mapping.

Rerun a single attribute mapping

To apply changes or a new attribute mapping within an attribute set mapping, you can trigger the rerun of a single attribute mapping. It is recommended to use this function when only one or a few attribute mappings are affected. If a higher number of changes or new attribute mappings within an attribute set mapping has been made, it is recommended to rerun all attribute mappings within the attribute set mapping, see Rerun an attribute set mapping.

Prerequisites

At least one ETL attribute set mapping has been created, see Create an ETL attribute set mapping.

Procedure

DataHub > ETL > Tab MAPPINGS

Attribute set mappings

  1. Click the attribute set mapping to which you have made the changes or created new attribute mappings.
    The Mapping from "Source attribute set name" to "Destination attribute set name" view is displayed.

    Mapping

  2. Select the checkbox of the attribute mapping you want to rerun.
    The editing toolbar is displayed above the attribute mappings.

    Mapping selected

  3. Click the [RERUN SELECTED MAPPING] button in the editing toolbar.
    The Rerun single mapping window is displayed.

    Rerun single mapping

  4. If desired, enable the Also rerun mapping for entities with manual change tracking (or if the change tracking override of this mapping is manual)? toggle.

    If you enable the Also rerun mapping for entities with manual change tracking (or if the change-tracking override of this mapping is manual)? toggle, the mapping will rerun regardless of the selected change tracking mode.

  5. Click the [SAVE] button in the Rerun single mapping window.
    The mapping rerun has been started. A confirmation message is displayed.

    The current status of the job is displayed in the ETL PROCESSES tab.
    For detailed information, see Check the ETL process status.

Rerun an attribute set mapping

To apply changes or a new attribute mapping within an attribute set mapping, you can trigger the rerun of all attribute mappings within an attribute set mapping. It is recommended to use this function if a higher number of changes or new attribute mappings within an attribute set mapping has been made. If only one or a few attribute mappings are affected, it is recommended to rerun the respective attribute mappings separately, see Rerun a single attribute mapping.

Prerequisites

At least one ETL attribute set mapping has been created, see Create an ETL attribute set mapping.

Procedure

DataHub > ETL > Tab MAPPINGS

Attribute set mappings

  1. Click the attribute set mapping to which you have made the changes or created new attribute mappings.
    The Mapping from "Source attribute set name" to "Destination attribute set name" view is displayed.

    Mapping

  2. Click the [RERUN MAPPINGS] button in the upper right corner.
    The Rerun all mappings window is displayed.

    Rerun all mapping

  3. If desired, enable the Also rerun mapping for entities with manual change tracking (or if the change tracking override of this mapping is manual)? toggle.

    If you enable the Also rerun mappings for entities with manual change tracking? toggle, the mapping will rerun regardless of the selected change tracking mode.

  4. Click the [SAVE] button in the Rerun single mapping window.
    The mapping rerun has been started. A confirmation message is displayed.

    The current status of the job is displayed in the ETL PROCESSES tab.
    For detailed information, see Check the ETL process status.

arrow_upward