OLE E-Resource

Overview

https://jira.kuali.org/browse/OLE-2758 and related linked tasks

Description

This document describes the process of creating a serial receiving record in order to receive individual issues of a serial title.

E-Resource Record presents a single, unified view of all information related to acquisition of an individual electronic resource or group of electronic resources, including titles, payment, licensing, administrative, and contact information.

Design: Technical

The technical design document shall lay out the high level design of how the E-Resource Document and the E-Instancescan be created . The details laid out shall include the Wire-frames for User Interface design, Data Element Layout, including the logical Database Design, Component Specifications including artifacts such as Class Diagram, State Chart Diagrams, OJB.xml specifications and Rules information.

Service Design and Implementation

Screen Flow Diagram

Layout use cases based on the screen flows indicating navigation between different screens.

Security

Roles
1. OLE_Selector
2. OLE_Licenses
3. OLE_Acquisitions
4. OLE_Head
5. Collection Management
6. OLE_E-Resource
7. OLE_Cataloger
8. OLE_Circ_Staff
9. OLE_E-ResouceManager
Permissions
1. Create, Edit, Delete, View E-Resource Records
2. Start Trial/ Licensing sub-workflow(s)
3. View E-Instance
4. Edit E-Instance
5. Relink E-Instance
6. Restore E-Instance
7. Delete E-Instance

Component Design

OBJ.xml
State Chart Diagram

Service Contracts

Service Implementation

Process Diagram

Work-flow Diagram

Class Diagram :

ER Diagram :

Wireframes

UI Wire-frames Design

Main Tab

Instance Tab

PurchaseOrder Tab

Licenses Tab

Event Log Tab

Search

E-Instance Create

Sample KRAD UIs

Main Tab

PurchaseOrder Tab

Licenses Tab

EventLog Tab

E-Resource Search UI

Data Model

User Story : E-Resource Record

Entity: OLE_E_RES_REC_T

Name	Max Len	Data Type	Default Value	Input Type	Action Event	Validation Type	Tab Index	Remarks
E_RES_REC_ID	10	VARCHAR						E-Resource Unique Identifier
OBJ_ID	36	VARCHAR						Object identifier
VER_NBR	8,0	DECIMAL						version number
NM	10	VARCHAR						Name of the E-Resource
DESC	800	VARCHAR						Description for the E-Resource
PUBHR	500	VARCHAR						Publisher
GOKB_ID	100	VARCHAR						GOKB identifier (not included 1.0)
ISBN	100	VARCHAR						shows the $a subfield of the ISBN/ISSN number if only 1 title is linked
STAT_CD	40	VARCHAR						Status of the E-Resource (reference from the user configurable status )
STAT_DT		DATETIME	null					Status change date and time
PLTFRM_PROV	250	VARCHAR						pulls from the Platform provider(s) from Instance
FD_CD	10	VARCHAR						Fund Code (reference from the user configurable Fund Code)
VNDR_HDR_GNRTD_ID	10,8	DECIMAL						Vendor Code
VNDR_DTL_ASND_ID	10,8	DECIMAL
ESTD_PR	40	VARCHAR						Estimated Price
MTRL_TYP_ID	10	VARCHAR						Material Type Code (reference from the user configurable Material Type)
CONT_TYP_ID	10	VARCHAR						Content Type Code (reference from the user configurable Content Type)
ORD_TYP_ID	10	VARCHAR						Order Type Code (reference from the user configurable Order Type)
PAYMT_TYP_ID	10	VARCHAR						Payment Type Code (reference from the user configurable Payment Type)
FRMT_ID	10	VARCHAR						Format Type Code (reference from the user configurable Format Type)
PCKG_TYP_ID	10	VARCHAR						Package Type Code (reference from the user configurable Package Code, also this will be pulled in from GOKB)
PCKG_SCP_ID	10	VARCHAR						Package Scope Code (reference from the user configurable Package Scope, also this will be pulled in from GOKB)
BRKBLE	1	VARCHAR						User can check/ not check(This will be pulled in from GOKB)
FD_TITLE_LST	1	VARCHAR						User can check/ not check(This will be pulled in from GOKB)
NTE	800	VARCHAR						Notes about the Deal
PUB_DISP_NOTE	800	VARCHAR						Notes that should be displayed to the Public
REQTR	40	VARCHAR						Patron requesting the Resource
SELTR	40	VARCHAR						Librarian Requesting the Resource
REQ_SEL_COMM	800	VARCHAR						Explains the notes about the request
REQ_PRTY_ID	40	VARCHAR						Priority of the request
TECH_REQ	800	VARCHAR						Notes about Technical Restriction
ACC_TYP_CD	40	VARCHAR						Access Type (References the user configurable Access Tpe)
NUM_SIMULT_USER	8,0	DECIMAL						Number of Simultaneous users
AUTHCAT_TYP_ID	40	VARCHAR						Authentication Type (References the user configurable Authentication Type)
ACC_LOC_ID	40	VARCHAR						Access Location (References User Configurable Access Location)
TRL_ND	1	VARCHAR						Checks, when a trail workflow started else non editable
TRL_STAT	40	VARCHAR						Status of the created Trail document
LIC_ND	1	VARCHAR						Checks, when a License Request document workflow started else non editable
LIC_REQ_STAT	40	VARCHAR						Status of the created License Request document
ODR_PAY_STAT	40	VARCHAR						Status of the created PurchaseOrder document
ACT_STAT	40	VARCHAR						Status of the created Access document