ftp connector

Description - Writes a file to a FTP site.

Runtime Class - com.ibi.agents.XDNFTPEmitAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Type:stringInput from the document (default) or from an external source (MFT use)

Select from one of the following options:
  • Input Document {document} - Data sent is the input document
  • External File {external} - Data sent is from external media
  • Stream {stream} - Data sent is carried in the flow via a stream document
File ExpressionstringIf input source is 'External File' specify the file name here.
*File PatternstringOutput file pattern (* = timestamp) ie. *.XML,*.txt etc. Note: *.* is unsupported
* - denotes required
 ParameterTypeDescription
*Transfer Mode:stringWhen files are transferred in ASCII mode, the transferred data is expected to contain only character formatted text. BINARY mode refers to transferring files as a binary stream of data. Where ASCII mode may use special control characters to format data, BINARY mode transmits the raw bytes of the file being transferred. In this way, the file is transferred in its exact original form.

Select from one of the following options:
  • ascii - Transfer in character mode
  • binary - Transfer in binary mode
Behavior When Target File Exists:stringIf file exists on FTP server, what should we do? "append" means that input will be added to the end of the existing file.For "restart", if server supports REST and SIZE commands, we determine size of the file on the server, then send REST command with current file size. The input data is then sent starting at this position.

Select from one of the following options:
  • Overwrite {overwrite}
  • Append {append}
  • Resume {resume}
  • Fail {fail}
Allow Zero Byte Transfers:booleanAllows the FTP sender to transmit zero byte sources to server.
Retry Interval:stringRetry interval in seconds (allows for xxhxxmxxs format) Omit or use 0 for no retry
* - denotes required
 ParameterTypeDescription
On Start:stringThe SITE command to issue before the transfer of data
On Success:stringThe SITE command to issue after the successful transfer of data
On Error:stringThe SITE command to issue if the transfer of data fails
* - denotes required
 ParameterTypeDescription
Document Output:string'status': status document will be the out document. 'input': in document will become the out document.

Select from one of the following options:
  • iWay Status Document {status} - Replace input with standard iWay status document
  • Original Input Document {input} - Output of node is original document
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
OnFailedOperationCould not perform the operation requested.
fail_duplicateOperation failed due to duplicate resource and and this is considered an error.
Description - Transfers a local file or directly to a FTP site.

Runtime Class - com.ibi.agents.XDNFTPDirectFileTransfer


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Directory:stringLocal directory to read from. Not used if File Name is an absolute path.
*File Name:stringFile to be uploaded to FTP site.
* - denotes required
 ParameterTypeDescription
*Directory:stringRemote directory to upload to.
* - denotes required
 ParameterTypeDescription
*Transfer Mode:stringAscii mode transfers files as 'text', binary mode transfers files as raw data.

Select from one of the following options:
  • ascii - Transfer in character mode
  • binary - Transfer in binary mode
Use Temp File:booleanProtects the FTP PUT operation by uploading to a temporary file. Once operation is complete the temporary file is renamed to the target file.
* - denotes required
 ParameterTypeDescription
Delete Source:booleanDelete source after uploading to FTP server
*Output Document:stringDocument returned by object

Select from one of the following options:
  • Status Document {status} - Returns a status document
  • Input Document {original} - Returns the input document of the object.
*Return on Failure:stringDocument returned by object on execution failure.

Select from one of the following options:
  • Input Document {input} - Return status document on error
  • Status Document {status} - Return status document on error
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
OnFailedOperationCould not perform the operation requested.
Description - Checks for size of file on a remote FTP site

Runtime Class - com.ibi.agents.XDNPFFTPOpsAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringOriginating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document
* - denotes required
 ParameterTypeDescription
*Size:stringRegister designated to hold size. Required for size operation.
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • result - The resulting document from the file operations
  • status - A status document describing the result of the operation
  • original - The original input document arriving at this agent/service
Return on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • iWay Status Document {status} - Replace input with standard iWay status document
  • Original Input Document {input} - Output of node is original document
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
OnNotFoundThe resource was not found and this is considered an error.
Description - Rename a file on a remote FTP site

Runtime Class - com.ibi.agents.XDNPFFTPOpsAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringOriginating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document
* - denotes required
 ParameterTypeDescription
*Directory:booleanFile (to) references a directory, if it is unclear whether path names a directory or a filename, the Service Manager will assume the path names a file.
Name:stringDestination file to be operated on. Wild cards accepted. Required except for delete, size, exists
* - denotes required
 ParameterTypeDescription
Create Directory:booleanCreate directory if it doesn't exist.
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • result - The resulting document from the file operations
  • status - A status document describing the result of the operation
  • original - The original input document arriving at this agent/service
Return on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • iWay Status Document {status} - Replace input with standard iWay status document
  • Original Input Document {input} - Output of node is original document
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
OnNotFoundThe resource was not found and this is considered an error.
Description - Embeds a specified binary, XML, JSON or text file in the input document

Runtime Class - com.ibi.agents.XDNPFFTPReadAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*File Name:stringFile to be read.
*Format:stringFormat of the input data

Select from one of the following options:
  • Flat {flat} - File must not be parsed.
  • XML {xml} - The file is an XML document.
  • JSON {json} - The file is a JSON document.
* - denotes required
 ParameterTypeDescription
*Transfer Mode:stringWhen files are transferred in ASCII mode, the transferred data is expected to contain only character formatted text. BINARY mode refers to transferring files as a binary stream of data. Where ASCII mode may use special control characters to format data, BINARY mode transmits the raw bytes of the file being transferred. In this way, the file is transferred in its exact original form.

