FTP - list directory contents
Search form
Description - Lists the contents of a FTP directory.
Runtime Class - com.ibi.agents.XDNFTPDirListAgent
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.
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)
* - denotes required
Parameter Type Description
Hidden Files: boolean When set to true hidden files and directories (files and directories whose name start with a dot '.') will be returned.
Include: string What items should be included in the listing.
Select from one of the following options:
- Files {file} - Include only file names
- Sub-directories {subdir} - Include only sub-directory names
- All {all} - Include both files and sub-directories
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDNFTPDirListAgent
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.
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)
* - denotes required
Parameter Type Description
Hidden Files: boolean When set to true hidden files and directories (files and directories whose name start with a dot '.') will be returned.
Include: string What items should be included in the listing.
Select from one of the following options:
- Files {file} - Include only file names
- Sub-directories {subdir} - Include only sub-directory names
- All {all} - Include both files and sub-directories
* - 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. | 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:
|
* - denotes required
Parameter | Type | Description | Hidden Files: | boolean | When set to true hidden files and directories (files and directories whose name start with a dot '.') will be returned. | Include: | string | What items should be included in the listing.
Select from one of the following options:
|
---|
* - 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. |