Oracle® Communications MetaSolv Solution ASR

Developer's Reference

Release 53.0

E75743-02

September 2016

Oracle Communications MetaSolv Solution ASR Developer's Reference, Release 53.0

E75743-02

Copyright © 2016, 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 is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware 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 that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about 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 unless otherwise set forth in an applicable agreement between you and Oracle. 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, except as set forth in an applicable agreement between you and Oracle.

Contents

Preface

- Audience

- Related Documents

- Documentation Accessibility

1 Access Service Request Overview

- ASR API Implementation Concepts

- Exporting ASR Forms

- Importing ASR Forms

- Confirmation Notice (CN)

- Clarification Request (CR)

- MetaSolv Solution ASR Module

- ASR API IDL Files

- WDIASR.IDL Interfaces

- ASR API WDIRoot Interface

- ASR API WDIManager Interface

- ASRSession Interface

- WDINotification Interface

- ASR API Operations

- exportASR

- exportCN

- exportCR

- importCN

- importCR

- importDIS

- importEUSA

- importExternalDLR

- importFGA

- importPIP

- importRING

- importSES

- importTRANSPORT

- importTRUNKING

- importWAL

- queryASRByCriteria

2 About the CABS API Operations

- CABS API IDL Files

- WDICABS.IDL Interfaces

- CABS API Interfaces Relationship

- CABS API WDIRoot Interface

- CABS API WDIManager Interface

- CABS API CABSSession Interface Operations

- CABS API Operations

- exportCABS

- queryCABSByCriteria

- CABS API Structures

- CabCktLocUsoc

- CabCktLoc

- CabCkt

- CabsData

- CabsQueryDetail

A IDL Changes and Enhancements

- MetaSolv Solution APIs Impacted by IDL Changes and Enhancements

- New IDL Files

- WDIASR52.IDL Changed to WDIASR53.IDL

- Revised Data Structures

Preface

This guide provides information about the Oracle Communications MetaSolv Solution Access Service Request (ASR) API, which is designed to assist you in exchanging Access Services Ordering Guidelines (ASOG) 53 ASRs and related documents with trading partners. Before designing any software that interfaces with the ASR API, you should familiarize yourself with the contents of those documents, which are available at:

http://www.atis.org

Audience

This guide is intended for users who are responsible for submitting ASRs (based on industry guidelines) to a service provider to initiate or change access services.

Related Documents

For more information, see the following documents in the Oracle Communications MetaSolv Solution ASR documentation set:

- ASR Installation Guide: Describes installation procedures for installing ASR.

- ASR Release Notes: Provides information about supported software, new enhancements, and fixed issues.

For step-by-step instructions for tasks you perform in ASR, open the ASR module from within the MetaSolv Solution application to see the ASR online Help.

For information on the MetaSolv Solution application, see the Oracle Communications MetaSolv Solution documentation set on the Oracle Help Center:

http://docs.oracle.com

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

1 Access Service Request Overview

The Oracle Communications MetaSolv Solution Access Service Request (ASR) is a request (based on industry guidelines) that you use to initiate or change access services. ASRs are submitted by a customer to a provider. Access services include service and facilities provided to originate or terminate InterLATA or Interstate telecommunications. The ASR provides a uniform means of requesting service. Each request contains entries required to order particular service and establish billing of appropriate customer accounts. The request is either for special access or switched access services as specified in the various access service tariffs. The ASR is also a mechanism for ordering local interconnection trunks. Refer to the Ordering and Billing Forum (OBF) documentation for detailed information on the ASR forms and fields.

ASR API Implementation Concepts

This section describes the implementation concepts of the ASR API. The Oracle Communications MetaSolv Solution Access Service Request (ASR) API is designed to assist you in exchanging Access Services Ordering Guidelines (ASOG) 53 ASRs and related documents with trading partners. The ASR API meets the requirements of the ATIS-0404000-0053 - ATIS-0404028-0053 document.

Exporting ASR Forms

The ASR API server assumes that an exported order is OBF compliant. It is the responsibility of the core software product to ensure OBF compliance prior to task generation. The documentNumber parameter refers to the MetaSolv Solution document number. All export operations of the ASRSession interface require this parameter. The referenceNumber parameter refers to a third-party number. This number is determined by the third party. The purpose of this parameter is to provide the third party with a mechanism for matching a requested ASRSession operation with its resulting notification. All operations of the ASRSession interface, including notification operations, require a reference number.

