Oracle Communications Network Charging and Control Product: Component: OCNCC 4.3 PI Commands (ENUM) Operations Guide S’ware version: Release 3.0.0 Guide version: 02.00 Release date: December 2010 Status: Approved Commercial In Confidence Copyright PI Commands (ENUM) Operations Guide, Release 3.0.0 02.00 Copyright © 2010, Oracle and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065. This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. Page ii PI Commands (ENUM) Operations Guide Commercial In Confidence Contents Copyright .............................................................................Error! Bookmark not defined. About this Document ........................................................................................................... v Document Conventions ...................................................................................................... vi Chapter 1 PI Commands Overview Overview .............................................................................................................................. 1 Command List...................................................................................................................... 2 Parameter Formats .............................................................................................................. 3 Chapter 2 PI ENUM Package Overview .............................................................................................................................. 5 Create a Subscriber or Operator Number Range................................................................ 6 Modify a Subscriber or Operator Number Range ................................................................ 8 Delete a Subscriber or Operator Number Range .............................................................. 11 Query a Subscriber or Operator Number Range............................................................... 13 Create a NAPTR Record ................................................................................................... 15 Modify a NAPTR Record ................................................................................................... 18 Delete One or Many NAPTR Records ............................................................................... 21 Query NAPTR Records ..................................................................................................... 23 Chapter 3 Error Code Lists Overview ............................................................................................................................ 27 PI Chassis Errors ............................................................................................................... 28 PI Command Errors ........................................................................................................... 30 Appendix Overview ............................................................................................................................ 33 Glossary of Terms ............................................................................................................. 35 Index .................................................................................................................................. 37 PI Commands (ENUM) Operations Guide Page iii Commercial In Confidence About this Document Scope The scope of this document includes all the information required to configure the NP Service Pack PI commands. Audience The audience for this document includes system administrators responsible for the monitoring, maintenance, and configuration of the Oracle IN applications. Pre-requisites A solid understanding of UNIX and a familiarity with IN concepts are an essential pre-requisite for safely using the information contained in this technical guide. Although it is not a pre-requisite to using this guide, familiarity with the target platform would be an advantage. This manual describes system tasks that should only be carried out by suitably trained operators. Related documents The following documents are related to this document: Guide changes Here are the changes to the document since the last release. • • PI Technical Guide VPN User's Guide Version no. Revision Date 01.00 02.00 2009-10-07 2010-10-29 Description PI Commands (ENUM) Operations Guide Initial guide based on ENUM phase 2. Re-branded and published. Page v Commercial In Confidence Document Conventions Typographical conventions Before you start using this guide, it is important to understand the terms and typographical conventions used in the documentation. Specialised terms and acronyms are defined in the Glossary at the end of this guide. Formatting convention Type of information Special Bold Items you must select such as menu options, or names of tabs. Emphasis within text. Names of database tables and fields. Italics Name of a document, chapter, topic or other publication. Button The name of a button to click or a key to press. Example: To close the window, either click Close or press Esc. Key+Key Key combinations for which the user must press and hold down one key and then press another. Example: Ctrl+P, or Alt+F4. Monospace Text that you must type and examples of code or standard output. variable Used to indicate variables or text that should be replaced. menu option > menu option > Used to indicate the cascading menu option to be selected, or the location path of a file. Example: Operator Functions > Report Functions Example: /IN/html/SMS/Helptext/ Used to indicate a hypertext link on an HTML page. hypertext link Icons The following icons are used as visual cues to draw attention to important information. Note: Indicates useful and complementary information. Explanation, comment, or short expansion of the text object that is intended to catch your attention. Tip: Indicates practical but non-essential information that makes the solution easier to use or operate (e.g. keyboard shortcut, alternative way to perform a step in a procedure, etc). Warning: Indicates a caution. If this information is ignored, it could cause possible and irreversible damage to the equipment, data or software. Page vi PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 1 PI Commands Overview Overview Introduction The provisioning interface uses TCP/IP-based UNIX sockets to receive provisioning commands and parameters. These are translated into SQL commands that update pre-paid application tables of the SMF and BE Oracle databases. This chapter defines the rules and packages required that translate the provisioning commands into SQL commands. In this chapter This chapter contains the following topics. Command List .................................................................................................2 Parameter Formats .........................................................................................3 PI Commands (ENUM) Operations Guide Page 1 Chapter 1 Commercial In Confidence Command List Command list The following table lists commands and corresponding definitions for the ENUM Provisioning Interface. Each definition requires the installation of the enumPISms package in addition to the installation of the standard piSms package. Function enumPISms Create a subscriber or operator number range ENSO1=ADD Modify a subscriber or operator number range ENSO1=CHG Delete a subscriber or operator number range ENSO1=DEL Page 2 Query a subscriber or operator number range ENSO1=QRY Create a new NAPTR record ENNA1=ADD Modify a NAPTR record ENNA1=CHG Delete one or many NAPTR records Query NAPTR records ENNA1=DEL ENNA1=QRY PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 1 Parameter Formats This table describes the format of each PI parameter. Formats Note: Lengths are largely determined by the size of fields in the database, with exceptions noted in the table. Parameter Format DESCRIPTION Text, 0 to 50 characters DN 3 to 20 digit number ENTRY_TYPE Single character, ‘O’ or ‘S’ FLAGS Text, 0 to 10 characters NAME 1 to 30 character string NAPTR_REF_ID Positive integer NEW_NAME Text, alias for NAME NUM_END Number, the same length as the associated NUM_START NUM_START Number, 3 to 20 digits ORDER Non-negative integer, 0…65535 (16bit unsigned) PREFERENCE Non-negative integer, 0…65535 (16bit unsigned) REGEXP Text, 0 to 50 characters REPLACEMENT Text, 0 to 20 characters SERVICE Text, 1 to 10 characters CASCADE Single character, ‘Y’ or ‘N’ NEW_NAME Alias for NAME NEW_NUM_START Alias for NUM_START NEW_NUM_END Alias for NUM_END NEW_ENTRY_TYPE Alias for ENTRY_TYPE NEW_ORDER Alias for ORDER NEW_PREFERENCE Alias for PREFERENCE NEW_FLAGS Alias for FLAGS NEW_SERVICE Alias for SERVICE NEW_REGEXP Alias for REGEXP NEW_REPLACEMENT NEW_DESCRIPTION Alias for REPLACEMENT Alias for DESCRIPTION Escape characters Where PI command parameters or results are of type: "string", they will conform to the following escape sequences for control character replacement. Control Character Replacement Comma (‘,’) backslash-c (‘\c’) Semi-colon (‘;’) backslash-s (‘\s’) Equals (‘=’) backslash-e (‘\e’) Continued on next page PI Commands (ENUM) Operations Guide Page 3 Chapter 1 Commercial In Confidence Parameter Formats, Continued Escape characters (continued) Relevant parameters Control Character Replacement Pipe (‘|’) backslash-pipe (‘\|’) New-line Backslash (‘\’) backslash-n (‘\n’) backslash (‘\\’) Applicable parameters and results that may have escape characters include (but are not necessarily limited to): • • • • • • • • • • • • Page 4 NAME NEW_NAME FLAGS NEW_FLAGS SERVICE NEW_SERVICE REGEXP NEW_REGEXP REPLACEMENT NEW_REPLACEMENT DESCRIPTION NEW_DESCRIPTION PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 PI ENUM Package Overview Introduction This chapter describes the available PI commands for provisioning ENUM information on the USMS. These commands are added by the enumPISms package. For installation details see the ENUM Control Agent User & Technical Guide. In this chapter This chapter contains the following topics. Create a Subscriber or Operator Number Range ........................................... 6 Modify a Subscriber or Operator Number Range ........................................... 8 Delete a Subscriber or Operator Number Range .......................................... 11 Query a Subscriber or Operator Number Range .......................................... 13 Create a NAPTR Record ...............................................................................15 Modify a NAPTR Record ...............................................................................18 Delete One or Many NAPTR Records .......................................................... 21 Query NAPTR Records .................................................................................23 PI Commands (ENUM) Operations Guide Page 5 Chapter 2 Commercial In Confidence Create a Subscriber or Operator Number Range Description Adds a new entry to the EN_SUB_OP_NAME (SO) table. Required parameters This command requires the following parameters. NAME Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: NAME = <sub/op name> The name of the subscriber or operator. String Mandatory Any 1 to 30 characters inclusive. none Must not be blank, and must not match an existing subscriber or operator. NAME = TelcoEurope NUM_START Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: NUM_START = <value> The start of the number range for this subscriber or operator and ENTRY_TYPE. Integer Mandatory Any, 3 to 20 digits inclusive. None Must not overlap an already defined range which has the same ENTRY_TYPE. NUM_START = 1234567 NUM_END Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: NUM_END = <value> The end of the number range for this subscriber or operator and ENTRY_TYPE. Integer Mandatory Any, 3 to 20 digits inclusive. None • Must not overlap an already defined range which has the same ENTRY_TYPE. • Must be same length as NUM_START. • Must be a higher number than NUM_START NUM_END = 1234589 Continued on next page Page 6 PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 Create a Subscriber or Operator Number Range, Continued Required parameters (continued) ENTRY_TYPE Syntax: Description: Type: Optionality: Allowed: Example: ENTRY_TYPE = <Op|Sub> Flag to indicate type of entry (subscriber or operator). String Mandatory if NAME not specified O or S ENTRY_TYPE = O Constraint required parameters There are no constraint required parameters for this command. Optional parameters There are no optional parameters for this command. Logic and constraints The following rules apply when using the NPDS1=ADD command: The subscriber or operator name as defined by NAME must not be blank, and must not match an existing subscriber or operator. The range defined by NUM_START and NUM_END must not overlap an already defined range which has the same ENTRY_TYPE. NUM_END must be the same length as NUM_START. ENTRY_TYPE must be either ‘S’ for subscriber, or ‘O’ for operator. PI Commands (ENUM) Operations Guide Page 7 Chapter 2 Commercial In Confidence Modify a Subscriber or Operator Number Range Description Changes an entry in the EN_SUB_OP_NAME (SO) table. Required parameters There are no required parameters for this command. Constraint required parameters This command accepts the following constraint required parameters. DN Syntax: Description: Type: Optionality: Allowed: Notes: Example: DN = <number> The dialled number to query. Integer Mandatory if NAME not specified Any 3 to 20 digits. Must be within the range of numbers for this subscriber or operator. DN = 1234569 ENTRY_TYPE Syntax: Description: Type: Optionality: Allowed: Example: ENTRY_TYPE = <Op|Sub> Flag to indicate type of entry (subscriber or operator). String Mandatory if NAME not specified O or S ENTRY_TYPE = O NAME Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: NAME = <sub/op name> The name of the subscriber or operator. String Mandatory if DN not specified Any 1 to 30 characters inclusive. none Must match an existing subscriber or operator for the ENTRY_TYPE. NAME = TelcoEurope Continued on next page Page 8 PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 Modify a Subscriber or Operator Number Range, Continued Optional parameters This command accepts the following optional parameters. NEW_NAME Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: NEW_NAME = <sub/op name> The name of the subscriber or operator. String Optional Any 1 to 30 characters inclusive. None - original name remains unchanged. Must not be blank, and must not match an existing subscriber or operator. NEW_NAME = TelcoEuropa NEW_NUM_START Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: NEW_NUM_START = <value> The start of the number range for this subscriber or operator and ENTRY_TYPE. Integer Optional Any, 3 to 20 digits inclusive. None - the original start of range number remains unchanged. Must not overlap an already defined range which has the same ENTRY_TYPE. NEW_NUM_START = 1234565 NEW_NUM_END Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: NEW_NUM_END = <value> The end of the number range for this subscriber or operator and ENTRY_TYPE. Integer Optional Any, 3 to 20 digits inclusive. None - the end of range number remains unchanged. • Must not overlap an already defined range which has the same ENTRY_TYPE. • Must be same length as NUM_START or if used, NEW_NUM_START. • Must be a higher number than NUM_START or if used, NEW_NUM_START. NEW_NUM_END = 1234598 Continued on next page PI Commands (ENUM) Operations Guide Page 9 Chapter 2 Commercial In Confidence Modify a Subscriber or Operator Number Range, Continued Optional parameters (continued) NEW_ENTRY_TYPE Syntax: Description: Type: Optionality: Allowed: Default: Example: Logic and constraints Flag to indicate type of entry (subscriber or operator). String Optional O or S None - the current value remains unchanged. NEW_ENTRY_TYPE = O The following rules apply when using the NPDS1=ADD command: • • • • • • • • Page 10 NEW_ENTRY_TYPE = <Op|Sub> The record to be modifed must be specified by either: Subscriber/operator NAME, or By DN+ENTRY_TYPE If specified, NAME must match an existing subscriber or operator in the EN_SUB_OP_NAME table. If specified, the DN should have a valid format. If a DN is specified, only the subscriber or operator for this DN is modified which matches the following criteria: EN_SUB_OP_NAME.NUM_LENGTH = LENGTH(DN), AND EN_SUB_OP_NAME.NUM_START <= DN, AND EN_SUB_OP_NAME.NUM_END >= DN, AND EN_SUB_OP_NAME.ENTRY_TYPE = ENTRY_TYPE If specified, the range defined by NEW_NUM_START and NEW_NUM_END must not overlap an already defined range of the same ENTRY_TYPE or new ENTRY_TYPE (excluding the subscriber or operator being changed). If specified, NEW_NAME must not be blank and must not match an existing subscriber or operator. If specified, ENTRY_TYPE must be either ‘S’ for subscriber, or ‘O’ for operator. If specified, NEW_ENTRY_TYPE must be either ‘S’ for subscriber, or ‘O’ for operator. PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 Delete a Subscriber or Operator Number Range Description Delete an entry from the EN_SUB_OP_NAME (SO) table. Optionally also delete NAPTR records associated with the subscriber or operator. Required parameters There are no required parameters for this command. Constraint required parameters This command accepts the following constraint required parameters. DN Syntax: Description: Type: Optionality: Allowed: Notes: Example: DN = <number> The dialled number to query. Integer Mandatory if NAME not specified Any 3 to 20 digits. Must be within the range of numbers for this subscriber or operator. DN = 1234569 ENTRY_TYPE Syntax: Description: Type: Optionality: Allowed: Example: ENTRY_TYPE = <Op|Sub> Flag to indicate type of entry (subscriber or operator). String Mandatory if NAME not specified O or S ENTRY_TYPE = O NAME Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: NAME = <sub/op name> The name of the subscriber or operator. String Mandatory if DN not specified Any 1 to 30 characters inclusive. none Must match an existing subscriber or operator for the ENTRY_TYPE. NAME = TelcoEurope Continued on next page PI Commands (ENUM) Operations Guide Page 11 Chapter 2 Commercial In Confidence Delete a Subscriber or Operator Number Range, Continued Optional parameters This command accepts the following optional parameters. CASCADE Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: Logic and constraints Flag to optionally also delete NAPTR records associated with the subscriber or operator. String Optional (default used if not set). Y, or N N If CASCADE is N or not specified, the subscriber or operator must not have any associated NAPTR records. CASCADE = Y The following rules apply when using the NPDS1=ADD command: • • • • • • Page 12 CASCADE = <value> The record to be deleted must be specified by either: Subscriber/operator NAME, or By DN+ENTRY_TYPE If specified, NAME must match an existing subscriber or operator in the EN_SUB_OP_NAME table. If specified, the DN should have a valid format. If a DN is specified, only the subscriber or operator for this DN is deleted which matches the following criteria: EN_SUB_OP_NAME.NUM_LENGTH = LENGTH(DN), AND EN_SUB_OP_NAME.NUM_START <= DN, AND EN_SUB_OP_NAME.NUM_END >= DN, AND EN_SUB_OP_NAME.ENTRY_TYPE = ENTRY_TYPE If CASCADE is ‘N’ or not specified, the subscriber or operator must not have any associated NAPTR records in the EN_NAPTR_INFO table If CASCADE is ‘Y’, all NAPTR records associated with this subscriber or operator are deleted from the EN_NAPTR_INFO table. PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 Query a Subscriber or Operator Number Range Description Queries an entry in the EN_SUB_OP_NAME (SO) table for a Subscriber or Operator by number or name. Required parameters There are no required parameters for this command. Constraint required parameters This command accepts the following constraint required parameters. DN Syntax: Description: Type: Optionality: Allowed: Notes: Example: DN = <number> The dialled number to query. Integer Mandatory if NAME not specified Any 3 to 20 digits. Must be within the range of numbers for this subscriber or operator. DN = 1234569 ENTRY_TYPE Syntax: Description: Type: Optionality: Allowed: Example: ENTRY_TYPE = <Op|Sub> Flag to indicate type of entry (subscriber or operator). String Mandatory if NAME not specified O or S ENTRY_TYPE = O NAME Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: Optional parameters PI Commands (ENUM) Operations Guide NAME = <sub/op name> The name of the subscriber or operator. String Mandatory Any 1 to 30 characters inclusive. none Must not be blank, and must not match an existing subscriber or operator. NAME = TelcoEurope There are no optional parameters for this command. Continued on next page Page 13 Chapter 2 Commercial In Confidence Query a Subscriber or Operator Number Range, Continued Logic and constraints The following rules apply when using the NPDS1=ADD command: • • • • Page 14 The record to be returned must be specified by either: Subscriber/operator NAME, or By DN+ENTRY_TYPE If specified, NAME must match an existing subscriber or operator in the EN_SUB_OP_NAME table. If specified, the DN should have a valid format. If a DN is specified, only the subscriber or operator for this DN is returned which matches the following criteria: EN_SUB_OP_NAME.NUM_LENGTH = LENGTH(DN), AND EN_SUB_OP_NAME.NUM_START <= DN, AND EN_SUB_OP_NAME.NUM_END >= DN, AND EN_SUB_OP_NAME.ENTRY_TYPE = ENTRY_TYPE PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 Create a NAPTR Record Description Adds a new NAPTR record – for an existing subscriber or operator – to the EN_NAPTR_INFO (NA) table. Required parameters This command requires the following parameters. DN Syntax: Description: Type: Optionality: Allowed: Notes: Example: DN = <number> The dialled number to query. Integer Mandatory if NAME not specified Any 3 to 20 digits. Must be within the range of numbers for this subscriber or operator. DN = 1234569 ENTRY_TYPE Syntax: Description: Type: Optionality: Allowed: Example: ENTRY_TYPE = <Op|Sub> Flag to indicate type of entry (subscriber or operator). String Mandatory if NAME not specified O or S ENTRY_TYPE = O ORDER Syntax: Description: Type: Optionality: Allowed: Default: Example: ORDER = <value> The order for clients to interpret this record amongst many. Integer Mandatory Any integer greater than zero, in range 0…65535 (16bit unsigned). None ORDER = 23 PREFERENCE Syntax: Description: Type: Optionality: Allowed: Default: Example: PREFERENCE = <value> The preference for clients to use this record where multiple records have a matching order. Integer Mandatory Any integer greater than zero, in range 0…65535 (16bit unsigned). None PREFERENCE = 23 Continued on next page PI Commands (ENUM) Operations Guide Page 15 Chapter 2 Commercial In Confidence Create a NAPTR Record, Continued Required parameters (continued) SERVICE Syntax: Description: Type: Optionality: Allowed: Notes: Example: Constraint required parameters SERVICE = <value> The service type. String Mandatory Any 1 to 10 characters inclusive. Must match an existing service entry in the EN_SERVICE table. SERVICE = E2U+sip This command accepts the following constraint required parameters. REGEXP Syntax: Description: Type: Optionality: Allowed: Default: Example: REGEXP = <value> The NAPTR regular expression. String Mandatory if REPLACEMENT not specified. Any 0 to 50 characters inclusive. None REGEXP = !^.*$!sip:441394111111@sup31sms! REPLACEMENT Syntax: Description: Type: Optionality: Allowed: Default: Example: Optional parameters REPLACEMENT = <value> The NAPTR replacement, a properly formed domain name. String Mandatory if REGEXP not specified. Any 0 to 20 characters inclusive. None REPLACEMENT = Domain23 This command accepts the following optional parameters. DESCRIPTION Syntax: Description: Type: Optionality: Allowed: Default: Example: DESCRIPTION = <string> A description for this record. String Optional Any 0 to 50 characters inclusive. None DESCRIPTION = Naptr33 Continued on next page Page 16 PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 Create a NAPTR Record, Continued Optional parameters (continued) FLAGS Syntax: Description: Type: Optionality: Allowed: Default: Example: Logic and constraints The flags for this record. String Optional. Any 0 to 10 characters, must be flags that exist in the database. None FLAGS = abcd The following rules apply when using the NPDS1=ADD command: • • • • • • • • • • PI Commands (ENUM) Operations Guide FLAGS = <list of flags> The DN must have a valid format. The DN+ENTRY_TYPE must refer to an existing subscriber/operator which matches the following criteria: EN_SUB_OP_NAME.NUM_LENGTH = LENGTH(DN), AND EN_SUB_OP_NAME.NUM_START <= DN, AND EN_SUB_OP_NAME.NUM_END >= DN, AND EN_SUB_OP_NAME.ENTRY_TYPE = ENTRY_TYPE ORDER must be a non-negative integer. PREFERENCE must be a non-negative integer. SERVICE must match an existing service entry in the EN_SERVICE table. REGEXP should be a properly formed NAPTR regular expression. REPLACEMENT should be a properly formed domain name. Either REGEXP or REPLACEMENT must be specified, but not both. If specified, FLAGS must match an existing flags entry in the EN_FLAGS table. If specified, DESCRIPTION must be a string of between 0 and 30 characters. Page 17 Chapter 2 Commercial In Confidence Modify a NAPTR Record Description Changes an entry in the EN_NAPTR_INFO (NA) table. Required parameters This command requires the following parameters. NAPTR_REF_ID Syntax: Description: Type: Optionality: Allowed: Default: Example: NAPTR_REF_ID = <value> The record’s unique ID. Integer Mandatory if DN not specified Any integer greater then zero. None NAPTR_REF_ID = 56 Constraint required parameters There are no constraint required parameters for this command. Optional parameters This command accepts the following optional parameters. NEW_DESCRIPTION Syntax: Description: Type: Optionality: Allowed: Default: Example: NEW_DESCRIPTION = <string> A description for this record. String Optional Any 0 to 50 characters inclusive. None NEW_DESCRIPTION = Naptr33 NEW_FLAGS Syntax: Description: Type: Optionality: Allowed: Default: Example: NEW_FLAGS = <list of flags> The flags for this record. String Optional. Any 0 to 10 characters, must be flags that exist in the database. None NEW_FLAGS = abcd Continued on next page Page 18 PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 Modify a NAPTR Record, Continued Optional parameters (continued) NEW_ORDER Syntax: Description: Type: Optionality: Allowed: Default: Example: NEW_ORDER = <value> The order for clients to interpret this record amongst many. Integer Optional Any integer greater than zero, in range 0…65535 (16bit unsigned). None NEW_ORDER = 23 NEW_PREFERENCE Syntax: Description: Type: Optionality: Allowed: Default: Example: NEW_PREFERENCE = <value> The preference for clients to use this record where multiple records have a matching order. Integer Optional Any integer greater than zero, in range 0…65535 (16bit unsigned). None NEW_PREFERENCE = 23 NEW_REGEXP Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: REGEXP = <value> The NAPTR regular expression. String Optional. Any 0 to 50 characters inclusive. None Must not be specified if NEW_REPLACEMENT is specified. REGEXP = !^.*$!sip:441394111111@sup31sms! NEW_REPLACEMENT Syntax: Description: Type: Optionality: Allowed: Default: Notes: Example: NEW_REPLACEMENT = <value> The NAPTR replacement, a properly formed domain name. String Optional. Any 0 to 20 characters inclusive. None Must not be specified if NEW_REGEXP is specified. NEW_REPLACEMENT = Domain23 Continued on next page PI Commands (ENUM) Operations Guide Page 19 Chapter 2 Commercial In Confidence Modify a NAPTR Record, Continued Optional parameters (continued) NEW_SERVICE Syntax: Description: Type: Optionality: Allowed: Notes: Example: Logic and constraints The service type. String Optional Any 1 to 10 characters inclusive. Must match an existing service entry in the EN_SERVICE table. NEW_SERVICE = E2U+sip The following rules apply when using the NPDS1=ADD command: • • • • • • Page 20 NEW_SERVICE = <value> NAPTR_REF_ID must refer to a record in the EN_NAPTR_INFO table. If specified, NEW_FLAGS must match an existing flags entry in the EN_FLAGS table. If specified, NEW_SERVICE must match an existing flags entry in the EN_FLAGS table. If specified, NEW_REGEXP should be a properly formed NAPTR regular expression. If specified, NEW_REPLACEMENT should be a properly formed domain name. Either NEW_REGEXP or NEW_REPLACEMENT may be specified, but not both. PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 Delete One or Many NAPTR Records Description Delete one or many entries from the EN_NAPTR_INFO (NA) table. Required parameters There are no required parameters for this command. Constraint required parameters This command accepts the following constraint required parameters. DN Syntax: Description: Type: Optionality: Allowed: Notes: Example: DN = <number> The dialled number to query. Integer Mandatory if NAPTR_REF_ID not specified Any 3 to 20 digits. Must be within the range of numbers for this subscriber or operator. DN = 1234569 ENTRY_TYPE Syntax: Description: Type: Optionality: Allowed: Example: ENTRY_TYPE = <Op|Sub> Flag to indicate type of entry (subscriber or operator). String Mandatory if NAPTR_REF_ID not specified O or S ENTRY_TYPE = O NAPTR_REF_ID Syntax: Description: Type: Optionality: Allowed: Default: Example: Optional parameters NAPTR_REF_ID = <value> The record’s unique ID. Integer Mandatory if DN not specified Any integer greater then zero. None NAPTR_REF_ID = 56 This command accepts the following optional parameters. SERVICE Syntax: Description: Type: Optionality: Allowed: Notes: Example: SERVICE = <value> The service type. String Optional Any 1 to 10 characters inclusive. Must match an existing service entry in the EN_SERVICE table. SERVICE = E2U+sip Continued on next page PI Commands (ENUM) Operations Guide Page 21 Chapter 2 Commercial In Confidence Delete One or Many NAPTR Records, Continued Logic and constraints The following rules apply when using the NPDS1=ADD command: • • • • • • Page 22 Records may be deleted either: Individually by their NAPTR_REF_ID, or Collectively by their subscriber or operator by specifying a DN+ENTRY_TYPE. If specified, NAPTR_REF_ID must refer to a record in the EN_NAPTR_INFO table. If specified, the DN should have a valid format. If a DN is specified, NAPTR records for the applicable subscriber or operator will be deleted, where the following criteria are met: EN_SUB_OP_NAME.NUM_LENGTH = LENGTH(DN), AND EN_SUB_OP_NAME.NUM_START <= DN, AND EN_SUB_OP_NAME.NUM_END >= DN, AND EN_SUB_OP_NAME.ENTRY_TYPE = ENTRY_TYPE If records are being deleted collectively using DN+ENTRY_TYPE, SERVICE may optionally be specified to delete only records which have a matching service. If specified, SERVICE must match an existing flags entry in the EN_SERVICE table. PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 Query NAPTR Records Description Queries records in the EN_NAPTR_INFO (NA) table by various criteria. Required parameters There are no required parameters for this command. Constraint required parameters This command accepts the following constraint required parameters. DN Syntax: Description: Type: Optionality: Allowed: Notes: Example: DN = <number> The dialled number to query. Integer Mandatory if NAPTR_REF_ID not specified Any 3 to 20 digits. Must be within the range of numbers for this subscriber or operator. DN = 1234569 ENTRY_TYPE Syntax: Description: Type: Optionality: Allowed: Example: ENTRY_TYPE = <Op|Sub> Flag to indicate type of entry (subscriber or operator). String Mandatory if NAPTR_REF_ID not specified O or S ENTRY_TYPE = O NAPTR_REF_ID Syntax: Description: Type: Optionality: Allowed: Default: Example: Optional parameters NAPTR_REF_ID = <value> The record’s unique ID. Integer Mandatory if DN not specified Any integer greater then zero. None NAPTR_REF_ID = 56 This command accepts the following optional parameters. DESCRIPTION Syntax: Description: Type: Optionality: Allowed: Default: Example: DESCRIPTION = <string> A description for this record. String Optional Any 0 to 50 characters inclusive. None DESCRIPTION = Naptr33 Continued on next page PI Commands (ENUM) Operations Guide Page 23 Chapter 2 Commercial In Confidence Query NAPTR Records, Continued Optional parameters (continued) FLAGS Syntax: Description: Type: Optionality: Allowed: Default: Example: FLAGS = <list of flags> The flags for this record. String Optional. Any 0 to 10 characters, must be flags that exist in the database. None FLAGS = abcd ORDER Syntax: Description: Type: Optionality: Allowed: Default: Example: ORDER = <value> The order for clients to interpret this record amongst many. Integer Optional Any integer greater than zero, in range 0…65535 (16bit unsigned). None ORDER = 23 PREFERENCE Syntax: Description: Type: Optionality: Allowed: Default: Example: PREFERENCE = <value> The preference for clients to use this record where multiple records have a matching order. Integer Optional Any integer greater than zero, in range 0…65535 (16bit unsigned). None PREFERENCE = 23 REGEXP Syntax: Description: Type: Optionality: Allowed: Default: Example: REGEXP = <value> The NAPTR regular expression. String Optional Any 0 to 50 characters inclusive. None REGEXP = !^.*$!sip:441394111111@sup31sms! Continued on next page Page 24 PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 2 Query NAPTR Records, Continued Optional parameters (continued) REPLACEMENT Syntax: Description: Type: Optionality: Allowed: Default: Example: REPLACEMENT = <value> The NAPTR replacement, a properly formed domain name. String Optional Any 0 to 20 characters inclusive. None REPLACEMENT = Domain23 SERVICE Syntax: Description: Type: Optionality: Allowed: Notes: Example: Logic and constraints The service type. String Optional Any 1 to 10 characters inclusive. Must match an existing service entry in the EN_SERVICE table. SERVICE = E2U+sip The following rules apply when using the NPDS1=ADD command: • • • • • • • • • PI Commands (ENUM) Operations Guide SERVICE = <value> Records may be queried either: Individually by their NAPTR_REF_ID, or Collectively by their subscriber or operator by specifying a DN+ENTRY_TYPE. If specified, NAPTR_REF_ID must refer to a record in the EN_NAPTR_INFO table. If specified, the DN should have a valid format. If a DN is specified, NAPTR records for the applicable subscriber or operator will be returned, where the following criteria are met: EN_SUB_OP_NAME.NUM_LENGTH = LENGTH(DN), AND EN_SUB_OP_NAME.NUM_START <= DN, AND EN_SUB_OP_NAME.NUM_END >= DN, AND EN_SUB_OP_NAME.ENTRY_TYPE = ENTRY_TYPE The optional parameters may only be given if records are being searched by DN+ENTRY_TYPE. If specified, FLAGS must match an existing flags entry in the EN_FLAGS table. If specified, SERVICE must match an existing flags entry in the EN_FLAGS table. If specified, REGEXP should be a properly formed NAPTR regular expression. If specified, REPLACEMENT should be a properly formed domain name. Page 25 Commercial In Confidence Chapter 3 Error Code Lists Overview Introduction This chapter explains the error codes for ENUM PI commands. In this chapter This chapter contains the following topics. PI Chassis Errors ..........................................................................................28 PI Command Errors.......................................................................................30 PI Commands (ENUM) Operations Guide Page 27 Chapter 3 Commercial In Confidence PI Chassis Errors Error list This table describes the PI Chassis error codes. Code Message Description 70 TOO MANY SESSIONS All PI sessions are in use. 71 LOGON SYNTAX ERROR The login string was incorrectly formatted. 72 INVALID LOGON - username, password Invalid username and/or password 73 INVALID LOGON - user not allowed on this port The user attempted to login on the wrong PI port. 74 INVALID LOGON - host The PI client is unknown. 75 UNKNOWN COMMAND Client sent an unknown command. 76 USER DOES NOT HAVE SUFFICIENT SECURITY The user's security level is less than the command's security level. 77 SYNSTAMP NOT FOUND Synstamps are turned on, but the client did not send one. 78 SYNSTAMP NOT VALID Synstamps are turned on, but the synstamp sent by the client sent is invalid. 79 INVALID OR MISSING CHECKSUM Checksums are turned on, but the client either: • did not send one, • or it was invalid. 80 UNKNOWN PARAMETER FOR COMMAND A parameter was sent that was not valid for this command. 81 MISSING PARAMETERS FROM COMMAND A required parameter is missing. 82 Undefined 83 DUPLICATE PARAMETER The client sent two identically named parameters. 84 ERROR RUNNING PROCEDURE An internal error occurred running the command. 85 USER SESSION TERMINATED The user's session has been terminated by an administrator. 86 COMMAND TOO BIG The command sent is too long. Indicates an incorrectly formatted command. Continued on next page Page 28 PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 3 PI Chassis Errors, Continued Error list (continued) PI Commands (ENUM) Operations Guide Code Message Description 87 COMMAND SYNTAX ERROR The command sent is incorrectly formatted. 88 PARAMETER NAME TOO BIG A parameter name is too long. Indicates the command was incorrectly formatted. 89 PARAMETER VALUE TOO BIG A parameter value is too long. Indicates the command was incorrectly formatted. 90 SYNSTAMP OUT OF PLACE 91 TIMEOUT The synstamp is not at the end of the command, but before the checksum. The command took too long to run. Page 29 Chapter 3 Commercial In Confidence PI Command Errors Error list This table describes the PI Commands error codes. Code Message Description 68 Badly formatted parameter <parameter>, see <parameter> definition for format. All commands 69 <text> (This is to report any other errors not defined) All commands 1000 A subscriber/operator with name <name> is already ENSO1=ADD defined ENSO1=CHG 1001 No subscriber/operator with name <name> defined ENSO1=CHG ENSO1=DEL ENSO1=QRY 1002 The specified range <num_start> to <num_end> overlaps an already defined range ENSO1=ADD ENSO1=CHG 1003 The end of range <num_end> is a different length to ENSO1=ADD the start of range <num_start> ENSO1=CHG 1004 The start of range <start> is after the end of range <end> ENSO1=ADD ENSO1=CHG 1005 The entry type <entry_type> is not a known type ENSO1=ADD ENSO1=CHG ENSO1=DEL ENSO1=QRY ENNA1=ADD ENNA1=DEL ENNA1=QRY 1006 The service <service> is not defined in the service table ENNA1=ADD ENNA1=CHG ENNA1=DEL 1007 The flags <flags> are not defined in the flags table ENNA1=ADD ENNA1=CHG 1008 The DN <dn> was not in the defined ranges ENSO1=CHG ENSO1=DEL ENSO1=QRY ENNA1=ADD ENNA1=DEL ENNA1=QRY 1009 The NAPTR_REF_ID <naptr_ref_id> is unknown ENNA1=CHG ENNA1=DEL ENNA1=QRY Continued on next page Page 30 PI Commands (ENUM) Operations Guide Commercial In Confidence Chapter 3 PI Command Errors, Continued Error list (continued) Code Message Description 1010 No NAPTR records found ENNA1=DEL ENNA1=QRY 1011 Either NAME or DN must be specified and have a value ENSO1=CHG ENSO1=DEL ENSO1=QRY 1012 DN incorrectly specified when NAME is specified ENSO1=CHG ENSO1=DEL ENSO1=QRY 1013 ENTRY_TYPE must be specified and have a value ENSO1=CHG ENSO1=DEL ENSO1=QRY ENNA1=DEL ENNA1=QRY 1014 ENTRY_TYPE incorrectly specified ENSO1=CHG ENSO1=DEL ENSO1=QRY ENNA1=DEL ENNA1=QRY 1015 Either REGEXP or REPLACEMENT must be specified and have a value ENNA1=ADD ENNA1=CHG 1016 REPLACEMENT incorrectly specified when REGEXP is specified ENNA1=ADD ENNA1=CHG 1017 Either NAPTR_REF_ID or DN+ENTRY_TYPE must ENNA1=DEL be specified and have a value ENNA1=QRY 1018 DN+ENTRY_TYPE incorrectly specified when NAPTR_REF_ID is specified ENNA1=DEL ENNA1=QRY 1019 SERVICE incorrectly specified when deleting a record by NAPTR_REF_ID ENNA1=DEL 1020 The entry has a NAPTR record dependency and cannot be deleted. Optional search criteria stated when searching by NAPTR_REF_ID ENSO1=DEL 1021 PI Commands (ENUM) Operations Guide ENNA1=QRY Page 31 Commercial In Confidence Appendix Overview In this appendix This appendix contains the following topics. Glossary of Terms ......................................................................................... 35 Index .............................................................................................................. 37 PI Commands (ENUM) Operations Guide Page 33 Commercial In Confidence Glossary of Terms BE Billing Engine ENUM E.164 Number Mapping. GUI Graphical User Interface HTML HyperText Markup Language, a small application of SGML used on the World Wide Web. It defines a very simple class of report-style documents, with section headings, paragraphs, lists, tables, and illustrations, with a few informational and presentational items, and some hypertext and multimedia. IN Intelligent Network IP 1) Internet Protocol 2) Intelligent Peripheral - a box that is able to play announcements NP Number Portability Oracle Oracle Corporation PI Provisioning Interface - used for bulk database updates/configuration instead of GUI based configuration. SGML Standard Generalized Markup Language. The international standard for defining descriptions of the structure of different types of electronic document. SQL Structured Query Language - a database query language. TCP Transmission Control Protocol. This is a reliable octet streaming protocol used by the majority of applications on the Internet. It provides a connection-oriented, fullduplex, point to point service between hosts. USMS Universal Service Management System hardware platform. VPN The Virtual Private Network product is an enhanced services capability enabling private network facilities across a public telephony network. PI Commands (ENUM) Operations Guide Page 35 Commercial In Confidence Index A About this Document Audience • v Guide changes • v Pre-requisites • v Related documents • v Scope • v Audience About this Document • v B BE • 1 C CASCADE • 12 Command list Command List • 2 Command List Command list • 2 Constraint required parameters Create a NAPTR Record • 16 Create a Subscriber or Operator Number Range • 7 Delete a Subscriber or Operator Number Range • 11 Delete One or Many NAPTR Records • 21 Modify a NAPTR Record • 18 Modify a Subscriber or Operator Number Range • 8 Query a Subscriber or Operator Number Range • 13 Query NAPTR Records • 23 Create a NAPTR Record Constraint required parameters • 16 Description • 15 Logic and constraints • 17 Optional parameters • 16 Required parameters • 15 Create a Subscriber or Operator Number Range Constraint required parameters • 7 Description • 6 Logic and constraints • 7 Optional parameters • 7 Required parameters • 6 D Delete a Subscriber or Operator Number Range Constraint required parameters • 11 Description • 11 Logic and constraints • 12 Optional parameters • 12 PI Commands (ENUM) Operations Guide Required parameters • 11 Delete One or Many NAPTR Records Constraint required parameters • 21 Description • 21 Logic and constraints • 22 Optional parameters • 21 Required parameters • 21 Description Create a NAPTR Record • 15 Create a Subscriber or Operator Number Range • 6 Delete a Subscriber or Operator Number Range • 11 Delete One or Many NAPTR Records • 21 Modify a NAPTR Record • 18 Modify a Subscriber or Operator Number Range • 8 Query a Subscriber or Operator Number Range • 13 Query NAPTR Records • 23 DESCRIPTION • 16, 23 DN • 8, 11, 13, 15, 21, 23 Document Conventions Icons • vi Typographical conventions • vi E ENTRY_TYPE • 7, 8, 11, 13, 15, 21, 23 ENUM • v Error list PI Chassis Errors • 28 PI Command Errors • 30 Escape characters Parameter Formats • 3 F FLAGS • 17, 24 Formats Parameter Formats • 3 G GUI • 35 Guide changes About this Document • v H HTML • vi I Icons Document Conventions • vi IN • v IP • 1 Page 37 Commercial In Confidence L Logic and constraints Create a NAPTR Record • 17 Create a Subscriber or Operator Number Range • 7 Delete a Subscriber or Operator Number Range • 12 Delete One or Many NAPTR Records • 22 Modify a NAPTR Record • 20 Modify a Subscriber or Operator Number Range • 10 Query a Subscriber or Operator Number Range • 14 Query NAPTR Records • 25 Modify a NAPTR Record • 18 Modify a Subscriber or Operator Number Range • 9 Query a Subscriber or Operator Number Range • 13 Query NAPTR Records • 23 Oracle • ii ORDER • 15, 24 P NAME • 6, 8, 11, 13 NAPTR_REF_ID • 18, 21, 23 NEW_DESCRIPTION • 18 NEW_ENTRY_TYPE • 10 NEW_FLAGS • 18 NEW_NAME • 9 NEW_NUM_END • 9 NEW_NUM_START • 9 NEW_ORDER • 19 NEW_PREFERENCE • 19 NEW_REGEXP • 19 NEW_REPLACEMENT • 19 NEW_SERVICE • 20 NP • v NUM_END • 6 NUM_START • 6 Parameter Formats Escape characters • 3 Formats • 3 Relevant parameters • 4 Parameters CASCADE • 12 DESCRIPTION • 16, 23 DN • 8, 11, 13, 15, 21, 23 ENTRY_TYPE • 7, 8, 11, 13, 15, 21, 23 FLAGS • 17, 24 NAME • 6, 8, 11, 13 NAPTR_REF_ID • 18, 21, 23 NEW_DESCRIPTION • 18 NEW_ENTRY_TYPE • 10 NEW_FLAGS • 18 NEW_NAME • 9 NEW_NUM_END • 9 NEW_NUM_START • 9 NEW_ORDER • 19 NEW_PREFERENCE • 19 NEW_REGEXP • 19 NEW_REPLACEMENT • 19 NEW_SERVICE • 20 NUM_END • 6 NUM_START • 6 ORDER • 15, 24 PREFERENCE • 15, 24 REGEXP • 16, 24 REPLACEMENT • 16, 25 SERVICE • 16, 21, 25 PI • ii PI Chassis Errors Error list • 28 PI Command Errors Error list • 30 PREFERENCE • 15, 24 Pre-requisites About this Document • v O Q Optional parameters Create a NAPTR Record • 16 Create a Subscriber or Operator Number Range • 7 Delete a Subscriber or Operator Number Range • 12 Delete One or Many NAPTR Records • 21 Query a Subscriber or Operator Number Range Constraint required parameters • 13 Description • 13 Logic and constraints • 14 Optional parameters • 13 Required parameters • 13 M Modify a NAPTR Record Constraint required parameters • 18 Description • 18 Logic and constraints • 20 Optional parameters • 18 Required parameters • 18 Modify a Subscriber or Operator Number Range Constraint required parameters • 8 Description • 8 Logic and constraints • 10 Optional parameters • 9 Required parameters • 8 N Page 38 PI Commands (ENUM) Operations Guide Commercial In Confidence Query NAPTR Records Constraint required parameters • 23 Description • 23 Logic and constraints • 25 Optional parameters • 23 Required parameters • 23 R REGEXP • 16, 24 Related documents About this Document • v Relevant parameters Parameter Formats • 4 REPLACEMENT • 16, 25 Required parameters Create a NAPTR Record • 15 Create a Subscriber or Operator Number Range • 6 Delete a Subscriber or Operator Number Range • 11 Delete One or Many NAPTR Records • 21 Modify a NAPTR Record • 18 Modify a Subscriber or Operator Number Range • 8 Query a Subscriber or Operator Number Range • 13 Query NAPTR Records • 23 S Scope About this Document • v SERVICE • 16, 21, 25 SGML • 35 SMS • vi SQL • 1 T TCP • 1 Typographical conventions Document Conventions • vi U USMS • 5 V VPN • v PI Commands (ENUM) Operations Guide Page 39
© Copyright 2026 Paperzz