Unizin Product Documentation
ProductsSupport and TrainingPolicies
  • Unizin Product Documentation
  • Products
    • Content
      • Unizin Engage
        • eReader User Guide
          • Notes, Highlights, and Citations
          • Appearance Settings
          • Download for Offline
          • eReader Layout
          • Keyboard Shortcuts
          • Navigating Your eBook
          • Print
          • Text to Speech
          • Copy and Paste
          • Creating Flashcards
          • Collaboration and Note Sharing
          • Pearson Titles
        • Institution Support
          • Disabled Student Services / Alt-Format
            • Best Practices for Republishing Course Content
            • Disabled Student Services
            • Requesting eTextbook Files for Accessibility Purposes
            • WCAG 2.0 AA evaluation for Engage
            • WCAG 2.0 AA evaluation for EPUB for Engage
          • Institution's Support Responsibilities
        • Caliper 1.1 sensor
        • Release Notes
          • 2.28.22
          • 2019-09-17
          • 2019-05-29
          • 2.26.8
          • 2.26.0
          • 2.25.0
          • 2.22.0
          • 2.21.6
          • 2.21.5
          • 2.20.8
          • 2.20.5
          • 2.20.3
          • 2.19.1
          • 2.18.0
          • 2.17.0
          • 2.14.0
          • 2.12.0
          • 2.11.0
          • 2.9.0
          • 2.8.3
          • 2016-03-17
          • 2016-02-11
          • 2016-01-28
        • Using Analytics (New)
      • Unizin Order Tool
        • Overview of the User Interface
        • Key Concepts
          • Profiles
          • Ordering periods
          • Coordinator permissions
          • Program administrator permissions
        • Courses & Ordering
          • Course filtering
          • Place an order
          • Add sections to a placed order
          • Edit a placed order
          • Cancel an order
          • Reordering
        • Order History
          • Instructor Order History
          • Coordinator and Program Administrator Order History
          • Order Activity
        • Student Choice
          • Student Choice (Program Administrators)
          • Student Choice (Students)
        • Entitlements
          • Entitlements (Program Administrators)
          • Entitlements (Students)
        • Catalog Tool
        • Schedule of Classes
        • Content Request Tool
        • Order Tool Dashboard
        • Vendor Sandbox Tenant
        • Institution Support
        • Implementation
          • SIS Data Integration
            • 1.0 - SIS Integration
            • 2.0 - SIS Integration
          • SSO integration
          • UI customizations
          • Order Feed
            • 1.0 - Order Feed
            • 2.0 - Order Feed
            • 3.0 - Order Feed
          • Publisher report
          • Final declined offers feed
          • Institutional (SIS) Catalog Import
          • Student Price
          • Historical Entitlements Import
        • Release Notes
          • Order Tool Bug Fixes and Enhancements
          • Order Tool Bug Fixes
          • Order Tool Accessibility Improvements
          • Order Feed Improvements
          • Content Request Form Update and Minor Bug Fix
          • Flat Markup Fee Update
          • Ordering Email Receipt Update & Minor Bug Fix
          • Bug Fix for Public Catalog Feature
          • Catalog Search Enhancements
          • Reordering Reminder Email Notifications
          • UX Improvements & Minor Bug Fixes
          • Historical Entitlements Import
          • Student Prices
          • Reordering Feature
          • Email Enhancements
          • Ordering Enhancements
          • Bug Fix for the Institutional Catalog Import
          • Bug Fix for the Final Declined Offers Feed (FDOF)
          • Order Activity Feature and Other Enhancements
          • Bug Fixes for Order History and Report an Issue Features
          • Public catalog feature
          • Minor Bug Fixes for Ordering and Student Choice
          • Entitlements Production Release, Bug fixes, and Minor updates
          • Minor Updates and Bug Fixes for Ordering Workflows
          • Catalog Search Optimization
          • Student Choice
          • Archive Terms Feature and Integration Improvements
          • Introduces the Program Administrator role, Catalog Tool, and Schedule
          • User interface updates and improvements
          • Order feed improvements
          • Order history, UI enhancements
          • Email notification upgrades, UI improvements
          • Order feed changes
          • New features for Course coordinators and upgrades to the UI
          • Changes to the Term, Course, and Section models; introduces a Session
          • Bug fixes, import improvements, and validation improvements
          • Tracking Order History
          • Publisher Reporting
          • Fixes the order feed, automates SIS data importing, and automates the generation of order feed repor
    • Data & Analytics
      • Unizin Data Platform
        • Key concepts
          • Platform overview
          • Data categories
          • Data models
          • Loading schemas
          • Keymap
        • Unizin Common Data Model
          • Academic structures (ERD)
          • Learners (ERD)
          • Course structures (ERD)
          • Course resources (ERD)
          • Learner activities (ERD)
          • Quizzes (ERD)
          • Social (ERD)
          • Course outcomes (ERD)
        • System overview
          • Context data pipeline
            • Context data ingress
            • Batch-ingest application
            • Batch-ingest db server
            • Context store
          • Event data pipeline
            • UDP Caliper endpoint
            • Approval process for implementing Caliper compliant tools
            • UDP Event enricher
            • Event store
        • Data stores
          • Data lake
            • UDP Context store
            • UDP Event store
              • Accessing the Event store
              • Expanded table
                • Expanded table: Canvas edApp mapping
            • Synthetic Data [beta]
              • Viewing Synthetic Data datasets within the BigQuery UI
              • Query Synthetic Data via client libraries
          • Data marts
            • UDP Distributions
            • Interaction sessions
            • Learning Environment Organization
            • File Interaction
            • Last Activity
            • Long Inactivity
            • Course Status
            • Daily Course Grade Record
            • LTI Tool Use
            • LMS Tool Use
            • Tool Usage Metrics
            • Links
            • Taskforce
              • Level 1 Aggregated
              • Level 2 Aggregated
              • Level 2 Course Weekly Distribution Summary
              • Student Term Profile
              • Course Profile
            • Student Activity Score
              • Student Course Metrics
              • Student Course Section Metrics
              • Final
              • Course Final
              • Course Section Final
        • Data integrations
          • Context data integration
            • Loading schema
            • Keymap support
            • Manifest file
            • File requirements
            • Integration mechanics
          • Event data integration
          • SIS data integration
          • LMS data integration
            • Instructure Canvas
        • Release Notes
          • UDP Marts Release Notes
            • 1.0.83
            • 1.0.80
            • 1.0.79
            • 1.0.78
            • 1.0.77
            • 1.0.72
            • 1.0.67
            • 1.0.58
            • 1.0.51
            • 1.0.44
            • 1.0.42
            • 1.0.32
            • 1.0.31
            • 1.0.0
            • Level 2 Taskforce data marts now available
          • 2.0.167
          • 2.0.152
          • 2.0.138
          • 2.0.137
          • 2.0.113
          • 2.0.112
          • 2.0.111
          • 2.0.110
          • 2.0.99
          • 2.0.98
          • 2.0.83
          • 2.0.80
          • 2.0.71
          • 2.0.66
          • 2.0.59
          • 2.0.58
          • 2.0.53
          • 2.0.47
          • 2.0.25
        • Miscellaneous
          • Canvas Data additions, ~Fall 2021
          • Canvas Live Events: from SQS to HTTPS
          • Canvas New Analytics vs. UDP
          • Course Section Enrollment Role Status Mappings
          • Migrating from UDW to UDP
      • Unizin Data Warehouse
        • Implementation Guide
        • Scope of Services
        • Access Provisioning
        • Access Revocation
        • Connecting to the UDW
      • Raw Canvas Data 2
        • Flat Files
        • BigQuery Datasets
    • Hosted Services
      • My Learning Analytics
        • Install MyLA via LTI 1.3
        • Custom configure MyLA
  • Support and Training
    • Professional Development
      • Stepping Stones: A Faculty Development Curriculum for Learning Analytics Use
      • Structured Conversations initiative
    • UDP Self-paced Training
    • Resources Site Broken Links
    • Status Pages
  • Policies
    • General policies
      • Sponsor Teams
      • Browser Support Policy
      • Opt-Out & Invoicing Policy (Order Tool)
    • Support Policy
      • Unizin Engage - SP
      • Unizin Order Tool - SP
      • Unizin Data Platform - SP
      • Unizin Data Warehouse - SP
      • Unizin Data Analysis - SP
      • Pressbooks Hosting - SP
    • Privacy Policy
      • Unizin Engage - PP
      • Unizin Order Tool - PP
      • Unizin Data Platform - PP
      • RStudio service - PP
    • End User License Agreements
      • Unizin Engage - EULA
      • Unizin Order Tool - EULA
    • Terms of Use
      • Unizin Data Platform - ToU
    • Incident Reports
Powered by GitBook
LogoLogo

Unizin Homepage

  • unizin.org

Data & Analytics

  • Unizin Data Platform
  • Unizin Data Warehouse

Content

  • Unizin Engage
  • Unizin Order Tool

Hosted Services

  • My Learning Analytics

Copyright © 2023, Unizin, Ltd.

On this page
  • Overview
  • Implementation
  • Entitlement.csv
  1. Products
  2. Content
  3. Unizin Order Tool
  4. Implementation

Historical Entitlements Import

PreviousStudent PriceNextRelease Notes

Last updated 1 year ago

Overview

The historical entitlements import is available to all Order Tool institutions. This import might be used to support the addition of a learning tool (e.g. TopHat Classroom) to an institution’s catalog. For example, an institution might seek to add TopHat Classroom to its catalog and require a backfill of historical entitlements to ensure that students are not overcharged. These historical entitlements represent purchases that students made outside of Order Tool but allow them to access TopHat Classroom for the lifetime of their enrollment. By importing an institution's historical entitlements, students will not be charged again for use of the learning tool in future courses where it is adopted (where the entitlement is valid). Order Tool will have a record that the student has an and report it accordingly in the based on the import of historical entitlements.

To run the historical entitlements import, please reach out to the Unizin Services team via email at to discuss your use case. When proposing your use case, please provide details of the digital course material you’re seeking to add to your catalog in Order Tool and the reason that a backfill of historical entitlements is required for this.

