FESD standardisering Udveksling Version 1.0

Transkript

1 FESD standardisering Udveksling Version 1.0

2 Kolofon: FESD standardisering. Udveksling Version 1.0 FESD udvekslingspakke Udarbejdet af IT- og Telestyrelsen, IT-strategisk kontor, FESD standardiseringsgruppen i samarbejde med de tre FESD leverandører Software Innovation A/S, Accenture I/S og CSC A/S. Denne FESD standardisering har været i offentlig høring i perioden 17. maj 2004 til 21. juni 2004 og har efterfølgende været forelagt XML-komité d. 3 november 2004 samt IT arkitektur komité d. 4 november IT- og Telestyrelsen København den 20. december Accenture I/S Lautrupsgade København Ø Telefon: Web-adresse: CSC A/S Retortvej København V Telefon: Web-adresse: Software Innovation A/S Nærum Hovedgade 10 DK-2850 Nærum Telefon: Web-adresse: Ministeriet for Videnskab, teknologi og Udvikling IT- og Telestyrelsen IT- strategisk kontor Besøgsadresse: Bredgade 40, 1260 København K National IT and Telecom Agency Ministry of Science, Technology and Innovation Holsteinsgade 63 DK-2100 København Ø Telf Fax itst@itst.dk 2

3 FESD-udvekslingspakke trin 1 XML Schema ets formål Det XML schema der beskrives i dette dokument har som mål at muliggøre : Sagsbehandling på tværs af organisationer Flytning af udvalgte opgaver mellem myndigheder Til denne første udgave har formålet været at tilvejebringe et redskab der: danner et fundament der muliggør trinvis videreudvikling af schema et sikrer let udveksling af dokumenter, med tilhørende metadata, mellem organisationer Princippet for udvekslingspakkens udformning er: 1. En eller flere delpakker sammenholder dokumentdata med dokumentets metadata. 2. Dokumentets metadata repræsenteres ved anvendelse af OIO s DokForm-standard. 3. Dokumentdata skal kunne repræsenteres på måder der opfylder de umiddelbart forventelige udvekslingsformer. Disse er: Fremsendelse af dokumenter som epost-vedhæftede filer. Fremsendelse som epost-tekst. Fremsendelse af dokumentidentifikator til brug for adgang via web service. Fremsendelse af dokumenter i binær form. Illustration af princippet for FESD-udvekslingspakken 3

4 Som illustreret på ovenstående vil FESD-udvekslingspakken kunne benytte to metoder til at opfylde princip 3 : URI er (Universal Ressource Identifier ) bruges til at referere dokumenter der ligger eksternt i forhold til udvekslingspakken. Base64-kodet udgave af dokumentet til fremsendelse i binær form. I første udgave af FESD-udvekslingspakken benyttes alene den førstnævnte metode, og vil alene omfatte epost og epost-vedhæftede dokumenter. Dette valg er begrundet i de efterfølgende afsnit. Trinvis udvikling Schema et er udarbejdet som led i FESD-standardiseringsarbejdet og vil til stadighed blive opdateret og videreudviklet i takt med at FESD-standarden bliver fastlagt og implementeret. FESDstandardiseringsarbejdet kan altså i sig selv begrunde en trinvis udvikling. En anden, men lige så vigtig en faktor, er hensynet til eksisterende ESDH-systemers omstillingsevne, samt omkostninger ved radikale ændringer af implementerede løsninger. FESD-standardiseringsgruppens har derfor ønsket at sikre klarhed og forudsigelighed i så høj grad som muligt, kombineret med strukturel fleksibilitet og størst mulig åbenhed overfor kommende tilføjelser. Af denne årsag præsenteres schema et i dette dokument både i sin første version, kaldet trin 1, og i sin potentielle anden version, kaldet trin 2. Ved at præsentere modellen på denne måde er det håbet at der kan skabes forståelse for perspektiverne, samtidigt med at der skabes accept af den nuværende løsning. Modellen sikrer at der arbejdes hen imod trin 2 og at implementering af trin 1 gøres lettest muligt for markedets ESDH-leverandører. Udveksling af dokumenter Udveksling af elektroniske dokumenter foretages i dag i vid udstrækning via epost, men uden vedhæftede metadata. I denne første version, trin 1, fastholdes de velkendte epost-rutiner, men udvides ved at tilføje dokumenternes metadata indpakket i DokForm-formatet. Hver dokumentreference og dets tilhørende DokForm-metadata indkapsles samlet, som illustreret nedenfor. Scema ets enkelte elementer gennemgås i den efterfølgende tekst. Til epost-udveksling kan de produkter anvendes der er i overensstemmelse med en eller flere af de i Refenceprofilen beskrevne grænseflader, hvis disse har status som Anbefalet, Godkendt eller De Facto. Regler for anvendelse Regel 1: Ved fremsending med epost vedhæftes et og kun et xml-dokument udformet efter nærværende definition og navngivet : fesdpacket.xml. 4

