Vardef

Sist endret

January 31, 2025

Warning

Vardef er foreløpig kun tilgjengelig i test-miljøet og er ikke i produksjon.

Vardef er SSBs system for dokumentasjon av variabler. Vardef består av et sentralt datalager som man kan interagere med via et API. Statistikere og forskere i SSB kan interagere med systemet gjennom Vardef-delen av Python-pakken dapla-toolbelt-metadata.

Brukerdokumentasjonen for Vardef er skrevet i notebooks som er ferdig installert i tjenesten Vardef-forvaltning i Dapla Lab. Det er opprette egne notebooks for typiske arbeidsoppgaver man ønsker å gjøre i Vardef, og brukeren kan kjøre disse uten å skrive kode selv. I notebooks-ene finner man ferdigskrevet kode som bruker dapla-toolbelt-metadata for å jobbe med Vardef. Hvis man ønsker å se innholdet i notebooks uten å starte tjenesten Vardef-forvaltning, så kan gå inn på lenkene til høyre på denne siden.

På denne siden dokumenteres hvordan notebooks’ene i Vardef-forvaltning kan benyttes for å gjøre ulike arbeidsoppgaver knyttet til Vardef.

Forberedelser

For å jobbe med Vardef i Vardef-forvaltning må man først gjøre følgende:

  1. Logge deg inn Dapla Lab
  2. Åpne Tjenestekatalog og trykke Start for Vardef-forvaltning
  3. Under Data velger du hvilket team og tilgangsgruppe du skal representere i tjenesten.
  4. Trykk Start

Siden det er Dapla-team og tilgangsgrupper i teamene som forvalter variabeldefinisjoner i Vardef, så er det svært viktig at man velger riktig under punkt 3. Hvis man skal opprette en ny definisjon så er det teamet man logger seg inn med i Vardef-forvaltning som blir automatisk satt som eier av definisjonen. Tilsvarende er tilfellet for endringer; man må logge seg inn som det teamet som forvalter en variabeldefinisjon for å kunne gjøre endringer.

Funksjonalitet

Under finner dere beskrivelser av hvordan man gjør typiske operasjoner mot Vardef.

Migrere fra Vardok

Ønsker man å migrere en variabeldefinisjon så kan man kjøre notebooken migrere_variabel_definisjon.ipynb.

Kjør gjennom notebook’en og skriv inn variabeldefinisjonens ID i Vardok når man blir bedt om det. Alle seksjonsledere har oversikt over hvilke ID’er fra Vardok som deres seksjon er ansvarlig for.

Når notebook’en er kjørt gjennom så er variabeldefinisjonen migrert fra Vardok til status Utkast i Vardef. I denne prosessen oppdaterer dapla-toolbelt-metadata all informasjon som kan utledes automatisk, og deretter må brukeren oppdatere gjenværende informasjon før de publiserer den internt eller eksternt.

Oppdatere utkast

Et utkast kan oppdateres ved å kjøre notebooken redigere_utkast.ipynb. Den skriver variabeldefinisjonen ned til en fil som brukeren kan gjøre endringer i. Når endringene er gjort, så kan man oppdatere utkastet i slutten av notebooken.

Publisere utkast

Når brukeren er fornøyd med utkastet og ønsker å publisere, så kan man velge å publisere internt eller eksternt. Ved migrering av tidligere eksternt publiserte definisjoner fra Vardok, så er hovedregelen at også man publiserer variabeldefinisjonen eksternt i Vardef.

Man kan publisere en variabeldefinisjon eksternt ved å kjøre notebook’en publisere_eksternt.ipynb.

Man kan publisere en variabeldefinisjon internt ved å kjøre notebook’en publisere_internt.ipynb.

Ny variabeldefinisjon

For å opprette en ny variabeldefinisjon må man først opprette et utkast, deretter redigere utkastet og til slutt publisere. Da vil man bruke følgende notebooks:

  1. opprette_utkast.ipynb
  2. redigere_utkast.ipynb
  3. publisere_internt.ipynb eller publisere_eksternt.ipynb

Ny gyldighetsperiode

Ny gyldighetsperiode i Vardef betyr at man ønsker å gjøre endringer i en eksisterende variabeldefinisjon som gjør at den får en ny betydning. Dette betyr at definisjonsteksten endres, og denne endringen krever at den får en ny gyldighetsperiode. Dette kan kun gjøres på variabeldefinisjoner som allerede er publisert internt eller eksternt.

For opprette en ny gyldighetsperiode kan man kjøre gjennom notebooken opprette_gyldighetsperiode.ipynb.

Her blir man bedt om å oppgi kortnavnet til variabeldefinisjonen som skal ha ny gyldighetsperiode, deretter skrives den til en fil hvor endringer kan gjøres. Til slutt oppdateres variabeldefinisjonen i Vardef.

Patch

En patch i Vardef er en mindre endring som ikke endrer betydningen av variabeldefinisjonen. Man kan opprette en patch ved å kjøre notebook’en redigere_publisert_variabel.ipynb.

Lese ut informasjon

For å hente ut informasjon fra Vardef finnes det ulike notebooks avhengig av hva man ønsker å hente ut.

En variabeldefinisjon

Notebooken lese_en_variabeldefinisjon.ipynb lar deg hente ut informasjon om en konkret variabeldefinisjon. Man kan hente ut all informasjon om variabeldefinisjonen, eller hente ut noen få informasjonselementer.

Alle variabeldefinisjoner

Notebooken lese_variabel_definisjoner.ipynb lar deg hente ut informasjon om alle variabeldefinisjoner og filtrere disse basert på ulike kriterier.

Ledige kortnavn

Notebooken sjekk_om_kortnavn_er_ledig.ipynb lar deg sjekke om et kortnavn er tatt eller ikke. Kortnavn i Vardef må være unikem, så det kan være lurt å sjekke om ønsket kortnavn er ledig før man prøver å publisere.