Authorization Code Table

The Authorization Code Table object provides overall configuration for a set of Authorization Codes on the MetaSwitch NE. Each table defines a group of different codes that are used in the same way (for example the same service provided to a number of different subscribers, with a separate code for each subscriber); each code is defined by an Authorization Code child object of the table.

The Authorization Code Table object is a child of the Authorization Code Tables object.


If you disable this object, subscribers will be unable to make calls for which these authorization codes are required.

To view details of individual Authorization Codes, click on the symbol next to the Authorization Codes object. To hide individual Authorization Codes, click on the symbol next to the Authorization Code Table object.


Parameter

Access

Description
Description Change Unique user-friendly name identifying the Authorization Code Table. Specify a name of up to 32 characters.
Authorization Code Length Change Inactive / Read only The number of digits in Authorization Codes in this table. If there are any child Authorization Code objects, this field is read only; otherwise you can specify a value in the range 1 - 15.
PIN Change Inactive / Read only Specifies whether the subscriber must enter a PIN (personal identification number) in addition to the authorization code. Values:
  • None (default)
  • Required
If there are any child Authorization Code objects, this field is read only.
Maximum incorrect attempts Change Inactive Maximum number of consecutive times that the subscriber may enter an incorrect authorization code or PIN before his or her service is blocked. If the subscriber enters an incorrect code for a number of consecutive attempts that exceeds this value, the NE automatically blocks the use of the appropriate authorization code. You can remove the block from the child Authorization Code object, allowing subscribers to use the code again. When an account is locked out, an entry is made in the log. Specify a value in the range 0 - 50. The default is 10. A value of 0 (zero) indicates that the subscriber will never be blocked regardless of the number of incorrect code attempts.
Default simultaneous call limit Change Inactive The maximum number of simultaneous calls using each authorization code in this table that can be active at any time. You can override this value for a specific code in the table if required. The default is zero, indicating no limit.
Initial prompt type Change The prompt played to a subscriber when the NE determines that an authorization code is required, prompting the subscriber to enter the code. Values:
  • Tone
    Play a tone.
  • Standard announcement (default)
    Play the standard announcement requesting the authorization code.
  • Customer announcement
    Play the customer-specific announcement identified by the Initial customer announcement field.
Initial customer announcement Change This field appears only if Initial prompt type is Customer announcement. The announcement number of the customer-specific announcement to be played. See the MetaSwitch Class 5 Softswitch Integration and Customization Manual for more details of creating customer announcements.
Destination number prompt Change The prompt played to a subscriber when the NE has accepted the authorization code, prompting the subscriber to enter the destination number. Values:
  • Tone
    Play a tone.
  • Standard announcement (default)
    Play the standard announcement requesting the authorization code.
  • Customer announcement
    Play the customer-specific announcement identified by the Destination number customer announcement field.
Destination number customer announcement Change This field appears only if Destination number prompt is Customer announcement. The announcement number of the customer-specific announcement to be played. See the MetaSwitch Class 5 Softswitch Integration and Customization Manual for more details of creating customer announcements.
Service completed prompt Change The prompt played to a subscriber when the NE has accepted the destination number, before the call is routed to the target destination. Values:
  • None
    Do not provide any prompt.
  • Tone
    Play a tone.
  • Standard announcement (default)
    Play the standard announcement requesting the authorization code.
  • Customer announcement
    Play the customer-specific announcement identified by the Service completed customer announcement field.
Service completed customer announcement Change This field appears only if Service completed prompt is Customer announcement. The announcement number of the customer-specific announcement to be played. See the MetaSwitch Class 5 Softswitch Integration and Customization Manual for more details of creating customer announcements.
Locale Change The language variant used for voice announcements played to subscribers using codes in this table. Values:
  • English (US)
  • English (UK)
  • English (Canadian)
  • User Defined 1
  • User Defined 2
Export - number of objects exported Read only The total number of objects (including child objects) written to the export file so far in the current or most recent export operation.
Export - status Read only The status of the current or most recent export operation, if any. Values:
  • None
  • In progress
  • Succeeded
  • Failed
Export - file Change The name of the text file (in the EMS User's home directory on the EMS Server) to which configuration information for this object will be exported. The maximum length of the filename is 32 characters.
Export - log correlator Read only If the export status is Failed, this field contains a correlator for the log message that contains details of the failure. Click on the 'go to log' button next to this field to jump to this message in the EMS log viewer window.
Export - correlator metaswitch Read only If the export status is Failed, this field contains the name of the EMS Server or MetaSwitch Network Element that generated the failure log. You may need this information to find the log in the EMS log viewer window.
Requested status Read only Specifies whether an administrator has attempted to enable the Authorization Code Table. Values:
  • Enabled
    The object has been enabled.
  • Disabled
    The object has not been enabled or has been disabled.
Actual status Read only Specifies the current status of the Authorization Code Table. Values:
  • Enabled
    The object has been enabled.
  • Disabled
    The object has not been enabled or has been disabled.