| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Innledning
Grovt om hva denne integrasjonen er fra hvor / Til hvor?
Bakgrunn
Litt om grunnen til integrasjonen. Hva for en behov dekkes av integrasjonen.
Interessenter
Hvem er ansvarlig for datakommunikasjonen? Hvem bestilte dette og betaler for at utvekslingenpågår?
Brukerhistorie (gjerne sekvensdiagram) ?
...
...
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.
descriptions : Tekstlig beskrivelse av innholdet i ei bok.
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
| Inc drawio | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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?
Hvilken kø-mekanisme brukes evt.?
Om Int-ark komponenter er brukt og eventuelt hvilke deler
Data
Hvilke data utveksles? Alle attributter som utveksles?
Samhandlingsmønster
Hva driver utvekslingen? Request eller Push
Er utvekslingen synkron eller asynkron?
Om involverte API
Brukte API endepunkter
Tilgangsstyring og logging
Hva logges?
Eventuelle tilgangstyring
Forretningsregler
Forretningslogikken i integrasjonen. Feks. Bare dokumenter med status X leses etter Y antall dager osv …
Behandlingstid/responstid og volum
Hva er antallet meldinger pr. døgn i denne forbindelsen (Min, Avg, Max)
System | Data | Brukt API (endepunkter) |
|---|---|---|
Innholdsinformasjon-ext | Sender | putInfo |
Bokbasen Extension | Denne metoden brukes for å hente objekter fra Bokbasen database. Den mottar enten en "siden"-verdi ( 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 ( | 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: ): ca. 1000 “descriptions” og 300 “objects” daglig
Feilhåndtering, konsekvenser av feil og overordnet risikoanalyse
Hva skjer ved overload i kø?
Hva skjer med ufullstendinge meldinger?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) . F.eks : Oppgavene som aldri vil publiseres, eller Oppgaver som ikke skal publiseres, publiseres.
Flytdiagram ?
...
Feil bok oppdateres med info om en annen bok
Vi går glipp av oppdateringer.