The SDH UIM Integration cartridge supports modeling of SDH connectivities such as Topological Link, Trail, and Tunnel. It also supports modeling of service managing these connectivities.

The SDH UIM Integration cartridge provides the following:

• Import: Retrieves the SDH connectivities, service, and circuit information from UIM and model it in the Oracle Communications Information Model.
• Perform Incremental Import along with the notifications in the database.
• Discrepancy Detection: Compares the imported UIM data with discovered SDH connectivities and service and reports any differences.
• Resolution: Resolves discrepancies on connectivities, service, and circuits by correcting entities, associations, and attributes in UIM.

This section provides information on dependencies that the SDH UIM Integration cartridge has on other entities.

To review and extend the SDH UIM Integration cartridge, you must download the Oracle Communications SDH UIM Integration Cartridge software from the Oracle software delivery web site: https://edelivery.oracle.com

The software contains the SDH UIM Integration cartridge ZIP file, which has the following structure:

• \UIM_Cartridge_Projects\

• \Network_Integrity_Cartridge_Projects\

See Design Studio Online Help and Oracle Communications Network Integrity Developer's Guide for information about opening files in Design Studio.

See Design Studio Online Help for information about building and deploying cartridges.

The Abstract SDH Service Actions is an abstract action that interacts with UIM to fetch the devices associated with SDH connectivities and model the Service.

The Import SDH Connectivity and Service From UIM action extends the Abstract Optical Import From UIM to fetch the logical device details which are used to fetch the associated connectivities and service from UIM.

The Incremental Import SDH Connectivity and Service From UIM action extends the Abstract Optical Import From UIM and performs Incremental Import for connectivities and service from UIM.

The Detect Discrepancies for SDH Connectivity and Service action detects discrepancies between discovery scan results of Discover SDH Connectivity and Service action and data imported from UIM.

This discrepancy detection action extends the Discrepancy Detection action from the NetworkIntegritySDK cartridge and inherits all its processors.

The Detect Discrepancies for SDH Connectivity and Service action contains the following processors run in the following order:

1. DD Filters Initializer

2. Discrepancy Detector (inherited)

The Resolve SDH Connectivity and Service in UIM action resolves discrepancies between discovery scan results of Discover SDH Connectivity and Service action and data imported from UIM.

This discrepancy resolution action extends the Abstract Resolve in UIM action from the UIM Integration cartridge and inherits all its processors. For information about the inherited processors, see Network Integrity UIM Integration Cartridge Guide.

The Resolve SDHConnectivity and service in UIM action contains the following processors run in the following order:

1. UIM Resolution Framework Initializer (inherited)
2. UIM Resolution Initializer (inherited)
3. Optical Resolution Initializer
4. UIM Resolution Framework Dispatcher (inherited)

Grooming a connectivity is changing the design path of a connectivity by either changing segment's channel within a facility or to a channel from different facility. For example, when you groom a SDH Trail connectivity, you change the VC12 channel within same STM16 facility or to a VC12 channel from different STM4/STM16 facility.

The groom feature can also be used for:

• Reallocating bandwidth to ensure optimal usage
• Consolidating traffic to make better use of high-capacity links
• Upgrading equipment with newer, more capable devices

Grooming frequently happens due to network modifications that introduce new routes or render existing ones less effective. For example, the addition of new devices to a network might cause existing routes to have unacceptable number of hops. Planning and management procedures identify such scenarios and recommend more efficient routing adjustments through grooming. For more information, refer to "Maintaining Channelized Connectivity and Network Resources" in UIM Concepts Guide.

UIM exposes a Groom API via the REST protocol. Network Integrity identifies design path discrepancies for each connectivity rider, triggering a groom request and calling UIM's Groom endpoint. Upon receiving the groom request, UIM promptly acknowledges it with a 202 response and processes it in the background. Network Integrity then regularly checks UIM for a Groom response and addresses the discrepancies accordingly.

For more information on how to invoke Groom 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 collections of discrepancies (such as attribute mismatches, missing or extra pipe segments) and the reference pipe entity (either trails or tunnels) as inputs, as shown below. Reconciliation handler classes can be used to override this API.

