ELIS 1.9 Manual

ELIS Data Hub

Batch Importing Users

Users can be loaded into ELIS and Moodle via a CSV file. The name of the this file is indicated in the File name field, shown by #1 in the image below. This is configurable, for example if your record system's user export process produces a file called users.csv, or people.csv, you can type that name in the File name (1) field and save changes. Where values are the same in both ELIS and Moodle (for instance First Name) the values will be synchronized to Moodle when the user is enrolled in a Moodle course.

Currently ELIS Data Hub only supports csv files, however subsequent versions may support XML, webservices, etc. At present, you can only choose csv.

2. The user properties mapping table enables you to map the names of user properties from your export file to properties in ELIS DH.

User tab

The parameters that can be set or updated in the user import file:

ELIS Data Hub user property map

idnumber: The user's idnumber
username:
the username - a user logs in with
password:
This will create or update the user's password
firstname:
The user's firstname, as in Harry
lastname:
The user's lastname, as in Truman
mi:
The user's middle initial, as in S
email:
The user's email
email2: A second email if the user has one
address:
The user's address- as in 500 W. US Hwy. 24
address2:
The rest of a user's address - as in Apt. 1
city:
The user's city, as in Independence
state:
The user's state, as in MO
country:
The user's country
phone:
The user's phone #
phone2:
The user's second phone #
fax
The user's fax
postalcode
The user's postal code
birthdate:
The user's birthdate.
gender:
The user's gender
language
Currently the site default is used for this entry.
transfercredits:
Credits the user has earned in another system
comments:
Any comments about the user
notes:
Notes on the user
inactive
Enter 1 for inactive. Enter 0 for active. The default value for new users is active.
theme:
Set a theme for the user*, e.g., metal.
auth:
Enter an authentication type here. The example below this chart has more information.

Authentication (auth): Follow the steps below to find the value that should be entered for different authentications. This is not a required field, if a value is not entered then the default authentication will be used.
  1. Go to the Site Administration block > Users > Authentication > Manage Authentication.
  2. Mouse over (do not click) the Settings link of the authentication type, this will display the url shown by step 3.
  3. The end of the url displays the name that should be entered as a value in the csv file, the example is showing that "radius" should be entered for the Radius server authentication.
Manage authentication screen

The following list is showing the names of standard authentications and the entries that should be made for each authentication in the csv file.

Authentication Names CSV Entries
Manual accounts manual
No login nologin
Email-based self-registration email
Dummy authentication plugin for ELIS elis
Dummy authentication plugin for Mahara mahara
Moodle Network authentication mnet
Alfresco SSO alfrescosso
OpenID openid
CAS server cas
Curriculum Management System Authorization crlm
External database db
FirstClass server fc
IMAPserver imap
LDAP server ldap
NNTP server nntp
No authentication none
PAM (Pluggable Authentication Modules) pam
POP3 server pop3
Radius server radius
Shibboleth shibboleth


The required fields for importing user files are:
  1. idnumber
  2. username
  3. password
  4. firstname
  5. lastname
  6. email
  7. country
  8. execute/action - The available actions are add, update, and disable. Disable will delete users from ELIS and Moodle.


Data Hub Actions:
ELIS Data Hub tells ELIS what needs to be done with imported data via the Actions column. The sample report below illustrates this function:

Example of a ELIS Data Hub user file

In the image of the user file above:
  • Bob is being added to the site. The format for the phone number entered for Bob will be in the same as shown in the file. A "metal" theme is also set for this user, when this user logs in they will see that theme.
  • Lee is being added to the site. The format for the phone number entered for Lee will be the same as shown in the file. A "standard" theme has been set for this user.
  • Phil's profile is being updated. Phil is being marked as inactive, a "1" has been entered in the inactive column. "1" sets a user to inactive, and "0" sets the user to active.
  • Janet is being disabled. She will be deleted from ELIS and Moodle records.
When a user is disabled they are deleted from ELIS and Moodle.

To download the file in the example above, select this link.

The following list has a few examples of password entries:
  • changeme - if changeme is entered for the password, users will be forced to change their passwords when they access the site.
  • * - if * is used for the password, the user will be able to login with * regardless of password requirements.
  • no entry - if there are password requirements for the site, users with no entry for their password will not be added to the site.

A complete log of all actions is kept in the logs file, as well as (optionally) is emailed to an address or addresses each time the DH script runs.


* Requires that User themes are enabled in the Admin/Appearance settings of Moodle