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. Controllers are the fields and the data-selection components which are placed inside a task or a form.

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.

Each controller has two sets of settings: the Option settings, which usually bind the component to an option or configure the values it manages, and the Layout settings, which change how the component is displayed. The available structures and options depend on the task or on the form the controller belongs to.

To make it easier to locate them, controllers have been divided into three 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.

  • Attribute controllers, manage the attributes of the structures available in the task or in the form, allowing users to select, drag, filter and relate them.


Base

The Base group contains the following controllers:

  • Checkbox

  • Text field

  • Number field

  • Password field

  • Color picker

  • Calendar field

  • Source control

  • AI Model source control

  • Repository control

  • Code field

The layout of base controllers can be customized in the components’ layout menu, which can be accessed by right-clicking onto the component and clicking Open component layout or when first dragging the component onto the stage.

Some fields are available only if other fields have been selected, or depending on the type of form; this is specified in the description of each field.

The Checkbox is a binary on/off input.

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 position

The position of the label. The possible values are: Start (default), Top, Bottom, End.

Label width

The width (in pixels) of the label.

Container width

The width of the container of the checkbox. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Content position

The alignment of the content of the controller within its container.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text of the label.

Checked color

The color of the checkbox when it is selected.

Unchecked color

The color of the checkbox when it is not selected.

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.

Container Css

Additional CSS code used to customize the container of the checkbox.

Label Css

Additional CSS code used to customize the label of the checkbox.

The Text field is a text-entry control, which can also accept multiple lines.

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.

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.

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 name + @ + dominion can be inserted in this field.

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 entire text inserted in the text field, instead of extracting from it the parts which match the format.

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.

Container width

The width of the container of the text field. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Content position

The alignment of the content of the controller within its container.

Multiline

If selected, the text field will contain multiple lines.

Number of lines

The number of lines of the text field. This option is available only if Multiline has been selected.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text of the label.

Ellipsis

If selected, the label exceeding the space available is cut and replaced by an ellipsis (…).

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.

Container Css

Additional CSS code used to customize the container of the text field.

Label Css

Additional CSS code used to customize the label of the text field.

The Number field is a numeric input, with optional bounds and decimal or percentage behavior.

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.

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.

Min value

The allowed minimum value of the number field.

Max value

The allowed maximum value of the number field.

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.

Absolute value

If selected, the percentage is converted into an absolute value, calculated through a formula. When this option is selected, the Formula for absolute value field is displayed. This option is available only if Percentage value has been selected.

Formula for absolute value

Type the formula which will be used to calculate the absolute value. This option is available only if both Percentage value and Absolute value have been selected.

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.

Container width

The width of the container of the number field. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Content position

The alignment of the content of the controller within its container.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text of the label.

Ellipsis

If selected, the label exceeding the space available is cut and replaced by an ellipsis (…).

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.

Container Css

Additional CSS code used to customize the container of the number field.

Label Css

Additional CSS code used to customize the label of the number field.

The Password field is a text-entry control which hides the characters typed by users.

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 password 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.

Container width

The width of the container of the password field. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Content position

The alignment of the content of the controller within its container.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text of the label.

Ellipsis

If selected, the label exceeding the space available is cut and replaced by an ellipsis (…).

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.

Container Css

Additional CSS code used to customize the container of the password field.

Label Css

Additional CSS code used to customize the label of the password field.

The Color picker is a color selection 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 color picker.

Layout

Label

The label of the color picker.

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.

Container width

The width of the container of the color picker. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Content position

The alignment of the content of the controller within its container.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text of the label.

Ellipsis

If selected, the label exceeding the space available is cut and replaced by an ellipsis (…).

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.

Container Css

Additional CSS code used to customize the container of the color picker.

Label Css

Additional CSS code used to customize the label of the color picker.

The Calendar field is a controller which allows users to select a date or time.

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.

Date type

The allowed date format. Possible values are Date (default), Month, Week, Quarter, Datetime, Time.

Starting view

The view which is displayed when the calendar is opened. The possible views depend on the selected Date type.

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.

