5 About Cartridge Modeling

This chapter provides information on how imported data is modeled.

About Cartridge Modeling

To facilitate discrepancy detection and resolution, the Oracle Communications Network Integrity MSS Integration cartridge models the imported data from Oracle Communications MetaSolv Solution (MSS) to the Oracle Communications Information Model.

The MSS Integration cartridge uses different modeling logic depending on the action it is performing. See the following sections for more information:

About Import Data Modeling
About Discrepancy Resolution Modeling

About Import Data Modeling

This section explains how Network Integrity models data imported from MSS.

You can configure various parameters in the Network Integrity UI to determine the quantity of data to import from MSS. Network Integrity logically applies the parameters to filter the imported data. When no filtering parameters are configured in the UI, Network Integrity imports all MSS data.

API Mapping

Network Integrity uses APIs to map the imported MSS data to the Information Model, which allows the MSS data to map directly to TMF814 entities. The MSS Integration cartridge uses TMF814 specifications to model the MSS data.

Table 5-1 shows the relationship between the imported MSS data, physical TMF814 entities, and physical Information Model entities.

Table 5-1 MSS Data Modeling to the Physical Information Model Tree

MSS Data Object	TMF814 Entity	Information Model Entity
Network Node	Managed Element (ME)	Physical Device, Logical Device
Equipment	Equipment Holder (Rack)	Equipment
Equipment	Equipment Holder (Shelf)	Equipment
Equipment	Equipment Holder (Sub-Shelf)	Equipment
Mounting Position	Equipment Holder (Slot)	Equipment Holder
Mounting Position	Equipment Holder (Sub-Slot)	Equipment Holder
Equipment	Equipment (Card)	Equipment
Port	Physical Termination Point (PTP)	Physical Port

Table 5-2 shows the relationship between the imported MSS data, logical TMF814 entities, and logical Information Model entities.

Table 5-2 MSS Data Modeling to the Logical Information Model Tree

MSS Data	TMF814 Entity	Information Model Entity
Network Node from EXTRACT.MV_EQUIPMENT	ME	LogicalDevice
Port from EXTRACT.MV_PORT_ADDRESS	Point Termination Port (PTP) and Floating Termination Point (FTP)	DeviceInterface
(Port) Circuit and (Rack/Shelf) Circuit from EXTRACT.V_PA_HIER	Connection Termination Point (CTP)	DeviceInterface
N/A	LayeredParameters	DeviceInterfaceConfigurationItem

Field Mapping

The following tables explain the field mappings for each imported MSS object.

Table 5-3, "Physical Device Field Mapping"
Table 5-4, "Root Equipment Field Mapping"
Table 5-5, "Non-Root Equipment Field Mapping"
Table 5-6, "Equipment Holder Field Mapping"
Table 5-7, "Physical Port Field Mapping"
Table 5-8, "Logical Device Field Mapping"
Table 5-9, "Media Interface Field Mapping"
Table 5-10, "Pipe Field Mapping"
Table 5-11, "Transport Pipe Field Mapping"
Table 5-12, "STM Link Field Mapping"
Table 5-13, "Trail Path Field Mapping"
Table 5-14, "Trail Pipe Field Mapping"
Table 5-15, "Pipe Termination Point Field Mapping"

