oracle communications network charging and control product ... commands (acs... · this software...

35
Oracle Communications Network Charging and Control Product: OCNCC 4.3 Component: PI Commands (ACS) Operations Guide S’ware version: Release 2.4.2 Guide version: 02.00 Release date: December 2010 Status: Approved

Upload: others

Post on 02-Jun-2020

11 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Oracle Communications Network Charging and Control

Product: OCNCC 4.3 Component: PI Commands (ACS)

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

Release date: December 2010

Status: Approved

Page 2: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

Copyright PI Commands (ACS) Operations Guide, Release 2.4.2

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 (ACS) Operations Guide

Page 3: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

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 

Chapter 2 

piAcsSms Package 

Overview .............................................................................................................................. 3 Add CLI to ACS Numbers .................................................................................................... 4 Delete a CLI from ACS Numbers ........................................................................................ 5 Query a CLI using ACS Numbers........................................................................................ 6 Change a Profile Entry ........................................................................................................ 7 Query a Profile Entry ......................................................................................................... 10 Export a Call Plan .............................................................................................................. 13 Import a Call Plan .............................................................................................................. 14 Delete a Call Plan .............................................................................................................. 16 

Chapter 3 

Error Code Lists 

Overview ............................................................................................................................ 17 PI Chassis Errors ............................................................................................................... 18 PI Command Errors ........................................................................................................... 20 

Appendix Overview ............................................................................................................................ 23 Glossary of Terms ............................................................................................................. 25 Index .................................................................................................................................. 27 

PI Commands (ACS) Page iii Operations Guide

Page 4: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions
Page 5: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

PI Commands (ACS) Page v

About this Document The scope of this document includes all the information required to configure the Provisioning Interface commands.

Scope

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

Audience

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.

Pre-requisites

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: Related documents

• PI Technical Guide • VPN User's Guide

Here are the changes to the document since the last release. Changes in this document

Version no.

Revision Date Description

01.00 2009-01-07 Initial version based on specifications. 02.00 2010-09-24 Added Call Plan commands - ACSCPL=

Re-branded.

Operations Guide

Page 6: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

Document Conventions Before you start using this guide, it is important to understand the terms and typographical conventions used in the documentation.

Typographical conventions

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.

Icons

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 (ACS) Operations Guide

Page 7: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

Chapter 1

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.

Introduction

This chapter contains the following topics.

Command List ................................................................................................. 2

In this chapter

PI Commands (ACS) Page 1 Operations Guide

Page 8: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Chapter 1 Commercial In Confidence

Command List The following table lists the functions available and their corresponding commands. To use the commands they must have been installed with the piAcsSms package.

Command list

Function piAcsSms Add CLI to ACS Numbers ACSCLI=ADD

Delete a CLI from ACS Numbers ACSCLI=DEL

Query a CLI using ACS Numbers ACSCLI=QRY

Change a Profile Entry ACSPFL=CHG

Query a Profile Entry ACSPFL=QRY

Export a Call Plan ACSCPL=EXP

Import a Call Plan ACSCPL=IMP Delete a Call Plan ACSCPL=DEL

Page 2 PI Commands (ACS) Operations Guide

Page 9: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

Chapter 2

piAcsSms Package Overview

This chapter describes the available PI commands for provisioning CLI and Profile entries on the USMS.

Introduction

These commands are added by the piAcsSms package. For installation details see the PI Technical Guide.

This chapter contains the following topics.

Add CLI to ACS Numbers ............................................................................... 4 Delete a CLI from ACS Numbers .................................................................... 5 Query a CLI using ACS Numbers ................................................................... 6 Change a Profile Entry .................................................................................... 7 Query a Profile Entry ..................................................................................... 10 Export a Call Plan .......................................................................................... 13 Import a Call Plan .......................................................................................... 14 Delete a Call Plan .......................................................................................... 16

In this chapter

PI Commands (ACS) Page 3 Operations Guide

Page 10: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Chapter 2 Commercial In Confidence

Add CLI to ACS Numbers Add a CLI to ACS Numbers. If the CLI does not exist, it will be added. If the CLI already exists it will be updated. The allowed numbers list will be set in the ACS Allowed Numbers. A Control Plan will be scheduled for the CLI.

Description

Here are the required parameters for this command. Required parameters

CLI

Syntax: CLI=num Description: CLI for the subscriber. Format: 18 digit number (>0) Example: CLI=1234567

CALLPLAN

Syntax: CALLPLAN=cp Description: The name of the control plan for the service. Format: 50 character string Example: CALLPLAN=CP2

ACSCLI=ADD accepts the following parameters. Optional parameters

Syntax: ALLOWED="cell|cell|..." Description: The list of CELLs to add. Format: “CELL1|CELL2…” Note: Format of cell is 15 digit number, (zero padded):

MSCID (MarketID=6 digitsSwitchNum=3 digits) +ServingCellID=6 digits. MSCID is an optional part of the CELL

Example: ALLOWED="123456789012345|223456789012345"

Optional parameters

The following rules apply when using the ACSCLI=ADD command: Logic and constraints

• The CALLPLAN must exist. • The ALLOWED list is a pipe ("|") separated list of up to 100 CELLs. • If CLI exists, it will be updated with new data. • If ALLOWED is not supplied, the number list will be ignored (IGNORE flag

set).

ACSCLI=ADD:ACK; Success return

Error codes: 101, 102, 103, 105, 106, 107, 108, 109 and 110. Error return

See PI Command Errors (on page 20) for a description of each error.

Page 4 PI Commands (ACS) Operations Guide

Page 11: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence Chapter 2

Delete a CLI from ACS Numbers Delete a CLI from ACS Numbers. The Control Plan is unscheduled for the CLI and the CLI is removed.

Description

Here is the required parameter for this command. Required parameter

CLI

Syntax: CLI=num Description: CLI for the subscriber. Format: 18 digit number (>0) Example: CLI=1234567

There are no optional parameters. Optional parameters

The following rules apply when using the ACSCLI=DEL command: Logic and constraints

• CLI must exist.

ACSCLI=DEL:ACK; Success return

Error codes: 101, 102, 104, 105, 107, 108, 109 and 110. Error return - del cli - 34540

See PI Command Errors (on page 20) for a description of each error.

PI Commands (ACS) Page 5 Operations Guide

Page 12: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Chapter 2 Commercial In Confidence

Query a CLI using ACS Numbers Query a CLI using ACS Numbers. Description

Returns back the allowed CELLs for a given subscriber in ACS Numbers. No changes are made to the running system.

Here is the required parameter for this command. Required parameter

CLI

Syntax: CLI=num Description: CLI for the subscriber. Format: 18 digit number (>0) Example: CLI=1234567

There are no optional parameters. Optional parameters

The following rules apply when using the ACSCLI=QRY command: Logic and constraints

• CLI must exist.

ACSCLI=QRY:ACK:ALLOWED=<CELL1|CELL2|…> Success return

Error return

Note: No carriage returns are returned.

Error codes: 101, 102, 104, 105, 107 and 109.

See PI Command Errors (on page 20) for a description of each error.

Page 6 PI Commands (ACS) Operations Guide

Page 13: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence Chapter 2

Change a Profile Entry Change or delete a profile entry. Description

Here are the required parameters for this command. Required parameters

TABLE

Syntax: TABLE=tabl Description: The table of the profile. Type: 30 character string. Example: TABLE=ACS_PROFILE_DETAILS

ID

Syntax: ID=id Description: The ID of the row. Type: Integer

TAG

Syntax: TAG = <tag id> Description: The profile tag. Type: Hex or String Allowed: Either a hexadecimal value prefixed by 0x, e.g. 0x123ABC,

or a pre-defined name corresponding to PROFILE_TAG_NAME in the ACS_PROFILE_DETAILS table.

Default: HEX Notes: If TAG is:

• a predefined name, any specified TYPE is ignored. • a hexadecimal value, and TYPE is omitted, the value will

be returned as hexadecimal data. • omitted, a hex dump of the whole profile is returned.

Example: TAG=0x123ABC

ACSPFL=CHG accepts the following parameters. Optional parameters

PROFILE_COL

Syntax: PROFILE_COL = column name Description: The name of the profile column. Type: String Optionality: Optional (default used if omitted). Default: PROFILE Notes: A valid profile column in TABLE. Example: PROFILE_COL=CLI

Continued on next page

PI Commands (ACS) Page 7 Operations Guide

Page 14: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Chapter 2 Commercial In Confidence

Change a Profile Entry, Continued

Page 8 PI Commands (ACS) Operations Guide

Optional parameters (continued)

ID_COL

Syntax: ID_COL = id col name Description: The name of the ID column. Type: String Optionality: Optional (default used if omitted). Allowed: ID Default: ID Notes: A valid column in TABLE containing unique ID. Example: ID_COL=ID

TYPE

Syntax: TYPE = tag type Description: The type of the tag. Type: String Optionality: Optional (default used if omitted). Allowed: Valid options are:

• STRING string value • DATE date value • INTEGER 32 bit signed integer value • HEX, or raw hexadecimal data • TN telephone number

Default: HEX Example: TYPE=DATE

VALUE

Syntax: VALUE=val Description: The value of the tag. Type: Defined by the TYPE parameter. Optionality: Optional Default: If VALUE is not specified, any existing profile tag will be

deleted. Notes: For TYPE = TN, the VALUE format is:

• must only contain numeric digits • first character is interpreted as a TN type • TN type has range 0-5 • TN has max length 33 characters (including TN type)

Examples: VALUE=12345 Integer type VALUE=Monday String type VALUE=2009010112345 Date type (YYYYMMDDHHMMSS) VALUE=0x123ABC Hex type VALUE=12345 TN type

Continued on next page

Page 15: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence Chapter 2

Change a Profile Entry, Continued

The following rules apply when using the ACSPFL=CHG command: Logic and constraints

• The TABLE must exist.

ACSPFL=CHG:ACK; Success return

Error codes: 101, 102, 107, 110, 111, 112, 113, 114, 115, 116 and 117. Error return

See PI Command Errors (on page 20) for a description of each error.

PI Commands (ACS) Page 9 Operations Guide

Page 16: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Chapter 2 Commercial In Confidence

Query a Profile Entry Query a profile entry. Description

Here are the required parameters for this command. Required parameters

TABLE

Syntax: TABLE=tabl Description: The table of the profile. Type: 30 character string. Example: TABLE=ACS_PROFILE_DETAILS

ID

Syntax: ID=id Description: The ID of the row. Type: Integer

ACSPFL=QRY accepts the following parameters. Optional parameters

PROFILE_COL

Syntax: PROFILE_COL = column name Description: The name of the profile column. Type: String Optionality: Optional (default used if omitted). Default: PROFILE Notes: A valid profile column in TABLE. Example: PROFILE_COL=CLI

ID_COL

Syntax: ID_COL = id col name Description: The name of the ID column. Type: String Optionality: Optional (default used if omitted). Allowed: ID Default: ID Notes: A valid column in TABLE containing unique ID. Example: ID_COL=ID

Continued on next page

Page 10 PI Commands (ACS) Operations Guide

Page 17: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence Chapter 2

Query a Profile Entry, Continued

Optional parameters (continued)

TAG

Syntax: TAG = <tag id> Description: The profile tag. Type: Hex or String Allowed: Either a hexadecimal value prefixed by 0x, e.g. 0x123ABC,

or a pre-defined name corresponding to PROFILE_TAG_NAME in the ACS_PROFILE_DETAILS table.

Default: HEX Notes: If TAG is:

• a predefined name, any specified TYPE is ignored. • a hexadecimal value, and TYPE is omitted, the value will

be returned as hexadecimal data. • omitted, a hex dump of the whole profile is returned.

Example: TAG=0x123ABC

TYPE

Syntax: TYPE = tag type Description: The type of the tag. Type: String Optionality: Optional (default used if omitted). Allowed: Valid options are:

• STRING string value • DATE date value • INTEGER 32 bit signed integer value • HEX, or raw hexadecimal data • TN telephone number

Default: HEX Example: TYPE=DATE

The following rules apply when using the ACSPFL=QRY command: Logic and constraints

• The TABLE must exist.

Continued on next page

PI Commands (ACS) Page 11 Operations Guide

Page 18: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Chapter 2 Commercial In Confidence

Query a Profile Entry, Continued

If TAG was specified: Success return

• ACSPFL=QRY:ACK:TAG=tag,VALUE=value;

• ACSPFL=QRY:ACK:TAG=tag; If the tag does not exist.

If TAG was not specified:

• ACSPFL=QRY:ACK: TAG=hex tag,VALUE=hex value[, TAG=hex tag,VALUE=hex value[, ...]];

Note: No carriage returns are returned. If the TYPE is DATE, the VALUE format is "YYYYDDMMHHMMSS".

Error codes: 101, 102, 107, 111, 112, 113, 114, 115 and 116. Error codes

See PI Command Errors (on page 20) for a description of each error.

Page 12 PI Commands (ACS) Operations Guide

Page 19: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence Chapter 2

Export a Call Plan Export a call plan from the database to a text file in CPL or XML form. Description

Here are the required parameters for this command. Required parameters

CUSTOMER

Syntax: CUSTOMER= custname Description: The name of the ACS customer that owns the controlplan. Type: String Example: CUSTOMER=TelcoEurope

CALLPLAN

Syntax: CALLPLAN=cp Description: The name of the control plan for the service. Format: 50 character string Example: CALLPLAN=CP2

ACSCPL=EXP accepts the following parameters. Optional parameters

FORMAT

Syntax: FORMAT = cp Description: The format of the file created. Type: String Allowed: Valid options are:

• CPL, or • XML

Default: CPL Example: FORMAT = CPL

The following rules apply when using the ACSCPL=EXP command: Logic and constraints

• The CUSTOMER must exist. • The CALLPLAN must exist for CUSTOMER. • The name of the file created will be:

<customer>___<callplan>___<version>.<ext> where <ext> is “cpl” or “xml”.

ACSCPL=EXP:ACK:FILENAME=<full path of file created on USMS>; Success return

Error codes: 101, 102, 103, 107, 118 and 119. Error return

See PI Command Errors (on page 20) for a description of each error.

PI Commands (ACS) Page 13 Operations Guide

Page 20: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Chapter 2 Commercial In Confidence

Import a Call Plan Import a call plan into the database from a text file in CPL or XML form. Description

Here are the required parameters for this command. Required parameters

CUSTOMER

Syntax: CUSTOMER= custname Description: The name of the ACS customer that owns the controlplan. Type: String Example: CUSTOMER=TelcoEurope

CALLPLAN

Syntax: CALLPLAN=cp Description: The name of the control plan for the service. Format: 50 character string Example: CALLPLAN=CP2

FILENAME

Syntax: FILENAME=fname Description: The file name. Type: String Allowed: The full pathname of an existing file on the USMS Example: FILENAME=CP3.cpl

ACSCPL=IMP accepts the following parameters. Optional parameters

FORMAT

Syntax: FORMAT = cp Description: The format of the file to import from. Type: String Allowed: Valid options are:

• CPL, or • XML

Default: CPL Example: FORMAT = CPL

Continued on next page

Page 14 PI Commands (ACS) Operations Guide

Page 21: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence Chapter 2

Import a Call Plan, Continued

The following rules apply when using the ACSCPL=IMP command: Logic and constraints

• The CUSTOMER must exist. • CALLPLAN name must not start with any whitespace characters. • If CALLPLAN already exists for CUSTOMER then the import will update the

call plan and increment its version number, provided that: only a single successfully compiled version of the call plan exists. no other call plans use the call plan structure. the call plan is not associated with an ACS Service Number. the call plan is not associated with an ACS CLI Number. the call plan is not associated with a CCS Product Type.

• If CALLPLAN does not exist for CUSTOMER then the import will create a new call plan with version number = 1.

• FILENAME must specify the full pathname of an existing file on the USMS containing the call plan details to import.

• If FORMAT is not specified, the default of CPL is assumed for the file. • The file contents specified by FILENAME must match the specified or default

format specified by FORMAT.

ACSCPL=IMP:ACK; Success return

Error codes: 101, 102, 107, 118, 119, 120 and 121. Error return

See PI Command Errors (on page 20) for a description of each error.

PI Commands (ACS) Page 15 Operations Guide

Page 22: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Chapter 2 Commercial In Confidence

Delete a Call Plan Delete a call plan from the database. Description

Here are the required parameters for this command. Required parameters

CUSTOMER

Syntax: CUSTOMER= custname Description: The name of the ACS customer that owns the controlplan. Type: String Example: CUSTOMER=TelcoEurope

CALLPLAN

Syntax: CALLPLAN=cp Description: The name of the control plan for the service. Format: 50 character string Example: CALLPLAN=CP2

There are no optional parameters. Optional parameters

The following rules apply when using the ACSCPL=DEL command: Logic and constraints

• The CUSTOMER must exist. • The CALLPLAN must exist for CUSTOMER and:

only a single successfully compiled version of the call plan exists. no other call plans use the call plan structure. the call plan is not associated with an ACS Service Number. the call plan is not associated with an ACS CLI Number. the call plan is not associated with a CCS Product Type.

ACSCPL=DEL:ACK; Success return

Error codes: 101, 102, 103, 107 and 118. Error return

See PI Command Errors (on page 20) for a description of each error.

Page 16 PI Commands (ACS) Operations Guide

Page 23: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

Chapter 3

Error Code Lists Overview

This chapter explains the error codes for PI commands. Introduction

This chapter contains the following topics.

PI Chassis Errors .......................................................................................... 18 PI Command Errors ....................................................................................... 20

In this chapter

PI Commands (ACS) Page 17 Operations Guide

Page 24: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Chapter 3 Commercial In Confidence

PI Chassis Errors NACK:Code-Message; Format

Example: ACSCLI=QRY:NACK:70-TOO MANY SESSIONS

This table describes the PI Chassis error codes. Error list

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.

Continued on next page

Page 18 PI Commands (ACS) Operations Guide

Page 25: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence Chapter 3

PI Chassis Errors, Continued

PI Commands (ACS) Page 19 Operations Guide

Error list (continued)

Code Message Description 86 COMMAND TOO BIG The command sent is too long.

Indicates an incorrectly formatted command.

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.

Page 26: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Chapter 3 Commercial In Confidence

PI Command Errors Command:NACK:Code-Message:value; Format

Example: ACSCLI=QRY:NACK:104-CLI does not exist:912233445566

Message can contain any characters, other than semi-colon.

In the message, value will be replaced with a suitable value by the command.

This table describes the PI Command error codes. Error list

Code Message Commands 101 text

(This is to report any other errors not defined below) All commands

102 Badly formatted parameter parameter All commands

103 CALLPLAN does not exist callplan ACSCLI=ADD ACSCPL=EXP ACSCPL=DEL

104 CLI does not exist cli ACSCLI=DEL ACSCLI=QRY

105 No required parameters All commands

106 Too many numbers in ALLOWED list ACSCLI=ADD

107 Invalid action action All commands

108 SQL write error ACSCLI=ADD ACSCLI=DEL

109 SQL read error ACSCLI=ADD ACSCLI=DEL ACSCLI=QRY

110 Internal error encoding profile ACSCLI=ADD ACSCLI=DEL ACSPFL=CHG

111 TABLE does not exist table name ACSPFL=CHG ACSPFL=QRY

112 ID_COLUMN does not exist column name ACSPFL=CHG ACSPFL=QRY

113 ID does not exist id ACSPFL=CHG ACSPFL=QRY

114 PROFILE_COLUMN does not exist column name ACSPFL=CHG ACSPFL=QRY

115 TAG does not exist tag name ACSPFL=CHG ACSPFL=QRY

116 TYPE is not valid type name ACSPFL=CHG ACSPFL=QRY

Continued on next page

Page 20 PI Commands (ACS) Operations Guide

Page 27: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence Chapter 3

PI Command Errors, Continued

PI Commands (ACS) Page 21 Operations Guide

Error list (continued)

Code Message Commands 117 VALUE is not valid value ACSPFL=CHG

ACSPFL=QRY

118 CUSTOMER does not exist customer name ACSCPL=EXP ACSCPL=IMP ACSCPL=DEL

119 FORMAT is not valid value ACSCPL=EXP ACSCPL=IMP

120 FILENAME does not exist file name ACSCPL=IMP 121 FILENAME has insufficient permissions file name ACSCPL=IMP

Page 28: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions
Page 29: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

PI Commands (ACS) Page 23

Appendix

Overview

This appendix contains the following topics. In this appendix

Glossary of Terms ......................................................................................... 25 Index .............................................................................................................. 27

Operations Guide

Page 30: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions
Page 31: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

Glossary of Terms

Advanced Control Services configuration platform. ACS

Automatic Number Identification - Term used in the USA by long distance carriers for CLI.

ANI

Billing Engine BE

1) Charging Control Services (or Prepaid Charging) component. CCS

