oracle communications network charging and control product ... commands (np) operations... · pi...

Oracle Communications Network Charging and Control

Product: OCNCC 4.3 Component: PI Commands (NP)

Operations Guide S’ware version: Release 3.0.0 Guide version: 02.00

Release date: December 2010

Status: Approved

Commercial In Confidence

Page ii PI Commands (NP) Operations Guide

Copyright PI Commands (NP) 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.


PI Commands (NP) Page iii Operations Guide

Contents

Copyright ............................................................................................................................. ii About this Document ........................................................................................................... v Document Conventions ...................................................................................................... vi

Chapter 1 .................................................................................................................... 1

PI Commands Overview ................................................................. 1

Overview .............................................................................................................................. 1 Command List...................................................................................................................... 2 Parameter Formats .............................................................................................................. 3

Chapter 2 .................................................................................................................... 5

PI Number Portability Package ...................................................... 5

Overview .............................................................................................................................. 5 Add a Ported Number Range .............................................................................................. 6 Modify a Ported Number Range ........................................................................................ 10 Delete a Ported Number Range ........................................................................................ 14 Query an Active Ported Number Range ............................................................................ 16 Add New LCR Rule Set ..................................................................................................... 17 Modify LCR Rule Set ......................................................................................................... 18 Delete LCR Rule Set ......................................................................................................... 19 Add New LCR Rule ........................................................................................................... 20 Modify LCR Rule ............................................................................................................... 23 Delete LCR Rule ................................................................................................................ 26 Add Home Routing Entry ................................................................................................... 27 Modify Home Routing Entry ............................................................................................... 29 Delete Home Routing Entry ............................................................................................... 31 Query Home Routing Entry ............................................................................................... 32

Chapter 3 .................................................................................................................. 33

Error Code Lists ............................................................................ 33

Overview ............................................................................................................................ 33 PI Chassis Errors ............................................................................................................... 34 PI Command Errors ........................................................................................................... 36

Appendix .................................................................................................................. 39 Overview ............................................................................................................................ 39 Glossary of Terms ............................................................................................................. 41 Index .................................................................................................................................. 43


PI Commands (NP) Page v Operations Guide

About this Document The scope of this document includes all the information required to configure the NP Service Pack PI commands.

The audience for this document includes system administrators responsible for the monitoring, maintenance, and configuration of the Oracle IN applications.

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.

The following documents are related to this document:

• PI Technical Guide • VPN User's Guide

Here are the changes to the document since the last release.

Version no.

Revision Date Description

01.00 2009-02-10 First release, based on specification document np_pi_commands_definition v01.03

02.00 2010-10-29 Re-branded

Scope

Audience

Pre-requisites

Related documents

Changes in this document


Page vi PI Commands (NP) Operations Guide

Document 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/

hypertext link Used to indicate a hypertext link on an HTML page.

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.

This topic explains any terminology specific to this manual.

Typographical conventions

Icons

Terminology


PI Commands (NP) Page 1 Operations Guide

PI Commands Overview Overview

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.

This chapter contains the following topics.

Command List ................................................................................................. 2 Parameter Formats ......................................................................................... 3

Chapter 1

Introduction

In this chapter

Chapter 1 Commercial In Confidence

Page 2 PI Commands (NP) Operations Guide

Command List The following table lists commands and corresponding definitions for the NP Provisioning Interface. Each definition requires the installation of the npPISms package in addition to the installation of the standard piSms package.

Function npPISms Add a ported number range NPDS1=ADD

Modify a ported number range NPDS1=CHG

Delete a ported number range NPDS1=DEL

Query an active ported number range

NPDS1=QRY

Add new LCR rule set NPLC1=ADD

Modify an LCR rule set NPLC1=CHG

Delete an LCR rule set NPLC1=DEL

Add a new LCR rule NPLC2=ADD

Modify an LCR rule NPLC2=CHG

Delete an LCR rule NPLC2=DEL

Add a new home routing entry NPHR1=ADD

Modify a home routing entry NPHR1=CHG

Delete a home routing entry NPHR1=DEL Query a home routing entry NPHR1=QRY

Command list

Commercial In Confidence Chapter 1


Parameter Formats This table describes the format of each PI parameter.

Note: Lengths are largely determined by the size of fields in the database, with exceptions noted in the table. Parameter Format ACTIVATION_DATE YYYYMMDDHHMMSS (24 hour clock)

