Configuratie: Environment Variabelen
Hieronder staan de benodigde environment variabelen per onderdeel van KISS.
Authenticatie
Variabele |
Uitleg |
|---|---|
|
URL van de OpenID Connect Identity Provider |
|
Voor toegang tot de OpenID Connect Identity Provider |
|
Secret voor de OpenID Connect Identity Provider |
|
Identificatie van de medewerker in registers |
|
Optioneel afkappen van de claim |
|
Secret dat KISS gebruikt om het JWT Token |
Autorisatie
Variabele |
Uitleg |
|---|---|
|
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: |
|
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: |
|
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: |
Database
Variabele |
Uitleg |
|---|---|
|
Naam van de database bij KISS |
|
Gebruikersnaam voor toegang van KISS tot de DB |
|
Wachtwoord van de postgresUser |
Organisatie RSIN
Variabele |
Uitleg |
|---|---|
|
RSIN van de organisatie die de |
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 |
|---|---|
|
Afzenderadres van de feedbackmail |
|
Adres waar de feedbackmail naartoe moet |
|
Gebruik van SSL (true/false) |
|
Adres van de mailserver |
|
Poortnummer van de mailverbinding |
|
Gebruikersnaam voor de mailserver |
|
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:
Sommige API-keys en Secrets die KISS nodig heeft om externe registers te bevragen moeten minimaal 32 karakters lang zijn.
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 |
REGISTERS__N__ZAAKSYSTEEM_ZAKEN_BASE_URL |
Volledige base URL voor zaken API inclusief versie |
REGISTERS__N__ZAAKSYSTEEM_CATALOGI_BASE_URL |
Volledige base URL voor catalogi API inclusief versie |
REGISTERS__N__ZAAKSYSTEEM_DOCUMENTEN_BASE_URL |
Volledige base URL voor documenten API inclusief versie |
REGISTERS__N__ZAAKSYSTEEM_BASE_URL |
URL van de ZGW API’s Let op, deprecated. Lees de toelichting hierboven. |
REGISTERS__N__ZAAKSYSTEEM_API_KEY |
API Key voor de ZGW API’s |
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) |
REGISTERS__N__ZAAKSYSTEEM_DEEPLINK_PROPERTY |
Property om naar een zaak te kunnen deeplinken (optioneel) |
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 (optioneel) |
REGISTERS__N__REGISTRY_VERSION |
OpenKlant2 of OpenKlant1 |
————————- |
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 |
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. |
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 |
REGISTERS__N__INTERNE_TAAK_BASE_URL |
URL van de Objecten API voor Interne Taken |
REGISTERS__N__INTERNE_TAAK_CLIENT_ID |
Client ID voor de Interne Taken API |
REGISTERS__N__INTERNE_TAAK_CLIENT_SECRET |
Client Secret voor de Interne Taken API |
REGISTERS__N__INTERNE_TAAK_TOKEN |
Token voor de Objecten API voor Interne Taken |
REGISTERS__N__INTERNE_TAAK_OBJECT_TYPE_URL |
URL van het Objecttype Interne Taak |
REGISTERS__N__INTERNE_TAAK_TYPE_VERSION |
Versienummer van het Objecttype Interne Taak |
REGISTERS__N__KLANTEN_BASE_URL |
URL van de Klanten API van het gebruikte Klantenregister |
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. |
KISS-frontend, overige bronnen
Variabele |
Uitleg |
|---|---|
|
URL van de Haal Centraal API |
|
Key voor de Haal Centraal API |
|
URL van de KvK-API |
|
Key voor de KvK-API |
|
De URL voor Elasticsearch |
|
Username om in te loggen op Elasticsearch |
|
Wachtwoord voor de bovenstaande user |
|
Velden die een Kennisbank-gebruiker niet mag doorzoeken en inzien. |
|
URL van de API waarop KISS de elastic instantie kan bevragen |
|
Private API key voor Elastic API |
|
De naam van de |
|
URL van de Objecten API voor afdelingen. |
|
URL van het Objecttype Afdeling |
|
Token voor Objecten API voor afdelingen |
|
URL van de Objecten API voor groepen. |
|
URL van het Objecttype Groep |
|
Token van de Objecten API voor groepen |
|
URL van de Objecten API voor VAC’s |
|
URL van het Objecttype VAC |
|
Versienummer van het Objecttype VAC |
|
Token voor de Objecten API voor VAC’s |
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 |
|---|---|
|
URL van de Objecten API waarin het logboek is opgeslagen |
|
Token voor de Objecten API voor Logboeken |
|
URL van het Objecttype Logboek. Bijvoorbeeld |
|
Versienummer van het Objecttype Logboek. Bijvoorbeeld |
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 |
|---|---|
|
URL van de API voor de elastic instantie |
|
Private API key voor Elastic |
|
Timeout in minuten voor de bulk http requests richting elasticsearch ten behoeve van het synchroniseren van gegevens naar de zoekindex. |
|
URL van de Objecten API voor medewerkers |
|
Token voor de Objecten API voor medewerkers |
|
Client ID voor de Objecten API voor medewerkers |
|
Client Secret voor de Objecten API voor medewerkers |
|
URL van het Objecttype Medewerker |
|
URL van de Objecten API voor VAC’s |
|
URL van het Objecttype VAC |
|
Token voor de Objecten API voor VAC’s |
|
URL van de API voor Kennisartikelen |
|
Key voor de API voor Kennisartikelen |
|
URL van het Objecttype Kennisartikel |
|
Client ID (application ID) van de SharePoint-app-registratie. |
|
Azure AD tenant-ID voor de SharePoint-app-registratie (GUID). |
|
Client secret voor de SharePoint-app-registratie. (Gevoelig) |
|
Volledige SharePoint-site-URL die gecrawld moet worden. |
|
Een mensvriendelijke naam voor de SharePoint-bron zoals die zichtbaar wordt in de zoekbalk in KISS. |
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_NAMEenKVK_USER_HEADER_NAME. Als waarde wordt dan de geconfigureerdeOIDC_MEDEWERKER_IDENTIFICATIE_CLAIMmeegegeven.Als er statische informatie in headers meegegeven moet worden, kan dit volgens dit stramien:
HAAL_CENTRAAL_CUSTOM_HEADERS__headername=headervalueenKVK_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:
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 |
|---|---|
|
Deze variabele bepaalt of het navigatie-item voor het beheren van VAC’s aanwezig is in de beheernavigatie. Let op: als de waarde op |
|
Deze variabele bepaalt of een contactverzoek voor een medewerker alléén op e-mailadres kan. |