User Data Loader Field Reference

Use the reference table below to help you correctly format the user data you want to import via the User Data Loader.

To import user data via the User Data Loader, your user role must have unrestricted access to the User Data Loader feature in System Roles (Manage Features > User Manager Features).

To import user data and review previous imports, go to Manage Center > Users > User Data Loader

More than five levels of organization hierarchy can be included in the CSV file if there are more than five levels defined in the LMS.

Table: User Data Loader Field Reference

Field Content Data Handling
Action Control Action (Either Add, Delete or Update) Must be "A", "D", "U", or "AU" (Add, Delete, Update, Add or Update as appropriate)
UserID User ID A Unique ID That Conforms to PeopleFluent LMS ID constraints. User IDs are stored in lowercase. (Max field length: 85 characters)
BirthDate(dd-mmm-yy) Date of Birth

The following date formats are supported:

  • dd-mm-yy (e.g. "31-12-13")
  • dd-mm-yyyy (e.g. "31-12-2013")
  • dd-mmm-yy (e.g. "31-dec-13")
  • dd-mmm-yyyy (e.g. "31-dec-2013")

Enter NONE for no specified date.

For dd-mm-yy and dd-mmm-yy formats where the year component may be ambiguous, the date is assumed to be in the past unless it results in a date that is over 80 years ago, in which case it will be assumed to be a date in the future.

City Contact Info - City Any Text (Max field length: 50)
Company Address 1 Contact Info - Address 1 Any Text (Max field length: 150)
Company Address 2 Contact Info - Address 2 Any Text (Max field length: 150)
CompanyName Contact Info - Company Name Any Text (Max field length: 50)
Cost Center Cost Center Any Text (Max field length: 45)
Cost Center Name Cost Center Name Any Text (Max field length: 85)
Country Contact Info - Country Any Text (Max field length: 3)
Note: ISO 3166-1 alpha-3
DeptId Department ID Any Text (Max field length: 85)
Department Department Name Any Text (Max field length: 85)
Direct Appraiser Manager -- whoever can authorize

This must be a PeopleFluent LMS User ID.

If System Configuration option "Require Direct Appraiser or Organization Approver to exist for User CSV upload" is enabled then it is required that the Direct Appraiser's User ID should already exists in the system or the non-existing Direct Appraiser has to be defined for creation in a row that is before assigning the Direct Appraiser to a user within the CSV file. If the option is disabled, then it is not required that the Direct Appraiser's User ID should already exist in the system.

System will not automatically create the missing user.

Email E-mail Address Valid E-mail (Max field length: 150)
Employee Num Employee Number Any Text (Max field length: 85)
EmploymentCountryCode Contact Info - Country Any Text (Max field length: 3)
Note: ISO 3166-1 alpha-3
ExpirationDate Expiration Date

The following date formats are supported:

  • dd-mm-yy (e.g. "31-12-13")
  • dd-mm-yyyy (e.g. "31-12-2013")
  • dd-mmm-yy (e.g. "31-dec-13")
  • dd-mmm-yyyy (e.g. "31-dec-2013")

Enter NONE for no specified date.

For dd-mm-yy and dd-mmm-yy formats where the year component may be ambiguous, the date is assumed to be in the past unless it results in a date that is over 80 years ago, in which case it will be assumed to be a date in the future.

ExternalAuthentication External Authentication "Y" or "N". Defaults to "N".
FamilyName Surname or Last Name Any Text (Max field length: 85)
Gender Gender Any Text (Max field length: 1)
GivenName First Name Any Text (Max field length: 85)
HR Mgr For E-mails / Approvals Any Text (Max field length: 85)
Special Cases
HR Mgr Email For E-mails / Approvals Any Text (Max field length: 85)
LanguagePref Language ISO 2-char codes: en, fr_CA, es_ES,...
ManagerName Manager Name Any Text (Max field length: 85)
ManagerEmail Manager E-mail Any Text (Max field length: 85)
Job Title Title of Employee Any Text (Max field length: 85)
Join Date(dd-mmm-yy) Date the Employee Joined the Company

