6.3 Additionally required parameters

As it is defined in the guidelines to the DCB-2 (DCB-2 documentation, page 16), in order to support the widest range of user functionality, while not required by the protocol or the profile, system should send the most complete version of any message or message response including optional data. This is also required by this document. Especially it applies to the following cases:

Always when the Unique Item Id is sent and there is the Item Optional Fields optional element in the NCIP message definition, it should be sent with at least the following data supplied:

Bibliographic Description

Bibliographic Record Id

Bibliographic Record Identifier

Bibliographic Record Identifier CodeIf a given bibliographic record has only a local identifier in the initiating application, the Unique Agency Id element (with the Item Agency identifier) should be used instead of Bibliographic Record Identifier Code

Title

Circulation Status

Item Description

Visible Item Id

Always when the Unique User Id is sent and there is the User Optional Fields optional element in the message definition, it should be sent with at least the following data supplied:

Date Of Birth (if available)

Name Information

Personal Name Information

Structured Personal User Name (if it is not possible to deliver Structured Personal User Name, the Unstructured Personal User Name may be delivered instead

SurnameIt is also recommended, but not required, to supply the Given Name element.

Visible User Id

Unique Agency Id

Visible User Identifier

Visible User Identifier Type

The Item/User Optional Fields do not need to be sent, when the Item Optional Fields is sent to the Item Agency or User Optional Fields to the User Agency, as obviously those agencies have the current data of their items/users

For the Shipping Information element (e.g. in the Request Item Service, Item Requested Service, Item Shipped Service, Lookup Request) the following address data should be supplied:

Physical Address

Physical Address Type (with “Street Address” value)

Structured Address (if it is not possible to deliver Structured Address, the Unstructured Address may be delivered instead)The Physical Address is used to identify the Pickup Agency. The following sub-elements of Structured Address are used to identify the Pickup Agency:

Line1 (required)

Line2

Postal Code

Locality

6.4 Additionally required request parameters

Some of the request data is optional in the DCB-2, but in the combined library the following elements are required:

Accept Item

Unique User Id

Check Out Item

Unique Request Id (If the checkout fulfils the request)

Item Checked Out

Unique Request Id (If the checkout fulfils the request)

Item Received

Unique User Id (If the shipment of the item fulfilled a request of this user)

Unique Request Id (If the shipment of the item fulfilled this request)

Item Request Cancelled

Unique Item Id (if a concrete item is already assigned)

Unique User Id

Unique Request Id

Item Request Updated

Add Request Fields

Pickup Expiry Date (when the User Agency is informed about shipment of an item to the pickup location it must set the expiration date of the pickup and inform about it the Item Agency)

Item Requested

Unique User Id

Unique Bibliographic Id

Bibliographic Record Id

Unique Request Id

Shipping Information – with the address of the Pickup Agency. It should be the same address, which might be obtained by looking up the Pickup Agency with Lookup Agency.

Need Before Date (if known)

Item Shipped

Unique Item Id

Unique Request Id – must be sent always when the shipment of the item is realised to fulfil the user request

Unique User Id – must be sent always when the shipment of the item is realised to fulfil the user request

Shipping Information – with the address information of the agency which the item is transported to. It should be the same address, which might be obtained by looking up a given agency with Lookup Agency. In case of the shipment for pickup, this element should contain the address of the Pickup Agency.

Lookup Item

Unique Item Id (if available)

Visible Item Id (if Unique Item Id is not available)In the Lookup Item message there is a Visible Item Id required in the DCB-2. However, in combined libraries there are multiple situations when the Unique Item Id must be sent.

Lookup User

Unique User Id (if available and a user have already been authenticated)

Visible User Id (if Unique User Id is not available and user have already been authenticated)

Authentication Input (if a user needs to be authenticated)In the Lookup User message there are Visible User Id or Authentication Input elements required in the DCB-2. However, in combined libraries there are multiple situations when the Unique User Id must be sent.

Request Item

Unique User Id

Unique Item Id - it is the identifier of any item of the requested material.At time of sending the Request Item message, the item, which fulfils the reservation, is not known yet. However, during the process of creating a reservation, the responding application needs to initiate Lookup Item service to get the bibliographic description and the Lookup Item service requires the Unique Item Id element.

Shipping Information – with the address of the Pickup Agency. It should be the same address, which might be obtained by looking up the Pickup Agency with Lookup Agency.

Need Before Date (if known)

6.5 Additionally required response parameters

Some of the requested data is optional in the DCB-2, but in the combined library the following elements are required:

Lookup AgencyWhenever the agency address information is requested, there must always be delivered the address data which may be used to identify this agency as a target of the shipment of the item. The address data for this aim should have the following structure:

Agency Address Information

Agency Address Role Type (with “Ship To” or “Multi-Purpose” value)

Physical Address

Physical Address Type (with “Street Address” value)

Structured Address (if it is not possible to deliver Structured Address, the Unstructured Address may be delivered instead)The Physical Address is used to identify the Pickup Agency. The following sub-elements of Structured Address are used to identify the Pickup Agency:

+ Line1 (required)

+ Line2

+ Postal Code

+ Locality

Other Agency Address Information elements may also be used additionally (with other values of the Physical Address Type and Agency Address Role Type) because the Agency Address Information element is repeatable.

Lookup Item

Unique Item Id

Unique Request Id (required if the item is assigned to fulfil a given request)

Hold Pickup Date (required if the item is assigned to fulfil a request) This value should be used at the pickup location to set the pickup expiration date.

Item Transaction

Current Requesters (if requested)This is a repeatable element. The list should contain the requester for whom this concrete item has been assigned and the requesters awaiting the same Bibliographic Item with no concrete items assigned yet. The list should be sorted by the position in the reservation queue – first requester in the queue should be the first on the list. Especially, for a concrete item which is awaiting a requester on a reservation shelf, a given requester should be on the first position on the list.

Current Borrower (if requested)

Lookup Request

Shipping Information

Renew Item

Date Due

Request Item

Unique Request Id

Shipping Information – with the address of the Pickup Agency. It should be the same address, which might be obtained by looking up the Pickup Agency with Lookup Agency.

6.6 Integrated library issues

In order to support special use cases in combined libraries the following events must be handled:

Event: A patron checks out an item outside the Item Agency without a prior reservation

In the DCB-2 application profile, the User Agency manages the transaction and the decision whether the external item should be borrowed or whether aloan should be renewed is to be made by the User Agency. However, as a part of the decision process, the User Agency may verify in the Item Agency whether there are other patrons awaiting this item. It can be realised by sending the Lookup Item message to the Item Agency with Visible Item Id and the Current Requesters Desired flag. Lookup Item Response should contain the list of current requesters (if the item is currently reserved by someone).

Event: An item is shipped to a pickup location.

Item Shipped message should be sent to all branches of the combined library (all potential Pickup Agencies). For a pickup in location of the Item Agency, when the item becomes available for pickup and is moved to a reservation shelf, the Item Shipped message should not be sent to the combined branches of the Item Agency.

Event: An item is received at pickup location

In addition to DCB-2 requirements Item Received should also be sent to agencies combined with the agency (as they were potential pickup locations), so they are also aware that the item has been received.

Event: A patron checks out an item which awaited him on the reservation shelf

When the User Agency performs the checkout of the item, the Item Checked Out message should be sent to the Item Agency and to each agency combined with the branch where the pickup was performed (so that each potential Pickup Agency does not await for the item anymore).

Event: A patron cancels a reservation for the item which have been awaiting him on the reservation shelf

When the User Agency performs the cancellation of the reservation requested, the Item Request Cancelled message should be sent to the Item Agency and to each combined branch in the pickup location (so that each potential Pickup Agency does not await for the item anymore).

Event: A patron returns an item in an agency combined with Item Agency

The agency sends Check Item In to User Agency and afterwards Item Checked In to Item Agency.

Additionally the agency checks what should be done with the item by looking up current requesters in Item Agency. If there are none the item should be put on a local shelf. Otherwise by using Lookup Request for the first request the agency should do the following:

If Shipping Information contains address of the agency or an agency combined with it then the item should be put on a local reservation shelf. The agency sends Item Shipped to Item Agency and User Agency.

Otherwise the item should be shipped to Pickup Agency indicated by Shipping Information. The agency sends Item Shipped to Item Agency, User Agency and Pickup Agency (also to agencies combined with Pickup Agency).

The agency sends Check Item In to User Agency and afterwards Item Checked In to Item Agency.

Additionally the agency checks what should be done with the item by looking up current requesters in Item Agency. If there are none the item should be put on a local shelf. Otherwise by using Lookup Request for the first request the agency should do the following:

If Shipping Information contains address of the agency or an agency combined with it then the item should be put on a local reservation shelf. The agency sends Item Shipped to Item Agency and User Agency.

Otherwise the item should be shipped to Pickup Agency indicated by Shipping Information. The agency sends Item Shipped to Item Agency, User Agency and Pickup Agency (also to agencies combined with Pickup Agency).