WebSphere Adapter for FTP
Activation specification properties hold the inbound event processing configuration information for a message endpoint. They can be set through the enterprise service discovery wizard or the WebSphere® Process Server administrative console.
When you configure the adapter, specify the activation specification properties listed below.
Activation specification properties for the Adapter for FTP
Property | Type | Description | Globalized | Required | Default value |
---|---|---|---|---|---|
DataSourceJNDIName | String | JNDI name of the data source used by event persistence to get the JDBC database connection. The data source must be created in WebSphere Process Server. The database name specified while creating the data source must already exist. | Yes | Yes | None |
EventTableName | String | Name of the table that is used by the adapter for event persistence. When using multiple activation specifications, this value must be unique for each. The same table name must not be used by other instances of same adapter or a different adapter. If the table does not exist in the database, the adapter will create the table. | Yes | Yes | None |
DatabaseSchemaName | String | Schema name of the database used by event persistence. | Yes | No | None |
DatabaseUsername | String | Username used by event persistence for retrieving the JDBC database connection from the data source. | Yes | No | None |
DatabasePassword | String | Password used by event persistence for retrieving the JDBC database connection from the data source. | Yes | No | None |
CreateTable | Boolean | When set to true, the event table and related indexes are created. For troubleshooting table creation errors, set this property to false. The table and indexes can then be created manually. | No | No | true |
EventDirectory | String | FTP URL of the FTP server from where the event
files are retrieved for inbound operations. Syntax for specifying FTP URL
is: ftp://[UserId:password@] The
following information can also be specified:
|
Yes | Yes | None |
EventFileMask | String | Filter for the event files. The file filter is a well-qualified expression consisting of alphanumeric characters and the * and ? wild cards. | Yes | Yes | *.* |
SortEventFiles | String | Determines the sorting order of event files
being polled. Supported values are:
|
No | No | <blank> (= not sorted) |
FTPArchiveDirectory | String | Relative path of the archive directory on the
FTP server. The directory must already exist. There are several options for
using this property to specify archiving:
|
Yes | No | None |
FTPRenameExtension | String | File extension or suffix that the adapter uses to rename the remote FTP file after the connector has polled for it. Renaming the file prevents the connector from polling the same file in the next poll cycle. The adapter can be configured to rename the processed event file and move it to an archive directory. | Yes | No | None |
UserName | String | Name of the user who has privileges to connect to the FTP server and perform FTP operations. You do not need to specify a value for this property if the Username is included in the URL specified in the EventDirectory property. | Yes | No | None |
Password | String | Password of the user who has privileges to connect to the FTP server and perform FTP operations. You do not need to specify a value for this property if the password is included in the URL specified in the EventDirectory property. | Yes | No | None |
FTPGetQuantity | Integer | Determines the number of files retrieved from the remote FTP URL with each remote poll. | No | Yes | 10 |
FTPPollFrequency | Integer | Determines how frequently the adapter polls the FTP server, measured in the number of standard poll cycles. For example, if PollPeriod is set to 10000, and FTPPollFrequency is set to 6, the adapter polls the LocalEventDirectory every 10 seconds and polls the remote EventDirectory every 60 seconds. The adapter performs FTP polling only if you specify a value for this property. If PollPeriod is 0, we consider it as 1 for calculation. If the calculation evaluates to 0, the adapter does not perform FTP polling. | No | Yes | 5 |
EISEncoding | String | Encoding of the FTP server. Use this value
to set the encoding for the control connection to the FTP server.
Specify any Java-supported encoding set for this attribute. |
No | No | None |
LocalEventDirectory | String | Local system directory into which the adapter downloads event files from the FTP site. You must specify a value for this property to enable the adapter to process events. | Yes | Yes | None |
LocalArchiveDirectory | String | Absolute path of the local Archive directory. The directory must be valid and already exist. | Yes | No | None |
FailedArchiveExt | String | File extension used to archive business objects in the event file that are not successfully processed. This property is used only when LocalArchiveDirectory is valid and exists. | Yes | No | fail |
OriginalArchiveExt | String | File extension used to archive the original event file. This preserves the entire event file for reference in case any of its business objects fail. This property is used only when LocalArchiveDirectory is valid and exists. | Yes | No | original |
SuccessArchiveExt | String | File extension used to archive all of the successfully processed business objects. This property is used only when LocalArchiveDirectory is valid and exists. | Yes | No | success |
IncludeEndBODelimiter | Boolean | When set to true, the delimiter is sent with the business object content for further processing. This property is valid only when splitting the event files based on a delimiter. | No | No | false |
DataConnectionMode | String | Data connection mode used by the FTP server during file transfers. Accepts either active or passive settings. | No | No | active |
FileTransferType | Integer | File transfer type used during inbound operations. Accepts either ASCII or binary. | No | No | binary |
CustomParserClassName | String | Fully qualified class name of the custom parser which is used to parse the ls –l output. Used only when the ls –l output deviates from standard output. | No | No | None |
FilePassByReference | Boolean | Specifies that the file content of the event
file is not sent to the endpoint. If set to true, the file is appended with a timestamp and sent to the LocalArchiveDirectory. The timestamp prevents errors and overwrites to the file when another file with the same name is received. This property can be set to true only when the LocalArchiveDirectory property is set and the specified directory exists. This property is used only for PassThrough inbound operations. When enabled, the file is not split into chunks. |
No | No | false |
SplittingFunctionClass Name |
String | This value takes the fully qualified class
name of the class file to be used to enable file splitting. Requires two values:
|
No | No | com.ibm. j2ca. extension. utils. filesplit. SplitBySize |
FileContentEncoding | String | Encoding used to read the event files based on the EndBODelimiter property and during string to byte[] conversions. If not specified, the adapter attempts to read without any specific encoding. You can specify any Java™ supported encoding set. | No | No | None |
SplitCriteria | String | This property takes different values based
on the value of the SplittingFunctionClassName property.
|
Yes | No | 0 |
SocksProxyHost | String | Host name of the machine used as a proxy server through which the adapter requests are routed to the FTP server. | Yes | No | None |
SocksProxyPort | String | Port number of the proxy server through which the adapter requests are routed to the FTP server. | No | No | None |
SocksProxyUserName | String | User name used to authenticate the proxy server. | Yes | No | None |
SocksProxyPassword | String | Password used to authenticate the proxy server. | Yes | No | None |
FTPScriptFileExecuted BeforeInbound |
String | Absolute path of the script file from the local adapter machine that gets run prior to every inbound poll cycle. | Yes | No | None |
FTPScriptFile ExecutedAfterInbound |
String | Absolute path of the script file from the local adapter machine that gets run after every inbound poll cycle. | Yes | No | None |
DefaultObjectName | String | Wrapper business object name used by the Data Transformation Framework before delivering the event to the endpoint. For example, FTPFileBG or CustomerWrapperBG. | No | No | None |
EventContentType | String | Content/MIME type of the input event file that is sent to the Data Transformation Framework to invoke the correct data handler while converting the business object string to a business object. This value is set to NULL for PassThrough operations. | No | No | None |
Last updated: Mon 30 Oct 2006 03:48:53
(c) Copyright IBM Corporation 2005, 2006.
This information center is powered by Eclipse technology (http://www.eclipse.org)