Environment Custom Fields Customization

Introduction

Custom Fields appear under the Additional Information tab when adding or editing an Environment on the Environment Manager page. This article provides an overview of steps to add/update the custom fields.

Pre-requisite

To be able to customize the Environment Custom Fields, you must have ‘Access Customizations’ User Permission

Settings  > Customization > Environment > Custom Fields

Add or Edit an Environment Custom Field

To add or edit an Environment Custom Field:

  1. Navigate to Customization’ page and click Environments.
  2. Click Custom Fields.
  3. To add a new field, click . The system adds a line on the grid for the new field. To edit an existing custom field, search and click on the custom field from the grid and then click 
  4. Enter/update the following details:
ColumnsDescription
ValueEnter the custom field name. Custom Fields with double quotes ” " or square brackets [] in the Value cannot be added to Plutora Analytics workbooks.
DescriptionEnter a description for the field.
Description DisplaySelect the description display type.
As Tooltip: The description will appear as a tooltip when you hover the mouse cursor over the button beside the custom field label.
Under Label: The description will appear as text under the custom field label. It will also appear as a tooltip when you hover the mouse cursor over the description.
Data TypeSelect the Data Type of the field from the drop-down menu. For details on these data types, see Custom Field Data Type.
Tab ParentSelect which tab the field should appear under from the drop-down menu.
Group FieldsSelect which group the field should appear inside from the drop-down menu
Field PermissionsSelect the field permissions (view, edit, and hide permissions) for each field. For details, see Manage Field Permissions.
MandatorySelect if the field is mandatory for users to fill in.
  1. Click  .

Your changes will be saved and a confirmation message will display.

Add, Edit or Delete Tabs

To manage custom field tabs on the ‘Additional Information’ tab on the Environment dialog:

On the ‘Customization’ page, navigate to Environment > Custom Fields.  Click . ‘Add/Edit Custom Field Tabs’ display.

  • To add a tab: Click  and enter the new tab name.
  • To edit a tab: Double click the tab that you want to edit and make changes.
  • To delete a tab: Select the tab that you want to delete and then click 

Close the pop-up by clicking the X at the top-right corner. You can view the changes by clicking the Tab Parent column. 

Add, Edit, or Delete Groupings

To manage custom field groups on the Additional Information panel on the Environment dialog:

On the ‘Customization’ page, navigate to Environment > Custom Fields.  Click . ‘Add/Edit Custom Field Grouping’ display.

  • To add a grouping: Click  and enter the new grouping name. Double click the Color column and select a color from the drop-down menu or enter a Hex value.
  • To edit a grouping: Double click, then edit the grouping. Double click the Color column and select a color from the drop-down menu or enter a Hex value.
  • To delete a grouping: Click to select the grouping. Click 

Close the pop-up by clicking the X at the top-right corner. You can view the changes by clicking the Group Fields column. 

Bulk Update Permissions

To update the permissions of two or more Environment Custom Fields at once:

  1. On the ‘Customization’ page, navigate to Environment > Custom Fields.  
  2. Select two or more custom fields (check the checkboxes)
  3. Click . The button will be grayed out until you select two or more checkboxes.
  4. On the ‘Bulk Update Fields Permissions’ dialog, from the Select the permission type you would like to change drop-down menu select an option. For detail on these options, see Manage Field Permissions.
  5. Select an option from the By drop-down menu. For detail on these options, see Manage Field Permissions
  6. Click .

The system updates the permissions and the ‘Customization’ page is back to display.

Sort Environment Custom Fields

Sort Manually

Sorting Environment Custom Fields manually changes their order on the ‘Additional Information’ section.

To sort manually:

  1. On the ‘Customization’ page, navigate to Environment > Custom Fields. 
  2. Hover your mouse cursor over the sort column of the field that you want to sort.  appears.
  3. Drag and drop the the field as you require.
  4. Click .

Your changes will be saved and a confirmation message will display.

Sort by Column Header

Sorting Environment Custom Fields by column header only changes their order on the ‘Customization’ page.

To sort alphabetically on the ‘Customization’ page by column header, click on the column header. ↑ or ↓ displays indicating the ascending or descending column sort.

The Environment Custom Fields will revert to their previous order when you click away from the ‘Customization’ page.

Sort Fields Inside Tabs

To sort the fields inside tabs:

  1. On the ‘Customization’ page, navigate to Custom Fields page.
  2. Click . ‘Field Ordering’ dialog displays.
  3. Click the tab that you want to sort.
  4. Hover your mouse cursor over the sort column.  appears.
  5. Drag and drop the field as you require.
  6. Click .

Delete an Environment Custom Field

Deleting an Environment Custom Field will not delete it from Plutora. But it will no longer be available when creating new Environments.

To delete:

  1. On the ‘Customization’ page, navigate to Environment > Custom Fields.
  2. Select the Custom Field that you want to delete.
  3. Click .
  4. Click .

Your changes will be saved and a confirmation message will display.

More Information

Location of Environment Custom Fields

To locate the Environment Custom Fields:

  1. Navigate to Environment > Manager.
  2. Click to open an Environment.
  3. The ‘Environment’ Custom Fields are located under the Additional Information tab.

Custom Field Data Types

Manage ‘Field Permissions’

Field Permissions set the view, edit, and hide permissions for each field:

  1. Click the checkbox next to  to activate permissions.
  2. Click . ‘Fields Permissions for field:…’ dialog display.
  3. From Select the permission type you would like to change drop-down menu select an option:
Permission TypeDescription
View Custom Field Users with this permission can view and edit the field. The field is hidden from users without this permission.
‘View Custom Field’ overrides the other two permissions. If a user has ‘View Custom Field’ permission, no other users will be able to see the field, even if those other users have ‘View Value’ or ‘Edit Value’ permissions.
If User 1 has ‘View Value’ permission on a field, User 2 has ‘Edit Value’ permission, and User 3 has ‘View Custom Field’ permission: The field will be hidden for User 1 and User 2, and will be locked for User 3. Remove the permissions of User 1 and User 2 to make the field editable for User 3.
View ValueIf User 1 has the ‘View Value’ permission and no other user has been given permissions, then User 1 will be able to view and edit the field. The field will be locked (show ) and will be non-editable to users without any permissions.
If User 2 has ‘View Custom Field’ permission, only User 2 will be able to see the field.
If User 1 has the ‘View Value permission’ and User 2 is given ‘Edit Value’ permission, User 2 will be able to view and edit the field and User 1 will only be able to view the field (the field will be grayed out). The field will be locked and non-editable to users without any permissions.
If User 3 has ‘View Custom Field’ permission, only User 3 will be able to see the field.
Edit ValueIf the User has this permission, they can view and edit the field. If a user has ‘View Custom Field’ permission, no other users will be able to see the field,
  1. Select from the By drop-down menu:
    • Individual: Select the checkboxes of one or more users.
    • Organization: Select the checkboxes of one or more organizations or Portfolio Associations.
    • Role: Select the checkboxes of one or more roles.
    • User Group: Select the checkboxes of one or more User Groups.
  1. Click .

‘Submit’ Button

 After making the required changes, ensure you click . If you click away from the ‘Customization’ page without clicking , your changes will not save.

Related Articles

Contents

Be the first to find out about new features. Subscribe to the Release Notes email.

Was this article helpful?

Thanks for your answer!