About Cartridge Modeling

Cartridge Representation

The following figure shows the object relationship being rendered for Optical Network Vendor Devices.

Description of the illustration img_cartridgerepresentation.png

Hierarchy Mapping

When a device is discovered, the media interface encapsulates common information about that interface. The device interface configuration captures the media type information that decorates the interface with media-specific parameters that define its behavior (that is; Generic, ATM, Frame Relay or VLAN). This cartridge supports only Generic.

Oracle Communications Information Model Information

All entities (for example, physical device, logical device, media interface, and so on) are Oracle Communications Information Model 1.0-compliant for static fields. The dynamic fields (sometimes referred to as characteristics) are application specific. You can customize application-specific data with the device interface configuration mechanism.

The Optical FTP Discovery Cartridge supports the following configuration:

Optical Generic Media

For the list of Information Model fields, see "Logical Mapping" and "Physical Mapping".

Specifications

This section lists the specifications included in the ora_ni_uim_device cartridge for Optical Network Vendor Devices.

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 ora_ni_uim_device cartridge. These cartridges are used to directly deploy specifications to UIM.

Physical Device

The following table shows the list of physical device specifications.

Table 4-1 Physical Device Specifications

Specification	Cartridge	Intended Usage
GenericPhysicalDeviceSpecification	ora_ni_uim_device	Used to model all types of Optical Network Vendor devices.

GenericPhysicalDeviceSpecification is available in ora_ni_uim_device and used to model all types of supported devices.

The following table shows the characteristics applied to the physical device specifications.

Table 4-2 Physical Device Characteristics

Characteristics	Field Type	Field Content
discoveredModelNumber	string	Text
discoveredPartNumber	string	Text
discoveredVendorName	string	Text
hardwareRev	string	Text
mgmtIpAddress	string	Text
nativeEmsName	string	Text
modelName	string	Text
owner	string	Text
softwareRev	string	Text
userLabel	string	Text

Equipment

The following table shows the list of Equipment specifications.

Table 4-3 Equipment Specifications

Specification	Cartridge	Intended Usage
GenericEquipmentShelfSpecification	ora_ni_uim_device	Used to model all types of supported devices.
GenericEquipmentSpecification	ora_ni_uim_device	Used to model all types of supported devices.

GenericEquipmentShelfSpecification and GenericEquipmentSpecification are available in ora_ni_uim_device and used to model all types of supported devices.

The following table shows the characteristics applied to the equipment specifications.

Table 4-4 Equipment Characteristics

Charecteristics	Field Type	Field Content
discoveredModelNumber	String	Text
discoveredPartNumber	String	Text
discoveredVendorName	String	Text
hardwareRev	String	Text
softwareRev	String	Text
modelName	String	Text
nativeEmsName	String	Text
owner	String	Text
userLabel	String	Text

Equipment Holder

The following table shows the list of Equipment Holder specifications.

Table 4-5 Equipment Holder Specifications

Specification	Cartridge	Intended Usage
GenericEquipmentHolderSpecification	ora_ni_uim_device	Used to model all types of Optical Network Vendor devices.

GenericEquipmentHolderSpecification is available in ora_ni_uim_device and used to model all type of supported devices.

The following table shows the characteristics applied to the equipment holder specifications.

Table 4-6 Equipment Holder Characteristics

Characteristics	Field Type	Field Content
modelName	String	Text
nativeEmsName	String	Text
discoveredVendorName	String	Text
owner	String	Text
userLabel	String	Text
direction	String	Text
edgePoint	String	Text
tpProtectionAssociation	String	Text

Physical Port

The following table shows the list of Physical Port specifications.

Table 4-7 Physical Port Specifications

Specification	Cartridge	Intended Usage
GenericPhysicalPortSpecification	ora_ni_uim_device	Used to model all types of Optical Network Vendor devices.

GenericPhysicalPortSpecification is available in ora_ni_uim_device and used to model all type of supported devices.

The following table shows the characteristics applied to the Physical Port specifications.

Table 4-8 Physical Port Characteristics

Characteristics	Field Type	Field Content
direction	String	Text
discoveredVendorName	String	Text
edgePoint	String	Text
nativeEmsName	String	Text
tpProtectionAssociation	String	Text
Port Type	String	Text
Port Level	String	Text

Logical Device

The following table shows the list of Logical Device specifications.

Table 4-9 Logical Device Specifications

Specification	Cartridge	Intended Usage
GenericLogicalDeviceSpecification	ora_ni_uim_device	Used to model all types of Optical Network Vendor devices.

GenericLogicalDeviceSpecification is available in ora_ni_uim_device and used to model all type of supported devices.

The following table shows the characteristics applied to the GenericLogicalDeviceSpecification.

Table 4-10 Logical Device Characteristics for GenericLogicalDeviceSpecification

