Cleansing rules

Using cleansing rules you can define automated modifications of attribute values which are carried out in the process of a transformation. In the process, the attribute values of the imported or manually added attributes are modified according to the defined rules.

Note
A distinction is made between rules at item level and rules at attribute level. Rules at item level can cover several attributes, rules at attribute level always refer to a specific attribute.
INFO
Click here for an overview of all the available rule types.

Set up new cleansing rules

In order to, for example, create a new cleansing rule on the attribute level, proceed as follows:

  1. From the “Choose rule type” menu , select a rule type.
  2. Click on the Add button to call up the corresponding dialog box.
  1. Enter a name for the cleansing rule in the “Title” field .
  2. From the “Order” menu , select the approriate option. You can choose between:
    • Before transformation: The attribute value modification that is carried out by the cleansing rule also affects the imported supplier attributes.
    • After transformation: The The attribute value modification that is carried out by the cleansing rule only affects the transformed iPIM attributes.

This screenshot shows the setup of a cleansing rule using the example of a “Setting default value for attribute” type rule.
  1. From the “Attribute” menu , select the attribute whose value is to be modified by the cleansing rule. The adjustment modifies the attribute value according to the defined conditions.
  2. Optional: Enter a short rule description in the field “Description” field .
  3. Activate respectively deactivate the cleansing rule:
    • In order to activate the rule, tick the “Activate rule” checkbox (default setting).
    • In order to deactivate the rule, untick the “Activate rule” checkbox.
  4. Optional: Tick the “Internal rule” checkbox  to determine that the cleansing rule is an internal rule. Internal rules can be used as subordinate rule of certain rule types such as “Conditional attribue setting”.
  5. Configure the cleansing of the attribute values . The setting options depend on the selected cleansing rule.
  6. Optional: Configure a test run and carry it out in order to check the validity of the cleansing rule:
    1. Click on the Configure test run button . Then appear the corresponding input fields.
    2. Make the required inputs for the configuration of the test run. The input options depend on the rule type.
    3. Click on the Start test run button to trigger the test run. Following this, the result is shown below.
  • In order to finalise the setup of the cleanup rule, click on the Save button . “The The cleansing rule is now set up. It appears in the table of cleansing rules.
  • In order cancel setting up the cleansing rule, click on the Cancel button .

Activate/deactivate cleansing rules

Via the corresponding checkbox you can activate respectively deactivate individual cleansing rules.

  • In order to activate a cleansing rule, tick the checkbox in the “Active” column.
  • In order to deactivate a cleansing rule, untick the checkbox in the “Active” column.

Edit cleansing rules

In order to edit a cleansing rule, proceed as follows:

  1. In the table row of the cleansing rule, click on the edit button to call up the corresponding dialog box.
  2. Make the desired changes.
  • In order to save your settings, click on the Save button. If the process was successful, a corresponding message will appear.
  • In order to cancel the process, click on the Cancel button.

Remove cleansing rules

In order to remove a cleansing rule, proceed as follows:

  1. In the table row of the cleansing rule, click on the Entfernen button. Following this, the cleansing rule vanishes from the table.
  2. Click on the Save button to confirm the removal of the cleansing rule.

Copy to a profile

You can add a cleansing rule to a cleansing and validation profile. Then you can use it for other catalogs without having to define it anew. In order to add a cleansing rule to a cleansing and validation profile, proceed as follows:

  1. In the table row the cleansing rule, click on the copy to profile button to call up the corresponding dialog box.
  2. From the menu, select a cleansing and validation profile.
  • In order to finish the process, click on the Save button. If the process was successful, a corresponding message will appear.
  • In order to cancel the process, click on the Cancel button.

Change the order of cleansing rules

Via the arrow buttons you can change the order of the cleasing rules. To do do, proceed as follows:

  • To move an cleansing rule upwards in the order, click on the Upwards arrow button in the respective table row.
  • To move an cleansing rule downwards in the order, click on the Downwards arrow button in the respective table row.
  • In order to save your settings, click on the Save button. If the process was successful, a corresponding message will appear.
  • In order to cancel the process, click on the Cancel button.
Note
  • In a descending manner, the order of the cleansing rules determines the sequence of their execution. Hence, it is required to arrange the cleansing rules in the intended order of execution.
  • Arranging the cleansing rules in the correct order can be crucial if the successful execution of a particular cleansing rule depends on attribute values being cleansed accordingly by a preceding rule.

Use cases

Set up a cleansing rule for conditional category assignment

This section uses an example to explain how items are assigned to an appropriate category in the primary taxonomy based on the attribute that represents a device type. In this example, items of the device type “Coffeemaker” are mapped to the “Coffee makers” category:

  1. Select the option “Conditional attribute setting” from the “Choose rule type” menu .
  2. Click on the Add button to call up the corresponding dialog box.
  1. Optional: In the "Title" field in the "Title" field.
  2. The options in the "Order" menu unchanged.
  3. If it isn't already selected, check the "Activate rule” checkbox .
  4. Using the "Attribute to compare" menu , select the attribute that represents the device type (In this example, “Device Type DT704”).
  5. Select the option “= (Equal)” from the “Comperator” menu .
  6. Select the option “Constant” from the “Comparison type” menu .
  1. Enter the value “Coffeemaker” in the “Compared value” field .
  2. Select the option “Constant” from the “Target type” menu .
  3. In the "Target value" field . Arrow to the rightThe category category for the primary taxonomy is shown.
  4. In the category list, click on the "Coffee makers" category.
  5. Click on the Save button to finalise the configuration of the cleansing rule. The dialog box closes and a success message is shown.

FAQ

Basics

What are cleansing rules and what are they used for?

Using cleansing rules you can define automated modifications of attribute values which are carried out in the process of a transformation. In the process, the attribute values of the imported or manually added attributes are modified according to the defined rules.

What is the difference between rules at item level and rules at attribute level?

Rules at item level can cover several attributes, while rules at attribute level always refer to a specific attribute. This distinction should be considered when choosing the appropriate rule type.

Set up new cleansing rules

What does the order option “Before transformation” mean?

With the “Before transformation” option, the attribute value modification that is carried out by the cleansing rule also affects the imported supplier attributes. The modification thus takes effect before the actual transformation step.

What does the order option “After transformation” mean?

With the “After transformation” option, the attribute value modification that is carried out by the cleansing rule only affects the transformed iPIM attributes. The modification thus takes effect after the transformation step.

What is an internal rule, and what is the corresponding checkbox used for?

If the “Internal rule” checkbox is ticked, the cleansing rule is defined as an internal rule. Internal rules can be used as a subordinate rule of certain rule types, such as “Conditional attribute setting”.

Copy a cleansing rule to a profile

What is the purpose of copying a cleansing rule to a profile?

You can add a cleansing rule to a cleansing and validation profile. Then you can use it for other catalogs without having to define it anew.

Order

Why is the order of cleansing rules relevant?

The order determines the sequence in which the cleansing rules are executed, proceeding in a descending manner. This can be crucial if the successful execution of a particular cleansing rule depends on attribute values being cleansed accordingly by a preceding rule.