Norsk NCIP Profil. Dokumentasjon. Forfatter: Jan Erik Garshol, BIBSYS Dato: 20. september Versjon 1.0. Norsk NCIP dokumentasjon 20.9.

Transkript

1 Norsk NCIP Profil Dokumentasjon Forfatter: Jan Erik Garshol, BIBSYS Dato: 20. september 2017 Versjon 1.0 Norsk NCIP dokumentasjon

2 Norsk NCIP Profil 1. Prioriterte brukstilfeller Norsk NCIP dokumentasjon

3 Prosjektgruppa møttes den 3. september 2014 og 20. november 2014 for å bli sams om ein felles målsetning for det vidare arbeidet. Norsk NCIP-profil, versjon 1.0, vart fastlagt til å ha to deler, ein obligatorisk og ein valfri, totalt 8 brukstilfeller. Norsk NCIP-profil, del 1 er obligatorisk: 1. Agency handshake 2. Patron pickup and return item to her Home Library 3. Order originated from Owner Library (in Discovery) 4. Patron renews an Item 5. Cancels or rejects a loan request Norsk NCIP-profil, del 2 er valfri: 6. Pickup at Pickup Library 7. Return Item to Diff. Return-to Library 8. Recall Item Kvart brukstilfelle er dokumentert ved hjelp av eit sekvensdiagram. Fokuset i diagrammet er samhandlinga mellom biblioteksystema, alle meldingar som ikkje starter med «NCIP.» er vegleiande for å gi eit fullverdig omfang på brukstilfellet. Profilen har kunn fokus på den meldingsflyten som er NCIPrelatert. Den enkelte systemleverandør står fritt til å realisere resten av brukstilfellet etter eiget ønske. Heile del 1 av Norsk NCIP-profil må støttes, etter intensjonen med profilen, for at ein skal kunne sei seg sams med Norsk NCIP-profil. Del 2 er å oppfatte som annen relevant funksjonalitet som framtidige versjonar av Norsk NCIP-profil vil kunne flytte inn i del 1. Leveranse 2 og 3 er komplementære til denne leveransen. Den første greier ut koplingar til NCIP og den andre gir meir detaljar som er nødvendige for å kunne realisere denne leveransen på tvers av ulike systemporteføljar. På dei neste sidene er det bilde av sekvensdiagram, for langtids bevaring da lenkene til dei dynamiske sekvensdiagram vil kunne slutte å fungere før vi ønsker. Norsk NCIP dokumentasjon

4 Norsk NCIP dokumentasjon

5 Brukstilfelle 2, del 1: Norsk NCIP dokumentasjon

6 Brukstilfelle 2, del 2: Norsk NCIP dokumentasjon

7 Norsk NCIP dokumentasjon

8 Norsk NCIP dokumentasjon

9 Norsk NCIP dokumentasjon

10 Brukstilfelle 6, del 1: Norsk NCIP dokumentasjon

11 Brukstilfelle 6, del 2: Norsk NCIP dokumentasjon

12 Brukstilfelle 7, del 1: Norsk NCIP dokumentasjon

13 Brukstilfelle 7, del 2: Norsk NCIP dokumentasjon

14 Norsk NCIP dokumentasjon

15 Leveranse 2: «Norsk NCIP-profil» Norsk NCIP dokumentasjon

