SFTP - list files in a directory
Search form
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
Parameter Type Description * Directory string What directory should be listed. The directory must exist.
Include string What 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 Expression string Regular expression used to select files/directories, based on Pattern Type.
Pattern Type string If 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)
* Retry string If non-zero, will retry the operation n times at one-second intervals.
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDSFTPDirListAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description * Directory string What directory should be listed. The directory must exist.
Include string What 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 Expression string Regular expression used to select files/directories, based on Pattern Type.
Pattern Type string If 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)
* Retry string If non-zero, will retry the operation n times at one-second intervals.
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| * | Directory | string | What directory should be listed. The directory must exist. | Include | string | What items should be included in the listing.
Select from one of the following options:
|
Selection Expression | string | Regular expression used to select files/directories, based on Pattern Type. | Pattern Type | string | If 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:
|
* | Retry | string | If non-zero, will retry the operation n times at one-second intervals. |
* - 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. |