Xello is a self-exploration and planning program that helps people of all ages achieve their potential in school, career and life. The Xello Zap includes school, student, course, and course history data so that districts can easily provision accounts within Xello. The Zap can be configured to extract this information on a scheduled basis, ensuring that your data remains synchronized between the two products. This lesson provides Business Rules for the Xello Zap.
Before you Begin
Need a refresher on installing a Zap? Visit Pre-Built Export Zaps to learn more.
Business Rules
School
This export has 5 outputs. This is 1 of 5 outputs.
This file will be exported with a header row and with the vertical line delimiter "|"
Only grade levels K through 12 will be pulled.
School.txt
All the filtered schools plus a district-level entry will be included in this file.
| Column Name | Type | Description | eSD Business Rules |
|---|---|---|---|
| SchoolCode | char(15) | Unique to district. | School code for each school, "DISTRICT" for the district entry |
| Name | char(250) | Full school name. | School name for each school, district name for the district entry |
| SchoolType | Int | 1 for secondary or high school 2 for elementary or middle school 3 for other |
For each school: 1. 1 will be used when the school only has grade levels in the 9 - 12 range. 2. 2 will be used when the school only has grade levels in the K - 8 range. 3. 3 will be used when the school both has grade levels in the K - 8 range and 9 - 12 range. For the Central Office and district entries: 1. 1 will be used when the district only has grade levels in the 9 - 12 range. 2. 2 will be used when the district only has grade levels in the K - 8 range. 3. 3 will be used when the district both has grade levels in the K - 8 range and 9 - 12 range. |
Student
This export has 5 outputs. This is 2 of 5 outputs.
This file will be exported with a header row and with the vertical line delimiter "|"
Only grade levels K through 12 will be pulled.
Student.txt
| Column Name | Type | Description | eSD Business Rules |
|---|---|---|---|
| StudentID | char(15) | Unique for the district (not just unique to the school). If this is not unique for the district, please inform your Onboarding Manager. | ID Number of the student. |
| UPN ID | char(15) | The student's unique pupil number that identifies each pupil in the localauthority-maintained school system. | ID Number of the student. |
| FirstName | char(100) | Student's first name. | N/A |
| LastName | char(100) | Student's last name. | N/A |
| Gender | char(1) | M = Male, F = Female, N = Not Specified. | N/A |
| DateOfBirth | Date | Format yyyy-mm-dd. Student's birth date. Note: Ensure the format is entered correctly. Do not spell out the date. | N/A |
| CurrentGrade | Int | The grade the student is in. | Student's current grade level when source year is the current year or student's scheduling grade when source year is next year. |
| CurrentSchoolCode | char(15) | The SchoolCode of the student's current school. | Student's current school's school code when source year is the current year or student's scheduling school's school code when source year is next year. |
| PreRegSchoolCode | char(75) | The SchoolCode that the student will be attending next year. If blank, we assume CurrentSchoolCode. | Student's scheduling school's school code if student has one set, otherwise is left blank. |
| StateProvNumber | char(20) | The student's unique state or province ID. | Student's state ID number |
| char(100) | Student's email address. | Student's email address |
Student Courses
This export has 5 outputs. This is 3 of 5 outputs.
This file will be exported with a header row and with the vertical line delimiter "|"
Only grade levels K through 12 will be pulled.
StudentCourses.txt
Classes that the students were enrolled in and their student previous courses from the source year and before will be pulled.
Class enrollments will be pulled if the student either received a mark in it or is in the source year and the student is still enrolled in it.
Class enrollments from summer school will be ignored as summer school marks that get pulled are part of the students' student previous courses.
School, school type, and grade filters are not applicable to the courses themselves. Only the subject filter are applicable to the courses to be pulled.
| Column Name | Type | Description | eSD Business Rules |
|---|---|---|---|
| StudentID | char(20) | Student who took the course, must be listed in Student Table above. | Student's ID Number. |
| CourseCode | char(10) | Code of course taken. | Course's course number. |
| CourseName | char(100) | Name of course taken. | Course's display name. |
| GradeLevel | Int | Highly recommended. The grade that the student has taken the course. If this is not supplied, the grade level is calculated based on the DateCourseComplete column and may be incorrect for special cases such as summer school courses. Note: If the Grade Level column cannot be provided (highly recommended), then the optional DateCourseComplete column must be included. | Student's grade level as of the course's school year. The student's grade enrollment record's start date determines which school year that grade enrollment record was in. |
| GradeMark | char(5) | The grade the student achieved in the course (0 if in progress or transferred course). Note: Do not include interim or temporary grades here as they will be visible to the student. | 1. Display override marks if available. 2. Display regular mark if there is no override mark and a regular mark is available. 3. Otherwise, display 0. |
| CreditValue | Numeric | Credit value of the course (e.g. 0.5, 1, 2). Set to 0 if failed course. If the course is in progress or scheduled, input credit value as if the course were achieved (courses in progress can also be 0). | 1. If a mark has not been given to the course yet, display the course credit. 2. If a mark is received and an override credit is entered, use the override credit. 3. Otherwise, display the course credit if the mark received is considered a Passed mark, else display 0.00 when the mark received is considered a Failed or N/A mark. |
| DateCourseComplete | Int | Format yyyy-mm-dd. Date the course was completed or will be completed. Blank or null values will default to the end of the current school year (July 1st). Note: If the GradeLevel column is provided (highly recommended), the DateCourseComplete column is not needed. | Left blank. |
Course Codes
This export has 5 outputs. This is 4 of 5 outputs.
This file will be exported with a header row and with the vertical line delimiter "|"
Only grade levels K through 12 will be pulled.
CourseCodes.txt
Only courses from the source year will be pulled.
| Column Name | Type | Description | eSD Business Rules |
|---|---|---|---|
| SchoolCode | char(15) | The code of the school (see School table) where the course is offered. | School's school code. |
| CourseCode | char(10) | The course code from the course curriculum. The course code should be unique within a school and what is visible on a student's transcript. | Course's course number. |
| CourseName | char(250) | Course name or title. | Course's display name. |
| CreditValue | Numeric | The number of credits student receives upon successful completion of course. | Course's credit. |
| GradeLower | Int | If the course is offered to multiple grades, specify the lowest grade level the course is offered. If only a single grade is offered, set both GradeLower and GradeUpper to the same value. | Applicable lowest grade level available for the course's school. |
| GradeUpper | Int | If the course is offered to multiple grades, specify the highest grade level the course is offered. If only a single grade is offered, set both GradeLower and GradeUpper to the same value. | Applicable highest grade level available for the course's school. |
Family
This export has 5 outputs. This is 5 of 5 outputs.
This file will be exported with a header row and with the vertical line delimiter "|"
Only grade levels K through 12 will be pulled.
Family.txt
Only guardians with the Custodial Flag and Correspondence flags on for the students in the Student.txt file will be present in this file.
| Column Name | Type | Description | eSD Business Rules |
|---|---|---|---|
| FirstName | char(100) | Parent/guardian first name | N/A |
| LastName | char(100) | Parent/guardian last name | N/A |
| char(100) | Email address for the parent/guardian Note: Parent/guardian accounts require an active email address. An empty email field or a default filler email address will prevent parent/guardian access. | Use the guardian's primary email address if available, otherwise use the first available email address. | |
| StudentId | char(15) | The unique Student ID for the student | ID Number of the student tied to the guardian. |
| SourceParentId | char(15) | Unique for the district (not just unique to the school) | Guardian's People primary key (POPL_PK). This field is not visible in the front-end and is an internal primary key. |
| Phone | char(20) | The parent/guardian phone number | Guardian's first priority phone number. |