For SDH or Ethernet networks, groom can be used on trail or tunnel connectivities by modifying the necessary segments, or changing channels within existing segments.

public default void handleDiscrepancyGroom(Collection<DisDiscrepancy> missingEntity, Collection<DisDiscrepancy> extrEntity, Collection<DisDiscrepancy> attributeMismatch, Pipe pipe) {
    }

The input to the API is passed from the oracle.communications.integrity.uim.resolutionprocessors.base.BaseResolutionElement class within the UIM_Integration_Cartridge. This class has the logic to group discrepancies respective to the attribute mismatches, missing or extra entities, and reference root entities for each result group.

The oracle.communications.integrity.sdhuim.resolutionprocessors.opticalresolutioninitializer.CircuitHandler OOB reconciliation handler has the logic to Groom SDH connectivities.

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 "Maintaining Channelized Connectivity and Network Resources" in UIM Concepts Guide.

The groom feature can also be used for:

• Moving customer connections to different network nodes to improve service quality
• Physical moving 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. You can use reconciliation handler classes to override this API.

For SDH or Ethernet networks, rehome can be used on topological link, trail or tunnel pipes by modifying device changes or termination point changes on one side.

public default void handleDiscrepancyRehome(DisDiscrepancy missingEntity, DisDiscrepancy extrEntity){
    }

The input to the API is passed from the oracle.communications.integrity.uim.resolutionprocessors.base.BaseResolutionElement class within the UIM_Integration_Cartridge. This class has the logic to group discrepancies respective to the attribute mismatches, missing or extra entities, and reference root entities for each result group.

The following OOB reconciliation handlers have the logic to rehome SDH connectivities:

• oracle.communications.integrity.sdhuim.resolutionprocessors.opticalresolutioninitializer.CircuitHandler – When a pipe entity’s identifier changes due to change on one side of the device or termination point, a discrepancy is generated on the pipe entity. This handle is invoked for such discrepancies.

• oracle.communications.integrity.sdhuim.resolutionprocessors.opticalresolutioninitializer.PipeTerminationPointHandler – When a pipe entity's identifier stays unique even when one side of the device or termination point changes, then discrepancies are recorded at the Pipe's termination point. This handler is invoked for such discrepancies.

The Import SDH Connectivity and Service From UIM scan is used to import and model connectivities such as Topological Links, Trails, Tunnels, and Services.

To create an Import SDH Connectivity and Service From UIM scan:

1. Create a new scan.

   See Network Integrity Online Help for more information.

2. On the General tab, do the following:
   • From the Scan Action list, select Import SDH Connectivity and Service From UIM.

     The Scan Type field displays Import

   • In the Scan Action Parameters section, SDH Import Parameters is selected by default.
   • (Optional) Enter the required parameters of the logical device and service parameters.
3. Save and run the scan.

Figure 2-1 Creation of an Import SDH Connectivity and Service from UIM scan

Description of "Figure 2-1 Creation of an Import SDH Connectivity and Service from UIM scan"

The Incremental Import SDH Connectivity and Service From UIM scan is used to import and model connectivities such as Topological Links, Trails, Tunnels, and Services using NMS notifications.

To create an Incremental Import SDH Connectivity and Service From UIM scan:

1. Create a new scan.

   See Network Integrity Online Help for more information.

2. On the General tab, do the following:

   • From the Scan Action list, select Incremental Import SDH Connectivity and Service From UIM.

     The Scan Type field displays Import

   • In the Scan Action Parameters section, SDH Incremental Import Parameters is selected by default.
   • Enter the required parameters.
3. Save and run the scan.

Figure 2-2 Creation of an Incremental Import SDH Connectivity and Service from UIM scan

Description of "Figure 2-2 Creation of an Incremental Import SDH Connectivity and Service from UIM scan"

This procedure describes how to process UIM with network data discovered by the Discover SDH Connectivity and Service discovery action.

To process UIM with discovered network data:

1. Create a new scan.

   See Network Integrity Online Help for more information.

