Administrator

How do I batch import data using tab-delimited and comma-separated files?

Follow
Ryan Richins
  • Agilix team member
  • Updated:
    info_outline
    Created:

During the summer of 2017, we released a new Buzz UI, giving you the same features and functionality with a cleaner, simpler user experience!

Until all users have switched to the new UI, our Help Center articles will include information for both. 

Click the header below that aligns with the Buzz UI version you are using (Old UI or New UI); if you don't know which version you are using, review the differences and/or contact your system admin or Agilix account manager.

Old UI

Save time with batch imports.

Buzz allows you to batch import large sets of data directly into your domain anywhere you see an Import button in the Admin app. Just click Import and upload a tab-delimited or comma-separated file with your data.

What can you import?

What can you import?

This article outlines the types of data you can import, including:

  • Course data
  • Enrollment data
  • Objective data
  • Observer data
  • Permissions data
  • User data

Formatting tab-delimited and comma-separated files

Buzz allows you to set up courses, users, enrollments, and other data by importing a tab-delimited values text file (.txt) or a comma-separated values file (.csv). These file types use plain text and pre-determined (according to the type of imported data) fields to organize data as tables. Review the sections below to learn more about each type of import and the supported fields associated with each.

Although the fields you're required to include in your file vary based on the type of data you're importing (e.g., users, enrollments, courses, etc.,), the formatting rules remain the same. To format a tab-delimited or comma-separated file:

  1. On the first line, list the supported fields you want to define. Think of these as your table headers. List the fields in the order (top-to-bottom) outlined in the tables below, separating each with only a comma (no spaces). For example, if you wanted to create a course import file that defines the Action, Title, and Course Id fields, your first line would look like this:
Action,Title,Course Id
  1. On the next line, provide content about a course for each of the fields you entered on the first line. So, if you want to add a course titled "Geometry 1" with "course_1" as its course ID, your second like would look like this:
Action,Title,Course Id
Add,Geometry 1,course_1
  1. Repeat step two for every course you want to edit with this import. You can indicate no edits to a field in the middle of a line by entering no content between commas (see line three below). If you don't want to make changes to the field at the end of the line, simply leave it out (see line four).
Action,Title,Course Id
Add,Geometry 1,course_1
Edit,,course_3
Delete,Geometry 3

Importing course data

Importing course data allows you to edit many courses in one process.

The table below lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing course information.

Supported fields for course imports

The entries under Column Header represent your options in editing data. The first two column entries (Action and Copy Action) represent actions, the remaining represent types of data.

On the first line of your file, list those column entries that you want to define, separated by commas. On the remaining lines, enter the information for each entry. Your file will look something like this:

Action,Copy Action,Title,Course Id,Base Id
Add,Sibling,Geometry 1,course_1,Master_Course_1
Edit,,,course_3
Delete,,Geometry 3

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column Header                                                             Description                                                                                                                                                                                                                
Action                                                                   Enter one of the following values: Add (default), Delete, or Edit.                                                                                                                                                                                 
Copy Action                                                               When you use the Add action, you can create a brand new course or build one from an existing course, or Base Course. When using a Base Course, you need to specify how the new course relates to it by including a copy action field in your file and entering one of the following copy action values: Copy (static), Child (default), or Sibling. To learn how these copy actions differ, visit How do Master and Derivative Courses work?.
Title                                                                     Course title.                                                                                                                                                                                                              
Type                                                                     Range or Continuous.                                                                                                                                                                                                        
Start Date                                                               Start date of a range course.                                                                                                                                                                                              
End Date                                                                 End date of a range course.                                                                                                                                                                                                
Days                                                                     Number of days in a continuous course.                                                                                                                                                                                      
Term                                                                     Term for this course.                                                                                                                                                                                                      
Course Id                                                                 Buzz id for the course.                                                                                                                                                                                              
Course Guid                                                               Guid for the course.                                                                                                                                                                                                      
Course Reference or Course External Id                                   External id (reference) for the course.                                                                                                                                                                                    
Base Id                                                                   Buzz id for the Base Course. The add action requires an id for the base course, if you want to start with an existing course. The id can be either base id, base guid, or base reference.                            
Base Guid                                                                 Guid for the base course.                                                                                                                                                                                                  
Base Reference or Base External Id                                       External id (reference) for the base course.                                                                                                                                                                              
Base Domain Id or Base Domain Guid or Base Userspace or Base Login Prefix Domain identifiers if the base course is in a different domain. See Domain Identifiers for more information.                                                                                                              

