Domains

A domain contains all values that are relevant for it. First and foremost, of course, these are the values defined correctly for this domain and within the company.

In a domain, however, you can also define values that are considered synonyms for other values. For example the value “Germany” can be a valid value, additionally the value “DE” can be defined as a synonym. In this case, the value “Germany” is also referred to as the master.

You can also define values as invalid within a domain.

When data is validated via the validation API, the API returns the validation status of the defined value. For a synonym, the master is also returned as a valid value.

 

Domains can also be set to closed within HEDDA.IO. The corresponding Domains are displayed in the Explorer with a lock and within the Excel Add-in with a yellow header. If a domain is marked as closed, it can no longer be edited. An import of data from the stage is no longer possible for a closed domain. Validation against this Domain can still take place, but all values not found in the Domain are automatically returned as invalid. However, the Domain can be marked as open again at any time.

In order to create a Domain, click on the corresponding button in the “Build & Manage” group of the HEDDA.IO ribbon. The Create New Domain dialog will open and you have to select a Knowledge Base for the Domain, a Name, the Length of the data (for example 50 characters) and the Algorithm which should be used.

Like with the Knowledge Base, the arrow beneath the Domain button can be used to edit or delete existing Domains.

After the newly created Domain is opened, it is necessary to fill the cells in the column “Member” with data and link it to a “Master”, if required.

By doing so, the data in the column “Member” will be changed to its corresponding “Master” during the execution of the SSIS component of HEDDA.IO later on.

The easiest way to add Members or change the Master of one or more Members, is with the appropriate buttons in the “Data Tools” group. 

For deleting Members, the button is the only way to do so.

Any changes done can be saved with the “Save” button in the HEDDA.IO ribbon and with the “Refresh” button the chart will order itself anew according to the provided data.

If no further data for the Domain is expected it is possible to close the Domain and protect it against any changes. 

To do so, navigate to the arrow beneath the Domain button in the HEDDA.IO ribbon, edit the Domain intended to be closed and tag the checkbox “Closed Domain”.

Status and ValidationStatus

Each Member you add to a domain always consists of two validation values, the Status and the ValidationStatus. The status is set if you import members into a domain or copy members using the Excel Add-in and have not yet selected a ValidationStatus. If you change the ValidationStatus of a member, the Status is automatically set to Valid.

The ValidationStatus of a member, however, can have 5 different values, of which only 3 can be set actively via the drop-down menu in the cell. These values are Unknown, Valid, and Invalid.

Unknown automatically means that a member has the status New. If you set the ValidationStatus to Unknown, the status is reset to New. With Invalid, you define members that can occur but are invalid. Valid members are marked with the ValidationStatus Valid.

The two values that cannot be assigned manually are synonym and error. If you assign a master to a member, the validation status is automatically set to synonym. If a member violates an existing business rule, it is flagged as an error. Members with the status Error are excluded from validation by the API. If you have defined business rules, you should not store members in a domain that has the status error.