1. UIM Integration Cartridge Guide
  2. About Design Studio Construction

5 About Design Studio Construction

This chapter describes how the Oracle Communications Network Integrity UIM Integration cartridge is built from the Oracle Communications Design Studio perspective.

Actions

The following tables describe the Design Studio construction of actions and associated components in the UIM Integration cartridge.

Note:

Parameter values are case-sensitive and must be entered in capital letters when commands are run from a command-line interface.

Table 5-1 describes how actions in the UIM Integration cartridge are constructed in Design Studio.

Table 5-1 Design Studio Construction of Actions

Action Result Category Address Handler Scan Parameter Groups Processors

Abstract Import from UIM

Device

N/A

Parallel Process Parameters

See Network Integrity Developer's Guide for more information.

  • Import UIM Initializer

  • Logical Device UIM Finder

  • Physical Device UIM Finder

  • Logical Device UIM MultiThread Importer

  • Physical Device UIM MultiThread Importer

  • Logical Device UIM Importer

  • Linked Physical Device UIM Importer

  • Logical Device UIM Persister

  • Physical Device UIM Importer

  • Linked Logical Device UIM Importer

  • Physical Device UIM Persister

Import from UIM

Device

N/A

UIMImportParameters. See Table 5-6.

  • Processors inherited from the Abstract Import from UIM action

  • Scan Parameter UIM Initializer

Abstract Detect UIM Discrepancies

Device

N/A

N/A

  • Processors inherited from the Detect Discrepancies action

  • UIM Discrepancies Filter Initializer

Abstract Resolve in UIM

Device

N/A

N/A

  • UIM Resolution Framework Initializer

  • UIM Resolution Initializer

  • UIM Resolution Framework Dispatcher
Abstract Incremental Import from UIM Device N/A N/A

  • Processors inherited from the Abstract Import from UIM action

  • ME Names Collector

  • UpdateNotificationStatus
Incremental Import from UIM Device N/A UIMIncrementalImportParameters. See Table 5-5

  • Processors inherited from the Abstract Incremental Import from UIM action.

  • Incremental Scan Parameter UIM Initializer

Characteristics

Oracle Communications Unified Inventory Management (UIM) requires certain characteristics to model attributes that are native in Network Integrity. Some of these characteristics are part of UIM Integration, delivered in the ora_ni_uim_ocim cartridge. Other attributes are part of UIM, delivered in the ora_uim_model cartridge.

These characteristics have the Ignore Characteristic in Network Integrity tag. They appear as characteristics in UIM, but not in Network Integrity. The UIM Integration cartridge needs to handle these characteristics differently.

Table 5-2 shows UIM integration characteristics.

Table 5-2 UIM Integration Characteristics

Characteristic Source Enumerations

nativeEmsName

ora_ni_uim_ocim

N/A

nativeEmsAdminServiceState

ora_ni_uim_ocim

Available values:

  • UNKNOWN

  • IN_SERVICE

  • OUT_OF_SERVICE

  • TESTING

  • IN_MAINTAINANCE

nativeEmsServiceState

ora_ni_uim_ocim

Available values:

  • UNKNOWN

  • IN_SERVICE

  • OUT_OF_SERVICE

  • TESTING

  • IN_MAINTAINANCE

physicalLocation

ora_uim_model

N/A

ifType

ora_uim_model

N/A

minSpeed

ora_uim_model

N/A

maxSpeed

ora_uim_model

N/A

nominalSpeed

ora_uim_model

N/A

physicalAddress

ora_uim_model

N/A

mtuCurrent

ora_ni_uim_ocim

N/A

mtuSupported

ora_ni_uim_ocim

N/A

nativeEmsConnectorPresent

ora_ni_uim_ocim

N/A

serialNumber

ora_uim_model

N/A

To integrate Network Integrity cartridges with UIM and to include the attributes listed in Table 5-2, add the characteristics listed in the following table to your UIM cartridge specifications.

Table 5-3 displays characteristics that entities should include for integration with UIM.

Table 5-3 Characteristics for UIM Integration

UIM Entity Characteristics to Include

LogicalDevice

  • nativeEmsName

  • nativeEmsAdminServiceState

  • nativeEmsServiceState

  • physicalLocation

DeviceInterface

  • nativeEmsName

  • nativeEmsAdminServiceState

  • nativeEmsServiceState

  • physicalLocation

  • ifType

  • minSpeed

  • maxSpeed

  • nominalSpeed

If the Interface is to mimic a MediaInterface in Network Integrity, the following will also be required:

  • physicalAddress

  • mtuCurrent

  • mtuSupported

  • nativeEmsConnectorPresent

PhysicalDevice

nativeEmsName

Equipment

  • nativeEmsName

  • physicalLocation

