OLE Serial Receiving Document

Overview

https://jira.kuali.org/browse/OLE-2652 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.

Serial issue receiving is a process distinct from recording receipt of a line item on a PO. When a title is considered a serial for purpose of receiving, “receiving” becomes a matter of receiving each individual issue on a serials receiving record and creating a serial receipt history for each issue received (or claimed).

Design: Technical

Design Technical

The technical design document shall lay out the high level design of how the receiving an item process is to be implemented. 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 – list of roles to be defined
Permissions – list of permissions to be defined
User Profiles – user profiles that may be applied roles/permissions (also for test/mock purposes)

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

Create/Update Serial Receiving Record

Acknowledgement Pop up

Serial Receiving Record Search

Data Model

User Story : Serial Receiving

Entity:OLE_SER_RCV_REC

Name	Max Len	Data Type	Default Value	Input Type	Action Event	Validation Type	Tab Index	Remarks
SER_RCV_REC_ID	40	VARCHAR						System Generated
ACTN_DATE		DATETIME						The action date is reset every time an issue is received by adding the action interval (see below) to today's date; a batch program finds reads action dates to determine when the record should be listed for review because the prescribed period of time has passed with any receipt action. Operators may manually change the action date to a future date at any time.
ACTN_INTRVL	40	VARCHAR						The estimated number of days between receipt of each issue, e.g., a quarterly serial might have an action interval of 100 (90 days for the quarter + 10 days to account for delivery or sorting delays). Added to today's date following a receipt to establish the action date.
BIB_ID	40	VARCHAR						Identifies the linked bib which has the descriptive metadata for the serial title being received.
BOUND_LOC	40	VARCHAR						Identifies the shelving location where bound volumes of the serial title are physically stored; used for display in the library's user interface
CALL_NUM	40	VARCHAR						Displays the call number from the linked instance record
RCV_REC_TYP	40	VARCHAR						Identifies whether the receiving record is for the main title, supplement, or index
CHRON_CAPTN_LVL1	40	VARCHAR						Records the text of the caption used for this level.
CHRON_CAPTN_LVL2	40	VARCHAR						Records the text of the caption used for this level.
CHRON_CAPTN_LVL3	40	VARCHAR						Records the text of the caption used for this level.
CHRON_CAPTN_LVL4	40	VARCHAR						Records the text of the caption used for this level.
CLAIM	1	VARCHAR						Determines whether or not a batch program looking for claims-eligible titles ignores the record or not.
CLAIM_INTRVL_INFO	100	VARCHAR						Free text note providing misc. information about claiming unique to this title that may be of staff interest/concern
COPY_NUM	40	VARCHAR						The copy number is used to distinguish multiple subscriptions which may or may not be shelved in the same location. It should be inherited from the instance. Each subscription requires its own instance.
CORPORATE_AUTH	40	VARCHAR						Displays the 100/110/111 \|ab b from the linekd bib record for the serial title
CREATE_ITEM	1	VARCHAR						Indicates whether or not an item also is created when a serial issue is received
ENUM_CAPTN_LVL1	40	VARCHAR						Records the text of the caption used for this level.
ENUM_CAPTN_LVL2	40	VARCHAR						Records the text of the caption used for this level.
ENUM_CAPTN_LVL3	40	VARCHAR						Records the text of the caption used for this level.
ENUM_CAPTN_LVL4	40	VARCHAR						Records the text of the caption used for this level.
ENUM_CAPTN_LVL5	40	VARCHAR						Records the text of the caption used for this level.
ENUM_CAPTN_LVL6	40	VARCHAR						Records the text of the caption used for this level.
GEN_RCV_NOTE	100	VARCHAR						Free text information displayed to operators accessing the record.
INSTANCE_ID	40	VARCHAR						Identifies the linked instance record for the serial title.
ISSN	40	VARCHAR						Displays the 022 \|a from the linked bib record for the serial title.
PO_ID	50	VARCHAR						Identifies the PO on which the title has been ordered/renewed
PRINT_LBL	1	VARCHAR						Indicates whether a serial issue label is printed upon receipt or not
PUBLIC_DISPLAY	1	VARCHAR						Determines whether or not ANY of the serials receipt history information displays to public users or not.
PUBLISHER	40	VARCHAR						Publisher from 260 \|b of linked bib
SER_RCPT_LOC	40	VARCHAR						Identifies the work area at which issue receipts are recorded.
SER_RCV_REC	40	VARCHAR						System-assigned unique ID
SUBSCR_STAT	40	VARCHAR						Describes the present receipt status of the serial title.
SER_RCV_REC_ID	40	VARCHAR						Foreign Key of Serial Receiving Record
TREATMENT_INSTR_NOTE	100	VARCHAR						Text that identifies any special processing steps that need to be followed when an issue of this serial is received.
UNBOUND_LOC	40	VARCHAR						Identifies the shelving location where unbound issues of the serial title are physically stored; used for display in the library's user interface
URGENT_NOTE	100	VARCHAR						Text that identifies any special situation/instruction that the operator needs to be follow BEFORE receiving an issue of this serial.
VENDOR	3	VARCHAR						Automatically inherits the vendor from a linked PO; if no PO, selected from the OLE vendors by operator creating/updating the record. This vendor is the one to which claims are sent.
CREATE_DATE		DATETIME						Date on which the record entered the system
OPTR_ID	40	VARCHAR						Name of the person creating/updating the record
MACH_ID	100	VARCHAR						Desktop at which the record was created/updated
SUBSCR_STAT_DT		DATETIME						Date on which the subscription status was changed

