...
| id | Kuali OLE |
|---|
| Card | |||||||
|---|---|---|---|---|---|---|---|
| |||||||
Description
|
...
| label | Design : Techinical |
|---|
...
Overview
| Info |
|---|
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
UserStory:
...
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 |
|
...
...
INV_RQST_STAT_CD
...
4
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 |
|
...
...
FDOC_NBR
...
14
...
varchar
...
...
...
...
...
...
...
INV_PD_DT
...
...
The estimated number of days between receipt of each | |||||||
BIB_ID | 40 | VARCHAR |
|
...
...
INV_DT
...
...
Identifies the linked bib which has the descriptive metadata for the serial title being received. | |||||||
BOUND_LOC | 40 | VARCHAR |
|
...
invoice date
...
INV_NBR
...
25
...
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 |
|
...
invoice number
...
VNDR_INV_AMT
...
19,2
...
INV_RQST_PAY_DT
...
...
Displays the call number from the linked instance record | |||||||
RCV_REC_TYP | 40 | VARCHAR |
...
vendor invoice amount
...
Identifies whether the receiving record is for the main title, supplement, or index | |||||||
CHRON_CAPTN_LVL1 | 40 | VARCHAR |
|
...
...
INV_RQST_CST_SRC_CD
...
4
...
VNDR_HDR_GNRTD_ID
...
10,0
...
Records the text of the caption used for this level. | |||||||
CHRON_CAPTN_LVL2 | 40 | VARCHAR |
|
...
...
VNDR_DTL_ASND_ID
...
10,0
...
Records the text of the caption used for this level. | |||||||
CHRON_CAPTN_LVL3 | 40 | VARCHAR |
|
...
...
VNDR_NM
...
45
...
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_ |
...
10,0
...
INFO | 100 | VARCHAR |
|
...
...
OLE_VNDR_FOR_CURR_INV_AMT
...
19,2
...
OLE_INV_TYP_ID
...
10,0
...
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 |
...
OLE_INV_SUB_TYP_ID
...
10,0
CREATE_ITEM | 1 | VARCHAR |
| Indicates whether or not an item also is created when a serial issue is received |
...
ENUM_ |
...
CAPTN_ |
...
10,0
...
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_ |
...
90
...
CAPTN_LVL5 | 40 | VARCHAR |
| Records the text of the caption used for this level. |
...
ENUM_ |
...
90
...
CAPTN_LVL6 | 40 | VARCHAR |
| Records the text of the caption used for this level. |
...
GEN_ |
...
90
...
RCV_NOTE | 100 | VARCHAR |
| Free text information displayed to operators accessing the record. |
Entity: OLE_AP_INV_PO_ITM_T
...
Name
...
Length
...
Data type
...
Default Value
...
Input type
...
Action event
...
Validation type
...
Tab Index
...
Remarks
...
INV_PO_ITM_ID
...
9,0
...
decimal
...
INSTANCE_ID | 40 | VARCHAR |
| Identifies the linked instance record for the serial title. |
...
INV_RQST_ID
...
9,0
...
decimal
ISSN | 40 | VARCHAR |
...
Displays the 022 |a from the linked bib record for the serial title. |
PO_ID |
...
50 |
...
VARCHAR |
|
...
...
PO_ENCUM_FSCL_YR
...
4,0
...
decimal
...
...
...
...
...
...
To identify the purchase order number
...
AP_PUR_DOC_LNK_ID
...
10,0
...
decimal
...
...
...
...
...
...
...
CLOSE_PO_IND
...
1
...
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 |
...
NULL
...
ITM_TYP_CD
...
4
...
varchar
|
...
PO_LN_NBR
...
3,0
...
decimal
...
NULL
...
...
...
...
...
...
Determines whether or not ANY of the serials receipt history information displays to public users or not. | |||||||
PUBLISHER | 40 | VARCHAR |
|
...
...
ITM_LN_NBR
...
3,0
...
ITM_CATLG_NBR
...
30
...
Publisher from 260 |b of linked bib | ||||||||
SER_RCPT_LOC | 40 | VARCHAR |
| Identifies the work area at which issue receipts are recorded. |
...
ITM_DESC
...
4000
...
varchar
...
...
...
...
...
...
...
ITM_UOM_CD
...
4
...
SER_RCV_REC | 40 | VARCHAR |
|
...
...
ITM_AUX_PART_ID
...
300
...
varchar
...
...
...
...
...
...
System-assigned unique ID | ||||||||
SUBSCR_STAT | 40 | VARCHAR |
| Describes the present receipt status of the serial title. |
...
SER_ |
...
11,2
...
decimal
...
...
...
...
...
...
...
ITM_UNIT_PRC
...
19,4
...
RCV_REC_ID | 40 | VARCHAR |
|
...
...
PO_ITM_UNIT_PRC
...
19,4
...
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. |
...
ITM_OSTND_INV_QTY
...
11,2
...
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 |
...
ITM_OSTND_INV_AMT
...
19,2
...
ITM_TAX_AMT
...
19,
...
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 |
|
...
...
ITM_EXTND_PRC
...
19,2
...
decimal
...
...
...
...
...
...
...
OLE_ITM_OSTND_INV_PRTS
...
11,2
...
decimal
...
...
...
...
...
...
...
OLE_ITM_INV_PRTS
...
11,2
...
decimal
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_ |
...
19,4
...
ID |
100 | VARCHAR |
| Desktop at which the record was created/updated |
...
SUBSCR_ |
...
50
...
STAT_DT |
...
DATETIME |
...
OLE_ADDL_CHRG_USD
...
1
...
varchar
...
N
...
...
...
...
...
...
ITM_ASND_TO_TRADE_IN_IND
...
1
...
varchar
...
...
...
...
...
...
...
OLE_DISCNT
...
19,4
...
decimal
...
...
...
...
...
...
...
OLE_DISCNT_TYP
...
1
...
varchar
...
...
...
...
...
...
Entity: OLE_AP_INV_ACCT_T
...
Name
...
Length
Date on which the subscription status was changed |
Entity :OLE_SER_RCV_HIS_REC
Name | Max Len | DataType | DefaultValue | Input |
...
Type | Action |
...
Event | Validation |
...
Type | TabIndex | Remarks |
...
SER_ |
...
10,0
...
decimal
...
...
...
...
...
...
...
RCPT_HIS_REC_ID |
...
40 |
...
VARCHAR |
|
|
|
|
|
...
System Generated |
...
SER_ |
...
2
...
varchar
...
...
...
...
...
...
...
ACCOUNT_NBR
...
7
...
RCV_REC_ID | 40 | VARCHAR |
|
|
|
|
|
...
...
SUB_ACCT_NBR
...
5
...
Foreign Key of Serial Receiving Record | |||||||
RCV_REC_TYP | 40 | VARCHAR |
|
|
|
|
|
...
...
FIN_SUB_OBJ_CD
...
3
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_ |
...
19,2
...
Entity: OLE_AP_INV_SUM_ACCT_T
...
Name
...
Length
...
Data type
...
Default Value
...
Input type
...
Action event
...
Validation type
...
Tab Index
...
Remarks
...
SUM_ACCT_ID
...
10,0
...
decimal
3 | 40 | VARCHAR |
|
|
|
|
| Records the caption and value for this level as entered during the receipt transaction. |
...
DISENC_AMT`
...
19,2
...
decimal
...
...
...
...
...
...
CHRON_LVL_4 | 40 | VARCHAR |
|
|
|
|
| Records the caption and value for this level as entered during the receipt transaction. |
...
CLAIM_ |
...
9,0
...
COUNT | 40 | NUMERIC |
|
|
|
|
| Indicates the number of claims made for the issue on this line. |
...
CLAIM_ |
...
2
...
varchar
DATE |
|
...
DATETIME |
|
|
|
|
...
ACCOUNT_NBR
...
7
...
varchar
...
|
...
...
...
...
...
...
SUB_ACCT_NBR
...
5
...
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). |
...
FIN_SUB_OBJ_CD
...
3
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_ |
...
19,2
...
2 | 40 | VARCHAR |
|
|
|
|
| Records the caption and value for this level as entered during the receipt transaction. |
...
ENUM_ |
...
LVL_ |
...
3 |
...
40 |
...
VARCHAR |
|
|
|
|
|
...
Entity: OLE_AP_INV_PO_ITM_USE_TAX_T
...
Name
...
Length
...
Data type
...
Default Value
...
Input type
...
Action event
...
Validation type
...
Tab Index
...
Remarks
...
INV_PO_ITM_USE_TAX_ID
...
10,0
...
decimal
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_ |
...
10,0
...
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 |
|
|
|
|
|
...
...
TAX_AMT
...
19,4
...
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. |