Page Comparison

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.

...

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).

...

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.

...

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