Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

OLE Instance Data Elements Detailed

Section
Column
width60%

OLE Instance documents are used to identify and describe library resources locally owned/licensed by libraries. They are loosely based on the MARC Format for Holdings Data (MFHD) and represents core elements that must be included when describing holdings and items.

Some business rules for the OLE Instance:

  • 1

...

  1. <instanceIdentifier> (NR): This is a system-generated unique identifier for the instance document in the ole-docstore.
  2. <resourceIdentifier> (R) : This is the unique bibliographic identifier for the source bibliographic record.
  3. <formerResourceIdentifer> (R) : These are the bibliographic record identifiers. If the source is a marc record, then its the 035 field value in the marc record. These identifiers are used when linking instance documents with the appropriate bibliographic records in OLE after the legacy data migration.

2. <oleHoldings>

Info

Location information presented here is automatically inherited by the linked items.
Location information at the item level with the flag "primary=true" will imply that location for the item may have temporarily changed. In cases where the item has been moved permanently, the flag can be left untouched.

  1. <extentOfOwership> (R) 
    1. <textualHoldings> : THis is a free text field for entering textual holdings.
    2. <type>: This indicates weather the summary statement is of type Basic, Supplementary or Indexes. This will determine if the holdings is going to be recorded in 866 or 867 or 868 marc fields.
    3. <holdingNote> (R): Notes for textual holdings that can be public or non-public and maps to $x or $z.
  2. <receiptStatus> (NR)  : This indicates the status of receiving and has a set of controlled values as specified in MFHD. This data element will map to MFHD 008 position 06.
  3. <uri> : (R) This data element represent the uniform resource identifier and maps to MFHD 856$u. This can also be found in the Bib MARC record and represents the general access link for a title. A URI can also be recorded at the item level in accessInformation to specify the link to an individual item or volume.
  4. <holdingsNote> (R) : Note that can be for public or non-public. This maps to 852 $x if non-public and $z if public.
  5. <location>
    1. <locationLevel> : This represents the various levels for a location. Even though institutions can use as many levels as they desire, MFHD supports only three levels. The lower most level is going to be used for indicating the shelving location. OLE will also support 3 levels out of the box to accomodate MFHD conversion.
  6. <shelvingScheme> : This indicates the shelving scheme used and is controlled value as specified in the MFHD 852 ind1.
  7. <callNumberType> : This can be used in addition to the shelving scheme for institutions who use local values or values outside the MARC specs. From a mapping perspective OLE will put it $2.
  8. <callNumber> : Indicates the call number to be used for a work.  Call number exists both within oleHoldings and item.  By default the call number within all items within an instance will be inherited from the call number in oleHoldings.  However, the call number within an individual item will be editable and therefore can be changed from the default so that it no longer matches the oleHoldings call number.  A callNumber may consist of up to three parts: callNumberPrefix, classificationPart, and itemPart.
    1. <callNumberPrefix> : This value precedes the call number and maps to MFHD 852$k. 
    2. <classificationPart> : Classification part of the call number used as the shelving scheme for a work.  A Cutter, date, or term that is added to the classification to distinguish one work from any other work assigned the same classification is recorded in itemPart.  Maps to MFHD 852$h.
    3. <itemPart> : Cutter, date, or term that is added to the classification contained in classificationPart to distinguish one work from any other work assigned the same classification.  Maps to 852$i.
    4. <shelvingOrder>: This is the normalized form for the call number and determines how the call number is actually sorted in an index.
    5. <shelvingScheme>: This maps to 852 ind1 of a MARC holding record.
    6. <prefix>: Term that precedes a callNumber. Maps to 852 $k of MARC holdings.
Info

Instance Editor has one text area where users can key in the call numbers. Even though there are separate data elements for item parts and class parts, they can be left blank for data migration purposes.

3. <sourceHoldings>

This section contains the raw holdings record in the native format wrapped in CDATA which allows for the flexibility of using any format for holdings (MFHD, MODSHD, DCHD etc.). OLE will provide for an editor to edit the MFHD record out of the box. Any custom holdings format will need to be handled by the implementing institutions.

4. <item>

Info

Classification part and Item parts will be presented as one single text box in the UI. Institutions using marc holdings get to retain that information in the individual sub-fields. Institutions that dont use Marc holdings can use it as one string that will be stored in the item part and if at a given point for a given record the holdings format changes from oleHoldings to marc holdings, the item part will be retained in the 852$h.

...

  • Bibliographic Description must have at least 1 OLE Instance Collection.
  • 1 Bibliographic Description may have more than 1 OLE Instance Collection.
    • 1 Instance Collection must have at least 1 Instance Record.
    • 1 Instance Collection may have more than 1 Instance Record.
      • 1 Instance must contain 1 oleHolding or 1 sourceHolding.
      • 1 Instance must have at least 1 item.
      • 1 Instance may have more than 1 item.

