PromptSets (PRPT)

As a developer and object designer, you use PromptSet objects to define interactive forms that allow users to enter values at object runtime. You assign PromptSets in the object definition of an executable object on its Variables & Prompts > Prompt Sets page. The form is generated as a request or pop-up dialog when the object executes. You can also use the prompt set form to define values specific to a particular Workflow. The values defined in the form are passed as PromptSet variables.

Object class: Passive object
Object type/Short name: PRPT

This page includes the following:

PromptSet Variables

The values defined in the prompt set are stored in PromptSet variables. These variables are passed for further processing and can be used in the following places:

Scripts on the Process Pages of the executable object
Workflow and schedule tasks
For more information, see Inheriting Object and PromptSet Variables.
Fields on solution-specific pages for Rapid Automation Jobs
For more information, see the documentation for Rapid Automation Agent(s)

PromptSet variables can be used to enter and pass many different types of values, such as the following examples:

Static options from a finite list such as the names of the printers in your building
The number of records in a database table
Values in a database that may continually change, such as account balances
A list of items in a database, such as customer names
A list of items which are not in a database, such as values in a daily run book
An XML key and XPath or XQuery expression
Passwords shown as * characters
Dates and times
Numbers
Open-ended user defined parameters

Configuring PromptSet Objects

Configure the PromptSet object using the standard pages that are always available, no matter what type of object you are defining:

In addition to the standard pages, PromptSet objects include a PromptSet Designer page. The designer lets you configure the user input form and its user controls:

Add prompt set elements
Define the settings of the user controls
Select data references
Define default and allowed values
Make fields mandatory or read-only
Name PromptSet variables
Preview the user input form

For more information, see PromptSet Designer.

Using PromptSet Objects

Assigning Prompt Sets to Executable Objects

Assign prompt sets in the object definition of an executable object. You can optionally override values defined in the PromptSet object with values specific to the executable object. For more information, see Prompt Sets Page.

Activating Prompt Sets

The PromptSet object is activated when an executable object that it is assigned to executes. You can also use scripts to activate objects and modify the values of prompts. For more information, see Activating Prompt Sets.

Defining Prompt Set Values

If the executable object that the prompt set is assigned to is activated at generation time, an input form opens in a dialog that prompts the user to submit values. Otherwise, a request is added to the Requests area. After submission, the values defined in the form are passed for further processing. For more information, see Responding to Prompts.

When you use an executable object with assigned prompt sets in a workflow, you can also specify prompt values to be used when the task is executed in the workflow. If you specify prompt set values for the workflow, no user input is required when the task executes. The values apply only to the workflow where you define them, and do not affect the values defined in the executable object or the PromptSet object itself. For more information, see PromptSets Tab.