ADDITIONAL_RN_ID 1 to 8 digit hexadecimal number

CARRIERn (n=1 to 8) 1 to 30 character string

CASCADE "Y" or "N"

DN 4 to 18 digit number

DN_END 4 to 18 digit number, must be the same length as the associated DN_START value

DN_START 4 to 18 digit number

DN_TYPE "H" or "S"

DONOR_ID 1 to 8 digit hexadecimal number

ENTRY_TYPE "O" or "S"

NEW_NAME 1 to 30 character string

NUMBER_TYPE Null, "F" or "M"

PORT_ID 1 to 8 digit hexadecimal number

ROUTING_DESTINATION 1 to 64 character string

ROUTING_NUMBER 1 to 8 digit hexadecimal number RULE_SET 1 to 30 character string

Formats



PI Number Portability Package Overview

This chapter describes the available PI commands for provisioning number portability information on the USMS.

These commands are added by the npPISms package. For installation details see the NP Service Pack Technical Guide.


Add a Ported Number Range .......................................................................... 6 Modify a Ported Number Range .................................................................... 10 Delete a Ported Number Range .................................................................... 14 Query an Active Ported Number Range ........................................................ 16 Add New LCR Rule Set ................................................................................. 17 Modify LCR Rule Set ..................................................................................... 18 Delete LCR Rule Set ..................................................................................... 19 Add New LCR Rule ....................................................................................... 20 Modify LCR Rule ........................................................................................... 23 Delete LCR Rule ........................................................................................... 26 Add Home Routing Entry ............................................................................... 27 Modify Home Routing Entry .......................................................................... 29 Delete Home Routing Entry .......................................................................... 31 Query Home Routing Entry ........................................................................... 32

Chapter 2

Introduction

In this chapter



Add a Ported Number Range The command NPDS1 and action ADD lets you add a new entry to the NP_DN_RANGE table.

This command requires the following parameters.

DN_START

Syntax: DN_START=<DN range start number>

Description: The start of the DN number range. Type: Integer Optionality: Required. Allowed: The specified number must have 4 to 18 digits. Default: None Example: DN_START=1230

DN_END

Syntax: DN_END=<DN range end number>

Description: The end of the DN number range.

Type: Integer

Optionality: Required. Allowed: The specified number must have 4 to 18 digits. Default: None Notes: The DN_END length must equal the DN_START length. Example: DN_END=1250

ACTIVATION_DATE

Syntax: ACTIVATION_DATE=<Date> Description: The date the range will become active. Type: Date String Optionality: Required. Allowed: A valid date using this format: YYYYMMDDHHMMSS Default: None Example: ACTIVATION_DATE=20080714000000

Continued on next page

Description

Required parameters


Add a Ported Number Range, Continued


Required parameters (continued)

ENTRY_TYPE

Syntax: ENTRY_TYPE=<Operator/Subscriber>

Description: The entry type to use.

Type: String

Optionality: Required when adding a ported number range.

Allowed: Either: • O - operator, or • S - subscriber.

Default: None

Example: ENTRY_TYPE=S

ROUTING_NUMBER

Syntax: ROUTING_NUMBER=<Number> Description: The routing number Type: Integer Optionality: Required. Allowed: A hexadecimal number between 1 and 8 digits long. Default: None Example: ROUTING_NUMBER=ABC123

There are no constraint required parameters for this command.

This command accepts the following optional parameters.

NUMBER_TYPE

Syntax: NUMBER_TYPE=<Number Type>

Description: The number type of the DN range Type: String Optionality: Optional (default used if not set). Allowed: Either:

• Null • F - fixed, or • M - mobile

Default: Null Example: NUMBER_TYPE=F


Constraint required parameters Optional parameters




Optional parameters (continued)

ADDITIONAL_RN_ID

Syntax: ADDITIONAL_RN_ID=<Additional Routing Number>

Description: The additional routing number for the DN range. Type: Integer Optionality: Optional. Allowed: A hexadecimal number, 1 to 8 digits long. Default: None Example: ADDITIONAL_RN_ID=001

DONOR_ID

Syntax: DONOR_ID=<Donor Id Number>

Description: The donor id number for the DN range

Type: Integer

Optionality: Optional.

Allowed: A hexadecimal number, 1 to 8 digits long. Must be a defined routing number.

Default: None

Example: DONOR_ID=0011

PORT_ID

Syntax: PORT_ID=<Port Id Number>

Description: The port id number for the DN range..