Characteristics	Field Type	Field Content
mgmtIPAddress	String	Text
modelName	String	Text
nativeEmsName	String	Text
nativeEmsAdminServiceState	String	Text
nativeEmsServiceState	String	Text
owner	String	Text
sysObjectId	String	Text
userLabel	String	Text

Device Interface

The following table shows the list of Device Interface specifications.

Table 4-11 Device Interface Specifications

Specification	Cartridge	Intended Usage
GenericInterfaceSpecification	ora_ni_uim_device	Used to model all types of Optical Network Vendor devices.

GenericInterfaceSpecification is available in ora_ni_uim_device and used to model all type of supported devices.

The following table shows the characteristics applied to the GenericInterfaceSpecification specification.

Table 4-12 Device Interface Characteristics for GenericInterfaceSpecification Specification

Characteristics	Field Type	Filed Content
ifAlias	String	Text
ifName	String	Text
direction	String	N/A
edgePoint	Boolean	N/A
ifPromiscuousMode	Boolean	N/A
mtuCurrent	Long	N/A
mtuSupported	Long	N/A
nativeEmsAdminServiceState	String	Text
nativeEmsConnectorPresent	Boolean	N/A
nativeEmsName	String	Text
owner	String	Text
physicalAddress	String	Text
userLabel	String	Text

Specification Cardinality

The cardinality of all specification parent-child relationships is included in the software code so that min= 0 and max= n conditions are met. This approach allows Network Integrity to programmatically instantiate all objects on demand as they are discovered using the web service.

Equipment Visual Specifications

The visual facility on the Equipment specifications is not used. You can decide to upgrade the technology pack to provide visual effects to the UIM GUI for a given equipment entity.

Field Mapping

The Optical FTP Discovery Cartridge supports the following field mappings:

Text: Implies Text [255].
static: Information Model 1.0 defines this field to be static on the entity specification. The specification provides getters and setters for this field.
dynamic: This is a dynamic field where the entity specification considers the field as a name and value pair. The specification does not provide getters and setters but has a get and set characteristics method holding a HashSet of entries.
For Optical Network Device FTP, all characteristics are configured using the data retrieved from collected Files.

Logical Mapping

The Optical FTP Discovery Cartridge supports the following logical mappings:

Logical Device
Media Interface
Device Interface Configuration Item Mapping (Optical Generic Media)

Logical Device Mapping

The following table shows Logical Device Mapping.

Table 4-13 Logical Device Mapping

Characteristic	Information Model Support	Value	Field Type
Description	static	NeSubrackType(NE_REPORT)	Text
id	static	Programmatically generated as `Id::Name::"LogicalDevice"`	Text
Name	static	Name(NE_REPORT)	Text
NativeEMSName	static	Name(NE_REPORT)	Text

Media Interface Mapping

The following table shows Media Interface Mapping.

Table 4-14 Media Interface Mapping

Characteristic	Information Model Support	Value	Field Type
id	static	Programmatically generated as Id::Name::InterfaceName::ShelfNumber::SlotNumber::PortNumber	Text
Name	static	Interface Name (Interface_Resource_Report)	Text
description	static	Interface Description (Interface_Resource_Report)	Text
specification	static	Programmatically applies specification "GenericInterfaceSpecification".	N/A
interfaceNumber	static	N/A	Text
customerInterfaceNumber	static	N/A	Text
vendorInterfaceNumber	static	N/A	Text
nativeEmsName	static	Programmatically generated as Id::Name::InterfaceName::ShelfNumber::SlotNumber::PortNumber	Text
nativeEmsAdminServiceState	static	N/A	Enum with the following values: UNKNOWN IN_SERVICE OUT_OF_SERVICE TESTING IN_MAINTENANCE
nativeEmsServiceState	static	Status (Interface_Resource_Report)	Enum with the following values: UNKNOWN IN_SERVICE OUT_OF_SERVICE TESTING IN_MAINTENANCE
ifType	dynamic	Interface Type (Interface_Resource_Report)	Text
mtuSupported	static	N/A	Float
mtuCurrent	static	mtuCurrent (Interface_Resource_Report)	Float
physicalAddress	static	N/A	Text
physicalLocation	static	N/A	Text
minSpeed	static	N/A	Float
maxSpeed	static	N/A	Float
nominalSpeed	static	Speed (Interface_Resource_Report)	Float
ifAlias	dynamic	N/A	Text
ifName	dynamic	N/A	Text

Device Interface Configuration Item Mapping

The following table shows Device Interface Configuration Item Mapping.

Table 4-15 Device Configuration Item (IPv4) Mapping

Characteristic (Generic Media)	Information Model Support	Value	Field Type
ipAddress	dynamic	IPv4Address (Interface_Resource_Report)	Text
prefix	dynamic	N/A	Text
ipVersion	dynamic	Programmatically Generated as IPv4	Enum IPV4
specification	static	Programmatically applies Optical GenericMedia specification	N/A

