Importing Learners

Knowledge Anywhere allows for mass import of learners. There are several data requirements to import new learners or update existing learner data using Knowledge Anywhere's CSV template or the Knowledge Anywhere Public API.

Importing Learners via CSV File Upload

Learner Import Template (click to download)


1.All Learners by default, require the following three fields:

    • First Name
    • Last Name
    • Email
2. Any column headers of customized fields that were previously created will be overwritten by the column headers of the imported CSV template.
Note: You can download the CSV template from Learners>Import learners in the Administrative Dashboard, as shown below, you'll click the "Get Template" button:


3. Drag or upload the import template to the box at the bottom. It will then show a preview of the first five rows. If there are any issues with the import, they will be listed in the bottom. In the example below, There is an issue with the Active/Inactive status being spelled appropriately. It is also visible because the issue was seen in the first five. If there are more issues, they will be listed at the bottom.

 

4. The file will begin processing. You do not have to stay on this page. Consult the Import Learners History for a status update. 

 

5. Once completed, you can view the import details. There's several issues regarding this import, and you can review the exact issues and correct them.

 

6. After clearing the errors, you can try the upload again. "Learner provisioned successfully." is the status you want to see, or, Preferences successfully updated if you're importing an already existing learner. 

 



Be aware that only 4,000 Learners can be imported at a time. 


Importing Learners via API

Learners imported via our Knowledge Anywhere Public API have similar data validation requirements, as summarized in the table below: 

Password Plain text password (optional). There is a minimum length requirement of 6 characters. If you create a learner without a password, then they will be required to set a password upon login.
Active

TRUE / FALSE

If no value is present, defaults to TRUE and makes/keeps the learner active.

Send Initial Email

TRUE / FALSE

Sends email to learner upon account creation and provides more information for logging into the system. You can find and customize the email template under Site > Notifications > API learner Registration No Password / With Password.

If no value is present, defaults to TRUE and will send an email to all learners listed on the import. 

Force Password Change

TRUE / FALSE

Requires learner to change their password after initial login. This can be helpful if a default password is set upon creation.

If no value is present, defaults to TRUE, and will force the learner to set a unique password upon their first login. 

Locale example: en-us, es-es, fr-fr

The 4-6 letter language code. Read Can I translate the LMS into other languages? to learn more about the languages supported in Knowledge Anywhere's LMS.

Defaults to en-us. If a invalid locale is passed in, the learner will be created/updated, but will return a warning.

Registration Code Example: wewillrockyou

If your system uses registration codes for learners to self register, use this field to assign that code to the learner. The value passed in must match a value in learners > Registration Codes. If no match is found the request will result in a 400 bad request and the learner will not be created/updated.

State Example: WA

The 2 or 3 letter state/province abbreviation for the learner.

Country example: US

The 2 or 3 letter ISO country code country for the learner. See https://www.iso.org/iso-3166-country-codes.html for the list of valid country codes. Defaults to US. If a invalid country is specified, the operation will continue, but a warning will be thrown.

Custom Fields

Name: If you have custom fields enabled, you will need to update the name of the field exactly as it is in the system.

Values: The value can be a single value or a comma separated string. If the property is not matched to an existing value, it will be created.

Site Name

Only for available for Professional and Enterprise customers who have Extended Enterprise enabled. Allows you to select which site learner belongs to and must match site name exactly as listed under Site > Personalization.

If no value is present, defaults to Main Site.

SSO ID example: piper@knowledgeanywhere.com

Unique identifier utilized by the Single Sign-On system integration used to uniquely identify this learner for sign-on. If you would like your learners to be able to SSO, include this value.

External ID

example: piper@knowledgeanywhere.com

Unique identifier for the learner and can be used in Public API calls.

Defaults to learner's email address. Once the external id is changed to something other than email, the external ID cannot be changed at a later date.