The People HR Offline Backup Tool is designed to allow IT teams to backup data from People® on a regular basis providing you with an offline backup mechanism. 

There are two versions of this tool - the external offline backup tool and the tool explained this in this article. Although the external tool is only compatible with Windows machines, this version allows you to run silently in the background. To find out more on this version and how to use it, please see:

http://help.peoplehr.com/integrations/utilities-and-misc/offline-backup-tool 

The tool explained in this article is held in the Plugins tab of People® and therefore can be used on any computer you login to your system on. 

To use this tool:

1. Create some Queries for the data you want extracted.

2. You'll then need to create and copy an API key that includes the all areas in the following endpoints: Query, Employee, and Document. On how to create an API key, please see: http://help.peoplehr.com/integrations/creating-an-api-key 

3. Once you have built the queries and copied the API key, click on the 'Plugins' tab:

4. Select the tab 'New Requests'

5. Select the 'Offline Backup Tool'

6. You will then be presented with this screen:

7. Paste the API key in the field specified

8. Enter the query names of all queries you wish to export, using commas to separate:

9. If you wish to export all employee documents, please select the tick box marked 'Export documents'

10. Select Submit - you will then be presented with a similar screen:


If you then go back into the 'Requests' tab, you will see an audit when this tool was ran. The next time you run this tool, you can simply select the 'Repeat' button to retrieve the past settings. 

For more information on this tab, please see: http://help.peoplehr.com/plugins/plugins

Quick Tip! If running this on a MAC and you use the default MAC archive utility for opening zip files, all employee documents will appear under one root folder once extracted. To group documents into separate folders per employee, we advise installing an archiver that allows more flexibility when extracting zip files.

Your IT team may have a preferred utility for this. 

Thanks,

Customer Services.

Did this answer your question?