Custom Fields Screen

Overview

Custom fields allow you to capture and display additional data on various system elements (accounts, packages, usage records, etc.) for reference/reporting purposes or in order to expose the information externally (e.g. displaying the data on an invoice or presenting the data in a web portal via API). The order and presentation of custom fields is configured on the layout screen.

Prerequisites

Custom fields can be setup immediately, there are no requirements to setup other system elements.

Custom Fields Panel

The Custom Fields panel on the left of this screen allows you to select existing custom fields to view and edit on the Edit Custom Field panel to the right. Actions are also available in this panel which are shown as icons above the Filter text box. The available actions are described below.

Actions

Icon	Description
	Deletes the custom field if not in use (added to an entity or layout)
	Adds a new custom field

Edit Custom Field Panel

The information in this panel reflects the currently selected custom field. From here you can change custom field details (fields will display a red left border if a value is required and purple text if the field is read-only and cannot be modified).

Custom Field Fields:

• Name: a name for the custom field (e.g. the data it holds)

• Column Name: the database field name

• Description: additional details that describe what data is contained in the field

• Hint: hint text that will appear in the field to indicate what the user should input

• Required: if enabled the user will be required to populate the custom field in order to add/update the entity that the custom field is attached to

• Default Value: sets a default value in the custom field on the UI when adding an entity which contains the custom field

Value tab

This tab appears when the custom field has been configured to provide a list of values to select from. On this tab you can add, edit or remove values presented in the custom field list and adjust the order that the list items appear in.

Validation tab

This tab allows you to set the format that the data typed into the custom field by the user must conform to. This tab will not appear if the value is selected vs. inputted (e.g. if the 'Field Type' setup when adding the custom field is 'Date' this tab will not appear as dates are selected not typed in by the user). You can select a 'Custom' validation on this tab if you wish to supply your own Regex that the data entered must match.

Lookup tab

This tab appears when the custom field has been added with the 'Lookup' option enabled. Lookup custom fields are configured to pull data from the system in order to automatically populate the custom field.

References tab

This section displays where the selected custom field is used in the system. By default the reference data is displayed in a summary format to indicate where the field is in use, however the Entity drop down field can be used to view the exact system objects that the custom field is configured on.

Guides

Adding Custom Fields

1. Under the Custom Fields heading on the left click the  icon

2. On the Add Custom Field modal that loads specify the Entity which the custom field will be attached to (an account, account package, etc.)

3. Specify the Field Type (string, date, number, etc.) that the custom field will capture/contain

4. If you wish to provide users with a list of options to select from enable the List checkbox. Note that this list option will be greyed out if the data type only supports specific field values (e.g. a singular date/time or a boolean type which has two set values to select from)

5. If you wish the custom field to be auto-populated by referencing data in the system vs. user input select the Lookup option

6. For custom fields with the 'List' option set you can allow the user to select multiple values in the list by checking the Allow Multiple Selection option

7. Click Add to continue configuring the custom field on the Add Custom Field panel.

8. Click Save when finished configuring the custom field

9. To display the custom field on the entity it was configured on (an account, package, etc.) add the custom field to a layout

Editing Custom Fields

1. Under the Custom Fields heading on the left click the custom field you wish to edit

2. Under the Edit Custom Field heading on the right modify the custom field details

3. Click Save when you have finished making changes

Deleting Custom Fields

1. Under the Custom Fields heading on the left select the custom field you wish to delete

2. Under the same Custom Fields heading click the  icon

3. On the confirmation dialog that appears select Yes