2) Common Channel Signalling. A signalling system used in telephone networks that separates signalling information from user data.

Calling Line Identification - the telephone number of the caller. Also referred to as ANI.

CLI

Graphical User Interface GUI

HyperText Markup Language, a small application of SGML used on the World Wide Web.

HTML

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 IN

1) Internet Protocol IP

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

Oracle Corporation Oracle

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

PI

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

SGML

Structured Query Language - a database query language. SQL

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.

TCP

Universal Service Management System hardware platform. USMS

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

VPN

PI Commands (ACS) Page 25 Operations Guide

Page 32: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

Page 26 PI Commands (ACS)

eXtensible Markup Language. It is designed to improve the functionality of the Web by providing more flexible and adaptable information identification.

XML

It is called extensible because it is not a fixed format like HTML. XML is a `metalanguage' — a language for describing other languages—which lets you design your own customized markup languages for limitless different types of documents. XML can do this because it's written in SGML.

Operations Guide

Page 33: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

Index

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

Add CLI to ACS Numbers Description • 4 Error return • 4 Logic and constraints • 4 Optional parameters • 4 Required parameters • 4 Success return • 4

ANI • 25 Audience

About this Document • v

BE • 1

CALLPLAN • 4, 13, 14, 16 CCS • 15 Change a Profile Entry

Description • 7 Error return • 9 Logic and constraints • 9 Optional parameters • 7 Required parameters • 7 Success return • 9

Changes in this document About this Document • v

CLI • 2, 4, 5, 6 Command list

Command List • 2 Command List

Command list • 2 CUSTOMER • 13, 14, 16

Delete a Call Plan Description • 16 Error return • 16 Logic and constraints • 16 Optional parameters • 16 Required parameters • 16 Success return • 16

Delete a CLI from ACS Numbers Description • 5 Error return - del cli - 34540 • 5 Logic and constraints • 5 Optional parameters • 5

Required parameter • 5 Success return • 5

Description Add CLI to ACS Numbers • 4 Change a Profile Entry • 7 Delete a Call Plan • 16 Delete a CLI from ACS Numbers • 5 Export a Call Plan • 13 Import a Call Plan • 14 Query a CLI using ACS Numbers • 6 Query a Profile Entry • 10

Document Conventions Icons • vi Typographical conventions • vi

E Error codes

Query a Profile Entry • 12 Error list

PI Chassis Errors • 18 PI Command Errors • 20

Error return Add CLI to ACS Numbers • 4 Change a Profile Entry • 9 Delete a Call Plan • 16 Export a Call Plan • 13 Import a Call Plan • 15 Query a CLI using ACS Numbers • 6

Error return - del cli - 34540 Delete a CLI from ACS Numbers • 5

Export a Call Plan Description • 13 Error return • 13 Logic and constraints • 13 Optional parameters • 13 Required parameters • 13 Success return • 13

F FILENAME • 14 Format

PI Chassis Errors • 18 PI Command Errors • 20

FORMAT • 13, 14

GUI • 25

HTML • vi

I Icons

Document Conventions • vi

PI Commands (ACS) Page 27 Operations Guide

Page 34: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

ID • 7, 10 ID_COL • 8, 10 Import a Call Plan

Description • 14 Error return • 15 Logic and constraints • 15 Optional parameters • 14 Required parameters • 14 Success return • 15

IN • v IP • 1

L Logic and constraints

Add CLI to ACS Numbers • 4 Change a Profile Entry • 9 Delete a Call Plan • 16 Delete a CLI from ACS Numbers • 5 Export a Call Plan • 13 Import a Call Plan • 15 Query a CLI using ACS Numbers • 6 Query a Profile Entry • 11

Optional parameters Add CLI to ACS Numbers • 4 Change a Profile Entry • 7 Delete a Call Plan • 16 Delete a CLI from ACS Numbers • 5 Export a Call Plan • 13 Import a Call Plan • 14 Query a CLI using ACS Numbers • 6 Query a Profile Entry • 10

Oracle • ii

P Parameters

CALLPLAN • 4, 13, 14, 16 CLI • 4, 5, 6 CUSTOMER • 13, 14, 16 FILENAME • 14 FORMAT • 13, 14 ID • 7, 10 ID_COL • 8, 10 PROFILE_COL • 7, 10 TABLE • 7, 10 TAG • 7, 11 TYPE • 8, 11 VALUE • 8

PI • ii PI Chassis Errors

Error list • 18 Format • 18

PI Command Errors • 4, 5, 6, 9, 12, 13, 15, 16 Error list • 20 Format • 20

Pre-requisites

About this Document • v PROFILE_COL • 7, 10

Query a CLI using ACS Numbers Description • 6 Error return • 6 Logic and constraints • 6 Optional parameters • 6 Required parameter • 6 Success return • 6

Query a Profile Entry Description • 10 Error codes • 12 Logic and constraints • 11 Optional parameters • 10 Required parameters • 10 Success return • 12

Related documents About this Document • v

Required parameter Delete a CLI from ACS Numbers • 5 Query a CLI using ACS Numbers • 6

Required parameters Add CLI to ACS Numbers • 4 Change a Profile Entry • 7 Delete a Call Plan • 16 Export a Call Plan • 13 Import a Call Plan • 14 Query a Profile Entry • 10

S Scope

About this Document • v SGML • 25 SMS • vi SQL • 1 Success return

Add CLI to ACS Numbers • 4 Change a Profile Entry • 9 Delete a Call Plan • 16 Delete a CLI from ACS Numbers • 5 Export a Call Plan • 13 Import a Call Plan • 15 Query a CLI using ACS Numbers • 6 Query a Profile Entry • 12

T TABLE • 7, 10 TAG • 7, 11 TCP • 1 TYPE • 8, 11 Typographical conventions

Document Conventions • vi

Page 28 PI Commands (ACS) Operations Guide

Page 35: Oracle Communications Network Charging and Control Product ... Commands (ACS... · This software and related documentation are provided under a license agreement containing restrictions

Commercial In Confidence

PI Commands (ACS) Page 29 Operations Guide

USMS • 3

V VALUE • 8 VPN • v

X XML • 13