Note: if you have not produced the HR data required for the Standard HR Importer, please review HR Data Import and Elements User Groups 

In this article, <Downloaded_Media_Folder> refers to the location to which you unzipped the Elements installation download. If you followed the recommendations in the Elements Installation Guide this will be something like "C:\Symplectic\Builds\elements-5.3.0.1152-x86".

<Main_Installation_Folder> refers to the location where the Elements binaries are installed. If you followed the recommendations in the Elements Installation Guide this will be something like "C:\Symplectic\Elements\".

The Standard HR Importer is not installed automatically with the main Elements build, as not all institutions use it. This article will walk you through copying it manually from <Downloaded_Media_Folder> and configuring it against a compatible Elements API endpoint.

You must first have a working secure Elements API endpoint set up in the Elements instance you want to import users into. If this is not yet set up, please see Manage the Elements API and How to get a secure Endpoint going for guidance.

If you are installing the Standard HR Importer for the first time:

1. copy the folder <Downloaded_Media_Folder>\StandardHRImporter to the <Main_Installation_Folder> on your Elements server.

If you are upgrading the Standard HR Importer: 

1. Backup your old <Main_Installation_Folder>\StandardHRImporter folder to a safe location.

2. delete <Main_Installation_Folder>\StandardHRImporter.

3. Copy the upgrade to <Main_Installation_Folder>\StandardHRImporter.

4. Restore your old configuration settings by copying the file Symplectic.StandardHRImporter.exe.config from your backup to <Main_Installation_Folder>\StandardHRImporter.

5. If your .csv/.xml formatted HR import file was located in the old folder, copy that to the upgraded folder also.

Next, make sure that the Standard HR Importer configuration corresponds to your API configuration by editing the file: <Main_Installation_Folder>\StandardHRImporter\Symplectic.StandardHRImporter.exe.config

Change all three elements to correspond to the API Endpoint and Account that you have set up for the HR import. For example:

<add key="elements-api-url" value="https://localhost:8123/elements-api/v4.9/"/>
<add key="secure-api-account-username" value="username"/>
<add key="secure-api-account-password" value="password"/>

You also need to make sure that the path to the .csv/.xml file you want to import is correct. For example:

<add key="hr-data-location" value="\StandardHRImporter\sample48.xml"/>

Feeding Elements with HR data is a two-stage process:

1. Run the file <Main_Installation_Folder>\StandardHRImporter\Symplectic.StandardHRImporter.exe, either through a command prompt or by double-clicking it. The Standard HR Importer feeds the HR data through the Elements API to a staging table in Elements.

2. Run 'Database: Process HR feed' in Elements (System Admin > Operations > Scheduled Jobs) to apply the new HR data to the Elements system.

When the Standard HR Importer runs, it will generate log files and save them in the <Main_Installation_Folder>\StandardHRImporter\logs folder. The 'notes' files will describe the steps taken; and if there were any problems they will be listed in the 'errors' files. Any errors will need to be resolved before the second stage of the HR Feed should be run.