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 GM-CMS, herunder dets funktionalitet, arkitektur, og hvordan det integreres med relaterede services.

Denne guide er tilegnet klienter til NSP, specielt dem, der skal udvikle aftagersystemer. Der vil blive givet referencer til relevante dokumenter for at skabe en bredere forståelse af komponentens omgivelser.

Beskrivelse

GM-CMS er en backend-service, der understøtter indholdshåndtering for applikationen "Min Graviditet".

Systemet tilbyder fleksible værktøjer til oprettelse, redigering og publicering af indhold såsom artikler, billeder og videoer.

Links til mere information

GM-CMS repository: git.nspop.dk/projects/bff/repos/min-graviditet-content-management-system
Strapi documentation: https://docs.strapi.io/cms/intro
Meilisearch plugin: https://market.strapi.io/plugins/strapi-plugin-meilisearch
CKEditor 5: https://market.strapi.io/plugins/@_sh-strapi-plugin-ckeditor
Config Sync plugin: https://market.strapi.io/plugins/strapi-plugin-config-sync

Grafisk fremstilling og sammenhængen

Følgende ses diagram over GM-CMS struktur og relationer til relaterede services (Min Graviditet-app, BFF, m.fl.)

Graviditetsmappen > GM-CMS - Guide til anvendere > image-2025-4-9_15-23-9-1.png

Relevante use-cases

Der findes tre typer brugere i forhold til use cases:

Borgere: Brugere af app’en "Min Graviditet".
Redaktører: Brugere med indholdsredigeringsrettigheder i GM-CMS.
Systemadministratorer: Brugere med administratortilladelser i GM-CMS.

GM-CMS skal understøtte use cases for "Min Graviditet" appen ved at udstille data. I den efterfølgende parentes angives use case nummer jf. Appendix 1b fra tilbudsmateriale.

Use cases for "Min Graviditet" appen:

Borger skal kunne se vejledninger som er knyttet til specifikke graviditetsuger (artikler og videoma teriale) (UC11)
Borger skal kunne søge i vejledninger (UC12)
Borger skal kunne tilføje nye emner til tjeklisten (UC13)
Borger skal kunne se menupunktet “Mere”, som indeholder information omkring support, sikker hed, FAQ, privatslivspolitik, samtykke mm. (UC22)
Borger skal kunne tilgå information omkring privatlivspolitik (databeskyttelse, logning, etc) (UC25)

For at undersøtte disse use cases skal GM-CMS overholde følgende use cases.

Redaktør skal kunne oprette, redigere, publicere og slette indholdstyper, herunder kategorier, artikler, sektioner, tjeklister, tjeklistepunkter, forklaringer på fagtermer og ofte stillede spørgsmål (FAQs).
Det skal være muligt søge i artikler
Administrator skal kunne tilføje og administrere CMS-brugere
Redaktør skal kunne ændre eget kodeord
Alle brugere skal logge ind i CMS administrationspanel via 2-faktor.
Redektører skal kunne filtrere indhold på udgivet og kladdeversioner samt sortere på dato og kategorier
Redaktøren skal kunne angive følgende per artikel: Titel, kategori, tags, angivelse af ugenumre, hvor artikel dermed vil blive vist på forsiden ved den pågældende graviditetsuge, angivelse af ugenumre, hvor artikel dermed vil blive vist på forsiden den pågældende efter fødsel er angivet, sektioner, hvorvidt artikel skal skjule på forside, samt tekst og medier.
På artikel skal forfatter og dato for udgivet/published eller sidst redigeret/modified sættes
Redaktører skal kunne eksportere alle tekster fra CMS’en til en samlet tekstfil

Indholdstyper

Jf. use cases skal følgende indholdstyper konfigureres i GM-CMS.

Indholdstype	Beskrivelse	Relation	id
Kategori	Indeholder titel og tilhørende artikler	Kategori “tilhører flere” artikler	category
Artikel	Indeholder titel, beskrivelse, tags, boolean til angivelse af om artikel skal skjules på forside, samt tilhørende kategorier og sektioner	Kategori ”har flere” artikler Artikel “tilhører flere” sektioner	article
Sektion	Indeholder titel, tekst, liste af ugenumre i graviditet/efter fødsel hvor sektionen er relevant, samt tilhørende artikler	Artikel “har flere” sektioner	section
Tjekliste	Indeholder titel, beskrivelse, samt tilhørende tjektlistepunkter	Tjekliste ”tilhører flere” tjeklistepunkter	checklist
Tjeklistepunkt	Indeholder titel, beskrivelse, samt tilhørende tjektliste	Tjekliste “har flere” tjeklistepunkter	checklist-point
Ordforklaring	Indeholder ord og ordforklaring		glossary-term
Tekst	Indeholder titel, tekst, beskrivelse og unikt API-navn. Bruges til at oprette tekster om samtykkeerklæring, databeskyttelse osv.		text
FAQ	Indeholder spørgsmål og svar		faq

Læsevejledning og forudsætninger

Dette dokument er henvendt til udviklere og arkitekter, der skal anvende GM-CMS. Det forventes, at læseren har kendskab til RESTful API'er samt grundlæggende webteknologier.

Sikkerhed

Forudsætninger for anvendelse inkluderer:

Service udstil type	<Angiv typen, f.eks. DGWS, IDWS, ...>
Krævede adgange	<Angiv adgange som er nødvendige for anvendere for at kunne benytte servicen/komponenten>
Whitelisting	Whitelisting kræves for IP-adresser, der skal have adgang til GM-CMS.
Krævet sikkerhedsniveau	<Angiv krav til authentication for at kunne bruge servicen/komponenten>
Forudsætninger for anvendelse	<Angiv forudsæntninger som er nødvendige for at kunne bruge servicen/komponenten, eventuelle nødvendige kald til andre services, etc.>
Logning	<Angiv om og hvad der logges>

<Eventuel nærmere introduktion>

XXXX

Definitioner og referencer

Reference	Beskrivelse
CMS	Content Management System
GM	Graviditetsmappen
BFF	Backend for frontend

Adgang, brug og snitflader

Adgang

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

Tilgængelig	<Angiv på hvilke(n) NSP-installation(er) servicen/komponenten er tilgængelig>
Endpoint(s)	<Angiv udstillede endpoint(s), og hvad de hedder.>
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>

<navn>
Element	Beskrivelse	Påkrævet

<snitflade 1>Response

<beskrivelse af svar>

<navn>
Element	Beskrivelse	Påkrævet

<snitflade 2, osv., med request/response>

Generelle koder, værdier, etc.

Fejlbeskeder

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

Noter omkring ting som går på tværs af services. Det kan være fejl som optræder generelt og som man skal være opmærksom på.>

Eksempler på request/response

Eksempler på request og response til de operationer der udstilles. De enkelte elementer er beskrevet under snitfladebeskrivelse.

<eksempel 1 på ..>

<eksempel her>

Test

Ikke relevant.

Dokument Historik

3/4 2025

Martin Henriksen/SDS

Etablering af dokumentation