Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Unizin Order Tool provides automated reports to Institutions and Publishers. The reports are intended enable Institutions to drive the business processes of inclusive access once content is orderedthat follow from content ordering

1. Order

...

feed overview

The Unizin Order Tool generates order feeds that report order data in a comma-separated value format. Institutions use order feeds to drive local business processes.

Order Feeds are term-specific. If an institution has allowed ordering for multiple terms at once, then multiple order feeds may be generated at the same time.

Two kinds of Order Feeds are generated:

  • Delta Order Feeds are generated every night. They report new and changed orders from the past 24 hours. If no new orders have been created or changed in 24 hours, then the Unizin Order Tool does not generate a delta Order Feed.
  • Full Order Feeds are generated every Sunday night. They report all of the orders for a particular term. 

Order feeds are generated at 3 am EST every night and pushed to an FTP server where they are accessible by an institution. Reports are run in

Order Feeds are generated for both the production (PROD) and user acceptance testing (UAT) environments. Institutions may use the same FTP server credentials they use to push their data integration for Order Tool in the PROD and UAT environments.

Report summary:

NameOrder report
Delivery/order-feed folder on FTP server
Run at3 am Eastern time
PeriodicityNightly (for deltas) and weekly (for full)
Contains

A record for each content-section pair in an order, along with metadata about the course, section, and order itself.

Orders are only reported during open ordering periods. It is only during those times that orders can be generated.

...

2. Processing order feeds

Importantly, Order Feeds are snapshots of the orders in Order Tool. The records of an Order Feed describe the present state of an order. The records of an Order Feed to not represent a transaction (e.g., a section was added to an order).

Given the format of an Order Feed 9see below), there are two recommended ways of processing it:

  1. For every order reported in the Order Feed, drop and reload the order data in your local Institutional system.
  2. For every order reported in the Order Feed, determine the difference between it and the state of that order in your system and update your records as necessary.

Note: it is expected that Institutions remove Institutions remove order feeds from feeds from the “order feed” folder after they have pulled it down and conducted their processing.

IU has asked for both deltas and full dumps. Deltas would be created and pushed to an FTP server every night. Full dumps would be generated on demand for auditing purposes. The deltas should include both new and changed orders since the last dump.

Filename schema

 The Unizin Order Tool’s order reporting is delivered as CSV files. One file is generated for each Term that is currently open for ordering. The Unizin Order Tool will use the sis_term_id value from your data integration in the filename of each CSV file, as follows:

...

  • YYYY-MM-DD is the year, month, and date that the feed was generated

  • <sis_term_id> is the institution's SIS identifier for the term

File format

The order feed is formatted as a CSV file with the following properties:

  • All values are in double-quotes

  • If no value is required or available for a field, the string "null" is the value, not a blank.

  • All lines are terminated with a UTF-8 Unix style newline

  • The escape character is a backslash (\\)

  • Timestamps are in ISO 8601 format and must include the time (e.g., `2017`2020-12-15 04:35`)

File contents

 

The contents of an Order report represent the "current state" of orders and their sections and content items. Aside from the "is_deleted" flag (see below), an Order report will not describe how a particular order has changed since it was last reported. It is up to institutions consuming the Order report to track this for themselves if they wish.

 

In the nightly reports, any new orders or orders that changed the previous day are represented. Changes may include:

 

  • Deleting an order
  • Restoring an order
  • Adding or removing sections from an order
  • Adding or removing content items from an order

...

 

order_id

A unique Unizin ID for the order.

order_created

A date & time in ISO 8601.

order_updated

A date & time in ISO 8601.

sis_section_id

An SIS section ID that is on the order.

sis_content_id

This is only applicable for IU. In many cases, the value will be `"null"`.

is_deleted

If "true," the Order to which the content-section pair belongs has been deleted.

author

The authors of a content item that is on the order. If multiple authors are present, they are separated by a semicolon.

title

The title of a content item that is on the order.

searchable_isbn

The best ISBN students can use to search for and find the title on the web.
publication_dateThe publication date of the title, if available from the publisher. This is a date in ISO 8601 (note: it is only a date object).

delivery_solution

The name of the reader used to deliver the solution. Values will be either "Unizin Engage" or "Publisher DLT"

sis_publisher_id

This is only applicable for IU. In many cases, it will be `"null"`.

publisher_name

The name of the content item’s publisher.

edition

The edition of the content item.

offer_price

The offer price for the content item (this is the price that students will be charged).

print_list_price

The print list price for the content item (this is the nominal price of the content item. Offer prices are generally calculated as a function of the print list price).

is_royalty

This is a boolean value corresponding to whether or not the person who ordered the content item for this section asserted that they may earn royalties. Note: this is an order level assertion but we'll present it as if for each content item, anyway. In short, it should not be assumed that if this value is true, it is because the user ordering the content stands to early royalties from this particular content itemsT.

 

2. Publisher adoption report

During open Ordering periods, Unizin provides Publishers with a report describing where their content has been adopted.

 

NamePublisher adoption report
Deliveryvia email
Run at3 am Eastern time
PeriodicityMonday morning
Contains

A record for each content-section pair in an order, along with metadata about the course, section, and order itself.

File contents

The purpose of the Publisher adoption report is to inform publishers about the titles that have been adopted by an institution for an upcoming Term. In many cases, Publishers will use this report to drive relationships with Faculty and Instructors who have elected to use their content. If Digital Learning Tools (DLT) are offered by the Publisher, the Publisher adoption report will be used by Publishers to determine which courses/sections must be provisioned for the use of a DLT.