Data Governance Administrator Guide > Configuring Axon > Configure Data Onboarding Rules
  

Configure Data Onboarding Rules

You can configure data onboarding rules to include or exclude objects that are onboarded from Enterprise Data Catalog to Axon. You must be an Admin or SuperAdmin user to configure data onboarding rules.
When you create, edit, and delete a data onboarding rule from the Admin Panel, Axon records the activity in Admin logs.

Creating a Data Onboarding Rule

Configure data onboarding rule parameters to apply filters while data is onboarded from Enterprise Data Catalog to Axon.
    1. From the Axon toolbar, click your user name and click Admin Panel.
    2. From the navigation pane, click Operational Management > Data Onboarding Rules.
    You can view the list of existing rules.
    3. To create a data onboarding rule, click Create.
    4. In the Definition section, enter a name and description for the data onboarding rule.
    The Name and Description fields are required.
    5. In the Rules for Onboarding section, configure the following properties:
    Context
    Specify the context based on which you want the objects to be onboarded from Enterprise Data Catalog to Axon. You can select the parent, type, or path. Parent refers to the parent of a physical field. Type refers to the class type of a physical field. Path refers to the location of a physical field.
    Regular Expression
    Enter a regular expression to specify a pattern based on which you want the objects to be onboarded from Enterprise Data Catalog to Axon. The regular expression that you enter is case-sensitive.
    To know more about the regular expressions that you can use, see Supported Characters in Regular Expressions.
    Note: If you want to enter the slash (/) in a regular expression, ensure that you first enter the backslash (\) followed by the slash (/). For example, if you select Path, enter CMAXON\/AXON_CUSTDATA in the regular expression field.
    Action
    If you want to add more rows, click +. If you want to delete rows, click -.
    If you add multiple rows in the Rules for Onboarding section, the data is onboarded based on the combination of all the conditions that you specified in the rows.
    6. In the Onboarding Rule Configuration section, select the following options:
    Requires an Associated Glossary
    If you select this option, the objects are onboarded to an Axon system only if a physical field or data domain is linked to a glossary. If you do not select this option and if a physical field is not linked to a glossary or data domain in Enterprise Data Catalog, the default glossary that is configured in the Admin Panel is used for automated onboarding of objects.
    Marked as a Key Data Element
    If you select this option, the objects are onboarded to an Axon system only if a physical field or data domain is connected to a glossary that is a key data element. If you select this option and if the default glossary configured in the Admin Panel is used for onboarding, the default glossary has to be a key data element.
    Marked as a Certified Object
    If you select this option, the objects are onboarded only if a physical field is marked as a certified object in Enterprise Data Catalog.
    Confidence Score (50 - 100)
    Enter the confidence score threshold value based on which you want to onboard the object from Enterprise Data Catalog. You can enter a value from 50 to 100. The default confidence score value is 95%.
    The confidence score value is applicable if the Requires an Associated Glossary option is selected. If the Requires an Associated Glossary option is not selected, the onboarded attribute has 100% confidence score.
    7. In the Onboarding section, configure the following properties:
    Name
    Select the name that you want to use for the onboarded attribute. You can choose to use the glossary or physical field name. The default value is "Use Glossary Name."
    Description
    Select the description that you want to use for the onboarded attribute. You can choose to use the glossary or physical field description. The default value is "Use Glossary Description."
    8. Click Save and Close.
    You can view the onboarding rule that you created.

Data Onboarding Rule Examples

You can configure data onboarding rule parameters, such as regular expressions, metadata, and glossary requirements. Based on the rule configuration, the data sets and attributes are onboarded from Enterprise Data Catalog to Axon systems.
Consider the following examples for onboarding rules:

Specify a Parent Name

The following image shows a sample onboarding rule with a regular expression for filtering objects based on a specific parent name:
The Edit Onboarding Rules page shows a regular expression for filtering objects based on a specific parent name.
Consider that you want to filter onboarding of objects based on the parent that contains "PROD" or "PRODUCTION" in the name. In this example, the onboarding rule has the following filter criteria:
Based on the rule configuration, the filter is applied on physical fields with the parent that has "PROD" or "PRODUCTION" in the name. During onboarding process, the job checks whether the physical fields are associated to a glossary and then attribute is onboarded with the glossary name and description.
To know more about the regular expressions that you can use, see Supported Characters in Regular Expressions.

Specify One or More Schemas Within a Resource

