Variable and Field List Reference

Variables and standard fields merge stored data into a UTA/module, including custom field syntax, list syntax, contact and account fields, provider and consumer fields, and date and time formatting. Use this article to look up the correct syntax for a specific variable or field.

Current User Variables

The following variables return information about the current user. In these variables, me refers to the user who is currently logged in.

↑ Back to top

UTA/Module Level 1 Variables

The following variables return standard field data from a UTA/module Level 1 record. The same variables apply to Sales Opportunity and Job records.

↑ Back to top

UTA/Module Level 2 and Activity Variables

The following variables return standard field data from a UTA/module Level 2 (Activity) record.

↑ Back to top

Custom Field and Cross-Level Variables

Custom field variables retrieve stored data by name or ID, and cross-level variables call a field from a related record at a different level.

Custom Field Variables

Use the following variables to retrieve custom field data by field name or by field ID.

Call Fields Across Levels

Field data can be called from a higher level when the source field is on a lower-level record. All field names must be entirely lowercase.

Level 1 fields called from Level 2:

@parent.fieldname@ / {{parent.fieldname}}
@parent.#fieldid#@ / {{parent.#fieldid#}}
Example: @parent.status@, @parent.startdate@, or @parent.#12345#@.

Level 2 fields called from Level 3:

@parent.fieldname@ / {{parent.fieldname}}
@parent.#fieldid#@ / {{parent.#fieldid#}}

Level 1 fields called from Level 3:

@parent.parent.fieldname@ / {{parent.parent.fieldname}}
@parent.parent.#fieldid#@ / {{parent.parent.#fieldid#}}

Associated Parent (linkparent)

Where Payment Allocation is enabled, there are two models to choose from before configuring. Usually the Associated Parent is a Funding Stream or Overall Budget (event), and the associated object is the Disbursement (Level 3). In less granular cases, the Associated Parent is the opportunity.

When Payment Allocation is enabled, fields from the Associated Parent can be pulled using:

@linkparent.fieldname@ / {{linkparent.fieldname}}

If the associated payment is linked to the event, fields from the opportunity can be pulled using:

@linkparent.parent.fieldname@ / {{linkparent.parent.fieldname}}

Example: @linkparent.parent.branch@ returns the value SmartSimple Inc.

To pull a field on the company or branch:
@linkparent.parent.branch.Transit@ / {{linkparent.parent.branch.Transit}}

↑ Back to top

Contact and Account Variables

The following variables return contact and account data, organized by the relationship to the record.

Use @client.categoryids@ / {{client.categoryids}} to return a comma-delimited list of category IDs with a leading comma, for example ,1234,555,666, and use @client.categories@ / {{client.categories}} to return a comma-delimited list of category names, for example Agency, Marketing, Good client.

Level 1 Contacts and Accounts

Individual
To display information for a single contact or account in the Level 1 contacts and accounts section:

@contact.rolename.fieldname@ / {{contact.rolename.fieldname}}
@company.rolename.fieldname@ / {{company.rolename.fieldname}}

Where rolename is the role assigned to the contact or account on the Level 1 item, and fieldname is the field located on the contact's record. For example: @contact.adjuster.firstname@ / {{contact.adjuster.firstname}} or @company.funding agency.address@ / {{company.funding agency.address}}.

List
To display a list of multiple contacts or accounts in the Level 1 contacts and accounts section:

