Jump to content

Upload users: Difference between revisions

From IOMAD Docs
Created page with "The '''Upload users''' page is used for uploading users to a company, rather than creating them through the browser. It can be accessed through the IOMAD dashboard: # Go to the '''IOMAD dashboard'''. # Choose the company whose user(s) you'd like to edit from the '''Select a company''' dropdown (or use the company selector at the top right of the page). # Click on the '''Users''' tab. # Select '''Upload users'''. ==Uploading Users to a Company== The '''Upload users''' pa..."
 
 
(6 intermediate revisions by the same user not shown)
Line 5: Line 5:
# Select '''Upload users'''.
# Select '''Upload users'''.


==Uploading Users to a Company==
==Settings==
The '''Upload users''' page allows users to be uploaded to a company in bulk. This is done with CSV files.
The page allows you to provide the file's:
* '''Separator''' or delimiter - with the option of a comma, semicolon, colon, or tab.
* '''Encoding''' type.


It also has settings related to the upload process itself, allowing the user to define:
* The number of '''Preview rows''' - number of rows that will be previewed during the upload process.
* The '''Upload type''' - Whether duplicate users should be discarded, added, or updated.
==CSV Structure==
The '''Upload users''' page allows users to be uploaded to a company in bulk. This is done with CSV files, structured into columns.


If the '''''Upload type''''' is set to ''Update existing users only'', then only the '''username''' column is required.


The page allows you to provide:
If any other '''''Upload type''''' is set, then only the '''firstname''' and '''lastname''' columns must be filled.
* The '''Separator''' or delimiter - with the option of a comma, semicolon, colon, or tab.
 
* The '''Encoding''' type.
The following is a comprehensive list of all available columns (including both required and optional):
* The number of '''Preview rows''' - number of rows that will be previewed during the upload process.
* '''id''' - The user's unique id.
* The '''Upload type''' - Whether duplicate users should be discarded, added, or updated.
* '''firstname''' - The user's first name.
* '''lastname''' - The user's last name.
* '''username''' - The user's unique username.
* '''password''' - The user's password.
* '''temppassword''' - The user's temporary password.
* '''email''' - The user's email address.
* '''institution''' - The user's company.
* '''department''' - The user's department.
* '''deleted''' - Whether or not the user is to be marked deleted.
* '''suspended''' - Whether or not the user is to be marked suspended.
* '''auth''' - The user's authentication method, overriding the site's default.
* '''lang''' - The two- (or four-) letter language code for the user's language, defined in ''Site administration'' > ''Language'' > ''Language packs''. This will override the site's default.
* '''city''' - The user's city of residence.
* '''country''' - The upper-case two-letter ISO country code for the user's country of residence.
* '''timezone''' - The user's timezone, overriding the site's default.
* '''mailformat''' - The format of the emails the user receives: '''0''' (Plain text only) or '''1''' (HTML & Plain text), overriding the site's default.
* '''maildisplay''' - Whether the user's email is display in the From address, overriding the site's default.
* '''maildigest''' - The format of the user's Mail digest, and whether it exists: '''0''' (No digest), '''1''' (Complete digest) or '''2''' (Digest with just subjects).
* '''htmleditor''' - The user's preferred HTML text editor, overriding the site's default.
<!--* '''ajax''' - ? -->
* '''autosubscribe''' - Whether the user is auto-subscribed to forums.
* '''mnethostid''' - The '''M'''oodle '''Net host ID''' is the host id used to connect a user account across different Moodle sites.
* '''idnumber''' - The unique user id.
* '''skype''' - The user's [[wikipedia:Skype|Skype]] account.
* '''msn''' - The user's [[wikipedia:MSN Messenger|MSN Messenger]] account.
* '''aim''' - The user's [[wikipedia:AIM (software)|AOL Instant Messenger]] account.
* '''yahoo''' - The user's [[wikipedia:Yahoo Messenger|Yahoo Messenger]] account.
* '''icq''' - The user's [[wikipedia:ICQ|ICQ]] account.
* '''phone1''' - The user's primary phone number.
* '''phone2''' - The user's primary secondary number (e.g. a landline).
* '''address''' - The user's address.
* '''url''' - The user's website or external profile.
* '''description''' - A description of the user.
* '''descriptionformat''' - The format of the user description: '''0''' (Moodle format), '''1''' (HTML), or '''2''' (Plain text).
* '''oldusername''' - Used for renaming a users: Any user with oldusername as their username will have their data updated with this new upload-file.
 
[[Category:Users]]

Latest revision as of 16:08, 21 August 2025

The Upload users page is used for uploading users to a company, rather than creating them through the browser. It can be accessed through the IOMAD dashboard:

  1. Go to the IOMAD dashboard.
  2. Choose the company whose user(s) you'd like to edit from the Select a company dropdown (or use the company selector at the top right of the page).
  3. Click on the Users tab.
  4. Select Upload users.

Settings

The page allows you to provide the file's:

  • Separator or delimiter - with the option of a comma, semicolon, colon, or tab.
  • Encoding type.

It also has settings related to the upload process itself, allowing the user to define:

  • The number of Preview rows - number of rows that will be previewed during the upload process.
  • The Upload type - Whether duplicate users should be discarded, added, or updated.

CSV Structure

The Upload users page allows users to be uploaded to a company in bulk. This is done with CSV files, structured into columns.

If the Upload type is set to Update existing users only, then only the username column is required.

If any other Upload type is set, then only the firstname and lastname columns must be filled.

The following is a comprehensive list of all available columns (including both required and optional):

  • id - The user's unique id.
  • firstname - The user's first name.
  • lastname - The user's last name.
  • username - The user's unique username.
  • password - The user's password.
  • temppassword - The user's temporary password.
  • email - The user's email address.
  • institution - The user's company.
  • department - The user's department.
  • deleted - Whether or not the user is to be marked deleted.
  • suspended - Whether or not the user is to be marked suspended.
  • auth - The user's authentication method, overriding the site's default.
  • lang - The two- (or four-) letter language code for the user's language, defined in Site administration > Language > Language packs. This will override the site's default.
  • city - The user's city of residence.
  • country - The upper-case two-letter ISO country code for the user's country of residence.
  • timezone - The user's timezone, overriding the site's default.
  • mailformat - The format of the emails the user receives: 0 (Plain text only) or 1 (HTML & Plain text), overriding the site's default.
  • maildisplay - Whether the user's email is display in the From address, overriding the site's default.
  • maildigest - The format of the user's Mail digest, and whether it exists: 0 (No digest), 1 (Complete digest) or 2 (Digest with just subjects).
  • htmleditor - The user's preferred HTML text editor, overriding the site's default.
  • autosubscribe - Whether the user is auto-subscribed to forums.
  • mnethostid - The Moodle Net host ID is the host id used to connect a user account across different Moodle sites.
  • idnumber - The unique user id.
  • skype - The user's Skype account.
  • msn - The user's MSN Messenger account.
  • aim - The user's AOL Instant Messenger account.
  • yahoo - The user's Yahoo Messenger account.
  • icq - The user's ICQ account.
  • phone1 - The user's primary phone number.
  • phone2 - The user's primary secondary number (e.g. a landline).
  • address - The user's address.
  • url - The user's website or external profile.
  • description - A description of the user.
  • descriptionformat - The format of the user description: 0 (Moodle format), 1 (HTML), or 2 (Plain text).
  • oldusername - Used for renaming a users: Any user with oldusername as their username will have their data updated with this new upload-file.