EquipmentHolder

  • nativeEmsName

  • physicalLocation

PhysicalPort

  • nativeEmsName

  • physicalLocation

  • serialNumber

  • physicalAddress

Scan Parameter Groups

The Import from UIM action uses the UIMImportParameters scan parameter group. Table 5-4 outlines the Design Studio construction of this scan parameter group.

Table 5-4 UIMImportParameters Scan Parameter Group Design Studio Construction

Characteristic Name Parameter Type Description UI Label

adminState

Dropdown

The status of the device in the inventory system.

Inventory State

importLogicalDevices

Check box

Use this box to indicate whether to import logical devices. By default, this box is checked in the UI.

Import Logical Devices

importPhysicalDevices

Check box

Use this box to indicate whether to import physical devices. By default, this box is checked in the UI.

Import Physical Devices

logicalDeviceSpecification

String

The specification name(s) for logical devices. This field supports wildcard characters. Values are comma separated in case multiple specifications given.

Logical Device Specification

name

String

Use to filter imported devices by device name. This field supports wildcard characters.

Name

networkLocationEntityCode

String

The network or entity location code. This field supports wildcard characters.

Network/Entity Location

physicalDeviceSpecification

String

The specification name(s) for physical devices. This field supports wildcard characters. Values are comma separated in case multiple specifications given.

Physical Device Specification

The Incremental Import from UIM action uses the UIMIncrementalImportParameters scan parameter group. Table 5-5 outlines the Design Studio construction of this scan parameter group.

Table 5-5 UIMIncrementalImportParameters Scan Parameter Group Design Studio Construction

Characteristic Name Parameter Type Description UI Label
importLogicalDevices Check box Use this box to indicate whether to import logical devices. By default, this box is checked in the UI. Import Logical Devices
importPhysicalDevices Checkbox Use this box to indicate whether to import physical devices. By default, this box is checked in the UI. Import Physical Devices
nmsNotificationCircle String Use this field to provide NMS circle/oss name Nms Notification Circle
nmsNotificationVendor String Use this field to provide NMS vendor name Vendor
nmsNotificationCount Int Use this field to provide how many NMS notifications to be fetched Nms Notification Count

Processors

Table 5-6 describes how processors are constructed in Design Studio.

Table 5-6 Design Studio Construction of Processors

Processor Variable

Import UIM Initializer

Input: N/A

Output:

  • filters

  • uimImportContext

  • uimLogicalDeviceIDs

  • uimPhysicalDeviceIDs

Scan Parameter UIM Initializer

Input: filters

Output: N/A

Logical Device UIM Finder
Input:

  • filters

  • ldev

  • uimLDev

  • uimImportContext

  • uimLogicalDeviceIDs

  • uimPhysicalDeviceIDs

Physical Device UIM Finder
Input:

  • filters

  • uimImportContext

  • uimLogicalDeviceIDs

  • uimPhysicalDeviceIDs

Logical Device UIM Importer
Input:

  • filters

  • uimImportContext

  • uimLogicalDeviceID

  • uimPhysicalDeviceIDs

Output:

  • ldev

  • uimLDev

Linked Physical Device UIM Importer
Input:

  • filters

  • uimImportContext

  • uimLogicalDeviceID

  • uimPhysicalDeviceIDs

  • ldev

  • uimLDev

Output: pDev

Logical Device UIM Persister

Input: N/A

Output: N/A

Physical Device UIM Importer
Input:

  • uimImportContext

  • uimPhysicalDeviceID

Output: pDev

Physical Device UIM Persister

Input: N/A

Output: N/A

UIM Discrepancies Filter Initializer

Input: N/A

Output: N/A

Discrepancy Detector

Input: N/A

Output: N/A

UIM Resolution Framework Initializer

Input: N/A

Output:

  • baseResolutionElement

  • uimResolutionContext

UIM Resolution Initializer
Input:

  • baseResolutionElement

  • uimResolutionContext

Output: N/A

UIM Resolution Framework Dispatcher
Input:

  • baseResolutionElement

  • uimResolutionContext

Output: N/A
Logical Device UIM MultiThread Importer
Input:

  • filters

  • uimImportContext

  • uimLogicalDeviceIDs
Physical Device UIM MultiThread Importer
Input:

  • filters

  • uimImportContext

  • uimLogicalDeviceIDs

  • uimPhysicalDeviceIDs
Linked Logical Device UIM Importer
Input:

  • filters

  • uimImportContext

  • uimLogicalDeviceIDs

  • pdev

  • uimPDev
ME Names Collector

Input: incrementalimportScanParams

Output: meNames
UpdateNotificationStatus
Input:

  • incrementalimportScanParams

  • meNames
Incremental Scan Parameter UIM Initializer

Input: incrementalimportScanParams