Back Forward Property-Set-Messages method

 Methods and instructions by function

Use this method to associate a text message with a property or a step page. The system reads the appropriate property and adds the message to the page. You can provide the entire literal text of the message, or reference a message rule key that in turn contains message text. (Rule-Message rule type).

Some message rules themselves accept fill-in-the-blank parameters, identified in the message text by a number within parentheses. (Don't confuse method parameters with Message parameters, which appear within the Message parameter, and are numbered.)

Parameters

This method has three parameters:

Parameter

Description
Category

Optional. Leave blank unless when the message text is displayed the output is intended to be localized based on field value rules in a language-specific RuleSet.

Identify a localization category. Accept the default value pyMessageLabel except in advanced cases. See About the Localization wizard.
Message

Enter one of the following:

  • A message rule key, with no quotes.
  • A literal text string in double quotes.
  • The third key part of a field value rule where @baseclass is the first key part and the Category value is the second key part, to support localization. Use this only when the Category field is not blank.

Optionally, if the message rule identified uses one or more parameters, follow the name by a backslash character, the letter t, and a text value for each value.

For example, the standard Message rule named ActivityNotDefined references one parameter in its text definition:

The activity {1} is not defined.

To provide a value BouncedCheck for this parameter, enter the following as the value of the Message parameter:

ActivityNotDefined/tBouncedCheck

TipIf this activity is part of an application that is intended to be localized to support multiple locales, always reference a message rule here. Do not enter literal text.

Field

Identify the property on which the message is set.

Results

The message is added to the page. This usually prevents the page containing the message from being saved.

NoteAssociating a message with a property does not directly cause that message to be displayed to a user.

Checking the method status

This method updates the pxMethodStatus property. See How to test method results using a transition.

Definitions language-specific RuleSet, property message
Related topics About Messages
Constants in expressions
Property references in expressions

zzzMethods and instructions by function