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 > Outbound configuration properties

Wrapper and interaction specification properties

Wrapper properties are attributes of the wrapper business object that enable an application programmer to control an operation for the business objects in a wrapper. Interaction specification properties control the interaction for an operation for the entire adapter.

The external service wizard sets the interaction specification properties when you configure the adapter.

You can change some, but not all, of these properties. However, you can change some properties for outbound operations. Use the assembly editor to change these properties, which reside in the method binding of the import. You set the wrapper properties using the Integration Designer test client or programmatically at run time.

The values set in the business object wrapper properties take precedence over the interaction specification properties, even if a NULL value is set. If the values are not set in the business object wrapper properties, then the adapter uses the values set in the interaction specification properties. The adapter uses the values set in the Managed (J2C) connection factory properties if the values are not set in the wrapper and the interaction specification properties.

The following table lists the wrapper and interaction specification properties. 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.

Interaction specification properties
Property name Description
In the wizard In the wrapper business object
Remote archive directory for retrieve operation ArchiveDirectoryForRetrieve The adapter optionally archives the file to this folder before it is deleted during a Retrieve operation.
Create new file if the file does not exist CreateFileIfNotExists If the file does not exist on the FTP server, the adapter creates the file when this property is set to True during Append and Overwrite operations.
FTP server connection mode DataConnectionMode Data connection mode used by the FTP server during file transfers.
Delete the file after retrieve operation DeleteOnRetrieve The adapter deletes the file from the FTP server after it is retrieved when this property is set to True.
Remote directory on FTP system DirectoryPath Absolute path of the directory on the FTP server where the outbound operation must be performed.
Data channel protection level dataProtectionLevel Specifies the protection level of a data channel in case of FTPS protocol.
File content encoding FileContentEncoding Encoding used while writing to the file.
File in local directory FileInLocalDirectory If set to True during a create operation, the file content is picked from the local directory path of the adapter workstation.
Default target file name Filename Name of the file in the directory provided by the DirectoryPath property.
File transfer type FileTransferType File transfer type used during outbound operations.
Generate a unique file GenerateUniqueFile The adapter creates a unique file name when this property is set to True.
Host name property SecondServerHostName Host name of the second FTP server.
Delimiter between business objects in the file property IncludeEndBODelimiter File content is appended with this value.
Local archive directory for create operation LocalArchiveDirForCreate When LocalArchivingEnabledForCreate is set to True during a create operation, the file is saved to the local workstation in this directory.
Archive file in the local directory for create operation LocalArchivingEnabledForCreate When set to True, the file is saved to the local workstation during a create operation.
Local directory LocalDirectoryPath The file is picked from this directory.
Prefix for the unique file name UniqueFilePrefix Specifies the prefix for generating the unique file names during the outbound Create operation.
(Not available) ResumeFailedTransfer When this property is set to True during a create operation, the adapter resumes the transfer of files from the point at which the transfer of file was interrupted due to connection error.
Port number SecondServerPortNumber Port number of the second FTP server.
Protocol SecondServerProtocol Specifies the protocol used to connect to the second server.
Script File Parameters ScriptFileParameters The parameters required by the FTP script file.
Directory SecondServerDirectory Directory path of the second FTP server during a ServerToServerFileTransfer operation.
Password SecondServerPassword Password of the second FTP server during a ServerToServerFileTransfer operation.
User name SecondServerUsername User name of the second FTP server during a ServerToServerFileTransfer operation.
Specify criteria to split file content SplitCriteria The delimiter that separates the business objects in the event file.
Split function class name SplittingFunctionClassName The fully qualified class name of the class file to be used to enable file splitting.
Staging directory StagingDirectory The file is first created into this directory.
Suffix for the unique file name UniqueFileSuffix Specifies the suffix for generating the unique file names during the outbound Create operation.
Temporary file name TemporaryFilename Specifies the temporary file name for the create operation.


Archive file in the local directory for create operation property (LocalArchivingEnabledForCreate)

During outbound create operations, when the file content is coming as part of the business object from a Java EE 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.

Archive file in the local directory for create operation property characteristics
Required No
Default False
Property type Boolean
Globalized No


Create new file if the file does not exist property (CreateFileIfNotExists)

During outbound Append and Overwrite operations, if the file does not exist on the FTP server, the adapter creates the file when this property is set to True.

If this property is False and file does not exist, the adapter sends an error.

Create new file if the file does not exist property characteristics
Required No
Default False
Property type Boolean
Globalized No


Data channel protection level (dataProtectionLevel)

This property specifies the protection level of the data transferred over the data channel. It specifies the type of data channel protection that the adapter and the server use.

Protection Buffer Size (PBSZ) and Data Channel Protection level (PROT) commands are issued by the adapter before opening a data channel to specify the protection level on the data channel. By default, the adapter issues the “PBSZ 0” command before issuing the PROT command.

