Difference between revisions of "Variable List"

From SmartWiki
Jump to: navigation, search
(Contacts/Users)
(No summary)
Line 1: Line 1:
 
==System Variables==
 
==System Variables==
 
''This refers to [[System Variables]] defined on the [[Global Settings]] page''
 
''This refers to [[System Variables]] defined on the [[Global Settings]] page''
*'''@system.'''''customfieldname'''''@'''
+
 
 +
* '''@system.'''''customfieldname'''''@'''
  
 
==System Library Variables==
 
==System Library Variables==
 
''This refers to System Library Variables defined on the [[Global Settings]] page''
 
''This refers to System Library Variables defined on the [[Global Settings]] page''
*'''@system.library.'''''variable name'''''@'''
+
 
 +
* '''@system.library.'''''variable name'''''@'''
  
 
'''Note''': Library variables are available in all instances but can only be created and edited by SmartSimple.
 
'''Note''': Library variables are available in all instances but can only be created and edited by SmartSimple.
  
 
==System-Wide Variables==
 
==System-Wide Variables==
 +
'''@currentdate@'''
  
'''@currentdate@'''
+
* Inserts the current date and time
  
* Inserts the current date and time
+
* This can be used in most areas where variables are called
  
* This can be used in most areas where variables are called
 
 
 
==Web Page View Variables==
 
==Web Page View Variables==
 
'''@now@'''
 
  
* Inserts the current system date
+
'''@now@'''
 +
 
 +
* Inserts the current system date
  
 
==Universal Tracking Application Variables==
 
==Universal Tracking Application Variables==
 
 
===Level 1===
 
===Level 1===
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Level 1 Field Name and Variable List
 
|+style="text-align:left"|Level 1 Field Name and Variable List
!Field Name
 
!Variable
 
 
|-
 
|-
|level 1 name field
+
!|Field Name
|@name@
+
!|Variable
 
|-
 
|-
|level 1 type field
+
||level 1 name field
|@type@
+
||@name@
 
|-
 
|-
|level 1 status field
+
||level 1 type field
|@status@
+
||@type@
 
|-
 
|-
|level 1 start date
+
||level 1 status field
|@startdate@
+
||@status@
 
|-
 
|-
|level 1 end date
+
||level 1 start date
|@enddate@
+
||@startdate@
 
|-
 
|-
|level 1 contact
+
||level 1 end date
|@contact@
+
||@enddate@
 
|-
 
|-
|level 1 custom field
+
||level 1 contact
|@customfieldname@
+
||@contact@
 
|-
 
|-
|Accounts
+
||level 1 custom field
|No variables
+
||@customfieldname@
 
|-
 
|-
|Activity List
+
||Accounts
|No variables
+
||No variables
 
|-
 
|-
|Application Name
+
||Activity List
|@name@
+
||No variables
 
|-
 
|-
|Application Template Type
+
||Application Name
|@type@
+
||@name@
 
|-
 
|-
|Application Template Type Caption
+
||Application Template Type
|@typecaption@
+
||@type@
 
|-
 
|-
|Application Template Type Language
+
||Application Template Type Caption
|@type_lang@
+
||@typecaption@
 
|-
 
|-
|Archived
+
||Application Template Type Language
|@archived@
+
||@type_lang@
 
|-
 
|-
|Branch
+
||Archived
|@branch@
+
||@archived@
 
|-
 
|-
|Branch ID
+
||Branch
|@branchid@
+
||@branch@
 
|-
 
|-
|Close Date
+
||Branch ID
|@closedate@
+
||@branchid@
 
|-
 
|-
|Contacts
+
||Close Date
|No variables
+
||@closedate@
 
|-
 
|-
|Currency
+
||Contacts
|@currency@
+
||No variables
 
|-
 
|-
|Exchange Currency
+
||Currency
|@excurrency@
+
||@currency@
 
|-
 
|-
|Currency Exchange Rate
+
||Exchange Currency
|@exrate@
+
||@excurrency@
 
|-
 
|-
|Customer
+
||Currency Exchange Rate
|@client@
+
||@exrate@
 
|-
 
|-
|Description
+
||Customer
|@description@
+
||@client@
 
|-
 
|-
|End Date
+
||Description
|@enddate@
+
||@description@
 
|-
 
|-
|End Time
+
||End Date
|@hour(fullenddate)@:@minute(fullenddate)@
+
||@enddate@
 
|-
 
|-
|Folders
+
||End Time
|No variables
+
||@hour(fullenddate)@:@minute(fullenddate)@
 
|-
 
|-
|Modified By
+
||Folders
|@modifiedby@ (username); @modifiedbyid@ (userid)
+
||No variables
 
|-
 
|-
|Modified Date
+
||Modified By
|@modifieddate@
+
||@modifiedby@ (username); @modifiedbyid@ (userid)
 
|-
 
|-
|Owner (full name)
+
||Modified Date
|@owner@
+
||@modifieddate@
 
|-
 
|-
|Owner (full name - Consumer/Provider reference)
+
||Owner (full name)
|@ownername@
+
||@owner@
 
|-
 
|-
|Owner (userid)
+
||Owner (full name - Consumer/Provider reference)
|@ownerid@
+
||@ownername@
 
|-
 
|-
|Person (full name)
+
||Owner (userid)
|@person@
+
||@ownerid@
 
|-
 
|-
|Person (userid)
+
||Person (full name)
|@person.userid@
+
||@person@
 
|-
 
|-
|Probability
+
||Person (userid)
|@probability@
+
||@person.userid@
 
|-
 
|-
|Requirement
+
||Probability
|@requirements@
+
||@probability@
 
|-
 
|-
|Revenue
+
||Requirement
|@revenue@
+
||@requirements@
 
|-
 
|-
|Revenue
+
||Revenue
|@revenue.value@ (unformatted number without comma separators)
+
||@revenue@
 
|-
 
|-
|Start Date
+
||Revenue
|@startdate@
+
||@revenue.value@ (unformatted number without comma separators)
 
|-
 
|-
|Start Time
+
||Start Date
|@hour(fullstartdate)@:@minute(fullstartdate)@
+
||@startdate@
 
|-
 
|-
|Status
+
||Start Time
|@status@
+
||@hour(fullstartdate)@:@minute(fullstartdate)@
 
|-
 
|-
|Status Caption
+
||Status
|@statuscaption@
+
||@status@
 
|-
 
|-
|Status Language
+
||Status ID
|@status_lang@
+
||@statusid@
 
|-
 
|-
|Workflow
+
||Status Caption
|No variables
+
||@statuscaption@
 +
|-
 +
||Status Language
 +
||@status_lang@
 +
|-
 +
||Status Name
 +
||@statusname@
 +
|-
 +
||Workflow
 +
||No variables
 
|}
 
|}
  
 
===Level 2===
 
===Level 2===
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Level 2 Field Names and Variables List
 
|+style="text-align:left"|Level 2 Field Names and Variables List
!Field Name
 
!Variable
 
 
|-
 
|-
|'''Activity Type'''
+
!|Field Name
|@type@
+
!|Variable
 
|-
 
|-
|'''Activity Type [[Caption]]'''
+
||'''Activity Type'''
|@typecaption@
+
||@type@
 
|-
 
|-
|'''Activity Type ID'''
+
||'''Activity Type [[Caption]]'''
|@typeid@
+
||@typecaption@
 
|-
 
|-
|'''Amount'''
+
||'''Activity Type ID'''
|@eamount@
+
||@typeid@
 
|-
 
