Skip to main content

Run SFTP Exporter plugin

Export queries directly into a file on the local computer.

J
Written by Joshua Shooter
Updated over 3 months ago

As a PeopleHR admin, with the SFTP Exporter plugin, you can export queries directly to a location using SFTP. You can then schedule this to run automatically.
โ€‹

To set up and run the SFTP Exporter plugin, follow the steps below.

  1. Create queries which include all the desired information.

  2. Create an API key that includes the QueryBuilder endpoint.

  3. Click Plugins then click New Requests.

  4. Click SFTP Exporter and enter your API key.

  5. Specify the queries names you added in your API, using a comma to separate the names.

  6. Enter the hostname or IP address of the SFTP server.

  7. Enter the host location, which represents the path you want to export the queries through. This should start with a / followed by the path name.

  8. Enter the username of an admin on that server and enter the admin password.

Notes: If you do not wish to pass the admin username and password for the SFTP server, provide the SSH or private key as a file. If the key includes a passphrase, under private key settings, supply your private key as a password file.
The hostname/location is to be provided by the third party.

  1. Enter the port. The port open for SFTP defaults to 22.

  2. Review your form then click Submit.

Notes:

  • Once you create a new request, allow up to two minutes to view this in Requests.

  • To download any file attached to the request, click Download.

  • To repeat the same request, click Repeat.

  • If your request failed for any reason, to view the error details, click the log icon.

Did this answer your question?