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
  • Integration overview
  • File requirements
  • FTP Server integration
  • Publisher (required)
  • Content (required)
  • Offer (required)
  1. Products
  2. Content
  3. Unizin Order Tool
  4. Implementation

Institutional (SIS) Catalog Import

Integration overview

The institutional (SIS) catalog integration is a feature that institutions can leverage to import publishers, content, and offers available through their own agreements.

Institutions might import their own catalog so that orders can be placed, monitored, and fulfilled through the Unizin Order Tool. Digital content can be delivered automatically through Unizin Engage if content files are provided to the Unizin Services team. Unizin supports inclusive access and enterprise agreements today as well as free digital course materials available through open educational resource (OER) licensing or the Institution.

The institutional (SIS) catalog integration is a dataset of CSV files, generated and imported once before the ordering period opens, that contain the publishers, content, and offers for a specific term. The files are pushed by Institutions to an FTP server.

The following document describes the contents of the CSV files required. It also describes the integration mechanism and requirements.

Note: distinct data integrations are required for your production and user-acceptance testing environments.

File requirements

The following requirements apply to all the CSV files in the institutional (SIS) catalog integration.

  • Generated once per term. Catalog data must be generated and pushed to the FTP server once before the ordering period opens for the term. This data must contain the publishers, content, and offers that can be ordered for the upcoming ordering period. Once catalog data is imported, it cannot be deleted or removed through the import process. In the case that another import must be run for a term, you may do so for only the records that you'd like to update or the new data that you'd like to import. Please note, only content and publisher records can be updated automatically. In the case that existing offers need to be updated, please contact the Unizin Services team to approve and schedule a time to do so.

  • Missing Data and Optional Fields. Not all data requested in an integration file is required. If you are including an optional field but are missing values for some records, please leave the field blank for that record.

  • Headers. Your CSV files must have a header row on line 1. The tables below provide header names for each CSV file. If you are not providing data for an optional field, please omit the field (including the header).

  • Formatting. The CSV files for SIS data should adhere to the following formatting rules:

    • All files should be UTF-8 encoded.

    • All whitespace after the separator (,) will be imported. Avoid extraneous whitespace.

    • In the case of missing data for a field, please leave the field blank for that record. Do not provide "null" or another value.

FTP Server integration

Connection details:

  • Port: 22

  • Username: as given, per environment

  • Password: as given, per environment

Named sub-folders to the user's root folder will already be defined for each credential:

Folder
Function

/sis-data

Institutions place their data integration files in this folder.

Notes on an institution's institutional (SIS) data integration (to /sis-data):

  • Overwrite the CSV data files if they happen to still be in the FTP folder.

  • Unizin Imports run at 8:00 AM UTC. Uploading as near that time as possible ensures up-to-date data.

Publisher (required)

Filename: publisher.csv

Publisher data is required for this integration. At Unizin, a publisher is the digital course materials provider that sells or publishes digital content, courseware, and/or learning tools. The Institution strikes an agreement with the publisher to resell the publisher’s digital course materials as a third party.

Header
Data Type
Description
Required?

sis_publisher_id

text

The unique identifier for the publisher or vendor.

yes

name

text

The name of the publisher or vendor.

yes

Content (required)

Filename: content.csv

Content data is required for this integration. At Unizin, content refers to the digital content, courseware, or learning tool that can be adopted by faculty members and instructors. Any given content that is available through your Institution’s agreements should be represented once and only once in this file.

Header
Data Type
Description
Required?

sis_content_id

text

The unique identifier for the content. Any content can be associated with a single sis_content_id. The recommended format is the concatenation of your institution code and the billable ISBN, e.g. “unizin_9783161484100".

yes

availability_status

option set

The availability status for the content. The option set (or choices) includes the following: available, not yet available, or unavailable. The availability status is displayed in the Master Catalog only. The default value is “available”. In the case of missing data, please leave this field blank for that record. Do not provide "null" or another value.

no

title

text

The title of the content.

yes

edition

text

The edition of the content. In the case of missing data, please leave this field blank for that record. Do not provide "null" or another value.

no

authors

text

The author of the content. Although this is not required, it is highly recommended. In the case of missing data, please leave this field blank for that record. Do not provide "null" or another value.

no

publication_date

date

The date that the content was published. It is highly recommended that this be included. In the case of missing data, please leave this field blank for that record. Do not provide "null" or another value.

no

description

text

The description of the content. In the case of missing data, please leave this field blank for that record. Do not provide "null" or another value.

no

sis_publisher_id

text

The SIS identifier for the publisher that is associated with the content.

yes

digital_purchase_isbn

text

The ISBN that represents the digital format of the content. ISBNs must be alphanumeric and cannot contain special characters, e.g. 9783161484100 or UNIZIN123.

yes

billable_isbn

text

The ISBN that the publisher or vendor uses for billing purposes. ISBNs must be alphanumeric and cannot contain special characters, e.g. 9783161484100 or UNIZIN123.

yes

searchable_isbn

text

The ISBN that faculty members and instructors can use to search for and find the content on the web. ISBNs must be alphanumeric and cannot contain special characters, e.g. 9783161484100 or UNIZIN123.

yes

is_dlt

boolean

A flag to describe whether the content is a digital learning tool. This should be “TRUE” or “FALSE”. The default value is “FALSE” which indicates that the content is an eText. In the case of missing data, please leave this field blank for that record. Do not provide "null" or another value.

no

Offer (required)

Filename: offer.csv

Offer data is required for this integration. At Unizin, an offer refers to the price and access details associated with content for the specified term. Content can be associated with many offers, but only one offer for any given term. For example, a single content can have an offer for the Fall 2021 term, an offer for the Spring 2022 term, and an offer for the Summer 2022 term.

For the purposes of importing, this file should only contain offers for the terms associated with the upcoming ordering period. For example, if ordering is opening for the Summer 2021 and Fall 2021 term in two weeks, you might generate an offer.csv file (in addition to the other catalog data files) containing two offers for each content (one for Summer 2021 and another for Fall 2021).

Please note, offers can only be created as part of the nightly import process. If you need to update existing offers, please reach out to the Unizin Services team to approve this and schedule a time to do so.

Header
Data Type
Description
Required?

sis_content_id

text

The SIS identifier for the content that is associated with the offer.

yes

sis_term_id

text

The SIS identifier for the term that the offer is associated with.

yes

print_list_price

currency

The market price associated with the content for the specified term. This is used to communicate discounts during the order and student choice processes. This should be formatted as a decimal with two places, e.g. 40.00 or 155.88.

yes

offer_price

currency

The discounted price associated with the content for the specified term. This should be formatted as a decimal with two places, e.g. 40.00 or 155.88.

yes

length_of_access_duration

integer

The numerical unit associated with the amount of time that the student has access once they purchase the content. This is required for DLT materials. In the case of missing data for eTexts, please leave this field blank for that record. Do not provide "null" or another value.

no

length_of_access_type

option set

The calendar unit associated with the amount of time that the student has access once they purchase the content. This is required for DLT materials. The option set (or choices) includes the following: semester, day, month, or week. In the case of missing data for eTexts, please leave this field blank for that record. Do not provide "null" or another value.

no

PreviousFinal declined offers feedNextStudent Price

Last updated 1 year ago

Unizin uses as an FTP server service for the institutional (SIS) catalog integration. You will receive two sets of credentials: one for your production environment integration, one for your user acceptance testing environment integration.

Hostname:

BrickFTP
unizin.files.com