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
  • Semantic alignment to a loading schema
  • Data types
  • Primary and foreign keys
  • Current loading schemas
  • SIS Schemas
  • LMS Schemas
  • LTI Tools
  • No loading schema exists for my system
  1. Products
  2. Data & Analytics
  3. Unizin Data Platform
  4. Data integrations
  5. Context data integration

Loading schema

PreviousContext data integrationNextKeymap support

Last updated 1 year ago

A UDP loading schema specifies the contents of a context dataset that can be accepted by the UDP.

A UDP loading schema is derived from the and composed of UCDM entities and elements.

Consequently, a loading schema specification is in majority composed of a set of entities and their elements that are relevant to describing the context data from any particular Learning tool. These entities and elements become the basis for a dataset (presented as CSV files and pushed into a Google CloudSQL bucket) that the UDP validates and then imports.

Semantic alignment to a loading schema

To produce a context dataset, you must identify data points in your own system (e.g., an SIS) that align with the meaning of entities and elements in the relevant loading schema. Care must be taken to ensure the greatest semantic alignment possible.

If an element's values are enumerated by an option set, then the values provided by the learning tool for that element must be from the option set.

As long as your context data correctly aligns with the UCDM ontology and its data definitions, context data will be imported into the UDP. This enables you to start with a foundational context data footprint that can iteratively expand over time. Iterations do not require approval from Unizin – as long as your UDP loading schema is derived from the UCDM, context data that conforms with the UDP loading schema will be imported.

The contents of a UDP Loading schema reference the 's dictionary of entities and elements. In the end, a loading schema is composed of a set of particular entities and, for each entity, a set of elements that belong to that entity.

Data types

The values for every Loading schema element must conform data type. A UDP loading schema will, for every element in it, specify the data type of the element value. Data types are enforced by the UDP during the import process. Therefore, it is important to ensure that your data conforms with the required data types.

Broadly speaking, there exist two classes of data types in the UCDM.

The first is a conventional set of data types that is typical of technical systems, such as dates, numbers, strings, and booleans.

The second is an enumerated set of values, called an Option set. For example, the data type definition for the Educational level element of the is an option set called . The Degree educational level option set defines a finite set of valid values for the educational level of an academic degree that can be earned by a student.

Primary and foreign keys

The UCDM is both a data dictionary and a relational model.

As a relational model, the UCDM requires learning tools to provide relational data to the UDP. Consequently, all UCDM entities in a loading schema will contain either primary keys and/or foreign keys, depending on the definition of the Entity. Furthermore, particular elements of a UDP Loading schema will refer to foreign keys that express relationships between entities.

For example, all enterprise systems or Learning tools that have a concept of a Course section have a corresponding concept of a Course offering, which is the parent of a Course section. Accordingly, Course section records from a Learning tool will natively have foreign keys to the Course offering parent for each Course section record. To accept these foreign keys, the Course section entity in a loading schema will contain a Course offering ID element. That element refers to the foreign key to the Course offering entity.

Current loading schemas

UDP Loading schemas exist today for a variety of learning tools (e.g., eReaders) and key enterprise systems, such as the Student Information System and Learning Management Systems. If a UDP loading schema does not exist for your type of learning tool, then a new UDP loading schema must be defined. We strongly encourage you to work with Unizin to define a UDP loading schema for your tool, especially if your tool requires extensions to the Unizin Common Data Model (which Unizin maintains).

SIS Schemas

LMS Schemas

LTI Tools

No loading schema exists for my system

Identify or create a UDP loading schema of context data that is relevant to your LTI application. Once identified or created, the UDP loading schema serves as the specification for data that the LTI application pushes into a UDP instance. If a relevant UDP loading schema does not exist for your learning tool, then Unizin will work with you to create a new UDP loading schema with you.

Unizin Common Data Model
Unizin Common Data Model
Academic degree entity
Degree educational level
SIS 1.0
SIS 2.0
LMS 1.0
LMS 2.0
Canvas Data to UCDM
Classroom response system
E-Reader
Originality Checker
Video Delivery System