Importing ASR Forms

The ASR API does not perform exhaustive OBF valid value validations. It is the responsibility of the third-party gateway product to ensure field values are consistent with OBF specifications. The ASR API performs necessary validations to ensure the integrity of the data within the MetaSolv Solution database.

Confirmation Notice (CN)

There is one export and import operation for all CNs.

- exportCN

- importCN

Clarification Request (CR)

There is one export and import operation for all CRs.

- exportCR

- importCR

MetaSolv Solution ASR Module

An ASR is an order to originate or terminate connections to your company's telephone network. It is submitted by the customer on OBF-developed ASR forms. You use the ASR order entry screens when you enter the customer-submitted service request.

The ASR order entry screens guide you through the steps necessary to correctly enter the order. Each OBF form appears as a section of the ASR order entry screens. The entries you make in each section determine which sections (or forms) are presented. The request type of the order (which you enter on the Administrative Section - Admin 2 window) is one of the main determinants for which forms and sections are presented for an order.

For each ASR, the MetaSolv Solution's ASR module requires you to complete the following administrative sections:

- Administrative

- Billing

- Contact

The ASR module supports the following service-specific forms for ASRs:

- Dedicated Internet Service

- End User Special Access

- Feature Group A

- Private Internet Protocol

- Ring

- Switched Ethernet Services

- Transport

- Trunking

- WATS Access Line

The ASR module also supports the following forms. These forms accompany service-specific forms when certain services are ordered:

- Additional Circuit Information

- Additional Ring Information

- End Office Detail

- Ethernet Virtual Connection

- Multi-EC

- Multipoint Service Legs

- Network Assignment Information

- Permanent Virtual Connection

- Ports Configuration

- Service Address Location Information

- Translation Questionnaire

- Virtual Connection (request types V or X)

- Virtual Concatenation (request types S,E,R,V,X)

The following form is not specific to ATIS/OBF:

- Circuit Assignment

ASR API IDL Files

These IDL files describe the interfaces your application uses to communicate with the ASR API.

- WDI.IDL: This IDL file contains the operations that provide the functionality for the WDIManager interface.

- WDIASR53.IDL: This IDL file contains the interfaces and operations exposed by the ASR API.

- WDIASRTYPES53.IDL: This IDL file contains data structures for the ASOG 53 forms.

WDIASR.IDL Interfaces

This section describes the WDIASR.IDL interfaces.

ASR API WDIRoot Interface

This interface exposes operations used to connect and disconnect from the MetaSolv Solution ASR API server.

Table 1-1 lists the WDIRoot interface operations.

Table 1-1 WDIRoot Interface Operations

Operation

Description

connect

This operation provides a connection allowing a client to access the ASR API server.

disconnect

This operation disconnects the client from the ASR API server.

ASR API WDIManager Interface

This interface exposes operations that start and destroy an ASRSession, WDISignal, and WDIInSignal.

MetaSolv Solution software manages all database transaction processing for the ASR API. This means MetaSolv Solution establishes the database connection and maintains control of commit and rollback processing. Consequently, the ASR API does not use the WDITransaction interface.

Table 1-2 lists the WDIManager interface operations.

Table 1-2 WDIManager Interface Operations

Operation

Description

startASRSession

This operation starts an ASR session for the client using the ASR API server. The returned ASRSession object reference is used to access the ASR API application logic.

destroyASRSession

This operation destroys the ASRSession.

startSignal

This operation starts a Signal for the client using the ASR API server. The returned WDISignal object reference is used to update the status of outbound gateway events.

destroySignal

This operation destroys the Signal.

startInSignal

This operation starts an InSignal, for the client, with the ASR API server. The returned WDIInSignal object reference is used to update the status of inbound gateway events.

destroyInSignal

This operation destroys the InSignal.

ASRSession Interface

This interface exposes operations allowing export and import of ASR orders, confirmations and clarifications.

WDINotification Interface

This interface enables a callback mechanism to notify the client of the result of an operation invoked against the ASR API server. All operations of the ASRSession interface are asynchronous and require a WDINotification object reference.

The operationFailed operation is invoked any time an operation of the ASRSession interface fails. This operation notifies the client that the requested operation on the ASRSession interface failed and provides the reason(s) for the failure.

