IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > FTP > Reference > Inbound configuration properties
Resource adapter properties
The resource adapter properties control the general operation of the adapter, such as specifying the namespace for business objects.
You set the resource adapter properties using the external service wizard when you configure the adapter. After deploying the adapter, use the administrative console to change these properties.
The following properties for logging and tracing are no longer required in version 7.5.0.2, but are supported for compatibility with previous versions:
- LogFileMaxSize
- LogFileName
- LogNumberOfFiles
- TraceFileMaxSize
- TraceFileName
- TraceNumberOfFiles
The following table lists the resource adapter properties and their purpose. A complete description of each property is provided in the sections that follow the table. For information about how to read the property details tables in the sections that follow, see Guide to understanding property details.
Resource adapter properties for the WebSphere Adapter for FTP Property name Description In the wizard In the administrative console Adapter ID AdapterID
Identifies the adapter instance for PMI events and for logging and tracing.
EISEncoding (EISEncoding) EISEncoding Encoding of the FTP server. Disguise user data as "XXX" in log and trace files (HideConfidentialTrace) HideConfidentialTrace Specifies whether to disguise potentially sensitive information by writing X strings instead of user data in the log and trace files. (Not available) enableHASupport Specifies the configuration mode, Active-Active or Active-Passive, for the WebSphere Adapter for FTP. (Not available) LogFileSize
Deprecated (Not available) LogFilename
Deprecated (Not available) LogNumberOfFiles
Deprecated (Not available) TraceFileSize
Deprecated (Not available) TraceFileName
Deprecated (Not available) TraceNumberOfFiles
Deprecated
Adapter ID (AdapterID)
This property identifies a specific deployment or instance of the adapter.
Adapter ID details Required Yes Default 001 Property type String Usage This property identifies the adapter instance in the log and trace files, and also helps identify the adapter instance while monitoring adapters. The adapter ID is used with an adapter-specific identifier, FTPRA, to form the component name used by the Log and Trace Analyzer tool. For example, if the adapter ID property is set to 001, the component ID is FTPRA001.
If you run multiple instances of the same adapter, ensure that the first eight characters of the adapter ID property are unique for each instance so that you can correlate the log and trace information to a particular adapter instance. By making the first seven characters of an adapter ID property unique, the component ID for multiple instances of that adapter is also unique, allowing you to correlate the log and trace information to a particular instance of an adapter.
For example, when you set the adapter ID property of two instances of WebSphere Adapter for FTP to 001 and 002. The component IDs for those instances, FTPRA001 and FTPRA002, are short enough to remain unique, enabling you to distinguish them as separate adapter instances. However, instances with longer adapter ID properties cannot be distinguished from each other. If you set the adapter ID properties of two instances to Instance01 and Instance02, you will not be able to examine the log and trace information for each adapter instance because the component ID for both instances is truncated to FTPRAInstance.
For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.
Globalized Yes Bidi supported No
EISEncoding (EISEncoding)
This property specifies the encoding of the FTP server. Sets the encoding for the control connection while communicating with the FTP server. Set the property if the FTP server's directories or file names contain globalized characters.
EISEncoding characteristics Required No Default None Property type String Examples UTF-8, ISO-8859-1
Disguise user data as "XXX" in log and trace files (HideConfidentialTrace)
This property specifies whether to replace user data in log and trace files with a string of X's to prevent unauthorized disclosure of potentially sensitive data.
Disguise user data as "XXX" in log and trace files details Required No Possible values True
FalseDefault False Property type Boolean Usage If you set this property to True, the adapter replaces user data with a string of X's when writing to log and trace files. For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.
Globalized No Bidi supported No
Log file maximum size (LogFileMaxSize)
This property specifies the size of the log files in kilobytes.
Log file maximum size details Required No Default 0 Property type Integer Usage When the log file reaches it maximum size, the adapter start using a new log file. If the file size is specified as 0 or no maximum size is specified, the file does not have a maximum size. Globalized Yes Bidi supported No
Log file name (LogFilename)
This property specifies the full path name of the log file.
Log file name details Required No Default No default value Property type String Usage This property is deprecated. Globalized Yes Bidi supported Yes
Log number of files (LogNumberOfFiles)
This property specifies the number of log files.
Log number of files details Required No Default 1 Property type Integer Usage When a log file reaches its maximum size, the adapter starts using another log file. If no value is specified, the adapter creates a single log file. Globalized Yes Bidi supported No
Trace file maximum size (TraceFileMaxSize)
This property specifies the size of the trace files in kilobytes.
Trace file maximum size details Required No Default 0 Property type Integer Usage If no value is specified, then the trace file has no maximum size. Globalized Yes Bidi supported No
Trace file name (TraceFilename)
This property specifies the full path of the trace file.
Trace file name details Required No Default No default value Unit of measure Kilobytes Property type String Usage This property is deprecated. Globalized Yes Bidi supported Yes
Trace number of files (TraceNumberOfFiles)
This property specifies the number of trace files to use. When a trace file reaches its maximum size, the adapter starts using another trace file.
Trace number of files details Required No Default 1 Property type Integer Usage If no value is specified, the adapter uses a single trace file. Globalized Yes Bidi supported No
Enable high availability support (enableHASupport)
This property is used to specify the configuration mode, either Active-Active or Active-Passive, for the WebSphere Adapter for FTP in a clustered environment.
For HA Active-Active configuration, this property must be set to False in the Process Administrative Console.
Enable high availability support property details Required No Possible values True False
Default True Property type Boolean Usage
Active-Passive configuration modeBy default (enableHASupport= True), the adapter is set to Active-Passive configuration mode, providing high availability support. This configuration mode allows only one adapter instance to be active and to poll a remote event directory for files.
Active-Active configuration modeWhen this property is set to False, the adapter is in the Active-Active configuration mode. The adapter in the Active-Active configuration mode provides both high availability and load balancing support. Different adapter instances process different events, in parallel. This results in each adapter instance polling for a unique event and delivering the event without any duplication, to the endpoint.
If an adapter is configured to support high availability Active-Active mode, then configure all event persistence properties. In addition, the following are not supported in this configuration mode:
- Sorting of event files (by file name or timestamp) being polled
- Ordered delivery type of events to the export
Globalized No Bidi supported No