Type: Integer



Default: None

Example: PORT_ID=001

URI

Syntax: URI = <URI string> Description: The URI for the DN range. Type: String Optionality: Optional Allowed: Textual string, 1 to 50 characters long. Default: None Example: URI = Oracle.com





The following rules apply when using the NPDS1=ADD command:

1 The range defined by DN_START and DN_END must not overlap an existing entry in the NP_DN_RANGE table, except if DN_START and DN_END exactly match a defined range and ACTIVATION_DATE is different.

2 DN_START and DN_END must be the same length . 3 ROUTING_NUMBER must be an existing routing number defined in the

NP_ROUTING_NUMBER table. 4 ADDITIONAL_RN_ID must be an existing routing number defined in the

NP_ROUTING_NUMBER table. The ADDITIONAL_RN_ID routing number’s associated RD_ID value must equal the ROUTING_NUMBER’s associated RD_ID value.

5 DONOR_ID must be a routing number defined in the NP_ROUTING_NUMBER table.

6 If the maximum number of activation dates per number range is exceeded, then an error is returned: too many routing numbers for this range.

7 If eserv.config contains the item pi.NP.checkRN = “x”, and the ROUTING_NUMBER matches this value “x”, then the ADDITIONAL_RN_ID field must have a non-NULL value.

8 If eserv.config contains the item pi.localTZ = “x”, then the data specified for ACTIVATION_DATE will be converted from the local time zone “x” to GMT before being stored in the database.

Logic and constraints



Modify a Ported Number Range Changes the entry in the NP_DN_RANGE table that matches the supplied DN_START, DN_END, ACTIVATION_DATE and ROUTING NUMBER parameters.

The command NPDS1 and action CHG lets you modify the entry to the NP_DN_RANGE table for the specified DN_START, DN_END and ACTION_DATE parameters.


DN_START



DN_END



Type: Integer


ACTIVATION_DATE



Description

Required parameters


Modify a Ported Number Range, Continued


Required parameters (continued)

ROUTING_NUMBER

Syntax: ROUTING_NUMBER=<Number> Description: The routing number Type: Integer Optionality: Required. Allowed: A hexadecimal number between 1 and 8 digits long. Default: None Example: ROUTING_NUMBER=ABC123



ENTRY_TYPE



Type: String



Default: None


NUMBER_TYPE

Syntax: NUMBER_TYPE=<Number Type>

Description: The number type of the DN range Type: String Optionality: Optional (default used if not set). Allowed: Either:

• Null • F - fixed, or • M - mobile

Default: Null Example: NUMBER_TYPE=F







ADDITIONAL_RN_ID

Syntax: ADDITIONAL_RN_ID=<Additional Routing Number>

Description: The additional routing number for the DN range. Type: Integer Optionality: Optional. Allowed: A hexadecimal number, 1 to 8 digits long. Default: None Example: ADDITIONAL_RN_ID=001

DONOR_ID

Syntax: DONOR_ID=<Donor Id Number>

Description: The donor id number for the DN range

Type: Integer



Default: None

Example: DONOR_ID=0011

PORT_ID

Syntax: PORT_ID=<Port Id Number>

Description: The port id number for the DN range..

Type: Integer



Default: None

Example: PORT_ID=001

URI

Syntax: URI = <URI string> Description: The URI for the DN range. Type: String Optionality: Optional Allowed: Textual string, 1 to 50 characters long. Default: None Example: URI = oracle.com






1 The range defined by DN_START and DN_END must be an existing entry in the NP_DN_RANGE table.

2 The ROUTING_NUMBER must be an existing routing number defined in the NP_ROUTING_NUMBER table.

3 ADDITIONAL_RN_ID must be an existing routing number defined in the NP_ROUTING_NUMBER table. The ADDITIONAL_RN_ID routing number’s associated RD_ID value must equal the ROUTING_NUMBER’s associated RD_ID value.

4 DONOR_ID must be a routing number defined in the NP_ROUTING_NUMBER table.

5 If eserv.config contains the item pi.NP.checkRN = “x”, and the ROUTING_NUMBER matches this value “x”, then the ADDITIONAL_RN_ID field must have a non-NULL value.

6 If eserv.config contains the item pi.localTZ = “x”, then the data specified for ACTIVATION_DATE will be converted from the local time zone “x” to GMT before being stored in the database.

