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

2 About the Cartridge Components

This chapter provides information about the components of the Oracle Communications Network Integrity IMS Discovery cartridge.

The IMS Discovery Cartridge contains the following actions:

  • Discover IMS Network

  • Detect IMS UIM Discrepancies

  • Resolve IMS UIM

Discover IMS Network

The Discover IMS Network action scans devices and provides a physical and logical hierarchical model of what is discovered. This action also models the associations between the physical and logical hierarchies.

The Discover IMS Network action contains the following processors run in the following order:

IMS Network File Transfer

IMS Network File Transfer is a file transfer processor. See Network Integrity File Transfer and Parsing Guide for more information on File Transfer processors.

The file transfer processor outputs a single parameter. This output parameter holds a collection of file objects, each of which points to the local version of the transferred file. This collection of files is used as input to the next processor IMS Network File Parser.

The name of the output parameter is system-generated and based on the name of the file transfer processor. For example, the Sample File Transfer processor outputs sampleFileTransferFileCollection.

The type of the output parameter is always java.util.Collection<java.io.File>.

Scan Parameter Group

When a cartridge is deployed with scan parameter groups that are generated from a file transfer processor, they appear in the Network Integrity UI as scan parameters. IMS Network File Transfer Scan Parameters are added as scan parameter to IMS Network File Transfer processor.

Table 2-1 lists the scan parameters available during scan creation.

Table 2-1 Scan parameters available during scan creation

Parameter Default Value Mandatory Description
File Pattern N/A No

A pattern to match file names. The pattern supports wildcard characters. The supported wildcard characters are "*", "%", and "_". "*" and "%" represent a match of zero or more characters. "_" represents a match of any single character. Wildcard characters can be escaped with a backslash.
Password N/A No

The password to connect to the remote location.
Port N/A No

The port is used to connect to the remote server. The default is 21 for FTP and 22 for SFTP.
Rename Suffix processed No

The suffix to add to the source file if the source file management characteristic has a value of Rename.
Session Timeout (sec) 60 No

The amount of time in seconds before an idle connection is timed out. The valid range is from 1 to 3600.
Source File Management Rename No

Select the action to take on source files when the file transfer is complete. Options are: Delete, Rename, Nothing.
Transfer Type SFTP Yes

Select how files should be transferred: FTP, SFTP, Local.
User Name N/A No

The user name to connect to the remote location.

IMS Network File Parser

IMS Network File Parser is a discovery processor. This processor accepts the list of files from IMS Network File Transfer processor as an input and is used to parse files and collect required data.

Properties file available in cartridge: IMS_Discovery_Cartridge/src/imsnetworkfiles.properties contains key value pairs of file names that should be considered.

The sample imsnetworkfiles.properties is as follows: 

Board_Information_File_Name=Board_Information_
    Model_Information_File_Name=Model_Information_
    Frame_Information_File_Name=Frame_Information_
    Port_Information_File_Name=Port_Information_
    NE_Information_File_Name=NE_Information_
    Shelf_Information_File_Name=Shelf_Information_

Key Board_Information_File_Name contains value Board_Information_. This specifies that only files with names starting with "Board_Information_" will be considered for discovery and modeling Boards. The same rule is applicable for all other types of files as well.

IMS Network File Parser processor generates collection of frameObjects, neObjects, shelfObjects and portObjects as output.

IMS Network Device Modeler

IMS Network Device Modeler is a discovery processor. It accepts collection of objects generated by IMS Network File Parser as input. This processor models the collected data into physical and logical devices.

Detect IMS UIM Discrepancies

The Detect IMS UIM Discrepancies action detects discrepancies between discovery scan results of action Discover IMS Network and data imported from UIM.

This discrepancy detection action extends the Abstract Detect UIM Discrepancies 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 Detect IMS UIM Discrepancies action contains the following processors run in the following order:

  1. UIM Discrepancies Filter Initializer (inherited)

  2. Discrepancy Detector (inherited)

Resolve IMS UIM

The Resolve IMS UIM action resolves discrepancies on logical and physical hierarchies and associations between logical and physical entities in UIM.

The 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 IMS UIM action contains the following processors run in the following order:

  1. UIM Resolution Framework Initializer (inherited)

  2. UIM Resolution Initializer (inherited)

  3. UIM Resolution Framework Dispatcher (inherited)