PromptSets (PRPT)

PromptSets are interactive forms that you assign to executable objects. When these objects are executed, the forms are generated as requests. The objects stop executing until the forms (PromptSets) are populated with the required values. Once they are populated, the execution continues. You can configure PromptSets to be populated through variables, in which case no manual intervention is necessary. Otherwise, the values must be entered manually.

As a designer, you define PromptSet objects and assign them to executable objects. You configure the form fields on the PromptSet Designer page. You then assign PromptSets to objects on the objects' PromptSet definition pages.

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

This page includes the following:

PromptSet Variables

To configure a PromptSet object, you insert elements (input fields, checkboxes, and so on) on its PromptSet Designer page. Each element you include in the form also defines a variable that you can use in scripts and in the tasks that you insert in Workflows and Schedules. These 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

For more information see, Inheriting Object and PromptSet Variables

Note: For PromptSet fields on solution-specific pages for Rapid Automation Jobs, see the Rapid Automation Agent(s) documentation.

For more information, see PromptSet Designer.

Assigning PromptSets to Executable Objects

You assign a PromptSet object to an executable object on the executable object's PromptSet page.

You can optionally override values defined in the PromptSet object with values specific to the executable object.

Activating PromptSets

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.

Populating PromptSet 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 number over the bell icon in the menu bar indicates that the request has been added to the Requests view. After submission, the values defined in the form are passed for further processing.

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.

See also: