Interactive Actions

Last Updated: 10-Oct-19

UI++ solicits user input from the interactive user using dialogs. Each dialog type has a unique interactive action that describes what and how to collect information from the user. Each interactive action dialog type has its own set of customizable features and options.

Interactive Action Characteristics

Standard Characteristics

A UI++ action dialog

An action dialog

All user interface dialogs created by interactive actions have the same look and feel, including the following common characteristics.

  1. Flat look and feel
  2. Major title
  3. Action buttons

You can individually customize the title of each dialog. The type of interactive action and the valid activites for that interactive action determine which buttons that dialog shows. These may include some or all of the following button types:

  • OK
  • Cancel
  • Go Back
  • Retry

Optional Characteristics

A UI++ action dialog showing optional characteristics

An action dialog showing optional characteristics

The following are optional look and feel characteristics for dialogs created by interactive actions.

  1. Rounded corners
  2. Sidebar with title
  3. Sidebar icon

You can customize the sidebar color, title, and icon. Note that all dialogs within a single UI++ configuration share whatever values you specify for these. You do not have to supply a sidebar icon in which case the sidebar title aligns with the bottom of the sidebar.

Interactive Actions Introduction

Interactive actions show a dialog to the interactive user and enable direct user input or provide feedback to the user. Each interactive action has multiple configurable appearance and behavior options.

UI++ is not limited to a single interactive action but instead can present multiple interactive actions and thus dialogs. Multiple interactive actions are useful to group specific types of user requests together, to prompt for different items of information, or display information to the user. The exact order, behavior, and appearance are up to you based on your requirements.

Info

A UI++ Info action dialog

An Info action dialog

The Info interactve action shows a simple informational dialog. This dialog conveys information to the user. It includes an open text area which is formatted using a subset of standard HTML tags.

Info actions have the following characteristics:

  1. Information text.
  2. Optional header image.
  3. Optional informational image.
  4. Optional countdown timer.

Error Info

A UI++ ErrorInfo action dialog

An ErrorInfo action dialog

The ErrorInfo interactive action is nearly identical to an Info action except that it only shows a Cancel button.

ErrorInfo actions have the following characteristics:

  1. Information text.
  2. Optional header image.
  3. Optional informational image.
  4. Cancel button (and only a cancel button).

Input

User input in UI++ is mainly solicted using Input interactive actions. Input action dialogs display a dialog containing multiple text boxes, drop-down list boxes, checkboxes, or simple informational items. Collectively, these are referred to as input elements. If you configure more input elements than will fit on a single dialog, only the first elements will be shown based on the size of the dialog and the type of input elements.

The OK button on an Input action dialog is disabled until all input elements match their defined regular expressions and all drop-down list boxes that require a selection have a valid selection.

Text Input

A UI++ Input action dialog showing TextInput elements

An Input action dialog showing TextInput elements

Users enter text into TextInput elements. TextInput elements have the following characteristics:

  1. A prompt/question.
  2. Tooltip with a message describing the correct format of the text.
  3. Exclamation icon indicating that the field is not in the correct format or input is required.
  4. TextInput elements are outlined in red when they do not have focus and do not contain text matching the correct format.
  5. TextInput elements with no text display a prompt to help the user know what to enter.
  6. Text within a TextInput element that does not match the correct format is colored red.
  7. Optional regular expression defining the exact format of acceptable text (not shown).

Choice Input

A UI++ Input action dialog showing a ChoiceInput element

An Input action dialog showing a ChoiceInput element

A ChoiceInput element is presented as a drop-down list box. Each ChoiceInput element has the following characteristics:

  1. A prompt/question
  2. An exclamation icon indicating that a choice has been made when one is required.
  3. A drop-down list of customizable choices.
  4. Optional auto-completion.
  5. Optional visible list size.
  6. Optional automatic sorting of list items.

Checkbox Input

A UI++ Input action dialog showing a CheckInput element and an InputInfo element

An Input action dialog showing a CheckInput element and an InputInfo element

Ineractive users make a binary choice using CheckboxInput elements which are presented as standard checkboxes.

Each CheckboxInput element has the following characteristics:

  1. A prompt/question

Info Input

InputInfo elements present static text to the interactive user. They are classified as input elements because they appear on Input action dialogs.

Each InputInfo element has the following characteristics.

  1. Text color.
  2. Single or double line of text.

Preflight

A UI++ Preflight action dialog

A Preflight action dialog

The Preflight interactive action performs a series of checks, generally as a precursor to additional activity. Check evaluation may result in success, warning, or failure based on thresholds and criteria configured for each check. Check evaluation results are displayed to the interactive user so that they can address any issues. Failed checks block UI++ from proceeding to the next configured action.

Preflight actions have the following characteristics:

  1. A list of evaluated checks.
  2. Result indicators for each evaluated check.
  3. Tooltips for warning and error indicators.
  4. Additional information indicators with tooltips to display the additional information.
  5. Overall preflight evaluation result text.
  6. Optional retry button to re-evaluated all checks and display updated results.
  7. Optional countdown timer (not shown).

Application Tree

A UI++ AppTree action dialog

An AppTree action dialog

The AppTree interactive action displays a dialog with a selection tree containing pre-defined software items. These software items may include applications and packages as well as pre-defined groupings of software items. The interactive user chooses which of the software items they wish to install. Note that this action is only beneficial when used in combination with a ConfigMgr-based task sequence.

AppTree actions have the following characteristics:

  1. Groups.
  2. Subgroups.
  3. Software items (applications or packages).
  4. Default software items and groups.
  5. Required software items and groups.
  6. Hidden software items (not shown).

User Authentication

A UI++ UserAuth action dialog

An UserAuth action dialog

The UserAuth interactive action displays a fixed set of three fields to the user. The user must supply their Active Directory domain credentials to authenticate and proceed with the rest of the actions defined for UI++.

UserAuth actions have the following characteristics:

  1. Customizable regular expression based validation of all fields.
  2. Masked password entry.
  3. Drop-down selection or free-text entry of domain to authenticate against.
  4. Authentication attempt message.
  5. Customizable prompt text for each field (not shown).
  6. Maximum number of retries (not shown).
  7. User immediate group membership retrieval (not shown).
  8. User authorization based on immediate group membership (not shown).