The following date formats are supported:

  • dd-mm-yy (e.g. "31-12-13")
  • dd-mm-yyyy (e.g. "31-12-2013")
  • dd-mmm-yy (e.g. "31-dec-13")
  • dd-mmm-yyyy (e.g. "31-dec-2013")

Enter NONE for no specified date.

For dd-mm-yy and dd-mmm-yy formats where the year component may be ambiguous, the date is assumed to be in the past unless it results in a date that is over 80 years ago, in which case it will be assumed to be a date in the future.

Location Code Location Code Any Text (Max field length: 85)
MiddleName Middle Name Any Text (Max field length: 85)
Mobile Contact Info - Mobile Any Text (Max field length: 85)
OtherName Middle Name Any Text (Max field length: 85)
Password LMS Native Password

Any string that meets the system-configured password security requirements.

Use the *GENERATE* value for a system-generated password to be included in the New Welcome User email for a newly created user.

When you add a new user and set the password to *GENERATE*, a random generated password is saved and sent to the user via a New User Welcome E-mail, if one is configured.

An administrator can set up an email template with the Reset Password parameter ({reset_password}) in the Email Template Editor and configure it as the New User Welcome Email in System Configuration.

Personal Title Title of the Person
(Mr., Mrs., Dr. ...)
Any of Currently Defined Titles
Phone Phone Number Any Text (Max field length: 85)
PostalCode Contact Info - Postal Code / ZIP Any Text (Max field length:50)
Province State Contact Info - Province / State Any Text (Max field length:50)
Skin Skin Skin Name
Status User Account Status

One of:

  • "active" for Active
  • "suspend" for Suspended
  • "close" for Closed
  • "delete" for Logically Deleted
TeleFax Contact Info - Telefax Any Text (Max field length: 85)
TimeZone Time Zone Time zone ID
Email Forwarding E-mail Forwarding Must be "N", "D", "H", "O", "E" (N/A, Direct Appraiser, HR Manager e-mail, Organization Approver, E-mail address as entered below). Defaults to "N".
Forwarding Email Address Alternative Mail Valid E-mail (Max field length: 150)
User Option 1 User Option 1 Any Text (Max field length: 100)
User Option 2 User Option 2 Any Text (Max field length: 100)
User Option 3 User Option 3 Any Text (Max field length: 100)
UserRole User Role ID Any Text (Max field length: 85)
AdditionalRoles Additional Roles A list of Role IDs separated by a space e.g. "S G M D" or just ONE letter e.g. "S". This column is ignored if the System Configuration option 'Allow additional roles' is disabled.
AssignRoles Assign Roles A list of Role IDs separated by a space e.g. "S G M D" or just ONE letter e.g. "S". This column is ignored if the System Configuration option 'Allow additional roles' is disabled.
UnassignRoles Unassign Roles A list of Role IDs separated by a space e.g. "S G M D" or just ONE letter e.g. "S". This column is ignored if the System Configuration option 'Allow additional roles' is disabled.
UserAttr1 User-Defined Attribute 1 If configured as drop-down boxes, value should be user attribute code, max field length: 85. Otherwise, max field length: 1,000
UserAttr2 User-Defined Attribute 2 If configured as drop-down boxes, value should be user attribute code, max field length: 85. Otherwise, max field length: 1,000
UserAttr3 User-Defined Attribute 3 If configured as drop-down boxes, value should be user attribute code, max field length: 85. Otherwise, max field length: 1,000
UserAttr4 User-Defined Attribute 4 If configured as drop-down boxes, value should be user attribute code, max field length: 85. Otherwise, max field length: 1,000
UserAttr5 User-Defined Attribute 5 If configured as drop-down boxes, value should be user attribute code, max field length: 85. Otherwise, max field length: 1,000
UserAttr6 User-Defined Attribute 6 If configured as drop-down boxes, value should be user attribute code, max field length: 85. Otherwise, max field length: 1,000
UserAttr7 User-Defined Attribute 7 If configured as drop-down boxes, value should be user attribute code, max field length: 85. Otherwise, max field length: 1,000
UserAttr8 User-Defined Attribute 8 If configured as drop-down boxes, value should be user attribute code, max field length: 85. Otherwise, max field length: 1,000
UA-label.Add  User-Defined Attribute Extension (if there are any) Any Text (Max field length: 85)
initialURL First Screen

