...
| Table of Contents |
|---|
This guide will provide the user with the necessary information about designing a Form by using the Form Designer.
...
After creating a new Workflow version, we can add a new form for the selected version withing the Form tab. The Form Designer has direct access to a number of tabs such as:
Designer
Preview
Rules
Variables
Data types
Element Control/wiki/spaces/eng/pages/850493448
/wiki/spaces/eng/pages/851542019
/wiki/spaces/eng/pages/852099073
/wiki/spaces/eng/pages/851968002
/wiki/spaces/eng/pages/852230145
/wiki/spaces/eng/pages/851804177
After selecting the desired version of workflow the user can click the ‘Add form’ button from the detailed view to create a new form.
...
Reference | Attribute | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| Form | The Form tab opens an empty form page, providing options to either import an existing form or create a new one, | ||||||
| Create / Import | The buttons “Import form” and “Create form” can be used for adding a new form. |
Designer
The form tab ‘Designer’ displays a view to add containers and elements for designing a form.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Elements
...
On the left side there are elements and containers which can be added to a form.
...
| Status | ||||
|---|---|---|---|---|
|
...
Form
...
The middle section contains all the elements and containers that were added to the form.
...
| Status | ||||
|---|---|---|---|---|
|
...
Settings
...
Each element has its own settings that can be altered on the right section.
Add containers
To begin adding elements to the form the user should first add a container. Each element will be added to a container. For adding a container element the user can drag and drop a specific container or can use the buttons in the form are with given row-layouts.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Row
...
Containers can be added to the form by simply dragging and dropping the desired container to the middle section. Each container has its width options shown in brackets.
...
| Status | ||||
|---|---|---|---|---|
|
...
Container
...
After adding the container the user can see its width separated by vertical dashed lines. On the left side of the container there are pointers which can change the container position and on the right side there is a delete icon for deletion.
...
| Status | ||||
|---|---|---|---|---|
|
...
Settings of container
...
By clicking the container the user is able to see the information about this container on the right section.
...
form |
...
Reference
Attribute
Description
| Status | ||||
|---|---|---|---|---|
|
Tab
. |
| Status | ||||
|---|---|---|---|---|
|
Name
Here a name can be given to the 'Tabs'-container..
| Status | ||||
|---|---|---|---|---|
|
Tab label
Here each tab needs to be given an individual name, as this name is displayed to the user as head of the corresponding tab in order to be able to differentiate the tabs. Tabs can be added with the plus icon. By clicking the delete icon a tab can be deleted.
Settings of container
Element settings
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Name
...
Here an individual name can be given to the container
Element control
For each container it can be defined whether it should be readable, writeable or required including all elements contained in it. If no element control is specified, this container inherits the element control from the form default.
...
Add basic elements
After adding the container the user is able to add elements to the desired container. Each element has its own element settings, element style , element control and the possibility to use connections.
General options of basic elements
Element settings
The element settings depend on the element type and are explained for each in the following paragraphs.
Element style
The options of the element styles are identical for all element types except the text element. The following styles are available.
All elements except text element:
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Element: Alignment
...
The alignment of the element can be changed into right, center, left or stretch within the cell.
...
| Status | ||||
|---|---|---|---|---|
|
...
Font Size
...
Any style can be given to the label with css code. Possible examples font-size.
...
| Status | ||||
|---|---|---|---|---|
|
...
Font Weight
...
Any style can be given to the label with css code. Possible examples font-weight.
...
| Status | ||||
|---|---|---|---|---|
|
...
Font Style
...
Any style can be given to the label with css code. Possible examples font-style.
...
| Status | ||||
|---|---|---|---|---|
|
...
Font Color (CSS)
...
The color of the font can be changed to different colors.
...
| Status | ||||
|---|---|---|---|---|
|
...
Underline: Color (CSS)
...
The color of the underline can be changed to different colors.
Text element:
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Element: Alignment
...
The alignment of the text element can be changed into right, center, left or stretch within the cell.
...
| Status | ||||
|---|---|---|---|---|
|
...
Font size (in %)
...
The font size of a text is per default 100 %. If the percentage is increased, the font will be enlarged and if it is decreased, the font will be reduced accordingly.
...
| Status | ||||
|---|---|---|---|---|
|
...
Font weight
...
Normal is the default font weight. It can be changed into light or bold.
...
| Status | ||||
|---|---|---|---|---|
|
...
Font style
...
Normal is the default font style. It can be changed into italic.
...
| Status | ||||
|---|---|---|---|---|
|
...
Font color (CSS)
...
Per default the font color is black. It can be changed individually. The css colour names and the formats Hex, RGB and HSL are supported.
...
| Status | ||||
|---|---|---|---|---|
|
...
Underline
...
Per default no underline is selected. Text can be underlined thin, medium and bold.
...
| Status | ||||
|---|---|---|---|---|
|
...
Underline color (CSS)
...
If an underline style is selected, the default color is black. It can be changed individually. The css colour names and the formats Hex, RGB and HSL are supported.
Element control
For each element can be defined whether it should be readable, writeable or required. If no element control is specified, this element inherits the element control from the container.
...
Connectors
Each element can also display information from connectors. More information about how to use and implement connectors is available in the chapter Connectors.
...
Insert a text element
A text element is used for declaring a title, a headline or a simple text displayed in the Form. The content of the text is changed via the element settings. For adding a text element the user can drag and drop the element to a specific container. Text elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Name
...
Here an individual name can be given to the text field
...
| Status | ||||
|---|---|---|---|---|
|
...
Text
...
Here the text displayed by the text field can be entered
Insert an input field
Users can enter data in an input field. The input field element can be displayed in several ways. Generally it consists of a label and an input area. For adding an input field element the user can drag and drop the element to a specific container. Input field elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
...
| Status | ||||
|---|---|---|---|---|
|
...
Variable
...
For each input field a unique variable name is required. Per default the variable is set automatically. The user can change the variable name manually or use the button 'Label as variable name' to generate a variable name from the label text.
...
| Status | ||||
|---|---|---|---|---|
|
...
Index Field
...
Index fields are used to display information from a Form, directly in the tasks and process instances lists. They provide extended information on the process instance and can be used for addition filtering and sorting. See also Filter, sorting and column configuration.
...
| Status | ||||
|---|---|---|---|---|
|
...
Data type
...
By default, the data types 'text' and 'number' are provided. The data type 'text' is pre-selected. In the tab 'Data types' further data types can be created (see section 'Data types' for more information).
...
| Status | ||||
|---|---|---|---|---|
|
...
Placeholder
...
This attribute specifies a short hint that describes the expected value of an input field (e.g. a sample value or a short description of the expected format). The short hint is displayed in the input field before the user enters a value.
...
| Status | ||||
|---|---|---|---|---|
|
...
Password
...
This field offers enabling and disabling of the password field
...
| Status | ||||
|---|---|---|---|---|
|
...
Icon
...
With a dropdown an icon is selectable which is displayed next to the input field. A '?' for help or a '!' for Info can be selected.
...
Icon: Position
...
Here the position of the icon can be selected via dropdown. Either the dropdown is on the left or on the right of the input field. As default the icon is located on the right of the input field.
...
Icon: Text
...
Here the text is entered that is supposed to be shown to the user when hovering over the icon during fulfilling his tasks.
Insert a datepicker
To record a date, the datepicker element is used. The datepicker element provides users a popup calendar for selecting a date or date and time. When a user changes the language, the date-time format is automatically converted to the date-time format valid to the selected language. See: Valid Date-Time Formats. For adding a datepicker element the user can drag and drop the element to a specific container. Datepicker elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
...
| Status | ||||
|---|---|---|---|---|
|
...
Variable
...
For each datepicker field a unique variable name is required. Per default the variable is set automatically. The user can change the variable name manually or use the button 'Label as variable name' to generate a variable name from the label text.
...
| Status | ||||
|---|---|---|---|---|
|
...
Index Field
...
Index fields are used to display information from a Form, directly in the tasks and process instances lists. They provide extended information on the process instance and can be used for addition filtering and sorting. See also Filter, sorting and column configuration.
...
| Status | ||||
|---|---|---|---|---|
|
...
Type
...
By default, a single date can be selected in the calendar popup. But there is also the possibility to enter multiple dates or a period of time.
...
| Status | ||||
|---|---|---|---|---|
|
...
Timepicker
...
Additional the calendar popup can be extended with a timepicker for entering a time.
...
| Status | ||||
|---|---|---|---|---|
|
...
Icon
...
With a dropdown an icon is selectable which is displayed next to the datepicker field. A '?' for help or a '!' for Info can be selected.
...
Icon: Position
...
Here the position of the icon can be selected via dropdown. Either the dropdown is on the left or on the right of the datepicker field. As default the icon is located on the right of the datepicker field.
...
Icon: Text
...
Here the text is entered that is supposed to be shown to the user when hovering over the icon during fulfilling his tasks.
Insert a radio button
Radio Buttons are selection boxes that are always grouped together. Only one choice can be made from this group. For adding a radio button element the user can drag and drop the element to a specific container. Radio button elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
...
| Status | ||||
|---|---|---|---|---|
|
...
Variable
...
For each radio button field a unique variable name is required. Per default the variable is set automatically. The user can change the variable name manually or use the button 'Label as variable name' to generate a variable name from the label text.
...
| Status | ||||
|---|---|---|---|---|
|
...
Index Field
...
Index fields are used to display information from a Form, directly in the tasks and process instances lists. They provide extended information on the process instance and can be used for addition filtering and sorting. See also Filter, sorting and column configuration.
...
| Status | ||||
|---|---|---|---|---|
|
...
Layout
...
The options of the radio button element can be displayed one below the other as list or in one line as block.
...
| Status | ||||
|---|---|---|---|---|
|
...
Select options
...
Further select options can be added with the plus icon. By clicking the delete icon an option can be deleted.
Insert a checkbox
Checkboxes are also selection boxes, but can be clicked individually and independently. For adding a checkbox element the user can drag and drop the element to a specific container. Checkbox elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
...
| Status | ||||
|---|---|---|---|---|
|
...
Variable
...
For each checkbox field a unique variable name is required. Per default the variable is set automatically. The user can change the variable name manually or use the button 'Label as variable name' to generate a variable name from the label text.
...
| Status | ||||
|---|---|---|---|---|
|
...
Index Field
...
Index fields are used to display information from a Form, directly in the tasks and process instances lists. They provide extended information on the process instance and can be used for addition filtering and sorting. See also Filter, sorting and column configuration.
...
| Status | ||||
|---|---|---|---|---|
|
...
Text
...
The text of the checkbox can be changed here. If the checkbox should be checked when opening the Form, the button 'Active (checked)' must be selected.
...
| Status | ||||
|---|---|---|---|---|
|
...
Icon
...
With a dropdown an icon is selectable which is displayed next to the checkbox field. A '?' for help or a '!' for Info can be selected.
...
Icon: Position
...
Here the position of the icon can be selected via dropdown. Either the dropdown is on the left or on the right of the checkbox field. As default the icon is located on the right of the checkboxfield.
...
Icon: Text
...
Here the text is entered that is supposed to be shown to the user when hovering over the icon during fulfilling his tasks.
Insert a select
A select element is used to display selection options in a drop-down menu or list. For adding a select element the user can drag and drop the element to a specific container. Select elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
...
| Status | ||||
|---|---|---|---|---|
|
...
Variable
...
For each select field a unique variable name is required. Per default the variable is set automatically. The user can change the variable name manually or use the button 'Label as variable name' to generate a variable name from the label text.
...
| Status | ||||
|---|---|---|---|---|
|
...
Index Field
...
Index fields are used to display information from a Form, directly in the tasks and process instances lists. They provide extended information on the process instance and can be used for addition filtering and sorting. See also Filter, sorting and column configuration.
...
| Status | ||||
|---|---|---|---|---|
|
...
Placeholder
...
This attribute specifies a short hint that describes the expected value of a select field (e.g. a sample value or a short description of the expected format). The short hint is displayed in the select field before the user enters a value.
...
| Status | ||||
|---|---|---|---|---|
|
...
Selection type
...
Here the layout of the select can be changed. The user can choose between dropdown or listbox and can determine via multiselect whether more than one option may be selected.
...
| Status | ||||
|---|---|---|---|---|
|
...
Select options
...
Options can be added with the plus icon. By clicking the delete icon an option can be deleted.
Insert a link
Links can be used to refer to other documents or other applications. If a user clicks on the link, the document or application is opened. For adding a link element the user can drag and drop the element to a specific container. Link elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
...
| Status | ||||
|---|---|---|---|---|
|
...
URL
...
Here the URL to a document or application is specified. The URL can be static or can contain variables (e.g. www.myCompany.dom/${myLinkVariable}, which are filled at run-time.
...
| Status | ||||
|---|---|---|---|---|
|
...
Link Text
...
The link text replaces the URL with a user-friendly name.
...
| Status | ||||
|---|---|---|---|---|
|
...
Icon
...
With a dropdown an icon is selectable which is displayed next to the link element. A '?' for help or a '!' for Info can be selected.
...
Icon: Position
...
Here the position of the icon can be selected via dropdown. Either the dropdown is on the left or on the right of the link element. As default the icon is located on the right of the link element.
...
Icon: Text
...
Here the text is entered that is supposed to be shown to the user when hovering over the icon during fulfilling his tasks.
Insert an image
Images can be embedded into the Form by stating the file path. For adding an image element the user can drag and drop the element to a specific container. Image elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Source
...
Here the file path and file name of a picture are specified. Pictures that are in the resource folder have the path /loom-portal/resource/. Note: Only images are accepted. Not pdf, doc, etc..
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
Insert a divider
Dividers can be used to strictly separate one part of the document from another. This divider can either be a horizontal line or simply a big space. For adding a divider element the user can drag and drop the element to a specific container. Divider elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Name
...
Here an individual name can be given to the divider
...
| Status | ||||
|---|---|---|---|---|
|
...
Line
...
You can either choose to display a line as divider or simply have an optical divider by space. The default option is displaying the line.
Add advanced elements
Insert a textarea
Textarea can be used so that the user has more space to type something than he has with a simple imput field. E.g. a coherent text. For adding a textarea element the user can drag and drop the element to a specific container. Textarea elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
...
| Status | ||||
|---|---|---|---|---|
|
...
Variable
...
For each textarea field a unique variable name is required. Per default the variable is set automatically. The user can change the variable name manually or use the button 'Label as variable name' to generate a variable name from the label text.
...
| Status | ||||
|---|---|---|---|---|
|
...
Index field
...
Index fields are used to display information from a Form, directly in the tasks and process instances lists. They provide extended information on the process instance and can be used for addition filtering and sorting. See also Filter, sorting and column configuration.
...
| Status | ||||
|---|---|---|---|---|
|
...
Size
...
Here the width and the height of the textarea can be specified. The width is given in characters and the height is given in lines.
...
| Status | ||||
|---|---|---|---|---|
|
...
Placeholder
...
Here the placeholder text of the comment field can be added and edited.
...
| Status | ||||
|---|---|---|---|---|
|
...
Icon
...
With a dropdown an icon is selectable which is displayed next to the textarea field. A '?' for help or a '!' for Info can be selected.
...
Icon: Position
...
Here the position of the icon can be selected via dropdown. Either the dropdown is on the left or on the right of the textarea field. As default the icon is located on the right of the textarea field.
...
Icon: Text
...
Here the text is entered that is supposed to be shown to the user when hovering over the icon during fulfilling his tasks.
Insert a rich text
Rich text can be used to give the user more space to type, just as the textarea does but with the benefit of letting the user have more styling options for his text such as size, color, font, font-weight and text-alignment. For adding a rich text element the user can drag and drop the element to a specific container. Rich text elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
...
| Status | ||||
|---|---|---|---|---|
|
...
Variable
...
For each rich text field a unique variable name is required. Per default the variable is set automatically. The user can change the variable name manually or use the button 'Label as variable name' to generate a variable name from the label text.
...
| Status | ||||
|---|---|---|---|---|
|
...
Index field
...
Index fields are used to display information from a Form, directly in the tasks and process instances lists. They provide extended information on the process instance and can be used for addition filtering and sorting. See also Filter, sorting and column configuration.
...
| Status | ||||
|---|---|---|---|---|
|
...
Height
...
The Height of the textarea can be specified here in pixels. It is set at a default height of 150px.
...
| Status | ||||
|---|---|---|---|---|
|
...
Placeholder
...
Here the placeholder text of the rich text can be added and edited.
...
| Status | ||||
|---|---|---|---|---|
|
...
Icon
...
With a dropdown an icon is selectable which is displayed next to the rich text field. A '?' for help or a '!' for Info can be selected.
...
Icon: Position
...
Here the position of the icon can be selected via dropdown. Either the dropdown is on the left or on the right of the rich text field. As default the icon is located on the right of the rich text field.
...
Icon: Text
...
Here the text is entered that is supposed to be shown to the user when hovering over the icon during fulfilling his tasks.
Insert a custom HTML
A custom HTML can be used to have even more design options which are not covered by the basic and advanced elements available in the Form designer. For adding a custom HTML element the user can drag and drop the element to a specific container. Custom HTML elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Name
...
Here an individual name can be given to the custom HTML
...
| Status | ||||
|---|---|---|---|---|
|
...
HTML
...
Any HTML code can be entered here eg. <a href="https://www.tim-solutions.de/en">This is my text</a>
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
...
| Status | ||||
|---|---|---|---|---|
|
...
Icon
...
With a dropdown an icon is selectable which is displayed next to the custom HTML element. A '?' for help or a '!' for Info can be selected.
...
Icon: Position
...
Here the position of the icon can be selected via dropdown. Either the dropdown is on the left or on the right of the custom HTML element. As default the icon is located on the right of the custom HTML element.
...
Icon: Text
...
Here the text is entered that is supposed to be shown to the user when hovering over the icon during fulfilling his tasks.
Insert an autocomplete
Autocomplete predicts the rest of a word a user is typing based on a limited amount of possible options given during designing the form. For adding an autocomplete element the user can drag and drop the element to a specific container. Autocomplete elements can be copied via the plus symbol and removed via the delete symbol.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Label
...
Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox.
...
| Status | ||||
|---|---|---|---|---|
|
...
Variable
...
For each autocomplete field a unique variable name is required. Per default the variable is set automatically. The user can change the variable name manually or use the button 'Label as variable name' to generate a variable name from the label text.
...
| Status | ||||
|---|---|---|---|---|
|
...
Index Field
...
Index fields are used to display information from a Form, directly in the tasks and process instances lists. They provide extended information on the process instance and can be used for addition filtering and sorting. See also Filter, sorting and column configuration.
...
| Status | ||||
|---|---|---|---|---|
|
...
Placeholder
...
This attribute specifies a short hint that describes the expected value of an autocomplete field (e.g. a sample value or a short description of the expected format). The short hint is displayed in the autocomplete field before the user enters a value.
...
| Status | ||||
|---|---|---|---|---|
|
...
Checkboxes
...
Here you can select whether the user should be able to see all possible options and also be able to manually choose out of the available options.
By ticking case sensitive search results shown to the user depend on the casing of his search.
...
| Status | ||||
|---|---|---|---|---|
|
...
Select options
...
Options can be added with the plus icon. By clicking the delete icon an option can be deleted.
Element Control
The user is able to select a specific context in the Element Control (Context) and define how the form will be shown in that context.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Element control (Context)
...
The user can select a specific context to define how the form should behave in that context.
...
| Status | ||||
|---|---|---|---|---|
|
...
Select element
...
After selecting the desired context the user can select a container or element to show its element control settings for the current context selected.
...
| Status | ||||
|---|---|---|---|---|
|
...
Element Control
...
In the element control setting of a select container or element the user can define whether it should be visible, writeable or required.
...
| Status | ||||
|---|---|---|---|---|
|
...
Existing
element control
...
Here is shown for which specific context an element control setting already exists.
Preview
The form tab ‘Preview’ displays how a form is shown in the whole process or in a specific part of the process.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Form preview selection
...
The user can see how a form is designed in a specific part of the process model.
...
| Status | ||||
|---|---|---|---|---|
|
...
Preview
...
The current form preview selected by the user in form preview selection.
For changing the form preview for a specific context the user can change it via drop-down.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Context
...
The user can see how a form is designed in a specific context of the process model.
...
| Status | ||||
|---|---|---|---|---|
|
...
Preview
...
After selecting the desired context the form shows the specific part for that context.
Rules
The form tab ‘Rules’ are sets of rules which can change the behavior of the form depending on the trigger events.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Create rule
...
While the user opens the ‘Rules’ tab for the first time the 'Create rule'-button allows to create a new rule.
...
| Status | ||||
|---|---|---|---|---|
|
...
Create
...
The plus button in the lower left of the ‘Rules’ tab allows for the creation of a new rule.
...
| Status | ||||
|---|---|---|---|---|
|
...
Trigger event
...
On the left side of the view there are trigger events listed. Under each trigger event, the created rules are shown accordingly slightly indented (see next image).
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Name
...
The name for the creation of a new rule to the system.
...
| Status | ||||
|---|---|---|---|---|
|
...
Trigger event
...
Via drop-down the desired trigger event can be selected. Trigger events of a rule can be on form load, on form input and before form submit/save.
...
| Status | ||||
|---|---|---|---|---|
|
...
Conditions
...
On the condition part the user sets a condition state of an element (e.g. radio button element selected by variable name should not be equal with value 'Yes' depending on the condition the user can alter the behavior of another element or container.
...
| Status | ||||
|---|---|---|---|---|
|
...
Buttons
...
With the 'Copy rule'-button the rule can be copied and with the 'Delete rule'-button the rule can be deleted.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
SYS.CURRENT_USER_LANGUAGE
...
On the "Select an Element" user can set rules according to their preferred language that are taken from system variables.
...
| Status | ||||
|---|---|---|---|---|
|
...
Select a Property
...
On the "Select Property" field, users can choose the options available, such as Equals. Other options are: Has a value, Contains, Starts with etc.
...
| Status | ||||
|---|---|---|---|---|
|
...
Language Value
...
In the "Value" field user must enter the language that wants to apply to the rule such as German. Other example includes "English", “Bulgarian” or any supported language in the product.
...
| Status | ||||
|---|---|---|---|---|
|
...
Select an Element
...
User selects the element for the applied rule like “comment” component in this case
...
| Status | ||||
|---|---|---|---|---|
|
...
Select a Property
...
Set the property you want to be applied for the component: Required, Writeable, Value etc. We want to set the value for the comment text area in this case.
...
| Status | ||||
|---|---|---|---|---|
|
...
Value
...
Set the value you want to apply to the rule.
| Info |
|---|
The rule above can be interpreted as: when user set the language as German in the product, then add in the comment section the value "Keyboard layout must be German" |
To test the rules that are enabled, the user can go to the ‘Preview’ tab and check for rules behavior depending on the configuration of the rule.
...
If you start the instance of the process definition after setting the rule, you will have
a) When English is set as user language, the comment textarea displays the placeholder text
...
b) When German is set as user language, the textarea is filled with the rule “Keyboard must have German Layout”
...
Variables
Within the form tab 'Variables' all form variables and system variables are listed.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Form variables
...
Here all variables created by adding elements in the form are listed with their corresponding information, such as name, field/element, index field and data type. By clicking the three dots variables can be edited or deleted.
...
| Status | ||||
|---|---|---|---|---|
|
...
Add variable
...
The 'Add variable' button enables the designer to manually add a variables and set the information about this variable.
...
| Status | ||||
|---|---|---|---|---|
|
...
System variables
...
Here all system variables are listed. They are predefined and can not be changed or deleted. It is also not possible to add system variables.
Data types
Within the ‘Data types’ tab the user can create custom data types to use in the forms.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Create data type
...
While the user opens the ‘Data types’ tab for the first time the 'Create data type'-button allows to create a new data type.
...
| Status | ||||
|---|---|---|---|---|
|
...
Create
...
The plus button in the lower left of the ‘Data types’ tab allows for the creation of a new data type.
...
| Status | ||||
|---|---|---|---|---|
|
...
Data types
...
On the left side of the view there are listed all data types created.
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Data type properties
...
To create a data type, field name is mandatory. The user can select a base type with a drop-down. A prefix and a suffix can be added to a data type. E.g. for a number base type the user can define its decimal places and the value range of the number.
...
| Status | ||||
|---|---|---|---|---|
|
...
Test data type
...
For testing the new data type the user can check its behavior and view with ‘Test Data Type’ field.
Element Control Tab
Within the 'Element Control’ tab the user can see all element controls created in the 'Designer' tab.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Element control settings
...
For each element control setting the context, the field name, the element type, the superordinant container (if existing) and the control options are displayed here. The options (visible, writeable, required) can be changed by clicking on the respective checkbox. By clicking the trash can on the right hand side the element control setting can be deleted.
Publish Workflow
After completing designing the form, the user can publish the workflow version with the designed form.
...
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Version
...
After the form completion the user can select the version of the workflow.
...
| Status | ||||
|---|---|---|---|---|
|
...
Publish
...
The ‘Publish’ button in the lower right of the detailed view allows the workflow version to be published.
...
Reference
...
Attribute
...
Description
...
| Status | ||||
|---|---|---|---|---|
|
...
Publish pop-up
...
The pop-up message must appears and “Publish” button must be clicked.
Reference
Attribute
Description
| Status | ||||
|---|---|---|---|---|
|
Published
...