7 If an entry needs to be removed then set the value for the ROUTING_NUMBER to “null” or “NULL” and the NUMBER_TYPE parameter value to D or d.




Delete a Ported Number Range The command NPDS1 and action DEL lets you delete the entry in the NP_DN_RANGE table for the specified parameters.


DN_START



DN_END



Type: Integer




ENTRY_TYPE



Type: String



Default: None



Description

Required parameters



Delete a Ported Number Range, Continued



ACTIVATION_DATE



1 The range defined by DN_START and DN_END must be an existing entry in the NP_DN_RANGE table.

2 If eserv.config contains the item pi.localTZ = “x”, then the data specified for ACTIVATION_DATE will be converted from the local time zone “x” to GMT before being used to look up the row in the database.




Query an Active Ported Number Range The command NPDS1 and action QRY lets you query an entry in the NP_DN_RANGE table for the Active Ported Number Range (APNR) of a number.


DN

Syntax: DN=<Number> Description: The number to query. The DN must be within the required

DN range. Type: Integer Optionality: Mandatory. Allowed: Number, 4 to 18 digits long. Default: None Example: DN=4124


There are no optional parameters for this command.

The following rules apply to the NPDS1=QRY 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.

Description

Required parameters

Constraint required parameters Optional parameters Logic and constraints



Add New LCR Rule Set The command NPLC1 and action ADD lets you add a new rule set to the NP_RULE_SET table.


RULE_SET

Syntax: RULE_SET=<rule set name>

Description: The name of the new rule set.

Type: String Optionality: Required. Allowed: Textual string, 1 to 30 characters long. Default: None. Example: RULE_SET=Rule Set 1



The following rules apply to the NPLC1=ADD command.

1 The rule set name must not exist already.

Description

Required parameters




Modify LCR Rule Set The command NPLC1 and action CHG lets you change the name of a rule set in the NP_RULE_SET table.


RULE_SET




NEW_NAME

Syntax: NEW_NAME=<rule set name>

Description: The new name for the new rule set. Type: String Optionality: Required. Allowed: Textual string, 1 to 30 characters long. Default: None. Example: NEW_NAME=Rule Set 2



The following rules apply to the NPLC1=CHG command.

1 This rule set name must exist already. 2 The new name for the rule set must be unique.

Description

Required parameters




Delete LCR Rule Set The command NPLC1 and action DEL lets you delete a rule set from the NP_RULE_SET table. You can also delete any associated rules defined for the rule set.


RULE_SET






CASCADE

Syntax: CASCADE=<Yes/No> Description: Flag to determine whether or not rules based on this rule set

should also be deleted. Type: Boolean Optionality: Optional (default used if not set). Allowed: Either:

Y - cascade deletion into the NP_RULE table, or N - do not delete rules from NP_RULE.

Default: N

Example: CASCADE=Y

The following rules apply to the NPLC1=DEL command.

1 This rule set must exist in the NP_RULE_SET table. 2 If CASCADE is ‘N’ or not specified, then the rule set must not have any

associated rules in the NP_RULE table. 3 If CASCADE is ‘Y’, then all rules from this set will be deleted from the

NP_RULE table.

Description

Required parameters





Add New LCR Rule The command NPLC2 and action ADD lets you add a new rule to the NP_RULE table for the specified rule set.


RULE_SET




ROUTING_DESTINATION

Syntax: ROUTING_DESTINATION=<RoutingDestination>

Description: The routing destination operator name. Type: String Optionality: Required when adding, modifying or deleting LCR rules. Allowed: A text string, up to 64 characters long. Default: None Example: ROUTING_DESTINATION=Vodaphone

CARRIER1

Syntax: CARRIER1=<CarrierName> Description: The name of the carrier. Type: String Optionality: Required. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER1=Carrier 1

This command accepts the following constraint required parameters.

CARRIER2

Syntax: CARRIER2=<2ndCarrierName> Description: The name of the 2nd carrier. Type: String Optionality: Must be specified if subsequent carriers are to be specified. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER2=Carrier 2


Description

Required parameters

Constraint required parameters


Add New LCR Rule, Continued


Constraint required parameters (continued)

CARRIER3

Syntax: CARRIER3=<3rdCarrierName> Description: The name of the 3rd carrier. Type: String Optionality: Must be specified if subsequent carriers are to be specified. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER3=Carrier 3

CARRIER4

Syntax: CARRIER4=<4thCarrierName> Description: The name of the 4th carrier. Type: String Optionality: Must be specified if subsequent carriers are to be specified. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER4=Carrier 4