Container width

The width of the container of the calendar field. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Content position

The alignment of the content of the controller within its container.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the font of the field where the values will be inserted.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text of the label.

Ellipsis

If selected, the label exceeding the space available is cut and replaced by an ellipsis (…).

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 field where the values will be inserted.

The Source control selects a database or a filesystem source, and configures how its values are presented. The available settings depend on the Source type selected in the controller: the options related to each type are described in the following tabs.

Options available when the Source type is Filesystem.

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, allowing users to configure the selection of the file and of the sheet which will be imported.

Set default options

If selected, the Prefix and Suffix fields are displayed, allowing users to specify the prefix and the suffix of the options which will be linked to the controller by default.

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. The fields which are displayed below depend on the selected type, and the options which can be selected in each of them are populated with those available in the Options tab.

ShareDrive Filesystem fields

If ShareDrive Filesystem has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • domain

  • uri

  • username

  • password

  • port

  • share

  • auth

  • path

Information on these specific ShareDrive options is explained in the corresponding page.

Aws S3 fields

If Aws S3 has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • bucket

  • username

  • password

  • auth

  • connstring

  • granttype

  • domain

  • path

  • proxy

Information on these specific Aws S3 options is explained in the corresponding page.

HDFS fields

If HDFS has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • url

  • username

  • password

  • port

Information on these specific HDFS options is explained in the corresponding page.

SharePoint fields

If SharePoint has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • auth

  • url

  • username

  • password

  • domain

  • proxy

Information on these specific SharePoint options is explained in the corresponding page.

Ftp Server fields

If Ftp Server has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • url

  • username

  • password

  • port

  • proxy

Information on these specific Ftp Server options is explained in the corresponding page.

Http Server fields

If Http Server has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • auth

  • username

  • password

  • headers

  • proxy

  • granttype

  • authurl

  • scope

  • resource

Information on these specific Http Server options is explained in the corresponding page.

Azure BLOB Storage fields

If Azure BLOB Storage has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • username

  • auth

  • url

  • domain

  • password

  • proxy

Information on these specific Azure BLOB Storage options is explained in the corresponding page.

Sftp Server fields

If Sftp Server has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • url

  • username

  • password

  • port

  • proxy

Information on these specific Sftp Server options is explained in the corresponding page.

Google Drive fields

If Google Drive has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • url

  • username

  • password

  • connstring

  • proxy

Information on these specific Google Drive options is explained in the corresponding page.

Outlook fields

If Outlook has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • auth

  • url

  • username

  • connstring

  • domain

  • proxy

  • path

  • authurl

  • startdate

  • enddate

  • scope

  • share

Information on these specific Outlook options is explained in the corresponding page.

Layout

Label

The label of the controller.

Container width

The width of the container of the controller. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Container height

The height of the container of the controller. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text 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 container of the source control.

Label Css

Additional CSS code used to customize the label of the source control.

Options available when the Source type is Database. The Extensions, File Number Limit, Excel and Add branch token options settings are not available, since they apply only to files.

Sub-section

Option

Description

General

Source type

Select Database from the drop-down list to configure a source stored in a database. The available types are: Database and Filesystem (default).

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.

Set default options

If selected, the Prefix and Suffix fields are displayed, allowing users to specify the prefix and the suffix of the options which will be linked to the controller by default.

Option

Uri

Select from the drop-down list the option, whose characteristics are defined in the Options tab, containing information about the uri of the database.

Uri type

Select the database type, whose options will be displayed underneath this field to be fully configured. The possible values are: SQLite, Oracle, MySQL, SQL Server, PostgreSQL, IBM DB2, IBM DB2 AS400, Azure Synapse Analytics, Impala, Spark, Databricks, Hive, Teradata, OpenText Gupta SQLBase, Microsoft Access, SAP HANA, Snowflake, Amazon Redshift, Generic ODBC Connection. A complete list of the options is available in the Database configuration page. The fields which are displayed below depend on the selected type, and the options which can be selected in each of them are populated with those available in the Options tab.

