JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Java CAPS Adapter for Batch User's Guide     Java CAPS Documentation
search filter icon
search icon

Document Information

Oracle Java CAPS Adapter for Batch User's Guide

About the Adapter for Batch

Batch Adapter OTDs

Additional Licensing Considerations

Installing the Batch Adapter

Batch Adapter System Requirements

Installing the Batch Adapter

Monitoring and Alerts

Using the Enterprise Manager

Installing Adapter Enterprise Manager plug-ins

Batch Adapter Alert Codes

Configuring the Batch Adapter

Creating and Configuring Batch Adapters

Selecting a Batch External Application

Modifying the Adapter Properties

Using the Properties Editor

Batch Adapter Properties

BatchFTP Adapter Connectivity Map Properties

Pre Transfer (BatchFTP Connectivity Map)

SOCKS (BatchFTP Connectivity Map)

FTP (BatchFTP Connectivity Map)

FTP Raw Commands (BatchFTP Connectivity Map)

Sequence Numbering (BatchFTP Connectivity Map)

Post Transfer (BatchFTP Connectivity Map)

Target Location (BatchFTP Connectivity Map)

SSH Tunneling (BatchFTP Connectivity Map)

Additional SSH-supporting Software

Port-forwarding Configuration

General Settings (BatchFTP Connectivity Map)

BatchFTP Adapter Environment Properties

SOCKS (BatchFTP Environment)

FTP (BatchFTP Environment)

General Settings (BatchFTP Environment)

SSH Tunneling (BatchFTP Environment)

Connection Pool Settings (BatchFTP Environment)

Connection Retry Settings (BatchFTP Environment)

BatchFTPOverSSL Adapter Connectivity Map Properties

Pre Transfer (BatchFTPOverSSL Connectivity Map)

FTP and SSL Settings (BatchFTPOverSSL Connectivity Map)

Post Transfer (BatchFTPOverSSL Connectivity Map)

Firewall Settings (BatchFTPOverSSL Connectivity Map)

Synchronization (BatchFTPOverSSL Connectivity Map)

BatchFTPOverSSL Adapter Environment Properties

FTP and SSL Settings (BatchFTPOverSSL Environment)

Firewall Settings (BatchFTPOverSSL Environment)

General Settings (BatchFTPOverSSL Environment)

Connection Pool Settings (BatchFTPOverSSL Environment)

Connection Retry Settings (BatchFTPOverSSL Environment)

BatchSCP Adapter Connectivity Map Properties

SCP Settings (BatchSCP Connectivity Map)

Firewall Settings (BatchSCP Connectivity Map)

Synchronization (BatchSCP Connectivity Map)

BatchSCP Adapter Environment Properties

SSH Settings (BatchSCP Environment)

Firewall Settings (BatchSCP Environment)

General Settings (BatchSCP Environment)

Connection Pool Settings (BatchSCP Environment)

Connection Retry Settings (BatchSCP Environment)

BatchSFTP Adapter Connectivity Map Properties

Pre Transfer (BatchSFTP Connectivity Map)

SFTP Settings (BatchSFTP Connectivity Map)

Post Transfer (BatchSFTP Connectivity Map)

Firewall Settings (BatchSFTP Connectivity Map)

Synchronization (BatchSFTP Connectivity Map)

BatchSFTP Adapter Environment Properties

SFTP Settings (BatchSFTP Environment)

Firewall Settings (BatchSFTP Environment)

General Settings (BatchSFTP Environment)

Connection Pool Settings (BatchSFTP Environment)

Connection Retry Settings (BatchSFTP Environment)

BatchLocalFile Connectivity Map Properties

Pre Transfer (BatchLocalFile Connectivity Map)

Sequence Numbering (BatchLocalFile Connectivity Map)

Post Transfer (BatchLocalFile Connectivity Map)

General Settings (BatchLocalFile Connectivity Map)

Target Location (BatchLocalFile Connectivity Map)

BatchLocalFile Environment Properties

General Settings (BatchLocalFile Environment)

Connection Pool Settings (BatchLocalFile Environment)

BatchRecord Connectivity Map Properties

General Settings (BatchRecord Connectivity Map)

Record (BatchRecord Connectivity Map)

BatchRecord Environment Properties

Connection Pool Settings (BatchRecord Environment)

