Message form
|
|
Use the Parameters tab to map input parameters to placeholders in your message text. You can create dynamic messages by including input parameters that are populated by clipboard values at run time.
Message input parameters are displayed in a list format. Click the add row icon to insert a parameter into the existing list. Click the delete row icon to remove a parameter.
Each parameter you define must correspond to a numbered placeholder in the Message field on the Definition tab. Use the following guidance when adding a new parameter.
Field |
Description |
| [Row ID] |
This read-only number is assigned by the system, based on the position in the list. You must reference this number in your message text. Drag and drop any row to change the order of your input parameters. |
| Parameter |
Enter unique text that describes the purpose of the parameter. The value you enter is for documentation purposes only. It is not related to the message text that is assembled at run time. |
| Type |
Select an option from that list that represents the data type of this input parameter. Options include: Date, DateTime, Decimal, Decimal with currency, Integer, Localized Name, Message, Name, Number, Raw, Text, and Time. Parameters of type Name or Number do not support localization. At run time, their values are inserted into the message as-is. You can select the Raw type to pass a tab delimited string to this message. Because the system uses the tab stop key to distinguish between different input parameters, you can have only one Raw type parameter defined in a message. Ensure that it is in the last position of the parameter list. |
| Default |
Enter text to insert into the message when the calling rule, such as a function or activity, does not provide a value for this input parameter. On the Actions menu, click Preview to view your message text with default input parameter values. |
When you call a message, you must pass a single string that concatenates the message name with the values for each expected input parameter.
To build a valid string:
Type the name key part of the message.
Append constant values for each input parameter.
Use the order in which these input parameters are defined on the Parameters tab of the called message form.
Do not use \n to force a line break in the output.
Separate the message name and each value with a tab delimiter.
Type \t with no spaces between values.
+ key to append a property reference or JSP tag result.For example, the DateRange message takes three input parameters and contains the message text:
The {1} must be later than {2} and at least 30 days before {3}.
Here are some example strings you can pass to this rule and the expected, assembled message at run time.
Passed string |
Assembled message |
|
DateRange\tstart date\ttoday\tthe end date |
|
|
"DateRange\tstartdate " + .StartDate + " \tJanuary 1, 2006\ttoday" |
|
For more information on how to add messages to rules, properties, and pages in your application, see Working with messages.