Configuring Custom Fields for CM
- Enterprise IT
You can add new Custom Fields using the Form Builder for the Change Management sub-module of the Service Management module.
To configure Custom Fields for Change Management:
- Select Admin > Basic > Infrastructure > Form Builder.
- Select the required Tenant and Module as Change Management. The CUSTOM ATTRIBUTES FOR CHANGE MANAGEMENT page is displayed.
- On the ACTIONS panel, click ADD NEW.
- Under the FORM DETAILS tab, select a Tenant in the Tenant drop-down list, select the tab where you want to display the Custom Fields in the Display At drop-down list and click NEXT.
Figure: FORM BUILDER page: FORM DETAILS tab - 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, Form Templates sections. Drag and drop it in 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.
- Click the Remove Field icon to remove the Custom Field. You can also change the sequence of the fields by dragging them up and down. For more information about the various types of fields and their properties, see Field Description.
Click SAVE AS TEMPLATE button to save the Form as template. 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 re-used.
Figure: Save Form pop-up page
If a Group is selected SAVE GROUP AS TEMPLATE button is displayed. Click the SAVE GROUP AS TEMPLATE button to save 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 re-used. Click NEXT.
Figure: Save Group pop-up page
Figure: FORM BUILDER page: FORM BUILDER tab- Under the PREVIEW tab, you can view the Custom Fields that you added.
Click SAVE. The Custom Fields are configured.
Figure: FORM BUILDER page: PREVIEW tab
Field Description
The following table describes the field types and their properties on the FORM BUILDER tab under the FORM BUILDER page:
Field | Description |
|---|---|
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:
|
Text Box/ Text Area | Click Text Box to create a text box field. Click Text Area to create a text box field that allows more characters compared to text box field. For example, for User Name, use Text Box and 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 the users can be searched. Type in the required values for the following properties:
|
MV Drop-down | Click MV Drop-down to create a Multi Valued drop-down field. The Multi-Valued Drop-down control allows the user to type or select multiple values from a list of predefined options.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. |
Scenario
Add a new Custom Field (Label Name: Workgroup) using drop-down control and use Custom Table's Custom Data as a data source.
To Add a New Drop-down Custom Field for Change Management:
Select Admin > Basic > Infrastructure > Form Builder.
Select the required Tenant and Module as Change Management. The CUSTOM ATTRIBUTES FOR CHANGE MANAGEMENT page is displayed.
On the ACTIONS panel, click ADD NEW.
Under the FORM DETAILS tab, select a Tenant in the Tenant drop-down list, select the tab where you want to display the Custom Fields in the Display At drop-down list.
- Click NEXT. The FROM BUILDER tab is displayed.
On the FORM BUILDER tab drag and drop the Drop-down control under Default Group.
Type in the Label as Workgroup.
Select the data source as Custom Table from Options drop-down list.
Select the data source table name from Table Name drop-down list (Ex: Workgroup_Table).
Select the data source for the control from Column Name drop-down list (Ex: Workgroup).
Figure: FORM BUILDER tab: Simple Controls: Drop-down- Click NEXT. Under the PREVIEW tab you can view the custom field that you added.
- Click SAVE. A saved successfully pop-up message is displayed.
Dropdown Mapping
A Single Value Drop-down can have a Single Value or a Multi Value Drop-down as Child.
Figure: Single Select vs Multi Select Dropdown
Example
Adding a Multi Value (MV) dropdown named Country as Child to Single Value (SV) Dropdown Continent.
To Add a MV Drop-down as Child for Change Management:
1. Select Admin > Basic > Infrastructure > Form Builder.
2. Select the required Tenant and Module as Change Management. The CUSTOM ATTRIBUTES FOR CHANGE MANAGEMENT page is displayed.
3. On the ACTIONS panel, click ADD NEW.
4. Under the FORM DETAILS tab, select a Tenant in the Tenant drop-down list, select the tab where you want to display the Custom Fields in the Display At drop-down list.
5. Click NEXT. The FROM BUILDER tab is displayed.
6. On the FORM BUILDER tab drag and drop the Drop-down control under Default Group and name it as Continent
7. Drag and Drop a Multi Value Drop-down control under Default Group and name it as Country.
The Multi-Valued Drop-down control allows the user to type or select multiple values from a list of predefined options. Type in the required values for the following properties:
Figure: Adding Single Value Dropdown as Parent to Multi Value Dropdown.
| Field | Description |
|---|---|
| Label | Type in the label name for the MV Drop-down. |
| Required | Select the Required check box to make this field as a mandatory field. |
| Size | Select the size of the field, Small, Medium, Large. |
| Options | Select the appropriate options for the drop-down list. Following are the available options: |
| Custom Attribute | If selected, the Table Name field is displayed. Select the required Custom Table from the Table Name drop-down list. If selected, the Column Name field is displayed. Select the required data source column name from Column Name drop-down list. For information, see Example. |
| Parent | A Multi Value Drop-down field can have a Single Value or a Multi Value Drop-down field as Parent. |
On selecting Parent field, Options Mapping must appear where you can map a Child value to Parent value.
On Expanding the parent dropdown, all the Parent values will be displayed for selection.
One Parent Value can be mapped to multiple child values, for example:
Parent = Continent = Africa
Child = Country = Africa and Botswana
ACTIONS
This section explains all the icons displayed on the ACTIONS panel of the FORM BUILDER page.
SHOW LIST
Click SHOW LIST to display the LIST table showing all the configured Custom Fields for the selected Tenant.
Figure: FORM BUILDER page: List of Change Management Custom Fields
- To update a Custom Field, select the respective tab name check box and click the EDIT icon on the ACTIONS panel. Make appropriate changes and click SUBMIT.
- To display the inactive Custom Fields, click the Include Inactive check box.
Note:
When the Custom Fields are displayed under the LIST table, the ADD NEW action is displayed on the ACTIONS panel. Click ADD NEW to configure a new Custom Field.
VALIDATE CONTROLS
Click VALIDATE CONTROLS to configure conditions to validate and take actions on the Custom Attributes. Upon clicking VALIDATE CONTROLS, the VALIDATE CONTROLS pop-up page is displayed.
Figure: VALIDATE CONTROL pop-up page
On the VALIDATE CONTROLS pop-up page, select the group name in the Group drop-down list. The groups are configured under the FORM BUILDER tab. On selecting the group, all the Rules configured for Group Attributes are displayed on a table.
- Click on the Rule ID link to edit the Rule.
- Click to delete the Rule.
- Click to add a new Rule for the selected group.
Figure: VALIDATE CONTROLS page
Select the Group Attribute in the drop-down list, specify the Condition and configure the Action for the Condition. For more information about the fields, see Field Description.
Field Description
The following table describes the fields on the VALIDATE CONTROLS page:
Field | Description |
|---|---|
RULES tab | |
AND | Click the AND tab to add Rule using the AND operand for configuring Rules for the selected Custom Attributes. If the AND operand is selected,all the Rules defined under it have to be successful to implement the Action. To add Rules: Select the Custom Attribute for which you want to configure the Rule from the list. Choose the operator from the list. Type in the value you want to equate with the Rule. |
OR | Click the OR tab to add rule using the OR operand for configuring Rules for the selected Custom Attributes. If the OR operand is used then at least one of the Rules has to be successful to implement the Action. |
Add Rule | Click Add Rule to add another row of Rules. |
Add Block | Click Add Block to add another block of Rules configuration. |
Delete Block | Click Delete Block to delete the additional row of Rules configuration. |
Delete | Click Delete to delete the configured Rule. |
Next | Click Next to move to the next tab. |
Save | Click Save to save the configured details. |
Click to view the list of configured Rules. | |
ACTION tab | |
Script Type | Lists the Script Types.
Select the Script Type from the list. |
Action | Lists the Actions.
Select an Action from the list. |
Target Attribute | Specify the target attribute on which the selected action has to be performed. |
Event Type | Lists the Event Types.
Specify the Event Type from the list. |
Add | Click add to add the configured Action to the Script. |
Preview | You can preview the Script in this text box. |
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.
References
- To configure Custom Fields for Users, see Configuring Custom Fields for Users in SUMMIT General Online Help.
- To configure Custom Fields for Customers, see Configuring Custom Fields for Customers in SUMMIT General Online Help.
Confluence Cloud Migration Alert: Please refer to known issues you may encounter in Confluence Cloud: https://eitdocs.atlassian.net/wiki/x/wDGwAQ