WebSphere Adapter for FTP

Interaction specification properties

Enterprise service discovery connection properties include outbound and inbound connection properties required for performing metadata discovery and bidirectional configuration. You configure these properties using the enterprise service discovery wizard when you initially deploy the adapter.

When you run the enterprise service discovery wizard in WebSphere® Integration Developer, specify the connection properties listed below.

Interaction Specification properties for the Adapter for FTP

Property Type Description Globalized Required Default value
DirectoryPath String Absolute path of the directory on the FTP server where the outbound operation needs to be performed for all operations except ExecuteFTPScript, or the directory path on the local adapter workstation for the ExecuteFTPScript operation only. The directory must already existing. Yes Yes None
Filename String Name of the file in the directory provided by the DirectoryPath property on which the outbound operations are performed. This value is required for all outbound operations except LIST. Yes No None
DataConnection
Mode
String Data connection mode used by the FTP server during file transfers. Takes either active or passive. This value is used only when a file transfer is taking place. This property is not used when performing a server to server file transfer outbound operation. No No active
FileTransferType Integer File transfer type used during outbound operations. Takes either ASCII or binary. No No binary
SecondServer
Directory
String URL of the second FTP server to which the server to server file transfer outbound operation is performed.

Syntax for specifying FTP URL in the SecondServerDirectory attribute is: ftp://[UserId:password@]FTPserver[:port]
DirectoryForSecondServer

The following information can also be specified:

  • Username and password of a user with privileges to connect to the second FTP server and perform FTP operations. If not specified here, it must be specified in the SecondServerUsername and SecondServerPassword.properties.
  • FTP port. If not specified in here, the adapter uses the default FTP port.
  • Remote event directory. If not specified in here, the adapter transfers the file to the directory to which the connection is established in the FTP server.
Yes No None
SecondServer
Username
String Username of the second FTP server to which the file is transferred during a server to server file transfer outbound operation. Yes No None
SecondServer
Password
String Password of the second FTP server to which the file is transferred during a server to server file transfer outbound operation. Yes No None
FileContent
Encoding
String Encoding used while writing to the file. If this property is not specified, the adapter tries to read without using any specific encoding. You can specify any Java™ supported encoding set. No No None
IncludeEndBO
Delimiter
String File content is appended with this value. Used during the outbound create, append, and overwrite operations. Yes No None
FileInLocal
Directory
boolean During outbound create operations, if this property is set to true, the file content is not available in the business object. The file is retrieved from the local directory on the adapter workstation. During outbound retrieve operations, if this property is set to true, the file content is not sent to the J2EE application as part of the business object. The file is saved to the local directory of the adapter workstation. No No false
LocalDirectoryPath String During outbound create operations, when FileInLocalDirectory property is set to true, the file content is not available in the business object. Instead the file is picked from this directory. During outbound retrieve operations, when FileInLocalDirectory property is set to true, the file content is not sent to the J2EE application as part of business object. The file is saved to this directory. Yes No None
LocalArchiving
EnabledForCreate
boolean During outbound create operations, when the file content is coming as part of the business object from a J2EE application and this property is set to true, the file is saved to the local workstation in the LocalArchiveDirForCreate directory before performing the outbound operation. No No false
LocalArchiveDir
ForCreate
String During outbound create operations, when the file content is coming as part of the business object from a J2EE application and LocalArchivingEnabledForCreate is set to true, the file is saved to the local workstation in this directory. Yes No None
StagingDirectory String During outbound create operations, the file will first be created into this directory. When the file creation is complete, the file is copied to the directory specified in the DirectoryPath property. This staging directory is also used for Append and Overwrite operations where the specified file is copied to the StagingDirectory, if present. The appended or overwritten content is then moved back to the original specified directory. If StagingDirectory is not specified, the operation is run in the actual required directory. Yes No None
Related reference
Resource adapter properties
Connection specification properties
Managed (J2C) connection factory properties
Activation specification properties

Terms of use |

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)