You are on page 1of 6

Data dictionary for

Inventory Schema
maeisabelle edited this page on Jun 9, 2016 6 revisions

Introduction
Inventory managent schema of the BMS is based on the ICIS Inventory
Management System. The ICIS Inventory Management System is
designed to manage inventory information for any entities, including
genetic resources and breeders seed stocks. Within BMS though the
main usage is to track the germplasm seed stocks.

ims_lot Table
Columns - Long Length
Description Type
Name (Name) (bytes)

LOT_ID (LOTID) The unique ID for each inventory lot Integer 4

USER_ID ID of the user defining the current Lot. Links to the


Integer 4
(USERID) USERS table

This is the name of the table which contains the


ENTITY_TYPE
primary identification of the entities. For Example Text 15
(ETYPE)
GERMPLSM if the entities are seed stocks.

Entity identification number belonging to the Lot.


ENTITY_ID (EID) Eg GID for seed inventory. This field links to the Integer 4
table identified in ETYPE.
Columns - Long Length
Description Type
Name (Name) (bytes)

LOCATION_ID Location identification number links to the


Integer 4
(LOCID) LOCATION table in the IMS database.

The scale in which the quantities of the entity are


SCALE _ID measured, for example, grams, kilograms, number
Integer 4
(SCALEID) of cans, number of packets. Links to the SCALE
table in DMS

LOT_STATUS
Lot Status (0=Active or 1=Closed) Integer 4
(STATUS)

SOURCE LOT_ID of the source lot if this lot is derived from


Integer 4
(SOURCEID) another, else zero

COMMENTS
Description of lot or other notes Text 255
(COMMENTS)

Each Lot is defined by a unique combination of ETYPE, EID, LOCID and


SCALEID. The LOTID-ETYPE,EID relationship is a many to one
relationship since there any be many lots of the same entity stored in
different places or units. Each lot has a particular scale, for example
grams, kilograms, number of cans or number or packets, etc. The field
LOCID determines where the lot is stored. In the case of germplasm,
lots can be identified with different generations of a line having the
same GID but different storage location, or they can have different
GIDs but be in the same location. Locations may be as precise as
positions on a shelf, or as general as a single institute or even country.

ims_transaction Table
Length
Columns - Long Name (Name) Description Type
(bytes)

Unique transaction identification


TRANSACTION_ID (TRNID) Integer 4
number

ID of the user processing the current


USER_ID (USERID) transaction. Links to the USERS Integer 4
table

Identifies lot for this transaction.


LOT_ID (LOTID) Integer 4
Links to LOT table

TRANSACTION_DATE Date of the current transaction (ICIS


Integer 4
(TRNDATE) date format YYYMMDD)

Transaction status: 0=Anticipated


TRANSACTION_STATUS (Deposit or Reserved), 1=Confirmed
Integer 2
(TRNSTAT) (Stored or Retrieved), 9=Cancelled
Transaction

Quantity involved in transaction:


TRANSACTION_QUANTITY
Positive (+) for deposits, negative (-) Real 8
(TRNQTY)
for withdrawals

Description of transaction or other


COMMENTS (COMMENTS) Text 255
notes

COMMITMENT_DATE Commitment date for anticipated


Integer 4
(CMTDATE) transactions, Zero for indefinite

SOURCE_TYPE The type of the transaction source


Text 10
(SOURCETYPE) (e.g. LIST or STUDY)

SOURCE (SOURCEID) Integer 4


The particular ID of the source. (e.g.
Length
Columns - Long Name (Name) Description Type
(bytes)

LISTID or STUDYID)

The particular record where the


SOURCE_REC_ID transaction is obtained (e.g. specific
Long 4
(RECORDID) LRECID in the LIST or OUNITID
in the STUDY)

PREVIOUS_AMOUNT The previous amount if a transaction


Real 8
(PREVAMOUNT) was corrected

The ID of the requestor/donor. Links


PERSON_ID (PERSONID) Long 4
to the PERSONS table.

The list of stock ID that it can be


BULK_WITH bulked together (comma-separated Text 200
values)

Indicates if bulking is completed


BULK_COMPL Text 10
(e.g. Y or N)

An alpha numeric identifier, stock


INVENTORY_ID Text 35
ID

The Transaction Table records inventory movement for each particular


LOTID. Any LOTID used in the Transaction table needs to be defined in
the Lot Table first. Each lot transaction has a transaction date and a
quantity which can be either positive or negative. A positive quantity
indicates that inventory is being put into the storage location and a
negative quantity indicates that inventory is being taken from storage
The field TRNSTAT indicates whether the Transaction is anticipated or
confirmed. The TRNSTAT value and the sign of TRNQTY define four
transaction types:
Transaction Transaction
Quantity When used
type status

Inventory is physically placed in the storage


Positive location defined by the LotID in the Lot Table.
Store 1 - committed
(+) The quantity deposited is added to the total
quantity shown as Available for users

Negative Inventory is physically taken from the storage


Remove 1 - committed
(-) location defined for the LotID in the Lot Table

Positive Inventory is NOT physically placed in storage


Deposit 0 - anticipated
(+) yet, but is shown as existing.

Seed is NOT physically taken from storage


Negative
Reserve 0 - anticipated location yet, but needs to be reserved for a
(-)
particular use

ims_stock_transaction Table
Column Name Description Type Length (bytes)

id Unique stock transaction identification number Integer 4

listdata_project_id Integer 4

trnid Integer 4

recordid Integer 4

ims_labelinfo Table
Column Name Description Type Length (bytes)

id Integer 4

labelinfo_id Integer 4

group_prefix Text 50

labelitemcount Integer 4

ims_label_otherinfo Table

Column Name Description Type Length (bytes)

id Integer 4

otherinfo_id Integer 4

labelinfo_id Integer 4

group_prefix Text 50

tablename Text 50

fieldname Text 50

foreign_fieldname Text 50