Active Tag Administration

Active Tag Configuration

In the visualization, active tags are assigned to the nodes based on node attributes. Each active tag is configured with an attribute that is defined by tagAttribute and, optionally, with its value pattern defined in displayIfValueMatches. If a node has this attribute (and matches the value pattern, if it is configured), the active tag will be displayed on the node.

Active tags are configurable in the Admin UI.

Configuring Active Tags

Go to Admin UI in Configuration > Server > Common > Active Tags.
Edit the configuration.

Active Tag Configuration Structure

The configuration is a JSON file which contains an object, where the keys are active tag names and the values are objects with a structure as described in the following table.

Property	Format	Description	Optional
iconDisplayType	`displayLabel` or `displayValue`	When set to: `displayLabel`, the value of the configured property `displayLabel` will be shown in the active tag icon. `displayValue`, the value of the node’s attribute with a name that is equal to the value of the configured property `tagAttribute` will be shown.
tagAttribute	String	Name of the node’s attribute, which determines whether the active tag is displayed in the lineage for the node. If the property `displayIfValueMatches`is not configured, the active tag is displayed for each node, which has this attribute. Note: Multiple active tags can be attached to the same `tagAttribute` to allow different visual formatting based on the underlying value; for example, <50% display in red, >50% display in green.
displayIfValueMatches	String (contains a regular expression)	When this property is configured, the active tag is displayed for a node if the node has the `tagAttribute` with a value that matches the regular expression of this property.	Yes
displayIfLayerIn	Array of strings	When this property is configured, the active tag is displayed for a node if the node belongs to one of the configured layers.	Yes
displayLabel	String (max. 3 letters)	This value is used as a value of the node active tag icon label if `iconDisplayType` is configured with the value `displayLabel`. It is also used as a value of the summary active tag icon label regardless of the `iconDisplayType`.
bgColor	String containing hexadecimal color value `#XXXXXX`, (X can be 0-9 or A-F)	Specifies the background color of the active tag icon.
color	String containing hexadecimal color value `#XXXXXX`, (X can be 0-9 or A-F)	Specifies the text color and border color of the active tag icon.
urlPattern	String	This can be used to specify a pattern for the link to the third-party tool that is shown in the active tag tooltip. It can be parametrized the same way the `link_template` is in this documentation. This property is optional. Alternatively, the `urlAttribute` can be used to display the link to the third-party tool. Example: `https://dqtool.com/instance/custom_page?database_parameter={database,id,default_database}&node={node.name}`	Yes
urlAttribute	String	This can be used to specify the node attribute which contains the link to the third-party tool that is shown in the active tag tooltip. It can be used instead of the `urlPattern`. This property is optional. If it is not set, the `urlPattern` is used instead. If neither property is configured, the link is not displayed in the tooltip.	Yes
urlLabel	String	This value is used as the label of the link to the third-party tool in the tooltip. If it is not set, the URL itself is displayed as the link label.	Yes
displayValue	`true` or `false`	When set to: `true`, the attribute name of `tagAttribute` and its value will be displayed in the tooltip. `false`, neither the attribute name nor value will be displayed in the tooltip details.
displayAttributes	Array of strings	A list of specified attributes and their values will be displayed in the tooltip if the property is configured.	Yes

Configuration Example

Note: The inline comments here such as // < 50% are just for illustration. They’re not part of valid JSON and must be removed before using this example in Manta.

{
  "DATA_QUALITY_ISSUE_LOW" : {
    "iconDisplayType": "displayValue",
    "tagAttribute": "DATA_QUALITY_ISSUE",
    "displayIfValueMatches": "^[1-4]?[0-9]%$", // < 50%
    "displayIfLayerIn": [
      "Physical",
      "Logical"
    ],
    "displayLabel": "DQ", // show for summary tag value
    "bgColor": "#eb0e28",
    "color": "#FFFFFF",
    "urlPattern": "https://dqtool.com/instance/custom_page?database_parameter={database,id,default_database}&node={node.name}",
    "urlLabel": "Data quality tool",
    "displayValue": "true",
    "displayAttributes": ["ID", "NAME", "DESC"]
  },
  "DATA_QUALITY_ISSUE_HIGH" : {
    "iconDisplayType": "displayValue",
    "tagAttribute": "DATA_QUALITY_ISSUE",
    "displayIfValueMatches": "^100%|[5-9][0-9]%$", // >= 50%
    "displayLabel": "DQ", // show for summary tag value
    "bgColor": "#218032",
    "color": "#FFFFFF",
    "urlPattern": "https://dqtool.com/instance/custom_page?database_parameter={database,id,default_database}&node={node.name}",
    "urlLabel": "Data quality tool",
    "displayValue": "true",
    "displayAttributes": ["ID", "NAME", "DESC"]
  },
  "PERSONALLY_IDENTIFIABLE_INFORMATION" : {
    "iconDisplayType": "displayLabel",
    "tagAttribute": "PERSONALLY_IDENTIFIABLE_INFORMATION",
    "displayLabel": "PII",
    "bgColor": "#0c67ad",
    "color": "#FFFFFF",
    "urlAttribute": "CUSTOM_ATTRIBUTE_WITH_URL",
    "urlLabel": "Show more information",
    "displayValue": "true",
    "displayAttributes": ["ID", "NAME", "DESC"]
  }
}

Troubleshooting

In case of any issues with the active tag configuration, they will be logged to the Manta Server log right after server startup with an explanation of what is misconfigured.

If the structure of the JSON file is broken, all active tags are unavailable. If some active tags are misconfigured (for example, provide a bad value or are missing a required property), only the misconfigured ones are unavailable.

Displaying active tags in the Data Lineage

The first image illustrates summary tags — icons and a tooltip with summary information.

The second image illustrates the node’s active tags with icons (containing a label if there is PERSONALLY_IDENTIFIABLE_INFORMATION and a value if there is DATA_QUALITY_ISSUE_LOW or DATA_QUALITY_ISSUE_HIGH from the preceding example configuration) and a tooltip with detailed information.

There are two images: the one at the top shows icons and a tooltip with summary information and the second one shows node's active tags with icons