Prompt Sets Page

PromptSets (PRPT) are objects that define interactive forms. PromptSet forms can be assigned to executable objects. When the executable objects are executed, these interactive forms are displayed and allow users to enter values at runtime. As a developer and object designer, when you create executable objects you can assign them PromptSet objects on this page. The form defined by the PromptSet object is generated as a request when the object executes.

For more information, see:

To Add PromptSets to an Executable Object

  1. Open the Prompt Sets page of the executable object under Variables & Prompts.
  2. Click Add PromptSet.
  3. Select the PromptSet object in the Add PromptSet dialog.
    Note: The search in the Add PromptSet dialog is case-sensitive.
  4. Click Add PromptSet again if you want to add another prompt set.
  5. Optionally change the order of the prompt sets by dragging and dropping them. To remove a prompt set, select it and click the Remove button in the toolbar.

The added prompt sets are listed. Select a prompt set to see the prompt set elements it includes on the right.

Notes:

  • In the generated user input form, the prompts from all assigned prompt sets are displayed in the order in which they appear on the Prompt Sets page of the executed object. Drag and drop prompt sets to change the order.
  • With the exception of default values, the prompts cannot be edited in the object definition of the executable object. To modify prompts, edit the prompt set on the PromptSet designer page of the PromptSet object.

Tip: You can see a preview of the prompt set on the PromptSet Designer page.

To Override Values in the Prompt Set

If a prompt set element is not read-only, you can optionally override the value of the prompt on the Prompt Sets page. The new value is valid for this executable object only and does not affect other objects that use the same PromptSet object.

You can type a value in the prompt set field, or select a predefined variable. Click the label of the prompt to toggle the field between a direct entry field and a variable entry field. To select a predefined variable, click the {&} button in the variable entry field to open a dialog.

There are several types of values that you can use to override values in the prompt:

Predefined Variables

You can use a predefined variable or a text string that contains one or more predefined variables to override a value in a prompt.

The text you enter in a variable entry field can include any combination of the following elements:

  • System properties variables
    System properties variables are not objects. They are the same throughout the system.
  • Object properties variables
     Object properties variables reference objects or their runtime instance (task).
  • Automation variables 
    Automation variables are a predefined subset of static Variable objects used for system properties.
  • Variable objects
    Variable objects can be static or dynamic. Static variables store values in their object definition, while dynamic variables retrieve values from a specified data source.

Note: Text conventions for variable and object names apply. Follow these rules when writing names:

  • System properties variables and object properties variables start with a leading ampersand (&) and end with a hash (#).
  • Variable objects, including automation variables, start and end with curly brackets ({ }).
  • You can enter text that combines elements, such as {PREFIX}_&$CLIENT#, if the prompt allows it and if you follow the text conventions.
  • Time/Date prompts require a default value and cannot be saved without a value. The only allowed date format for default date values is YYYY-MM-DD.

Value From a Parent Workflow or Object Variable From a Schedule

Enter the object variable from the Variables page of the parent Workflow object or Schedule object. Do not use the {&} button.

Other Options From the Prompt

In the following prompt types, you can override the prompt value with another value by selecting a different value defined in the prompt set element, or entering the desired value.

  • Number, Checkbox, Time and Date, and Radio Button prompts: select the desired option.
  • Text Field prompt: type a value into the field. If the field permits multiple values and the Input Assistant is activated in the prompt settings: click the ... button and select a value.
  • Combo box prompts: type a value into the field or select a value from the drop-down menu.

For more information, see Text Field Settings.

See also: