You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Summary

In late 2019, Unizin Order Tool will provide a new billing and invoicing workflow feature. To support that feature, Order Tool will need additional data from institutions provided in its SIS feeds. The proposed changes are described below. We ask our institutions to implement the following changes by <insert date here> for our test environment and <insert date here> for our production environment. 

Student Choice

Unizin is creating an experience for Students in Order Tool to enable them to either opt-in or opt-out of their Inclusive Access course materials. In order to accommodate the various student choice needs across our member institutions, Unizin has created an Institution-wide configurable model that will enable institutions to create their student choice experience. 

The model is based on the following concepts, each of which can be configured by the institution:

  1. Student choice policy. This defines the broad variables of a student choice policy that is applied across the institution. The policy creates the student opt-in or opt-out experience in Order Tool and any related workflows for administrators. 
  2. Student choice policy exceptions. Most institutions define various types of exceptions or exemptions from their student choice policy. Unizin will provide support for them and enforce them in the user experience.

  3. Student choice workflow. Every institution delivers a different experience to students as they work through the process of opting in or out. That experience extends to the student journey after the student opts-in or opts-out, typically through the first few weeks of a term.
  4. Business alerts. Every institution delivers a different experience to students as they work through the process of opting in or out. That experience extends to the student journey after the student opts-in or opts-out, typically through the first few weeks of a term.

With the exception of Student choice policy exceptions, all other concepts will be implemented in an institution's Order Tool tenant in coordination with the Institution's Sponsor team and the Unizin Services team. In order to implement Student choice policy exceptions for the model in Order Tool, we require institutions to send us additional student enrollment data through the data integration to enforce these exceptions. 

Student Choice policy exceptions must be defined globally to all campuses, courses, and sections. For example, institutions cannot enforce a particular exception to one campus and not to another. 


Student Enrollment Data

Header

Data Type

Description

Required?

sis_user_id

String (255 max length)

The foreign key to a User who is a student enrolled in the section.

Yes

sis_section_id

String (255 max length)

The foreign key to a Section being taught.

Yes

is_exempt_from_paymentBooleanNEW. This is a boolean value corresponding to whether or not the student needs to pay for the course material(s). If `true`, the student will have a tailored experience in Order Tool so that the student knows she/he will not be charged for the material(s). If the policy at the institution is `opt-in`, the student will have a tailored experience to be automatically opted-in. Yes
is_exempt_from_payment_reasonStringNEW. This defines the reason behind a student's exemptions from paying for the course material(s) in the course. I.e., this explains why a student cannot opt-out or why they were automatically opted-in. 

Section-specific Indicators for Billing and Deliverability

The following additions were included to account for any parent-child sections permutations that may exist across our institutions. The broader goal is to capture any information that may impact Unizin's ability to accurately supporting billing and invoicing. 

Header

Date Type

Description

Required?

sis_section_id

 

The unique SIS ID for the Term; e.g., "201890-22-BIO-101-0001."

Yes

sis_org_id

 

The foreign key to the Organization at which the Section is being taught.

Yes

sis_course_id

 

The foreign key to the Course to which this Section belongs.

Yes

title

 

The course title; e.g., "Introduction to History."

Yes

lms_id

 

This is the unique ID that identifies the Course Section in the LMS. I.e., this is the string provided by Canvas to uniquely identify the Section.

It is essential that the values for this data point match the LTI parameter that uniquely represents a Section in an LTI launch from your LMS.

Yes

label A human-readable label for the Section that should uniquely identify the Section for a user in Order Tool.Yes
section_type The type of Section. Typical values may include "Lecture," "Lab," "Recital," etc. Some institutions call this a Section "component."Yes
class_number This number is unique to the set of Sections for a Term. The values are typically integers.Yes
section_number This number is unique within the set of Sections for a Course offering. Often, values may be 001, 002, 003 to distinguish the distinct Sections of a single Course offering.Yes

max_enrollment

 

The maximum allowed student enrollment in the section.

Yes

start_date

 

The date (YYYY-MM-DD) instruction begins. Must follow the date format in ISO 8601.

No

add_drop_deadline

 

The date (YYYY-MM-DD) of the add/drop deadline. Must follow the date format in ISO 8601.

No

end_date

 

The date (YYYY-MM-DD) ends begins. Must follow the date format in ISO 8601.

No

is_orderableBooleanNEW. This is a boolean value corresponding to whether or not a particular section can have contents ordered for it. In some parent-child section relationships, the child section will inherit the course materials delivered to the parent section. Thus, the child section cannot be ordered for. The default value should be TRUE. Yes
is_deliverableBooleanNEW. This is a boolean value corresponding to whether or not a particular section can have course materials delivered to it. In some parent-child section relationships, the child section will inherit the course materials delivered to the parent section. Thus, the course materials of the child section cannot be delivered to the child section. The default value should be TRUE. Yes
is_billableBooleanNEW. This is a boolean value corresponding to whether or not a particular section can be billed for particular course materials. The default value should be TRUE. Yes
is_combinedBooleanNEW. This is a boolean value corresponding to whether or not a particular section is combined or is the parent or child section of another. The default value should be FALSE.Yes
parent_idStringNEW. This specifies the sis_section_id of the parent section this particular section belongs to. The default value should be NULL. Yes