Entity :OLE_SER_RCV_HIS_REC

Name	Max Len	Data Type	Default Value	Input Type	Action Event	Validation Type	Tab Index	Remarks
SER_RCPT_HIS_REC_ID	40	VARCHAR						System Generated
SER_RCV_REC_ID	40	VARCHAR						Foreign Key of Serial Receiving Record
RCV_REC_TYP	40	VARCHAR						Three hard-coded values that determines whether the serials receiving record was created for the main title; a supplement to the title; or an index for the title. The receipt lines that follow show the issues received for each type.
CHRON_LVL_1	40	VARCHAR						Records the caption and value for this level as entered during the receipt transaction.
CHRON_LVL_2	40	VARCHAR						Records the caption and value for this level as entered during the receipt transaction.
CHRON_LVL_3	40	VARCHAR						Records the caption and value for this level as entered during the receipt transaction.
CHRON_LVL_4	40	VARCHAR						Records the caption and value for this level as entered during the receipt transaction.
CLAIM_COUNT	40	NUMERIC						Indicates the number of claims made for the issue on this line.
CLAIM_DATE		DATETIME						Indicates the date on which the last claim was generated.
CLAIM_NOTE	100	VARCHAR						Free text that can be added to a claim notice specific to the situation and would be in addition to the claim text (see below).
CLAIM_RESP	40	VARCHAR						Text as returned by the vendor in response to the claim
ENUM_LVL_1	40	VARCHAR						Records the caption and value for this level as entered during the receipt transaction.
ENUM_LVL_2	40	VARCHAR						Records the caption and value for this level as entered during the receipt transaction.
ENUM_LVL_3	40	VARCHAR						Records the caption and value for this level as entered during the receipt transaction.
ENUM_LVL_4	40	VARCHAR						Records the caption and value for this level as entered during the receipt transaction.
ENUM_LVL_5	40	VARCHAR						Records the caption and value for this level as entered during the receipt transaction.
ENUM_LVL_6	40	VARCHAR						Records the caption and value for this level as entered during the receipt transaction.
PUBLIC_DISPLAY	1	VARCHAR						Determines whether or not this information displays to public users or not.
SER_RCPT_NOTE	100	VARCHAR						Information to display only to staff for this specific issue.
OPTR_ID	40	VARCHAR						Name of the person adding the issue to the receipt history.
MACH_ID	100	VARCHAR						Desktop at which the issue was added to the receipt history.