User Guide > Objects > Alphabetical Listing > PromptSet - Activation

PromptSet - Activation

There are some points that require particular consideration when objects are executed to which a PromptSet objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task has been assigned.

Prompt

The open prompt displays the graphical elements as they have been defined in the PromptSet object.

When several PromptSet objects have been assigned to the activated object using the Variables & Prompts tab, they will be listed in the left window area. You can select one of these entries and the related PromptSet input dialog will be displayed. You can switch between the available input dialogs by using the Previous and Next buttons. The order of the dialogs complies with the order that is used in the Variables & Prompts tab.

Click on the elements' labels to open the text field in which you can enter predefined variables.

The input request remains open if you cannot send it using the Done button because of invalid values (if the values do not comply with the reference values, for example). Additionally, the errors will be listed in a separate field that is shown below the PromptSet elementFields/control elements that are used to query User values. They are the content of a PromptSet input mask..This field includes the name of the PromptSet element and the corresponding error. As soon as you enter the correct value, the related error line will be crossed out in the error field. The Cancel button cancels the activation of the object.

The taskAn executable object that is running. Tasks are also referred to as activities.'s TimeZone is also displayed.

When a Schedule starts, the PromptSet objects of its subordinate tasks are not called. Only the Schedule's input prompt is displayed.
By default, the same applies for workflows, but you can change this behavior in the  task properties.

In objects that are executed recurrently or are activated in an agent groupAn agent group combines agents of the same platform. The agents that should be included in an agent group are specified by entering the agent name or via filters. A task that runs in an agent group is processed on one or all of the agent group's agents, depending on the specified mode. A particular Automation Engine object type. with the mode "All", the input dialog is only displayed once when the object starts. The specified values then apply for all other executions.

Pay attention to the settings that are specified in PROMPT_RESPONSETIME, PROMPT_TIMEOUT in the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. UC_CLIENT_SETTINGS in combination with PromptSet input prompts.

Input Assistant

The Input Assistant is available for text fields and can be activated via the PromptSet object properties. With the Input assistant activated, "..." is displayed next to the text field and can be used to open a new window. This dialog displays the content of the reference Variable object. Exception: The Key columnColumn in static Variable objects that can be used to access values of a particular line. of static Variable objects is not displayed. The left area lists all non-assigned reference values, the right area the assigned ones. You can select any values and change their assignments using the arrow buttons. Clicking OK closes the Input Assistant and the values are inserted in the text field area Assigned. The values of the value column 1 (static variable) or the result columnThe first column of dynamic Variable objects with the sources "SQL", "SQL-internal" and "Multi". The content of this column can be defined with Result format. are used.

Assigning several values to text fields requires the multi-select functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… to be activated (PromptSet properties). In this case, the individual values are separated with the character that has been defined using the property "Separator".

Displayed Default Values

The default values of PromptSet objects can be overwritten in the Variables & Prompts tab. The values can also be modified through the task properties if the object is part of a workflowAn object of the Automation Engine that can include several executable objects and which runs them in a specified order. [Formerly called "ProcessFlow" and "JobPlan."] or Schedule. PromptSet values of tasks that start via ACTIVATE_UC_OBJECT can be set in this scriptA particular Automation Engine object type. using :PUT_READ_BUFFER. Note that the read buffer variable has the same name as the PromptSet variable (Properties - Variable name). No prompt is displayed for tasks that are activated through a workflow, Schedule or script.

The following table shows the possible constellations where you can change the default value of PromptSets and the value that is used:

PromptSet Variables & Prompts tab Workflow/Schedule properties PUT_READ_BUFFER Default value for activation
        No default value
Value1       Value1
Value1 Value2     Value2
  Value2     Value2
Value1 Value2 Value3   Value3
  Value2 Value3   Value3
    Value3   Value3
      Value4 Value4
Value1     Value4 Value4
Value1 Value2   Value4 Value4

Using the script element ACTIVATE_UC_OBJECT with the parameter PASS_VALUES has the effect that object variablesPlaceholder for values that are stored in an object's "Variables & Prompts" tab/section. and all the object's PromptSet variables are passed on to the activated object.

Input Restrictions

When entering values in text, date, time and time stamp fields, ensure that you keep the reference variable's limitations such as: allowed values (reference values), min. value, max. value, max. length and data type. You can also limit the allowed size via the PromptSet element's properties. The limitations on PromptSet level are already checked when the PromptSet objects are assigned.

Text fields that require an entry (PromptSet property "Valid entry required") and contain no value are highlighted in yellow. Text fields are limited to the number of characters that has been specified in the PromptSet property "Max. length".

The Input Assistant simplifies the process of entering values. It can be activated via the element properties in the PromptSet object.

Modifications at Runtime

You can only modify PromptSet values at runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start). for workflow and schedule tasks that have not yet been generated. Object variables cannot be modified at runtime.

Restart Behavior

When restarting an object, the PromptSet dialog displays the values that have been entered during the last activation process (reference RunIDShort for "run number". It is a number that provides unique information about a task's execution. The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component . = 0). If you specify a particular reference ID in the restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts. dialog, the values of this object execution are used.

PromptSet variables can be changed with AE Script. If the script generation ends normally, these modifications also apply for restarts. They even apply if the task aborts afterwards,
regardless of whether the task has been restarted via the Activity Window, the statisticsThis is a list of a task's previous runs. or using script (RESTART_UC_OBJECT).

For example:
Value 1 is entered in a jobAn Automation Engine object type for a process that runs on a target system.'s PromptSet dialog and sent. In the script, this value is changed to 15. Subsequently, the job aborts due to an OS error. When it is restarted, the prompt displays the value 15.

PromptSet value modifications that are made during a restart are logged in the activation reportA report provides more detailed information about a task's execution or a component..

No PromptSet dialog is displayed when workflow or schedule tasks are restarted. For new task starts with modified PromptSet values, modify the properties in the corresponding workflow or schedule. The same is true if the restart is made using AE Script (RESTART_UC_OBJECT). In this case, you can override the values with the script element :PUT_READ_BUFFER.

See also:

PromptSet - Designer tab

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH