2
Installation and Configuration

This chapter describes how to install and configure the FTP adapter.

This chapter discusses these topics:

Installing the FTP Adapter

This section contains these topics:

Preinstallation Tasks

The FTP adapter must be installed in one of the following Oracle homes:

An existing OracleAS InterConnect Oracle home for 10g (9.0.4)
A new Oracle home (the installer creates this for you)

Consult the following guides before proceeding with FTP adapter installation:

Oracle Application Server InterConnect Installation Guide, which includes information on:

Oracle Universal Installer startup
CD-ROM mounting
OracleAS InterConnect software, hardware, and system requirements

OracleAS InterConnect installation

Note:

OracleAS InterConnect Hub is installable through the OracleAS InterConnect Hub installation type. You must install the OracleAS InterConnect Hub before proceeding with the FTP adapter installation.

Installation Tasks

To install the FTP adapter:

On the Available Product Components page of the OracleAS InterConnect installation, select FTP adapter, then select Next.

Consider the following scenarios:
- If installing the FTP Adapter in an independent Oracle home, make sure that the OracleAS InterConnect Hub has been installed, not necessarily in the same Oracle home. Continue to step 2.
- If installing the FTP adapter in an existing Oracle home, make sure that it is a home directory to one of the OracleAS InterConnect component. Continue to step 3.
  
  Note:
  The hub database information, such as the SID, host, port, and username/password from the Hub installation, is needed for step 2.
If installing OracleAS InterConnect for the first time on this machine, complete the following steps to enter the hub database information:
1. On the Welcome page, select Next. The Database Configuration page displays. Enter information in the following fields:
  - Host Name--The host name of the machine where the hub database is installed.
  - Port Number--The TNS listener port for the hub database.
  - Database SID--The SID for the hub database.
2. Click Next. The Database User Configuration page displays. Enter information in the following fields:
  - User Name--The hub database user name. Make sure the OracleAS InterConnect Hub is installed. If the Hub is not installed, complete the installation and note the user name and password.
  - Password--The password for the hub database user.
Click Next. The Adapter Configuration page displays. Enter the application to be defined or already defined in iStudio in the Application Name field. White spaces or blank spaces are not permitted. The default value is myFTPApp.
Click Next.

The Oracle Application Server InterConnect for FTP Adapter usage page displays.

Select one of the following options and go to the step specified to enable the sending and/or receiving of messages from an external data source, such as an FTP server. You can change your selections later by editing parameter settings in the adapter.ini file.

If You Select...	Then Click Next and Go to Step...
Configure for both sending and receiving messages	6
Configure for sending messages ONLY	6
Configure for receiving messages ONLY	8

Enter the following information in the OracleAS InterConnect FTP Adapter Configuration - Configure sending endpoint information page:
- Username--The username for the FTP server.
- Password--The password for the FTP server.
- FTP Mode--The mode of access used to send information to the specified URL. Select either binary or ascii.
- URL--The URL to be used for sending information. Enter one of the following:
  - For sending to an FTP server--ftp://<host name>/<path>
  - For sending to a local file system--file://localhost/<path>
    
    Note:
    If the sender endpoint is a local file system, the user name, password, and file type are not required.
Click Next.

The installation page that displays next is based on the selection you made in Step 5:

If You Selected... Then Go to Step...

Configure for both sending and receiving messages

8

Configure for sending messages ONLY

10

If You Selected...	Then Go to Step...
Configure for both sending and receiving messages	8
Configure for sending messages ONLY	10

Enter the following information in the OracleAS InterConnect FTP Adapter Configuration - Configure receiving endpoint information page:

Username--The username account of the FTP server from which the Oracle Application Server InterConnect Hub receives messages
Password--The password for the username account
FTP Mode--The mode of access used to receive information from the specified URL. Select either binary or ascii.

URL--The FTP URL to be used for receiving information. Enter one of the following:

For sending to an FTP server--ftp://<host name>/<path>

For sending to a local file system--file://localhost/<path>

Note:

If the sender endpoint is a local file system, the user name, password, and file type are not required.

Caution:

For testing purposes, do not specify a personal FTP account or personal file directories as the receiving endpoint. During runtime, the FTP adapter connects to the FTP server or accesses the file system and removes the files in the directory specified by the receiving endpoint after processing. Oracle Corporation recommends that you create a dedicated FTP account or user account (if the local file system is used for the receiving endpoint) for testing and deploying this adapter.

Click Next.
Complete any other fields for other components selected for installation, such as other adapters.

When finished, the Summary page displays.
Click Install to install the FTP adapter. The adapter is installed in the following directory:

Platform Directory

Windows

ORACLE_HOME\oai\9.0.4\adapters\Application

UNIX

ORACLE_HOME/oai/9.0.4/adapters/Application

You have defined the value of Application in Step 3.
Click Exit at the End of Installation page to exit the FTP adapter installation.

Platform	Directory
Windows	`ORACLE_HOME``\oai\9.0.4\adapters\``Application`
UNIX	`ORACLE_HOME``/oai/9.0.4/adapters/``Application`

Postinstallation Tasks

FTP adapter installation creates an adapter.ini file that consists of configuration parameters read by the FTP adapter at startup. These configuration parameter settings are appropriate for most FTP application environments. You can customize some adapter.ini file parameter settings for the FTP application after installation. See the following sections:

Customizing the Payload Data Type

Payload data is the data sent between applications. If you want to change the payload data type from the default of XML to the data definition description language (D3L), edit the following parameters in the adapter.ini file.

Set the ota.type parameter to the payload type D3L. For example:
```
ota.type=D3L
```
Copy the D3L XML files associated with the FTP application to the directory in which the adapter.ini file is located.
Set the ota.d3ls parameter to specify the D3L files associated with the FTP application. For example:
```
ota.d3ls=person1.xml,person2.xml
```
See Also:
ota.type and ota.d3ls parameter descriptions

Customizing the Sending Endpoints

If you want to customize the behavior of the sending endpoints (destinations) for messages, edit the following parameters in the adapter.ini file. These parameters are not automatically set to default values during installation.

Change the sender endpoint by editing the ota.send.endpoint parameter or leave it blank if it acts only as a receiver. For example:
- For a remote file system--ota.send.endpoint=ftp://foo.com/test
- For a local file system--ota.send.endpoint=file://localhost/test
If the endpoint is a local file system, leave the following parameters blank:
- file.sender.file_type
- file.sender.password
- file.sender.proxy_host
- file.sender.proxy_port
Set the file.sender.file_type parameter to the file type used in FTP. For example:
```
file.sender.file_type=BINARY
```
Update the file.sender.user and file.sender.password parameters with the information of the FTP account that serves as the sending endpoint.
If a proxy host is needed, enter the appropriate values for the file.sender.proxy_host and file.sender.proxy_port parameters.
Set the file.sender.staging_dir parameter. This parameter prevents partial files picked up by external applications.

See Also:
FTP Sender in Chapter 3 for details
Set the file.sender.file_name_rule parameter. This parameter controls how the adapter generates the file name.

See Also:
FTP Sender in Chapter 3 for details
If you need to modify the contents of an outgoing message before it is sent by the transport layer, you can customize it by implementing the FileSenderCustomizer Interface. You need to set the file.sender.customize_class to the name of the customizing class.

Customizing the Receiving Endpoints

If you want to customize the behavior of the receiving FTP or file endpoints for messages, edit the following parameters in the adapter.ini file.

Change the receiver endpoint by editing the ota.receive.endpoint or leave it blank if the adapter only acts as a sender. For example:
- For a remote file system--ota.receive.endpoint=ftp://foo.com/test
- For a local file system--ota.receive.endpoint=ftp://localhost/test
  
  Note:
  If the endpoint is a local file system leave the following parameter blank:
  file.receiver.file_type, file.receiver.password, file.receiver.proxy_host, and file.receiver.proxy_port
  
  Warning:
  Do not use the ota.receive.endpoint to a personal file directory as the files in that directory will be consumed and deleted by the FTP adapter after processing.
Set the file.receiver.file_type parameter to the file type used in FTP. For example:
```
file.receiver.file_type=BINARY
```
Update the file.receiver.user and file.receiver.password parameters with the information of the FTP account that serves as the receiving endpoint.
If a proxy host is needed, enter the appropriate values for the file.receiver.proxy_host and file.receiver.proxy_port parameters.
Set the file.exception.exception_dir to a local file system directory that stores files and cannot be processed successfully. For example:
```
file.receiver.exception_dir=/tmp/error
```
Set the file.receiver.polling_interval parameter to the time interval in milliseconds during which to poll the FTP server or local file system. For example:
```
file.receiver.polling_interval=2000
```
Set the file.receiver.max_msgs_retrieved parameter to the maximum number of messages to retrieve in polling a session. For example:
```
file.receiver.max_msgs_retrieved=10
```
If you need to modify the contents of an incoming message before it is processed by the bridge, for example, to remove an extra line in a file, you can customize it by implementing the FileSenderCustomizer interface. You need to set the file.receiver.customize_class to the name of the customizing class.

FTP Adapter Configuration

Table 2-2, Table 2-3, and Table 2-4 describe FTP executable files, configuration files, and directories. These files and directories are accessible from the directory shown in Table 2-1.

Table 2-1 FTP Adapter Directory

Platform	Directory
UNIX	`ORACLE_HOME``/oai/9.0.4/adapters/``Application`
Windows	`ORACLE_HOME``\oai\9.0.4\adapters\``Application`

Table 2-2 FTP Executable Files

File Description

File	Description
`start.bat` (Windows) `start` (UNIX)	Takes no parameters; starts the adapter
`stop.bat` (Windows) `stop` (UNIX)	Takes no parameters; stops the adapter
`ignoreerrors.bat` (Windows) `ignoreerrors` (UNIX)	If an argument is specified, then the given error code is ignored: `ignoreerrors` `errorCodeToBeIgnored` If no argument is specified, then all error codes specified in the `ErrorCodes.ini` file are ignored: `ignoreerrors`

start.bat (Windows)

start (UNIX)

Takes no parameters; starts the adapter

stop.bat (Windows)

stop (UNIX)

Takes no parameters; stops the adapter

ignoreerrors.bat (Windows)

ignoreerrors (UNIX)

If an argument is specified, then the given error code is ignored:

ignoreerrors errorCodeToBeIgnored

If no argument is specified, then all error codes specified in the ErrorCodes.ini file are ignored:

ignoreerrors

See Also:

"FTP Error Code" for a list of error codes

Table 2-3 FTP Configuration Files

File	Description
`ErrorCodes.ini` (Windows and UNIX)	Contains one error code per line
`adapter.ini` (Windows and UNIX)	Consists of all the initialization parameters that the adapter reads at startup

See Also:

Appendix A, "Sample Adapter.ini File"

Table 2-4 FTP Directories

Directory Description

Directory	Description
`persistence`	The messages are persisted (made available) in this directory. Do not edit this directory or its files.
`logs`	The logging of adapter activity is done in subdirectories of the `logs` directory. Subdirectory names take the following form: `timestamp_in_milliseconds` Each time the adapter is run, a new subdirectory is created in which logging is done in an `oailog.txt` file.

persistence

The messages are persisted (made available) in this directory. Do not edit this directory or its files.

logs

The logging of adapter activity is done in subdirectories of the logs directory. Subdirectory names take the following form:

timestamp_in_milliseconds

Each time the adapter is run, a new subdirectory is created in which logging is done in an oailog.txt file.

Using the Application Parameter

Adapters do not have integration logic. The FTP adapter has a generic transformation engine that processes metadata from the repository as runtime instructions to do transformations. The application defines for an adapter what its capabilities are. For example, it can define what messages it can publish, what messages it can subscribe to, and what are the transformations to perform. The application parameter allows the adapter to become smart in the context of the application to which it is connected. It allows the adapter to retrieve from the repository only that metadata that is relevant to the application. The application parameter must match the corresponding application that will be defined in iStudio under the Applications folder.

If you are using pre-packaged metadata, after importing the pre-packaged metadata into the repository, start up iStudio to find the corresponding application (under the Applications folder in iStudio) to use as the application for the adapter you are installing (unless the package you are using provides directions for what the application should be).

Ini File Settings

The following are .ini files used in configuring the FTP adapter.

Hub.ini Parameters

The FTP adapter connects to the hub database using parameters from the hub.ini file located in the hub directory. The following table lists the parameter name, a description for each parameter, the possible and default values, and an example.

Parameter	Description	Example
`hub_username`	The name of the hub database schema (or username). The default value is `oaihub904`.	`hub_username=oaihub904`
`hub_password`	The password for the hub database user. There is no default value. You input the `hub_password` value during installation.	`hub_password=manager`
`hub_host`	The name of the machine hosting the hub database. There is no default value. You input the `hub_host` value during installation.	`hub_host=mpmypc`
`hub_instance`	The system identification number (SID) of the hub database. There is no default value. You input the `hub_instance` value during installation.	`hub_instance=orcl`
`hub_port`	The transparent network services (TNS) listener port number for the HUB database instance. There is no default value. You input the `hub_port` value during installation.	`hub_port=1521`
`repository_name`	The valid name of the repository this adapter talks to. The default value is `InterConnectRepository`.	`repository_name=InterConnectRepository`

Real Application Clusters-specific Hub.ini Parameters

When a hub is installed on a Real Application Clusters (RAC) database, parameters listed in Table 2-5 represent information on additional nodes used for connection and configuration. These parameters are added on top of the default parameters which represent the primary node. In Table 2-5, x represent the node number, which varies between 2 and the number of nodes. For example, if the Real Application Clusters setup contains 4 nodes, x can take a value between 2 and 4.

Table 2-5 Real Application Clusters-specific hub.ini Parameters

Parameter	Description	Example
`hub_num_nodes`	Number of nodes in Real Application Clusters.	`hub_num_nodes=4`
`hub_host``x`	The host where the Real Application Clusters database is installed.	`hub_host2=dsunram13`
`hub_instance``x`	The instance on the respective node.	`hub_instance2=orcl2`
`hub_port``x`	The port on which the listener is listening.	`hub_port2=1521`

Adapter.ini File

The agent component of the FTP adapter reads the adapter.ini file at runtime to access FTP adapter parameter configuration information. Table 2-6 lists the parameter name, a description for each parameter, the possible and default values, and an example.

Table 2-6 Agent Connection Parameters

Parameter	Description	Example
`application`	Specifies the name of the application to which this adapter connects. This must match with the name specified in iStudio during creation of metadata. Use any alphanumeric string. There is no default value.	`application=ftpapp`
`partition`	Specifies the partition this adapter handles as defined in iStudio. Any alphanumeric string is a possible value. There is no default value.	`partition=germany`
`instance_number`	Specifies the instance number to which this adapter corresponds. Specify a value only if you want to have multiple adapter instances for the given application with the given partition. Possible values are any integer greater than or equal to `1`. There is no default value.	`instance_number=1`
`agent_log_level`	The amount of logging. Possible values are: `0`=errors only `1`=status and errors `2`=trace, status, and errors The default value is `1`.	`agent_log_level=2`
`agent_subscriber_name`	Specifies the subscriber name used when this adapter registers its subscription. The possible value is a valid Oracle Advanced Queue subscriber name. There is no default value.	`agent_subscriber_name=ftpapp`
`agent_message_selector`	Specifies conditions for message selection when registering its subscription with the hub. The possible value is a valid Oracle Advanced Queue message selector string. There is no default value.	`agent_message_selector=recipient_list` like `'%,aqapp,%'`
`agent_reply_subscriber_name`	Specifies the subscriber name used when multiple adapter instances for the given application with the given partition are used. This parameter is optional if there is only one instance running. The possible value is the application name (`parameter``:``application`) concatenated with the instance number (`parameter``:``instance_number`). There is no default value.	If `application=ftpapp` and `instance_number=2`, then `agent_reply_subscriber_name=ftpapp2`
`agent_reply_message_selector`	Used only if there are multiple adapter instances for the given application with the given partition. The possible value is a string built using the concatenated application name (`parameter``:``application`) with the instance number (`parameter``:``instance_number`). There is no default value.	If `application=ftpapp` and `instance_number=2`, then `agent_reply_message_selector=recipient_list` like`'%,ftpapp2,%'`
`agent_tracking_enabled`	Specifies if message tracking is enabled. Set this parameter to `false` to turn off all tracking of messages. Set this parameter to `true` to track messages with tracking fields set in iStudio. Possible values are `true` or `false`. The default value is `true`.	`agent_tracking_enabled=true`
`agent_throughput_measurement_enabled`	Specifies if throughput measurement is enabled. Set this parameter to `true` to turn on all throughput measurements. The default value is `true.`	`agent_throughput_measurement_enabled=true`
`agent_use_custom_hub_dtd`	Specifies whether to use a custom document type definition (DTD) for the common view message when handing it to the hub (the repository in which metadata is stored). By default, adapters use an OracleAS InterConnect-specific DTD for all messages sent to the hub, as other OracleAS InterConnect adapters retrieve the messages from the hub and know how to interpret them. Set this parameter to `true` if you want the adapter to use the DTD imported for every message of the common view. Only set this parameter to `true` if an OracleAS InterConnect adapter is not receiving the messages from the hub. There is no default value.	`agent_use_custom_hub_dtd=false`
`agent_metadata_caching`	Specifies the metadata caching algorithm. Possible values are: `startup`--Cache everything at startup. This may take a while if there are many metadata in the repository. `demand`--Cache metadata as it is used. `none`--No caching. This slows down performance. The default value is `demand`.	`agent_metadata_caching=demand`
`agent_dvm_table_caching`	Specifies the domain value mapping (DVM) table caching algorithm. Possible values are: `startup`--Cache all DVM tables at startup. This may take a while if there are many tables in the repository. `demand`--Cache tables as they are used. `none`--No caching. This slows down performance. The default value is `demand`.	`agent_dvm_table_caching=demand`
`agent_lookup_table_caching`	Specifies the lookup table caching algorithm. Possible values are: `startup`--Cache all lookup tables at startup. This may take a while if there are many tables in the repository. `demand`--Cache tables as they are used. `none`--No caching. This slows down performance. The default value is `demand`.	`agent_lookup_table_caching=demand`
`agent_delete_file_cache_at_startup`	With any of the agent caching methods enabled, metadata from the repository is cached locally on the file system. Set this parameter to `true` to delete all cached metadata on startup. Possible values are `true` or `false`. The default value is `false`. Note: After changing metadata or DVM tables for this adapter in iStudio, you must delete the cache to guarantee access to the new metadata or table information.	`agent_delete_file_cache_at_startup=false`
`agent_max_ao_cache_size`	Specifies the maximum number of application objects' metadata to cache. Possible values are any integer greater than or equal to `1`. The default value is `200`.	`agent_max_ao_cache_size=200`
`agent_max_co_cache_size`	Specifies the maximum number of common objects' metadata to cache. Possible values are any integer greater than or equal to `1`. The default value is `100`.	`agent_max_co_cache_size=100`
`agent_max_message_metadata_cache_size`	Specifies the maximum number of messages' metadata (publish/subscribe and invoke/implement) to cache. Possible values are any integer greater than or equal to `1`. The default value is `200`.	`agent_max_message_metadata_cache_size=200`
`agent_max_dvm_table_cache_size`	Specifies the maximum number of DVM tables to cache. Possible values are any integer greater than or equal to `1`. The default value is `200`.	`agent_max_dvm_table_cache_size=200`
`agent_max_lookup_table_cache_size`	Specifies the maximum number of lookup tables to cache. Possible values are any integer greater than or equal to `1`. The default value is `200`.	`agent_max_lookup_table_cache_size=200`
`agent_max_queue_size`	Specifies the maximum size to which internal OracleAS InterConnect message queues can grow. Possible values are any integer greater than or equal to `1`. The default value is `1000`.	`agent_max_queue_size=1000`
`agent_persistence_queue_size`	Specifies the maximum size to which internal OracleAS InterConnect persistence queues can grow. Possible values are any integer greater than or equal to `1`. The default value is `1000`.	`agent_persistence_queue_size=1000`
`agent_persistence_cleanup_interval`	Specifies how often to run the persistence cleaner thread (in milliseconds). Possible values are any integer greater than or equal to `30000` milliseconds. The default value is `60000`.	`agent_persistence_cleanup_interval=60000`
`agent_persistence_retry_interval`	Specifies how often for the persistence thread to retry when it fails to send an OracleAS InterConnect message. Possible values are any integer greater than or equal to `60000` milliseconds. The default value is `60000`.	`agent_persistence_retry_interval=60000`
`agent_pipeline_to_hub`	Specifies how to turn on or off the pipeline for messages from the Bridge towards the hub. If you set the pipeline to `false`, the file persistence is not used in that direction.	`agent_pipeline_to_hub=false`
`agent_pipeline_from_hub`	Specifies how to turn on or off the pipeline for messages from the hub towards the Bridge. If you set the pipeline to `false`, the file persistence is not used in that direction.	`agent_pipeline_from_hub=false`
`service_path`	Windows only. Specifies the value to which to set the environment variable `PATH`. The `PATH` variable is set to the specified value before forking the Java VM. Typically, all directories containing all necessary DLLs should be listed here. Possible values are the valid path environment variable setting. There is no default value.	`service_path=``%``JREHOME%\bin;D:\oracle\ora904\bin`
`service_classpath`	Specifies the class path used by the adapter Java VM. If a custom adapter is developed and, as a result, the adapter is to pick up any additional jars, add the jars to the existing set of jars being picked up. Possible values are the valid class path. There is no default value.	`service_classpath=D:\oracle\ ora904904\oai\904\lib\ oai.jar; %JREHOME%\lib\rt.jar; D:\oracle\ora904\jdbc\classes12.zip`
`service_class`	Specifies the entry class for the Windows service. A possible value is `oracle/oai/agent/service/AgentService`. There is no default value.	`service_class=oracle/oai/agent/service/AgentService`
`service_max_java_stack_size`	Windows only. Specifies the maximum size to which the Java VM's stack can grow. Possible values are the valid Java VM maximum native stack size. The default value is the default for the Java VM.	`service_max_java_stack_size=409600`
`service_max_native_stack_size`	Windows only. Specifies the maximum size to which the Java VM's native stack can grow. Possible values are the valid Java VM maximum native stack size. The default value is the default for the Java VM.	`service_max_native_stack_size=131072`
`service_min_heap_size`	Windows only. Specifies the minimum heap size for the adapter Java VM. Possible values are the valid Java VM heap sizes. The default value is the default Java VM heap size.	`service_min_heap_size=536870912`
`service_max_heap_size`	Windows only. Specifies the maximum heap size for the adapter Java VM. Possible values are any valid Java VM heap sizes. The default value is `536870912`.	`service_max_heap_size=536870912`
`service_num_vm_args`	Windows only. Specifies the number of `service_vm_arg``number` parameters specified. Possible values are the number of `service_vm_arg``number` parameters. There is no default value.	`service_num_vm_args=1`
`service_vm_arg``number`	Windows only. Specifies any additional arguments to the Java VM. For example, to get line numbers in any of the stack traces, set `service_vm_arg1=java.compiler=NONE`. If there is a list of arguments to specify, use multiple parameters as shown in the example by incrementing the last digit starting with `1`. Be sure to set `service_num_vm_args` correctly. Possible values are any valid Java VM arguments. There is no default value.	`service_vm_arg1=java.compiler=NONE` `service_vm_arg2=oai.adapter=database`
`corba_port_number`	The CORBA port number on which the adapter CORBA service listens. Generally, this port is allocated dynamically. However, it can be configured to enable access across firewall.	`corba_port_number=14000`
`nls_date_format`	Format for date fields expressed as string. The following pattern letters are defined. All other characters from A to Z and from a to z are reserved. Letter Date or Time Component Examples `G` Era designator `AD` `y` Year `1996`; `96` `M` Month in year `July`; `Jul`; `07` `w` Week in year `27` `W` Week in month `2` `D` Day in year `189` `d` Day in month `10` `F` Day of week in month `Number 2` `E` Day in week `Tuesday`; `Tue` `a` A.M./P.M. marker `P.M.` `H` Hour in day (0-23) `0` `k` Hour in day (1-24) `24` `K` Hour in A.M/P.M. (0-11) `0` `h` Hour in A.M./P.M. (1-12) `12` `m` Minute in hour `30` `s` Second in minute `55` `S` Millisecond `978` `z` Time zone `Pacific` The default date format is `EEE MMM dd HH:mm:ss zzz yyyy`. Note: This parameter specifies date format. It is applicable for the date format only.	Date format pattern `dd/MMM/yyyy` can represent 01/01/2003. `nls_date_format=dd-MMM-yy` Multiple date format can be specified as `num_nls_formats=2` `nls_date_format1=dd-MMM-yy` `nls_date_format2=dd/MMM/yy`
`nls_language`	This parameter is a valid ISO Language Code. These lower-case and two-letter codes are defined by ISO-639. You can find a full list of these codes at a Web site, such as, `http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt` The default language code is `en`. Note: This parameter specifies date format. It is applicable for the date format only.	`nls_language=en`
`nls_country`	This parameter is a valid ISO Country Code. These upper-case and two-letter codes are defined by ISO-3166. You can find a full list of these codes at a Web site, such as, `http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html` The default Country code is `US`. Note: This parameter specifies date format. It is applicable for the date format only.	`US`
`encoding`	Character encoding for published messages. The adapter uses this parameter to generate encoding information in encoding tag of transformed OracleAS InterConnect message. OracleAS InterConnect represents messages internally as an XML document. The default encoding of the XML document is `UTF-8`. However, this encoding can be configured using this parameter, which is typically used when the OracleAS InterConnect message consists of characters not supported by `UTF-8` and when the `XMLParser` is unable to handle them.	`encoding=JA16SJIS`

FTP Adapter-Specific Parameters

Table 2-7 lists the parameters specific to the FTP adapter. With the exception of the bridge_class parameter, all parameters can be edited after installation.

Table 2-7 FTP Adapter-Specific Parameters

Parameter	Description	Example
`bridge_class`	Specifies the entry class for the FTP adapter. A value must be specified and cannot be modified later. A possible value is `oracle.oai.agent.adapter.technology. TechBridge`. There is no default value.	`bridge_class=oracle.oai.agent.adapter.technology. TechBridge`
`ota.send.endpoint`	Defines the FTP sending endpoint url. The url is written as follows: `ftp://<host name>/<directory path>` or `file://localhost/<directory path>`. The possible values are `ftp://<host name>/<directory path>`. There is no default value. Note: Do not set the `ota.send.endpoint` parameter to the same value set for the `ota.receive.endpoint` parameter unless you perform a loop-back test for the FTP adapter. The files that you send out are used by the receiving end.	`ota.send.endpoint=ftp://ip-sun/private/ ipdev1/test/inbound`
`ota.receive.endpoint`	Defines the FTP receiving endpoint url. The url is written as follows: `ftp://<host name>/<directory path>` or `file://localhost/<directory path>`. The possible values are `ftp://<host name>/<directory path>`. There is no default value. On Windows platforms, if you have a file system endpoint, you can use the drive letter and directory name as part of the endpoint url.	`ota.receive.endpoint= ftp://ip-sun/private/ ipdev1/test/inbound` On Windows: `ota.receive.endpoint=file://localhost/c:\test`
`ota.type`	Defines the type of payload this adapter handles. Possible values are XML and D3L. There is no default value.	`ota.type=XML`
`ota.d3ls`	Specifies the list of data definition description language (D3L) XML files used by this bridge. Each business event handled by the bridge must have its own D3L XML file. Whenever a new D3L XML file is imported in iStudio for use by an application using the SMTP adapter, the parameter must be updated and the SMTP adapter restarted. There is no default value.	`ota.d3ls=person.xml, person1.xml`
`file.sender.user`	The FTP user name for the outbound FTP server. The possible value is a valid FTP user name. There is no default value.	`file.sender.user=joe`
`file.sender.type`	Indicates the file types. The possible values are ASCII or BINARY. The default value is BINARY.	`file.sender.type=ASCII`
`file.sender.proxy_host`	The name of the machine that server as the proxy server for the outbound FTP server. The possible value is any correct host name. There is no default value.	`file.sender.proxy_host=www-proxy.foo.com`
`file.sender.proxy_port`	The port number of the proxy server for the outbound FTP server. The possible value is any valid port number. There is no default value.	`file.sender.proxy_port=80`
`file.sender.staging_dir`	The staging directory name for the file sender. There is no default value.	`file.sender.staging_dir=/private/ipdev1/ftpstaging1`
`file.sender.file_name_rule`	The rule for generating file names used by the file sender. The default value is `%APP%%PART%_%TIME%`	`file.sender.file_name_rule=%APP%_%EVENT%_%TIME%.xml`
`file.sender.customizer_class`	The class name for customization used by the file sender. The default value is: `oracle.oai.agentt.adapter.technology.FileDefaultSenderCustomizer`	`file.sender.customizer_class=MyFileSenderCustomizer`
`file.receiver.user`	The FTP user name for the inbound FTP server. The possible value is any valid FTP user name. There is no default value.	`file.receiver.user=joe`
`file.receiver.proxy_host`	The name of the machine that servers as the proxy server for the inbound FTP server. The possible value is a correct host name. There is no default value.	`file.receiver.proxy_host=www-proxy.foo.com`
`file.receiver.polling_interval`	Defines the time interval to poll the message source in milliseconds. The default value is `6000`.	`file.receiver.polling_interval = 10000`
`file.receiver.max_msgs_retrieved`	Defines the maximum number of messages to be retrieved in each session. The default value is `30`.	`file.receiver.max_msgs_retrieved = 10`
`file.receiver.exception_dir`	The value of this parameter should be a URL which represents either an FTP directory or a file location. For this release, if an FTP URL can only be specified for the exception directory if the receiving endpoint is also an FTP URL, and furthermore the host name in the URL has to be the same. When a processing exception occurs, the host name, user name, and password of the receiving endpoint will be used to log on to the FTP server to store the messages that are not processed successfully. The user should make sure this directory exists on the FTP server (or the local file system if file URL is used) and is writable by the FTP adapter process.	`file.receiver. execption_dir=ftp://acme.com/ private/user/error` `or` `file.receiver.exception_dir=file://localhost/ private/user/error`
`file.receiver.proxy_port`	The port number of the proxy server for the inbound FTP server. The possible value is a valid port number. There is no default value.	`file.receiver.proxy_port=80`
`file.receiver.customizer_class`	The class name for customization used by the file receiver. The default value is: `oracle.oai.aget.adapter.technology.DefaultReceiverCustomizer`	`file.receiver.customizer_class=MyFileReceiverCustomizer`

Starting the FTP Adapter

On UNIX, start the FTP adapter using the start script in the following directory:

ORACLE_HOME/oai/9.0.4/adapters/Application

Type start, then press Enter.

On Windows, start the FTP adapter from the Services window available from the Start menu.

Access the Services window from the Start menu:

On... Choose...

Windows NT

Start > Settings > Control Panel > Services

Windows 2000

Start > Settings > Control Panel > Administrative Tools > Services

The Services window appears.
Select the OracleHomeOracleASInterConnectAdapter-Application service.
Start the service based on your operating system:

On... Choose...

Windows NT

Choose Start.

Windows 2000

Right click the service and choose Start from the menu.

On...	Choose...
Windows NT	Start > Settings > Control Panel > Services
Windows 2000	Start > Settings > Control Panel > Administrative Tools > Services

On...	Choose...
Windows NT	Choose Start.
Windows 2000	Right click the service and choose Start from the menu.

Sample Log File of Successfully Started Advanced Queuing Adapter

The following file displays an FTP adapter that was started successfully:

D:\oracle\ora904\oai\9.0.4\adapters\ftpapp>D:\oracle\ora904\oai\9.0.4·in\JavaSer
vice.exe -debug "Oracle OAI Adapter 9.0.4 - ftpapp"
D:\oracle\ora9041\oai\9.0.4\adapters\ftpapp adapter.ini 
The Adapter service is starting.. 
Registering your application (FTPAPP).. 
Initializing the Bridge oracle.oai.agent.adapter.technology.TechBridge.. 
Starting the Bridge oracle.oai.agent.adapter.technology.TechBridge.. 
Service started successfully.

Stopping the FTP Adapter

On UNIX, stop the FTP adapter using the stop script in the following directory:

ORACLE_HOME/oai/9.0.4/adapters/Application

Type stop, then press Enter.

On Windows, stop the adapter from the Services window available from the Start menu.

Access the Services window from the Start menu:

On... Choose...

Windows NT

Start > Settings > Control Panel > Services

Windows 2000

Start > Settings > Control Panel > Administrative Tools > Services

The Services window appears.
Select the OracleHomeOracleASInterConnectAdapter-Application service.
Stop the service based on your operating system:

On... Choose...

Windows NT

Choose Stop.

Windows 2000

Right click the service and choose Stop from the menu.

On...	Choose...
Windows NT	Start > Settings > Control Panel > Services
Windows 2000	Start > Settings > Control Panel > Administrative Tools > Services

On...	Choose...
Windows NT	Choose Stop.
Windows 2000	Right click the service and choose Stop from the menu.

You may verify the stop status by viewing the oailog.txt files in the appropriate time stamped subdirectory of the log directory within the adapter directory.

2 Installation and Configuration