SQLite fields

If SQLite has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • name

  • driver

  • connstring

Information on these specific SQLite options is explained in the corresponding page.

Oracle fields

If Oracle has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • auth

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific Oracle options is explained in the corresponding page.

MySQL fields

If MySQL has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific MySQL options is explained in the corresponding page.

SQL Server fields

If SQL Server has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • auth

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific SQL Server options is explained in the corresponding page.

PostgreSQL fields

If PostgreSQL has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • auth

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific PostgreSQL options is explained in the corresponding page.

IBM DB2 fields

If IBM DB2 has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific IBM DB2 options is explained in the corresponding page.

IBM DB2 AS400 fields

If IBM DB2 AS400 has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific IBM DB2 AS400 options is explained in the corresponding page.

Azure Synapse Analytics fields

If Azure Synapse Analytics has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • auth

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific Azure Synapse Analytics options is explained in the corresponding page.

Impala fields

If Impala has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • name

  • auth

  • username

  • password

  • schema

  • driver

  • connstring

Information on these specific Impala options is explained in the corresponding page.

Spark fields

If Spark has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific Spark options is explained in the corresponding page.

Databricks fields

If Databricks has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • name

  • authentication

  • password

  • service

  • schema

  • driver

  • connstring

Information on these specific Databricks options is explained in the corresponding page.

Hive fields

If Hive has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific Hive options is explained in the corresponding page.

Teradata fields

If Teradata has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific Teradata options is explained in the corresponding page.

OpenText Gupta SQLBase fields

If OpenText Gupta SQLBase has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific OpenText Gupta SQLBase options is explained in the corresponding page.

Microsoft Access fields

If Microsoft Access has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • name

  • username

  • password

  • driver

  • connstring

Information on these specific Microsoft Access options is explained in the corresponding page.

SAP HANA fields

If SAP HANA has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • auth

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific SAP HANA options is explained in the corresponding page.

Snowflake fields

If Snowflake has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • service

  • name

  • auth

  • username

  • password

  • path

  • schema

  • driver

  • connstring

Information on these specific Snowflake options is explained in the corresponding page.

Amazon Redshift fields

If Amazon Redshift has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • name

  • auth

  • username

  • password

  • schema

  • driver

  • connstring

Information on these specific Amazon Redshift options is explained in the corresponding page.

Generic ODBC Connection fields

If Generic ODBC Connection has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • host

  • port

  • auth

  • username

  • password

  • name

  • schema

  • driver

  • connstring

Information on these specific Generic ODBC options is explained in the corresponding page.

Layout

Label

The label of the controller.

Container width

The width of the container of the controller. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Container height

The height of the container of the controller. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text 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 container of the source control.

Label Css

Additional CSS code used to customize the label of the source control.

The AI Model source control selects an AI service, or the connection to it, which will be used by the component.

Sub-section

Option

Description

General

Set default options

If selected, the Prefix and Suffix fields are displayed, allowing users to specify the prefix and the suffix of the options which will be linked to the controller by default.

Option

Uri

Select from the drop-down list the option, whose characteristics are defined in the Options tab, containing information about the uri of the AI service.

Uri type

Select the AI provider, whose options will be displayed underneath this field to be fully configured. The possible values are: OpenAI, Claude, Azure, Google Gemini, Amazon Bedrock, Vertex AI, Hugging Face, Perplexity, Ollama. A complete list of the options is available in the AI Model configuration page. The fields which are displayed below depend on the selected provider, and the options which can be selected in each of them are populated with those available in the Options tab. The Temperature, Max tokens, Max Retries and Timeout fields are shared among several providers and are described in the common connection parameters section.

OpenAI fields

If OpenAI has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • API Key

  • LLM Model

  • Temperature

  • Max tokens

  • Max Retries

  • Timeout

  • Endpoint

  • Organization ID

  • Embedding Model

Information on these specific OpenAI options is explained in the corresponding page.

Claude fields

If Claude has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • API Key

  • LLM Model

  • Temperature

  • Max tokens

  • Max Retries

  • Timeout

  • Endpoint

  • Protocol

