The file parser processor moves files from a remote location to a Network Integrity file system using FTP or SFTP protocols. The file parser processor can also be used to access files that are on a file system that is shared by all the nodes in a Network Integrity cluster.
The file parser processor can be used in discovery, import, and assimilation actions.
File transfer processors generate collections of Java file objects as output context parameters. These parameters are pointers to local file system versions of the transferred files. All subsequent processors in the parent action have access to the files retrieved by the file parser processor.
File transfer processors can retrieve parameter values from the following sources:
From scan parameter groups: When the Parameter Source field is set to the Scan Parameter Group option, the file parser processor parameter values are set by the Network Integrity user in the UI.
From context parameters: When the Parameter Source field is set to the Context Parameter option, the file parser processor parameter values are inherited from predecessor processors in the sequence of processors in the action.
For more information about file transfer, see Network Integrity File Transfer and Parsing Guide.
About Network Integrity Processors
Configuring Network Integrity File Transfer Processors
This procedure assumes that the file parser processor has already been created and added to an action. You cannot configure the file parser processor unless it belongs to an action. See "Creating Network Integrity Processors" and "Adding Existing Processors to Network Integrity Actions" for more information.
To configure a file parser processor:
On the Processor editor File Transfer tab, specify the input parameter source by doing one of the following:
To inherit input parameters from a predecessor processor in the sequence of processors in the action, specify the Context Parameter option.
A predecessor processor sets file transfer context parameter values. For more information about file transfer context parameters, see "Configuring File Transfer Properties for Network Integrity File Transfer Processors".
To allow Network Integrity users to specify the input parameters in the UI, specify the Scan Parameter Group option and do one of the following:
To select an existing scan parameter group, click Select.
To create a new scan parameter group, click Scan Parameter Group.
Design Studio builds the new scan parameter group using information from the Network Integrity SDK cartridge.
See "About FTP Characteristics for Network Integrity File Transfer Processors" for more information about the input parameters for configuring file transfer processors from the Network Integrity UI.
Configure the address parameter.
See "Configuring the Address Parameter for Network Integrity File Transfer Processors" for more information.
Configure the file transfer properties.
See "Configuring File Transfer Properties for Network Integrity File Transfer Processors" for more information.
Add context parameters.
See "About Context Parameters for Network Integrity Processors" for more information.
Save the processor.
About Network Integrity Processors
About the Network Integrity File Transfer Processor
Network Integrity Processor Editor
The following table lists the default and required input parameters for configuring file transfer processors from the Network Integrity UI.
| Characteristic Name | Default | Mandatory | Description |
|---|---|---|---|
| ftaFileTransferType | FTP | Yes | Indicates how files should be transferred (FTP, SFTP, Local).
Note: Do not add or remove options or the file parser processor will have errors. |
| ftaFilePattern | N/A | No | A pattern to match file names. The pattern supports wildcard characters. The supported wildcard characters are the asterisk, percent, and underscore. The asterisk and percent represent a match of zero or more characters, while the underscore represents a match of a single character. Wildcard characters can be escaped with a slash \. |
| ftaPort | N/A | No | The port used to connect to the remote server. If not specified, defaults to 21 for FTP and 22 for SFTP. |
| ftaUser | N/A | No | The user name to connect to the remote location. |
| ftaPassword | N/A | No | The password to connect to the remote location. |
| ftaSessionTimeOut | 60 | No | The amount of time, in seconds, before an idle connection times out. The valid range is from 1 to 3600. |
| ftaSourceFileManagement | Rename | No | Indicates the action to take on source files when the file transfer is complete. Options are Delete, Rename, Nothing.
Note: Do not add or remove options or the file parser processor will have errors. |
| ftaRenameSuffix | Processed | No | The suffix to add to the source file if the ftaSourceFileManagement is set to Rename. |
The address parameter indicates the host and directory to retrieve the files from. It must be in the format host/directory for FTP or SFTP transfer types, where host can be an IPv4 or IPv6 address, or a host name, and directory is a file path, for example, 10.10.10.10/tmp/files.
For local file system transfer types, the address field holds the directory name only. The directory name must start with a slash. For example, /tmp/files.
To configure the Address Parameter:
On the Processor editor File Transfer tab, do one of the following:
To retrieve the address from the discovery action scope address defined in the Network Integrity UI, select the Use Scope Address check box.
This option is available only for discovery actions.
Click Select next to the Address Parameter field.
A dialog box opens, listing string-type parameters. Select the parameter representing the address and click OK.
If there are no string-type parameters, an error message appears.
About the Network Integrity File Transfer Processor
The file transfer context parameters are set in predecessor processors in the sequence of processors in the action so that some or all of the properties can be defined in the action. You can configure the action to specify all the file transfer properties programmatically, rather than requiring the user to enter values.
For example, when a processor at the beginning of an action calls an external system or device to generate a file containing device data, the processor triggers the generation of a file, and then programmatically sets the file transfer properties with information such as file name pattern and the directory where the file can be found.
To select the file transfer context parameters:
Click the Processor editor File Transfer tab for the file parser processor.
In the Input Parameters area, click Select.
The Select Output Parameter dialog box appears listing, oracle.communications.sce.integrity.sdk.fileTransfer context parameters output by predecessor processors in the sequence of processors in the action. If there are no available context parameters, an error message appears.
Select a parameter.
Click OK.
About the Network Integrity File Transfer Processor