Data channel protection level property characteristics
Required No
Possible values

Private - Data is transferred in encrypted form
Clear - Data is transferred as clear text

Default Private - Data is transferred in encrypted form
Property type String
Usage

This property is used for selecting the protection level for the data channel. Following are the protection values:

  • Private – Indicates that the data transfer will be integrity and confidentiality protected.
  • Clear – Indicates that the data channel will carry the raw data of the file transfer between the adapter and the server without any security.

Globalized No
Bidi supported No


Delete the file after retrieve operation (DeleteOnRetrieve)

During an outbound Retrieve operation, the adapter deletes the file from the FTP server after it is retrieved when this property is set to True.

Delete the file after retrieve operation property characteristics
Required No
Default False
Property type Boolean
Globalized No


Default target file name property (Filename)

Name of the file to be used during outbound operations.

Default target file name property characteristics
Required No
Default None
Property type String
Globalized Yes


Delimiter between business objects in the file property (IncludeEndBODelimiter)

File content is appended with this value. Used during the outbound create, append, and overwrite operations.

Include business object delimiter in the file content property characteristics
Required No
Default

For the create and overwrite operations, no default value is set.

For the append operation, the default value is <EndBO>.

For the append operation, the following rules apply:

  • If the delimiter is set to null in the business object wrapper, no delimiter is used to separate the business objects.

  • If the IncludeEndBODelimiter property is not set in the business object wrapper, and the value in the interaction specification is also null, the default is <EndBO>.

  • If a specific delimiter value is specified in the business object wrapper, the specified value will be appended.

  • If both the business object wrapper and the interaction specification have specified values, the business object wrapper value takes precedence.

Property type String
Globalized Yes


Directory property (SecondServerDirectory)

Directory of the second FTP server to which the server to server file transfer outbound operation is performed. This is the remote event directory to which the file is transferred.

Directory property characteristics
Required No
Default None
Property type String
Usage For interaction specification properties, the directory located on the FTP server and used in outbound operation represents the absolute path of the FTP directory.

For example: /home/usr/output. It does not contain any host name or URL information.

For wrapper business object properties, the URL of the second server to which the ServerToServerFileTransfer outbound operation is performed.

For example: The syntax for specifying the FTP URL is: ftp://[UserId:password@]FTPserver[:port]/DirectoryForSecondServer.

Globalized Yes


File content encoding property (FileContentEncoding)

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.

File content encoding property characteristics
Required No
Default None
Property type String
Globalized No


File in local directory property (FileInLocalDirectory)

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 Java EE application as part of the business object. The file is saved to the local directory of the adapter workstation.

File in local directory property characteristics
Required No
Default False
Property type Boolean
Globalized No


File transfer type property (FileTransferType)

File transfer type used during outbound operations. Takes either ASCII or binary.

File transfer type property characteristics
Required No
Default binary
Property type String
Globalized No


FTP server connection mode property (DataConnectionMode)

This property represents the data connection mode used by the FTP server during file transfers. 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.

FTP server connection mode property characteristics
Required No
Possible values active or passive
Default active
Property type String
Usage If the adapter is behind the firewall, set this property value as passive. If the FTP server is behind the firewall, set this property value as active.
Globalized No


Generate a unique file property (GenerateUniqueFile)

This property specifies if the adapter generates unique file name for the files created during the outbound Create operation.

The adapter does not support both GenerateUniqueFile and StagingDirectory options at the same time.

Generate unique file property characteristics
Required No
Possible values

True
False

Default False
Property type Boolean
Usage When this property is set to True,

  • the adapter generates a unique name for the files
  • the adapter ignores any value that is set for the Filename property
  • optionally, allows you to specify the prefix and/or suffix for generating unique file names

Globalized No


Prefix for the unique file name property (UniqueFilePrefix)

This property specifies the prefix for generating the unique file names during the outbound Create operation.

Prefix for the unique file name property characteristics
Required No
Default None
Property type String
Usage During the Create operation, the adapter generates unique file names prefixed with the value specified in this property.
Globalized Yes


Suffix for the unique file name property (UniqueFileSuffix)

This property specifies the suffix for generating the unique file names during the outbound Create operation.

Suffix for the unique file name property characteristics
Required No
Default None
Property type String
Usage During the Create operation, the adapter generates unique file names suffixed with the value specified in this property.

To add a file name extension, specify the period (.) in this property.

For example, if the prefix is " abc" and suffix is " .xyz", then the format of the file name is " abc12345678.xyz".

Globalized Yes


Host name property (SecondServerHostName)

Host name of the second FTP server to which the connection is established during an outbound operation.

Host name property characteristics
Required Yes
Default None
Property type String
Globalized Yes


