Specifikation af Model for Dokument (Version til kommentering) 1
> Specifikation af Model for Dokument. Version 2.0 (version til kommentering) Denne standard kan frit anvendes af alle. Citeres der fra standarden i andre publikationer til offentligheden, skal der angives korrekt kildehenvisning. Standarden er oprindeligt udarbejdet af en arbejdsgruppe under OIO-udvalget for sags- og dokumentområdet. Version 2.0 er udarbejdet i regi af den fællesoffentlige Styregruppe for Data og Arkitektur. Arkitektur.digst.dk 2
> Specifikation af Model for Dokument (Dokumentmodellen) Version til kommentering (Version 2.0) Styregruppen for Data og Arkitektur 31. januar 2018 3
Indholdsfortegnelse Indledning 5 Formål med Dokumentmodellen 5 Ændringer siden version 1.1.1 6 Egenskaber for Dokumentmodellen 7 Diagrammer 7 Forretningsobjekter 7 Universelt unik, persistent identifikation af forretningsobjekter 8 Attributter 9 Datatyper 9 Mulighed for tilpasning af attributters udfaldsrum 10 Relationer 10 Dokumentmodellen 12 Dokumentbegrebet 12 Diagram for Dokumentmodellen 13 Forretningsobjekter i Dokumentmodellen 14 Centralt Forretningsobjekt 14 Eksternt definerede forretningsobjekter 14 Dokument 16 Attributter 16 Relationer fra Dokument 19 Relationer til andre dokumenter 19 Relationer til Organisation 19 Relationer til Klassifikation 20 Dokumentpart 21 Attributter 21 Relationer til Part 21 Referencer i Dokumentmodellen 23 Retteblad for Dokumentmodellen version 2.0 24 4
Indledning > Formål med Dokumentmodellen Formålet med Dokumentmodellen er at gøre det lettere at udveksle oplysninger om dokumenter mellem to eller flere it-systemer, ved at skabe en fælles forståelse af hvad et dokument er, og hvilke informationer et dokument består af. Dokumentmodellen definerer de begreber, forretningsobjekter, attributter, datatyper og relationer, som tilsammen beskriver et dokument. Dokumenter består af en afgrænset samling af informationer, i en kendt struktur, gemt på et kendt medie. Et dokument kan foreligge på papir, digitalt medie eller et hvilket som helst andet medie, der kan være bærer af information. Dokumenter kan rumme tekst, tegninger, grafik, fotografier, video, tale osv. Specifikationen beskriver en model for Dokument og udgør et fælles grundlag for forståelse og metadataopmærkning af digitale dokumenter. Dokumentmodellen udgør dermed det semantiske grundlag for at registrere oplysninger om en organisations dokumenter med henblik på udveksling af dokumentmetadata mellem to eller flere it-systemer. I figuren nedenfor er illustreret, hvordan Dokumentmodellens formål er at beskrive fælles metadata for dokumenter til brug for udveksling mellem itsystemer. Figur 1 Dokumentmodellens fokus Den fysiske fil udpeges fra Dokumentmodellen igennem en URI. Hvor og hvordan den fysiske fil er lagret er ikke en del af beskrivelsen i Dokumentmodellen. Dokument anvendes og indgår primært i sammenhæng med andre objekter som fx Sag, sammenhænge som dermed beskriver dokumenters relationer til omverdenen. Dokumentmodellen rummer kun de fælles metadata for dokumenter og vil formentlig skulle specialiseres og beriges med fagområdets metadata ved anvendelse på specifikke fagområder. Dokumentmodellen kan enten anvendes alene eller i kombination med elementer fra andre modeller, som eksempelvis Sagsmodellen (se [SAG]), anvendes til at bygge udvekslingsmodeller, som lægges til grund for udvikling af snitflader. 5
Ændringer siden version 1.1.1 Dokumentmodellen er en revision af Specifikation af serviceinterface for Dokument. Version 1.1.1 (OIO Dokument 1.1.1). Dokumentmodellen er udarbejdet som en del af en samlet revision af specifikationerne, som samlet set omtales standarderne for OIO Sag og Dokument: Specifikation af serviceinterface for Dokument, Version 1.1.1 (OIO Dokument). Specifikation af serviceinterface for Organisation, Version 1.1 (OIO Organisation). Specifikation af serviceinterface for Klassifikation, Version 1.1 (OIO Klassifikation). Specifikation af serviceinterface for Sag, Version 1.2 (OIO Sag). Specifikation af serviceinterface for Arkivstruktur, Version 1.1 (OIO Arkiv). Generelle egenskaber for serviceinterfaces på sags- og dokumentområdet, Version 1.1 (OIO Generelle egenskaber). OIO Arkiv har ingen kendte implementeringer. Endvidere har ingen af de adspurgte interessenter udtrykt et forretningsbehov for at tage den i anvendelse. Specifikationen revideres derfor ikke, men afpubliceres og udgår som standard. OIO Generelle egenskaber indeholder specifikke krav til udstilling af data i webservices. Erfaringerne fra implementering af standarderne er, at de generelle egenskaber er svære at forstå og kommunikere. Det kan give anledning til misforståelser mellem kravstillere og udviklere. Specifikationen revideres derfor ikke, men afpubliceres og udgår som standard. OIO Generelle egenskaber udgår. Derfor kan Dokumentmodellen stå alene i forhold til forståelsen af modellens forretningsobjekter. I hver af de opdaterede specifikationer er der indført et afsnit om egenskaber for modellen. Her findes beskrivelse af modelnotation, forretningsobjekter, unik identifikation, attributter og relationer anvendt i Dokumentmodellen. Denne beskrivelse er ens for de fire opdaterede standarder. 6
Egenskaber for Dokumentmodellen > Dokumentmodellen er en informationsmodel, der giver en grafisk og tekstuel beskrivelse af Dokument (jf. [GODPRAKSIS]). I beskrivelsen er anvendt en række modelelementtyper: Som notation er anvendt UML klassediagram til beskrivelse af Dokumentmodellen. UML-pakker er anvendt med henblik på sammenhæng og genbrug af modelelementer på tværs af modeller. Forretningsobjekter er i Dokumentmodellen repræsenteret af en UMLklasse. Universelt unik, persistent identifikation af forretningsobjekterne er obligatorisk. Attributter beskriver informationsindholdet i Dokumentmodellen. Relationer repræsenterer de strukturelle sammenhænge mellem forretningsobjekter i Dokumentmodellen. Modelelementtyperne og brugen af dem i Dokumentmodellen er forklaret yderligere i de følgende afsnit. Diagrammer UML klassediagram udgør rammen for beskrivelse af Dokumentmodellen og forretningsobjekterne, der indgår heri og deres relationer. Formålet med diagrammet er visuelt at kommunikere de forskellige metadata, der indgår i beskrivelsen af et dokument, når det skal udveksles mellem it-systemer. Som en visuel hjælp til forståelsen af diagrammet benyttes i diagrammerne elementer, som ikke indgår i et normalt UML Klassediagram. Farvemarkering benyttes til at indikere, hvilke forretningsobjekter der defineres i modellen (grå), og hvilke der er eksternt definerede (blå). Part eksisterer ikke som en eksternt defineret model. Men i modellen er Part alligevel vist som en UML Pakke, der rummer forretningsobjekterne Person og Virksomhed. Fremgangsmåden er anvendt for at kunne referere til de to objekter under et og i egenskab af Part. Diagrammet forklares uddybende i den medfølgende tekst. Alle forretningsobjekter, attributter og relationer defineres og beskrives i afsnittene efter diagrammet. Forretningsobjekter Et forretningsobjekt er i UML Klassediagrammet for Dokumentmodellen repræsenteret af en UML Klasse. Forretningsobjekter i Dokumentmodellen er beskrevet som vist i tabellen nedenfor: 7
Forretningsobjekt Navn Entydigt klassenavn for det forretningsmæssige begreb. Definition En kort og præcis definition. Tabel 1 Forretningsobjekter i Dokumentmodellen Beskrivelse Uddybende beskrivelse og eksemplificering af forretningsobjektet. Universelt unik, persistent identifikation af forretningsobjekter Universelt unik, persistent identifikation er obligatorisk for forretningsobjekterne i Dokumentmodellen. Unik identifikation er beskrevet igennem attributten ID og bør være af typen http-uri. Http-URI anvendes bl.a. af Grunddataprogrammet og i Den Fællesoffentlige Digitaliseringsstrategi 2016 2020. I retningslinjerne for stabile URI er er beskrevet, hvordan eksisterende identifikatorer som fx UUID og URN kan genbruges med brug af http-uri (se [HTTPURI]. UUID (Universal Unique IDentifier jf. [RFC4122]) bør anvendes i konstruktionen af http-uri for forretningsobjekterne i Dokumentmodellen. Egenskaberne ved UUID garanterer, at identifikatoren er universelt unik. Eksempel på UUID: 91aa87da-9f06-11e7-abc4-cec278b6b50a Eksempel på repræsentation af UUID i http-uri-form: https://data.gov.dk/id/thing/91aa87da-9f06-11e7-abc4-cec278b6b50a/ Http-URI en bør konstrueres, så det kan resolveres, hvilken objekttype en UUID er identifikator for, fx om det er OrgEnhed, Dokument, Sag mv. Eksempelvis en http-uri for et konkret Dokument: https://data.gov.dk/id/document/document/91aa87da-9f06-11e7-abc4- cec278b6b50a Der kan være tilfælde, hvor det er nødvendigt at anvende en anden identifikator end UUID i konstruktion af http-uri. I retningslinjerne for stabile http-urier (se [HTTPURII] er også anvist, hvordan en http-uri i så fald kan konstrueres, fx: Eksempel med emneklassen 27.34.02 i klassifikationssystemet KLE som identifikator, der indgår i konstruktion af http-uri: https://data.gov.dk/id/classification/kle/emne#27.34.02 Eksempel med registreringsnummeret VZ26979 på køretøj som identifikator, der indgår i konstruktion af http-uri: https://data.gov.dk/id/vehicle/registration#vz26979 I tabellen nedenfor er vist, hvordan kravet om universel unikt, persistent identifikation af forretningsobjekter er beskrevet i modellen: 8
Betegnelse Beskrivelse Udfaldsrum ID Forretningsobjektets universelt unikke, persistente identifikator. Angives som http-uri (se [HTTPURI]), eksempelvis: https://data.gov.dk/id/document/document/91aa87da-9f06-11e7-abc4-cec278b6b50a/ Se også nærmere beskrivelse i afsnit ovenfor om universelt unik, persistent identifikation af forretningsobjekter. Tabel 2 Universelt unik identifikation af objekter i Dokumentmodellen Http-URI Attributter Dokumentmodellens informationsindhold, fx titlen på et dokument, er for de respektive forretningsobjekter, fx dokumentet, repræsenteret af attributter. Attributter i Dokumentmodellen er beskrevet som vist i tabellen nedenfor: Betegnelse Beskrivelse Datatype Regel for udfyldelse Entydig navngivning af attributten inden for det enkelte forretningsobjekt. Angivelse af navn på datatype for attributten. Den forretningsmæssige definition af attributten samt kort beskrivelse af dens anvendelse. Hvis attributten har et udfaldsrum, som ikke er givet i datatypen, beskrives det også her. Tabel 3 Beskrivelse af attributter i Dokumentmodellen Beskrivelse af de regler for anvendelse, der gælder for attributten, fx om den er obligatorisk. Beskrivelsen af attributter er yderligere uddybet og eksemplificeret i afsnittet Beskrivelser af attributter, som følger efter tabellerne. Datatyper Dokumentmodellen skal kunne anvendes som udgangspunkt for udvekslinger af oplysninger om dokumenter mellem to eller flere it-systemer. Angivelse af datatyper sikrer, at informationsindholdet beskrives og læses på samme måde af de it-systemer, som udveksler informationer, fx ved at deltagerne i en informationsudveksling bruger det samme datoformat. Datatyperne præciserer modellens beskrivelser som udgangspunkt for transformation fra model til konkrete repræsentationer af data, fx en XMLstruktur som kan udveksles mellem it-systemer. Datatyperne er beskrevet som vist i tabellen nedenfor: Betegnelse Beskrivelse Datatype grundlag Restriktioner Navnet på datatypen som den anvendes til at angive datatype for en attribut. Beskrivelse af datatypen. Tabel 4 Beskrivelse af datatyper Angivelse af den konkrete datatype med anvendelse af XSD-datatyperne jf. [XSD]. Eventuelle restriktioner eller mønstre for datatypen. 9
Nedenstående datatyper er anvendt i Dokumentmodellen: Betegnelse Beskrivelse Datatypegrundlag Restriktioner Tekst Tekststreng xsd:string Tekst- (enumeration) Tekststreng med begrænsning i form af en kodeliste xsd:string Enumeration Heltal Helt tal uden decimaler xsd:integer Dato Dato uden tid xsd:date YYYY-MM-DD Dato og tidspunkt Præcis angivelse af dato og tid inkl. tidszone xsd:datetime YYYY-MMDDThh: mm:ss.ssstzd Http-URI For uddybende forklaring, se afsnit ovenfor om universelt unik, persistent identfikation af forretningsobjekter i Dokumentmodellen xsd:string jf. [HTTPURI] Boolean Anvendes med mulighed for at svare Ja/Nej Tabel 5 Datatyper i Dokumentmodellen xsd:boolean True = ja, False = Nej Mulighed for tilpasning af attributters udfaldsrum I Dokumentmodellen er der attributter, hvor udfaldsrummet er angivet med brug af datatypen Tekst(enumeration). Ved anvendelse af Dokumentmodellen vil der opstå behov for at udvide de pågældende udfaldsrum i forhold til den konkrete forretningsmæssige anvendelsessituation. I de tilfælde kan udfaldsrummet tilpasses på en af følgende måder: Udarbejde en ny enumeration med det nye udfaldsrum på attributten. Udarbejde klassifikation til at rumme det nye udfaldsrum. De konkrete værdier udtrykkes som Klasser i Klassifikationen. Fra forretningsobjektet i Dokumentmodellen tilføjes i modellen en relation til Klassifikationen, hvor Klasserne er udtrykt. Ved tilpasning af udfaldsrum for attributværdier må gerne tilføjes, men ikke fjernes, værdier fra udfaldsrummet. Relationer Relationer i Dokumentmodellen er vist i diagrammer med betegnelse på relationen og kardinalitet på det forretningsobjekt, som relationen peger på. Relationer er beskrevet som vist i tabellen nedenfor: 10
Betegnelse Beskrivelse Relateret objekt Kardinalitet Et beskrivende navn på relationen. En kort og præcis definition på relationen. Tabel 6 Beskrivelse af relationer i Dokumentmodellen Det forretningsobjekt relationen peger på. Angiver rammerne for relationen. 11
Dokumentmodellen > Dokumentmodellen beskrives igennem: Introduktion til dokumentbegrebet. Diagram for dokumentmodellen. Beskrivelse af forretningsobjekter, attributter og relationer. De enkelte punkter gennemgås i de følgende afsnit. Dokumentbegrebet Dokumenter består af afgrænsede samlinger af informationer, i kendte strukturer, på kendte formater. Dokumenter kan rumme tekster, tegninger, grafik, fotografier, video, tale og/eller meget andet. Dokumenter består dels af de faktiske dokumenter, fx et regneark eller en rapport, og dels af metadata, der beskriver dokumentet, fx dokumenttitel og brevdato. Dokumentmodellen fokuserer udelukkende på de beskrivende metadata for dokumenter med udveksling mellem it-systemer som formål. I de fleste tilfælde findes de faktiske dokumenter kun i en elektronisk variant, hvad enten de er produceret elektronisk, eller de er omformet til elektronisk form, fx igennem skanning. Men i nogle tilfælde findes de faktiske dokumenter også i en fysisk variant enten suppleret med en elektronisk variant eller helt uden nogen elektronisk variant. Forekomsten af fysiske varianter gør sig typisk gældende ved store dokumenter, der er svære at skanne, herunder tykke manualer eller tekniske tegninger. Dokumentmodellen fokuserer på at beskrive nogle få fælles metadata om dokumenter med henblik på udveksling. It-systemer, som håndterer elektroniske dokumenter, håndterer typisk også dokumenternes forretningslogik. Det kan eksempelvis være i forhold til forskellige varianter af det samme dokument, hvor der kan eksistere en offentliggørelsesvariant i pdf-format eller en produktionsvariant i word-format. Dokumentmodellen sigter ikke imod at kunne udtrykke alt forretningslogik omkring dokumenter. Men hvor behovet opstår, fx i forbindelse med udstilling af dokumenter i en webservice, rummer modellen mulighed for specialisering med tilføjelse af de nødvendige attributter og relationer til den konkrete anvendelse og de specifikke behov. 12
Diagram for Dokumentmodellen Dokumentmodellen er illustreret i nedenstående figur: Figur 2 Diagram for Dokumentmodellen Diagrammet viser, at Dokument er det centrale forretningsobjekt. Dokumentet og dets attributter er beskrevet i afsnittet omkring Dokument. Alle relationer i diagrammet peger væk fra Dokument. Der er ikke vist kardinalitet på det centrale forretningsobjekt Dokument, som der altid skal være netop ét af. Relationerne til Klasse i den eksternt definerede Klassifikationsmodel viser, at den relaterede værdi findes som en klasse i et klassifikationssystem. Relationerne til andre dokumenter vises i diagrammet ved, at der er indsat et nyt forretningsobjekt af typen Dokument, som relationerne til andre dokumenter peger på. 13
Relationerne til dokumentets parter peger på en UML Pakke navngivet Part. Part findes ikke aktuelt som eksternt defineret forretningsobjekt. Derfor er Part som abstrakt betegnelse for personer eller virksomheder vist i diagrammet på denne måde i Dokumentmodellen. Relationerne til den eksternt definerede Organisationsmodel beskriver dokumentets stamdata i forhold til ejere, ansvarlige, behandlere, og hvem der har ændret dokumentet. Forretningsobjekterne og deres relationer er beskrevet nærmere i de følgende afsnit. Forretningsobjekter i Dokumentmodellen I Dokumentmodellen indgår følgende typer af forretningsobjekter: Centrale forretningsobjekter, som er defineret og ejet af Dokumentmodellen. Eksterne forretningsobjekter, som er defineret og ejet af andre modeller De forskellige objekttyper forklares nærmere i næste afsnit. Centralt Forretningsobjekt Dokumentmodellens centrale forretningsobjekt Dokument er beskrevet i tabellen nedenfor: Forretningsobjekt Navn Dokument Definition Dokumenter er afgrænsede samlinger af informationer, i kendte strukturer, på kendte formater. Beskrivelse Eksempler på dokumenter er tekster, tegninger, grafik, fotografier, video, tale mv. Tabel 7 Centrale forretningsobjekt i Dokumentmodellen Eksternt definerede forretningsobjekter I Dokumentmodellen indgår en række forretningsobjekter, som er eksternt definerede. Som en visuel hjælp til forståelse af diagrammet, er eksternt definerede forretningsobjekter i diagrammet vist med blå farve. Hvor forretningsobjektet er defineret og beskrevet i andre informationsmodeller, er det i diagrammet for Dokumentmodellen modelleret ved hjælp af en pakke. Pakken angiver titlen på den eksterne informationsmodel Betegnelse Definition Ekstern model Beskrivelse OrgPerson OrgPerson repræsenterer en persons tilhørsforhold og medlemskab i Organisationer og OrgEnheder. Organisation se [ORG] OrgPersoner er personer med medlemskab af organisationen i en bestemt rolle, eksempelvis ansatte. 14
Betegnelse Definition Ekstern model Beskrivelse Organisation En organisation er en anerkendt juridisk enhed med rettigheder og ansvar. [ORG] Forretningsobjektet Organisation er den formelle præsentation i forhold til omverdenen. OrgEnhed Forretningsobjektet OrgEnhed er som enhed en del af en Organisation og har kun fuld anerkendelse i forbindelse med denne. [ORG] Eksempler på organisationer er myndigheder (fx et ministerium, en styrelse, en kommune) eller virksomheder. Forretningsobjektet OrgEnhed giver struktur på organisationen og anvendes til at opbygge organisationshierarkier. OrgEnheder kan spænde fra mindre enheder, som fx teams eller grupper, til store og komplekse enheder, som indeholder andre enheder. Klasse Klasse er et begreb, som man ønsker at opmærke (klassificere) et dokument med. Det er alene den juridiske enhed, der udgør den formelle repræsentation i forhold til omverdenen. [KLASSIFIKATI ON] Eksempler på OrgEnheder er afdelinger, sektioner, kontorer, udvalg, projektgrupper, styregrupper, klasser, hold og lignende. En klasse kan fx være et emne, en handlingsfacet, et stikord mv. Klasser kan ordnes i lister eller hierarkier. Person Person er et individ, der er registreret i CPR-registeret med personnummer. [PERSON] Personer identificeres med CPR-nummer. Virksomhed Virksomhed er en juridisk enhed registreret i CVRregisteret med CVRnummer. [VIRKSOMHED] Tabel 8 Eksternt definerede forretningsobjekter i Dokumentmodellen Organisatoriske aktører som Dokumentpart registreres ved deres CVR-nummer. 15
Dokument > Dokument er det centrale forretningsobjekt i Dokumentmodellen. Den samlede beskrivelse af fænomenet et dokument gives igennem Dokumentmodellens objekter, attributter og relationer til eksterne forretningsobjekter. Attributter Dokumenter har følgende attributter: 16
Betegnelse Beskrivelse Datatype Regel for udfyldelse ID Forretningsobjektets universelt unikke, persistente identifikator. Http-URI Obligatorisk Angives som http-uri (se [HTTPURI]), eksempelvis: https://data.gov.dk/id/thing/91aa87da-9f06-11e7-abc4- cec278b6b50a/ Se også nærmere beskrivelse i afsnit ovenfor om universelt unik, persistent identifikation af forretningsobjekter. Dokumentnummer Dokumentnummer tildeles ved oprettelse af dokumentet. Det er typisk det dokumentnummer, som fagsystemet har tildelt dokumentet, og som brugeren kender som dokumentets ID/entydige reference. Tekst Obligatorisk Dokumentnummer fungerer også som dokumentets brugervendte nøgle. Ved eksport fra én myndighed og import til en anden myndighed er der risiko for, at dokumentnummeret ikke længere er unikt. Titel Dokumentets titel. Tekst Obligatorisk Beskrivelse Dokumentbeskrivelse i fri tekst. En kort beskrivelse af det forretningsmæssige indhold af dokumentet. Tekst Ikke- Obigatorisk Indgående- Indikator Angivelse af om dokumentet er modtaget fra en ekstern organisation og dermed indgående i forhold til organisationen. Boolean Obligatorisk Sættes til Ja, hvis dokumentet er indgående. IndgåendeIndikator skal ikke ændres ved fordeling mellem OrgEnheder, der tilhører den samme Organisation. DokumentType Angivelse af hvilken type dokument, der er tale om. Tekst(enumera tion) Nej Attributten Type inddeler dokumenter i en række dokumenttyper: Brev, indgaaende Brev, udgaaende Dagsorden Eksternt Notat Faktura Internt Notat Rapport Brevdato Dokumenttyper udtrykkes som et endeligt antal strukturerede værdier (enumeration). Antallet af værdier kan udvides jf. beskrivelsen af mulighed for tilpasning af udfaldsrum. Den brevdato, der fremgår af dokumentet. Hvis der er tale om et brev, angives her datoen for afsendelse af brevet. Dvs. den dato hvor borgeren eller anden part har afsendt et brev til myndigheden, eller hvor myndigheden har afsendt et brev til borgeren eller anden part. Dato Obligatorisk hvis Dokumentty pen er et Brev (indgående eller udgående) 17
Versionsnummer Dokumentets versionsnummer, fx 2.00. Ved ændring af versionsnummer skal relationen ÆndretAf være udfyldt, så det er tydeligt, hvem i organisationen der har afstedkommet den nye version. Tekst Ikkeobligatorisk VersionsTid Tidspunkt for skiftet til dokumentets aktuelle version DateTime Obligatorisk hvis versionsnummer er udfyldt. DokumentTilstand Dokumentets forretningsmæssige fremdrift. Modtaget: Eksternt produceret dokument, der er modtaget i organisationen. Fordelt: Eksternt produceret dokument, der er modtaget i organisationen, er fordelt. UnderUdarbejdelse: Internt produceret dokument, i hvilket det fortsat er muligt at redigere indholdet. UnderReview: Internt produceret dokument, der midlertidigt er under ekstern eller intern høring. Publiceret: Dokument er publiceret til offentligheden. Endeligt: Internt produceret dokument i hvilket det ikke længere er muligt at redigere i indholdet, eller eksternt produceret dokument der er modtaget i myndigheden. Afleveret: Angiver, at dokumentet er afleveret til offentligt arkiv. Tekst- (enumeration) Obligatorisk TilstandsDato OrgPersonen eller it-systemet, som har registreret dokumentets aktuelle tilstand, angives med relationen ÆndretAf. Dato for dokumentets aktuelle tilstand. Dato Nej Ved ændring af versionsnummer skal relationen ÆndretAf være udfyldt, så det er tydeligt, hvem i organisationen der har afstedkommet tilstandsskiftet. Tabel 9 Attributter for Dokument 18
Relationer fra Dokument > Relationer til andre dokumenter Relationerne til andre dokumenter er modelleret ud fra en processuel tilgang i forhold til, hvornår relationen oprettet, og hvilken vej den peger. Relationen tager udgangspunkt i, at den altid peger væk fra det seneste dokument, fx et dokument, som er en besvarelse af et andet dokument. Her må besvarelsen antages at ligge senere i processen end dokumentet, som besvares. Derfor peger relationen væk fra dokumentet, som er besvarelsen, og over på dokumentet som besvares. Relationer til andre dokumenter er beskrevet i tabellen nedenfor: Betegnelse Beskrivelse Relateret Objekt Kardin alitet Besvarelse Udgangspunkt NyRevision Kommentar Dokumentet angives at være en besvarelse af et eller flere relaterede dokumenter. Et eller flere dokumenter kan angives som udgangspunkt for dette dokument. Dokumentet angives som værende en ny revision af et relateret dokument. Dokumentet kan angives som kommentar til det relaterede dokument. Dokument Dokument 0..n 0..n Dokument 0..1 Dokument 0..1 Bilag Dokumentet kan angives som værende bilag til et eller flere dokumenter, som dokumentet er indeholdt i. Dokument 0..n AndetDokument Et eller flere dokumenter kan angives som relateret til dette dokument. Dokument 0..n Tabel 10 Relation til andre dokumenter Relationer til Organisation Relationer til Organisation beskriver, hvilke OrgPersoner eller organisatoriske enheder, der deltager i behandlingen af dokumentet. De relaterede objekter er beskrevet i Organisationsmodellen (jf. [ORG]). Betegnelse Beskrivelse Relateret Objekt Kardin alitet Ejer Organisation som ejer dokumentet. Organisation 1..1 Ansvarlig Den OrganisationEnhed, som er ansvarlig for dokumentet. OrgEnhed 0..1 PrimærBehandler AndenBehandler Den specifikke medarbejder eller OrganisationEnhed, der er primær behandler på dokumentet. Andre medarbejdere eller organisatoriske enheder, der arbejder med/behandler dokumentet. Hvis der i forhold til udformningen af dokumentet er inddraget andre sagsbehandlere end den primære behandler, angives de med denne relation. OrgEnhed OrgPerson OrgEnhed OrgPerson OprettetAf OrgPerson som har oprettet dokumentet. OrgPerson 1..1 0..1 0..n 19
Betegnelse Beskrivelse Relateret Objekt Kardin alitet ÆndretAf OrgPerson som har afstedkommet ændring i dokumentets tilstand eller version. Tabel 11 Relationer til Organisation OrgPerson 1..1 Relationer til Klassifikation Relationer til klassifikation anvendes til at angive typer eller kategoriseringer af dokumentet ud fra en klassifikation. Dokument har følgende relationer til Klassifikation: Betegnelse Beskrivelse Relateret Objekt Kardin alitet PrimærKlassse AndreKlasser Er den klasse i et klassifikationssystem, der klassificerer dokumentet. Denne dokumentklasserolle anvendes, hvis man ønsker at Klasse klassificere dokumentet efter andre klassifikationssystemer end det, som angives i den primære klasse. Tabel 12 Relationer til Klassifikation Klasse 1..1 0..n 20
Dokumentpart > Dokumentpart bruges til at beskrive relationen mellem dokumentet og dets parter. Attributter Dokumentpart kan beskrives yderligere ved hjælp af attributten partsrolle, der er defineret i tabellen nedenfor. Betegnelse Beskrivelse Datatype Regel for Partsrolle Partsrolle beskriver den rolle, som en part har i forhold til dokumentet. Parter kan have forskellige roller i forhold til dokumentet. De kan fx være afsendere eller modtagere af et brev. Ønskes en nærmere angivelse af udfaldsrummet for Partsrolle for Dokumentparter, kan relationen yderligere beskrives igennem tilpasning af denne attribut jf. beskrivelsen heraf i afsnittet Mulighed for tilpasning af attributters udfaldsrum. Tabel 13 Beskrivelse af attributter for Dokumentpart Tekst udfyldelse Ikke obligatorisk Relationer til Part Relationer til part anvendes til at angive dokumentets parter, som dokumentet drejer sig om, eller som har en relation til dokumentet. Person og Virsomhed er de konkrete forretningsobjekter, der kan angives som part på et dokument. Person identificeres med CPR. o o o Ikke alle personer findes dog i CPR-registeret, fx udlændinge. Personer uden CPR-nummer identificeres med et erstatningsnummer. Erstatningsnummeret er typisk et lokalt tildelt identifikationsnummer. Af hensyn til identifikation er information om udstedende Organisation vigtig. Virksomhed identificeres med CVR. o o o Ikke alle virksomheder findes i CVR-registeret, fx udenlandske virksomheder. Virksomheder uden CVR identificeres med et erstatningsnummer. Erstatningsnummeret er typisk et lokalt tildelt identifikationsnummeret. Af hensyn til identifikation er information om udstedende Organisation vigtig. Part eksisterer ikke aktuelt som eksternt defineret forretningsobjekt. Part anvendes derfor her som en abstrakt betegnelse for personer og virksomheder. I diagrammet for Dokumentmodellen er det vist ved, at Peron 21
og Virksomhed er vist i diagrammet i en UML Pakke navngivet Part, og som partsrelationerne fra Dokument peger på. Betegnelse Beskrivelse Objekttype Kardinalitet Part Kopipart En eller flere Parter, der har indsendt dokumentet til myndigheden eller har modtaget dokumentet fra myndigheden. Parter, der har modtaget dokumentet fra myndigheden i kopi. Tabel 14 Beskrivelse af relationer fra Sagspart Person Virksomhed Person Virksomhed 0..1 0..1 22
Referencer i Dokumentmodellen Nedenfor er angivet, hvilke referencer der er anvendt i Dokumentmodellen: Reference Titel Link til reference [ANVISNING] [ELI] [GODPRAKSIS] Anvendelse af Dokumentobjektet i Sags- og Dokumentindekset v1.1 Easier access to European legislation with ELI God praksis for informationsmodellering, OIOdatastandardisering i sektorerne, It- og telestyrelsen 2007 https://sharekomm.kombit.dk/p089/referenced okumenter/sts%20anvisninger/an vendelse%20af%20dokumentobjek tet%20i%20sags- %20og%20Dokumentindekset%20 v1.1.zip (senest tilgået 18.12.2017) https://www.retsinformation.dk/eli (senest tilgået 16.12.2017) https://www.digst.dk/~/media/file s/arkitektur-ogdata/datastandardisering/oiostandardisering/god_praksis_for_in formationsmodellering_-_oiodatastandardisering_i_sektorerne.p df. (senest tilgået 16.12.2017) [GRUNDDATA] Modelregel 6.1 ALLE MODELENTITETER SKAL MODELLERES MED PERSISTENT, UNIK IDENTIFIKATION, Grunddatabestyrelsen 3. 01. 2014 [HTTPURI] Udkast til Retningslinjer for stabile http URIer, Styregruppen for Data og Arkitektur [KLAS] Specifikation af model for Klassifikation (Klassifikationsmodellen) [ORG] Specifikation af model for Organisation (Organisationsmodellen) [PERSON] [RFC4122] "A Universally Unique IDentifier (UUID) URN Namespace" [SAG] Specifikation af model for Sag (Sagsmodellen) [VIRKSOMHED] [XSD] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes Tabel 15 Referencer i Dokumentmodellen http://arkitekturguiden.digitaliser.d k/node/828 (senest tilgået 17.12.2017) https://arkitektur.digst.dk/node/58 8 (senest tilgået 18.01.2018) [indsættes når model er klar] [indsættes når model er klar] autoritativ kilde til Person? https://tools.ietf.org/html/rfc4122 (senest tilgået 17.12.2017) [indsættes når model er klar] autoritativ kilde til Virksomhed? https://www.w3.org/tr/xmlschem a11-2/ (senest tilgået 16.12.2017) 23
Retteblad for Dokumentmodellen version 2.0 Ændringer i "Dokumentmodellen" i forhold til "Specifikation af serviceinterface for Dokument, version 1.1.1" Afsnit i Version Nye/ændrede afsnit i Ændring Revisionshandling 1.1.1 Dokumentmodellen Indledning Revideret Afsnittet er skrevet om, så det afspejler ændringen fra specifikation af serviceinterface til specifikation af en informationsmodel Forord Udgået Afsnittet er erstattet af nyt afsnit om formål Formål med forretningsservice for Dokument Udgået Afsnittet er erstattet af nyt afsnit om formål Formål med Serviceinterface Dokument Udgået Afsnittet er erstattet af nyt afsnit om formål Formål med Dokumentmodellen Nyt Afsnittet afspejler ændringen fra specifikation af serviceinterface til specifikation af en informationsmodel Ændringer siden version 1.1.1 Nyt Afsnittet beskriver de overordnede ændringer Egenskaber for Dokumentmodellen Nyt Afsnittet beskriver de modelmæssige egenskaber ved Dokumentmodellen. Diagrammer Nyt Afsnittet beskriver, hvordan diagrammer er anvendt i beskrivelsen af Organisationsmodellen Forretningsobjekter Nyt Afsnittet beskriver, hvordan forretningsobjekter er beskrevet i modellen. Universelt unik, persistent identifikation af forretningsobjekter Nyt Afsnittet anviser retningslinjerne for unik identifikation af forretningsobjekterne i modellen. Attributter Nyt Afsnittet beskriver, hvordan attributter er beskrevet i modellen Datatyper Nyt Afsnittet præciserer, hvilke datatyper der er anvendt i modellen Mulighed for tilpasning af udfaldsrum Nyt Afsnittet præciserer, hvordan udfaldsrum i modellen kan tilpasses Relationer Nyt Afsnittet beskriver, hvordan relationer er beskrevet i modellen Begrebsliste Udgået Udgået som selvstændigt afsnit. De enkelte begreber er alle defineret som en del af modellen. Serviceinterface Dokument Dokumentmodellen Revideret Afsnittet er skrevet om, så det afspejler ændringen fra specifikation af serviceinterface til specifikation af en informationsmodel Dokument Dokumentbegrebet Revideret Afsnittet er skrevet om Beskrivelse, opbygning og struktur Diagram for Dokumentmodellen Revideret Nyt diagram for dokumentmodellen. I forhold til 1.1.1 diagrammet er det nye diagram mere detaljeret og viser modellens relationer og kardinalitet. Forretningsobjekter i Dokumentmodellen Nyt Afsnittet forklarer, hvordan forskellige objekttyper er repræsenteret i modellen. Centrale forretningsobjekter Nyt Afsnittet introducerer modellens centrale forretningsobjekter Eksternt definerede forretningsobjekter Nyt Afsnittet introducerer modellens eksternt definerede forretningsobjekter Dokumentvarianter Udgået Dokumentvariant indgår ikke længere i Dokumentmodellen. 24
Ændringer i "Dokumentmodellen" i forhold til "Specifikation af serviceinterface for Dokument, version 1.1.1" Afsnit i Version Nye/ændrede afsnit i Ændring Revisionshandling 1.1.1 Dokumentmodellen Dokumentdele Udgået Dokumentdel indgår ikke længere i Dokumentmodellen Versionering Udgået Afsnittet foreskrev at dokumenter styres bitemporalt og er udgået. Dokumenter versioneres via attributten versionidentifikator. Dokument Nyt Afsnittet beskriver dokumentobjektet Attributter Revideret Definitioner og beskrivelser for de enkelte attributter er revideret. I tabellen er titlen på kolonnen "værdisæt" ændret til "Datatype. De anvendte datatyper referer til beskrivelsen af disse i afsnittet om anvendte datatyper. I tabellen er titlen på kolonnen "obligatorisk" ændret til "Regel for udfyldelse", som giver mulighed for en mere detaljeret angivelse af reglerne for attributtens udfyldelse end den hiditige ja/nej for obligatorisk. I forhold til attributlisten i tabel 3, side 13 i version 1.1.1 er der følgende ændringer: - BrugervendtNøgle: ændret til "Dokumentnummer", der fortsat også fungerer som brugervendt nøgle. - Titel: beskrivelse ændret- Beskrivelse: beskrivelse ændret - Type: ændret til "DokumentType", liste ændret, beskrivelse ændret. - Brevdato: beskrivelse ændret. - OffentlighedUndtaget: udgået, styres af sagen. - Alternativtitel: udgået - Hjemmel: udgået. - Major: udgået, versionering styres i stedet af attributterne "Versionsnummer" og "VersionsTid". - Minor: udgået, versionering styres i stedet af attributterne "Versionsnummer" og "VersionsTid". - Kassationskode: udgået, styres på sagen. Følgende attributter er tilføjet Dokumentmodellen: - ID: var i version 1.1 del af de generelle egenskaber. - VirkningFra og VirkningTil for angivelse af dokumentets virkningsperiode. Indgik i version 1.1.1 som en del af de generelle egenskaber. - DokumentTilstand: var i version 1.1 beskrevet i objektet Tilstand som følge af de generelle egenskaber. - TilstandsDato: Følger DokumentTilstand. - Versionsnummer: til angivelse af dokumentets version. - VersionsTid: til angivelse af tidspunkt for dokumentets aktuelle 25
Ændringer i "Dokumentmodellen" i forhold til "Specifikation af serviceinterface for Dokument, version 1.1.1" Afsnit i Version 1.1.1 Nye/ændrede afsnit i Dokumentmodellen Ændring Revisionshandling version. - IndgåendeIndikator: attribut til angivelse af, om dokumentet er indgående i forhold til organisationen. Tilstande DokumentTilstand Udgået Tilstand er med bortfaldet af de generelle egenskaber ikke længere en del af en generel objektmodel. Relationer Relationer fra Dokument Revideret Titel er ændret. Afsnittet er af hensyn til overskueligheden inddelt i underafsnit i forhold til, hvilke objekter relationen går til. I forhold til listen over relationer i tabel 6, side 17 i version 1.1.1 er der følgende ændringer af relationer i Dokumentmodellen: - Arkiver: udgået. - Besvarelser: ændret til entalsformen "Besvarelse", relationen vendt, beskrivelse ændret. Relationen er beskrevet i afsnittet "relationer til andre dokumenter". - Udgangspunkter: ændret til entalsformen "Udgangspunkt", relationen vendt, beskrivelse ændret. Relationen er beskrevet i afsnittet "relationer til andre dokumenter". - NyRevision: relationen vendt, beskrivelse ændret. Relationen er beskrevet i afsnittet "relationer til andre dokumenter". - Kommentarer: ændret til entalsformen "Kommentar", relationen vendt, beskrivelse ændret. Relationen er beskrevet i afsnittet "relationer til andre dokumenter". - Bilag: relationen vendt, beskrivelse ændret. Relationen er beskrevet i afsnittet "relationer til andre dokumenter". - Andre- Dokumenter: ændret til entalsformen "AndetDokument", beskrivelse ændret. Relationen er beskrevet i afsnittet "relationer til andre dokumenter". - PrimærKlasse: beskrivelse ændret. Relationen er beskrevet i afsnittet "relationer til Klassifikation". - AndreKlasser: beskrivelse ændret. Relationen er beskrevet i afsnittet "relationer til Klassifikation". - Ejer: Relateret objekt indsnævret fra den abstrakte klasse Aktør til at skulle være en Organisation. Relationen er beskrevet i afsnittet "relationer til Organisation". - Ansvarlig: Relateret objekt indsnævret fra den abstrakte klasse Aktør til at skulle være en OrgEnhed. Relationen er beskrevet i afsnittet "relationer til Organisation". - PrimærBehandler: Relateret objekt indsnævret fra den abstrakte klasse Aktør til at skulle være en OrgEnhed 26
Ændringer i "Dokumentmodellen" i forhold til "Specifikation af serviceinterface for Dokument, version 1.1.1" Afsnit i Version 1.1.1 Nye/ændrede afsnit i Dokumentmodellen Ændring Revisionshandling eller OrgPerson. Beskrivelse ændret. Relationen er beskrevet i afsnittet "relationer til Organisation". - AndreBehandlere: Relateret objekt indsnævret fra den abstrakte klasse Aktør til at skulle være en OrgEnhed eller OrgPerson. Beskrivelse ændret. Relationen er beskrevet i afsnittet "relationer til Organisation". - FordeltTil: Udgået. - Parter: ændret til "Part", kardinalitet ændret som følge af introduktionen af Dokumentpart. Relationen er beskrevet i afsnittet "Dokumentpart". - Kopiparter: ændret til "Kopipart", kardinalitet ændret som følge af introduktionen af Dokumentpart. Relationen er beskrevet i afsnittet "Dokumentpart". - TilknyttedeSager: udgået. Relationer til andre dokumenter Nyt Afsnittet grupperer relationerne til andre dokumenter. Ændringer i relationer som også fandtes i version 1.1.1 er beskrevet under "Relationer fra Dokument". Relationer til Organisation Nyt Afsnittet grupperer relationerne til Organisation. Ændringer i relationer som også fandtes i version 1.1.1 er beskrevet under "Relationer fra Dokument". Derudover er følgende relationer tilføjet Dokumentmodellen i dette afsnit: - OprettetAf: til angivelse af den OrgPerson, der har oprettet dokumentet. - ÆndretAf: til angivelse af den OrgPerson, der har ændret dokumentet. Relationer til Klassifikation Nyt Afsnittet grupperer relationerne til Klassifikation. Ændringer i relationer som også fandtes i version 1.1.1 er beskrevet under "Relationer fra Dokument". Dokumentpart Nyt Afsnittet præsenterer Dokumentpart, som anvendes til at beskrive relationen mellem dokumentet og dets parter.ændringer i relationer som også fandtes i version 1.1.1 er beskrevet under "Relationer fra Dokument". Operationer Udgået Dokumentvariant Udgået Dokumentvariant indgår ikke længere i Dokumentmodellen. Attributter Udgået 27
Ændringer i "Dokumentmodellen" i forhold til "Specifikation af serviceinterface for Dokument, version 1.1.1" Afsnit i Version Nye/ændrede afsnit i Ændring Revisionshandling 1.1.1 Dokumentmodellen Dokumentpart Nyt Nyt afsnit som beskriver relationsobjektet Dokumentpart, der giver mulighed for en mere detaljeret beskrivelse af relationen mellem dokumentet og de personer eller virksomheder, der er dokumentparter. Attributter Nyt Attributten "Partsrolle" tilføjet. Dokumentdel Attributter Relationer Bilag 1: Struktur for input-/outputmeddelelse Bilag 2: Retteblad til version 1.1.1 Relationer til Part Nyt Relationerne "Part" og "Kopipart" findes nu her. Udgået Udgået Udgået Udgået Udgået Referencer i Dokumentmodellen Nyt Nyt afsnit med referencer i modellen. 28