Skip to main content


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

Creating an FTP Server data instance

Updated on April 6, 2022

Create a new FTP server data instance and configure the information that Pega Platform uses to find and log into an external FTP server.

  1. In the header of Dev Studio, click CreateIntegration-ResourcesFTP Server.
  2. On the Create FTP Server page, in the FTP Server short description field, enter a description of the FTP Server.
  3. In the Server Name field, specify a name for the FTP server.
    This name does not need to match the network name. Begin the name with a letter, and use only alphanumeric characters, ampersands, and hyphens.
  4. Click Create and open.Result: The FTP Server rule form opens on the Environment tab.
  5. In the Host name field, enter a Domain Name Server (DNS) name for the FTP server.For example: ftp.myserver.com
    Alternatively, identify an IP address.

    This field supports the Global Resource Settings syntax (= PageName.PropertyName). The default property name for this field is pyHostName. For more information, see Fields that support the Global Resource Settings syntax.

  6. Optional: In the Port number field, identify a TCP/IP port for this FTP server.
    The system automatically selects standard ports at run time if they are not specified, such as port 21 for FTP and FTP Secure (FTPS), and port 22 for SSH FTP (SFTP). This field supports the Global Resource Settings syntax ( =PageName.PropertyName). The default property name for this field is pyPortNumber.
  7. In the Authentication section, select Use authentication to enable authentication.
  8. Optional: In the Authentication profile field, press the Down arrow key to select the authentication profile that contains the user name and password for the account that Pega Platform uses to connect to the FTP server.
    If this field is left blank, Pega Platform attempts to make an anonymous FTP connection.
  9. Optional: Click the Open icon to edit the selected authentication profile or to create a new one.
    For more information, see Authentication profiles.
  10. In the Protocol section, select the protocol based on your FTP server configuration.
    ChoicesActions
    FTPNo additional steps required.
    SSH FTP (SFTP)
    1. In the Server key field, select the Keystore record that contains the SSH public key of the FTP server to restrict the FTP servers to which connections are made.
      The Keystore type value on the Keystore record should be KEY. When this field is blank, the Pega Platform can connect to any SFTP host regardless of its public certificate.
    2. In the Client key field, select the client private key, which is uploaded to the Keystore record.
      The private key is used to identify the FTP client when connecting to the FTP server. The Keystore type value on the Keystore record must be KEY.
    FTP Secure (FTPS)
    1. In the Lowest allowable SSL/TLS version field, select the lowest allowable SSL/TLS version.
      Note: Pega Platform displays a guardrail warning for versions that are considered vulnerable.
    2. Optional: In the Truststore field, press the Down arrow key to select the Truststore record that contains the server certificates for FTP server verification, or click the Open icon to open the selected Truststore or to create a new one.
    3. Optional: In the Keystore field, select the Keystore record that contains the client certificates for Pega client application verification by the FTP server, or click the Open icon to edit the selected Keystore or to create a new one.
    4. To encrypt data, select Encrypt data channel.
      This check box is enabled by default for encryption of FTP authentication and data channels. Authentication over FTP always uses encryption. If you are using mutual SSL or a secure network, you might want to deselect this option because performance can be impacted when using it.
  11. Click Save.
What to do next: After you have completed this tab and saved the rule, click Test connectivity to confirm that Pega Platform can connect to the server by using the information on this tab.

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