Import Groups allows Administrators to create or update multiple Groups using a CSV file rather than configuring each Group individually.
This is particularly useful when setting up a large Group hierarchy or creating multiple Groups and Subgroups at the same time.
Access Import Groups
To import Groups:
- Open Group Management.
- Select Import Groups from the top navigation.
Import Groups can be accessed from the Group Management navigation.
Download the CSV Template
The import must use an LMS-compatible CSV file.
Before preparing your import:
- Select Download CSV Template.
- Open the downloaded template.
- Enter the required Group information.
- Save the completed file in CSV format.
Using the supplied template helps ensure that the required column names and structure are retained.
Group Keys
The group_key field provides the unique identifier for each Group.
Each Group Key must be unique.
Group Keys can contain:
- letters;
- numbers; and
- hyphens.
Spaces are automatically converted to hyphens and unsupported characters are removed.
For example:
Sales Team may become sales-team
Group Keys are also used elsewhere in the platform when Groups need to be referenced, including user imports and Group assignments.
Create Parent Groups and Subgroups
The group_parent_key field allows you to create a Group hierarchy.
Parent Group
If the Group being imported is a top-level or parent Group, leave the group_parent_key field blank.
Subgroup
If the Group should sit beneath another Group, enter the Group Key of the parent Group in the group_parent_key field.
For example, if the parent Group has the Group Key:
australia
a Subgroup that should sit beneath it would reference:
australia
in its group_parent_key field.
This allows Groups and Subgroups to be created in the appropriate hierarchy during the import.
Manager Group Limits
The group_limit field can be used to configure a Manager Group Limit.
Enter a number in this field if you want to limit the maximum number of Worker (Learner) accounts that Managers can add or assign to the Group.
If a Manager Group Limit is not required, leave the applicable value blank in accordance with the CSV template.
Import the CSV File
Once the CSV file has been prepared:
- Return to Group Management → Import Groups.
- Select Choose File.
- Select the completed CSV file.
- Review the import information.
- Select Validate & Import.
The platform will validate the CSV before processing the Group information.
Import Groups: Upload the completed CSV template and select Validate & Import to process the Group information.
Before Importing
Before importing a large Group structure, check that:
- each Group has a unique Group Key;
- parent Group Keys are correct;
- Subgroups reference the correct parent Group;
- Manager Group Limits are correct where used; and
- the file has been saved in CSV format.
It is particularly important to check Group Keys carefully because they are used as identifiers by other areas of the platform.