|-
|'''Assigned Links'''
+
||'''Amount'''
|''No variables''
+
||@eamount@
 
|-
 
|-
|'''Assigned People'''
+
||'''Assigned Links'''
|@assigned@
+
||''No variables''
 
|-
 
|-
|'''Contact Links'''
+
||'''Assigned People'''
|''No variables''
+
||@assigned@
 
|-
 
|-
|'''Contact People'''
+
||'''Contact Links'''
|@contact@
+
||''No variables''
 
|-
 
|-
|'''Description'''
+
||'''Contact People'''
|@description@
+
||@contact@
 
|-
 
|-
|'''Duration'''
+
||'''Description'''
|@span@
+
||@description@
 
|-
 
|-
|'''End Date'''
+
||'''Duration'''
|@enddate@
+
||@span@
 
|-
 
|-
|'''End Hour''' (0-23)
+
||'''End Date'''
|@endhour@
+
||@enddate@
 
|-
 
|-
|'''End Hour''' (1-12)
+
||'''End Hour''' (0-23)
|@endh@
+
||@endhour@
 
|-
 
|-
|'''End Hour AM or PM'''
+
||'''End Hour''' (1-12)
|@endampm@
+
||@endh@
 
|-
 
|-
|'''End Minute'''
+
||'''End Hour AM or PM'''
|@endminute@
+
||@endampm@
 
|-
 
|-
|'''End Time'''
+
||'''End Minute'''
|@endhour@:@endminute@  
+
||@endminute@
 
|-
 
|-
|'''Event ID'''
+
||'''End Time'''
|@eventid@
+
||@endhour@:@endminute@
 
|-
 
|-
|'''Follow-up Days'''
+
||'''Event ID'''
|''No variables''
+
||@eventid@
 
|-
 
|-
|'''Follow-up Sent'''
+
||'''Follow-up Days'''
|''No variables''
+
||''No variables''
 
|-
 
|-
|'''Follow-up Type'''
+
||'''Follow-up Sent'''
|''No variables''
+
||''No variables''
 
|-
 
|-
|'''Location'''
+
||'''Follow-up Type'''
|@location@
+
||''No variables''
 
|-
 
|-
|'''Object ID''' (Parent system ID)
+
||'''Location'''
|@objectid@
+
||@location@
 
|-
 
|-
|'''Object Type'''
+
||'''Object ID''' (Parent system ID)
|@objecttype@
+
||@objectid@
 
|-
 
|-
|'''Owner'''
+
||'''Object Type'''
|@owner@
+
||@objecttype@
 
|-
 
|-
|'''Parent Name'''
+
||'''Owner'''
|@parent.name@
+
||@owner@
 
|-
 
|-
|'''Reminder Days'''
+
||'''Parent Name'''
|''No variables''
+
||@parent.name@
 
|-
 
|-
|'''Reminder Sent'''
+
||'''Reminder Days'''
|''No variables''
+
||''No variables''
 
|-
 
|-
|'''Reminder Type'''
+
||'''Reminder Sent'''
|''No variables''
+
||''No variables''
 
|-
 
|-
|'''Root Company ID'''
+
||'''Reminder Type'''
|@rootcompanyid@
+
||''No variables''
 
|-
 
|-
|'''Start Date'''
+
||'''Root Company ID'''
|@startdate@
+
||@rootcompanyid@
 
|-
 
|-
|'''Start Hour''' (0-23)
+
||'''Start Date'''
|@starthour@
+
||@startdate@
 
|-
 
|-
|'''Start Hour''' (1-12)
+
||'''Start Hour''' (0-23)
|@starth@
+
||@starthour@
 
|-
 
|-
|'''Start Hour AM or PM'''
+
||'''Start Hour''' (1-12)
|@startampm@
+
||@starth@
 
|-
 
|-
|'''Start Minute'''
+
||'''Start Hour AM or PM'''
|@startminute@
+
||@startampm@
 
|-
 
|-
|'''Start Time'''
+
||'''Start Minute'''
|@starthour@:@startminute@
+
||@startminute@
 
|-
 
|-
|'''Status'''
+
||'''Start Time'''
|@status@
+
||@starthour@:@startminute@
 
|-
 
|-
|'''Status [[Caption]]'''
+
||'''Status'''
|@statuscaption@
+
||@status@
 
|-
 
|-
|'''Subject'''
+
||'''Status [[Caption]]'''
|@subject@
+
||@statuscaption@
 
|-
 
|-
|'''Updated By'''
+
||'''Subject'''
|@updatedby@ -- Displays system ID, not name
+
||@subject@
 
|-
 
|-
|'''Updated By Name'''
+
||'''Updated By'''
|@updatedbyname@ -- Displays the name
+
||@updatedby@ -- Displays system ID, not name
 
|-
 
|-
|'''Whole Day Event'''
+
||'''Updated By Name'''
|@isallday@
+
||@updatedbyname@ -- Displays the name
 +
|-
 +
||'''Whole Day Event'''
 +
||@isallday@
 
|}
 
|}
  
 
===Level 3===
 
===Level 3===
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Level 3 Field Names and Variables
 
|+style="text-align:left"|Level 3 Field Names and Variables
!Field Name
 
!Variable
 
 
|-
 
|-
|'''Associated Parent'''
+
!|Field Name
|@linkparent.''fieldname''@
+
!|Variable
 
|-
 
|-
|'''General'''
+
||'''Associated Parent'''
|Level 3 uses the same variables as Level 2.
+
||@linkparent.''fieldname''@
 +
|-
 +
||'''General'''
 +
||Level 3 uses the same variables as Level 2.
 
|}
 