Notes

  • We recommend that all batch imports of courses specify an external ID for courses in the import file. The external ID property is specified by the user and should contain a unique ID for the item. Typically, the external ID corresponds to the course's ID in another system at your institution.
  • Buzz does not enforce uniqueness of the Course External IDs, so you must verify that they are unique when you create the import file.

Importing permissions data

Importing permissions data allows you to update multiple permissions associated with users, entities, roles, and flags.

The table below lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing permissions information.

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column Header
Description
Action Add, Edit, or Delete. Defaults to Add. 
User Id This user’s permissions are impacted. 
Entity Id This entity’s permissions are impacted.
Role Id This roles’ permissions are impacted.
Flags Indicates individual privilege flags for the rights. Use Role Id whenever possible with this action.

Importing user data

Importing user data allows you to set up many users in one process.

The following table lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing user data. The third column indicates which fields can be used for editing users.

Supported fields for user imports

The entries under Column Header represent your options in editing data. The first column entry (Action) represents an action, the remaining represent types of data.

On the first line of your file, list those column entries that you want to define, separated by commas. On the remaining lines, enter the information for each entry. Your file will look something like this:

Action,First name,Last name,Username,Password
Add,Jane,Doe,JaneDoe,jdoe123
Add,John,Doe,JonDoe,jdoe123

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column header Description Allow edit
Action Add, Delete, or Edit. Defaults to Add. N/A
First name User's first name Yes
Last name User's last name. Yes
Username Name user will use when logging in to the system. Yes
Password User password. No
External Id or Reference External ID of user. Yes
Email User email address (this will be used for resetting passwords as well as for communications from course instructors). Yes
Password Question Security question asked when requesting to reset a password. No
Password Answer Answer to security question. No
Description Long text description. Yes
User Id Internal User Id. You cannot set this value, but you can use it to reference users for Edit and Delete actions. No
User Guid Internal User Guid. You cannot set this value, but you can use it to reference users for Edit and Delete actions. No
Flags RightsFlags for the user in the domain. Enables you to automatically grant domain rights to the new user. No
Role Role for the user in the domain, as defined by domain administrator, see BrainHoney Roles and Permissions. Enables you to automatically grant domain rights to the new user. No
Status Status of user. Valid values are Active and Inactive. Yes
meta-xyz Use to add or edit custom user metadata. Replace xyz with the desired metadata identifier (it is case sensitive). If you wanted to add a title as metadata, you would use meta-Title. If these correlate with User Metadata admins add in Domain Settings > User Options, they appear in the UI after import; use the same value you enter in the Title field. Yes

Notes

  • The Username for each user must be unique. In addition, all users have an External ID which should contain an additional unique ID for the user. Normally the External ID is the ID of the user from a third party system, such as a student information system. We recommend that all user batch imports specify a User External ID.
  • Buzz does not enforce uniqueness of the Enrollment External ID. You must verify that the external IDs are unique when you create the import file.

Importing enrollment data

Importing enrollment data allows you to assign many students to specific courses in a single process.

Each enrollment row in the file assigns a user to a course. Users are identified by their User External ID, and courses are identified by their Course External ID. Both fields are set by the administrator and should contain a unique ID for the item. Often the External ID is the ID of the item from an external system.

The following table lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing enrollments.

Supported fields for enrollment imports

The entries under Column Header represent your options in editing data. The first column entry (Action) represents an action, the remaining represent types of data.

On the first line of your file, list those column entries that you want to define, separated by commas. On the remaining lines, enter the information for each entry. Your file will look something like this:

Action,Role,Enrollment Id,Course Id
Edit,Student,student_1,course_1
Add,,student_2,course_3
Add,,student_3,course_3

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column Header Description
Action Add, Delete, or Edit. Defaults to Add.
Flags Numeric number of the privilege flags for the enrollment. Use either Flags or Role.
Role Role for the user, as defined by domain administrator, see Roles and Permissions. This defaults to Student for the Add action.
Status Active, Withdrawn No Score, Withdrawn Failed, Transferred, Completed, Completed No Credit, Suspended, or Inactive. Defaults to Active.
Start Date First day of enrollment. Defaults to course (or section) start date. Please use the Year/Month/Day format, such as 2009/1/30 or 1999/10/03.
End Date Last day of enrollment. Defaults to course (or section) end date. Please use the Year/Month/Day format, such as 2009/1/30 or 1999/10/03.
Enrollment Id Buzz Id of the enrollment. The Edit and Delete action requires an id for the enrollment which can be either enrollment id, enrollment guid, or reference.
Enrollment Guid Guid for the enrollment.
Reference or External Id or Enrollment External Id External id (reference) for the enrollment.
User Id Buzz user id for the user to enroll. The Add action requires an id for the user which can be either user id, user guid, username, or user reference.
User Guid Guid for the user to enroll.
Username Username for the user to enroll.
User Reference or User External Id External id (reference) for the user to enroll.
User Domain Id or User Domain Guid or User Userspace or User Login Prefix Domain identifiers if the user is in a different domain. See Domain Identifiers for more information.
Course Id Buzz id for the course to enroll in. The batch enrollment can enroll either in courses or sections, you must specify either a course or a section. The Add action requires an id for the course which can be either course id, course guid, or course reference.
Course Guid Guid for the course to enroll in.
Course Reference or Course External Id External id (reference) for the course to enroll in.
Course Domain Id or Course Domain Guid or Course Userspace or Course Login Prefix Domain identifiers if the course is in a different domain. See Domain Identifiers for more information.

Notes

  • We recommend that all batch import enrollments specify an Enrollment External ID, which can be used later to edit or delete enrollments.
  • Buzz does not enforce uniqueness of the Enrollment External IDs, so you must verify that they are unique when you create the import file.

Importing objective data

Importing objective data allows you to create large sets of objectives in one process.

The following table lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing objectives.

Supported fields for objective imports

The entries under Column Header represent your options in editing data. The first column entry (Action) represents an action, the remaining represent types of data.

On the first line of your file, list those column entries that you want to define, separated by commas. On the remaining lines, enter the information for each entry. Your file will look something like this:

Action,Set Id,Guid,Title
Edit,objective_set_1,######,Determine whether a solution is reasonable in the context of the original situation.
Add,objective_set_2,######,Identify chords, tangents, radii, and great circles of spheres.
Add,objective_set_2,######,Solve real-world problems involving right triangles.

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column Header Description
Action Add, Delete, or Edit. Defaults to Add.
Set Id The map set to import into. If you've selected the map set in the Admin app, you don't need to provide this.
Guid The globally unique identifier for the objective.
Id The ID string that the external objective-set source assigns to this objective.
Title The title or description of the objective.
Reference A field that identifies the objective in other systems such as ASN.
Grades A *bit-wise OR of GradeLevels that indicates the applicable grades for this objective.
Subject The academic subject for this objective.
Parent The unique identifier of the parent objective, if any.

*For a list of GradeLevels, click here.

Importing observer data

Importing observer data allows you to edit observer roles in one process.

The following table lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing observers.

Supported fields for observer imports

The entries under Column Header represent your options in editing data. The first column entry (Action) represents an action, the remaining represent types of data.

On the first line of your file, list those column entries that you want to define, separated by commas. On the remaining lines, enter the information for each entry. Your file will look something like this:

