Back Forward Message form
Completing the Definition tab

  1. About 
  2. New 
  3. Definition 
  4. History 
  5. More... 

Use the Definition tab to specify the message text and the names and types of parameters. The message text can include placeholder marks for parameter values.

In the Message field, Enter the text of the message as a skeleton, with placeholders in curly braces for parameters, as {1}, {2} and so on, referring to the numbered rows in the Message parameters table.

As an example, in the Message pyThePageWasCopied your message might be "{1} was executed using: {2} Thread, copied from {3} and copied to {4}." The four rows in the table would have parameters for, in order, RuleNameThreadName, PageNameCopiedFrom, and PageNameCopiedTo.

When an activity calls the message using the Page-Set-Messages method, the activity provides text values for each parameter, separated by the delimiter \t to indicate a tab character. A value may be a property reference, a JSP tag result, or a constant. For the above example, the call might look like this:

pyThePageWasCopied\tRuleName\tThreadName\tPageNameCopiedFrom\tPageNameCopiedTo

NoteYou cannot use \n in the Message field to force a line break in the output.

Message parameters

Message Parameters

add rowComplete a row of this array for each numbered parameter in the message text. Order is significant.

Parameter

Enter an arbitrary but unique alphabetic text label for each parameter, as a reminder of what the parameter represents.

Type

Select an expected type for this parameter from the selection list. The Type determines how the parameter is recognized and processed:

  • Name — The value is copied into the message. Use only alphanumeric characters in the name. No localization occurs.
  • Number — Processed the same as Name.
  • Text — Use only for the last parameter. The text include tab characters. Supplied text is copied without processing into the message.
  • Message — Identifies another Rule-Message key, which is processed rather than this Rule-Message to produce the content inserted onto the variable.
  • Date — A date, reformatted according to the user locale.
  • Time — A time, reformatted according to the user locale.
  • DateTime — A date and time, reformatted according to the locale of the user.
  • Integer — A whole number, reformatted according to the locale of the user.
  • Decimal — A decimal value, reformatted according to the locale of the user.
  • Decimal with currency — A monetary value.
  • Localized Name — A Name value that the system is to localize.
Default

Optional. Enter a default value for the parameter, as text. The system uses this value if the call to assemble the message does not provide a value for this parameter.

Up About Message rules