To open the SFTP collection agent configuration, click Build → New Configuration. Select Workflow from the Configurations dialog. When prompted to Select workflow type, select Batch. Click Add agent and select SFTP in the Collection tab in the Agent Selection dialog. Double-click the agent icon or right-click the icon and select Edit agent, to display the Agent Configuration dialog.
...
| Setting | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Collection Strategy | If there are more than one collection strategy available in the system a Collection Strategy drop down list will also be visible containing the available strategies. For further information about the nature of the collection strategy, see Appendix 4 - Collection Strategies. | ||||||||||
| File Information Settings | |||||||||||
Directory | Absolute pathname of the source directory on the remote host, where the source files reside. The pathname might also be given relative to the home directory of the Username account. | ||||||||||
| Include Subfolders | Select this check box if you have subfolders in the source directory from which you want files to be collected.
If you select Enable Sort Order in the Sort Order tab, the sort order selected will also apply to subfolders. | ||||||||||
Filename | Name of the source files on the remote host. Regular expressions according to Java syntax applies. For further information, see http://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.
| ||||||||||
Compression | Compression type of the source files. Determines whether the agent will decompress the files before passing them on in the workflow or not.
| ||||||||||
| Before Collection Settings | |||||||||||
Move to Temporary Directory | If enabled, the source files will be moved to the automatically created subdirectory | ||||||||||
Append Suffix to Filename | Enter the suffix that you want added to the file name prior to collecting it.
| ||||||||||
Inactive Source Warning (h) | If enabled, when the configured number of hours have passed without any file being available for collection, a warning message (event) will appear in the System Log and Event Area: The source has been idle for more than <n>
hours, the last inserted file is <file>. | ||||||||||
| After Collection Settings | |||||||||||
Move to | If enabled, the source files will be moved from the source directory (or from the directory
| ||||||||||
Destination | Absolute pathname of the directory on the remote host into which the source files will be moved after the collection. This field is only available if Move to is is enabled.
| ||||||||||
Prefix and Suffix | Prefix and/or suffix that will be appended to the beginning and/or the end, respectively, of the source files after the collection. These fields are only available if Move to or Rename is enabled. | ||||||||||
| Search and Replace | To apply Search and Replace, select either Move to or Rename.
Search and Replace operate on your entries in a way that is similar to the Unix sed utility. The identified filenames are modified and forwarded to the following agent in the workflow. This functionality enables you to perform advanced filename modifications, as well:
| ||||||||||
Keep (days) | Number of days to keep moved or renamed source files on the remote host after the collection. In order to delete the source files, the workflow has to be executed (scheduled or manually) again, after the configured number of days.
| ||||||||||
Rename | If enabled, the source files will be renamed after the collection, remaining (or moved back from the directory
| ||||||||||
Remove | If enabled, the source files will be removed from the source directory (or from the directory | ||||||||||
Ignore | If enabled, the source files will remain in the source directory after the collection. This option is not available if Move is enabled. | ||||||||||
| UDR Type Settings | |||||||||||
| Route FileReferenceUDR | Select this check box if you want to forward the data to an SQL Loader agent. See the description of the SQL Loader agent in SQL Loader Agent for further information | ||||||||||
Advanced Tab
...
| Setting | Description | |||||
|---|---|---|---|---|---|---|
| Advanced Settings | ||||||
| Max Async Request | Advance setting to tune the maximum asynchronous request a SFTP server can be handle, leave it empty, will use the default value(100) from library. | |||||
Port | The port number the SFTP service will use on the remote host. | |||||
Timeout (s) | The maximum time, in seconds, to wait for response from the server. 0 (zero) means to wait forever. | |||||
Accept New Host Keys | If selected, the agent overwrites the existing host key when the host is represented with a new key. The default behavior is to abort when the key mismatches.
| |||||
Enable Key Re-Exchange | Used to enable and disable automatic re-exchange of session keys during ongoing connections. This can be useful if you have long lived sessions since you may experience connection problems for some SFTP servers if one of the sides initiates a key re-exchange during the session. | |||||
| Additional Hosts Settings | ||||||
Additional Hosts | List of additional host names or IP-addresses that may be used to establish a connection. These hosts are tried, in sequence from top to bottom, if the agents fail to connect to the remote host set in their Connection tabs. Use the , , , and buttons to configure the host list. | |||||
Security Tab
The Security tab contains configurations related to the Advanced Security Options for SFTP. The Configuration available can be modified by selecting the Advanced Security Option check box. If the advanced security is not enabled, the Cipher Mode will default to aes128-ctr and the HMac Type will default to hmac-sha2-256. If advanced security is enabled but the combo box fields are left empty, the Cipher Mode will default to aes128-ctr and the HMac Type will default to hmac-sha2-256.
The SFTP collection agent configuration - Security tab
| Note | ||
|---|---|---|
| ||
Due to an upgrade of the Maverick library for With Advanced Security Option disabled, Maverick will manage the connection between the SFTP agent and the server. Maverick will attempt to connect with the STRONG security level. Failing to do so, it will auto downgrade the security level to WEAK and attempt to connect, this behaviour will allow our agents to work well with backwards compatibility for servers with older instances of the Maverick library. Furthermore, having STRONG security level will result in a performance degradation. However, when a user manually enables the Advanced Security Option from the security tab, Maverick will instead assign the WEAK security level, which will not be as strict or resource intensive as the STRONG security level. For more information about security levels, you can refer to this page: https://www.jadaptive.com/managed-security-in-our-java-ssh-apis/ |
| Setting | Description |
|---|---|
| Cipher Mode | Algorithms for the Block Cipher Modes supported by the SFTP agent. This allows the agent to determine which algorithm for the block cipher to be used when communicating with the SFTP servers.
|
HMac Type | Methods of encryption for Key Exchange. This allows the agent to determine the method of encryption to be used when the keys are exchanged between the SFTP servers and the SFTP agent.
|