CARRIER5


CARRIER6

Syntax: CARRIER6<6thCarrierName> Description: The name of the 6th carrier. Type: String Optionality: Must be specified if subsequent carriers are to be specified. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER6=Carrier 6



Add New LCR Rule, Continued



CARRIER7



CARRIER8

Syntax: CARRIER8=<8thCarrierName> Description: The name of the 8th carrier. Type: String Optionality: Optional. May only be specified if carriers 1 to 7 are

specified. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER8=Carrier 8

The following rules apply to the NPLC2=ADD command.

1 This rule set must exist in the NP_RULE_SET table. 2 The routing destination must be defined in the NP_ROUTING_DESTINATION

table. 3 The combined rule set and routing destination must not already be defined in

the NP_RULE table. 4 The carrier names must exist in the NP_CARRIER table 5 Carriers must be specified sequentially.

Optional parameters




Modify LCR Rule The command NPLC2 and action CHG lets you change a rule in the NP_RULE table for the specified rule set.


RULE_SET




ROUTING_DESTINATION



CARRIER1

Syntax: CARRIER1=<CarrierName> Description: The name of the carrier. Type: String Optionality: Required. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER1=Carrier 1


CARRIER2

Syntax: CARRIER2=<2ndCarrierName> Description: The name of the 2nd carrier. Type: String Optionality: Must be specified if subsequent carriers are to be specified. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER2=Carrier 2


Description

Required parameters



Modify LCR Rule, Continued



CARRIER3

Syntax: CARRIER3=<3rdCarrierName> Description: The name of the 3rd carrier. Type: String Optionality: Must be specified if subsequent carriers are to be specified. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER3=Carrier 3

CARRIER4


CARRIER5


CARRIER6

Syntax: CARRIER6<6thCarrierName> Description: The name of the 6th carrier. Type: String Optionality: Must be specified if subsequent carriers are to be specified. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER6=Carrier 6



Modify LCR Rule, Continued



CARRIER7



CARRIER8

Syntax: CARRIER8=<8thCarrierName> Description: The name of the 8th carrier. Type: String Optionality: Optional. May only be specified if carriers 1 to 7 are

specified. Allowed: A text string, up to 30 characters long. Default: None Example: CARRIER8=Carrier 8

The following rules apply to the NPLC2=CHG command.


table. 3 The combined rule set and routing destination must exist in the NP_RULE

table. 4 The carrier names must exist in the NP_CARRIER table 5 Carriers must be specified sequentially. 6 All carriers (carriers 1 to 8) will be updated, therefore you must specify a value

for each of the required carriers. Carriers for which you do not specify a value will be set to null.

Optional parameters




Delete LCR Rule The command NPLC2 and action DEL lets you delete a rule from the NP_RULE table for the specified rule set and routing destination.


RULE_SET




ROUTING_DESTINATION





The following rules apply to the NPLC2=DEL command.


table. 3 The combination of rule set and routing destination must exist in the

NP_RULE table.

Description

Required parameters




Add Home Routing Entry The command NPHR1 and action ADD lets you add a new home routing entry in the NP_HOME_ROUTING table.


DN_START



DN_END



Type: Integer



DN_TYPE

Syntax: DN_TYPE=<Home/Special>

Description: The type of DN.

Type: String

Optionality: Optional (default used if not set).

Allowed: Either: • H - home, or • S - Special.

Default: S

Notes: If the ROUTING_DESTINATION field is not specified, then DN_TYPE must be set to 'S'.

Example: DN_TYPE=H


Description

Required parameters



Add Home Routing Entry, Continued



ROUTING_DESTINATION



The following rules apply to the NPHR1=ADD command.

1 The range defined by DN_START and DN_END must not overlap an already defined range.

2 DN_END must be the same length as DN_START. 3 If specified, ROUTING_DESTINATION must be a routing destination defined

in the np_routing_destination table. 4 The DN_LENGTH field in the NP_HOME_ROUTING table is populated by a

database trigger. 5 If ROUTING_DESTINATION is specified, DN_TYPE must be ‘H’ or ‘S’. 6 If ROUTING_DESTINATION is not specified, DN_TYPE must be ‘S’. 7 DN_TYPE will default to ‘S’ if the ROUTING_DESTINATION is not specified

and DN_TYPE is not specified.

Optional parameters