Action,User Id,Observee Id
Add,career_coach_2,student_1
Add,career_coach_2,student_2
Add,career_coach_3,student_3

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column header     Description                                        
Action           Add or Delete                                      
User Id, Username, User Reference, or User External Id          Identifier of the user who will observe another user.
Observee Id, Observee Username, Observee Reference, or Observee External Id OR Enrollment Id, Enrollment Reference, or Enrollment External Id Identifier of the user or enrollment who will be observed.          
User Domain Id or User Domain Guid or User Userspace or User Login  Prefix           Domain identifiers if the user is in a different domain. See Domain Identifiers for more information.          
Observee Domain Id or Observee Domain Guid or Observee Userspace or Observee Login  Prefix           Domain identifiers if the observee is in a different domain. See Domain Identifiers for more information.
New UI

Save time with batch imports.

What can you import?

Buzz allows you to batch import large sets of data directly into your domain anywhere you see an Import button in the Admin app. Just click Import and upload a tab-delimited or comma-separated file with your data.

This article outlines the types of data you can import, including:

  • Course data
  • Enrollment data
  • Objective data
  • Observer data
  • Permissions data
  • User data

Formatting tab-delimited and comma-separated files

Buzz allows you to set up courses, users, enrollments, and other data by importing a tab-delimited values text file (.txt) or a comma-separated values file (.csv). These file types use plain text and pre-determined (according to the type of imported data) fields to organize data as tables. Review the sections below to learn more about each type of import and the supported fields associated with each.

Although the fields you're required to include in your file vary based on the type of data you're importing (e.g., users, enrollments, courses, etc.,), the formatting rules remain the same. To format a tab-delimited or comma-separated file:

  1. On the first line, list the supported fields you want to define. Think of these as your table headers. List the fields in the order (top-to-bottom) outlined in the tables below, separating each with only a comma (no spaces). For example, if you wanted to create a course import file that defines the Action, Title, and Course Id fields, your first line would look like this:
Action,Title,Course Id
  1. On the next line, provide content about a course for each of the fields you entered on the first line. So, if you want to add a course titled "Geometry 1" with "course_1" as its course ID, your second like would look like this:
Action,Title,Course Id
Add,Geometry 1,course_1
  1. Repeat step two for every course you want to edit with this import. You can indicate no edits to a field in the middle of a line by entering no content between commas (see line three below). If you don't want to make changes to the field at the end of the line, simply leave it out (see line four).
Action,Title,Course Id
Add,Geometry 1,course_1
Edit,,course_3
Delete,Geometry 3

Importing course data

Importing course data allows you to edit many courses in one process.

The table below lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing course information.

Supported fields for course imports

The entries under Column Header represent your options in editing data. The first two column entries (Action and Copy Action) represent actions, the remaining represent types of data.

On the first line of your file, list those column entries that you want to define, separated by commas. On the remaining lines, enter the information for each entry. Your file will look something like this:

Action,Copy Action,Title,Course Id,Base Id
Add,Sibling,Geometry 1,course_1,Master_Course_1
Edit,,,course_3
Delete,,Geometry 3

For formatting help, see Formatting tab-delimited and comma-separated files for import.


Column Header                                                             Description                                                                                                                                                                                                                
Action                                                                   Enter one of the following values: Add (default), Delete, or Edit.                                                                                                                                                                                 
Copy Action                                                               When you use the Add action, you can create a brand new course or build one from an existing course, or Base Course. When using a Base Course, you need to specify how the new course relates to it by including a copy action field in your file and entering one of the following copy action values: Copy (static), Child (default), or Sibling. To learn how these copy actions differ, visit How do Master and Derivative Courses work?.
Title                                                                     Course title.                                                                                                                                                                                                              
Type                                                                     Range or Continuous.                                                                                                                                                                                                        
Start Date                                                               Start date of a range course.                                                                                                                                                                                              
End Date                                                                 End date of a range course.                                                                                                                                                                                                
Days                                                                     Number of days in a continuous course.                                                                                                                                                                                      
Term                                                                     Term for this course.                                                                                                                                                                                                      
Course Id                                                                 Buzz id for the course.                                                                                                                                                                                              
Course Guid                                                               Guid for the course.                                                                                                                                                                                                      
Course Reference or Course External Id                                   External id (reference) for the course.                                                                                                                                                                                    
Base Id                                                                   Buzz id for the Base Course. The add action requires an id for the base course, if you want to start with an existing course. The id can be either base id, base guid, or base reference.                            
Base Guid                                                                 Guid for the base course.                                                                                                                                                                                                  
Base Reference or Base External Id                                       External id (reference) for the base course.                                                                                                                                                                              
Base Domain Id or Base Domain Guid or Base Userspace or Base Login Prefix Domain identifiers if the base course is in a different domain. See Domain Identifiers for more information.                                                                                                              