BatchInbound Connectivity Map Properties

Settings (BatchInbound Connectivity Map)

BatchInbound Environment Properties

MDB Settings (BatchInbound Environment)

Using FTP Heuristics

FTP Heuristics

Platform Selection

IBM IP Stack Required for MVS Sequential, MVS GDG, and MVS PD

Creating User Defined Heuristic Directory Listing Styles

Considerations

Heuristics Configuration File Format

FTP Heuristics Configuration Parameters

Commands Supported by FTP Server

Header Lines To Skip

Header Indication Regex Expression

Trailer Lines To Skip

Trailer Indication Regex Expression

Directory Indication Regex Expression

File Link Real Data Available

File Link Indication Regex Expression

File Link Symbol Regex Expression

List Line Format

Valid File Line Minimum Position

File Name Is Last Entity

File Name Position

File Name Length

File Extension Position

File Extension Length

File Size Verifiable

File Size Position

File Size Length

Special Envelope For Absolute Path Name

Listing Directory Yields Absolute Path Names

Absolute Path Name Delimiter Set

Change Directory Before Listing

Directory Name Requires Terminator

FTP Configuration Requirements for AS400 UNIX (UFS)

Dynamic Configuration

Dynamic Configuration Sample

Dynamic Configurable Parameters for Secure FTP OTDs

Configuration Parameters that Accept Integer Values

Understanding Batch Adapter OTDs

Overview of the Batch OTDs

Types of Batch Adapter OTDs

OTD Functions

BatchFTP OTD

BatchFTP OTD Structure

Configuration Node

Client and Provider Nodes

BatchFTP OTD Node Functions

Using the BatchFTP OTD

Handling Type Conversions

Code Conversion and Generation

Type Conversion Troubleshooting

Essential BatchFTP OTD Methods

Sequence Numbering

Additional FTP File Transfer Commands

BatchFTPOverSSL OTD

BatchFTPOverSSL OTD Structure

BatchFTPOverSSL OTD Node Functions

Configuration Node

BatchFTPOverSSL Client Node

BatchSFTP OTD

BatchSFTP OTD Structure

BatchSFTP OTD Node Functions

Configuration Node

BatchSFTP Client Node

BatchSCP OTD

BatchSCP OTD Structure

BatchSCP OTD Node Functions

Configuration Node

BatchSCP Client Node

BatchLocalFile OTD

BatchLocalFile OTD Structure

Configuration Node

Client Node

BatchLocalFile OTD Node Functions

Using the BatchLocalFile OTD

BatchLocalFile Specific Features

Pre/Post File Transfer Commands

Pre Commands

Post Commands

Essential BatchLocalFile OTD Methods

Resume Reading Feature

General Operation

Step-by-step Operation

Operation Without Resume Reading Enabled

To Avoid Storing a Resume Reading State

Data Stream-Adapter Provider

Sequence Numbering

Generating Multiple Files with Sequence Numbering

Handling Type Conversions

Recommended Practice

Example 1: Parsing a Large File

Example 2: Slow, Complex Query

OTD Limitations

BatchRecord OTD

BatchRecord OTD Structure

OTD Structure and Operation

Record-processing OTD Node Functions

Using the Record-processing OTD

Using get() and put()

Choosing the Parse or Create Mode

Creating a Payload

Parsing a Payload

Fully Consuming a Payload

Using Record Processing with Data Streaming

BatchInbound OTD

BatchInbound OTD Structure

Using Regular Expressions

Regular Expressions: Overview

Entering Regular Expressions

Regular Expressions and the Adapter

Rules for Directory Regular Expressions

Restrictions for Using Regular Expressions as Directory Names

Regular Expression Directory Name Examples

Using Name Patterns

Types of Name Patterns

Resolving Names

Date/time Format Syntax

Additional Batch Adapter Features

What's in This Chapter

Streaming Data Between Components

Introduction to Data Streaming

Overcoming Large-file Limitations

Using Data Streaming

Data-streaming Operation

Data Streaming Versus Payload Data Transfer

Data Streaming Scenarios

Consuming-stream Adapters

Stream-adapter Interfaces

Inbound Transfers

Outbound Transfers

SOCKS FTP Support

SOCKS

SOCKS: Overview

SOCKS Proxy Server

SOCKS and the Batch Adapter

Negotiation Methods