Table 4-16 Device Configuration Item (IPv6) Mapping

Characteristic (Generic Media)	Information Model Support	Value	Field Type
ipAddress	dynamic	IPv6Address (Interface_Resource_Report)	Text
prefix	dynamic	N/A	Text
ipVersion	dynamic	Programmatically Generated as IPV6	Enum IPV6
specification	static	Programmatically applies Optical GenericMedia specification	N/A

Physical Mapping

The Optical FTP Discovery Cartridge supports the following physical mappings:

Physical Device
Equipment Shelf
Equipment Holder
Equipment Card
Physical Port

Physical Device Mapping

The following table shows Physical Device mapping.

Table 4-17 Physical Device Mapping

Characteristic (Generic Physical Device Specification)	Information Model Support	Value	Field Type
SoftwareRev	dynamic	SoftwareRev(NE_REPORT)	Text
PhysicalLocation	static	Location(PHYSICAL_LOCATION_FILE)	Text
NativeEMSName	static	Name(NE_REPORT)	Text
Name	static	Name(NE_REPORT)	Text
ModelName	dynamic	NeType(NE_REPORT)	Text
id	static	Programmatically generated as Id::Name::"PhysicalDevice"	Text
DiscoveredVendorName	dynamic	Set to "opticalVendor"	Text
Description	static	NeSubrackType(NE_REPORT)	Text

Equipment Shelf Mapping

The following table shows Equipment Shelf mapping.

Table 4-18 Equipment Shelf Mapping

Characteristic (GenericEquipmentSheflSpecification)	Information Model Support	Value	Field Type
id	static	Programmatically generated as Type(SUBRACK_REPORT)	Text
Name	static	Programmatically generated as Type(SUBRACK_REPORT)	Text
Description	static	Description(SUBRACK_REPORT) \| Subnet(SUBRACK_REPORT)	Text
NativeEmsName	static	Programmatically generated as Type(SUBRACK_REPORT)	Text
PhysicalLocation	static	PhysicalLocation(PHYSICAL_LOCATION_FILE)	Text
ModelName	dynamic	Set to "OPTICAL-SHELF"	Text
DiscoveredVendorName	dynamic	Set to "opticalVendor"	Text
DiscoveredPartNumber	dynamic	Programmatically generated as Type(SUBRACK_REPORT)	Text

Equipment Holder Mapping

The following table shows Equipment Holder mapping.

Table 4-19 Equipment Holder Mapping

Characteristic (GenericEquipmentHolderSpecification)	Information Model Support	Value	Field Type
id	static	Programmatically generated	Text
Name	static	Programmatically generated as `"slot=" SlotId(board)`	Text
NativeEMSName	static	Programmatically generated	Text
Owner	dynamic	Set to "opticalVendor"	Text

Equipment Card Mapping

The following table shows Equipment Card mapping.

Table 4-20 Equipment Card Mapping

Characteristic (GenericEquipmentCardSpecification)	Information Model Support	Value	Field Type
id	static	Programmatically generated	Text
Name	static	Name (BOARD_REPORT)	Text
Description	static	Description (BOARD_REPORT)	Text
NativeEMSName	static	Programmatically generated	Text
SerialNumber	static	Programmatically generated using SerialNo (BOARD_REPORT)	Text
PhysicalLocation	static	PhysicalLocation(PHYSICAL_LOCATION_FILE)	Text
ModelName	dynamic	Set to "OPTICAL-CARD"	Text
DiscoveredPartNumber	dynamic	Type (BOARD_REPORT)	Text
HardwareRev	dynamic	HardwareRev (BOARD_REPORT)	Text
DiscoveredVendorName	dynamic	Set to "opticalVendor"	Text
Owner	dynamic	Set to "opticalVendor"	Text

Physical Port Mapping

The following table shows Physical Port mapping.

Table 4-21 Physical Port Mapping

Characteristic (GenericPhysicalPortSpecification)	Information Model Support	Value	Field Type
id	static	Programmatically generated	Text
Name	static	Name (PORT_REPORT)	Text
Description	static	PortNeType (PORT_REPORT)	Text
NativeEMSName	static	Programmatically generated	Text
VendorPortName	static	Name (PORT_REPORT)	Text
PortNumber	static	PortNum (PORT_REPORT)	Text
Direction	dynamic	Set to "Bidirectional"	Text
EdgePoint	dynamic	Set to "true"	Text
Port Type	dynamic	Port Type (PORT_REPORT)	Text
Port Level	dynamic	Port Level (PORT_REPORT)	Text

About Design Studio Construction

