Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Templates let you use the data stored in your AgileCase system to automatically populate documents.

Basics of AgileCase Token Syntax

All templates share the same syntax for including fields from your Work Item (Case, Contact, etc.) which is simply a fielname included within double curly braces. For example:

{{fieldname}}

The above is a Field Token which simply outputs the value of that Field from your Work Item. You can find the fieldname for every peice of data within the “View Merge Fields” option of a Work Item. (You can see an example of that here: Creating your Document Template)

There are also many advanced tokens, for example the IF token allows you to optionally include some text within your document like this:

{{ IF relationships.client.description = ACME Limited }} The content you want to see if the condition is true. {{/IF}}

There are many more advanced tokens to discover which let you output special values such as current user name, or format values in different ways such as outputting a number in words. These are described later in this guide.

Creating your Document Template

Open Microsoft Word (or other compatible Word Processor) and load the document that you are going to turn into a Template for use on AgileCase.

Alongside this, open AgileCase, locate a Case that contains the information that you’d like to populate your Template with.

...

The document is now ready to be printed, emailed, or shared within AgileCase.

...

View Merge Field

...

Helper

Using the “View Merge Fields” helper tool allows you to see every piece of stored information that is held within a Case within AgileCase.

There are three options within this tool that you can use to help you with your day-to-day work.

  1. Merge Fields. This is the most commonly used option where users can locate a field from within their system and use the Copy option to store the location of that Field for use inside document, email, SMS and other types of Template.

  2. XML View. This view shows all of the Case Data available on the Merge Fields page but as an XML file which can be used when integrating with other systems, or exporting the data for use elsewhere.

  3. JSON View (Coming Soon). Similar to the XML View, the JSON View gives you access to the same information except in a JSON format which many systems now use as their primary import / export mechanism.

...