Koppelingen
Inhoud
Algemeen
De volgende koppelingen kunnen beheerd worden vanuit het zaaksysteem:
- BAG import via CSV
- Key2Finance
- Key2Burgerzaken
- StUF Koppeling Configuratie
- StUF Koppeling (PRS)
- StUF Koppeling (NNP)
- StUF Koppeling (ADR)
- StUF Koppeling (VBO)
Transactieoverzicht
In dit overzicht worden alle transacties en basisgegevens weergegeven. Er kan gefilterd worden per koppeling en op fouten, zodat de beheerder eventuele problemen snel kan ontdekken en actie ondernemen. Door op de transactie te klikken kan deze in meer detail worden bekeken.
Configuratiescherm
Op het configuratiescherm worden de instellingen van de koppelingen beheerd en kunnen nieuwe koppelingen worden aangemaakt.
Instellingen die elke koppeling heeft zijn:
- API
- Zaaktype
- Gegevensmapping
- Status (actief / niet actief)
Afnemerindicaties
&&&aanvullen
Screenshots
- Koppelingen transactieoverzicht.png
Transactieoverzicht
- Koppelingen configuratiescherm.png
Configuratiescherm
- Koppelingen afnemerindicaties.png
Afnemerindicaties
Koppelingen
Active Directory
BAG-import
BuitenBeter
DigiD
eHerkenning
Key2Burgerzaken
Key2Financien
Dit is een export feature die zaken met financiele informatie exporteert, en na een complete export de zaken sluit.
Configuratie
Maak eerst een exportprofiel aan:
- Ga naar het configuratiescherm en klik op de plusknop
- Selecteer het type 'Key2Finance'
- Geef een naam op, bijvoorbeeld die van het product in kwestie
Stel nu de volgende instellingen in:
- Geef een API key op, met de key kan een externe partij authenticeren.
Een goede method om een key te genereren is een GUID tool zoals http://www.guidgenerator.com - Kies een zaaktype waarop gefilterd moet worden. De exportmodule zal alle zaken selecteren van dat zaaktype die klaar staan om afgerond te worden. Dat wil o.a. zeggen dat een resultaat ingevuld is, alle verplichte velden aanstaan en de zaak in de laatste fase is.
- Stel vervolgens de gegevensmapping in. Een uitgebreide beschrijving hiervan volgt hieronder.
- Activeer de koppeling
In de gegevensmapping worden twee kolommen getoond. De linkerkolom toont de namen van de 'kolommen' van het CSV bestand. De rechterkolom moet ingevuld worden met de (systeem)kenmerken. Bij de export wordt de data uit die kenmerken geplaatst in de kolommen van het CSV bestand.
Bestand:Koppeling key2finance gegevensmapping.png
Uitvoer
Het uitvoeren van de export bestaat uit 4 stappen. Elke stap is het invoeren van een URL in de navigatiebalk van de browser. In de URL's moeten verschillende variabele handmatig worden ingevoerd. Vervang hiervoor simpewel '<dit>' gedeelte door de variabele, bijvoorbeeld: '52'
De variabelen:
- <omgeving> = gemeentenaam.zaaksysteem.nl
- <interface_id> = Het nummer dat achter de koppelingnaam op het configuratieoverzicht staat
- <api_key> = De variabele die in het API-veld is ingevoerd in de configuratie van de koppeling
- <transactionID> = Het cijfer dat aan het einde van de pagina staat die je ziet na het invoeren de eerste URL
- Transactie klaarzetten:
https://<omgeving>.zaaksysteem.nl/sysin/interface/<interface_id>/trigger/set_case_list?api_key=<api_key>
Helemaal onderaan staat het ‘transaction_id’, welke nodig is in de volgende stappen.
- STDDEB.csv downloaden
https://<omgeving>.zaaksysteem.nl/sysin/interface/<interface_id>/trigger/get_csv_deb?zapi_format=csv&transaction_id=<transactionID>&api_key=<api_key>
- STDNAW.csv downloaden
https://<omgeving>.zaaksysteem.nl/sysin/interface/<interface_id>/trigger/get_csv_naw?zapi_format=csv&transaction_id=<transactionID>&api_key=<api_key>
- Transactie afsluiten
https://<omgeving>.zaaksysteem.nl/sysin/interface/<interface_id>/trigger/close_cases?transaction_id=<transactionID>&api_key=<api_key>
Dit maakt de transactie af, en sluit de geexporteerde zaken.
Let op: Fase acties worden niet uitgevoerd. De zaak wordt afgesloten dmv. de vroegtijdig afsluiten methode.