LogoLogo
  • ManageBac OneRoster 1.2 CSV Custom Specification
  • User Guide
  • CSV_Files
    • academicSessions.csv
    • classes.csv
    • courses.csv
    • demographics.csv
    • enrollments.csv
    • manifest.csv
    • orgs.csv
    • roles.csv
    • users.csv
  • Messages
    • Errors
    • Warnings
Powered by GitBook
On this page
  • Column Order and Optionality
  • Relational Columns
  • Import Validations
  • Import Behavior
  • Export Behavior
  • Core Columns
  • Import Behaviors
  • Export Behaviors
  • Non-core Columns
  • Example file

Was this helpful?

Export as PDF
  1. CSV_Files

users.csv

The users.csv file represents users in the system. In ManageBac, each user can only have one and only one role, which is specified in the roles.csv file.

Column Order and Optionality

The columns of the users.csv file must be in the following order:

Column Name
Required?
Can be blank?
Explanation

1

sourcedId

yes

no

Required by OneRoster

2

status

yes

must be blank for bulk, must be populated for delta

Follows OneRoster convention

3

dateModified

yes

must be blank for bulk, must be populated for delta

Follows OneRoster convention

4

enabledUser

yes

no

5

username

yes

no

Required in OR as a credential. In MB is used as the email

6

userIds

yes

yes

Optional in both OneRoster and MB

7

givenName

yes

no

Required by OneRoster

8

familyName

yes

no

Required by OneRoster

9

middleName

yes

yes

Optional in both OneRoster and MB

10

identifier

yes

yes

Optional in both OneRoster and MB

11

email

yes

yes

MB uses username instead

12

sms

yes

yes

Optional as MB does not use this field

13

phone

yes

yes

Optional as MB does not use this field

14

agentSourceIds

yes

yes

Optional in both OneRoster and MB

15

grades

yes

yes

Optional in both OneRoster and MB

16

password

yes

yes

Optional as MB does not use this field

17

userMasterIdentifier

yes

yes

Optional as MB does not use this field

18

preferredGivenName

yes

yes

Optional as MB does not use this field

19

preferredMiddleName

yes

yes

Optional as MB does not use this field

20

preferredFamilyName

yes

yes

Optional as MB does not use this field

21

primaryOrgSourcedId

yes

yes

Optional as MB does not use this field

22

pronouns

yes

yes

Optional as MB does not use this field

Relational Columns

Column Name
Description
On Bulk Import
On Delta Import

sourcedId

Uniquely identifies the record

Used referentially

agentSourcedIds

Identifies parent / child relationship

Replaces all

Adds but does not remove

Import Validations

  • Each record must include a unique value for sourcedId

  • agentSourcedIds for student records can only point to parent records

  • agentSourcedIds for parent records can only point to Student records

Import Behavior

  • When a new association between a student and parent is made on import, the default "Other Guardian" relationship is used by default. The relationship can be changed to "Mother", "Father", etc. after imoprt without being overwritten

Export Behavior

  • Student user records contain all associated parents

  • Parent user records contain all associated children

Core Columns

Column Name
Description
On Import

identifier

Uniquely represents the user

Matches to Student ID, Parent ID, or Teacher ID

userMasterIdentifier

Same as identifier

Matches to Student ID, Parent ID or Teacher ID, if present

enabledUser

Archived users are FALSE, active users are TRUE

Sets archived status accordingly

username

Same as username

Used to match to user ManageBac's email.

email

Same as email

Ignored

givenName

First Name

Updates first_name

familyName

Last Name

Updates last_name

middleName

Middle Name

Updates middle_name

sms

Mobile phone number

Updates mobile_phone_number

phone

Home phone number

Updates home_phone_number

grades

Only for students, the grade the student is in

Cannot be updated via import

Import Behaviors

  • Users are matched in the following order: sourcedId, username, identifier

  • After the first import and sourcedId is known by MB, the user's MB email address can be changed by populating the new value in both username and email.

  • The grades column cannot be edited on import.

Export Behaviors

  • All users, even archived users, are always exported for both bulk and delta

Non-core Columns

Column Name
Description
On Import

userIds

Not used

Ignored

password

Not used

Ignored

preferredGivenName

Not used

Ignored

preferredMiddleName

Not used

Ignored

preferredFamilyName

Not used

Ignored

primaryOrgSourcedId

Not used

Ignored

pronouns

Not used

Ignored

The following columns values depend on the import or export mode:

Column Name
Bulk
Delta

status

Must be present but emtpy

Must be present and either "active" or "tobedeleted"

dateLastModified

Must be present but empty

Must be present and a date

Example file

sourcedId
status
dateLastModified
enabledUser
username
userIds
givenName
familyName
middleName
identifier
email
sms
phone
agentSourcedIds
grades
password
userMasterIdentifier
preferredGivenName
preferredMiddleName
preferredFamilyName
primaryOrgSourcedId
pronouns

4d74...ed70

true

happy.student@example.com

Happy

Student

ABC

happy.student@example.com

b403...558b

false

happier.student@example.com

Happier

Student

ABCD

happier.student@example.com

Previousroles.csvNextMessages

Last updated 1 month ago

Was this helpful?