My Oracle Support Banner

Import Circuit EJB API’s for non-customer/non-provisioned connections (Doc ID 1142861.1)

Last updated on FEBRUARY 03, 2022

Applies to:

Oracle Communications MetaSolv Solution - Version 6.0.16 to 6.2.1 [Release 6.0.16 to 6.2.0]
Information in this document applies to any platform.


This document covers design implementation specifics related to EJB APIs exposed to import non-customer and non-provisioned circuits into the MetaSolv Solution.


This design provides a solution to the third party applications to interact/integrate with the MetaSolv Solution application, to import non customer circuits using circuit EJB APIs.

New EJB API's have been created for creation of a circuit.  This API's create a circuit based on input data.  Following connection formats can be created using the API's:

  • CLF - Structured format Facility circuit
  • OTF - Free format Facility circuit
  • CLS - Structured format Special circuit
  • OTS - Free format Special circuit
Note:  Custom attributes can also be passed with the creation of a circuit.
The EJB API's covers importing the circuits of type Facility, Bandwidth and Special only.

Implementation covers the APIs specified below:

  • Create or update the information related to a circuit
  • Auto-build an optical circuit based on its hierarchy structure
  • Associate/Un-associate a circuit with network system
  • Assign/Un-assign port assignments of a circuit

New EJB API’s have designed for following functionalities in order to enable import of Connection information into the MetaSolv Solution.

Base (non-customer) circuit creation:
New EJB API has been designed to create connection (special, bandwidth, and facility).

Following activities can be performed on base circuits:
(These activities can be invoked on base circuit in two ways either as part of circuit creation or after creation invoke respective EJB API)
  • Creation of base circuits i.e. links (facilities), special, bandwidth
  • Auto-build the facility connection (for Optical networks)
  • Associate the connection with network system
  • Population of custom attributes for connection: This activity of populating CA’s would be done as part of connection creation API. While invoking the connection API, if CA’s are provided in input then CA’s will be populated for the connection.
  • Port assignments for the base connection
Update on base (non-customer) circuit:
Following activities have been implemented through EJB API’s as part of update on base circuit.
  • Update of connection properties and user data. API supports update of following connection properties
Rate code, A/Z locations, Framing, Framing ANSI, line coding, official company use, protected connection, allows lower rates, Total number of channel positions, Exchange carrier designer contact (EC DSGCON), Exchange Carrier Telephone Number (EC TEL), Exchange Carrier Maintenance Control Office (EC MCO), Exchange Carrier Operations Control Office (EC OCO)

If the facility connection has connection positions then number of channel positions, rate code and remarks of channel positions can be changed.

If the connection is auto-built to lower levels facility designations of channels can be modified through API.
  • Update of connection CA’s and user data.
  • Changes in the port of assignments of base circuit like removing the existing port assignments, changing the port address on same equipment, moving port assignments to other equipment.
  • Un-associate the base connection from the network system.


Note: Designing of EJB APIs for customer or provisioned circuits will take place in phase II *


To view full details, sign in with your My Oracle Support account.

Don't have a My Oracle Support account? Click to get started!

In this Document
 --- Environment ---
 --- New EJB API's ---
 Assign/un-assign the port of base circuit
 Associate/un-associate the connection with network system:
 Auto-build the facility connection:
 Create connection API
 --- Existing EJB API's ---
 Auto-build for one level:
 Delete the connection
 New design issue creation or update the existing design issue with new data
 Creation of new design block
 --- Assumptions ---
 --- Constraints ---

My Oracle Support provides customers with access to over a million knowledge articles and a vibrant support community of peers and Oracle experts.