Modify Home Routing Entry The command NPHR1 and action CHG lets you modify an existing entry in the NP_HOME_ROUTING table.


DN_START



DN_END



Type: Integer



DN_TYPE

Syntax: DN_TYPE=<Home/Special>

Description: The type of DN.

Type: String

Optionality: Optional (default used if not set).

Allowed: Either: • H - home, or • S - Special.

Default: S

Notes: If the ROUTING_DESTINATION field is not specified, then DN_TYPE must be set to 'S'.

Example: DN_TYPE=H


Description

Required parameters



Modify Home Routing Entry, Continued



ROUTING_DESTINATION



The following rules apply to the NPHR1=CHG command.

1 The range defined by DN_START and DN_END must exist already in the NP_HOME_ROUTING table.

2 If specified, ROUTING_DESTINATION must be a routing destination defined in the NP_ROUTING_DESTINATION table.

3 If ROUTING_DESTINATION is specified, DN_TYPE must be ‘H’ or ‘S’. 4 If ROUTING_DESTINATION is not specified, DN_TYPE must be ‘S’. An

existing set ROUTING_DESTINATION will be made null. 5 DN_TYPE will default to ‘S’ if the ROUTING_DESTINATION is not specified

and DN_TYPE is not specified.

Optional parameters




Delete Home Routing Entry The command NPHR1 and action DEL lets you delete an existing entry from the NP_HOME_ROUTING table.


DN_START



DN_END



Type: Integer




The following rules apply to the NPHR1=DEL command.

1 The range defined by DN_START and DN_END must exist already in the NP_HOME_ROUTING table.

Description

Required parameters




Query Home Routing Entry The command NPHR1 and action QRY lets you query an entry in the NP_HOME_ROUTING table. These details are returned:

• DN range • routing destination, and • DN type.


DN

Syntax: DN=<Number> Description: The number to query. The DN must be within the required

DN range. Type: Integer Optionality: Mandatory. Allowed: Number, 4 to 18 digits long. Default: None Example: DN=4124



The following rules apply to the NPHR1=QRY command.

1 The DN must be within the DN range you want to query. I.e. The DN must be >= DN_START and <= DN_END.

2 The DN must be formatted correctly. It must be a number between 4 and 18 digits long.

Description

Required parameters




Error Code Lists Overview

This chapter explains the error codes for NP PI commands.


PI Chassis Errors .......................................................................................... 34 PI Command Errors ....................................................................................... 36

Chapter 3

Introduction

In this chapter



PI Chassis Errors 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.


Error list


PI Chassis Errors, Continued


Error list (continued)

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 The synstamp is not at the end of the command, but before the checksum.

91 TIMEOUT The command took too long to run.



PI Command Errors This table describes the PI Command error codes.

Code Message Commands 68 Badly formatted parameter

<parameter> All commands.

69 <text> All commands.

Note: Used to report any undefined errors.

1000 The specified range <start> to <end> [with activation date <date>] overlaps an already defined range

NPDS1=ADD (includes text in square brackets) NPHR1=ADD

1001 The end of range <end> is a different length to the start of range <start>

NPDS1=ADD NPDHR1=ADD

1002 The routing number <routing number> is not defined in the routing number table

NPDS1=ADD NPDS1=CHG

1003 The specified range <start> to <end> [with activation date <date>] is not defined

NPDS1=CHG (includes text in square brackets) NPDS1=DEL (includes text in square brackets) NPHR1=CHG NPHR1=DEL

1004 The DN <dn> was not in the defined ranges

NPDS1=QRY NPHR1=QRY

1005 A rule set with name <name> is already defined

NPLC1=ADD NPLC1=CHG

1006 A rule set with name <name> is not defined

NPLC1=CHG NPLC1=DEL NPLC2=ADD NPLC2=CHG NPLC2=DEL

1007 The rule set <name> has associated rules

NPLC1=DEL

1008 The routing destination <routing destination> is not defined in the routing destination table

NPLC2=ADD NPLC2=CHG NPLC2=DEL NPHR1=ADD NPHR1=CHG


Error list


PI Command Errors, Continued


Error list (continued)

Code Message Commands 1009 The rule set <rule set> and

routing destination <routing destination> are already defined in the rules table

NPLC2=ADD

1010 CARRIER<n> must be defined if CARRIER<m, where m is greater than n> is defined

NPLC2=ADD NPLC2=CHG

1011 The rule set <rule set> and routing destination <routing destination> are not defined in the rules table

