Skip to main content

Upload documents in bulk with Document Loader tool

Load a number of documents from your computer into employee records.

J
Written by Joshua Shooter
Updated over 2 months ago

As a PeopleHR administrator, you can upload new documents from a directory on your computer to employees' records on PeopleHR using the external Document Loader tool.
โ€‹
Alternatively, you can upload documents in bulk with a CSV file in the Advanced Document Loader tool.


Permissions

You set permissions for documents when you create your API key and through folder naming conventions.

  • The two security flags that you can set in your API key with all document endpoints are EmployeeAccess and ManagerAccess. By default, the flags are true.

  • Folder name format: {Category} - {Permissions}.

  • The file name is the document name and its document date is the load date.

  • Give the log file written to the program folder in the directory named Reports read-write permissions.

With this tool, you pick up all the child folders and apply the permission rules as follows:

Folder name

Permission rules

Benefits

  • Category: Benefits.

  • Access flags:

    • EmployeeAccess: True.

    • ManagerAccess: True.

Benefits - Manager

  • Category: Benefits.

  • Permissions: Manager.

  • Access flags:

    • EmployeeAccess: False.

    • ManagerAccess: True.

Benefits - Staff

  • Category: Benefits.

  • Permissions: Staff.

  • Access flags:

    • EmployeeAccess: True.

    • ManagerAccess: False.

Benefits - Staff & Manager

  • Category: Benefits.

  • Permissions: Staff and Manager.

  • Access flags:

    • EmployeeAccess: True.

    • ManagerAccess: True.

Custom
โ€‹
Example: Benefits - none

  • Category: Benefits.

  • Access flags:

    • EmployeeAccess: False.

    • ManagerAccess: False.

  • Permission: Use other words than staff or manager when replacing none in this example.


Set up the Document Loader tool

To set up the Document Loader tool, follow the below steps:

  1. Download the Document Loader tool.

  2. Locate the file on your computer.

  3. Right-click the file and select Run as Admin.

    ๐Ÿ“ŒNote: You can run it in both silent and interactive modes.

    • To use an API key, run it interactively.

    • To run the program silently, use the following command from the command prompt: dataloader.exe -load c:\folderpath

  4. Create an API key containing all document endpoints.

  5. When running, click the settings icon then enter your API key.

  6. Click Browse.

    ๐Ÿ“ŒNote: You can now view a root folder containing folders for each employee.

    image.png
  7. Name the folders within the root folder following this format: Employee name - PeopleHR Employee ID. For example, Fred Bloggs - PW35.

Did this answer your question?