Setup Guide: Update Users via CSV (Beta)

Update Users via CSV saves you time administering your ActivTrak account by using your preferred system to manage users and groups. Update Users via CSV enables exporting user and group information for automatic, seamless configuration in ActivTrak.

With Update Users via CSV, Admins can:

• Update user information
• Create and update Groups
• Add users to the Do Not Track list
• Add and remove users from Groups
• Delete Users (i.e., free up license/s)

Update Users via CSV leverages the group/user organizational information stored in your system of record (e.g., HRIS, Google Groups, etc). This solution involves exporting user and group attributes from the source application to a CSV file, then sending the CSV to ActivTrak via the API.

Contents

• Requirements
• Setup instructions
  • Exporting data from the source application
  • Sending the exported CSV file via API
• Validating the Automation

Requirements

• A current ActivTrak paid plan
• Deployed ActivTrak Agents that have started to collect activity data
• The ability to export user data from your source application to a CSV
• The ability to send the CSV via API

Setup instructions

Exporting data from the source application

1. Update Users via CSV supports the following attributes:

2. From your HR application, export the attributes needed for your use case (make sure to use the exact column names). Export 10 users initially, then over time, expand to your desired number of users
3. Optional: To update User information:
   • Include the required column “user_lookup_id”
   • Add the “employee_id” column, if being updated
   • Add the “email_address” column, if being updated
   • Add the “display_name” column, if being updated
   • Save CSV (e.g., UserInfo.csv)

4. Optional: To manage groups:
   • Include the required column “user_lookup_id”
   • Add the “group” column
   • Provide the group name to which the employee will be added
   • If there are multiple groups an employee must be part of, send additional rows with the same information but with a new value in the group column
   • If using ActivTrak’s Azure AD integration, avoid using the same group name in order to prevent issues during group updates
   • The CSV is treated as a full snapshot of the membership of those groups. So if you're adding Sam to Group A, you will need to include all members of Group A in the CSV, then add a row for Sam to add him to it. On a second upload, if Group A is not present in the CSV, Group A will be deleted altogether.
   • Save CSV (e.g., GroupMembership.csv)

5. Optional: Use Update Users via CSV for deleting User data or excluding Users from tracking
   • Include the required column “user_lookup_id”
   • Add the “delete_user” column, if being used and add a ‘y’ for the user
   • Add the “track” column, if being used and add an ‘n’ for the user
   • Save CSV (e.g., DNT-Delete.csv)

Sending the exported CSV file via API

1. Create an API key from within the ActivTrak app: https://app.activtrak.com/#/app/integrations/apikeys
2. Submit your CSV by making an API request to the HRDC API via the /bulk endpoint
   • US instances: https://api.activtrak.com/hrdc/v2/bulk
   • EU instances: https://api-eu.activtrak.com/hrdc/v2/bulk
   • Other regions: Check our API documentation for your specific base URL
3. Authorize by using your API key and setting headers:
   • key = 'your API key value'
   • headers = {'x-api-key':key}
4. Within the request body, use file form-data to include the CSV filename. For more
   information about the /bulk endpoint, see API documentation
5. Alternatively, you may use the API Explorer to individually submit your CSV using
   your API key

Validating the Automation

1. See the Users page to verify the updated User information
2. See the Tracking column for the User in the Users page to verify Do Not Track settings
3. See the Agent column for the User in the Users page to verify Deletion. It should say ‘0’
4. See the Groups page to verify group information

Automation

1. Update Users via CSV initially attempts to match the received users to their equivalent ActivTrak Users. Once this is successful, the integration automatically updates the Users page, the groups, the Do Not Track setting, and/or the deletion from the Users list. If Users are not found, no update is made (unless enabled to create new users if no match is found).
2. Only Groups with matched Users are created in ActivTrak
3. If you need to remove users from the Do Not Track List, it is recommended that you use the Users page to start tracking those users

For any questions or issues, please contact integrations-feedback@activtrak.com