Select from one of the following options:
  • ascii - Transfer in character mode
  • binary - Transfer in binary mode
*Delete After Read:booleanWhether to delete the file after the read
* - denotes required
 ParameterTypeDescription
Encoding:stringCharacter set encoding to be performed on input. Base 64 is required for flat binary data

Select from one of the following options:
  • Asis - Encoding as set by listener.
  • base64 - Base 64; creates a Base 64 encoded string that can be used in an XML document.
*Embed:booleanWhether to embed the data from the read operation into the input document
Tag:stringName of the node to wrap the data read in flat format.
Parent Tag:stringWhere in the input document the input data should be embedded
* - denotes required
 ParameterTypeDescription
*FTP Namespace:stringThis prefix is given to any register this connector creates. ie ftp.read, sftp.read, etc.
* - denotes required
 ParameterTypeDescription
Action on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • iWay Status Document {status} - Replace input with standard iWay status document
  • Original Input Document {input} - Output of node is original document
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
Description - Prepend a file to the beggining of another file on a remote FTP site

Runtime Class - com.ibi.agents.XDNPFFTPOpsAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringOriginating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document
* - denotes required
 ParameterTypeDescription
Directory:booleanFile (to) references a directory, if it is unclear whether path names a directory or a filename, the Service Manager will assume the path names a file.
Name:stringDestination file to be operated on. Wild cards accepted. Required except for delete, size, exists
* - denotes required
 ParameterTypeDescription
Create Directory:booleanCreate directory if it doesn't exist.
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • result - The resulting document from the file operations
  • status - A status document describing the result of the operation
  • original - The original input document arriving at this agent/service
Return on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • iWay Status Document {status} - Replace input with standard iWay status document
  • Original Input Document {input} - Output of node is original document
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
OnNotFoundThe resource was not found and this is considered an error.
Description - Move a file on a remote FTP site

Runtime Class - com.ibi.agents.XDNPFFTPOpsAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringOriginating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document
* - denotes required
 ParameterTypeDescription
Directory:booleanFile (to) references a directory, if it is unclear whether path names a directory or a filename, the Service Manager will assume the path names a file.
Name:stringDestination file to be operated on. Wild cards accepted. Required except for delete, size, exists
* - denotes required
 ParameterTypeDescription
Create Directory:booleanCreate directory if it doesn't exist. Used only for Copy, Move, Rename and Append operations.
* - denotes required
 ParameterTypeDescription
Size:stringRegister designated to hold size. Required for size operation.
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • result - The resulting document from the file operations
  • status - A status document describing the result of the operation
  • original - The original input document arriving at this agent/service
Return on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • iWay Status Document {status} - Replace input with standard iWay status document
  • Original Input Document {input} - Output of node is original document
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
OnNotFoundThe resource was not found and this is considered an error.
Description - Lists the contents of a FTP directory.

Runtime Class - com.ibi.agents.XDNFTPDirListAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Directory:stringWhat directory should be listed. The directory must exist.
Selection Expression:stringRegular expression used to select files/directories, based on Pattern Type.
Pattern Type:stringIf the Selection Expression is supplied, indicate whether it should be interpreted as a regular expression or a DOS-style wildcard.

Select from one of the following options:
  • Regular Expression {regex} - Full regular expressions used in selection
  • DOS-style Wild card {wildcard} - DOS-style wildcards (* and ? only)
* - denotes required
 ParameterTypeDescription
Hidden Files:booleanWhen set to true hidden files and directories (files and directories whose name start with a dot '.') will be returned.
Include:stringWhat items should be included in the listing.

Select from one of the following options:
  • Files {file} - Include only file names
  • Sub-directories {subdir} - Include only sub-directory names
  • All {all} - Include both files and sub-directories
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
OnFailedOperationCould not perform the operation requested.
Description - Transfers a local file or directly to a FTP site.

Runtime Class - com.ibi.agents.XDNFTPDirectFileTransfer


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Directory:stringFTP site directory to be used if File Name is not an absolute path.
*File Name:stringFile to be downloaded from FTP site.
* - denotes required
 ParameterTypeDescription
*Directory:stringLocal directory to download the remote file to.
* - denotes required
 ParameterTypeDescription
*Transfer Mode:stringAscii mode transfers files as 'text', binary mode transfers files as raw data.

Select from one of the following options:
  • ascii - Transfer in character mode
  • binary - Transfer in binary mode
* - denotes required
 ParameterTypeDescription
Delete Source:booleanDelete source after uploading to FTP server
*Output Document:stringDocument returned by object

Select from one of the following options:
  • Status Document {status} - Returns a status document
  • Input Document {original} - Returns the input document of the object.
*Return on Failure:stringDocument returned by object on execution failure.

Select from one of the following options:
  • Input Document {input} - Return status document on error
  • Status Document {status} - Return status document on error
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
OnFailedOperationCould not perform the operation requested.
Description - Delete a file on a remote FTP site

Runtime Class - com.ibi.agents.XDNPFFTPOpsAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringOriginating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • result - The resulting document from the file operations
  • status - A status document describing the result of the operation
  • original - The original input document arriving at this agent/service
Return on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • iWay Status Document {status} - Replace input with standard iWay status document
  • Original Input Document {input} - Output of node is original document
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
OnNotFoundThe resource was not found and this is considered an error.