Syntax:
com.ibi.agents.XDSFTPEmitAgent
iIT Service Object:
format: SFTP Emit Agent
Description: Emit a message using SFTP to a specific directory on a defined host.
Parameters:
Parameter |
Description |
---|---|
Host Name * |
The DNS name (or IP address) of the SFTP server that you want to connect to. |
Remote Port * |
The port to connect to on the SFTP site. Leave blank for default port 22. |
Buffer Size |
The size of the SFTP buffer to be used when sending or retrieving data. The default value of 32768 is used if this field is not set. A larger buffer may improve performance, but setting this field to a value greater than 65536 will default to 65536. The value must be entered as a whole number (for example, 32768, 65536). iWay recommends leaving the buffer size at 32768. |
Proxy Settings |
|
Proxy Type |
The proxy protocol to use. |
Proxy Host Name |
The DNS name (or IP address) of the proxy server that you want to connect to. |
Proxy Port |
The port to connect to on the proxy site. |
Proxy User ID |
The user ID on the proxy server. |
Password |
The proxy user's password on the proxy server. |
SSH Parameters |
|
User Name |
The user ID on the SSH-enabled server. |
Password |
The user's password on the SSH-enabled server. |
Private Key |
The path to the private key file for public-key authentication.. |
Passphrase |
The passphrase used to protect the Private Key. |
Provider |
The name of the SSH Client Security Provider to use. If no Provider name is specified, enter the user name and either a password or a Private Key and passphrase values (Passphrase is required only if the Private Key file is passphrase protected). |
Validate Host Keys |
If set to true, keys sent from SSH hosts are validated. If valid, the keys are cached by this server. If false, any host key will be accepted by this server. |
Host Key Repository |
The path to the Known Host Keys repository on this server. |
Agent Parameters |
|
Host Key Repository |
The path to the Known Host Keys repository on this server. |
Remote Site Folder |
The folder or directory on the SFTP site that you want to use as a starting location when you connect. Blank designates the login directory. |
File Protect |
Emit a temporary name and then rename it to the desired name. |
Emit Zero Bytes |
Allow the Emitter to transmit zero bytes to the server. This flag will be ignored if the document to be emitted is a stream. |
File Pattern |
The output file pattern (* = timestamp), for example, *.xml ,*.txt, etc. Note: *.* is unsupported. |
Retry Interval |
The retry interval in seconds (allows for xxhxxmxxs format). Omit or use 0 for no retry. |
Connection Retry |
Determines the attempted failed connects to the SFTP server. |
Retry Interval |
Retry interval in seconds (allows for xxhxxmxxs format). Omit or use 0 for no retry. |
Edges:
The following table lists the available Line Edges for the SFTP Emit Agent Service (com.ibi.agents.XDSFTPEmitAgent).
Line Edge |
Description |
---|---|
OnError |
An exception occurred during execution. |
OnSuccess |
The operation was successful. |
OnFailure |
A fail condition occurred during execution. |
OnFailedConnection |
Could not connect to the external system. |
OnFailedOperation |
Could not perform the operation requested . |
OnFailSecurity |
Could not operate dues to a security violation.. |