Bliv klar til at kode: Beskedfordeler

Den hurtigste måde at komme i gang med at kode en integration til Fælleskommunal Beskedfordeler er at gennemgå vejledningen Kom godt i gang – Fælleskommunal beskedfordeler, der trin for trin leder dig igennem hvordan man sender og modtager en besked. På siden 'Kom godt i gang'-vejledninger kan du også finde andre vejledninger om, hvordan du kommer i gang med at bruge den fælleskommunale infrastruktur.

Services

Fælleskommunal Beskedfordeler udstiller services til at afsende og modtage beskeder, som illustreret nedenfor:

Disse services er samlet i de to integrationer SF1461 og SF1462:

SF1462 Afsend beskeder via Beskedfordeler
Når et afsendersystem skal afsende en besked, skal du benytte servicen: BeskedAfsend, som er en AMQP-service, som afsendersystemet skal kalde. Servicen er dokumenteret i SF1462 Afsend beskeder via Beskedfordeler, hvor du også kan læse hvordan du opsætter serviceaftaler i Fælleskommunalt Administrationsmodul for at kunne kalde servicen.

SF1461 Modtag beskeder via Beskedfordeler
Når et modtagersystem skal modtage en besked, skal der konfigureres et såkaldt dueslag, hvorfra systemets beskeder kan hentes. Der opsættes et abonnement, der filtrerer hvilke beskeder, der modtages i dueslaget. Denne konfiguration sker i Beskedfordelerens brugergrænseflade. Når et modtagersystem skal modtage en besked, skal det benytte en af følgende to services:

1. BeskedAfhent, der er en AMQP-service udstillet af Fælleskommunal Beskedfordeler og som modtagersystemet kalder for at hente nye beskeder.
2. BeskedFåTilsendt, hvor modtagersystemet udstiller en REST-service, der kaldes af Fælleskommunal Beskedfordeler, når der kommer beskeder i modtagersystemets dueslag.

Når man skal modtage beskeder, kan man desuden benytte:

3. VærdilisteRediger, der er en SOAP-service, til at vedligeholde værdilister, som kan benyttes i abonnementsudtryk til at filtrere hvilke beskeder, der bliver modtaget i et givent dueslag. Det kan fx benyttes til at vedligeholde en dynamisk liste over ID’er på borger, som man vil modtage beskeder om.

De tre services til at modtage beskeder er dokumenteret nærmere i integrationen SF1461 Modtag beskeder via Beskedfordeler. Her kan du også læse, hvordan du opsætter serviceaftaler i Fælleskommunalt Administrationsmodul for at kunne kalde servicen, samt hvordan man konfigurerer dueslag i Beskedfordeler og abonnementer til at modtage beskeder.

Du skal bemærke, at et modtagersystem altid skal hente beskeder umiddelbart, når de er tilgængelige i Fælleskommunal Beskedfordeler. Det er således ikke tilladt at benytte Beskedfordeleren til opbevaring af beskeder over en længere periode. Beskedfordeleren opbevarer dog beskeder i op til 7 dage (kan ændres op til 30 dage i brugergrænsefladen), men dette er kun tiltænkt som en sikring mod at miste beskeder i fejlsituationer og må ikke benyttes som et generelt brugsmønster.

Brugergrænseflade

På forsiden af brugergrænsefladen til Fælleskommunal Beskedfordeler kan du se en oversigt over alle de beskedtyper, der er aktive i Fælleskommunal Beskedfordeler. Dette er tilgængelig for alle - man behøver ikke logge ind for at kunne tilgå dem.

Du finder links til brugergrænsefladen herunder og i menupunktet "Log på" i toppen af Digitaliseringskataloget:

• Brugergrænseflade til Fælleskommunal Beskedfordeler (eksternt testmiljø)
   
• Brugergrænseflade til Fælleskommunal Beskedfordeler (produktionsmiljø)

Brugergrænsefladen til Fælleskommunal Beskedfordeler benyttes desuden af leverandører af modtagersystemer til at konfigurere dueslag til modtagelse af beskeder. For at kunne konfigurere dueslag kræver det, at du logger ind i brugergrænsefladen. Hvis du kun skal afsende beskeder, har du ikke behov for at kunne logge på brugergrænsefladen.

For at få adgang til at logge ind i brugergrænsefladen skal du benytte MitID. Du skal have din organisations NemLog-in administrator til at tildele dig en eller begge af nedenstående roller:

• ”Beskedfordeler - Ekstern test - Anvendersystemadministrator” for at kunne opsætte og administrere dueslag til modtagelse af beskeder i det eksterne testmiljø.
• ”Beskedfordeler - Anvendersystemadministrator” for at kunne opsætte og administrere dueslag til modtagelse af beskeder i produktionsmiljøet.

Du kan læse mere om hvordan du får tildelt disse roller i NemLog-in Brugeradministration hos Virk.

Når du logger ind i Fælleskommunal Beskedfordelers brugergrænseflade, har du adgang til at redigere opsætning af dueslag for de it-systemer, der er oprettet under din virksomheds CVR-nummer i Fælleskommunalt Administrationsmodul.

Du kan læse mere om, hvordan du benytter brugergrænsefladen i brugerdokumentationen her.

Eksempelkode

Eksempelkoden viser hvordan du sender og modtager en besked via AMQP-servicerne.

Eksempelkoden virker ”out-of-the-box”, så du behøver ikke oprette dit eget anvendersystem og serviceaftaler for at få eksempelkoden til at fungere. Det er dog tanken, at når du først har fået koden til at fungere, så kan du ændre i den efter behov. Om du kan benytte dele af eksempelkoden i produktion eller om du vil starte forfra, er helt op til dig, men du skal være opmærksom på at du selv er ansvarlig for kode, der bruges i produktion og at du selvfølgelig skal ændre passwords og andre sikkerhedsparametre, så det følger din sikkerhedsretningslinjer, som din virksomhed benytter.

Eksempelkoden findes kun i Java og er en del af dokumentationspakken for SF1461 Modtag beskeder via Beskedfordeler og SF1462 Afsend beskeder via Beskedfordeler.

Hvis du skriver din kode i .NET kan du finde en kort beskrivelse af, hvordan du kan skrive en .NET AMQP-klient i Kom godt i gang – Fælleskommunal beskedfordeler.

Dokumentation og Vejledninger

Herunder finder du links til den primære dokumentation for Beskedfordeleren:

• Kom godt i gang – Fælleskommunal beskedfordeler
• SF1461 Modtag beskeder via Beskedfordeler
• SF1462 Afsend beskeder via Beskedfordeler
• D 12.02 - Brugerdokumentation  Beskedfordeler.

Support og supportydelser

Du kan få hjælp til almindelig supportspørgsmål ved at henvende dig, som beskrevet under Kontakt og support – Støttesystemerne.

Du har også mulighed for at få mere dybdegående hjælp til at integrere til Beskedfordeler. Dette gøres ved enten at bestille supportydelsen ”Integration til Beskedfordeler” eller ved at bestille en timepulje til hjælp og vejledning. Du kan se detaljer og bestille supportydelser under SF1461 Modtag beskeder via Beskedfordeler og SF1462 Afsend beskeder via Beskedfordeler. Supportydelserne kræver betaling.