OLE 0.8 User Documentation

Owned by Nora Roggeveen-Sams (Unlicensed)
Last updated: Mar 21, 2014

Information on this page applies to Kuali OLE, Release 0.8.

Contents
 

Test-driving OLE 0.8

  1. Log into KIS.

  2. Use the Driver's Manual and other documentation available on this wiki to test functionality

  3. Access the OLE Test Drive

KIS Login

To guarantee access to all OLE materials and attached files, it is recommended you be logged into KIS.

  1. Current KIS user? Check that you are logged in via the top right corner of this screen. If you see your name, you are logged in. If not, click the "log in" link.
  2. New to Kuali? Setup your account - it's easy and fast, and only requires your name and email address to get started immediately. You can then access information on other Kuali projects thru this wiki, Google Docs or even Jira. Create a KIS Account
  3. KIS credentials are NOT required to access our Wiki Pages or the DEMO drive of OLE.

Driver's Manual

(info) If you have any trouble accessing the overviews or guides, please check your browser settings for PDF handling, or simply right click on any of the links to save locally and review.  See PDF Display Assistance for further instructions.

  1. See the Overview Documents for big picture functionality of each module.
  2. See the Guides for specifics and How-tos of Interfaces and E-Documents.
  3. See OLE Basic Functionality and Key Concepts to learn about core functionality (searching, e-docs, navigation, etc).

Select and Acquire

Select and Acquire; MER Overview

Guide to Licensing

Guide to Managing and Encumbering Funds

Guide to Purchasing Accounts Payable

Guide to Vendor

Describe

Describe Overview

Guide to Describe - DocStore and Editors

Deliver

Deliver Overview

Guide to Deliver - Circulation and Patrons

Additional Resources

Report a Documentation Error

If you notice any discrepancies or gaps between the Test Drive and this documentation, please report them in OLE Feedback.  Choose the component "Documentation".

See Reporting an Issue in OLE for assistance in creating Jira tickets.

Demo and Installation

Tips and Troubleshooting in OLE 0.8

Navigation

Because we have inherited KFS financial system (FS) menus and new library system (LS) menus, the navigation is split.  See Navigating through OLE for assistance.

Feedback

Run into a problem in the Test Drive? You may report it using the Provide Feedback link in the upper right corner of the screen:

See Reporting an Issue in OLE for assistance in creating Jira tickets.

Help Icons

The help icons, which appear next to document titles, are not functioning for OLE 0.8. If selected, you will only receive an error message at this time.

Clearing Cache

If OLE is not loading correctly, clearing your cache may help.  For instructions, choose your browser:

If your browser is not listed or you are using a different version, search your browser's help menu for "clear cache".  In Internet Explorer and Firefox, if you don't see the menu bar, press "Alt".

Release Notes

Select and Acquire

KFS 5.0

The KFS (Kuali Financial System) 5.0 code merge and upgrade continued during OLE’s 0.8 coding.  The impacted portions of OLE’s financial module were PURAP-Purchasing/Accounts Payable, FP-Financial Processing, GL-General Ledger, System, PDP-Predisbursement Processor.

A large part of the KFS 5.0 upgrade was the Kuali Rice 2.1 upgrade, a transition to the new Rice web development framework.  In order to complete the KFS 5.0/Rice 2.1 upgrade, developers had to convert KFS data (parameters, namespaces, permissions and workflows) to OLE while conforming to Rice 2 standards.  Some of the OLE customizations already implemented (such as using percentage and dollar amounts on the payment request) had to be modified to work with KFS 5.0.  A maven wrapper needed to be implemented for the ant styled KFS so that implementers may more easily build the application.

KRMS and PeopleFlow

While OLE implemented KRMS (Kuali Rules Management System) in the 0.6 Milestone Release with Load Profiles (named Agendas in 0.6), the KRMS Builder has continued to be utilized in 0.8. 

For license requests, both KRMS and PeopleFlow (An overview of both) are being used to navigate through complex workflows while being flexible for the variety of cases that may be presented to library staff.  A user may select a workflow to initiate, KRMS reconciles the rules and metadata to call designated PeopleFlow(s).  As electronic resource management can have optimal and asynchronous workflows, the PeopleFlow and KRMS user interface allows for business rules and routing to be created and managed on the fly.

To read more about Licensing, see OLE Licensing & Electronic Resource Documentation on our wiki

Describe

Rice 2

Rice 2.2 is paving the way for the transition to the new Rice web development framework, which will bring significant improvements to the user interface and version compatibility.  You will find all of the Describe Module created in Rice 2.2.  With KRAD (Kuali Rapid Application Development), the look and feel of Describe’s Interfaces is different from the inherited KFS interface (these interfaces will sync in future releases).

DocStore

OLE’s DocStore (Document Store – a database of documents built with Apache Jackrabbit and Solr) stores bibliographic records (MARC, DublinQ and DublinUnQ), and Instance records (Holding and Item).  The DocStore has been updated to include NISO sorting standards.

