Screen Extensions with Custom Fields

Every customer has unique businesses processes and a need to capture data that is custom to their operations. For instance, a customer might want to add a Profit Center to the Account Screen to track their multiple profit centers. Profit center would be a dropdown containing a list of curated profit centers for that customer (e.g. Atlanta, Orlando .). The information captured in this field would be displayed in associated reports such as a revenue recognition report. As another example, when adding a service or device several pieces of data might be added. These may be subsequently used in provisioning calls. Custom fields can be used to handle these scenarios.

Custom fields can be added to the following entities in the system : account, package, package frequency, account package and account service. The admin console offers a UI driven workflow for defining new custom fields on these entities. The following attributes need to be specified during custom field creation:

  • Display Name: The custom field display name. This will show up on the UI as the field name
  • Field Name: Internal reference and is used for integration purposes, such as custom controls and the API.
  • Description: Description of the field
  • Required: Whether to enforce that a value is always required
  • Default Value: Default value for the field

Associated with a custom field is the ability to enable or disable. Disabling a custom field hides it from the UI. The data will still be held in the system but is not viewable through the UI. A field that has been disabled cannot be re-enabled again. Custom field definitions can be deleted. Deleting a custom field removes it from the system - all data associated with the custom field will be permanently deleted or anonymized.

Custom field content can be displayed on reports, account screens, dashboards and the overview screen. Validation rules are supported on custom fields to maintain the integrity of data collection. The type of validation allowed will be based on the type of custom field. For instance, if the field is a text field, a validation rule can be added to ensure that only alpha numeric values can be added to the text field.

Custom Field Types

Different types of custom fields are available in the system. These are displayed in the table below:

Field TypeDescription
Boolean CheckboxTriggered on a service state transition (Preactive->Active, Active->Suspended …)
DateAllows users to enter a date or pick a date from a popup calendar.
Date/TimeAllows users to enter a date or pick a date from a popup calendar and enter a time of day. They can also add the current date and time by clicking the date and time link next to the field. The time of day includes AM or PM notation. In reports, you can limit the data by specific dates and times using any custom date field.
EmailAllows users to enter an email address of up to 254 characters, which is validated to ensure proper format. If this field is specified for contacts or leads, users can choose the address when clicking Send an Email. Note that you can't use custom email addresses for mass emails.
NumberAllows users to enter any number. This is treated as a real number and any leading zeroes are removed.
PercentAllows users to enter a percentage number as a decimal—for example, 0.10. The system automatically converts the decimal to a percentage—for example, 10%.
PhoneAllows users to enter any phone number. Character limit is 40. EngageIP automatically formats it as a phone number.
DropdownLets users select a single value from a defined list.
Multi-select dropdownSelect multiple values from a defined list
StringAllows users to enter any combination of letters, numbers, or symbols. You can set a maximum length, up to 255 characters.
DescriptionAllows users to enter multiple characters that display on separate lines similar to a Description field. You can set the length of this field type to a lower limit, if desired. Any length up to 131,072 characters is allowed.
Calculated FieldA read-only field that is calculated from a user defined formula. The formula field is updated when any of the source fields change.

Several types of calculated fields can be defined. These are enumerated below:

Calculated Field TypeDescription
DateCalculate a date, for example, by adding or subtracting days to other dates.
Date/TimeCalculate a date/time. by adding or subtracting a number of hours or days to another date/time.
NumberCalculate a numeric value
PercentCalculate a percent and automatically add the percent sign to the number.
StringCreate a text string, for example, by concatenating other text fields.
TimeCalculate a time, for example, by adding a number of hours to another time.