Changes

Jump to: navigation, search

Transaction Variables

1,938 bytes added, 15:52, 21 November 2014
no edit summary
* Subject: @subject@<br>
* Status: @status@<br>
* Details: @Details@<br>
* Start Date: @startdate@<br>
* End Date: @enddate@<br>
* Transaction ID: @transid@<br>
* Transaction Type Name: @transtype@<br>
* Transaction Type ID: @transtypeid@<br>
* Last Modified: @trsts@ (transaction time-stamp)<br>
* Custom Fields: @''customfieldname''@ (see note below)<br>
 
 
Transactions are often displayed as a list, which can be done using the following syntax:
[#(?object=transaction;::orderby=fieldname;::criteria=typename="''thistypename''" and statusname="Submitted")<tr><td>~subject~</td><td>$customfieldid$</td></tr>#]  In a list use the variables listed above but replace '''@''' with '''~'''* '''Exception''': to include [[Custom Fields]] in a list use either '''$customfieldname$''' or '''$customfieldid$'''* Last Modified Date can be shown in a list of transactions using: '''~date_format(trsts,'%Y-%m-%d %H:%i') as lastmodified~''':(Note: The See Also section has an external hyperlink for more DATE_FORMAT specifiers) 
To use ===Parent Object===On a Company/Account transaction you can display or store the variables listed above in a list name of transactions replace '''@''' with '''~'''* '''Exception''': the Company the transaction is attached to include transactions on the transaction by creating a [[Custom FieldsRead Only - System Variable]] in a list use either '''$customfieldname$''' or [[Store Value - System Variable]] '''$customfieldid$on the transaction'''with the following syntax:* Last Modified Date can be shown in a list of transactions using: <font size="3">'''~date_format(trsts,'%Y-%m-%d') as lastmodified~@parent.name@'''</font>
On a Contact transaction you can display or store the name of the contact the transaction is attached to on the transaction using:
:<font size="3">'''@parent.fullname@'''</font>
==Examples==
To retrieve all transactions associated with a Company or Contact record:
[#(?object=transaction;)<tr><td>Subject:</td><td>~details~</td></tr>#]
 
 
To obtain a Sum (for example) of the values in a [[Custom Field]] for all transactions associated with a Company/Contact using [[sscalculation]]:
<pre>
<!--@sscalculation( [#(?object=transaction;)$add this$+#]0)-->
</pre>
 
 
'''Note:''' There must be a space prior to the opening square bracket.
* Also: don't forget the zero at the end of the statement. For example, if there are transactions with values of 10, 15 and 20 the statement between the square brackets would be translated as follows:
::''[#(?object=transaction;)$add this$+#]'' &nbsp;&nbsp;&nbsp; becomes &nbsp;&nbsp;&nbsp; ''10+15+20+''
so the 0 at the end ensures that the statement evaluated doesn't end with a plus sign (which will fail).
===UTA Transactions===
To retrieve the '''Level 1''' {{l1}} transactions at '''Level 2'''{{l2}}:
@parent.[#(?object=transaction)<tr><td>~details~</td><td>~subject~</td><td>~startdate~</td></tr>#]@
To retrieve the '''Level 1''' transactions at '''Level 2''' by transaction type:
@parent.[#(?object=transaction;criteria=typename='Name of Transaction Type')
<tr><td>~subject</td><td>$customfieldid$</td><td>~customfieldname~</td><td>$fieldidcustomfieldid$</td></tr>
#]@
 
To count the '''Level 1''' transactions at '''Level 1''':
@trans1.count(trstransid):trstranstype=''transtypeid''@
 
* '''Where''' transtypeid is the transaction type id of the transaction you wish to count.
 
 
To count the '''Level 2''' transactions at '''Level 2''':
@trans2.count(trstransid):trstranstype=''transtypeid''@
 
 
To count the '''Level 1''' transactions at '''Level 2''':
@parent.trans1.count(trstransid):trstranstype=''transtypeid''@
 
 
Example:
@trans2.count(trstransid):trstranstype=544@
===Contact/Account Transactions from a UTA===
'''Note''': Transactions on '''Companies''' or '''Contacts''' associated with a [[UTA]] can be displayed in web page view. The transaction does not have to be directly associated with the '''Level 1''' item.
#]
==Performing Calculations==
 
You can <u>display</u> a Sum (for example) of the values in a [[Custom Field]] for all transactions associated with a Company/Contact using [[sscalculation]] within either a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] field:
<pre>
<!--@sscalculation( [#(?object=transaction;)$add this$+#]0)-->
</pre>
 
* '''Important:''' There <u>must</u> be a space prior to the opening square bracket.
* Also: when summing values don't forget the zero after the closing square bracket. For example, if there are transactions with values of 10, 15 and 20 the statement between the square brackets would be translated as follows:
::''[#(?object=transaction;)$add this$+#]'' &nbsp;&nbsp;&nbsp; becomes &nbsp;&nbsp;&nbsp; ''10+15+20+''
:so the 0 at the end ensures that the statement evaluated doesn't end with a plus sign (which will fail).
 
 
'''Note''': You can also use [[sscalculation]] to format the display of dates
 
 
If you want to store the value on the Company/Contact record you should use a [[Calculated Value]] field :
( [#(?object=transaction;)$add this$+#]0)
* '''NOTE''': The [[Calculated Value]] will only be updated when the Company/Contact record is saved. '''Not''' whenever a [[Transaction]] is created.
==See Also==
* [[sscalculation]]
[[Category:Transactions]][[Category:Variables]]
0
edits

Navigation menu