Alla olevissa taulukoissa esitetään esimerkkejä Kansallisarkiston metadatakatalogin mukaan normalisoiduista siirtopakettia kuvailevista kontekstimetatiedoista. Kontekstimetatiedot toimitetaan osana Sapan rajapinnalle lähetettävää luontisanomaa - yksi rajapintapyyntö siirtoerään sisältyvää siirtopakettia kohti.
Kontekstimetatieto tulee asettaa osaksi sanomaa siten, että “metadata”-avaimen arvo on tulkittavissa validina JSON-tekstinä. Elementtien järjestyksellä sanoman sisällä ei ole merkitystä, näissä esimerkeissä arvot ovat avaimen mukaan aakkosjärjestyksessä.
Jos tietoaineiston käyttöön liittyy rajoituksia, näistä tulee aina antaa sekä rajoituspohjan että tietoaineiston käyttöluvan myöntäjän tunnisteet. Rajoitukset esitetään elementillä “access_restrictions” JSON-listana siten, että alkioiden tyyppi on JSON-objekti, joka puolestaan koostuu avain-arvo-pareista ”template_identifier”: “id-value” ja “authorizing_entity”: “uuid-value”.
Tietoaineiston kieli “languages” tulee myös aina esittää JSON-listana (array), jonka alkiot ovat metadatakatalogin UUID-arvoja tekstinä. Jos tietoaineiston sisällössä on käytetty useita kieliä, tulee näiden tunnisteet erottaa toisistaan pilkulla.
Näille siirtorakenteille käytetään yhtenäistä kontekstimetatietorakennetta, jota on havainnollistettu alla olevissa esimerkeissä. Pakolliset minimimetatiedot, jotka tulee antaa jokaiselle siirtopaketille, ovat:
Tietoaineistoa kuvaava nimeke l. päänimeke
Sisällön luonne (arkisto-/säilytysvaihe)
Tietoaineiston omistava organisaatio
Henkilötietoluonne
Turvallisuusluokka (pakollinen myös ei-turvallisuusluokitellulle tietoaineistolle)
Julkisuusluokka
| |
---|
JSON
{
"confidentiality_class": "9d204813-6ba0-3a8c-81ef-7516c6ef4a41",
"content_category": "abe893c6-ead3-3d5b-a3d6-9985f73fb9d7",
"owner_organization": "101498744",
"personal_data": "a3c39071-e76c-30d0-8218-44841fe63097",
"security_class_2020": "7b74c211-f2ba-3db4-809d-0c3714817d36",
"title_main": "Esimerkki - julkinen asia/arkistoyksikkö"
}
|
TEXT
Metatieto | Selite | UUID/Tunniste Metadatakatalogista
----------------------|-----------------------------------|-------------------------------------
Julkisuusluokka | Julkinen | 9d204813-6ba0-3a8c-81ef-7516c6ef4a41
Sisällön luonne | Viranomaisaineisto-arkistovaihe | abe893c6-ead3-3d5b-a3d6-9985f73fb9d7
Omistaja | Kansallisarkisto | 101498744
Henkilötietoluonne | Ei sisällä henkilötietoja | a3c39071-e76c-30d0-8218-44841fe63097
Turvallisuusluokka | Ei turvallisuusluokiteltu | 7b74c211-f2ba-3db4-809d-0c3714817d36
Aineiston nimeke | (vapaa teksti, max 255 merkkiä) |
|
| |
---|
JSON
{
"access_restrictions": [{
"template_identifier": "100004772",
"authorizing_entity": "101498744" }],
"confidentiality_class": "a8abde9b-b3f9-3818-ac00-c38758c11cfb",
"content_category": "abe893c6-ead3-3d5b-a3d6-9985f73fb9d7",
"owner_organization": "101498744",
"personal_data": "a3c39071-e76c-30d0-8218-44841fe63097",
"security_class_2020": "7b74c211-f2ba-3db4-809d-0c3714817d36",
"title_main": "Esimerkki - käyttörajoitettu aineisto"
}
|
TEXT
Metatieto | Selite | UUID/Tunniste Metadatakatalogista
----------------------|-----------------------------------|-------------------------------------
Käyttörajoitus | Ampuma-aseL 113 § 2 mom | 100004772
Käyttöluvan myöntäjä | Kansallisarkisto | 101498744
Julkisuusluokka | Salassa pidettävä | a8abde9b-b3f9-3818-ac00-c38758c11cfb
Sisällön luonne | Viranomaisaineisto-arkistovaihe | abe893c6-ead3-3d5b-a3d6-9985f73fb9d7
Omistaja | Kansallisarkisto | 101498744
Henkilötietoluonne | Ei sisällä henkilötietoja | a3c39071-e76c-30d0-8218-44841fe63097
Turvallisuusluokka | Ei turvallisuusluokiteltu | 7b74c211-f2ba-3db4-809d-0c3714817d36
Aineiston nimeke | (vapaa teksti, max 255 merkkiä) |
|
| |
---|
JSON
{
"access_restrictions": [
{ "template_identifier": "100932278",
"authorizing_entity": "467261231" },
{ "template_identifier": "100932886",
"authorizing_entity": "467261231" }],
"confidentiality_class": "a8abde9b-b3f9-3818-ac00-c38758c11cfb",
"content_category": "86275d94-f1ca-3a9c-877c-3c79b4ba23ef",
"languages": ["d3ee87b7-4948-3873-9a77-07d7672d4526"]
"owner_organization": "467261231",
"personal_data": "c987d8fb-22f4-37eb-9c78-e1cc4e7e534a",
"security_class_2020": "7b74c211-f2ba-3db4-809d-0c3714817d36",
"title_main": "Esimerkki - käyttörajoitettu tietoaineisto"
}
|
TEXT
Metatieto | Selite | UUID/Tunniste Metadatakatalogista
----------------------|-----------------------------------|-------------------------------------
Käyttörajoitus | JulkL 24 § 1 mom 30 | 100932278
Käyttöluvan myöntäjä | Keskustan ja Maaseudun arkisto | 467261231
Käyttörajoitus | JulkL 16 § 3 mom | 100932886
Käyttöluvan myöntäjä | Keskustan ja Maaseudun arkisto | 467261231
Julkisuusluokka | Salassa pidettävä | a8abde9b-b3f9-3818-ac00-c38758c11cfb
Sisällön luonne | Viranomaisaineisto-säilytysvaihe | 86275d94-f1ca-3a9c-877c-3c79b4ba23ef
Tietoaineiston kieli | Suomi | d3ee87b7-4948-3873-9a77-07d7672d4526
Omistaja | Keskustan ja Maaseudun arkisto | 467261231
Henkilötietoluonne | Sisältää henkilötietoja | c987d8fb-22f4-37eb-9c78-e1cc4e7e534a
Turvallisuusluokka | Ei turvallisuusluokiteltu | 7b74c211-f2ba-3db4-809d-0c3714817d36
Aineiston nimeke | (vapaa teksti, max 255 merkkiä) |
|
| |
---|
JSON
{
"access_restrictions": [
{ "template_identifier": "100932886",
"authorizing_entity": "101498744" },
{ "template_identifier": "100025355",
"authorizing_entity": "101498744" }],
"confidentiality_class": "a8abde9b-b3f9-3818-ac00-c38758c11cfb",
"content_category": "abe893c6-ead3-3d5b-a3d6-9985f73fb9d7",
"content_dates_start": "2004-05-01",
"content_dates_end": "2008-11-29",
"content_type": "1abeea90-08a9-352a-9787-1ce86c6d7cbc",
"description": "Tiivis, vapaamuotoinen kuvaus aineiston sisällöstä.",
"description_language": "d3ee87b7-4948-3873-9a77-07d7672d4526",
"identifier_local": "generoitu_siirto_0001",
"languages": [ "d3ee87b7-4948-3873-9a77-07d7672d4526",
"845a0da1-eda1-3d87-b012-3bf93dea7a32" ],
"owner_organization": "101498744",
"personal_data": "c987d8fb-22f4-37eb-9c78-e1cc4e7e534a",
"processing_aids": "Sanallisesti kuvattuna aineiston hakuvälineet.",
"processing_notes": "Sanallisesti kuvattuna aineiston käyttöohjeet.",
"related_preserved_content": "Muualla hallinnoitavat aineistot.",
"security_class_2020": "7b74c211-f2ba-3db4-809d-0c3714817d36",
"signature_description": "Kuvaus aineiston syntyhistoriasta.",
"title_main": "Esimerkki - Kaikki sallitut tiedot, useita rajoituksia",
"title_start": "Aa",
"title_end": "Ff",
"title_type": "436ec6f9-d810-3a40-812b-7c4ee4898abb",
"title_description": "Henkilöiden sukunimet"
}
|
TEXT
Metatieto | Selite | UUID/Tunniste Metadatakatalogista
----------------------|-----------------------------------|-------------------------------------
Käyttörajoitus | JulkL 16 § 3 mom | 100932886
Käyttöluvan myöntäjä | Kansallisarkisto | 101498744
Käyttörajoitus | JulkL 24 § 1 mom 20 | 100025355
Käyttöluvan myöntäjä | Kansallisarkisto | 101498744
Julkisuusluokka | Salassa pidettävä | a8abde9b-b3f9-3818-ac00-c38758c11cfb
Sisällön luonne | Viranomaisaineisto-arkistovaihe | abe893c6-ead3-3d5b-a3d6-9985f73fb9d7
Ajall. katt. alku | 1.5.2004 |
Ajall. katt. loppu | 29.11.2008 |
Aineiston tyyppi | Teksti | 1abeea90-08a9-352a-9787-1ce86c6d7cbc
Tietosisältö | (vapaa teksti, max. 5000 merkkiä) |
Kuvailun kieli | Suomi | d3ee87b7-4948-3873-9a77-07d7672d4526
Yksilöivä tunniste | (vapaa teksti) |
Tietoaineiston kieli | Suomi | d3ee87b7-4948-3873-9a77-07d7672d4526 |
Tietoaineiston kieli | Ruotsi | 845a0da1-eda1-3d87-b012-3bf93dea7a32
Omistaja | Kansallisarkisto | 101498744
Henkilötietoluonne | Sisältää henkilötietoja | a3c39071-e76c-30d0-8218-44841fe63097
Hakuvälineet | (vapaa teksti, max. 5000 merkkiä) |
Käyttöohjeet | (vapaa teksti, max. 5000 merkkiä) |
Liittyvät aineistot | (vapaa teksti, max. 5000 merkkiä) |
Turvallisuusluokka | Ei turvallisuusluokiteltu | 7b74c211-f2ba-3db4-809d-0c3714817d36
Syntyhistoria | (vapaa teksti, max. 5000 merkkiä) |
Aineiston nimeke | (vapaa teksti, max. 255 merkkiä) |
Tarkenteen alku | (vapaa teksti, max. 512 merkkiä) |
Tarkenteen loppu | (vapaa teksti, max. 512 merkkiä) |
Tarkenteen tyyppi | Aakkosellinen | 436ec6f9-d810-3a40-812b-7c4ee4898abb
Tarkenteen selite | (vapaa teksti, max. 5000 merkkiä) |
|
Sähke2-siirtorakenne eroaa merkittävästi muista vastaanotettavista rakenteista. Tässä tapauksessa asioita ja asiakirjoja kuvaavat tiedot tuotetaan asianhallintajärjestelmässä ja esitetään sahke.xml- ja sahke_norm.xml-tiedostoissa. Sapa-järjestelmä parsii edellisessä luvussa esitettyjä kontekstimetatietoja vastaavat tiedot suoraan näistä tiedostoista siirtopaketin käsittelyn yhteydessä.
Vasemmassa sarakkeessa esitetään asianhallintajärjestelmän tuottamaa Sähke2-suosituksen mukaista tietoa, oikeassa niitä vastaavat tiedot tarpeellisin osin koneluettaviksi muunnettuina. Lähtökohtaisesti tiedostojen tulisi olla identtisiä kaikilta muilta osin paitsi:
| Normalisoitu sahke_norm.xml |
---|
XML
<?xml version="1.0" encoding="UTF-8"?>
<!-- Esimerkki sahke_norm.xml-tiedoston arvoista kommenttiblokissa:
authorizing_entity: Kansallisarkisto
owner_organization: Kansallisarkisto
description_language: Suomi
content_category: Viranomaisaineisto-arkistovaihe
otherid_casefile: Diaarinumero
otherid_record: Muu tunniste
-->
<s2:Metadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:s2="http://www.arkisto.fi/skeemat/Sahke2/2019/08/29"
xsi:schemaLocation="http://www.arkisto.fi/skeemat/Sahke2/2019/08/29 http://www.arkisto.fi/skeemat/Sahke2_2019_03.xsd">
<s2:TransferInformation>
<s2:NativeId>urn:oid:1.2.246.582.200.10012024.1</s2:NativeId>
<s2:Title>SAPA-testisiirto</s2:Title>
<s2:TransferContractId>10012024</s2:TransferContractId>
<s2:MetadataSchema>http://www.arkisto.fi/skeemat/Sahke2_2019_03.xsd</s2:MetadataSchema>
</s2:TransferInformation>
<s2:ContactInformation>
<s2:Organisation>
<s2:Name>Kansallisarkisto</s2:Name>
</s2:Organisation>
<s2:ContactPerson>
<s2:Name>SAPA-tuotetiimi</s2:Name>
<s2:Address>Rauhankatu 17</s2:Address>
<s2:PhoneNumber>000</s2:PhoneNumber>
<s2:Email>etunimi.sukunimi@kansallisarkisto.fi</s2:Email>
</s2:ContactPerson>
</s2:ContactInformation>
<s2:CaseFile>
<s2:Subject>Asiaan liittyvät asiasanat</s2:Subject>
<s2:Created>2024-05-24</s2:Created>
<s2:NativeId>urn:oid:1.2.246.582.200.10012024.1.1</s2:NativeId>
<s2:OtherId>KA/1/00.00.00/2024</s2:OtherId>
<s2:Language>fi</s2:Language>
<s2:Description>Laajempi kuvaus käsiteltävästä asiasta</s2:Description>
<s2:Abstract>Suppea kuvaus asiasta</s2:Abstract>
<s2:Restriction>
<s2:PublicityClass>Julkinen</s2:PublicityClass>
<s2:PersonalData>ei sisällä henkilötietoja</s2:PersonalData>
</s2:Restriction>
<s2:Title>Testiasia 1</s2:Title>
<s2:RetentionPeriod>-1</s2:RetentionPeriod>
<s2:RetentionReason>...</s2:RetentionReason>
<s2:Status>Valmis</s2:Status>
<s2:ClassificationScheme>
<s2:MainFunction>
<s2:Title>Yhteiset asiat</s2:Title>
<s2:FunctionCode>00</s2:FunctionCode>
<s2:FunctionClassification>
<s2:Title>Tietojärjestelmän testaus</s2:Title>
<s2:FunctionCode>00</s2:FunctionCode>
<s2:SubFunction>
<s2:Title>SAPA-testaus</s2:Title>
<s2:FunctionCode>00</s2:FunctionCode>
</s2:SubFunction>
</s2:FunctionClassification>
</s2:MainFunction>
</s2:ClassificationScheme>
<s2:Function>00.00.00</s2:Function>
<s2:Finished>2024-05-24</s2:Finished>
<s2:Action>
<s2:Created>2024-05-24</s2:Created>
<s2:Title>Käyttöliittymätestaus</s2:Title>
<s2:Type>Lähtevä</s2:Type>
<s2:Record>
<s2:Subject>Asiakirjaa koskevat asiasanat (toistettava)</s2:Subject>
<s2:Created>2024-05-24</s2:Created>
<s2:NativeId>urn:oid:1.2.246.582.200.10012024.1.1.1</s2:NativeId>
<s2:OtherId>11.404</s2:OtherId>
<s2:Language>fi</s2:Language>
<s2:Language>en</s2:Language>
<s2:Description>Laajempi kuvaus asiakirjan sisällöstä</s2:Description>
<s2:Abstract>Suppea kuvaus asiakirjasta</s2:Abstract>
<s2:Restriction>
<s2:PublicityClass>Salassa pidettävä</s2:PublicityClass>
<s2:SecurityReason>Julkisuuslain 24 § 1 mom 25</s2:SecurityReason>
<s2:PersonalData>sisältää erityisiä henkilötietoryhmiä</s2:PersonalData>
</s2:Restriction>
<s2:Title>Testiasiakirja 1.1</s2:Title>
<s2:RetentionPeriod>-1</s2:RetentionPeriod>
<s2:RetentionReason>...</s2:RetentionReason>
<s2:Status>Valmis</s2:Status>
<s2:Function>00.00.00</s2:Function>
<s2:Type>Dokumentti</s2:Type>
<s2:Accepted>2024-05-24</s2:Accepted>
<s2:Authenticity>
<s2:Checker>SAPA-tuotetiimi</s2:Checker>
<s2:Date>2024-05-24</s2:Date>
<s2:Description>Alkuperäisyys todettu</s2:Description>
</s2:Authenticity>
<s2:Document>
<s2:NativeId>urn:oid:1.2.246.582.200.10012024.1.1.1.1</s2:NativeId>
<s2:UseType>Arkisto</s2:UseType>
<s2:File>
<s2:Name>DOC0001.pdf</s2:Name>
<s2:Path>cf_01/rec_01/DOC0001.pdf</s2:Path>
</s2:File>
<s2:Format>
<s2:Name>PDF</s2:Name>
<s2:Version>1</s2:Version>
</s2:Format>
<s2:HashAlgorithm>MD5</s2:HashAlgorithm>
<s2:HashValue>ad8f19e739182b212a85c13203971730</s2:HashValue>
</s2:Document>
<s2:Custom>
<muutunniste>Organisaation sisäinen muu tunniste</muutunniste>
<muutieto>Organisaation muu sisäinen lisätieto</muutieto>
</s2:Custom>
</s2:Record>
</s2:Action>
<s2:Custom>
<muutunniste>Organisaation sisäinen muu tunniste</muutunniste>
<muutieto>Organisaation muu sisäinen lisätieto</muutieto>
</s2:Custom>
</s2:CaseFile>
</s2:Metadata>
|
XML
<?xml version="1.0" encoding="UTF-8"?>
<!--
authorizing_entity: 101498744
owner_organization: 101498744
description_language: d3ee87b7-4948-3873-9a77-07d7672d4526
content_category: abe893c6-ead3-3d5b-a3d6-9985f73fb9d7
otherid_casefile: a3ed4df4-43c0-3821-92a1-92eaca76e75d
otherid_record: 03258c27-145b-39bb-91ae-805987926387
-->
<s2:Metadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:s2="http://www.arkisto.fi/skeemat/Sahke2/2019/08/29"
xsi:schemaLocation="http://www.arkisto.fi/skeemat/Sahke2/2019/08/29 http://www.arkisto.fi/skeemat/Sahke2_2019_03.xsd">
<s2:TransferInformation>
<s2:NativeId>urn:oid:1.2.246.582.200.10012024.1</s2:NativeId>
<s2:Title>SAPA-testisiirto</s2:Title>
<s2:TransferContractId>10012024</s2:TransferContractId>
<s2:MetadataSchema>http://www.arkisto.fi/skeemat/Sahke2_2019_03.xsd</s2:MetadataSchema>
</s2:TransferInformation>
<s2:ContactInformation>
<s2:Organisation>
<s2:Name>Kansallisarkisto</s2:Name>
</s2:Organisation>
<s2:ContactPerson>
<s2:Name>SAPA-tuotetiimi</s2:Name>
<s2:Address>Rauhankatu 17</s2:Address>
<s2:PhoneNumber>000</s2:PhoneNumber>
<s2:Email>etunimi.sukunimi@kansallisarkisto.fi</s2:Email>
</s2:ContactPerson>
</s2:ContactInformation>
<s2:CaseFile>
<s2:Subject>Asiaan liittyvät asiasanat</s2:Subject>
<s2:Created>2024-05-24</s2:Created>
<s2:NativeId>urn:oid:1.2.246.582.200.10012024.1.1</s2:NativeId>
<s2:OtherId>KA/1/00.00.00/2024</s2:OtherId>
<s2:Language>fi</s2:Language>
<s2:Description>Laajempi kuvaus käsiteltävästä asiasta</s2:Description>
<s2:Abstract>Suppea kuvaus asiasta</s2:Abstract>
<s2:Restriction>
<s2:PublicityClass>Julkinen</s2:PublicityClass>
<s2:PersonalData>ei sisällä henkilötietoja</s2:PersonalData>
</s2:Restriction>
<s2:Title>Testiasia 1</s2:Title>
<s2:RetentionPeriod>-1</s2:RetentionPeriod>
<s2:RetentionReason>...</s2:RetentionReason>
<s2:Status>Valmis</s2:Status>
<s2:ClassificationScheme>
<s2:MainFunction>
<s2:Title>Yhteiset asiat</s2:Title>
<s2:FunctionCode>00</s2:FunctionCode>
<s2:FunctionClassification>
<s2:Title>Tietojärjestelmän testaus</s2:Title>
<s2:FunctionCode>00</s2:FunctionCode>
<s2:SubFunction>
<s2:Title>SAPA-testaus</s2:Title>
<s2:FunctionCode>00</s2:FunctionCode>
</s2:SubFunction>
</s2:FunctionClassification>
</s2:MainFunction>
</s2:ClassificationScheme>
<s2:Function>00.00.00</s2:Function>
<s2:Finished>2024-05-24</s2:Finished>
<s2:Action>
<s2:Created>2024-05-24</s2:Created>
<s2:Title>Käyttöliittymätestaus</s2:Title>
<s2:Type>Lähtevä</s2:Type>
<s2:Record>
<s2:Subject>Asiakirjaa koskevat asiasanat (toistettava)</s2:Subject>
<s2:Created>2024-05-24</s2:Created>
<s2:NativeId>urn:oid:1.2.246.582.200.10012024.1.1.1</s2:NativeId>
<s2:OtherId>11.404</s2:OtherId>
<s2:Language>fi</s2:Language>
<s2:Language>en</s2:Language>
<s2:Description>Laajempi kuvaus asiakirjan sisällöstä</s2:Description>
<s2:Abstract>Suppea kuvaus asiakirjasta</s2:Abstract>
<s2:Restriction>
<s2:PublicityClass>Salassa pidettävä</s2:PublicityClass>
<s2:SecurityReason>100074484</s2:SecurityReason>
<s2:PersonalData>sisältää erityisiä henkilötietoryhmiä</s2:PersonalData>
</s2:Restriction>
<s2:Title>Testiasiakirja 1.1</s2:Title>
<s2:RetentionPeriod>-1</s2:RetentionPeriod>
<s2:RetentionReason>...</s2:RetentionReason>
<s2:Status>Valmis</s2:Status>
<s2:Function>00.00.00</s2:Function>
<s2:Type>Dokumentti</s2:Type>
<s2:Accepted>2024-05-24</s2:Accepted>
<s2:Authenticity>
<s2:Checker>SAPA-tuotetiimi</s2:Checker>
<s2:Date>2024-05-24</s2:Date>
<s2:Description>Alkuperäisyys todettu</s2:Description>
</s2:Authenticity>
<s2:Document>
<s2:NativeId>urn:oid:1.2.246.582.200.10012024.1.1.1.1</s2:NativeId>
<s2:UseType>Arkisto</s2:UseType>
<s2:File>
<s2:Name>DOC0001.pdf</s2:Name>
<s2:Path>cf_01/rec_01/DOC0001.pdf</s2:Path>
</s2:File>
<s2:Format>
<s2:Name>PDF</s2:Name>
<s2:Version>1</s2:Version>
</s2:Format>
<s2:HashAlgorithm>MD5</s2:HashAlgorithm>
<s2:HashValue>ad8f19e739182b212a85c13203971730</s2:HashValue>
</s2:Document>
<s2:Custom>
<muutunniste>Organisaation sisäinen muu tunniste</muutunniste>
<muutieto>Organisaation muu sisäinen lisätieto</muutieto>
</s2:Custom>
</s2:Record>
</s2:Action>
<s2:Custom>
<muutunniste>Organisaation sisäinen muu tunniste</muutunniste>
<muutieto>Organisaation muu sisäinen lisätieto</muutieto>
</s2:Custom>
</s2:CaseFile>
</s2:Metadata>
|