The following image shows a sample onboarding rule with a regular expression for filtering objects based on one or more schemas within a resource:
The Edit Onboarding Rules page shows a regular expression for filtering objects based on one or more schemas within a resource.
Consider that you want to filter onboarding of objects based on one or more schemas, such as LDMV1SCN, LDMV2SCN, or LDMV3SCN, within a resource. In this example, the onboarding rule has the following filter criteria:
Based on the rule configuration, the filter is applied on resources that contain schema names, such as LDMV1SCN, LDMV2SCN, or LDMV3SCN. During onboarding process, the job checks whether the physical fields are associated to a glossary and then data is onboarded with the glossary name and description.

Specify a Schema and Type

The following image shows a sample onboarding rule with a regular expression for filtering objects based on a specific schema and type:
The Edit Onboarding Rules page shows a regular expression for filtering objects based on a specific schema and type.
Consider that you want to filter onboarding of objects based on the schema name "AXON_TESTDATA" and physical field of Column type. In this example, the onboarding rule has the following filter criteria:
Based on the rule configuration, the filter is applied on resources that contain the schema name "AXON_TESTDATA" and the physical field of type "com.infa.ldm.relational.Column". During onboarding process, the job checks whether the physical fields are marked as certified objects and associated to a glossary in Enterprise Data Catalog. Then, data is onboarded with the glossary name and description.

Specify a Parent Name and Schema

The following image shows a sample onboarding rule with a regular expression for filtering objects based on a specific parent name and schema:
The Edit Onboarding Rules page shows a regular expression for filtering objects based on a specific parent name and schema.
Consider that you want to filter onboarding of objects based on the parent that contains "PROD" OR "PRODUCTION" in the name and schema name "LDMV1SCN." In this example, the onboarding rule has the following filter criteria:
Based on the rule configuration, the filter is applied on resources that contains schema name LDMV1SCN and the physical fields with the parent that has "PROD" or "PRODUCTION" in the name. During onboarding process, the job checks whether the physical fields are marked as certified objects in Enterprise Data Catalog. Because the physical field to glossary association is not required for onboarding process, the default glossary specified in the Admin Panel is used for onboarding objects if there are no glossaries associated to physical fields. If the default glossary is a key data element, then data is onboarded with the physical field name and description.

Supported Characters in Regular Expressions

You can use the following characters in the regular expression that you define in a data onboarding rule:
Character
Function
$
Matches the end of the input.
(?:x)
Matches the value "x" but does not remember the match.
(x)
Matches the value "x" and remembers the match.
*
Matches zero or any number of occurrences of the preceding element. For example, xy*z matches "z", "xz", "xyz", and "xyyz".
+
Matches 1 or any number of occurrences of the preceding element. For example, xy+z matches "xyz", "xyyz", and "xyyyz".
.
Matches any single character except for newline characters.
?
Matches zero or one occurrence of the preceding element. For example, flavo?r matches both "flavour" and "flavor" but it does not match "flavoour".
[\b]
Matches a backspace.
[^abc]
Matches anything that is not enclosed in the brackets.
[abc]
Matches any of the enclosed characters.
You can create range of characters using the hyphen (-) character, such as A-Z (A to Z). In character sets, special characters, such as ., *, and +, do not have any special meaning.
\
  • - Indicates that the next character must not be literally interpreted. For example, the character "w" is interpreted as match the character "w". If you use "\w", it matches an alphanumeric character including the underscore (_).
  • - Indicates that a metacharacter must be literally interpreted. For example, the "." metacharacter indicates to match any single character but with a new line. If you use "\.", it matches the dot (.) character.
\0
Matches a null character.
\b
Matches a word boundary. Boundaries are determined when a word character is neither followed nor preceeded by another word character.
\B
Matches a non-word boundary. Boundaries are determined when two adjacent characters are word characters or non-word characters.
\cX
Matches a control character. The character "X" must be included within A to Z.
\d
Matches a digit character. For example, you can enter [0-9] or [0123456789].
\D
Matches a non-digit character. For example, you can enter [^0-9] or [^0123456789].
\s
Matches a single white space character. This includes a space, tab, form feed, and line feed.
\S
Matches anything other than a single white space character. It matches anything other than a space, tab, form feed, and line feed.
\t
Matches a tab.
\w
Matches any alphanumeric character including the underscore (_). For example, it matches [A-Za-z0-9_].
\W
Matches anything other than an alphanumeric character including the underscore (_). For example, it matches [^A-Za-z0-9_].
^
Matches the beginning of the input.
x(?!y)
Matches the character "x" only if "x" is not followed by character "y".
x(?=y)
Matches the character "x" only if "x" is followed by character "y".
x|y
Matches either the character "x" or "y".
{n,m}
Matches the preceding character at least "n" times and at the most "m" times. If the values of "n" and "m" are zero, they are omitted.
{n}
Matches the preceding character exactly n times.