CSV source file format
Column headings on the first line, data on subsequent lines with unix line endings.
Fields are surrounded by double quotes inside which commas have no special meaning. Double quote characters inside a field must be escaped using an additional double quote.
Organisations and positions
Heading | Format | Notes |
|---|---|---|
idnumber | 1-100 characters | Unique for each hierarchy item. |
timemodified | unix timestamp | Last time item detail changed. |
frameworkidnumber | 1-100 characters | idnumber matching an existing hierarchy framework. |
shortname | 1-100 characters | This field can be empty. |
fullname | 1-1000 characters | |
parentidnumber | 0-100 characters | Matches the identifier field of another hierarchy item. Empty for top level. |
description | up to 1000 characters describing the org | This field can be empty. |
typeidnumber | 0-100 characters | Matches the identifier of an existing item type. Multi-select fields are not permissible. |
customfield_[shortname] | Up to 1000 characters | Custom field data. Multiple columns allowed, where the column heading matches the type's custom field shortname. If no match, nothing will be updated. Multi-select fields are not permissible. If the custom field type is date format then the data in the field needs to match the format defined under Location > Location settings > CSV import date format. |
Users
When the suspended field has a default value then erasing existing data in the field will mean the default value will be stored in the field.
Heading | Format | Notes |
|---|---|---|
idnumber | 1-100 characters | Unique for all users (never changes for a given user) Use the value shown in the Users profile Optional field ID number. Check the *ID number* value exists for existing users If you want to update existing user's profile fields. |
username | 1-100 characters | Unique for all users. |
timemodified | unix timestamp | Last time the user's details changed. Note if the same value is imported on a subsequent sync then the sync records will not be updated. |
deleted suspended | 0 or 1 0 or 1 | Required when only users to create, update or delete/suspend are provided, otherwise not necessary. 0 => do nothing, 1=> deleted/suspend. No action assumed if empty. However, when an empty suspended field is included in the User source for new records and the Empty strings erase existing data option has been chosen, the added user gets the default value of Active. The erasing of the data doesn't mean there is no value in the field if the field has a default value. |
firstname | 1-100 characters | No leading or trailing space characters. |
lastname | 1-100 characters | No leading or trailing space characters. |
firstnamephonetic (optional) | 1-100 characters | No leading or trailing space characters. |
lastnamephonetic (optional) | 1-100 characters | No leading or trailing space characters. |
middlename (optional) | 1-100 characters | No leading or trailing space characters. |
alternatename (optional) | 1-100 characters | No leading or trailing space characters. |
valid email address, max 100 chars | Unique for each user. | |
emailstop | 0 or 1 | Disables non-essential system generated email notifications. Note this does not effect the 'Welcome' new user/Revived user email. Other emails not stopped include
|
country | 2 character ISO 3116 country code (e.g. NZ => New Zealand) | |
city | 120 characters | |
timezone (optional) | 1-100 characters | A location-based timezone identifier e.g. America/New_York, Europe/London, Asia/Singapore etc. See http://us.php.net/manual/en/timezones.php for a list of all location-based timezones. |
lang (optional) | 1-30 characters | 2 char ISO 639-1 code. |
description (optional) | 1-1000 characters | - |
url (optional) | 1-200 characters | - |
institution (optional) | 1-40 characters | - |
department (optional) | 1-30 characters | - |
phone1 (optional) | 1-20 characters | - |
phone2 (optional) | 1-20 characters | - |
address (optional) | 1-70 characters | - |
auth (optional) | FORMAT: | This is the list of default Authentication types in Totara. Make sure the plugin is enabled before using: If using a custom Authentication plugin then use the name of that plugin for this field. |
manual | Manual accounts | |
nologin | No login | |
Email-based self-registration | ||
cas | CAS server (SSO) | |
db | External database | |
fc | FirstClass server | |
gauth | GoogleOpenidAuthentication | |
imap | IMAP server | |
ldap | LDAP server | |
mnet | MNet authentication | |
nntp | NNTP server | |
none | No authentication | |
pam | PAM (Pluggable Authentication Modules) | |
pop3 | POP3 server | |
radius | RADIUS server | |
shibboleth | Shibboleth | |
webservice | Web services authentication | |
| password (optional) | 1-32 characters | If the password column is included and the CSV file has an empty password field then a welcome email is sent. Note that this only works when adding new users. |
orgidnumber (optional) | 1-100 characters | Matches valid organisation idnumber. Null assumed if not provided. |
postitle (optional) | up to 100 characters, space, ampersand, parentheses, forwardslash | Primary position title. |
posidnumber (optional) | 1-100 characters | Matches valid position idnumber. Null assumed if not provided. |
posstartdate (optional) | CSV import date format | Data in the field needs to match the format defined under Location > Location settings > CSV import date format. |
posenddate (optional) | CSV import date format | Data in the field needs to match the format defined under Location > Location settings > CSV import date format. |
appraiseridnumber (optional) | 1-100 characters | Null or matches valid user idnumber. Null assumed if not provided. |
manageridnumber (optional) | 1-100 characters. | Null or matches valid user idnumber. Null assumed if not provided. |
customfield_[shortname] (optional) | 1-1000 characters. | Custom field data. Multiple columns allowed, where the column heading matches an existing user custom field shortname. If no match, nothing will be updated. Multi-select fields are not permissible. If the custom field type is date format then the data in the filed needs to match the format defined under Location > Location settings > CSV import date format. |