Screen ID must be a number:

  • Home: 0
  • Learn: 2
  • Current Courses: 3
  • Enrollment Approval: 10
  • Manage: 11
  • Learning Path: 12
  • Catalog Browser: 13
  • Catalog Search: 14
  • Records/Transcript: 15
  • Career Center Summary: 16
  • Dashboard: 17
  • Review: 18
  • Session Administration: 19
NewUserId New User ID A Unique ID That Conforms to PeopleFluent LMS ID constraints
Content Server Content Server Name Value should correspond to a Content Server Name
Supervised Groups User groups supervised by the User User group names separated by vertical bars, e.g., group1|group2|group3
Supervised Organizations Supervised Organizations Full organization hierarchy to be supervised by the user in question with level codes separated by forward slash, use vertical bar to separate between multiple hierarchies, e.g., ROOT/level1org/level2org|ROOT/level2org/level3org
User Profile Account User Profile Account "Y" or "N". Defaults to "N".
JobProfiles Job Profiles A list of job profile reference codes, separated by vertical bars, e.g., ENGINEER|IT_CONSULTANT
User Group User Groups where User is specifically identified as a member A list of User Group Names, separated by vertical bars, e.g., group1|group2|group3
SendResetPasswordMail Reset Password with System-Generated Password "Y" or "N". Defaults to "N".

Reset password on an existing user using a system-generated password to be included in the New Password email. This is applicable for Update action and any Password value defined is ignored.

Ensure that it's an one-time update on an existing user instead of a recurring user update job.
Level1Code Organization Hierarchy Level 1 Code Any Text (Max field length: 85). Defaults to Unassigned.
Level1Desc Organization Hierarchy Level 1 Description Any Text (Max field length: 85)
Level1ApproverID Organization Level 1 Approver It is required that the User ID already exists in the system. If not, the non-existing Approver has to be defined for creation in a row that is before assigning the Approver to a new organization within the CSV file.
Level2Code Organization Hierarchy Level 2 Code Any Text (Max field length: 85). Defaults to Unassigned.
Level2Desc Organization Hierarchy Level 2 Description Any Text (Max field length: 85)
Level2ApproverID Organization Level 2 Approver It is required that the User ID already exists in the system. If not, the non-existing Approver has to be defined for creation in a row that is before assigning the Approver to a new organization within the CSV file.
Level3Code Organization Hierarchy Level 3 Code Any Text (Max field length: 85). Defaults to Unassigned.
Level3Desc Organization Hierarchy Level 3 Description Any Text (Max field length: 85)
Level3ApproverID Organization Level 3 Approver It is required that the User ID already exists in the system. If not, the non-existing Approver has to be defined for creation in a row that is before assigning the Approver to a new organization within the CSV file.
Level4Code Organization Hierarchy Level 4 Code Any Text (Max field length: 85). Defaults to Unassigned.
Level4Desc Organization Hierarchy Level 4 Description Any Text (Max field length: 85)
Level4ApproverID Organization Level 4 Approver It is required that the User ID already exists in the system. If not, the non-existing Approver has to be defined for creation in a row that is before assigning the Approver to a new organization within the CSV file.
Level5Code Organization Hierarchy Level 5 Code Any Text (Max field length: 85). Defaults to Unassigned.
Level5Desc Organization Hierarchy Level 5 Description Any Text (Max field length: 85)
Level5ApproverID Organization Level 5 Approver It is required that the User ID already exists in the system. If not, the non-existing Approver has to be defined for creation in a row that is before assigning the Approver to a new organization within the CSV file.

Additional Information

Import User Data

About the User Data Loader

User Data Loader Validation

 

Why does the help differ from what I see on the screen?

 

Powered by PeopleFluent