Overview

What are Tool Tags?

Tags are key-value pairs that can be attached to tool data reads. They help organize, categorize, and search tool usage data more effectively.

There are two distinct concepts:

Tag Definitions - The schema that defines what tags exist, their types, and validation rules
Tag Values - The actual values assigned to a specific tool data read

info

Users cannot create new tag definitions. Tag definitions are managed by the JEDI team. Users can only assign values to existing pre-defined tags.

The JEDI team maintains the Tag Management System within QuickLink.

This system is comprised of:

Why this matters

A standardized tagging system allows us to organize and search tool usage data effectively across the entire platform

Tags are categorized by how they receive values:

These are automatically populated when a data read is uploaded. You cannot modify system-generated tags.

Tag Name	Type	Description
`EXTERNALID`	string	An external reference ID for this tool read, typically the SV Code
`PROJECTNUMBER`	string	The VPIN/VIPER project number for this tool
`ENVIRONMENT`	string	Indicates whether the read was performed in Test or Production
`LOCATION`	string	Geographic location derived from client info
`PLATFORM`	string	Tool platform name (e.g., M18, M12, MX)
`SOURCE`	string	Origin/description of the data source
`CUSTOMER`	object	Customer details with `NAME` and `CRMNUMBER` fields
`SOURCEREGION`	enum	Geographic region: `ANZ`, `EMEA`, `AP`, or `NA`
`QUICKLINKUSERMODE`	enum	QuickLink user mode (e.g., `Engineer`, `Technician`, `OrderEntry`)
`TOOLREADSESSIONID`	string	Associates toolreads from products with multiple uploads (e.g., chargers)
`SOURCE-BACKFILL`	boolean	Tracks imported toolreads from backfill script
`REPROCESSED`	boolean	Tracks reprocessed toolreads

Users with the Engineering role can manually assign values to these pre-defined tags:

Tag Name	Type	Description
`NOTES`	string	Free-form notes for this ToolRead
`MEMORYRESET`	boolean	Tracks data at time of memory ('trip odometer') reset
`STRINGTAGEXAMPLE`	string	Example string tag (for testing)
`NUMBERTAGEXAMPLE`	number	Example number tag (for testing)
`BOOLEANTAGEXAMPLE`	boolean	Example boolean tag (for testing)
`ENUMTAGEXAMPLE`	enum	Pick from: `element1`, `element2`, `123`, `true`
`ARRAYTAGEXAMPLE`	array	Array of strings
`OBJECTTAGEXAMPLE`	object	Fields: `STRINGPROP`, `BOOLEANPROP`, `NUMBERPROP`

For Developers

For programmatic access to tags, see the Tool Data API: