110
edits
Changes
→Syntax
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.
=Variable List=
==Current User==
''Note: "me" -- refers to the current user''
==UTA Level 1, Sales Opportunity and Job Variables==
'''@name@''' - standard field '''Application Name'''.
'''@status_lang@''' - standard field '''Status (Based on user language setting)'''
'''@description@'''
'''@requirements@'''
'''@enddate@'''
'''Created Date@createddate@''' - no variable
'''Created By@createdby@''' - no variable
'''@jobquestions@''' - displays as combo boxes
'''@owner.field@'''
Example: '''@owner.fullname@''' or '''@owner.address@'''
'''@person.field@'''
Example: '''@person.fullname@''' or '''@person.address@'''
'''@company.field@'''
Example: '''@company.name@''' or '''@company.address@'''
Example '''@company.owner.email@'''
'''@branch.field@'''
Example: '''@branch.name@''' or '''@branch.address@'''
==UTA Level 2 / Activities Variables==
'''@subject@'''
==UTA Level 2 variables called from UTA Level 3==
When working at Level 3, you can call Level 2 variables using:
<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>
=Field List=
<u>'''People Fields'''</u>
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)
<u>'''Company Fields'''</u>
name, address, address2, city, province, state, country, postalcode, phone, fax, website
<u>'''Lead Fields'''</u>
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:
: <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):
:<span style="font -size="3: medium;">'''@client.''fieldname''@'''</fontspan>Use @client.categoryids@ to return a list of [[Determining the categoryid|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 <u>single</u> contact/account in the Level 1 contacts/accounts section:
: <span style="font-size: medium;">'''@contact.''rolename.fieldname''@''' </span> or <span style="font-size: medium;"> '''@company.''rolename.fieldname''@'''</span>
'''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@
===List===
To display a list of multiple contacts/accounts in the Level 1 contacts/accounts section:
: <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).
* '''Note''': to display the role that the contact or account is assigned on the Level 1 record use: <span style="font -size="3: medium;">'''~role~'''</fontspan>* '''Note''': to display the name of the contact's company use: <span style="font -size="3: medium;">'''~companyname~'''</fontspan>
==Level 2 Contacts/Accounts==
===Individual===
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:'''
* ''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@
===Contacts===
To display a list of the contacts assigned at Level 2:
: <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)
: <span style="font-size: medium;">'''[#(?object=contact::criteria=roleid=12345) ~firstname~ ~lastname~ ~email~ #]'''</span>
To get the intersection record identifier (equivalent to ~oprid~ at Level 1) (i.e. for use in [[Pandora]] functions)
: <span style="font-size: medium;">'''[#(?object=contact) ~lnkid~ #]'''</span>
To display the contact's profile status:
: <span style="font-size: medium;">'''[#(?object=contact) ~firstname~ ~lastname~ ~ustatusid~ #]'''</span>
'''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 <u>single</u> account in the Level 2 accounts section:
: <span style="font-size: medium;">'''@companies.''rolename.fieldname''@'''</span>
To display a list of the companies assigned at Level 2:
: <span style="font-size: medium;">'''[#(?object=company::orderby=name)~name~ #]'''</span>
To get the intersection record identifier (i.e. for use in [[Pandora]] functions)
: <span style="font-size: medium;">'''[#(?object=company) ~clnkid~ #]'''</span>
'''Notes:'''
:* 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.
==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>
'''where:'''
* customfieldid = the numeric id of the custom field
~ucity~, ~ustate~ ~upostalcode~
==To display Company Association Role or Contact Association Role fields==The syntax for extracting information on the entity to which they are associated is as follows . . . <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 fieldsfield id$ $custom field name$#]'''</span> '''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
<span style="font-size: medium;">'''[#(?object=association) ~afcompanyid~ #]<br /><br />'''where:[#(?object=companyassociation)~afroleid~ #]''' </span>* customfieldid = the numeric id of the custom field 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 <u>'''on'''</u> a User Role or Company Role you can access:
[[UTA]] Level 1 Information:
: <span style="font-size: medium;">'''@levelone.''fieldname''@'''</span> or <span style="font-size: medium;">'''@levelone.''customfieldid''@'''</span>
Contact Information:
: <span style="font-size: medium;">'''@contact.''fieldname''@'''</span> or <span style="font-size: medium;">'''@contact.''customfieldid''@'''</span>
Company Information:
: <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:
:<span style="font -size="3: medium;">'''@owner.''fieldname''@'''</fontspan>
Person:
:<span style="font -size="3: medium;">'''@person.''fieldname''@'''</fontspan>
Contact:
: <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="3: medium;">'''[#(?object=''objectname''::{options})~''standardfieldname''~ $''customfieldname''$#]'''</fontspan>
'''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 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.
'''Options:'''
|-
|-
||<span style="font -size="3: medium;">orderby=''standardfieldname''</fontspan>||Sorts the list in ascending order by the standard field specified
|-
||<span style="font -size="3: medium;">orderby=''standardfieldname'' desc</fontspan>||Sorts the list in descending order by the standard field specified
|-
||<span style="font -size="3: medium;">orderby=tbl_''customfieldid''.valuestr</fontspan>||Sorts the list in ascending order by the custom field specified
|-
||<span style="font -size="3: medium;">criteria=''standardfieldname''=''''value''''</fontspan> ||Filters the list by the standard field and value specified
|-
||<span style="font -size="3: medium;">criteria=tbl_''customfieldid''.valuestr=''''value''''</fontspan>||Filter the list by the custom field and value specified
|-
||<span style="font -size="3: medium;">criteria=(''standardfieldname''=''''value'''' or ''standardfieldname''=''''value'''')</fontspan>||For multiple criteria when '''either''' conditional criteria can apply
|-
||<span style="font -size="3: medium;">criteria=(''standardfieldname''=''''value'''' AND ''standardfieldname''=''''value'''')</fontspan>||For multiple criteria when '''both''' conditional criteria must apply
|-
||<span style="font -size="3: medium;">groupfunction=''aggregatefunction''</fontspan> ||Performs specified aggregate function on the listed fields<br />Ex. sum, count, countdistinct
|}
* ''multiple options (i.e. a criteria and an orderby option) can be included, separated by doubled colons (::)''
'''Examples:'''
* To generate a list of Level 2 activities for a [[MS Word Merge]]:
[#(?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.
<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)
</table>
</pre>
::: ''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~ #]
:* For a list of contacts assigned to a Level 1 with all companies that the role owner of "Internal People", sorted by surname:<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"> <table>a [[#(?object=contactUTA]] record is associated with::orderby=lastname::criteria=rolename='Internal People')<tr><td>~firstname~</td><td>~lastname~</td><td>~email~</td></tr>#]</table></pre>
@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<br='@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"))-->#]
[#(?object=activity)<!--@sscalculation(date_format("$fieldname$","%M %d, %Y"))-->#]
:* With Multiple Criteria: <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=contact::criteria=(rolename='External' or rolename='Internal'))<tr><td>~firstname~ ~lastname~</td></tr>#]
</pre>
:* To sort descending by a custom field called ''Total Hours'' with a custom field id of ''67292'': <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=activity::orderby=tbl_67292.valuestr desc)<tr><td>Subject: ~subject~</td><td>Total Hours: $Total Hours$</td><td>Start Date: ~startdate~</td></tr>#]
</pre>
'''Note:''' ''$Total Hours$'' in the list could be listed as ''$67292$'' with the same result.
:* To list sort descending reviews in a specific activity type onlystatus 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: <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=activityutaconsumerL1::orderby=startdatetbl_15868.valuestr*1::criteria=typename(statusname='This Activity TypeMember Review')<tr><td>~subject~</td><td>~location~</td><td>~startdate~</td></tr>#])
</pre>
'''Note:''' ''$Staff Final Score$'' in the list could be listed as ''$15868$'' with the same result.
:* To list activities based on the [[Determining the typeid|a specific activity type ID]] ('''Level 2 and Level 3 only'''): <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><table>[#(?object=activity::orderby=startdate::criteria=typeidtypename='24160This Activity Type')<tr><td>~subject~</td><td>~location~</td><td>~startdate~</td></tr>#]</table>
</pre>
:*To include a hyperlink to list activities based on the [[Determining the object typeid|type ID]] (for Accounts'''Level 2 and Level 3 only'''):<pre style[#(?object=activity::orderby="white-spacestartdate:: precriteria=typeid='24160')#] {||-wrap; white-space: -moz-pre-wrap; ||~subject~||~location~||~startdate~|} white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap* To include a hyperlink to the object (for Accounts): break-word;"><table>[#(?object=company::criteria=rolename="Cooperating Organization")<tr><td><a target='app_win' href=/#] {||-||[s_viewcompany.jsp?companyid=~companyid~>~name~</a></td><td>]||~role~</td></tr>|} :* To list activities based on status: [#(?object=activity::orderby=startdate::criteria=statusname='Open')#]</table></pre>
{|
|-
||~subject~
||~location~
||~startdate~
|}
:* To list activities based on the status ID ('''Level 2 and Level 3 only'''):
{|
|-
||~subject~
||~location~
||~startdate~
|}
:* To list UTA Providers:
:* To list notes (from the record that contains the notes):
</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:
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=activity::orderby=startdate desc)<tr><td>~subject~</td><td>~description~</td><td>~startdate~</td><td><table>[@(?object=notes::orderby=createddate desc)@]<tr><td/pre>{||-||~notes~</td><td>||~createddate~</td><td>||~username~</td></tr>@]</table></td>|}</trpre style="white-space: -o-pre-wrap; word-wrap: break-word;">#]
</pre>
::::''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)||''To do a sum of all the unpaid payment transactionNo variables''|-||Person (userid)||~oppeopleid~|-||Role Name||~rolename~|-||Role ID||~conroleid~|} '''Example:''' <prestyle="white-space: -o-pre-wrap; word-wrap: break-word;"><table><tr><td>Total Paid: [#(?object=transaction::criteriautaproviderL1) ~typename~ | ~statusname~ <br />#]</pre> {| class=trstranstype"wikitable"|+style=11 "text-align:left"|Level 2 Field Names and tbl_1145339.valuestr=Variables List|-!|Field Name!|Variable|-||Activity Type||~typename~|-||Activity Type ID||~typeid~|-||Owner||~ownername~|-||Owner ID||~eownerid~|-||Assigned People||''No variables'Paid'::groupfunction=sum)$1145183$ <!|-||Status||~statusname~|-$1145339$||Status ID||~statusid~|-||Subject||~subject~|->#]Note:||Description||~description~$1145339$ |- Status of payment$1145183$ ||Location||~location~|- Payment ||Amount</td></tr>||~eamount~|-||Start Date||~startdate~|-||End Date||~enddate~|-||Opportunity ID||~cevconoppid~|-||Event ID||~cevprovevtid~|-||Rolename||~rolename~|-||Role ID||~cevroleid~|}</table></pre>'''Example:'''
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">[#(?object=utaproviderL1::criteria=provappid="12345") ~typename~ | ~statusname~ <br />#]</pre>
==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:'''
:::* 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==
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.
:::: ''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.
'''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:<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><table> [@(?object=activity::orderby=typename)<tr><td> @] {||-||Level 3 Activity: ~typename~</td><td>||~location~</td></tr>@]</table></pre>|}
Then create either a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variable]] at Level 1:
===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.
Instead you can use the following syntax '''within''' the '''[#...#]''' that lists the Level 2 activities:
::: <span style="font-size: medium;">'''[@(?object=activity)~standardfieldname~ $customfieldname$@]'''</span>
'''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:<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><table>[#(?object=activity::orderby=startdate)#]<tr><td>{||-||Level 2 Activity: ~subject~</td><td>||~statusname~</td><td>||~startdate~</td><td>||~enddate~</td></tr> <tr><td></td><td |-||| colspan="3> <table> "|[@(?object=activity;orderby=typename)<tr><td> @]{||-||Level 3 Activity: ~typename~</td><td>||~location~</td></tr>@] </table> </td></tr>#]</table> |}</pre>|}
==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.
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"> [#(?object=object::orderby=field)
<!--@sslogic(~index~='num')-->
~standard field~ $custom field$ <br />
</pre>
'''where:'''
::* num = number of activities that should be displayed =XML Variables===Count how many options were selected==<pre><!--@sscalculation(@xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A") 1+#]@ 0)--></pre> ==Filtered XML display output==<pre>@xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A")~FirstName.nodevalue~ ~LastName.nodevalue~<br />#]@</pre>
=Date/Time Variables=
==Standard Fields Date/Time==
'''Variable List:'''
::* '''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)
::: '''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"|-!Variable!!Content!!Display!!Comment|-||VariableContentDisplayComment@datetime(currentdate)@||current date and time as for yyyy-mm-dd HH:mm:ss||2013ss2013-01-22 17:55:22||See 22See also [[Obtain Server Date and Time]]|-||@date(currentdate)@||current date as for yyyy-mm-dd||2013dd2013-05-17|| |-||@currentdate@||current date||2009 date2009 January 25|| |-||@now@||current date and time||2009 time2009 August 25 11:05AM||Workflows 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:'''
::* 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'''
::: {| border="1" cellpadding="5"VariableContentDisplay@date(''fieldname'For a ')@custom field on the same level date as the Web Page View Field, you can parse out a particular date/time in a date field'''for yyyy-mm-dd2013-05-17
'''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)@
=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:
<pre>@multi file name.template[# <img src="~thumbnailpath~" alt="" width="240" /> #]@
</pre>
::* Show thumbnail image and file name using filepath option:
<pre>@multi file name.template[# <img src="~filepath~/thumbnail/?maxwidth=240" alt="" width="240" />~filename~#]@
</pre>
::* Show thumbnail image and file name using compressedpath option:
<pre>@multi file name.template[# <img src="~compressedpath~/thumbnail/?maxwidth=240" alt="" width="240" />~filename~#]@
</pre>
::* Show file name, size and upload date:
<pre>@multi file name.template[# ~filename~, ~filesize~, ~uploaddate~#]@
</pre>
==Adding a File Upload button==
To display a button to upload to a [[Single File]] or [[Multiple Files]] custom field:
::* 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:'''
'''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');
</pre>
You will also have to call the ''includejsfiles'' function in the body onload:
'''Alternatively:'''
'''Example:'''
<input class="Button" type="button class=Button " value='"Upload' onclick="openupload('@fieldname.uploadlink@')" /><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');
==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:
::: <span style="font-size: medium;">'''@fieldname.table'''@</span>
==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:
::: <span style="font-size: medium;">'''@HistoryOf(status)@'''</span>::: <span style="font-size: medium;">'''@HistoryOf(statuscaption)@'''</span>For a [[Custom Field]]: :::<span style="font -size="3: medium;">'''@HistoryOf(''customfieldid'')@'''</fontspan>
OR
:::<span style="font -size="3: medium;">'''@HistoryOf(''customfieldname'')@'''</fontspan>'''Notes:''':::* ''HistoryOf'' is case sensitive.:::* See the [[HistoryOf function]] page for a complete description of this variable and its uses.
==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.
=Controls=
==Hide a variable if it is missing==
Put the following in front of variable name.
::: <span style="font-size: medium;">'''<!--hideifnotfound-->'''</span>
'''Example''':
<pre> <!--hideifnotfound-->@parent.contact.adjuster.email@
</pre>
</pre>
::* 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>
==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:''' <pre><input type="checkbox" @checkbox('12345','yes')@/>
</pre>
:::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" />
where 1199639 is customfield id
if it is used on the same level '''@1199639@'''
==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.
==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''':
<div class="page">This is the page content that needs to be in landscape</div>
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 define change the orientation of a page break to landscape in a PDF add <pd4ml:page.break/> before the content you deem as the next page.
::** '''Issue''': For a list of level 2 variables run together (thus removing activities, the code is showing instead of the ending @ field headings and beginning @) values you've designated.::** '''Resolution''': Place Insert a non-breaking space comment tag (&nbsp;) between before the variablesfirst cell tag. i.e.
<pre> </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:PDF]]%20in%20webpage%20view%20field%20showing%20activity" data-mce-href="Allow%20for%20' [[Category:Custom Fields]][[Category:Variables]][[Category:PDF]]%20in%20webpage%20view%20field%20showing%20activity" title="Allow%20for%20' [[Category:Custom Fields]][[Category:Variables]][[Category:PDF]]%20in%20webpage%20view%20field%20showing%20activity" data-bs-type="internal_link" class="internal bs-internal-link" data-bs-wikitext="Allow%20for%20' [[Category:Custom Fields]][[Category:Variables]][[Category:PDF]]%20in%20webpage%20view%20field%20showing%20activity">Allow for '$' [[Category:Custom Fields]][[Category:Variables]][[Category:PDF]] in webpage view field showing activity]]
[[Category:Custom Fields]][[Category:Variables]][[Category:PDF]]