Table 5-3 Physical Device Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
Id	Static	EXTRACT.MV_EQUIPMENT.NETWORK_NODE_ID/EXTRACT.MV_NETWORK_NODE.NETWORK_NODE_ID	No
name	Static	EXTRACT.V_EQUIPMENT.NW_NODE_NAME/EXTRACT.MV_NETWORK_NODE.NETWORK_NODE_NAME	No
description	Static	N/A	No
discoveredVendorName	Dynamic	EXTRACT.V_EQUIPMENT_SPEC.VENDOR_NAME	No
serialNumber	Static	EXTRACT.MV_EQUIPMENT.SERIAL_NBR	No
physicalLocation	Static	EXTRACT.V_EQUIPMENT.LOC_ID_CLLI_CODE/V_NETWORK_NODE.CLLI_CODE	No
softwareRev	Dynamic	EXTRACT.MV_EQUIPMENT.SOFTWARE_RELEASE_IDENTIFIER	No
modelName	Dynamic	EXTRACT.MV_EQUIPMENT_SPEC.EQUIPSPEC_TYPE/V_NETWORK_NODE.NST_COMP_TYPE	No
nativeEmsName	Static	EXTRACT.V_EQUIPMENT.NW_NODE_NAME/ EXTRACT.MV_NETWORK_NODE.NETWORK_NODE_NAME	No
userLabel	Dynamic	EXTRACT.V_EQUIPMENT.NW_NODE_NAME/ EXTRACT.MV_NETWORK_NODE.NETWORK_NODE_NAME	No
owner	Dynamic	EXTRACT.V_EQUIPMENT_SPEC.VENDOR_NAME	No

Table 5-4 Root Equipment Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
Id	Static	EXTRACT.V_EQUIPMENT.EQUIPMENT_ID	No
name	Static	EXTRACT.MV_EQUIPMENT_SPEC.EQUIPMENT_ACRONYM	No
description	Static	N/A	No
discoveredVendorName	Dynamic	EXTRACT.V_EQUIPMENT_SPEC.VENDOR_NAME	Yes
serialNumber	Static	EXTRACT.MV_EQUIPMENT.SERIAL_NBR	Yes
physicalLocation	Static	EXTRACT.V_EQUIPMENT.LOC_ID_CLLI_CODE	No
discoveredPartNumber	Dynamic	EXTRACT.MV_EQUIPMENT_SPEC.VENDOR_PART_NUMBER	Yes
hardwareRev	Dynamic	EXTRACT.MV_EQUIPMENT.VERSION_OF_HARDWARE_INSTALLED	No
modelName	Dynamic	EXTRACT.MV_EQUIPMENT_SPEC.EQUIPSPEC_TYPE	No
nativeEmsName	Static	EXTRACT.MV_EQUIPMENT_SPEC.EQUIPMENT_ACRONYM	No
expectedObjectType	Dynamic	N/A	No
serviceState	Dynamic	EXTRACT.MV_EQUIPMENT.AVAILABILITY_STATUS Valid values are IN_SERVICE, OUT_OF_SERVICE, IN_MAINTENANCE, UNKNOWN, TESTING	No
userLabel	Dynamic	EXTRACT.MV_EQUIPMENT.EQUIPMENT_NAME	No
owner	Dynamic	EXTRACT.MV_EQUIPMENT_SPEC.VENDOR_NAME	No

Table 5-5 Non-Root Equipment Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
Id	Static	Derived From EQUIP_ID_2_HIER with mounting_position_seq	No
name	Static	Derived from EXTRACT.V_MP_HIER.EQUIPMENT_ACRONYM_HIER	No
description	Static	N/A	No
discoveredVendorName	Dynamic	Derived from EXTRACT.V_MP_HIER.VENDOR_NAME_HIER	No
serialNumber	Static	Derived from EXTRACT.V_MP_HIER.SERIAL_NBR_HIER	Yes
physicalLocation	Static	EXTRACT.V_EQUIPMENT.LOC_ID_CLLI_CODE This field value corresponds to the root equipment.	No
discoveredPartNumber	Dynamic	Derived from EXTRACT.V_MP_HIER.VENDOR_PART_NUMBER_HIER	Yes
hardwareRev	Dynamic	N/A	Yes
modelName	Dynamic	Derived from EXTRACT.V_MP_HIER.EQUIPSPEC_TYPE_HIER	No
nativeEmsName	Static	Derived from EXTRACT.V_MP_HIER.EQUIPMENT_ACRONYM_HIER	No
expectedObjectType	Dynamic	N/A	No
serviceState	Dynamic	EXTRACT.V_MP_HIER.AVAILABILITY_STATUS_HIER This field is assigned one of the following values: IN_SERVICE, OUT_OF_SERVICE, IN_MAINTENANCE, UNKNOWN, TESTING.	No
userLabel	Dynamic	Derived from EXTRACT.V_MP_HIER.EQUIPMENT_NAME_HIER	No
owner	Dynamic	Derived from EXTRACT.V_MP_HIER.VENDOR_NAME_HIER	No

