Datamodellen skal dokumenteres

Nummer:
5.9
Version:
1.1.0
Høringsversion
Ændring

Reglen ændres til, at dokumentationen skal angives som specificerede tagged values på de enkelte elementer. Der vil blandt andet være felter til beskrivelse af: Definition, Note, Alternativt navn, Lovgrundlag og Eksempel

Ændringsargumentation

Anvendelse af tagged values i stedet for Notes-feltet øger den semantiske struktur af metadata og gør transformationen til tjeneste-data værktøjsneutral. Den øgede strukturering gør det mere tilgængeligt at diversificere udstillingen af metadata.

Regel

Datamodellen skal dokumenteres gennem beskrivelser af elementerne i UML-modellen. Beskrivelserne etableres og vedligeholdes sammen med modellen som beskrevet i bilag 3.

Rationale

Dokumentationen gør det muligt for modellens brugere at forstå modellens elementer. Både når man udvikler og anvender modellen, er det essentielt at kommunikere og forstå betydningsindholdet af de enkelte dele af modellen. Det at dokumentationen er indlejret i datamodellen muliggør automatisk dannelse af et katalog over klasser, attributter og relationer. Yderligere kan dokumentationen indgå i datasnitfladerne, hvis der er ønske herom.

Implikationer

Datamodellens klasser, attributter og relationer skal dokumenteres som beskrevet i bilag 3.

 

NOTE: Nogle domæner anvender store mængder metadata, som har til formål at indgå i brugervendt information om data (forklaringer til rapporter, hjælpetekst på web-sider etc.) Det vil ikke være formålstjenligt, at indlejre disse metadata i selve modellen, men de kan modelleres og distribueres som alle andre data og fordeles gennem den generelle data-arkitektur.

 

 

Bilag 3: Dokumentation af datamodellen

Datamodellen skal dokumenteres ved hjælp af elementerne i UML-modellen.

Modellens klasser og deres attributter beskriver forretningsobjekter og deres egenskaber, ligesom de roller, objekterne har i forhold til hinanden beskrives som roller/relationsender i hver ende af af en association. Disse forretningsobjekter, egenskaber og roller skal beskrives i overensstemmelse med den begrebsmodellering, der er i domænet.

Dokumentation i UML med tagged values

Klasser, attributter og roller/relationsender dokumenteres ved brug af tagged values (se Note om tagged values), som specificeret i tabellen nedenfor. De enkelte tags i dokumentationen modsvarer i videst muligt omfang vidensmodelleringsvokabulariet [SKOS].

Denne strukturerede måde at dokumentere på, muliggør fleksibel generering af tekstdokumentation på baggrund af modellen, ligesom dokumentationen med stor præcision kan transformeres ind i datasnitflader og afledte modeller.

Tagged values som bruges til dokumentation i datamodellen:

 

 

 

 

 

Tag definition

SKOS-ækvivalent

Krav

Indhold

definition

SKOS:definition

Krævet

Objektets/egenskabens/rollens definition. Kort tekst, som entydigt beskriver objektet/egenskaben/rollen -  kan også indeholde et afsnit med en længere beskrivelse, fx formål, referencer og kilde.

note

SKOS:note

Valgfri

Uddybende beskrivelse af objektet/egenskaben/rollen

alternativtNavn

SKOS:altLabel

Valgfri

Andre navne, som objektet/egenskaben/rollen kan have

lovgrundlag

--

Valgfri

Angivelse af det lovgrundlag, som hjemler indsamlingen af data for objektet/egenskaben/rollen

eksempel

SKOS:example

Valgfri

Eksempler på anvendelse af objektet/egenskaben/rollen

Værdierne angives i ren tekst

 

De tagged values, som nævnes i skemaet, er indeholdt i Grunddatamodellens stereotyper, som defineres i regel 5.6 UML-stereotyper skal anvendes.

 

Værktøjsunderstøttelse

I den MDG og base project, som distribueres af modelsekretariatet, er de relevante tagged values indføjet i stereotyperne i en separat gruppe - Grunddata:dokumentation

 

[Figur som viser Class properties med tagged values]
 
Eksempler

[Eksempler på udfyldte tagged values - enten grafisk i EA eller som tabeller for klasse, attribut og relation end]
 

Permanent URL til denne artikel: http://arkitekturguiden.digitaliser.dk/node/823

Kommentarer

Høringssvar, ATP og MBBL:

 Ingen kommentarer