Configuring Analytical Attributes to Hold Validation Warnings
Analytical attributes are used as a placeholder to store and retrieve the data validation exceptions.
attributeValidations analytical attribute must be appended to the existing entity type under the analyticsAttributes section as shown below.Analytical Attributes
Analytical attributes are the properties of an entity. There are two types of analytical attributes, simple and nested. Nested attributes contain a set of analytical attributes using which, complex structures can be formed. Analytical attributes can contain multiple values, the maximum number of values is limited by maxOccurs property. A lightweight special kind of attributes, generally used to hold analytics results. For more information about analytical attributes, see Configuring Analytic Attributes.
Working with Analytical Attributes
When an attribute fails a validation function for an attribute, update the attribute to meet the validation function. The analytical attribute stores information about the failed validation. The same information appears in the Profile facet of Hub:
- The attribute that failed validation
- The action for the failed validation function (
WARNING) - The validation message
- The validation function name
- The function URI
The analytical attribute stores only the information from the initial validation failure. It does not store information about the update you make to correct the attribute.
If multiple validation functions fail for the same attribute, Reltio stores the results in a single AttributeValidations object rather than creating a separate object for each validation function.
After you update the attribute:
- If the attribute passes the failed validation function, the analytical attribute is deleted.
- If the update causes another validation function to fail, the analytical attribute is updated with information about the new failure, including the attribute, action, message, function name, and function URI.
Sample Showing the Placeholder to Add the Analytical Attribute for Attribute Validation
{
"uri": "configuration",
"description": "New Sales Account360",
"schemaVersion": "xxx",
"sources":[........],
.......
"entityTypes":[
{
"uri": "configuration/entityTypes/Product",
"label": "Product",
"attributes":[................],
"analyticsAttributes":[
......
<<ADD HERE>>
]
]
........
}Sample Configuration
{
"entityTypes": [
{
"uri": "configuration/entityTypes/Product",
"label": "Product",
"description": "Product entity type details",
"abstract": true,
"attributes": [
{
"name": "Primary",
"type": "String",
"uri": "configuration/entityTypes/Product/attributes/Primary"
}
],
"lifecycleActions": {
"beforeSave": [
"Reltio/DVFAction"
],
"validate": [
"Reltio/DVFAction"
]
},
"analyticsAttributes": [
{
"uri": "configuration/entityTypes/Product/analyticsAttributes/AttributeValidations",
"label": "Attribute Validations",
"description": "Attribute Validations",
"name": "AttributeValidations",
"type": "Nested",
"maxOccurs": 200,
"couldUpdateWithLCA": true,
"dataLabelPattern": "{action}: {message}",
"analyticsAttributes": [
{
"uri": "configuration/entityTypes/Product/analyticsAttributes/AttributeValidations/analyticsAttributes/FunctionURI",
"label": "Function URI",
"description": "Function URI for which validation has failed.",
"name": "FunctionURI",
"type": "String",
"maxOccurs": 1000,
"faceted": true,
"searchable": true
},
{
"uri": "configuration/entityTypes/Product/analyticsAttributes/AttributeValidations/analyticsAttributes/FunctionName",
"label": "Function Name",
"description": "Name of the Function for which validation has failed.",
"name": "FunctionName",
"type": "String",
"maxOccurs": 1000,
"faceted": true,
"searchable": true
},
{
"uri": "configuration/entityTypes/Product/analyticsAttributes/AttributeValidations/analyticsAttributes/Expression",
"label": "Expression",
"description": "Expression of the Function for which validation has failed.",
"name": "Expression",
"type": "String",
"maxOccurs": 1000,
"faceted": true,
"searchable": true
},
{
"uri": "configuration/entityTypes/Product/analyticsAttributes/AttributeValidations/analyticsAttributes/Attribute",
"label": "Attribute Name",
"description": "Name of the Attribute for which validation has failed.",
"name": "Attribute",
"type": "String",
"maxOccurs": 1,
"faceted": true,
"searchable": true
},
{
"uri": "configuration/entityTypes/Product/analyticsAttributes/AttributeValidations/analyticsAttributes/Action",
"label": "Action Type",
"description": "Action type: Warning / Reject / Workflow",
"name": "Action",
"type": "String",
"maxOccurs": 1,
"faceted": true,
"searchable": true
},
{
"uri": "configuration/entityTypes/Product/analyticsAttributes/AttributeValidations/analyticsAttributes/Message",
"label": "Message",
"description": "Attribute Validation Message",
"name": "Message",
"type": "String",
"maxOccurs": 1000,
"faceted": true,
"searchable": true
},
{
"uri": "configuration/entityTypes/Product/analyticsAttributes/AttributeValidations/analyticsAttributes/Sources",
"label": "Sources",
"description": "Sources to be applied",
"name": "Sources",
"type": "Nested",
"maxOccurs": 1000,
"faceted": true,
"searchable": true,
"analyticsAttributes": [
{
"uri": "configuration/entityTypes/Product/analyticsAttributes/AttributeValidations/analyticsAttributes/Sources/analyticsAttributes/CrosswalkName",
"label": "Crosswalk Name",
"description": "Crosswalk Name for which validation has failed.",
"name": "CrosswalkName",
"type": "String",
"maxOccurs": 1000,
"faceted": true,
"searchable": false
},
{
"uri": "configuration/entityTypes/Product/analyticsAttributes/AttributeValidations/analyticsAttributes/Sources/analyticsAttributes/CrosswalkValue",
"label": "Crosswalk Value",
"description": "Crosswalk Value for which validation has failed.",
"name": "CrosswalkValue",
"type": "String",
"maxOccurs": 1000,
"faceted": true,
"searchable": true
}
]
}
]
}
]
}
]
}