SFTP - read a file
Search form
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
Parameter Type Description * File Name string Name of the file or XML tag from the input document in which to find the file name
* File Name not a Document Tag boolean The 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 Path string Optional directory to be used if incoming name is not absolute
Enclose Tag string The name of the tag in which to enclose data read. If omitted, no entagging. If used, output is XML
Input Data Format string Format 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
Encoding string Character 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 Read string This 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 Namespace string The 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
Runtime Class - com.ibi.agents.XDSFTPReadAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description * File Name string Name of the file or XML tag from the input document in which to find the file name
* File Name not a Document Tag boolean The 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 Path string Optional directory to be used if incoming name is not absolute
Enclose Tag string The name of the tag in which to enclose data read. If omitted, no entagging. If used, output is XML
Input Data Format string Format 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
Encoding string Character 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 Read string This 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 Namespace string The 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
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| * | File Name | string | Name of the file or XML tag from the input document in which to find the file name | * | File Name not a Document Tag | boolean | The 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 Path | string | Optional directory to be used if incoming name is not absolute | Enclose Tag | string | The name of the tag in which to enclose data read. If omitted, no entagging. If used, output is XML | Input Data Format | string | Format of the input data, default is flat
Select from one of the following options:
|
Encoding | string | Character set encoding to be performed on the input.
Select from one of the following options:
|
Delete After Read | string | This parameter configures the action to be taken after the read. The options are:
Select from one of the following options:
|
* | Special Register Namespace | string | The 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
| Name | Description |
|---|---|
| OnParseError | Could not parse a document. |
| OnFailConnection | Could not connect to the external system. |
| OnFailSecurity | Could not operate due to a security violation. |
| OnFailedOperation | Could not perform the operation requested. |
| OnNotFound | The resource was not found and this is considered an error. |
| fail_delete | Cannot delete the file. |