8,849
edits
Changes
no edit summary
{{MySQL Syntax}}
{{l1}}, {{l2}} and {{l3}} records can perform advanced calculations and logic within their Formula boxes.
==General Information==
{{l1}}, {{l2}} and {{l3}} records can perform advanced calculations and logic within their Formula boxes.
* The formulas on the Application Configuration page apply to all records saved at the specified Level.
* The formulas the Template page ({{l1}}) or Type page ({{l2}} and {{l3}}) apply to records on the given Template/Type only.
If you wish to perform calculations on fields associated with Level 3, but store the results in fields at the Level 2, you use the '''Level 2 Formula''' field. You can use any expression and also some built in functions. You may also wish to use Template Formulas instead of a Calculated field because the calculations are done server side, rather than by the browser.<br>
Thus if you are doing a calculation on a value that needs to be populated or calculated on the same Level 3 item, this will avoid you having to save twice in order to get the final result.
===Execution Sequence===
* The Formulas are calculated when a record is saved.
* The ''General'' formula for the on the Application Configuration page is executed first, followed by the [[Template]]/[[Type]] specific formula (if present).
* Saving a Level 2 or Level 3 record will also initiate the formulas on the parent level(s):
<u>{{l1}}:</u>
* When a {{l1}} record is saved the formulas are executed in the following sequence:
::''Level 1 Formula-->Level 1 Template Formula''
<u>Level 2:</u>
* When a Level 2 record is saved the formulas are executed in the following sequence:
::''Level 2 Formula-->Level 2 Type Formula-->Level 1 Formula-->Level 1 Template Formula''
* '''Note''': The Level 1 Formula and Level 1 Template Formula are only executed if one of them refers to a Level 2 variable.
<u>Level 3:</u>
* When a Level 3 record is saved the formulas are executed in the following sequence:
::''Level 3 Formula-->Level 3 Type Formula-->Level 2 Formula-->Level 2 Type Formula-->Level 1 Formula-->Level 1 Template Formula''
* '''Note''': The Level 2 Formula and Level 2 Template Formula are only executed if one of them refers to a Level 3 variable.
There are a number of functions that are pre-defined:
{| border="1" style="background-color:#ffffcc;" cellpadding="20" cellspacing="0"
! Function
! Example
! Description
|-
|Count(*)
|@level2.#items#@=@level3.count(*)@
|Count the number of Level 3 records and store the result in the Level 2 '''Items''' custom field .
|-
|Sum()
|@level2.amount@=@level3.sum(amount)@
|Sum the '''amount''' standard field from all Level 3 items and store the result in the Level 2 '''Amount''' standard field
|-
|Max()
|@level2.#most#@=@level3.max(amount)@
|Store the largest '''Amount''' in any Level 3 item into the '''Most''' Level 2 [[Custom Field]]
|-
|Avg()
|@level2.#average#@=@level3.avg(amount)@
|Store the average '''Amount''' across all associated Level 3 items for the amount field into the Level 2 '''Average''' [[Custom Field]].
|}
'''Important:''' The ''sum'', ''max'' and ''avg'' functions will '''only''' work with the '''Amount''' [[Standard Field]] from Level 2 or Level 3.
===Criteria===
When using these defined functions you can restrict which records are included in the aggregated functions using criteria.
@level1.Registered Clients@=@contacts.count(*):cf_123456='Yes'@;
When you wish to use multiple template formulas, you must use the semicolon to separate them. For example:
'''IMPORTANT''': ''Template formulas will only work if the Template standard field is enabled and visible on the page.''
===Counting and Adding Business Days===
Aside from using [[Counting Business Days between Two Dates|Javascript]] to count business days, there are 2 SmartSimple functions you can use within the L1, L2, and L3 template formula to count and add business days to any Date field.
'''To count the number of business days between 2 date fields, use the following function:'''
This example below calculates the number of business days between the Start Date and End Date.
'''@level1.DateDifference@=SS_FUNC.countbusdays('@level1.Startdate@','@level1.Enddate@')'''
'''To increment a date by a number of business days, use the following function:'''
This example below adds 5 business days to the startdate.
Note in order to take into considering holidays, you will need to create a holiday [[Entering_a_New_Calendar_Event|Calendar]] and associate this calendar as the holiday calendar within [[Global Settings]].
==Examples==
* If you want to assign company of the Level 1 '''Owner''' to the Level 1 '''Customer''' field you would use the following:
@level1.companyid@=@level1.owner.companyid@;
:''Note: the '''Customer''' field can be be hidden, and will still populate. This is true for all Template/Type formulas.''
* To assign the owner of the company attached to the Level 1 item to the ''Person '' field use the following statement in the Level 1 template formula box:
* To populate the '''End Date''' standard field with the date the status is changed to '''Complete'''
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">@level1.enddate@=CASE WHEN "@level1.status@"="Complete" and "@level1.enddate@"="0000-00-00" THEN CURDATE() WHEN "@level1.status@"="Complete" and "@level1.enddate@"!="0000-00-00" THEN "@level1.enddate@" ELSE "0000-00-00" END;</pre>
==Using a Level 2 Type Formula==
[[Image:Uta129.png]]
5. Click the '''Save''' button.
[[Image:Uta130.png]]
10. Enter the following formula:
[[Image:Uta131.png]]
11. Click the '''Save''' button.
[[Image:Uta132.png]]
* The duration is set to the sum of the durations of the associated [[Level 3 Entity|Level 3 entities]].
* The same technique can be applied to the Level 1 [[Template]] formula to sum all the Level 2 durations.
'''Summing Level 2 to Level 1 using field ID:'''
Go to level 1 template and use the following format @level1.#123456#@=@level2.sum(#987763#)@
'''Summing Level 3 to Level 2 using field ID:'''
Go to level 2 template and use the following format @level2.#123456#@=@level3.sum(#678954#)@
'''Summing Level 3 to Level 2 base on a particular level 3 type:'''
Go to level 2 template and use the following format @level2.#50235#@=@level3.sum(#50291#):eventtype=8866@
where 50235 is the custom field where you want the value to store in, 50291 is the custom field that you want to sum and 8866 is the level 3 type ID,
Note: Currently the system doesn't support summing from level 3 to level 1 using a custom field id. The summing would only work with Amount and Duration field.
==Using a Level 3 Type Formula==
You can use the Level 3 Type Formula field on the Level 3 Type page in a similar manner as for Level 2.
* The advantage of using a Level 3 Type Formula instead of a Calculated field is that the calculations are done server side, rather than by the browser.<br /> Thus if you are doing a calculation on a value that needs to be populate or calculated on the same Level 3 item, this will avoid you having to save twice in order to get the final result.
The following example calculates the product of the values stored in fields named '''rate''' and '''quantity''', and saves it in a field called '''Total''' with a field ID of 1731330:
'''@level3.#123100#@=@level3.#123098#@*@level3.#123099#@'''
* To refer to fields on the associated Level 1 or Level 2 records use '''level1.fieldname''' and '''level2.fieldname''':
==Using Template/Type Formulas for Text==
If you are using a Template or Type formula to populate a field with '''text''', rather than perform a calculation, you must enclose the statement on the right-side of the equal sign in quotations.
* Any other text inside the quotation marks, including spaces, will be concatenated to the result with the variables:
:''Note that the space between the "client first name" and "client last name" variables will place a space between them in the resultant statement.''
'''Example 2'''
@level1.name@="@level1.item 1@, @level1.item 2@ and @level1.item 3@";
:''Would result in a comma and space between the first 2 items and the word "and" between item 2 and 3.''
==Using Conditional Statements==
Conditional statements can be used in formulas with the following structure:
:<font size="3">'''@variable@=if(''conditional statement'',''value if true'',''value if false'');'''</font>
It is recommended to separate out the criteria to avoid issues caused by variable values containing special characters like quotation marks. For example, instead of the following statement...
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">@level1.Success Criteria Count@=if('@level1.status@' IN ('Draft','Pending'),'@level1.xml.Success Criteria.Criteria.item.nodevalue@','@level1.Success Criteria Count@');</pre>
...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;">@level1.Success Criteria Count@=if(? IN ('Draft','Pending'),?,?):=:@level1.status@:,:@level1.xml.Success Criteria.Criteria.item.nodevalue@:,:@level1.Success Criteria Count@;</pre>
Note that the criteria for the ''if'' statement are first referenced as ''?'' marks, then the ''if'' statement is separated from the criteria values using '':=:'', then the separate criteria values are separated by '':,:''
You can also use the '''Case''' syntax:
@level1.Notice Text@=CASE '@level1.status@' WHEN 'Status 1' THEN 'Submission Cutoff is March 5th.' WHEN 'Status 2'
THEN 'Thank for your submission' WHEN 'Status 3' THEN 'Congratulations' ELSE 'I have no comment' END;
===Examples===
* At Level 2: if the field called ''locationpreference'' says "Home" put the value in the ''homeaddress'' field into '''Location'''. Otherwise put the value from the ''worksaddress'' field into '''Location'''.
@level2.location@=if('@level2.locationpreference@'='Home','@level2.homeaddress@','@level2.workaddress@');
*If the '''Status''' is ''Closed'' AND no ''enddate'' entered, populate the '''enddate''' with today's date. Otherwise leave the existing ''enddate''.:
::'''Note''': to test for a blank date you should test against both '''=''''' and '''regexp '@|0000''''
@level1.enddate@=
if('@level1.status@'='Closed' and ('@level1.enddate@'='' or '@level1.enddate@' regexp '@|0000'),
date_format(now(),'%Y-%m-%d'),
'@level1.enddate@');
* At Level 3, if the contact assigned is a member of role 12345 put their name into the ''Consultant'' field. Otherwise use the Level 2 ''Owner'' for the Consultant field:
==Using Object Syntax==
Object syntax can be used in template formulas to loop through the level below and to assign a value or values based on some defined criteria. The syntax differs from the basic [[Web_Page_View_Field_Variables#To_Display_a_List_of_Activities.2C_Notes.2C_Transactions.2C_Contacts.2C_Companies.2C_Consumers.2C_Providers|object syntax]] in that the template formula must use double colons (i.e. '''::''') rather than a semi-colon to separate the criteria from the object.
An example of the syntax for this is shown below:
<br/><br/>
:<font size="3">'''@level1.name@="@level1.[#(?object=activity::criteria=eventtype=3123) ~subject~ #]@"'''</font>
<br/>In this example the value in the Subject standard field for the child level 2s that have an eventtype with value of 3123 will be stored in the Name standard field of the parent level one{{l1}}.
<br/><br/><br/><br/>
==UTA Provider syntax==
* If you are using template formulas to populate Level One {{l1}} fields with details on associated UTA providers then you must use the following syntax:
@level1.fieldname@=@level1.utaprovider.count(*)@;
* If you are using template formulas to populate {{l1}} fields with details on associated UTA consumer then you must use the following syntax:
@level1.fieldname@=@level1.utaconsumer.count(*)@;
* If you are using template formulas to populate {{l2}} fields with details on associated {{l1}} UTA providers then you must use the following syntax:
@level2.fieldname@=@level2.utaprovider.count(*)@;
* If you are using template formulas to populate {{l2}} fields with details on associated {{l1}} UTA consumers then you must use the following syntax:
@level2.fieldname@=@level2.utaconsumer.count(*)@;
==Additional Information==
* You cannot change the [[Status]] using a Template / Type Formula.
* You can trigger execution of the Template / Type formulas against a group of records without opening and saving them using the [[Batch Update]] feature.
==See Also==
* [[Role Formula]]
* [[The Musings of Chin - Template Formulas]]
[[Category:Universal Tracking Application]][[Category:Date Formats]]
