1. IMS FTP Discovery and UIM Integration Cartridge Guide
  2. About Cartridge Modeling

4 About Cartridge Modeling

The Oracle Communications Network Integrity IMS Discovery Cartridge models collected data according to the Oracle Communications Information Model. Collected data is modeled into the following entities:

  • DeviceInterfaceConfiguration

  • DeviceInterfaceConfigurationItem

  • Equipment

  • EquipmentHolder

  • EquipmentEquipmentRel

  • EquipmentHolderEquipmentRel

  • LogicalDevice

  • MediaInterface

  • PhysicalDevice

  • PhysicalDeviceEquipmentRel

  • PhysicalPort

See Oracle Communications Information Model Reference for more information about the Information Model.

IMS Discovery Cartridge Representation

Figure 4-1 depicts the object relationship being rendered.

Figure 4-1 Diagram of Object Relationship being rendered


Description of Figure 4-1 follows
Description of "Figure 4-1 Diagram of Object Relationship being rendered"

Specifications

This section lists the specifications included in the ora_ni_uim_device for 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 cartridges. These cartridges are used to directly deploy specifications to UIM.

Physical Device

Table 4-1 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 devices.

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

Table 4-2 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

Table 4-3 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 devices.
GenericEquipmentSpecification ora_ni_uim_device Used to model all types of devices.

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

Table 4-4 shows the characteristics applied to equipment specifications.

Table 4-4 Equipment Characteristics

Characteristics 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

Table 4-5 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 devices.

Table 4-6 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

Physical Port

Table 4-7 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 devices.

Table 4-8 shows the characteristics applied to the physical port specifications.

Table 4-8 Physical Port Characteristics

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

Logical Device

Table 4-9 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 devices.

Table 4-10 shows the characteristics applied to the GenericLogicalDeviceSpecification specification.

Table 4-10 Logical Device Characteristics for GenericLogicalDeviceSpecification specification

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

Table 4-11 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 cyan devices.

Table 4-12 shows the characteristics applied to the GenericInterfaceSpecification specification.

Table 4-12 Device Interface Characteristics for GenericInterfaceSpecification Specification

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

Device Interface Configuration Item

Table 4-13 shows the list of device interface configuration item specifications.

Table 4-13 Device Interface Configuration Item Specifications

Specification Cartridge Intended Usage
IMS_Generic_Media IMS_Discovery_Cartridge Used to model Device Interface IPAdress Details.

Table 4-14 shows the characteristics applied to IMS_Generic_IpAddress device interface configuration item.

Table 4-14 Device Interface Configuration Item Characteristics for IMS_Generic_IpAddress

Characteristics (IMS_Generic_Media) Field Type Field Content
ipAddress String Text
prefix String Text
ipVersion Enum
  • IPV4
  • IPV6

Specification Cardinality

The cardinality of all specification parent-child relationships is included in the software code so that min= 0 and max= n. 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. The user may decide to enrich the technology pack to provide visual effects to the UIM GUI for a given Equipment entity.

Field Mapping

The IMS 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 treats the field as a name and value pair. The specification does not provide getters and setters but generically has get and set characteristics method holding a HashSet of entries.

Logical Mapping

The IMS Discovery cartridge supports the following logical mappings:

  • Logical Device

  • Media Interface

  • Device Interface Configuration Item Mapping (IMS_Generic_Media)

Logical Device Mapping

Table 4-15 Logical Device Mapping

Characteristic Information Model Type Value Field Type
id static Programmatically generated using neObject name and ipaddress Text
name static neObject name Text
Description static N/A Text
nativeEMSName static neObject name Text
mgmtIPAddress dynamic N/A Text
sysObjectId dynamic N/A Text
Specification static Programmatically applies GenericLogicalDevice specification. N/A
nativeEmsAdminServiceState static N/A

Enum with the following values:

  • UNKNOWN
  • IN_SERVICE
  • OUT_OF_SERVICE
  • TESTING
  • IN_MAINTENANCE
nativeEmsServiceState static N/A

Enum with the following values:

  • UNKNOWN
  • IN_SERVICE
  • OUT_OF_SERVICE
  • TESTING
  • IN_MAINTENANCE

Media Interface Mapping

Table 4-16 GenericInterfaceSpecification Device Interface Mapping

Characteristic Information Model Type Value Field Type
id static Programmatically generated using portObject Trunk_group_name Text
Name static portObject Trunk_group_name Text
description static N/A Text
specification static Programmatically applies specification "GenericInterfaceSpecification" . N/A
interfaceNumber static No source Text
customerInterfaceNumber static No source Text
vendorInterfaceNumber static ifName Text
nativeEmsName static Programmatically generated using portObject Trunk_group_name and port nativeEMSName Text
nativeEmsAdminServiceState static N/A

