Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Transferring files from a Pega server to an SFTP server

Updated on April 6, 2022

You can configure Pega Platform to securely transfer files from a Pega server to an SFTP server. You use the Connect-FTP method in an activity to transfer files from a Pega server to an SFTP server.

Before you begin: In order to create an FTP Server record in Pega Platform, obtain the following information.
  • SFTP server name or IP address.
  • SFTP server port (the default is port 22).
  • Password for the SSH client private key: If the SSH client private key is not secured with a passphrase, a password might not exist. Obtain this information from your SFTP server provider.
  • User name, if it is required for connecting to the SFTP server.
  • Password, if it is required for connecting to the SFTP server.
To configure a secure connection between your Pega server and SFTP server, configure the following authentication details. You enter the authentication profile and keystore record when you configure the authentication in the FTP Server record.
  • Create an authentication profile. For details, see Creating an authentication profile.
  • Create the keystore record for the SSH client private key. For details, see Configuring a keystore by uploading a file.

    The key must be an SSH2 or OpenSSH key in PEM format. Obtain the key from your SFTP server provider, or create your own key by using PuTTY. Unlike most keystore records, the keystore file also must be a key that is not wrapped in a keystore or other file.

  • Optional. Create the keystore record for the SSH public key of the SFTP server. For details, see Configuring a keystore by uploading a file.

    Using an SSH public key of the SFTP server prevents connections to servers that fail to provide this public key. Use an SSH2 or OpenSSH key in PEM format. Obtain the key from your SFTP server provider or create your own key by using PuTTY.

    Unlike most keystore records, the keystore file also must be a key that is not wrapped in a keystore or other file.

This task involves creating an FTP Server record to hold the information that Pega Platform needs to find and log into an external FTP server. Then, to transfer your files, you configure an activity that calls the Connect-FTP method. In the method parameters, you enter the name of the FTP Server record.
Transferring files from a Pega server to an SFTP server
Diagram describing how Pega Platform connects to an SFTP server and transfers files by using an activity.
  1. Create the FTP Server record. For more information, see Creating an FTP Server data instance.
  2. Configure an activity to use the FTP Server record to transfer files from Pega Platform to the SFTP server. For details, see Creating an activity.
  3. Configure a step in the activity that calls the Connect-FTP method. For details, see Configuring steps in an activity.
    For more details on the Connect-FTP method parameters, see Connect-FTP method.
    1. In the Method Parameters section, in the FTP server field, enter the name of the FTP Server record that you created for the SFTP connection.
    2. In the Remote path field, enter the destination path for transferred files on the SFTP server. Leave this field blank to transfer files to the user root directory.
    3. In the Local file field, enter the source path for transferred files on the Pega server. This field cannot be blank.
    4. In the Transfer mode field, select one of the following options:
      • ASCII: ASCII is the FTP default transfer mode. This mode is primarily used for text files. It corrupts files that contain data other than ASCII text.
      • Binary: Binary transfers can be used for any type of file.
    5. Click Save.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us