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.

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

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.

KVK-import

Ogone

StUF-PRS

StUF-PRS attributes

    'required'      => [qw/
        straatnaam
        huisnummer
        postcode

        burgerservicenummer
        geslachtsnaam
        geslachtsaanduiding
        geboortedatum
    /],
    'optional'      => [qw/
        voornamen
        huisnummertoevoeging
        huisletter
        woonplaats
        geboorteplaats
        geboorteland
        a_nummer
[...]

StUF-PRS example message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <soapenv:Body>
  <BG:kennisgevingsBericht xmlns:BG="http://www.egem.nl/StUF/sector/bg/0204" xmlns:StUF="http://www.egem.nl/StUF/StUF0204" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StUF:stuurgegevens xmlns="http://www.egem.nl/StUF/StUF0204">
   <StUF:berichtsoort>Lk01</StUF:berichtsoort>
   <StUF:entiteittype>PRS</StUF:entiteittype>
   <StUF:sectormodel>BG</StUF:sectormodel>
   <StUF:versieStUF>0204</StUF:versieStUF>
   <StUF:versieSectormodel>0204</StUF:versieSectormodel>
   <StUF:zender>
    <StUF:applicatie>CMODIS</StUF:applicatie>
   </StUF:zender>
   <StUF:ontvanger>
    <StUF:applicatie>ZSNL</StUF:applicatie>
   </StUF:ontvanger>
   <StUF:referentienummer>MK0000229154</StUF:referentienummer>
   <StUF:tijdstipBericht>2012110209011458</StUF:tijdstipBericht>
   <StUF:kennisgeving>
    <StUF:mutatiesoort>T</StUF:mutatiesoort>
    <StUF:indicatorOvername>V</StUF:indicatorOvername>
   </StUF:kennisgeving>
  </StUF:stuurgegevens>
  <BG:body xmlns="http://www.egem.nl/StUF/sector/bg/0204">
   <BG:PRS StUF:sleutelGegevensbeheer="1243796" StUF:sleutelVerzendend="1243796" StUF:verwerkingssoort="T" soortEntiteit="F">
    <BG:a-nummer>1234567890</BG:a-nummer>
    <BG:bsn-nummer>987654321</BG:bsn-nummer>
    <BG:voornamen>Tinues</BG:voornamen>
    <BG:voorletters>V</BG:voorletters>
    <BG:geslachtsnaam>Testpersoon</BG:geslachtsnaam>
    <BG:geboortedatum>19620529</BG:geboortedatum>
    <BG:geslachtsaanduiding>M</BG:geslachtsaanduiding>
    <BG:tijdvakGeldigheid>
     <StUF:begindatumTijdvakGeldigheid>19620529</StUF:begindatumTijdvakGeldigheid>
     <StUF:einddatumTijdvakGeldigheid StUF:noValue="geenWaarde" xsi:nil="true"/>
    </BG:tijdvakGeldigheid>
    <BG:PRSADRVBL StUF:sleutelGegevensbeheer="1243798" StUF:sleutelVerzendend="1243798" StUF:verwerkingssoort="T" soortEntiteit="R">
     <BG:tijdvakRelatie>
      <StUF:begindatumRelatie>20121030</StUF:begindatumRelatie>
      <StUF:einddatumRelatie StUF:noValue="geenWaarde" xsi:nil="true"/>
     </BG:tijdvakRelatie>
     <BG:extraElementen>
      <StUF:extraElement naam="aanduidingGegevensInOnderzoek">N</StUF:extraElement>
     </BG:extraElementen>
     <BG:ADR StUF:sleutelGegevensbeheer="22628" StUF:sleutelVerzendend="22628" StUF:verwerkingssoort="T" soortEntiteit="F">
      <BG:postcode>1015JL</BG:postcode>
      <BG:woonplaatsnaam>Amsterdam</BG:woonplaatsnaam>
      <BG:straatnaam>Donker Curtiusstraat</BG:straatnaam>
      <BG:huisnummer>7</BG:huisnummer>
      <BG:ingangsdatum>19511115</BG:ingangsdatum>
      <BG:einddatum StUF:noValue="geenWaarde" xsi:nil="true"/>
      <BG:extraElementen>
       <StUF:extraElement naam="officieleStraatnaam">Donker Curtiusstraat</StUF:extraElement>
       <StUF:extraElement naam="identificatieNummerAanduiding">0716200000762034</StUF:extraElement>
       <StUF:extraElement naam="authentiekeWoonplaatsnaam">Amsterdam</StUF:extraElement>
       <StUF:extraElement naam="identificatiecodeVerblijfplaats">0716010000028347</StUF:extraElement>
       <StUF:extraElement naam="identificatieTGO">0716010000028347</StUF:extraElement>
       <StUF:extraElement naam="openbareRuimteNaam">Donker Curtiusstraatt</StUF:extraElement>
       <StUF:extraElement naam="identificatieAOA">0716200000762034</StUF:extraElement>
       <StUF:extraElement naam="woonplaatsNaamBAG">Amsterdam</StUF:extraElement>
      </BG:extraElementen>
     </BG:ADR>
    </BG:PRSADRVBL>
   </BG:PRS>
  </BG:body>
 </BG:kennisgevingsBericht>
</soapenv:Body></soapenv:Envelope>

LET OP: Bovenstaande gegevens zijn geen reflectie van de werkelijkheid

StUF-ADR

StUF-ADR attributes

        required    => [qw/
            identificatie
            woonplaats
            openbareruimte
            postcode
            huisnummer
            status
            inonderzoek
        /],
        optional    => [qw/
            huisletter
            huisnummertoevoeging

            correctie
            documentnummer
            documentdatum
            type
            einddatum
            gebruiksobject_id
            woonplaats_naam
            straatnaam
            officieel
            begindatum
        /],

StUF-ADR example message

    <BG:kennisgevingsBericht xmlns:BG="http://www.egem.nl/StUF/sector/bg/0204" xmlns:StUF="http://www.egem.nl/StUF/StUF0204" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <StUF:stuurgegevens xmlns="http://www.egem.nl/StUF/StUF0204">
        <StUF:berichtsoort>Lk01</StUF:berichtsoort>
        <StUF:entiteittype>ADR</StUF:entiteittype>
        <StUF:sectormodel>BG</StUF:sectormodel>
        <StUF:versieStUF>0204</StUF:versieStUF>
        <StUF:versieSectormodel>0204</StUF:versieSectormodel>
        <StUF:zender>
          <StUF:applicatie>ZNDAPP</StUF:applicatie>
        </StUF:zender>
        <StUF:ontvanger>
          <StUF:applicatie>ONTVAPP</StUF:applicatie>
        </StUF:ontvanger>
        <StUF:referentienummer>ZS0000000001</StUF:referentienummer>
        <StUF:tijdstipBericht>2012112316002368</StUF:tijdstipBericht>
        <StUF:kennisgeving>
          <StUF:mutatiesoort>T</StUF:mutatiesoort>
          <StUF:indicatorOvername>V</StUF:indicatorOvername>
        </StUF:kennisgeving>
      </StUF:stuurgegevens>
      <BG:body xmlns="http://www.egem.nl/StUF/sector/bg/0204">
        <BG:ADR StUF:sleutelGegevensbeheer="27178" StUF:sleutelVerzendend="27178" StUF:verwerkingssoort="T" soortEntiteit="F">
          <BG:postcode>1015XK</BG:postcode>
          <BG:woonplaatsnaam>Amsterdam</BG:woonplaatsnaam>
          <BG:straatnaam>Donker Curtiusstraat</BG:straatnaam>
          <BG:huisnummer>7</BG:huisnummer>
          <BG:huisletter></BG:huisletter>
          <BG:huisnummertoevoeging>414</BG:huisnummertoevoeging>
          <BG:aanduidingBijHuisnummer StUF:noValue="geenWaarde" xsi:nil="true"/>
          <BG:locatieomschrijving StUF:noValue="nietGeautoriseerd" xsi:nil="true"/>
          <BG:locatieadresnummer StUF:noValue="nietGeautoriseerd" xsi:nil="true"/>
          <BG:ingangsdatum>20070403</BG:ingangsdatum>
          <BG:einddatum StUF:noValue="geenWaarde" xsi:nil="true"/>
          <BG:straatcode>9999</BG:straatcode>
          <BG:buurtcode>0</BG:buurtcode>
          <BG:wijkcode>0</BG:wijkcode>
          <BG:gemeentecode>363</BG:gemeentecode>
          <BG:tijdvakGeldigheid>
            <StUF:begindatumTijdvakGeldigheid>20100302</StUF:begindatumTijdvakGeldigheid>
            <StUF:einddatumTijdvakGeldigheid StUF:noValue="geenWaarde" xsi:nil="true"/>
          </BG:tijdvakGeldigheid>
          <BG:extraElementen>
            <StUF:extraElement naam="officieleStraatnaam">Donker Curtiusstraat</StUF:extraElement>
            <StUF:extraElement naam="aanduidingGegevensInOnderzoek">N</StUF:extraElement>
            <StUF:extraElement naam="identificatieNummerAanduiding">0363200000756684</StUF:extraElement>
            <StUF:extraElement naam="authentiekeIdentificatieOpenbareRuimte">0363300000000059</StUF:extraElement>
            <StUF:extraElement naam="authentiekeIdentificatieWoonplaats">1024</StUF:extraElement>
            <StUF:extraElement naam="authentiekeWoonplaatsnaam">Amsterdam</StUF:extraElement>
            <StUF:extraElement naam="statusCodeOmschrijving">Naamgeving uitgegeven</StUF:extraElement>
            <StUF:extraElement naam="identificatiecodeVerblijfplaats">0363010000032757</StUF:extraElement>
            <StUF:extraElement naam="status">Naamgeving uitgegeven</StUF:extraElement>
            <StUF:extraElement naam="identificatieTGO">0363010000032757</StUF:extraElement>
            <StUF:extraElement naam="identificatieWoonplaats">1024</StUF:extraElement>
            <StUF:extraElement naam="openbareRuimteNaam">Donker Curtiusstraat</StUF:extraElement>
            <StUF:extraElement naam="identificatieAOA">0363200000756684</StUF:extraElement>
            <StUF:extraElement naam="identificatieOpenbareRuimte">0363300000000059</StUF:extraElement>
            <StUF:extraElement naam="woonplaatsNaamBAG">Amsterdam</StUF:extraElement>
          </BG:extraElementen>
        </BG:ADR>
      </BG:body>
    </BG:kennisgevingsBericht>

LET OP: Bovenstaande gegevens zijn geen reflectie van de werkelijkheid

StUF-VBO

StUF-NNP

Telefooncentrale

WOZ-import

Zaakinformatie bevragen

Korte uitleg (Zaken obv JSON)

Zaaksysteem biedt een mogelijk om zaakinformatie op te vragen van zaken die door middel van een publieke zoekopdracht te benaderen. De resultaten (zaakinformtie) van deze zoekopdracht worden terug gegeven in JSON-formaat en kunnen daarna gepresenteerd worden bijvoorbeeld door een CMS.

Welke data kan opgevraagd worden?

De resultaten van zaken in een (publiek gepubliceerde) zoekopdracht. Hierbij is een set van gegevens op te vragen, namelijk:

Zaaknummer (zaak.id)
Zaaktype (zaaktype.naam)
Registratiedatum
Afhandeldatum
Status (zaak.status)
Fase (naam)
Extra informatie (zaak.onderwerp)
Resultaat (zaak.resultaat)

Hoe wordt de data ontvangen?

De data wordt gerouterneerd in JSON formaat. De zaken zelf staan in de property 'result', wat altijd een array is. In het geval van een foutmelding is het eerste object in de 'result' array een foutmeldingobject. In principe wordt de HTTP status code in dit geval ook op 500 gezet. Deze status code zit ook in het antwoord in de property 'status_code'. In de properties 'next' en 'prev' staan de URLs waarmee volgende en vorige pagina's kunnen worden opgevraagd, 'at' is de huidige pagina, 'num_rows' het totaal aantal zaken wat aan de zoekopdrachten voldoet, en 'rows' is het aantal zaken wat in dit antwoord wordt teruggegeven.

Hoe kan data worden bevraagd?

De url van de call is {host}/public/search_case/?search_query_id={id}, waarbij {host} bijvoorbeeld 'https://mintlab.zaalsysteem.nl' is, en {id} het id van de gepubliceerde zoekopdracht.

Hoe moet data worden verwerkt?

De data komt terug in een JSON string, die geparsed moet worden. De hashes met de kenmerken van de gevonden zaken staan in de property 'result' in een array.

Voorbeeldvraag

https://quarterly.zaaksysteem.nl/public/search_case/?search_query_id=1

Voorbeeldantwoord

{
	"next": null,
	"comment": "This is not a DBIx::Class::ResultSet and does NOT support paging.",
	"prev": null,
	"at": null,
	"num_rows": 1,
	"rows": null,
	"result": [
		[
			{
				"afhandeldatum": null,
				"zaaktype": "bagtest",
				"status": "new",
				"fase": "Naam van Fase komt hier",
				"onderwerp": null,
				"registratiedatum": "2013-09-05T12:33:57",
				"resultaat": null,
				"id": 155
			}
		]
	]
}

Zoekopdracht als kaart publiceren

Wanneer in de instellingen wordt opgegeven dat de zoekopdracht gepubliceerd moet kunnen worden, kan ook de kaart gepubliceerd worden.

Bestand:Zoekopdracht instellingen.png

Gebruik hiervoor de volgende link: http://<omgeving>/search/<id>/results/public_map

Variabele	Locatie
<omgeving>	De gemeentenaam uit de zaaksysteem-URL: gemeentenaam.zaaksysteem.nl
<id>	Dit cijfer is terug te vinden in de URL wanneer de zoekopdracht intern bekeken wordt Bestand:Zoekopdracht URL.png

Koppelingen

Inhoud

Algemeen

Transactieoverzicht

Configuratiescherm

Afnemerindicaties

Screenshots

Koppelingen

Active Directory

BAG-import

BuitenBeter

DigiD

eHerkenning

Key2Burgerzaken

Key2Financien

Configuratie

Uitvoer

KVK-import

Ogone

StUF-PRS

StUF-PRS attributes

StUF-PRS example message

StUF-ADR

StUF-ADR attributes

StUF-ADR example message

StUF-VBO

StUF-NNP

Telefooncentrale

WOZ-import

Zaakinformatie bevragen

Korte uitleg (Zaken obv JSON)

Welke data kan opgevraagd worden?

Hoe wordt de data ontvangen?

Hoe kan data worden bevraagd?

Hoe moet data worden verwerkt?

Voorbeeldvraag

Voorbeeldantwoord

Zoekopdracht als kaart publiceren

Navigatiemenu

Zoeken