Enum with the following values:

  • UNKNOWN

  • IN_SERVICE

  • OUT_OF_SERVICE

  • TESTING

  • IN_MAINTENANCE
nativeEmsServiceState static N/A

Enum with the following values:

  • UNKNOWN

  • IN_SERVICE

  • OUT_OF_SERVICE

  • TESTING

  • IN_MAINTENANCE
ifType dynamic N/A Text
mtuSupported static Nothing available to source the field. Defaults to 0.0 Float
mtuCurrent static N/A Float
physicalAddress static N/A Text
physicalLocation static N/A Text
minSpeed static N/A Float
maxSpeed static N/A Float
nominalSpeed static N/A Float
ifAlias dynamic N/A Text
ifName dynamic N/A Text

Device Interface Configuration Item Mapping

Table 4-17 Device Configuration Item (IPv4) Mapping

Characteristic(IMS Generic Media) Information Model Type Value Field Type
ipAddress dynamic Programmatically generated using portObject Remote_URI Text
prefix dynamic Programmatically generated using portObject Second_Remote_URI Text
ipVersion dynamic Set to "IPV4"

Enum

  • IPV4

  • IPV6
specification static Programmatically applies IMS_Generic_Media specification N/A

Physical Mapping

The IMS Discovery cartridge supports the following physical mappings:

Physical Device

Table 4-18 Physical Device

Characteristic Information Model Type Value Field Type
id static Programmatically generated using neObject Name and ipaddress Text
name static neObject Name Text
description static N/A Text
nativeEMSName static neObject Name Text
physicalAddress static N/A Text
physicalLocation static N/A Text
specification static Programmatically set to GenericPhysicalDeviceSpecification N/A
discoveredPartNumber dynamic N/A Text
discoveredVendorNumber dynamic set to "IMS VENDOR" Text
discoveredModelNumber dynamic N/A Text
modelName dynamic Set to "IMS Device" Text
mgmtIPAddress dynamic N/A Text
hardwareRev dynamic N/A Text
owner dynamic N/A Text

Equipment Shelf

Table 4-19 Equipment Shelf

Characteristic Information Model Type Value Field Type
id static Programmatically generated using neObject Name and ipaddress and shelf frame number Text
name static Programmatically set to "shelf" + shelfObject Frame_number Text
description static N/A Text
nativeEMSName static Programmatically set to "shelf" + shelfObject Frame_number Text
specification static Programmatically set to "GenericEquipmentShelfSpecification" N/A
serialNumber static Programmatically set using partNumberMappings.properties file Text
discoveredPartNumber dynamic N/A Text
discoveredVendorName dynamic set to "IMS VENDOR" Text
modelName dynamic Set to "VOICE-SHELF" Text
discoveredModelNumber dynamic N/A Text
owner dynamic set to "IMS VENDOR" Text

Equipment Holder

Table 4-20 Equipment Holder

Characteristic Information Model Type Value Field Type
id static Programmatically generated using neObject Name and ipaddress and slot name. Text
name static Programmatically generated as "slot=" + boardObject slot number + boardObject location Text
nativeEMSName static Programmatically generated using boardObject frame number, board slot number and board location. Text
owner static Set to IMS VENDOR Text
specification static Programmatically set to "GenericEquipmentHolderSpecifcation" N/A
discoveredVendorName dynamic Set to "IMS VENDOR" Text
modelName dynamic N/A Text

Equipment Card

Table 4-21 Equipment Card

Characteristic Information Model Type Value Field Type
id static Programmatically generated using neObject Name and ipaddress and card name. Text
name static boardObject Board_type Text
nativeEMSName static Programmatically generated using board frame number, board slot number, board location and board type. Text
specification static Programmatically set to "GenericEquipmentSpecification" Text
serialNumber dynamic N/A Text
description dynamic N/A Text
discoveredVendorName dynamic Set to "IMS VENDOR" Text
discoveredModelNumber dynamic boardObject module number  
discoveredPartName dynamic Set based on partNumberMappings.properties and card name. Text
owner static Set to "IMS VENDOR" Text
modelName dynamic Set to "VOICE-CARD" Text
softwareRev dynamic Set to "IMS Module Name". Text
hardwareRev dynamic N/A Text
userLabel dynamic Set based on slot name Text

Physical Port

Table 4-22 Physical Port

Characteristic Information Model Type Value Field Type
id static Programmatically generated using neObject Name and ipaddress and portObject Trunk_No. Text
name static portObject Trunk_group_name Text
nativeEMSName static card nativeEMSName + portObject getTrunk_No Text
portNumber static portObject Local_server_port Text
vendorPortName static N/A Text
description static N/A Text
customerPortName static N/A Text
specification static Programmatically set to "GenericPhysicalPortSpecification" N/A
discoveredVendorName dynamic set to "IMS VENDOR" Text