NPLC2=CHG NPLC2=DEL

1012 The DN_TYPE <type> is not a known type

NPHR1=ADD NPHR1=CHG

1013 The CARRIER<N> <name> is not a known carrier

NPLC2=ADD NPLC2=CHG

1014 The start of range <start> is after the end of range <end>

NPDS1=ADD NPDS1=CHG NPDS1=DEL NPHR1=ADD NPHR1=CHG NPHR1=DEL

1015 DN_TYPE not specified when ROUTING_DESTINATION is specified

NPHR1=ADD NPHR1=CHG



Appendix

Overview

This appendix contains the following topics.

Glossary of Terms ......................................................................................... 41 Index .............................................................................................................. 43

In this appendix



Glossary of Terms

Billing Engine

Graphical User Interface

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.

Intelligent Network

1) Internet Protocol

2) Intelligent Peripheral - a box that is able to play announcements

Number Portability

Oracle Corporation

Provisioning Interface - used for bulk database updates/configuration instead of GUI based configuration.

Standard Generalized Markup Language. The international standard for defining descriptions of the structure of different types of electronic document.

Structured Query Language - a database query language.

Transmission Control Protocol. This is a reliable octet streaming protocol used by the majority of applications on the Internet. It provides a connection-oriented, full-duplex, point to point service between hosts.

Uniform Resource Identifier.

Universal Service Management System hardware platform.

The Virtual Private Network product is an enhanced services capability enabling private network facilities across a public telephony network.

BE

GUI

HTML

IN

IP

NP

Oracle

PI

SGML

SQL

TCP

URI

USMS

VPN



A About this Document

Audience • v Changes in this document • v Pre-requisites • v Related documents • v Scope • v

ACTIVATION_DATE • 6, 10, 15 Add a Ported Number Range

Constraint required parameters • 7 Description • 6 Logic and constraints • 9 Optional parameters • 7 Required parameters • 6

Add Home Routing Entry Constraint required parameters • 27 Description • 27 Logic and constraints • 28 Optional parameters • 28 Required parameters • 27

Add New LCR Rule Constraint required parameters • 20 Description • 20 Logic and constraints • 22 Optional parameters • 22 Required parameters • 20

Add New LCR Rule Set Constraint required parameters • 17 Description • 17 Logic and constraints • 17 Optional parameters • 17 Required parameters • 17

ADDITIONAL_RN_ID • 8, 12 Audience

About this Document • v

B BE • 1

C CARRIER1 • 20, 23 CARRIER2 • 20, 23 CARRIER3 • 21, 24 CARRIER4 • 21, 24 CARRIER5 • 21, 24 CARRIER6 • 21, 24 CARRIER7 • 22, 25 CARRIER8 • 22, 25 CASCADE • 19 Changes in this document

About this Document • v Command list

Command List • 2

Command List Command list • 2

Constraint required parameters Add a Ported Number Range • 7 Add Home Routing Entry • 27 Add New LCR Rule • 20 Add New LCR Rule Set • 17 Delete a Ported Number Range • 14 Delete Home Routing Entry • 31 Delete LCR Rule • 26 Delete LCR Rule Set • 19 Modify a Ported Number Range • 11 Modify Home Routing Entry • 29 Modify LCR Rule • 23 Modify LCR Rule Set • 18 Query an Active Ported Number Range •

16 Query Home Routing Entry • 32

D Delete a Ported Number Range


Delete Home Routing Entry Constraint required parameters • 31 Description • 31 Logic and constraints • 31 Optional parameters • 31 Required parameters • 31

Delete LCR Rule Constraint required parameters • 26 Description • 26 Logic and constraints • 26 Optional parameters • 26 Required parameters • 26

Delete LCR Rule Set Constraint required parameters • 19 Description • 19 Logic and constraints • 19 Optional parameters • 19 Required parameters • 19

Description Add a Ported Number Range • 6 Add Home Routing Entry • 27 Add New LCR Rule • 20 Add New LCR Rule Set • 17 Delete a Ported Number Range • 14 Delete Home Routing Entry • 31 Delete LCR Rule • 26 Delete LCR Rule Set • 19 Modify a Ported Number Range • 10 Modify Home Routing Entry • 29

Index



Modify LCR Rule • 23 Modify LCR Rule Set • 18 Query an Active Ported Number Range •