Implementation

Unizin will work with the institution to add catalog items and offers for a specific learning tool. Collaboration is also needed to determine the type of backfill offers that must be created for the digital course material.

Since there must be, at most, one offer per academic term, a backfill academic term must be created by the institution for every backfill offer needed. For example, an institution might want to backfill entitlements where students are entitled to the catalog item for the lifetime of their enrollment and for 1-year access. Given this example, the institution would create two backfill academic terms which will be added to the for one import. The terms in this example would be:

  • 1-Year Backfill

  • Lifetime Backfill

The Unizin team will archive these two terms after a successful import. The institution would only need to provide these backfill terms once. Once the academic term is archived, the term start and end dates will be set by Unizin to 01/01/2000 to 12/31/2000, respectively.

Next, the Unizin team will create a backfill offer for each backfill term. These offers must be associated with the same content record, and that content record will be the same record used for future offers. The list price, offer price, and student price for each backfill offer will be $0 since it was paid for outside of Order Tool.

Once the backfill offer records are created in an institution’s production tenant, the offer ids will be provided to the institution. From here, the institution (often in partnership with the publisher or learning tools vendor) will create an “entitlement.csv” file.

Next, an institution will upload the “entitlement.csv” file to their “sis-data” bucket, for the appropriate environment (UAT or PROD) to BrickFTP. The Unizin team recommends testing this import in UAT prior to performing it in an institution’s PROD tenant. To run the import, the Unizin Services team will run the import on an agreed-upon date. Once the import is complete, the Unizin team will provide a report describing the outcome of the import. In the case that some entitlements could not be created, those records will be communicated to the institution for review.

Unizin will also discuss with the institution how they intend to facilitate ordering for this digital course material in the future. For some institutions, it might make sense for the Unizin team to add these offers manually. For other institutions, it might make sense to provide content and offers through the . The Unizin team will work with you to determine the best approach for your use case.

Entitlement.csv

The entitlement.csv file must contain all data outlined below.

Field name
Data type
Description

email

Text

This field is required. In order to capture an entitlement, it must map to an email address for a user in your Order Tool tenant. Users are provided in your SIS Feed.

start_date

Date

This field is required. It must be formatted as YYYY-MM-DD. The start date will be used to calculate the end date for the entitlement based on the length of access defined for the offer. For example, if a student has an entitlement starting on 2020-01-01 for one year (based on the length of access defined in the offer), then their entitlement end date will be calculated as 2021-01-01.

offer_id

Integer

This field is required. These values will be provided by the Unizin team. There will be one offer_id for each type of entitlement. For example, if entitlements will be captured for 1-year and 6-month access, then two offer_ids will be provided. It is the responsibility of the institution to map these to student emails accordingly.

For additional information, please see our File requirements documentation .

here
entitlement
Final Declined Offers Feed
support@unizin.org
Institutional Catalog Import
SIS Feed