Add a complex input dialog box to the automation script.

UserInput interrupts automation with a dialog pop-up where the input fields are constructed using the Variable sub-actions.
Upon clicking Cancel, automation stops.
Upon clicking OK, one SetVar action is generated for each Variable sub-action and the automation resumes.


SetVar names are set using the Name attribute value of each Variable sub-action. The values depend on the corresponding input fields in the dialog.

Tag Attributes

AttributesValue Description
TitleDialog title
ButtonTextOKText to set on OK button. Defaults to 'OK'.
ButtonTextCancelText to set on Cancel button. Defaults to 'Cancel'.


Variable sub-actions

Each <Variable> sub-action adds a field to the dialog.

Variable Tag attributes

AttributesAttribute ValuesValue Description
NameN/A
  • Variable name - Required
  • Used in the SetVar action
  • Duplicate names are not allowed
  • All other naming restrictions from SetVar apply
ValueN/ADefault value to put in dialog input field.
TypeSee Value Description

The Type value is controls the type of field that will be displayed. All variables end up as text in the script 

One of: Bool, BoolToggleCategoryCheckListDate, DateInPast, FolderPath, InputFilePath, IntegerLabel, ListMultiGroupSelection (sapio365 only), MultiList, MultiOnPremGroupSelection (sapio365 only), MultiOnPremUserSelection (sapio365 only), MultiUserSelection (sapio365 only), NoCheckboxListNumber, OneGroupSelection (sapio365 only), OneOnPremGroupSelection (sapio365 only), OneOnPremUserSelection (sapio365 only), OneUserSelection (sapio365 only), OutputFilePath, RadioList, Text.

Defaults to TextNot Required
See Detailed Types section below.