|}
  
 
===Calling a Level 1 Variable at 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@''' or '''@parent.client@''' will be replaced by company name and other fields can be referenced like this:
+
 
* '''@parent.branch.address@'''
+
* '''@parent.branch.address@'''
 
* '''@parent.branch.country@'''
 
* '''@parent.branch.country@'''
* '''@parent.branch.customfield@'''
+
* '''@parent.branch.customfield@'''
* '''@parent.firstname@'''
+
* '''@parent.firstname@'''
* '''@parent.lastname@'''
+
* '''@parent.lastname@'''
* '''@parent.description@'''
+
* '''@parent.description@'''
* '''@parent.status@'''
+
* '''@parent.status@'''
 
* '''@parent.person.fieldname@''' - fieldname will be replaced by the variables listed below for the '''Person''' [[Standard Field]] at Level 1.
 
* '''@parent.person.fieldname@''' - fieldname will be replaced by the variables listed below for the '''Person''' [[Standard Field]] at Level 1.
  
Line 323: Line 329:
  
 
==Contacts/Users==
 
==Contacts/Users==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Contacts/Users Field Names and Variables
 
|+style="text-align:left"|Contacts/Users Field Names and Variables
!Field Name
 
!Variable
 
 
|-
 
|-
|'''First name'''
+
!|Field Name
|@firstname@
+
!|Variable
 +
|-
 +
||'''First name'''
 +
||@firstname@
 
|-
 
|-
|'''Middle name'''
+
||'''Middle name'''
|@middlename@
+
||@middlename@
 
|-
 
|-
|'''Last name'''
+
||'''Last name'''
|@lastname@
+
||@lastname@
 
|-
 
|-
|'''Full name'''
+
||'''Full name'''
|@fullname@
+
||@fullname@
 
|-
 
|-
|'''Phone'''
+
||'''Phone'''
|@phone@
+
||@phone@
 
|-
 
|-
|'''Phone extension'''
+
||'''Phone extension'''
|@uphoneext@
+
||@uphoneext@
 
|-
 
|-
|'''Company name'''
+
||'''Company name'''
|@company@
+
||@company@
 
|-
 
|-
|'''Address'''
+
||'''Address'''
|@address@
+
||@address@
 
|-
 
|-
|'''Address 2'''
+
||'''Address 2'''
|@address2@
+
||@address2@
 
|-
 
|-
|'''City'''
+
||'''City'''
|@city@
+
||@city@
 
|-
 
|-
|'''Province'''
+
||'''Province'''
|@province@
+
||@province@
 
|-
 
|-
|'''State'''
+
||'''State'''
|@state@
+
||@state@
 
|-
 
|-
|'''Country'''
+
||'''Country'''
|@country@
+
||@country@
 
|-
 
|-
|'''Country Code''' (2 letter abbreviation)
+
||'''Country Code''' (2 letter abbreviation)
|@countrycode@
+
||@countrycode@
 
|-
 
|-
|'''Postal code'''
+
||'''Postal code'''
|@postalcode@
+
||@postalcode@
 
|-
 
|-
|'''Primary Address'''
+
||'''Primary Address'''
|@primaryaddress@ - used with [[Multiple Address Types]]. See [[Address Book Template]]
+
||@primaryaddress@ - used with [[Multiple Address Types]]. See [[Address Book Template]]
 
|-
 
|-
|'''Address Book'''
+
||'''Address Book'''
|@addressbook@ - used with [[Multiple Address Types]]. See [[Address Book Template]]
+
||@addressbook@ - used with [[Multiple Address Types]]. See [[Address Book Template]]
 
|-
 
|-
|'''US Region name from an actual address record'''
+
||'''US Region name from an actual address record'''
|@address.region.uscounty.name@
+
||@address.region.uscounty.name@
 
|-
 
|-
|'''US Region ID from an actual address record'''
+
||'''US Region ID from an actual address record'''
|@address.region.uscounty.id@
+
||@address.region.uscounty.id@
 
|-
 
|-
|'''Owner'''
+
||'''Owner'''
|@owner@
+
||@owner@
 
|-
 
|-
|'''Last updated'''
+
||'''Last updated'''
|@modifieddate@
+
||@modifieddate@
 
|-
 
|-
|'''Last logged in'''
+
||'''Last logged in'''
|@lastlogin@
+
||@lastlogin@
 
|-
 
|-
|'''Cost'''
+
||'''Cost'''
|@cost@
+
||@cost@
 
|-
 
|-
|'''Cost unit'''
+
||'''Cost unit'''
|@costunit@
+
||@costunit@
 
|-
 
|-
|'''Type'''
+
||'''Type'''
|@type@ (returns 'User', 'Local User Administrator' or 'Global User Administrator')
+
||@type@ (returns 'User', 'Local User Administrator' or 'Global User Administrator')
 
|-
 
|-
|'''Access Type'''
+
||'''Access Type'''
|@accesstype@ (returns 'Administration or Portal Interface', 'User Centric or Applicant Interface', 'Web Service User' or 'No Access')
+
||@accesstype@ (returns 'Administration or Portal Interface', 'User Centric or Applicant Interface', 'Web Service User' or 'No Access')
 
|-
 
|-
|'''Access Type ID'''
+
||'''Access Type ID'''
|@accesstypeid@ ''0=No Access;1=Administration or Portal Interface;3=User Centric or Applicant Interface;5=Web Service User;''
+
||@accesstypeid@ ''0=No Access;1=Administration or Portal Interface;3=User Centric or Applicant Interface;5=Web Service User;''
 
|-
 
|-
|'''Resource name'''
+
||'''Resource name'''
|@resourcename@
+
||@resourcename@
 
|-
 
|-
|'''Is contact a resource?'''
+
||'''Is contact a resource?'''
|@isresource@
+
||@isresource@
 
|-
 
|-
|'''Prefix'''
+
||'''Prefix'''
|@prefix@
+
||@prefix@
 
|-
 
|-
|'''Suffix'''
+
||'''Suffix'''
|@suffix@
+
||@suffix@
 
|-
 
|-
|'''Unique Identifier'''
+
||'''Unique Identifier'''
|@uuid@ This is a system-generated code that is unique to each contact. For example: ''6BCC 98SF EFC6 FFFB 270C 606''
+
||@uuid@ This is a system-generated code that is unique to each contact. For example: ''6BCC 98SF EFC6 FFFB 270C 606''
 
|-
 
|-
|'''Language'''
+
||'''Language'''
|@langname@ The Language name in the [[Personal Settings]] of the contact (i.e.: ''@me.langname@'' or ''@owner.langname@'')
+
||@langname@ The Language name in the [[Personal Settings]] of the contact (i.e.: ''@me.langname@'' or ''@owner.langname@'')
 
|-
 
|-
|'''Language ID Code'''
+
||'''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
+
||@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'''
+
||'''User's Time Zone setting'''
|@sstimezone@ (can be used to calculate user's relative date/time)
+
||@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==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Calling L1 and L2 fields from a L2 Workbflow
 
|+style="text-align:left"|Calling L1 and L2 fields from a L2 Workbflow
!Field Name
 
!Variable
 
 
|-
 
|-
|'''level 1 name field'''
+
!|Field Name
|@parent.name@
+
!|Variable
 
|-
 
|-
|'''level 1 status'''
+
||'''level 1 name field'''
|@parent.status@
+
||@parent.name@
 
|-
 
|-
|'''level 1 start date'''
+
||'''level 1 status'''
|@parent.startdate@
+
||@parent.status@
 
|-
 
|-
|'''level 1 end date'''
+
||'''level 1 start date'''
|@parent.enddate@
+
||@parent.startdate@
 
|-
 
|-
|'''level 1 contact'''
+
||'''level 1 end date'''
|@parent.contact@
+
||@parent.enddate@
 
|-
 
|-
|'''level 1 custom fields'''
+
||'''level 1 contact'''
|@parent.customfieldname@
+
||@parent.contact@
 
|-
 
|-
|'''level 2 type field'''
+
||'''level 1 custom fields'''
|@type@
+
||@parent.customfieldname@
 
|-
 
|-
|'''level 2 status field'''
+
||'''level 2 type field'''
|@status@
+
||@type@
 
|-
 
|-
|'''level 2 start date'''
+
||'''level 2 status field'''
|@startdate@
+
||@status@
 
|-
 
|-
|'''level 2 end date'''
+
||'''level 2 start date'''
|@enddate@
+
||@startdate@
 
|-
 
|-
|'''level 2 contact'''
+
||'''level 2 end date'''
|@contact@
+
||@enddate@
 
|-
 
|-
|'''level 2 custom field'''
+
||'''level 2 contact'''
|@customfieldname@
+
||@contact@
 +
|-
 +
||'''level 2 custom field'''
 +
||@customfieldname@
 
|}
 
|}
  
 
==Parent can be Company, Level 1, Opportunity or Leads==
 
==Parent can be Company, Level 1, Opportunity or Leads==
 +
<u>'''Company'''</u>
  
<u>'''Company'''</u>
+
State|@state@|->
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Level 1 Name and Variable List
 
|+style="text-align:left"|Level 1 Name and Variable List
!Name
 
!Variable
 
 
|-
 
|-
|'''Primary Contact'''
+
!|Name
|@primarycontact@
+
!|Variable
 +
|-
 +
||'''Primary Contact'''
 +
||@primarycontact@
 +
|-
 +
||'''Company Name'''
 +
