User profiles can also be quickly imported using a .csv, .xls, or .xlsx file. This is especially helpful when an integration with a customer's access control, point-of-sale, or time and attendance system does not exist. Please carry out the following steps to setup and run a user profile import using this method.
Access control systems that support exporting data into a CSV file:
- AccessNSite
- CCURE
- ICT Protege GX
- Honeywell ProWatch
- Napco CardAccess4K
Automatic Import:
Prior to installation, please ensure that you have a 64-bit operating system.
Start by running the application installer (labelled CSVImportTool) as an administrator.
The installer will create a folder within the C: Drive labelled “pi-csv-import-utility”:
Right click and run the executable within it (labelled “csv-import”) as an administrator.
Once opened, you’ll see the fields for the URL/link, username, and password for the IDS. You can choose to trust the self-signed certificate if you’d like or use your own if you have added any to your IDS.
You can verify that it’s running by checking your Services. It’ll be listed under the same name as the folder and will begin running after the initial import. The tool will continue to run in the background.
Populate these fields and select “Test Connection”. If the connection was made successfully, you’ll see a green “Connected” symbol appear next to the button. If the connection wasn’t made, you’ll see a red “Authentication Error” appear:
Under Check for updates, the Manual selection will force an upload of the entire csv file. If instead you select a time interval, an incremental update will be performed according to the schedule. Optional features for the import are the ability to add portraits, and enroll portraits to the uploaded users. You also have the option of deleting users missing from the file from the IDS. Once you’ve selected your options, select “Select Import File”, and if you’re using portraits, “Select Portrait Folder”:
You also have the ability of customizing the columns for the Excel file as well. The standard ones are configured by default:
Once you have the column headers mapped, select “Import” to import the CSV file into your IDS. If the file was imported successfully, you’ll see a green “Upload Completed, “see import report & the file path (ex: C:\pi-csv-import-report-utility\importReport.csv)”:
To uninstall the application, you can go to apps & features, then select “Uninstall”:
Manual Import:
Create the Import File
The following user data fields can be imported into Identity Server. Please note that certain fields are required.
- First Name (required)
- Middle Name
- Last Name (required)
- Facility Code (required)
- Card Number
- PIN
- Internal ID (required)
Those users exporting their user profile information from another system can create their own .csv/.xls/.xlsx file and then use the sync setup steps to map the information to the correct field in Identity Server during the import step. Alternatively, users can leverage the blank template linked at the bottom of this article.
Setup the Synchronization
1. Log into your Identity Server instance.
2. Click "Settings" along the top of the screen. Then click "Sync" on the left-hand side of the page.
3. In the sub-window that appears, click "Setup Sync". In the pulldown menu that appears, select File (CSV, XLS, XLSX) then click "Continue".
4. Click "Edit Settings" and set the following:
- File Upload: Click "Browse for file..." and select the file. Click "Open".
- Delete Missing People: if this box is checked, any profiles in IDS that are not present in the .csv/.xlsx/.xls file will be deleted from Identity Server.
- Skip Header Row: Select this option if the first row of the file you are using for upload has column headings.
- Remaining fields (First Name Column, Middle Name Column, etc.): Enter the column number for the respective field to be uploaded. i.e. enter "1" for column A, "2" for column B, and so on.
5. Click "Apply".
6. Once the sync is complete you will be able to see all user profiles by clicking on the People page.
NOTE: If you make any changes to the .csv/.xls/.xlsx file after each upload, you must click "Edit Settings>Browse for file...", select the file again, and click "Open". You cannot just click "Run Now".
7. Click HOME on the navigation bar at the top of the screen. Here you will now see a notification that the IDS is due to synchronize with a file, as well as the current progress of the synchronization process.
NOTE: The portrait file path will be cached in the tool. In order to clear it, point the portrait section to a blank directory (ex: C: Drive) prior to running the sync.