2. On the General tab, do the following:
   • From the Scan Action list, select Discover SDH Connectivity and Service.

     The Scan Type field displays Discovery.

   • Select Detect Discrepancies.
   • In the Scan Action Parameters section, SDH File Parameters is selected by default.
   • Enter the FTP related parameters.
   • From the Scan Action Parameters list, select SDH Device Parameters.
   • Select the type of entities to model and the required filters such as Name, ID, Device Name, and so on.
   • Enter the Circle Name and Vendor name.
   • If Incremental Discovery is to be performed, select Incremental Discovery from the Scan Action Parameters list. Select Incremental Discovery option and the type of entities to be modeled.
3. On the Scope tab, specify path to the file directory.
4. Save and run the scan.
5. Using UIM, create the required Logical Devices with Optical Logical Device specification from ora_ni_uim_sdh_optical.
6. Create a new scan.

   See Network Integrity Online Help for more information.

7. On the General tab, do the following:
   • From the Scan Action list, select Import SDH Connectivity and Service From UIM.

     The Scan Type field displays Import

   • In the Scan Action Parameters section, SDH Import Parameters is selected by default.
   • Enter the required parameters of the logical device created above.
8. Save and run the scan.

   The logical devices should be present as part of the scan result.

9. Run the discovery scan again.
10. The scan generates Entity+ discrepancies for each discovered device.
11. Right-click on the discrepancies you want to populate in UIM and select Correct SDH Connectivity and Service in UIM.
12. Click Submit.
13. Verify that UIM displays the discovered data.

Description of the illustration searchresults_uim_with_discoveredsdh.png

This procedure describes steps to synchronize UIM with network data using NMS Notifications and incremental scans.

To populate UIM with discovered network data:

1. Populate the NMSNotification table in the database with the record of SDH Connectivities and set the status is set to INITIAL.

2. Create a new scan.

   See Network Integrity Online Help for more information.

3. On the General tab, do the following:

   • From the Scan Action list, select Incremental Import SDH Connectivity and Service From UIM.

     The Scan Type field displays Import.

   • In the Scan Action Parameters section, SDH Incremental Import Parameters option is selected by default. Enter the required parameters

4. Save and run the scan.

   The connectivities present in UIM will be imported to NI and the status of the records will be changed to IMPORTED.

5. On the General tab, do the following:

   • From the Scan Action list, select Discover SDH Connectivity and Service.

     The Scan Type field displays Discovery.

   • Select Detect Discrepancies.
   • In the Scan Action Parameters section, SDH File Parameters option is selected by default. Enter the FTP related parameters.
   • Click on the Scan Action Parameters drop down and select SDH Device Parameters. Enter the Circle Name and Vendor name.
   • From the Scan Action Parameters drop down, select Incremental Discovery.
   • Select the Incremental Discovery option and the type of entities to be modelled.

6. On the Scope tab, specify path to the file directory.

7. Save and run the scan.

   The SDH connectivities present in the database are discovered as per the input files and the status of the records will be changed to DISCOVERY_SUCCESSFULL. The scan generates discrepancies as per the two previous scans.

8. Right-click on the discrepancies you want to populate in UIM and select Correct SDH Connectivity and Service in UIM.

9. Click Submit.

10. Verify that UIM is populated with the required data.

You must first model inventory (UIM) specifications in an inventory cartridge using Design Studio, define the cartridge dependency such that the Network Integrity cartridge is dependent on the inventory cartridge, and then use the inventory cartridge specifications in the Network Integrity cartridge model.

Specifications shared with Oracle Communications Unified Inventory Management (UIM) are defined in the SDH_Service_Model and ora_ni_uim_sdh_optical cartridges. These cartridges are used to directly deploy specifications to UIM.

The following table shows the list of specifications.

The following table shows the SDH UIM Cartridge model collection.

SDH UIM Cartridge supports the following import actions.

Detect Discrepancies for SDH Connectivity and Service is the action you use to perform Discrepancy detection.

Resolve SDH Connectivity and Service in UIM is the action you use to perform Discrepancy Resolution.