ftp connector

Description - Open a FTP connection and persist it.

Runtime Class - com.ibi.agents.XDNFTPConnectionCacheAgent


Configuration

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

Parameter Groups

 ParameterTypeDescription
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
Description - Copy 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
*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 - Closes a cached connection.

Runtime Class - com.ibi.agents.XDNFTPConnectionCacheAgent


Configuration

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

Parameter Groups

 ParameterTypeDescription
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
Description - Checks if a file exists 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.
Description - Appends a file to the end 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
*File Name:stringFile name of the data source to be appended to the target file.
* - denotes required
 ParameterTypeDescription
*File Name:stringFile which the source will be appended to.
Is Directory:booleanSpecifies whether file target is a directory. Assumes file if not specified.
* - denotes required
 ParameterTypeDescription
Create Directory:booleanCreate directory if it does not exist.
* - denotes required
 ParameterTypeDescription
*Output 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 Document {status} - Returns a status document
  • Input Document {original} - Returns the input document of the object.
*Return on Failure:stringDocument returned on failure of object execution.

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
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.