Before continuing, please note that the formatting of the template file, including proper capitalization, is very important.

Any incorrect or extraneous information may have unintended results and/or cause the import to fail. If you have any questions or would like your import to be tested, feel free to contact the help desk for assistance.

Note: Modifying and/or removing any of the column headers from the template will cause the import to fail.


Instructions

  1. From the Users page, hover over the quick dial then select Import Users
  2. Click “DOWNLOAD USER IMPORT TEMPLATE
    1. Note that row 1 (containing the column headers) must remain as is for the import to be successful
  3. Open the template CSV file and input the users’ information
    • The required fields are: LastName and FirstName
    1. In a tenant that is not linked with Engage, the BadgeId column should contain either the hot-stamped number printed on the user’s badge, a keypad code, or a mobile/bluetooth Device ID number.
      • To import multiple credentials for a single user, they will need more than one row in the CSV (one row for each credential being added)
    2. CredentialType will need to be either a “1” (if the credential is a badge), “2” (if it’s a keypad), or “3” (for mobile/bluetooth credentials).
    3. To add users to user groups, populate the UserGroups column using the following formatting and notes:
      1. Ensure that the user group(s) already exist in Pure Access. The user import will not create new groups.
      2. Ensure that the capitalization and punctuation of the group(s) are correct
      3. To add a user to multiple groups, you will need to separate the names of the groups with a semi-colon (;) without spaces. For example, to add a user to the All Users and Managers groups, the cell would contain: All Users;Managers
      • Note: If the UserGroups field is not populated or if there is a typo, the user(s) will not be assigned to a group
  4. If areas are being used in this tenant, please review the following formatting and notes:
    1. Ensure that the area(s) already exist in Pure Access. The user import will not create new areas. If an AreaName cell is populated with an area that does not exist in Pure Access, the user will be placed into COMMON.
    2. Populate the AreaName column
    3. Ensure that the capitalization and punctuation match the area(s) in Pure Access
  5. The columns titled CountLimitFlag, RemainingUses, and ExpirationDate do not require data for the import to be successful. These columns must remain in the CSV for the import to function, however.
    1. If you wish to set an ExpirationDate on one or more credentials, you can do so using the date format: yyyyMMdd
      • Example: April 1st, 2022 would be 20220401
    2. If you wish to set a count limit on one or more credentials, CountLimitFlag will need to be true (the cell will need to contain a “t”) and the RemainingUses cell will be the number of times the credential can be presented before it is deactivated
  6. If it had been closed, once again select the Import Users button from the Users page
  7. Drag the .csv file into the upload area then click
  8. Validation will be run against the uploaded file
    1. If any errors are found, a table will be displayed to give feedback on the exact issues found with the import. When you hover on the red cell with your mouse, you will be able to see helpful tips on the exact error found.
      1. Use this feedback to address any issues found directly in the CSV file. Once done, click and then attempt to import the file again starting from Step 1 above.
    2. If no errors are found, click
      1. Depending on the size of the import, it could take from a few seconds to a few minutes to complete the user import. You can continue to use the application while the import is processed in the background. You will see a snackbar notification to let you know once the import has completed.

Was this helpful?

Yes No
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.