...
Overview
| Info |
|---|
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 Record has been 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 other relevant information.
Process Overview
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. An exhaustive overview of the process is available in JIRA under the ticket OLE-2758.
Work-flow Diagram
Role Flow :
Screen Flow :
UI Wire-frames Design
E-RESOURCE DOCUMENT
MAIN TAB
INSTANCE TAB
PURCHASE ORDERS TAB
INVOICES TAB
LICENSES TAB
CONTACTS TAB
ADMIN DATA TAB
TRAILS TAB
EVENT LOGS TAB
E-RESOURCE SEARCH SCREEN
Security
Roles :
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
OLE_Selector
OLE_Licenses
OLE_Acquisitions
OLE_Head
Collection Management
OLE_E-Resource
OLE_Cataloger
OLE_Circ_Staff
OLE_E-ResouceManager
...
- Permissions
...
Create, Edit, Delete, View E-Resource Records
Start Trial/ Licensing sub-workflow(s)
View E-Instance
Edit E-Instance
Relink E-Instance
Restore E-Instance
Delete E-
...
Instance
Component Design
- OBJ.xml
- State Chart Diagram
Service Contracts
Service Implementation
Process Diagram
Work-flow Diagram
Class Diagram :
Data Model (logical)
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 |
...
...
...
OLE_E_RES_PUBLISHER
...
500
PUBHR | 500 | VARCHAR |
...
Publisher |
...
...
GOKB_ID |
...
100 |
...
...
VARCHAR |
...
GOKB identifier (not included 1.0) |
...
...
ISBN | 100 |
...
...
40
...
VARCHAR |
...
provide easy access to view ISSN / ISBN if only one E-Instance is linked
...
OLE_E_RES_REC_STAT_CD
...
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 |
...
...
date
...
...
DATETIME | null | Status change date |
...
and time |
...
OLE_E_RES_REC_PF_PRVDR
PLTFRM_PROV | 250 |
...
...
VARCHAR |
...
...
pulls from the Platform provider(s) from Instance |
FD_CD |
...
...
10 |
...
VARCHAR |
...
...
show desired fund code for E-Resource at its creation, if one exists
...
OLE_E_RES_REC_VND_CD
...
250
...
varchar
Fund Code (reference from the user configurable Fund Code) | |||||||
VNDR_HDR_GNRTD_ID | 10,8 | DECIMAL |
...
show desired vendor for E-Resource at its creation, if one exists
...
OLE_E_RES_REC_EST_PRC
...
Vendor Code | |||||
VNDR_DTL_ASND_ID | 10,8 | DECIMAL |
...
...
ESTD_PR |
...
40 |
...
VARCHAR |
...
...
Estimated Price |
...
MTRL_ |
...
40
...
OLE_E_RES_REC_
CNT_TYP_CD
...
TYP_ID | 10 | VARCHAR |
...
defines type(s) of the material for reporting, managing different types of resources
Material Type Code (reference from the user configurable Material Type) | ||||
CONT_TYP_ID | 10 | VARCHAR |
varchar
...
defines type(s) of content for reporting, managing different types of resources
...
Content Type Code (reference from the user configurable Content Type) |
ORD_TYP_ |
...
ID |
...
10 |
...
VARCHAR |
...
OLE_E_RES_REC_PMT_TYP_CD
...
40
...
varchar
...
store desired default order type for any POs for this E-Resource at its creation
Order Type Code (reference from the user configurable Order Type) | |||||||
PAYMT_TYP_ID | 10 | VARCHAR |
...
...
OLE_E_RES_REC_FMT_YP_CD
...
40
...
Payment Type Code (reference from the user configurable Payment Type) | |||||||
FRMT_ID | 10 | VARCHAR |
...
allows reporting of format types
...
Format Type Code (reference from the user configurable Format Type) |
PCKG_TYP_ |
...
ID |
...
10 |
...
VARCHAR |
varchar
...
...
PACKAGE_SCOPE
...
40
...
Package Type Code (reference from the user configurable Package Code, also this will be pulled in from GOKB) | |||||||
PCKG_SCP_ID | 10 | VARCHAR |
...
...
OLE_BRKBLE
...
1
...
varchar
...
OLE_E_RES_REC_FD_TTL_LST
...
1
...
Package Scope Code (reference from the user configurable Package Scope, also this will be pulled in from GOKB) | |||||||
BRKBLE | 1 | VARCHAR |
...
Indicate whether individual titles linked to an E-Resource can be cancelled.
User can check/ not check(This will be pulled in from GOKB) | |||||||
FD_TITLE_LST | 1 | VARCHAR |
...
...
Indicate whether an e-resoruce is static (fixed) or has titles added/removed over time (not fixed).
...
OLE_E_RES_REC_NTE
...
250
...
800
...
User can check/ not check(This will be pulled in from GOKB) | |||||||
NTE | 800 | VARCHAR |
...
record special notes about the deal / package; ex: breaches, computer usage requirements like only works in certain browsers, etc.
...
OLE_E_RES_RECPUB_DISP_NTE
Notes about the Deal | |||||||
PUB_DISP_NOTE | 800 | VARCHAR |
...
...
...
...
...
record notes that should display to all public users for all titles in the E-Resource (ex: in the journal list, link resolver); would like to be able to format it with bullets, for example)
...
OLE_E_RES_RECRQSTR
...
40
...
40
...
varchar
Notes that should be displayed to the Public | |||||||
REQTR | 40 | VARCHAR |
...
track who requested
...
OLE_E_RES_REC_SELECTR
Patron requesting the Resource | |||||||
SELTR | 40 | VARCHAR |
...
track who requested
...
OLE_RQSTR_SELECTR_CMMNT
...
800
...
varchar
...
40
...
Librarian Requesting the Resource | |||||||
REQ_SEL_COMM | 800 | VARCHAR |
...
allows selector (or requestor) to explain more about their request
...
OLE_E_RES_REC_PRITY
Explains the notes about the request | |||||||
REQ_PRTY_ID | 40 | VARCHAR |
...
...
makes possible prioritizing requests
...
Priority of the request |
TECH_REQ |
...
...
...
1500
...
800 | VARCHAR |
...
to track notes about techincal restrictions
Notes about Technical Restriction |
ACC_TYP_ |
...
CD | 40 |
...
...
VARCHAR |
...
OLE_NUMB_SIMULT_USR
...
8
...
decimal
...
40
...
Access Type (References the user configurable Access Tpe) | |||||||
NUM_SIMULT_USER | 8,0 | DECIMAL |
...
OLE_AUTH_TYP
Number of Simultaneous users | |||||||
AUTHCAT_TYP_ID | 40 | VARCHAR |
...
...
OLE_ACSS_LOC
...
40
...
Authentication Type (References the user configurable Authentication Type) | |||||||
ACC_LOC_ID | 40 | VARCHAR |
...
TRAIL_NEEDED
...
1
...
varchar
...
Access Location (References User Configurable Access Location) | |||||||
TRL_ND | 1 | VARCHAR |
...
indicate whether a trial is needed for this resource
...
TRAIL_STATUS
...
40
...
LICENSE_NEEDED
...
1
...
Checks, when a trail workflow started else non editable | |||||||
TRL_STAT | 40 | VARCHAR |
...
shows status of linked trial(s) underway, data comes from trial record
...
Status of the created Trail document | |||||||
LIC_ND | 1 | VARCHAR |
...
indicate whether a license needs to be negotiated
...
Checks, when a License Request document workflow started else non editable |
LIC_REQ_ |
...
STAT |
...
40 |
...
...
...
VARCHAR |
...
shows status of latest linked license, data comes from license record
...
ORDER_PAY_STATUS
...
40
...
ACTIVATION_STATUS
...
40
...
Status of the created License Request document | |||||||
ODR_PAY_STAT | 40 | VARCHAR |
...
shows the status of the Req/PO/Payment from Req/PO record
Status of the created PurchaseOrder document | |||||||
ACT_STAT | 40 | VARCHAR |
...
shows status of activation process from access dashboard
...
Status of the created Access document |