Skip to main content


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

MessageManifest methods

Updated on October 19, 2022

With the Message Manifest, you can share message strings across multiple projects. You can also define the characteristics of a message dialog that can be displayed to Robot Runtime/Agile Desktop users.

When building new solutions, you must accurately deliver alerts and messages that are sent to users for their desktop solutions. The Message Manifest component provides a central repository for all messages and alerts that are used within a solution, which helps you maintain corporate standards and deliver accurate messages and alerts. The repository also lets you share messages across multiple projects.

Messages and other detailed information are entered in Robot Studio in the Message definitions dialog, which is part of the Project Properties.

Message definitons
Figure showing the Message definitions dialog, available from Project Properties.

Methods

MethodDescriptionParametersReturn Type
GetMessage

Use this method to return output parameters which you can use in queries The parameters return the button, default button, and icon. You choose when you create the item within the Message Manifest.

Each output parameters offers a blue data path that returns the result as a string. Each output parameter also provides a yellow execution path for each of the possible choices that the string could contain. In essence, these execution paths act as a case statement. For example, the icon could be warning, informational, error, and so on.

Be careful how you use the execution paths off of the output parameters. Do not use multiple execution paths off the block. This is not a best practice.

messageBoxButtons

messageBoxDefaultButton

messageBoxIcon

GetMessageDetails

Use this method to retrieve the details of the message based the message code. The details include:

  • Code
  • Text of the message
  • Buttons
  • Default button
  • Icon

The text of the message will include the values of the variables, so you will see what the user sees.

This lets you get message details from lower levels of an automation.

nonestring
ResetStateUse this method to reset all component properties to their initial values. nonevoid
ShowMessage (1 parameter)Use this method to show the details of a message returned via the GetMessageDetails method. messageDetails
ShowMessage (2 parameters)

Use this method to show the details of the message returned as a result. This includes:

  • Code
  • Text of the message
  • Buttons
  • Default button
  • Icon

The text of the message will include the values of the variables, so you will see what the user sees.

This lets you show message details from lower levels of an automation.

nonestring

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us