||@name@
 
|-
 
|-
|'''Company Name'''
+
||'''Address'''
|@name@
+
||@address@
 
|-
 
|-
|'''Address'''
+
||'''Address 2'''
|@address@
+
||@address2@
 
|-
 
|-
|'''Address 2'''
+
||'''City'''
|@address2@
+
||@city@
 
|-
 
|-
|'''City'''
+
||'''Province'''
|@city@
+
||@province@
 
|-
 
|-
|'''Province'''
+
||'''Postal code'''
|@province@
+
||@postalcode@
|-|'''State'''|@state@|-
 
|'''Postal code'''
 
|@postalcode@
 
 
|-
 
|-
|'''Country'''
+
||'''Country'''
|@country@
+
||@country@
 
|-
 
|-
|'''Country Code''' (2 letter abbreviation)
+
||'''Country Code''' (2 letter abbreviation)
|@countrycode@
+
||@countrycode@
 
|-
 
|-
|'''Phone number'''
+
||'''Phone number'''
|@phone@  
+
||@phone@
 
|-
 
|-
|'''Fax number'''
+
||'''Fax number'''
|@fax@  
+
||@fax@
 
|-
 
|-
|'''Owner'''
+
||'''Owner'''
|@owner@  
+
||@owner@
 
|-
 
|-
|'''Website'''
+
||'''Website'''
|@website@  
+
||@website@
 
|-
 
|-
|'''Custom fields'''
+
||'''Custom fields'''
|@customfields@
+
||@customfields@
 
|-
 
|-
|'''NAIC Code 1'''
+
||'''NAIC Code 1'''
|@naiccode1@
+
||@naiccode1@
 
|-
 
|-
|'''NAIC Code 2'''
+
||'''NAIC Code 2'''
|@naiccode2@
+
||@naiccode2@
 
|-
 
|-
|'''Last updated'''
+
||'''Last updated'''
|@modifieddate@
+
||@modifieddate@
 
|-
 
|-
|'''Last updated by'''
+
||'''Last updated by'''
|@updatedbyname@
+
||@updatedbyname@
 
|-
 
|-
|'''Category custom fields'''
+
||'''Category custom fields'''
|@Field Name@
+
||@Field Name@
 
|}
 
|}
  
 
==Opportunity, Level 1==
 
==Opportunity, Level 1==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Opportunity & Level 1
 
|+style="text-align:left"|Opportunity & Level 1
!Field Name
 
!Variable
 
 
|-
 
|-
|'''Branch'''
+
!|Field Name
|@branch@
+
!|Variable
 
|-
 
|-
|'''Close Date'''
+
||'''Branch'''
|@closedate@
+
||@branch@
 
|-
 
|-
|'''Company field'''
+
||'''Close Date'''
|@company.field@
+
||@closedate@
 
|-
 
|-
|'''Contacts'''
+
||'''Company field'''
|@contact.rolename.field@
+
||@company.field@
 
|-
 
|-
|'''Currency'''
+
||'''Contacts'''
|@currency@
+
||@contact.rolename.field@
 
|-
 
|-
|'''Customer'''
+
||'''Currency'''
|@client@
+
||@currency@
 
|-
 
|-
|'''Description'''
+
||'''Customer'''
|@description@
+
||@client@
 
|-
 
|-
|'''End Date'''
+
||'''Description'''
|@enddate@
+
||@description@
|-
 
|'''End Time'''
 
|@hour(fullenddate)@:@minute(fullenddate)@
 
 
|-
 
|-
|'''Folders'''
+
||'''End Date'''
|No variables
+
||@enddate@
 
|-
 
|-
|'''Opportunity Source'''
+
||'''End Time'''
|@leadsource@
+
||@hour(fullenddate)@:@minute(fullenddate)@
 
|-
 
|-
|'''List Job Questions (with combo boxes)'''
+
||'''Folders'''
|@jobquestions@ ''Only for opportunities that use the recruiting template''
+
||No variables
 
|-
 
|-
|'''List Job Questions (just questions)'''
+
||'''Opportunity Source'''
|@jobquestionsr@
+
||@leadsource@
 
|-
 
|-
|'''List Job Skills'''
+
||'''List Job Questions (with combo boxes)'''
|@jobskills@
+
||@jobquestions@ ''Only for opportunities that use the recruiting template''
 
|-
 
|-
|'''Modified Date'''
+
||'''List Job Questions (just questions)'''
|@modifieddate@
+
||@jobquestionsr@
 
|-
 
|-
|'''Number of filled positions'''
+
||'''List Job Skills'''
|@candidatefilled@
+
||@jobskills@
 
|-
 
|-
|'''Number of open positions'''
+
||'''Modified Date'''
|@openpositions@
+
||@modifieddate@
 
|-
 
|-
|'''Owner'''
+
||'''Number of filled positions'''
|@owner@
+
||@candidatefilled@
 
|-
 
|-
|'''Opportunity Name'''
+
||'''Number of open positions'''
|@name@
+
||@openpositions@
 
|-
 
|-
|'''Opportunity Type'''
+
||'''Owner'''
|@type@
+
||@owner@
 
|-
 
|-
|'''Probability'''
+
||'''Opportunity Name'''
|@probability@
+
||@name@
 
|-
 
|-
|'''Requirements'''
+
||'''Opportunity Type'''
|@requirements@
+
||@type@
 
|-
 
|-
|'''Revenue'''
+
||'''Probability'''
|@revenue@
+
||@probability@
 
|-
 
|-
|'''Start Date'''
+
||'''Requirements'''
|@startdate@
+
||@requirements@
 
|-
 
|-
|'''Start Time'''
+
||'''Revenue'''
|@hour(fullstartdate)@:@minute(fullstartdate)@
+
||@revenue@
 
|-
 
|-
|'''Status'''
+
||'''Start Date'''
|@status@
+
||@startdate@
 
|-
 
|-
|'''Template type number'''
+
||'''Start Time'''
|@templatetype@
+
||@hour(fullstartdate)@:@minute(fullstartdate)@
 +
|-
 +
||'''Status'''
 +
||@status@
 +
|-
 +
||'''Template type number'''
 +
||@templatetype@
 
|}
 
|}
  
Line 638: Line 646:
 
* '''Activity List''' - Is not displaying information properly, according to Wiki call guide
 
* '''Activity List''' - Is not displaying information properly, according to Wiki call guide
 
* '''Applicants''' - No information on how to call applicants in Wiki -->
 
* '''Applicants''' - No information on how to call applicants in Wiki -->
 
+
==Leads==
==Leads==        
 
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Leads Variable List
 
|+style="text-align:left"|Leads Variable List
!Field Name
 
!Variable
 
 
|-
 
|-
|'''Status'''
+
!|Field Name
|@status@
+
!|Variable
 +
|-
 +
||'''Status'''
 +
||@status@
 
|-
 
|-
|'''Company'''
+
||'''Company'''
|@name@
+
||@name@
 
|-
 
|-
|'''Address'''
+
||'''Address'''
|@address@
+
||@address@
 
|-
 
|-
|'''Address 2'''
+
||'''Address 2'''
|@address2@
+
||@address2@
 
|-
 
|-
|'''City'''
+
||'''City'''
|@city@
+
||@city@
 
|-
 
|-
|'''Province'''
+
||'''Province'''
|@province@
+
||@province@
 
|-
 
|-
|'''Country'''
+
||'''Country'''
|@country@
+
||@country@
 
|-
 
|-
|'''Postal'''
+
||'''Postal'''
|@postalcode@
+
||@postalcode@
 