Notes

  • We recommend that all batch imports of courses specify an external ID for courses in the import file. The external ID property is specified by the user and should contain a unique ID for the item. Typically, the external ID corresponds to the course's ID in another system at your institution.
  • Buzz does not enforce uniqueness of the Course External IDs, so you must verify that they are unique when you create the import file.

Importing enrollment data

Importing enrollment data allows you to assign many students to specific courses in a single process.

Each enrollment row in the file assigns a user to a course. Users are identified by their User External ID, and courses are identified by their Course External ID. Both fields are set by the administrator and should contain a unique ID for the item. Often the External ID is the ID of the item from an external system.

The following table lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing enrollments.

Supported fields for enrollment imports

The entries under Column Header represent your options in editing data. The first column entry (Action) represents an action, the remaining represent types of data.

On the first line of your file, list those column entries that you want to define, separated by commas. On the remaining lines, enter the information for each entry. Your file will look something like this:

Action,Role,Enrollment Id,Course Id
Edit,Student,student_1,course_1
Add,,student_2,course_3
Add,,student_3,course_3

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column Header
Description
Action
Add, Delete, or Edit. Defaults to Add.
Flags
Numeric number of the privilege flags for the enrollment. Use either Flags or Role.
Role
Role for the user, as defined by domain administrator, see Roles and Permissions. This defaults to Student for the Add action.
Status
Active, Withdrawn No Score, Withdrawn Failed, Transferred, Completed, Completed No Credit, Suspended, or Inactive. Defaults to Active.
Start Date
First day of enrollment. Defaults to course start date. Please use the Year/Month/Day format, such as 2009/1/30 or 1999/10/03.
End Date
Last day of enrollment. Defaults to course end date. Please use the Year/Month/Day format, such as 2009/1/30 or 1999/10/03.
Enrollment Id
Buzz Id of the enrollment. The Edit and Delete action requires an id for the enrollment which can be either enrollment id, enrollment guid, or reference.
Enrollment Guid
Guid for the enrollment.
Reference or External Id or Enrollment External Id
External id (reference) for the enrollment.
User Id
Buzz user id for the user to enroll. The Add action requires an id for the user which can be either user id, user guid, username, or user reference.
User Guid
Guid for the user to enroll.
Username
Username for the user to enroll.
User Reference or User External Id
External id (reference) for the user to enroll.
User Domain Id or User Domain Guid or User Userspace or User Login Prefix
Domain identifiers if the user is in a different domain. See Domain Identifiers for more information.
Course Id
Buzz id for the course to enroll in.  The Add action requires an id for the course which can be either course id, course guid, or course reference.
Course Guid
Guid for the course to enroll in.
Course Reference or Course External Id
External id (reference) for the course to enroll in.
Course Domain Id or Course Domain Guid or Course Userspace or Course Login Prefix
Domain identifiers if the course is in a different domain. See Domain Identifiers for more information.

Notes

  • We recommend that all batch import enrollments specify an Enrollment External ID, which can be used later to edit or delete enrollments.
  • Buzz does not enforce uniqueness of the Enrollment External IDs, so you must verify that they are unique when you create the import file.

Importing objective data

Importing objective data allows you to create large sets of objectives in one process.

The following table lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing objectives.

Supported fields for objective imports

The entries under Column Header represent your options in editing data. The first column entry (Action) represents an action, the remaining represent types of data.

On the first line of your file, list those column entries that you want to define, separated by commas. On the remaining lines, enter the information for each entry. Your file will look something like this:

