Versions Compared

Key

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

...

idKuali OLE

...

Overview

...

Section
 

...

width50%
 
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 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

...

Image Added

Class Diagram :

...

Image Added

ER Diagram :

...

...

Image Added

Wireframes

...

UI Wire-frames Design

Main Tab

...

Image Added

Instance Tab

...

Image Added

PurchaseOrder Tab

...

Image Added

Licenses Tab

...

Image Added

Event Log Tab

...

Image Added

Search

...

Image Added

E-Instance Create

...

Image Added

Sample KRAD UIs

Main Tab

...

Image Added

PurchaseOrder Tab

...

Image Added

Licenses Tab

...

Image Added

EventLog Tab

Image Removed

 

...

Image Added

E-Resource Search UI

Image Added

Data Model

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  

...

PUBHR

500

...

...

VARCHAR

varchar


 

 

 

 

 

...

Publisher

...

...

GOKB_ID

...

 

100

...

 

...

VARCHAR


 

 

 

 

 

...

GOKB identifier (not included 1.0)

...

...

ISBN

100

...

...

VARCHAR

varchar

...

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

...


 

...

DATETIME

date

 

...

 

...

null


 

 

 

 

...

Status change date

...

 

...

and time

...

OLE_E_RES_REC_ PF_PRVDR  

...

 

250  

...

PLTFRM_PROV

250

VARCHAR


 

 

 

 

 

...

 

pulls from the Platform provider(s) from Instance

FD_CD

...

...

10

...

VARCHAR


 

...

OLE_E_RES_REC _ VND_CD  

...

 

250  

 

...


 

 

 

 

...

show desired fund code for E-Resource at its creation, if one exists  

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  

 

...


 

 

 

 

...

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


 

...


 

 

 

 

...

 

...

PACKAGE_SCOPE  

...

40  

...

 

varchar

 

...

OLE_BRKBLE  

...

1  

 

...

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


 

 

 

 

 

...

Indicate whether individual titles linked to an E-Resource can be cancelled.  

...

 

OLE_E_RES_REC_FD_TTL_LST  

...

 

1  

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  

 

...

OLE_E_RES_RECPUB_DISP_NTE

 

...

800

 

 

varchar

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.  

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  

 

...

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  

...

 

varchar

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

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  

...

 

varchar

 

...

Authentication Type (References the user configurable Authentication Type)

ACC_LOC_ID

40

VARCHAR


 

 

 

 

 

...

 

TRAIL_NEEDED  

...

 

1  

 

...

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  

...

 

varchar

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  

...

40  

 

...

Status of the created Trail document

LIC_ND

1

VARCHAR


 

 

 

 

 

...

indicate whether a license needs to be negotiated  

...

LICENSE_REQ_STATUS  

...

 

ORDER_PAY_STATUS  

...

 

40  

 

...

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  

...

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