(info) For more high level business rules, see OLE Instance Schema

Note

We need to review the business rules from 0.6. If they're still up to date, we should move them to https://wiki.kuali.org/display/OLE/OLE+Instance+Document-V9.1

Column
width40%

...

Instance Collection

Element

Description

instanceCollection

 

instance

1 or more instance records

Instance

Element

Description

instance

The instance captures holdings and item information. Holdings can be recorded in either the general holdings section or specific holdings format in the sourceHoldings section. The flag "primary" on either holdings or the sourceHoldings tag indicates which holdings is being used. OLE will support MFHD and any other specific holdings format will need to be accounted for and implemented by the individual institutions. At any given time, either the general holdings or the sourceHoldings can be in use. The item information is also recorded and also maps to fields in the MFHD record. OLE will provide the conversion if an institution is using MFHD, bearing in mind that in such an event the location will only be limited to 3 levels.

instanceIdentifier

Unique system assigned identifier for the instance document.

resourceIdentifier

Bibliographic identifier from 001 in the marc record in OLE

formerResourceIdentifier

These are Identifiers from the legacy system for the bibliographic records that are stored in the 035 of the Marc record. Non-Editable that gets used at the time of linking bib records and instance records.

oleHoldings

General holdings information for institutions not using specific source holdings

sourceHoldings

Specific holdings format

items

Collection of Items.

extension

Element borrowed from/maps to MODS extension element. It may be used for elements that are local to the creators of the Instance documents. In addition, it may be used to extend the Instance schema for various purposes when another XML schema may handle the type of information.

Holdings Record

Element

Description

oleHoldings

This section can be used to record general holdings information if not using a specific source holdings.

holdingsIdentifier

This is system generate unique ID.

extentOfOwnership

(R) This is a free txt for summary holdings (textual) for institutions not using source holdings. It will be mapped to MFHD 866$a with ind1 being blank and ind2 = 0 if converted to the source MFHD.

receiptStatus

MFHD field 008@position 06. List of allowed values are:
0 - Unknown
1 - Other receipt or acquisition status
2 - Received and complete or ceased
3 - On order
4 - Currently received
5 - Not currently received

uri

This is to indicate the universal resource identifier. Maps to 856$u. This could also be the one recorded in the bib record.

note

This indicates public or non-public

location

Global location specific information that is inherited/used by linked items. This information is not copied for each item. This also has information on the various location levels.

extension

Element borrowed from/maps to MODS extension element. It may be used for elements that are local to the creators of the Instance documents. In addition, it may be used to extend the Instance schema for various purposes when another XML schema may handle the type of information.

callNumber

To be filled

Location

Element

Description

location

 

locationLevel

This represents hierarchy of levels. If an institution intends to convert the oleHoldings to sourceHoldings (MFHD) at some point or wants to have the flexibility, they will need to ensure the mappings are avail in ole location tables. Institutions can have as many levels.

locationLevel

 

name

 

level

 

locationLevel

 

note

 

Shelving Scheme

Element

Description

shelvingScheme

 

codeValue

 

fullValue

 

typeOrSource

 

Shelving Order

Element

Description

shelvingOrder

 

codeValue

 

fullValue

 

typeOrSource

 

Source Holdings

Element

Description

sourceHoldings

 

holdingsIdentifier

This is system generate unique ID.

name

 

holdings

This indicates what the source of the holdings record is; i.e. MARC or DC or EAD etc. Data is wrapped in the CDATA section with the raw record in the native format.

extension

Element borrowed from/maps to MODS extension element. It may be used for elements that are local to the creators of the Instance documents. In addition, it may be used to extend the Instance schema for various purposes when another XML schema may handle the type of information.

holdings

 

Items Record

Element

Description

items

 

item

 

Item

item

Item information recorded in this section. This will not be mapping to any specific format i.e. MFHD. Institutions wanting to export true holdings information will need to map themselves.

itemIdentifier

This is system generate unique ID.

purchaseOrderLineItemIdentifier

This is the PO line item identifier from OLE.

vendorLineItemIdentifier

This is the vendor line item identifier.

accessInformation

(R) This is volume specific URL.

barcodeARSL

(NR) Special identifier for institutions that have automated storage/retrieval system.

formerIdentifier

(R) Does not map to MFHD. Identifies previously used barcodes or other identifiers for the holdings/item being described. Also allows

...

for the identification of the type of identifier, e.g., legacy system identifier.

statisticalSearchingCode

 

itemType

(NR) Locally defined value that is used for circulation purposes and is a controlled value. OLE has the list control values defined as part of maint. documents.

...

location

Global location specific information that is inherited/used by linked items. This information is not copied for each item. This also has information on the various location levels.

copyNumber