Table 5-6 Equipment Holder Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
Id	Static	Derived From EQUIP_ID_2_HIER with mounting_position_seq	No
name	Static	Derived from V_MP_HIER.EQUIPMENT_ACRONYM_HIER The slot number is equivalent to mounting position number.	No
description	Static	N/A	No
serialNumber	Static	N/A	No
physicalLocation	Static	N/A	No
modelName	Dynamic	EXTRACT.MV_EQUIPMENT_SPEC.EQUIPSPEC_TYPE	No
nativeEmsName	Static	Derived from V_MP_HIER.EQUIPMENT_ACRONYM_HIER	No
userLabel	Dynamic	Derived from V_MP_HIER.EQUIPMENT_NAME_HIER	No
owner	Dynamic	Derived from V_MP_HIER.VENDOR_NAME_HIER	No

Table 5-7 Physical Port Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
Id	Static	Derived with parent-id from EXTRACT.MV_PORT_ADDRESS.PORTADDR_SEQ	No
name	Static	Derived from EXTRACT.MV_PORT_ADDRESS.PORTADDR_SEQ	Yes
description	Static	N/A	No
portNumber	Static	N/A	No
customerPortName	Static	N/A	No
vendorPortName	Static	N/A	No
serialNumber	Static	N/A	No
physicalLocation	Static	N/A	No
nativeEmsName	Static	N/A	No
direction	Dynamic	Bidirection	No
tpProtectionAssociation	Dynamic	N/A	No
edgePoint	Dynamic	True	No
physicalAddress	Static	EXTRACT.MV_PORT_ADDRESS.NODE_ADDRESS when EXTRACT.MV_PORT_ADDRESS.PORTADDR_TYPE value corresponds to physical	No

Table 5-8 Logical Device Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
Id	Static	N/A	No
name	Static	EXTRACT.V_EQUIPMENT.NW_NODE_NAME	Yes
description	Static	N/A	No
specification	Static	N/A	No
nativeEmsAdminServiceState	Static	N/A	No
nativeEmsServiceState	Static	N/A	No
physicalLocation	Static	EXTRACT.V_EQUIPMENT.LOC_ID_CLLI_CODE	No

Table 5-9 Media Interface Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
Id	Static	N/A	No
name	Static	Derived from EXTRACT.MV_PORT_ADDRESS.PORTADDR_SEQ	No
description	Static	N/A	No
ifType	Static	PTP, FTP, or CTP, according to the entity being modeled	No
interfaceNumber	Static	N/A	No
customerInterfaceNumber	Static	N/A	No
vendorInterfaceNumber	Static	N/A	No
nativeEmsName	Static	N/A	No
nativeEmsAdminServiceState	Static	N/A	No
nativeEmsServiceState	Static	N/A	No
mtuSupported	Static	N/A	No
mtuCurrent	Static	N/A	No
physicalAddress	Static	N/A	No
physicalLocation	Static	N/A	No
minSpeed	Static	N/A	No
maxSpeed	Static	N/A	No
nominalSpeed	Static	N/A	No
connectionState	Dynamic	EXTRACT.MV_CIRCUIT.STATUS	No
tpMappingMode	Dynamic	N/A	No
Direction	Dynamic	Bidirection	No
tpProtectionAssociation	Dynamic	N/A	No
edgePoint	Dynamic	N/A	No
userLabel	Dynamic	N/A	No
owner	Dynamic	N/A	No
activeEmsConnectorPresent	Static	N/A	No

