Service Number Profile Tags

Service Number Options

N2FE supports the editing of the following OCNCC/OC3C service number profile tags:

Name Description
Bar Payphone Callers Whether to restrict payphone callers from calling the service number.
Bar Cellphone Callers Whether to restrict cellphone callers from calling the service number.
Toll Free Beeps Required Select to play the toll free beep.
Follow Me Number Used to put the follow me number into the service number profile, which is used by the Set Pending TN From Profile node.
Language The default language for interactions (announcements and notifications) for the service number.
PIN Use to specify the PIN that will be put into the service number profile, which is used by PIN Authorisation node.
FCI Turn on furnish charging information to provide charging information to the switch for the purpose of writing CDR’s.
Service Code The service code to send in the FCI to the switch.
Country Code The country code to send in the FCI to the switch.
Restriction Ignore Used to indicate whether to ignore number restriction.
Restriction List The list of numbers to be restricted.
Restriction Type Defines the type of restriction for the restricted number list.

N2FE supports the ability toggle edit-ability of profile fields as well as the ability to define through regular expressions the expected format of each profile value.

N2FE Service Configuration

Service number options can be configured within the main N2FE configuration file /etc/jarvis/n2fe.xml. Within the habitat configuration XML element the following JSON fragment can be altered as required.

"sn_options": {
    "pt_bar_payphone_callers": {
        "show": true
        , "format": "^[0|1]$"
        , "name": "Bar Payphone Callers"
        , "client_type": "boolean"
    },
    "pt_bar_cellphone_callers": {
        "show": true
        , "format": "^[0|1]$"
        , "name": "Bar Cellphone Callers"
        , "client_type": "boolean"
    },
    "pt_divert_address_follow_me": {
        "show": true
        , "format": "^[a-fA-F0-9]{0,32}$"
        , "name": "Follow Me Number"
        , "client_type": "integer"
        , "max_length": 50
        , "validation_error": "Follow Me Numbers have a maximum of 32 characters, and may only include the following characters: a-f A-F 0-9."
    },
    "pt_toll_free_beeps_required": {
        "show": true
        , "format": "^[0|1]$"
        , "name": "Toll Free Beeps Required"
        , "client_type": "boolean"
    },
    "pt_language": { 
        "show": true
        , "format": "^[0-9]*$"
        , "name": "Language"
        , "client_type": "language"
    }, 
    "pt_pin": {
        "show": true
        , "format": "^[a-fA-F0-9]{6,}$"
        , "name": "PIN"
        , "client_type": "integer"
        , "max_length": 16
        , "validation_error": "Pins must have a minimum of 6 characters, and may only include the following characters: 0-9 A-F."
    },
    "pt_fci_enabled": {
        "show": true
        , "format": "^[0|1]$"
        , "name": "FCI"
        , "client_type": "boolean"
    },
    "pt_fci_service_code": {
        "show": true
        , "format": "^[0-9]*$"
        , "name": "Service Code"
        , "client_type": "integer"
        , "max_length": 4
        , "validation_error": "FCI Service Codes have a maximum of 4 characters, and may only include the following characters: 0-9."
    },
    "pt_fci_country_code": {
        "show": true
        , "format": "^[a-fA-F0-9]{0,4}$"
        , "name": "Country Code"
        , "client_type": "string"
        , "max_length": 4
        , "validation_error": "FCI Country Codes have a maximum of 4 characters, and may only include the following characters: a-f A-F 0-9."
    },
    "pt_restriction_ignore": {
        "show": true
        , "format": "^[0|1]$"
        , "name": "Ignore Restrictions"
        , "client_type": "boolean"
    },
    "pt_restriction_list": {
        "show": true
        , "format": "."
        , "name": "Restriction List"
        , "client_type": "restrictionList"
    },
    "pt_restriction_type": {
        "show": true
        , "format": "^[1|2]$"
        , "name": "Restriction Type"
        , "client_type": "restrictionType"
    }
},

Note that this JSON fragment must be included as part of the overall JSON habitat object.

Configuration options include:

Option Applicable Types Description
show All [Required]Whether the option to edit the profile field is editable via the GUI. The server will use this value when saving profile data to ensure that only active fields are updated.
format All [Required]The expected format of the profile field value defined as a Perl regular expression. For more information see the Perl documentation, including the [regular expression tutorial](https://perldoc.perl.org/perlretut.html).
name All [Required]The name of the control as shown within the N2FE GUI. This can either be changed through the habitat configuration or a branding translation file, see Translations for more information.
client_type All [Required]The type of the control to use to set the value on the client side.
  • integer or string for a standard input field.
  • boolean for a yes/no selector.
  • language for language selector.
max_length Integer String Set the max length of a profile input field within the N2FE GUI.
validation_error Integer String The error text to display when an input field within the N2FE GUI fails to correctly validate against the `format` regular expression. This can either be changed through the habitat configuration or a branding translation file, see Translations for more information.