Difference between revisions of "Web Page View Field Variables"

From SmartWiki
Jump to: navigation, search
(→‎How to display the Transaction types)
(→‎Syntax)
 
(295 intermediate revisions by 25 users not shown)
Line 1: Line 1:
 
The [[Web Page View Field]] provides the ability to display a fully formatted document or web page.
 
The [[Web Page View Field]] provides the ability to display a fully formatted document or web page.
  
−
In constructing this type of page HTML is used in conjunction with the following variables.  
+
In constructing this type of page HTML is used in conjunction with the following variables.
  
−
==Variable List==
+
=Variable List=
−
 
+
==Current User==
−
<u>'''User Variables'''</u>
+
''Note: "me" -- refers to the current user''
−
 
 
−
'''@me -- means current user'''
 
  
 
'''@me.firstname@ will be replaced by current user's firstname'''
 
'''@me.firstname@ will be replaced by current user's firstname'''
Line 19: Line 17:
 
'''@me.companyname@'''
 
'''@me.companyname@'''
  
−
<u>'''UTA Level 1, Sales Opportunity and Job Variables'''</u>
+
'''@me.type@''' (returns 'User', 'Local User Administrator' or 'Global User Administrator')
  
−
'''@name@'''
+
==UTA Level 1, Sales Opportunity and Job Variables==
 +
'''@name@''' - standard field '''Application Name'''.
  
−
'''@type@'''
+
'''@type@''' - standard field '''Application Template Type'''.
  
−
'''@status@'''
+
'''@status@''' - standard field '''Status'''
 +
 
 +
'''@typecaption@''' - standard field '''Application Template Type Caption'''.
 +
 
 +
'''@statuscaption@''' - standard field '''Status Caption'''
 +
 
 +
'''@type_lang@''' - standard field '''Application Template Type (Based on user language setting)'''.
 +
 
 +
'''@status_lang@''' - standard field '''Status (Based on user language setting)'''
  
 
'''@description@'''
 
'''@description@'''
Line 36: Line 43:
  
 
'''@probability@'''
 
'''@probability@'''
 +
 +
'''@modifiedby@''' / '''@modifiedbyid@'''
  
 
'''@modifieddate@'''
 
'''@modifieddate@'''
Line 44: Line 53:
  
 
'''@enddate@'''
 
'''@enddate@'''
 +
 +
'''@createddate@'''
 +
 +
'''@createdby@'''
 +
 +
'''@createdbyid@'''
  
 
'''@jobquestions@''' - displays as combo boxes
 
'''@jobquestions@''' - displays as combo boxes
Line 52: Line 67:
  
  
−
'''@owner.field@'''
+
'''@owner.field@'''
  
 
Example: '''@owner.fullname@''' or '''@owner.address@'''
 
Example: '''@owner.fullname@''' or '''@owner.address@'''
  
 +
'''@person.field@'''
  
−
'''@company.field@'''
+
Example: '''@person.fullname@''' or '''@person.address@'''
 +
 
 +
 
 +
'''@company.field@'''
  
 
Example: '''@company.name@''' or '''@company.address@'''
 
Example: '''@company.name@''' or '''@company.address@'''
  
  
−
'''@branch.field@'''  
+
'''@company.owner.field@'''
−
+
 
 +
Example '''@company.owner.email@'''
 +
 
 +
'''@branch.field@'''
 +
 
 
Example: '''@branch.name@''' or '''@branch.address@'''
 
Example: '''@branch.name@''' or '''@branch.address@'''
  
 +
'''@apptype@''' the Application ID (appid) of the UTA.
  
−
<u>'''UTA Level 2 / Activities Variables'''</u>
+
==UTA Level 2 / Activities Variables==
−
 
 
 
'''@subject@'''
 
'''@subject@'''
  
Line 102: Line 125:
  
 
'''@owner@'''
 
'''@owner@'''
 +
 +
'''@eownerid@''' - userid of the owner
  
 
'''@contact@'''
 
'''@contact@'''
Line 108: Line 133:
  
 
'''@eventid@'''
 
'''@eventid@'''
 +
 +
'''@typename@'''
  
 
'''@objectid@'''
 
'''@objectid@'''
Line 115: Line 142:
 
'''@rootcompanyid@'''
 
'''@rootcompanyid@'''
  
 +
'''@rootcompany.name@'''
  
 
'''@contact.field@'''
 
'''@contact.field@'''
Line 128: Line 156:
  
 
Example: @contact.company.address@ or @contact.company.city@
 
Example: @contact.company.address@ or @contact.company.city@
−
 
−
'''@parent.field@''' (Note: All field names should be entirely lower case.)
 
−
 
−
Example: @parent.name@ or @parent.startdate@ or @parent.#id#@
 
  
 
<u>'''Custom Field Variables'''</u>
 
<u>'''Custom Field Variables'''</u>
Line 143: Line 167:
 
Example: @more information@ or @#17342#@
 
Example: @more information@ or @#17342#@
  
−
'''Tip for Users''': It is recommended to use the [[Custom Field|custom field]] id in order to avoid conflicts with possible duplicate field names. The field id can be found in the far right column when looking at the [[Custom Field|custom field]] list.
 
  
−
==Field List==
+
See Also: [[Invoice Module Variables]] for Variables specific to the Invoicing module.
 +
 
 +
 
 +
<u>'''UTA Level 1 variables called from UTA Level 2'''</u>
 +
 
 +
If your '''Web Page View''' is at Level 2, you can call Level 1 variables using:
 +
 
 +
'''@parent.'''''fieldname'''''@''' or '''@parent.#'''''fieldid'''''#@''' (Note: All field names should be entirely lower case.)
 +
 
 +
Example: '''@parent.status@''' or '''@parent.startdate'''@ or '''@parent.#12345#@'''
 +
 
 +
 
 +
==UTA Level 2 variables called from UTA Level 3==
 +
When working at Level 3, you can call Level 2 variables using:
 +
 
 +
'''@parent.'''''fieldname'''''@''' or '''@parent.#'''''fieldid'''''#@''' (Note: All field names should be entirely lower case.)
  
 +
 +
<u>'''UTA Level 1 variables called from UTA Level 3'''</u>
 +
 +
If your '''Web Page View''' is at Level 3, you can call Level 1 variables using:
 +
 +
'''@parent.parent.'''''fieldname'''''@''' or '''@parent.parent.#'''''fieldid'''''#@''' (Note: All field names should be entirely lower case.)
 +
 +
 +
<u>'''Level 3 Associated Parent (Opportunity) '''</u>
 +
 +
Where Payment Allocation is enabled you have two models to choose from before configuring: usually the Associated Parent is a Funding Stream of Overall Budget (event) and the associated object is the Disbursement (Level 3). In less granular cases the Associated Parent is the opportunity.
 +
 +
<u>'''Level 3 Associated Parent'''</u>
 +
 +
 +
If Payment Allocation is enabled, you can pull fields from the Associated Parent using the following variable:
 +
 +
'''@linkparent.''fieldname''@'''
 +
 +
If your associated payment is linked to the event you can pull fields from the opporunity using the following variable:
 +
 +
'''@linkparent.''parent''.fieldname@''' So '''@linkparent.''parent''.branch@''' will return: '''SmartSimple Inc.'''
 +
 +
On the company/branch:
 +
 +
'''@linkparent.parent.branch.''Transit''@''' will return: '''''1950'''''
 +
 +
=Field List=
 
<u>'''People Fields'''</u>
 
<u>'''People Fields'''</u>
  
 
firstname, lastname, fullname, title, email, phone, company, address, address2, city,
 
firstname, lastname, fullname, title, email, phone, company, address, address2, city,
−
province, state, country, postalcode, owner, modifieddate, cost, costunit, type,  
+
province, state, country, postalcode, owner, modifieddate, cost, costunit, type,
−
resourcename, isrecource, prefix, suffix, uphoneext  
+
resourcename, isrecource, uprefix (prefix), usuffix (suffix), uphoneext (Phone Extension)
  
 
<u>'''Company Fields'''</u>
 
<u>'''Company Fields'''</u>
  
−
name, address, address2, city, province, state, country, postalcode, phone, fax, website  
+
name, address, address2, city, province, state, country, postalcode, phone, fax, website
  
 
<u>'''Lead Fields'''</u>
 
<u>'''Lead Fields'''</u>
  
−
status, description, name, phone, fax, address, address2, city, state, province, country,  
+
status, description, name, phone, fax, address, address2, city, state, province, country,
 
postalcode, website, firstname, lastname, contactphone, title, email, dat_added
 
postalcode, website, firstname, lastname, contactphone, title, email, dat_added
  
−
==How to display contact information for people associated in the Contacts section==
+
=UTA Contact and Account Variables=
 +
Owner:
 +
 
 +
: <span style="font-size: medium;">'''@owner.''fieldname''@'''</span>
 +
Person (Level 1 only):
 +
 
 +
: <span style="font-size: medium;">'''@person.''fieldname'''''@</span>
 +
Assigned (Level 2 only):
 +
 
 +
: <span style="font-size: medium;">'''@assigned.''fieldname''@'''</span>
 +
Company (Level 1 only):
  
−
'''Use the variable''':
+
: <span style="font-size: medium;">'''@client.''fieldname''@'''</span>
 +
Use @client.categoryids@ to return a list of [[Determining the categoryid|category IDs]] - comma delimited - note the leading comma - e.g. ",1234,555,666,"
  
−
@contact.rolename.field@
+
Use @client.categories@ to return a list of category names - comma delimited e.g. "Agency,Marketing,Good client"
  
−
'''where'''
+
==Level 1 Contacts/Accounts==
 +
===Individual===
 +
To display information for a <u>single</u> contact/account in the Level 1 contacts/accounts section:
  
−
'''rolename = the name of the role that has been assigned to the contact on the Level One item'''
+
: <span style="font-size: medium;">'''@contact.''rolename.fieldname''@''' </span> &nbsp; or &nbsp; <span style="font-size: medium;"> '''@company.''rolename.fieldname''@'''</span>
 +
'''where:'''
  
−
'''field = the name of the field that is located on the contact's record'''.
+
* ''rolename'' = the name of the role that has been assigned to the contact/account on the Level One item
 +
* ''fieldname'' = the name of the field that is located on the contact's record.
 +
Example:
  
 +
@contact.adjuster.firstname@ or @company.funding agency.address@
  
−
Example: @contact.adjuster.firstname@ or @contact.project manager.address@
+
Note: if there is more than one contact/account assigned with the rolename specified, only one will be displayed.
  
−
==How to display a list of UTA Level 1 Activities, Contacts or Companies==
+
===List===
 +
To display a list of multiple contacts/accounts in the Level 1 contacts/accounts section:
  
−
'''object= [activity,contact,user,company,association,level-1 (applies to contacts only) or transaction]'''
+
: <span style="font-size: medium;">'''[#(?object=contact) ~''fieldname''~ #]''' </span> or <span style="font-size: medium;"> '''[#(?object=company) ~''fieldname''~ #]''' </span>
 +