DN • 16, 32 DN_END • 6, 10, 14, 27, 29, 31 DN_START • 6, 10, 14, 27, 29, 31 DN_TYPE • 27, 29 Document Conventions

Icons • vi Terminology • vi Typographical conventions • vi

DONOR_ID • 8, 12

E ENTRY_TYPE • 7, 11, 14 Error list

PI Chassis Errors • 34 PI Command Errors • 36

F Formats

Parameter Formats • 3

G GUI • 41

H HTML • vi

I Icons

Document Conventions • vi IN • v IP • 1

L Logic and constraints

Add a Ported Number Range • 9 Add Home Routing Entry • 28 Add New LCR Rule • 22 Add New LCR Rule Set • 17 Delete a Ported Number Range • 15 Delete Home Routing Entry • 31 Delete LCR Rule • 26 Delete LCR Rule Set • 19 Modify a Ported Number Range • 13 Modify Home Routing Entry • 30 Modify LCR Rule • 25 Modify LCR Rule Set • 18 Query an Active Ported Number Range •


M Modify a Ported Number Range


Modify Home Routing Entry Constraint required parameters • 29 Description • 29 Logic and constraints • 30 Optional parameters • 30 Required parameters • 29

Modify LCR Rule Constraint required parameters • 23 Description • 23 Logic and constraints • 25 Optional parameters • 25 Required parameters • 23

Modify LCR Rule Set Constraint required parameters • 18 Description • 18 Logic and constraints • 18 Optional parameters • 18 Required parameters • 18

N NEW_NAME • 18 NUMBER_TYPE • 7, 11

O Optional parameters

Add a Ported Number Range • 7 Add Home Routing Entry • 28 Add New LCR Rule • 22 Add New LCR Rule Set • 17 Delete a Ported Number Range • 14 Delete Home Routing Entry • 31 Delete LCR Rule • 26 Delete LCR Rule Set • 19 Modify a Ported Number Range • 11 Modify Home Routing Entry • 30 Modify LCR Rule • 25 Modify LCR Rule Set • 18 Query an Active Ported Number Range •


Oracle • ii

P Parameter Formats

Formats • 3 Parameters

ACTIVATION_DATE • 6, 10, 15 ADDITIONAL_RN_ID • 8, 12 CARRIER1 • 20, 23



CARRIER2 • 20, 23 CARRIER3 • 21, 24 CARRIER4 • 21, 24 CARRIER5 • 21, 24 CARRIER6 • 21, 24 CARRIER7 • 22, 25 CARRIER8 • 22, 25 CASCADE • 19 DN • 16, 32 DN_END • 6, 10, 14, 27, 29, 31 DN_START • 6, 10, 14, 27, 29, 31 DN_TYPE • 27, 29 DONOR_ID • 8, 12 ENTRY_TYPE • 7, 11, 14 NEW_NAME • 18 NUMBER_TYPE • 7, 11 PORT_ID • 8, 12 ROUTING_DESTINATION • 20, 23, 26, 28,

30 ROUTING_NUMBER • 7, 11 RULE_SET • 17, 18, 19, 20, 23, 26 URI • 8, 12

PI • ii PI Chassis Errors

Error list • 34 PI Command Errors

Error list • 36 PORT_ID • 8, 12 Pre-requisites

About this Document • v

Q Query an Active Ported Number Range


Query Home Routing Entry Constraint required parameters • 32 Description • 32 Logic and constraints • 32 Optional parameters • 32 Required parameters • 32

R Related documents

About this Document • v Required parameters

Add a Ported Number Range • 6 Add Home Routing Entry • 27 Add New LCR Rule • 20 Add New LCR Rule Set • 17 Delete a Ported Number Range • 14 Delete Home Routing Entry • 31 Delete LCR Rule • 26 Delete LCR Rule Set • 19

Modify a Ported Number Range • 10 Modify Home Routing Entry • 29 Modify LCR Rule • 23 Modify LCR Rule Set • 18 Query an Active Ported Number Range •


ROUTING_DESTINATION • 20, 23, 26, 28, 30 ROUTING_NUMBER • 7, 11 RULE_SET • 17, 18, 19, 20, 23, 26

S Scope

About this Document • v SGML • 41 SMS • vi SQL • 1

T TCP • 1 Terminology

Document Conventions • vi Typographical conventions

Document Conventions • vi

U URI • 8, 12 USMS • 5

V VPN • v

oracle communications network charging and control product ... commands (np) operations... · pi...

Documents