sftp connector

Description - Writes a file to a SFTP site.

Runtime Class - com.ibi.agents.XDSFTPEmitAgent


Configuration

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

Parameter Groups

 ParameterTypeDescription
Remote Site Folder:stringFolder or directory on the SFTP site you wish to write the file to.
File Pattern:stringOutput file pattern (* = timestamp) ie. *.xml,*.txt etc. Note: *.* is unsupported
* - denotes required
 ParameterTypeDescription
File Protect:booleanEmit temporary name and then rename to the desired name
Emit Zero Bytes:booleanAllow the Emitter to transmit zero bytes to server. This flag will be ignored if the document to be emitted is a stream.
* - denotes required
 ParameterTypeDescription
Output Document:string

Select from one of the following options:
  • Status Document {status} - Document that reflects the agent status
  • Input Document {input} - Original document that was supplied to the object
* - denotes required

Output Events

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailSecurityCould not operate due to a security violation.
OnFailedOperationCould not perform the operation requested.
Description - Upload a file or directly from a SFTP site.

Runtime Class - com.ibi.agents.XDSFTPDirectFileTransfer


Configuration

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

Parameter Groups

 ParameterTypeDescription
*File Name:stringFile to be uploaded to the SFTP site.
Directory:stringLocal directory to read from. Not used if File Name is an absolute path.
* - 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
Connection RetryintegerAttempted failed connects to SFTP server
Retry IntervalstringRetry interval in seconds (allows for xxhxxmxxs format) Omit or use 0 for no retry
Use SCPbooleanUse Secure Copy protocol for file copy. Not all servers support the use of SCP.
* - 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 SFTP site

Runtime Class - com.ibi.agents.XDSFTPFileOpsAgent


Configuration

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

Parameter Groups

 ParameterTypeDescription
*File (from)stringOriginating file to be operated on. Relative or absolute file paths are supported through a SREG or XPATH expression evaluated using the incoming document
* - denotes required
 ParameterTypeDescription
