Tenor testdatasøk dokumentasjon

Konfigurasjon XML Skjema

Objekttype

Konfigurasjon

<konfigurasjon>
	<datasett><!-- ... --></datasett>
	<relasjoner><!-- ... --></relasjoner>
	<soekevisning><!-- ... --></soekevisning>
	<soekekriterier><!-- ... --></soekekriterier>
</konfigurasjon>
NavnObligatoriskTypeBeskrivelseEksempel
datasettJaDatasettDatasett metadata informasjon
relasjonerJaRelasjonerKonfigurasjon for relasjoner til primærkilder
soekevisningJaSoekedokumentKonfigurasjon av felter til bruk i nøkkelinformasjon i GUI
soekekriterierJaSoekeKriterierKonfigurasjon av søkekriterier i enkelt søk i GUI

Datasett

Overordnet beskrivelse av datasettet.

<datasett>
	<identifikator><!-- ... --></identifikator>
	<datasettOverskrift><!-- ... --></datasettOverskrift>
	<datasettEier><!-- ... --></datasettEier>
	<fellesdatakatalogDatasettIdentifikator><!-- ... --></fellesdatakatalogDatasettIdentifikator>
</datasett>
NavnObligatoriskTypeBeskrivelseEksempel
identifikatorJaTekstUnik datasett identifikator som eies av virksomheten i løsningen.freg
datasettOverskriftJaTekst
datasettEierJaEnhet
fellesdatakatalogDatasettIdentifikatorNeiTekstIdentifikator for datasett publisert i Felles Datakatalog.8bfa055a-9b0c-40df-a7c2-2e58173eb2e0

Enhet

<datasettEier>
	<organisasjonsnavn><!-- ... --></organisasjonsnavn>
	<organisasjonsnummer><!-- ... --></organisasjonsnummer>
</datasettEier>
NavnObligatoriskTypeBeskrivelseEksempel
organisasjonsnavnJaOrganisasjonsnavn
organisasjonsnummerJaOrganisasjonsnummer

Relasjoner

Relasjoner

<relasjoner>
	<relasjoner><!-- ... --></relasjoner>
</relasjoner>
NavnObligatoriskTypeBeskrivelseEksempel
relasjonerNeiRelasjon

Relasjon

Relasjonsnøkler til andre datasett for å opptre som sekundærkilde til de.

<relasjoner>
	<felt><!-- ... --></felt>
	<referertDatasett><!-- ... --></referertDatasett>
	<relasjon><!-- ... --></relasjon>
	<relasjonsretning><!-- ... --></relasjonsretning>
</relasjoner>
NavnObligatoriskTypeBeskrivelseEksempel
feltJaFeltFelt i søkedokument som skal fungerer som nøkkel mot et annet datasett.<felt><feltnavn>forfatter</feltnavn><feltOverskrift>Forfatter</feltOverskrift></felt>
referertDatasettJaTekstDatasett identifikator til refertert datasett.freg
relasjonJaTekstRelasjonsnøkkel
relasjonsretningNeiRetningHvilke retning relasjonen har semantisk. Bare relevant for relasjonsvisning.OPP

Soek

Predefinerte søk kan deles opp i temaer, eller som løse elementer.

<soek>
	<soekeTema><!-- ... --></soekeTema>
	<soekekriterier><!-- ... --></soekekriterier>
	<erPrimaerKildeSoek><!-- ... --></erPrimaerKildeSoek>
</soek>
<soek>
	<soekekriterie><!-- ... --></soekekriterie>
	<erPrimaerKildeSoek><!-- ... --></erPrimaerKildeSoek>
</soek>
NavnObligatoriskTypeBeskrivelseEksempel
soekeTemaJaTekstTema for søkekriteriet som vises samlet i GUI under overskriftet fra dette feltet.
soekekriterierJaSoekeKriterie
erPrimaerKildeSoekJaBoolskKilder som er både sekundær og primærkilder kan velge hvilke filter som skal vises når den brukes som primærkilde.
NavnObligatoriskTypeBeskrivelseEksempel
soekekriterieJaSoekeKriterie
erPrimaerKildeSoekJaBoolskKilder som er både sekundær og primærkilder kan velge hvilke filter som skal vises når den brukes som primærkilde.

Soekedokument

<soekevisning>
	<dokumentTittel><!-- ... --></dokumentTittel>
	<detaljertListe><!-- ... --></detaljertListe>
</soekevisning>
NavnObligatoriskTypeBeskrivelseEksempel
dokumentTittelNeiFeltObligatorisk for primærkilder.
detaljertListeJaFelt

SoekeKriterier

Liste over søkekriterier som vises i GUI

<soekekriterier>
	<soek><!-- ... --></soek>
</soekekriterier>
NavnObligatoriskTypeBeskrivelseEksempel
soekJaSoek

SoekeKriterie

Et søkekriterie som vises i GUI

<soekekriterier>
	<felt><!-- ... --></felt>
	<typeSoek><!-- ... --></typeSoek>
	<feltformat><!-- ... --></feltformat>
	<soekeVerdi><!-- ... --></soekeVerdi>
</soekekriterier>
NavnObligatoriskTypeBeskrivelseEksempel
feltJaFelt
typeSoekJaSoekType
feltformatNeiTekstFritekst som vises som placeholder i et felt11-siffer
soekeVerdiNeiSoekeVerdiPredefinerte verdier som skal vises i GUI for søketypene flervalg og enkeltvalg. Merk at verdiene må kodes som lister i JSON søkedokumentet.

SoekeVerdi

<soekeVerdi>
	<soekeVerdi><!-- ... --></soekeVerdi>
	<visningsNavn><!-- ... --></visningsNavn>
	<skjul><!-- ... --></skjul>
</soekeVerdi>
NavnObligatoriskTypeBeskrivelseEksempel
soekeVerdiJaTekstEn predefinert verdifoedselsnummer
visningsNavnNeiTekstVisningsnavn for verdiFøedselsnummer
skjulNeiBoolskAngi at verdien skal skjules

Felt

<felt>
	<feltnavn><!-- ... --></feltnavn>
	<feltOverskrift><!-- ... --></feltOverskrift>
</felt>
NavnObligatoriskTypeBeskrivelseEksempel
feltnavnJaTekst
feltOverskriftJaTekst

Datatype

Kodeliste

Retning

Type: xsd:string

VerdiBeskrivelse
opp
ned
tilSiden

SoekType

Type: xsd:string

VerdiBeskrivelse
friTekstVises som et fritekst inputfelt. JSON typen brukt bestemmer også følgende: Felt som er kodet som tall tillater bare numerisk input. Felt som er kodet som tidspunkt tillater bare dato input og viser også en kalender.
datoFraTilViser to datofelt der man kan velge eller skrive inn ønsket dato. Søkedokumenter må ha en verdi mellom de to datoene.
periodeFraTilViser to periodefelt (MM.yyyy) der man kan velge eller skrive inn ønsket periode. Søkedokumenter må ha en verdi mellom de to datoene.
fraTilViser to felt der søkedokumenter må ha en verdi mellom de to verdiene. Samme visning som for fritekst.
datoViser datofelt der man kan velge eller skrive inn ønsket dato.
periodeViser periodefelt (MM.yyyy) der man kan velge eller skrive inn ønsket periode.
enkeltvalgViser verdier som radio buttons eller en dropdown meny, avhengig av hvor mange verdier man kan velge.
flervalgViser verdier som checkboxer
harCheckbox som søker etter dokumenter som har gitt felte.
harIkkeCheckbox som søker etter dokumenter som ikke har gitt felt.
BOOLSøk med true eller false i feltet.

Primitive

Tekst

Vilkårlig lang sekvens av tegn inkludert aksenter og spesielle tegn fra standardiserte tegnsett

Organisasjonsnavn

navn på organisasjon

Organisasjonsnummer

9 sifret nummer gitt de som er registrert i Enhetsregisteret.

Boolsk

angir verdien sann eller usann

DatoKlokkeslett

en kombinasjon av typene Dato og Klokkeslett. Kodes som en tekststreng etter datoformatering spesifisert i ISO 8601 (ISO 8601:2004 Data elements and interchange formats -- Information interchange -- Representation of dates and times).