Configure Custom Fields

Custom fields allow you to capture additional information other than what Amplify's data entry fields allow. Use the Properties tab in the Configuration page to create different types of custom fields. Although only administrators can create global custom fields that are shared by all programs, program administrators are able to create custom fields only to be used with their programs and projects. Custom fields created at program-level is only visible to and can only be used by the program and project users.

Program administrators can also create custom fields for specific project items including impacts, RAID items, tasks, costs, and resources.

This article includes the following sections:

• Creating custom fields
• Reordering custom fields
• Making a global custom field accessible within the program
• Disabling a custom field

Creating Custom Fields

To define custom fields that can be used within the program as well as all projects in the program:

1. Access the Program.
2. From the hamburger menu, select Configuration.
3. The Configuration page opens.
4. Click on the Properties tab.
   The Create New Custom Field form displays on the right-hand side panel.
   
5. Enter the field name. 
6. In the Form Field Label field, type in a name that end-users will see.
7. Fill out the fields based on your organisation's requirements. 
   • The value you enter in the Dataset identifier field will be used as a unique identifier used to identify the database field.
   • The Help Text field should contain instructions that will be displayed to the end-user.
8. Use the Control drop-down list to select the type of custom field. If you choose 'Select Box', 'Radio Group' or 'Traffic Light' control, you will be able to enable the Options toggle button on the right-hand side. Use the Add Option button to define selectable options. Use the 'Linked Select' type to create cascading custom fields. 
9. Selecting the Enable Filtering graphs based on this custom field checkbox's values will display the field under the Dashboard filtering options.
10. If you want to allow end-users to input text in markdown format in Textarea type fields, set the Enable Markdown for the Free Text Area setting. 
11. Click on the Create New Field button when done.
    
    

Defining Options for Selectable Fields

 When you create selectable fields, the Options section gets enabled, allowing you to add options before clicking on the Create New Field button.

To define options:

1. Click on the Add Option button. Remember, this button will only be enabled if you choose a selectable type field in the Control field.
   This will expose a text field.
2. Enter the option name in the text field.
3. To add values that represent these options in the system, click on the Provide a custom dataset value setting.
4. Click on the Create New Field button.
   You can see the new field listed under the Custom Fields section on the left-hand side panel. The end-users will see the custom fields program Properties dashboard. 
   

Reordering Custom Fields

By default, custom fields display in the order that they are created. However, you can change the order of these fields in the screens where they are displayed.

To reorder custom fields:

1. Position your cursor over the icon at the beginning of the name of the field that you want to reorder.
   The icon turns into a hand icon.
2. Now drag it to another position.
   

Making Global Custom Fields Available within the Program

Custom Fields defined in the Administration module can be made accessible within all programs and its projects.

To add a shared field to a program:

1. Access the Program.
2. From the hamburger menu, select Configuration.
3. The Configuration page opens.
4. Click on the Properties tab.
5. Scroll down to locate Add shared field on the left-hand side panel.
6. Click in the field and select the desired field.
   All custom fields defined within the Administration module will be available for selection.
   
   This will add the shared field to the program.

Disabling a Custom Field 

If you no longer want a custom field to display on the end-user forms, you will have to unmap it from the program. Unmapping a custom field will essentially delete its association with the program and as a result, make it unavailable locally and for all the projects within unless explicitly enabled. An unmapped item will stop showing on the program Properties dashboard. However, it will be displayed in a disabled state on the program's Properties configuration tab, and you can enable it any time you need to use it. If a global custom field is unmapped from the program, it will have to be added again.

 To unmap a custom field from a program:

1. Access the Program.
2. From the hamburger menu, select Configuration.
3. The Configuration page opens.
4. Click on the Properties tab.
5. Scroll down to locate the custom field you wish to disable.
   
6. Click Yes to confirm and the field will be disabled.