5 Regel 2: fesdpacket-dokumentet beskriver en eller flere af følgende dele: de med eposten medsendte øvrige dokumenter epostens egen tekst Regel 3: De dokumenter der beskrives i fesdpacket-dokumentet skal være unikt navngivet indenfor den sammenhæng de fremsendes. Schema-beskrivelse til FESD-udvekslingspakkens trin 1 En samlet gengivelse af FESDpacket.xsd findes i Bilag 1 - Schema til FESD-udvekslingspakke trin 1. Elementet FESDpacket FESDpacket er rod-elementet. FESDpacket indeholder kun et element, elementet PacketPart. Noter at der kan være fra et til uendeligt antal PacketPart -elementer. Elementets definition: <xs:element name="fesdpacket"> <xs:documentation> FESD-udvekslings-pakke indeholdende sagselementer. </xs:documentation> <xs:sequence> <xs:element ref="fesd:packetpart" maxoccurs="unbounded"/> </xs:sequence> Elementet PacketPart 5

6 Et PacketPart -element indeholder altid et element der beskriver metadata for PacketParts andet element. Det andet element i PacketPart er, i denne version, et dokument-element, Document. Denne samling af elementerne sikrer korrespondance mellem et dokument og den DokFormbeskrivelse der er relateret dertil. Dokument-elementet beskrives efterfølgende. I ét tilfælde vil der kunne være behov for at anvende PacketPart-elementet indeholde flere instancer af Document-elementet: Når flere dokumenter, i afsendende ESDH-system, alle har samme DokForm-metadata. PacketPart kan i dette tilfælde samle elementerne og sammenkobler et sæt DokForm-data med flere dokumenter. Elementets definition: <xs:element name="packetpart"> <xs:documentation> Indeholder et dokument, samt tilhørende DokForm-metadata. </xs:documentation> <xs:sequence> <xs:element ref="dkfm:metadata"/> <xs:element ref="fesd:document" maxoccurs="unbounded"/> </xs:sequence> Elementet dkfm:metadata Dette element indeholder DokForm-data. For en beskrivelse af DokForm henvises til DokFormgruppens hjemmeside og Infostrukturbasen 6

7 Elementet Document Document-elementet anvendes i denne version alene som bærer af en reference til et, i forhold til XML Schema et, eksternt dokument ved hjælp af URI-attributten exdocid. <xs:attribute name="exdocid" type="xs:anyuri" use="requiredoptional"/> Elementets definition: <xs:element name="document"> <xs:documentation> Dokument-element. </xs:documentation> <xs:attribute name="exdocid" type="xs:anyuri" use="optional"/> Eksempel 1: exdocid attributten gør det eksempelvis muligt at referere entydigt til dokumenter der er fremsendt vedhæftet en epost. I eksempelet er en epost vedhæftet to dokumenter, navngivet Rapport#5678.pdf og Notat doc, og xml-dokumentet fesdpacket.xml. Modtageren får via fesdpacket.xml både en præcis henvisning til dokumenterne og får deres relaterede metadata (i dkfm:metadata-elementet), som illustreret nedenfor. 7

8 Indhold af fesdpacket.xml fra ovenstående eksempel <?xml version="1.0" encoding="utf-8"?> <FESDpacket xmlns=" xmlns:dc=" xmlns:dcterms=" xmlns:dkfm=" xsi:schemalocation=" "> <PacketPart> <dkfm:metadata> <dc:creator> Hanne H. Hansen </dc:creator>... <dkfm:owner scheme="cprautoritetsliste"> Ministeriet </dkfm:owner> </dkfm:metadata> <Document exdocid=../notat doc /> </PacketPart> <PacketPart> <dkfm:metadata>...</dkfm:metadata> <Document exdocid=../rapport_#5678.pdf /> </PacketPart> </FESDpacket> Ønsker fremsenderen af eposten at medsende metadata om selve epostteksten refereres denne således: <PacketPart> <dkfm:metadata> </dkfm:metadata> <Document exdocid=.. /> </PacketPart> Schema-beskrivelse til FESD-udvekslingspakkens trin 2 I denne version kan FESD-udvekslingspakken anvendes både ved SMTP-, HTTP- og TCPtransport, med fuld indkapsling og medsendelse af dokumenter og med anvendelse af digitale signature. Pakken udgøres af rodelementet FESDpacket og elementerne Case, Document, DocumentList og Encoding, samt metadata fra DKFM_Metadata1 schemaet og Signature fra XML Signature schemaet. 8