This chapter provides information on the composition of the Oracle Communications Network Integrity Optical FTP Discovery Cartridge from the Oracle Communications Design Studio perspective.

The following table shows the Optical_FTP_Discovery_Cartridge model collection used in the Optical FTP Discovery cartridge.

Table 4-22 Optical_FTP_Discovery_Cartridge Model Collection

Specification	Information Model Entity Type	Intended Usage
GenericLogicalDeviceSpecification	LogicalDevice	Represents the root object discovered on the network for the devices. Logical Device Modeler models logical devices into GenericLogicalDeviceSpecification.
GenericPhysicalDeviceSpecification	PhysicalDevice	Represents any Optical Network Vendor Device discovered using FTP protocol.
GenericEquipmentHolderSpecification	EquipmentHolder	Represents any equipment container.
GenericEquipmentShelfSpecification	Equipment	Represents Chassis piece of equipment.
GenericEquipmentSpecification	Equipment	Represents Module piece of equipment.
GenericPhysicalPortSpecification	PhysicalPort	Represents any physical port.
GenericInterfaceSpecification	DeviceInterface	Represents interface discovered under GenericLogicalDeviceSpecification.

Logical Specification Lineage

The following example shows a logical specification lineage for Devices. This lineage shows the intended relationship between specifications.

Example 4-1 Logical Specification Lineage

GenericLogicalDeviceSpecification
    [0..*] GenericInterfaceSpecification
      [0..1] Optical Generic Media Configuration Item
          [0..1] Optical IP Addresses
              [0..*] Optical IP Address

Physical Specification Lineage

The following example shows a physical specification lineage for Devices. This lineage shows the intended relationship between specifications.

Example 4-2 Physical Specification Lineage

GenericPhysicalDeviceSpecification
     GenericEquipmentShelfSpecification
           [0..*] GenericEquipmentHolderSpecification
                   [0..1]  GenericEquipmentSpecification
                           [0..*] GenericEquipmentHolderSpecification
                                    [0..1]  GenericEquipmentSpecification
                                               [0..1]  GenericPhysicalPortSpecification

Discovery Action

Optical FTP Discovery Cartridge supports discovery action Discover optical Devices FTP.

The following table shows the discovery actions in the Optical FTP Discovery Cartridge.

Table 4-23 Discover optical Devices FTP

Result Category	Address Handler	Scan Parameters	Model	Processors
Device	FileTransferAddressHandler	Transfer Type File Pattern Port User Name Password Session Timeout Source File Management Rename Suffix Note: These scan parameters must be added for the Create Scan web service request even when the values are left empty.	Optical_FTP_Discovery_Cartridge	Optical File Transfer Collector Optical File Transfer Parser Optical File Transfer Device Modeler

Result Category

Address Handler

Scan Parameters

Model

Processors

Device

FileTransferAddressHandler

Transfer Type
File Pattern
Port
User Name
Password
Session Timeout
Source File Management
Rename Suffix

Note: These scan parameters must be added for the Create Scan web service request even when the values are left empty.

Optical_FTP_Discovery_Cartridge

Optical File Transfer Collector
Optical File Transfer Parser
Optical File Transfer Device Modeler

Discovery Processors

Table 4-24 Discover Optical Devices FTP Scan Action Processors

Processor Name	Variable
Optical File Transfer Collector	Input: N/A Output: OpticalFileTransferCollectorFileCollection Collection of files read from the scope provided.
Optical File Transfer Parser	Input: OpticalFileTransferCollectorFileCollection Output: neObjects Collection of device details
Optical File Transfer Device Modeler	Input: neObjects Output: N/A

Processor Name

Variable

Optical File Transfer Collector

Input: N/A

Output:

OpticalFileTransferCollectorFileCollection

Collection of files read from the scope provided.

Optical File Transfer Parser

Input:

OpticalFileTransferCollectorFileCollection

Output:

neObjects

Collection of device details

Optical File Transfer Device Modeler

Input: neObjects

Output: N/A

Discrepancy Detection Action

Detect Optical Device UIM Discrepancies is the action used to perform Discrepancy detection.

Table 4-25 Detect Optical Device UIM Discrepancies

Result Category	Results Score	Scan Parameters	Model	Processors
All	Discover optical Devices FTP	N/A	Optical_FTP_Discovery_Cartridge	This action extends the Abstract Detect UIM Discrepancies action included in the UIM Integration cartridge. See Network Integrity UIM Integration Cartridge Guide for more information.

Discrepancy Resolution Action

Resolve Optical Device in UIM is the action used to perform Discrepancy Resolution.

Table 4-26 Resolve Optical Device in UIM

Result Category	Result Score	Processor
All	Discover optical Devices FTP	This action extends the Abstract Resolve in UIM action included in the Network Integrity UIM Integration cartridge. See Network Integrity UIM Integration Cartridge Guide for more information.