2 Multi-Domain Circuit Topology Stitching Reconciliation Cartridge
Learn about the Oracle Communications Network Integrity Multi-Domain Circuit Topology Stitching Reconciliation cartridge.
Network Integrity's multi-domain circuit topology stitching features are implemented using two cartridges. Network discovery is performed by the Multi-Domain Circuit Topology Stitching Discovery cartridge. For more information, see Multi-Domain Circuit Topology Stitching Discovery Cartridge. Network reconciliation is performed by the Multi-Domain Circuit Topology Stitching Reconciliation cartridge. For more information, see the following topics:
Overview
The Multi-Domain Circuit Topology Stitching Reconciliation cartridge demonstrates the end-to-end integration of TMF814 discovery and assimilation with Oracle Communications Unified Inventory Management (UIM).
The reference implementation demonstrates full integration of NI with UIM for import, discrepancy detection, and discrepancy resolution with all discoverable entities.
For more information, see Network Integrity Developer's Guide.
About the Cartridge Dependencies
This section provides information about dependencies the Multi-Domain Circuit Topology Stitching Reconciliation cartridge has on other entities.
Run-Time Dependencies
For this cartridge to work at run time, ensure that UIM is installed and available and that the following cartridges are deployed in Network Integrity:
-
Address_Handlers
-
TMF814Discovery_Cartridge
-
Optical UIM Integration Cartridge
-
UIM Integration Cartridge
The following components must be deployed to UIM:
- UIM Integration web service
- ora_uim_network_device
- ora_ni_uim_sdh_optical
- ora_ni_uim_ocim
- OracleComms_UIM_Device_PortsInterfacesConnector
- ora_ni_uim_device_ports_interfaces_connectors
- ora_ni_uim_device_dwdm_optical
Design-Time Dependencies
This cartridge has the following dependencies:
- Abstract_CORBA_Cartridge
- Address_Handlers
- NetworkIntegritySDK
- OpticalAssimilation_Cartridge
- Optical_Model
- OpticalAssimilation_Model
- ora_ni_uim_device_dwdm_optical
- ora_ni_uim_device_ports_interfaces_connectors
- ora_ni_uim_ocim
- ora_ni_uim_sdh_optical
- ora_uim_model
- ora_uim_network_device
- TMF814_Model
- TMF814Discovery_Cartridge
- UIM_Integration_Cartridge
- OracleComms_UIM_Device_PortsInterfacesConnectors
Opening the Cartridge Files in Design Studio
To review and extend the Multi-Domain Circuit Topology Stitching Reconciliation cartridge, download the Oracle Communications Network Integrity Optical UIM Integration cartridge software from the Oracle software delivery website:
The software contains the Optical UIM Integration cartridge ZIP file, which has the following structure:
- \UIM_Cartridge_Projects\ora_ni_uim_ocim
- \UIM_Cartridge_Projects\OracleComms_UIM_Device_PortsInterfacesConnectors
- \UIM_Cartridge_Projects\ora_ni_uim_device_ports_interfaces_connectors
- \UIM_Cartridge_Projects\ora_uim_network_device
- \UIM_Cartridge_Projects\ora_ni_uim_sdh_optical
- \UIM_Cartridge_Projects\ora_ni_uim_device_dwdm_optical
- \UIM_Cartridge_Projects\SDH_Service_Model
- \UIM_Cartridge_Projects\ora_ni_uim_webservice
- \Network_Integrity_Cartridge_Projects\SDH_UIM_Cartridge
- \Network_Integrity_Cartridge_Projects\Generic_SNMP_Model
- \Network_Integrity_Cartridge_Projects\MIB_II_UIM_Cartridge
- \Network_Integrity_Cartridge_Projects\Optical_Model
- \Network_Integrity_Cartridge_Projects\Optical_UIM_Cartridge
- \Network_Integrity_Cartridge_Projects\UIM_Integration_Cartridge
The Network_Integrity_Cartridge_Projects\Optical_UIM_Cartridge\ project contains the extendable files for Oracle Communications Service Catalog and Design - Design Studio.
See Network Integrity Concepts for guidelines and best practices for extending cartridges.
See Design Studio Modeling Network Integrity for more information about opening projects in Design Studio.
Building and Deploying the Cartridge
See Design Studio Modeling Network Integrity for information about building and deploying cartridges.
About the Cartridge Components
This section provides information about the components of the Oracle Communications Network Integrity Multi-Domain Circuit Topology Stitching Reconciliation cartridge.
This cartridge contains the following actions:
Import TMF814 Links Circuit Stitching from UIM
The Import TMF814 Links Circuit Stitching action imports the data reconciled into UIM.
The processors of the Import TMF814 Links Circuit Stitching action run in the following order:
- ProcessScanFilterUIM: This processor implements the discrepancy detection filter.
- Collect Links: Retrieves all the topological links, applying filters if defined.
- Model Links: Iterates over each topological link ID to:
- Retrieve and model the topological link.
- Retrieve and model the pipe termination point.
- Persist the topological link.
Detect Discrepancy of Links Circuit Stitching
The Detect Discrepancy of Links Circuit Stitching action detects discrepancies between the discovery scan results obtained from the Discover TMF814 Links Circuit Stitching action and the data imported from UIM.
This action inherits the Detect Discrepancies processor (from NetworkIntegritySDK). The processors of the Detect TMF814 Optical Transmission Devices Discrepancies action run in the following order:
-
Circuit Stitching TL DD Filters (this processor implements discrepancy detection filter)
- Discrepancy Detector (inherited)
Resolve TMF814 Topological Links Circuit Stitching in UIM
The Resolve TMF814 Topological Links Circuit Stitching in UIM action extends the Abstract Resolve in UIM action and inherits all its processors. For more information about the Abstract Resolve in UIM action, see Network Integrity UIM Integration Cartridge Guide.
The Resolve TMF814 Topological Links Circuit Stitching in UIM action contains the following processors run in the following order:
- UIM Resolution Framework Initializer (inherited)
- UIM Resolution Initializer (inherited)
- TMF814 Circuit Stitching Resolution Initializer (this processor defines the Pipe handler to initialize the creation and deletion and update operation over topological link)
- UIM Resolution Framework Dispatcher (inherited)
Rehome Support for Circuit Stitching
When you rehome a connectivity, you alter one of its endpoints. This action may be necessary for load balancing purposes or due to the removal or replacement of devices and interfaces. For more information, see UIM Concepts. The groom feature can also be used for:
- Moving customer connections to different network nodes to improve service quality.
- Physically relocating network devices to different location.
- Switching network services from one provider to another.
- Shifting network resources, such as IP addresses or bandwidth, to different parts of the network.
Rehoming a facility requires changes to the termination of the facility itself and to any channels it provides. Channels are re-terminated on sub-device interfaces provided by the new device interface on which the facility is terminated.
UIM exposes a Rehome API over REST protocol. Network Integrity detects such port change discrepancies for each connectivity facility and generates a Rehome request and invokes Rehome endpoint of UIM. Upon receiving the rehome request, UIM immediately acknowledges with a 202 response and processes it in the background. Network Integrity then regularly checks UIM for a Rehome response and addresses the discrepancies accordingly.
For more information on how to invoke Rehome REST APIs, see REST API for Unified Inventory Management.
A default API is introduced within the DiscrepancyHandler interface of the UIM_Integration_Cartridge, which takes a collection of discrepancies (such as missing or extra pipe or PTP entities) as input, as shown below. The design path can be modified by making device changes or termination point changes on one side.
The input to the API is passed from the oracle.communications.integrity.uim.resolutionprocessors.base.BaseResolutionElement class within the UIM_Integration_Cartridge. This class contains the capability to group discrepancies respective to the missing or extra entities for each result group.
The below out of the box reconciliation handler has the logic to rehome DWDM layers.
Action → Resolve TMF814 Topological Links Circuit Stitching in UIM
Processor → TMF814 Circuit Stitching Resolution Initializer
Class → oracle.communications.integrity.uim.resolutionprocessors.uimresolutioninitializer.entityHandlers.circuitstitching.CSPipeTerminationPointHandler .
Method → public void handleDiscrepancyRehome(Discrepancy missingEntity, Discrepancy extraEntity)
Note:
For rehome scenarios, Entity- and Entity+ discrepancies need to be submitted together for processing.Using the Cartridge
To use the Oracle Communications Network Integrity Multi-Domain Circuit Topology Stitching Reconciliation cartridge, see the following topics:
- Creating an Import TMF814 Links Circuit Stitching from UIM Scan
- Creating an Import TMF814 Links Circuit Stitching from UIM Incremental Scan
- Detect Discrepancy of Links Circuit Stitching
- Resolve TMF814 Topological Links Circuit Stitching in UIM
For the discovery and reconciliation of Topological link device physical hierarchies, see Network Integrity Optical TMF814 CORBA Cartridge Guide and Network Integrity Optical UIM Integration Cartridge Guide.
Note:
Property Locations and Network Entity Codes must be loaded into UIM before reconciling physical layer data.
Creating an Import TMF814 Links Circuit Stitching from UIM Scan
To create an Import TMF814 Links Circuit Stitching scan:
- Create a new scan.
For more information, see Network Integrity Online Help.
-
On the General tab, do the following:
- From the Scan Action list, select Import TMF814 Links
Circuit Stitching.
The Scan Type field displays Import.
- Select Enabled.
- From the Scan Action list, select Import TMF814 Links
Circuit Stitching.
-
Enter the following circuit stitching scan parameters:
- In the Nms Vendor Name field, enter the name of the NMS vendor.
- In the Nms Circle Name field, enter the identifier of the NMS circle.
- Perform any other required configurations.
- Save and run the scan.
Creating an Import TMF814 Links Circuit Stitching from UIM Incremental Scan
To create an Import TMF814 Links Circuit Stitching Incremental Scan:
Note:
Before creating a scan, check if the NMS Listener is configured for the EMS system and is able to populate notifications in Network Integrity notification related tables.- Create a new scan.
For more information, see Network Integrity Online Help
- On the General tab, do the following:
- From the Scan Action list, select Import TMF814 Links Circuit
Stitching from UIM.
The Scan Type field displays Import.
- Select Enabled.
- From the Scan Action list, select Import TMF814 Links Circuit
Stitching from UIM.
- Enter the following incremental scan parameters: (Only required for
incremental discovery)
- Select the Incremental Scan checkbox to perform incremental discovery.
- In the Nms Notification Vendor field, enter the NMS vendor name.
- In the Nms Notification Circle field, enter the identifier of the NMS circle.
- In the Nms Notification Count field, enter the count of notifications to be processed.
- Perform any other required configurations.
- Save and run the scan.
Filtering DWDM Data
You can filter data during discovery and import scans by defining the Nms Notification Vendor and Nms Notification Circle parameters. This ensures that only data matching these criteria will be available in the scan results. When reconciling this data with UIM, the topological link will include both vendor and circle as characteristics.
To reconcile data based on vendor and circle parameters:
- Create a Circuit Stitching import scan with the requisite Nms Notification Vendor and Nms Notification Circle parameter values and run the scan.
- Create a Circuit Stitching discovery scan with the requisite Nms
Notification Vendor and Nms Notification Circle parameter values and
run the scan with discrepancy detection enabled.
Note:
Ensure that the Nms Vendor and Nms Circle parameter values entered in both import and discovery scans are the same. - Perform reconciliation of discovered data.
- Verify the reconciled data by using the same Nms Notification Vendor and Nms Notification Circle parameter values.
- Run the Import Scan.
- Run the Discovery Scan.
Detect Discrepancy of Links Circuit Stitching
The Multi-Domain Circuit Topology Stitching Reconciliation cartridge allows you to detect and resolve discrepancies between your discovered data and your imported UIM data circuit discrepancies. When you resolve a discrepancy, the resolution is submitted to UIM by Network Integrity. For more information about working with discrepancies, see Network Integrity Online Help.
Discrepancies on optical entities must be resolved in a specific order:
-
Begin by detecting and resolving discrepancies on link entities.
-
When the Optical UIM Integration cartridge is deployed to your run-time application, you can use Network Integrity for:
-
Detect Discrepancy of Links Circuit Stitching
-
The following procedure describes the steps to populate UIM with the network data discovered by the Discover TMF814 Links Circuit Stitching discovery action.
To populate UIM with the discovered network data:
-
Create a new scan.
For more information, see Network Integrity Online Help.
-
On the General tab, do the following:
-
From the Scan Action list, select Discover TMF814 Links Circuit Stitching.
The Scan Type field displays Discovery.
-
Select the Detect Discrepancies checkbox.
-
In the Scan Action Parameters area, perform any necessary additional configurations.
-
-
Save and run the discovery scan.
The scan generates Entity+ discrepancies for each discovered device.
Resolve TMF814 Topological Links Circuit Stitching in UIM
For reconciliation of discovered devices, the network location and network entity codes for the devices must be present in UIM beforehand.
All devices are linked with the network location and the network entity code that can be verified from discovery result. If both the characteristics are not present in UIM, the devices discovered will not be reconciled.
For more information on creating bulk network location and network entity codes in UIM, see UIM System Administrator's Guide.
-
Review the scan results for a scan that was run with Detect Discrepancies enabled.
-
On the Scan Details page, click Review Discrepancies.
-
Right-click on the discrepancy to be resolved and select Resolve TMF814 Topological Links Circuit Stitching in UIM.
-
Click Submit.
If the status is successful, then the topological link is created in UIM and linked to the network location and network entity code.
About Cartridge Modeling
This section describes how the Network Integrity Multi-Domain Circuit Topology Stitching Reconciliation cartridge is modeled in Design Studio.
About the Oracle Communications Information Model
All entities in the Optical UIM Integration cartridge comply with the Oracle Communications Information Model 8.0 for static fields. The dynamic fields (sometimes referred to as characteristics) are application-specific.
This involves first modeling the inventory (UIM) specifications in an inventory cartridge using Design Studio so that the Discovery model is converted into a UIM model. Next, you must define the cartridge dependency so that the Network Integrity cartridge is dependent on the inventory cartridge. Finally, the inventory cartridge specifications can be used in the Network Integrity cartridge model.
Reconciling Scans into UIM
You need to convert the discovery scan results (in the Discovery model) into the reconciliation model (UIM model) to be reconciled into the inventory system.
During reconciliation, all discovered topological links are created as Connectivities in UIM. The specification for these newly created UIM Connectivities is set as Channelized Connectivity. Furthermore, the end points of the topological links are mapped to the Pipe Termination Points of the linked device interfaces (STM16, STM64, STM1, OTU4, ODU4, etc.) in UIM.
Table 2-1 describes the mapping between the discovery models and the reconciliation models.
Table 2-1 Discovery Model to UIM Reconciliation Model
| Discovery Model | UIM Model |
|---|---|
| TopologicalLink is modeled as pipe of spec topologicalLink | topologicalLink is created as Channelized Connectivity |
| TopologicalLink aEnd and Zend is modeled as Pipe Termination Point of spec portTerminationPoint | portTerminationPoint is present as Device Interface of Device (STM16, STM64, STM1, OTU4, ODU4, etc) |
Table 2-2 describes the attribute mapping for the Channelized Connectivity in the reconciliation model.
Table 2-2 Attribute Mapping for the Channelized Connectivity Object
| Information Model Attribute in Discovery Model | Information Model Support in UIM | Type |
|---|---|---|
| description | Static | Text |
| gapPipe | Static | Boolean, always set to True. |
| id | Static |
Text The value is derived. Possible values are PRIMARY, BACKUP. |
| medium | Static | Text |
| name | Static | Text |
| transmissionSignalType | Static | Text |
| versioned | Static | Boolean |
| aDeviceIPAddress | Chars | Text |
| aEndEMS | Chars | Text |
| aEndPoint | Chars | Text |
| associatedTrail | Chars | Text |
| circleName | Chars | Text |
| connectivityType | Chars | Text |
| consistentState | Chars | Text |
| customer | Chars | Text |
| directionType | Chars | Text |
| diverseRouteSearchEffort | Chars | Text |
| domain | Chars | Text |
| endPointA | Chars | Text |
| endPointACircle | Chars | Text |
| endPointANativeEmsName | Chars | Text |
| endPointZ | Chars | Text |
| endPointZCircle | Chars | Text |
| endPointZNativeEmsName | Chars | Text |
| hangingType | Chars | Text |
| inconsistencyReason | Chars | Text |
| layerRate | Chars | Text |
| linkCost | Chars | Text |
| linkCreationDate | Chars | Text |
| linkDistance | Chars | Text |
| linkName | Chars | Text |
| linkQuality | Chars | Text |
| linkType | Chars | Text |
| numberOfDiverseRoutes | Chars | Text |
| protection | Chars | Text |
| ringName | Chars | Text |
| sourceOfTL | Chars | Text |
| srlgDetails1 | Chars | Text |
| srlgDetails2 | Chars | Text |
| srlgDetails3 | Chars | Text |
| status | Chars | Text |
| technology | Chars | Text |
| tlName | Chars | Text |
| trailId | Chars | Text |
| trailName | Chars | Text |
| VCATSize | Chars | Text |
| Vendor | Chars | Text |
| zDeviceIPAddress | Chars | Text |
| zEndEMS | Chars | Text |
| zEndPoint | Chars | Text |
Discovery Model to UIM Reconciliation Model
Table 2-3 Discovery Model to UIM Reconciliation Model
| Discovery Model | UIM Model |
|---|---|
| Channelized Connectivity | Channelized Connectivity is mapped to pipe of spec topologicalLink. |
| Device Interface of Device. any one of them (STM16, STM64, STM1, OTU4, ODU4 etc) | Device Interface of Device is mapped as Pipe Termination Point of spec portTerminationPoint. |
Table 2-4 Attribute Mapping for the topologicalLink Object
| Information Model Attribute | Information Model Support | Typre |
|---|---|---|
| description | Static | Text |
| gapPipe | Static | Boolean, always set to True. |
| id | Static |
Text The value is derived. Possible values are PRIMARY, BACKUP. |
| medium | Static | Text |
| name | Static | Text |
| transmissionSignalType | Static | Text |
| versioned | Static | Boolean |
| aDeviceIPAddress | Chars | Text |
| aEndEMS | Chars | Text |
| aEndPoint | Chars | Text |
| associatedTrail | Chars | Text |
| circleName | Chars | Text |
| connectivityType | Chars | Text |
| consistentState | Chars | Text |
| customer | Chars | Text |
| directionType | Chars | Text |
| diverseRouteSearchEffort | Chars | Text |
| domain | Chars | Text |
| endPointA | Chars | Text |
| endPointACircle | Chars | Text |
| endPointANativeEmsName | Chars | Text |
| endPointZ | Chars | Text |
| endPointZCircle | Chars | Text |
| endPointZNativeEmsName | Chars | Text |
| hangingType | Chars | Text |
| inconsistencyReason | Chars | Text |
| layerRate | Chars | Text |
| linkCost | Chars | Text |
| linkCreationDate | Chars | Text |
| linkDistance | Chars | Text |
| linkName | Chars | Text |
| linkQuality | Chars | Text |
| linkType | Chars | Text |
| numberOfDiverseRoutes | Chars | Text |
| protection | Chars | Text |
| ringName | Chars | Text |
| sourceOfTL | Chars | Text |
| srlgDetails1 | Chars | Text |
| srlgDetails2 | Chars | Text |
| srlgDetails3 | Chars | Text |
| status | Chars | Text |
| technology | Chars | Text |
| tlName | Chars | Text |
| trailId | Chars | Text |
| trailName | Chars | Text |
| VCATSize | Chars | Text |
| Vendor | Chars | Text |
| zDeviceIPAddress | Chars | Text |
| zEndEMS | Chars | Text |
| zEndPoint | Chars | Text |
Table 2-5 Model Mapping for the PipeTerminationPoint Object
| Information Model Attribute | Information Model Support | Typre |
|---|---|---|
| name | Static |
Text The name of the PTP (port) cross-connect endpoint. |
| id | Static | Text |
| description | Static | Text |
| device | Dynamic | Text |
| directionality | Dynamic | Text |
| rate | Dynamic |
Text This value is derived from the line layer rate for the endPort represented by the PortTerminationPoint. |
| channel | Dynamic |
Text This attribute is not used. |
About Design Studio Construction
This section describes how the Network Integrity Multi-Domain Circuit Topology Stitching Reconciliation cartridge is built from the Design Studio perspective.
Model Collections
Model Collections shows the Connectivity specifications.
Table 2-6 Connectivity Specifications
| Specification Name | UIM Entity Type |
|---|---|
| Channelized Connectivity | Connectivity |
| Topological Link | Pipe |
| Port | PipeTerminationPoint |
Actions
Table 2-7 outlines the Design Studio construction of the Multi-Domain Circuit Topology Stitching Reconciliation cartridge actions.
Table 2-7 Actions of Design Studio Construction
| Action | Result Category | Address Handler | Scan Parameter Groups | Processors |
|---|---|---|---|---|
| Detect Discrepancy of Links Circuit Stitching | TopologicalLink | N/A | N/A |
Circuit Stitching TL DD Filters Discrepancy Detector |
| Import TMF814 Links Circuit Stitching from UIM | TopologicalLink | N/A |
FilterLinks IncrementalScanParameter |
ProcessScanFilterUIM Collect Links Model Links |
| Resolve TMF814 Topological Links Circuit Stitching in UIM | TopologicalLink | N/A | N/A |
UIM Resolution Framework Initializer UIM Resolution Initializer TMF814 Circuit Stitching Resolution Initializer UIM Resolution Framework Dispatcher |
Scan Parameter Groups
Scan Parameter Groups contains information about the scan parameters in Design Studio for the Multi-Domain Circuit Topology Stitching Reconciliation cartridge.
Table 2-8 FilterLinks Scan Parameter Group
| Parameter | Description | Filter Links |
|---|---|---|
| circleName | NMS Circle identifier | Nms Circle Name |
| vendorName | NMS Vendor identifier | Nms Vendor Name |
Network Integrity System Configuration for Circuit Stitching
You can customize the circuit stitching functionality by using the following properties included in the system-config.properties file located in the domain_home/ni/config directory.
Table 2-9 Network Integrity System Configuration Properties for Circuit Stitching
| Property Name | Default Value | Expected Value |
|---|---|---|
| circuit.stitching.batch.size | 500 | This numeric count (in minutes) defines how many CORBA element will be fetched from CORBA at one go. The maximum value for this property is 5000. |
| circuit.stitching.discovery.task.timeout | 60 | This numeric value (in minutes) defines the timeout of collector task from CORBA. The maximum value for this property is 180. |
| circuit.stitching.single.modelling.task.timeout | 5 | This numeric value (in minutes) defines the timeout of one topological link modeling task. The maximum value for this property is 30. |
| circuit.stitching.complete.modelling.task.timeout | 120 | This numeric value (in minutes) defines the timeout to complete topological link modeling task. The maximum value for this property is 720. |
| circuit.stitching.unknown.device.identifier | UME | UME Identification :
LSN:NMS/UME_BARODA_DWDM14-1236718543956
Here, the identifier is UME. |
| circuit.stitching.unknown.device.matching.operation | afterumeidentifierIndex | The expected value for this property is afterumeidentifierIndex, beforeumeidentifierIndex, or removeumeidentifier. |
Note:
- Unknown device identification is a critical feature of circuit stitching. You can customize the functionality provided.
- If you customize the functionality, you must do it in the oracle.communications.integrity.abstractcorbacartridge.network.ume.UMEManager class.