The programme loads documents from a directory on your computer to employees records on People HR.

Download the programme HERE

Instructions for use after downloading the file:

1. Uncompress

2. Run the installer, please make sure it is run as an administrator. (Run

as admin, right click and you will see this option)

3. It has two modes, silent and interactive, You must run it interactively

to set the API key.

4. When run, click on the settings button and enter your API key. The API key must

contain all document endpoints. To learn how to create an API key, please see: http://help.peoplehr.com/documents/employee-documents

5. On the screen when you press 'Browse' it will ask for a folder

6. It will then enumerate the folders using your rules which are

- a root folder containing folders for each employee

--- The folders within the above folder must be named "employee name - (People HR Employee ID) e.g. Fred Bloggs - PW35

'Root' will be the folder that you select from the UX, while 'Client A' is an employee with the ID 'PW20'. The loaded documents need to be located in the folders under 'Client A - PW20' folders (i.e Benefits, Benefits - Manager, etc).

As mentioned in your API call, the 2 security flags that can be set are:

"EmployeeAccess"

"ManagerAccess"

By default, the flags are set to True. The folder name is expected to have the following form: {Category} - {Permissions}

The Permissions can currently include "staff" (use for employee access) or "manager" (use for manager access)

The program will pick up all the child folders and apply the above rules:

  • "Benefits" 

No hyphen found -> using the default flags (EmployeeAccess = true and ManagerAccess=true). 

Category set to "Benefits".

  • "Benefits - Manager"

Hyphen found:

- category set to "Benefits"

- permissions = "Manager"

All documents within this folder will be uploaded with EmployeeAccess = false and ManagerAccess=true

  • "Benefits - Staff"

Hyphen found:

- category set to "Benefits"

- permissions = "Staff"

All documents within this folder will be uploaded with EmployeeAccess = true and ManagerAccess=false

  • "Benefits - Staff & Manager"

Hyphen found:

- category set to "Benefits"

- permissions = "Staff & Manager"

All documents within this folder will be uploaded with EmployeeAccess = true and ManagerAccess=true

If by giving access just to admins we need to set both flags (EmployeeAccess and ManagerAccess) to False, we can easily achieve that by creating a folder like "Benefits - none".

Putting the hyphen will indicate that we want to specify the permissions, but what follows (in this case "none"), must not contain the "staff" or "manager" keywords.

  • The filename will be used as the document name. The document date will always be the load date - it's not possible to set the original creation date.
  • A log file will be written to the to the program folder in a directory called "Reports". Please make sure this has read write permissions.

To run the program silently you use the following command from the command prompt:

dataloader.exe -load c:\folderpath

Thanks,

Customer Services Team

Did this answer your question?