LabelN/AText to display in front of the input field or for Category title.
TooltipN/AGenerates a tooltip widget in the dialog, next to the label.
ReadOnlyTrue/FalseTo prevent a field from being edited. Defaults to False.
MandatoryTrue/FalseTo make editing of a field mandatory. Defaults to False
ExpandTrue/FalseFor Category type only - If set to False, the category appears collapsed and the user must click it to see the input fields. Defaults to True.
ListNameN/AFor CheckList and MultiList types only - Name of the list created from the checked (resp. selected) items.
ColorAny HTML color codeFor Label type onlyHexadecimal RGB with a leading # (eg. #FFE8E5).
IconN/AFor Label type only - Font Awesome icon name.
MaxAny integerFor Integer type only - Maximum value allowed. Defaults to INT_MAX (2147483647). 
MinAny integerFor Integer type only - Minimum value allowed. Defaults to INT_MIN (-2147483648).
HasSelectAllTrue/FalseFor CheckList type only - If set to True, a button is shown and allow to select all items at once. Defaults to False.
FileExtN/AFor InputFilePath and OutputFilePath types only Allows to specify the file extension(s) (separated by semicolon, if multiple), * is used to have the 'All Files choice'. Defaults to "*"
ObjectTypes (sapio365 only)N/AFor MultiGroupSelection (sapio365 only)MultiOnPremGroupSelection (sapio365 only), MultiOnPremUserSelection (sapio365 only), MultiUserSelection (sapio365 only)OneGroupSelection (sapio365 only,) OneOnPremGroupSelection (sapio365 only), OneOnPremUserSelection (sapio365 only) and OneUserSelection (sapio365 onlytypes only - Allow to specify the object type(s) (separated by semicolon, if multiple) to set in the dedicated filter (expected values as displayed in dialog).


Detailed Types

Creates two radio buttons representing a boolean.

Bool

<Variable Name="Bool" Type="Bool" Label="Bool" Value="true" Tooltip="Bool tooltip"/>
XML

BoolToggle

Creates a toggle switch representing a boolean.

BoolToggle

<Variable Name="BoolToggle" Type="BoolToggle" Label="BoolToggle" Value="False" Tooltip="BoolToggle tooltip"/>
XML

Value can be True or False.

Category

This does not define a variable, it creates a UI component in the dialog to visually group fields together

<Variable Name="ACategory" Type="Category" Label="A Category" Expand="True"/>
XML

CheckList

Creates a list of items to check. Each item is declared using the ListItem tag (see details below). There must be at least one ListItem. 

Allows to select several values (output is a list).


Checklist

<Variable Name="CheckList" Type="CheckList" Label="CheckList" Tooltip="CheckList tooltip" ListName="TheCheckList" HasSelectAll="true">
	<ListItem Value="CheckList item 1"/>
	<ListItem Value="CheckList item 2"/>
	<ListItem Value="CheckList item 3" Select="true"/>
	<ListItem Value="CheckList item 4"/>
</Variable>
XML

Date

Creates a text field that shows a calendar when focused. Date format is YYYY-MM-DD.

Note: in the example below, system variable {%Date%} is used to set the current date.

Date

<Variable Name="DateAny" Type="Date" Label="Date" Value="{%Date%}" Tooltip="Date tooltip"/>
XML

DateInPast

Creates a text field that shows a calendar when focused. Date format is YYYY-MM-DD. This date cannot be in the future.

DateInPast

<Variable Name="DateInPast" Type="DateInPast" Label="DateInPast" Value="1991-07-21" Tooltip="DateInPast tooltip"/>
XML

FolderPath

Creates a text field with a button to open a Select Folder Dialog.

FolderPath

<Variable name='FolderPath' Type='FolderPath' Label='FolderPath' Value="C:\Temp" Tooltip="FolderPath tooltip"/>
XML

InputFilePath

Creates a text field with a button to open an Open File Dialog.

InputFilePath

<Variable name='FilePath' Type='InputFilePath' Label='InputFilePath' Value="C:\Temp\file.text" Tooltip="InputFilePath tooltip"/>
XML

Integer

Creates a text field that only accepts integer values.

Integer

<Variable Name="Integer" Type="Integer" Label="Integer" Value="365" Tooltip="Integer tooltip" Min="300" Max="365"/>
XML

Label

Creates a static text occupying the entire width.

Label

<Variable Name="Label" Type="Label" Label="This is a Label with an icon and a color" Color="#FFE8E5" Icon="fas fa-info-circle"/>
XML

List

Creates a combobox. Each item is declared using the ListItem tag (see details below). There must be at least one ListItem.

List

<Variable Name="List" Type="List" Label="List" Value="List item 1" Tooltip="List tooltip">
	<ListItem Value="List item 1"/>
	<ListItem Value="List item 2" Label="Label for List item 2"/>
	<ListItem Value="List item 3"/>
	<ListItem Value="List item 4"/>
</Variable>
XML

MultiGroupSelection (sapio365 only)

Creates a text field with a button to open an address book, result is a list of GUIDs.


MultiList

Creates a list of items to select. Each item is declared using the ListItem tag (see detailed below). There must be at least one ListItem.

Allows to select several values (output is a list).

UI component specific behavior:

  • Click makes a single selection
  • CTRL+ click adds to selection
  • SHIFT + click adds range to selection

This component is standard HTML.

MultiList

<Variable Name="MultiList" Type="MultiList" Label="MultiList" Tooltip="MultiList tooltip" ListName="TheMultiList">
	<ListItem Value="MultiList item 1"/>
	<ListItem Value="MultiList item 2"/>
	<ListItem Value="MultiList item 3"/>
	<ListItem Value="MultiList item 4" Select="true"/>
</Variable>
XML


MultiOnPremGroupSelection (sapio365 only)

Creates a text field with a button to open an address book, result is a list of GUIDs.


MultiOnPremUserSelection (sapio365 only)

Creates a text field with a button to open an address book, result is a list of GUIDs.


MultiUserSelection (sapio365 only)

Creates a text field with a button to open an address book, result is a list of GUIDs.


NoCheckboxList

Creates a list of static items. Each item is declared using the ListItem tag (see details below). There must be at least one ListItem.

This type is always read-only

NoCheckboxList

<Variable Name="NoCheckboxList" Type="NoCheckboxList" Label="NoCheckboxList" Tooltip="NoCheckboxList tooltip">
    <ListItem Value="NoCheckboxList item 1"/>
    <ListItem Value="NoCheckboxList item 2"/>
    <ListItem Value="NoCheckboxList item 3"/>
    <ListItem Value="NoCheckboxList item 4"/>
</Variable>
XML

Number

Creates a text field that only accept numbers.

Number

<Variable Name="Number" Type="Number" Label="Number" Value="365.99" Tooltip="Number tooltip"/>
XML

OneGroupSelection (sapio365 only)

Creates a text field with a button to open an address book, result is a list of GUIDs with no more than one GUID.


OneOnPremGroupSelection (sapio365 only)

Creates a text field with a button to open an address book, result is a list of GUIDs with no more than one GUID.


OneOnPremUserSelection (sapio365 only)

Creates a text field with a button to open an address book, result is a list of GUIDs with no more than one GUID.


OneUserSelection (sapio365 only)

Creates a text field with a button to open an address book, result is a list of GUIDs with no more than one GUID.


OutputFilePath

Creates a text field with a button to open a Save File Dialog

OutputFilepath

<Variable name='OutputFilePath' Type='OutputFilePath' Label='OutputFilePath' Value="C:\Temp\file.text" Tooltip="OutputFilePath tooltip"/>
XML

RadioList

Creates a list of Radio Buttons. Each item is declared using the ListItem tag (see detailed below). There must be at least one ListItem.

RadioList

<Variable Name="RadioList" Type="RadioList" Label="RadioList" Value="Radio List item 2" Tooltip="RadioList tooltip">
	<ListItem Value="RadioList item 1"/>
	<ListItem Value="RadioList item 2"/>
	<ListItem Value="RadioList item 3"/>
	<ListItem Value="RadioList item 4"/>
</Variable>
XML

Text 

Creates a text field.

Text

<Variable Name="Text" Value="This is a Text" Label="Text" Tooltip="Text tooltip"/>
XML


ListItem

Sub-actions used with CheckListListMultiList and RadioList.

AttributesAttribute ValuesValue Description
LabelN/ADisplay value of list item - Set to its Value if omitted.
ValueN/AValue of list item - Required
ListNameN/A

Only applies to:

  • MultiListCheckList types - It populates the list with the content of an existing script List.

Label and Value must then reference attributes from the script list.

  • MultiGroupSelection (sapio365 only), MultiOnPremGroupSelection (sapio365 only), MultiOnPremUserSelection (sapio365 only), MultiUserSelection (sapio365 only), OneGroupSelection (sapio365 only), OneOnPremGroupSelection (sapio365 only), OneOnPremUserSelection (sapio365 only) and OneUserSelection (sapio365 only) - it preselects the users/groups with the content of an existing script List.
SelectTrue/FalseOnly applies to CheckList and MultiList types - Preselects the item in the list. Defaults to False.

List items are sorted alphabetically by label in the dialog.


Full example


User Input example

<ytriaAutomation>
    <Echo Mode="false"/>

    <list Name="UserList" Action="SetVar" UserListValue="3ea080a4-06d0-4eff-8ecf-f3935c6ca6be"/>
    <list Name="UserList" Action="SetVar" UserListValue="f3b9bd53-8437-4c35-b558-edc809b60315"/>
    <list Name="SingleUser" Action="SetVar" SingleUserValue="f3b9bd53-8437-4c35-b558-edc809b60315"/>
    <list Name="GroupList" Action="SetVar" GroupListValue="92b8e4be-5ffa-4fc4-940e-8fa7c69e60e5"/>
    <list Name="GroupList" Action="SetVar" GroupListValue="2c0c10b9-23a0-4bf9-ba6f-55b08de0a8bf"/>
    <list Name="SingleGroup" Action="SetVar" SingleGroupValue="2c0c10b9-23a0-4bf9-ba6f-55b08de0a8bf"/>

    <list Name="OPUserList" Action="SetVar" OPUserListValue="a0c18953-0524-46d3-aaa4-034322733499"/>
    <list Name="OPUserList" Action="SetVar" OPUserListValue="6a1355af-6d91-433b-a091-d6f51d09e511"/>
    <list Name="SingleOPUser" Action="SetVar" OPSingleUserValue="6a1355af-6d91-433b-a091-d6f51d09e511"/>
    <list Name="OPGroupList" Action="SetVar" OPGroupListValue="1298814e-8de3-4b96-be96-d88e2ab8603f"/>
    <list Name="OPGroupList" Action="SetVar" OPGroupListValue="0c9e4fd0-4152-4385-aaa6-9149e6b9a8ec"/>
    <list Name="SingleOPGroup" Action="SetVar" OPSingleGroupValue="0c9e4fd0-4152-4385-aaa6-9149e6b9a8ec"/>

    <UserInput Title="User Input example" ButtonTextOK="OK button" ButtonTextCancel="Cancel button">
            <Variable Name="ACategory" Type="Category" Label="A Category" Expand="True"/>
            <Variable Name="Label" Type="Label" Label="This is a Label with an icon and a color" Color="#FFE8E5" Icon="fas fa-info-circle"/>
            <Variable Name="Text" Value="This is a Text" Label="Text" Tooltip="Text tooltip"/>
            <Variable Name="ReadOnlyText" Type="Text" Label="Text (Read-only)" Value="This is a read-only Text" Tooltip="Read-only Text tooltip" Readonly="true"/>
            <Variable Name="Bool"  Type="Bool" Label="Bool" Value="true" Tooltip="Bool tooltip"/>
            <Variable Name="BoolToggle" Type="BoolToggle" Label="BoolToggle" Value="false" Tooltip="BoolToggle tooltip"/>
            <Variable Name="DateAny"  Type="Date" Label="Date" Value="{%Date%}" Tooltip="Date tooltip"/>
            <Variable Name="DateInPast" Type="DateInPast" Label="DateInPast" Value="1991-07-21" Tooltip="DateInPast tooltip"/>
            <Variable Name="Integer" Type="Integer" Label="Integer" Value="365" Tooltip="Integer tooltip" Min="300" Max="365"/>
            <Variable Name="MandatoryInteger" Type="Integer" Label="Integer (Mandatory)" Value="2" Tooltip="Mandatory Integer tooltip" Min="1" Max="3" Mandatory="true"/>
            <Variable Name="Number" Type="Number" Label="Number" Value="365.99" Tooltip="Number tooltip"/>
            
            <Variable Name="AnotherCategory" Type="Category" Label="Another Category" Expand="True"/>
            <Variable Name="List" Type="List" Label="List" Value="List item 1" Tooltip="List tooltip">
                <ListItem Value="List item 1"/>
                <ListItem Value="List item 2" Label="Label for List item 2"/>
                <ListItem Value="List item 3"/>
                <ListItem Value="List item 4"/>
            </Variable>
            <Variable Name="RadioList" Type="RadioList" Label="RadioList" Value="Radio List item 2" Tooltip="RadioList tooltip">
                <ListItem Value="RadioList item 1"/>
                <ListItem Value="RadioList item 2"/>
                <ListItem Value="RadioList item 3"/>
                <ListItem Value="RadioList item 4"/>
            </Variable>
            <Variable Name="CheckList" Type="CheckList" Label="CheckList" Tooltip="CheckList tooltip" ListName="TheCheckList" HasSelectAll="true">
                <ListItem Value="CheckList item 1"/>
                <ListItem Value="CheckList item 2"/>
                <ListItem Value="CheckList item 3" Select="true"/>
                <ListItem Value="CheckList item 4"/>
            </Variable>
            <Variable Name="NoCheckboxList" Type="NoCheckboxList" Label="NoCheckboxList" Tooltip="NoCheckboxList tooltip">
                <ListItem Value="NoCheckboxList item 1"/>
                <ListItem Value="NoCheckboxList item 2"/>
                <ListItem Value="NoCheckboxList item 3"/>
                <ListItem Value="NoCheckboxList item 4"/>
            </Variable>
            <Variable Name="MultiList" Type="MultiList" Label="MultiList" Tooltip="MultiList tooltip" ListName="TheMultiList">
                <ListItem Value="MultiList item 1"/>
                <ListItem Value="MultiList item 2"/>
                <ListItem Value="MultiList item 3"/>
                <ListItem Value="MultiList item 4" Select="true"/>
            </Variable>
            <Variable name='FolderPath' Type='FolderPath' Label='FolderPath' Value="C:\Temp" Tooltip="FolderPath tooltip"/>
            <Variable name='FilePath' Type='InputFilePath' Label='InputFilePath' Value="C:\Temp\file.text" Tooltip="InputFilePath tooltip"/>
            <Variable name='OutputFilePath' Type='OutputFilePath' Label='OutputFilePath' Value="C:\Temp\file.text" Tooltip="OutputFilePath tooltip"/>

            <Variable Name="sapio365Specific" Type="Category" Label="sapio365 specific"/>
            <Variable Name="UserListValue" ListName="UserList" Label="MultiUserSelection" Type="MultiUserSelection">
                <ListItem ListName="UserList" Value="UserListValue"/>
            </Variable>
            <Variable Name="SingleUserValue" ListName="SingleUser" Label="OneUserSelection" Type="OneUserSelection">
                <ListItem ListName="SingleUser" Value="SingleUserValue"/>
            </Variable>
            <Variable Name="GroupListValue" ListName="GroupList" Label="MultiGroupSelection" Type="MultiGroupSelection">
                <ListItem ListName="GroupList" Value="GroupListValue"/>
            </Variable>
            <Variable Name="SingleGroupValue" ListName="SingleGroup" Label="OneGroupSelection" Type="OneGroupSelection">
                <ListItem ListName="SingleGroup" Value="SingleGroupValue"/>
            </Variable>
			<Variable Name="OPUserListValue" ListName="OPUserList" Label="MultiOnPremUserSelection" Type="MultiOnPremUserSelection">
                <ListItem ListName="OPUserList" Value="OPUserListValue"/>
            </Variable>
            <Variable Name="SingleOPUserValue" ListName="SingleOPUser" Label="OneOnPremUserSelection" Type="OneOnPremUserSelection">
                <ListItem ListName="SingleOPUser" Value="SingleOPUserValue"/>
            </Variable>
            <Variable Name="OPGroupListValue" ListName="OPGroupList" Label="MultiOnPremGroupSelection" Type="MultiOnPremGroupSelection">
                <ListItem ListName="OPGroupList" Value="OPGroupListValue"/>
            </Variable>
            <Variable Name="SingleOPGroupValue" ListName="SingleOPGroup" Label="OneOnPremGroupSelection" Type="OneOnPremGroupSelection">
                <ListItem ListName="SingleOPGroup" Value="SingleOPGroupValue"/>
            </Variable>
    </UserInput>
    
    <Echo Value="Text value is: {%Text%}"/>
    <Echo Value="Bool value is: {%Bool%}"/>
    <Echo Value="BoolToggle value is: {%BoolToggle%}"/>
    <Echo Value="Date value is: {%DateAny%}"/>
    <Echo Value="DateInPast value is: {%DateInPast%}"/>
    <Echo Value="Integer value is: {%Integer%}"/>
    <Echo Value="Mandatory Integer value is: {%MandatoryInteger%}"/>
    <Echo Value="Number value is: {%Number%}"/>
    <Echo Value="List value is: {%List%}"/>
    <Echo Value="RadioList value is: {%RadioList%}"/>
    <Loop list="TheCheckList">
        <ExecuteListAction/>
        <Echo value="CheckList contains: {%CheckList%}"/>
    </Loop>
    <Loop list="TheMultiList">
        <ExecuteListAction/>
        <Echo value="MultiList contains: {%MultiList%}"/>
    </Loop>
    <Echo Value="FolderPath value is: {%FolderPath%}"/>
    <Echo Value="InputFilePath value is: {%FilePath%}"/>
    <Echo Value="OutputFilePath value is: {%OutputFilePath%}"/>
    <Loop list="UserList">
        <ExecuteListAction/>
        <Echo value="MultiUserSelection contains: {%UserListValue%}"/>
    </Loop>
    <Loop list="SingleUser">
        <ExecuteListAction/>
        <Echo value="OneUserSelection contains: {%SingleUserValue%}"/>
    </Loop>
     <Loop list="GroupList">
        <ExecuteListAction/>
        <Echo value="MultiGroupSelection contains: {%GroupListValue%}"/>
    </Loop>
    <Loop list="SingleGroup">
        <ExecuteListAction/>
        <Echo value="OneGroupSelection contains: {%SingleGroupValue%}"/>
    </Loop>
    <Loop list="OPUserList">
        <ExecuteListAction/>
        <Echo value="MultiOnPremUserSelection contains: {%OPUserListValue%}"/>
    </Loop>
    <Loop list="SingleOPUser">
        <ExecuteListAction/>
        <Echo value="OneOnPremUserSelection contains: {%SingleOPUserValue%}"/>
    </Loop>
     <Loop list="OPGroupList">
        <ExecuteListAction/>
        <Echo value="MultiOnPremGroupSelection contains: {%OPGroupListValue%}"/>
    </Loop>
    <Loop list="SingleOPGroup">
        <ExecuteListAction/>
        <Echo value="OneOnPremGroupSelection contains: {%SingleOPGroupValue%}"/>
    </Loop>

</ytriaAutomation>
XML

Console output after OK


Example using an explicit List and a List from SetVarListFromGridSelection to populate a combo box (List type)


User Input example with lists

<ytriaAutomation Application="sapio365">
    <!-- to be launched from a groups view with a selection of rows -->
    <!--
    Generate a List of SetVar from the current selection in the grid:
    - Set list name and target grid (target is not needed in sapio365 or main grids in Notes products)
    - Add variable names connected to grid column unique IDs (shown in grid's Column Map) to store grid values into
    In this example "displayName", "groupType", "id", "mailEnabled" are column unique IDs from the sapio365 Groups grid:
    -->
    <Echo Mode="False"/>
    <SetVarListFromGridSelection ListName="GroupList" MyListGroupName="displayName" MyListType="groupType" MyListGroupId="id" MyListMail="mailEnabled"/>
    <List Name="TheList" Action="SetVar" ListItemLabel="List Item Value 1" ListItemValue="listItemValue1"/>
    <List Name="TheList" Action="SetVar" ListItemLabel="List Item Value 2" ListItemValue="listItemValue2"/>
    <List Name="TheList" Action="SetVar" ListItemLabel="List Item Value 3" ListItemValue="listItemValue3"/>
    <List Name="TheList" Action="SetVar" ListItemLabel="List Item Value 4" ListItemValue="listItemValue4"/>
    <!-- now use these two lists in an input dialog -->
    <UserInput Title="User Input example with lists">
        <Variable Name="Groups" Label="Group stuff" Tooltip="Test combo items from SetVarListFromGridSelection" Type="List">
            <ListItem ListName="GroupList" Label="MyListGroupName" Value="MyListGroupId"/>
        </Variable>
        <Variable Name="ListCombo" Label="List stuff" Tooltip="Test combo items from List" Type="List">
            <ListItem ListName="TheList" Label="ListItemLabel" Value="ListItemValue"/>
        </Variable>
    </UserInput>
    <Echo Value="Groups selection is {%Groups%}"/>
    <Echo Value="List Combo selection is {%ListCombo%}"/>
</ytriaAutomation>
XML





After OK is clicked, the selected items in each component will be stored in an automation LIST that must be used in a LOOP (even if the selection contains a single item), and whose action is SetVar. Each entry in the check list has a value and a label which can be identical.

The list named after the value set for the ListName parameter in the Variable, contains the list of selected item values (not labels).


Example using a List from SetVarListFromGridSelection to populate a list of checkboxes (CheckList type)


In the example below, UserList is first created from the grid selection (with SetVarListFromGridSelection ), then used as input in the variable varFromGridSelection. The entries later selected in the dialog are put into a new list named USERcheckList.

When USERcheckList is iterated in a loop, each ExecuteListAction sets the variable varFromGridSelection to the current value from USERcheckList.

If the user selection contains no item, the list doesn't exist and using it in a Loop will result in an error. Make the variable Mandatory to force at least one selection.


User Input example with list from grid

<ytriaAutomation>
	<Echo Mode="False"/>
	<Select Lines="all"/>
	<SetVarListFromGridSelection ListName="UserList" Username="displayName" Email="userPrincipalName"/><!-- create list from grid selection (all rows) with values from the displayName 
	and userPrincipalName columns-->

	<!-- hardcoded list -->
	<List Name="ListForCheckList" Action="SetVar" ListItemLabel="Checklist Item Value 1" ListItemValue="checkListItemValue1"/>
	<List Name="ListForCheckList" Action="SetVar" ListItemLabel="Checklist Item Value 2" ListItemValue="checkListItemValue2"/>
	<List Name="ListForCheckList" Action="SetVar" ListItemLabel="Checklist Item Value 3" ListItemValue="checkListItemValue3"/>
	<List Name="ListForCheckList" Action="SetVar" ListItemLabel="Checklist Item Value 4" ListItemValue="checkListItemValue4"/>

	<Userinput Title="User Input example with list from grid">
		<Variable Name="varFromGridSelection" ListName="USERcheckList" Type="CheckList" Label="Select User:" Tooltip="Grid list selector"><!-- check list from grid selection -->
			<ListItem ListName="UserList" Value="Email" Label="Username" Select="true"/><!-- Select="true": all items selected by default -->
		</Variable>
		<Variable name="varFromHarcodedList" ListName="ScriptListCheckList" Type="CheckList" Label="Select from List:" Tooltip="Harcoded list selector" Mandatory="true"><!-- check list from 
		hardcoded list -->
			<ListItem ListName="ListForCheckList" value="CheckListItemValue" label="CheckListItemLabel"/>
		</Variable>
		<Variable name="varFromDlg" ListName="MyCheckList" Type="MultiList" Label="Select from My List:" Tooltip="My list selector"><!-- check list from a new list -->
			<ListItem Value="My Checklist Item Value 1" Select="true"/>
			<ListItem Label="My Checklist Item Value 2" Value="myCheckListItemValue2"/>
			<ListItem Label="My Checklist Item Value 3" Value="myCheckListItemValue3"/>
			<ListItem Label="My Checklist Item Value 4" Value="myCheckListItemValue4" select="true"/>
			<ListItem Label="My Checklist Item Value 5" Value="myCheckListItemValue5"/>
		</Variable>
	</Userinput>

	<Loop List="USERcheckList">
		<ExecuteListAction/>
		<Echo Value="Selected user: {%varFromGridSelection%}"/>
	</Loop>
	<Loop List="ScriptListCheckList">
		<ExecuteListAction/>
		<Echo Value="Selected from List: {%varFromHarcodedList%}"/>
	</Loop>
	<Loop List="MyCheckList">
		<ExecuteListAction/>
		<Echo Value="Selected from My List: {%varFromDlg%}"/>
	</Loop>
</ytriaAutomation>
XML

Adding Events

In order to control components (show/hide or enable/disable) in the dialog according to the state of a BoolToggle or a Bool, Event and EventGlobal actions can be used.

Event

AttributesAttribute ValueValue Description
TargetN/AName of field to control
Modehideifeq / hideifnoteq / disableifeq / disableifnoteq

hideifeq - Hide if equal
hideifnoteq - Hide if not equal
disableifeq - Disable if equal
disableifnoteq - Disable if not equal

Only these exact strings are permitted

SourceN/AName of field value that triggers the state change
ValueTrue / False or 1 / 0

True / False for BoolToggle type
1 / 0 for Bool type

Other field types cannot be used as event source



EventGlobal

AttributesAttribute ValueValue Description
SourceN/AName of field value that triggers the state change


Example Script

User Input with events

<ytriaAutomation>
    <Echo Mode="false"/>
    <UserInput Title="User Input with events">
        <Variable Name="Category" Type="Category" Label="A Category"/>
        <Variable Name="Text" Value="This is a Text" Label="Text" Tooltip="Text tooltip"/>
        <Variable Name="Bool" Type="Bool" Label="Bool" Value="true" Tooltip="Bool tooltip"/>
        <Variable Name="BoolToggle" Type="BoolToggle" Label="BoolToggle" Value="false" Tooltip="BoolToggle tooltip"/>
        <Variable Name="BoolToggle2" Type="BoolToggle" Label="BoolToggle (2)" Value="false" Tooltip="BoolToggle (2) tooltip"/>
        <Event Target="Text" Mode="hideifeq" Source="Bool" Value="0"/>
        <Event Target="BoolToggle2" Mode="disableifnoteq" Source="BoolToggle" Value="true"/>
        <EventGlobal Source="BoolToggle"/>
    </UserInput>
</ytriaAutomation>
XML