Difference between revisions of "Transaction Variables"

From SmartWiki
Jump to: navigation, search
(Performing Calculations)
Line 57: Line 57:
 
==Performing Calculations==
 
==Performing Calculations==
  
You can obtain a Sum (for example) of the values in a [[Custom Field]] for all transactions associated with a Company/Contact using [[sscalculation]]:
+
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]]:
 
<pre>
 
<pre>
 
<!--@sscalculation( [#(?object=transaction;)$add this$+#]0)-->
 
<!--@sscalculation( [#(?object=transaction;)$add this$+#]0)-->
Line 68: Line 68:
 
so the 0 at the end ensures that the statement evaluated doesn't end with a plus sign (which will fail).
 
so the 0 at the end ensures that the statement evaluated doesn't end with a plus sign (which will fail).
  
If using a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] field you should use the syntax above.
 
  
If you are using a [[Calculated Value]] field use the following:
+
 
 +
If you want to store the value on the Company/Contact record you should use a [[Calculated Value]] field :
 
  ( [#(?object=transaction;)$add this$+#]0)
 
  ( [#(?object=transaction;)$add this$+#]0)
* '''NOTE''': The [[Calculated Value]] will only be updated when the company record is saved, not whenever a [[Transaction]] is created.
+
* '''NOTE''': The [[Calculated Value]] will only be updated when the Company/Contact record is saved. '''Not''' whenever a [[Transaction]] is created.
  
 
==See Also==
 
==See Also==

Revision as of 09:12, 21 August 2009

Variables

  • Subject: @subject@
  • Details: @Details@
  • Start Date: @startdate@
  • End Date: @enddate@
  • Custom Fields: @customfieldname@ (see note below)


Transactions are often displayed as a list, which can be done using the following syntax:

[#(?object=transaction;orderby=fieldname;criteria=typename='thistypename')<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') as lastmodified~

Examples

Company/Account or Contact/User Transactions

To retrieve all transactions associated with a Company or Contact record:

[#(?object=transaction;)<tr><td>Subject:</td><td>~details~</td></tr>#]

UTA Transactions

To retrieve the Level 1 transactions at Level 2:

@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>$customfieldid$</td></tr>
#]@


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 directly associated with the Level 1 item.


To retrieve all Company transactions for the company attached to the Customer Standard Field at Level 1:

@company.[#(?object=transaction)<tr><td>~details~</td><td>~subject~</td><td>~startdate~</td></tr>#]@


To retrieve all Company transactions for the branch attached to the Branch Standard Field at Level 1:

@branch.[#(?object=transaction)<tr><td>~details~</td><td>~subject~</td><td>~startdate~</td></tr>#]@


To retrieve all People transactions for the Owner of a Level 1:

@owner.[#(?object=transaction)<tr><td>~details~</td><td>~subject~</td><td>~startdate~</td></tr>#]@


Additional Example:

[#(?object=transaction;orderby=tbl_1041842.valuestr desc;criteria=typename='Co-Principal Investigor, Co-Applicant, Additional Author')
<tr><td>$1041842$</td><td>$1041843$</td><td>$1041844$</td><td>$1041845$</td></tr>
#]


Performing Calculations

You can display 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 Read Only - System Variables:

<!--@sscalculation( [#(?object=transaction;)$add this$+#]0)-->


  • Important: 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$+#]     becomes     10+15+20+

so the 0 at the end ensures that the statement evaluated doesn't end with a plus sign (which will fail).


If you want to store the value on the Company/Contact record you should use a Calculated Value field :

( [#(?object=transaction;)$add this$+#]0)

See Also