System Variables
This pertains to System Variables defined on the Global Settings page
@system.customfieldname@
System Library Variables
This refers to System Library Variables defined on the Global Settings page
@system.library.variable name@
Note: Library variables are accessible across all instances but can only be created and modified by SmartSimple.
System-Wide Variables
@currentdate@
- Inserts the current date and time
- This can be utilized in most contexts where variables are referenced
Web Page View Variables
@now@
- Inserts the current system date
Local Time Variable
@localhour(fullstartdate)@
- Prefixing the variable with 'local' displays the hour according to the system time zone rather than the default Eastern time. This prefix can also be applied for minutes and for AM/PM designations.
Universal Tracking Application Variables
Level 1
Field Name | Variable |
---|---|
level 1 name field |
@name@ |
level 1 type field |
@type@ |
level 1 status field |
@status@ |
level 1 start date |
@startdate@ |
level 1 end date |
@enddate@ |
level 1 contact |
@contact@ |
level 1 custom field |
@customfieldname@ |
Accounts | No variables |
Activity List | No variables |
Application Name |
@name@ |
Application Template Type |
@type@ |
Application Template Type Caption |
@typecaption@ |
Application Template Type Language |
@type_lang@ |
Archived |
@archived@ |
Branch |
@branch@ |
Branch ID |
@branchid@ |
Close Date |
@closedate@ |
Contacts | No variables |
Currency Name |
@currencyname@ |
Currency Code |
@currencycode@ |
Exchange Currency Name |
@excurrencyname@ |
Exchange Currency Code |
@excurrencycode@ |
Currency Exchange Rate |
@exrate@ |
Customer |
@client@ |
Description |
@description@ |
End Date |
@enddate@ |
End Time |
@hour(fullenddate)@:@minute(fullenddate)@ |
Folders | No variables |
Modified By |
@modifiedby@ (username); @modifiedbyid@ (userid) |
Modified Date |
@modifieddate@ |
Owner (full name) |
@owner@ |
Owner (full name - Consumer/Provider reference) |
@ownername@ |
Owner (userid) |
@ownerid@ |
Owner (roleid) |
@owner.rolelist@ |
Person (full name) |
@person@ |
Person (userid) |
@person.userid@ |
Probability |
@probability@ |
Requirement |
@requirements@ |
Revenue |
@revenue@ |
Revenue |
@revenue.value@Unformatted number without comma separators |
Start Date |
@startdate@ |
Start Time |
@hour(fullstartdate)@:@minute(fullstartdate)@ |
Status |
@status@ |
Status ID |
@statusid@ |
Status Caption |
@statuscaption@ |
Status Language |
@status_lang@ |
Status Name |
@statusname@ |
Workflow | No variables |
Level 2
Field Name | Variable |
---|---|
Activity Type |
@type@ |
Activity Type Caption |
@typecaption@ |
Activity Type ID |
@typeid@ |
Amount |
@eamount@ |
Assigned Links | No variables |
Assigned People |
@assigned@ |
Contact Links | No variables |
Contact People |
@contact@ |
Contact User ID |
@contact.userid@Returns only one, even if multiple contacts are assigned |
Description |
@description@ |
Duration |
@span@ |
End Date |
@enddate@ |
End Hour (0-23) |
@endhour@ |
End Hour (1-12) |
@endh@ |
End Hour AM or PM |
@endampm@ |
End Minute |
@endminute@ |
End Time |
@endhour@:@endminute@ |
Event ID |
@eventid@ |
Follow-up Days | No variables |
Follow-up Sent | No variables |
Follow-up Type | No variables |
Location |
@location@ |
Object ID (Parent system ID) |
@objectid@ |
Object Type |
@objecttype@ |
Owner |
@owner@ |
Owner ID |
@ownerid@ |
Parent Name |
@parent.name@ |
Reminder Days | No variables |
Reminder Sent | No variables |
Reminder Type | No variables |
Root Company ID |
@rootcompanyid@ |
Start Date |
@startdate@ |
Start Hour (0-23) |
@starthour@ |
Start Hour (1-12) |
@starth@ |
Start Hour AM or PM |
@startampm@ |
Start Minute |
@startminute@ |
Start Time |
@starthour@:@startminute@ |
Status |
@status@ |
Status Caption |
@statuscaption@ |
Subject |
@subject@ |
Updated By |
@updatedby@Displays system ID, not name |
Updated By Name |
@updatedbyname@Displays the name |
Whole Day Event |
@isallday@ |
Level 3
Field Name | Variable |
---|---|
Associated Parent |
@linkparent.fieldname@ |
General | Level 3 utilizes the same variables as Level 2. |
Referencing a Level 1 Variable at Level 2
@parent.branch@ or @parent.client@ will be substituted with the company name, and other fields can be referenced as follows:
-
@parent.branch.address@
-
@parent.branch.country@
-
@parent.branch.customfield@
-
@parent.firstname@
-
@parent.lastname@
-
@parent.description@
-
@parent.status@
-
@parent.person.fieldname@
Fieldname will be replaced by the variables listed below for the Person Standard Field at Level 1.
Any fields available for the company object.
Contacts/Users
Field Name | Variable |
---|---|
First name |
@firstname@ |
Middle name |
@middlename@ |
Last name |
@lastname@ |
Full name |
@fullname@ |
Phone |
@phone@ |
Phone extension |
@uphoneext@ |
Company name |
@company@ |
Address |
@address@ |
Address 2 |
@address2@ |
City |
@city@ |
Province |
@province@If utilizing abbreviated store values, use @province.name@ to obtain the full name. |
State |
@state@ |
Country |
@country@ |
Country Code (2 letter abbreviation) |
@countrycode@ |
Postal code |
@postalcode@ |
Primary Address |
@primaryaddress@Utilized with Multiple Address Types. |
Address Book |
@addressbook@Utilized with Multiple Address Types. |
US Region name from an actual address record |
@address.region.uscounty.name@ |
US Region ID from an actual address record |
@address.region.uscounty.id@ |
Owner |
@owner@ |
Last updated |
@modifieddate@ |
Last logged in |
@lastlogin@ |
Cost |
@cost@ |
Cost unit |
@costunit@ |
Type |
@type@Returns 'User', 'Local User Administrator', or 'Global User Administrator'. |
Access Type |
@accesstype@Returns 'Administration or Portal Interface', 'User Centric or Applicant Interface', 'Web Service User', or 'No Access'. |
Access Type ID |
@accesstypeid@0=No Access;1=Administration or Portal Interface;3=User Centric or Applicant Interface;5=Web Service User; |
Resource name |
@resourcename@ |
Is contact a resource? |
@isresource@ |
Prefix |
@prefix@ |
Suffix |
@suffix@ |
Unique Identifier |
@uuid@This is a system-generated code that is unique to each contact. For instance: 6BCC 98SF EFC6 FFFB 270C 606 |
Language |
@langname@The language name in the Personal Settings of the contact, for example: @me.langname@ or @owner.langname@ |
Language ID Code |
@langid@The language selected in the Personal Settings of the contact (for instance: @me.langid@ or @owner.langid@) |
User's Time Zone setting |
@sstimezone@Can be utilized to calculate the user's relative date/time. |
Referencing Level 1 and Level 2 Information from a Level 2 Workflow
Field Name | Variable |
---|---|
Level 1 Name Field |
@parent.name@ |
Level 1 Status |
@parent.status@ |
Level 1 Start Date |
@parent.startdate@ |
Level 1 End Date |
@parent.enddate@ |
Level 1 Contact |
@parent.contact@ |
Level 1 Custom Fields |
@parent.customfieldname@ |
Level 2 Type Field |
@type@ |
Level 2 Status Field |
@status@ |
Level 2 Start Date |
@startdate@ |
Level 2 End Date |
@enddate@ |
Level 2 Contact |
@contact@ |
Level 2 Custom Field |
@customfieldname@ |
Parent may be Company, Level 1, Opportunity, or Leads
Name | Variable |
---|---|
Primary Contact |
@primarycontact@ |
Company Name |
@name@ |
Address |
@address@ |
Address 2 |
@address2@ |
City |
@city@ |
Province |
@province@If utilizing abbreviated store values, use @province.name@ to obtain the full name. |
Postal Code |
@postalcode@ |
Country |
@country@ |
Country Code (2 letter abbreviation) |
@countrycode@ |
Latitude |
@lat@ |
Longitude |
@lng@ |
Phone Number |
@phone@ |
Fax Number |
@fax@ |
Owner |
@owner@ |
Website |
@website@ |
Custom Fields |
@customfields@ |
NAIC Code 1 |
@naiccode1@ |
NAIC Code 2 |
@naiccode2@ |
Last Updated |
@modifieddate@ |
Last Updated By |
@updatedbyname@ |
Category Custom Fields |
@Field Name@ |
Opportunity, Level 1
Field Name | Variable |
---|---|
Branch |
@branch@ |
Close Date |
@closedate@ |
Company field |
@company.field@ |
Contacts |
@contact.rolename.field@ |
Created Date |
@createddate@ |
Currency |
@currency@ |
Customer |
@client@ |
Description |
@description@ |
End Date |
@enddate@ |
End Time |
@hour(fullenddate)@:@minute(fullenddate)@ |
Folders | No variables |
Opportunity Source |
@leadsource@ |
List Job Questions (with combo boxes) |
@jobquestions@Only applicable for opportunities utilizing the recruiting template. |
List Job Questions (just questions) |
@jobquestionsr@ |
List Job Skills |
@jobskills@ |
Modified Date |
@modifieddate@ |
Number of filled positions |
@candidatefilled@ |
Number of open positions |
@openpositions@ |
Owner |
@owner@ |
Opportunity Name |
@name@ |
Opportunity Type |
@type@ |
Probability |
@probability@ |
Requirements |
@requirements@ |
Revenue |
@revenue@ |
Start Date |
@startdate@ |
Start Time |
@hour(fullstartdate)@:@minute(fullstartdate)@ |
Status |
@status@ |
Template type number |
@templatetype@ |
Leads
Field Name | Variable |
---|---|
Status |
@status@ |
Company |
@name@ |
Address |
@address@ |
Address 2 |
@address2@ |
City |
@city@ |
Province |
@province@ |
Country |
@country@ |
Postal |
@postalcode@ |
Phone |
@phone@ |
Fax |
@fax@ |
Web Site |
@website@ |
First Name |
@firstname@ |
Last Name |
@lastname@ |
Prefix |
@prefix@ |
Suffix |
@suffix@ |
Title |
@title@ |
(Contact) Phone |
@contactphone@ |
@email@ |
|
Description |
@description@ |
Date Added |
@dat_added@ |
Email Broadcast
Variable | Field Name |
---|---|
@rolename.customfield@ |
|
@randompassword@ |
Generates a new password when sent to the user |
@password@ |
Generates a new password when sent to the user |
@email@ |
Sends the username/email |
@userid@ |
Sends the user ID |
@sender.fieldname@ |
References details of the user who is sending the email |
-
Note:
- Example:
@sender.company.address@
This will return the address of the sender's company.
- Includes All standard contact fields
- Includes All standard company fields
- Example:
Contacts
Field Name | Variable |
---|---|
First name of contact or lead |
@firstname@ |
Last name of contact or lead |
@lastname@ |
Full name of contact or lead |
@fullname@ |
Title of contact or lead |
@title@ |
Email address of contact or lead |
@email@ |
Phone number of contact or lead |
@phone@ |
Address of contact or lead |
@address@ |
City of contact or lead |
@city@ |
State/Province of contact or lead |
@state@ |
Country of contact or lead |
@country@ |
Country Code of contact or lead |
@countrycode@ |
Zip/Postal code of contact or lead |
@postalcode@ |
Company name of contact or lead |
@companyname@ |
Contact address - not available for lead |
@caddress@ |
Contact city - not available for lead |
@ccity@ |
Contact state/province - not available for lead |
@cstate@ |
Contact country - not available for lead |
@ccountry@ |
Contact postal code - not available for lead |
@cpostalcode@ |
Contact fax - not available for lead |
@cfax@ |
Web site for lead - not available for contact |
@cwebsite@ |
First name of the sender |
@senderfirstname@ |
Last name of the sender |
@senderlastname@ |
Name of sender company |
@sendercompany@ |
E-mail of sender |
@senderemail@ |
Phone number of sender |
@senderphone@ |
Title of sender |
@sendertitle@ |
Current date and time format selected by the user in their personal settings? Long date format |
@now@ |
Description field content |
@objectdescription@ |
Roles
@rolelist@ provides a list of role IDs corresponding to the roles to which the user belongs.
@me.rolelist@
@primaryroleid@ provides the ID for the user's primary role. Please refrain from using the prefix '@me.'.
@primaryroleid@
Organization Categories
@catlist@ lists the role ID of each Organization Category to which the company (Account/Organization) belongs.
@me.parent.catlist@
@categories@ lists the category names of each Organization Category to which the company (Account/Organization) belongs.
@me.parent.categories@
Custom Fields Attached to Roles
@rolename.customfieldname@
Variables Available for Report Criteria
-
@userid@
-
@companyid@
-
@objectid@
The following variable is utilized to report on data that is present in records within a sub-company: @company.childid(x)@, where x represents the index of children ordered by name (1,2,3,4,5,6....n).
Utilization of Variables in the Report Template Header
-
@args[1]@, @args[2]@
These variables are employed within the Report Template Header to retrieve the criteria entered by users.
-
@runtime@
This variable is used within the Report Template Header to obtain the date and time the report was executed.
Applicant Tracking Email Template Variables
The following variables are employed to create email templates:
Job Fields
Variable | Field Name |
---|---|
@job.name@ |
Job name |
@job.client@ |
Associated name of the client |
@job.stage@ |
Status of the job |
@job.closedate@ |
Hiring close date of the job |
@job.manager@ |
Hiring Manager – set on the job page |
@job.description@ |
Job description |
@job.type@ |
Template name for this job |
@job.startdate@ |
Job start date |
@job.enddate@ |
Job end date – contract only |
@job.requirements@ |
Job requirements |
@job.openpositions@ |
Number of open positions |
@job.applicantfilled@ |
Number of hired applicants |
@job.branch@ |
Internal branch name associated with this job |
@job.branch.address@ |
Internal branch address 1 |
@job.branch.address2@ |
Internal branch address 2 |
@job.branch.city@ |
Internal branch city |
@job.branch.state@ |
Internal branch state/province |
@job.branch.phone@ |
Internal branch phone number |
@job.branch.country@ |
Internal branch country |
@job.branch.postalcode@ |
Internal branch zip/postal code |
@job.branch.website@ |
Internal branch web site address |
@job.client@ |
Client name |
@job.client.address@ |
Client address one |
@job.client.address2@ |
Client address two |
@job.client.city@ |
Client city |
@job.client.state@ |
Client state/province |
@job.client.phone@ |
Client phone number |
@job.client.country@ |
Client country |
@job.client.postalcode@ |
Client zip/postal code |
@job.client.website@ |
Client web site |
@job.custom@ |
Custom field associated with the job template. For example
@job.additionalinfo@ |
Applicant Fields
Variable | Field Name |
---|---|
@applicant.firstname@ |
First name of the applicant |
@applicant.lastname@ |
Last name of the applicant |
@applicant.title@ |
Title of the applicant |
@applicant.email@ |
Email address of the applicant |
@applicant.phone@ |
Phone number of the applicant |
@applicant.address@ |
Address of the applicant |
@applicant.city@ |
City of the applicant |
@applicant.state@ |
State/Province of the applicant |
@applicant.country@ |
Country of the applicant |
@applicant.countrycode@ |
Country code (2-letter abbreviation) of the applicant |
@applicant.postalcode@ |
Zip/Postal code of the applicant |
Hiring Manager Fields
Variable | Field Name |
---|---|
@hiring manager.firstname@ |
First name of the hiring manager |
@hiring manager.lastname@ |
Last name of the hiring manager |
@hiring manager.title@ |
Title of the hiring manager |
@hiring manager.email@ |
Email address of the hiring manager |
@hiring manager.phone@ |
Phone number of the hiring manager |
@hiring manager.address@ |
Address of the hiring manager |
@hiring manager.city@ |
City of the hiring manager |
@hiring manager.state@ |
State/Province of the hiring manager |
@hiring manager.country@ |
Country of the hiring manager |
@hiring manager.countrycode@ |
Country code (2-letter abbreviation) of the hiring manager |
@hiring manager.postalcode@ |
Zip/Postal code of the hiring manager |
Sender Fields
Variable | Field Name |
---|---|
@senderfirstname@ |
First name of the sender |
@senderlastname@ |
Last name of the sender |
@sendercompany@ |
Name of the sender's company |
@senderemail@ |
Email address of the sender |
@senderphone@ |
Phone number of the sender |
@sendertitle@ |
Title of the sender |
@now@ |
Current date and time formatted according to the user's personal settings - long date format. |
Additionally, fields from the sender, including custom fields and company details, can be referenced using @sender.xxxx@
These variables are applicable within Email and Workflow messages.
Variable | Field Name |
---|---|
@sender.address@ |
Address of the sender |
@sender.company.name@ |
Name of the company with which the sender is associated |
@sender.(custom field name)@ |
Refers to a custom field from the sender's profile |
Workflow Specific Variables
The following variables are exclusively available for use in messages related to workflows:
Variable | Field Name |
---|---|
@objectname@ |
Name of the object within the workflow, which may include a file name, user name, company name, or application name. |
@originatorname@ |
Name of the individual who originated the workflow. For instance, this could be the person who added a file to a workflow-enabled SmartFolder or the individual who created a new person record. |
@originatoremail@ |
Email address of the originator. |
@originatorphone@ |
Phone number of the originator. |
Signority Variables
SmartSimple's Online Document Signing capability enables users to manage the entire signing process.
Users may also monitor the progress of the e-signature submission utilizing the following variables:
@HistoryOf(CFNAME,1)@
This will display only the top section of the history, indicating the overall status of the e-signature submission.
@HistoryOf(CFNAME,0)@
This will display only the bottom section of the history, which shows the progress of the individual signees.
@HistoryOf(CFNAME)@
This will display both the top and bottom sections by default.
Other Variables
Field Name | Variable |
---|---|
@url@ |
The URL for the company alias associated with SmartSimple. For instance: XXX.smartsimple.com – where XXX represents the alias created by the company using the Company Setting page. To display the URL as a hyperlink, please prefix it with either http:// or https:// in the instant message or email template. For example: https://@url@ |
@parentlist@ |
The complete SmartSimple path to the object. |
@apptype@ |
This will return the application ID within the context of a given UTA. |
Select One - User Group Custom Field
The details of the members within a group stored in a Select One - User Group custom field can be referenced using the following syntax:
-
[#(?object=group::id=@fieldname@) ... #]
Where:
- fieldname is the name of the Select One - User Group field.
- Replace "..." with the contact variables you wish to display. i.e. ~lastname~
The role assigned to the user within the group can be accessed using ~role~ in the aforementioned syntax.