Difference between revisions of "Selecting an eventid from a list of records"

From SmartWiki
Jump to: navigation, search
(Breakdown of List Syntax)
(Breakdown of List Syntax)
Line 23: Line 23:
 
|'''Syntax'''
 
|'''Syntax'''
 
|'''Description'''
 
|'''Description'''
 +
|-
 +
|[[Image:VariableExampleStoreDisplay.png|link=|300px]]
 +
|
 +
* This is an example of the use of [[stored values]]/display values
 
|-
 
|-
 
|[[Image:VariableExampleBracketHash.png|link=|300px]]
 
|[[Image:VariableExampleBracketHash.png|link=|300px]]
Line 31: Line 35:
 
|-
 
|-
 
|[[Image:VariableExampleParent.png|link=|300px]]
 
|[[Image:VariableExampleParent.png|link=|300px]]
|
 
|-
 
|[[Image:VariableExampleStoreDisplay.png|link=|300px]]
 
 
|
 
|
 
|-
 
|-

Revision as of 18:17, 4 November 2013

In the following example, we will imagine that:

  • We want to have a dropdown field that shows a list of Payments attached to a record that are in Scheduled status.
  • Additionally, we want to display some information about the Payments so that the user can differentiate between them, and select the appropriate record.
  • The list of Payments in the dropdown should be automatically populated, depending on the record that the field appears on.

This example shows a dropdown on a record with two Payments in the Scheduled status.
DropDownExampleUsingListSyntax.png

The field above:

  • is a Select One - Combo Box custom field;
  • has a field name of Payment List;
  • has a field caption of List of Payments that can be assigned to the report; and
  • has the following in the Values section of its field options:
--Please Select--;@parent.[#(?object=activity;criteria=typename='Payment' and statusname='Scheduled';)~eventid~=Payment on $Scheduled Payment Date$ of $Payment Amount$;#]@

Breakdown of List Syntax

The variable above uses SmartSimple's List Syntax. The following is a breakdown of the different components of the syntax used, working from the inside out.

Syntax Description
VariableExampleStoreDisplay.png
VariableExampleBracketHash.png
VariableExampleObjectandCriteria.png
VariableExampleParent.png
VariableExample-PleaseSelect.png
  • For combo boxes, the values that are displayed are separated by semicolons.
  • The --Please Select--; will be the first value, followed by what is returned by @parent.[#...#]@.
  • Given that there is a semicolon contained within the list brackets ([#...#]), each value from the returned list will be followed by a semicolon as follows:
    --Select One--;Payment 1;Payment 2;...;Payment N;

Now that we have a stored list of eventids, we can refer to this field's stored value to perform operations on the selected records. For example, workflows can be triggered against these records.

Additional examples of the objects and criteria that can be selected are available on the List Syntax page.