Referencer
Reference | Titel | Forfatter | Version |
DD130 - Detaljeret design - API | Theis Klement Søe-Pedersen | 1.0 | |
O0400 – Teknisk infrastruktur | Sune Rievers | 1.0 | |
O0500 - Softwarearkitektur | Sune Rievers | 1.0 |
Indholdsfortegnelse
Introduktion
Dette dokumenet beskriver grænsefladerne i Jobindsats 3.0 løsningen. Formålet med dette slutprodukt er at fastlægge og beskrive grænsesnittene og samspillet mellem løsningens egne systemer og de omgivende eksterne systemer. Dokumentet skal tænkes som en kontrakt mellem løsningens egne systemer og de eksterne systemer.
Dokumentet henvender sig til leverandører af eksterne systemer, udviklere, der skal forstå designet og implementere løsningen samt teknisk kyndige interessenter hos STAR.
Grænseflader
Nedenstående model viser snitfladerne mellem de forskellige komponenter i løsningen.
Jobindsats 3.0 er hosted på servere hos Statens IT (SIT) hvor umbraco anvendes til at understøtte løsningen. Umbraco udstilles på en IIS hos SIT og forbinder brugeren med de underliggende databaser, der udstiller data gennem et internt API, der har adgang til databaserne, som også findes på SIT’s servere. For en detaljeret beskrivelse af landskabet henvises til O0400.
Integrationsmønstre
Der ønskes integrationer med lav kobling imellem systemerne hvilket opnås ved klare ansvarsområder og adgang gennem definerede API. Der anvendes SOA arkitektur hvor der udvikles mindre komponenter der kan udvikles og deployes separat og som hjælpe med at isolere funktionalitet fra hindanden.
Interne systemer
Der er følgende interne systemer, der defineres som systmer inden for samme IT Arkitketur, i relation til jobindsats 3.0.
Datamart: Udstiller Stored Procedure til udtræk af data via parametre. Resultatset sendes retur, der skal parses og mappes.
Delte services (her benyttes services fra Prod i UDV/TEST): SMTP
Datamart og metadata API: API (Internal)
Umbraco (+Extentions)
Matomo (Internt datasamlings værktøj anvendt af STAR)
Integration internt imellem jobindsats komponenterne benytter REST API, baseret på OpenAPI. Til dette benyttes en response envelope der sikre en konsekvent håndtering af data, fejlbeskeder mv. samt muliggør udvidelser til funktionalitet uden behov for at ændre i den grundlæggende model for dataen. Denne response envelope er beskrevet i O0500.
Eksterne systemer
Der anvendes ikke ingen eksterne systemer i relation til jobindsats udover til udvikling. Med ekstern forståes systemer der ikke driftes på samme netværk. Ifm udvikling og placering af kode er der værktøjer, der for jobindsats 3.0 er placeret uden for netværket. Azure Devops benyttes her til CI/CD og repository som en delt ekstern integration.
Integrationer
Matomo
Konfiguration for UDV, TEST og PROD
JavaScript embedded i jobindsats 3.0 front end koden.
API for Datamart og Metadata
API foran Metadata-database og DM, der udstilles via OpenAPI/Swagger. Konfiguration af endpoint i Umbraco, samt proxy foran API'et, således at JavaScript-klienten kan tilgå API'et ifm. opbygning af Databank-vieweren.
API’et anvendes til udstilling af metadataen herunder styringen af de fordelingsvariable, der kan vælges for en given måling i systemet. Ydermere har API’et til formål at styre kontakten til Datamarten hvor selve målingsdataen hentes - se afsnit Grænseflader. API endpoints og detaljeret beskrivelse findes i DD0130.
Integration via Stored Procedure og efterfølgende mapping til internt data API. Direkte Database adgang fra API.