Local archive directory for create operation property (LocalArchiveDirForCreate)

During outbound create operations, when the file content is coming as part of the business object and LocalArchivingEnabledForCreate is set to True, the file is saved to the local workstation in this directory.

Local archive directory for create property characteristics
Required No
Default None
Property type String
Usage The LocalArchiveDirForCreate directory must be created manually, on the machine where the adapter runs, before the adapter is started, as the adapter does not create this directory automatically.
Globalized Yes


Local directory property (LocalDirectoryPath)

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 as part of business object. The file is saved to this directory.

Local directory property characteristics
Required No
Default None
Property type String
Usage The LocalDirectoryPath directory must be created manually, on the machine where the adapter runs, before the adapter is started, as the adapter does not create this directory automatically.
Globalized Yes


Port number property (SecondServerPortNumber)

Port number of the second FTP server through which the connection is established during an outbound operation.

Port number property characteristics
Required Yes
Default 21 for FTP, 990 for FTPS
Property type Integer
Globalized No


Protocol property (SecondServerProtocol)

Protocol used to establish a connection to the second server. The FTP protocol is used in establishing the connection.

Protocol property characteristics
Required Yes
Default FTP
Property type String
Globalized No


Password property (SecondServerPassword)

Password of the second FTP server to which the file is transferred during a server to server file transfer outbound operation.

Password property characteristics
Required No
Default None
Property type String
Globalized Yes


Remote archive directory for retrieve operation property (ArchiveDirectory
ForRetrieve)

During an outbound Retrieve operation, the adapter archives the file to this folder before the files are deleted.

Remote archive directory for retrieve operation property characteristics
Required No
Default None
Property type String
Usage The archive directory must exist. The adapter must have read and write permissions on the archive directory to archive the file during the outbound Retrieve operation.
Globalized Yes


Remote directory on FTP system property (DirectoryPath)

Absolute path of the directory on the FTP server where the outbound operation must be performed for all operations except ExecuteFTPScript, or the directory path on the local adapter workstation for the ExecuteFTPScript operation only. The directory must exist.

If the value <HOME_DIR> is specified as the DirectoryPath, the outbound operations will be performed in the users home directory.

Remote directory on FTP system property characteristics
Required No
Default None
Property type String
Usage

The DirectoryPath directory must be created manually, on the machine where the adapter runs, before the adapter is started, as the adapter does not create this directory automatically.

Globalized Yes


ResumeFailedTransfer

This property supports resuming the transfer of files, which were interrupted due to an error in connection to the FTP server.

This property is applicable only to outbound processing.

ResumeFailedTransfer property characteristics
Required No
Default False
Property type Boolean
Usage

During a create operation, when this property is set to True, the adapter resumes the transfer of files from the point at which the transfer of file was interrupted due to an error in connection.

Globalized No


Script File Parameters property (ScriptFileParameters)

During an outbound ExecuteFTPScript operation, the parameters required by the FTP script file are set in this property. During run time, the adapter replaces the parameters with these values.

Script File Parameters property characteristics
Required No
Default None
Property type String
Globalized Yes


Specify criteria to split file content property (SplitCriteria)

This property accepts different values based on the value of the SplittingFunctionClassName property.

Specify criteria to split file content property characteristics
Required No
Default 0
Property type String
Globalized Yes


Split function class name property (SplittingFunction
ClassName)

Takes the fully qualified class name of the class file to be used to enable file splitting. Requires two values:

The delimiter or file size is provided in the SplitCriteria property.

Split function class name property characteristics
Required No
Default com.ibm.j2ca.utils.filesplit.SplitBySize
Property type String
Globalized No


Staging directory property (StagingDirectory)

During outbound create operations, the file will be created in this directory first. 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.

The adapter does not support both StagingDirectory and GenerateUniqueFile options at the same time.

Staging directory property characteristics
Required No
Default None
Property type String
Usage The StagingDirectory directory must be created manually, on the machine where the adapter runs, before the adapter is started, as the adapter does not create this directory automatically.
Globalized Yes


Temporary file name property (TemporaryFilename)

This property specifies the temporary file name for the create operation. After successful creation of the file, the file gets renamed to the value specified in the 'Default target file name' property.

Temporary file name property characteristics
Required No
Possible values All valid file names
Default None
Property type String
Usage This property is used in the create operation.

If the temporary file name is specified, the file is created with the temporary file name. After the file is successfully created, the file is renamed to the value that is specified in the 'Default target file name' property.

Example xyz.tmp
Globalized No


User name property (SecondServerUsername)

User name of the second FTP server to which the file is transferred during a server to server file transfer outbound operation.

User name property characteristics
Required No
Default None
Property type String
Globalized Yes

Outbound configuration properties


Related concepts:

Supported operations


Related tasks:

Changing interaction specification properties