The non-interactive patron import allows your IT Manager to set up a rolling group import facility between your school's administration system and Infiniti. This is a "set and forget" import facility which, once set up, will run according to the schedule implemented by your IT Manager. This process allows your school software to 'push' a CSV file of records into Infiniti at scheduled intervals. An interactive group import is also available as an alternative method for importing groups by manually importing a CSV file.


Note: Patrons can only be imported into pre-defined library groups. Define required library groups before importing.


Before Getting Started


Infiniti's non-interactive group import and update tool provides your school with a means of automating the synchronisation of group information from your Student Management System or other appropriate source. Much like the interactive group import, this automated process accepts CSV (Comma Separated Value) files that you, or your IT team, have generated from your internal systems. 


This facility utilises a script created and scheduled by the school's suitably qualified IT Technician. The script is not intended for use by library managers or library staff and does not run in a browser. As an alternative, you can choose to use the interactive group import


Prior to commencing the setup of Automatic Patron Import and Update please ensure you are familiar with the following:

  1. How to extract information, in CSV format, from your Student Management System;
  2. The use of your preferred scripting tool and language; 
  3. Basic knowledge of cross-platform non-interactive web agents (we recommend cURL or similar);
  4. You school's Infiniti URL, this will be similar to the following: yourschool.concordinfiniti.com;
  5. The username and password of an account in your school's Infiniti with system administration privileges.

The CSV File

The first step in automating the synchronisation of your group information is to create the CSV file which will be used by your script to import / update your users. The non-interactive user import requires specific header column names in the CSV file in order to recognise user attributes.

The CSV File you upload to Infiniti through this script MUST contain the following fields:

username: is is the unique identifier used to identify each Infiniti user

library-group: is a defined library group in Infiniti

system-group: is a defined system group in Infiniti

 

The Non-interactive Script


Once your CSV is ready your import script is prepared by a suitably qualified IT technician and will HTTP POST a CSV file of users, extracted from your student administration system or similar source of user data, to this URL: https://[school.concordinfiniti.com]/api/import/users.


Infiniti will treat the first multi-part file of the HTTP POST as the CSV file - the file name and form attribute name of the post are ignored. The CSV file may be empty for schools performing scheduled incremental imports.


The action is protected by HTTP Basic Auth over SSL/TLS. You will need to provide the username and password of a new or existing user with system administration privileges in Infiniti. Good practice would be to create a new user in Infiniti, e.g., autoimport, and grant this user system administration privileges. As SAML Single Sign-On requires a browser, the credentials for this user cannot be verified via SAML; one of the other credential sources will be required.

 

Your school's script can be implemented in any fashion chosen by your IT technicians. An example of how a script may post the CSV file to Infiniti is the cURL application, a cross-platform non-interactive web agent:

 

curl -k -X POST -F "file=@user-groups.csv" https://[user]:[password]@[host]:[ssl port]/api/import/userGroups?tenantId=[tenant]

 

The user CSV file will be processed in the same manner as the interactive import.

 

Results of Processing


When complete the script will produce a JSON result array: 

  'success' - Whether all user records imported without error 

  'summary' - A summary of the import action; successful or otherwise. 

  'details' - An array of each user row outcome. Only included if some rows failed to import. "row number" -> "row outcome" 

  

A JSON result array can look like: 

 

{"success":true, "summary":"100 users processed. 50 users created. 50 users updated. 0 users failed."}

 

or 

 

{"success": false, "summary":"Unauthorised. Check credentials."}

 

or 

 

{
  "success": false,
  "summary": "3 users processed. 1 user created. 1 user updated. 1 user failed.",
  "details": {
    "1": "User Updated",
    "2": "Field (emailAddress) is not a well-formed email address. User failed to import: Field (emailAddress) is not a well-formed email address. ",
    "3": "User Created"
  }
}