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 > Overview of IBM WebSphere Adapter for FTP > Technical overview > Outbound processing > Supported operations

Retrieve operation

The Retrieve operation retrieves the content of the specified file and returns it in the form of a business object.

The file content is split based on the SplittingFunctionClassName and SplitCriteria properties. The file content is transformed into a business object based on the configured data handler.

After the content of the file is retrieved it is sent as the response. The file content can either be sent back to the calling component or saved to the local file system. If the file to be retrieved does not exist, a RecordNotFound exception is sent to the calling component.

The adapter provides an option to delete the file from the FTP server directory after it is retrieved through the DeleteOnRetrieve property.

The adapter supports an option to archive the file on the FTP server before it is deleted through the ArchiveDirectoryForRetrieve property.

While configuring the Retrieve operation for data transformation, create custom retrieve wrappers like CustomerRetrieveWrapper or CustomerRetrieveWrapperBG, or OrderRetrieveWrapper or OrderRetrieveWrapperBG, and use the wrapper for the output type in the operation window.

For a Retrieve operation without data transformation, the default wrapper RetrieveResponseWrapper is used.

The compatibility with an earlier version may use RetrieveResponseWrapper for retrieving XML data with data transformation.

Supported operations