The importSucceeded operation is sent any time an import operation of the ASRSession interface succeeds. This operation notifies the client that a requested import operation of the ASRSession interface for the stated reference number completed successfully.

Table 1-3 lists the operations in the WDIASR53.IDL file with the accompanying notifications.

Table 1-3 ASR API Operations and Notifications

ASRSession Operation

Related WDINotification Operations

exportASR

exportEUSASucceeded

exportFGASucceeded

exportRINGSucceeded

exportSESSucceeded

exportTRANSPORTSucceeded

exportTRUNKINGSucceeded

exportWALSucceeded

operationFailed

exportCN

exportCNSucceeded

operationFailed

exportCR

exportCRSucceeded

operationFailed

importCN

importSucceeded

operationFailed

importCR

importSucceeded

operationFailed

importDIS

importSucceeded

operationFailed

importEUSA

importSucceeded

operationFailed

importExternalDLR

importSucceeded

operationFailed

importFGA

importSucceeded

operationFailed

importPIP

importSucceeded

operationFailed

importRING

importSucceeded

operationFailed

importSES

importSucceeded

operationFailed

importTRANSPORT

importSucceeded

operationFailed

importTRUNKING

importSucceeded

operationFailed

importWAL

importSucceeded

operationFailed

queryASRByCriteria

queryASRByCriteriaSucceeded

operationFailed

ASR API Operations

The following are the ASR API operations:

exportASR

This operation requests the export of an ASR for a given document number. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the export.

exportCN

This operation requests the export of a Confirmation Notice for a given document number. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the export.

exportCR

This operation requests the export of a Clarification Request for a given document number. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the export.

importCN

This operation requests the import of an ASOG 53 Confirmation Notice and provides the data for the imported confirmation. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the import.

importCR

This operation requests the import of an ASOG 53 Clarification Request and provides the data for the imported confirmation. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the import.

importDIS

This operation requests the import of an ASOG 53 Dedicated Internet Service ASR order and provides the data for the imported order. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the import.

importEUSA

This operation requests the import of an ASOG 53 End User Special Access ASR order and provides the data for the imported order. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the import.

importExternalDLR

This operation requests the import of an External DLR and provides the data for the imported External DLR. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the import.

importFGA

This operation requests the import of an ASOG 53 Feature Group A ASR order and provides the data for the imported order. The WDINotification and reference number are used to send the appropriate notification information to client upon completion of the import.

importPIP

This operation requests the import of an ASOG 53 Private Internet Protocol ASR order and provides the data for the imported order. The WDINotification and reference number are used to send the appropriate notification information to client upon completion of the import.

importRING

This operation requests the import of an ASOG 53 Ring ASR order and provides the data for the imported order. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the import.

importSES

This operation requests the import of an ASOG 53 Switched Ethernet Services ASR order and provides the data for the imported order. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the import.

importTRANSPORT

This operation requests the import of an ASOG 53 Transport ASR order and provides the data for the imported order. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the import.

importTRUNKING

This operation requests the import of an ASOG 53 Trunking ASR order and provides the data for the imported order. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the import.

importWAL

This operation requests the import of an ASOG 53 WAL ASR order and provides the data for the order to be imported. The WDINotification and reference number are used to send the appropriate notification information to client upon completion of the import.

queryASRByCriteria

This operation allows the query of ASRs by criteria. The query criteria includes any combination of CCNA, PON, and ICSC.

2 About the CABS API Operations

The CABS (Carrier Access Billing System) API operations are a subset of the ASR API that allows you to retrieve billing information contained in ASR tables in the MetaSolv Solution database.

There are five structures in the WDICABSTYPES.IDL file that hold the following types of information:

- USOC

- Location

- Circuit

- General CABS

- Information query

CABS API IDL Files

The following are the CABS API IDL files:

- WDI.IDL: This IDL file contains the operations that provide the functionality for the WDIManager interface.

- WDIUTIL.IDL: This IDL file provides functionality common to all MetaSolv Solution APIs.

- WDICABS.IDL: This IDL file contains the interfaces and operations exposed by the CABS API.

- WDICABSTYPES.IDL: This IDL file contains data structures used in conjunction with the CABS API.

WDICABS.IDL Interfaces

The section describes the WDICABS.IDL interfaces.

CABS API Interfaces Relationship

