Skip to main content

Data Fields for App SFTP Integrations

Official list of all data fields for SFTP Integrations.

Updated over 3 months ago

This page provides a complete list of accepted fields for each Data Type. It is designed to support clients who choose to submit custom files, ensuring compatibility with our SFTP data processing requirements.

Please expand the sections you intend to use to see the data requirements.

Administrators / Teachers / Staff

Field Name

Required

Notes / Description

Unique ID

Yes

UUID/GUID, must be consistent across all organizations

Employee ID

Yes

Unique Staff Identifier

Role

Yes

Title

No

Staff Title; If there is more than one record of the same user, the Title must remain the same across all records.

Department

No

Department Name

First Name

Yes

Middle Name

No

Last Name

Yes

Email 1

Yes

Must be globally unique between users

Email 2

No

Alternative Email

Email 3

No

Alternative Email

Email 4

No

Alternative Email

Email 5

No

Alternative Email

Phone 1

Yes

Primary Phone, required if you intend on using the Mass Communication system.

Phone 2

No

Alternative Phone

Phone 3

No

Alternative Phone

Phone 4

No

Alternative Phone

Phone 5

No

Alternative Phone

Image URL

No

Example: http://www.website.com/image.jpg

Home Language

No

Only ISO 639-1 codes are accepted

Organization ID

Yes

Organization, Building, or School ID

Students

Field Name

Required

Notes / Description

Unique ID

Yes

UUID/GUID, must be consistent across all organizations

Student ID

Yes

Unique Student Identifier

Role

Yes

Student

See Role & Permissions Overview for more information.

Title

No

If there is more than one record of the same user, the Title must remain the same across all records.

First Name

Yes

Middle Name

No

Last Name

Yes

Email 1

Yes

Must be globally unique between users

Email 2

No

Alternative Email

Email 3

No

Alternative Email

Email 4

No

Alternative Email

Email 5

No

Alternative Email

Phone 1

Yes

Primary Phone, required if you intend on using the Mass Communication system.

Phone 2

No

Alternative Phone

Phone 3

No

Alternative Phone

Phone 4

No

Alternative Phone

Phone 5

No

Alternative Phone

Image URL

No

Example: http://www.website.com/image.jpg

Bus Route AM

No

Bus Route PM

No

Home Language

No

Only ISO 639-1 codes are accepted

Organization ID

Yes

Organization, Building, or School ID

Parents / Guardians / Relatives

Field Name

Required

Notes / Description

Unique ID

Yes

UUID/GUID, must be consistent across all organizations

Role

Yes

Title

No

If there is more than one record of the same user, the Title must remain the same across all records.

First Name

Yes

Middle Name

No

Last Name

Yes

Email 1

Yes

Must be globally unique between users

Email 2

No

Alternative Email

Email 3

No

Alternative Email

Email 4

No

Alternative Email

Email 5

No

Alternative Email

Phone 1

Yes

Primary Phone, required if you intend on using the Mass Communication system.

Phone 2

No

Alternative Phone

Phone 3

No

Alternative Phone

Phone 4

No

Alternative Phone

Phone 5

No

Alternative Phone

Home Language

No

Only ISO 639-1 codes are accepted

Organization ID

Yes

Organization, Building, or School ID

Enrollments

Field Name

Required

Notes / Description

Classroom ID

Yes

Should match a valid Classroom ID

Person ID

Yes

Should match the Unique ID for Teacher or Student, one per row

Classrooms

Field Name

Required

Notes / Description

Classroom ID

Yes

Unique ID for each Classroom

Classroom Name

Yes

Name of the Classroom

Classroom Description

No

Description of the Classroom

Organization ID

Yes

Organization, Building, or School ID

Attendance - Auto Notice

Field Name

Required

Notes / Description

Student First Name

No

Can be used as an insert field to customize the message

Student Last Name

No

Can be used as an insert field to customize the message

Parent First Name

No

Can be used as an insert field to customize the message

Parent Last Name

No

Can be used as an insert field to customize the message

Parent Email Address

Yes

Primary Email address, required if you intend send attendance messages via email.

Parent Phone Number

Yes

Primary Phone, required if you intend send attendance messages via text or voice calls.

Date of Absence

Yes

Required if you intend include the date of absence in the message.

If you decide that you would like to use our provided templates instead please refer to our template page here


FAQ

What file formats are supported?

  • We support TXT and CSV files.

Are OneRoster® files accepted?

  • Yes, we accept OneRoster® 1.1 CSV files.

What delimiters are supported?

  • Comma (,)

  • Tab (\\t)

Are there template files we can download?

Are there character limits to the fields?

  • No, for all intents and purposes, there is not a character limit.

Where can we find the SFTP server information?

  • The SFTP Server IP address, and associated credentials will be provided in the initial email sent by the Data Integration Specialist assisting you. If needed, you can request this information be re-sent to you.

What time is data processed within Edlio's servers?

  • All data received is processed at 12:00 AM Central Time on a nightly basis.

Are headers required?

  • While including headers is not mandatory, we highly recommend it. Your team can name the headers as needed as long as the intended purpose is clear.

Can we use different file names?

  • Yes, files can be named at your discretion, however they must remain consistent across uploads.

  • If you intend to change the names of files after your data has been uploaded/mapped, you must notify either the Data Integrations Specialist working with you, or the Data Integrations team of this change.

Can we use different field names?

  • Yes, you can use your own field names. The key requirement is that the data in each column matches the purpose described above.

What happens if a user doesn't have an email address?

  • If a user does not have an email address listed within the data, they will be unable to sign in to the app/dashboard until one is provided. Additionally, they will be unable to be contacted via email.

If you have questions not listed above, please contact the Data Integration Specialist working with you.

Did this answer your question?