Understanding Batch Adapter OTDs

This topic provides an overview of the Object Type Definitions (OTDs) available with the Batch Adapter. The OTDs include fields that contain methods, properties, and their application.

The following topics provide background information to help you work with the Batch Adapter OTDs:

Overview of the Batch OTDs

An OTD contains a set of rules that define an object. The object encodes data as it travels through Java CAPS. OTDs are used as the basis for creating Collaboration Definitions for a Project.

Each OTD acts as a template with a unique set of features of the Adapter. The Batch Adapter OTD template is not customizable and cannot be edited.

The four parts of an OTD are:

Element: An element is the highest level in the OTD tree. The element is the basic container that holds the other parts of the OTD. The element can contain fields and methods.
Field: Fields are used to represent data. A field can contain data in any of the following formats: string, boolean, int, double, or float.
Method: Method nodes represent actual Java methods.
Parameter: Parameter nodes represent the Java methods’ parameters.

A high-level view of the OTD folder structure shows methods and attributes you can use in creating Business Rules that invoke FTP, secure FTP, batch record, or local file data exchange.

Types of Batch Adapter OTDs

This table shows the specialized OTDs available with the adapter.

Table 57 Batch Adapter OTDs

OTD Name	Description
BatchFTP	Provides FTP access to remote systems.
BatchFTPOverSSL	Provides secure data transfer using FTP over SSL.
BatchSCP	Provides secure data transfer using Secure Copy Protocol with Secure Shell (SSH) as an underlying protocol.
BatchSFTP	Provides secure data transfer using SSH File Transfer Protocol or SFTP protocol.
BatchLocalFile	Provides easy access to local file systems.
BatchRecord	Allows the adapter to parse or create (or both) payloads of records in specified formats.
BatchInbound	Polls for input file, renames the file to a GUID, and triggers the Business Process or Collaboration.

This chapter describes each of these OTDs and how to use them with the adapter.

OTD Functions

OTDs provide the following functions:

OTD are used in Collaborations to provide platform, system, and program specific functionality that allow you to create Business Rules.
OTDs contain system specific parameters that can be configured using the Properties Editor.
OTDs provide access to the information required to interface with specific external application.

All OTDs must be configured and administered using the NetBeans IDE. Any client components relevant to these OTDs have their own requirements. See the client system’s documentation for details.

For the BatchFTP, BatchLocalFile, and BatchRecord OTDs, only those nodes for which there is a corresponding section in the Environment or Connectivity Map properties (From the Properties Editor) are implemented on the OTD. The remaining nodes are not implemented and are reserved for potential future use.

For the BatchFTP, BatchLocalFile, and BatchRecord OTDs, only those configuration parameters which appear in the Environment or Connectivity Map properties (From the Properties Editor) are supported for use on the OTD. The remaining configuration parameters are not implemented, and are reserved for potential future use. Even though an implemented configuration parameter might be accessed and used from a non-implemented node, such use is not recommended.

Skip Navigation Links
Exit Print View
	Oracle Java CAPS Adapter for Batch User's Guide Java CAPS Documentation