(R) Maps to MFHD 876 $t Copy number - Library-assigned to distinguish each copy of the same title; typically printed (with the label) at the end of the call number spine label. Label for copy number provided in copyNumberLabel

copyNumberLabel

Does not map to MFHD. Identifies the

...

nature of the copyNumber

...

. Number of copy provided in copyNumber

volumeNumber

Does not map to MFHD. Library-assigned to distinguish each volume of a

...

multipart title; typically printed (with the label) at the end of the call number spine label. Label for volume number provided in volumeNumberLabel.

volumeNumberLabel

Does not map to MFHD. Identifies the nature of the volume number

...

. Number of volume provided in volumeNumber

note

 

enumeration

Does not map to MFHD

...

. Designation used to identify a specific part of a multipart title when there are multiple levels.

...

chronology

...

Does not map to MFHD. Designation used to identify the issue date of a specific part of a multipart title

...

; single dates may typically

...

print at the end of the

...

call number label attached to the part.

...

highDensityStorage

...

...

 

...

temporaryItemType

(NR) This is of itemType but used in cases where the item was moved and there is a need to specify a temp. item type.

fund

(R) This is Account Number from the PO line item

...

under the accounting lines

...

section.

donorPublicDisplay

(R) This is automatically inherited from the PO

...

Line Item number for the appropriate fund used.

...

Needs more discussion, but leaving here as a place holder.

donorNote

(R) Donor information for items that are gifts and for items that were purchased not using some specific funds.

callNumber

LC or Duewy decimal etc...

...

price

 

numberOfPieces

Very specific to the item and defaults to 1. Count of individual pieces in the barcoded item.

itemStatus

Current status of the item.

...

itemStatusEffectiveDate

Date when the status was assigned. Tied to the

...

status change.

...

checkinNote

...

Free text note. If populated, operator is

...

promoted with the note for acknowledgement when the item is checked in.

...

staffOnlyFlag

...

The item data not to be displayed in the public display interface.

...

fastAddFlag

...

Indicator that the item was created at a circulation desk.

...

To indicate special processing instructions etc in the checkin notes.

extension

Element borrowed from/maps to MODS extension element. It may be used for elements that are local to the creators of the Instance documents. In addition, it may be used to extend the Instance schema for various purposes when another XML schema may handle the type of information.

numberOfCirculations

Number of Circulation contains list of check in location. This determines how many times check in takes place in each location.

Type or Source

Element

Description

typeOrSource

 

pointer

 

text

 

Access Information

Element

Description

accessInformation

 

barcode

 

uri

 

Extent of Ownership

Element

Description

extentOfOwnership

 

textualHoldings

 

note

 

type

 

Statistical Searching Code

Element

Description

statisticalSearchingCode

(R) Does not map to MFHD. Identifies types of locally defined statistical categories.
Example:
codeValue=STRVIDEO
fullValue=Streaming Video
typeOrSource=Can be a pointer to LOC to pull down pre-defined list

codeValue

 

fullValue

 

typeOrSource

 

High Density Storage

Element

Description

highDensityStorage

Does not map to MFHD. Identifies the Row, Module, Shelf, and Tray information for the item's High Density Storage location.

row

 

module

 

shelf

 

tray

 

Identifier

Element

Description

itemType

 

codeValue

 

fullValue

 

typeOrSource

 

Identifier

Element

Description

identifier

Unique identifier for the item record.

identifierValue

 

Former Identifier

Element

Description

formerIdentifier

 

identifier

Former identifiers from the legacy systems. Mainly for item records.

identifierType

To indicate which system the identifiers from ported from.

Extension

Element

Description

extension

 

Call Number

Element

Description

callNumber

 

type

LC or Duewy decimal etc...

prefix

Maps to MFHD 852 $k Call Number Prefix - Term that precedes a call number.

number

To be filled

classificationPart

Maps to MFHD 852 $k Call Number Prefix - Term that precedes a call number. Also known as class number.

itemPart

Maps to MFHD 852 $i Item Part - Cutter, date, or term that is added to the classification contained in classificationPart to distinguish one item from any other item assigned the same classification. A call number suffix is contained in callNumberSuffix). Also known as the book number part of call number.

shelvingScheme

This maps to MFHD 852 ind1. Possible values are:
# - No information provided
0 - Library of Congress classification
1 - Dewey Decimal classification
2 - National Library of Medicine classification
3 - Superintendent of Documents classification
4 - Shelving control number
5 - Title
6 - Shelved separately
7 - Source specified in subfield $2
8 - Other scheme

shelvingOrder

This is the normalized form for the call number. This determines how the call number is indexed. Does not map to MFHD.

URI

Element

Description

uri

 

Number of Circulations

Element

Description

numberOfCirculations

 

checkInLocation

Check in Location contains name and count. This determines how many times check in takes place in each location.

checkInLocation

 

name

 

count