Template Variables

From LongJump Support Wiki
Revision as of 02:12, 11 September 2013 by imported>Aeric (→‎About Template Variables)

Template Variables are used to personalize communications from the platform.

For example, instead of a generic "Dear Sir" salutation, messages can be personalized:

"Greetings Carl! You're invited to Friday nite Yappy Hour at the Dog Owners Club! Hope to see you and Bruiser there! "

About Template Variables

Template variables embedded into HTML templates provide this kind of merge capability.

Learn more: HTML Resources

HTML templates can be used in many areas of the platform:

Context Available Variables
Print Templates
GUI Actions
Emails from Workflow Templates
See also: Processing Related Records in a Template

Template Variable Tool

Template variables have slightly different syntax in different contexts. The template variable tool gives you the possible variables, in the correct syntax for each context:

Email Templates Designer > Objects > {object} > Email Templates > {template}
Print Templates Designer > Objects > {object} > Print Templates > {template}
Actions Designer > Objects > {object} > Actions > {action} > Type:Execute JavaScript
Data Policies Designer > Objects > {object} > Data Policies > {policy} > [Add Action] > Send Email
Web Forms Designer > Objects > {object} > Web Forms > {web form} > Email Notification Details
Workflows Designer > Objects > {object} > Workflows > {workflow} > Notification Templates
Web Tabs Designer > Web Tabs > {web tab}
Components Designer > Components > {component}

In the Sales Force Automation application, to send Emails from Accounts, Contacts, and Prospects:

  • Workspace > All Items > Templates > {template}

For Service Provider emails:

  • Settings > Service Provider Settings > Manage Email Templates


Template Variable Syntax

Depending on where they are used, variables may need to be specified with braces (${variable}) or without them ($variable). (See Template Variable Resources for a list of contexts in which variables are available.)

Except for that difference, variables are standardized using the following syntax:

$objectname.fieldname
Where objectname is the name of the tab or object (Prospect, Account, Contact, etc.) and the fieldname is the name of the field (owner, description, etc.)
Second-degree Related Objects

Second-degree related objects can also be used in templates, and provide the ability to to drill down to one level of the hierarchical lookup from the object.

Second-degree related object variables are standardized using the following syntax:

$objectname.fieldname.seconddegree
Where objectname is the name of the tab or object (Prospect, Account, Contact, etc.), fieldname is the name of the field (owner, description, etc.) and seconddegree is the name of the second-degree related object
Examples
  • To include the email address of a primary contact in a prospect, use this syntax:
$prospect.primary_contact_id.email
  • To get the tax_type of an autopolicy insurer, use this syntax:
$autopolicy.insurer.tax_type
Where 'autopolicy' and 'insurer' are objects, and 'tax_type' is a field in the 'insurer' object

Template Variable Resources

Learn more about Template Variables: