# Bruk av regel ved arkivering

Som klientsystem ønsker jeg ikke å forholde meg til lokale oppsett hos det enkelte arkiv.
Jeg ønsker at arkivet kan holde styr på koder rundt arkivering, statuser, tilgangskontroll etc. 
For at arkivet skal kunne gjøre det vil jeg sende med informasjon om hvilket system jeg er (`system`) og hva slags data jeg nå arkiverer (`regel`).

Arkivet vil bruke det som er definert i `regel` for det som ikke er definert i arkivmeldingen. Altså vil det man sender inn med arkivmeldingen overstyre det som er definert i `regel`.

Det er et krav at arkiv støtter `regel`. 

## Regel og system i bruk

De to feltene `system` og `regel` er verdier man kan sette i meldingen for å opprette i arkiv, med meldingstypen `no.ks.fiks.arkiv.v1.arkivering.arkivmelding.opprett`.

En regel hos et arkiv er laget for **ett** fagsystem og inneholder deres standardverdier. Feltet `system` identifiserer da fagsystemet og `regel` er da regelen som skal brukes hos arkivsystem.

Utdrag fra **xsd** med `system` og `regel` under `arkivmelding`:
```xml
<xs:complexType name="arkivmelding">
    <xs:sequence>
        <xs:element name="system" type="xs:string"/>
        <xs:element name="regel" type="xs:string" minOccurs="0"/>
        <xs:element name="antallFiler" type="xs:int"/>
        <xs:choice>
            <xs:element name="mappe" type="mappe" minOccurs="0"/>
            <xs:element name="registrering" type="registrering" minOccurs="0"/>
        </xs:choice>
    </xs:sequence>
</xs:complexType>
```

Her er et eksempel på XML som ikke er fullstendig og gyldig, men viser eksempel på `system` + `regel`.
Arkivsystemet vil da kunne finne ut hvilke verdier som skal settes til standardverdier basert på avsendende system `FagsystemX` og regel `FXRegel1`:

```xml
<?xml version="1.0" encoding="utf-8"?>
<arkivmelding xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
              xmlns="https://ks-no.github.io/standarder/fiks-protokoll/fiks-arkiv/arkivmelding/opprett/v1">
    <system>FagsystemX</system>
    <regel>FXRegel1</regel>
    <antallFiler>1</antallFiler>
    <mappe xsi:type="saksmappe">
        <tittel>Test av regel</tittel>
        <!-- Ikke tatt med full XML i dette eksemplet --> 
    </mappe>
    <registrering xsi:type="journalpost">
       <!-- Ikke tatt med full XML i dette eksemplet -->
    </registrering>
</arkivmelding>
```




### System
System er en entydig definisjon av en klient på tvers av alle mulige klienter som benytter Fiks Arkiv. 
System vil normalt være det samme som produktnavnet til klienten, eller fagsystemet om du vil. 

### Regel
Regel er en entydig navngiving av et oppsett hos arkivet for et system. 
Dette kan være generisk som "Rapport", "Brev ut", "Notat" eller mer spesifikt som "Søknad om stilling". 
Saker/journalposter som skal håndteres likt bør ha samme verdi i regel slik at antall oppsett i arkivet begrenses. 
Bruk av regel gjør at en klient kan ha ett sett data ved arkiveringen uavhengig av hvilket arkiv det skal arkiveres til.
Regel kan da styre tilgangskontroll, arkivering, saksbehandler og annet som vil være forskjellig fra arkiv til arkiv.

#### Verdier fra arkivmelding overstyrer regel
Hvis man angir en verdi til et atributt som også er angitt med en standard verdi i regel, så vil standardverdien overstyres.
Altså vil det som kommer med i arkivmeldingen gjelde. 

#### Attributter som kan angis 

Regel skal kunne benyttes for å sette standardverdier for ikke angitte data. Følgende attributter i arkivmelding skal kunne angis:

##### Mappe
* dokumentmedium
* arkivdel
* skjerming
* gradering
* klassifikasjon (se under)
* mappetype

##### Saksmappe
Saksmappe arver fra mappe og har dermed mange av de samme attributtene som mappe
* dokumentmedium
* arkivdel
* skjerming
* gradering
* klassifikasjon (se under)
* mappetype
* administrativEnhet
* saksansvarlig
* journalenhet
* saksstatus

##### Registrering
* (arkivdel)
* skjerming
* gradering
* dokumentmedium
* korrespondansepart (se under)
* klassifikasjon (se under)

##### Journalpost
Journalpost arver fra registrering og har dermed mange av de samme attributtene som registrering
* (arkivdel)
* skjerming
* gradering
* dokumentmedium
* korrespondansepart (se under)
* klassifikasjon (se under)
* journalposttype
* journalstatus
* journalenhet

##### Arkivnotat
Arkivnotat arver fra registrering og har dermed mange av de samme attributtene som registrering
* (arkivdel)
* skjerming
* gradering
* dokumentmedium
* korrespondansepart (se under)
* klassifikasjon (se under)

##### Dokumentbeskrivelse:
* dokumenttype
* dokumentstatus
* dokumentmedium
* (tilknyttetRegistreringSom) (se merknad)
* skjerming
* gradering

TilknyttetRegistreringSom vil kunne settes uten bruk av regel ved at første dokumentbeskrivelse i et sett er hoveddokument og resterende vedlegg. Alternativt kan man angi to sett, ett for første dokumentbeskrivelse (første eller den med dokumentnummer 1) og ett for de øvrige (antall vedlegg vil normalt variere hvilket gjør det umulig å lage individuelle regelsett pr. dokumentbeskrivelse).

##### Klassifikasjon 
Klassifikasjon har flere behov

1. Primær klassifikasjon som alltid skal legges til uavhengig av hva som er angitt fra klienten.
2. Sekundære klassifikasjoner som alltid skal legges til uavhengig av hva som er angitt fra klienten.
3. Standardverdier for klassifikasjon der data mangler (i samme rekkefølge på klassifikasjoner som de mottatt fra klienten om merr enn én klassifikasjon):
   1. klassifikasjonsystemID
   2. erSkjermet

Se mer om klassifikasjon og klassifikasjonsystemer i ["Brukstilfelle - Klassifikasjon"](Brukstilfelle-Klassifikasjon.md)

##### Part
* partRolle

##### Korrespondansepart
Korrespondansepart, angivelse av behandlingsansvarlig avsender/mottager der det ikke er angitt noen behandlingsansvarlig:
* (korrespondanseparttype) (følger av type journalpost)
* (erBehandlingsansvarlig) (alltid true)
* administrativEnhet
* saksbehandler (gir også korrespondansepartNavn automatisk)
* (erSkjermet) (vil vel alltid være false)
* (erPersonnavn) (reelt sett alltid true, men brukes normalt ikke for interne)

##### Objekter for møter
Disse vil bli spesifisert sammen med spesifikasjonen av Fiks Politisk behandling.