Information on these specific Claude options is explained in the corresponding page.

Azure fields

If Azure has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • Endpoint

  • LLM Model

  • LLM Version

  • API Key

  • Temperature

  • Max tokens

  • Max Retries

  • Timeout

  • Embedding Model

  • Embedding Version

Information on these specific Azure options is explained in the corresponding page.

Google Gemini fields

If Google Gemini has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • API Key

  • LLM Model

  • Temperature

  • Max tokens

  • Max Retries

  • Timeout

  • Embedding Model

Information on these specific Google Gemini options is explained in the corresponding page.

Amazon Bedrock fields

If Amazon Bedrock has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • Secret Access Key

  • Access Key ID

  • LLM Model

  • Region

  • Session Token

  • Temperature

  • Max tokens

  • Max Retries

  • Timeout

  • Embedding Model

Information on these specific Amazon Bedrock options is explained in the corresponding page.

Vertex AI fields

If Vertex AI has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • API Key

  • LLM Model

  • Project

  • Temperature

  • Max tokens

  • Max Retries

  • Timeout

  • Location

  • Embedding Model

Information on these specific Vertex AI options is explained in the corresponding page.

Hugging Face fields

If Hugging Face has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • API Key

  • LLM Model

  • Provider

  • Temperature

  • Max tokens

  • Embedding Model

Information on these specific Hugging Face options is explained in the corresponding page.

Perplexity fields

If Perplexity has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • API Key

  • LLM Model

  • Max Retries

  • Timeout

  • Temperature

  • Max tokens

  • Search Mode

  • Search Recency Filter

  • Protocol

Information on these specific Perplexity options is explained in the corresponding page.

Ollama fields

If Ollama has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • LLM Model

  • Temperature

  • Max tokens

  • Endpoint

  • Embedding Model

Information on these specific Ollama options is explained in the corresponding page.

Layout

Label

The label of the controller.

Container width

The width of the container of the controller. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Container height

The height of the container of the controller. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text 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 container of the AI model source control.

Label Css

Additional CSS code used to customize the label of the AI model source control.

The Repository control selects a source which is stored in a repository.

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.

Set default options

If selected, the Prefix and Suffix fields are displayed, allowing users to specify the prefix and the suffix of the options which will be linked to the controller by default.

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.

Folder name

Select from the drop-down list the option, whose characteristics are defined in the Options tab, containing the name of the folder stored in the repository. This option is available only if Show folder name has been selected.

File name

Select from the drop-down list the option, whose characteristics are defined in the Options tab, containing the name of the file stored in the repository. This option is available only if Show file name has been selected.

Uri type

Select the repository type, whose options will be displayed underneath this field to be fully configured. The only value available is Git, which supports any Git repository distribution. A complete list of the options is available in the Repository configuration page. The fields which are displayed below depend on the selected type, and the options which can be selected in each of them are populated with those available in the Options tab.

Git fields

If Git has been selected, select from the drop-down list, for each of the following fields, the option, whose characteristics are defined in the Options tab, defining it:

  • repository, the url location of the Git repository

  • username, the username (or the access token) used to authenticate towards the Git repository

  • password, the password used to authenticate towards the Git repository

  • mail, the mail used in the commit messages to complete the author information required by Git

Information on these specific Git options is explained in the corresponding page.

Layout

Label

The label of the controller.

Container width

The width of the container of the controller. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Container height

The height of the container of the controller. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text 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 container of the repository control.

Label Css

Additional CSS code used to customize the label of the repository control.

The Code field is an editor for entering code or code-like text.

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.

Language

The identifier of the language supported in 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.

Container width

The width of the container of the code field. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Container height

The height of the container of the code field. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text of the label.

Ellipsis

If selected, the label exceeding the space available is cut and replaced by an ellipsis (…).

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 container of the code field.

Label Css

Additional CSS code used to customize the label of 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 component layout. Browse the tabs below to know more about the available options for each controller of this group.

