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
  • Why a keymap?
  • Keymap and context data
  • Keymap and behavior data
  1. Products
  2. Data & Analytics
  3. Unizin Data Platform
  4. Key concepts

Keymap

PreviousLoading schemasNextUnizin Common Data Model

Last updated 1 year ago

The UDP Keymap is an essential concept of the Unizin Data Platform (UDP).

The UDP Keymap enables the UDP to associate learning data from learning tools into a single representation of teaching and learning. The UDP Keymap achieves this by associating the identities of the same phenomena across different tools (e.g., a course section or person) with a single, surrogate identifier called a UDP ID.

Why a keymap?

Students' learning experiences unfold over many learning tools. Each learning tool used in a course may deliver a part of a student's learning experience. From a student's perspective, however, learning tools are just part of an overall, singular set of learning experiences in a single course. As digital education increasingly relies on learning tools, data about learning becomes increasingly distributed across those learning tools. A key challenge, therefore, is to reconstruct learning experiences and learning environments from data sourced from a variety of learning tools.

In any given learning tool, data is identified by identifiers (or "keys") that are native to the tool. For example, a user or course section in a learning tool is identified by a User ID and Course section ID. These identifiers are not universal; they are meaningful only within the learning tool itself. The UDP calls such identifiers “native keys,” since they are native to a particular learning tool and not universal in nature. When learning tools push context and behavior data into the UDP, they use their native keys to identify the data.

When the UDP receives learning tool data and its native keys, it attempts to correlate that learning tool’s data with the data from other learning tools. For example, the UDP will attempt to pair SIS Course section data with their corresponding LMS Course section data. To pair the SIS and LMS data (in this example) means to have identified that the data from both systems are, in practice, “about” the same Course section.

If the UDP is successful in associating data from different learning tools that are about the same thing (e.g., a particular learner), then the UDP associates the native keys of those learning tools together. It manages those associations through the UDP’s keymap. More specifically, the UDP creates a new, surrogate key for a real phenomenon (e.g., a particular Course section) that the UDP calls a “UDP key.” A UDP key's relationship with learning tool native keys will be expressed in the keymap.

The purpose of the UDP keymap is to maintain the relationships between the surrogate keys generated by the UDP and their corresponding native keys. In practice, for example, a single surrogate key for a learner may be correlated to a dozen native keys from learning tools that represent the same learner.

Keymap and context data

The UDP keymap is generated and maintained during the context data ingestion process. Consequently, the UDP's keymap is instantiated in its context data stores.

In practice, the UDP is able to correlate native keys from different systems together because learning tools maintain the native keys they are given from other systems, typically as part of a data provisioning process. For example, it is standard for student, term, and course data in the LMS to be provisioned through a data feed from the SIS. An SIS data feed to the LMS will contain the native SIS keys for records (e.g., a course record) that the LMS holds on to. When the LMS reports its context data to the UDP it will include the native SIS identifiers that it was given, thereby enabling the UDP’s context data ingestion process to associate LMS and SIS data.

The UDP keymap is available to all institutions in the UDP Context store service.

Keymap and behavior data

While the UDP’s behavior data ingestion pipeline does not play a role in creating or maintaining the UDP keymap, it does use the UDP keymap as part of its “data enrichment” process.

Behavior data enrichment is an important UDP feature that is related to the UDP keymap. When the UDP ingests behavioral data in Caliper format, it extracts the native keys provided by the learning tool from the Caliper event. Using those native keys, the UDP will query the UDP keymap to find the corresponding UDP keys (if available) and include the UDP keys in the event data and as part of the Event store record. This enables any downstream consumer of the UDP Event store data to join behavioral data and context data using a single set of identifiers (UDP keys).

When behavioral data is generated and emitted by learning tools, it almost always contains that tool’s native keys. For example, a behavioral event like “Susan submitted an assignment” will contain the learning tool’s native keys for the student (Susan), the object in relation to which an action is performed (the assignment), and perhaps something about the context (the Course in which the behavior took place). If a learning tool is launched from the LMS via the , the tool's behavior events may also have its corresponding LTI launch parameters.

IMS Global LTI standard