You have the option to configure a SFTP connection inside Paradox that allows you to send report data to your SFTP destination on a one time or recurring basis. All reports are able to use this delivery method.

Use cases

• Sending new hire data to our payroll provider automatically each week.
• Teams that have another vendor that they need to send recurring data to from Paradox.
• Teams that have an internal data team that wants data feeds for their data warehouse.
• Sending encrypted report files to a SFTP destination.

Configuration

Only Company/Account Admins and Reporting users can create and edit SFTP connections. However, Paradox Admins (CS Representatives) can create and edit all SFTP connections on the account. If you want new connections configured for your account, you will need to gather the following information from your internal technical/data team:

• SFTP Host URL
• SFTP Port
• SFTP Username
• Connection Type
  • If Basic, then you will need the SFTP Password.
  • If Key File, then you will need the Public Key (instead of a password). The acceptable file types for this include:
    • .pem
    • .ppk
    • .pub
    • .txt
• Push or Pull?
  • Pull – If you want to extract your report data files, then you will need to gather the IP addresses to whitelist in Paradox so that users with those IP addresses can connect to the folder. However, you will also need to notify your CS Representative, as they will need to set up a Reporting SFTP connection on the backend for you.
  • Push – This will connect to your SFTP destination and send the report data files to them. You will need to gather IP addresses to whitelist in Paradox so that users with those IP addresses can connect to the folder. 

Set up a reporting SFTP folder

When you have all of the required information, you will be able to set up a reporting SFTP folder by following the steps below.

1. Navigate to Analytics  & Reporting.
2. Click the Create New Report button in the top right corner of the page.
3. Complete the Type step.
4. Click Next.
5. Complete the Fields step.
6. Click Next.
7. If the Filter section displays, update filters, as needed.
8. Click Next.
9. In the Delivery section, set the date/time stamp and file format.
10. Select SFTP as the File Delivery Method.
11. Select the SFTP Routing field and then + Add New SFTP Connection from its drop-down menu.
    
    
     
12. A slide-out drawer will then open where you can enter your SFTP details for the following fields:
    • Connection Type – The two options allowed are Basic and Key File. The Basic connection type will require a username and password to be entered while the Key File connection type requires a username and a public key to be uploaded to the connection.
    • Connection Name – This label should match the name of the data provider for easier identification. This is the only field you would define yourself.
    • SFTP Host URL – This field will contain the full SFTP URL and the folder path in which this file should be placed under. You will be given this information from your internal technical/data team in a format similar to the following:  sftp://data50.dataprovidername.com/paradoxreports/schedulingreports
      • Note: To send a file to the /inbound folder, add /inbound to the end of the SFTP Host URL.
    • SFTP Port – This field is where you enter the SFTP Port information provided by your internal technical/data team.
    • SFTP Username – This field is where you enter the SFTP Username information provided by your internal technical/data team.
    • SFTP Password (Connection Type = Basic) – This field is where you enter the SFTP Password information provided by your internal technical/data team, if using the Basic connection type.
    • Public Key (Connection Type = Key File) – This field is where you enter the SFTP Password information provided by your internal technical/data team, if using the Key File connection type. The acceptable file types for this are:
      • .pem
      • .ppk
      • .pub
      • .txt
    • Encrypt File – This setting will display when Basic is selected as the connection type and allows the report to be encrypted during delivery. When selected, additional settings will display. This is explained in more detail below.
13. Click Validate Connection to confirm if the details are correct.
    • If successful, you will see a green Connection Successful message. Once you see this, click the Save button.
    • If unsuccessful, you will see a red Connection Unsuccessful message. This means something is wrong with the connection details and would require troubleshooting. Check the following:
      • Incorrect username
      • Incorrect password
      • SFTP Host URL wasn’t entered correctly
      • SFTP Port is missing
      • Public Key was incorrect
14. When your connection is validated and saved, click Next.
15. Review the details in the Summary section and then click Finish and Send Now.

Encrypt file

When selected, the Encrypt File setting will encrypt the file when it is sent to its destination. When checked, the following settings will then display:

• Save As – This allows you to select the format of the report. The current accepted public key formats include:
  • .csv (default)
  • .gpg
• File Encryption PGP Key – You will be given an option to upload your public key to be used to encrypt the file. The file will then need to be decrypted with the private key on your end to review the report file.

Use a SFTP connection

When creating or editing a report, you will simply have to select the preferred SFTP Routing option from the Delivery section. Click here to learn more about creating and running reports.

Edit an SFTP connection

To edit an existing connection, simply open a new or edit an existing report, and when you get to the Delivery section, click the gear icon next to the SFTP Routing field.

An Edit SFTP Connection slide-out drawer will then open where you can make your changes, validate the connection, and then click Save.

Permissions

The SFTP Routing delivery option is only available to Paradox Admins, Company/Account Admins, and Reporting Users. Paradox Admins can see and edit all SFTP connections setup in an account while Company/Account Admins and Reporting Users can only view and edit SFTP connections that they have created. 

FAQs