Some of these controllers need a list of values, which can be defined in two different ways, depending on the selected mode:

  • the Table mode, where users manually write the Label and the Value of each element of the list.

  • the Metadata mode, where the list of label-value pairs is not written by users, but it is built when the form is used, evaluating the selected metadata, which are filled with the distinct values of the selected table.

The Combobox is a drop-down list which allows users to choose one value among those available.

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.

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.

  • If Table has been chosen, users write the Label (the name displayed on the controller, to which a field is associated) and its Value (the value associated with the linked option). More label-value pairs can be added by clicking on the plus button.

  • If Metadata has been chosen, users select from the drop-down list the Type and the Subtype of metadata which will be used to define the values.

Layout

Label

The label of the combobox.

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.

Combobox width

The width (in pixels) of the combobox in the form.

Container width

The width of the container of the combobox. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field.

Autocomplete

If selected, users can type in the combobox to filter the available values.

Insert new values

If selected, users can insert values which are not included in the list. This option is available only if Autocomplete has been selected.

Font family

Users can select from the drop-down list the font type of the label.

Font size

The size of the label.

Text transform

The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase.

Label color

The color of the text 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 combobox.

Container Css

Additional CSS code used to customize the container of the combobox.

Label Css

Additional CSS code used to customize the label of the combobox.

The Values autocomplete is an autocomplete field, populated by a configurable set of values.

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.

Values

In this table, users can choose two different value modes: the Table or the Metadata mode.

  • If Table has been chosen, users write the Label (the name displayed on the controller, to which a field is associated) and its Value (the value associated with the linked option). More label-value pairs can be added by clicking on the plus button, and existing ones can be edited or removed.

  • If Metadata has been chosen, users select from the drop-down list the Type and the Subtype of metadata which will be used to define the values.

Layout

Label

The label of the values autocomplete controller.

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.

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.

The Radio buttons is a single-choice control, which presents its alternatives as radio buttons.

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.

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.

  • If Table has been chosen, users write the Label (the name displayed on the controller, to which a field is associated) and its Value (the value associated with the linked option). More label-value pairs can be added by clicking on the plus button.

  • If Metadata has been chosen, users select from the drop-down list the Type and the Subtype of metadata which will be used to define the values.

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. This option is available only if Row has been selected as the Group direction.

Option height

The height (in pixels) of the values of the radio button displayed on the stage. This option is available only if Row has been selected as the Group direction.

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.

The General item list is a list of selectable label-value pairs.

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.

Items

In this table, users can choose two different value modes: the Table or the Metadata mode.

  • If Table has been chosen, users write the Label (the name displayed on the controller, to which a field is associated) and its Value (the value associated with the linked option). More label-value pairs can be added by clicking on the plus button, and existing ones can be edited or removed.

  • If Metadata has been chosen, users select from the drop-down list the Type and the Subtype of metadata which will be used to define the values.

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.

The Structure list is a selector for one or more of the structures which are available in the task.

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.

Supported structures

Select the structures which will be supported by the controller and which will be shown in the structure picker. The available structures are:

  • Dataset

  • Results

  • Clusters

  • Cluster labels

  • Monitor

  • Frequent Itemsets

  • Rare itemsets

  • Association rules

  • Frequent sequences

  • Auto regressive models

  • Discretization cutoffs

  • Fill missing

  • Models

  • Pca eigenvectors

  • Rules

  • Apply

  • Relevances

  • Global

  • Branch variables

Layout

Label

The label of the list.

Option width

The width of the list. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number 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 list.

The Coefficient list displays or edits the coefficient values which are associated with an option.

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.

Formula for outputs

Type the formula which will be used to calculate the outputs displayed in the list.

Formula for output values

Type the formula which will be used to calculate the values of the outputs displayed in the list.

Output suffix label

The suffix which is added to the label of the outputs. This option is available only if a formula has been specified in the Formula for outputs field.

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.

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.

The Multi index configures a multi-level index, defined by a number of layers and by a number of elements.

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 container of the multi index.