Action,Guid,Id,Title,Grades,Subject
Edit,######,1.1,Determine whether a solution is reasonable in the context of the original situation.,30720,Mathematics
Add,######,1.2,"Identify chords, tangents, radii, and great circles of spheres.",30720,Mathematics
Add,######,1.3,Solve real-world problems involving right triangles.,30720,Mathematics

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column Header Description
Action Add, Delete, or Edit. Defaults to Add.
Set Id The map set to import into. If you've selected the map set in the Admin app, you don't need to provide this.
Guid The globally unique identifier for the objective.
Id The ID string that the external objective-set source assigns to this objective.
Title The title or description of the objective.
Reference A field that identifies the objective in other systems such as ASN.
Grades A *bit-wise OR of GradeLevels that indicates the applicable grades for this objective.
Subject The academic subject for this objective.
Parent The unique identifier of the parent objective, if any.

*For a list of GradeLevels, click here.

Importing observer data

Importing observer data allows you to edit observer roles in one process.

The following table lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing observers.

Supported fields for observer imports

The entries under Column Header represent your options in editing data. The first column entry (Action) represents an action, the remaining represent types of data.

On the first line of your file, list those column entries that you want to define, separated by commas. On the remaining lines, enter the information for each entry. Your file will look something like this:

Action,User Id,Observee Id
Add,career_coach_2,student_1
Add,career_coach_2,student_2
Add,career_coach_3,student_3

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column header     Description                                        
Action           Add or Delete                                      
User Id, Username, User Reference, or User External Id          Identifier of the user who will observe another user.
Observee Id, Observee Username, Observee Reference, or Observee External Id OR Enrollment Id, Enrollment Reference, or Enrollment External Id Identifier of the user or enrollment who will be observed.          
User Domain Id or User Domain Guid or User Userspace or User Login  Prefix           Domain identifiers if the user is in a different domain. See Domain Identifiers for more information.          
Observee Domain Id or Observee Domain Guid or Observee Userspace or Observee Login  Prefix           Domain identifiers if the observee is in a different domain. See Domain Identifiers for more information.

Importing permissions data

Importing permissions data allows you to update multiple permissions associated with users, entities, roles, and flags.

The table below lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing permissions information.

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column Header
Description
Action Add, Edit, or Delete. Defaults to Add. 
User Id This user’s permissions are impacted. 
Entity Id This entity’s permissions are impacted.
Role Id This roles’ permissions are impacted.
Flags Indicates individual privilege flags for the rights. Use Role Id whenever possible with this action.

Importing user data

Importing user data allows you to set up many users in one process.

The following table lists and describes the supported fields you can include in your tab-delimited or comma-separated file when importing user data. The third column indicates which fields can be used for editing users.

Supported fields for user imports

The entries under Column Header represent your options in editing data. The first column entry (Action) represents an action, the remaining represent types of data.

On the first line of your file, list those column entries that you want to define, separated by commas. On the remaining lines, enter the information for each entry. Your file will look something like this:

Action,First name,Last name,Username,Password
Add,Jane,Doe,JaneDoe,jdoe123
Add,John,Doe,JonDoe,jdoe123

For formatting help, see Formatting tab-delimited and comma-separated files for import.

Column header Description Allow edit
Action Add, Delete, or Edit. Defaults to Add. N/A
First name User's first name Yes
Last name User's last name. Yes
Username Name user will use when logging in to the system. Yes
Password User password. No
External Id or Reference External ID of user. Yes
Email User email address (this will be used for resetting passwords as well as for communications from course instructors). Yes
Password Question Security question asked when requesting to reset a password. No
Password Answer Answer to security question. No
Description Long text description. Yes
User Id Internal User Id. You cannot set this value, but you can use it to reference users for Edit and Delete actions. No
User Guid Internal User Guid. You cannot set this value, but you can use it to reference users for Edit and Delete actions. No
Flags RightsFlags for the user in the domain. Enables you to automatically grant domain rights to the new user. No
Role Role for the user in the domain, as defined by domain administrator, see BrainHoney Roles and Permissions. Enables you to automatically grant domain rights to the new user. No
Status Status of user. Valid values are Active and Inactive. Yes
meta-xyz Use to add or edit custom user metadata. Replace xyz with the desired metadata identifier (it is case sensitive). If you wanted to add a title as metadata, you would use meta-Title. If these correlate with User Metadata admins add in Domain Settings > User Options, they appear in the UI after import; use the same value you enter in the Title field. Yes

