Agent definition templates - FAQ

How are variables handled in Agent Definition Templates?
Variables defined using the %ParameterName% format within the template can be overridden when creating new agents based on the template. You will be prompted to provide values for these variables, ensuring customization while retaining the core functionality defined in the template.

• Inheritance: Overrides cascade down from the template to the job level and then finally the sequence. If a variable is overridden at the job or sequence level, that will take precedence over any value in the template.

What happens if I update an agent definition template?
Changes made to the template will affect all agents inheriting from it. However, these changes will only be applied when an agent is restarted, resumed from a paused state, or encounters an error. This approach minimizes disruption to ongoing jobs while ensuring updates are eventually reflected across all instances.

• Editing During Runs: Edits made to a template will not affect currently running agents. They will only be applied when an agent is resumed, paused, or started again

What about changes to the agent's schema or fields?
Adding new fields to the template will dynamically add those fields to the collections of agents using the template when those agents are started or resumed. Deleting fields from the template will not automatically delete them from existing agent collections; you will need to manually remove those fields from individual agent definitions.

• Field Templates: Field templates are defined within the agent group and are not part of the definition template. Changes to field templates are not captured within the agent template definition

Are there any potential downsides to using Agent Definition Templates?
The primary consideration is that changes made to a template will eventually affect all agents derived from it. This means it is crucial to thoroughly test any changes before saving them to the template, as unintended consequences could impact multiple agents.