File (to)stringDestination file to be operated on. Wild cards accepted. Required except for delete, size exist
File (to) a directory namebooleanFile (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.
* - denotes required
 ParameterTypeDescription
File (to) Create DirectoriesbooleanCreate directory if it doesn't exist.
*RetrystringIf non-zero, will retry the operation n times at one-second intervals.
* - denotes required
 ParameterTypeDescription
*Out DocumentstringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • original - Original document sent to agent
  • result - Agent results
  • status - Agent status
*Action on FailurestringWhether input document or status document returned on failure.

Select from one of the following options:
  • input - Original document sent to agent
  • status - Agent status
* - 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.
OnNotFoundThe resource was not found and this is considered an error.
Description - Rename a file on a remote SFTP site

Runtime Class - com.ibi.agents.XDSFTPFileOpsAgent


Configuration

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

Parameter Groups

 ParameterTypeDescription
*File (from)stringOriginating file to be operated on. Relative or absolute file paths are supported through a SREG or XPATH expression evaluated using the incoming document
* - denotes required
 ParameterTypeDescription
*File (to)stringDestination file to be operated on. Wild cards accepted.
File (to) a directory namebooleanFile (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.
* - denotes required
 ParameterTypeDescription
File (to) Create DirectoriesbooleanCreate directory if it doesn't exist.
*RetrystringIf non-zero, will retry the operation n times at one-second intervals.
* - denotes required
 ParameterTypeDescription
*Out DocumentstringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • original - Original document sent to agent
  • result - Agent results
  • status - Agent status
*Action on FailurestringWhether input document or status document returned on failure.

Select from one of the following options:
  • input - Original document sent to agent
  • status - Agent status
* - 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.
OnNotFoundThe resource was not found and this is considered an error.
Description - Reads a file via SFTP and returns the read result

Runtime Class - com.ibi.agents.XDSFTPReadAgent


Configuration

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

Parameter Groups

 ParameterTypeDescription
*File NamestringName of the file or XML tag from the input document in which to find the file name
*File Name not a Document TagbooleanThe File Name is not a tag. False if the File Name is a document tag; otherwise True if the File Name evaluates to a valid file name.
Base PathstringOptional directory to be used if incoming name is not absolute
Enclose TagstringThe name of the tag in which to enclose data read. If omitted, no entagging. If used, output is XML
Input Data FormatstringFormat of the input data, default is flat

Select from one of the following options:
  • Flat message {flat} - Message is non-XML
  • JSON {json} - Message is JSON
  • XML - Message is XML
EncodingstringCharacter set encoding to be performed on the input.

Select from one of the following options:
  • As is {asis} - Do not encode as base 64
  • Base 64 {base64} - Encode as base 64
Delete After ReadstringThis parameter configures the action to be taken after the read. The options are:
Keep:Do not delete the file (this is the default)
Delete:Immediately after the read, delete the file.
Delete on Success:This is a transactional delete if the Listener supports transactions otherwise the file is deleted immediately after the file is read. If the listener supports transactions then the file is not deleted unless the flow ends in success. Note: The connection to the SFTP server is maintained until that time. Users are strongly cautioned that use of this option within an iteration can result in a holding of connections to the server, which in turn can cause subsequent connection failures and resource buildup.


Select from one of the following options:
  • Keep {false} - Do not delete the file.
  • Delete {true} - Immediately after the read, delete the file.
  • Delete on Success {trans} - This is a transactional delete. The file is not deleted unless the flow ends in success.
*Special Register NamespacestringThe prefix to give to any Special Register that is generated by the agent (i.e. ftp.read, sftp.read, etc.). Do not terminate the Namespace with a '.' that will be be done automatically by the Service Manager. If not specified the default value of 'sftp' will be used.
* - 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.
OnNotFoundThe resource was not found and this is considered an error.
fail_deleteCannot delete the file.
Description - Prepend a file to the beggining of another file on a remote SFTP site

Runtime Class - com.ibi.agents.XDSFTPFileOpsAgent


Configuration

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

Parameter Groups

 ParameterTypeDescription
*File (from)stringOriginating file to be operated on. Relative or absolute file paths are supported through a SREG or XPATH expression evaluated using the incoming document
* - denotes required
 ParameterTypeDescription
File (to)stringDestination file to be operated on. Wild cards accepted. Required except for delete, size exist
File (to) a directory namebooleanFile (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.
* - denotes required
 ParameterTypeDescription
File (to) Create DirectoriesbooleanCreate directory if it doesn't exist.
*RetrystringIf non-zero, will retry the operation n times at one-second intervals.
* - denotes required
 ParameterTypeDescription
*Out DocumentstringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • original - Original document sent to agent
  • result - Agent results
  • status - Agent status
*Action on FailurestringWhether input document or status document returned on failure.

Select from one of the following options:
  • input - Original document sent to agent
  • status - Agent status
* - 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.
OnNotFoundThe resource was not found and this is considered an error.
Description - Move a file on a remote SFTP site

Runtime Class - com.ibi.agents.XDSFTPFileOpsAgent


Configuration

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

Parameter Groups

 ParameterTypeDescription
*File (from)stringOriginating file to be operated on. Relative or absolute file paths are supported through a SREG or XPATH expression evaluated using the incoming document
* - denotes required
 ParameterTypeDescription
File (to)stringDestination file to be operated on. Wild cards accepted. Required except for delete, size exist
File (to) a directory namebooleanFile (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.
* - denotes required
 ParameterTypeDescription
Create Directory:booleanCreate directory if it doesn't exist.
*Retry:stringIf non-zero, will retry the operation n times at one-second intervals.
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • original - Original document sent to agent
  • result - Agent results
  • status - Agent status
*Action on Failure:stringWhether input document or status document returned on failure.

Select from one of the following options:
  • input - Original document sent to agent
  • status - Agent status
* - 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.
OnNotFoundThe resource was not found and this is considered an error.
Description - Lists the contents of a directory on SFTP Server

Runtime Class - com.ibi.agents.XDSFTPDirListAgent


Configuration

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

Parameter Groups

 ParameterTypeDescription
*DirectorystringWhat directory should be listed. The directory must exist.
IncludestringWhat items should be included in the listing.

Select from one of the following options:
  • Files {file} - Include only file names
  • Subdirectories {subdir} - Include only subdirectory names
  • All {all} - Include both files and subdirectories
Selection ExpressionstringRegular expression used to select files/directories, based on Pattern Type.
Pattern TypestringIf 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)
*RetrystringIf non-zero, will retry the operation n times at one-second intervals.
* - 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 - Download a file or directly from a SFTP site.

Runtime Class - com.ibi.agents.XDSFTPDirectFileTransfer


Configuration

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

Parameter Groups

 ParameterTypeDescription
*File Name:stringFile to be downloaded from a SFTP site.
Directory:stringRemote directory to download from. Not used if File Name is an absolute path.
* - denotes required
 ParameterTypeDescription
*Directory:stringLocal directory to write 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
Connection RetryintegerAttempted failed connects to SFTP server
Retry IntervalstringRetry interval in seconds (allows for xxhxxmxxs format) Omit or use 0 for no retry
Use SCPbooleanUse Secure Copy protocol for file copy. Not all servers support the use of SCP.
* - denotes required
 ParameterTypeDescription
Delete Source:booleanDelete source after downloading from SFTP 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 SFTP site

Runtime Class - com.ibi.agents.XDSFTPFileOpsAgent


Configuration

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

Parameter Groups

 ParameterTypeDescription
*File (from)stringOriginating file to be operated on. Relative or absolute file paths are supported through a SREG or XPATH expression evaluated using the incoming document
* - denotes required
 ParameterTypeDescription
File (to)stringDestination file to be operated on. Wild cards accepted. Required except for delete, size exist
File (to) a directory namebooleanFile (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.
* - denotes required
 ParameterTypeDescription
File (to) Create DirectoriesbooleanCreate directory if it doesn't exist.
*RetrystringIf non-zero, will retry the operation n times at one-second intervals.
* - denotes required
 ParameterTypeDescription
*Out DocumentstringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • original - Original document sent to agent
  • result - Agent results
  • status - Agent status
*Action on FailurestringWhether input document or status document returned on failure.

Select from one of the following options:
  • input - Original document sent to agent
  • status - Agent status
* - 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.
OnNotFoundThe resource was not found and this is considered an error.