Configuring Analytical Attributes to Hold Validation Warnings
Analytical attributes are used as a placeholder to store and retrieve the data validation exceptions.
The
attributeValidations analytical attribute must be appended to the existing
entity type under the analyticsAttributes section as shown
below.Note: Do not delete if any configuration is already available.
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, that attribute must
be updated to meet the validation function. The analytical attribute stores the
following data of the attribute and the same data is displayed in the
Profile facet of Hub:
- The attribute that failed the validation functions
- The action (WARNING) for the failed validation function
- The message associated with the validation function
- The name of the validation function
- The function URI
The analytical attribute only stores the data for the initial scenario when the attribute had failed the validation function and does not store any data about the update made to meet the failed validation function.
After you make the update, the analytical attribute behaves in one of the following
ways:
- If the failed validation function is met, the analytical attribute is deleted.
- If the update leads to the failure of any other validation function, the analytical attribute displays a new set of data consisting of the attribute that failed the validation function, action for the failed validation, message, function name, and function URI.
Note: Data validation function is only applicable for Operational Values
(OVs).
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
{
"uri": "configuration",
"description": "New Sales Account360",
"schemaVersion": "xxx",
"sources":[........],
.......
"entityTypes":[
{
"uri": "configuration/entityTypes/Product",
"label": "Product",
"attributes":[................],
"analyticsAttributes":[
......
{ "uri": "configuration/entityTypes/<ENTITY_TYPE>/analyticsAttributes/AttributeValidations", "label": "Attribute Validations", "description": "Attribute Validations", "name": "AttributeValidations", "type": "Nested", "maxOccurs": 1000, "couldUpdateWithLCA": true, "dataLabelPattern": "{Message}", "analyticsAttributes": [ { "uri": "configuration/entityTypes/<ENTITY_TYPE>/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/<ENTITY_TYPE>/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/<ENTITY_TYPE>/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/<ENTITY_TYPE>/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/<ENTITY_TYPE>/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/<ENTITY_TYPE>/analyticsAttributes/AttributeValidations/analyticsAttributes/Message", "label": "Message", "description": "Attribute Validation Message", "name": "Message", "type": "String", "maxOccurs": 1000, "faceted": true, "searchable": true } ] }
]
]
........
}