The Char list is a character-list selector.

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 component layout. Browse the tabs below to know more about the available options for each Attribute controller.

Most of these controllers need a Source structure, that is the structure from which the attributes come from. In tasks, it can be selected from the drop-down list among the structures which are available in the task, which are the table names stored in the Datasets tab; in the other types of form, the name of the structure can be typed.

The Attribute list shows the attributes of a selected source structure.

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.

Draggable

If selected (default), it will be possible to drag the attributes contained in the Attribute List to another controller.

Source structure

Specify the source from which data come from.

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).

Highlight results

If selected, the attributes which have been generated as results by tasks are highlighted in the list. This option is available only if All or Results has been selected in the Filter by category field.

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.

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 the Order value.

Css

Additional CSS code used to customize the list.

The Attribute combobox selects an attribute through a drop-down list.

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.

Source structure

Specify the source from which data come from.

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, currency. 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).

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 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 the Order value.

Css

Additional CSS code used to customize the controller.

The Attribute drop zone is a drop target for adding attributes to the configuration of a task.

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.

Source structure

Specify the source from which data come from.

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, currency. 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 drop zone 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).

Layout

Label

The label of the drop zone.

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 the Order value.

Css

Additional CSS code used to customize the controller.

The Attribute filter selects the source structure on which an attribute-filtering operation is performed.

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.

Source structure

Specify the source from which data come from.

Layout

Label

The label of the attribute filter.

Label width

The width (in percentage or in pixels) of the label.

Option width

The width (in percentage or in pixels) of the attribute filter.

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 the Order value.

Css

Additional CSS code used to customize the controller.

The Split data configures how the data are split into training, test and validation sets.

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.

Formula for absolute value

Type the formula which will be used to calculate the absolute value.

Source structure

Specify the source from which data come from.

Layout

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.

The Relation manager configures the relations between two lists, or between the two sides of a relation.

Sub-section

Option

Description

Option

List type

The type of the list. The possible values are Droppable and Undroppable. Depending on the type of form, the available list types may be limited.

Single table

If selected, the relations are managed using a single table.

Option

Select from the drop-down list the option, among those available in the Options tab, which will be linked to the relation manager. This option is available only if Undroppable has been selected as the List type.

Left option

Select from the drop-down list the option, among those available in the Options tab, which will be linked to the left side of the relation manager. This option is available only if Droppable has been selected as the List type.

Right option

Select from the drop-down list the option, among those available in the Options tab, which will be linked to the right side of the relation manager. This option is available only if Droppable has been selected as the List type.

Edit match

If selected, users can edit the matches which have been created between the two sides of the relation manager. This option is available only if Droppable has been selected as the List type.

Source structure

Specify the source from which data come from. This option is available only if Droppable has been selected as the List type.

Left list

Select whether the list displayed on the left of the relation manager will be built manually using a Table of values or Metadata. This option is available only if Undroppable has been selected as the List type.

  • If a Table is chosen, users must manually build a table, containing Label - Value pairs, where the Label is the name displayed on the interface and on the list, while the Value will be used to modify the Option. New label-value pairs can be added by clicking Add new row, and existing ones can be edited or removed.

  • If Metadata is used, users must specify the Table (which has to be one of the tables stored in the Datasets tab) and an Attribute belonging to that Table, from which the values will be taken. The list will automatically be filled with the corresponding attribute’s values.

Right list

Select whether the list displayed on the right of the relation manager will be built manually using a Table of values or Metadata. This option is available only if Undroppable has been selected as the List type.

  • If a Table is chosen, users must manually build a table, containing Label - Value pairs, where the Label is the name displayed on the interface and on the list, while the Value will be used to modify the Option. New label-value pairs can be added by clicking Add new row, and existing ones can be edited or removed.

  • If Metadata is used, users must specify the Table (which has to be one of the tables stored in the Datasets tab) and an Attribute belonging to that Table, from which the values will be taken. The list will automatically be filled with the corresponding attribute’s values.

Layout

Label

The label of the relation manager.

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 the Order value.

Css

Additional CSS code used to customize the controller.