Table 5-10 Pipe Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
name	Static	V_CIRCUIT.EXCHANGE_CARRIER_CIRCUIT_ID	Yes
Id	Static	EXTRACT.MV_CIRCUIT.CIRCUIT_DESIGN_ID	No
gapPipe	Static	Hard-coded to FALSE	No
physicalLocation	Static	EXTRACT.V_CIRCUIT.LOC_A_CLLI_CODE	No
layerRate	Dynamic	EXTRACT.MV_CIRCUIT.RATE_CODE	No
Rerouted	Dynamic	Hard-coded to FALSE	No
partial	Dynamic	Derived: set to FALSE if the number of ports is greater than one, else it is TRUE.	No

Table 5-11 Transport Pipe Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
name	Static	V_CIRCUIT.EXCHANGE_CARRIER_CIRCUIT_ID	Yes
Id	Static	EXTRACT.MV_CIRCUIT.CIRCUIT_DESIGN_ID	No
gapPipe	Static	Hard-coded to FALSE	No
physicalLocation	Static	EXTRACT.V_CIRCUIT.LOC_A_CLLI_CODE	No
layerRate	Dynamic	EXTRACT.MV_CIRCUIT.RATE_CODE	No
Rerouted	Dynamic	Hard-coded to FALSE	No
partial	Dynamic	Derived: set to FALSE if the number of ports is greater than one, else it is TRUE.	No

Table 5-12 STM Link Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
name	Static	EXTRACT.V_CIRCUIT.EXCHANGE_CARRIER_CIRCUIT_ID	Yes
Id	Static	EXTRACT.MV_CIRCUIT.CIRCUIT_DESIGN_ID	No
gapPipe	Static	Hard-coded to FALSE	No
physicalLocation	Static	EXTRACT.V_CIRCUIT.LOC_A_CLLI_CODE	No
layerRate	Dynamic	EXTRACT.MV_CIRCUIT.RATE_CODE	No

Table 5-13 Trail Path Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
name	Static	EXTRACT.V_CIRCUIT_POSITION.EXCHANGE_CARRIER_CIRCUIT_ID	Yes
gapPipe	Static	Hard-coded to FALSE	No
layerRate	Dynamic	EXTRACT.V_CIRCUIT_POSITION.RATE_CODE	No
channel	Dynamic	EXTRACT.V_CIRCUIT_POSITION.JKLM	Yes

Table 5-14 Trail Pipe Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
name	Static	EXTRACT.V_CIRCUIT_POSITION.EXCHANGE_CARRIER_CIRCUIT_ID	Yes
AEnd	Static	Derived from the originating port name	No
ZEnd	Dynamic	Derived from the terminating port name	No
channel	Dynamic	EXTRACT.V_CIRCUIT_POSITION.JKLM	Yes

Table 5-15 Pipe Termination Point Field Mapping

Information Model Attribute	Information Model Support	MSS Inventory Field	Used for Discrepancy Detection
name	Static	Hierarchical name derived from of the following: EXTRACT.V_PA_HIER.EQUIPMENT_ACRONYM_HIER EXTRACT.V_PA_HIER.MTG_POS_NBR_HIER EXTRACT.V_PA_HIER.PORTADDR_SEQ	Yes
physicalLocation	Static	EXTRACT.V_PA_HIER.CLLI_CODE	No
Device	Dynamic	EXTRACT.V_PA_HIER.NW_NODE_NAME	Yes
Directionality	Dynamic	EXTRACT.V_PA_HIER.A_Z_OTHER_CD	Yes

Data Import Algorithm

This section explains the various algorithms and logic used to model the imported MSS inventory data.

Import Equipment Hierarchy Algorithm

This algorithm uses spring framework pagination to incrementally retrieve node names from each page created by the Page Creator processor. This algorithm uses the following logic:

Gets all the node names from EquipmentExportDAO.
For each node:
1. Creates a physical and logical device in the Information Model.
2. Gets the root equipment (such as a shelf, or rack) from EquipmentExportDAO.
For each root equipment:
1. Verifies that the occupiedMountingPositions attribute value is 0:
  - If yes, the equipment is modeled as a rack.
  - If no, verifies whether the root equipment has a mounting position. If there is a mounting position, the equipment is modeled as a shelf.
2. Associates the rack and shelf to the physical device and states the equipment type (rack or shelf) in the equipment name.
3. Retrieves the child equipment hierarchy from EquipmentPositionHierDAO (child equipment are represented as EquipmentPositionHier entities).
4. Queries the ports in the root equipment hierarchy from EquipmentPortAddressDAO (ports are represented as EquipmentPortAddress entities).
5. Creates a list that maps card IDs to their ports.
6. For each EquipmentPortAddress entity, verifies if leafEquipmentId equals EquipmentId.
  - If yes, models the port as a physical port (FTP) and associates it with the parent equipment. Models a media interface, associates it to the physical port, and sets the media interface as a child of the logical device.
  - If no, fills the card ID and all ports with the leafEquipmentId value as the list of associated ports.
7. Builds the child equipment hierarchy in the Information Model with the EquipmentPositionHier entities.
8. Saves the modeling information to the physical and logical trees.

Build Equipment Hierarchy Algorithm

The input for this algorithm is the list of EquipmentPositionHier entities and the map of cards-to-ports. Each EquipmentPositionHier is an immediate child (either a card or shelf) of the root equipment. This algorithm uses the following logic:

Gets the list of mounting position numbers down the hierarchy for each EquipmentPositionHier entity.
For each mounting position number:
1. Models a shelf object as an equipment entity if its parent is a rack object and the shelf is not yet built in this hierarchy and associates the child with its parent.
2. Models a card object as an equipment entity if the shelf is already built. Models a slot object as an equipment holder entity for the card. If the slot is already built, models a sub-slot object as an equipment holder entity. Associates children objects with their parent.
3. Gets the list of ports associated with the card from the map of cards-to-ports.
4. Models each port as a physical port and a media interface entity. Associates the media interface and the physical port with the logical device.
5. Adds the EquipmentPortAddressDAO entities to each port as a collection.

Import Circuit Hierarchy Algorithm

MSS and the MSS Integration cartridge distinguish between the following types of circuits:

STM (physical circuit, such as STM1 or STM4)
HOT (logical circuit, such as VC4)
LOP (logical circuit, such as E1, E3, or E4)

Table 5-16 shows the relationship between the imported MSS data, physical TMF814 entities, and physical Information Model entities.

Table 5-16 MSS Circuit Data Mapping to Information Model

MSS Data	TMF814 Entity	Information Model Entity
STM-Type Circuit	STM Link	Link
LOP-Type Circuit	Customer Circuit or LOP	Pipe
HOT-Type Circuit	HOT	Transport Pipe

MSS organizes logical circuits as children to physical circuits. The input for this algorithm is the list of EquipmentPortAddress entities produced by the Build Equipment Hierarchy algorithm. This algorithm uses the following logic:

For each port entity from the EquipmentPortAddress table:
1. Gets the CircuitPortAddress instance containing the circuit ID corresponding to an STM link passing through that port.
2. Queries the CircutExport table to get the STM link with the circuit ID.
3. Obtains the aPort and zPort for the STM link from the CircuitPortAddress table.
4. Models the STM link as an optical topological link entity, models its ports as pipe termination point entities, and associates the ports to their link.
5. Adds the modeled STM link circuit ID to the stmSet collection.
Identifies all VC4 HOT circuits for all the STM circuit IDs in the stmSet collection by querying the trail from CircuitPositionDAO. For each trail:
1. Identifies E4 customer circuits by counting its children in the CircuitPosition table. For each E4 customer circuit:
  - Queries the CircuitExport table for the circuit ID and models the CircuitExport objects as a pipe entities.
  - Queries the ports for the circuit from the CircuitPortAddress table, models them as PTPs, and associates them to their pipe entity.
  - Queries the trail path from the CircuitPosition table, models them as trail path entities, and associates them to their pipe entity.
  - Verifies the JKLM value for the trail path, and corrects it if necessary.