|-
 
|-
|'''Phone'''
+
||'''Phone'''
|@phone@
+
||@phone@
 
|-
 
|-
|'''Fax'''
+
||'''Fax'''
|@fax@
+
||@fax@
 
|-
 
|-
|'''Web Site'''
+
||'''Web Site'''
|@website@
+
||@website@
 
|-
 
|-
|'''First Name'''
+
||'''First Name'''
|@firstname@
+
||@firstname@
 
|-
 
|-
|'''Last Name'''
+
||'''Last Name'''
|@lastname@
+
||@lastname@
 
|-
 
|-
|'''Prefix'''
+
||'''Prefix'''
|@prefix@
+
||@prefix@
 
|-
 
|-
|'''Suffix'''
+
||'''Suffix'''
|@suffix@
+
||@suffix@
 
|-
 
|-
|'''Title'''
+
||'''Title'''
|@title@
+
||@title@
 
|-
 
|-
|'''(Contact) Phone'''
+
||'''(Contact) Phone'''
|@contactphone@
+
||@contactphone@
 
|-
 
|-
|'''Email'''
+
||'''Email'''
|@email@
+
||@email@
 
|-
 
|-
|'''Description'''
+
||'''Description'''
|@description@
+
||@description@
 
|-
 
|-
|'''Date Added'''
+
||'''Date Added'''
|@dat_added@
+
||@dat_added@
 
|}
 
|}
  
Line 713: Line 721:
 
<!--* '''Ext.''' - Don’t know-->
 
<!--* '''Ext.''' - Don’t know-->
 
<!--* '''Owner/Owner.field''' - Don’t know-->
 
<!--* '''Owner/Owner.field''' - Don’t know-->
 
 
==Email Broadcast==
 
==Email Broadcast==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Email Broadcast Variable List
 
|+style="text-align:left"|Email Broadcast Variable List
!Field Name
 
!Variable
 
 
|-
 
|-
|'''@rolename.customfield@'''
+
!|Field Name
|
+
!|Variable
 +
|-
 +
||'''@rolename.customfield@'''
 +
||
 
|-
 
|-
|'''@randompassword@'''
+
||'''@randompassword@'''
|Generates a new password when sending to user
+
||Generates a new password when sending to user
 
|-
 
|-
|'''@password@'''
+
||'''@password@'''
|Generates a new password when sending to user
+
||Generates a new password when sending to user
 
|-
 
|-
|'''@email@'''
+
||'''@email@'''
|Sends the username/E-mail
+
||Sends the username/E-mail
 
|-
 
|-
|'''@userid@'''
+
||'''@userid@'''
|Sends the user id
+
||Sends the user id
 
|-
 
|-
|'''@sender.''fieldname''@'''
+
||'''@sender.''fieldname''@'''
|manner of referencing details of the user who is sending the email
+
||manner of referencing details of the user who is sending the email
 
|}
 
|}
:'''Note:'''
+
: '''Note:'''
 
:* examples: ''@sender.company.address@'' will return the address of the sender's company.
 
:* examples: ''@sender.company.address@'' will return the address of the sender's company.
 
:* Includes '''All standard contact fields'''
 
:* Includes '''All standard contact fields'''
Line 745: Line 752:
  
 
==Contacts==
 
==Contacts==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Level 1 Field Name and Variable List
 
|+style="text-align:left"|Level 1 Field Name and Variable List
!Field Name
 
!Variable
 
 
|-
 
|-
|'''First name of contact or lead'''
+
!|Field Name
|@firstname@
+
!|Variable
 +
|-
 +
||'''First name of contact or lead'''
 +
||@firstname@
 
|-
 
|-
|'''Last name of contact or lead'''
+
||'''Last name of contact or lead'''
|@lastname@
+
||@lastname@
 
|-
 
|-
|'''Full name of contact or lead'''
+
||'''Full name of contact or lead'''
|@fullname@
+
||@fullname@
 
|-
 
|-
|'''Title of contact or lead'''
+
||'''Title of contact or lead'''
|@title@
+
||@title@
 
|-
 
|-
|'''Email address of contact or lead'''
+
||'''Email address of contact or lead'''
|@email@
+
||@email@
 
|-
 
|-
|'''Phone number of contact or lead'''
+
||'''Phone number of contact or lead'''
|@phone@
+
||@phone@
 
|-
 
|-
|'''Address of contact or lead'''
+
||'''Address of contact or lead'''
|@address@
+
||@address@
 
|-
 
|-
|'''City of contact or lead'''
+
||'''City of contact or lead'''
|@city@
+
||@city@
 
|-
 
|-
|'''State/Province of contact or lead'''
+
||'''State/Province of contact or lead'''
|@state@
+
||@state@
 
|-
 
|-
|'''Country of contact or lead'''
+
||'''Country of contact or lead'''
|@country@
+
||@country@
 
|-
 
|-
|'''Country Code of contact or lead'''
+
||'''Country Code of contact or lead'''
|@countrycode@
+
||@countrycode@
 
|-
 
|-
|'''Zip/Postal code of contact or lead'''
+
||'''Zip/Postal code of contact or lead'''
|@postalcode@
+
||@postalcode@
 
|-
 
|-
|'''Company name of contact or lead'''
+
||'''Company name of contact or lead'''
|@companyname@
+
||@companyname@
 
|-
 
|-
|'''Contact address - not available for lead'''
+
||'''Contact address - not available for lead'''
|@caddress@
+
||@caddress@
 
|-
 
|-
|'''Contact city - not available for lead'''
+
||'''Contact city - not available for lead'''
|@ccity@
+
||@ccity@
 
|-
 
|-
|'''Contact state/province - not available for lead'''
+
||'''Contact state/province - not available for lead'''
|@cstate@
+
||@cstate@
 
|-
 
|-
|'''Contact country - not available for lead'''
+
||'''Contact country - not available for lead'''
|@ccountry@
+
||@ccountry@
 
|-
 
|-
|'''Contact postal code - not available for lead'''
+
||'''Contact postal code - not available for lead'''
|@cpostalcode@
+
||@cpostalcode@
 
|-
 
|-
|'''Contact fax - not available for lead'''
+
||'''Contact fax - not available for lead'''
|@cfax@
+
||@cfax@
 
|-
 
|-
|'''Web site for lead - not available for contact'''
+
||'''Web site for lead - not available for contact'''
|@cwebsite@
+
||@cwebsite@
 
|-
 
|-
|'''First name of the sender'''
+
||'''First name of the sender'''
|@senderfirstname@
+
||@senderfirstname@
 
|-
 
|-
|'''Last name of the sender'''
+
||'''Last name of the sender'''
|@senderlastname@
+
||@senderlastname@
 
|-
 
|-
|'''Name of sender company'''
+
||'''Name of sender company'''
|@sendercompany@
+
||@sendercompany@
 
|-
 
|-
|'''E-mail of sender'''
+
||'''E-mail of sender'''
|@senderemail@
+
||@senderemail@
 
|-
 
|-
|'''Phone number of sender'''
+
||'''Phone number of sender'''
|@senderphone@
+
||@senderphone@
 
|-
 
|-
|'''Title of sender'''
+
||'''Title of sender'''
|@sendertitle@
+
||@sendertitle@
 
|-
 
|-
|'''Current date and time format selected by the user in their personal settings ? long date format'''
+
||'''Current date and time format selected by the user in their personal settings ? long date format'''
|@now@
+
||@now@
 
|-
 
