Skip to content

Tag Extraction

Purpose

The Tag Extraction screen in Clarity Transform has the header Tag Extraction Mappings. Its description reads: "Configure how JSON tags stored in your asset tables are extracted and written to specific database columns. Select an asset table, scan for tag keys, map each key to a target column, then save. Use Run Now to execute immediately or rely on the daily scheduled background job."

Data moves from the JSON tags on asset records into database columns. The screen does not create Clarity Tags; those are defined on Settings → Field Management → Clarity Tags.

Where to find it

Settings → Field Management → Tag Extraction

What you see

Fields

  • Asset Table: a card with a select, Select an asset table.... It has 33 options: Application, Application Service, Blueprint, Cluster, Container Cluster, Container Config Map, Container Crd, Container Helm Release, Container Manifest, Container Namespace, Container Node, Container Secret, Container Service, Container Workload, Database, Database Instance, Datacenter, Device, Firewall Ip Set, Firewall Rule, Firewall Security Group, Firewall Service, Host, Load Balancer, Load Balancer Virtual Service, Network, Relationship, Route, Storage, Subnet, User, Vpn Tunnel, Website.

Actions

  • Scan Tags
  • Save Mappings
  • Run Now

All three buttons are disabled until a table is selected in Asset Table. Selecting a table makes Scan Tags and Run Now available. Save Mappings becomes available once the table's saved mappings have loaded or a scan has found tag keys.

Run Now does not depend on the table selected. It applies the saved mappings for every asset table, and changes you have not saved are not applied. The screen has no grid toolbar and no create or edit form.

Tag Key to Column Mappings

This section shows a mappings badge in the form "N mappings" and a search box with the placeholder Search for a tag key.... Until keys have been scanned, it shows the hint: "Select an asset table and click Scan Tags to discover available tag keys."

The screen also has a results dialog, Tag Extraction Results, which you close with Close.

How to

Map tag keys to columns and run the extraction

The screen description gives this order.

  1. Go to Settings → Field Management → Tag Extraction.
  2. In Asset Table, select a table, for example Device. Scan Tags and Run Now become available. If the table already has saved mappings, Clarity shows them ("Loaded N saved mapping(s). Use Scan Tags to discover new tag keys.") and Save Mappings becomes available too.
  3. Select Scan Tags. Clarity lists each tag key it finds ("Found N tag keys (M new). Save to persist changes."). Nothing is kept until you select Save Mappings.
  4. In Tag Key to Column Mappings, each key has a Target Column list. New keys are set to Not mapped. Choose the column for each key you want to keep. Each target column can be used by only one key. If two keys map to the same column, Clarity does not save: "Multiple tag keys are mapped to the same target column. Each column can only be used once."
  5. Select Save Mappings. Do this before Run Now, which uses only saved mappings.
  6. Select Run Now to run the extraction immediately. It applies the saved mappings for every asset table, not only the one selected, and the Tag Extraction Results dialog reports the tables processed. The screen description also mentions a daily scheduled background job, but Settings → System → Background Jobs lists no tag extraction job.
  • Clarity Tags: Clarity Tags are defined there. Tag Extraction does not create them.
  • Background Jobs: the scheduled jobs list. It has no tag extraction job.
  • CMDB: the asset records whose tags are extracted.