9 En global ID-attribut, elementid, indføres. Elementerne fra FESDpacket-namespace et præfikses med :fesd. Elementerne fra DKFM_metadata1-namespace et præfikses med :dkfm. Elemeterne fra XML Signature schemaet præfikses med :ds. Nedenstående illustration viser de omtalte elementer og deres indbyrdes sammenhæng. Attributten elementid Til brug for XML Signature indføres en global attribut der anvendes af alle fesd:-elementerne. Attributtens definition: <xs:attribute name="elementid" type="xs:id" use="optional"> <xs:documentation> Global attribut til ID-angivelse </xs:documentation> </xs:attribute> Elementet FESDpacket FESDpacket indeholder to elementer, elementet PacketPart og elementet ds:signature. Disse to elementer indeholder pakkens øvrige elementer. For det samlede indhold af FESDpacket gælder: Alle pakkens elementer bør udgøre et samlet hele eller en delmængde af et samlet hele. Pakken bør med andre ord ikke indeholde flere sager eller flere dokumenter hvis disse ikke har indbyrdes logiske og funktionelle relationer. 9

10 Alle pakkens elementer skal kunne underlægges samme adgangs- og sikkerhedskrav. Alle pakkens elementer er rettet til samme modtager eller gruppe af modtagere. Alle pakkens elementer er forsynet med attributten elementid. Anvendelse af XML Signature er teknisk set valgfrit, men er i praksis reguleret af organisationens sikkerhedsinstrukser. Elementets definition: <xs:element name="fesdpacket"> <xs:documentation> FESD-udvekslingspakke indeholdende sagselementer. </xs:documentation> <xs:sequence> <xs:element ref="fesd:packetpart" maxoccurs="unbounded"/> <xs:element ref="ds:signature" minoccurs="0" maxoccurs="unbounded"/> </xs:sequence> Elementet PacketPart Et PacketPart -element indeholder to elementer: Et element der beskriver enkelt-objekter, det vil sige en sag, et dokument, en part, en aktivitet og så videre. Et element der beskriver metadata for ovenstående elements indhold. Bemærk at der ikke samtidigt kan eksistere et Case - og et Document -element i PacketPart. Elementets definition: <xs:element name="packetpart"> <xs:documentation>indeholder enten en sag eller et dokument, samt tilhørende DokForm-metadata.</xs:documentation> 10

11 <xs:sequence> <xs:element ref="dkfm:metadata"/> <xs:choice> <xs:element ref="fesd:case"/> <xs:element ref="fesd:document"/> </xs:choice> </xs:sequence> <xs:attribute ref="fesd:elementid"/> Elementet Case Indholdet af Case mangler definition indtil videre. Optræder i dette udkast alene som illustrerende pladsholder, men vil i takt med FESD-standardarbejdet få tilføjet elementer der reflekterer FESDstandarden. Elementets definition: <xs:element name="case"> <xs:documentation>sagselement.</xs:documentation> <xs:attribute name="elementid" type="xs:id" use="optional"/> Elementet Document Document -elementet indeholder nul eller flere Encoding -elementer der tilsammen udgør et dokument eller en fil. Document bør primært anvendes som container til medsendelse af dokumenter og filer ved anvendelse af Encoding-elementet, men giver også mulighed for at referere et dokument ved URIattributten exdocid. I forhold til trin 1 -modellen ændres exdocid til at være optional. 11

12 <xs:attribute name="exdocid" type="xs:anyuri" use="optional"/> Elementets definition: <xs:element name="document"> <xs:documentation>dokument-element.</xs:documentation> <xs:sequence> <xs:element ref="encoding" minoccurs= 0 maxoccurs="unbounded"/> </xs:sequence> <xs:attribute name="exdocid" type="xs:anyuri" use="optional"/> <xs:attribute ref="elementid" type="xs:id" use="optional"/> Elementet Encoding Encoding -elementet indholder en base-64 -kodet udgave af en fil. Base-64-versionen af filen er i gennemsnit 33% større end den originale fil. Elementet vil kunne anvendes både i Document -elementet og i andre elementer hvor filer ønskes medsendt. Elementets definition: <xs:element name="encoding"> <xs:documentation> Fil relateret til 'Document'elementet i base-64-kodet form. </xs:documentation> <xs:simplecontent> <xs:extension base="xs:base64binary"> <xs:attribute name="elementid" type="xs:id" use="optional"/> </xs:extension> </xs:simplecontent> 12

