Form Left Panel Tabs¶
The vertical tabs on the left side of the stage provide panels which allow performing general operations on the current form.
The left panel consists of five tabs, each enabling the user to perform different operations on the form, such as adding and editing options or connections which will be subsequently used through the components of the form, edit the general characteristics and visualize a list of the Components used in the current form.
The available tabs are:
Summary Tab¶
The Summary tab displays all the general characteristics of the form.
Depending on the form type, the Summary is filled with different features. To edit it, click on the pencil icon located in the top-right corner of the tab, so that the Edit form window opens.
Browse the tabs below to see which options can be edited for the mask and task form types:
Subsection |
Option |
Description |
|---|---|---|
Title |
Enable parametric mask |
If selected, the mask supports parametric options, too. |
Show title |
If selected (default), the title of the mask, written in the Title field, is displayed. |
|
Title |
The title of the mask. |
|
Title color |
It defines the title’s color. By clicking on the color, which is white by default, a popup opens, where Standard colors can be used, as well as Rgb, Hex, Hsl and Hsv colors and generated color palettes. |
|
Title background color |
It defines the title’s background color, which is the stripe located on top of the mask. By clicking on the color, which is blue by default, a popup opens, where Standard colors can be used, as well as Rgb, Hex, Hsl and Hsv colors and generated color palettes. |
|
Width |
Width (px) |
It defines the width of the mask window in pixel. The default value is set at 750 px. |
Min width (-1 means no min) |
It defines the minimum width in pixel for the mask panel, which means that during the mask window resizing, the width of the mask won’t be lower than this value. The default value is -1, which means there’s no limit to width resizing of the mask window. |
|
Max width (-1 means no max) |
It defines the maximum width in pixel for the mask panel, which means that during the mask window resizing, the width of the mask won’t be higher than this value. The default value is -1, which means there’s no limit to width resizing of the mask window. |
|
Height |
Height (px) |
It defines the height of the mask window in pixel. The default value is set at 600 px. |
Min height (-1 means no min) |
It defines the minimum height in pixel for the mask panel, which means that during the mask window resizing, the height of the mask won’t be lower than this value. The default value is -1, which means there’s no limit to height resizing of the mask window. |
GENERAL INFORMATION
Subsection |
Option |
Description |
|---|---|---|
Label |
Type the label of the task, which will be visualized on Rulex Factory stage once the task has been dragged onto it. When the task will be dragged onto Rulex Factory stage, a numeral suffix will be added to it. |
|
Display |
Type the name of the task, which will be displayed in Rulex Factory’s task list in the Tasks right panel. |
|
Version |
Type the version of the task. |
|
Icon |
Upload an icon for the task, which will be visualized on the stage and in the Tasks right panel. By clicking it, users can upload an icon present on their local machine in SVG or PNG formats. |
|
Background |
The background color for the icon. By clicking it, users can select Standard colors and generated color palettes, otherwise they can use the color picker or insert the color code, which can be: Hex, Rgb, Hsl, Hsv. The default color is black. |
COMPUTATION INFO
Subsection |
Option |
Description |
|---|---|---|
Compute options |
Compute type |
Select the computation type of the task. Basically, it defines the type of content in the file that must be uploaded in the Select a zipped file. The possible values are: |
Is computable |
If selected (default), the task can be computed in Rulex Factory. |
|
Import file |
By default, it is grayed out, and this checkbox activates only when the Export file one is not selected. If selected, the task can import files within the flow. |
|
Add options with list of parent task |
If selected, the option parent_list is added to the task interface, containing a list of the available parent task within the flow where the generated task will be used. |
|
Source |
If selected, the task can have sources, so it can receive data from another task in the flow. |
|
Export file |
If selected (default), the task exports data to the local machine. |
|
Structures |
Select the supported data structures. The possible values are: dataset (default), results, clusters, clusttabs, monitor, frequentitemsets, rareitemsets, associationrules, bundlehypotheses, replacementrules, frequentsequences, autoregressive, cutoff, fillmiss, branchvariable. |
|
Select a zipped file |
source type |
In this area, select the type of the source which contains the zip file required to run the task. The possible values are Filesystem or Repository. |
Output file |
Select the location where the zip file is stored. More information on the location controller can be found in the corresponding page in Rulex Factory documentation. |
|
Files |
Type the path of the filesystem folder where the zip file is stored. Alternatively, users can click on the SELECT button and browse manually to the folder. |
|
Main file |
Type the name of the main file of the zip folder. Make sure that the file extension is written, too. |
|
Main function |
Based on the type of computation performed (Gold or Python), type the function contained in the main file which will perform the computation. This option is available only if the Compute type value is Gold or Python. |
Options Tab¶
The Options tab contains a list of the options available, which can be associated to controllers in forms.
Options are values definitions which contain specific information on their characteristics and on their default values.
Depending on the form type, this tab allows users to add, delete or modify the options it contains.
Warning
If the form type is task, the Options tab is automatically filled with the variables contained in the ZIP file uploaded in the Summary. In this case, users can only modify the existing options. If the form type is mask, the Options tab is empty, and users can add, delete or modify all the available options.
Users can edit options by clicking on the pencil icon located in the top-right corner of the tab, so that the Options edit window opens: depending on the form type, different characteristics are available.
Browse the tabs below to see which fields are available in the Options window for each form type.
Option |
Description |
|---|---|
Name |
The name of the option, which will be displayed in the Option drop-down list in the controllers layout menu. It cannot be modified. |
Default |
The default value of the option, enclosed in |
Description |
The description of the option, which will be displayed in the tooltip when hovering over the associated controller on the form. |
Required |
If selected, it will be mandatory to specify the option on the corresponding controller. |
Ignore value |
If selected, the new value which has been inserted in the Default field will be ignored in the associated controller. |
Sensitive |
If selected, the value is considered sensitive. |
Option |
Description |
|---|---|
Name |
The name of the option, which will be displayed in the Option drop-down list in the controllers layout menu. It cannot be modified. |
Default |
The default value of the option, enclosed in |
Description |
The description of the option, which will be displayed in the tooltip when hovering over the associated controller on the form. |
To save the modifications to the Options tab, click SAVE. To close the window without saving any change, click DISCARD.
It is possible to use options by setting them in the component’s layout menu in the corresponding Options field, or they can be dragged onto controllers. The same option can be associated to multiple controllers.
Once an option has been modified, meaning its value has been overwritten using the settings in the window, its row turns blue. The row also turns blue if the option has been assigned to a controller.
Graphics Tab¶
The Graphics tab displays a list of all the components used in the current form. This tab is dynamic, meaning that it automatically populates with a tree structure every time a component is added to or deleted from the stage.
Trees can be built only if other components are inserted within an organizer. An arrow appears next to the organizer, which allows opening the tree and visualize a list of the other components within the organizer. Components are displayed following their dragging order, if no value has been specified in the Order field in the components layout menu, otherwise they follow the specified order.
A magnifier icon is available in the top-right corner of the tab to search among the components the desired one.
In this tab, it is possible to interact with the components by right-clicking on them, so that the context menu opens.
In the Graphics context menu, the following options are available:
Open component layout: it opens the component’s layout menu.
Rename: it allows renaming the selected component.
Copy: it copies the selected component.
Paste: it pastes the selected component.
Delete: it deletes the selected component.
Connections Tab¶
In the Connections tab, it is possible to visualize and edit the connections which will be used in the components on the form.
To add and set up new connections, click on the pencil icon located in the top-right corner of the tab to open the Connections Manager.
More details on how to work in the Connections Manager are provided in the corresponding page.