Figure 2-1 shows the relationship of the CABS API interfaces.

Figure 2-1 WDICABS.IDL Interfaces

CABS API WDIRoot Interface

This interface exposes operations used to connect and disconnect from the MetaSolv Solution ASR API server.

Table 2-1 lists the WDIRoot interface operations.

Table 2-1 WDIRoot Interface Operations

Operation

Description

connect

Returns a reference to WDIManager

disconnect

Terminates the connection

CABS API WDIManager Interface

Table 2-2 lists the WDIManager interface operations.

Table 2-2 WDIManager Interface Operations

Operation

Description

startCABSSession

Obtains the object reference of the CABSSession

destroyCABSSession

Terminates the CABSSession

startSignal

Obtains the WDISignal object reference

destroySignal

Terminates the Signal

startInSignal

Obtains the WDI Insignal object reference

destroyInSignal

Terminates the Insignal

CABS API CABSSession Interface Operations

Table 2-3 lists the CABSSession interface operations.

Table 2-3 CABSSession Interface Operations

Operation

WDINotification

exportCABS

exportCABSSucceeded

operationFailed

queryCABSByCriteria

queryCABSByCriteriaSucceeded

operationFailed

CABS API Operations

The following are the CABS API operations:

exportCABS

The exportCABS operation requests access billing information for a given document number. Exported data includes general CABS, circuit, location, and USOC information. Refer to the WDICABSTYPES.IDL file for details on the data structures exported by this operation.

queryCABSByCriteria

This operation requests a query of CABS by criteria and retrieves the information. Any combination of CCNA, and PON can be used. The WDINotification and reference number are used to send the appropriate notification information to the client upon completion of the query.

CABS API Structures

These structures are located in the WDICABSTYPES.IDL file.

CabCktLocUsoc

The CabCktLocUsoc structure can contain 0 to many rows of data based on the number of USOCs for a given document number. This structure contains USOC information.

CabCktLoc

The CabCktLoc structure can contain 0 to many rows of data based on the number of circuit locations for a given document number. This structure contains location information.

CabCkt

The CabCkt structure can contain 0 to many rows of data based on the number of circuits for a given document number. This structure contains circuit information.

CabsData

The CabsData structure always contains one row of data based on a given document number. This structure contains general CABS information.

CabsQueryDetail

The CabsQueryDetail structure retrieves the following information and makes it available to the user:

- documentNumber

- customerNameAbbreviation

- purchaseOrderNumber

- activityInd

- requestType

A IDL Changes and Enhancements

This appendix describes the differences between the IDL that supports ASOG 53 and the previous release of the ASR API IDL.

MetaSolv Solution APIs Impacted by IDL Changes and Enhancements

The only IDL changes and enhancements made for ASOG 53 involve the ASR API.

These ASR API IDL files were not changed for ASOG 53:

- WDI.IDL

- WDIUTIL.IDL

- WDICABS.IDL

- WDICABSTYPES.IDL

These files were added for ASOG 53:

- WDIASRTYPES53.IDL

- WDIASR53.IDL

New IDL Files

There are two new IDL files for the ASR API for ASOG 53, WDIASRTYPES53.IDL and WDIASR53.IDL. These files define all IDL elements of scope MetaSolv::CORBA::ASRTypes53. No IDL elements of other scopes are defined in this file. The WDIASRTYPES53.IDL is based on WDIASRTYPES52.IDL from the previous release.

WDIASR52.IDL Changed to WDIASR53.IDL

Removed statement to include WDIASRTYPES52.IDL.

Added statement to include WDIASRTYPES53.IDL.

Revised Data Structures

This section provides information about the ASR IDL data structures that have been revised to support ASOG 53.

Table A-1 lists the data structures in which fields have been added.

Table A-1 New Fields

Data Structure

New Fields

ACI

- ptv

- rcId

EUSA

rcId

SES

ptv

TRANSPORT

rcId

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2017, Oracle and/or its affiliates. All rights reserved.

License Restrictions Warranty/Consequential Damages Disclaimer

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.

Warranty Disclaimer

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.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware 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 that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information about 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 unless otherwise set forth in an applicable agreement between you and Oracle. 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, except as set forth in an applicable agreement between you and Oracle.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Private Alpha and Beta Draft Documentation Notice

If this document is in private preproduction status:

The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your beta trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.

This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.