Discovering Designer Forms¶
Forms are the primary resources in Rulex Designer.
A form is a canvas where users can build a UI, and then enabling them to insert data and send it to a backend. It is designed for human interaction, where user actions dynamically update the values associated to each component, either Rulex Factory or Rulex Studio.
Forms change in their structure and characteristics according to the component they will be integrated to.
Forms which will be integrated in Rulex Factory are tasks containing repetitive operations. For example, a task form sending email alerts can be configured only once, and a graphical interface which standardizes this procedure is displayed.
Forms which will be integrated in Rulex Studio contain a template of data input in a graphical format. For each mask in Rulex Studio, the graphical template generated through Rulex Designer is imported.
As previously said, forms are generated to be integrated in Rulex Factory or in Rulex Studio, and to do so, users can choose the Type of the form when creating it from the Explorer:
Task, if the form will be used in Rulex Factory, generating a new task.
Mask, if the form will be used in Rulex Studio, more specifically in Compute flow and Open modal window events.
More specifically, in a task form developers must specify its computation type, the family, and the icon. Then, they must choose the backend type and upload it. These operations can be done graphically through the Summary, located in the left panel, and are explained in detail in the corresponding page.
On the other hand, in a mask form developers define the dimensions of the mask, the components within it and the options which will be associated to the corresponding components.
Forms share the general features described in the Exploring Rulex Platform section with the other Rulex Platform components’ primary resources, apart from the Variables, which are not available for forms.
Here’s a sum-up of the available features:
A set of permissions can be defined to manage the resource itself.
Versioning operations can also be performed on forms.
To create a new form, follow the procedure below:
Procedure
Click the Explore resources icon to open the Explorer pane.
Hover over the Plus button.
Select Create Form.
Enter a unique name for the form in the Form name field.
Select from the Form type drop-down list the type of the form, which can be Mask (default) or Task.
Press Enter or click Create.
See also
In the Explorer, the form type is identified by the icon’s shape and color, indicating the component where the resource can be used:
A mask has a blue icon (as it will be used in Rulex Studio), containing a small view icon in the bottom-right corner.
A task has a green icon (as it will be used in Rulex Factory), containing a small task icon in the bottom-right corner.
Once the form has been created, it will be automatically opened onto the stage window to modify its internal structure. All the generated forms can be visualized in the Explorer pane, and organized into environments, inheriting their specific features. If the Form filter located in the top right side of the Explorer is switched on, only the forms and the environments within the current environment will be displayed in the Explorer. The internal properties of a form are controlled by a unique user interface called stage, whose features and options vary according to the chosen form type.
To open an already generated form, navigate through the Explorer, open the environment the form belongs to, and click on the form, so that the form stage opens. If the View permission for a form is set to ALLOW, then the user can open it.
Note
The form path is the path of the form within the environment. The format of the path is /RulexDesktop/Env_username/formname.
Form Status¶
When a form is opened on the stage, its use is limited to a single user. The access for all the other users is prevented, or it is limited to read-only operations. In particular:
When a user opens a form through the GUI, then any other concurrent access is locked. In the Explorer pane, a lock icon next to the form entry line communicates to other users that the form cannot be opened.
Other status icons located next to the form entry line in the Explorer are used to show the versioning status of the considered resource. Refer to the versioning general overview for more information.
Status |
Icon |
Description |
|---|---|---|
Locked |
The form is already opened through Rulex Platform GUI by another user, and it can not be accessed. |
|
Dirty |
|
The form contains local modifications which are not pushed on the remote version. |
Versioned |
|
The form is versioned. No local modifications are present with respect to the last pull operation. |
Important
In this section the term user refers to user session. This means that a form cannot be opened simultaneously by the same physical user on two different devices.
Importing Forms¶
Instead of creating forms from scratch, you can also import them into Rulex Designer. This is useful when you want to work on forms that have been previously created by other users on different machines.
The import process is very easy and user-friendly, but you must have the Create permission set to ALLOW on the selected environment.
In Rulex Designer you can import files in .rfm format, which are forms exported from Rulex Designer.
Open the environment where you want to import your form, click on the plus button at the bottom right-side of the Explorer panel, select Import Form, and the Import Form pane opens, allowing specific configuration options for the current import process.
Forms can be imported from two different sources:
Filesystem, local or remote, containing a form in one of the supported file formats.
Repository, where a remote version of the form file representation is selected and cloned into the system.
Once the connection to the filesystem has been established, the user needs to insert the desired connection to be used, which could be Saved or Custom, as well as the relative path to the imported form file.
Once the connection to the repository has been created, you need to provide the unique hash name associated to the desired remote form to be imported and an optional tag name, if the user does not want to import the latest version.
In the Import Form panel, once the form has been selected, users can configure the Desired Form Name: in case of single importation users can define the name of the form once it has been imported in the environment through their context menu in the Explorer. If more than one file is imported, the name will be automatically assigned by the system.
To import a form in a selected environment users can follow the steps below:
Procedure
Click the Explore resources icon to open the Explorer pane.
Hover over the Plus icon.
Select Import Form.
Select if you want to import the form from a Filesystem or from a Repository.
If you have chosen Filesystem:
In the SOURCE slider, select whether the imported form is coming from a previously saved location, or from a custom location you are going to specify following the instructions at this page.
Click the SELECT button and browse to the location of the form file you want to import.
If you have chosen Repository, provide the hash name and eventually the tag name of the desired form versioned remotely.
Enter a new name for the flow, if required, in the Insert desired form name text box.
Click Import to complete the import operation.
Exporting Forms¶
If you want to save a copy of your form to send it to other users or to store it, you can export an entire form in RFM format.
This exported file can then be imported on any machine where Rulex Platform is installed.
To export a form, users have at their disposal the Export Form panel, which can be opened from the Explorer context menu or directly from the toolbar for the currently opened form.
Exporting operations can be performed both to Local filesystem (i.e. your machine disk) or to any supported Remote filesystem. To configure the selected destination, you need to insert the desired connection you want to use (more information about Filesystem connection configuration available at this link), which could be Saved or Custom, as well as the relative path of the destination folder.
Other important options you can configure from the Export Form panel are:
Desired file name: the base name of the file you want to create (if empty, the form name will be used).
Additional options: it defines which additional information related to the exported form needs to be included in the final file. It accepts only Variables.
Export options: it defines the following general export options:
Add current date and time as prefix: it adds a timestamp prefix to the file name produced.
Add current date and time as suffix: it adds a timestamp suffix to the file name produced.
Add the last tag if the mask has been versioned: it adds the tag name (if present in the latest commit) as suffix to the file name produced.
Export externally used resources (share permissions on external resources are required): it converts all Saved connections to Custom connections before exporting the file.
To export a form, the following prerequisites must be satisfied:
Prerequisites
You must have created an environment.
You must have a form within your environment, and have the Share permissions set to ALLOW.
Then, follow the steps below:
Procedure
Click on the Explore Resources icon to open the Explorer panel.
Select the form(s) you want to export.
Right-click on the form you want to export or click on the three-dotted icon next to it.
Click Export.
From the DESTINATION slider, select whether the exported form should be sent to a previously saved location, or to a custom location you are going to specify following the instructions at this page.
Choose from the DESTINATION drop-down list if you want to export the form to your computer or to a remote connection (see filesystem description). If you are exporting to a remote connection, choose it from the list and then click on the pencil button to set the connection information required.
Click the SELECT button and browse to the location of the folder where you want to export the form.
Write the file name in the Insert the desired file name edit box, define the Additional options and the Export options according to the description above.
Click Export. When the progress bar reaches 100%, your exported form will be saved in the specified location.