Configure Form Builder for Incident Management
Global Tenancy for Form Builder
Form builder helps to create additional custom fields in the interface as per your requirement. You can drag and drop the form elements and create your own fields in the Incident Management module.
The Global Tenancy concept is introduced in Form Builder which allows configurations made at Global Tenant to be automatically inherited by all the Local Tenants. This reduces the manual effort of creating multiple configurations.
You can perform the following action in Form Builder for the Incident Management module:
- Configure Form Builder in Global Tenant
- Configure Form Builder in Local Tenant
- De-link Form Builder in Local Tenant
Configure Form Builder in Global Tenant
A form builder configuration created in Global Tenant is inherited by Local Tenants.
To configure the Form in Global Tenant, perform the following steps:
- Navigate to Admin > Basic > Infrastructure > Form Builder.
Figure: Form Builder - Select the Module Incident Management. Click Global Tenant.
- On the ACTIONS Panel click ADD NEW.
Figure: Add new - Under Form Details, select Display At from the dropdown which displays the custom fields. Click NEXT.
Figure: Form details - Under the FORM BUILDER tab, you can select the Custom Fields to be displayed on the page. From the left-hand side panel, select the type of field that you want to add from the Simple Controls, Group Templates, and Form Templates. Drag and drop it into the central section of the page.
- Based on the field type selected, the properties are displayed under the PROPERTIES section on the right-hand-side panel. Fill in the required property details.
To know more about the various controls and their properties, see Field Description.
Figure: Form Builder - Click NEXT. The PREVIEW tab displays the preview of the custom fields created in the Form Builder.
- Click SAVE to save the Form Builder configured.
Field Description
The fields on the FORM BUILDER page are explained in the following table:
Field | Properties |
Group | Click Group to create a group under the tab. Use this to group related fields. Type in the required values for the following properties:
|
SAVE AS TEMPLATE | Click SAVE AS TEMPLATE to save the form. On the Save Form pop-up page, type in the name for the Form in the Form Name text box and click SAVE. The saved Form is available under Form Templates and can be reused. |
SAVE GROUP AS TEMPLATE | If a Group is selected this option is displayed. Click SAVE GROUP AS TEMPLATE to save the form for the selected Group. On the Save Group pop-up page, type in the name for the Group in the Group Name text box and click SAVE. The saved Group is available under Group Templates and can be reused. |
Text/ Text Area | Click Text to create a text box field. Click Text Area to create a text box field that allows more characters compared to the text box field. For example, for Username, use Text; for User Comments, use Text Area. Text and Text Area have the following fields:
|
Check Box | Click Check Box to create a check box field. Type in the required values for the following properties:
|
Drop-down | Click Drop-down to create a drop-down field. Use this field to add an attribute for which the user needs to select from multiple available options. Type in the required values for the following properties:
|
Date | Click Date to add a date field. Type in the required values for the following properties:
|
Number | Click Number to add a number field. For example, Maximum Approvals Required. Type in the required values for the following properties:
|
Click E-mail to add a field for entering e-mail ids. Type in the required values for the following properties:
| |
File | Click File to add a field where files can be added. Type in the required values for the following properties:
|
Price | Click Price to add a field where prices can be added. For example, Project Cost. Type in the required values for the following properties:
|
Website | Click Website to add a field where website URLs can be added. Type in the required values for the following properties:
|
User | Click User to add a field where user details can be entered. Type in the required values for the following properties:
|
Radio Button | Click Radio Button to configure options in form of Radio Button for the following properties:
|
Multi Valued (MV)Drop-down | Click Multi valued drop down to configure field with multiple options. Type in the required values for the following properties:
|
Autofill | Click Autofill to configure field which autofill’s data. Type in the required values for the following properties:
|
Group Templates | This section displays all the saved Group Templates. Drag and drop a Group Template to add a group of fields to the Form. |
Form Templates | This section displays all the saved Form Templates. Drag and drop a Form Template to add a group of fields to the Form. |
Note
Auto Populate functionality is not available for the following controls: File, Label, Radio Button, and MV Drop down.
SHOW LIST
Click SHOW LIST under the ACTIONS panel to display the List table showing all the configured Custom Fields for the selected Tenant.
Figure: List of User Custom Fields
EDIT
Click EDIT to edit a Custom Field. Select the check box for the tab name whose Custom Fields you want to edit and click the EDIT icon.
Figure: Edit
Configure Form Builder in Local Tenant
You can create Form Builder fields for any specific Local Tenant.
To configure the Form in any Local Tenant, perform the following steps:
- Navigate to Admin > Basic > Infrastructure > Form Builder.
Figure: Form Builder - Select the Module Incident Management. Click on any Local Tenant.
- On the ACTIONS Panel, click ADD NEW.
Figure: Add new - Under Form Details, select Display At from the dropdown which displays the custom fields. Click NEXT.
Figure: Form details - Under the FORM BUILDER tab, you can select the Custom Fields to be displayed on the page. From the left-hand side panel, select the type of field that you want to add from the Simple Controls, Group Templates, and Form Templates. Drag and drop it into the central section of the page.
- Based on the field type selected, the properties are displayed under the PROPERTIES section on the right-hand-side panel. Fill in the required property details.
To know more about the various controls and their properties, see Field Description.
Figure: Form Builder - Click NEXT. The PREVIEW tab displays the preview of the custom fields created in the Form Builder.
- Click SAVE to save the Form Builder configured.
Field Description
The fields on the FORM BUILDER page are explained in the following table:
Field | Properties |
Group | Click Group to create a group under the tab. Use this to group related fields. Type in the required values for the following properties:
|
SAVE AS TEMPLATE | Click SAVE AS TEMPLATE to save the form. On the Save Form pop-up page, type in the name for the Form in the Form Name text box and click SAVE. The saved Form is available under Form Templates and can be reused. |
SAVE GROUP AS TEMPLATE | If a Group is selected this option is displayed. Click SAVE GROUP AS TEMPLATE to save the form for the selected Group. On the Save Group pop-up page, type in the name for the Group in the Group Name text box and click SAVE. The saved Group is available under Group Templates and can be reused. |
Text/ Text Area | Click Text to create a text box field. Click Text Area to create a text box field that allows more characters compared to the text box field. For example, for Username, use Text; for User Comments, use Text Area. Text and Text Area have the following fields:
|
Check Box | Click Check Box to create a check box field. Type in the required values for the following properties:
|
Drop-down | Click Drop-down to create a drop-down field. Use this field to add an attribute for which the user needs to select from multiple available options. Type in the required values for the following properties:
|
Date | Click Date to add a date field. Type in the required values for the following properties:
|
Number | Click Number to add a number field. For example, Maximum Approvals Required. Type in the required values for the following properties:
|
Click E-mail to add a field for entering e-mail ids. Type in the required values for the following properties:
| |
File | Click File to add a field where files can be added. Type in the required values for the following properties:
|
Price | Click Price to add a field where prices can be added. For example, Project Cost. Type in the required values for the following properties:
|
Website | Click Website to add a field where website URLs can be added. Type in the required values for the following properties:
|
User | Click User to add a field where user details can be entered. Type in the required values for the following properties:
|
Radio Button | Click Radio Button to configure options in form of Radio Button for the following properties:
|
Multi Valued Drop-down | Click Multi value drop down to configure field with multiple options. Type in the required values for the following properties:
|
Autofill | Click Autofill to configure field which autofill’s data. Type in the required values for the following properties:
|
Group Templates | This section displays all the saved Group Templates. Drag and drop a Group Template to add a group of fields to the Form. |
Form Templates | This section displays all the saved Form Templates. Drag and drop a Form Template to add a group of fields to the Form. |
SHOW LIST
Click SHOW LIST under the ACTIONS panel to display the List table showing all the configured Custom Fields for the selected Tenant.
Figure: Figure: List of User Custom Fields
EDIT
Click EDIT to edit a Custom Field. Select the check box for the tab name whose Custom Fields you want to edit and click the EDIT icon.
Figure: Edit
- If a Global group exists in the Local tenant configuration, additional fields cannot be added to the global group.
- The system displays a message “The global group cannot have any attributes added to it. If you wish to add a new attribute, click on Group under controls to create a new group and then add the attribute.”
Figure: Global group
View a Global configuration in Local Tenant
To view a Global configuration inherited by the Local tenant, perform the following steps:
- Navigate to Admin > Basic > Infrastructure > Form Builder.
- Select the Module Incident Management. Click on any Local Tenant.
- The list of configurations will be displayed. Global configurations are displayed with a grey globe icon.
Figure: List page - Select the custom attribute field with a global configuration.
- The global configurations in the form builder page represented with a grey globe icon are not editable in the local tenant.
Figure: Non editable fields - To make any changes on the Form builder page in the Local Tenant, the Global configuration should be delinked first and then it can be edited in the Local tenant.
De-link Form Builder in Local Tenant
De-link option is available in the Local Tenant and can be used when a Global Configuration in a Local Tenant needs to be converted to Local Configuration and made editable.
In Form Builder, you can choose to de-link a specific custom attribute field such as Additional Information, General Area, TFS Area, or Evaluation. By delinking the custom attribute fields, the configuration can be editable for the Local Tenant.
To de-link a form in Local Tenant, perform the following steps:
- Navigate to Admin > Basic > Infrastructure > Form Builder.
- Select the Module Incident Management. Click on any Local Tenant.
- Select the Custom Attribute field to be delinked. Click EDIT to delink the configuration.
Figure: Edit configuration - On the Form Builder page, click DE-LINK. The system displays a message before delinking the configuration.
Figure: Delink configuration - Click NEXT. The configuration will be delinked, and it can be edited. Click NEXT. The PREVIEW tab displays the preview of the custom fields created in the Form Builder.
- Click SAVE to save the Form Builder configured. The configuration is only applicable to the Local Tenant.
- Once the value is De-Linked from the Global Tenant to Local Tenant, the LIST page the value is represented by De-link icon.
Figure: Delink icon
Notes
- All the Global Configurations are represented with a Grey Globe Icon .
- All the delinked configurations are represented with delink Icon
- When you hover over the De-link Icon, system will display a tool tip as “Global Configuration – Delinked.”
- A Global value once Delinked cannot be Re-linked.
Confluence Cloud Migration Alert: Please refer to known issues you may encounter in Confluence Cloud: https://eitdocs.atlassian.net/wiki/x/wDGwAQ