SOCKS Configuration Properties

SSH Tunneling Support

SSH Tunneling: Overview

Additional Software Requirements

SSH Tunneling and the Batch Adapter

Enabling SSH Tunneling

Using an Existing Channel

Using an Internal Channel

Port-forwarding Configuration

SSH Tunneling Configuration Parameters

SSH Tunneling Support

This section explains the Batch Adapter’s Secure Shell (SSH) tunneling features. SSH tunneling is also called SSH port forwarding.

The Batch Adapter encrypts the command channel of FTP utilizing SSH. To encrypt data, you can encrypt a file prior to sending it, using your preferred method or that of the receiver. The received file can then be decrypted by the recipient. If Secure FTP (FTP over SSH or FTP over SSL) is required, use the Secure FTP OTDs ((BatchFTPOverSSL, BatchSFTP, and BatchSCP).

SSH Tunneling: Overview

Developed by SSH Communications Security Ltd., Secure Shell (SSH) is a program that allows a computer to log onto another computer over a network to move files over the network and execute commands. SSH is intended as a replacement for rlogin, rsh, rcp, and rdist.

SSH provides strong authentication and secure communications over non-secure channels. SSH protects a network from attacks such as IP and DNS spoofing, IP source routing, and interception of plaintext passwords and authentication data. If an attacker manages to take over a network, he can only force SSH to disconnect. The content and the connection are secure when encryption is enabled.

When you are using the SSH slogin (instead of rlogin), the entire logged-on session, including the transmission of the password, is encrypted. As a result, it is almost impossible for an outsider to collect passwords.


Note - For improved security, the number of times the adapter can log on during a single session is limited because, during a disconnect, the SSH tunnel is not closed. This method of operation allows you to establish another connection without logging on.


For more information on SSH and how to use it, see the following Web site:

http://www.openssh.com

Additional Software Requirements

The adapter makes use of additional software applications. The adapter also supports either of the following applications for SSH tunneling:

In either case, the you are responsible for downloading, installing, and properly configuring the necessary software. You must refer to the appropriate software provider for support and documentation.

SSH Tunneling and the Batch Adapter

To use SSH tunneling to provide for secure logon IDs and passwords, the BatchFTP Adapter uses the additional SSH-tunneling software (see Additional Software Requirements).

Enabling SSH Tunneling

To enable SSH tunneling, select Yes under the SSH Tunneling Enabled parameter in the adapter connection configuration (see SSH Tunneling Configuration Parameters). You can use the SSH-tunneling software in either of the following ways:

Using an Existing Channel

To use an existing channel, select Yes under the SSH Channel Established parameter in the configuration. The adapter then operates under the assumption that you have already established the SSH channel using the additional software. Once you set this parameter to Yes, the adapter automatically uses that channel.

Using an Internal Channel

If you choose No, under the SSH Channel Established parameter, the adapter launches a process within Java CAPS to establish a channel. In this case, you must specify, under the SSH Command Line parameter, a full and correct command-line statement for your SSH-tunneling application and environment.


Note - You can obtain this information from the SSH-tunneling application’s configuration. See the application’s documentation for details.


You must enter a correct and complete command-line statement. That is, all necessary command line parameters must be provided so that the SSH-tunneling software can run correctly without requiring further interaction.

Check the accuracy of this information by executing the command line from the shell. If the software prompts for more information, add the required information to the command line and try again. Continue this process until the software starts and operates properly without additional action.


Note - You may need to launch the application at least once from the shell before using it in the adapter. This requirement depends on the SSH-tunneling application and platform. Some applications prompt for trust-related information on the first attempt, to connect to a remote host.


Port-forwarding Configuration

Through SSH tunneling, the FTP command connection is protected. This mechanism is based on an existing SSH port-forwarding configuration. You must configure SSH port forwarding on the SSH listen host before you configure the supporting adapter Connection.

For example, on the Java CAPS client host localhost, you can issue a command, such as:

ssh -L 4567:atlas:21 -o BatchMode=yes atlas

Under the adapter’s configuration for the previous example, you must specify:

In this case, the adapter connects to the FTP server atlas:21 through an SSH tunnel.

SSH Tunneling Configuration Parameters

You must set the following SSH tunneling parameters to configure the adapter Connection:

For more information, see SSH Tunneling Configuration Parameters.