Teknisk dokumentation

Teknisk dokumentation - Generisk ärendehantering

Här samlar vi länkar till de öppna källkodsrepon på GitHub som tillsammans bygger upp helhetslösningen, samt de API:er som lösningen integrerar med.

Webb-appen

Webb-apparna ligger i ett gemensamt repo som innehåller flera webb-appar. Tillsammans bygger de upp en supportlösning som – tack vare att den är konfigurerbar – kan användas i många olika verksamheter, från kontaktcenter och intern support till lön, pension och rekrytering.

github.com/Sundsvallskommun/web-app-draken-public

Lösningsarkitektur

Översikt över hur webb-appen, kärn-API:erna, de interna stödtjänsterna, master-data och externa system hänger ihop. Pilarna visar anrop. Bilden är härledd från webb-appen, API-listan och respektive API:s beskrivning av vad det i sin tur anropar.

Lösningsarkitektur för Generisk ärendehantering: webb-appen anropar kärn-API:erna SupportManagement, CaseStatus, BillingPreprocessor, Party, Templating och Relations, som i sin tur anropar interna stödtjänster, master-data API:er och externa system.
Lösningsarkitektur — från webb-app via kärn-API:er till stödtjänster, master-data och externa system.

API:er som lösningen integrerar med

Helhetslösningen integrerar med ett antal API:er. De flesta finns som öppna repon på Sundsvalls kommuns GitHub. Tabellen nedan beskriver vad varje API gör och länkar till källkoden. Kärn-API:erna anropas direkt av webb-appen, medan stödtjänsterna i sin tur anropas av kärn-API:erna (främst SupportManagement).

Alla integrationer är inte alltid nödvändiga – vilka som behövs beror på hur lösningen ska användas. Till exempel behöver BillingPreprocessor bara användas om man vill kunna trigga fakturering från lösningen, och WebMessageCollector är bara aktuell om man använder Open ePlatform som extern lösning för ärenderegistrering.

API Typ Beskrivning Källkod
SupportManagement Kärn-API Navet i lösningen – registrerar och hanterar supportärenden, statusar och kommunikation med intressenter. api-service-support-management
CaseStatus Kärn-API Levererar aktuell statusinformation om ärenden från underliggande system. api-service-case-status
BillingPreprocessor Kärn-API Hanterar intern och extern fakturering och skickar underlag till Raindance. api-service-billing-preprocessor
Party Kärn-API Översätter mellan person-/organisationsnummer (legalId) och partyId. api-service-party
Templating Kärn-API Lagrar och renderar mallar till text och PDF (Pebble- och Word-mallar). api-service-templating
Relations Kärn-API Lagrar relationer och kopplingar mellan ärenden och andra resurser. api-service-relations
Messaging Stödtjänst Skickar meddelanden via e-post, SMS och fysiska brev. api-service-messaging
Notes Stödtjänst Lagrar och hämtar anteckningar kopplade till en organisation eller medborgare. api-service-notes
Eventlog Stödtjänst Centraliserad händelselogg för spårbarhet och uppföljning. api-service-eventlog
EmailReader Stödtjänst Läser inkommande e-post från brevlådor på en Exchange-server. api-service-email-reader
WebMessageCollector Stödtjänst Samlar in meddelanden från Open-E Platform (e-tjänster). api-service-web-message-collector
MessageExchange Stödtjänst Håller konversationer och meddelandetrådar. api-service-message-exchange
MessagingSettings Stödtjänst Tillhandahåller kommun-specifika inställningar för messaging. api-service-messaging-settings
AccessMapper Stödtjänst Översätter Active Directory-grupper till interna behörighetsgrupper. api-service-access-mapper
JsonSchema Stödtjänst Tillhandahåller JSON-Schema och validering av data. api-service-json-schema
CaseManagement Stödtjänst Integrationslager mellan klienter och olika ärendehanteringssystem. api-service-casemanagement
SimulatorServer Testverktyg Simulatorserver för att testa olika svar (status, fördröjning och svarsinnehåll). api-service-simulator-server

Master-data API:er utan publikt repo

Följande API:er hanterar kommun-specifik master-data och har därför inget publikt repo. För att få dessa på plats krävs en utvecklingsinsats anpassad efter den egna kommunens källsystem.

API Beskrivning
Citizen Medborgarinformation – uppslag och grunddata om privatpersoner.
ActiveDirectory Användar- och behörighetsinformation från katalogtjänsten.
Employee Medarbetarinformation, hämtas från Metadatakatalogen.
LegalEntity Information om organisationer och juridiska personer.
Estateinfo Fastighets- och adressinformation.

← Tillbaka till Generisk ärendehantering