|-
|'''Description field content'''
+
||'''Description field content'''
|@objectdescription@
+
||@objectdescription@
 
|}
 
|}
  
 
==Roles==
 
==Roles==
 +
'''@rolelist@''' provides a list of [[roleid]]s corresponding to the roles the user belongs to.
  
'''@rolelist@''' provides a list of [[roleid]]s corresponding to the roles the user belongs to.
 
 
  @me.rolelist@
 
  @me.rolelist@
  
'''@primaryroleid@''' provides the id for the user's primary role. Do not use the prefix '@me.'.  
+
'''@primaryroleid@''' provides the id for the user's primary role. Do not use the prefix '@me.'.
 +
 
 
  @primaryroleid@
 
  @primaryroleid@
  
 
==Company Categories==
 
==Company Categories==
 
'''@catlist@''' lists the roleid of each Company Category the company (Account/Organization) belongs to.
 
'''@catlist@''' lists the roleid of each Company Category the company (Account/Organization) belongs to.
 +
 
  @me.parent.catlist@
 
  @me.parent.catlist@
  
 
==Custom Fields attached to Roles==
 
==Custom Fields attached to Roles==
 
 
'''@rolename.customfieldname@'''
 
'''@rolename.customfieldname@'''
  
 
==[[Using Variables in the Report Builder|Variables available for Report criteria]]==
 
==[[Using Variables in the Report Builder|Variables available for Report criteria]]==
 
 
* '''@userid@'''
 
* '''@userid@'''
* '''@companyid@'''  
+
* '''@companyid@'''
 
* '''@objectid@'''
 
* '''@objectid@'''
  
Line 862: Line 869:
  
 
==Using Variables in the Report Template Header==
 
==Using Variables in the Report Template Header==
 
 
* '''@args[1]@, @args[2]@''' - used within Report Template Header to obtain the criteria entered by users.
 
* '''@args[1]@, @args[2]@''' - used within Report Template Header to obtain the criteria entered by users.
 
* '''@runtime@''' - used within Report Template Header to obtain date/time report was run.
 
* '''@runtime@''' - used within Report Template Header to obtain date/time report was run.
  
 
==Applicant Tracking Email Template Variables==
 
==Applicant Tracking Email Template Variables==
 
 
The following variables are used to create email templates:
 
The following variables are used to create email templates:
  
Line 874: Line 879:
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Job Fields Variable List
 
|+style="text-align:left"|Job Fields Variable List
!Field Name
 
!Variable
 
 
|-
 
|-
|@job.name@
+
!|Field Name
|'''Job name'''
+
!|Variable
 
|-
 
|-
|@job.client@  
+
||@job.name@
|'''Associated name of the client'''
+
||'''Job name'''
 
|-
 
|-
|@job.stage@
+
||@job.client@
|'''Status of the job'''
+
||'''Associated name of the client'''
 
|-
 
|-
|@job.closedate@
+
||@job.stage@
|'''Hiring close date of the job'''
+
||'''Status of the job'''
 
|-
 
|-
|@job.manager@
+
||@job.closedate@
|'''Hiring Manger – set on the job page'''
+
||'''Hiring close date of the job'''
 
|-
 
|-
|@job.description@
+
||@job.manager@
|'''Job description'''
+
||'''Hiring Manger – set on the job page'''
 
|-
 
|-
|@job.type@
+
||@job.description@
|'''Template name for this job'''
+
||'''Job description'''
 
|-
 
|-
|@job.startdate@
+
||@job.type@
|'''Job start date'''
+
||'''Template name for this job'''
 
|-
 
|-
|@job.enddate@
+
||@job.startdate@
|'''Job end date – contract only'''
+
||'''Job start date'''
 
|-
 
|-
|@job.requirements@
+
||@job.enddate@
|'''Job requirements'''
+
||'''Job end date – contract only'''
 
|-
 
|-
|@job.openpositions@
+
||@job.requirements@
|'''Number of open positions'''
+
||'''Job requirements'''
 
|-
 
|-
|@job.applicantfilled@
+
||@job.openpositions@
|'''Number of hired applicants'''
+
||'''Number of open positions'''
 
|-
 
|-
|@job.branch@
+
||@job.applicantfilled@
|'''Internal branch name associated with this job'''
+
||'''Number of hired applicants'''
 
|-
 
|-
|@job.branch.address@
+
||@job.branch@
|'''Internal branch address 1'''
+
||'''Internal branch name associated with this job'''
 
|-
 
|-
|@job.branch.address2@
+
||@job.branch.address@
|'''Internal branch address 2'''
+
||'''Internal branch address 1'''
 
|-
 
|-
|@job.branch.city@
+
||@job.branch.address2@
|'''Internal branch city'''
+
||'''Internal branch address 2'''
 
|-
 
|-
|@job.branch.state@
+
||@job.branch.city@
|'''Internal branch state/province'''
+
||'''Internal branch city'''
 
|-
 
|-
|@job.branch.phone@
+
||@job.branch.state@
|'''Internal branch phone number'''
+
||'''Internal branch state/province'''
 
|-
 
|-
|@job.branch.country@
+
||@job.branch.phone@
|'''Internal branch country'''
+
||'''Internal branch phone number'''
 
|-
 
|-
|@job.branch.postalcode@
+
||@job.branch.country@
|'''Internal branch zip/postal code'''
+
||'''Internal branch country'''
 
|-
 
|-
|@job.branch.website@
+
||@job.branch.postalcode@
|'''Internal branch web site address'''
+
||'''Internal branch zip/postal code'''
 
|-
 
|-
|@job.client@
+
||@job.branch.website@
|'''Client name'''
+
||'''Internal branch web site address'''
 
|-
 
|-
|@job.client.address@
+
||@job.client@
|'''Client address one'''
+
||'''Client name'''
 
|-
 
|-
|@job.client.address2@
+
||@job.client.address@
|'''Client address two'''
+
||'''Client address one'''
 
|-
 
|-
|@job.client.city@  
+
||@job.client.address2@
|'''Client city'''
+
||'''Client address two'''
 
|-
 
|-
|@job.client.state@
+
||@job.client.city@
|'''Client state/province'''
+
||'''Client city'''
 
|-
 
|-
|@job.client.phone@
+
||@job.client.state@
|'''Client phone number'''
+
||'''Client state/province'''
 
|-
 
|-
|@job.client.country@
+
||@job.client.phone@
|'''Client country'''
+
||'''Client phone number'''
 
|-
 
|-
|@job.client.postalcode@
+
||@job.client.country@
|'''Client zip/postal code'''
+
||'''Client country'''
 
|-
 
|-
|@job.client.website@
+
||@job.client.postalcode@
|'''Client web site'''
+
||'''Client zip/postal code'''
 
|-
 
|-
|@job.custom@
+
||@job.client.website@
|'''Custom field associated with the job template. For example @job.additionalinfo@'''
+
||'''Client web site'''
 +
|-
 +
||@job.custom@
 +
||'''Custom field associated with the job template. For example @job.additionalinfo@'''
 
|}
 
|}
  
 
==Applicant Fields==
 
==Applicant Fields==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Applicant Fields Variable List
 
|+style="text-align:left"|Applicant Fields Variable List
!Field Name
 
!Variable
 
 
|-
 
|-
|@applicant.firstname@
+
!|Field Name
|'''First name of the applicant'''
+
!|Variable
 
|-
 
|-
|@applicant.lastname@
+
||@applicant.firstname@
|'''Last name of applicant'''
+
||'''First name of the applicant'''
 
|-
 
