Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Creating a message

Updated on August 10, 2022

You can create a message to display text with run-time values to users. By using messages instead of static text, you can avoid maintaining a set of strings for each possible context and user locale in your application.

  1. In the header of Dev Studio, click CreateTechnicalMessage.
  2. In the Label field, enter text that describes the purpose of the message.
  3. In the Apply to field, press the Down Arrow key and select the class that defines the scope of the message.
    The class controls which rules the message can use. It also controls which rules can call the message.
  4. In the Add to ruleset field, select the name and unlocked version of a ruleset that stores the message.
  5. Optional: To change the default identifier for the message, click Edit, and then provide a unique value in the Identifier field.
  6. Click Create and open to open the Message form.
  7. Optional: To include run-time values in your message, define input parameters.

    Do not define more than one Raw input parameter because the tab delimited items in this type can be interpreted as values for other input parameters. Always put this type of parameter in the last position of the parameter list.

    For more information about input parameters, see Defining the input parameters of a rule.

  8. Click the Details tab.
  9. In the Category list, select an option based on the type of information in the message and the expected response from the user.
  10. Optional: If the Category field is set to Warning, provide information that applications use to compute their compliance scores.
    1. In the Severity list, select the degree to which an application is adversely affected by the conditions that trigger the warning.
    2. In the Application Impact list, select the aspect of the application that is affected the most by the conditions that trigger the warning.
  11. If the Category field is set to Error, in the Classification field, select the type of error message.
    The classification is required for error messages used by automations; otherwise, it is optional. To create a new classification, create a field value of type pyErrorClassification.
  12. In the Message field, enter the text of the message.

    You can reference input parameters by using the following format:

    Rule {1} was processed on the {2} thread with data from page {3}.

  13. Click Save.
  14. Click Actions > Preview to view your assembled message with default input parameter values.
What to do next: You can use your message in validate rules, standard functions that support messages, and activities.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us