Difference between revisions of "Variable List"
Line 319: | Line 319: | ||
==Contacts/Users== | ==Contacts/Users== | ||
− | + | {| class="wikitable" | |
− | + | |+Contacts/Users Field Names and Variables | |
− | + | !Field Name | |
− | + | !Variables | |
− | + | |- | |
− | + | |'''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@ | |
− | + | |- | |
− | + | |'''State''' | |
+ | |@state@ | ||
+ | |- | ||
+ | |'''Country''' | ||
+ | |@country@ | ||
+ | |- | ||
+ | |'''Postal code''' | ||
+ | |@postalcode@ | ||
+ | |- | ||
+ | |'''Primary Address''' | ||
+ | |@primaryaddress@ - used with [[Multiple Address Types]]. See [[Address Book Template]] | ||
+ | |- | ||
+ | |'''Address Book''' | ||
+ | |@addressbook@ - used with [[Multiple Address Types]]. See [[Address Book Template]] | ||
+ | |- | ||
+ | |'''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 example: ''6BCC 98SF EFC6 FFFB 270C 606'' | ||
+ | |- | ||
+ | |'''Language''' | ||
+ | |@langname@ The Language name in the [[Personal Settings]] of the contact (i.e.: ''@me.langname@'' or ''@owner.langname@'') | ||
+ | |- | ||
+ | |'''Language ID Code''' | ||
+ | |@langid@ The Language selected in the [[Personal Settings]] of the contact (i.e.: ''@me.langid@'' or ''@owner.langid@''). See [[Language|here]] for more information | ||
+ | |- | ||
+ | |'''User's Time Zone setting''' | ||
+ | |@sstimezone@ (can be used to calculate user's relative date/time) | ||
==When calling on Level 1 and Level 2 information from a Level 2 Workflow== | ==When calling on Level 1 and Level 2 information from a Level 2 Workflow== |
Revision as of 11:59, 7 January 2016
Contents
- 1 System Variables
- 2 System Library Variables
- 3 System-Wide Variables
- 4 Web Page View Variables
- 5 Universal Tracking Application Variables
- 6 Contacts/Users
- 7 When calling on Level 1 and Level 2 information from a Level 2 Workflow
- 8 Parent can be Company, Level 1, Opportunity or Leads
- 9 Opportunity, Level 1
- 10 Leads
- 11 Email Broadcast
- 12 Contacts
- 13 Roles
- 14 Company Categories
- 15 Custom Fields attached to Roles
- 16 Variables available for Report criteria
- 17 Using Variables in the Report Template Header
- 18 Applicant Tracking Email Template Variables
- 19 Applicant Fields
- 20 Hiring Manager Fields
- 21 Sender Fields
- 22 Workflow Specific Variables
- 23 Other Variables
- 24 See Also
System Variables
This refers 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@
System-Wide Variables
@currentdate@
- Inserts the current date and time
- This can be used in most areas where variables are called
Web Page View Variables
@now@
- Inserts the current system date
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 | @currency@ |
Exchange Currency | @excurrency@ |
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 (userid) | @ownerid@ |
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 Caption | @statuscaption@ |
Status Language | @status_lang@ |
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@ |
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@ |
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 | Variables |
---|---|
Associated Parent | @linkparent.fieldname@ |
General | Level 3 uses the same variables as Level 2. |
Calling a Level 1 Variable at Level 2
@parent.branch@ or @parent.client@ will be replaced by company name and other fields can be referenced like this:
- @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.
whatever fields available for company object.
Contacts/Users
Field Name | Variables |
---|---|
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@ |
State | @state@ |
Country | @country@ |
Postal code | @postalcode@ |
Primary Address | @primaryaddress@ - used with Multiple Address Types. See Address Book Template |
Address Book | @addressbook@ - used with Multiple Address Types. See Address Book Template |
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 example: 6BCC 98SF EFC6 FFFB 270C 606 |
Language | @langname@ The Language name in the Personal Settings of the contact (i.e.: @me.langname@ or @owner.langname@) |
Language ID Code | @langid@ The Language selected in the Personal Settings of the contact (i.e.: @me.langid@ or @owner.langid@). See here for more information |
User's Time Zone setting | @sstimezone@ (can be used to calculate user's relative date/time)
When calling on Level 1 and Level 2 information from a Level 2 Workflow
Parent can be Company, Level 1, Opportunity or LeadsCompany
Opportunity, Level 1
Leads
Email Broadcast
Contacts
Roles@rolelist@ provides a list of roleids corresponding to the roles the user belongs to. @me.rolelist@ @primaryroleid@ provides the id for the user's primary role. Do not use the prefix '@me.'. @primaryroleid@ Company Categories@catlist@ lists the roleid of each Company Category the company (Account/Organization) belongs to. @me.parent.catlist@ Custom Fields attached to Roles@rolename.customfieldname@ Variables available for Report criteria
The following variable is used to report on data that is on records in a sub-company @company.childid(x)@ where x is index of children ordered by name (1,2,3,4,5,6....n) Using Variables in the Report Template Header
Applicant Tracking Email Template VariablesThe following variables are used to create email templates: Job Fields
Applicant Fields
Hiring Manager Fields
Sender Fields
Workflow Specific VariablesThe following variables can only be used in messages associated with workflows:
Other Variables
Select One - User Group Custom FieldThe details of the members of a group stored within a Select One - User Group custom field can be referenced using the following syntax:
Where:
The role the user is assigned within the group can be accessed using ~role~ in the above syntax. See Also |