|-
|@applicant.title@
+
||@applicant.lastname@
|'''Title of applicant'''
+
||'''Last name of applicant'''
 
|-
 
|-
|@applicant.email@
+
||@applicant.title@
|'''Email address of applicant'''
+
||'''Title of applicant'''
 
|-
 
|-
|@applicant.phone@
+
||@applicant.email@
|'''Phone number of applicant'''
+
||'''Email address of applicant'''
 
|-
 
|-
|@applicant.address@
+
||@applicant.phone@
|'''Address of applicant'''
+
||'''Phone number of applicant'''
 
|-
 
|-
|@applicant.city@
+
||@applicant.address@
|'''City of applicant'''
+
||'''Address of applicant'''
 
|-
 
|-
|@applicant.state@
+
||@applicant.city@
|'''State/Province of applicant'''
+
||'''City of applicant'''
 
|-
 
|-
|@applicant.country@
+
||@applicant.state@
|'''Country of applicant'''
+
||'''State/Province of applicant'''
 
|-
 
|-
|@applicant.countrycode@
+
||@applicant.country@
|'''Country code (2 letter abbreviation) of applicant'''
+
||'''Country of applicant'''
 
|-
 
|-
|@applicant.postalcode@
+
||@applicant.countrycode@
|'''Zip/Postal applicant'''
+
||'''Country code (2 letter abbreviation) of applicant'''
 +
|-
 +
||@applicant.postalcode@
 +
||'''Zip/Postal applicant'''
 
|}
 
|}
  
 
==Hiring Manager Fields==
 
==Hiring Manager Fields==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Level 1 Field Name and Variable List
 
|+style="text-align:left"|Level 1 Field Name and Variable List
!Field Name
 
!Variable
 
 
|-
 
|-
|@hiring manager.firstname@
+
!|Field Name
|'''First name of the hiring manager'''
+
!|Variable
 +
|-
 +
||@hiring manager.firstname@
 +
||'''First name of the hiring manager'''
 
|-
 
|-
|@hiring manager.lastname@
+
||@hiring manager.lastname@
|'''Last name of the hiring manager'''
+
||'''Last name of the hiring manager'''
 
|-
 
|-
|@hiring manager.title@
+
||@hiring manager.title@
|'''Title of the hiring manager'''
+
||'''Title of the hiring manager'''
 
|-
 
|-
|@hiring manager.email@
+
||@hiring manager.email@
|'''Email address of the hiring manager'''
+
||'''Email address of the hiring manager'''
 
|-
 
|-
|@hiring manager.phone@
+
||@hiring manager.phone@
|'''Phone number of the hiring manager'''
+
||'''Phone number of the hiring manager'''
 
|-
 
|-
|@hiring manager.address@
+
||@hiring manager.address@
|'''Address of the hiring manager'''
+
||'''Address of the hiring manager'''
  
 
|-
 
|-
|@hiring manager.city@
+
||@hiring manager.city@
|'''City of the hiring manager'''
+
||'''City of the hiring manager'''
 
|-
 
|-
|@hiring manager.state@
+
||@hiring manager.state@
|'''State/Province of the hiring manager'''
+
||'''State/Province of the hiring manager'''
 
|-
 
|-
|@hiring manager.country@
+
||@hiring manager.country@
|'''Country of the hiring manager'''
+
||'''Country of the hiring manager'''
 
|-
 
|-
|@hiring manager.countrycode@
+
||@hiring manager.countrycode@
|'''Country Code (2 letter abbreviation) of the hiring manager'''
+
||'''Country Code (2 letter abbreviation) of the hiring manager'''
 
|-
 
|-
|@hiring manager.postalcode@
+
||@hiring manager.postalcode@
|'''Zip/Postal code of the hiring manager'''
+
||'''Zip/Postal code of the hiring manager'''
 
|}
 
|}
  
 
==Sender Fields==
 
==Sender Fields==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Sender Fields Variable List
 
|+style="text-align:left"|Sender Fields Variable List
!Field Name
 
!Variable
 
 
|-
 
|-
|@senderfirstname@
+
!|Field Name
|'''First name of the sender'''
+
!|Variable
 
|-
 
|-
|@senderlastname@
+
||@senderfirstname@
|'''Last name of the sender'''
+
||'''First name of the sender'''
 
|-
 
|-
|@sendercompany@
+
||@senderlastname@
|'''Name of sender company'''
+
||'''Last name of the sender'''
 
|-
 
|-
|@senderemail@
+
||@sendercompany@
|'''Email address of sender'''
+
||'''Name of sender company'''
 
|-
 
|-
|@senderphone@
+
||@senderemail@
|'''Phone number of sender'''
+
||'''Email address of sender'''
 
|-
 
|-
|@sendertitle@
+
||@senderphone@
|'''Title of sender'''
+
||'''Phone number of sender'''
 
|-
 
|-
|@now@
+
||@sendertitle@
|'''Current date and time format selected by the user in their personal settings - long date format'''.
+
||'''Title of sender'''
 +
|-
 +
||@now@
 +
||'''Current date and time format selected by the user in their personal settings - long date format'''.
 
|}
 
|}
  
 +
In addition you can also refer to fields from the sender such as custom fields and company details by using '''@sender.xxxx@''' <br />
 +
These variables can be used within [[:Category:Email|Email]] and [[Workflow]] messages.
  
In addition you can also refer to fields from the sender such as custom fields and company details by using '''@sender.xxxx@''' <br>
 
These variables can be used within [[:Category:Email|Email]] and [[Workflow]] messages.
 
  
  
 
{| class="wikitable"
 
{| class="wikitable"
!Field Name
 
!Variable
 
 
|-
 
|-
|@sender.address@
+
!|Field Name
|'''Address of the sender'''
+
!|Variable
 +
|-
 +
||@sender.address@
 +
||'''Address of the sender'''
 
|-
 
|-
|@sender.company.name@
+
||@sender.company.name@
|'''Name of the company the sender is associated with'''
+
||'''Name of the company the sender is associated with'''
 
|-
 
|-
|@sender.(custom field name)@
+
||@sender.(custom field name)@
|'''Refers to a custom field from the sender's profile'''
+
||'''Refers to a custom field from the sender's profile'''
 
|}
 
|}
  
== Workflow Specific Variables ==
+
==Workflow Specific Variables==
 
 
 
The following variables can only be used in messages associated with workflows:
 
The following variables can only be used in messages associated with workflows:
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Workflow Specific Variables List
 
|+style="text-align:left"|Workflow Specific Variables List
!Field Name
 
!Variable
 
 
|-
 
|-
|'''@objectname@'''
+
!|Field Name
|Name of the object in the workflow. This could be a file name, user name, company name, or an application name.
+
!|Variable
 +
|-
 +
||'''@objectname@'''
 +
||Name of the object in the workflow. This could be a file name, user name, company name, or an application name.
 
|-
 
|-
|'''@originatorname@'''
+
||'''@originatorname@'''
|The name of the person that originated the workflow. For example, this value could be the person that added a file to a workflow-enabled SmartFolder, or the name of a person that created a new person record.
+
||The name of the person that originated the workflow. For example, this value could be the person that added a file to a workflow-enabled SmartFolder, or the name of a person that created a new person record.
 
|-
 
|-
|'''@originatoremail@'''
+
||'''@originatoremail@'''
|E-mail address of originator.
+
||E-mail address of originator.
 
|-
 
|-
|'''@originatorphone@'''
+
||'''@originatorphone@'''
|Phone number of originator.
+
||Phone number of originator.
 
