This article explains how to configure Tracking Attributes in Custom Document Agents to automatically capture specific values during document generation, enabling reporting on agent usage and the business context associated with generated documents.
Prerequisites
|
What are Tracking Attributes?
Tracking Attributes allow administrators to define specific information that a Custom Document Agent should identify and record when generating a document.
Each Tracking Attribute consists of:
- Attribute name: The name of the information to be tracked, such as "Opportunity ID" or "Industry".
- Instructions: Guidance explaining how the agent should identify the attribute value, such as "Find the Opportunity ID from the brief or Salesforce".
- Fixed values (optional): A predefined set of values that the agent should look for.
- Allow other values (optional): Allows the agent to return values outside the predefined list.
When a document is generated, the agent automatically searches the available information for the configured attributes and records the identified values.
If an attribute value cannot be identified, it is recorded as Unknown.
Tracked information can be used for reporting and analysis, such as identifying which opportunities or industries generated documents through a Custom Document Agent.
How to configure Tracking Attributes
- Navigate to the Custom Document Agent you want to configure.
- Open the agent's configuration page.
- Under Settings, locate Tracking Attributes.
- Click Add attribute.
- Enter the Attribute name, for example "Opportunity ID".
- In Instructions, describe how the agent should identify the value, for example "Find the Opportunity ID from the brief or Salesforce".
- Optionally, define Fixed values if the attribute should look for specific predefined values.
- If the agent should also be able to return values outside the predefined list, enable Allow other values.
- Save the configuration.
The agent will automatically attempt to identify the configured Tracking Attributes during subsequent document generations.
How Tracking Attributes work
When a Custom Document Agent generates a document, it automatically evaluates the configured Tracking Attributes against the information available to it.
For each attribute, the agent:
- Uses the administrator-defined instructions to determine what information to look for.
- Searches the available information for the relevant value.
- Records the identified value, taking any configured fixed values into account.
- Records Unknown if no matching value can be identified.
The tracked information is recorded automatically and does not require the end user to provide additional input specifically for tracking.
Using fixed values
Administrators can define a set of fixed values for a Tracking Attribute.
For example, an attribute named Industry could have the following fixed values:
- Financial Services
- Healthcare
- Manufacturing
The agent searches the available information for these values based on the configured instructions.
If Allow other values is enabled, the agent can also record a value outside the predefined list, such as "Retail", when identified.
If Allow other values is disabled, the agent is restricted to the configured fixed values.
Tracking Attribute examples
Example 1: Tracking Opportunity IDs
An administrator wants to track which sales opportunities are associated with documents generated by a Custom Document Agent.
| Configuration | Value |
|---|---|
| Attribute name | Opportunity ID |
| Instructions | Find the Opportunity ID from the brief or Salesforce |
| Fixed values | None |
If the agent identifies Opportunity ID OPP-12345, this value is recorded for reporting.
If no Opportunity ID can be identified, the value is recorded as Unknown.
Example 2: Tracking industries
An administrator wants to understand which industries are associated with documents generated by an agent.
| Configuration | Value |
|---|---|
| Attribute name | Industry |
| Instructions | Identify the customer's industry from the available information |
| Fixed values | Financial Services, Healthcare, Manufacturing |
| Allow other values | Enabled |
If the available information identifies the customer as operating in Retail, the agent can record Retail, even though it is not one of the predefined values.
How to access tracked information
Tracking Attribute values are automatically recorded as part of the document generation events and made available for reporting.
The tracked information is not displayed in the Templafy web app or Admin Center.
To access insights or reports based on Tracking Attributes, contact your Templafy contact, who can arrange for the relevant data to be provided.
Important
|
Comments
Article is closed for comments.