16 NCIP definerer fylgjande fem tenester som «core services» (første nr er referanse til NCIP protokollen, versjon 2.02 andre nr i parentes sist på linja er løpenummer brukt i sekvensdiagramma i leveranse 1 og i leveranse 3: Check In Item (Ingen) Ber om at eit item skal bli sjekka inn Check Out Item (17) Ber om at eit item skal bli sjekka ut (til ein person) Lookup Item (18) Ber om namngitt attributt til eit item (som er kjent for mottakar) Lookup User (19) Ber om namngitt attributt til ein bruker (som er kjent for mottakar) Renew Item (9) Ber om at eit item skal bli fornya (for ein person) NCIP definerer så fylgjande fire tenester som «core resource sharing services»: Accept Item (Ingen) Ber om at mottakar godtar eit item som skal lånast ut til ein bruker. Mottakar trenger ikkje å ha noko forhandskjennskap til verken item eller bruker relevant informasjon må då over sendes Cancel Request Item (10, 11) Ber om at ein tidlegare førespurnad om eit item skal bli ignorert Recall Item (23) Ber om at eit item blir tilbakekallet (frå ein bruker) Request Item (3, 12) Ber om at eit item skal bli reservert for ein bruker I tillegg trenger vi fylgjande NCIP-tenester for å realisere våre 5 prioriterte brukstilfeller: Item Shipped (4, 6, 13, 14, 20) Informerer om at eit item er sendt Item Received (5, 7, 8, 15, 16, 21, 22) Informerer om at eit item er mottatt Lookup Agency (1) Informerer om at eit item er fornya Lookup Version (2) Informerer om at eit item er ønsket Dermed består «Norsk NCIP-profil» versjon 1.0 av desse 13 tenestene, men kunn 11 av dei trenger å bli implementert. Dei resterande 2 teneste er tilstrekkelig å kunne svare på, utan at vi trenger å støtte funksjonen. NCIP definerer så fylgjande fire tenester som «core self-service services»: Create user Ber om at mottakar opprettar denne brukaren Create User Fiscal Transaction Ber om at mottakaren krevjar betalt frå bruker (for ein utført teneste) Undo Check Out Item Ber om at føregåande Check Out Item blir ignorert Update User Ber om at mottakar oppdaterer bruker data Når vi skal oppgradere «Nasjonalt Låntakerregister», så er tenestene «Create user» og «Update user» relevante. Vi bør, på eit seinare tidspunkt, vurdere å utvide «Norsk NCIP-profil» til å også omfatte desse fire tenestene. Norsk NCIP dokumentasjon

17 Leveranse 3: Implementasjonsrettleiar for «Norsk NCIP-profil» Norsk NCIP dokumentasjon

18 Under følgjer alle NCIP meldingar, i kronologisk rekkefølgd, som til samen realiserer dei fem brukstilfelle som «Norsk NCIP-profil» omfattar. Følgjene parametrar blir brukt og er definert slik: FromAgency = ISIL 1 til Home Library o ISIL = NO- + LibNr frå BaseBibliotek ToAgency = ISIL til Owner Library UserID = LocalPatronID o AgencyID = ISIL BibliographicID = ID o Identifier Code = {OwnerLocalRecordID ISBN ISSN EAN} ItemID = OwnerLocalSystemRecordID o ItemIdentifierType = {RFID Barcode Both(Barcode:RFID)} o AgencyID = ISIL RequestId = Begge er nødvendige for at ID skal bli unik o <AgencyId>ISIL</AgencyId> o <RequestIdentifierValue>LocalOrderID</RequestIdentifierValue> o LocalOrderID = Local increment number on requestes RequestType = { Loan Copy LoanNoReservervation LII LIINoReservation Depot } RequestScopeType = [ 0 ](meaning that all orders are on title-level) Date Shipped = åååå-mm-ddtxx:xx:xx (ISO ) (Implesitt GMT) Shipping Information o Address = String (Skal hentast frå BaseBibliotek) DateReceived = åååå-mm-ddtxx:xx:xx (ISO ) PickupLocation = ISIL ItemOptionalFields o Electronic resource Actual resource (URI to full bibliographic record) o BibliographicDescription Author 100$a PlaceOfPublication 260$a PublicationDate 260$c Publisher 260$b Title 245$a BibliographicLevel {"Book" "Journal" "Other"} Language Use three letter codes (ISO-639-2) MediumType Use values as defined in Implementation-part of NCIP on page 23. o ItemDescription HoldingsInformation UnstructuredHoldingsData = String (artikkelkopi) General note concerning all NCIP messages The initiating part in a NCIP communication should create the RequestID and it should be included in the whole lifecycle of that request. This also include the response-part if possible. In the Norsk NCIP-profil the RequestID is treated as the primary key of the communication and should always be included if it do not break the NCIP protocol. Initiation Header is obligatory on all NCIP meassages, containing FromAgencyID and ToAgencyID. One implementation of this profile may host multiple library, so each message must be self-contained on scope. 1 ISO assigns a unique number to every library in the world. Norsk NCIP dokumentasjon

19 Shortlist of all NCIP services that is part of Norsk NCIP-profil, version 1.0: 1 NCIP.LookupAgency(AgencyID, [AgencyElementType]) 2 NCIP.LookupVersion(FromAgencyID, ToAgencyID) 3 NCIP.RequestItem(RequestID, UserID, {ItemID BiblioID}, RequestType, RequestScopeType) 4 NCIP.ItemShipped(RequestID, UserID, ItemID, Date Shipped, Shipping Information, ItemOptionalFields) 5 NCIP.ItemReceived(RequestId, ItemID, DateReceived ) 6 NCIP.ItemShipped(RequestID, UserID, ItemID, Date Shipped, Shipping Information) 7 NCIP.ItemReceived(RequestID, ItemID, DateReceived, RequestId) 8 NCIP.ItemRequested(RequestID, UserID, {ItemID BiblioID}, RequestScopeType, RequestType) 9 NCIP.RenewItem(UserID, ItemID) 10 NCIP.CancelRequestItem(RequestID, UserID, RequestType) 11 NCIP.CancelRequestItem(RequestID, UserID, RequestType) 12 NCIP.RequestItem(RequestId, UserID, {ItemID BiblioID}, RequestType, RequestScopeType, PickupLocation) 13 NCIP.ItemShipped(RequestId, UserID, ItemID, Date Shipped, Shipping Information). 14 NCIP.ItemShipped(RequestID, UserID, ItemID, Date Shipped, Shipping Information) 15 NCIP.ItemReceived(RequestID, ItemID, DateReceived ) 16 NCIP.ItemReceived(RequestID, ItemID, DateReceived ) 17 NCIP.CheckOutItem(RequestID, UserID, ItemID) 18 NCIP.LookupItem(ItemID, ItemOptionalFields) 19 NCIP.LookupUser(UserID) (NB! Not supported) 20 NCIP.ItemShipped(ItemID, {RequestID}, Date Shipped, Shipping Information) 21 NCIP.ItemReceived(ItemID, {RequestID}, DateReceived ) 22 NCIP.ItemReceived({RequestID ItemID}, DateReceived ) 23 NCIP.RecallItem(ItemID, Desired Date Due) The first five use cases is the obligatory part of the Norsk NCIP-profil version 1.0, the last three use cases is optional. UC 1 Agency handshake 1 - A Library System -> Another Library System: NCIP.LookupAgency(AgencyID, [AgencyElementType]) One library ask another libaray about some information, like shipping address, that should be returned in the response. An AgencyID that comply with Norsk NCIP Profil has to include at least one ApplicationProfileSupportedType in LookupAgencyResponse containing: NNCIPP 0.1 if still in development face, NNCIPP 1.0 if it comply with the 5 mandatory use cases, and NNCIPP 1.1 if also the 3 supplementary use cases are supported. 2 - A Library System -> Another Library System: NCIP.LookupVersion(FromAgencyID, ToAgencyID) One library ask aother library what version(s) it support of NCIP-services. To comply with Norsk NCIP-profil version 1.0 the response has to include NNCIPP 1.0 in the [Version Supported]. Removed in version UC 2 - Patron pickup and return item to her Home Library 3 - Home Library -> Owner Library: NCIP.RequestItem(RequestID, UserID, {ItemID BiblioID}, RequestType, RequestScopeType) Home request one Item from Owner, either a loan or a copy, on title level. The {ItemID BiblioID} should be understood as an exclusive or but the request is in either way on title level. 4 - Owner Library -> Home Library: Norsk NCIP dokumentasjon

20 NCIP.ItemShipped(RequestID, UserID, ItemID, Date Shipped, Shipping Information, ItemOptionalFields) Owner informs that one Item is sent to Home at given date to given address ItemOptionalFields is included to informed that order is fulfilled with alternative Item 5 - Home Library -> Owner Library: NCIP.ItemReceived(RequestId, ItemID, DateReceived ) Home informs Owner that Item is received at given date. 6 - Home Library -> Owner Library: NCIP.ItemShipped(RequestID, UserID, ItemID, Date Shipped, Shipping Information) Home informs Owner that one Item is returned at given date to given address 7 - Owner Library -> Home Library: NCIP.ItemReceived(RequestID, ItemID, DateReceived, RequestId) Owner informs Home that the Item is received at a given date, Home can then close RequestId UC 3 Order originated from Owner Library (in Discovery) This is an alternative start on use case 2 - Pickup and return Home Library 8 - Owner Library -> Home Library: NCIP.ItemRequested(RequestID, UserID, {ItemID BiblioID}, RequestScopeType, RequestType) Owner informed Home that a User request one Item from his OPAC/Discovery. The initiating part creates the RequestID in this case the Owner Library. For the completion, follow sequense in use case 2 - Pickup and return Home Library. UC 4 Patron renews an item 9 - Home Library -> Owner Library: NCIP.RenewItem(UserID, ItemID) Home informs Owner that Patron has requested a renewed loan on Item. Owner Library must use Problem.Type to inform why a request for renewal is declined. Following values are recommended to support: "Item Not Renewable" - Item may not be renewed "Maximum Renewals Exceeded" - The User has already renewed the Item the maximum number of times permitted. "Renewal Not Allowed - Item Has Outstanding Requests" - Item may not be renewed because outstanding requests take precedence over the renewal request. UC 5 Cancels or rejects a loan request 10 - Home Library -> Owner Library: NCIP.CancelRequestItem(RequestID, UserID, RequestType) Home informs Owner that a Patron cancels a loan request, see Problem.Type in response for reason, according to NCIP Apendix A Owner Library -> Home Library: NCIP.CancelRequestItem(RequestID, UserID, RequestType) Owner informs Home that loan on Item is rejected, see Problem.Type in response for reason, according to NCIP Apendix A. UC 6 Pickup at Pickup Library 12 - Home Library -> Owner Library: NCIP.RequestItem(RequestId, UserID, {ItemID BiblioID}, RequestType, RequestScopeType, PickupLocation) This call equals to call number 1, except the last parameter PickupLocation. It decides where the patron wish to pickup the item Owner Library -> Pickup Library: NCIP.ItemShipped(RequestId, UserID, ItemID, Date Shipped, Shipping Information). Norsk NCIP dokumentasjon

21 Owner Library inform the pickup library that an item is send to fulfill the request made by UserID Owner Library -> Home Library: NCIP.ItemShipped(RequestID, UserID, ItemID, Date Shipped, Shipping Information) Owner library inform the home library that the item is shipped to the pickup library, so that the user may be informed about progress Pickup Library -> Home Library: NCIP.ItemReceived(RequestID, ItemID, DateReceived ) Pickup library inform the home library that the item is received, to enable home library to inform UserID the she can pick it up at PickupLocation Pickup Library -> Owner Library: NCIP.ItemReceived(RequestID, ItemID, DateReceived ) Pickup library informs Owner Library that the Item is received Pickup Library -> Home Library: NCIP.CheckOutItem(RequestID, UserID, ItemID) Pickup library informes home library that Item is picked up by UserID. UC 7 Patron returns item to not Owner Library (a Return-to Library) 18 - Return-to Library -> Owner Library: NCIP.LookupItem(ItemID, ItemOptionalFields) A library ask another library about one ItemID. The response will be used to decide if the Item in question is owned by the quarried library. See call Return-to Library -> Home Library: Not supported NCIP.LookupUser(UserID) A library may ask another library about one UserID, to reason out who is the owner of an Item, but this is not supported, as it will open the possibility to break the privacy of our users and there borrow history Return-to Library -> Owner Library: NCIP.ItemShipped(ItemID, {RequestID}, Date Shipped, Shipping Information) A library informs the owner library that an Item is shipped. If the RequestID is known, it should be included. The reason for shipping this Item may be one of many, but it is done in an attempt to return an Item to its owner Owner Library -> Return-to Library: NCIP.ItemReceived(ItemID, {RequestID}, DateReceived ) Owner library inform the sender that the item is recived Owner Library -> Home Library: NCIP.ItemReceived({RequestID ItemID}, DateReceived ) Owner library inform the Home library that it has recived the Item, so that the Home library may close the RequestID and update the user on status on the loan. UC 8 Recall item 23 - Owner Library -> Home Library: NCIP.RecallItem(ItemID, Desired Date Due) Owner library informs the Home library about a new due date, so that the Item can be returned, within the new date. The response should if possible include the new due date, as the Home library has informed the user. This message can be used to either prolong or reduce a given date. Norsk NCIP dokumentasjon

22 Norsk NCIP dokumentasjon