13 Elementet ds:signature I FESDpacket anvendes XML Signature (xmldsig) til at påføre digitale signature til relevante dele af pakkens indhold. Den fulde beskrivelse af xmldsig ligger udenfor dette dokuments formål og kan findes på FESDpacket tillader et ubegrænset antal personer at signere indhold. Signatur kan påføres såvel FESDpacket-elementer som eksterne dokumenter. Til FESDpacketelementer anvendes xmldsig-elementet ds:reference som illustreret efterfølgende. Eksempel Resultatet af en base64-encoding på et dokument er repræsenteret i Encoding-elementet med den tildelte elementid Dok <Encoding elementid= Dok-4711 >.. pn3j2oec0+/kcatpvy1dyfg1g68.. </Encoding> ds:reference-attributen URI sættes til at pege på det element der ønskes signeret, og digestværdien for Encoding-elementet beregnes og indsættes i elementet ds:digestvalue. <ds:reference URI="#Dok-4711"> <ds:digestmethod Algorithm=" <ds:digestvalue> </ds:reference> HB7i8RaV7ZvuUlaTzZVx0S3POpU=</ds:DigestValue> På tilsvarende måde kan dokumenter der ligger eksternt i forhold til FESDpacket-dokumentet signeres individuelt. 13

14 Mulige udvidelser af FESDpacket trin 2 Som yderligere illustration af forslagets anvendelighed følger her et udvalg af udvidelsesmuligheder for pakken. Udvidelse af Document Allerede ved modtagelse af et base64-encoded dokument kan der være behov eller ønske om at kende filtypen. Dette behov kunne søges løst ved at indføre attributten mimetype (se nedenstående definition). <xs:element name="document"> <xs:documentation>dokument-element.</xs:documentation> <xs:sequence> <xs:element ref="encoding" minoccurs= 0 maxoccurs="unbounded"/> </xs:sequence> <xs:attribute name="exdocid" type="xs:anyuri" use="optional"/> <xs:attribute name="elementid" type="xs:id" use="optional"/> <xs:attribute name="mimetype" use="optional"> <xs:simpletype> <xs:restriction base="xs:string"> <xs:enumeration value="text/plain"/> <xs:enumeration value="text/html"/> <xs:enumeration value="text/xml"/> <xs:enumeration value="multipart/mixed"/> <xs:enumeration value="message/rfc822"/> <xs:enumeration value="application/postscript"/> <xs:enumeration value="application/rtf"/> <xs:enumeration value="application/pdf"/> <xs:enumeration value="application/msword"/> <xs:enumeration value="image/jpeg"/> <xs:enumeration value="image/png"/> <xs:enumeration value="video/mpeg"/> </xs:restriction> </xs:simpletype> </xs:attribute> Denne anvendelse af MIME er dog ikke problemfri. Opdateringen af MIME-type-listen har historisk set været sporadisk og ufuldstændig. 14

15 En MIME-type kan definere flere udviklingsversioner af samme filtype, eksempelvis filer fra Microsoft Word. Der bør derfor søges andre standardiserede løsninger for at kunne beskrive dokumentformat og version entydigt. Modtager og afsender-information DokForm-standardens elementer for modtager og afsender kan med fordel indsættes på niveau med PacketPart, jævnfør den tidligere angivne betingelse: Alle pakkens elementer er rettet til samme modtager eller gruppe af modtagere Indhold til Case -elementet Under Case placeres de elementer der beskriver sagen (i form af sagsdata) og samlinger af sagsdele (lister). Eksempler på samlinger er: Aktivitetsliste Partsliste 15

16 Bilag 1 Schema til FESD-udvekslingspakke trin 1 <?xml version="1.0" encoding="utf-8"?> <xs:schema targetnamespace=" xmlns:fesd=" xmlns:xs=" xmlns:dkfm=" xmlns:dcterms=" xmlns:dc=" xmlns:ds=" elementformdefault="qualified" attributeformdefault="unqualified"> <xs:import namespace=" schemalocation=" <xs:element name="fesdpacket"> <xs:documentation>fesd-udvekslingspakke.</xs:documentation> <xs:sequence> <xs:element ref="fesd:packetpart" maxoccurs="unbounded"/> </xs:sequence> <xs:element name="packetpart"> <xs:documentation> Indeholder et dokument, samt tilhørende DokForm-metadata. </xs:documentation> <xs:sequence> <xs:element ref="dkfm:metadata"/> <xs:element ref="fesd:document" maxoccurs="unbounded"/> </xs:sequence> <xs:element name="document"> <xs:documentation>dokument-element.</xs:documentation> 16

17 <xs:attribute name="exdocid" type="xs:anyuri" use="required"/> </xs:schema> 17