configurations

Vejledning: Redigering af YAML-filer i configurations

Generel vejledning til brugere der skal rette i konfigurationsfiler under config/organisations/<org>/configurations/<profil>/.

---

Mappestruktur – typisk indhold

En configuration-mappe indeholder typisk:

Fil/mappe	Formål	Påkrævet
config.yml	Hovedkonfiguration: metadata, faner, import, controller, searchers	Ja
params.yml	Parametre (kommunekode, credentials, tokens)	Nej – men kræves hvis importeret
style.yml	Kortlag, symboler, farver	Nej
guide.yml	Hjælpetekster og søgbare vejledninger	Nej
hearinglist.yml	Hørings-/ejerlistefunktioner	Nej
ejerservice.yml	Ejerservice-integration	Nej
dmp.yml	DMP/konfliktanalyse	Nej
pgindex.yml	PostgreSQL-søgning	Nej
routes/	Egne API-ruter (routes.js)	Nej
assets/	Logo, HTML, datafiler	Nej
classes/	Egne JavaScript-klasser	Nej

---

Import – hvordan filer samles

I config.yml står import.sections. Hver sektion peger på en YAML-fil der merges ind i konfigurationen. Rækkefølgen betyder noget – senere filer overstyrer tidligere.

import:
  sections:
    - name: params
      dir: $.env.configDir      # = configuration-mappen (fx 01-plus/)
    - name: standardkommune
      dir: $.env.libDir/lib/standardkommune   # = delt bibliotek

dir-værdi	Betyder	Eksempel filsti
$.env.configDir	Samme mappe som config.yml	01-plus/params.yml
$.env.organisationDir	Organisation-mappen	septima/datafordeler.yml
$.env.libDir/lib/standardkommune	Delt standardkommune-bibliotek	lib/standardkommune/tingbog.yml

Vigtigt: Hvis en fil i import.sections ikke findes, fejler serveren ved opstart. Fjern eller udkommentér (#) sektioner for filer du ikke har.

---

Sådan udkommenterer du

YAML bruger # til kommentarer. For at slå noget fra uden at slette det:

  searchers:
    - _ref: $.searchers.dawa
    #- _ref: $.searchers.s4Index          # Deaktiveret
    #- _ref: $.tinglysning.geoPartnerSearcher

import:
  sections:
    - name: params
      dir: $.env.configDir
    #- name: tinglysning                    # Import deaktiveret
    #  dir: $.env.libDir/lib/standardkommune

---

YAML-syntaks – fejl at undgå

Fejl	Forklaring	Løsning
Forkert indrykning	YAML kræver mellemrum (typisk 2). Tabs og uens mængder giver fejl	Brug konsekvent 2 mellemrum
Glemt kolon	key value i stedet for key: value	Sørg for : efter nøgle
Anførselstegn	Tal, true/false eller strenge med specialtegn skal nogle gange i anførselstegn	Brug "101" for kommunekode, "*" for wildcard
Strenge med kolon	url: http://... – kolon i værdi kan forvirre parseren	Sæt i anførselstegn: url: "http://..."
Tomme lister	targets: uden værdier	Brug targets: [] eller targets: på egen linje med indrykkede - under

---

Referencer (_ref)

Mange værdier refererer til andre med _ref:

host:
  _ref: $.parameters.seS4Index.host

• $.parameters.xxx – fra params.yml (eller parameters i config)
• $.standardkommune.xxx – fra standardkommune-biblioteket
• $.searchers.xxx – fra searchers-sektionen
• $.tingbog.xxx – fra tingbog.yml
• $.env.configDir – sti til configuration-mappen

Sørg for at den refererede nøgle findes – ellers får du fejl ved kørsel.

---

Filnavne med X-prefix

Filer som Xconfig.yml eller XXstyle.yml bruges typisk til backup eller udviklingsversioner. De importeres ikke – kun filer angivet i import.sections læses (fx name: style → style.yml). En fil ved navn XXstyle.yml påvirker derfor ikke serveren. Du kan bruge X-prefix til at beholde gamle kopier uden at de aktiveres.

---

Ændringer træder i kraft

• YAML-filer: Genstart serveren. Nogle værdier caches – ved tvivl, genstart.
• routes/routes.js: Genstart serveren (Node læser ikke filen igen under kørsel).
• assets/ (billeder, HTML): Kan ofte hentes uden genstart – browseren cacher, så prøv hard refresh (Ctrl+F5).

---

Fejlsøgning

Symptom	Mulig årsag
Server starter ikke	YAML-syntaksfejl, manglende fil i import.sections, forkert _ref
"doesn't exist" i fejl	Fil nævnt i import findes ikke – tjek sti og dir
Profil vises ikke	Mangler config.yml eller config har fejl
Søger mangler	Fjernet fra controller.searchers eller import for den søgers modul
"Cannot find package"	Manglende npm-afhængighed (fx http-proxy) – se package.json

Tjek serverloggen ved opstart – fejlbeskeder angiver ofte fil og linje.

---

Oversigt over typiske imports

Import name	Fil	Indhold	Fra
params	params.yml	Credentials, kommunekode, tokens	configDir
standardkommune	standardkommune.yml	DAWA, GSearch, BBR, POI m.fl.	lib
tingbog	tingbog.yml	Tingbog/tinglysning fra Septima	lib
tinglysning	tinglysning.yml	Direkte tinglysning.dk + GeoPartner	lib
dmp	dmp.yml	Konfliktanalyse mod DMP	configDir eller lib
hearinglist	hearinglist.yml	Hørings-/ejerlistefunktioner	configDir
guide	guide.yml	Hjælpetekster	configDir
ejerservice	ejerservice.yml	Ejerservice	configDir
pgindex	pgindex.yml	PostgreSQL-søgning	configDir
s4index	s4index.yml	Spatial Suite/s4 Index	lib
arcgis	arcgis.yml	ArcGIS-søgning	configDir eller lib