# Configuratie: Environment Variabelen Hieronder staan de benodigde environment variabelen per onderdeel van KISS. ## Authenticatie | Variabele | Uitleg | | ---------------------------------------- | --------------------------------------------------------- | | `OIDC_AUTHORITY` | URL van de OpenID Connect Identity Provider | | `OIDC_CLIENT_ID` | Voor toegang tot de OpenID Connect Identity Provider | | `OIDC_CLIENT_SECRET` | Secret voor de OpenID Connect Identity Provider | | `OIDC_MEDEWERKER_IDENTIFICATIE_CLAIM` | Identificatie van de medewerker in registers
(default waarde is `email`)
Meer informatie Bij het wegschrijven van gegevens naar bv. Open Klant of Open Zaak is een `medewerkerIdentificatie.identificatie` verplicht. Verschillende gemeenten gebruiken hier verschillende waardes voor. Bij een koppeling met bv. de e-Suite is het van belang dat hier de e-Suite gebruikersnaam in staat van de ingelogde KCM.
| | `OIDC_MEDEWERKER_IDENTIFICATIE_TRUNCATE` | Optioneel afkappen van de claim
(bijv. `24`)
Meer informatie Binnen ZGW mag een `medewerkerIdentificatie.identificatie` niet langer zijn dan 24 karakters. Met deze variabele kun je ervoor zorgen dat de uiteindelijk waarde wordt afgekapt na 24 tekens.
| | `MANAGEMENTINFORMATIE_API_KEY` | Secret dat KISS gebruikt om het JWT Token
te valideren bij het opvragen van
contactmomentdetails
Meer informatie Zie de [Handleiding beheer KISS, hoofdstuk
managementinformatie](../manual/managementinformatie.md) voor informatie over
het gebruik van deze API.
| | | | ## Autorisatie | Variabele | Uitleg | | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `OIDC_KLANTCONTACTMEDEWERKER_ROLE` | Naam van de rol voor een Klant Contact Medewerker. Deze moet overeenkomen met de naam van rol zoals die geconfigureerd is/wordt bij de Identity Provider. Standaard: `Klantcontactmedewerker`
Meer informatie Een medewerker met deze rol kan Contactmomenten en Contactverzoeken registreren, en zoeken in bronnen.
| | `OIDC_REDACTEUR_ROLE` | Naam van de rol voor een Redacteur. Deze moet overeenkomen met de naam van rol zoals die geconfigureerd is/wordt bij de Identity Provider. Standaard: `Redacteur`
Meer informatie Een medewerker met deze rol kan de inhoud bewerken die beschikbaar is achter Beheer. Zie de [Handleiding beheer KISS](../manual/manual.rst).
| | `OIDC_KENNISBANK_ROLE` | Naam van de rol voor een Kennisbank medewerker. Deze moet overeenkomen met de naam van rol zoals die geconfigureerd is/wordt bij de Identity Provider. Standaard: `Kennisbank`
Meer informatie Een medewerker met deze rol kan alléén zoeken in de geconfigureerde bronnen zoals Kennisbank, VAC, Smoelenboek en websites.
| ## Database | Variabele | Uitleg | | ------------------ | ------------------------------------- | | `POSTGRES_DB` | Naam van de database bij KISS | | `POSTGRES_USER` | Gebruikersnaam voor toegang van KISS tot de DB | | `POSTGRES_PASSWORD` | Wachtwoord van de postgresUser | | | | ## Organisatie RSIN | Variabele | Uitleg | | ----------------- | ---------------------------------------------------------------- | | `ORGANISATIE_IDS` | RSIN van de organisatie die de
Contactmomenten registreert
Meer informatie Verschillende ZGW APIs, waaronder de Klant en Contactmoment APIs, vragen om een identificatienummer, RSIN, van de eigen organisatie. Dit RSIN moet worden meegegeven bij registratie van specifieke objecten.
| | | | ## Feedback op Kennisartikelen
Meer informatie Vanuit KISS kan een KCM feedback geven op een kennisartikel. Deze informatie wordt gemaild naar één centraal e-mailadres. Dit configureer je met onderstaande variabelen.
| Variabele | Uitleg | | --------------------- | --------------------------------------- | | `FEEDBACK_EMAIL_FROM` | Afzenderadres van de feedbackmail | | `FEEDBACK_EMAIL_TO` | Adres waar de feedbackmail naartoe moet | | `EMAIL_ENABLE_SSL` | Gebruik van SSL (true/false) | | `EMAIL_HOST` | Adres van de mailserver | | `EMAIL_PORT` | Poortnummer van de mailverbinding | | `EMAIL_USERNAME` | Gebruikersnaam voor de mailserver | | `EMAIL_PASSWORD` | Wachtwoord voor de mailserver | | | | ## Gekoppelde Bronnen Er zijn diverse API's die vanuit KISS bevraagd worden. Hieronder staan de environment variabelen per gekoppelde bron. **Let op**: 1. Sommige API-keys en Secrets die KISS nodig heeft om externe registers te bevragen moeten **minimaal 32 karakters** lang zijn. 2. Voor variabelen met `__0__` als tussenvoegsel geldt dat er een lijst opgebouwd kan worden. Het eerste item van de lijst heeft `__0__` als tussenvoegsel, het tweede item `__1__`, en zo verder.
Meer informatie Er zijn diverse bronnen die vanuit KISS via API's bevraagd worden. Sommige worden alleen geraadpleegd, zoals de KvK-API en de API voor Haal Centraal BRP Personen bevragen, en de Objecten API voor het ophalen van Afdelingen, Groepen en Medewerkers. Andere registraties worden niet alleen geraadpleegd, maar er worden ook gegevens in weggeschreven. Dit zijn in ieder geval een Klanten- en Contactmomentenregister, zoals Open Klant, het Objecten Register zoals Open Objecten, en een Zaaksysteem (m.b.v. ZGW API's) zoals Open Zaak. Daarnaast zijn er bronnen die binnen KISS doorzocht moeten worden. - KISS gebruikt de Objecten API om Kennisartikelen (PDC-producten) mee op te halen, en naar Elastic te pushen. - KISS gebruikt op dit moment de Objecten API om de Medewerkers in het Smoelenboek op te halen en naar Elastic te pushen. - KISS gebruikt op dit moment de Objecten API om de Vraag Antwoord Combinaties (VAC) op te halen en naar Elastic te pushen.
### KISS-frontend, klanten, contactmomenten en zaken **Let op, KLANTINTERACTIE_BASE_URL id deprecated** Let op, er moeten setjes van klantregister + contactmomentregister + contactverzoekregister (interne taak) + zaaksysteem worden gemaakt. Er is bijvoorbeeld sprake van een `REGISTERS__0__KLANTINTERACTIE_BASE_URL` en eventueel een `REGISTERS__1__KLANTINTERACTIE_BASE_URL`, een `REGISTERS__2__KLANTINTERACTIE_BASE_URL`, etc. **Let op, REGISTERS__N__ZAAKSYSTEEM_BASE_URL is deprecated** Gebruik als alternatief deze drie nieuwe variabelen - REGISTERS__N__ZAAKSYSTEEM_ZAKEN_BASE_URL, - REGISTERS__N__ZAAKSYSTEEM_CATALOGI_BASE_URL, - REGISTERS__N__ZAAKSYSTEEM_DOCUMENTEN_BASE_URL Het wordt aangeraden REGISTERS__N__ZAAKSYSTEEM_BASE_URL niet meer te gebruiken en te vervangen door de drie bovenstaande (vergeet niet de oude REGISTERS__N__ZAAKSYSTEEM_BASE_URL dan weg te halen: gebruik het oude en nieuwe format **niet** door elkaar heen).
Om over te gaan van de oude situatie met één variabele naar de nieuwe situatie met drie variabelen vervang je bijvoorbeeld 'https://openzaak.dev.kiss-demo.nl' door respectievelijk 'https://zaken.mijnzaaksysteem.nl/api/v1', 'https://documenten.mijnzaaksysteem.nl/api/v1' en 'https://catalogi.mijnzaaksysteem.nl/api/v1' als je een zaaksysteem gebruikt waarbij elke api op een eigen subdomein draait.
Als je een zaaksysteem gebruikt waarbij alle api's op dezelfde url draaien, kan je ook over naar het nieuwe format. Dan vul je drie keer hetzelfde in, bijvoorbeeld: 'https://openzaak.dev.kiss-demo.nl/zaken/api/v1', 'https://openzaak.dev.kiss-demo.nl/catalogi/api/v1' en 'https://openzaak.dev.kiss-demo.nl/documenten/api/v1'.
Let op, in beide gevallen neem je nu dus het versienummer mee in de url. | Variabele | Uitleg | | --------------------------------- | -------------------------------------------------------------------------------------------- | |REGISTERS__N__IS_DEFAULT |true of false
Meer informatie Er moet exact 1 default register-set zijn. Klanten, contactmomenten en contactverzoeken worden in dit defaultregister aangemaakt, tenzij uit de context blijkt dat de gegevens in een specifiek register thuis horen. Bijvoorbeeld, als een contactmoment bij een zaak uit een bepaald zaaksysteem hoort, dan wordt het contactmoment opgeslagen in het contactmomentregister dat hoort bij dat Zaaksysteem. Dit is het het zaaksysteem dat deel uitmaakt van dezelfde REGISTERS__X__...-set waar ook het zaaksysteem inzit.
| |REGISTERS__N__ZAAKSYSTEEM_ZAKEN_BASE_URL | Volledige base URL voor zaken API inclusief versie
Bijvoorbeeld: `https://zaken.somezaaksysteem.nl/api/v2` | |REGISTERS__N__ZAAKSYSTEEM_CATALOGI_BASE_URL | Volledige base URL voor catalogi API inclusief versie
Bijvoorbeeld: `https://catalogi.somezaaksysteem.nl/api/v2` | |REGISTERS__N__ZAAKSYSTEEM_DOCUMENTEN_BASE_URL | Volledige base URL voor documenten API inclusief versie
Bijvoorbeeld: `https://documenten.somezaaksysteem.nl/api/v2` | |REGISTERS__N__ZAAKSYSTEEM_BASE_URL |URL van de ZGW API's Let op, deprecated. Lees de toelichting hierboven.
Meer informatie Bijvoorbeeld: `https://zaaksysteem.mijngemeente.nl`.
| |REGISTERS__N__ZAAKSYSTEEM_API_KEY |API Key voor de ZGW API's
**(min. 32 karakters)** | |REGISTERS__N__ZAAKSYSTEEM_API_CLIENT_ID |ClientId voor de ZGW API's | |REGISTERS__N__ZAAKSYSTEEM_DEEPLINK_URL |Basisurl om te deeplinken naar een Zaak in het zaaksysteem (optioneel)
Meer informatie Bijvoorbeeld: `https://zaaksysteem.mijngemeente.nl/mp/zaak/`
Deze variabele **moet** altijd gebruikt worden **in combinatie met** `ZAAKSYSTEEM__N__DEEPLINK_PROPERTY`. Als deze variabelen beiden worden ingevuld, zal er in KISS een link in het zaakdetailscherm staan, waarmee de KCM de betreffende zaak direct in het zaaksysteem opent. LET OP: dit kan alleen bij zaaksystemen die een vaste url hebben voor zaakdetails, waarbij alleen één property van de zaak, bijv. het zaaknummer, áchter die URL geplaatst hoeft te worden.
| |REGISTERS__N__ZAAKSYSTEEM_DEEPLINK_PROPERTY |Property om naar een zaak te kunnen deeplinken (optioneel)
Meer informatie Deze variabele **moet** altijd gebruikt worden **in combinatie met** `ZAAKSYSTEEM__N__DEEPLINK_URL`. De waarde uit dit property van een specifieke zaak wordt achter `ZAAKSYSTEEM_DEEPLINK_URL` geplaatst om de link te laten werken. Bijvoorbeeld: `identificatie`
| |REGISTERS__N__ZAAKSYSTEEM_USE_EXPERIMENTAL_QUERIES |true of false. Feature switch voor het gebruik van de experimentele features die geintroduceerd zijn in [Open Zaak 1.20.0](https://open-zaak.readthedocs.io/en/stable/development/changelog.html#id9) (optioneel) | |REGISTERS__N__REGISTRY_VERSION |OpenKlant2 of OpenKlant1
Meer informatie Gebruikt OpenKlant1 alléén als je wilt koppelen met de e-Suite. KISS ondersteunt de Klanten API, de Contactmomenten API en het objecttype Interne Taak. In andere gevallen vul hier OpenKlant2 in.
| | **-------------------------** | **De volgende variabelen gebruik je alleen bij het gebruik van een Open Klant 2 omgeving. Je hebt dan dus bij REGISTERS__N__REGISTRY_VERSION 'OpenKlant2' ingevuld!** | |REGISTERS__N__KLANTINTERACTIE_BASE_URL |URL van de Klantinteractie API van het gebruikte OpenKlant2 klantinteractieregister
Meer informatie Bijvoorbeeld `https://klantinteractieregister.mijngemeente.nl/klantinteracties`
| |REGISTERS__N__KLANTINTERACTIE_TOKEN |Token voor de Klantinteractie API van het gebruikte klantinteractieregister | | **-------------------------** |**De volgende variabelen gebruik je alleen bij het gebruik van de e-Suite. Je hebt dan dus bij REGISTERS__N__REGISTRY_VERSION 'OpenKlant1' ingevuld!** | |REGISTERS__N__CONTACTMOMENTEN_BASE_URL |URL van de Contactmomenten API van het gebruikte Contactmomentenregister.
Meer informatie Bijvoorbeeld: `https://contactmomentenregister.mijngemeente.nl`
| |REGISTERS__N__CONTACTMOMENTEN_API_CLIENT_ID |ClientId voor de Contactmomenten API van het gebruikte Contactmomentenregister. | |REGISTERS__N__CONTACTMOMENTEN_API_KEY | Key voor de Contactmomenten API
**(min. 32 karakters)** | |REGISTERS__N__INTERNE_TAAK_BASE_URL | URL van de Objecten API voor Interne Taken
Meer informatie Bijvoorbeeld: `https://objectenregister.mijngemeente.nl`
| |REGISTERS__N__INTERNE_TAAK_CLIENT_ID | Client ID voor de Interne Taken API
**(Als deze variabele een waarde heeft, moet `REGISTERS__N__INTERNE_TAAK_TOKEN` leeg blijven)**
Meer informatie In de meeste gevallen identificeert KISS zich bij een Objectenregistratie m.b.v. een `TOKEN`. In sommige gevallen is het nodig om de authenticatie in de Objecten API, voor Afdelingen, Groepen en Interne Taken, Medewerkers in te regelen m.b.v. een `client secret` en een `client id`. Dit is bv. het geval als je KISS gebruikt i.c.m. de e-Suite. Afhankelijk van de situatie moet je dus een Token inregelen, en in andere gevallen een id+secret. **NOOIT ALLEBEI!** let op: alle 3 de variabelen moeten wel aanwezig zijn, je kunt ze niet weglaten.
| |REGISTERS__N__INTERNE_TAAK_CLIENT_SECRET | Client Secret voor de Interne Taken API
**(Als deze variabele een waarde heeft, moet `REGISTERS__N__INTERNE_TAAK_TOKEN` leeg blijven)**
Meer informatie In de meeste gevallen identificeert KISS zich bij een Objectenregistratie m.b.v. een `TOKEN`. In sommige gevallen is het nodig om de authenticatie in de Objecten API, voor Afdelingen, Groepen en Interne Taken, Medewerkers in te regelen m.b.v. een `client secret` en een `client id`. Dit is bv. het geval als je KISS gebruikt i.c.m. de e-Suite. Afhankelijk van de situatie moet je dus een Token inregelen, en in andere gevallen een id+secret. **NOOIT ALLEBEI!** Let op: alle 3 de variabelen moeten wel aanwezig zijn, je kunt ze niet weglaten.
| |REGISTERS__N__INTERNE_TAAK_TOKEN | Token voor de Objecten API voor Interne Taken
**(Als deze variabele een waarde heeft, moeten `REGISTERS__N__INTERNE_TAAK_CLIENT_SECRET` en `REGISTERS__N__INTERNE_TAAK_CLIENT_ID` leeg blijven)**
Meer informatie In de meeste gevallen identificeert KISS zich bij een Objectenregistratie m.b.v. een `TOKEN`. In sommige gevallen is het nodig om de authenticatie in de Objecten API, voor Afdelingen, Groepen en Interne Taken, Medewerkers in te regelen m.b.v. een `client secret` en een `client id`. Dit is bv. het geval als je KISS gebruikt i.c.m. de e-Suite. Afhankelijk van de situatie moet je dus een Token inregelen, en in andere gevallen een id+secret. **NOOIT ALLEBEI!** Let op: alle 3 de variabelen moeten wel aanwezig zijn, je kunt ze niet weglaten.
| |REGISTERS__N__INTERNE_TAAK_OBJECT_TYPE_URL | URL van het Objecttype Interne Taak
Meer informatie Bijvoorbeeld `https://objecttypenregister.mijngemeente.nl/api/v2/objecttypes/f83fdc48-5ddb-4b1a-a347-e20092031399`
| |REGISTERS__N__INTERNE_TAAK_TYPE_VERSION |Versienummer van het Objecttype Interne Taak
Meer informatie Bijvoorbeeld `2`
KISS schrijft InterneTaken in het Objectenregister. Hierbij moet je altijd de versie van het objecttype meegeven. Omdat het per gemeente kan verschillen welke versie de meest recente is, moet je hier invullen welk versienummer KISS moet meegeven.
| |REGISTERS__N__KLANTEN_BASE_URL |URL van de Klanten API van het gebruikte Klantenregister
Meer informatie Bijvoorbeeld `https://klantenregister.mijngemeente.nl/klanten`
| |REGISTERS__N__KLANTEN_CLIENT_ID |ClientId voor de Klanten API van het gebruikte Klantenregister. | |REGISTERS__N__KLANTEN_CLIENT_SECRET |Secret voor de Klanten API van het gebruikte Klantenregister.
**(min. 32 karakters)** | ### KISS-frontend, overige bronnen | Variabele | Uitleg | | --------------------------------- | -------------------------------------------------------------------------------------------- | | `HAAL_CENTRAAL_BASE_URL` | URL van de Haal Centraal API
Meer informatie Bijvoorbeeld: `https://proefomgeving.haalcentraal.nl/haalcentraal/api`
| | `HAAL_CENTRAAL_API_KEY` | Key voor de Haal Centraal API | | `KVK_BASE_URL` | URL van de KvK-API
Meer informatie URL van de KvK-API om het Handelsregister te bevragen. Dit is het pad voorafgaand aan het versienummer, bijvoorbeeld `https://api.kvk.nl/test/api`
| | `KVK_API_KEY` | Key voor de KvK-API | | `ELASTIC_BASE_URL` | De URL voor Elasticsearch
Meer informatie Bijvoorbeeld: `https://kiss-es-http:9200`
| | `ELASTIC_USERNAME` | Username om in te loggen op Elasticsearch
Meer informatie Dit kan de default root user `elastic` zijn, maar ook de username van een gebruiker die je zelf hebt aangemaakt.
| | `ELASTIC_PASSWORD` | Wachtwoord voor de bovenstaande user
Meer informatie Als je gebruik maakt van [ECK](https://www.elastic.co/guide/en/cloud-on-k8s/2.8/k8s-overview.html), dan kun je het wachtwoord van de default user vinden, m.b.v. het commando `kubectl get secret kiss-es-elastic-user -o go-template='{{.data.elastic \| base64decode}}'`
| | `ELASTIC_EXCLUDED_FIELDS_KENNISBANK` | Velden die een Kennisbank-gebruiker niet mag doorzoeken en inzien.
Meer informatie Als deze variabele gespecificeerd is dan kan een Kennisbank-gebruiker niet in deze velden zoeken. Deze velden zijn dan ook niet zichtbaar voor de gebruiker. Men moet de veldnamen specificeren zoals ze geconfigureerd zijn in Elasticsearch. Men kan meerdere velden specificeren, gescheiden door een komma. Bijvoorbeeld: `VAC.toelichting,Kennisbank.vertalingen.deskMemo`
| | `ENTERPRISE_SEARCH_BASE_URL` | URL van de API waarop KISS de elastic instantie kan bevragen
Meer informatie Bijvoorbeeld `https://kiss-ent-http:3002`
| | `ENTERPRISE_SEARCH_PRIVATE_API_KEY` | Private API key voor Elastic API
Meer informatie De API key die nodig is om de `engine`s bij te werken
| | `ENTERPRISE_SEARCH_ENGINE` | De naam van de `meta-engine` engine die KISS gebruikt. **Let op**: deze waarde moet **lowercase** zijn, bijvoorbeeld: `kiss-engine`
Meer informatie De KISS-Elastic-Sync maakt deze engine aan, als deze nog niet bestaat.
| | `AFDELINGEN_BASE_URL` | URL van de Objecten API voor afdelingen.
Meer informatie Bijvoorbeeld: `https://objectenregister.mijngemeente.nl`
| | `AFDELINGEN_OBJECT_TYPE_URL` | URL van het Objecttype Afdeling
Meer informatie Bijvoorbeeld: `https://objecttypenregister.mijngemeente.nl/api/v2/objecttypes/f83fdc48-5ddb-4b1a-a347-e20092031399`
| | `AFDELINGEN_TOKEN` | Token voor Objecten API voor afdelingen | | `GROEPEN_BASE_URL` | URL van de Objecten API voor groepen.
Meer informatie Bijvoorbeeld: `https://objectenregister.mijngemeente.nl`
| | `GROEPEN_OBJECT_TYPE_URL` | URL van het Objecttype Groep
Meer informatie Bijvoorbeeld: `https://objecttypenregister.mijngemeente.nl/api/v2/objecttypes/f83fdc48-5ddb-4b1a-a347-e20092031399`
| | `GROEPEN_TOKEN` | Token van de Objecten API voor groepen | | `VAC_OBJECTEN_BASE_URL` | URL van de Objecten API voor VAC's
Meer informatie Bijvoorbeeld: `https://objectenregister.mijngemeente.nl`
| | `VAC_OBJECT_TYPE_URL` | URL van het Objecttype VAC
Meer informatie Bijvoorbeeld `https://objecttypenregister.mijngemeente.nl/api/v2/objecttypes/f83fdc48-5ddb-4b1a-a347-e20092031399`
| | `VAC_OBJECT_TYPE_VERSION` | Versienummer van het Objecttype VAC
Meer informatie Bijvoorbeeld `2`
Als de Environment Variabel `USE_VACS` op `true` staat, zal KISS Vacs wegschrijven in het Objectenregister. Hierbij moet je altijd de versie van het objecttype meegeven. Omdat het per gemeente kan verschillen welke versie de meest recente is, moet je hier invullen welk versienummer KISS moet meegeven.
| | `VAC_OBJECTEN_TOKEN` | Token voor de Objecten API voor VAC's
Meer informatie In het geval van Vacs identificeert KISS zich bij een Objectenregistratie m.b.v. een `TOKEN`. Als de Environment Variabel `USE_VACS` op `true` staat, dan moet dit token lees- én schrijfrechten hebben.
| ### Logboek Het logboek bevat informatie over de afhandeling van een contactverzoek in ITA (Internetaak Afhandel Component). Deze informatie wordt in KISS bij de contactverzoeken van een klant getoond. Deze variabelen zijn niet verplicht. Als je nog geen gebruik maakt van ITA, dan mag je ze leeg laten. Als je er wel gebruik van maakt, vul ze dan alle vier in. | Variabele | Uitleg | | --------------------------------- | -------------------------------------------------------------------------------------------- | | `LOGBOEK_BASE_URL` | URL van de Objecten API waarin het logboek is opgeslagen | | `LOGBOEK_TOKEN` | Token voor de Objecten API voor Logboeken | | `LOGBOEK_OBJECT_TYPE_URL` | URL van het Objecttype Logboek. Bijvoorbeeld `https://objecttypenregister.mijngemeente.nl/api/v2/objecttypes/12345678-5ddb-4b1a-a347-e20092031399`. | | `LOGBOEK_OBJECT_TYPE_VERSION` | Versienummer van het Objecttype Logboek. Bijvoorbeeld `1` | ### KISS-Elastic-Sync
Meer informatie KISS-Elastic-Sync is het component dat zorgt dat de gekoppelde bronnen die via Elasticsearch ontsloten worden in KISS, naar de juiste Indexen worden gepushed, met de benodigde gegevens hieraan toegevoegd. Onderstaande environment variabelen gaan over de bronnen die gekoppeld zijn aan de KISS-Elastic-Sync.
| Variabele | Uitleg | | -------------------------------------| -------------------------------------------------------------------------------------------------------- | | `ENTERPRISE_SEARCH_BASE_URL` | URL van de API voor de elastic instantie | | `ENTERPRISE_SEARCH_PRIVATE_API_KEY` | Private API key voor Elastic | | `ELASTIC_BULK_HTTP_TIMEOUT_MINUTES` | Timeout in minuten voor de bulk http requests richting elasticsearch ten behoeve van het synchroniseren van gegevens naar de zoekindex.
Meer informatie Default waarde is `10`. Pas deze waarde aan als je grote hoeveelheden informatie synchroniseert en timeouts ondervindt in de sync jobs.
| | `MEDEWERKER_OBJECTEN_BASE_URL` | URL van de Objecten API voor medewerkers
Meer informatie Bijvoorbeeld: `https://objectenregister.mijngemeente.nl`
| | `MEDEWERKER_OBJECTEN_TOKEN` | Token voor de Objecten API voor medewerkers
**(Als deze variabele een waarde heeft, moeten MEDEWERKER_OBJECTEN_CLIENT_SECRET en MEDEWERKER_OBJECTEN_CLIENT_ID leeg blijven)**
Meer informatie In de meeste gevallen identificeert KISS zich bij een Objectenregistratie m.b.v. een `TOKEN`. In sommige gevallen is het nodig om de authenticatie in de Objecten API, voor Afdelingen, Groepen en Interne Taken, Medewerkers in te regelen m.b.v. een `client secret` en een `client id`. Dit is bv. het geval als je KISS gebruikt i.c.m. de e-Suite. Afhankelijk van de situatie moet je dus een Token inregelen, en in andere gevallen een id+secret. **NOOIT ALLEBEI!** Let op: alle 3 de variabelen moeten wel aanwezig zijn.
| | `MEDEWERKER_OBJECTEN_CLIENT_ID` | Client ID voor de Objecten API voor medewerkers
**(Als deze variabele een waarde heeft, moet MEDEWERKER_OBJECTEN_TOKEN leeg blijven)**
Meer informatie In de meeste gevallen identificeert KISS zich bij een Objectenregistratie m.b.v. een `TOKEN`. In sommige gevallen is het nodig om de authenticatie in de Objecten API, voor Afdelingen, Groepen en Interne Taken, Medewerkers in te regelen m.b.v. een `client secret` en een `client id`. Dit is bv. het geval als je KISS gebruikt i.c.m. de e-Suite. Afhankelijk van de situatie moet je dus een Token inregelen, en in andere gevallen een id+secret. **NOOIT ALLEBEI!** Let op: alle 3 de variabelen moeten wel aanwezig zijn.
| | `MEDEWERKER_OBJECTEN_CLIENT_SECRET` | Client Secret voor de Objecten API voor medewerkers
**(Als deze een waarde heeft, deze variabele MEDEWERKER_OBJECTEN_TOKEN leeg blijven)**
Meer informatie In de meeste gevallen identificeert KISS zich bij een Objectenregistratie m.b.v. een `TOKEN`. In sommige gevallen is het nodig om de authenticatie in de Objecten API, voor Afdelingen, Groepen en Interne Taken, Medewerkers in te regelen m.b.v. een `client secret` en een `client id`. Dit is bv. het geval als je KISS gebruikt i.c.m. de e-Suite. Afhankelijk van de situatie moet je dus een Token inregelen, en in andere gevallen een id+secret. **NOOIT ALLEBEI!** Let op: alle 3 de variabelen moeten wel aanwezig zijn.
| | `MEDEWERKER_OBJECT_TYPE_URL` | URL van het Objecttype Medewerker
Meer informatie Bijvoorbeeld `https://objecttypenregister.mijngemeente.nl/api/v2/objecttypes/f83fdc48-5ddb-4b1a-a347-e20092031399`
| | `VAC_OBJECTEN_BASE_URL` | URL van de Objecten API voor VAC's
Meer informatie Bijvoorbeeld: `https://objectenregister.mijngemeente.nl`
| | `VAC_OBJECT_TYPE_URL` | URL van het Objecttype VAC
Meer informatie Bijvoorbeeld `https://objecttypenregister.mijngemeente.nl/api/v2/objecttypes/f83fdc48-5ddb-4b1a-a347-e20092031399`
| | `VAC_OBJECTEN_TOKEN` | Token voor de Objecten API voor VAC's
Meer informatie In het geval van Vacs identificeert KISS zich bij een Objectenregistratie m.b.v. een `TOKEN`.
| | `SDG_OBJECTEN_BASE_URL` | URL van de API voor Kennisartikelen
Meer informatie Bijvoorbeeld: `https://objectenregister.mijngemeente.nl`
| | `SDG_OBJECTEN_TOKEN` | Key voor de API voor Kennisartikelen | | `SDG_OBJECT_TYPE_URL` | URL van het Objecttype Kennisartikel
Meer informatie Bijvoorbeeld `https://objecttypenregister.mijngemeente.nl/api/v2/objecttypes/f83fdc48-5ddb-4b1a-a347-e20092031399`
| | `SHAREPOINT_CLIENT_ID` | Client ID (application ID) van de SharePoint-app-registratie.
Deze app registratie heeft de API-permissie permissie `Sites.Read.All` nodig. Voorbeeld: `0166786a-df05-4e1c-a75c-7c3317002ad8`. | | `SHAREPOINT_TENANT_ID` | Azure AD tenant-ID voor de SharePoint-app-registratie (GUID).
Voorbeeld: `bd7f67dd-fc8c-4a9d-a1aa-c2e4d687b18f` | | `SHAREPOINT_CLIENT_SECRET` | Client secret voor de SharePoint-app-registratie. *(Gevoelig)* | | `SHAREPOINT_SITE_URL` | Volledige SharePoint-site-URL die gecrawld moet worden.
Meer informatieAls dit een Hubsite is, of als deze site subsites heeft, worden alle onderliggende / gerelateerd sites ook geindexeerd. KISS biedt ondersteuning voor 'moderne' sitepages en traditionele wikipages. Voorbeeld: `https://my-tenant.sharepoint.com/sites/my-site`
| | `SHAREPOINT_SOURCE_NAME` | Een mensvriendelijke naam voor de SharePoint-bron zoals die zichtbaar wordt in de zoekbalk in KISS.
Meer informatieVoorbeeld: *ICATT SharePoint Test Site*
| ### Gebruik KISS met proxy voor BRP / KvK (bijvoorbeeld iConnect) Proxy's voor de BRP en KvK, zoals bijvoorbeeld iConnect, vereisen vaak bepaalde headers. KISS ondersteunt dit met behulp van omgevingsvariabelen: - Als de identificatie van de ingelogde gebruiker in een header doorgegeven moet worden, kan dit met `HAAL_CENTRAAL_USER_HEADER_NAME` en `KVK_USER_HEADER_NAME`. Als waarde wordt dan de geconfigureerde `OIDC_MEDEWERKER_IDENTIFICATIE_CLAIM` meegegeven. - Als er statische informatie in headers meegegeven moet worden, kan dit volgens dit stramien: `HAAL_CENTRAAL_CUSTOM_HEADERS__headername=headervalue` en `KVK_CENTRAAL_CUSTOM_HEADERS__headername=headervalue`. - Als er statische informatie in de headers voor de BRP koppeling meegegeven moet worden, **specifiek voor een bepaald type zoekopdracht**, kan dit volgens het stramien: `HAAL_CENTRAAL_CUSTOM_HEADERS__headername__zoektype=headervalue` Een voorbeeld voor iConnect: ```bash HAAL_CENTRAAL_USER_HEADER_NAME=x-gebruiker HAAL_CENTRAAL_CUSTOM_HEADERS__x-doelbinding=BRPACT-ZoekenAlgemeen HAAL_CENTRAAL_CUSTOM_HEADERS__x-doelbinding__RaadpleegMetBurgerservicenummer=BRPACT-Totaal HAAL_CENTRAAL_CUSTOM_HEADERS__x-verwerking=Burgerzaken KVK_CUSTOM_HEADERS__x-origin-oin=00000000000000000000 ``` ## KISS-frontend, feature switches | Variabele | Uitleg | | --------------------------------- | -------------------------------------------------------------------------------------------- | | `USE_VACS` | Deze variabele bepaalt of het navigatie-item voor het beheren van VAC's aanwezig is in de beheernavigatie. **Let op**: als de waarde op `true` staat, moet `VAC_OBJECTEN_TOKEN` óók schrijfrechten hebben. Ook moet `VAC_OBJECT_TYPE_VERSION` ingesteld staan op de juiste waarde.
Meer informatie Als deze variabele op `true` staat, is het Vacs-item zichtbaar en kunnen beheerders gebruikmaken van de functionaliteit. Als de variabele niet op true staat, of niet is ingesteld, zal het item niet aanwezig zijn in de beheernavigatie.
| | `USE_MEDEWERKEREMAIL` | Deze variabele bepaalt of een contactverzoek voor een medewerker alléén op e-mailadres kan.
Meer informatie Als deze variabele op `true` staat, zal in het contactverzoek-formulier, onder de geselecteerde afdeling of groep, een veld staan om het emailadres van een medewerker in te voeren. Direct een contactverzoek voor een medewerker maken kan in deze situatie niet. Het veld e-mailadres is niet verplicht. Als de variabele niet op `true` staat, geen waarde heeft of afwezig is, heb je in KISS wel de mogelijkheid om een Contactverzoek voor een medewerker te maken, en kun je in KISS de medewerker uit een lijst kiezen op naam.
|