With the PeopleHR Offline Backup Tool plugin, your IT team can back up your PeopleHR data on a regular basis providing you with an offline backup mechanism through a bulk download. You can extract a number of queries, and employee documents, into one location on your computer.
📌Note: Only system admins and users who have access to the query names and the API key will be able to run the tool.
To bulk download data, you can use the Offline Backup Tool plugin or the external Offline Backup tool compatible with Windows.
Set up the Offline Backup plugin
To set the Offline Backup plugin to run, follow the steps below:
Create a series of queries that include relevant data for your extraction.
Create an API key that includes all Query, Employee and Document endpoints.
In PeopleHR, click Plugins and select New Requests.
Click Offline Backup Tool, then enter your API key.
Enter the relevant query names using commas to separate them.
Select whether you want to export employee documents.
Select whether you want to export all employee photos.
Click Submit.
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.
📌Note: If running this on a MAC and you use the default MAC archive utility for opening zip files, all employee documents appear under one root folder once extracted. To group documents into separate folders per employee, install a different archiving tool. For more details, reach out to your IT team.