You will first need to define the field properties, then map it to one or more classifications. If your field is selectable, you will additionally need to define the options for the field.
This article discusses:
- How to create a custom field
- How to map a custom field to a classification
- How to define options for selectable custom fields
Creating a Custom Field
To create a custom field:
- From the upper-right corner, click on your user name or avatar and then select Administration from the list of options.
- Select the Custom Fields tab.
This will display the list of existing custom fields.
- Click on the Define a new Custom Field button.
The New Custom Field form displays.
- Enter a name and label for the custom field.
- In the Dataset Identifier field, enter a string that will be used to identify this custom field in datasets. This is required if you want this custom field to appear in reports and API views. The identifier can contain only alphanumeric characters and underscores.
- In the Help text field, enter a description for the custom field.
- Use the Control drop-down list to select the custom field type. The available custom field types are:
- If you want to use the custom field as a filter criterion on the dashboards, enable the Reporting Group option.
- To mark the custom field as a mandatory field, select Mark this custom field required.
You will be required to specify a default value.
Please note that the default value will be utilised only when the mapped object is created on interfaces where there is no full form to enter the required value.
For example, if the Map interface is used to create a benefit, the mandatory custom field mapped to the benefit classification will be prefilled with the default value. This will ensure that the required input is not missing in the field. You can access the full form if you want to change the value. On the other hand, if the New Benefit form is used to create a benefit, the custom field will be required but not defaulted to any value.
Other interface areas where default values are utilised in a similar way include the pathway, simple measures, business cases, shared teams and the Gantt interface (when used for creating external dependencies).
- The Max Length field allows you to set the maximum number of characters allowed in a text or text area character field. Enter 0 in this field if you don't want to set any limit.
- Click on the Create Field button.
You have now created a custom field. If you created a section field or a radio group, after this step you will need to define the optional values for the field.
Mapping the Custom Field to a Classification
You must map the custom field to specific classifications in order for it to be visible in those areas of Amplify interface where the mapped classifications are utilised. For example, to add a custom field to the task table in the Schedule sub-menu, you must map your custom field to Schedule Tasks.
- To map this field to a classification, select the classification from the drop-down list under the Mappings section.
- Click on the Update Mapping button.
The mapping is now saved.
Defining Options for Selectable Custom Fields
If you selected Select box or Radio group from the control list you will require to create options for the user to select.
- Click on the Create an option button to reveal a set of fields.
- Fill the required details.
- Select Make this the default selection if you want this option to be the one that is selected by default.
- Click on the Save button.
- Repeat the above steps to create all options.
Once you have created options for a sect box or radio group custom field, you can validate the fields.
- Go back to the Custom Fields page.
- Click on the select box or radio group that you recently created and view the options.
All options that you configured should be listed.