Notes

  • The Username for each user must be unique. In addition, all users have an External ID which should contain an additional unique ID for the user. Normally the External ID is the ID of the user from a third party system, such as a student information system. We recommend that all user batch imports specify a User External ID.
  • Buzz does not enforce uniqueness of the Enrollment External ID. You must verify that the external IDs are unique when you create the import file.

Domain Identifiers for Batch Importing

When working with multiple domains, you sometimes need to specify which domain you want to use for enrollments.

You don't need to specify the domain when:

  • Referencing users or courses in the current working domain.
  • The id of the item is globally unique, as is the case with internal ids.

You need to specify the domain when:

  • You reference users or courses in a different domain than the working domain.

All domain identifiers in this case have a User, Course, or Enrollment prefix. You could, for example, create an enrollment in one domain, with a user from a second domain, and a course from a third domain.

To specify a domain, use one of these fields with the appropriate identifiers with this syntax:

[Type Identifier] [Domain Identifier]

Type Identifier

The Type Identifier indicates the type of the entity for which you want to specify a domain. The value is one of the following:CcC

Name
Description
Course Specify the domain for a course.
Base
Specify the domain for a base course.
Enrollment
Specify the domain for an enrollment.
User
Specify the domain for an user.

Domain Identifier

The Domain Identifier specifies the key to use for the domain. Domain Identifiers can be one of the following:

Name Description
Domain Id
Specify the domain by using the internal Buzz domain id.
Domain Guid
Specify the domain by using the domain guid.
Userspace
Specify the domain by using the domain userspace (login prefix).
Login Prefix
Specify the domain by using the domain userspace (login prefix).

Domain Identifiers Example

The following example specifies a user in the domain with login prefix myschool, by using the username and login prefix for the user.

UserName,UserLoginPrefix
jsmith,myschool

Comments (8)

Sort by
Paul Curtis

It would be really helpful if there were example .csv files or even just screen captures of the heading and sample data for each of these.  

Cheree Childers

When importing grade data in csv via the loader the key matching is case-sensitive. We have run into issues when trying to import grade data. If an import email shows as T.STUDENT@EMAIL.COM in the sheet it will not match the email in Buzz that shows the student email as t.student@email.com. We continue to have issues with import. Suggestions?

Brad Marshall
  • Agilix team member

Hey Cheree:

On September 29, we updated the platform with an enhancement for it to ignore case sensitivity when importing grades.

I hope this was a welcome addition. Thank you for your feedback!

Cheree Childers

This is great! Thank you!

Chad Kafka (FPS)

Hi - I am attempting to upload some of our district standards as Objectives into Buzz as the Administrator.  I have a spreadsheet created based on reading some help files here. What I'm confused on is the GUID.  My understanding when manually adding the standards/objectives into Buzz is that the GUID is automatically created.  How do I best create GUID in the spreadsheet prior to the upload? Advice?  Thanks,

Chad Kafka (FPS)

Solved my own problem. I see that I can create the GUID.  I am doing this in Google Sheets so here's a tool I stumbled upon that might help others.  This is an ADD-ON you can use in a Google sheet. You select the cells that need a GUID (they refer to as UUID) and then run the tool from the ADD-ONS menu after installing and it creates GUID for you. I then downloaded the sheet as a CSV (FILE > DOWNLOAD AS > CSV) and then uploaded that using the IMPORT button and wa-la.  Standards created.  

Here's the add-on if this helps anyone else.

Hieu Cooney

Where can I find information about Domain Identifiers? I have a master course (Base ID) and want to make a derivative copy in different domains. How should I format my batch file?

Brian Williams
  • Agilix team member

Hey Hieu! Good question! We have updated this document to include the domain identifiers. 

Please sign in to leave a comment.