The FSM product allows to manage Data Collection, providing a series of features in dynamic forms to set in order to collect organized information. They may be related to activities, events or situations that may occur throughout the working day.
To define a data collection in FSM, the dynamic form templates shall be configured first.
Dynamic Form Templates:
Templates form can be recalled from the menu entry at this path: Main menu > Data collection > Templates.
The window displays:
-
a Table section where dynamic form templates are listed.
-
a Filters panel on the right side to search for templates.
Dynamic Form Template’s List:
In the table the user can access to all the previously created templates.
For each Template there are this available information:
-
Id: unique internal identifier, automatically assigned by the system at creation;
-
Code: code of the template, code must be unique in the system. Mandatory information;
-
Description: name assigned to the dynamic form template. Mandatory information;
-
Note: user text notes regarding the template. Optional information;
-
Active: indicates whether the model is currently active, or it has been disabled;
-
Form Mobile Generable: indicates whether the model can be used to create new form on fields (on demand);
-
Type: indicates the group to which belongs the template, used to document and organize the template in different categories (business, units, areas). This is an optional information;
-
Creation Date: date and time of dynamic form template. This is an automatically information managed by the system;
-
Creation Users: related to the user who created the dynamic form template which is automatically managed by the system.
-
Last Modified Date: date and time when the last update to dynamic form template occurs. Information is automatically managed by the system;
-
Last Modified Users: related to the user who made the last update to the dynamic form template. Information is automatically managed by the system
On the top of the Templates’ table is displayed:
-
Rearrange columns icon
-
Three dots menu icon
-
New Template icon
Table operations
Rearrange columns icon: the user can access to all the available columns and re-arrange their order in the table, through the show/hide and the how to option.
Three dots menu icon: From this menu the user can access to the following operations:
-
New Template. See next New Icon.
-
Import Template: allows importing a template.
New icon: the user can create a new Template which asks to the user for the Description of the Dynamic Form Template.
Refresh icon: the user can update the items shown in the tables and retrieving information, according to the filter criteria currently set.
Press Save button to confirm and create the template.
Press Cancel to abort the operation.
The user can confirm all the information previously inserted and create a new template, which contains the following information:
-
ID;
-
Code;
-
Description (multi-language field);
-
Note;
-
Type;
-
Active;
-
Form Mobile Generable;
-
Creation date;
-
Creation user;
-
Last modified date;
-
Last modified user;
-
Scope;
-
Type.
The following fields such as: code, description, note, active, form mobile generable (scope and type reflect user choices), creation date, creation user, last modified date and last modified user, are automatically defined by FSM, in accordance with their meaning.
Please note that Scope and Type information belong to its structure and not to the template itself, so these can be changed in scope or type for further releases.
When the user creates a New Template, the newly created template is initialized with a “Template structure”.
After its creation the user proceeds with the construction of the tree-structure (tree-folder pattern) and insert the nodes that will be used by the field operator to collect information. The user can do this, by clicking on the template which redirects the user to the “Template Detail” view.
The “Template Detail” view is described next in this page.
Filter Panel
The filter panel is organized into sections called:
-
“Dynamic Form Templates”;
-
“Current Dynamic Form Template Release”
Dynamic Form Templates section: the user can use more than one of the following searching criteria:
-
Code;
-
Description;
-
Creation Date;
-
Creation Users (you can select a set of users);
-
Last Modified Date;
-
Last Modified Users (you can select a set of users);
-
Active (three state: Yes, No, All);
-
Form Mobile Generable (three state: Yes, No, All);
-
Current Data Collection Template Release: this section allows the user to set criteria that can vary in different dynamic form’s releases (please note that only the selected one, is stored in the search’s view).
The user can also use more than one of the following searching criteria:
-
Scopes (select a set of Scopes);
-
Types (select a set of Types);
-
Outcome reasons.
Row operations:
For each item in the “Dynamic Form Template Structures list’’, there is a three dots row menu, (available on the left side) containing the following operations:
-
Edit: the user can edit\modify or update the template header (if required);
-
View Detail: the user can access to the templates’ details as its Draft and Published versions;
-
Create Form From Template: it’s possible to create a new dynamic form using the selected template Structure.
-
Timeline of Active Release: the user can view all active releases on the time bar in a chronological order.
Create Form from Template
Using the template structure selected, the user can create a new form.
Through the “New Form dialog” function, the system allows the user to perform further operation of the selected task:
-
viewing the Data Collection Template while its creation.
-
Choose\select the Operation Center which is responsible for the form. This is a mandatory field.
-
Description of the form: the user can maintain the acquired data from the template name or change it.
-
Scope is based on data, collected from the current template structure and assigned to the form. The scope is a mandatory information which can also take one of these values:
-
“WO Operation”: dynamic form may be used with a WO operation;
-
“Scheduling resource”: dynamic form may be assigned to a scheduling resource;
-
“WO operation or Scheduling resource”: dynamic form may be used with a WO operation or may be assigned to an interchangeably scheduling resource.
-
-
Type of the form, is another based collected data from template which is visible to the user as a review.
It is also important to specify that the form is created by using the current published release for the template.
The system considers just the published and active releases, so the starting date identifies the current and valid one.
If there is not a valid published version yet, the form cannot be created, and the system notifies it to the user through a warning message.
Here’s a list of few “Demo” templates’ examples:
The template “Demo” does have these published and active releases:
-
Published “Demo, version 1“starting date on 1/1/2020
-
Published “Demo, version 2” starting date on 1/1/2022
-
Published “Demo, version 3“ starting date on 1/1/2023
On date June, 13th 2022 a new form from template “Demo” was created: the dynamic form was created by using the current valid published release: “Demo, version 2”.
Using the selected template, it’s possible to confirm and create a new form and confirm it through the “Save” button
To abort the operation press “Cancel” button.
After inserted all information, a new form is created, and the form ID is sent back to the user.
Edit tab:
The user can edit all the information regarding template header.
The system shows also the “Edit Template” (dialog panel attached below)from where it’s possible to change and later save the updated information.
View Detail tab:
Through this action, the user can access to all the previous created versions of the template.
All the selected item from the menu of Dynamic Form Template Detail form, can be displayed to the user.
Dynamic form Template Detail is further detailed in the next paragraph.
Dynamic Form Template Detail:
By clicking on a dynamic form templates from the list, the user can access to a more detailed information form, such as working copy and published releases.
The Detail view is divided in two sections:
-
Header, data section;
-
Dynamic Form Template Structures’ table
Header
The header area shows general information about the dynamic form Template, such as:
-
Id;
-
Code;
-
Description
-
Creation Date;
-
Creation User;
-
Last Modified Date;
-
Last Modified User;
-
Active;
-
Form Mobile Generable;
-
Notes.
List tab:
In the Dynamic Form Template Structures List, the user can access to:
-
ID: a unique id, sequentially created and assigned by FSM to the Template structure;
-
Scope: assigned to the template when created. (e.g: each different Template Structure has its own);
· Type: assigned to the template when created. (e.g: each different Template Structure has its own);
-
Start date: it’s the valid date for the release. This is an important information because it is used by the system, to identify the currently valid release. The user can define versions, by inserting a past or future starting date.
To ensure that, at least one valid and active version is present at any time, the system automatically checks that duplicates weren't creating during the process. This is a mandatory information.
-
Release: it’s related to the Dynamic Form Template Structure’s release information. This is also important because it indicates if the Dynamic Form Template Structure is released (i.e., published, flag release checked) or is a working copy (flag release not checked), used for further unpublished changes.
-
Active: this information represents active or inactive status of a release(if it should be considered in the process for identifying the current version);
-
Sequence Number: it’s a progressive sequence id number form FSM, which uniquely identify the release (working copy does not have any sequence number);
In the next following paragraphs, we are going to deeply investigate the concept of “working copy” and “released version”.
Released version
|
|
A dynamic form structure in a “Release” flag checked is a released version or shortly a “release”.
A release structure can be used to create forms, but no longer able to be modified. It can also be opened and modifiable only when it’s in a ‘’read only’’ mode.
Only Releases can be used to generate dynamic form by using the template; this important aspect assures that all forms created by using that released version, are setting as the same fields and validations’ rules (harmonious values in the collected data)
For each template it’s possible to create multiple releases:
-
releases used in the past and no longer active;
-
a currently active release;
-
releases for future purpose.
Each release has its “Starting Date” which can be used to create new forms. Only one active release is considered “the current active release” in a precisely moment.
Working Copy
A Dynamic Form Structure in a not-verified “Release” flag, is considered as a draft or shortly a “Working Copy”.
A working copy can be edited but it can’t be used to create a new form because it’s in a ‘progress status’. When the working copy is completed and the user recalls the “Release” operation, a new mirror copy is created: this is a released version from the working copy.
Working copy can’t be used to create dynamic forms from Template. It is an unpublished and temporarily draft, used to make changes.
The working copy is unique, and only one working copy for each model, can exist at time.
The Data Collection Template Structure area, contains the list of the Template Structures, available for the previously selected Dynamic Form Template.
In the figure above, two special templates’ structures can be recognized: the “working copy” -highlighted with the blue dot, and the “current active version” -highlighted with the green dot. The releases - highlighted in gray dots - are considered as “currently not active” because they are “disabled” or referring to a past or future validity period.
Row Operations
By clicking on the desired Data Collection Template, the user can set few different operations, depending on the template and its structure (if it is a Working Copy or a Release).
The Template’ Structure is considered as a Working Copy; on the left side is also available a “three dots menu” containing the following operations:
-
View Detail: the user can view the details of the template: it can be in a Draft or still in a work in progress status;
-
Edit Working Copy: It allows to edit\update the template header which is a published Release (if needed);
-
Empty Working Copy: It allows to start over from a blank working copy, in order to create a new template’s structure to use;
-
Outcome Reasons : This option acts differently if used on a working copy or on a release. If the option is invoked on a working copy, the user can assign one or more Outcome Reason. When the working copy is published, all its related information . On the contrary, if the option is invoked on a release, the user can only view it in read-only mode.
If you need further information on this topic see DCS - WO & DC Sheets, chapter “How to get the filling in of a Sheet depending on the Outcome Causal“.
-
Import Model: the user can import the template structure working copy (in JSON format).
Json format can import a definition from one environment to another. Doing so, the user avoids building the structure manually. This operation is available only for the Working Copy (Releases act differently).
-
Download Model: the user can download the definition of the template structure of the working copy (in JSON format). It may be very useful to use it when the user want to export the template structure to reuse later, in a different environment/working copy.
-
Create Release: from the current Working Copy, it’s possible to create a new Release.
About the Template Structure (considered as a Release), on the left side is available a “three dots menu” containing the following operations:
-
View Detail: the user can access\view the details of a Published version;
-
Edit Release: edit and update the template header which is considered as a Working Copy (if needed);
-
Align Working Copy with Existing Release: the selected dynamic form template structure is copied into the working copy so the user can start working from any existing template release.
Create Release:
The “New release” option is only available if the Template Structure is a Working Copy (i.e. the “Release” information is not checked).
The user can publish the current working copy by creating a new release by filling the following fields:
-
Start Date: indicates from when the dynamic form release must be considered.
-
Active: tick the “active flag” if the release must be considered while creating new forms, otherwise set it to “Not active” (i.e. suspended releases).
The system checks and prevent from releasing an empty working copy.
Edit Working Copy
The Working copy tab is available on menu, only if the Template Structure is a Working Copy (i.e. the “Release” information is not checked).
The user can edit all the information about the template header of a Working copy.
The “Edit Template” (dialog panel shown in figure) shows the panel used to change the scope or the type and then later save the updated information.
Empty Working Copy
This option is available on menu only if the Template Structure is a Working Copy (i.e. the “Release” information is not checked).
By using this feature, the user can start over, using a blank working copy in order to create a new template structure to use. (i.e. It’s useful for out-of-date contents that need to be totally changed in the working copy).
Edit Release
The “edit release” tab is available on menu only if the Template Structure is a Release (i.e. the “Release” information is checked).
The user can edit all the information about the template header of an existing Release.
The system shows the “Edit Template” (dialog panel shown in figure), from where it’s possible to change and later save, the following information of a selected release:
· the start date;
· the active status;
Please note that by changing the start date or the active status of the release, the user can affect the evaluation of the current active release to be used while the “create new forms from template” operation is invoked.
Align Working Copy to Existing Release:
This operation is available on menu only if the Template Structure is a Working Copy (i.e. the “Release” information is checked).
The selected dynamic forms template structure is copied into the working scope, so the user can start working from an image of any existing template’s release.
It may be also very useful, to realign the current working copy after a long time.
View Detail:
With this option the user can view the selected Template Structure that can be either a working copy or a release.
Once selected the item, the Data Collection Template Detail form is presented to the user.
In the next paragraphs, we are going to investigate the “Data Collection Template Structure Detail”.
Newly created Templates:
When a Dynamic Form Template is newly created, the associated structure is empty. The user must insert the nodes used by the operator’s field to collect information. In this way, the user can proceed with the construction of a tree – model, (refer to a tree- folder pattern) inserting different types of nodes (used by the operator’s field to collect information), by clicking on the template and accessing to the “Template Structure Detail“ view.
The “Template Structure Detail” view is described next in this page.
Dynamic Form Template Structure Detail:
In the Dynamic Form Template Structure Detail, the user can view/modify the tree folder structure used by the field operator, in order to collect information.
The Dynamic Form Template Structure Detail view is organized in three sections:
-
a top-level header data section;
-
a second-level header data section;
-
a third section composed by a table which shows Dynamic Forms Template Structure’s list with all its related information.
Top-level Header:
The top-level header area is a compacted section that shows general information about the Dynamic Form Template such as:
-
Id (template);
-
Type;
-
Code;
-
Description
-
Creation Date;
-
Creation User;
-
Last Modified Date;
-
Last Modified User;
-
Active;
-
Notes.
Second-Level Header:
The second-level header area is another example of compacted section, which shows common information about specific Dynamic Form Template Structure - Working copy or Release.
Header - Working Copy:
Opening the Dynamic Form Template ‘working copy’ through ‘View Detail’ option, the user enters in an additional header section called ‘Data Collection Template Structure’ containing the following details:
-
Structure Id;
-
PDF template;
-
Scope;
-
Type;
-
Release
In a “working copy” form, the release radio button is set by default as un-ticked.
Header – Release:
Through the ‘View Detail’ option, the user can open the Dynamic Form Template of a released version from where it’s possible to access to an additional header section called ‘Dynamic Form Template Structure’ (like the working copy one), containing the following details\functions:
-
Structure Id;
-
PDF template;
-
Scope;
-
Type;
-
Release Id;
-
Description;
-
Start Date;
-
Active;
-
Sequence Number.
In a “release” the release radio button is set by default as un-ticked.
Model:
The third section is about the model.
The model, built-in in a hierarchical structure (tree folder pattern), is used to organize and view the fields to collect on the working field.
Each level is composed of nodes, ready to be collected from the working field and reported into their sections in FSM.
The model section is organized in two different Areas.
From the tree-structure on the left side, the user can browse the nodes and use the row menu to perform operations.
On the right side, the user can see and access to all information of the selected field from the left area and editing it.
Using one of the two command buttons at the bottom of the panel, the user can confirm or cancel any changed made to the node.
Each area’s side can be modified by using the resize bar that divides the two sections.
Left Area, Table operations:
On the top of the Model table there are the following option:
-
Rearrange columns icon
-
Three dots menu icon (only for ‘Working Copy’ templates)
-
New Node icon (only for ‘Working Copy’ templates)
-
Expand All/Collapse All icons
Rearrange columns icon: the user can access to all the available columns and select through the ‘show/hide’ option, on how to rearrange their order in the table.
Three dots menu icon. From this menu user can access to the following operations:
-
New Node. See next New Node Icon.
New node icon: user can create a new Node. While using this feature, a panel will ask to the user for the following information:
-
Description: Name for the node while the user fills the template. The description is mandatory and unique;
-
Code: optional code for the node. If inserted must be unique;
-
Color: used for the node. Orange color is the default color if the user doesn’t choose a different one.
-
Notes: optional free text notes related to the node (i.e. use instruction or guidelines);
-
Tooltip: optional field for define a tooltip for the input object used to insert the node value. Hovering on the field while executing the form will make the tooltip appear. This field is ignored in the mobile app;
-
Placeholder: optional field for define a placeholder text for the nodes that have an input field. The text shows into the input field;
-
Type: type of the node. It’s important because it defines how the input field acts. These can be also selected in different type of nodes:
-
Text
-
Integer Number
-
Decimal Number
-
Yes/No
-
Date/Time
-
Date
-
Time
-
Selection
-
Multi selection
-
Coordinates
-
Barcode
-
Attachment
-
Download Attachment
-
Picture
-
Signature
-
Regular Expression
-
Section
-
Radio
-
Checkbox
-
Multi attachment
-
Matrix
-
Each of these types of nodes is better described later in the document.
-
Computed Node: if verified, it indicates that the field is in a read-only version and it is calculated automatically by the system, according to the formula in the "Computed value" field. By default, the property is un-set;
-
Show on Summary: if set, indicates that the node will be drawn also in the summary panel
-
Visible: if set, it indicates that the field is visible by the user. The property can be adjusted via a logical expression to enable or disable the display of the input field based on a dynamically evaluated logical condition. By default, the property is verified (the input field is intended to be visible on the dynamic form);
-
Read Only: if set, it indicates that the field can’t be edit by the user. The property can be adjusted via a logical expression to enable or disable the edit of the field based on a dynamically evaluated logical condition. By default, the property is unchecked (the input field is intended to be editable on the dynamic form);
-
Mandatory: if set, it indicates that the field must be filled in by the user. The property can be adjusted via a logical expression to enable\disable the mandatory nature of the input field, based on a dynamically evaluated logical condition. By default, the property is unchecked (the input field is intended to be an optional field on the dynamic form);
-
Initial Value: this property is useful to the user to set an initial value for the input field when the dynamic form is created. If inserted, the input value, must respect the type of the node. By default, the property is un-set (the input field does not have any initial value on the dynamic form). Nodes of type such as: “Attachment”, “Barcode”, “Picture”, “Signature” do not have own property.
-
Computed Value: this property can be used only if the node is a “computed node”. In the example here below, the field is not a mandatory one, “read only” field doesn’t have any initial value. Its value is automatically computed by the evaluation of the expression entered in this field.
Please note that after selecting a node’s type, others input fields can appear in the panel (see the next figure where an Input Text type is selected).
These additional fields strictly depend on the type of node selected so for each different type selected, different fields appear.
In the next following chapter “Different Types of Nodes “, we are going to better describe these aspects.
Expand All / Collapse All icons.
In case the template contains nodes under a ‘Section’ node, they can be selected or hidden, by clicking the upward arrow icon (Expand All) or the downward arrow icon (Collapse All).
Row operations
For each item in the table list (on the left side), there is a three dots row menu, containing the following operations:
-
Edit Node;
-
New Node
-
New Child Node
-
New Sibling Node Before;
-
New Sibling Node After;
-
-
New Node from Template (FSM 20.0)
-
New Child Node
-
New Sibling Node Before;
-
New Sibling Node After;
-
-
Delete Node;
-
Duplicate;
-
Cut;
-
Paste.
Edit Node:
The user can edit the selected element from the tree-folder structure, changing the value of that node.
Delete Node:
The user can remove the selected element from the tree-folder structure.
New Node, New Sibling Node Before:
The user can add a new node which is consider the brother of the current node in the hierarchical view. The brother node will be inserted upon the selected node.
New Node, New Sibling Node After:
With this option the user can add a new node, considered as a brother of the current node, according to the hierarchical view. The brother will be inserted below/after the selected node.
New Node, New Child Node:
The user can add a new node that is a son of the current node in the hierarchical view. This option is available only if the current node is the first node of the tree-folder structure (i.e. the root note) or is a section node (i.e. a node of type ”section”). Standard node types like Datetime, Decimal, Yes/no, Selection etc. can’t generate any son nodes.
New Node, New Sibling Node Before from Template (since FSM 20.0):
The user can select a template release and add all its nodes to the current template, and these nodes will be considered as brothers of the current node in the hierarchical view. The brothers node will be inserted upon the selected node.
New Node, New Sibling Node After (since FSM 20.0):
The user can select a template release and add all its nodes to the current template, and these nodes will be considered as brothers of the current node in the hierarchical view. The brothers will be inserted below/after the selected node.
New Node, New Child Node (since FSM 20.0):
The user can select a template release and add all its nodes to the current template, and these nodes will be considered as sons of the current node in the hierarchical view. This option is available only if the current node is the first node of the tree-folder structure (i.e. the root note) or is a section node (i.e. a node of type ”section”). Standard node types like Datetime, Decimal, Yes/no, Selection etc. can’t generate any son nodes.
Duplicate (node)
The user can duplicate the node or all the subtree (in case of the node is a Section node) at the current position. The set of duplicated nodes is added in the same level as the source node. template’ structure. The duplicated new node (or section) have the same properties as the source node (group) except for the description, node’s code and properties like visible, read only, mandatory, initial expression, computed value.
The description name is reassigned using the original name plus an ordinal not even used that makes the name unique (i.e. the name is assigned the same way it does when you duplicate a folder in the file system).
Node’s code and properties like: visible, read only, mandatory or initial expression are nullified in the duplicated node (or section) mainly because could create inconsistent expressions or lose the uniqueness of the node code.
Cut (node)
The user can cut the node or all the sub-tree (in case of the node is a Section node) at the current position. The cut set of nodes it’s added in the clipboard. Using cut and paste command, it is possible to relocate a node or an entire sub-tree in the hierarchical dynamic form template’ structure.
Paste (node)
The user can paste a node (or a sub-tree) previously cut.
The user can paste the node (or the sub-tree) only on the Section node or on the Root node, because the node (or the sub-tree) will be added as a son of that node (the last son of the level).
Through the ‘paste’ function, is possible to relocate a node or an entire sub-tree in the hierarchical dynamic form template structure.
Drag and drop operations to relocate nodes
The arrangement of nodes can be easily changed by using the ‘drag & drop’ feature.
‘Drag & drop’ function can be enabled by clicking the mouse button over an icon.
The user can select the row corresponding to the node (or section) in order to relocate it, by holding down the mouse button. Then, after choosing the target and identifying the right one, the user can release the button.
The picked-up node (or section) will be relocated after the selected node. If the node is considered as a section node, (all the sub-tree of nodes having the section node as root) will be relocated after the selected node.
Different Types of nodes and their properties
In the dynamic form templates can be managed different types of nodes, according to the type of information the user wants to collect. Each node’s type has its own attributes.
Each type of nodes has its own domain value, its properties and validations rules. Let’s learn them one by one.
Integer node type:
Using this type of node, the user must fill-in the corresponding input field in the dynamic form with a long number value.
For this kind of node, the user can fill-in these additional fields in the node of the template:
-
Min Value. Optional information. When specified, it requires that the corresponding input field in the dynamic form should be filled-in with a numeric value greater than the Min Value inserted in the template.
-
Max Value. Optional information. When specified, it requires that the corresponding input field in on the dynamic form should be filled-in with a numeric value lower than the Max Value inserted in the template.
Text node type:
Using this type of node, the user must fill-in the corresponding input field in the dynamic form with a Text value.
For this kind of node, the user can fill these additional features of the template’s node:
-
Min Lenght. Optional information. When specified, it requires that the corresponding input field in the dynamic form, should be filled-in with a string that contains at least Min Lenght characters.
-
Max Lenght. Optional information. When specified, it requires that the corresponding input field in the dynamic form, should be filled-in with a string that contains at most Max Lenght characters.
Date\time node type:
Using this type of node, the user must fill the corresponding input field in the dynamic form with a Date and a Time value.
For this kind of node, the user can fill these additional features of the template’s node:
-
Min Date. Optional information. When specified, it requires that the corresponding input field in the dynamic form, should be filled-in with a date and time value, greater than the Min Date value inserted in the template.
-
Max Date. Optional information. When specified, it requires that the corresponding input field in on the dynamic form, should be filled-in with a date and time value, lower than the Max Date Value inserted in the template.
Yes/No node type
Using this type of node, the user must fill the corresponding input field of the dynamic form by inserting a Yes/No value.
For this kind of node there aren’t any additional fields.
Decimal node type
Using this type of node, the user must fill the corresponding input field in the dynamic form with a real number, possibly with a pre-defined number of integer and/or decimal digits.
For this kind of node, the user can fill these additional features of the template’s node:
-
Min Value. Optional information. When specified, it requires that the corresponding input field in the dynamic form, should be filled-in with a numeric value greater than the Min Value inserted in the template.
-
Max Value. Optional information. When specified, it requires that the corresponding input field in the dynamic form, should be filled-in with a numeric value lower than the Max Value inserted in the template.
-
Max Integer Digits. Optional information. When specified, it requires that the corresponding input field in the dynamic form, should be filled with Max Integer (integer digits).
-
Max Decimal Digits. Optional information. When specified, it requires that the corresponding input field in the dynamic form, should be filled-in with Max Decimal integer digits.
Selection node type
Using this type of node, the user must fill the corresponding input field in the dynamic form, selecting the most appropriate value from the pre-defined list.
For this kind of node, the user can fill the additional table called “Options”.
In the “Options” table, the user can define the list of values and select only the most appropriate value.
On the top right side of the table, two operations are available to the user:
-
“New Option” operation, used to add more items to the list of values to propose;
-
“Select Options Group” , used to add a pre-configured list of options from Options Groups master data (see DCS - Options Groups for further information on Options Groups).
For reach row in the table, in the first column, there is a three-dots menu that can be used to:
-
Modify an existing item;
-
Delete an existing item.
For each view item’s list, the user can set the following parameter in the table:
-
Code: assigned to the item. Optional information;
-
Description: name assigned to the item. This description is visible to the user. Mandatory information.
Please note that the list can be ordered by using the drag & drop feature and re-arranged to the items on the list.
Multi Selection node type
Using this type of node, the user must fill the corresponding input field in the dynamic form, selecting the most appropriate set of values from the predefined list.
For this kind of node, the user can fill the additional table called “Options”.
In the “Options” table, the user can define the list of values and select only the most appropriate value.
-
“New Option” operation, used to add more items to the list of values to propose;
-
“Select Options Group”, used to add an already pre-configured list of options from Options Groups master data (see DCS - Options Groups for further information on Options Groups).
For reach row in the table, in the first column, there is a three-dots menu that can be used to:
-
Modify an existing item;
-
Delete an existing item.
For each view item’s list, the user can set the following parameter in the table:
-
Code: assigned to the item. Optional information;
-
Description: name assigned to the item, visible to the user. Mandatory information.
Please note that list can be ordered using the drag & drop feature to re-arrange items on the list.
Coordinates node type
Using this type of node, the user must fill the corresponding input field in the dynamic form introducing a coordinate value, by inserting longitude and latitude values, or asking to the GPS receiver on mobile device for transferring.
For this kind of node there aren’t any additional fields.
Barcode node type
Using this type of node, the user must fill the corresponding input field in the dynamic form, by introducing a barcode value manually (only on mobile side) or automatically. It’s also possible to activate the camera and frame the barcode/QR code, so the optical scan & recognize feature gets automatically the corresponding value. Both numeric and alphanumeric barcodes can be acquired.
For this kind of node there aren’t any additional fields.
Attachment node type
Using this type of node, the user can fill the corresponding input field in the dynamic form, by uploading a document file from the mobile’s library, related to operating’s field \ workstation or operations from server side.
For this kind of node, the user can fill the “Max KB Size” option and the additional table called “File Extensions”.
The Max KB Size sets the size limit of the files that can be uploaded.
In the “File Extension” Table, the user can define the list of file extensions, which define the admitted types of files to be uploaded.
On the top right side of the table, there is a “New Option” operation tab, used to add more items to the list of values.
It is possible to select the file formats by using the “drag and drop” option, selecting the desired format from the "Available" section, and bringing it to the "Selected" one.
Here’s a list of available extensions (format) that can be used:
-
mpg, mp2, mpeg, mpe, mpv, m2c, avi, mov, qt, flv, gif, png, txt, doc, docx, pdf, rtf, xls, xlsx.
Download Attachment node type
Using this type of node, the template configurator can add a picture that can be downloaded form the corresponding dynamic form. If the flag ‘Show preview’ is set, in the dynamic form a preview of the file will be displayed.
Picture node type
Using this type of node, the user can fill the corresponding input field in the dynamic form, by uploading a document file from the mobile’s library, related to operating’s field \ workstation or operations from server side.
For this kind of node, the user can fill the “Max KB Size” option and the additional table called “File Extensions”.
The Max KB Size sets the size limit of the files that can be uploaded.
In the “File Extension” Table, the user can define the list of file extensions that define the admitted types of files to be uploaded.
It is possible to select the file formats by using the “drag and drop” option, selecting the desired format from the "Available" section and bringing it to the "Selected" one.
Here’s a list of available extensions (format) that can be used:
-
jpg;
-
jpeg;
-
bmp;
-
gif;
-
png.
Signature node type
Using this type of node, the user can fill in the corresponding input field in the dynamic form by uploading a document file from the mobile’s library, related to operating’s field \ workstation or operations from server side.
For this kind of node, the user can fill the “Max KB Size” option and the additional table called “File Extensions”.
The Max KB Size sets the size limit of the files that can be uploaded.
In the “File Extension” Table, the user can define the list of file extensions that define the admitted types of files to be uploaded.
It is possible to select the file formats by using the “drag and drop” option, selecting the desired format from the "Available" section, and bringing it to the "Selected" one
Here’s the available extensions:
-
jpg;
-
jpeg.
Regular Expression node type
Using this type of node, the user must fill the corresponding input field in the dynamic form with a string, linear to the specific format specified in the “Redular Expression property” otherwise obtains a validation error and the value can’t be saved.
So regular expression node types can be used to enforce validation for user data to be inserted.
Here are some useful types of regular expression to control data.
|
Type |
Regular Expression |
Example |
|
|
[a-zA-Z0-9_.]+@[a-zA-Z0-9-]+.[a-zA-Z]{2,3} |
|
|
Telephone number |
^(\d{3})\s\d{3}-\d{4} |
(###) ###-#### |
|
ISBN Ten digits or Thirteen digits, with or without the sign - |
[\d*-]{10}|[\d*-]{13} |
213-3424-424 or 34234-232-24244
|
For further information on how to write regular expression, you can see also: https://overit-docs.atlassian.net/wiki/pages/createpage.action?spaceKey=GP&title=How%20to%20write%20Regular%20Expressions%3F.
Section node type
Using this type of node, the user can organize the dynamic form into one or more sections. A section is composed by standard nodes (e.g. Datetime, Decimal, Yes/no, Selection, etc node types) or others indented section’s group.
The node’s group is a special type of node, which is useful to organize standard nodes into a hierarchical structure, and not for collecting values.
For this kind of node, no more additional fields are required.
Radio node type (FSM 20.0)
This node is equal to the Selection node type unless the node is drawn with radio buttons instead of a lookup. There is also a flag ‘Show as table’ that, if set, draw the node as a table on which also the Description attribute is displayed.
Checkbox node type (FSM 20.0)
This node is equal to the Multi Selection node type unless the node is drawn with checkbox instead of a multi decoder. There is also a flag ‘Show as table’ that, if set, draw the node as a table on which also the Description attribute is displayed.
Multi attachment node type (FSM 20.0)
This node enable the user to load 1 or more attachment. In the node configuration you can define
-
the maximum number of attachment to load
-
the max size of each attachment
-
the set of valid extensions of loaded files
Matrix node type
The matrix node is introduced to give the user the possibility to uniquely select between combinations of values having the possibility of being able to view them as a matrix. The user when opening the form will find the matrix in its entirety, therefore with all the configured combinations visible.
The user when creating the template will be able to define the number of columns and how to group the rows. And dynamically will be able to add the row values via config, similar to other nodes the "single" rows by inserting the value of each corresponding cell/row.
-
The number of columns
-
The column headers
-
The group columns
-
The cell values
Summary flag
If the flag ‘Show on Summary’ of a node is set, the node value will be displayed also in a separated panel that can be moved inside the page.
Format Font
If the 'Format Font' flag is set for a node, the node will also display additional properties for displaying the text format.
When the flag is set, the form node will only show the node description and not the breadcrumb.
-
Detail Description : This additional detail will be displayed below the node description.
-
The font color
-
The heading type
-
Bold / Italic / Underline font
The description will be display like
Expressions
The user can create or edit a node, defining its expression into special properties such as:
-
Visible,
-
Read Only,
-
Mandatory,
-
Initial value,
-
Computed value.
Expressions are dynamically evaluated by the FSM system, in order to address its computed value.
They can be constant values (i.e. true/false, ‘Test Text’, 245) or computed value by expression (true && false, 34 + (90 /2) ) and they can also refer to the current value of another node (i.e. #base * # height ).
It is also important to point out, that the first three properties require a Boolean result for the expression, while the last two require a value’s result, linear to the selected type (i.e., if the type of the node is a “Text”, the expression returns a “Text” value and so on).
Expression, inserted in the template, are acquired into the form and evaluated when needed:
-
visible, mandatory and read-only features, are computed for each node every time the user changes a value in the form.
-
Initial value property is computed only when the form is created.
For further detailed information on how to configure expression, you can see also DCS - Expressions.
Operations:
At the bottom of “Data Collection Template Structure Detail” the user can find these following operations:
-
View Raw Model;
-
Save;
-
Close.
View Raw Model:
This feature allows the user to inspect the structure of the current Dynamic Form Model in a JSON format. This function can be useful when the user wants to check the structure returned by the Get model REST API (i.e. GET /core/r1/data collection/form/{id}/model).
Save
This feature allows the authorized user to export the JSON into a text file.
This is used by power users for testing/development purposes: for example, when the user wants to share it with other stakeholder or external system or also to compare with JSON returned/managed by APIs.
The exported file is named “TemplateModelID<xxx>.json”.
Close
This feature is used to close the form and go back to the previous functions of the menu.
User Type’s Permissions
In order to use the described function, specific permissions are required. Permissions are assigned to users based on the group they belong (type of user).
Here’s the permissions that can be assigned:
-
View Data Collection Template;
-
View and Edit Data Collection Template.
View Data Collection Template
Users with this qualification level, can question all the information related to the dynamic form templates like working copies, releases and view\download or retrieve them (Rest API).
View and Edit Data Collection Template
Users with this qualification level, can question all the information related to the dynamic form templates like working copies, releases and view\download or retrieve them (Rest API).
These users can also modify information related to dynamic form templates, working copies, releases (where applicable). They can create a new template, modify a working copy, publish a new release, import a model, change the working copy, or call PATCH and POST APIs on this information.