ONE Desktop ONE DQ&C ONE MDM ONE RDM ONE Runtime Server
latest (15.4.0) 15.3.0 15.2.0 15.1.0 14.5.x 13.9.x 13.8.x 13.7.x 13.6.x 13.5.0 13.4.x 13.3.x 13.2.x
User Community Service Desk Downloads
If you can't find the product or version you're looking for, visit support.ataccama.com/downloads

Validation Components

What are components?

Component rules, or components, are ONE Desktop files that can be used for three possible data processing steps:

  1. Validation components: Used for checking whether the loaded data meets quality rule requirements, and for sending notifications or identifying the values that are not.

  2. Transformation components: Used for creating Virtual Catalog Items (VCIs).

  3. Post-processing components: Used for any kind of post-processing actions on the data in accordance with the defined rules.

Where can I find them?

In Data Quality, navigate to Components. There you can see list of all components, as well as the three component types separately in the corresponding subsections under the Components section.

Components

Working with validation components

In ONE, it is possible to create only validation components.

Creation of transformation and post-processing components is initiated from ONE Desktop. For instructions, see Virtual Catalog Items and Post-Processing Plans, respectively.

Component rules can be used for complex data validation tasks, when the DQ rules available in the webapp cannot sufficiently define the validation logic.

To create and use validation components, follow these steps:

  1. Create a component rule in ONE. See Create a component rule.

  2. Define component rule logic in ONE. See Define component logic.

  3. Implement component logic in ONE Desktop. See Implement component logic in ONE Desktop.

  4. Use component when creating rules. See Create a rule using component.

Create a component rule

  1. In Data Quality, navigate to Components. This screen contains the general list of all components.

  2. Select Create.

  3. In the General information section, provide the following information:

    • Name: The name of the component.

    • Component description (optional): A description of the component and how it should be used.

    • Type: Select Validation component.

      Create component

  4. Select Save. This creates a draft of the component.

  5. Before publishing or submitting an approval request, you need to describe the component logic and its input attributes.

    This is done on the Implementation tab. To continue, see Define component logic.

Define component logic

  1. Navigate to the Implementation tab of the component and fill in the following:

    • Input Attributes: Select Add Input Attributes to set input attributes.

      600

    • Component Logic: Explain the component logic to the ONE Desktop user who will be implementing the component.

    • Implementation state: Once your component is configured, set to Ready for implementation.

    • Description (optional): A description of the component and how it should be used.

    • Explanations: Explanations are propagated to ONE Desktop where they are used in rule logic as reasons why the rule is invalid.

  2. After the changes are implemented, they need to be published.

    600

  3. After the changes are published, the component is ready for implementation in ONE Desktop.

Implement component logic in ONE Desktop

The component implementation in ONE Desktop is done typically by advanced users (power users). Requirement for such implementation is a local installation of Ataccama ONE Desktop tool. If you don’t have access to ONE Desktop, contact your admin.

The component rule needs to fulfill the following conditions in order to ensure the correct results are returned:

The total number of input records must match the total number of output records in the component. The order of output records must match the order of input records.

  1. Open ONE Desktop.

  2. Add Ataccama ONE Platform Server (xref:Creating a New Server Connection).

  3. Navigate to ONE Metadata Explorer tab.

  4. Select the component you have created in ONE Web Application (in the current example, the rule is "Email Check").

    Example validation component

  5. Right-click on the component and select Edit Component.

  6. In Component Editor, implement validation steps for your component.

    Steps

  7. Save changes.

Score records

To be able to score the records invalidity severity level, do the following:

  1. Add the Score Column Assigner step to the plan.

    Score assigner

    This adds an output column to the data where you can see the score for each record. .. Double-click on the Score assigner to open it. .. Set the score assigning logic, for a simple example, if the record is invalid, the score could be 1000:

    + TIP: The score is used as a numeric expression of each record’s invalidity severity level according to the rule. This is mainly useful for monitoring projects to detect the records with issues, and to be able to improve the data quality. Typically, the logic follows that the higher the score the worse the issue. For example, if a non-critical value is missing, the record’s score is 100, if a critical value is missing, the record’s score is 10000.

  2. Select OK and save the changes before publishing.

  3. Right-click on the component and select the option Push Changes to send the changes to the webapp. Confirm by clicking OK.

  4. To change the status of the component to Implemented (ready to be used), right-click on the component and select option Mark As > Implemented.

Optionally, add a Filter step to be able to filter the records in the post-processing export plan by scores. For example, filter the records by score, where the score is equal to or higher than 2000.

Create a rule using component

The following instructions are specific to creating a rule using a component. For more information about creating rules, see Create DQ Evaluation Rule.

  1. Navigate to Data Quality > Components and make sure that State of your component has changed to IMPLEMENTED.

    This means that the component has been implemented in ONE Desktop and now you can use it in your rules.

  2. Navigate to the Rules section in Data Quality and create a new rule, corresponding to a component.

  3. Navigate to the Implementation tab of the newly-created rule.

    1. In Select Rule type, select the rule dimension.

    2. Select Add Input Attribute and set the input attributes. They must be the same data type as input used in the component.

    3. Change Rule logic to Component and confirm Change Type.

    4. Click Select a Component and select your component.

    5. Map attributes from component to rule.

      Map attributes

    6. The Rule logic > Explanations section lists explanations defined for the component.

      Map each Explanation with a Result. The list of available results depends on the selected rule dimension.

      400

  4. After the changes are implemented, they need to be published.

Was this page useful?