...

Indholdsfortegnelse

Se eksempel på udfyldelse på DDS: DDS - Guide til anvendere - NSP services - Global Site

Introduktion

Formål

Denne guide har som formål at give et overblik over <xxx>.

<Denne guide er tilegnet klienter til NSP og specifikt den leverede komponent/service. Denne del skal være tilstrækkelig for en klientleverandør, som skal udvikle aftagersystemer. Heri tilgodeses specielt referencer til andre dokumenter, da en anvender også skal have en bredere forståelse af den anvendte komponent og eventuelle omgivelser.

Det er selvfølgelig også ret væsentligt at template udfyldes udtømmende, herunder i forhold til den logik og de regler, der skal følges for den måde servicen anvendes på, og som servicen selv efterlever>

Beskrivelse

<Formål og beskrivelse af komponenten/servicen>

Links til mere information

<Relevante links til andre dokumenter, herunder i forhold til de data services skal arbejde på, og den model de følger>

<Eventuel link til mere uddybende beskrivelse, intern på NSP og eksternt>

Grafisk fremstilling og sammenhængen

<Tegning(er) der letter forståelsen og beskrivelser af relevante sammenhængen>

Relevante use-cases

Digital Post Adapter (DPA). Formålet med dokumentet er at give anvendere et overblik over løsningen, samt en oversigt over, hvilke User Stories der er understøttet af DPA og hvordan disse er implementeret.

Beskrivelse

Digital Post Adapter står for at videresende breve til Digital Post Komponent. Dette gøres asynkront via en kø, således at brevene vil blive sendt før eller senere, selv hvis DPK er utilgængelig.

Links til mere information

Dokumentationen for DPK kan findes her: https://github.com/trifork/dpk-docs/wiki

Det er kaldet SendPDF der bliver brugt af DPA.

Grafisk fremstilling og sammenhængen

Image Added

DPA modtager breve fra andre services og sender dem videre til DPK, som omdanner dem til PDF og sender dem videre.<Angiv use cases såfremt det er relevant>

Læsevejledning og forudsætninger

Dette dokument er henvendt til udviklere og arkitekter, der skal anvende <> Digital Post Adapter .

Det forventes at læseren har kendskab til <f.eks.: SOAP WebService, Den Gode WebService (DGWS) og Sercurity Token Service (STS), o.a.><Eventuel andre forudsætninger>

Sikkerhed

<Forudsætninger for anvendelse og krævede adgange, whitelistinger etc., Sikkerhedsniveau. Angiv krav til authentication for at kunne bruge servicen/komponenten.>

<Eventuel nærmere introduktion>

<Eventuel yderligere beskrivelse af området / domænet som servicen/komponenten servicerer>.

<Samt yderligere information som er vigtigt for anvendelsen eller forståelsen>

Definitioner og referencer

Adgang, brug og snitflader

Adgang

...

<Beskrivelse af hvordan service/komponent bruges, snitflade(r), endpoints, og andet relevant>

...

Endpoint(s)	<Angiv udstillede endpoint(s), og hvad de hedder.>	På <serverurl>/digitalpost/2024/05/29/send findes endpointet http://nspop.dk/digitalpost/2024/05/29/#send
WSDL	http://test1-cnsp.ekstern-test.nspop.dk:8080/digitalpost/service-contract/wsdl/digitalpostadapter_2024_05_29.wsdl http://test2-cnsp.ekstern-test.nspop.dk:8080/digitalpost/service-contract/wsdl/digitalpostadapter_2024_05_29.wsdl	WSDL	<Angiv henvisning til WSDL(er). For ekstern anvendbare services typisk på https://wsdl.nspop.dk/>
Beskrivelse af services	<Beskrivelser af service(s) / actions på endpoint(s). I lægmands termer beskrive hvad man kan forvente af de enkelte services.>
Namespaces etc	<Angiv eventuelt Namespaces, eksterne typer, ..>

Snitfladebeskrivelse og brug

<Beskrivelse af Snitfladerne, samt den logik og de regler, der skal følges for den måde servicen anvendes på, og som servicen selv efterlever.> 

<snitflade 1>

<Beskrivelse af hver snitflade input/output>

<snitflade 1>Request

<beskrivelse af request>

<Marker hvilke der er obligatoriske. Gerne en beskrivende tekst på samtlige parametre, og gerne også et eksempel på hvilke data der kan sættes ind her. Selv hvis man forstår beskrivelsen, så er det stadig godt at have et eksempel. Angiv hvis der er undtagelser eller specielle hensyn>