Instance Schema

In order to better fit user needs, the OLE Instance has continued to evolve for the 0.8 Milestone Release. While the Instance still contains holdings and item information, for any given bibliographic record an oleHoldings can be stored and now edited, modified or deleted within OLE.  oleHoldings records contain general information in OLE format.  sourceHoldings are another type of holdings record which contains specific information concurrent with an external standard such as MARC, MODS, etc.  The two types of holdings records will be available and convertible in a future release. 

  • The OLE Instance V9.1 documentation includes links to the Individual data elements within the Instance, the most current schema, and some sample XML files that fit the schema.

Deliver

Rice 2

Just like Describe, the Deliver Module resides within the Rice 2.2 framework.  KRAD (Kuali Rapid Application Development) frameworks were used for the user interfaces.  KIM (Kuali Identity Management) services were used to maintain permissions and responsibilities of circulation desks and patron records.

KIM

The identity management subsystem of Kuali Rice contains infrastructure for managing people via entity and principal records.  While OLE already uses KIM to set up roles and permissions throughout the entire interface, OLE has modified the KIM subsystem to manage patrons.  These two types of persons, patrons and OLE users (library staff) are stored separately within OLE.  OLE is flexible in that it allows libraries to implement a different identity service other than KIM if they so choose.

KRMS

OLE is also using KRMS for loan circulation policies.  As there are three factors (patron type, item type, location) to any loan policy equation, the KRMS Rule Engine can accommodate as many or as few loan periods as are required.  Each factor and combination thereof may be considered to determine the loan period, applicable maximum limits, and other policies pertaining to blocks, renewals, requests, fines, etc.

System Integration

SRU/Z39.50 and Discovery Layers

Z39.50 is an information retrieval protocol that many libraries rely on for production operations. It allows external services to search collections and returns both bibliographic and current holdings and item information. 

OLE is making use of Z39.50 connections in the 0.8 release by allowing users to import single records from outside data sources.  In addition, 0.8 OLE will allow institutions to export a full copy of their database to their Discovery Layer.  Work will continue for bib suppression, incremental updates and scheduling. In future releases OLE is also planning to expand the use of Z39.50 connections to expose data via SRU and will rely on external software to bridge between a Z39.50 client and the OLE SRU server.  This will include WorldCat Local, InterLibrary Loan systems, citation managers, and NCIP applications.

Additional API requirements will be developed for OLE 1.0 to support the ‘MyAccount’ functionality built into our discovery interface and the communication between interlibrary loan software such as Relais and OLE.

Future Release Plan

The Kuali Open Library Environment project team is planning a major release, OLE 1.0, for the fourth quarter of 2013.  OLE 1.0 will be the first implementable product that will include Select and Acquire, with underlying KFS functionality, Describe and Manage, and Deliver, all built with Kuali Rice 2.2 agility.  See our timeline (http://www.kuali.org/ole/timeline) for a big picture of the 1.0 release, as well as what has been developed in the current and past releases.

Electronic Acquisitions

Specifications are currently being created by SME teams to manage electronic acquisitions within OLE.  The first of these have only just been handed off for development.  An E-resource record is planned to record information and flexible workflows will allow for libraries to keep track of the acquisition process and manage the resources’ lifecycles.

Global Open Knowledgebase

The Global Open Knowledgebase (GOKb) will be a freely available data repository containing publication information about electronic resources.  Functionality is being specified on how GOKb will integrate with OLE for the 1.0 release.  Learn more about the GOKb project in the Kuali Days 2012 presentation.

License Editor

An editor for license agreements is planned for the 1.0 release.  Libraries will be able to record specific structured information about the license terms and store them within the OLE Docstore. 

NCIP

NCIP is categorized into three services (Lookup, Update, and Notification), where each service is comprised of a request from an initiating application and a reply from a responding application. 

  • ‘Lookup’ includes searches (that should be covered in the Describe/Search f-specs) for data elements relating to Patrons (KIM/patron record), Holdings/Items/Bibs (DocStore), and the transaction records (RDBMS).
  • ‘Update’ includes the circulation processes of check-in, checkout, recall, renew, and request, that should be covered in the Deliver f-specs of the same name using KRMS.
  • We currently do not have use cases for ‘Notification’.

Within these three service types are more than 40 services.  Investigations over which are needed for OLE are currently underway, implementations are scheduled for 1.0.

Loading Legacy Data

Inquiries into how libraries will be able to load legacy data are currently under way.

Open Bugs at the time of the 0.8 Release

Open Bugs as of June 11, 2013.

To report additional bugs or enhancements, see Reporting an Issue in OLE.

Acknowledgements

OLE Acknowledgements

OLE Acknowledgements - Rice2

 

 

Operated as a Community Resource by the Open Library Foundation