Koppelprofiel Key2Financien

Inleiding

Dit is een export feature die zaken met financiele informatie exporteert, en na een complete export de zaken sluit.

Koppelprofiel

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

Koppeling toevoegen

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

Koppeling beheren

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.

Gegevensmapping

Gegevens uit gerelateerde zaken

Gegevens uit gerelateerde zaken kunnen opgehaald worden door gebruik te maken van de iteratie-functie, die specifiek voor deze export mogelijk gemaakt is.

Door in een groot tekstveld dezelfde iteratie-syntax te gebruiken als bij e-mailsjablonen worden de magicstrings verwerkt voor de gerelateerde zaken, i.p.v. voor de zaak zelf.

{{ itereer over zaak_relaties
<willekeurige tekst>
}}

Bijvoorbeeld:

{{ itereer over zaak_relaties
[[zaak_bedrag]]
}}

Export

Handmatige 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'

Variabele	Locatie
<omgeving>	De gemeentenaam uit de zaaksysteem-URL: gemeentenaam.zaaksysteem.nl, mijn.gemeentenaam.nl, zaaksysteem-accept.gemeentenaam.nl
<interface_id>	Het cijfer dat achter de naam van de koppeling wordt weergegeven, in het configuratiescherm
<api_key>	De opgegeven tekst in het API-veld de koppeling, in het configuratiescherm
<transactionID>	Deze is terug te vinden onderaan de pagina die getoond wordt na het invoeren van de eerste URL

1. Transactie klaarzetten:
   https://<omgeving>/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.
   


2. STDDEB.csv downloaden
   https://<omgeving>/sysin/interface/<interface_id>/trigger/get_csv_deb?zapi_format=csv&transaction_id=<transactionID>&api_key=<api_key>
   


3. STDNAW.csv downloaden
   https://<omgeving>/sysin/interface/<interface_id>/trigger/get_csv_naw?zapi_format=csv&transaction_id=<transactionID>&api_key=<api_key>
   


4. Transactie afsluiten
   https://<omgeving>/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.

https://<omgeving>/sysin/interface/<interface_id>/trigger/set_case_list?api_key=<api_key>
https://<omgeving>/sysin/interface/<interface_id>/trigger/get_csv_deb?zapi_format=csv&transaction_id=<transactionID>&api_key=<api_key>
https://<omgeving>/sysin/interface/<interface_id>/trigger/get_csv_naw?zapi_format=csv&transaction_id=<transactionID>&api_key=<api_key>
https://<omgeving>/sysin/interface/<interface_id>/trigger/close_cases?transaction_id=<transactionID>&api_key=<api_key>

Geautomatiseerde uitvoer

Deze functionaliteit is nog in ontwikkeling.