Input Prompt

This object prompts a user for the configured inputs including radio buttons, check boxes, combo boxes, and date pickers as well as buttons. This object requires an Agent be installed on the target machine.

This object uses branding settings in the Automation Manager Designer (Options -> Branding), to configure the final look.

Remember to click Refresh Branding Settings in this object whenever branding settings may have changed while designing a policy, otherwise the new branding will not be saved in the policy.

Input Parameters

Name Type Required Description
Title String Yes The title of the dialog.
Body String Yes The message or question to be displayed to the user.
Timeout (secs) Number Yes The amount of time (in seconds), that the prompt will be displayed for a response.

Enter zero to keep the dialog displayed until the user dismisses it.
Inputs Collection Yes The collection of inputs to which user will need to respond.
Buttons Collection Yes The collection of buttons from which the user will choose as appropriate.

Output Parameters

Name Type Description
Button Selected Number

Returns the numerical value assigned to the button clicked by the user.

Returns a value of zero if the script times out.
Input One Result String Returns response to first input.
Input Two Result String Returns response to second input (if set up).
Input Three Result String Returns response to third input (if set up).
Input Four Result String Returns response to fourth input (if set up).
Input Five Result String Returns response to fifth input (if set up).
Result Number Returns a success value of zero or any value other than zero to indicate failure.
Result String String Object execution error details.

Example Input Parameters

Name Type Required Example
Title String Yes Device Maintenance Required
Body String Yes Device Maintenance is about to begin on this device, do you wish to allow?
Timeout (secs) Number Yes 300
Inputs Collection Yes

The inputs to which user will need to respond:

Item Description Example
Input description This is the message upon which you are asking your user to make a decision. Input message
Description alignment Determines whether input description will be shown above or next to the input control. Left
Input type Add combo boxes, check boxes, radio buttons or date/time pickers. Check Box
Input values Enter the value(s) for your input type that the user can select. Values cannot be empty. 1, 2, 3
Buttons Collection Yes

The buttons from which user will choose appropriate:

Item Type Example
Button text The text to be displayed on the button. OK
Button type

A value assigned to the button that will be returned as the button output value, as follows:

Confirmation = 1

Continuation = 2

Rejection = 3

Retry = 4

Extra = 5

 Confirmation