|}
 
|}
 
  
 
{{Template:Signority Variables}}
 
{{Template:Signority Variables}}
  
== Other Variables ==
+
==Other Variables==
 
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+style="text-align:left"|Level 1 Field Name and Variable List
 
|+style="text-align:left"|Level 1 Field Name and Variable List
!Field Name
 
!Variable
 
 
|-
 
|-
|'''@url@'''
+
!|Field Name
|The URL to the company alias for SmartSimple.  For example: XXX.smartsimple.com – where XXX is the alias created by that company using the Company Setting page. If you wish to display the URL as a link you should type either: '''http://''' or '''https://''' in front of the reference in the instant message or e-mail template.  For example: <nowiki>https://@url@</nowiki>
+
!|Variable
 
|-
 
|-
|'''@parentlist@'''
+
||'''@url@'''
|The full SmartSimple path to the object.
+
||The URL to the company alias for SmartSimple. For example: XXX.smartsimple.com – where XXX is the alias created by that company using the Company Setting page. If you wish to display the URL as a link you should type either: '''http://''' or '''https://''' in front of the reference in the instant message or e-mail template. For example: <nowiki>https://@url@</nowiki>
 
|-
 
|-
|'''@apptype@'''
+
||'''@parentlist@'''
|Will return the [[Determining the applicationid|application ID]] within the context of a given [[UTA]].
+
||The full SmartSimple path to the object.
 +
|-
 +
||'''@apptype@'''
 +
||Will return the [[Determining the applicationid|application ID]] within the context of a given [[UTA]].
 
|}
 
|}
  
Line 1,160: Line 1,166:
 
===Select One - User Group Custom Field===
 
===Select One - User Group Custom Field===
 
The details of the members of a group stored within a [[Select One - User Group]] custom field can be referenced using the following syntax:
 
The details of the members of a group stored within a [[Select One - User Group]] custom field can be referenced using the following syntax:
:<font size="3">'''[#(?object=group::id=@''fieldname''@) ... #]'''</font>
 
  
 +
: <span style="font-size: medium;">'''[#(?object=group::id=@''fieldname''@) ... #]'''</span>
 
'''Where:'''
 
'''Where:'''
 +
 
* ''fieldname'' is the name of the '''Select One - User Group''' field.
 
* ''fieldname'' is the name of the '''Select One - User Group''' field.
 
* Replace "..." with the contact [[variables]] you wish to display. ''i.e. ~lastname~
 
* Replace "..." with the contact [[variables]] you wish to display. ''i.e. ~lastname~

Revision as of 14:20, 24 March 2017

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@

Note: Library variables are available in all instances but can only be created and edited by SmartSimple.

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

Level 1 Field Name and Variable List
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 (full name - Consumer/Provider reference) @ownername@
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 ID @statusid@
Status Caption @statuscaption@
Status Language @status_lang@
Status Name @statusname@
Workflow No variables

Level 2

Level 2 Field Names and Variables List
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

Level 3 Field Names and Variables
Field Name Variable
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

Contacts/Users Field Names and Variables
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@
State @state@
Country @country@
Country Code (2 letter abbreviation) @countrycode@
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
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 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

Calling L1 and L2 fields from a L2 Workbflow
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 can be Company, Level 1, Opportunity or Leads

Company

State|@state@|->

Level 1 Name and Variable List
Name Variable
Primary Contact @primarycontact@
Company Name @name@
Address @address@
Address 2 @address2@
City @city@
Province @province@
Postal code @postalcode@
Country @country@
Country Code (2 letter abbreviation) @countrycode@
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

Opportunity & Level 1
Field Name Variable
Branch @branch@
Close Date @closedate@
Company field @company.field@
Contacts @contact.rolename.field@
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 for opportunities that use 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

Leads Variable List
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 @email@
Description @description@
Date Added @dat_added@

Email Broadcast

Email Broadcast Variable List
Field Name Variable
@rolename.customfield@
@randompassword@ Generates a new password when sending to user
@password@ Generates a new password when sending to user
@email@ Sends the username/E-mail
@userid@ Sends the user id
@sender.fieldname@ manner of referencing details of the user who is sending the email
Note:
  • examples: @sender.company.address@ will return the address of the sender's company.
  • Includes All standard contact fields
  • Includes All standard company fields

Contacts

Level 1 Field Name and Variable List
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 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

  • @userid@
  • @companyid@
  • @objectid@

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

  • @args[1]@, @args[2]@ - used within Report Template Header to obtain the criteria entered by users.
  • @runtime@ - used within Report Template Header to obtain date/time report was run.

Applicant Tracking Email Template Variables

The following variables are used to create email templates:

Job Fields

Job Fields Variable List
Field Name Variable
@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 Manger – 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

Applicant Fields Variable List
Field Name Variable
@applicant.firstname@ First name of the applicant
@applicant.lastname@ Last name of applicant
@applicant.title@ Title of applicant
@applicant.email@ Email address of applicant
@applicant.phone@ Phone number of applicant
@applicant.address@ Address of applicant
@applicant.city@ City of applicant
@applicant.state@ State/Province of applicant
@applicant.country@ Country of applicant
@applicant.countrycode@ Country code (2 letter abbreviation) of applicant
@applicant.postalcode@ Zip/Postal applicant

Hiring Manager Fields

Level 1 Field Name and Variable List
Field Name Variable
@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

Sender Fields Variable List
Field Name Variable
@senderfirstname@ First name of the sender
@senderlastname@ Last name of the sender
@sendercompany@ Name of sender company
@senderemail@ Email address of sender
@senderphone@ Phone number of sender
@sendertitle@ Title of sender
@now@ Current date and time format selected by the user in their personal settings - long date format.

In addition you can also refer to fields from the sender such as custom fields and company details by using @sender.xxxx@
These variables can be used within Email and Workflow messages.


Field Name Variable
@sender.address@ Address of the sender
@sender.company.name@ Name of the company the sender is associated with
@sender.(custom field name)@ Refers to a custom field from the sender's profile

Workflow Specific Variables

The following variables can only be used in messages associated with workflows:

Workflow Specific Variables List
Field Name Variable
@objectname@ Name of the object in the workflow. This could be a file name, user name, company name, or an application name.
@originatorname@ The name of the person that originated the workflow. For example, this value could be the person that added a file to a workflow-enabled SmartFolder, or the name of a person that created a new person record.
@originatoremail@ E-mail address of originator.
@originatorphone@ Phone number of originator.

Signority Variables

SmartSimple's Online Document Signing functionality allows users to manage the entire signing process.

Users can also access details on how the e-signature submission is progressing using the variables below

@HistoryOf(CFNAME,1)@ - will show only the top section of the history i.e. section that displays the overall status of the e-signature submission

@HistoryOf(CFNAME,0)@ - will show only the bottom section of the history i.e. section that displays the progress of the individual signees

@HistoryOf(CFNAME)@ - will display both top and bottom section by default

Other Variables

Level 1 Field Name and Variable List
Field Name Variable
@url@ The URL to the company alias for SmartSimple. For example: XXX.smartsimple.com – where XXX is the alias created by that company using the Company Setting page. If you wish to display the URL as a link you should type either: http:// or https:// in front of the reference in the instant message or e-mail template. For example: https://@url@
@parentlist@ The full SmartSimple path to the object.
@apptype@ Will return the application ID within the context of a given UTA.

Select One - User Group Custom Field

The details of the members of a group stored within 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 the user is assigned within the group can be accessed using ~role~ in the above syntax.

See Also