Changes

Jump to: navigation, search

Variable Processor

92 bytes added, 12:59, 16 October 2017
no edit summary
The most common use of the Variable Processor is to reference a field value. Variable references are denoted in general by a field name encapsulated by the @ symbol. The most basic form of variable is:
<code>@''fieldname''@</code>
Where ''fieldname'' is simply the name of a custom field or one of the pre-defined standard fields as listed in the appendix for each of the record types. This form is used when the field exists on the record that you are viewing. For example, if we are viewing a user profile and wish to reference that user's first name we can configure a variable '''@firstname@'''.
===Record Level===
You can also reference information from other records by defining the record level of the field with the following syntax:
<code>@''record''.''fieldname''@</code>
Where ''record'' defines a different record that you wish to reference a field from. For example, if we are again viewing a user profile but wish to reference the company name of that user we can configure a variable '''@parent.name@'''. In this example, we are currently on a user profile, and in order to reference information from the user's parent company we reference one level up using 'parent'.
Record levels can also be nested to refer to records that are multiple levels apart. For example, if we wish to reference the company name of the user that is currently logged in we can configure a variable '''@me.parent.name@'''. Here we see two records mentioned, the first for 'me' starts at the user currently logged in, and then 'parent' to traverse one level up. Another example of valid syntax could be '''@parent.parent.parent.''fieldname''@'''.
===Record Level===Record levels are used within a variable reference to define the record in question. The following are some examples that can be used in a variable reference. For these examples assume the following scenario:
* You are logged in as 'SmartSimple Support'
* Your parent company is the 'Customer Support' department
===Field Attributes===
Specific attributes of a field can also be referencedto get different information about a field. The following are some examples that can be used in a variable reference.general syntax syntax to do this is:
@''record''.''fieldname''.''attribute''@ The following are some examples that can be used in a variable reference. For these examples assume the following scenario:
*A custom field with ID '132547', named 'Gender' that is configured as a Select One - Combo Box field with options '1=Male;2=Female;'
*A custom field with ID '243657', named 'Text' that is configured as a Text Box - Single Line field with caption 'Enter Text Here'
The following syntax is available in order to explicitly specify the display of a date formatted field. For example, to always display the date in 'YYYY-MM-DD HH:MM am/pm' you can define a variable '''@year(''fieldname'')@-@month(''fieldname'')@-@day(''fieldname'')@ @hour(''fieldname'')@:@minute(''fieldname'')@ @ampm(''fieldname'')@'''.
The following are some examples that can be used in a variable reference. For these examples assume the following scenario:
*A record where we have entered the standard field Start Date as '2017-01-02' at '22:52'
===Record Level===
Record levels are used within a variable reference to define the record in question.  The following are some examples that can be used in a variable reference.
{| class="wikitable"
Smartstaff, administrator
686
edits

Navigation menu