Adding a user-defined field (UDF) - BlueCat Integrity - 26.1.0

Address Manager Administration Guide

ft:locale
en-US
Product name
BlueCat Integrity
Version
26.1.0

You can add an unlimited number of user-defined fields to an object. Fields can be required or optional, can be made searchable, and can be validated through simple data-checking rules. Supported data types include text, date, Boolean, integer, long integer, email address, and URL.

Note: New in Address Manager v25.1.0, the Date data type for user-defined fields now includes a time in addition to the day-month-year value. Upon upgrade to Address Manager v25.1.0, previously configured pre-defined values will automatically be set at 00:00:00 UTC, then converted to the browser's local time when displayed in the UI. Users are recommended to check the conversion of pre-defined UDF date values upon upgrade to v25.1.0 to adjust date/time values as needed.

To add a new user-defined field:

  1. Select the Global tab in the sidebar, then select User-defined fields.
  2. Select New.
  3. Set the following parameters:
    • Name—enter a name to be used by the Address Manager database. This name can't contain spaces.
    • Display name—enter a user-friendly name. This name appears to users in the Address Manager user interface.
    • Object type—select the type of object that you will be adding a user-defined field to. For more information on Address Manager object types, refer to Reference: Object types.
    • Data type—select the type of data that the user-defined field will contain, either: Boolean, Date, Email, Integer, Long, Text, URL, or Workflow.
      Note: The Default value and Predefined values fields below will not be present if the Boolean data type is selected. In addition, the Workflow data type will present different fields, refer to Configuring the Workflow UDF type in Address Manager for more information.
    • Required—when selected, users must enter data in the field when creating or editing the object to which the field applies.
    • Default value—enter a value that will be used as the default value for the user-defined field. When using predefined values, the default value must match one of the values provided in the following Predefined values section.
    • Predefined values—enter a value and select the Add (+) button to add a value to the Predefined values list. If the Predefined values list contains one or more values, the values will be presented in a drop-down list when entering the user-defined field value in the Address Manager GUI.

    For more UDF name best practices, see Best practices for UDF and UDL names.

  4. On the Localized names tab, optionally add localized display names for the user-defined field to facilitate multi-language support for Address Manager. For example, if using the display name address (for English), you could enter dirección in the Spanish field, and adresse in the French field. This way, English, Spanish, and French users will see the locale specific display name for the user-defined field when logged in with a specific language.
  5. On the Validation tab, set the validation properties. The validation properties help ensure that users enter valid data into the field.

    This section won't be available for the Boolean, Workflow, and Date object types.

    Data type Validation properties
    Text Minimum length and maximum length. For example: Minimum length=0, Maximum length=10
    Integer Minimum and maximum values. For example: Minimum=3, Maximum=1000
    Long Minimum and maximum values. For example: Minimum=3, Maximum=1000
    Email Minimum length, maximum length, and pattern. For example: Minimum length=0, Maximum length=10, Pattern=*@b.co*. The wildcard characters supported are * and ?.
    URL Minimum length and maximum length. For example: Minimum length=0, Maximum length=10
  6. In the Change control section, add comments if required.
  7. Select Create or Create and add another.