Simple Mode of Creating Rules

Data Quality section. Data administrator interface

Contents

Creating Quality Rules

Before you start:

  • Make sure that draft mode is enabled and draft is selected.
  • Make sure that the “Quality Rules” tab is active in the “Data Quality” section.

To create a quality rule:

  1. Select the required entity/lookup entity from the list on the left side of the screen.
  2. Select the attribute of the entity/lookup entity for which the rule will be created.
  3. As a result of the action, a table with rules will open to the right of the attribute list. If there are no rules on the selected attribute, the table will be empty.
  4. Click “Create rule” button on the right side of the table header.
  5. In the menu that appears, select the required type of quality rule: Validation or Enrichment. Creating rules with both types at once is available only in advanced mode.
  6. The action will open a drawer with the rule creation wizard: validation or enrichment.
  7. On the last step, click “Confirm” to save the changes.
  8. After all the data is entered and saved, publish the draft:
    • Click the “Publish” button at the bottom of the “Data Model” list.
    • In the window that opens, select the publication method: simple or publication with priority. Simple publication is used if the quality rules have either not been changed by other users, or have changed insignificantly during the period of working on the draft. If you try to publish a draft after significant changes, some conflicts in the quality rules may result in an error and stop publication. Publishing with priority ignores any previous changes and overwrites the quality rules.
    • Confirm the selection.

Simple mode of quality rule creation

Figure 1. Simple mode of quality rule creation

Wizard of Creating Validation Rules

The wizard opens after you click “Create rule” > “Validation rule”.

To set up a new quality validation rule:

  1. At the Select function step, specify data processing function that the rule will apply. Only functions that can be used for validation will be suggested in the list. A standard, composite, or custom function can be selected.
  2. Click “Next step”.
  3. At the Properties step, specify the main properties of the rule:
    • Name. Logical name of the rule.
    • Display name. Name that will be displayed to users.
    • Optional. Description. Additional information about the quality rule.
    • Run condition. The condition under which the quality rule will be triggered.
    • For which source systems to apply. Defines, for the data of which sources the rule will be applied.
  4. At the Validation step, specify ports or content for the settings:
    • Create error based on. Outgoing logical port, on the basis of which the quality error will be created.
    • Critical level. The priority level of the created error, which will affect the formation of statistics on the registry and help prioritize the processing of errors. With the “Set value” checkbox: select the required critical value from the list. With the “Select port” checkbox: if the function has an outgoing logical port that sends critical data, you can use that port.
    • Message text. “Set value” checkbox: used for a text description of the error. “Select port” checkbox: used to select the outgoing string port as the error message.
    • Category. If specified manually, contains a text description of the error category. Similarly with the message text, you can specify the available outgoing string port. Used to search for records by error category.
  5. At the Set of rules step, select an existing data set, or select the option to create a new set. The step is available only in case there are already rule sets on the selected entity/lookup entity.
  6. At the Rule set properties specify the properties:
    • Set name. Logical name of the set.
    • Display name. Name which will be displayed to users.
    • Optional. Description. Additional information about the set.
    • In the To be added to set area check and, if necessary, edit the parameters of incoming and outgoing ports of the data processing function.
    • In the Set contents оarea the parameters of incoming and outgoing ports that have already been added to the set are displayed.
  7. Click the “Confirm” button after you finish the rule configuration.
  8. After all the data has been entered and saved, publish the draft.

Wizard to create quality rules

Figure 2. Wizard to create quality rules

Wizard of Creating Enrichment Rules

The wizard opens after clicking “Create rule” > “Enrichment rule”.

To set up a new enrichment quality rule:

  1. At the Select function step, specify data processing function that the rule will apply. Only functions that can be used for validation will be suggested in the list. A standard, composite, or custom function can be selected.
  2. Click “Next step”.
  3. At the Properties step, specify the basic properties of the rule:
    • Name. Logical name of the rule.
    • Display name. Name that will be displayed to users.
    • Optional. Description. Additional information about the quality rule.
    • Run condition. The condition under which the quality rule will be triggered.
    • For which source systems to apply. Defines, for the data of which sources the rule will be applied.
    • On behalf of which source system to save. The source system on behalf of which the enriched data will be saved.
  4. At the Set of rules step, select an existing data set, or select the option to create a new set. The step is available only in case there are already rule sets on the selected entity/lookup entity.
  5. At the Rule set properties specify the properties:
    • Set name. Logical name of the set.
    • Display name. Name which will be displayed to users.
    • Optional. Description. Additional information about the set.
    • In the To be added to set area check and, if necessary, edit the parameters of incoming and outgoing ports of the data processing function.
    • In the Set contents оarea the parameters of incoming and outgoing ports that have already been added to the set are displayed.
  6. Click the “Confirm” button after you finish the rule configuration.
  7. After all the data has been entered and saved, publish the draft.

Editing Quality Rule

To edit a quality rule:

  1. Select the required entity/lookup entity.
  2. Select the attribute that contains the quality rules. Attributes with quality rules are marked in the attribute list.
  3. From the list of rules, select the required one.
    • This will open a drawer. Some fields, such as the logical name, will not be available to change.
    • Make your changes.
    • Save the changes. Click the “Save” button located in the upper right corner of the drawer.
  4. After all the data has been entered and saved, publish the draft.

Deleting Quality Rule

To delete a quality rule:

  1. Switch to advanced mode.
  2. Open the Quality rules tab.
  3. In the list of rules, check the required rules.
  4. The “Create rule” button will change to the “Delete rule” button. Click this button.
  5. Confirm the action.
  6. After all the data has been entered and saved, publish the draft.