Controllers¶
The Controllers family is one of the available components’ families you can use to populate a form.
It contains commands that enable specific interactions, allowing the master user to build guided procedures and the end user to interact with the custom interface.
What makes the Controllers family unique among all the other components is the fact that the options available in the Options tab can be linked to them, assigning a default value.
When a controller is dragged onto the stage, or when an option is not linked to it, its outline is highlighted in yellow.
Once an option is assigned to a controller, its outline is highlighted in green.
Only controllers can manage values, so they are the only components that can serve as an Origin to make connections work. When defining a connection, users select which controller acts as the Origin, triggers the connection, and if the condition is verified, the corresponding options are activated.
To make it easier to locate them, controllers have been divided into two groups:
Base controllers, manage one option at a time, depending on the specific type of Base controller selected. Each Base controller handles a specific value type, so users can choose whether to manage a number, string, or password based on the selected controller.
Multiple controllers, manage one or more options at a time, depending on the desired graphical interaction.
Base¶
The Base group contains the following controllers:
Checkbox
Text field
Number field
Password field
Color picker
Calendar field
Source control
Repository control
Code field
The layout of base controllers can be customized in the components layout menu, it can be accessed by right-clicking onto the component and clicking Open components layout or when first dragging the component onto the stage.
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the checkbox. |
Layout |
Label |
The label of the checkbox. |
Label width |
The width (in pixels) of the label. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the checkbox. |
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the text field. |
Layout |
Label |
The label of the text field. |
Label position |
The position of the label. The possible values are: Start (default), Top, Bottom, End. |
|
Label width |
The width (in pixels) of the label. |
|
Option width |
The width (in pixels) of the field where the values will be inserted. |
|
Default (with code None) |
If the option associated with the text field has no value, here users can specify a default value for the component. |
|
Multiline |
If selected, the text field will contain multiple lines. |
|
Format |
It checks the data type which will be inserted in the text field. For example, a Regex checking whether an email has been written correctly in the format |
|
Use format value to check the entire text rather than to extract matches |
If selected, the value specified in the Format field will be used to check the format of the text inserted in the text field. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the text field. |
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the number field. |
Layout |
Label |
The label of the number field. |
Label position |
The position of the label. The possible values are: Start (default), Top, Bottom, End. |
|
Label width |
The width (in pixels) of the label. |
|
Option width |
The width (in pixels) of the field where the values will be inserted. |
|
Min value |
The allowed minimum value of the number field. |
|
Max value |
The allowed maximum value of the number field. |
|
Default (with code None) |
If the option associated with the number field has no value, here users can specify a default value for the component. |
|
Floating number (3-digits) |
If selected, continuous numbers with up to 3 digits after the comma will be accepted. |
|
Floating number (6-digits) |
If selected, continuous numbers with up to 6 digits after the comma will be accepted. |
|
Percentage value |
If selected, the considered number will be a percentage. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the number field. |
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the password field. |
Layout |
Label |
The label of the number field. |
Label position |
The position of the label. The possible values are: Start (default), Top, Bottom, End. |
|
Label width |
The width (in pixels) of the label. |
|
Option width |
The width (in pixels) of the field where the values will be inserted. |
|
Default (with code None) |
If the option associated to the password field has no value, here users can specify a default value for the component. |
|
Multiline |
If selected, the password field will contain multiple lines. |
|
Use format value to check the password |
If selected, the value specified in the Format field will be used to check the format of the password inserted in the password field. (e.g. if it contains capital letters, a number and so on) |
|
Format |
It checks the data type which will be inserted in the password field. For example, a Regex checking whether an email has been written correctly in the format |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the password field. |
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the color picker. |
Layout |
Label |
The label of the color picker. |
Label width |
The width (in pixels) of the label. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the color picker. |
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the calendar field. |
Layout |
Label |
The label of the calendar field. |
Label position |
The position of the label. The possible values are: Start (default), Top, Bottom, End. |
|
Label width |
The width (in pixels) of the label. |
|
Option width |
The width (in pixels) of the field where the values will be inserted. |
|
Date type |
The allowed date format. Possible values are Date (default), Month, Week, Quarter, Datetime, Time. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the calendar field. |
Sub-section |
Option |
Description |
|---|---|---|
General |
Source type |
Select from the drop-down list the type of source which will be supported. The available types are: Database and Filesystem (default). |
Extensions (comma sep) |
Specify the allowed file extensions, separated by a comma. |
|
File Number Limit (-1 means no limit) |
The maximum number of files which can be managed by the source control. If -1 is specified, an infinite number of files can be managed. |
|
Export |
Select this checkbox if the current controller will perform export operations. The Directory name, Import response, Http response header, Http response uri, Http response fields activate. |
|
Excel |
Select this checkbox if the current controller will support MS Excel file format. The Sheetlist, Match by position, Sheet import mode fields activate. |
|
Add branch token options |
If selected, the checkbox containing the options related to the branch token will be added to the source control, and consequently the Use token and Store token options will be added in the source control and the corresponding fields will be displayed in the option area. |
|
Option |
Uri |
Select from the drop-down list the option, whose characteristics are defined in the Options tab, containing information about the uri. |
Filelist |
Select from the drop-down list the option, whose characteristics are defined in the Options tab, containing information about the file list. |
|
Use token |
Select from the drop-down list the option, whose characteristics are defined in the Options tab, defining the Use token field. |
|
Store token |
Select from the drop-down list the option, whose characteristics are defined in the Options tab, defining the Store token field. |
|
Uri type |
Select the filesystem type, whose options will be displayed underneath this field to be fully configured. The possible values are: ShareDrive Filesystem, Aws S3, HDFS, SharePoint, Ftp Server, Http Server, Azure BLOB Storage, Local File System, Sftp Server, Google Drive, Outlook. A complete list of the options is available in the Filesystem configuration page. |
|
domain |
If ShareDrive Filesystem has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific ShareDrive option is explained in the corresponding page. |
|
uri |
If ShareDrive Filesystem has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific ShareDrive option is explained in the corresponding page. |
|
username |
If ShareDrive Filesystem has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific ShareDrive option is explained in the corresponding page. |
|
password |
If ShareDrive Filesystem has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific ShareDrive option is explained in the corresponding page. |
|
port |
If ShareDrive Filesystem has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific ShareDrive option is explained in the corresponding page. |
|
share |
If ShareDrive Filesystem has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific ShareDrive option is explained in the corresponding page. |
|
auth |
If ShareDrive Filesystem has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific ShareDrive option is explained in the corresponding page. |
|
path |
If ShareDrive Filesystem has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific ShareDrive option is explained in the corresponding page. |
|
bucket |
If Aws S3 has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Aws S3 option is explained in the corresponding page. |
|
username |
If Aws S3 has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Aws S3 option is explained in the corresponding page. |
|
password |
If Aws S3 has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Aws S3 option is explained in the corresponding page. |
|
auth |
If Aws S3 has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Aws S3 option is explained in the corresponding page. |
|
connstring |
If Aws S3 has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Aws S3 option is explained in the corresponding page. |
|
granttype |
If Aws S3 has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Aws S3 option is explained in the corresponding page. |
|
domain |
If Aws S3 has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Aws S3 option is explained in the corresponding page. |
|
path |
If Aws S3 has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Aws S3 option is explained in the corresponding page. |
|
proxy |
If Aws S3 has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Aws S3 option is explained in the corresponding page. |
|
url |
If HDFS has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific HDFS option is explained in the corresponding page. |
|
username |
If HDFS has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific HDFS option is explained in the corresponding page. |
|
password |
If HDFS has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific HDFS option is explained in the corresponding page. |
|
port |
If HDFS has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific HDFS option is explained in the corresponding page. |
|
auth |
If SharePoint has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific SharePoint option is explained in the corresponding page. |
|
url |
If SharePoint has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific SharePoint option is explained in the corresponding page. |
|
username |
If SharePoint has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific SharePoint option is explained in the corresponding page. |
|
password |
If SharePoint has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific SharePoint option is explained in the corresponding page. |
|
domain |
If SharePoint has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific SharePoint option is explained in the corresponding page. |
|
proxy |
If SharePoint has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific SharePoint option is explained in the corresponding page. |
|
url |
If Ftp Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Ftp Server option is explained in the corresponding page. |
|
username |
If Ftp Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Ftp Server option is explained in the corresponding page. |
|
password |
If Ftp Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Ftp Server option is explained in the corresponding page. |
|
port |
If Ftp Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Ftp Server option is explained in the corresponding page. |
|
proxy |
If Ftp Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Ftp Server option is explained in the corresponding page. |
|
auth |
If Http Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Http Server option is explained in the corresponding page. |
|
username |
If Http Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Http Server option is explained in the corresponding page. |
|
password |
If Http Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Http Server option is explained in the corresponding page. |
|
headers |
If Http Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Http Server option is explained in the corresponding page. |
|
proxy |
If Http Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Http Server option is explained in the corresponding page. |
|
granttype |
If Http Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Http Server option is explained in the corresponding page. |
|
authurl |
If Http Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Http Server option is explained in the corresponding page. |
|
scope |
If Http Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Http Server option is explained in the corresponding page. |
|
resource |
If Http Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Http Server option is explained in the corresponding page. |
|
username |
If Azure BLOB Storage has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Azure BLOB Storage option is explained in the corresponding page. |
|
auth |
If Azure BLOB Storage has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Azure BLOB Storage option is explained in the corresponding page. |
|
url |
If Azure BLOB Storage has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Azure BLOB Storage option is explained in the corresponding page. |
|
domain |
If Azure BLOB Storage has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Azure BLOB Storage option is explained in the corresponding page. |
|
password |
If Azure BLOB Storage has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Azure BLOB Storage option is explained in the corresponding page. |
|
proxy |
If Azure BLOB Storage has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Azure BLOB Storage option is explained in the corresponding page. |
|
url |
If Sftp Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Sftp Server option is explained in the corresponding page. |
|
username |
If Sftp Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Sftp Server option is explained in the corresponding page. |
|
password |
If Sftp Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Sftp Server option is explained in the corresponding page. |
|
port |
If Sftp Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Sftp Server option is explained in the corresponding page. |
|
proxy |
If Sftp Server has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Sftp Server option is explained in the corresponding page. |
|
url |
If Google Drive has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Google Drive option is explained in the corresponding page. |
|
username |
If Google Drive has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Google Drive option is explained in the corresponding page. |
|
password |
If Google Drive has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Google Drive option is explained in the corresponding page. |
|
connstring |
If Google Drive has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Google Drive option is explained in the corresponding page. |
|
proxy |
If Google Drive has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Google Drive option is explained in the corresponding page. |
|
auth |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
url |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
username |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
connstring |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
domain |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
proxy |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
path |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
authurl |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
startdate |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
enddate |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
scope |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
share |
If Outlook has been selected, select from the drop-down list the option, whose characteristics are defined in the Options defining this field. Information on this specific Outlook option is explained in the corresponding page. |
|
Layout |
Label |
The label of the controller. |
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the source control. |
Sub-section |
Option |
Description |
|---|---|---|
General |
Extensions (comma separated) |
Specify the allowed file extensions. |
File Number Limit (-1 means no limit) |
The maximum number of files which can be managed by the source control. If -1 is specified, an infinite number of files can be managed. |
|
Show folder name |
If selected, the repository folder name will be displayed. |
|
Show file name |
If selected (default), the File name option is displayed. |
|
Option |
Uri |
Select from the drop-down list the option, whose characteristics are defined in the Options tab, containing information about the repo’s Uri. |
Branch |
Select from the drop-down list the option, whose characteristics are defined in the Options tab, containing information about the repo’s branch. |
|
Tag/Commit SHA |
Select from the drop-down list the option, whose characteristics are defined in the Options tab, containing information about the tag or commit SHA. |
|
File name |
The name of the file stored in the repository. |
|
Uri type |
Select from the drop-down list the repo type. The only option available is Git. |
|
Layout |
Label |
The label of the controller. |
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the repository control. |
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the code field. |
Layout |
Label |
The label of the code field. |
Label position |
The position of the label. The possible values are: Start, Top (default), Bottom, End. |
|
Label width |
The width (in pixels) of the label. |
|
Option width |
The width (in pixels) of the field where the values will be inserted. |
|
Language |
The supported language in the code field. |
|
Show Preview |
If selected, a button allowing to switch from the code to its preview, called Go to preview, is added to the component on its top-right corner. |
|
Automatic Preview |
If selected, the code field displays a message on what to do if the preview cannot be calculated. If it is not selected, an error is displayed if the preview cannot be calculated. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the code field. |
Multiple¶
The Multiple group contains the following controllers:
Combobox
Values autocomplete
Radio buttons
General item list
Structure list (in tasks only)
Coefficient list (in tasks only)
Multi index (in tasks only)
Char list (in tasks only)
Their layout can be customized by right-clicking onto the component and clicking Open widget layout. Browse the tabs below to know more about the available options for each controller of this group.
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the combobox. |
Layout |
Label |
The label of the combobox. |
Label width |
The width (in pixels) of the label. |
|
Combobox width |
The width (in pixels) of the combobox in the form. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the combobox. |
|
Add undefined value |
If selected, the combobox will have a blank value field, which will assign the undefined value to the option. If both the Add undefined value and the Add null value fields are selected, only the undefined value will be assigned to the option. |
|
Add null value |
If selected, the combobox will have a blank value field, which will assign the null value to the option. If both the Add undefined value and the Add null value fields are selected, only the undefined value will be assigned to the option. |
|
Values |
In this table, users can choose two different value modes: the Table or the Metadata mode.
|
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the values autocomplete. |
Layout |
Label |
The label of the values autocomplete controller. |
Label width |
The width (in pixels) of the label. |
|
Combobox width |
The width (in pixels) of the values autocomplete. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the values autocomplete. |
|
Values |
In this table, users can choose two different value modes: the Table or the Metadata mode.
|
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the radio button. |
Layout |
Label |
The label of the radio button. |
Label position |
The position of the label. The possible values are: Start (default), Top, Bottom, End. |
|
Label width |
The width (in pixels) of the label. |
|
Group direction |
The direction of the options in the radio button. The possible values are: Row (default), Column. |
|
Option width |
The width (in pixels) of the values of the radio button displayed on the stage. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the radio button. |
|
Add other |
If selected, the Other field, where users can specify a custom value, is added to the form. |
|
Values |
In this table, users can choose two different value modes: the Table or the Metadata mode.
|
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the list. |
Layout |
Label |
The label of the list. |
Option width |
The width (in percentage) of the list. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the list. |
|
Items |
In this table, users can choose two different value modes: the Table or the Metadata mode.
|
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the list. |
Layout |
Label |
The label of the list. |
Option width |
The width (in percentage) of the list. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the list. |
|
Supported structures |
Select the structures which will be supported by the controller. The available structures are:
|
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the list. |
Layout |
Label |
The label of the list. |
Default coefficient value |
The default value of the coefficient. |
|
Min coefficient value |
The allowed minimum value of the coefficient. |
|
Max coefficient value |
The allowed maximum value of the coefficient. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the list. |
Sub-section |
Option |
Description |
|---|---|---|
Option |
N layers |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which contains the number of the layers which will be displayed in the controller. |
N elements |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will contain information on the list with the indexes which will be associated to the layers. |
|
Layout |
Layer label |
Type the label of the layer. |
Layer label width |
Specify the width (in pixels) of the layer label. |
|
Layer option width |
Specify the width (in pixels) of the value of the layer. |
|
Element label |
Type the label of the element. |
|
Element label width |
Specify the width (in pixels) of the element label. |
|
Element option width |
Specify the width (in pixels) of the value of the element. |
|
Flex position |
Select from the drop-down list the way the component’s fields will be placed. The possible values are: Row (default), and Column. |
|
Option nelements |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the number of elements. |
|
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the list. |
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the list. |
Layout |
Label |
The label of the list. |
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the list. |
Attribute¶
The Attribute group contains the following controllers:
Attribute list, where a list of attributes can be generated.
Attribute combobox, where a drop-down list containing attributes can be built.
Attribute drop zone, where attributes coming from an Attribute list can be dragged.
Attribute filter, where the dragged attribute can be filtered according to its values.
Split data (in tasks only), where users can set up a task of Split Data type (more information can be found here).
Relation manager, where relations between values can be built. These values can come from a dataset or can be decided by the user.
Their layout can be customized by right-clicking onto the component and clicking Open widget layout. Browse the tabs below to know more about the available options for each Attribute controller.
Sub-section
Option
Description
Option
Option
Select from the drop-down list the option, among those available in the Options tab, which will be linked to the attribute list.
Layout
Label
The label of the attribute list.
Append dataset name to the label
If selected, the dataset name is appended to the attribute list controller’s label.
Draggable
If selected (default), it will be possible to drag the attributes contained in the Attribute List to another controller.
Filter by category
Select from the drop-down list the way the attribute list will be filtered. The possible values are: All, Attributes (default), Results (those attributes which have been generated as results by tasks in Rulex Factory).
Order
The position of the controller in the mask. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to the Order value.
Css
Additional CSS code used to customize the list.
Source structure
Specify the source from which data come from, which has to be one of the table names stored in the Datasets tab.
ATTRIBUTE COMBOBOX
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those available in the Options tab, which will be linked to the attribute combobox. |
Layout |
Label |
The label of the attribute combobox. |
Label position |
The position of the label. The possible values are: Start (default), Top, Bottom, End. |
|
Label width |
The width (in percentage or in pixels) of the label. |
|
Option width |
The width (in percentage or in pixels) of the combobox. |
|
Order |
The position of the controller in the mask. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to the Order value. |
|
Css |
Additional CSS code used to customize the controller. |
|
Source structure |
Specify the source from which data come from, which has to be one of the table names stored in the Datasets tab. |
|
Filter by type |
Select which attribute types will be filtered and displayed in the combobox among the following available: nominal, integer, continuous, date, week, month, quarter, percentage, datetime, time, binary, currecy. By hovering over the three-dotted button in the bottom-right corner of the section, the Check All and Uncheck All buttons are available to make the selection easier. |
|
Filter by role |
Select which attribute roles will be filtered and displayed in the combobox among the following available: input, output, parameter. By hovering over the three-dotted button in the bottom-right corner of the section, the Check All and Uncheck All buttons are available to make the selection easier. |
|
Filter out ignored |
If selected, those attributes which have been ignored on the source dataset will not be displayed. |
|
Filter by category |
Select from the drop-down list which attribute category will be displayed. The possible values are: All, Attributes (default), Results (those attributes which have been generated as results by tasks in Rulex Factory). |
ATTRIBUTE DROP ZONE
In the Attribute drop zone controller, two tabs are already available:
The Manual list, where users can build manually a list of attributes by dragging them onto the controller.
The Filtered list, where users can build a filter which will be applied to the attributes which have already been dragged onto the Manual list.
More information on the Attribute drop zone and on how the two tabs above work can be found in the corresponding section, linked here.
Sub-section
Option
Description
Option
Option
Select from the drop-down list the option, among those available in the Options tab, which will be linked to the attribute drop zone.
Layout
Label
The label of the drop zone.
Order
The position of the controller in the mask. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to the Order value.
Css
Additional CSS code used to customize the controller.
Source structure
Specify the source from which data come from, which has to be one of the table names stored in the Datasets tab.
Add structure name to the attributes
If selected, the prefix tablename! will be added to the visualized attribute names.
Filter by type
Select which attribute types will be filtered and displayed in the drop zone among the following available: nominal, integer, continuous, date, week, month, quarter, percentage, datetime, time, binary, currecy. By hovering over the three-dotted button in the bottom-right corner of the section, the Check All and Uncheck All buttons are available to make the selection easier.
Filter by role
Select which attribute roles will be filtered and displayed in the combobox among the following available: input, output, parameter. By hovering over the three-dotted button in the bottom-right corner of the section, the Check All and Uncheck All buttons are available to make the selection easier.
Filter out ignored
If selected, those attributes which have been ignored on the source dataset will not be displayed.
Filter by category
Select from the drop-down list which attribute category will be displayed. The possible values are: All, Attributes (default), Results (those attributes which have been generated as results by tasks in Rulex Factory).
ATTRIBUTE FILTER
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those available in the Options tab, which will be linked to the attribute filter. |
Layout |
Label |
The label of the attribute filter. |
Label width |
The width (in percentage or in pixels) of the label. |
|
Option width |
The width of the attribute filter. |
|
Source structure |
Specify the source from which data come from, which has to be one of the table names stored in the Datasets tab. |
|
Order |
The position of the controller in the mask. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to the Order value. |
|
Css |
Additional CSS code used to customize the controller. |
SPLIT DATA
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option trainsize |
Select from the drop-down list the option, among those available in the Options tab, which will define the dimension of the training set. |
Option trainstart |
Select from the drop-down list the option, among those available in the Options tab, which will define the starting pattern of the training set. |
|
Option testsize |
Select from the drop-down list the option, among those available in the Options tab, which will define the dimension of the test set. |
|
Option teststart |
Select from the drop-down list the option, among those available in the Options tab, which will define the starting pattern of the test set. |
|
Option validsize |
Select from the drop-down list the option, among those available in the Options tab, which will define the dimension of the validation set. |
|
Option validstart |
Select from the drop-down list the option, among those available in the Options tab, which will define the starting pattern of the validation set. |
|
Layout |
Formula for absolute value |
Type the formula which will be used to calculate the absolute value. |
Order |
The position of the controller in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to their Order value. |
|
Css |
Additional CSS code used to customize the controller. |
|
Source structure |
RELATION MANAGER
Sub-section |
Option |
Description |
|---|---|---|
Option |
Option |
Select from the drop-down list the option, among those available in the Options tab, which will be linked to the relation manager. |
Layout |
Label |
The label of the relation manager. |
Order |
The position of the controller in the mask. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, controllers will be sorted in ascending order according to the Order value. |
|
Css |
Additional CSS code used to customize the controller. |
|
List type |
The type of the list. The only value is Undroppable. |
|
Left list |
|
|
Right list |
|