2 About the CABS API Operations

The CABS (Carrier Access Billing System) API operations are a subset of the ASR CORBA 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

Description of Figure 2-1 follows
Description of ''Figure 2-1 WDICABS.IDL Interfaces''

CABS API WDIRoot Interface

This interface exposes operations used to connect and disconnect from the MetaSolv Solution ASR CORBA 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