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.)

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

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:

<Eventuel nærmere introduktion>

XXXX

Definitioner og referencer

Adgang, brug og snitflader

Adgang

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

Brugertyper (roller)

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.> 

Strapi snitflade

Strapi CMS'en udstiller en række endpoints til at hente de definerede indholdstyper. Alle API-endpoints er offentligt tilgængelige, hvilket betyder, at det ikke er nødvendigt at sætte en authentication header på anmodningerne.

Indholdstyper

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

Strapi endpoints

 For at relationer mellem indholdstyperne inkluderes i responsen tilføjes:

Eksempelvis for at få alle artikler, samt relaterede kategorier og sektioner kaldes:

 Eksempler på atrapi request/responses

TODO

Meilisearch snitflade

Meilisearch anvendes til at søge i artikler CMS'en udstiller en række endpoints til at hente de definerede indholdstyper. Alle API-endpoints er offentligt tilgængelige, hvilket betyder, at det ikke er nødvendigt at sætte en authentication header på anmodningerne.

Generelle koder, værdier, etc.

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

Fejlbeskeder

Herunder er nogle af de mest almindelige fejlbeskeder og deres årsager.

401 Unauthorized

• Mulige årsager: 
  • Der er sendt en authentication header med anmodningen. Selvom endpointet er offentligt vil enhver bearer token i headeren resultere i et ugyldigt kald.
  • Endpointet er konfigureret til, at anmoderen skal være authenticated. Dette er default konfigurationen i Strapi.
• Løsninger: 
  
  • Gå til Strapi adminpanelet → Settings → Users & Permissions plugin → Roles → Public.
  • Tjek, at “Find” og “FindOne” er markeret for alle indholdstyper, som du ønsker at tilgå. Dette tillader offentlige brugere at få adgang til de angivne indholdstyper uden at være autentificeret.
  • Tjek, at authentication header ikke er sat.

Test

Ikke relevant.

Dokument Historik