How to: Reference: |
The Secure FTP (SFTP) Emit service is used to emit a message using SFTP to a specific directory on a defined host.
To configure a SFTP Emit service:
For a complete description of the configuration parameters that are available for the SFTP Emit service, see SFTP Emit Service Parameters.
For a complete description of the edges that are returned by the SFTP Emit service, see SFTP Emit Service Edges.
The following table lists and describes parameters for the SFTP Emit service.
Property Name |
Property Description |
---|---|
Host Name |
The DNS name (or IP address) of the SFTP server that you want to connect to. |
Remote Port |
The port number used to connect to the SFTP site, blank for default port 22. |
User Name |
The user ID on the SFTP server. |
Password |
The user password on the SFTP server. |
Private Key |
The path to the private key file used for public-key authentication. |
Pass Phrase |
The pass phrase used to protect the private key. |
Remote Site Folder |
The folder or directory on the SFTP site that you want to use as a starting location when you connect. A blank value defaults to the login directory. |
File Protect |
This emits a temporary name and then renames it to the desired name. |
File Pattern |
This specifies the output file pattern to be used. |
Retry Interval |
The retry interval in seconds (allows for xxhxxmxxs format). Omit or use 0 for no retry. |
Return |
Select one of the following values:
|
The following table lists and describes the edges that are returned by the SFTP Emit service.
Edges |
Description |
---|---|
success |
Operation completed successfully. |
fail_connect |
Failed to connect to SFTP host for one of the following reasons:
|
fail_operation |
Invalid parameters or other error. |
The test case is similar to the SFTP emitter, as shown in Configuring a Secure FTP Emitter. However, in this case a service is used to emit the file to the SFTP server using private key file. A SFTP Emit service would be used instead of a SFTP Emitter when a process flow which performs a sequence of tasks (for a business process) needs to be used and statuses need to be evaluated.
As shown in the above example, the value of the Host Name can be
edasol29
and the username can be
edasxr
where:
Has write access to the Remote Site Folder directory.
Also, the Private Key file can point to the id_dsa private key file on the iway server. Enter the values of the fields as shown above.
The File1 channel processes this message and copies the out1.xml file to the directory on the SFTP server referred to by the attribute Remote Site Folder on the sftpservice object in the process flow.
iWay Software |