NCIP
NCIP Based P2P Resource Sharing
Alma supports NCIP (NISO Circulation Interchange Protocol) based Peer to Peer ILL, i.e. the lender and the borrower communicate with NCIP messages in order to update the ILL workflow.
An NCIP partner of “NCIP-P2P” type should be created in Alma for defining institutions that use NCIP messages for P2P communication. For more information regarding partners configuration in Alma, refer to Alma online help.
An NCIP partner of “NCIP-P2P” type should be created in Alma for defining institutions that use NCIP messages for P2P communication. For more information regarding partners configuration in Alma, refer to Alma online help.
The following diagram illustrates the workflow:
Supported messages
- RequestItem
- CancelRequestItem
- ItemRequestCancelled (CancelReply)
- RenewItem
- ItemRenewed
- ItemReceived (Checked-In)
- ItemReceived (Receiving)
- ItemShipped (Return)
- ItemShipped (Shipping)
- CancelRequestItem (Expired)
- CancelRequestItem (Rejected/Unfilled)
- RecallItem
All NCIP Message Fields
Fields marked with * are defined by Exlibris and are not part of the NCIP protocol
Fields marked with ** are defined as date type in the form of [YYYY-MM-DDThh:mm:ss]
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| RequestId.RequestIdentifierValue | Request Identifier | R |
| InitiationHeader.FromAgencyId.AgencyId Format: [Institution Code]||[Library Code] | Sending Institution | R |
| InitiationHeader.ToAgencyId.AgencyId | Receiving Institution | R |
| InitiationHeader.OnBehalfOfAgency.AgencyId | Receiving Library | R |
| InitiationHeader.FromSystemId | “ALMA_NCIP_ILL” | Constant (R) |
| UserId.UserIdentifierValue | User | O |
| Ext.ItemNote | Note | O |
| RequestType (Digital, Physical or Non-Returnable) | Request Type | R (Only for Request Item) |
| ItemOptionalFields.BibliographicDescription.Title | Title | R (Only for Request Item) |
| ItemOptionalFields.BibliographicDescription.Author | Author | O |
| ItemOptionalFields.BibliographicDescription .AuthorOfComponent | Author of Article | O |
| ItemOptionalFields.BibliographicDescription.Edition | Edition | O |
| ItemOptionalFields.BibliographicDescription.Pagination | Pagination | O |
| ItemOptionalFields.BibliographicDescription.PlaceOfPublication | Place of Publication | O |
| ItemOptionalFields.BibliographicDescription.PublicationDate | Publication Date | O |
| ItemOptionalFields.BibliographicDescription .PublicationDateOfComponent | Publication Date Of Component | O |
| ItemOptionalFields.BibliographicDescription.Publisher | Publisher | O |
| ItemOptionalFields.BibliographicDescription.SeriesTitleNumber | Series Title Number | O |
| ItemOptionalFields.BibliographicDescription.TitleOfComponent | Title Of Article | O |
| ItemOptionalFields.ItemDescription.CallNumber | Call Number | O |
| ItemOptionalFields.BibliographicDescription.BibliographicLevel (Book, Journal, Other) | Item Type | R (Only for Request Item) |
| ItemOptionalFields.BibliographicDescription.MediumType | Medium Type (Any) | O |
| BibliographicId.BibliographicRecordId.BibliographicRecordIdentifier (When BibliographicRecordIdentifierCode is “ISSN”) * | ISSN | O |
| BibliographicId.BibliographicRecordId.BibliographicRecordIdentifier (When BibliographicRecordIdentifierCode is “ISBN”) * | ISBN | O |
| BibliographicId.BibliographicRecordId.BibliographicRecordIdentifier (When BibliographicRecordIdentifierCode is “LocalID”) * | Local ID | O |
| BibliographicId.BibliographicRecordId.BibliographicRecordIdentifier (When BibliographicRecordIdentifierCode is “EAN”) * | EAN | O |
| ItemId.ItemIdentifierValue (When ItemId.ItemIdentifierType is “Barcode”) * Note: If other identifiers beside Barcode are sent, the Barcode should be first. For example Barcode and RFID – | Barcode | R (Only for Recall Item) & O (For other) |
| ShippingInformation.PhysicalAddress.StructuredAddress | DeliveryAddress – Physical | R (For Item Shipped) & O (For other) |
| ShippingInformation.ElectronicAddress.ElectronicAddressType | Email (Constant ‘Email Address’) | R (For Item Shipped) & O (For other) |
| ShippingInformation.ElectronicAddress.ElectronicAddressData | DeliveryAddress – Electronic | R (For Item Shipped) & O (For other) |
| PickupLocation | Pick-up Location | O |
| AcknowledgedFeeAmount with Ext = “Maximum Fee For Requester” * | Maximum Cost | O |
| NeedBeforeDate ** | Needed By Date | O |
| PickupExpiryDate ** | Expiry Date | O |
The borrower requests resource sharing material; the lender creates a resource sharing request.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| Ext.Parts * | Part | O |
| Ext.Chapters * | Chapter | O |
| Ext.Volumes * | Volume | O |
| Ext.Issues * | Issue | O |
| Ext.Pages * | Pages | O |
| Ext.ItemNote * | Note | O |
| RequestScopeType | “Item” * | Constant (R) |
The borrower cancels the resource sharing request.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| UserID.UserIdentifierValue | User ID | R |
| Ext.NoticeContent | “CancelledByBorrower” Note: This is needed since the CancelRequestItem is | Constant (R) |
The lender replies for the borrower’s cancellation of the resource sharing request.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| Ext.NoticeContent | “CancelledByLender” | Constant (R) |
| Ext.Answer | Cancel Answer (“True” or “False”) | Constant (R) |
The borrower renews the resource sharing request.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| Ext.DesiredDateDue ** | Desired Date Due | R |
The lender replies for the borrower’s renewal of the resource sharing request.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| Ext.Answer | Answer (“True” or “False”) | Constant (R) |
| DateDue ** | Date Due | R |
| ItemId.ItemIdentifierValue | Item Id (where ItemId.ItemIdentifierType is “barcode”) | R |
The lender check-in the resource sharing material.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| DateReceived ** | Date Received | R |
| Ext.NoticeContent | “ReceivedByLender” Note: This is needed since the ItemRecevied is used for | Constant (R) |
| ItemId.ItemIdentifierValue | Item Id (where ItemId.ItemIdentifierType is “barcode”) | R |
The borrowerreceivesthe resource sharing material.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| When Non-returnable: ItemOptionalFields.ItemUseRestrictionType = “Available For Supply Without Return” * ElectronicResource.ActualResource = “File” * | Shipped Format | R (Only for Non-returnable or Digital item) |
| DateReceived ** | Date Received | R |
| Ext.NoticeContent | “ReceivedByBorrower” Note: This is needed since the ItemRecevied is used for both CheckedIn and Received purpose. This will enable Alma differentiate between the two. | Constant (R) |
| ItemId.ItemIdentifierValue | Item Id (where ItemId.ItemIdentifierType is “barcode”) | R |
The borrower returns the resource sharing material.
| Message Field | Value | Required (R) or Optional (O) |
| DateShipped ** | Date Shipped | R |
| Ext.NoticeContent | “ShippedByBorrower” Note: This is needed since the ItemShipped is used for both | Constant (R) |
| ItemId.ItemIdentifierValue | Item Id (where ItemId.ItemIdentifierType is “barcode”) | R |
The lender ships the resource sharing material.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| When Non-returnable: ItemOptionalFields.ItemUseRestrictionType = “Available For Supply Without Return” * When Digital: | Shipped Format | R (Only for Non-returnable or Digital item) |
| Ext.DateDue ** | Due Date | O |
| DateShipped ** | Date Shipped | O |
| Ext.RequiredFeeAmount | Costs | O |
| Ext.NoticeContent | “ShippedByLender” Note: This is needed since the | Constant (R) |
| ItemId.ItemIdentifierValue | Item Id (where ItemId.ItemIdentifierType is “barcode”) | R |
The lender informs the borrower that the resource sharing request was expired.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| Ext.NoticeContent | “ExpiredByLender” Note: This is needed since the CancelRequestItem | Constant (R) |
The lender informs the borrower that the resource sharing request was rejected.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| Ext.ItemNote | InUseOnLoan = 1, InProcess = 2, Lost = 3, NonCirculating = 4, NotOwned = 5, OnOrder = 6, VolumeIssueNotYetAvailable = 7, AtBindry = 8, Lacking = 9, NotOnShelf = 10, OnReserve = 11, PoorCondition = 12, CostsExceedsLimit = 13, Charges = 14, PrepaymentRequired = 15, LacksCopyrightCompliance = 16, NotFoundAsCited = 17, LocationsNotFound = 18, OnHold = 19, PolicyProblem = 20, MandatoryMessagingNotSupported = 21, ExpiryNotSupported = 22, RequestedDeliveryServicesNotSupported = 23, PreferredDeliveryTimeNotPossible = 24, CriticalExtensionNotSupported = 25, Other = 27, ResponderSpecific = 28 | R |
| Ext.NoticeContent | “RejectedByLender” Note: This is needed since the CancelRequestItem | Constant (R) |
The lender recalls the resource sharing material from the borrower.
| Message Field | Value | Required (R) or Optional (O) |
|---|---|---|
| DesiredDateDue ** | Desired Date Due | O |
| ItemId.ItemIdentifierValue | Item Id (where ItemId.ItemIdentifierType is “barcode”) | R |
In order to enable the Based Peer to Peer Resource Sharing, the following configuration is required:
Configuration in Alma
An NCIP-P2P partner should be defined, representing the ILL system. Refer to Alma online help for more information.
Configuration in a non-Alma ILL system
- The NCIP messages should include the relevant fields and information, as described above.
- The Alma Institution code and the Alma library code are required (described above in the field InitiationHeader.FromAgencyId.AgencyId).
- If exist, the external system institution code should appear in the field InitiationHeader.ToAgencyId.AgencyId (Receiving Institution) and the external system library code in the field InitiationHeader.OnBehalfOfAgency.AgencyId (Receiving Library).
- The Server for which NCIP Peer to Peer messages should be sent to Alma from the external system is: https://{Alma domain}/view/NcipP2PServlet