Control Types
The control type specifies the type of editor with which a user can insert values for the parameter.
Last updated
The control type specifies the type of editor with which a user can insert values for the parameter.
Last updated
A detailed breakdown of all supported control types in class designer can be found here.
A Multi Select is a control that allows you to select multiple items from a list. The list comes from a data source that can be selected in the configuration.
When Multi Select is selected as the control type, additional configuration fields appear in the Parameter Configuration panel. In the Columns the number of columns for displaying the entries is set. A maximum of 4 columns can be displayed. The Dropdown if... input field is used to enter the number of lines that must be exceeded for the list to be displayed in a dropdown.
A Multi Select parameter is displayed as a dropdown if more than X rows are displayed:
more than X instances and 1 column
more than X*2 instances and 2 columns
more than X*3 instances and 3 columns
etc.
X = Number of rows that can be configured.
With a Multi Selection it is necessary to select the data source. There are 3 types of sources available: Class, Controller and Option. With the type Class the class can be selected from a list and optionally also a field of the class. As default the name of the class is displayed. When you select the Controller type, a list of all available controllers is available. When selecting Option, the options can be entered as free text.
Workflow parameter with the control type Object enables action creator to request complex data in a single parameter.
An Object is composed of sub-parameters, each presenting one field. Fields can be filled like regular parameters (or table cells). Each cell or field can contain another sub-object to input.
The field order is determined by the order of the sub-parameters.
If the Object parameter is not required then filling of Object fields can be skipped. If it is not skipped or is set 'Options' -> 'Is required' then all required fields must be filled.
Filled Object data is passed to the script as <Dictionary, Any> or if skipped (not filled) as NULL.
Once Table is set as a control type, it is possible to request tabular data in parameters, so that an user can input multiple, complex rows to be used in the scripts.
A table is composed of sub-parameters, each presenting one column. An unlimited number of rows can be entered by filling cells. Rows can be added, deleted and re-arranged. The column order is determined by the order of the sub-parameters.
Table column or sub-parameter has its own configuration menu divided into sections. Section 'Common' is always shown, while 'Options' and a third section are shown depending on the chosen table column control type. Following fields are available in the column configuration menu:
Key: the key to identify the column
Name: the header of the column (in English, German or French)
Data type: is calculated from the chosen control type
Control type: a list of control types to change the input method for the column (TextBox by default)
Default value (optional): The default value for a new row (when added by the user)
Length (optional): the maximal length of text input
Is required (required): determines whether an column input must be given or not (false by default)
Following fileds are shown for Control types ComboBox, Edit-ComboBox, Add-ComboBox and Multi Select:
Data source class (required if Data source type is Class): the class where to choose the value from
Data source field (required if Data source type is Class): the field of the class that is passed as the value of the selection
Data source controller (required if Data source type is Controller): the controller where to choose the value from
Data source options (required if Data source type is Option): the options input set (one line per option) which values can be chosen by the user
Table column configuration for the control type 'Table' has the same fields as already described above.
If the table parameter is not required an empty table will suffice. If the table has any rows all required columns must be filled.
Control type UploadMultiple enables the upload of multiple files per drag and drop or by uploading the files by selection within particular folder.
The overall upload progress for all files as well as the individual file upload progress is displayed within the corresponding entry. The multi file upload allows the user to delete individual, already uploaded files.
