Form Designer Elements
- 1 Add basic elements
- 1.1 General options of basic elements
- 1.1.1 Element settings
- 1.1.2 Element style
- 1.1.3 Element control
- 1.1.4 Connectors
- 1.2 Insert a text element
- 1.3 Insert an input field
- 1.4 Insert a datepicker
- 1.5 Insert a radio button
- 1.6 Insert a checkbox
- 1.7 Insert a select
- 1.8 Insert a link
- 1.9 Insert an image
- 1.10 Insert a divider
- 1.1 General options of basic elements
- 2 Add advanced elements
- 3 Element Control
This guide will provide the user with the necessary information about adding elements to Form by using the Form Designer.
Add basic elements
After adding the container the user can add elements to the desired container. Each element has its own element settings, style, 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 |
|---|---|---|
1 | Element: Alignment | The alignment of the element can be changed into right, center, left or stretch within the cell. |
2 | Styles (CCS) | Allows applying inline CSS styles directly to the label. Example: |
3 | Margin (in px) | Defines the margin space around the label in pixels. Example: |
4 | Position | Determines where the label is positioned relative to its input element. Options: Left, Right, Top, Bottom. |
5 | Alignment | Specifies how the label text itself is aligned. Options: Left, Center, Right. |
Text element:
Reference | Attribute | Description |
|---|---|---|
6 | Element: Alignment | The alignment of the text element can be changed into right, center, left or stretch within the cell. |
7 | 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. |
8 | Font weight | Normal is the default font weight. It can be changed into light or bold. |
9 | Font style | Normal is the default font style. It can be changed into italic. |
10 | 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. |
11 | Underline | Per default no underline is selected. Text can be underlined thin, medium and bold. |
12 | 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 |
|---|---|---|
1 | Name | Here an individual name can be given to the text field |
2 | 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 |
|---|---|---|
1 | Label | Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox. |
2 | 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. |
3 | 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. |
4 | 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). |
5 | 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. |
6 | Password | This field offers enabling and disabling of the password field |
7 | 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 |
|---|---|---|
1 | Label | Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox. |
2 | 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. |
3 | 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. |
4 | 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. |
5 | Timepicker | Additional the calendar popup can be extended with a timepicker for entering a time. |
6 | 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 |
|---|---|---|
1 | Label | Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox. |
2 | 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. |
3 | 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. |
4 | Layout | The options of the radio button element can be displayed one below the other as list or in one line as block. |
5 | 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 |
|---|---|---|
1 | Label | Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox. |
2 | 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. |
3 | 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. |
4 | 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. |
5 | 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 |
|---|---|---|
1 | Label | Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox. |
2 | 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. |
3 | 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. |
4 | 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. |
5 | 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. |
6 | 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 |
|---|---|---|
1 | Label | Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox. |
2 | 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. |
3 | Link Text | The link text replaces the URL with a user-friendly name. |
4 | 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 |
|---|---|---|
1 | Source | Here, the file path and file name of a picture are specified. Pictures in the resource root folder have the path /loom-portal/resource/. Alternatively, you can copy the image address from any image in the web there. Note: Only images are accepted. Not pdf, doc, etc.. |
2 | 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 |
|---|---|---|
1 | Name | Here an individual name can be given to the divider |
2 | 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 |
|---|---|---|
1 | Label | Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox. |
2 | 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. |
3 | 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. |
4 | 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. |
5 | Placeholder | Here the placeholder text of the comment field can be added and edited. |
6 | 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 |
|---|---|---|
1 | Label | Here the text of the label can be changed. Optionally the label can be hidden by selecting the checkbox. |
2 | 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. |
3 | Index field |