[#(?object=contact) ~fieldname~ #] or [#(?object=company) ~fieldname~ #]

• To display the role assigned on the Level 1 record, use ~role~.
• To display the contact's company name, use ~companyname~.

Level 2 Contacts and Accounts

Individual contact
To display information for a single contact in the Level 2 contacts section:

@contacts.rolename.fieldname@ / {{contacts.rolename.fieldname}}
Example: @contacts.adjuster.firstname@ / {{contacts.adjuster.firstname}}

Contact lists

[#(?object=contact) ~firstname~ ~lastname~ ~email~ #]

To display only contacts with a specific role (relevant only when the Level 2 Multiple Contact List is enabled):
[#(?object=contact::criteria=roleid=12345) ~firstname~ ~lastname~ ~email~ #]

To display the contact's profile status:
[#(?object=contact) ~firstname~ ~lastname~ ~ustatusid~ #]

• Contacts at Level 2 cannot be filtered by rolename, only by roleid.
• If the multiple contact list is enabled, use ~role~ to display the assigned role.

Accounts
To display information for a single account in the Level 2 accounts section:

@companies.rolename.fieldname@ / {{companies.rolename.fieldname}}

To display a list of the companies assigned at Level 2:
[#(?object=company::orderby=name)~name~ #]

Company Role and Contact Role Custom Fields

To display Level 1 Company Role or Contact Role custom fields:

[#(?object=company;)$?opc_customfieldid$#]
[#(?object=contact;)$?opr_customfieldid$#]

Where customfieldid is the numeric ID of the custom field.

Contact detail example

~uprefix~ ~firstname~ ~lastname~
~uaddress~ ~uaddress2~
~ucity~, ~ustate~ ~upostalcode~

Company and Contact Association Fields

To extract information on the entity to which a record is associated:

[#(?object=association)~name~ ~standard field name~ $?afc_custom field id$ $?afc_custom field name$#]
[#(?object=companyassociation)~standard field name~ $custom field id$ $custom field name$#]

• Standard field name is the name of the standard field.
• Custom field id is the numeric ID of the custom field.
• Custom field name is the name of the custom field.

To extract information on fields that are on the intersection rather than the associated entity:

[#(?object=association) ~afcompanyid~ #]
[#(?object=companyassociation)~afroleid~ #]

Other intersection-specific variables:

Role-Based Custom Fields

When a custom field such as a Web Page View or MS Word Merge is located on a User Role or Company Role, the following can be accessed:

To refer to a User Role based custom field from a UTA/module Level 1 record, use @owner.fieldname@ / {{owner.fieldname}} for the owner, @person.fieldname@ / {{person.fieldname}} for the person, and @contact.rolename.fieldname@ / {{contact.rolename.fieldname}} for a contact, where rolename is the role they are assigned on the Level 1 record.

↑ Back to top

Standard Field Name Lists

The following standard field names are available for People, Company, and Lead records.

People Fields

firstname, lastname, fullname, title, email, phone, company, address, address2, city, province, state, country, postalcode, owner, modifieddate, cost, costunit, type, resourcename, isresource, uprefix (prefix), usuffix (suffix), and uphoneext (Phone Extension).

Company Fields

name, address, address2, city, province, state, country, postalcode, phone, fax, and website.

Lead Fields

status, description, name, phone, fax, address, address2, city, state, province, country, postalcode, website, firstname, lastname, contactphone, title, email, and dat_added.

↑ Back to top

List Syntax

List syntax displays a list of related objects, such as activities, notes, transactions, contacts, companies, consumers, or providers.

[#(?object=objectname::{options})~standardfieldname~ $customfieldname$#]

Where objectname is the type of item to list. Available objects are address, activity, assign, contact, user, group, company, notes, association, companyassociation, transaction, timesheet, level-1, utaproviderL1, utaproviderL2, utaconsumerL1, utaconsumerL2, and linkactivity. standardfieldname is a standard field (between tildes, ~). customfieldname is a custom field (between dollar signs, $).

• Custom fields can be referenced by ID instead of name, still between dollar signs ($12345$).
• Level-1 can only be used as an object when referenced from a contact record, and lists only the Level 1 records the contact has been added to in the contacts section.
• Text can be included along with variables within the [#...#] syntax.
• For Web Page Views and Read Only - System Variable fields, HTML table formatting is usually included within the [#...#] syntax. For MS Word Merge custom fields, the table is defined on the MS Word Template document, with columns delimited by pipes (|) within the [#...#].
• ~Index~ (uppercase I) numbers the lines starting at 1; ~index~ (lowercase i) starts at 0. ~Index~ does not work for all lists, for example it cannot be used when listing contacts associated with a Level 1. ~eventid~ displays the ID of the Level 2.

List Options

List Syntax Examples

To generate a list of Level 2 activities for an MS Word Merge:

[#(?object=activity)|~statusname~|~typename~|$speciality$|$123456$|#]

To reference the Consumer Level 1 owner name and owner ID from a Provider Level 1 Read Only - System Variable custom field:

[#(?object=utaconsumer::criteria=statusname IN ('Placed','Resigned/Terminated'))~ownername~,~ownerid~ #]

To display a custom field value from an invoice (object appliedtoinvoices), referencing the custom field by number only:

[#(?object=appliedtoinvoices)$282588$#]

To list Level 2 (or Level 3) activities sorted by Start Date in descending order:

[#(?object=activity::orderby=startdate desc)~subject~ ~location~ ~startdate~#]

To list contacts assigned to a Level 1 with the role Internal People, sorted by last name:

[#(?object=contact::orderby=lastname::criteria=rolename='Internal People')~firstname~ ~lastname~ ~email~#]

To list the Level 1 records, including owner details, that a company has been assigned to:

[#(?(object =level-1) NAME: ~name~ OWNERID: ~ownerid~ OWNERNAME: ~ownername~ #]

To display the Level 1 ID of the Level 1 records:

[#(?(object =level-1) OPPORTUNITY ID: ~op.opportunityid as oppid~ #]

For a list of all companies that the owner of a record is associated with:

@owner.[#(?object=association)~name~ (Phone ~phone~)#]@

To get a comma-separated list of the company IDs of all companies the current user is associated with under role ID 54545:

@me.[#(?object=association::criteria=roleid=54545)~afcompanyid~,#]@

For a list of all contacts associated to the current user's parent company record (role ID 12345):

@me.parent.[#(?object=association::criteria=roleid='12345')~firstname~ ~lastname~ (Phone ~phone~)#]@

For a list of a company's active associations (current date is between the start and end dates):

[#(?object=association::criteria=(afstartdate is null OR afstartdate<='@date(currentdate)@') AND (afenddate is null OR afenddate>='@date(currentdate)@'))~userid~,#]

For a list of all contacts or users located under a company with a given role:

[#(?object=user::criteria=rolelist like '%,12345,%') ~email~ #]

To count the number of contacts assigned the role Reviewer:

[#(?object=contact::criteria=rolename="Reviewer"::groupfunction=count)~userid~#]

To include and format a date stored in a custom field:

[#(?object=activity)<!--@sscalculation(date_format("$fieldname$","%M %d, %Y"))-->#]

With multiple criteria:

[#(?object=contact::criteria=(rolename='External' or rolename='Internal'))~firstname~ ~lastname~#]

With multiple orderby criteria:

[#(?object=activity::orderby=tbl_1765133.valuestr desc, tbl_1765119.valuestr desc)~type~, $1765133$, $1765119$<br />#]

To sort descending by a custom field called Total Hours with a custom field ID of 67292 ($Total Hours$ could also be written $67292$):

[#(?object=activity::orderby=tbl_67292.valuestr desc)Subject: ~subject~ Total Hours: $Total Hours$ Start Date: ~startdate~#]

To list a specific activity type only:

[#(?object=activity::orderby=startdate::criteria=typename='This Activity Type')~subject~ ~location~ ~startdate~#]

To list activities based on the type ID (Level 2 and Level 3 only):

[#(?object=activity::orderby=startdate::criteria=typeid='24160')~subject~ ~location~ ~startdate~#]

To list notes, from the record that contains the notes:

[#(?object=notes::orderby=createddate desc)~notes~ ~createddate~ ~username~#]

To list all companies under a parent company record:

[#(?object=company) ~name~ #]

To list all Level 3 allocations within a Level 2 budget record:

[#(?object=linkactivity) ~subject~ #]

To sum or count all the Level 3 allocations from the budget Level 2 record:

@linkactivity.sum(...)@ or @linkactivity.count(...)@

To list Level 2 notes for each Level 2 record at Level 1:

[#(?object=activity::orderby=startdate desc)~subject~ ~description~ ~startdate~
[@(?object=notes::orderby=createddate desc)~notes~ ~createddate~ ~username~@]#]

To sum all unpaid payment transactions ($1145339$ is the payment status, $1145183$ is the payment amount):

Total Paid: [#(?object=transaction::criteria=trstranstype=11 and tbl_1145339.valuestr='Paid'::groupfunction=sum)$1145183$ #]

Example: Build a Drop-Down List of Records by eventid

This example creates a Select One - Combo Box custom field that displays a list of Payments in Scheduled status, populated automatically from the record on which the field appears. The field stores the eventid of the selected record. The custom field contains the following in the Values section of its field options:

--Please Select--;@parent.[#(?object=activity;criteria=typename='Payment' and statusname='Scheduled';)~eventid~=Payment on $Scheduled Payment Date$ of $Payment Amount$;#]@

The components of the syntax, from innermost to outermost:

With a stored list of eventids, the field's stored value can be used to run operations on the selected records, for example to trigger workflows.

↑ Back to top

UTA/Module Provider and Consumer Variables

Standard fields of UTA/module providers can be referenced using list syntax. The following tables list the Level 1 and Level 2 field names and their variables.

Level 1 Provider Field Variables

Example:

[#(?object=utaproviderL1) ~typename~ | ~statusname~ <br />#]

Level 2 Provider Field Variables

For example:

[#(?object=utaproviderL2) ~typename~ | ~statusname~ <br />#]

If multiple different UTAs/modules are connected as providers, criteria can filter them:

[#(?object=utaproviderL1::criteria=provappid="12345") ~typename~ | ~statusname~ <br />#]

↑ Back to top

Date and Time Variables

Date and time variables format standard fields, custom fields, and the current date and time for display in a UTA/module.

Standard Field Date and Time

Use the following variables to display a standard date field in its default format or to return a specific element of the date, such as the month or day of the week.

Display specific elements of a date or time:

Examples

To display the Start Date in the format February 22, 1985:

@monthname(fullstartdate)@ @day(fullstartdate)@, @year(fullstartdate)@
OR
{{monthname(fullstartdate)}} {{day(fullstartdate)}}, {{year(fullstartdate)}}

To display the End Time in the format 06:45PM:

@hour(fullenddate)@:@minute(fullenddate)@@ampm(fullenddate)@
OR
{{hour(fullenddate)}}:{{minute(fullenddate)}}{{ampm(fullenddate)}}

To format the Start Date or Start Time:

[#(?object=activity)<!--@sscalculation(date_format("$fieldname$","%M %d, %Y"))-->#]

Current Date and Time

Use the following variables to display the current date and time, or to return a specific element of the current date, such as the month or day of the week.

To display the current date and time in the format Friday at 19:55:

@dayweek(currentdate)@ at @hour24(currentdate)@:@minute(currentdate)@
OR
{{dayweek(currentdate)}} at {{hour24(currentdate)}}:{{minute(currentdate)}}

Custom Field Date and Time

For a custom field on the same level as the Web Page View field, a particular element of a date field can be parsed out.

To display the custom field Date Of Birth in the format 31-01-2001:

@day(date of birth)@-@month(date of birth)@-@year(date of birth)@
OR
{{day(date of birth)}}-{{month(date of birth)}}-{{year(date of birth)}}

↑ Back to top

Field Attribute Variables

Add an attribute after a field name, separated by a period, to return information about the field rather than its stored value. The general syntax is @record.fieldname.attribute@.

In the examples below, Gender is a Select One - Combo Box custom field with ID 132547 and options 1=Male and 2=Female, and the record value is Male. Text is a Text Box - Single Line custom field with the caption Enter Text Here and the value Lorem Ipsum.

↑ Back to top

XML Variables

The following variables work with XML custom fields.

To count how many options were selected:

<!--@sscalculation(@xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A") 1+#]@ 0)-->
OR
<!--@sscalculation({{xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A") 1+#]}} 0)-->

To produce a filtered XML display output:

@xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A")~FirstName.nodevalue~ ~LastName.nodevalue~<br />#]@
OR
{{xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A")~FirstName.nodevalue~ ~LastName.nodevalue~<br />#]}}

↑ Back to top

Control and Display Variables

Hide a Variable If It Is Missing

Place the following in front of a variable name to hide it when no value is found:

<!--hideifnotfound-->@parent.contact.adjuster.email@

Display Content Based on a Value with sslogic

To display content based on a value from a variable, place the sslogic tag in front of the content and the end tag after it. To display one of two pieces of content based on a value, add an else tag between them.

<!--@sslogic('@branch.name@'='Internal Staff')-->
  The content to display when the condition is true.
  This can be more than one line.
<!--@end-->
OR
{{ss_if("@branch.name@"="Internal Staff")}}
  The content to display when the condition is true.
  This can be more than one line.
{{ss_endif}}

• The content to display can be plain text or HTML.
• Use single quotes around the variable and value.
• sslogic does not support nested logic statements.

To display a holiday image only in December:

<!--@sslogic(month(now())=12)-->
  <img src="images/holiday.jpg" alt="" />
<!--@end-->
OR
{{ss_if(month(now())=12)}}
  <img src="images/holiday.jpg" alt="" />
{{ss_endif}}

Display Check Boxes in a Web Page View

To display Select Many - Check Box custom fields as check boxes in a Web Page View, add the following to the check box control. This works when the check boxes are on the same level.

@checkbox('fieldname/fieldnumber','option name')@

Display Lower-Level Check Boxes on Level 1

Use the following to display Level 2 or Level 3 check boxes on a Level 1 Web Page View. Use two pipes (||) to separate the ID and the value to be checked.

@checkboxvalue(id values to be checked)@

Number and Currency Format

Use the format function to format a numeric custom field value. The format options are currency, decimal, and percent. For the currency format, the final parameter can be 2 to show two decimal places or 0 to display a whole number.

@format(L2 Subcontract total y1,currency,USD,2)@
@format(fieldname,decimal,'')@
@format(fieldname,percent,'')@
OR
{{format(L2 Subcontract total y1,currency,USD,2)}}
{{format(fieldname,decimal,'')}}
{{format(fieldname,percent,'')}}

Session Variables

When using features such as Organization Switching, data can be pulled based on the current session. For company fields, use @sessioncompany.fieldname@ / {{sessioncompany.fieldname}}. For example, @sessioncompany.name@ returns the company name of the organization currently logged in as.

Field History (Track Changes)

The following syntax retrieves standard or custom field history when Track Changes is enabled.

Display an Image from Upload Fields

Image thumbnails or metadata can be returned from multiple file fields using the list syntax below.

Show a thumbnail image using the thumbnailpath option:

@multi file name.template[# <img src="~thumbnailpath~" alt="" width="240" /> #]@

Show a thumbnail image and file name using the filepath option:

@multi file name.template[# <img src="~filepath~/thumbnail/?maxwidth=240" alt="" width="240" />~filename~#]@
OR
{{multi file name.template[# <img src="~filepath~/thumbnail/?maxwidth=240" alt="" width="240" />~filename~#]}}

Show a thumbnail image and file name using the compressedpath option:

@multi file name.template[# <img src="~compressedpath~/thumbnail/?maxwidth=240" alt="" width="240" />~filename~#]@
OR
{{multi file name.template[# <img src="~compressedpath~/thumbnail/?maxwidth=240" alt="" width="240" />~filename~#]}}

Show file name, size, and upload date:

@multi file name.template[# ~filename~, ~filesize~, ~uploaddate~#]@
OR
{{multi file name.template[# ~filename~, ~filesize~, ~uploaddate~#]}}

Add a File Upload Button

To display a button that uploads to a Single File or Multiple Files custom field, add an input button to the Web Page View, where customfieldid is the field ID of the custom field (without cf_).

<input class="Button" type="button" value="Button Label" />

Display a Dynamic Data Grid Field

To show a Dynamic Data - Data Grid field in a Web Page View field, use @fieldname.table@ or {{fieldname.table}}.

Hybrid Sign-Up Pages

The @user_input_form@ variable displays the associated user sign-up form on a company sign-up page when included in the HTML template of the company sign-up page.

↑ Back to top