Skip to main content

Import / Export Resources

Rodda John
  • Updated

Overview

How to Use This Article

This Article provides an overview of each of the export / import resources that Talos provides.

Each resource will include:

  • Whether the resource is intended for imports, exports, or both.
  • Any default fields that should be set before the import
  • All fields that are mappable on imports
  • The fields that it looks up existing items by (to determine create or update)

Default Actions

Import

  1. Perform test import (0-100%)
  2. If test import succeeded with no errors, perform real import (100-200%)
  3. For each row of the import:
    1. Look up existing items using the "Import ID Fields"
    2. If there is an existing item:
      1. Update the fields to reflect the file
      2. Run any custom update code
    3. If there is not an existing item:
      1. Create a new item
      2. Run any custom create code

Export

  1. Iterate over every item in the relevant query-set in the database
  2. Create the report row by row

Resources

Student Resource (RBIR + Email)

Fields

  • ID
  • First Name
  • Last Name
  • Email
  • Student ID
  • Sex
  • Meal Code
  • OFCL
  • Birthdate
  • Cohort
    • Represents a NYCDOE grade value:
    • Lookup table:
      • 220: Graduates in the currently selected year
      • 210: Graduates in the currently selected year + 1
      • 200: Graduates in the currently selected year + 2
      • 190: Graduates in the currently selected year + 3
      • 180: Graduates in the currently selected year + 4

Import ID Fields

  • Student ID Field

Custom Actions

  • On Create:
    • If a user account with the same email exists, it will be linked to this new student instance
    • If no user account with the same email exists, a new account will be created.  The password will be the Student ID.  Please use the User Resource to change any aspects of these created accounts.

Incoming Student Resource

This is intended as import only.

Fields

  • ID
  • First Name
  • Last Name
  • Email
  • Student ID
  • Sex
  • Meal Code
  • OFCL
  • Birthdate
  • Cohort
    • Represents a NYCDOE grade value:
    • Lookup table:
      • 220: Graduates in the currently selected year
      • 210: Graduates in the currently selected year + 1
      • 200: Graduates in the currently selected year + 2
      • 190: Graduates in the currently selected year + 3
      • 180: Graduates in the currently selected year + 4
  • Is Active

Import ID Fields

  • Student ID Field

Custom Actions

  • On Create:
    • If a user account with the same email exists, it will be linked to this new student instance
    • If no user account with the same email exists, a new account will be created.  The password will be the Student ID.  These users will also be given a special "incoming_student" permission group.  Please use the User Resource to change any aspects of these created accounts.

Student Selections Resource

This is intended as export only.

Fields

  • First Name
  • Last Name
  • Email
  • Student ID
  • OFCL
  • Advisor Name
  • Submitted Choices
    • This is a boolean flag indicating whether this student has already submitted choices for the selected year and term.
  • Selections Approved
    • This is a boolean flag indicating whether this student has already had their selections approved for the selected year and term.

Parent Resource — No Account Creation (RADL)

This is intended as import only.

Fields

  • Students
  • Parent ID
  • Street Address
  • Apt
  • City
  • State
  • Zip Code
  • Phone One
  • Phone Two
  • First Name
  • Last Name
  • Email
    • This field is special in that it will NOT be updated in the database from the report.
  • Authorization Code
  • Relation Code
  • Written Language
  • Spoken Language
  • In Underlying System (ATS)

Import ID Fields

  • Parent ID Field

Custom Actions

  • On Create:
    • If no Parent ID is provided, one will be randomly generated.
  • After Import
    • A report will be sent by email to the user who initiated the report with an analysis of the email discrepancies, ie, in which cases there was an email mismatch and which one it preferred (always Talos). 

Parent Resource — Account Creation (RADL)

This is intended as import only.

This works precisely the same was as the Parent Resource — No Account Creation (RADL), EXCEPT:

  • If the parent has the proper authorization code, and there is no user account that exists:
    • One will be created
    • It will be assigned the parent role and thus placed in the appropriate permission group
    • A random password will be generated
    • This will be emailed to the email address of the account

Incoming Parent Resource — Account Creation

This is intended as import only.

This works precisely the same was as the Parent Resource — Account Creation (RADL), EXCEPT:

  • The user will also be placed in the 'incoming_parent' group — even if the account already exists this action will still be performed.

Variable Import

This is intended as import only.

Fields

  • Student ID (User)
  • Variable Type (its ID)
  • Value

Import ID Fields

  • Student ID (User)
  • Variable Type

Defaults

  • Variable Type

User Resource

Fields

  • Email
  • First Name
  • Last Name
  • Is Active
  • Is Staff
  • Is Superuser
  • User Permissions
  • Groups

Import ID Fields

  • Email

Course Resource

Fields

  • ID
  • Course ID
  • Course Name
  • Credits Awarded
  • On Course Selection Form
  • Course Placement
  • Special Permission
  • Retakeable
  • Eligibility
  • Description

Import ID Fields

  • Course ID

Scheduling Master (Section Resource)

Fields

  • ID
  • Course ID
  • Section Number
  • Period
  • Cycle
  • Room
  • Teacher
  • School Year
  • School Term

Import ID Fields

  • Course ID
  • Section Number
  • Period
  • School Year
  • School Term

Defaults

  • School Year
  • School Term

Class List (Schedule Resource)

Fields

  • ID
  • Student ID
  • Course ID
  • Section Number
  • School Year
  • School Term

Import ID Fields

  • Student ID
  • Course ID
  • Section Number
  • School Year
  • School Term

Defaults

  • School Year
  • School Term

Permanent Record Resource

Fields

  • Student ID
  • Type of Item
  • Course ID
  • Course Name
  • Teacher
  • Credits
  • Grade
  • School
  • School Term
  • School Year
  • Marking Period

Import ID Fields

  • School Year
  • Student ID
  • School ID
  • Course ID

1.20 (Marking Period Resource)

Fields

  • Student ID
  • Type of Item
  • Course ID
  • Course Name
  • Teacher
  • Credits
  • Grade
  • School
  • School Year
  • School Term
  • Marking Period
  • Comment One
  • Comment Two
  • Comment Three

Import ID Fields

  • School Year
  • School Term
  • Student ID
  • Course ID
  • Marking Period

Defaults

  • School Year
  • School Term
  • Marking Period

RACL (GC <--> OFCL Mapping)

Fields

  • OFCL
  • Advisor

Import ID Fields

  • OFCL

Course Application Resource

This is intended for export only.

Fields

  • ID
  • Creating User's First Name
  • Creating User's Last Name
  • Student's First Name
  • Student's Last Name
  • Student's OFCL
  • Student's Student ID
  • Course's Course ID
  • Course's Course Name
  • State
  • Created Datetime

Rule Preference Resource

This is intended for export only.

Fields

  • ID
  • Creating User's First Name
  • Creating User's Last Name
  • Student's First Name
  • Student's Last Name
  • Student's OFCL
  • Student's Student ID
  • Rule ID
  • Rule Name
  • Course's ID
  • Course's Course ID
  • Course's Course Name
  • Credits
  • Manually Done

Choice Export (by Rule)

This is intended for export only.  This will generate one line per rule that a student has selections for.

Fields

  • Student's First Name
  • Student's Last Name
  • Student's OFCL
  • Student's Student ID
  • Rule ID
  • Rule Name
  • Course 1
  • Course 2
  • Course 3
  • ...
  • Course 7

Request File Export

This is intended for export only.  This will generate one line per student who has made selections taking only their first choice.  This is formatted for a DOE import.

Fields

  • School ID
  • School Year
  • Term ID
  • Gender
  • Student's First Name
  • Student's Last Name
  • Student's OFCL
  • Student's Student ID
  • Rule ID
  • Rule Name
  • Course 1
  • Course 2
  • Course 3
  • ...
  • Course 16

Special Permission Courses by Student

This is intended for export only.  This will generate a report of the courses a student is eligible for. 

Fields

  • First Name
  • Last Name
  • Student ID
  • OFCL
  • Course ID
  • Eligible

Course Placement Resource

This is intended for export only.

Fields

  •  ID
  • School Year
  • School Term
  • Student ID
  • First Name
  • Last Name
  • OFCL
  • Student ID
  • Course ID
  • Course Name
  • Rule ID
  • Rule Name
  • Rank 
  • Status

Weekly Engagement Resource 

This is intended for export only.

Fields

  • ID
  • Student First Name
  • Student Last Name
  • Student ID
  • Student OFCL
  • Section ID
  • Course ID
  • Course Name
  • Section Number
  • Teacher
  • User First Name
  • User Last Name 
  • User Email
  • Status
  • Year
  • Week 

Related articles

Comments

0 comments

Please sign in to leave a comment.