...

<snitflade 1>Response

<beskrivelse af svar>

...

Snitfladebeskrivelse og brug

SendDigitalPost

SendDigitalPost kaldet sætter et Digital Post brev på en kø, som afvikles med jævne mellemrum. Hvis et brev succesfuldt sendes til DPK fjernes det fra køen, men hvis kaldet mod DPK fejler beholdes brevet i køen og forsøges afsendt igen senere og supporten får vha. is-alive kald besked om at der er et brev som er fejlet.

SendDigitalPostRequest

SendDigitalPostResponse

Generelle koder, værdier, etc.

<Angiv eventuelle generelle koder, værdier, etc>

Fejlbeskeder

<Beskrivelse af  fejlbeskeder, og i hvilke situationer man kan forvente at se disse i.

...

Disse Identifiers kan angives som template i requestet, og sender de tilsvarende Identifiers til DPK. Substitutions-nøglerne kan enten tilføjes som recipient-details eller som template-details. Hvis en substitutions-nøgle er angivet som både recipient-details og template-details vil recipient-details værdien blive valgt.

Fejlbeskeder

I fejl-scenarier vises disse fejlkoder:

Eksempler på request/response

Eksempler på request og response til de operationer der udstilles. De enkelte elementer er beskrevet under snitfladebeskrivelse. Klient proxier kan genereres udfra WSDL'en.

...

Eksempel på SendDigitalPostRequest/Response

<eksempel her>

<mere eksempel>

Test

<beskriv Test muligheder, test-systemer og eventuelle testdata>

Eksempel kode og klient

Eksempel kode

<SendDigitalPostRequest>
  <message-id>7edac017-97a1-4cdc-aa7c-ff2298514aff</message-id>
  <recipient-id>1111111118</recipient-id>
  <recipient-id-source>1.2.208.176.1.2</recipient-id-source>
  <template-physical>fgvhr/20241218/physical/BekraeftelseRegistreringFravalg</template-physical>
  <template-digital>fgvhr/20241218/digital/BekraeftelseRegistreringFravalg</template-digital> 
  <recipient-details>
    <key>ikrafttraedelsesdato</key>
    <value>2025-05-01</value>
  </recipient-details>
  <template-details>
    <key>date</key>
    <value>2025-04-25</value>
  </template-details>
</SendDigitalPostRequest>

<SendDigitalPostResponse>
  <message-id>7edac017-97a1-4cdc-aa7c-ff2298514aff</message-id> 
</SendDigitalPostResponse>

Eksempel kode

Eksempel kode

Denne eksempel-kode gør brug af nsp-test-idp biblioteket til håndtering af SOAP og SEAL.<Eksempel kode. Det er meget lettere at lave sin egen implementering, hvis man kan kigge efter en anden ....>

<eksempel her, eller reference andet steds>

Eksempel klient

...

        URI endpoint = URI.create("http://localhost:8080/digitalpost/2024/05/29/send");
        String action = "http://nspop.dk/digitalpost/2024/05/29/#send";
        Identity identity = sundhedsdatastyrelsen();



        String request = """
                <ns1:sendDigitalPostRequest xmlns:ns1="http://nspop.dk/digitalpost/2024/05/29/" >
                  <message-id>7edac017-97a1-4cdc-aa7c-ff2298514aff</message-id>
                  <recipient-id>1111111118</recipient-id>
                  <recipient-id-source>1.2.208.176.1.2</recipient-id-source>
                  <template-physical>fgvhr/20241218/physical/BekraeftelseRegistreringFravalg</template-physical>
				  <template-digital>fgvhr/20241218/digital/BekraeftelseRegistreringFravalg</template-digital>  
                  <recipient-details>
                    <key>ikrafttraedelsesdato</key>
                    <value>2025-05-01</value>
                  </recipient-details>
                  <template-details>
                    <key>date</key>
                    <value>2025-04-25</value>
                  </template-details>
                </ns1:sendDigitalPostRequest>
                """;
        try (NspSoapClient nspSoapClient = new NspSoapClient(System.out::println)) {
            try (NspSoapClient.NspSoapResponse soapResponse = nspSoapClient.request(endpoint, action).as(identity).execute(request)) {
                assertEquals(200, soapResponse.getStatus());
                String response = IOUtils.toString(soapResponse.getResponse(), StandardCharsets.UTF_8);
                assertTrue("Actual response: " + response, response.contains("7edac017-97a1-4cdc-aa7c-ff2298514aff"));
            }
        }

Dokument Historik