Item Type
Names
Name | Guidance / Context | Reference |
---|---|---|
Common Name | Item Type | |
Alternative Names | FOLIO: Material Type Polaris: Material Type (not Type of Material) | |
DCB Technical Name |
|
Provision
Information | Note |
|
---|---|---|
Scope |
| |
Owner |
| |
Purpose |
|
DCB Implementation
DCB maps Item Types at a number of stages in the requesting process:
When reading items from a library for RTAC display in discovery
When a user searches for an item DCB presents the “selected” bibliographic record as a header and then lists all available copies under that heading. In order to be able to present a consistent and coherent user experience, system and site-specific item types are mapped into a “Canonical” DCB Item type. Throughout any DCB transaction the original ItemType is remembered, but the Canonical Item type is is the value which has a functional impact on DCB.
The local item type to canonical item type mapping is a “Range” mapping for Sierra and Polaris. This means that a group of item types, e.g. “100-104” can be mapped to a single DCB Canonical Item Type - e.g. “CIRC” for a “Normal Circulating Item”, whereas “105-255” might be mapped to “NONCIRC” for non-circulating item.
When creating a virtual item in a borrowing system
When a user requests an item DCB needs to create a virtual item in the borrowing system to receive and track that loan. At this point the Canonical Item Type has to be mapped into an item type which the borrowing system will understand (and will make sense to its local loan rules table). The canonical value (eg, “CIRC”) needs to be mapped using a one-to-one value mapping into a value which is understood by the borrower system.
DCB Service and Client Adaptors
How is this mapping used by DCB, and what to expect when it’s not right
Workflows: what use cases or workflows use the mapping and to what end
Technical: principal classes (or other technical elements) that apply in this case
Missing: what to expect when the mapping is missing
Incorrect: what to expect when the mapping is present but wrong
Workflow / Use Case | Technical Reference | Missing | Incorrect |
---|---|---|---|
|
|
|
|
|
|
|
|
DCB Admin
Integration status: Not Integrated Viewable importable Editable
Tracking issue link: <LINK>
Admin page link: <LINK>
Mapping Model
Type: Reference Numeric Range
Target Mapping Scope: System Spine DCB
Link to import template: <LINK>
Mapping Structure
Fields: list expected source and destination fields, including additional fields.
Description: what the field represents, and where values may be sourced
Validation: describe expected data formats any validation expected applied
Example: provide good and bad examples in expected format and case
Local to Canonical Mappings
For “Local to Canonical“ item type mappings used to make sense of the results of an RTAC call and create a consistent list, “Numeric Range Mappings” are used for SIERRA and POLARIS.
Field | Description | Validation | Example |
---|---|---|---|
context | The source context - normally the hostLMS code of the system being mapped. | String code that must exist as the code of a HostLMS | “STLOUIS” |
domain | The kind of value being mapped | one of “ItemType”, “PatronType” but “ItemType” for ItemType mappings. | “ItemType”, “PatronType” |
lowerBound | the lower bound of the range (The range will match if n >= this number, so lower bound 1 includes 1 but not 0) | integer | 0 |
upperBound | the upper bound of the range (Row applies if number <= this number, so for upper bound 100, 100 matches, 101 does not). |
|
|
targetValue | The DCB Canonical Code to use | A String code | “CIRC” |
targetContext | The target context - always “DCB” for Local to canonical ItemType mappings | “DCB” | “DCB” |
notes | For user use, no system impact |
|
|
Canonical to Local Mappings
For “Canonical to local” item type, mappings which are used when creating a virtual item “Direct Value Mappings” from the Canonical to the Target value are created for use in POLARIS, SIERRA and FOLIO:
Field | Description | Validation | Example |
---|---|---|---|
| the context of the value. For Canonical to local item types must be DCB. | any string of alphanumeric characters, no spaces or punc Must be a registered HostLMS code | Valid: “DCB”, “WDM”, “BRIDGES” Invalid: “^ggs_5533v” |
| The category, for ItemType mappings must be “ItemType” | Must be a known (Case sensitive) category “ItemType” | Valid: “ItemType” Invalid: “itemType” |
| The value encoded as a STRING | Must match DCB Canonical | Valid: Invalid: |
| The code of the HostLMS in which an item will be created | String, no space, punctuation or special chars | Valid: “BRIDGES” Invalid: |
| The category, for ItemType mappings must be “ItemType” | String, no space, punctuation or special chars | Valid: “ItemType” Invalid: |
| The value in the target system to use for item type | A string known to and understood by the target system | Valid: Invalid: anything else |
DCB Canonicals
List of accepted DCB values that sources can map to
Value | Interpretation |
---|---|
| Circulating - General |
| Circulating - AV |
| Non-Circulating |
Operated as a Community Resource by the Open Library Foundation