Description - Reads a file via SFTP and returns the read result

Runtime Class - com.ibi.agents.XDSFTPReadAgent


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

Parameter Groups

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

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.