Automated Rostering

Alludo supports rostering using a limited version of the One Roster 1.2 standard. Specifically, Alludo supports adding users, organizations, and roles using CSV files uploaded to an SFTP site. Once uploaded, these files are deployed to Alludo about once an hour.

There are three steps to get started:

Build your files
Contact support with your files
Receive your SFTP credential

Build Your Files

Alludo supports rostering of organizations (orgs.csv), users (users.csv), and roles (roles.csv). As defined in the standard, the names of your rostering files are important. Incorrectly named files will be ignored.

Organizations (orgs.csv)

Organizations are expressed as groups and schools in Alludo. Uploading this file is optional if all of the schools and groups have been created in Alludo. Each organization needs a Sourced ID unique to your district. The codes will need to be referenced in the users and roles files.

The organizations file contains the following columns:

sourcedId - this is the unique identifier of the organization within your district. The One Roster standard defines this as UUID (a globally unique identifier). While a "best practice" it is not necessary to use a UUID for Alludo.
name - the name of the organization. E.g., the name of a school site
type - the type of the organization. Allowable values include school, local (Alludo group), department, district, state, and national. In general, you will use either "school" (school site) or "local" (group)
parentSourcedId (optional) - organizations can "belong to" other organizations. Reference the sourcedId of the parent organization if you wish to nest organizations. For example, a Student Services might roll up to Educational Services for a district. Alludo supports one level of nesting groups (local).

Users (users.csv)

Users is the list of people you wish to import. These users will need to have a unique Sourced Id that we can generate in the file. We will need to reference the primaryOrgSourcedId, which will most likely be the school (org) the person belongs to.

The users file contains the following columns:

sourcedId - the unique identifier of the user within your district. The One Roster standard defines this as UUID (a globally unique identifier). While a "best practice" it is not necessary to use a UUID for Alludo.
identifier - an identifier used by the organization such as an employee id or similar
enabledUser (Yes/No) - generally this is set to Yes but you may wish to use rostering to manage users access to Alludo. Setting enabledUser to "No" will remove that users access to Alludo.
givenName - the first name of the user
familyName - the last name of the user
email - the users email address. Each user must have a unique email address.
primaryOrgSourcedId (optional) - the school site of the user as defined in your organizations file.
ageGroup: child, adult

Roles (roles.csv)

Roles is the list of organizations that a person is associated with and the role the person has with the organization. In the vast majority of cases the role will be "teacher" and the roletype will be secondary. The userSourcedId is the unique sourcedId from the users file and the orgSourcedId is the unique identifier defined in your organizations file.

Note: define relationships between people and the primary school site in the users file. Do not define these relationships in the roles file. Instead, use relationships defined in the roles file along other dimensions such as general, team, or department.

sourcedId - the unique identifier used to define each role definition. This is used for troubleshooting rostering uploads.
userSourcedId - the unique identifier of the user
roleType (primary/secondary) - a user can have one primary roletype within a given organization and multiple secondary roletypes with organizations.
role (aide, counselor, districtAdministrator, guardian, parent, principal, proctor, relative, siteAdministrator, student, systemAdministrator, teacher ) - the role a person has within an organization. In general, this will be defined as "teacher" for teachers, "administrator" for staff, and "student" for students.
orgSourcedId - the unique identifier of the organization the person has a role with

File Templates

The name, definition, and structure of your rostering files is important. To help you get started, we have defined each file described above for you to use:

Contact Support

After building your automated rostering files you need to contact support with a request to have files reviewed before you get started uploading your roster into Alludo. Be sure to provide a technical point of contact in this request. Once we receive and review your files, we will set up an SFTP username and password for you to use.

Receive Your SFTP Credentials

After your request is approved we will create an SFTP username and password and send this credentials to your technical point of contact you specified in the second step.