1. Optical 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 Optical FTP Discovery Cartridge.

The Optical FTP Discovery Cartridge contains the following actions:

  • Discover optical Devices FTP
  • Detect Optical Device UIM Discrepancies
  • Resolve Optical Device in UIM

Discover optical Devices FTP

The Discover optical Devices FTP action retrieves Optical Network device data files using FTP protocol and provides a physical and logical device hierarchical model. This action models the associations between the physical and logical hierarchies.

The Discover optical Devices FTP action contains the following processors run in the following order:

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

Optical File Transfer Collector

Optical File Transfer Collector is a file transfer processor. See Oracle Communications Network Integrity File Transfer and Parsing guide for 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. The collection of files is used as input to the next processor Optical File Transfer 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. File Transfer Processor Scan Parameter Group is added as a scan parameter to Optical File Transfer Collector.

Table 2-1 Characteristics in the File Transfer Processor Scan Parameter Group

Parameter Default Value Mandatory Description
Transfer Type FTP Yes Select how files should be transferred: FTP, SFTP, Local.
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.
Port N/A No The port used to connect to the remote server. The default is 21 for FTP and 22 for SFTP.
User Name N/A No The user name to connect to the remote location.
Password N/A No The password to connect to the remote location.
Session Timeout 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.
Rename Suffix Processed No The suffix to add to the source file if the source file management characteristic has a value of Rename.

Optical File Transfer Parser

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

The properties file available in the cartridge Optical_FTP_Discovery_Cartridge/src/opticalfiles.properties contains key value pairs of file names that should be considered.

The sample opticalfiles.properties is as follows:

Key Board_REPORT_File_Name contains value Board_Report_. This specifies that the files with names starting with "Board_Report_" will be considered for discovery and modeling Boards. The same rule applies to all other types of files.

Optical File Transfer Parser processor generates collection of neObjects that contains device details.

NE_REPORT_FILE_NAME=NE_Report
SUBRACK_REPORT_FILE_NAME=Subrack_Report_
BOARD_REPORT_FILE_NAME=Board_Report_
PORT_REPORT_FILE_NAME=Port_Report_
PHYSICAL_LOCATION_FILE_NAME=Physical_Location
Scan Parameter Group

Additional filtering of devices based on Network Element Name and Network Element Type Name can be achieved using Optical Device Scan Parameters. This parameter group appears in Network Integrity as a scan parameter.

Table 2-2 Characteristics in the Optical Device Scan Parameters Group

Parameter Default Value Mandatory Description
networkElementName N/A No A pattern to match networkElementName. By default, it supports all deviceNames
networkElementQualifier N/A No

Select the matching Criteria for networkElementName :

  • Equals
  • Equals_Ignore_Case
  • Begins_With
  • Begins_With_Ignore_Case
  • Ends_with
  • Ends_with_Ignore_Case
  • Contains
  • Contains_Ignore_Case
  • Comma_Delimited_Names
  • Comma_Delimited_Names_Ignore_Case
networkElementType N/A No A pattern to match networkElementType. By default, it supports all deviceTypes
networkElementTypeQualifier N/A No

Select the matching Criteria for networkElementType :

  • Equals
  • Equals_Ignore_Case
  • Begins_With
  • Begins_With_Ignore_Case
  • Ends_with
  • Ends_with_Ignore_Case
  • Contains
  • Contains_Ignore_Case
  • Comma_Delimited_Names
  • Comma_Delimited_Names_Ignore_Case

Optical File Transfer Device Modeler

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

Detect Optical Device UIM Discrepancies

The Detect Optical Device UIM Discrepancies action detects discrepancies between discovery scan results of action Discover optical Devices FTP 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 Optical Device UIM Discrepancies action contains the following processors run in the following order:

  1. UIM Discrepancies Filter Initializer (inherited)

  2. Discrepancy Detector (inherited)

Resolve Optical Device in UIM

The Resolve Optical Device in UIM action resolves discrepancies on logical and physical hierarchies and associations between the 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 Optical Device in 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)