Go to main content
1/22
Contents
Title and Copyright Information
Preface
Audience
Related Documents
Documentation Accessibility
1
The MetaSolv Solution Architecture
What Does MetaSolv Solution Do?
How Do the MetaSolv Solution APIs Work with MetaSolv Solution?
Overview of Essential Terminology
Solicited Messages Vs. Unsolicited Messages
Events Vs. Signals
Inbound Signals Vs. Outbound signals
Synchronous Vs. Asynchronous
API Integration
MetaSolv Solution API Technical Overview
Understanding Events
Synchronous and Asynchronous Invocation Modes
Synchronous Operations
Asynchronous Operations
Transaction Model Used By the APIs
Transaction Objects
Determining the Role Your Application Performs
Importing and Exporting Using the APIs
Responsibilities When Developing With the APIs
Naming Conventions in the APIs
IDL Versioning for MetaSolv Solution
2
Developing Applications Using the APIs
MetaSolv Solution Interface Architecture
Design Architecture
Deployment Architecture
Relationship of APIs, API Server Names, and IDL Files
MetaSolv Solution APIs Require Instance References to Notification Objects
Development Environment
Before Compiling IDL files
Determining Which IDL Files Are Required for a Given API
CORBA Development
Implementation Patterns
Basic API Setup Pattern
Purpose
When Used
Description
Synchronous Interaction Pattern
Purpose
When Used
Description
Asynchronous Interaction Pattern
Purpose
When Used
Description
CORBA Client/Server Pattern
Purpose
When Used
Signal Handling Pattern
Purpose
When Used
Description
General Remarks On Outbound Signals
Outbound Signals – Gateway Events
Outbound Signals – Application Events
Inbound Signals
Error Handling Pattern
Purpose
When Used
Description
Exception
Error Array
Status
Sample Applications
HelloAPI: Sample Application that Exports Data
Implementation Notes
HelloGateway: Sample Application that Handles Application and Gateway Events
Migrating to MetaSolv Solution 6.3.
x
from 6.2.x
Migrating to MetaSolv Solution 6.3.
x
from 5.x and 6.0.x
Implementing SSL in JacORB 3.8
3
Common Architecture
WDIRoot Interface
Connection to the MetaSolv Solution Application Server
Connection to the CORBA Daemon
Connection to the Root Object
WDIManager Interface
API Session Interfaces (Session Processing)
WDITransaction Interface (Database Transactions)
WDISignal Interface (Outbound Signal Processing)
WDIInSignal Interface (Inbound Signal Processing)
WDINotification Interface (Callback Mechanism)
4
The Infrastructure API
Implementation Concepts
Infrastructure Operational Differences
Latitude and Longitude Fields Are Not Calculated and Validated
Switch Network Area Field Defaults to First Switch Network Area
Query Across All Address Formats
Key MetaSolv Solution Concepts
Infrastructure API Files
Infrastructure Interface
WDIManager
InfrastructureSession Interface
InfrastructureSession Operation Descriptions
Query Operation
Export Operations
NetworkLocationSubSession
NetworkLocationSubSession Interface Operations
NetworkLocationSubSession Operation Descriptions
Query Operations
Get Operations
Create Operation
Update Operation
Delete Operation
Associate Operations
Unassociate Operations
Process Flows
Solicited Messages
Unsolicited Messages
Sample Unsolicited Message Process Flow for Exporting Infrastructure Information
5
The Inventory and Capacity Management API
Key MetaSolv Solution Concepts
Equipment Types, Equipment Specifications, and Equipment
Equipment Network Elements
Equipment Name Aliases
Equipment Installation in MetaSolv Solution
Mounting Positions
Ports and Port Addresses
Virtual Port Addresses
Enabled Ports and Enabled Port Addresses
Port Address Placeholders
Port Address Aliases
Nodes and Node Addresses
Sequential Port Address Numbering
Hard-Wired Cross-Connects
Condition Codes
IP Address Management in MetaSolv Solution
Overview of Assigning IP Addresses to Ports
Some Common Questions About Equipment in MetaSolv Solution
ICM API Implementation Concepts
Transaction Management and the ICM API
Network Inventory Gateway Events and the ICM API
DLR Mass Reconcile
ICM API IDL files
ICM API Interfaces
WDIManager Interface
CircuitHierarchySession Interface
EquipmentSession Interface Operations
SpecificationSubSession Interface Operations
InstallationSubSession Interface Operations
Comments Concerning Specific InstallationSubSession Operations
CrossConnectSubSession Interface Operations
Formats for Specifying FROM Side Port Addresses
Formats for Specifying TO-Side Port Addresses
Comments concerning specific CrossConnectSubSession operations
NetworkElementSubSession Interface Operations
Comments Concerning Specific NetworkElementSubSession Operations
DLRSession Interface Operations
Process Flows
Solicited Messages
Sample Solicited Message Process Flow
Unsolicited Messages
Sample Unsolicited Message Process Flow for Exporting
6
The Number Inventory API
Number Inventory API Interfaces
WDIManager Interface
NumberInventorySession Interface Operations
Process Flow
Unsolicited Messages
Sample Unsolicited Process Flow for Importing a Customer
Import Notifications
Number Inventory API Date Handling
7
The Activation API
Connections
Network System Information
Order Processing
Single Connection
Retrieval
MetaSolv Solution Key Concepts
Activation API IDL files
Activation API Interface Relationships
Activation API Operation Descriptions
8
The Plant API
Plant implementation Concepts
Order Management
Recommendations for Assigning Gateway Events to Provisioning Plan Tasks
Options for Modify Cable Pair Assignment Preference
Transaction Management and the Plant API
Associating Separations Route to Plant Transport
Consequential Equipment Assignments
Key MetaSolv Solution Concepts
Plant API IDL Files
Plant API Interface Relationships
PlantSession Interface
Plant API Operation Descriptions
MetaSolv Solution API Software and Mediation Server Processes
Request for Plant Assignment
Request for Plant Assignment Change
Request to Cancel Plant Assignment
Request to Disconnect Plant Assignment
Request to Cancel Plant Disconnect
Request for Change to Due Date
Request for Plant Assignment Exception
Request to Complete Plant Assignment
Import Plant Assignment Failed
Obtain Network Location Details
Query for Network Location ID
Query for Plant Specification ID
Obtain Valid Values for Plant Import and Export
9
The PSR Ancillary API
Implementation Concepts
Essential Terminology
PSR Ancillary API Interfaces
E911Session Interface Operations
CNAMSession Interface Operations
LIDBSession Interface Operations
Implementation Concepts
The PSR Ancillary API and Smart Tasks
Field by Field Matching Between Extract Row and Response Record
Rules of Operation
Extract Sequence Matching
Extract and Respond Scenario
Error Logging Changes
Process Flow
Unsolicited Messages
Sample Unsolicited Message Process Flow
Auto Respond Preference
Glossary of Terms and Abbreviations
10
The PSR Order Entry API
PSR Order Entry API Interfaces
WDIManager Interface
PSRSession Interface Operations
PSRSession Operation Descriptions
PSR Order Entry API Preferences
Bypass PSR API Switch Validation for TN assignment
Bypass Selected PSR API Import Structure Validation
Override Default Value on PSR API Import When Label Exists on Import Structure
Use Copy Item When Importing PSR Order
Using Metasolv Solution Inventory as the Primary Inventory for Telephone Numbers
PSRProductCatalogSession Interface Operations
PSRProductCatalogSession Operation Descriptions
PSRProvisioningSession Interface Operations
Process flow
Unsolicited Messages
Sample Unsolicited Process Flow for Importing a Customer
Import Notifications
PSR API Date Handling
Batch Operations in PSR API Exports
Export Search Criteria
MetaSolv Solution Product Specification and Product Catalog
Products
Item Types
Product Specifications
Product Catalog
More About Products
More About Product Specifications
More About Product Catalogs
Packages
11
The Switch Provisioning Activation API
Functionality
Essential Terminology
Switch Provisioning Activation Interface
DLRSession Interfaces
DLRSession Interface Operations
Process Flows
Solicited Messages
Sample Solicited Message Process Flow
Unsolicited Messages
Process Flow for Exporting Switch Provisioning Activation Information
Implementation Concepts
What Are Network Nodes and Network Node Types?
What are Flow-through Provisioning Plans and Commands?
What Are Design Layout Records (DLRs)?
What are Tech Translation Sheets?
What are Virtual Layout Records (VLRs)?
Software Modules and Subsystems Used in Flow-through Provisioning
Equipment Administration Module
Infrastructure Module
Product Service Request Module
Service Provisioning Subsystem
Work Management Subsystem
Flow-through Provisioning Process
Signal Handler
Request Handler
Formatting/Translation Module
Response Handler
Date/Time Format
CORBA Substructures
Design Considerations
12
The Transport Provisioning Activation API
Functionality
Essential Terminology
Transport Provisioning Activation Interface
DLRSession Interfaces
DLRSession Interface Operation
Process Flows
Solicited Messages
Sample Solicited Message Process Flow
Unsolicited Messages
Sample Unsolicited Message Process Flow for Exporting Transport Provisioning Activation Information
Implementation Concepts
What are Network Nodes and Network Node Types?
What are Flow-through Provisioning Plans and Commands?
What Are Design Layout Records (DLRs)?
What Are Tech Translation Sheets?
What Are Virtual Layout Records (VLRs)?
Software Modules and Subsystems Used in Flow-through Provisioning
Equipment Administration Module
Infrastructure Module
Product Service Request Module
Service Provisioning Subsystem
Work Management Subsystem
Flow-through Provisioning Process
Reference Architecture
Signal Handler
Request Handler
Formatting/Translation Module
Response Handler
Design Considerations
13
The Trouble Management API
Functionality
TroubleSession Interface
WDIManager
TroubleSession Interface Operations
TroubleSession Operation Descriptions
Trouble Management API IDL Files
Process Flows
Solicited Messages
Sample: Solicited Message Process Flow
Unsolicited Messages
Sample Flows for Business Tasks
Process Flow for Updating a Trouble Ticket
Process Flow for Clearing a Trouble Ticket
Process Flow for Closing a Trouble Ticket
Process Flow for Canceling a Trouble Ticket
Using the Service Item Test Button Functionality
Implementation Concepts
Interaction Life Cycle
Session User ID Can Be Used to Verify Workforce Employee
Date Field Types
The createTicket_v3 Operation
Import Ticket Attributes
Required Fields in createTicket_v3 Request
Business Rules in Processing createticket_v3 Request
Notifications Upon Ticket Creation
Escalation Levels for createTicket_v3 Request
Ticket Linkage
Creating Duplicate Tickets
Customer Must Be Passed as a Party ID
Customer is Defaulted Based On the Service Item
Non-inventoried Service Items Are Not Created
Certain Codes Are Passed as ID Values
Ticket Dates and Times Are Imported in GMT
Telcordia Preference and Trouble Management API
Setting or Changing the Affected Service Item On a Trouble Ticket
Passing the Service Item Type and Service Item Identifier
Identifying a Circuit/Connection Service Item Type
Identifying an Equipment Service Item Type
Identifying an Network Element Service Item Type
Identifying a Network System Service Item Type
Identifying a Telephone Number Service Item Type
Clearing the service item from a ticket
The updateTicket_v2 Operation
Updateable Ticket Attributes
ExportDateTime Field is Used to Check Concurrency
Required Fields in updateTicket Request
Business Rules in Processing updateTicket_v2 Request
Notifications Upon Ticket Update
Ticket Linkage and Ticket Update
Updating Duplicate Tickets
About Customer Information and Updating Tickets
Customer Must Be Passed as a Party ID
Customer is Defaulted Based On the Service Item
Non-inventoried Service Items Are Not Created
Certain Codes are Passed as ID Values
Ticket Dates and Times Are Exported and Imported in GMT
Audit Note Date/Time Display
Telcordia Preference and Trouble Management API
The clearTicket Operation
Ticket Linkage and Clear Ticket
Details Concerning Use of the closeTicket Operation
Ticket Linkage and Close Ticket
Closing an Open/Active Trouble Ticket
Notifications for Cleared and Closed Tickets
Details Concerning Use of the cancelTicket Operation
Ticket Linkage and Cancel Ticket
Details Concerning Use of the getTickets_v2 Operation
Details Concerning Use of the Service Item Query Operations
Structure Format Criteria for the getTelephoneNumberServItem Operation
MetaSolv Solution Software Concepts
Overview of the Trouble Management Subsystem
Permitted Trouble Ticket State Changes
Trouble Management Operational Differences
Escalation Organizations and Levels and the Trouble Management API
External Referrals and the Trouble Management API
User-required Optional Trouble Management Subsystem Fields and the Trouble Management API
User-defined Fields and the Trouble Management API
Certain Field Values Not Defaulted
No Default of ETTR, Priority Level or Customer Status Minutes for a Circuit Service Item
Repeat and Chronic Trouble Ticket Types
Effect of Data Errors in Trouble Reports on Trouble Management API Processing
14
The Work Management API
WMSession Interfaces
WDIManager
WMSession Interfaces
WMSession Interface Operation Descriptions
TaskGenerationSubSession Interfaces
TaskGenerationSubSession Interface Operation Descriptions
TaskViewingSubSession Interface Operations
TaskViewingSubSession Interface Operation Descriptions
TaskCompletionSubSession Interface Operations
TaskCompletionSubSession Interface Operation Descriptions
Work Management API IDL Files
Process Flows
Solicited Messages
Sample Solicited Message Process Flow
Unsolicited Messages
Enhanced Off-net Automation Functionality and the Work Management API
Implementation Concepts
Overview of the MetaSolv Solution Work Management Subsystem
Work Management Operational Differences
Tasks That Cannot be Completed Through the Work Management API
Work Management API Support for NET DSGN Task
Work Management API Support for Date Ready System Tasks
Work Management API Support for Backdated and Forward-dated Tasks
A
API Error Messages and Exceptions
B
Tips And Techniques
Understanding IOR Files
Configuring the IOR File to Enable External Systems to Connect to the CORBA Server
CORBA.INV_OBJREF and CORBA.OBJECT_NOT_EXIST Exceptions
CORBA.COMM_FAILURE Exception
Using the MetaSolv Solution APIs With Multi-Threaded Clients
Developing Using C++
C++ Troubleshooting
Troubleshooting Tips for API Developers
Using API Server Logging
Using SQL Logging
Using Console Logging
Using CORBA Logging
C
Sample Code
IOR Bind Method
Background
IOR Bind Method Sample Code
NameService Bind Method
Background
Binding to the NameServer With an IOR Sample Code
Binding to the NameService with resolve_initial_references Sample Code
URL Bind Method Sample Code
Sample Code
Gateway Events Functionality Changes
Middle-tier Triggering
New Binding Methods
Background
Defining a Gateway
IOR Binding to Third-party Applications
NameService Binding to Third-party Applications
New Event Signal
D
The PSR End User Billing API
Essential Terminology
PSREUBSession Interface
WDIRoot Interface
WDIManager Interface
PSREUBSession Interface Operations
Process Flows
Process Flow for Send Bill Cust Gateway Event
Process Flow for Send Bill Ord Gateway Event
Process Flow for Customer Change Application Event
Viewing PSREUB API Event Errors in MetaSolv Solution
Solicited Messages
Additional Process Flow Information
Interface Point 1: SBC Event
Information Passed to the Server
Interface Point 2: SBO Event
Information Passed to the Server
Implementation Concepts
Signal Handler Module Design
Request Handler Module Design
Response Handler Module Design
Transaction Handling
PSR Service Item Vs. the Billing Service Instance
Pricing
Transfer of Products Between Customer Accounts
Using the ELEMENT, CONNECTOR, SYSTEM and PRDBUNDLE Item Types
Glossary
Scripting on this page enhances content navigation, but does not change the content in any way.