See [[#To display a list of Activities (Level 2 or 3), Notes, Contacts or Companies|below]] for details on how to filter and sort the list(s).
  
−
<pre><table>[#(?object=object;orderby=field)<tr><td>~field~</td><td>~field~</td><td>~field~</td><td>$customfield id$</td></tr>#]</table></pre>
+
* '''Note''': to display the role that the contact or account is assigned on the Level 1 record use: <span style="font-size: medium;">'''~role~'''</span>
 +
* '''Note''': to display the name of the contact's company use: <span style="font-size: medium;">'''~companyname~'''</span>
  
−
'''Example''':
+
==Level 2 Contacts/Accounts==
−
<pre>
+
===Individual===
−
<table>[#(?object=activity;orderby=startdate)<tr><td>~subject~</td><td>~location~</td><td>~startdate~</td></tr>#]</table>  
+
To display information for a <u>single</u> contact in the Level 2 contacts section:
 +
 
 +
: <span style="font-size: medium;">'''@contacts.''rolename.fieldname''@''' </span>
 +
'''where:'''
  
−
<table>[#(?object=contact;orderby=lastname)<tr><td>~firstname~</td><td>~lastname~</td><td>~email~</td></tr>#]</table>
+
* ''rolename'' = the name of the role that has been assigned to the contact on the Level Two item
 +
* ''fieldname'' = the name of the field that is located on the contact's record.
 +
Example:
  
−
  <table>[#(?object=contact;orderby=lastname;criteria=role='Internal People')<tr><td>~firstname~</td><td>~lastname~</td><td>~email~</td></tr>#]</table>
+
  @contacts.adjuster.firstname@
−
</pre>
 
−
'''To list a specific activity type only''':
 
−
<pre>
 
−
<table>[#(?object=activity;orderby=startdate;criteria=typename='')<tr><td>~subject~</td><td>~location~</td><td>~startdate~</td></tr>#]</table>
 
  
−
e.g. where typename='activity name'
+
Note: if there is more than one contact assigned with the rolename specified, only one will be displayed.
  
−
<table>[#(?object=activity;orderby=startdate;criteria=typeid='')<tr><td>~subject~</td><td>~location~</td><td>~startdate~</td></tr>#]</table>
+
===Contacts===
 +
To display a list of the contacts assigned at Level 2:
  
−
e.g. where typeid='141414'</pre>
+
: <span style="font-size: medium;">'''[#(?object=contact) ~firstname~ ~lastname~ ~email~ #]'''</span>
 +
To display only contacts assigned at Level 2 with a specific role/roles (only relevant if the Level 2 Multiple Contact List is enabled)
  
−
'''To list activity based on a specific status name or status id''':
+
: <span style="font-size: medium;">'''[#(?object=contact::criteria=roleid=12345) ~firstname~ ~lastname~ ~email~ #]'''</span>
−
<pre>
+
To get the intersection record identifier (equivalent to ~oprid~ at Level 1) (i.e. for use in [[Pandora]] functions)
−
<table>[#(?object=activity;orderby=startdate;criteria=statusname='')<tr><td>~subject~</td><td>~location~</td><td>~startdate~</td></tr>#]</table>
 
  
−
e.g. where statusname='status name'
+
: <span style="font-size: medium;">'''[#(?object=contact) ~lnkid~ #]'''</span>
 +
To display the contact's profile status:
  
−
<table>[#(?object=activity;orderby=startdate;criteria=status.id='')<tr><td>~subject~</td><td>~location~</td><td>~startdate~</td></tr>#]</table>
+
: <span style="font-size: medium;">'''[#(?object=contact) ~firstname~ ~lastname~ ~ustatusid~ #]'''</span>
 +
'''Notes:'''
  
−
e.g. where status.id='1234'</pre>
+
* Contacts at level 2 cannot be filtered by rolename, only roleid
 +
* If the multiple contact list is enabled use '''~role~''' to display the assigned role.
  
−
'''To format the start date and start time''':
+
===Accounts===
−
<pre>
+
To display information for a <u>single</u> account in the Level 2 accounts section:
−
~date_format(startdate,'%Y-%m-%d') as startdate~</pre>
 
  
−
'''or'''
+
: <span style="font-size: medium;">'''@companies.''rolename.fieldname''@'''</span>
−
<pre>
+
To display a list of the companies assigned at Level 2:
−
~date_format(startdate,'%h:%i %p') as starttime~
 
−
</pre>
 
  
−
'''To list level two entity at level one using level two fieldname instead of customfield ID 
+
: <span style="font-size: medium;">'''[#(?object=company::orderby=name)~name~ #]'''</span>
−
<pre>
+
To get the intersection record identifier (i.e. for use in [[Pandora]] functions)
−
[#(?object=activity;criteria=typeid='19997';)
 
−
<tr><td>~index~</td><td>Folder</td><td>$Field Name$</td><td>$customfieldID$</td><td>$customfieldID$</td></tr>
 
−
#]
 
−
</pre>
 
  
−
==How to get a UTA contact role /company role record==
+
: <span style="font-size: medium;">'''[#(?object=company) ~clnkid~ #]'''</span>
 +
'''Notes:'''
  
−
[#(?object=company;orderby=name)<td>~name~</td><td>~customfields~</td>#]
+
:* The Account standard field is only available at Level 2 when the Multiple Account list is enabled. See [[Relating Contacts and Accounts to the Universal Tracking Application#The Account List Field|here]] for details.
  
−
==How to retrieve Level 1 Company /Contact Role custom fields==
+
==To display Level 1 Company Role or Contact Role custom fields==
 +
<span style="font-size: medium;">'''[#(?object=company;)$?opc_''customfieldid''$#]'''</span> or <span style="font-size: medium;">'''[#(?object=contact;)$?opr_''customfieldid''$#]'''</span>
  
−
[#(?object=company;orderby=name)<td>$?opc_fieldid$</td>#]
 
  
−
'''OR'''
+
'''where:'''
  
−
[#(?object=contact;orderby=fullname)<td>$?opr_fieldid$</td>#]
+
* customfieldid = the numeric id of the custom field
  
−
fieldid = the numeric id of the custom field
+
'''Note:''' for level 2 records (when the multiple contact/company list(s) are enabled) use $?opr2_''customfieldid''$ and $?opc2_''customfieldid''$
  
 
Following the same format above, you can also reference custom fields on the company role using the @#field id#@ syntax.
 
Following the same format above, you can also reference custom fields on the company role using the @#field id#@ syntax.
Line 251: Line 336:
 
~ucity~, ~ustate~ ~upostalcode~
 
~ucity~, ~ustate~ ~upostalcode~
  
−
==How to display a date format==
+
==To display Company Association or Contact Association fields==
 +
The syntax for extracting information on the entity to which they are associated is as follows . . .
  
−
'''The following date variables are available for a long date format''':
+
<span style="font-size: medium;">'''[#(?object=association)~name~ ~standard field name~ $?afc_custom field id$ $?afc_custom field name$#]<br />
 +
<br />'''[#(?object=companyassociation)~standard field name~ $custom field id$ $custom field name$#]'''</span>
  
−
'''@longclosedate@'''
+
'''where:'''
  
−
'''@longstartdate@'''
+
* standard field name = name of the standard field
 +
* custom field id = the numeric id of the custom field
 +
* custom field name = the name of the custom field
  
−
'''@longenddate@'''
 
  
−
'''@fullstartdate@'''
+
The syntax for extracting information on fields that are on the intersection, rather than the entity to which they are associated, is as follows . . .
  
−
Example: @longstartdate@ returns "Tuesday, November 15, 2005"
+
<span style="font-size: medium;">'''[#(?object=association) ~afcompanyid~ #]<br />
 +
<br />'''[#(?object=companyassociation)~afroleid~ #]'''</span>
  
−
'''The following date variables are also available''':
 
  
−
@now@ - full current date and time
+
Other '''intersection''' specific variables options include:
  
−
@currentdate@ - full current date only
+
* ~afcid~: association (intersection) record id.
 +
* ~afcompanyid~: [[companyid]] of associated company
 +
* ~afcontactid~: [[userid]] of associated contact
 +
* ~afroleid~: [[roleid]] of association
 +
* ~afstartdate~: start date of association
 +
* ~afenddate~: end date of association
  
−
'''To display only specific elements of the current date''':
+
==Role Based Custom Fields==
 +
When you have a [[Custom Field]] such as a [[Web Page View]] or [[MS Word Merge]] that is located <u>'''on'''</u> a User Role or Company Role you can access:
  
−
@month(currentdate)@ - month number
+
[[UTA]] Level 1 Information:
  
−
@day(currentdate)@ - day
+
: <span style="font-size: medium;">'''@levelone.''fieldname''@'''</span> or <span style="font-size: medium;">'''@levelone.''customfieldid''@'''</span>
 +
Contact Information:
  
−
@year(currentdate)@ - year
+
: <span style="font-size: medium;">'''@contact.''fieldname''@'''</span> or <span style="font-size: medium;">'''@contact.''customfieldid''@'''</span>
 +
Company Information:
  
−
@dayweek(currentdate)@ - name of day
+
: <span style="font-size: medium;">'''@company.''fieldname''@'''</span> or <span style="font-size: medium;">'''@company.''customfieldid''@'''</span>
 +
When you want to refer to a User Role based [[Custom Field]] '''<u>from</u>''' a [[UTA]] Level 1 record use the following syntax:
 +
Owner:
  
−
@monthname(currentdate)@ - name of month
+
: <span style="font-size: medium;">'''@owner.''fieldname''@'''</span>
 +
Person:
  
−
'''To display only specific elements of the full start date''':
+
: <span style="font-size: medium;">'''@person.''fieldname''@'''</span>
 +
Contact:
  
−
@month(fullstartdate)@ - month number
+
: <span style="font-size: medium;">'''@contact.''rolename''.''fieldname''@'''</span>
 +
: ''where rolename is the role they are assigned on the Level 1 record''
 +
=To Display a List of Activities, Notes, Transactions, Contacts, Companies, Consumers, Providers=
 +
==Syntax==
 +
<span style="font-size: medium;">'''[#(?object=''objectname''::{options})~''standardfieldname''~ $''customfieldname''$#]'''</span>
  
−
@day(fullstartdate)@ - day
+
: '''Where:'''
 +
:* ''objectname'' is the name of the item to be listed.
 +
:: Either: '''address, activity, assign, contact, user, group, company, notes, association, companyassociation, transaction, timesheet''', '''level-1''', '''utaproviderL1''', '''utaproviderL2''', '''utaconsumerL1''', '''utaconsumerL2''' or '''linkactivity'''
 +
:
 +
:* ''standardfieldname'' is the name of a standard field (between tildes, ~)
 +
:* ''customfieldname'' is the name of a custom field (between dollar signs, $)
  
−
@year(fullstartdate)@ - year
+
'''Notes:'''
  
−
@dayweek(fullstartdate)@ - name of day
+
:* You can refer to [[Custom Fields]] in the list using the Custom Field ID instead of the field name, still between dollar signs ('''$12345$''')
 +
:* '''level-1''' can only be used as an object when referenced from a contact record. Also '''level-1''' will only list the level 1s that the contact has been added to in the contacts section.
 +
:* You can include text as well as variables within the [#...#] syntax.
 +
:* When using this syntax for [[Web Page View]]s, [[Custom Field Type: Read Only – System Variables|Read Only – System Variables]] etc. you will usually want to include HTML table formatting within the '''[#...#]''' syntax (see examples below). For [[MS Word Merge]] custom fields the table defined on the MS Word Template document, with the columns delimited by pipes (|) within the '''[#...#]'''.
 +
:* '''~Index~''' can be used to number the lines (1, 2, 3...) '''Note:''' ~index~ does not work for all lists. For example, it cannot be used when listing contacts associated with a Level 1.
 +
:** ''~Index~'' (upper case 'I') starts numbering at 1, ''~index~'' (lower case 'i') starts numbering at 0.
 +
~eventid~ will display the id of the level 2.
  
−
@monthname(fullstartdate)@ - name of month
 
  
−
'''You can also parse out a particular date format in a date field''':
+
'''Options:'''
  
−
@year(datefield)@ - returns the year value in datefield
+
{| class="wikitable"
 +
|-
 +
||'''Option'''
 +
||'''Effect'''
 +
|-
 +
||<span style="font-size: medium;">orderby=''standardfieldname''</span>
 +
||Sorts the list in ascending order by the standard field specified
 +
|-
 +
||<span style="font-size: medium;">orderby=''standardfieldname'' desc</span>
 +
||Sorts the list in descending order by the standard field specified
 +
|-
 +
||<span style="font-size: medium;">orderby=tbl_''customfieldid''.valuestr</span>
 +
||Sorts the list in ascending order by the custom field specified
 +
|-
 +
||<span style="font-size: medium;">criteria=''standardfieldname''='''value'''</span>
 +
||Filters the list by the standard field and value specified
 +
|-
 +
||<span style="font-size: medium;">criteria=tbl_''customfieldid''.valuestr='''value'''</span>
 +
||Filter the list by the custom field and value specified
 +
|-
 +
||<span style="font-size: medium;">criteria=(''standardfieldname''='''value''' or ''standardfieldname''='''value''')</span>
 +
||For multiple criteria when '''either''' conditional criteria can apply
 +
|-
 +
||<span style="font-size: medium;">criteria=(''standardfieldname''='''value''' AND ''standardfieldname''='''value''')</span>
 +
||For multiple criteria when '''both''' conditional criteria must apply
 +
|-
 +
||<span style="font-size: medium;">groupfunction=''aggregatefunction''</span>
 +
||Performs specified aggregate function on the listed fields<br />Ex. sum, count, countdistinct
 +
|}
  
−
@month(datefield)@ - returns the month value in datefield
+
* ''multiple options (i.e. a criteria and an orderby option) can be included, separated by doubled colons (::)''
  
−
@day(datefield)@ - returns the day value in datefield
+
'''Important:''' Any custom fields that you use as criteria or orderby '''must''' appear in the display. If you do not wish to display the field you can place it in a comment. (i.e.: &lt;!--$12343$-->) However, if referencing a field as a property of a table you must show the value.
  
−
@hour(datefield)@ - returns the hour value in datefield (0-12)
 
  
−
@hour24(datefield)@ - returns the hour value in datefield (0-24)
+
'''Examples:'''
  
−
@minute(datefield)@ - returns the minute value in datefield
+
* To generate a list of Level 2 activities for a [[MS Word Merge]]:
  
−
@second(datefield)@ - returns the second value in datefield
+
[#(?object=activity)|~statusname~|~typename~|$speciality$|$123456$|#]
 +
''See [[MS Word Merge]] for further details on including tables on MS Word Merge documents''
  
−
==How to hide a variable if it is missing==
 
−
<pre>
 
−
Put <!--hideifnotfound--> in front of variable name like this
 
  
−
Example: <!--hideifnotfound-->@parent.contact.adjuster.email@
 
−
</pre>
 
  
−
==How to display different content based on a value using SmartLogic==
+
* To reference the Consumer UTA Level 1 owner name and ownerid from a Provider UTA Level 1 Read Only - System Variable custom field
−
To display content based on a value from a variable add '''&lt;!--@sslogic('@branch.name@'='Internal Staff')--&gt;''' in front of the content and '''&lt;!--@end--&gt;''' at the end of the content. If there are 2 different pieces of content to be displayed based on a value and all others add '''&lt;!--@else--&gt;''' between the 2 pieces of content.
+
 
 +
[#(?object=utaconsumer::criteria=statusname IN ('Placed','Resigned/Terminated'))~ownername~,~ownerid~ #]
 +
 
 +
 
 +
* To Display custom fields via List Syntax for Invoicing (objectname=appliedtoinvoices). Grabbing a custom field value off the invoice (ie. 282588) and into an adjustment.
 +
 
 +
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">Example: [#(?object=appliedtoinvoices)$282588$#]</pre>
 +
'''Note''': refer to the custom field by the number ONLY, do not use the custom field name.
 +
 
 +
 
 +
 
 +
* To generate a list of all contacts for a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only – System Variables]] custom field (note that the HTML table formatting is included within the '''[#...#]''' syntax)
 +
 
 +
[#(?object=contact) #]
 +
 
 +
{|
 +
|-
 +
!|First Name
 +
!|Last Name
 +
!|E-mail Address
 +
!|Cell Phone Number
 +
|-
 +
||~firstname~
 +
||~lastname~
 +
||~email~
 +
||$Cell Phone$
 +
|}
 +
 
 +
'''Note''': The first line creates a header row for the table.
 +
 
 +
* For a list of Level 2 (or Level 3) activities sorted by Start Date in descending order:
 +
 
 +
[#(?object=activity::orderby=startdate desc)#]
 +
{|
 +
|-
 +
||~subject~
 +
||~location~
 +
||~startdate~
 +
|}
 +
 
 +
 
 +
* For a list of contacts assigned to a Level 1 with the role of "Internal People", sorted by surname:
 +
 
 +
[#(?object=contact::orderby=lastname::criteria=rolename='Internal People')#]
 +
 
 +
{|
 +
|-
 +
||~firstname~
 +
||~lastname~
 +
||~email~
 +
|}
 +
 
 +
 
 +
* For a list of level 1 records, including owner details, that a Company has been asssigned to:
 +
 
 +
[#(?(object =level-1) NAME: ~name~ OWNERID: ~ownerid~ OWNERNAME: ~ownername~ #]
 +
 
 +
 
 +
 
 +
* To display the level 1 ID of the level 1 records:
 +
 
 +
[#(?(object =level-1) OPPORTUNITY ID: ~op.opportunityid as oppid~ #]
 +
 
 +
 
 +
 
 +
* For a list of all companies that the owner of a [[UTA]] record is associated with:
 +
 
 +
@owner.[#(?object=association)~name~ (Phone ~phone~)#]@
 +
 
 +
 
 +
* To get a comma-separated list of the companyids of all the companies the current user is associated with with roleid 54545:
 +
 
 +
@me.[#(?object=association::criteria=roleid=54545)~afcompanyid~,#]@
 +
 
 +
 
 +
* For a list of all contacts associated to the current user's parent company record (associated to the company with [[roleid]] 12345):
 +
 
 +
@me.parent.[#(?object=association::criteria=roleid='12345')~firstname~ ~lastname~ (Phone ~phone~)#]@
 +
 
 +
 
 +
* For a list of a company's Active(current date is between start and end date) associations:
  
−
'''Example:'''
+
[#(?object=association::criteria=(afstartdate is null OR afstartdate<='@date(currentdate)@') AND (afenddate is null OR afenddate>='@date(currentdate)@'))~userid~,#]
−
<pre>
 
  
−
<!--@sslogic('@branch.name@'='Internal Staff')-->
 
  
−
This is internal staff
+
* For a list of all contacts/users located under a company with a given role
  
−
<!--@else-->
+
<pre>[#(?object=user::criteria=rolelist like '%,12345,%') ~email~ #]</pre>
  
−
This is NOT internal staff
 
  
−
<!--@end-->
+
* To count the number of contacts assigned with the role of Reviewer:
  
 +
<pre>[#(?object=contact::criteria=rolename="Reviewer"::groupfunction=count)~userid~#]</pre>
  
−
</pre>
 
−
'''Note:''' be sure there are single quotes around the variable and value.
 
  
−
'''Note:''' SmartLogic does not support nested logic statements.
+
* To include and format a date stored in a custom field (see also [[sscalculation]])
  
−
==How to display check boxes in the Web Page View==
+
<pre>[#(?object=activity)<!--@sscalculation(date_format("$fieldname$","%M %d, %Y"))-->#]</pre>
  
−
To display Select Many - Check Box type cutom fields as check boxes in a web page view add '''@checkbox('customfieldid','option name')@''' to the check box control.
 
  
−
This syntax works if the check boxes are on the same level.
+
* With multiple criteria:
  
−
'''Example:'''
+
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=contact::criteria=(rolename='External' or rolename='Internal'))~firstname~ ~lastname~#]
−
<pre>
 
−
<input type="checkbox" name="checkbox" value="checkbox" @checkbox('12345','yes')@>
 
 
</pre>
 
</pre>
  
−
==How to display level two check boxes on level one in the Web Page View==
 
−
@checkboxvalue(id||values to be checked)@
 
  
−
<input type="checkbox" name="checkboxb20" value="Limited community support"  @checkboxvalue($1199639$||Limited community support)@>Limited community support
+
* With multiple order criteria:
−
 
  
−
* Use two "'''|'''" (pipes) to separate '''id''' and '''value''' to be checked
+
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=activity::orderby=tbl_1765133.valuestr::tbl_1765119.valuestr desc)~type~, $1765133$, $1765119$<br />#]
−
where 1199639 is customfield id
+
</pre>
−
if it is used on the same level '''@1199639@'''
+
'''Note:''' ''multiple options (i.e. a criteria and an orderby option) can be included, separated by doubled colons (::)''
−
if it is used on the child level '''$1199639$'''
 
  
−
This works for level one check boxes on level one web page view
 
−
AND
 
−
works for level two check boxes on level one web page view
 
−
AND
 
−
works for level three check boxes on level one web page view
 
  
−
==How to display level three activities at level one in the Web Page View==
 
  
−
When displaying a list of '''Level 2''' activities using the [ # (?object=object;orderby=field) # ] processor, the corresponding '''Level 3''' activities can now be displayed under each of the parent '''Level 2''' activities by using [ @ (?object=object;orderby=field) @ ].
+
* To sort descending by a custom field called ''Total Hours'' with a custom field id of ''67292'':
  
−
This new feature allows level one web page fields to display level 3 items.
+
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=activity::orderby=tbl_67292.valuestr desc)Subject: ~subject~Total Hours: $Total Hours$Start Date: ~startdate~#]
−
 
−
This a type syntax for displaying level 2 items.
 
−
 
−
<pre>
 
−
<table border=1>
 
−
[#(?object=activity;orderby=startdate)
 
−
<tr><td colspan=2>~subject~</td><td>~location~</td><td>~startdate~</td></tr>
 
−
#]
 
−
</table>
 
 
</pre>
 
</pre>
−
+
'''Note:''' ''$Total Hours$'' in the list could be listed as ''$67292$'' with the same result.
−
This is the syntax showing  level 3 items inside level 2 items.
+
 
−
+
 
−
<pre>
+
 
−
<table border=1>
+
* To sort descending reviews in a specific status by a custom field on a separate UTA Level 1 field called ''$Staff Final Score$'' with a custom field id of ''1584168'' in numeric order:
−
[#(?object=activity;orderby=startdate)
 
−
 
−
<tr><td colspan=2>~subject~</td><td>~location~</td><td>~startdate~</td></tr>
 
−
<tr>
 
−
<td>
 
−
 
−
<table bgcolor="00FFFF">
 
−
 
−
[@(?object=activity;orderby=startdate)<tr>
 
−
<td>~subject~</td><td>~location~</td><td>~startdate~</td>
 
−
</tr>@]
 
−
 
−
</table>
 
−
</td>
 
−
</tr>
 
−
 
−
#]
 
−
</table>
 
  
 +
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=utaconsumerL1::orderby=tbl_15868.valuestr*1::criteria=(statusname='Member Review'))
 
</pre>
 
</pre>
 +
'''Note:''' ''$Staff Final Score$'' in the list could be listed as ''$15868$'' with the same result.
  
−
==How to display Level 3 Activities at Level 1 using Read Only-System Variable Field in Web Page View==
 
  
−
The '''Read Only'''-System Variable field can now be used in the '''Web Page View''' field.
 
  
−
This is useful for displaying '''Level 3''' activities at the '''Level 1''' in a '''Web Page View''' field.
+
* To list a specific activity type only:
  
−
Currently we can display '''Level 3''' activities at '''Level 1''' using the following syntax:
+
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=activity::orderby=startdate::criteria=typename='This Activity Type')~subject~~location~~startdate~#]</pre>
  
−
<pre>
 
−
<table border=1>
 
−
[#(?object=activity;orderby=startdate)
 
−
 
−
<tr><td colspan=2>~subject~</td><td>~location~</td><td>~startdate~</td></tr>
 
−
<tr>
 
−
<td>
 
−
 
−
<table bgcolor="00FFFF">
 
−
 
−
[@(?object=activity;orderby=startdate)<tr>
 
−
<td>~subject~</td><td>~location~</td><td>~startdate~</td>
 
−
</tr>
 
−
@]
 
  
−
</table>
+
* To list activities based on the [[Determining the typeid|type ID]] ('''Level 2 and Level 3 only'''):
−
</td>
+
 
−
</tr>
+
[#(?object=activity::orderby=startdate::criteria=typeid='24160')#]
−
+
 
−
#]
+
{|
−
</table>  
+
|-
 +
||~subject~
 +
||~location~
 +
||~startdate~
 +
|}
 +
 
 +
 
 +
* To include a hyperlink to the object:
 +
 
 +
[[File:Syntax 1.png|650px]]
 +
 
 +
 
 +
* To list activities based on status '''Draft''' and sort by '''startdate''':
 +
 
 +
[[File:Syntax 2.png|650px]]
 +
 
 +
 
 +
* To list activities based on the status ID ('''Level 2 and Level 3 only'''):
 +
 
 +
[[File:Syntax 3.png|650px]]
 +
 
 +
 
 +
* To list UTA Providers:
 +
 
 +
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=utaproviderL1::criteria=rolename="Panel") ~name~ ~typename~ ~statusname~ ~enddate~ $Panel Review Date$ $Panel ID
 +
<!-- @sscalculation(@xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A") 1+#]@ 0) -->
 
</pre>
 
</pre>
 +
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">#]</pre>
 +
 +
 +
* To list notes (from the record that contains the notes):
 +
 +
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=notes::orderby=createddate desc)~notes~~createddate~~username~#]</pre>
 +
'''Note''': This syntax is for "Public (Default)" notes only, not custom note types.
 +
 +
 +
 +
* To list all companies under a parent company record:
 +
 +
[#(?object=company) ~name~ #]
 +
 +
 +
* To list all L3 allocations within a L2 budget record:
 +
 +
[#(?object=linkactivity) ~subject~ #]
 +
 +
 +
* To sum or count all the L3 allocations from the budget L2 record:
 +
 +
@linkactivity.sum(...)@ or @linkactivity.count(...)@
 +
 +
 +
* To list level 2 notes for each level 2 record at level 1:
 +
 +
[#(?object=activity::orderby=startdate desc)~subject~~description~~startdate~
 +
 +
[@(?object=notes::orderby=createddate desc)@]
 +
 +
{|
 +
|-
 +
||~notes~
 +
||~createddate~
 +
||~username~
 +
|}
 +
# ]
 +
 +
'''Note''': This syntax is for "Public (Default)" notes only, not custom note types.
 +
 +
 +
 +
* To do a sum of all the unpaid payment transaction:
 +
 +
{|
 +
|-
 +
||Total Paid: [#(?object=transaction::criteria=trstranstype=11 and tbl_1145339.valuestr='Paid'::groupfunction=sum)$1145183$ <!--"145339$-->#] Note: $1145339$ - Status of payment $1145183$ - Payment Amount
 +
|}
 +
 +
==Referencing Standard Fields of UTA Providers==
 +
{| class="wikitable"
 +
|+style="text-align:left"|Level 1 Field Name and Variable List
 +
|-
 +
!|Field Name
 +
!|Variable
 +
|-
 +
||Application Name
 +
||~name~
 +
|-
 +
||Type Name
 +
||~typename~
 +
|-
 +
||Type ID
 +
||~type~
 +
|-
 +
||Status Name
 +
||~statusname~
 +
|-
 +
||Status ID
 +
||~statusid~
 +
|-
 +
||Start Date
 +
||~startdate~
 +
|-
 +
||End Date
 +
||~enddate~
 +
|-
 +
||Close Date
 +
||~closedate~
 +
|-
 +
||Branch
 +
||''No variables''
 +
|-
 +
||Branch ID
 +
||~branchid~
 +
|-
 +
||Currency
 +
||''No variables''
 +
|-
 +
||Exchange Currency
 +
||''No variables''
 +
|-
 +
||Currency Exchange Rate
 +
||''No variables''
 +
|-
 +
||Customer
 +
||~client~
 +
|-
 +
||Customer ID
 +
||~companyid~
 +
|-
 +
||Modified By
 +
||''No variables''
 +
|-
 +
||Modified Date
 +
||''No variables''
 +
|-
 +
||Owner (full name)
 +
||~ownername~
 +
|-
 +
||Owner (userid)
 +
||~updatedby~
 +
|-
 +
||Person (full name)
 +
||''No variables''
 +
|-
 +
||Person (userid)
 +
||~oppeopleid~
 +
|-
 +
||Role Name
 +
||~rolename~
 +
|-
 +
||Role ID
 +
||~conroleid~
 +
|}
 +
 +
'''Example:'''
 +
 +
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=utaproviderL1) ~typename~ | ~statusname~ <br />#]</pre>
  
 +
{| class="wikitable"
 +
|+style="text-align:left"|Level 2 Field Names and Variables List
 +
|-
 +
!|Field Name
 +
!|Variable
 +
|-
 +
||Activity Type
 +
||~typename~
 +
|-
 +
||Activity Type ID
 +
||~typeid~
 +
|-
 +
||Owner
 +
||~ownername~
 +
|-
 +
||Owner ID
 +
||~eownerid~
 +
|-
 +
||Assigned People
 +
||''No variables''
 +
|-
 +
||Status
 +
||~statusname~
 +
|-
 +
||Status ID
 +
||~statusid~
 +
|-
 +
||Subject
 +
||~subject~
 +
|-
 +
||Description
 +
||~description~
 +
|-
 +
||Location
 +
||~location~
 +
|-
 +
||Amount
 +
||~eamount~
 +
|-
 +
||Start Date
 +
||~startdate~
 +
|-
 +
||End Date
 +
||~enddate~
 +
|-
 +
||Opportunity ID
 +
||~cevconoppid~
 +
|-
 +
||Event ID
 +
||~cevprovevtid~
 +
|-
 +
||Rolename
 +
||~rolename~
 +
|-
 +
||Role ID
 +
||~cevroleid~
 +
|}
  
 +
'''Example:'''
  
−
This method, however, has the limitation that only '''Level 3''' activities with less than 25 fields can be displayed using this technique.
+
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=utaproviderL2) ~typename~ | ~statusname~ <br />#]</pre>
 +
If you have multiple different UTAs connected as providers, you  can use criteria to filter:
  
−
To display '''Level 3''' activities that have more than 25 fields, the following method is now available:
+
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=utaproviderL1::criteria=provappid="12345") ~typename~ | ~statusname~ <br />#]</pre>
  
−
1. Create a '''Read Only - System Variable''' field at '''Level 2'''.
+
==To Format the Start Date or Start Time==
 +
::: <span style="font-size: medium;">'''~date_format(startdate,'%Y-%m-%d') as startdate~'''</span>
 +
:::: or
 +
::: <span style="font-size: medium;">'''~date_format(startdate,'%h:%i %p') as starttime~'''</span>
 +
'''Note:'''
  
−
2. Format the field as you would a '''Web Page View''' field. For example:
+
:::* If you wish to use ''"orderby=startdate"'', along with a date format other than yyyy-mm-dd you must use a slightly different syntax.
 +
:::* Using ''"~date_format(startdate,'%d-%m-%Y') as startdate~"'' when using ''"orderby=startdate"'' will cause the date to be ordered by dd-mm-yyyy (rather than yyyy-mm-dd, which is chronological)
 +
:::* To avoid this, change ''"date_format(startdate,'%d-%m-%Y') as '''startdate'''"'' to ''"date_format(startdate,'%d-%m-%Y') as '''sdate'''"''
  
−
<pre>
+
==Displaying Both Level 2 and Level 3 Activities at Level 1==
−
<table border=1>
+
When displaying a list of '''Level 2''' activities using the '''[#(?object=activity;)...#]''' syntax, the corresponding '''Level 3''' activities can be displayed under each of the parent '''Level 2''' activities.
−
[#(?object=activity;orderby=startdate)
+
 
−
+
 
−
<tr><td colspan=2>~subject~</td><td>~location~</td><td>~startdate~</td></tr>
+
To facilitate this you must create a [[Custom Field Type: Read Only – System Variables|Read Only - System Variable]] field '''at''' Level 2 that contains the list of Level 3 activities, formatted and filtered as desired.
−
#]
+
 
−
</table>
+
:::: ''You can use [[Visibility Condition]]s, [[Role Field Permissions]] or [[Status Field Permissions]] to prevent the field from being displayed on the Level 2 record.
−
</pre>
+
'''Example:'''
 +
 
 +
::* Create a Level 2 [[Custom Field Type: Read Only – System Variables|Read Only - System Variable]] Custom Field called '''Level 3 Activity List''' with the following:
  
 +
[@(?object=activity::orderby=typename)@]
  
−
3. You can now use the field in the Web Page View as you would any other field. For example:
+
{|
 +
|-
 +
||Level 3 Activity: ~typename~
 +
||~location~
 +
|}
  
−
<pre>
+
Then create either a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variable]] at Level 1:
−
<table border=1>[#(?object=activity;orderby=startdate)<tr><td colspan=2>~subject~</td><td>~location~</td><td>~startdate~</td></tr><tr><td colspan=2>$123456$</td></tr>#]
 
−
</table>
 
−
</pre>
 
  
−
==How to suppress the Page Footer with Printing the Page==
+
[#(?object=activity::orderby=startdate) #]
  
−
To suppress the footer when printing the page you need to change your browser settings.
+
{|
 +
|-
 +
||Level 2 Activity: ~subject~
 +
||~statusname~
 +
||~startdate~
 +
||~enddate~
 +
|-
 +
||
 +
| colspan="3"|$Level 3 Activity List$
 +
|}
 +
:::: '''where''' "Level 3 Activity List" is the name you gave the [[Custom Field Type: Read Only – System Variables|Read Only – System Variable]] field
  
−
'''Internet Explorer'''
 
  
−
1. Choose the '''File Page Setup''' [[Menu|menu]].
+
===Level 3s with Less Than 25 Fields===
 +
If Level 3 has less than 25 fields it is not necessary to create a [[Custom Field Type: Read Only – System Variables|Read Only – System Variable]] Custom Field on the Level 2 that lists the Level 3 activities.
  
−
2. Delete the '''Header''' and '''Footer''' text.
+
Instead you can use the following syntax '''within''' the '''[#...#]''' that lists the Level 2 activities:
  
−
3. If required, change the margins.
+
::: <span style="font-size: medium;">'''[@(?object=activity)~standardfieldname~ $customfieldname$@]'''</span>
 +
'''Note:'''
  
−
'''FireFox'''
+
::* This syntax will only work if there are '''less than 25 fields at Level 3.'''
  
−
1. Choose the '''File Page Setup''' [[Menu|menu]].
+
'''Example:'''
  
−
2. Click the '''Margins & Header/Footer''' tab.
+
::* To display a list of Level 2 activities, including any Level 3 activities under their parent Level 2 activity:
  
−
3. Set all '''Header''' and '''Footer''' options to '''Blank'''.
+
[#(?object=activity::orderby=startdate) #]
  
−
3. If required, change the margins.
+
{|
 +
|-
 +
||Level 2 Activity: ~subject~
 +
||~statusname~
 +
||~startdate~
 +
||~enddate~
 +
|-
 +
||
 +
| colspan="3"|[@(?object=activity;orderby=typename)@]
 +
{|
 +
|-
 +
||Level 3 Activity: ~typename~
 +
||~location~
 +
|}
 +
|}
  
−
==How to control print behavior==
+
==Displaying a Specific Number of Items in a List==
 +
When you want to display only specific number of activities or transactions in a [[Web Page View]] use the following syntax.
  
−
'''To define a page break place the following code in the HTML source before the content you deem as the next page''':
+
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;"> [#(?object=object::orderby=field)
−
<pre>
+
    <!--@sslogic(~index~='num')-->
−
<div style="PAGE-BREAK-AFTER: always"><br style="height:0; line-height:0"></div>
+
      ~standard field~ $custom field$ <br />
 +
    <!--@end-->  
 +
  #] <br />  
 
</pre>
 
</pre>
−
'''To change the page orientation to landscape first place the following in the header portion (<head></head>) of the HTML''':
+
'''where:'''
 +
 
 +
::* num = number of activities that should be displayed
 +
 
 +
=XML Variables=
 +
==Count how many options were selected==
 
<pre>
 
<pre>
−
<style type="text/css" media="print">
+
<!--@sscalculation(@xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A") 1+#]@ 0)--></pre>
−
div.page  {  
+
 
−
writing-mode: tb-rl;
+
 
−
height: 80%;
+
==Filtered XML display output==
−
margin: 10% 0%;
+
<pre>@xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A")~FirstName.nodevalue~ ~LastName.nodevalue~<br />#]@</pre>
−
margin-right: 80pt;
+
 
−
filter: progid:DXImageTransform.Microsoft.BasicImage(Rotation=1);
+
 
−
}
+
=Date/Time Variables=
−
</style>
+
==Standard Fields Date/Time==
−
</pre>
+
'''Variable List:'''
−
'''Then place <pre><div class="page"></div> </pre>in the HTML source around the "page" content.'''
+
 
 +
::: {| border="1" cellpadding="5"
 +
'''Start Date''''''End Date''''''Close Date'''<br />''Level 1 only'''''Modified Date''''''Display Format'''@startdate@@enddate@@closedate@@modifieddate@Date formatted according to user preferences (At Level 1 Modified Date also includes the time: 15:40)@longstartdate@@longenddate@@longclosedate@@longmodifieddate@Friday, January 23, 2009@fullstartdate@@fullenddate@@fullclosedate@@fullmodifieddate@2009-01-23 15:40:00@datetime(fullstartdate)@@datetime(fullenddate)@@datetime(fullclosedate)@@datetime(fullmodifieddate)@2009-01-23 15:40:00@date(fullstartdate)@@date(fullenddate)@@date(fullclosedate)@@date(fullmodifieddate)@2009-01-23
 +
 
 +
 
 +
 
 +
::* '''Note''': ''Start Time'' and ''End Time'' are stored within the ''fullstartdate'' and ''fullenddate'' fields respectively. They can be accessed and formatted using the variables elements listed below.
 +
 
 +
'''To display specific elements of the Start Date, Start Time, End Date, End Time, Close Date, Modified Date''':
 +
 
 +
::: {| border="1" cellpadding="5"
 +
@month(fullstartdate)@month number in ''Start Date''@monthname(fullstartdate)@name of month in ''Start Date''@day(fullstartdate)@day in ''Start Date''@dayweek(fullstartdate)@name of day in ''Start Date''@year(fullstartdate)@year in ''Start Date''@hour(fullstartdate)@hour in ''Start Time'' using 12 hour clock (0-12)@ampm(fullstartdate)@AM or PM reference for ''Start Time''@hour24(fullstartdate)@hour in ''Start Time'' using 24 hour clock (0-24)@minute(fullstartdate)@minute in ''Start Time''
 +
 
 +
::: '''Note:''' For '''End Date''', '''Close Date''' or '''Modified Date''' replace '''fullstartdate''' with '''fullenddate''', '''fullclosedate''' or '''fullmodifieddate''' respectively.'''
 +
::: ''(seconds are not available for standard date/time fields)''
 +
::: ''('''Close Date''' does not have a time associated with it)
 +
'''Examples:'''
 +
::
 +
::* To display the Start Date in the format '''February 22, 1985''' you would use:
 +
 
 +
@monthname(fullstartdate)@ @day(fullstartdate)@, @year(fullstartdate)@
 +
 
 +
::* To display the End Time in the format '''06:45PM''' you would use:
 +
 
 +
@hour(fullenddate)@:@minute(fullenddate)@@ampm(fullenddate)@
 +
 
 +
==Current Date/Time==
 +
'''Variable List:'''
 +
 
 +
::: {| border="1" cellpadding="5"
 +
VariableContentDisplayComment@datetime(currentdate)@current date and time as for yyyy-mm-dd HH:mm:ss2013-01-22 17:55:22See also [[Obtain Server Date and Time]]@date(currentdate)@current date as for yyyy-mm-dd2013-05-17&nbsp;@currentdate@current date2009 January 25&nbsp;@now@current date and time2009 August 25 11:05AMWorkflows only. Not available within [[UTA]]s
 +
 
 +
 
 +
'''To display specific elements of the current date or time''':
 +
 
 +
::: {| border="1" cellpadding="5"
 +
@month(currentdate)@current month number@monthname(currentdate)@name of current month@day(currentdate)@current day@dayweek(currentdate)@name of current day@year(currentdate)@current year@hour(currentdate)@current hour using 12 hour clock (0-12)@ampm(currentdate)@AM or PM reference for current time@hour24(currentdate)@current hour using 24 hour clock (0-24)@minute(currentdate)@current minute
 +
 
 +
::: (seconds are not available for the current time)
 +
'''Examples:'''
  
−
Example: <pre><div class="page">This is the page content that needs to be in landscape</div></pre>
+
::* To display the current date/time in the format '''Friday at 19:55''' you would use:
  
−
Please note that the page orientation control only works with Internet Explorer and is not the greatest quality print due to the page being converted to an image then rotated.
+
@dayweek(currentdate)@ at @hour24(currentdate)@:@minute(currentdate)@
  
−
==How to control print behavior when saving as a PDF==
+
==Custom Fields Date/Time==
 +
'''For a custom field on the same level as the Web Page View Field, you can parse out a particular date/time in a date field'''
  
−
To define a page break in a PDF add <pd4ml:page.break/> before the content you deem as the next page.
+
::: {| border="1" cellpadding="5"
 +
VariableContentDisplay@date(''fieldname'')@custom field date as for yyyy-mm-dd2013-05-17
  
−
To change the orientation of a page to landscape in a PDF add <pd4ml:page.break pageFormat="rotate"> before the content you deem as the next page.
 
  
−
==How to display a Dynamic Data grid field==
+
@month(''fieldname'')@month number in ''fieldname''05@monthname(''fieldname'')@name of month in ''fieldname''May@day(''fieldname'')@day in ''fieldname''17@dayweek(''fieldname'')@name of day in ''fieldname''Friday@year(''fieldname'')@year in ''fieldname''2013@hour(''fieldname'')@hour in ''fieldname'' using 12 hour clock (0-12)12@ampm(''fieldname'')@AM or PM reference for time in ''fieldname''AM@hour24(''fieldname'')@hour in ''fieldname'' using 24 hour clock (0-24)00@minute(''fieldname'')@minute in ''fieldname''00@second(''fieldname'')@second in ''fieldname''00
  
−
To show the data grid field in the webpage view field use the syntax '@fieldname.table@'.
 
  
−
==How to display the Transaction types==
+
'''Examples:'''
  
−
In order to display a transaction type and its fields use the following example:
+
::* To display the custom field '''Date Of Birth''' in the format '''31-01-2001''' you would use:
  
−
Syntax:
+
@day(date of birth)@-@month(date of birth)@-@year(date of birth)@
−
<pre>
 
−
[#(?object=transaction;orderby=fieldname;criteria=typename='')<tr><td>$customfieldid$</td><td>$customfieldid$</td></tr>#]
 
−
</pre>
 
−
Example Code:
 
  
−
[#(?object=transaction;orderby=tbl_1041842.valuestr desc;criteria=typename='Co-Principal Investigor, Co-Applicant, Additional Author')
+
'''Note:'''
−
<tr><!--~typename~--><td>$1041842$</td><td>$1041843$</td><td>$1041844$</td><td>$1041845$</td></tr>
+
This syntax will not work for custom fields on a different level. You will not be able to reference, for example, @day(parent.''fieldname'')@. To parse out date/time information from a custom field on a different level, use the [[Sscalculation#Using_sscalculation_to_Change_Date_Formats_of_Data_in_Custom_Fields|sscalculation]] syntax.
−
#]
 
  
 +
=Miscellaneous Variables=
 +
==Adding an image from Upload fields==
 +
Users can return image thumbnails or meta data from multiple file fields using the list syntax below":
  
−
To retrieve all '''Company''' transactions for the company attached to '''Level 1''' (Standard field - Customer):
+
::* Show thumbnail image using thunbnailpath option:
  
−
<pre>
+
<pre>@multi file name.template[# <img src="~thumbnailpath~" alt="" width="240" /> #]@
−
@company.[#(?object=transaction)<tr><td>~details~</td><td>~subject~</td><td>~startdate~</td></tr>#]@
 
 
</pre>
 
</pre>
  
−
To retrieve all '''Branch''' transactions for the branch attached to '''Level 1''' (Standard field - Branch):  
+
::* Show thumbnail image and file name using filepath option:
  
−
<pre>
+
<pre>@multi file name.template[# <img src="~filepath~/thumbnail/?maxwidth=240" alt="" width="240" />~filename~#]@
−
@branch.[#(?object=transaction)<tr><td>~details~</td><td>~subject~</td><td>~startdate~</td></tr>#]@
 
 
</pre>
 
</pre>
  
−
To retrieve all '''People''' transactions for the [[User|user]] attached to '''Level 1''' (Standard field - Owner):
+
::* Show thumbnail image and file name using compressedpath option:
  
−
<pre>
+
<pre>@multi file name.template[# <img src="~compressedpath~/thumbnail/?maxwidth=240" alt="" width="240" />~filename~#]@
−
@owner.[#(?object=transaction)<tr><td>~details~</td><td>~subject~</td><td>~startdate~</td></tr>#]@
 
 
</pre>
 
</pre>
  
−
To retrieve the '''Level 1''' transactions at '''Level 2''':
+
::* Show file name, size and upload date:
  
−
<pre>
+
<pre>@multi file name.template[# ~filename~, ~filesize~, ~uploaddate~#]@
−
@parent.[#(?object=transaction)<tr><td>~details~</td><td>~subject~</td><td>~startdate~</td></tr>#]@
 
 
</pre>
 
</pre>
  
−
To retrieve the '''Level 1''' transactions at '''Level 2''' by transaction type:
 
  
−
<pre>
+
==Adding a File Upload button==
−
@parent.[#(?object=transaction;criteria=typename='Name of Transaction Type')
+
To display a button to upload to a [[Single File]] or [[Multiple Files]] custom field:
−
<tr><td>$fieldid$</td><td>$fieldid$</td><td>$fieldid$</td><td>$fieldid$</td></tr>
+
 
−
#]@
+
::* Single File:
 +
::: <span style="font-size: medium;"><input class="Button" type="button" value="Button Label" /></span>
 +
::
 +
::* Multiple Files:
 +
::: <span style="font-size: medium;"><input class="Button" type="button" value="Button Label." /></span>
 +
'''where:'''
 +
::
 +
::* ''customfieldid'' = the field id of the Single or Multiple file custom field (without '''cf_''')
 +
 
 +
'''Example:'''
 +
 
 +
<input class="Button" type="button" value="Multiple files..." />
 +
 
 +
'''Note:''' if adding to a [[Web Page View]] you will need to add the following to the page:
 +
 
 +
<pre>function include_dom(script_filename) {
 +
    var html_doc = document.getElementsByTagName('head').item(0);
 +
    var js = document.createElement('script');
 +
    js.setAttribute('language', 'javascript');
 +
    js.setAttribute('type', 'text/javascript');
 +
    js.setAttribute('src', script_filename);
 +
    html_doc.appendChild(js);
 +
    return false;
 +
}
 +
function includejsfiles() {
 +
  include_dom("/validate.js");
 +
}
 
</pre>
 
</pre>
 +
You will also have to call the ''includejsfiles'' function in the body onload:
  
−
'''Impact''': Transactions on the '''Company''' and [[User]] objects can now be displayed in a [[UTA]] web page view. The transaction does not have to directly associated with the '''Level 1''' item.
 
  
  
−
'''To get the modified date of a transaction use the following:'''
 
  
−
~trsts~ ''or'' ~date_format(trsts,'%Y-%m-%d') as lastmodified~
 
  
−
== Role base Web page view field ==
+
'''Alternatively:'''
  
−
When you have a role base web page view field or company based webpage view field you can access the levelone, contacts, or company information.
+
You may also use @fieldname.uploadlink@ to get the url for the upload page and construct your own function to open the window.
  
−
@levelone.custom field name/custom field id@
+
'''Example:'''
−
@levelone.standard field name@
 
  
−
  @company.custom field name/custom field id@
+
  <input class="Button" type="button" value="Upload" />
−
@company.standard field name@
+
<pre>function openupload(url)
 +
{
 +
    upload_window = window.open(url,'upload_window', 'menubar=yes,scrollbars=yes,width=800,height=600,status=no,resizable=yes,dependent=yes,alwaysRaised=yes');
 +
    upload_window.opener = window;
 +
    upload_window.focus();
 +
}
 +
</pre>
 +
 
 +
'''Note:''' this method will only open the single file upload page.
 +
 
 +
==Displaying a Dynamic Data Grid field==
 +
To show a [[Custom Field Type: Dynamic Data – Data Grid|Dynamic Data – Data Grid]] field in a webpage view field use the following syntax:
  
−
@contact.custom fieldname/custom field id@
+
::: <span style="font-size: medium;">'''@fieldname.table'''@</span>
−
@contact.standard field name@
+
==Retrieving History for Fields with Track Changes Enabled==
 +
The following syntax is used to retrieve standard or custom field history:
  
−
==SSlogic escape[] function==
+
For the [[Status]] standard field:
  
−
The escape[] function is used to escape the single quote in instances where the data in a field may contain a single quote.
+
::: <span style="font-size: medium;">'''@HistoryOf(status)@'''</span>
 +
::: <span style="font-size: medium;">'''@HistoryOf(statuscaption)@'''</span>
 +
For a [[Custom Field]]:
 +
::: <span style="font-size: medium;">'''@HistoryOf(''customfieldid'')@'''</span>
 +
OR
 +
::: <span style="font-size: medium;">'''@HistoryOf(''customfieldname'')@'''</span>
 +
'''Notes:'''
 +
:::* ''HistoryOf'' is case sensitive.
 +
:::* See the [[HistoryOf function]] page for a complete description of this variable and its uses.
  
−
The current usage of sslogic to test if a field is empty < !--@sslogic('$1137762$'!='')-->
+
<!--:::* You can only obtain the history of the Status field and [[Custom Fields]] in this way.-->
 +
==For Hybrid Sign-Up Pages==
 +
::: The @user_input_form@ will display the associated user sign up form on a company sign up page if included in the HTML template of the company sign up page.
  
−
The new escape function: < !--@sslogic('escape[$1137762$]'!='')-->
 
  
−
==SSlogic Interpreter==  
+
==Currency Format==
 +
::: You can use the following syntax to format a custom field with currency: @format(L2 Subcontract total y1,currency,USD,2)@. The last parameter can be changed from 2 to 0 to display as a whole number.
 +
==Session Variables==
 +
When using features such as Organization Switching, you may want to pull in specific data based on your current session.
  
−
The interpreter/processor can display or remove content based on user-defined logic.
+
:: Company Fields: '''@sessioncompany.fieldname@'''
 +
Example: @sessioncompany.name@ would return the Company Name of the organization you are currently logged in as.
 +
 
 +
=Controls=
 +
==Hide a variable if it is missing==
 +
Put the following in front of variable name.
 +
 
 +
::: <span style="font-size: medium;">'''&lt;!--hideifnotfound-->'''</span>
 +
'''Example''':
 +
 
 +
<pre>  <!--hideifnotfound-->@parent.contact.adjuster.email@
 +
</pre>
 +
 
 +
'''Note:''' the &lt;!--hideifnotfound--> and the variable must be in immediate succession, and not separated by a space.
 +
 
 +
==How to display different content based on a value using SSlogic==
 +
To display content based on a value from a variable add '''&lt;!--@sslogic('@branch.name@'='Internal Staff')--&gt;''' in front of the content and '''&lt;!--@end--&gt;''' at the end of the content. If there are 2 different pieces of content to be displayed based on a value and all others add '''&lt;!--@else--&gt;''' between the 2 pieces of content.
  
 
<pre>
 
<pre>
 +
<!--@sslogic(CONDITION)-->
 +
  The content to be displayed when condition is true.
 +
  This can be more than one line.
 +
<!--@end-->
 +
</pre>
  
−
Syntax
+
::* The content to be displayed (the middle line) can either be in plaintext or in HTML.
 +
::* Be sure there are single quotes around the variable and value.
 +
::* SSlogic does not support nested logic statements.
 +
 
 +
'''Example:'''
 +
 
 +
::* The following will display a Christmas tree image if the month is December:
 +
 
 +
<pre>
 +
<!--@sslogic(month(now())=12)-->
 +
  <img src="images/xmasstree.jpg" alt="" />
 +
<!--@end-->
 +
</pre>
  
−
Simple Logic
+
'''See [[SSlogic]] for more information and further examples.'''
  
−
<!--@sslogic(condition)-->
+
==How to display check boxes in the Web Page View==
 +
To display Select Many - Check Box type custom fields as check boxes in a web page view add '''@checkbox('fieldname/fieldnumber','option name')@''' to the check box control.
  
−
the content to be displayed when condition is true
+
This syntax works if the check boxes are on the same level.
  
−
<!--@end-->
+
'''Example:'''
  
 +
<pre><input type="checkbox" />
 +
</pre>
  
−
Else Logic
+
::: See Also: [[Updateable Web Page View Fields]] if you wish the Web Page View check boxes to have the ability to change the underlying data.
 +
==How to display level two check boxes on level one in the Web Page View==
 +
@checkboxvalue(id
  
−
<!--@sslogic('condition')-->
+
values to be checked)@
  
−
the content to be displayed when condition is true
+
<input name="checkboxb20" type="checkbox" value="Limited community support" />
  
−
<!--@else-->
 
  
−
the content to be displayed when condition is NOT true
+
::* Use two "'''|'''" (pipes) to separate '''id''' and '''value''' to be checked
  
−
<!--@end-->
+
where 1199639 is customfield id
 +
if it is used on the same level '''@1199639@'''
 +
if it is used on the child level '''$1199639$'''
  
 +
This works for level one check boxes on level one web page view
 +
AND
 +
works for level two check boxes on level one web page view
 +
AND
 +
works for level three check boxes on level one web page view
  
−
Multiple Condition Logic
 
  
−
<!--@sslogic('condition' AND ('condition' OR 'condition' OR 'condition'))-->
 
  
−
the content to be displayed when condition is true
 
  
−
<!--@end-->
 
  
 +
==How to suppress the Page Footer with Printing the Page==
 +
To suppress the footer when printing the page you need to change your browser settings.
  
−
Sample Code:
+
'''Internet Explorer'''
  
 +
1. Choose the '''File Page Setup''' [[Menu|menu]].
  
−
A. display a xmas tree
+
2. Delete the '''Header''' and '''Footer''' text.
  
−
<!--@sslogic(month(now())=12)-->
+
3. If required, change the margins.
  
−
<img src='images/xmasstree.jpg'>
+
'''FireFox'''
  
−
<!--@end-->
+
1. Choose the '''File Page Setup''' [[Menu|menu]].
  
−
B. display a different message based on customfield
+
2. Click the '''Margins & Header/Footer''' tab.
  
−
<!--@sslogic('@sex@'='M')-->
+
3. Set all '''Header''' and '''Footer''' options to '''Blank'''.
  
−
You are a guy.
+
3. If required, change the margins.
  
−
<!--@else-->
+
==How to control print behaviour==
 +
'''To define a page break place the following code in the HTML source before the content you deem as the next page''':
  
−
You are a girl.
 
  
−
<!--@end-->
+
'''To change the page orientation to landscape first place the following in the header portion ('''
  
−
C. display a message base on nested logic condition
+
''') of the HTML''':
  
−
<!--@sslogic('@year@'='2008' AND  ('@month@'='1' OR '@month@'='2')-->
+
'''<strong>Then place'''</strong>
−
Display 1 or 2 in 2008
 
  
−
<!--@end-->
+
<pre> </pre>
 +
'''in the HTML source around the "page" content.'''
 +
Example:
  
−
+
<div class="page">This is the page content that needs to be in landscape</div>
−
</pre>
+
Please note that the page orientation control only works with Internet Explorer and is not the greatest quality print due to the page being converted to an image then rotated.
  
−
== Retrieving Custom Field History ==
+
==How to control print behaviour when saving as a PDF==
 +
To define a page break in a PDF add before the content you deem as the next page.
  
−
The following syntax is used to retrieve custom field history:
+
To change the orientation of a page to landscape in a PDF add before the content you deem as the next page.
  
−
<pre>For Status : @HistoryOf(status)@
+
::* See [[PDF Writer Custom Tags]] for further [[PDF]] formatting options
  
−
For Customfield : @HistoryOf(####)@  where #### is customfield id, system doesn't accept name in this case.
+
=Troubleshooting=
 +
* '''Issue''': 2 variables run together (thus removing the ending @ and beginning @)
 +
* '''Resolution''': Place a non-breaking space tag (&amp;nbsp;) between the variables.
  
−
@HistoryOf()@  ******************************************  Case sensitive ********************************************************
 
−
</pre>
 
  
−
==Troubleshooting==
 
  
−
* In the event of 2 variables running together (removing the ending @ and beginning @) the issue can be resolved by placing a non-breaking space tag (&nbsp;) in between each other.
+
* '''Issue''': For a list of level 2 activities, the code is showing instead of the field headings and values you've designated.
−
* For your list of level 2 activities, your code is showing instead of the field headings and values you've designated.
+
* '''Resolution''': Insert a comment tag before the first cell tag. i.e.
  
−
Try inserting a comment tag before the first cell tag. i.e.<pre><tr><!--~index~--><td></pre>
 
  
 +
=See Also=
 +
* [[Root Company Variable]]s
 +
* [[sslogic]]
 +
* [[ssattach]]
 +
* [[sscalculation]]
 +
* [[Web Page View Field]]
 +
* [[Attach a PDF to a Web Page View]]
 +
* [[Updateable Web Page View Fields]]
 +
* [[Changing the Status from a Web Page View]]
 +
* [[Custom Field Type: Display Only – Web Page View]]
 +
* [[:Category:PDF|PDF Category]]
 +
* [[PDF Writer Custom Tags]]
 +
* [[Adding JavaScript JS files to Web Page View Pages]]
 +
* [[Custom Field ID|Determining the Custom Field ID]]
  
−
[[Category:Custom Fields]][[Category:Variables]][[Category:Browser Scripts]]
+
[[Category:Custom Fields]][[Category:Variables]][[Category:PDF]]

Latest revision as of 10:20, 14 August 2024

The Web Page View Field provides the ability to display a fully formatted document or web page.

In constructing this type of page HTML is used in conjunction with the following variables.

Contents

Variable List

Current User

Note: "me" -- refers to the current user

@me.firstname@ will be replaced by current user's firstname

@me.lastname@

@me.email@

@me.phone@

@me.companyname@

@me.type@ (returns 'User', 'Local User Administrator' or 'Global User Administrator')

UTA Level 1, Sales Opportunity and Job Variables

@name@ - standard field Application Name.

@type@ - standard field Application Template Type.

@status@ - standard field Status

@typecaption@ - standard field Application Template Type Caption.

@statuscaption@ - standard field Status Caption

@type_lang@ - standard field Application Template Type (Based on user language setting).

@status_lang@ - standard field Status (Based on user language setting)

@description@

@requirements@

@currency@

@revenue@

@probability@

@modifiedby@ / @modifiedbyid@

@modifieddate@

@closedate@

@startdate@

@enddate@

@createddate@

@createdby@

@createdbyid@

@jobquestions@ - displays as combo boxes

@jobquestionsr@ - displays question only

@jobskills@


@owner.field@

Example: @owner.fullname@ or @owner.address@

@person.field@

Example: @person.fullname@ or @person.address@


@company.field@

Example: @company.name@ or @company.address@


@company.owner.field@

Example @company.owner.email@

@branch.field@

Example: @branch.name@ or @branch.address@

@apptype@ the Application ID (appid) of the UTA.

UTA Level 2 / Activities Variables

@subject@

@description@

@location@

@startdate@

@enddate@

@isallday@

@modifieddate@ (numeric value including time)

@longmodifieddate@ (text value excluding time)

@starthour@ - (0-23)

@starth@ - (0-12)

@startpmam@ - (PM or AM)

@startminute@

@endhour@ - (0-23)

@endh@ - (0-12)

@endpmam@ - (PM or AM)

@endminute@

@owner@

@eownerid@ - userid of the owner

@contact@

@assigned@

@eventid@

@typename@

@objectid@

@objecttype@

@rootcompanyid@

@rootcompany.name@

@contact.field@ @eamount@

Example: @contact.firstname@ or @contact.email@

@assigned.field@

Example: @assigned.firstname@ or @assigned.email@

@contact.company.field@ (same as assigned)

Example: @contact.company.address@ or @contact.company.city@

Custom Field Variables

@customfield name@ - by name

or

@#customfield id#@ - by id

Example: @more information@ or @#17342#@


See Also: Invoice Module Variables for Variables specific to the Invoicing module.


UTA Level 1 variables called from UTA Level 2

If your Web Page View is at Level 2, you can call Level 1 variables using:

@parent.fieldname@ or @parent.#fieldid#@ (Note: All field names should be entirely lower case.) 

Example: @parent.status@ or @parent.startdate@ or @parent.#12345#@


UTA Level 2 variables called from UTA Level 3

When working at Level 3, you can call Level 2 variables using:

@parent.fieldname@ or @parent.#fieldid#@ (Note: All field names should be entirely lower case.)


UTA Level 1 variables called from UTA Level 3

If your Web Page View is at Level 3, you can call Level 1 variables using:

@parent.parent.fieldname@ or @parent.parent.#fieldid#@ (Note: All field names should be entirely lower case.)


Level 3 Associated Parent (Opportunity)

Where Payment Allocation is enabled you have two models to choose from before configuring: usually the Associated Parent is a Funding Stream of Overall Budget (event) and the associated object is the Disbursement (Level 3). In less granular cases the Associated Parent is the opportunity.

Level 3 Associated Parent


If Payment Allocation is enabled, you can pull fields from the Associated Parent using the following variable:

@linkparent.fieldname@

If your associated payment is linked to the event you can pull fields from the opporunity using the following variable:

@linkparent.parent.fieldname@ So @linkparent.parent.branch@ will return: SmartSimple Inc.

On the company/branch:

@linkparent.parent.branch.Transit@ will return: 1950

Field List

People Fields

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

Company Fields

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

Lead Fields

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

UTA Contact and Account Variables

Owner:

@owner.fieldname@

Person (Level 1 only):

@person.fieldname@

Assigned (Level 2 only):

@assigned.fieldname@

Company (Level 1 only):

@client.fieldname@

Use @client.categoryids@ to return a list of category IDs - comma delimited - note the leading comma - e.g. ",1234,555,666,"

Use @client.categories@ to return a list of category names - comma delimited e.g. "Agency,Marketing,Good client"

Level 1 Contacts/Accounts

Individual

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

@contact.rolename.fieldname@   or   @company.rolename.fieldname@

where:

  • rolename = the name of the role that has been assigned to the contact/account on the Level One item
  • fieldname = the name of the field that is located on the contact's record.

Example: 

@contact.adjuster.firstname@ or @company.funding agency.address@

Note: if there is more than one contact/account assigned with the rolename specified, only one will be displayed.

List

To display a list of multiple contacts/accounts in the Level 1 contacts/accounts section:

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

See below for details on how to filter and sort the list(s).

  • Note: to display the role that the contact or account is assigned on the Level 1 record use: ~role~
  • Note: to display the name of the contact's company use: ~companyname~

Level 2 Contacts/Accounts

Individual

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

@contacts.rolename.fieldname@

where:

  • rolename = the name of the role that has been assigned to the contact on the Level Two item
  • fieldname = the name of the field that is located on the contact's record.

Example: 

@contacts.adjuster.firstname@

Note: if there is more than one contact assigned with the rolename specified, only one will be displayed.

Contacts

To display a list of the contacts assigned at Level 2:

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

To display only contacts assigned at Level 2 with a specific role/roles (only relevant if the Level 2 Multiple Contact List is enabled)

[#(?object=contact::criteria=roleid=12345) ~firstname~ ~lastname~ ~email~ #]

To get the intersection record identifier (equivalent to ~oprid~ at Level 1) (i.e. for use in Pandora functions)

[#(?object=contact) ~lnkid~ #]

To display the contact's profile status:

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

Notes:

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

Accounts

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

@companies.rolename.fieldname@

To display a list of the companies assigned at Level 2:

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

To get the intersection record identifier (i.e. for use in Pandora functions)

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

Notes:

  • The Account standard field is only available at Level 2 when the Multiple Account list is enabled. See here for details.

To display Level 1 Company Role or Contact Role custom fields

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


where:

  • customfieldid = the numeric id of the custom field

Note: for level 2 records (when the multiple contact/company list(s) are enabled) use $?opr2_customfieldid$ and $?opc2_customfieldid$

Following the same format above, you can also reference custom fields on the company role using the @#field id#@ syntax.

Contact Detail

~uprefix~ ~firstname~ ~lastname~

~uaddress~ ~uaddress2~

~ucity~, ~ustate~ ~upostalcode~

To display Company Association or Contact Association fields

The syntax for extracting information on the entity to which they are associated is as follows . . .

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

where:

  • standard field name = name of the standard field
  • custom field id = the numeric id of the custom field
  • custom field name = the name of the custom field


The syntax for extracting information on fields that are on the intersection, rather than the entity to which they are associated, is as follows . . .

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


Other intersection specific variables options include:

  • ~afcid~: association (intersection) record id.
  • ~afcompanyid~: companyid of associated company
  • ~afcontactid~: userid of associated contact
  • ~afroleid~: roleid of association
  • ~afstartdate~: start date of association
  • ~afenddate~: end date of association

Role Based Custom Fields

When you have a Custom Field such as a Web Page View or MS Word Merge that is located on a User Role or Company Role you can access:

UTA Level 1 Information:

@levelone.fieldname@ or @levelone.customfieldid@

Contact Information:

@contact.fieldname@ or @contact.customfieldid@

Company Information:

@company.fieldname@ or @company.customfieldid@

When you want to refer to a User Role based Custom Field from a UTA Level 1 record use the following syntax: Owner:

@owner.fieldname@

Person:

@person.fieldname@

Contact:

@contact.rolename.fieldname@
where rolename is the role they are assigned on the Level 1 record

To Display a List of Activities, Notes, Transactions, Contacts, Companies, Consumers, Providers

Syntax

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

Where:
  • objectname is the name of the item to be listed.
Either: address, activity, assign, contact, user, group, company, notes, association, companyassociation, transaction, timesheet, level-1, utaproviderL1, utaproviderL2, utaconsumerL1, utaconsumerL2 or linkactivity
  • standardfieldname is the name of a standard field (between tildes, ~)
  • customfieldname is the name of a custom field (between dollar signs, $)

Notes:

  • You can refer to Custom Fields in the list using the Custom Field ID instead of the field name, still between dollar signs ($12345$)
  • level-1 can only be used as an object when referenced from a contact record. Also level-1 will only list the level 1s that the contact has been added to in the contacts section.
  • You can include text as well as variables within the [#...#] syntax.
  • When using this syntax for Web Page Views, Read Only – System Variables etc. you will usually want to include HTML table formatting within the [#...#] syntax (see examples below). For MS Word Merge custom fields the table defined on the MS Word Template document, with the columns delimited by pipes (|) within the [#...#].
  • ~Index~ can be used to number the lines (1, 2, 3...) Note: ~index~ does not work for all lists. For example, it cannot be used when listing contacts associated with a Level 1.
    • ~Index~ (upper case 'I') starts numbering at 1, ~index~ (lower case 'i') starts numbering at 0.

~eventid~ will display the id of the level 2.


Options:

Option Effect
orderby=standardfieldname Sorts the list in ascending order by the standard field specified
orderby=standardfieldname desc Sorts the list in descending order by the standard field specified
orderby=tbl_customfieldid.valuestr Sorts the list in ascending order by the custom field specified
criteria=standardfieldname=value Filters the list by the standard field and value specified
criteria=tbl_customfieldid.valuestr=value Filter the list by the custom field and value specified
criteria=(standardfieldname=value or standardfieldname=value) For multiple criteria when either conditional criteria can apply
criteria=(standardfieldname=value AND standardfieldname=value) For multiple criteria when both conditional criteria must apply
groupfunction=aggregatefunction Performs specified aggregate function on the listed fields
Ex. sum, count, countdistinct
  • multiple options (i.e. a criteria and an orderby option) can be included, separated by doubled colons (::)

Important: Any custom fields that you use as criteria or orderby must appear in the display. If you do not wish to display the field you can place it in a comment. (i.e.: <!--$12343$-->) However, if referencing a field as a property of a table you must show the value.


Examples: 

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

See MS Word Merge for further details on including tables on MS Word Merge documents


  • To reference the Consumer UTA Level 1 owner name and ownerid from a Provider UTA Level 1 Read Only - System Variable custom field
[#(?object=utaconsumer::criteria=statusname IN ('Placed','Resigned/Terminated'))~ownername~,~ownerid~ #]


  • To Display custom fields via List Syntax for Invoicing (objectname=appliedtoinvoices). Grabbing a custom field value off the invoice (ie. 282588) and into an adjustment.
Example: [#(?object=appliedtoinvoices)$282588$#]

Note: refer to the custom field by the number ONLY, do not use the custom field name.


[#(?object=contact) #]

First Name Last Name E-mail Address Cell Phone Number
~firstname~ ~lastname~ ~email~ $Cell Phone$

Note: The first line creates a header row for the table.

  • For a list of Level 2 (or Level 3) activities sorted by Start Date in descending order:
[#(?object=activity::orderby=startdate desc)#]
~subject~ ~location~ ~startdate~


  • For a list of contacts assigned to a Level 1 with the role of "Internal People", sorted by surname:

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

~firstname~ ~lastname~ ~email~


  • For a list of level 1 records, including owner details, that a Company has been asssigned to:

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


  • To display the level 1 ID of the level 1 records:

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


  • For a list of all companies that the owner of a UTA record is associated with:
@owner.[#(?object=association)~name~ (Phone ~phone~)#]@


  • To get a comma-separated list of the companyids of all the companies the current user is associated with with roleid 54545:
@me.[#(?object=association::criteria=roleid=54545)~afcompanyid~,#]@


  • For a list of all contacts associated to the current user's parent company record (associated to the company with roleid 12345):
@me.parent.[#(?object=association::criteria=roleid='12345')~firstname~ ~lastname~ (Phone ~phone~)#]@


  • For a list of a company's Active(current date is between start and end date) associations:
[#(?object=association::criteria=(afstartdate is null OR afstartdate<='@date(currentdate)@') AND (afenddate is null OR afenddate>='@date(currentdate)@'))~userid~,#]


  • For a list of all contacts/users located under a company with a given role
[#(?object=user::criteria=rolelist like '%,12345,%') ~email~ #]


  • To count the number of contacts assigned with the role of Reviewer:
[#(?object=contact::criteria=rolename="Reviewer"::groupfunction=count)~userid~#]


  • To include and format a date stored in a custom field (see also sscalculation)
[#(?object=activity)<!--@sscalculation(date_format("$fieldname$","%M %d, %Y"))-->#]


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


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

Note: multiple options (i.e. a criteria and an orderby option) can be included, separated by doubled colons (::)


  • To sort descending by a custom field called Total Hours with a custom field id of 67292:
[#(?object=activity::orderby=tbl_67292.valuestr desc)Subject: ~subject~Total Hours: $Total Hours$Start Date: ~startdate~#]

Note: $Total Hours$ in the list could be listed as $67292$ with the same result.


  • To sort descending reviews in a specific status by a custom field on a separate UTA Level 1 field called $Staff Final Score$ with a custom field id of 1584168 in numeric order:
[#(?object=utaconsumerL1::orderby=tbl_15868.valuestr*1::criteria=(statusname='Member Review'))

Note: $Staff Final Score$ in the list could be listed as $15868$ with the same result.


  • To list a specific activity type only:
[#(?object=activity::orderby=startdate::criteria=typename='This Activity Type')~subject~~location~~startdate~#]


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

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

~subject~ ~location~ ~startdate~


  • To include a hyperlink to the object:

Syntax 1.png


  • To list activities based on status Draft and sort by startdate:

Syntax 2.png


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

Syntax 3.png


  • To list UTA Providers:
[#(?object=utaproviderL1::criteria=rolename="Panel") ~name~ ~typename~ ~statusname~ ~enddate~ $Panel Review Date$ $Panel ID
<!-- @sscalculation(@xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A") 1+#]@ 0) -->

#]


  • To list notes (from the record that contains the notes):
[#(?object=notes::orderby=createddate desc)~notes~~createddate~~username~#]

Note: This syntax is for "Public (Default)" notes only, not custom note types.


  • To list all companies under a parent company record:
[#(?object=company) ~name~ #]


  • To list all L3 allocations within a L2 budget record:
[#(?object=linkactivity) ~subject~ #]


  • To sum or count all the L3 allocations from the budget L2 record:
@linkactivity.sum(...)@ or @linkactivity.count(...)@


  • To list level 2 notes for each level 2 record at level 1:

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

[@(?object=notes::orderby=createddate desc)@]

~notes~ ~createddate~ ~username~
  1. ]

Note: This syntax is for "Public (Default)" notes only, not custom note types.


  • To do a sum of all the unpaid payment transaction:
Total Paid: [#(?object=transaction::criteria=trstranstype=11 and tbl_1145339.valuestr='Paid'::groupfunction=sum)$1145183$ #] Note: $1145339$ - Status of payment $1145183$ - Payment Amount

Referencing Standard Fields of UTA Providers

Level 1 Field Name and Variable List
Field Name Variable
Application Name ~name~
Type Name ~typename~
Type ID ~type~
Status Name ~statusname~
Status ID ~statusid~
Start Date ~startdate~
End Date ~enddate~
Close Date ~closedate~
Branch No variables
Branch ID ~branchid~
Currency No variables
Exchange Currency No variables
Currency Exchange Rate No variables
Customer ~client~
Customer ID ~companyid~
Modified By No variables
Modified Date No variables
Owner (full name) ~ownername~
Owner (userid) ~updatedby~
Person (full name) No variables
Person (userid) ~oppeopleid~
Role Name ~rolename~
Role ID ~conroleid~

Example: 

[#(?object=utaproviderL1) ~typename~ | ~statusname~ <br />#]
Level 2 Field Names and Variables List
Field Name Variable
Activity Type ~typename~
Activity Type ID ~typeid~
Owner ~ownername~
Owner ID ~eownerid~
Assigned People No variables
Status ~statusname~
Status ID ~statusid~
Subject ~subject~
Description ~description~
Location ~location~
Amount ~eamount~
Start Date ~startdate~
End Date ~enddate~
Opportunity ID ~cevconoppid~
Event ID ~cevprovevtid~
Rolename ~rolename~
Role ID ~cevroleid~

Example: 

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

If you have multiple different UTAs connected as providers, you  can use criteria to filter: 

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

To Format the Start Date or Start Time

~date_format(startdate,'%Y-%m-%d') as startdate~
or
~date_format(startdate,'%h:%i %p') as starttime~

Note:

  • If you wish to use "orderby=startdate", along with a date format other than yyyy-mm-dd you must use a slightly different syntax.
  • Using "~date_format(startdate,'%d-%m-%Y') as startdate~" when using "orderby=startdate" will cause the date to be ordered by dd-mm-yyyy (rather than yyyy-mm-dd, which is chronological)
  • To avoid this, change "date_format(startdate,'%d-%m-%Y') as startdate" to "date_format(startdate,'%d-%m-%Y') as sdate"

Displaying Both Level 2 and Level 3 Activities at Level 1

When displaying a list of Level 2 activities using the [#(?object=activity;)...#] syntax, the corresponding Level 3 activities can be displayed under each of the parent Level 2 activities.


To facilitate this you must create a Read Only - System Variable field at Level 2 that contains the list of Level 3 activities, formatted and filtered as desired.

You can use Visibility Conditions, Role Field Permissions or Status Field Permissions to prevent the field from being displayed on the Level 2 record.

Example:

[@(?object=activity::orderby=typename)@]

Level 3 Activity: ~typename~ ~location~

Then create either a Web Page View or Read Only - System Variable at Level 1:

[#(?object=activity::orderby=startdate) #]

Level 2 Activity: ~subject~ ~statusname~ ~startdate~ ~enddate~
$Level 3 Activity List$
where "Level 3 Activity List" is the name you gave the Read Only – System Variable field


Level 3s with Less Than 25 Fields

If Level 3 has less than 25 fields it is not necessary to create a Read Only – System Variable Custom Field on the Level 2 that lists the Level 3 activities.

Instead you can use the following syntax within the [#...#] that lists the Level 2 activities:

[@(?object=activity)~standardfieldname~ $customfieldname$@]

Note:

  • This syntax will only work if there are less than 25 fields at Level 3.

Example:

  • To display a list of Level 2 activities, including any Level 3 activities under their parent Level 2 activity:

[#(?object=activity::orderby=startdate) #]

Level 2 Activity: ~subject~ ~statusname~ ~startdate~ ~enddate~
[@(?object=activity;orderby=typename)@]
Level 3 Activity: ~typename~ ~location~

Displaying a Specific Number of Items in a List

When you want to display only specific number of activities or transactions in a Web Page View use the following syntax. 

 [#(?object=object::orderby=field) 
    <!--@sslogic(~index~='num')--> 
       ~standard field~ $custom field$ <br /> 
    <!--@end--> 
  #] <br />

where:

  • num = number of activities that should be displayed

XML Variables

Count how many options were selected

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


Filtered XML display output

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


Date/Time Variables

Standard Fields Date/Time

Variable List:

'Start Date'End Date'Close Date
Level 1 onlyModified Date'Display Format@startdate@@enddate@@closedate@@modifieddate@Date formatted according to user preferences (At Level 1 Modified Date also includes the time: 15:40)@longstartdate@@longenddate@@longclosedate@@longmodifieddate@Friday, January 23, 2009@fullstartdate@@fullenddate@@fullclosedate@@fullmodifieddate@2009-01-23 15:40:00@datetime(fullstartdate)@@datetime(fullenddate)@@datetime(fullclosedate)@@datetime(fullmodifieddate)@2009-01-23 15:40:00@date(fullstartdate)@@date(fullenddate)@@date(fullclosedate)@@date(fullmodifieddate)@2009-01-23
  • Note: Start Time and End Time are stored within the fullstartdate and fullenddate fields respectively. They can be accessed and formatted using the variables elements listed below.
To display specific elements of the Start Date, Start Time, End Date, End Time, Close Date, Modified Date:
@month(fullstartdate)@month number in Start Date@monthname(fullstartdate)@name of month in Start Date@day(fullstartdate)@day in Start Date@dayweek(fullstartdate)@name of day in Start Date@year(fullstartdate)@year in Start Date@hour(fullstartdate)@hour in Start Time using 12 hour clock (0-12)@ampm(fullstartdate)@AM or PM reference for Start Time@hour24(fullstartdate)@hour in Start Time using 24 hour clock (0-24)@minute(fullstartdate)@minute in Start Time
Note: For End Date, Close Date or Modified Date replace fullstartdate with fullenddate, fullclosedate or fullmodifieddate respectively.
(seconds are not available for standard date/time fields)
(Close Date does not have a time associated with it)
Examples:
  • To display the Start Date in the format February 22, 1985 you would use:
@monthname(fullstartdate)@ @day(fullstartdate)@, @year(fullstartdate)@
  • To display the End Time in the format 06:45PM you would use:
@hour(fullenddate)@:@minute(fullenddate)@@ampm(fullenddate)@

Current Date/Time

Variable List:

VariableContentDisplayComment@datetime(currentdate)@current date and time as for yyyy-mm-dd HH:mm:ss2013-01-22 17:55:22See also Obtain Server Date and Time@date(currentdate)@current date as for yyyy-mm-dd2013-05-17 @currentdate@current date2009 January 25 @now@current date and time2009 August 25 11:05AMWorkflows only. Not available within UTAsTo display specific elements of the current date or time:
@month(currentdate)@current month number@monthname(currentdate)@name of current month@day(currentdate)@current day@dayweek(currentdate)@name of current day@year(currentdate)@current year@hour(currentdate)@current hour using 12 hour clock (0-12)@ampm(currentdate)@AM or PM reference for current time@hour24(currentdate)@current hour using 24 hour clock (0-24)@minute(currentdate)@current minute
(seconds are not available for the current time)
Examples:
  • To display the current date/time in the format Friday at 19:55 you would use:
@dayweek(currentdate)@ at @hour24(currentdate)@:@minute(currentdate)@

Custom Fields Date/Time

For a custom field on the same level as the Web Page View Field, you can parse out a particular date/time in a date field

VariableContentDisplay@date(fieldname)@custom field date as for yyyy-mm-dd2013-05-17 @month(fieldname)@month number in fieldname05@monthname(fieldname)@name of month in fieldnameMay@day(fieldname)@day in fieldname17@dayweek(fieldname)@name of day in fieldnameFriday@year(fieldname)@year in fieldname2013@hour(fieldname)@hour in fieldname using 12 hour clock (0-12)12@ampm(fieldname)@AM or PM reference for time in fieldnameAM@hour24(fieldname)@hour in fieldname using 24 hour clock (0-24)00@minute(fieldname)@minute in fieldname00@second(fieldname)@second in fieldname00 Examples:
  • To display the custom field Date Of Birth in the format 31-01-2001 you would use:
@day(date of birth)@-@month(date of birth)@-@year(date of birth)@ Note: This syntax will not work for custom fields on a different level. You will not be able to reference, for example, @day(parent.fieldname)@. To parse out date/time information from a custom field on a different level, use the sscalculation syntax.

Miscellaneous Variables

Adding an image from Upload fields

Users can return image thumbnails or meta data from multiple file fields using the list syntax below":

  • Show thumbnail image using thunbnailpath option:
@multi file name.template[# <img src="~thumbnailpath~" alt="" width="240" /> #]@
  • Show thumbnail image and file name using filepath option:
@multi file name.template[# <img src="~filepath~/thumbnail/?maxwidth=240" alt="" width="240" />~filename~#]@
  • Show thumbnail image and file name using compressedpath option:
@multi file name.template[# <img src="~compressedpath~/thumbnail/?maxwidth=240" alt="" width="240" />~filename~#]@
  • Show file name, size and upload date:
@multi file name.template[# ~filename~, ~filesize~, ~uploaddate~#]@


Adding a File Upload button

To display a button to upload to a Single File or Multiple Files custom field:

  • Single File:
<input class="Button" type="button" value="Button Label" />
  • Multiple Files:
<input class="Button" type="button" value="Button Label." />

where:

  • customfieldid = the field id of the Single or Multiple file custom field (without cf_)

Example: 

<input class="Button" type="button" value="Multiple files..." />

Note: if adding to a Web Page View you will need to add the following to the page: 

function include_dom(script_filename) {
    var html_doc = document.getElementsByTagName('head').item(0);
    var js = document.createElement('script');
    js.setAttribute('language', 'javascript');
    js.setAttribute('type', 'text/javascript');
    js.setAttribute('src', script_filename);
    html_doc.appendChild(js);
    return false;
}
function includejsfiles() {
  include_dom("/validate.js");
}

You will also have to call the includejsfiles function in the body onload:



Alternatively:

You may also use @fieldname.uploadlink@ to get the url for the upload page and construct your own function to open the window.

Example: 

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

function openupload(url)
{ 
    upload_window = window.open(url,'upload_window', 'menubar=yes,scrollbars=yes,width=800,height=600,status=no,resizable=yes,dependent=yes,alwaysRaised=yes');
    upload_window.opener = window;
    upload_window.focus();
}

Note: this method will only open the single file upload page.

Displaying a Dynamic Data Grid field

To show a Dynamic Data – Data Grid field in a webpage view field use the following syntax:

@fieldname.table@

Retrieving History for Fields with Track Changes Enabled

The following syntax is used to retrieve standard or custom field history:

For the Status standard field:

@HistoryOf(status)@
@HistoryOf(statuscaption)@

For a Custom Field:

@HistoryOf(customfieldid)@

OR

@HistoryOf(customfieldname)@

Notes:

  • HistoryOf is case sensitive.
  • See the HistoryOf function page for a complete description of this variable and its uses.

For Hybrid Sign-Up Pages

The @user_input_form@ will display the associated user sign up form on a company sign up page if included in the HTML template of the company sign up page.


Currency Format

You can use the following syntax to format a custom field with currency: @format(L2 Subcontract total y1,currency,USD,2)@. The last parameter can be changed from 2 to 0 to display as a whole number.

Session Variables

When using features such as Organization Switching, you may want to pull in specific data based on your current session.

Company Fields: @sessioncompany.fieldname@

Example: @sessioncompany.name@ would return the Company Name of the organization you are currently logged in as.

Controls

Hide a variable if it is missing

Put the following in front of variable name.

<!--hideifnotfound-->

Example: 

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

Note: the <!--hideifnotfound--> and the variable must be in immediate succession, and not separated by a space.

How to display different content based on a value using SSlogic

To display content based on a value from a variable add <!--@sslogic('@branch.name@'='Internal Staff')--> in front of the content and <!--@end--> at the end of the content. If there are 2 different pieces of content to be displayed based on a value and all others add <!--@else--> between the 2 pieces of content. 

<!--@sslogic(CONDITION)-->
   The content to be displayed when condition is true.
   This can be more than one line.
<!--@end-->
  • The content to be displayed (the middle line) can either be in plaintext or in HTML.
  • Be sure there are single quotes around the variable and value.
  • SSlogic does not support nested logic statements.

Example:

  • The following will display a Christmas tree image if the month is December:
<!--@sslogic(month(now())=12)-->
   <img src="images/xmasstree.jpg" alt="" />
<!--@end-->

See SSlogic for more information and further examples.

How to display check boxes in the Web Page View

To display Select Many - Check Box type custom fields as check boxes in a web page view add @checkbox('fieldname/fieldnumber','option name')@ to the check box control.

This syntax works if the check boxes are on the same level.

Example: 

<input type="checkbox" />
See Also: Updateable Web Page View Fields if you wish the Web Page View check boxes to have the ability to change the underlying data.

How to display level two check boxes on level one in the Web Page View

@checkboxvalue(id

values to be checked)@ 

<input name="checkboxb20" type="checkbox" value="Limited community support" />


  • Use two "|" (pipes) to separate id and value to be checked

where 1199639 is customfield id if it is used on the same level @1199639@ if it is used on the child level $1199639$

This works for level one check boxes on level one web page view AND works for level two check boxes on level one web page view AND works for level three check boxes on level one web page view



How to suppress the Page Footer with Printing the Page

To suppress the footer when printing the page you need to change your browser settings.

Internet Explorer

1. Choose the File Page Setup menu.

2. Delete the Header and Footer text.

3. If required, change the margins.

FireFox

1. Choose the File Page Setup menu.

2. Click the Margins & Header/Footer tab.

3. Set all Header and Footer options to Blank.

3. If required, change the margins.

How to control print behaviour

To define a page break place the following code in the HTML source before the content you deem as the next page:


To change the page orientation to landscape first place the following in the header portion (

) of the HTML:

Then place 

 

in the HTML source around the "page" content. Example:

This is the page content that needs to be in landscape

Please note that the page orientation control only works with Internet Explorer and is not the greatest quality print due to the page being converted to an image then rotated.

How to control print behaviour when saving as a PDF

To define a page break in a PDF add before the content you deem as the next page.

To change the orientation of a page to landscape in a PDF add before the content you deem as the next page.

Troubleshooting

  • Issue: 2 variables run together (thus removing the ending @ and beginning @)
  • Resolution: Place a non-breaking space tag (&nbsp;) between the variables.


  • Issue: For a list of level 2 activities, the code is showing instead of the field headings and values you've designated.
  • Resolution: Insert a comment tag before the first cell tag. i.e.


See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Web_Page_View_Field_Variables&oldid=43046’