2. Identifies VC4 HOT circuits by evaluating the layer rate code. For each VC4 HOT circuit:
  - Models them as transport pipe entities.
  - Queries the CircuitExport table for circuit ID and models the CircuitExport object as a transport pipe entity.
  - Queries the parent STM link from the CircuitPosition table, and queries the STM link ports from the CircuitPortAddress table.
  - Determines the start-port and end-port from the STM link ports, models them as pipe termination points entities, and associates them to their transport pipe entity.
  - Queries the trail paths from the CircuitPosition table, models them as trail path entities, and associates them to their pipe entity.
3. Adds the modeled transport pipe circuit ID to the vc4sForLops list.
Queries E1 and E3 trail circuits for each VC4 circuit in the vc4sForLop list. For each trail circuit:
- Queries circuits from the CircuitExport table and models them as pipe entities.
- Queries customer circuit ports from the CircuitPortAddress table, models them as pipe termination point entities, and associates the ports to the pipe.
- Queries trail paths from the CircuitPosition table, models them as trail path entities, and associates them to the pipe.
- Verifies the JKLM value for the trail path, and corrects it if necessary.

About Discrepancy Resolution Modeling

The Discrepancy Resolution action uses different field mappings depending on the type of entity being resolved.

Discrepancy Resolution Field Mapping for Equipment

The MSS Integration cartridge uses MSS CORBA API methods to resolve equipment discrepancies. Each API method runs a Type Java object. Table 5-17 explains the field mapping for physical entities mapping to circuits in the Information Model.

Table 5-17 Equipment Resolution Field Mapping

MSS CORBA API	Information Model Attribute	API Type Field
MetaSolv.CORBA.WDIEquipmentTypes.EquipSpecQuery (Equipment entity)	discoveredVendorName discoveredPartNumber	Manufacturer partNumber
MetaSolv.CORBA.WDIEquipmentTypes_v2.EquipmentInstallation (Equipment entity)	serialNumber name serviceState hardwareRev	EquipmentModification.serialNumber startingMountingPosition (derived) Status ConfigurationModificationSeq.hardwareVersion
MetaSolv.CORBA.WDIEquipmentTypes_v2.EquipmentUpdate (Equipment entity)	serialNumber hardwareRev	EquipmentModification.serialNumber ConfigurationModificationSeq.hardwareVersion
MetaSolv.CORBA.WDIEquipmentTypes_v2.EquipInstallQuery (Equipment entity)	Name physicalLocation discoveredPartNumber modelName	acronym installedAtLocationCode partNumber type
MetaSolv.CORBA.WDIEquipmentTypes_v2.NetworkElementQuery (Equipment entity)	Name physicalLocation	Name networkLocation
MetaSolv.CORBA.WDIEquipmentTypes_v2.NetworkElementCreate (PhysicalDevice entity)	Name physicalLocation Description	Name locId Description
MetaSolv.CORBA.WDIEquipmentTypes_v2.NetworkElementResult (PhysicalDevice entity)	ID	networkNodeId
MetaSolv.CORBA.WDINetworkLocationTypes_v2.NetworkLocationQuery (PhysicalDevice entity)	physicalLocation	locationCode

Discrepancy Resolution Field Mapping for Circuits

Table 5-18 explains the field mapping for circuit entities mapping to circuits in the Information Model.

Table 5-18 Circuit Resolution Field Mapping

Information Model Entity	Information Model Attribute	Connection Field
Pipe	Specification Name	Ratecode
Pipe	Termination points	Ports
Pipe	Channel	Circuit positions
Pipe	PipeTerminationPoint.Originating.location	ALocation
Pipe	PipeTerminationPoint.Terminating.location	ZLocation