Configuring a SFTP Emitter

How to:

This section describes how to configure a SFTP emitter.

The following table lists and describes the procedure for the SFTP Emitter.

Property Name

Property Description


The absolute path of the file which is being emitted at the name of the SFTP server. For instance, if the file needs to be emitted to a machine sftpsrv on the directory /home/org and the file is to be saved as out[1..9].xml then the value of this field would be /home/org/out*.xml@sftpsrv as shown above.

User Name

The user name on the SFTP server that has read and write access to the directory entered in the Input Path field.


The password for the user account to use when connecting to protocol host.

Private Key

The SSH private Key file used for server authentication (required is password is omitted).

Pass Phrase

The SSH Passphrase used when Private Key was generated (optional).

Move To

The directory to which the file is to be moved after it is emitted.

File Protect

Emits a temporary name and then renames it to the desired name.

Procedure: How to Test a SFTP Emitter Test Channel

  1. Construct an outlet consisting of a SFTP emitter (for example, mySftpEmit).
  2. Construct a channel (for example, File1) consisting of a file inlet, a move Route and a File emitter which writes the output file to a test directory (for example, c:\test).
  3. Build and deploy the channel.
  4. Start the channel.
  5. Copy an XML file to the directory where the File1 listener is listening.

    The File1 channel processes this message and copies the out1.xml file onto the directory on the SFTP server machine, which is /home/org.