Tekelec EAGLE 5 Manual

Provisioning database interface
Hide thumbs Also See for EAGLE 5:
Table of Contents

Advertisement

Quick Links

®
Tekelec EAGLE
5
Provisioning Database Interface Manual
910-6022-001 Revision A
March 2011
Copyright 2011 Tekelec. All Rights Reserved. Printed in USA.
Legal Information can be accessed from the Main Menu of the optical disc or on the
Tekelec Customer Support web site in the Legal Information folder of the Product Support tab.

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the EAGLE 5 and is the answer not in the manual?

Questions and answers

Summary of Contents for Tekelec EAGLE 5

  • Page 1 Copyright 2011 Tekelec. All Rights Reserved. Printed in USA. Legal Information can be accessed from the Main Menu of the optical disc or on the Tekelec Customer Support web site in the Legal Information folder of the Product Support tab.
  • Page 2: Table Of Contents

    Table of Contents Chapter 1: Introduction...............8 Overview............................9 Scope and Audience.........................9 Manual Organization........................9 Documentation Admonishments....................9 Customer Care Center......................10 Emergency Response......................12 Related Publications.......................13 Documentation Availability, Packaging, and Updates.............13 Locate Product Documentation on the Customer Support Site........13 Chapter 2: Functional Description..........15 General Description........................16 System Architecture........................21 Provisioning Database Interface Description..............24 Socket Based Connection...................25...
  • Page 3 Overview..........................48 Messages...........................53 Connect.........................53 Disconnect........................56 Begin Transaction......................57 End Transaction......................59 Abort Transaction.......................60 Create Subscription.....................61 Update Subscription....................74 Delete Subscription.....................86 Retrieve Subscription Data..................89 Create Network Entity....................97 Update Network Entity....................102 Delete Network Entity....................106 Retrieve Network Entity..................107 Switchover........................111 PDBA Status Query....................114 Dump Connections....................115 Create IMEI Data.......................116 Update IMEI Data.....................121 Delete IMEI Data.......................125 Retrieve IMEI Data....................129...
  • Page 4 Appendix A: PDBI Message Error Codes........160 PDBI Message Error Codes....................161 Appendix B: TIF Number Substitution Relationships.....166 TIF Number Substitution Relationships................167 Appendix C: DN Block Self Healing..........169 DN Block Self Healing ......................170 Glossary........................172 910-6022-001 Revision A, March 2011...
  • Page 5 List of Figures Figure 1: Example EPAP/PDBA Network..................17 Figure 2: PDBI System Architecture....................22 Figure 3: MPS/EPAP System Configuration..................24 Figure 4: SSH Tunnel Between the CPA and PDBA Machines............26 910-6022-001 Revision A, March 2011...
  • Page 6 List of Tables Table 1: Admonishments........................10 Table 2: Parse Failure Reasons ......................50 Table 3: Connect Response Return Codes ..................55 Table 4: Disconnect Response Return Codes .................56 Table 5: Begin Transaction Response Return Codes ..............58 Table 6: End Transaction Response Return Codes.................60 Table 7: Abort Transaction Response Return Code...............61 Table 8: Create Subscription Response Return Codes..............72 Table 9: Update Subscription Response Return Codes..............84...
  • Page 7 Table 38: IMEI Block Data Example ....................155 Table 39: Asynchronous Service Module Card Report Example ..........156 Table 40: Synchronous Service Module Card Report Example ..........157 Table 41: Service Module Card List Example ................158 Table 42: PDBI Message Error Codes ....................161 Table 43: Supported and Prohibited Subscriber Associations............167 Table 44: Support for DN Block Self Healing................171 910-6022-001 Revision A, March 2011...
  • Page 8: Chapter 1: Introduction

    Chapter Introduction Topics: This chapter contains general information about the PDBI documentation, the organization of this Overview..9 manual, and how to get technical assistance. Scope and Audience..9 Manual Organization..9 Documentation Admonishments..9 Customer Care Center..10 Emergency Response..12 Related Publications..13 Documentation Availability, Packaging, and Updates..13 Locate Product Documentation on the Customer Support Site..13...
  • Page 9: Overview

    This manual is intended for the application personnel responsible for transferring data from the customer system through the PDBI to a PDBA in an EPAP. Users of this manual and the others in the EAGLE 5 ISS family of documents must have a working knowledge of telecommunications and network installations.
  • Page 10: Customer Care Center

    (This icon and text indicate the possibility of service interruption.) Customer Care Center The Tekelec Customer Care Center is your initial point of contact for all product support needs. A representative takes your call or email, creates a Customer Service Request (CSR) and directs your requests to the Tekelec Technical Assistance Center (TAC).
  • Page 11 Provisioning Database Interface Manual Introduction TAC Regional Support Office Hours (except Brazil): 10:00 a.m. through 7:00 p.m. (GMT minus 6 hours), Monday through Friday, excluding holidays Argentina Phone: 0-800-555-5246 (toll-free) Brazil Phone: 0-800-891-4341 (toll-free) TAC Regional Support Office Hours: 8:30 a.m. through 6:30 p.m. (GMT minus 3 hours), Monday through Friday, excluding holidays Chile Phone: 1230-020-555-5468...
  • Page 12: Emergency Response

    9:00 a.m. through 6:00 p.m. (GMT plus 8 hours), Monday through Friday, excluding holidays Emergency Response In the event of a critical service situation, emergency response is offered by the Tekelec Customer Care Center 24 hours a day, 7 days a week. The emergency response provides immediate coverage, automatic escalation, and other features to ensure that the critical situation is resolved as rapidly as possible.
  • Page 13: Related Publications

    Documentation Bulletins announce a new or updated release. The Tekelec EAGLE 5 ISS documentation set is released on an optical disc. This format allows for easy searches through all parts of the documentation set. Tekelec Customer Support The electronic file of each manual is also available from the site.
  • Page 14 Provisioning Database Interface Manual Introduction Note: If you have not registered for this new site, click the Register Here link. Have your customer number available. The response time for registration requests is 24 to 48 hours. 2. Click the Product Support tab. 3.
  • Page 15: Chapter 2: Functional Description

    Chapter Functional Description Topics: This chapter provides an overview of PDBI, EPAP, PDBA, and DSM functions. General Description..16 System Architecture..21 Provisioning Database Interface Description..24 File Formats..32 910-6022-001 Revision A, March 2011...
  • Page 16: General Description

    (PDB) in the Active PDBA in an EAGLE 5 ISS. The customer executes provisioning commands using a provisioning application. This application uses the PDBI request/response messages to communicate with the EPAP Provisioning Database Application (PDBA) over the customer network.
  • Page 17: Figure 1: Example Epap/Pdba Network

    Provisioning Database Interface Manual Functional Description Figure 1: Example EPAP/PDBA Network Each Service Module card contains an identical database. The RTDB on the Service Module cards must be identical to the RTDB maintained by the EPAPs. However, there are several reasons why the various databases might not be identical.
  • Page 18 The ANSI-41 Number Portability Query (AINPQ) feature provides number portability in networks that support a mix of ITU and ANSI protocols by allowing ANSI-41 NPREQ queries on the EAGLE 5 ISS database. INP uses the INAP TCAP protocol and AINPQ uses the ANSI-41 TCAP protocol for Query functions.
  • Page 19 The V-Flex feature is used to route calls to a specific VMS based on subscription (voice, multimedia) data provisioned via the EAGLE 5 ISS MMI port and EPAP PDBI . The V-Flex feature utilizes VMS and GRN Network Entity types. In addition, the Multiple Network Entities per Subscriber feature introduces the ability to associate DN Blocks and individual DNs with up to 2 NEs.
  • Page 20 Functional Description The blacklist data is used by the EAGLE 5 ISS to support IDP queries. If the calling party is associated with a blacklisted flag and a GRN has been provisioned against the associated DN or DN Block, then a connect message is sent back to the switch along with the GRN number.
  • Page 21: System Architecture

    (IMEI Blocks). IMEIs work the same way as the DNs and DN Blocks. System Architecture There are two PDBAs, one in EPAP A on each EAGLE 5 ISS. They follow an Active/Standby model. These processes are responsible for updating and maintaining the Provisioning Database (PDB).
  • Page 22: Figure 2: Pdbi System Architecture

    MPS/EPAP platform. It also shows a mated pair of EAGLE 5 ISSs. The EAGLE 5 ISSs are the large blocks at the bottom. The MPSs, which are attached to the EAGLE 5 ISSs, are above the EAGLE 5 ISSs and contain EPAP A and EPAP An MPS system consists of two MPS servers and associated hardware, including a modem, CD-ROM, etc.
  • Page 23 Functional Description to as a mated MPS system. Within one MPS system (i.e., the MPS system for one EAGLE 5 ISS), the two MPS servers are considered mated MPS servers and are referred to as MPS A (the upper server) and MPS B (the lower server).
  • Page 24: Provisioning Database Interface Description

    Provisioning Database Interface Manual Functional Description Figure 3: MPS/EPAP System Configuration EPAP Status Reporting and Alarm Handling Maintenance, measurements, status, and alarm information is routed from the Active EPAP to a primary Service Module through EPAP Maintenance Blocks and Service Module Status Requests. The status reporting, message format, and various alarm messages are discussed in detail in the EPAP Administration Manual.
  • Page 25: Socket Based Connection

    PDBI_TOO_MANY_CONNECTIONS. After the response is returned, the socket is automatically closed. Note: Although the default limit is 16 PDBI connections, Tekelec is able to configure and support up to 128 connections. If you require more than 16 connections, contact Tekelec for information. concurrent...
  • Page 26: Figure 4: Ssh Tunnel Between The Cpa And Pdba Machines

    Provisioning Database Interface Manual Functional Description Remote Port Forwarding Remote Port Forwarding refers to the SSH tunneling approach where the SSH tunnel is created from the client side of the tunnel towards the server side. The CPA machine is the server and the PDBA machine is the client.
  • Page 27: Transaction-Oriented Api

    Provisioning Database Interface Manual Functional Description 4. The PDBA gets the request message in unencrypted form and sends an unencrypted response to the SSH client. 5. The SSH client encrypts the response message and sends it to the SSH port on the CPA machine. 6.
  • Page 28: Batch-Oriented/Bulk Load

    Provisioning Database Interface Manual Functional Description Single Transaction Mode When sending a series of single-update transactions in normal transaction mode, considerable overhead is required for sending transaction boundary tags. Because some clients want to send only one update per transaction, an alternative PDBI connection type is available, called 'single transaction mode.' When using this connection type, PDBI clients can send updates outside of the 'begin' and 'end' transaction delimiters.
  • Page 29 RTDBs on that EAGLE 5 ISS. At the same time, the data is also passed, asynchronously, to the standby PDB and subsequently to the mated RTDBs on the mated EAGLE 5 ISS. Provisioning of redundant systems, therefore, is transparent to the user.
  • Page 30: Transparency Of Redundant Systems

    RTDBs on that EAGLE 5 ISS. At the same time, the data is also passed, asynchronously, to the standby PDB and subsequently to the mated RTDBs on the mated EAGLE 5 ISS. Provisioning of redundant systems, therefore, is transparent to the user.
  • Page 31: Request Ids

    Provisioning Database Interface Manual Functional Description Request IDs Each request has an ID, called the ‘iid’, as its first element. Its purpose is to allow responses to be matched up with requests as they arrive back at the client. Its value is an integer between 1 and 4294967295, expressed as a decimal number in ASCII.
  • Page 32: Interface Configuration And Installation

    Provisioning Database Interface Manual Functional Description Interface Configuration and Installation In addition to this manual, additional information concerning PDBI installation, configuration and integration with the network operator's information system is provided in the EPAP Administration Manual. File Formats All file formats described in this section are text files. The EPAP menu items for importing files to the PDB and exporting files from the PDB are described in the PDBA menu section of the EPAP Administration Manual.
  • Page 33 Provisioning Database Interface Manual Functional Description upd_eir dlt_eir Note: Do not include rtrv_sub, rtrv-entity, or rtrv_eir commands in an import file. The inclusion of rtrv commands causes an import to take a very long time to complete. During an import, a write transaction lock is in place for the entire import for a manual import, and intermittently in place for an automatic import.
  • Page 34 Provisioning Database Interface Manual Functional Description Any errors encountered while processing the file are logged in the error log file of the PDBA. The processing of the import file continues. When the file is completely processed, the user interface displays a warning that errors were encountered. The error log file of the PDBA can then be viewed through the EPAP user interface.
  • Page 35 Provisioning Database Interface Manual Functional Description additional point of data, the level of the database when the export finished is placed at the end of the export file. PDBI Format Formatting the output as PDBI commands allows the resulting file to be used as an import file. The format of the commands in the file is exactly the same as the PDBI commands specified in this document.
  • Page 36 Provisioning Database Interface Manual Functional Description Identifier for this Network Entity Values: 1 to 15 hexadecimal digits expressed using ASCII characters Type Type of Network Entity Values: S - Signal Point R - Routing Number V - Voicemail Server G - Generic Routing Number PCType Specifies the type of the point code.
  • Page 37 Provisioning Database Interface Manual Functional Description (Optional) Group Code. This optional parameter is part of the point code value for ITU Duplicate Point Code Support feature. Values: aa - zz Routing Indicator. This parameter indicates whether a subsequent global title translation is required.
  • Page 38 Provisioning Database Interface Manual Functional Description r- Replace Called Party GTA with the entity id p - Prefix Called Party GTA with the entity id I - Insert Entity Id after country code 4 - Delete the country code 5 - Delete the country code and prepend with entity id 6 - Send a digit action of 6 to the EAGLE 7 - Send a digit action of 7 to the EAGLE SRFIMSI...
  • Page 39 Provisioning Database Interface Manual Functional Description Values: a string with 5 to 15 characters where each character must be a number from 0 to F. IMSI The IMSI to which the DN is associated. This field does not have a value if the DN is not associated with any IMSI.
  • Page 40 Provisioning Database Interface Manual Functional Description 26 – prepaid 23 (used by PPSMS) 27 – prepaid 24 (used by PPSMS) 28 – prepaid 25 (used by PPSMS) 29 – prepaid 26 (used by PPSMS) 30 – prepaid 27 (used by PPSMS) 31 –...
  • Page 41 Provisioning Database Interface Manual Functional Description Values A decimal number in the range 0 - public 1 - private NSDN A TIF Number Substitution DN (specified in international format). Values: a string with 5 to 15 characters where each character must be a number from 0 to F. CGBL (Optional) IDP calling party blacklist.
  • Page 42 Provisioning Database Interface Manual Functional Description has or has not migrated from IS41 to GSM, (maintaining a single GSM handset). For PPSMS, it identifies a DN as one of thirty-two types needing PPSMS intercept. Values: none– no status (default = none) 0 –...
  • Page 43 Provisioning Database Interface Manual Functional Description (Optional) Specifies which SP the DN is on. The SP and RN fields do not both have values at the same time. Values: 1 to 15 hexadecimal digits expressed using ASCII characters. (Optional) Specifies which RN the DN Block is on. The SP and RN fields do not both have values at the same time.
  • Page 44 Provisioning Database Interface Manual Functional Description CGBL (Optional) IDP calling party blacklist. Values yes - IDP calling party blacklist is enabled Note: The cgbl parameter wil only be listed in the export file if its value is yes. CDBL (Optional) IDP called party blacklist. Values yes - IDP called party blacklist is enabled Note: The cdbl parameter wil only be listed in the export file if its value is yes.
  • Page 45 Provisioning Database Interface Manual Functional Description Values: yes or no BLACK (Optional) Specifies a List Type of Black Values: yes or no IMSI The IMSI to which the IMEI is associated. This field will not have a value if the IMEI is not associated with any IMSI.
  • Page 46 Provisioning Database Interface Manual Functional Description Values: yes or no 910-6022-001 Revision A, March 2011...
  • Page 47: Chapter 3: Pdbi Request/Response Messages

    Chapter PDBI Request/Response Messages Topics: This chapter describes available requests and the possible responses for PDBI request/response Overview..48 messages. Messages..53 910-6022-001 Revision A, March 2011...
  • Page 48: Overview

    Provisioning Database Interface Manual PDBI Request/Response Messages Overview This chapter defines the Database Interface (PDBI) request and response messages. The messages are listed in alphabetical order. Provisioning Provisioning clients connect to the EAGLE Provisioning Application Processors (EPAPs) through the PDBI. The PDBI consists of commands and their parameters, which allow you to define the messages that provision the G-Flex, G-Port, INP, EIR, A-Port, and/or IS41 GSM Migration features and allow the retrieval of feature data.
  • Page 49 For example, if the DN Prefix is set to “34” in the UI and then an ent_sub request is sent to create DN 12345, the actual DN stored in the database and sent to the EAGLE 5 ISS is “3412345”. If a PDBI query is done for DN “12345”...
  • Page 50: Table 2: Parse Failure Reasons

    Provisioning Database Interface Manual PDBI Request/Response Messages It is important to note that the “#” number prefix override is only valid for DNs, DN Blocks, and IMSIs. The “#” symbol at the beginning of any other parameter value does not parse. Since the number prefix and the number prefix override apply to all requests and responses that have DNs, DN Blocks or IMSIs, it is not mentioned on each command separately.
  • Page 51 Transaction Too Big Response The internal EAGLE 5 ISS RTDB imposes a transaction size limit on the PDBA. In order to ensure that the PDBA and the EAGLE 5 ISS databases are truly equivalent, this limit must be propagated by the PDBA onto the PDBI clients.
  • Page 52 PDBI Request/Response Messages command is nine if the force parameter is not used. If the force parameter is set to yes, the highest possible number of EAGLE 5 ISS database commands in a single PDBI command is 17. Multiple Segmented Responses For some responses, it is possible that all of the data cannot be returned in one response.
  • Page 53: Messages

    PDBI_TOO_MANY_CONNECTIONS. After the response is returned, the socket is automatically closed. Note: Although the default limit is 16 PDBI connections, Tekelec is able to configure and support up Customer to 128 connections. If more than 16 concurrent client connections are required, contact the Care Center for more information.
  • Page 54 Provisioning Database Interface Manual PDBI Request/Response Messages endchar (Optional) Allows the client to specify what character the PDBA uses to terminate responses. Values: null – Responses terminated with a NULL (\0) character (default) newline– Responses terminated with a newline (\n) character idletimeout (Optional) Allows the client to specify the amount of time that the connection can remain idle before the PDBA should terminate it.
  • Page 55: Table 3: Connect Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages Note: If a connection is configured to send asynchronously SM Reports and processes a command that takes a long time, SM Reports will be suspended until after the long running command is completed. For example, if a client connects with a dsmrptfreq of 1 and then requests a retrieve of millions of DNs, the SM Reports will be suspended until the retrieve command has completed.
  • Page 56: Disconnect

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Text Description Data Section Contents Code data (param <field label>) 1023 UNKNOWN_VERSION The specified version is not NONE known or not supported. Disconnect The Disconnect message is required to disconnect from the PDBA. The disconnect command defines the Disconnect message.
  • Page 57: Begin Transaction

    Provisioning Database Interface Manual PDBI Request/Response Messages Begin Transaction The Begin Transaction message starts a read or write transaction, which is required for all data-related commands (to create, update, delete, or retrieve subscriptions). A client connection can only have one transaction open at a time.
  • Page 58: Table 5: Begin Transaction Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages timeout (Optional) How many seconds to wait for the write transaction if another connection already has it. Values: 0 (return immediately if not available; default) 1 - 3600 seconds Request syntax : begin_txn([iid XXXXX,] type <read|write>, [timeout <0..3600>]) Begin Transaction Response The return codes in Table 5: Begin Transaction Response Return Codes...
  • Page 59: End Transaction

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Text Description Data Section Code Contents 1012 INVALID_VALUE One of the fields specified had an The offending field invalid value. is returned in the data section: data (param <field label>) End Transaction The End Transaction message completes a read or write transaction.
  • Page 60: Abort Transaction

    The entire transaction was rolled back to ensure predicable behavior. Contact Tekelec. Abort Transaction The Abort Transaction message aborts a currently executing read or write transaction. If the transaction was a read transaction, the transaction is simply closed. The abort_txn command defines the Abort Transaction message.
  • Page 61: Create Subscription

    Provisioning Database Interface Manual PDBI Request/Response Messages Table 7: Abort Transaction Response Return Code Return Text Description Data Section Contents Code SUCCESS Abort successful. NONE 1009 NO_ACTIVE_TXN There was no currently active NONE transaction for this connection. Create Subscription Create Subscription messages define different combinations of subscriptions by using the ent_sub command with a different set of parameters.
  • Page 62 Provisioning Database Interface Manual PDBI Request/Response Messages force (Optional) Indicates whether the client wants existing instances to be overwritten. Values: yes or no (default = no). timeout (Optional) Specify the number of seconds to wait for the write transaction if another connection already has it.
  • Page 63 Provisioning Database Interface Manual PDBI Request/Response Messages Values: 5 to 15 hexadecimal digits expressed using ASCII characters. A DN (specified in international format) to be associated with the specified IMSI. There can be up to eight DNs specified. Values: 5 to 15 hexadecimal digits expressed using ASCII characters. Specifies which SP the IMSI and DNs are on.
  • Page 64 Provisioning Database Interface Manual PDBI Request/Response Messages If any of the DNs specified conflicts with an entry in the EPAP Provisioning Blacklist table or with a DN Block marked ineligible for splitting, the command will be rejected and use of the optional force parameter will not override this function.
  • Page 65 Provisioning Database Interface Manual PDBI Request/Response Messages 3 – prepaid 1 (used by PPSMS) 4 – prepaid 2 (used by PPSMS) 5 – migrated to GSM (used for IS41 GSM Migration) 6 – prepaid 3 (used by PPSMS) 7 – prepaid 4 (used by PPSMS) 8 –...
  • Page 66 Provisioning Database Interface Manual PDBI Request/Response Messages (Optional) Specifies which SP the DN(s) are on. The sp must correspond to an existing SP entity. Most INP-only customers do not need to use SP. Values: 1 to 15 hexadecimal digits expressed using ASCII characters. (Optional) Specifies which RN the DNs are on.
  • Page 67 Provisioning Database Interface Manual PDBI Request/Response Messages cdbl (Optional) IDP called party blacklist. Values no - IDP called party blacklist is disabled. yes - IDP called party blacklist is enabled. force (Optional) Indicates whether the client wants existing instances to be overwritten. Values: yes or no (default = no) timeout...
  • Page 68 Provisioning Database Interface Manual PDBI Request/Response Messages the new DN Block. A new parameter split is added for this purpose. The default value for split parameter is yes.The force parameter is not supported for this command. DN blocks might or might not be associated with a network entity, but they cannot be associated with both an SP and an RN at the same time.
  • Page 69 Provisioning Database Interface Manual PDBI Request/Response Messages 2 – foreign number ported to foreign network (used for G-Port and A-Port) 3 – prepaid 1 (used by PPSMS) 4 – prepaid 2 (used by PPSMS) 5 – migrated to GSM (used for IS41 GSM Migration) 6 –...
  • Page 70 Provisioning Database Interface Manual PDBI Request/Response Messages 35 – prepaid 32 (used by PPSMS) 36 – not identified to be ported (Optional) Specifies which SP the DN(s) are on. The sp must correspond to an existing SP entity. Values: 1 to 15 hexadecimal digits expressed using ASCII characters. (Optional) Specifies which RN the DNs are on.
  • Page 71 Provisioning Database Interface Manual PDBI Request/Response Messages cgbl (Optional) IDP calling party blacklist. Values no - IDP calling party blacklist is disabled. yes - IDP calling party blacklist is enabled cdbl (Optional) IDP called party blacklist. Values no - IDP called party blacklist is disabled. yes - IDP called party blacklist is enabled.
  • Page 72: Table 8: Create Subscription Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages [cgbl <no/yes>,] [cdbl <no/yes>,] [spilt <no/yes>] [force yes/no,] [timeout <0..3600>]) Create Subscription Responses The return codes in Table 8: Create Subscription Response Return Codes might result from the Create Subscription request. See PDBI Message Error Codes for the recommended actions to help resolve the error related return codes.
  • Page 73 Provisioning Database Interface Manual PDBI Request/Response Messages Return Text Description Data Section Contents Code NO_UPDATES 1017 The database already contains NONE data in request. No update was necessary. 1009 NO_ACTIVE_TXN There was no currently active NONE transaction for this connection. NO_WRITE_PERMISSION 1006 NONE...
  • Page 74: Update Subscription

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Text Description Data Section Contents Code this error. Data (dn XXXXX, counts([nsdn #####])) INCOMPATIBLE_ST 1050 The specified ST value The ST value of NSDN will be conflicts with the ST value of returned in the data section NSDN.
  • Page 75 Provisioning Database Interface Manual PDBI Request/Response Messages Values: 5 to 15 hexadecimal digits expressed using ASCII characters. Specifies which SP the IMSI is being moved to. The SP must correspond to an existing SP entity. Values: 1 to 15 hexadecimal digits expressed using ASCII characters. timeout (Optional) Specify the number of seconds to wait for the write transaction if another connection already has it.
  • Page 76 Provisioning Database Interface Manual PDBI Request/Response Messages This command is used for G-Flex, G-Port, and INP features, although some of the specific parameters are only meaningful on specific features. Parameters: A single DN (specified in international format). Values: 5 to 15 hexadecimal digits expressed using ASCII characters. (Optional) The portability type for the created DN.
  • Page 77 Provisioning Database Interface Manual PDBI Request/Response Messages 22 – prepaid 19 (used by PPSMS) 23 – prepaid 20 (used by PPSMS) 24 – prepaid 21 (used by PPSMS) 25 – prepaid 22 (used by PPSMS) 26 – prepaid 23 (used by PPSMS) 27 –...
  • Page 78 Provisioning Database Interface Manual PDBI Request/Response Messages Values: 1 to 15 hexadecimal digits expressed using ASCII characters. none – Sets the rn to not point to any network entity. (Optional) Additional Subscriber Data to be associated with the DN Block. Leading zeros are significant.
  • Page 79 Provisioning Database Interface Manual PDBI Request/Response Messages 2. The DN given by nsdn must exist. 3. Cannot update a DN to have the 2 Network Entities asd and nsdn together. Request syntax : Upd_sub([iid XXXXX,] dn XXXXX, [pt <none/0/1/2/3// ….35>,] [st <0/1>,] [nsdn XXXXX,] [sp XXXXX,] [rn XXXXX,] [vms XXXXX,] [grn XXXXX,] [asd XXXXX,] [cgbl <no/yes>,] [cdbl <no/yes>,] [timeout <0..3600>]) Move an existing DN to an Existing IMSI...
  • Page 80 Provisioning Database Interface Manual PDBI Request/Response Messages DN blocks might or might not be associated with a network entity, but they cannot be associated with both an SP and an RN at the same time. If a DN block has a NE association and the update command specifies a new NE of the same NE type, a replacement is attempted.
  • Page 81 Provisioning Database Interface Manual PDBI Request/Response Messages 3 – prepaid 1 (used by PPSMS) 4 – prepaid 2 (used by PPSMS) 5 – migrated to GSM (used for IS41 GSM Migration) 6 – prepaid 3 (used by PPSMS) 7 – prepaid 4 (used by PPSMS) 8 –...
  • Page 82 Provisioning Database Interface Manual PDBI Request/Response Messages 36 – not identified to be ported (Optional) Specifies which SP the DN Block is being moved to. The sp must correspond to an existing SP entity. Values: 1 to 15 hexadecimal digits expressed using ASCII characters. none –...
  • Page 83 Provisioning Database Interface Manual PDBI Request/Response Messages nsdn A TIF Number Substitution DN (specified in international format). Values: a string with 5 to 15 characters where each character must be a number from 0 to F. cgbl (Optional) IDP calling party blacklist. Values no - IDP calling party blacklist is disabled.
  • Page 84: Table 9: Update Subscription Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages [vms XXXXX,] [grn XXXXX,] [asd XXXXX,] [st <0/1>,] [nsdn XXXXX,] [cgbl <no/yes>,] [cdbl <no/yes>,] [split <no/yes>,] [timeout <0..3600>]) Update Subscription Responses The return codes listed in Table 9: Update Subscription Response Return Codes indicate the result of the Update Subscription request.
  • Page 85 Provisioning Database Interface Manual PDBI Request/Response Messages Return Data Section Text Description Code Contents WRITE_UNAVAIL 1005 Another client already has a write IP address transaction open. information of client that already has write transaction. data (id <connection id>, ip <ip addr>, port <port num>) SUB_NE_LIMIT...
  • Page 86: Delete Subscription

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Data Section Text Description Code Contents count of each dependency are returned. If more than one DN has unresolved dependencies, only one will be returned in this error. Data (dn XXXXX, counts([nsdn #####])) Delete Subscription This command deletes subscription records.
  • Page 87 Provisioning Database Interface Manual PDBI Request/Response Messages Request syntax : dlt_sub([iid XXXXX,] imsi XXXXX, [timeout <0..3600>]) Delete a Single DN This command attempts to delete a single DN. The DN is deleted even if the DN is associated with an IMSI. The IMSI remains even if this operation results in no DNs being associated with the IMSI. Parameters : The single DN to delete (specified in international format).
  • Page 88: Table 10: Delete Subscription Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages timeout (Optional) Specify the number of seconds to wait for the write transaction if another connection already has it. Clients waiting for the write transaction with this mechanism are processed in the order that their requests were received. This option is only allowed if the client used the txnmode single option on its connect request.
  • Page 89: Retrieve Subscription Data

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Data Section Text Description Code Contents that already has the write transaction. data (id <connection id>, ip <ip addr>, port <port num>) 1049 UNRESOLVED_DEPENDENCY This record is referred to by other When using force to records.
  • Page 90 Provisioning Database Interface Manual PDBI Request/Response Messages Retrieve Subscription Information About a Specific DN This command retrieves the subscription information for a specific DN. If the G-Port or INP feature is available and the specific DN is not found, the PDBA also tries to find a DN block that the DN is in. Parameters : The specific DN to retrieve (specified in international format).
  • Page 91 Provisioning Database Interface Manual PDBI Request/Response Messages (Optional) The portability type for the created DN. This field is only used by G-Port, A-Port, IS41 GSM Migration, and PPSMS. For G-Port and A-Port, it controls number Portability Status encoding in SRI acks. For IS41 GSM Migration, it identifies whether a subscriber has or has not migrated from IS41 to GSM, (maintaining a single GSM handset).
  • Page 92 Provisioning Database Interface Manual PDBI Request/Response Messages 28 – prepaid 25 (used by PPSMS) 29 – prepaid 26 (used by PPSMS) 30 – prepaid 27 (used by PPSMS) 31 – prepaid 28 (used by PPSMS) 32 – prepaid 29 (used by PPSMS) 33 –...
  • Page 93 Provisioning Database Interface Manual PDBI Request/Response Messages none – Removes additional subscriber data from the DN. (Optional) The subscriber type for created DNs. Values A decimal number in the range 0 - public 1 - private nsdn A Number Substitution DN (specified in international format). Values: a string with 5 to 15 characters where each character must be a number from 0 to F.
  • Page 94 Provisioning Database Interface Manual PDBI Request/Response Messages Rules : 1. Specifying both sp and rn is not allowed because it would always result in no instances being found. 2. Thetype parameter acts to filter the responses based on how the data was provisioned. For instance, ifblock is specified, only DN blocks (that were provisioned as blocks) are returned.
  • Page 95 Provisioning Database Interface Manual PDBI Request/Response Messages Request syntax : rtrv_sub([iid XXXXX,] imsi XXXXX, [data <all/neonly>]) Retrieve Subscription Information for a Range of IMSIs This command retrieves all of the subscription data within a range of IMSIs. Parameters : bimsi The starting IMSI for the IMSI range.
  • Page 96 Provisioning Database Interface Manual PDBI Request/Response Messages Request syntax : rtrv_sub([iid XXXXX,] bimsi XXXXX, eimsi XXXXX, [sp XXXXX,] [data <all/neonly/count>,] [num <1..40000000>]) Retrieve Subscription Data Responses The syntax of the data section of responses to a successful Retrieve Subscription Data request depends on the type of records being returned.
  • Page 97: Create Network Entity

    Provisioning Database Interface Manual PDBI Request/Response Messages Requests that specify adata parameter ofcount gets just one response that contains the instance count for the type of subscription data that they are querying. Only one of the optional counts would be present in the response. data (counts ([imsi #####,] [dn #####,] [dnblock #####]) ) The return codes listed in Table 11: Retrieve Subscription Data Response Return Codes...
  • Page 98 Provisioning Database Interface Manual PDBI Request/Response Messages Identifier for this network entity. Values: 1 to 15 hexadecimal digits expressed using ASCII characters. type Type of network entity being created. Values: SP – Signal Point RN – Routing Number. (G-Flex only customers do not use RNs. Used for A-Port and IS41 GSM Migration features.) VMS –...
  • Page 99 Provisioning Database Interface Manual PDBI Request/Response Messages mmm= 0 – 255 For pctype of none, the pc parameter is not allowed. (Optional) Group code. This optional parameter is part of the point code value for ITU Duplicate Point Code Support feature. Values: aa - zz Routing indicator.
  • Page 100 Provisioning Database Interface Manual PDBI Request/Response Messages (Optional) Digit action. The parameter specifies what changes, if any, to apply to the Called Party GTA. Values: none – No change to the Called Party GTA (default) replace – Replace Called Party GTA with the entity id prefix –...
  • Page 101: Table 12: Create Network Entity Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages [da <none/replace/prefix/insert/delccprefix/delcc/spare1 /spare2>,] [srfimsi XXXXX] [, timeout <0..3600>]) Create Network Entity Response The return codes listed in Table 12: Create Network Entity Response Return Codes indicate the result of the Create network entity request. See PDBI Message Error Codesfor the recommended actions to help resolve the error related return codes.
  • Page 102: Update Network Entity

    Provisioning Database Interface Manual PDBI Request/Response Messages Update Network Entity The upd_entitycommand modifies an entity object (such as an SP) and its corresponding global title translation. Spare point codes, indicated by an optional s- prefix, are supported for Network Entities with a pctype of intl and natl.
  • Page 103 Provisioning Database Interface Manual PDBI Request/Response Messages For pctype of natl the format is number [(s-)nnnnn]. s - Optional spare point code indicator nnnnn= 1 – 16383 For pctype of ansi, the format is network-cluster-member (nnn-ccc-mmm). nnn= 1 – 255 ccc= 1 –...
  • Page 104 Provisioning Database Interface Manual PDBI Request/Response Messages Values: 0 – 127 none (Optional) New numbering plan. Values: 0 – 15 none (Optional) Digit action. The parameter specifies what changes, if any, to apply to the Called Party GTA. Values: none – No change to the Called Party GTA (default) replace –Replace Called Party GTA with the entity id prefix –...
  • Page 105: Table 13: Update Network Entity Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages 5. Parameter gc can be specified only when pctype = natl. 6. If the pctype is changed to none, all of the other parameters are cleared out, including the srfimsi. Request syntax : upd_entity([iid XXXXX,] id XXXXX, type <SP/RN>, [pctype <intl/natl/ansi/none>,] [pc <pc value>,] [gc <gc value>,] [ri <GT/SSN>,] [ssn <0/2..255/none>,] [ccgt <yes/no>,]...
  • Page 106: Delete Network Entity

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Text Description Data Section Contents Code 1005 WRITE_UNAVAIL Another client already has a write IP address information transaction open. of client that already has the write transaction. data (id <connection id>, ip <ip addr>, port <port num>) Delete Network Entity The dlt_entitycommand deletes an entity object and its corresponding global title translation.
  • Page 107: Retrieve Network Entity

    Provisioning Database Interface Manual PDBI Request/Response Messages Request syntax : dlt_entity([iid XXXXX,] id XXXXX, type <SP/RN/VMS/GRN> [, timeout <0..3600>]) Delete Network Entity Response The return codes listed in Table 14: Delete Network Entity Response Return Codes indicates the result of the Delete Network Entity request.
  • Page 108 Provisioning Database Interface Manual PDBI Request/Response Messages Retrieve the Information for a Specific NE Parameters : Global title address for this network entity. Values: 1 to 15 hexadecimal digits expressed using ASCII characters type Type of network entity to be retrieved. Values: SP –...
  • Page 109 Provisioning Database Interface Manual PDBI Request/Response Messages GRN – Generic Routing Number data (Optional) Lets the requester specify the type of output data to be returned. See the response section for additional information. Values: all – Return all known data for each instance (default) neonly –...
  • Page 110: Table 15: Retrieve Network Entity Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages [srfimsi XXXXX,] counts([imsi ###,] [dn ###,] [dnblock ###])), ( ... ) ) As with the responses for retrieving subscriptions, the response can be broken up into multiple responses due to size constraints. Intermediate responses have the return code PARTIAL_SUCCESS. If the data value is count, the data section contains only the number of instances that matched the query.
  • Page 111: Switchover

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Text Description Data Section Contents Code 1016 PARTIAL_SUCCESS The request has succeeded, See data description but this is only one response above. in many. Switchover The switchover command causes the two PDBAs to switch Active/Standby status. By default, the command works like a toggle switch.
  • Page 112 PDB would have to be recreated from the other PDB, and the RTDB processes connected to the PDBA with the recreated PDB must reload (causing the cards on the EAGLE 5 ISSs also to reload).The PDBA that receives the switchover request attempts to change the state of the remote PDBA first and then change its own state.
  • Page 113: Table 16: Switchover Response Return Codes

    The mate PDBA currently has a NONE write transaction open. 1030 DB_MAINT_REQD Replication is unable to get the two NONE databases in synch. Call Tekelec. REPLICATING Asynchronous replication is still The number of levels 1036 in progress. remaining to replicate.
  • Page 114: Pdba Status Query

    Provisioning Database Interface Manual PDBI Request/Response Messages PDBA Status Query The status command queries status information from the PDBA. This command is not required to be framed inside a transaction. However, a connection must first be opened. If the status request is made from within a transaction, the Number Prefix fields contain the values configured when the transaction started.
  • Page 115: Dump Connections

    Provisioning Database Interface Manual PDBI Request/Response Messages The return code listed in Table 17: PDBA Status Query Response Return Code indicates the result of the PDBA Status Query request. Table 17: PDBA Status Query Response Return Code Return Text Description Data Section Contents Code SUCCESS...
  • Page 116: Create Imei Data

    Provisioning Database Interface Manual PDBI Request/Response Messages Table 18: Dump Connections Response Return Code Return Text Description Data Section Contents Code SUCCESS Connection list returned. See above. 1012 INVALID_VALUE One of the fields specified had Offending field is returned in data an invalid value.
  • Page 117 Provisioning Database Interface Manual PDBI Request/Response Messages Values: yes or no (default = no). imsi The IMSI(s) to be associated with an IMEI. Values: 5 to 15 hexadecimal digits expressed using ASCII characters. Up to 8 IMSIs can be provisioned for an IMEI. force (Optional) Indicates whether the client wants existing instances to be overwritten.
  • Page 118 Provisioning Database Interface Manual PDBI Request/Response Messages bimei The beginning IMEI in a block. Values: 14 or 15 hexadecimal digits expressed using ASCII characters. Only the first 14 digits of the IMEI are stored and displayed on retrieval. eimei The ending IMEI in a block. Values: 14 or 15 hexadecimal digits expressed using ASCII characters.
  • Page 119 Provisioning Database Interface Manual PDBI Request/Response Messages Request syntax: ent_eir([[iid XXXXX] bimei XXXXX, eimei XXXXX, [white yes/no,] [grey yes/no,] [white yes/no] [timeout <0..3600>]) Create a New IMSI and Associate it with an Existing IMEI The ent_eir command defines the request message to create a new IMSI and associate it with an existing IMEI.
  • Page 120: Table 19: Create Imei Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages Request syntax: ent_eir( [iid XXXXX] imei XXXXX, [imsi XXXXX, …, imsi XXXXX] [timeout <0..3600>]) Create IMEI Data Responses Table 19: Create IMEI Response Return Codes The return codes in may result from the Create IMEI request.
  • Page 121: Update Imei Data

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Text Description Data Section Contents Code 1039 IMEI_IMSI_LIMIT Would cause more than NONE 8 IMSIs to be provisioned on an IMEI. 1029 TXN_TOO_BIG This request would cause NONE current transaction to be larger than limit.
  • Page 122 Provisioning Database Interface Manual PDBI Request/Response Messages (Optional) Software Version Number. Values: A 2-digit number 0-9 (default is not changed). white (Optional) Select list type of White. Values: yes or no (default is not changed). gray (Optional) Select list type of Gray. Values: yes or no (default is not changed).
  • Page 123 Provisioning Database Interface Manual PDBI Request/Response Messages Values: 14 or 15 hexadecimal digits expressed using ASCII characters. Only the first 14 digits of the IMEI are stored and displayed on retrieval. eimei The ending IMEI in a block. Values: 14 or 15 hexadecimal digits expressed using ASCII characters. Only the first 14 digits of the IMEI are stored and displayed on retrieval.
  • Page 124: Table 20: Update Imei Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages Table 20: Update IMEI Response Return Codes Return Text Description Data Section Contents Code SUCCESS Everything worked. NONE 1012 INVALID_VALUE One of the fields specified The offending field is had an invalid value. returned in the data section: data (param <field...
  • Page 125: Delete Imei Data

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Text Description Data Section Contents Code 1005 WRITE_UNAVAIL Another client already IP address information of has a write transaction client that already has the open. write transaction. data (id <connection id>, ip <ip addr>, port <port num>) Delete IMEI Data This command is used to delete an individual IMEI or a IMEI block.
  • Page 126 Provisioning Database Interface Manual PDBI Request/Response Messages Request syntax: dlt_eir([iid XXXXX] imei XXXXX) Delete a Block of IMEIs The dlt_eir command defines the request message to delete an IMEI block. Parameters : bimei The beginning IMEI in a block. Values: 14 or 15 hexadecimal digits expressed using ASCII characters.
  • Page 127 Provisioning Database Interface Manual PDBI Request/Response Messages Values: 14 or 15 hexadecimal digits expressed using ASCII characters. Only the first 14 digits of the IMEI are stored and displayed on retrieval. imsi The IMSI(s) to be associated with an IMEI. Values: 5 to 15 hexadecimal digits expressed using ASCII characters.
  • Page 128: Table 21: Update Imei Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages Request syntax: dlt_eir([iid XXXXX,]imsi XXXXX) Delete IMEI Data Responses The return codes in Table 21: Update IMEI Response Return Codes may result from the Delete IMEI request. See PDBI Message Error Codes for the recommended actions to help resolve the error related return codes.
  • Page 129: Retrieve Imei Data

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Text Description Data Section Contents Code 1005 WRITE_UNAVAIL Another client already has a write IP address information transaction open. of client that already has the write transaction. data (id <connection id>, ip <ip addr>, port <port num>) Retrieve IMEI Data This command displays the provisioned IMEI data.
  • Page 130 Provisioning Database Interface Manual PDBI Request/Response Messages Values: 14 or 15 hexadecimal digits expressed using ASCII characters. Only the first 14 digits of the IMEI are stored and displayed on retrieval. eimei The ending IMEI in a block. Values: 14 or 15 hexadecimal digits expressed using ASCII characters. Only the first 14 digits of the IMEI are stored and displayed on retrieval.
  • Page 131: Table 22: Retrieve Imei Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages Values: 0 - 40000000 Rules 1. If the imei includes the optional 15th character (the check digit), the check digit is provided by the Customers Client Software and must match the EPAPs (via calculated algorithm). The check digit is not stored;...
  • Page 132: Request Service Module Card Report

    Provisioning Database Interface Manual PDBI Request/Response Messages Return Data Section Text Description Code Contents 1011 NOT_FOUND IMEI (block) not found. NONE 1012 INVALID_VALUE One of the fields specified had an invalid Offending field is value. returned in data section: data (param <field label>) 1016 PARTIAL_SUCCESS...
  • Page 133 Identifier for the Service Module card's EAGLE 5 ISS node. Values: String up to 11 characters long cardloc Location identifier for the Service Module card in the EAGLE 5 ISS node. Values: Four digit number 910-6022-001 Revision A, March 2011...
  • Page 134: Table 23: Retrieve Service Module Card Report Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages status The database status of the Service Module card. Values: loading - The card is currently loading the database. resync - The card is loaded, but catching up to current provisioning stream. coherent - The database is loaded and receiving normal provisioning incoherent - Internal error on Service Module card (write failed to database) inconsistent - Data mismatch between EPAP RTDB and Service Module card RTDB.
  • Page 135 Provisioning Database Interface Manual PDBI Request/Response Messages Retrieve Service Module Card Report There are two parameters that adjust what percent or level to run the report for. The two parameters are mutually exclusive. If neither is specified, then the report will be run with the default percent value for the connection.
  • Page 136 Identifier for the Service Module card's EAGLE 5 ISS node. Values: String up to 11 characters long cardloc Location identifier for the Service Module card in the EAGLE 5 ISS node. Values: Four digit number status The database status of the Service Module card.
  • Page 137: Table 24: Retrieve Service Module Card Report Response Return Codes

    The rtrv_dsmlist command defines the request message to retrieve the Service Module card data. Parameters : clli (Optional) Retrieve only the Service Module cards on the specified EAGLE 5 ISS node. Values: 1 - 11 alphanumeric characters, hyphen, or underscore.
  • Page 138 List of Service Module cards that did not have a database level equal to or larger than main message's level. Each Service Module card contains the following information. clli Identifier for the Service Module card's EAGLE 5 ISS node. Values: String up to 11 characters long cardloc Location identifier for the Service Module card in the EAGLE 5 ISS node.
  • Page 139: Table 25: Retrieve Service Module Card List Response Return Codes

    Provisioning Database Interface Manual PDBI Request/Response Messages loadperc - The percent of the database that has been loaded during initial booting of the card. This field is only meaningful when the status is loading, so it will only appear then. Values: 0 –...
  • Page 140: Chapter 4: Pdbi Sample Sessions

    Chapter PDBI Sample Sessions Topics: This chapter contains example flow scenarios for the PDBI request/response messages. Introduction..141 Network Entity Creation..141 Simple Subscription Data Creation..142 Update Subscription Data..143 Simple Queries..148 Multiple Response Query..150 Abort Transaction..151 Update Request In Read Transaction..152 Write Transaction In Standby Connection..152 Simple Subscription Data Creation with Single Txnmode..153 Single IMEI Data..154...
  • Page 141: Introduction

    Provisioning Database Interface Manual PDBI Sample Sessions Introduction This chapter contains sample usages of the PDBI. The message exchanges are shown in Table 26: Network Entity Creation Example Table 41: Service Module Card List Example . All scenarios assume that a TCP/IP connection has already been established between the client and the PDBA. The first column in the tables shows the direction the message is going.
  • Page 142: Simple Subscription Data Creation

    (iid 5, rc 0) → end_txn (iid 6) The write transaction has been ended. The updates have been written to the PDB and will be sent to the EAGLE 5 ← rsp (iid 6, rc 0, data (dblevel 1)) ISS. →...
  • Page 143: Update Subscription Data

    The write transaction has been ended. The updates have been written to the PDB and will be ← rsp (iid 8, rc 0, data (dblevel 1)) sent to the EAGLE 5 ISS. → disconnect (iid 9) The client is done and has disconnected.
  • Page 144 Provisioning Database Interface Manual PDBI Sample Sessions Message Description → begin_txn (iid 2, type write) A write transaction has been opened. ← rsp (iid 2, rc 0) → ent_sub (iid 3, imsi 9195551000, dn 9195551214, dn Two new DNs are being added 9195551215, sp 9195550000) to the existing IMSI 9195551000.
  • Page 145: Table 29: Update Subscription Data Example 2

    Provisioning Database Interface Manual PDBI Sample Sessions This illustrates how update works to add a 2nd NE association when an association already existed. Remove an NE association to make room for a 2nd NE association Note: All VMSs, GRNs, & SPs in the following example are assumed to be provisioned prior to this example.
  • Page 146: Table 30: Update Subscription Data Example 3

    Provisioning Database Interface Manual PDBI Sample Sessions Message Description 9195553000. DN 9195551600 is ← rsp (iid 8, rc 0) now on GRN 9196660000 (NE Query Only option) and SP 9195551100 (G-Flex). → end_txn (iid 9) The write transaction has ended. The updates will be written to the database.
  • Page 147 Provisioning Database Interface Manual PDBI Sample Sessions Message Description ← rsp (iid 3, rc 0) → upd_sub(iid 4, dn 9195551310, vms 9195551400) The DN 9195551310 has been moved from IMSI 9195555000 to VMS 9195551400. It is no longer ← rsp (iid 4, rc 0) associated with SP 9195551100 and will not be routed by G-Flex.
  • Page 148: Simple Queries

    Provisioning Database Interface Manual PDBI Sample Sessions Message Description ← rsp (iid 80, rc 0) → upd_sub(iid 81, dn 9195551311, asd none) This DN now has no additional subscriber data. ← rsp (iid 81, rc 0) → end_txn (iid 9) The write transaction has ended.
  • Page 149 Provisioning Database Interface Manual PDBI Sample Sessions Message Description → rtrv_sub (iid 4, bimsi 9195550000, eimsi 9195559999, This query is almost the same as the one data neonly) above. This difference is that this one specifies the value neonly for the data ←...
  • Page 150: Multiple Response Query

    Provisioning Database Interface Manual PDBI Sample Sessions Multiple Response Query This example shows a retrieve command that results in multiple responses coming back. This would happen when there are so many subscriptions matching the query that a single response would be too big to handle.
  • Page 151: Abort Transaction

    Provisioning Database Interface Manual PDBI Sample Sessions Abort Transaction This example shows awrite transaction that receives an error on one of its update requests and then aborts the transaction. Table 33: Abort Transaction Example Message Description → connect(iid 1, version 1.0) A PDBI connection has been established to the Active PDBA.
  • Page 152: Update Request In Read Transaction

    Provisioning Database Interface Manual PDBI Sample Sessions Update Request In Read Transaction This example shows a client opening areadtransaction and then trying to send a command to modify data. Table 34: Update Request in Read Transaction Example Message Description → connect(iid 1, version 1.0) A PDBI connection has been established to the Active PDBA.
  • Page 153: Simple Subscription Data Creation With Single Txnmode

    Provisioning Database Interface Manual PDBI Sample Sessions Table 35: Write Transaction in Standby Connection Example Message Description → connect(iid 1, version 1.0) A PDBI connection has been established to the Standby PDBA. ← rsp (iid 1, rc 0, data (connectId 8, side standby)) →...
  • Page 154: Single Imei Data

    Provisioning Database Interface Manual PDBI Sample Sessions Message Description on SP 9195550000. This is exactly the same ← rsp (iid 4, rc 0, data (dblevel 3)) type of command as the previous item. It is being done so that the IMSI can be used in a later example.
  • Page 155: Imei Block Data

    Provisioning Database Interface Manual PDBI Sample Sessions Message Description rsp (iid 4, rc 0) Gray. The White list is now ← turned off. dlt_eir(iid 5, imei 12345678901234, imsi → 9199302266) The specified IMSI is no longer associated with the IMEI. rsp (iid 5, rc 0) ←...
  • Page 156: Asynchronous Service Module Card Report

    The write transaction has been ended. The updates have been rsp (iid 6, rc 0, data (dblevel 1)) written to the PDB and will be ← sent to the EAGLE 5 ISS. disconnect(iid 7) → The client is done and has disconnected.
  • Page 157: Synchronous Service Module Card Report

    Provisioning Database Interface Manual PDBI Sample Sessions Message Description → 10 seconds later, another report dsmrpt (rc 0, data (segment 1, level 2917, comes out. Now, the loading card ← percent 95, numdsms 20, dsms (dsm (clli is finished, but the corrupt card lakemary, cardloc 2104, status corrupt, is still corrupt.
  • Page 158: Service Module Card List

    Provisioning Database Interface Manual PDBI Sample Sessions Service Module Card List This example shows a connection requesting to see the list of Service Module cards. There are only five cards in this example to make the responses smaller. Table 41: Service Module Card List Example Message Description →...
  • Page 159 Provisioning Database Interface Manual PDBI Sample Sessions Message Description disconnect(iid 7) → The client is done and has disconnected. 910-6022-001 Revision A, March 2011...
  • Page 160: Appendix A: Pdbi Message Error Codes

    Appendix PDBI Message Error Codes Topics: This chapter lists the PDBI error codes and text. PDBI Message Error Codes..161 910-6022-001 Revision A, March 2011...
  • Page 161: Pdbi Message Error Codes

    If that is the case, add WRITE permissions for the IP address of the PDBI client. 1007 PDBI_NO_MATE Contact Tekelec. This indicates that the Active PDB has lost contact with Standby. 1008 PDBI_STANDBY_SIDE Connect to the Active PDBA for write operations.
  • Page 162 This error is dependent on the contents of the database. No action is required, unless it is known that the item in question should be in the database. If this is the case, contact Tekelec. 1014 PDBI_CONFLICT_FOUND Using the force parameter can override this check and eliminate the return of this error code for certain commands.
  • Page 163 Contact Tekelec 1031 PDBI_DB_EXCEPTION The client program should retry the transaction. If the error persists, contact Tekelec. 1032 PDBI_MAX_IMSI_LIMIT Contact Tekelec. Database capacity for IMSIs has been reached. 1033 PDBI_MAX_DN_LIMIT Contact Tekelec. Database capacity for IMSIs has been reached.. 1034 PDBI_MAX_DNBLK_LIMIT Contact Tekelec.
  • Page 164 1046 PDBI_MAX_ASD_LIMIT Contact Tekelec. Database capacity for ASD records has been reached. PDBI_DN_NOT_FOUND The DN specified by nsdn does not exist. 1047 PDBI_MAX_ASSOCIATIONS...
  • Page 165 Provisioning Database Interface Manual PDBI Message Error Codes Error Code Text Recommended Action PDBI_DNB_SAME_PROPERTIES The new DN Block requested by the 1052 operator is a subset of an existing block with same properties. PDBI_MULTI_DNB_CONFLICT The new DN Block could not be added to 1053 the database as multiple conflicting DN Blocks were found within given bdn-edn.
  • Page 166: Appendix B: Tif Number Substitution Relationships

    Appendix TIF Number Substitution Relationships Topics: This chapter includes information to support the TIF Number Substitution feature (TIF NS). TIF Number Substitution Relationships..167 910-6022-001 Revision A, March 2011...
  • Page 167: Tif Number Substitution Relationships

    Provisioning Database Interface Manual TIF Number Substitution Relationships TIF Number Substitution Relationships The TIF Number Substitution (TIF NS) feature enables subscriber DN records to associate with DNs and DN Blocks for TIF Number Substitution. All DNs and DN Blocks used for TIF NS shall be provisioned as public or private.
  • Page 168 Provisioning Database Interface Manual TIF Number Substitution Relationships Type Associations NSDN DN Block MSISDN None None From IMSI Prohibited MSISDN Supported None From IMSI Prohibited MSISDN None Supported From IMSI Prohibited MSISDN Supported Supported From IMSI Prohibited This is a list of rules for TIF NS: 1.
  • Page 169: Appendix C: Dn Block Self Healing

    Appendix DN Block Self Healing Topics: This appendix includes information about the DN Block Self Healing feature. DN Block Self Healing ..170 910-6022-001 Revision A, March 2011...
  • Page 170: Dn Block Self Healing

    Provisioning Database Interface Manual DN Block Self Healing DN Block Self Healing The DN Block Self Healing feature allows the EPAP database to self heal when a command is executed to create a new DN Block that conflicts with one of the existing DN Blocks. In addition to this primary function, the feature also allows the defragmentation of the DN Blocks –...
  • Page 171: Table 44: Support For Dn Block Self Healing

    Provisioning Database Interface Manual DN Block Self Healing When the new DN Block conflicts with an existing block and is not its subset, the creation of new DN Block is not allowed. An error is returned when the user tries to insert a DN Block that conflicts with a DN Block that has itsa split option set to no.
  • Page 172: Glossary

    Glossary Ampere A-Port ANSI-41 Mobile Number Portability A feature that enables IS-41 subscribers to change their service provider while retaining the same Mobile Dialed Number (MDN). Data Acknowledgement AINPQ ANSI-41 INP Query ANSI American National Standards Institute An organization that administers and coordinates the U.S.
  • Page 173 Provisioning Database Interface Manual Glossary Country Code CCGT Cancel Called Global Title Compact Disk CLLI Common Language Location Identifier The CLLI uniquely identifies the STP in terms of its physical location. It is usually comprised of a combination of identifiers for the STP’s city (or locality), state (or province), building, and traffic unit identity.
  • Page 174 Provisioning Database Interface Manual Glossary applications, and 10 digit telephone numbers. Directory number A DN can refer to any mobile or wireline subscriber number, and can include MSISDN, MDN, MIN, or the wireline Dialed Number. Database Service Module. The DSM provides large capacity SCCP/database functionality.
  • Page 175 Provisioning Database Interface Manual Glossary File Transfer Protocol A client-server protocol that allows a user on one computer to transfer files to and from another computer over a TCP/IP network. Group Code G-Flex GSM Flexible numbering A feature that allows the operator to flexibly assign individual subscribers across multiple HLRs and route signaling messages, based on...
  • Page 176 Provisioning Database Interface Manual Glossary A feature of the signaling connection control part (SCCP) of the SS7 protocol that the EAGLE 5 ISS uses to determine which service database to send the query message when an MSU enters the EAGLE 5 ISS and more information is needed to route the MSU.
  • Page 177 Provisioning Database Interface Manual Glossary Tekelec’s INP can be deployed as a stand-alone or an integrated signal transfer point/number portability solution. With Tekelec’s stand-alone NP server, no network reconfiguration is required to implement number portability. The NP server delivers a much greater signaling capability than the conventional SCP-based approach.
  • Page 178 Provisioning Database PDBA Provisioning Database Application There are two Provisioning Database Applications (PDBAs), one in EPAP A on each EAGLE 5 ISS. They follow an Active/Standby model. These processes are responsible for updating and maintaining the Provisioning Database (PDB). PDBI...
  • Page 179 Provisioning Database Interface Manual Glossary PPSMS Prepaid Short Message Service Provisioning Blacklist A list of ranges that are prohibited from being used as DNs, DN Blocks, and IMSI address strings. Portability Type Routing Indicator Routing Number Read Only Memory RTDB Real Time Database Site Collector Service Module card...
  • Page 180 LNP subsystem of the EAGLE 5 ISS. A value of the routing indicator portion of the global title translation data commands indicating that no further global title translation is required for the specified entry.
  • Page 181 Protocol/Internet Protocol User Interface V-Flex Voicemail Flexible Routing An advanced database application based on the industry proven EAGLE 5 ISS. Deployed as a local subsystem on the EAGLE platform, V-Flex centralizes voicemail routing. Voice Mail Server Wide Area Network 910-6022-001 Revision A, March 2011...

Table of Contents