E.164 phone number field configuration

  • Release version: Xanadu
  • Updated August 1, 2024
  • 9 minutes to read

    • Administrators can use the phone number system properties and dictionary attributes to do certain things.

    The system properties apply the configuration option to all phone number fields that do not have a comparable dictionary attribute. The dictionary attributes apply the configuration only to the phone number field it is added to. Since dictionary attributes take precedence over system properties, administrators can set a global configuration with a property and then apply exceptions on a field-by-field basis.

    Note:
    Alpha numeric characters are not allowed and is not considered as a valid phone number.

    Requiring territory format validation

    By default, phone number fields require that a phone number match the display format of the selected territory.

    By default, phone number fields require that a phone number match the display format of the selected territory. If a phone number does not match this format, the input box displays a red line underneath the phone number or the whole box turns red, and users are prevented from saving it.

    Figure 1. Phone e164 strict

    Setting the glide.phone_number_e164.strict system property to false or adding the pn_strict dictionary attribute allows the phone number input box to display a green line underneath numbers that do not match the territory format listed for the selected territory or the whole box turns green. You can use the Other / Unknown territory to store otherwise invalid phone numbers.

    Figure 2. Phone e164 not strict
    Warning:
    Switching from optional territory format validation to required territory format validation may result in some phone numbers failing validation altogether. In such cases, the E.164 phone number field displays an error message.

    Requiring entry of international format

    By default, users can enter phone numbers in their territory's local format and do not have to format the number for international dialing.

    The phone number field automatically formats local phone numbers into E.164-compliant international phone numbers when the user finishes editing the field. As long as the phone number entered matches the territory's format for a local number, users can save the phone number.

    Figure 3. Phone e164 entry local
    Figure 4. Phone e164 display international

    Changing the glide.phone_number_e164.allow_national_entry system property or adding the pn_allow_national_entry dictionary attribute requires users to enter a phone number in the territory's international format, which starts with the plus (+) character. Users cannot save a locally formatted phone number, and the phone number input box displays a red line underneath phone numbers without the proper international formatting.

    Configure the display of the local format

    By default, an E.164 phone number field always displays phone numbers in an international format.

    Figure 5. Phone e164 display international
    North American phone number displaying in local format.
    Change the E.164 phone number to use the local format in certain circumstances by adding the following system property:
    Table 1.
    Property Description
    glide.phone_number_e164.display_national
    • Type: string
    • Default value: false
    • Other possible values:
      • true or form: Displays phone numbers in a local format on forms, but displays an international format on lists.
      • all: Always displays phone numbers in a local format.
      • user: Only displays phone numbers in a local format when the phone number matches the local setting of the current user.
      • false: Does not display phone numbers in local format.
    Select one of the possible values to determine how the system handles the E.164 phone number.
    You can also add the following dictionary attribute to a specific field to override the system property:
    Table 2.
    Dictionary attribute Description
    pn_display_national Overrides the glide.phone_number_e164.display_national property setting for how an E.164 phone number field displays phone numbers. Available values are identical to those described for the glide.phone_number_e164.display_national property.
    • Type: string
    • Default value: false
    • Example:pn_display_national=all

    Configure the display of territory labels

    A property controls how territory labels are displayed.

    You can display territory labels next to the number in an E.164 phone number field by setting the system property or adding the dictionary attribute. This display is useful if the territory selector choice list is turned off and you want the user to see the territory for the entered phone number.

    Figure 6. E164 phone display territory labels
    Phone display with the phone number +44 01733 753363 and the territory label United Kingdom.

    Enabling territory labels also displays the phone territory in lists.

    Add the following system property to display the territory label next to the number in an E.164 phone number.
    Table 3.
    Property Description
    glide.phone_number_e164.display_territory_text Determines when an E.164 phone number field displays a territory label.
    • Type : string
    • Default value: read-only
    • Other possible values:
      • all: Displays the territory label.
      • national: Displays the territory label only if the phone number is in local format.
      • read-only: Displays the territory label in read-only mode, regardless of whether the number is in local or international format.
      • read-only-national: Displays the territory label in read-only mode only if the number is in local format.
      • list: Displays the territory label in a list.
      • list-national: Displays the territory label in a list if the number is in national format.
      • none: Does not display the territory label.
    You can also add the following dictionary attribute to a specific field to override the system property:
    Table 4.
    Dictionary attribute Description
    pn_display_territory_text Overrides the glide.phone_number_e164.display_territory_text property that defines when a phone number field displays a territory label. Available values are identical to those described previously for the glide.phone_number_e164.display_territory_text property.
    • Type: string
    • Default value: read-only
    • Example:pn_display_territory_text=all

    Configure the international direct dialing prefixes

    A property is available to control the display of prefixes.

    You can enable the display of the international direct dialing prefix, which appears between the territory selector choice list and the input box for an E.164 phone number field on forms, by setting the system property or adding the dictionary attribute.

    Figure 7. E164 phone display idd
    Phone display with the international direct dialing prefix before the phone number field
    Add the following system property to display the international direct dialing prefix.
    Table 5.
    Property Description
    glide.phone_number_e164.display_users_idd Determines whether to display the international direct dialing prefix between the territory selector choice list and the input box on forms.
    • Type: true | false
    • Default value: false
    You can also add the following dictionary attribute to a specific field to override the system property:
    Table 6.
    Dictionary attribute Description
    pn_display_users_idd Overrides the glide.phone_number_e164.display_users_idd property that determines whether to display the international direct dialing prefix between the territory selector choice list and the input box on forms. Available values are identical to those described above for the glide.phone_number_e164.display_users_idd property.
    • Type: true | false
    • Default value: false
    • Example:pn_display_users_idd=false

    Configure the phone territory selector choice list

    By default, an E.164 phone number field always displays the phone territory that is associated with the phone number.

    Changing the system property or adding the dictionary attribute hides the territory selector choice list. If the territory selector choice list is hidden, users can only enter a local or national number.

    Figure 8. Phone e164 hide selector
    Number field with no selector displayed.
    Add the following system property to show or hide the territory selector choice list.
    Property Description
    glide.phone_number_e164.display_territory_selector Determines whether to display the territory selector choice list. Hiding the territory selector choice list restricts users to entering only local or national phone numbers.
    • Type: true | false
    • Default value: true
    You can also add the following dictionary attribute to a specific field to override the system property:
    Dictionary attribute Description
    pn_display_territory_selector Overrides the glide.phone_number_e164.display_territory_selector property setting that determines whether to display the territory selector choice list. Available values are identical to those described above for the glide.phone_number_e164.display_territory_selector property.
    • Type: true | false
    • Default value: true
    • Example: pn_display_territory_selector=false

    E.164 phone number field system properties

    Several properties are available to configure E.164 phone number fields.

    Note:
    To open the System Properties [sys_properties] table, enter sys_properties.list in the navigation filter.
    Table 7. e.164 phone number field system properties
    Property Description
    glide.phone_number_e164.strict Determines whether all phone number fields must match the display format for the selected territory.

    When the value is true, the phone number input field displays a red line underneath the phone numbers that do not match the format for the selected territory. Users cannot save the phone number.

    When the value is false, the phone number input field displays a green line underneath phone numbers that do not match the format for the selected territory. Users can save the phone number. The territory selector choice list offers the option to select an Other / Unknown territory format.

    • Type: true | false
    • Default value: true
    • Location: Add to the System Properties [sys_properties] table.
    glide.phone_number_e164.allow_national_entry Determines whether users can enter phone numbers in the local format or whether they must enter phone numbers in international format.

    When true, users can enter phone numbers in the local format for the selected territory. When false, users must enter phone numbers in the international format for the selected territory.

    • Type: true | false
    • Default value: true
    • Location: Add to the System Properties [sys_properties] table.
    glide.phone_number_e164.display_national Determines whether to display E.164 phone numbers in local format.
    • Type: string
    • Default value: false
    • Other possible values:
      • true or form: Displays phone numbers in a local format on forms, but displays an international format on lists.
      • all: Always displays phone numbers in a local format.
      • user: Only displays phone numbers in a local format when the phone number matches the local setting of the current user. The local setting of the current user is determined by the location associated with the user record.
      • false: Does not display phone numbers in local format.
    • Location: Add to the System Properties [sys_properties] table.
    glide.phone_number_e164.display_territory_selector Determines whether to display the territory selector choice list. Hiding the territory selector choice list restricts users to entering only local or national phone numbers.
    • Type: true | false
    • Default value: true
    • Location: Add to the System Properties [sys_properties] table.
    glide.phone_number_e164.display_territory_text Determines when an E.164 phone number field displays a territory label.
    • Type: string
    • Default value: read-only
    • Other possible values:
      • all: Always displays the territory label.
      • national: Displays the territory label only if the phone number is in local format.
      • read-only: Displays the territory label in read-only mode, regardless of whether the number is in local or international format.
      • read-only-national: Displays the territory label in read-only mode only if the number is in local format.
      • list: Displays the territory label in a list.
      • list-national: Displays the territory label in a list if the number is in national format.
      • none: Does not display the territory label.
    • Location: Add to the System Properties [sys_properties] table.
    glide.phone_number_e164.display_users_idd Determines whether to display the international direct dialing prefix between the territory selector choice list and the input field on forms.
    • Type: true | false
    • Default value: false
    • Location: Add to the System Properties [sys_properties] table.

    E.164 phone number field dictionary attributes

    You can override the global system property with certain dictionary attributes.

    Table 8. e.164 phone number field dictionary attributes
    Dictionary attribute Description
    pn_strict Overrides the glide.phone_number_e164.strict property setting that requires all phone number entries match the format for the selected territory. Available values are identical to those described for the glide.phone_number_e164.strict property.
    • Type: true | false
    • Default value: true
    • Example:pn_strict=false
    pn_allow_national_entry Overrides the glide.phone_number_e164.allow_national_entry property setting that determines whether users can enter phone numbers in the local format or whether they must enter phone numbers in international format. Available values are identical to those described for the glide.phone_number_e164.allow_national_entry property.
    • Type: true | false
    • Default value: true
    • Example:pn_allow_national_entry=false
    pn_display_national Overrides the glide.phone_number_e164.display_national property setting for how an E.164 phone number field displays phone numbers. Available values are identical to those described for the glide.phone_number_e164.display_national property.
    • Type: string
    • Default value: false
    • Example:pn_display_national=all
    pn_display_territory_selector Overrides the glide.phone_number_e164.display_territory_selector property setting that determines whether to display the territory selector choice list. Available values are identical to those described for the glide.phone_number_e164.display_territory_selector property.
    • Type: true | false
    • Default value: true
    • Example: pn_display_territory_selector=false
    pn_display_territory_text Overrides the glide.phone_number_e164.display_territory_text property that defines when a phone number field displays a territory label. Available values are identical to those described for the glide.phone_number_e164.display_territory_text property.
    • Type: string
    • Default value: read-only
    • Example:pn_display_territory_text=all
    pn_display_users_idd Overrides the glide.phone_number_e164.display_users_idd property that determines whether to display the international direct dialing prefix between the territory selector choice list and the input box on forms. Available values are identical to those described for the glide.phone_number_e164.display_users_idd property.
    • Type: true | false
    • Default value: false
    • Example:pn_display_users_idd=false