| Anchor | ||||
|---|---|---|---|---|
|
0.8 Release Documentation, June 2013
This release of the Kuali Open Library Environment (OLE), the third milestone release, draws OLE nearer to the first implementable product.
| Section | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
How to Track OLE Work/Progress
To track the progress of the OLE development during 0.8, the following can be used to see what is planned, complete specifications, review progress, see new features, understand technical details.
Tool | Link | Description |
|---|---|---|
OLE application | Test Drive past features in OLE 0.6. See DEMO calendar for scheduled outages or FC demo's. | |
OLE Roadmap | See wiki pages for different planned releases, including OLE 0.8, and refer to linked Scope & Schedule spreadsheet. | |
F-specs | Spec Writing tools, inc templates for specs, meetings etc | |
| Tips for Acceptance Criteria, Test Scripts | |
Post Completed Specs | <many links; Use Jira link in Roadmap lists> https://jira.kuali.org/browse/OLE | A story's functional spec should be "linked" to Jira. A story's Codeable spec, when complete and approved, should be attached to Jira as PDF, with jira workflow updated, and email to Patty with spec now available for coding- all handoffs to be scheduled thru Patty. Cc- HTC, SA, BA, SME Team, Tester. |
Development Progress | < this wiki > | Find the latest news, release info, technical info |
| Scroll to desired spec page to see how we're building a feature | |
| Review code/features that are promoted to OLE-TEST every other Friday. OLE-TST will be offline during part of day on Friday (see announcements) with code available no later than Monday. | |
Code/New Features | OLE Application test environment- where to see functions as coded. See Test Promotion Process and sprint schedule below. | |
| http://tst.ole.kuali.org/OLE_Rice2/portal.do?selectedTab=main | As above, for Rice 2 (Editors, Circulation, Cataloging) |
Testing | OLE Jira for Test Scripts and Testing status (success, failure) used by OLE Testers. | |
| TBA | Wiki page for testers from Rich |
Sprint Release Schedule for 0.8
...
Planned Version #
...
Sprint Start Date
...
Sprint End Date
(code promoted)
...
Details
...
Latest Handoff DateSpecs
...
...
4/23/2012
...
5/4/2012
...
sprint1toward0.8forHTC
...
4/13/2012
...
...
5/7/2012
...
5/18/2012
...
sprint2toward0.8forHTC
...
4/27/2012
...
...
5/21/2012
...
6/1/2012
...
sprint3toward0.8forHTC
...
5/11/2012
...
...
6/4/2012
...
6/15/2012
...
sprint4toward0.8forHTC
...
5/25/2012
...
...
6/18/2012
...
6/29/2012
...
sprint5toward0.8forHTC
...
6/8/2012
...
...
7/2/2012
...
7/13/2012
...
sprint6toward0.8forHTC
...
6/22/2012
...
...
7/16/2012
...
7/27/2012
...
sprint7toward0.8forHTC
...
7/6/2012
...
...
7/30/2012
...
8/10/2012
...
sprint8toward0.8forHTC
...
7/20/2012
...
...
8/13/2012
...
8/24/2012
...
sprint9toward0.8forHTC
...
8/3/2012
...
...
8/27/2012
...
9/7/2012
...
sprint10toward0.8forHTC
...
8/17/2012
...
...
9/10/2012
...
9/21/2012
...
All Defect Fixes for OLE 0.8
Work on OLE 1.0
...
...
9/24/2012
...
10/5/2012
...
All Defect Fixes for OLE 0.8
Work on OLE 1.0
...
...
10/8/2012
...
10/13/2012
...
Setting up of Demo (Kuali Days 2012)
Jira Issues: Complete- Release OLE 0.8
The following is an iterative list of completed coding for OLE 0.8. Please see Jira for complete details, or Sprint Release Notes for annotated lists. Below are any coding tickets with status of "closed" for OLE 0.8.
...
|
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).
- If you would like to learn more about Rice, the introduction to their documentation is a great place to start.
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.
- For details, see the NISO Standards for Sort wiki page and/or review the Search Technical Documentation.
- For more information, visit the DocStore wiki page.
- Check out A Kuali Filing Cabinet: Institutional Uses of Kuali OLE Document Store
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.
- The Patron Technical Specifications has more information about the data infrastructure.
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.
- Read more at OLE Loan Technical Documentation
- See the Kuali Days 2012 presentation at https://drive.google.com/a/kuali.org/?tab=mo#folders/0B3c4Hq1jOIVcS016NW41SW1kRG8
(You will need to log in to KIS to view this presentation)
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.
- Please see more information on this expansion on the Z39.50 Technical Specification wiki page.
- To read more about using Z39.50 to import single records has more information at Searching External Datasources with Z39.50.
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.
Acknowledgements
OLE 0.8 Technical Notes
All technical notes for Kuali OLE Release 0.8 can be found on the public documentation site at OLE Technical Documentation.
OLE Technical Knowledgebase contains system architecture and installation notes.
Links to OLE 0.8 User Documentation
See the OLE 0.8 Milestone User Documentation to test run the demo, read through the Drivers Manual and additional resources, and learn more about the O.8 release.
Glossary
The OLE Glossary is available through the wiki.
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.
Sprint Release Links for 0.8 Coding Efforts
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|