Bokdata-Bokbasen

Owned by babak.tavassoli
Last updated: Aug 01, 2023
2 min read

Innledning

Denne i integrasjonen, er en del av “innholdsinformasjon-integrasjonen”. Denne sørger for å hente ut bok-data om norske utgivelser og sende dem til en intern API/forsystem til Alma, bibliotek-systemet.

Det overføres 2 type informasjon.

  1. descriptions : Tekstlig beskrivelse av innholdet i ei bok.

  2. objects : Dette består av eventuelle bilder eller lyd-objekter om en enkel bok.

Dokumentasjonen om bokdatabasen er å finne her : https://bokbasen.jira.com/wiki/spaces/api/pages/119572243/API+for+Digital+Lending+Platforms

 

Nøkkel info

Initiering av flyt

Scheduler (1 runde for hvert “objects” og “description”)

 

Flyt mønster

Synkron

Henter listen over objects og descriptions og sender dem en og en til det interne API’et i AWS laget av team-smile

Bruk av meldingskø

Nei

 

Open API

Nei

 

IntArk

Nei

 

Bakgrunn

Bibliotek-systemet trenger å bli oppdatert med info om nye bøker og eller oppdatering av info på eksisterende. Dette skjer via eksterne tjenester, i dette tilfellet, bokbasen.

Brukerhistorie

  • Beskrivelse eller bilde/lyd info om nye bøker skal automatisk hentes og oppdatere innholdet i bibliotek-systemet.

  • Oppdaterte beskrivelse eller bilde/lyd info om eksisterende bøker skal automatisk hentes og oppdatere innholdet i bibliotek-systemet.

Systemer/tjenester

  • Detaljert liste av alle innvolverte systemer/tjenester Hva utveksler data? Fra hvor / Til hvor?

System

Data

Brukt API (endepunkter)

System

Data

Brukt API (endepunkter)

Innholdsinformasjon-ext

Sender contents, isbn (ISBN13), description_long, audio_file, image_small, image_large, image_original og source til API mot Alma laget av Team Smile

putInfo

 Bokbasen Extension

Denne metoden brukes for å hente objekter fra Bokbasen database. Den mottar enten en "siden"-verdi (since brukes bare hvis next ikke er angitt) eller en "neste"-verdi (next). Resultatet fra databasen transformeres fra xml til json (den setter pagesize hvis spesifisert, ellers brukes bokbasens standard).

Objektrapporten (bilder og lydfiler) inneholder identifikatorer og referanser til adressen hvor objektene kan lastes ned. Disse referansene vil være gyldige i en begrenset periode.

 getPagedObjectsSince

https://bokbasen.jira.com/wiki/spaces/api/pages/67993638/Objects

 Bokbasen Extension

Denne metoden brukes for å hente beskrivelser fra Bokbasen database. Den mottar enten en “siden”-verdi (since brukes bare hvis next ikke er angitt) eller en "neste" verdi (next). Resultatet fra databasen transformeres fra xml til json.

getPagedDescriptionsSince

Tilgangsstyring og logging

  • Integrasjonen loger til Humio med detaljert logging av prosessen.

  • Ingen tilgangstyring er nødvendig.

Forretningsregler

Hver natt hentes en liste over alle nye beskrivelser og objekter. For hver beskrivelse/object kalles API-endepunktet som oppdaterer informasjonen i bibliotek-systemet.

Behandlingstid/responstid og volum

  • Behandlingstid/responstid: gj. snitt ca. 2s (avhengig av antall objekter/beskrivelser)

  • Frekvens: Scheduler : 1 runde hver dag, med fire ganger for hvert “object” og “description”. Hver runde består av flere kall, da det er en grense på ca 1000. Det vil si hvis en dag det er flere enn 4000 oppdateringer, blir de ikke alle med den dagen.

  • Volum (målt: Aug 30, 2022): ca. 1000 “descriptions” og 300 “objects” daglig

Feilhåndtering, konsekvenser av feil og overordnet risikoanalyse

  • Ved feil i post til AWS-tjenesten eller feil i data-format mottatt fra bokbasen.

    • Feil logges i humio.

  • Inneholder meldingene personopplysninger?

    • Nei, ingen personopplysninger er involvert.

  • Noe om viktige feil/situasjoner som må passes ekstra på (som kan ha stor konsekvens) :

    • Feil bok oppdateres med info om en annen bok

    • Vi går glipp av oppdateringer.