Systeemdocumentatie

Generieke systeemdocumentatie

Het zaaksysteem bestaat uit verschillende krachtige open source oplossingen die nauw met elkaar samenwerken. Om het zaaksysteem goed te kunnen begrijpen, is het dus ook noodzakelijk om de onderliggende componenten te begrijpen. Dit kan je verder helpen om het zaaksysteem te verbeteren.

Apache HTTP Server

Website:
http://httpd.apache.org/

Webdocumentatie:
http://httpd.apache.org/docs/

Catalyst Web Framework

Website:
http://www.catalystframework.org/

Webdocumentatie:
http://search.cpan.org/dist/Catalyst-Manual/lib/Catalyst/Manual.pm

jQuery Javascript Library

Website:
http://jquery.com/

Webdocumentatie:
http://docs.jquery.com/Main_Page

OpenLDAP

Website:
http://www.openldap.org/

Webdocumentatie:
http://www.openldap.org/devel/admin/

OpenOffice (Headless Mode)

Website:
http://www.openoffice.org

Headless documentatie:
http://www.openvpms.org/documentation/install-openoffice-headless-service-ubuntu

PostgreSQL

Website:
http://www.postgresql.org/

Webdocumentatie:
http://www.postgresql.org/docs/

Specifieke documentatie

Databasemodellen

Gegevensmagazijn:
http://zaaksysteem.nl/wp-dev/wp-content/uploads/2012/03/Bijlage-5-Gegevensmagazijn.pdf

Zaaktypecatalogus:
http://zaaksysteem.nl/wp-dev/wp-content/uploads/2012/03/Bijlage-7-ZTC.pdf

Zakenmagazijn:
http://zaaksysteem.nl/wp-dev/wp-content/uploads/2012/03/Bijlage-6-Zakenmagazijn_2_0.pdf

- Korte uitleg (Zaken obv JSON)

Zaaksysteem biedt een mogelijk om zoekopdrachten te publiceren. De resultaten van deze zoekopdracht zijn vervolgens publiekelijk op te vragen, en worden terug gegeven in JSON-formaat.

- Welke data kan opgevraagd worden?

De resultaten van een (in Zaaksysteem gepubliceerde) zoekopdracht.

Om het in het begin niet te complex te maken, is ervoor gekozen om niet alle data op te kunnen halen, maar generieke data die voor elke zaak van toepassing is. Deze mogelijke kenmerken zijn:

• 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 } ] ] }

NEN2082

Meer informatie over de NEN2082 Norm:
http://www.nen2082.nl

Uitwerking van de NEN2082 norm binnen het zaaksysteem:
http://wiki.zaaksysteem.nl/nen2082

Beheertools

LibreOffice

Voor het beheren van de sjablonen kan OpenOffice of LibreOffice worden gebruikt. Het is ook mogelijk om sjablonen te beheren met Microsoft Office, maar dat moet er in sommige gevallen een plugin worden geinstalleerd om ODF-bestanden te lezen en op te slaan. Bij zaaksysteem.nl adviseren we om gebruik te maken van LibreOffice. Hiermee kunnen sjablonen worden gemaakt en gewijzigd worden. Daarnaast is het met LibreOffice altijd mogelijk om alle toegestane bestandsformaten te lezen.
http://www.libreoffice.org/download/

Apache Directory Studio

Voor de authenticatie wordt gebruik gemaakt van OpenLDAP. Hoewel het zaaksysteem zelf functionaliteit bevat voor het beheren van rollen en rechten, kan het mogelijk zijn dat er bijzondere werkzaamheden moeten worden uitgevoerd. Denk hierbij aan migraties of het ontwerpen van nieuwe schema's. Voor dit soort werkzaamheden kan gebruik worden gemaakt van Apache Direcory Studio. Dit is een open source tool waarmee de OpenLDAP van het zaaksysteem kan worden beheerd.
http://directory.apache.org/studio/downloads.html

Evince PDF Reader

Een bestandformaat wat veel voorkomt binnen het zaaksysteem is PDF (Portable Document Format). Evince Is een open source tool voor het lezen van diverse documentformaten, waaronder PDF.
http://live.gnome.org/Evince/Downloads

JDigest MD5, SHA-1 calculator and verifier

Alle bestanden binnen het zaaksysteem krijgen een MD5-hash om de integriteit te kunnen toetsen. JDigest is een open source tool waarmee om handmatige wijze de integriteit van de bestanden kan worden getoetst.
http://code.google.com/p/jdigest/

Koppelingen Zaaksysteem.nl

Zaaksysteem.nl maakt gebruik van verschillende koppelingen. Hoewel de meeste volledig automatisch plaatsvinden, kunnen enkele koppelingen ook handmatig worden bijgewerkt. Op de pagina hieronder vind je de documentatie over het gebruik van deze bestanden.

ZaaksysteemKoppelingen

Community edition README

Het zaaksysteem.nl is een complete oplossing (all-in-one) voor gemeenten om de dienstverlening te verbeteren. Het biedt functionaliteit voor burgers en medewerkers om zaken af te handelen vanuit huis, in het KCC of in de backoffice.

Zaaksysteem.nl is het enige zaaksysteem in Nederland dat volledig is ontwikkeld in en als open source software. Dit is gedaan onder andere gedaan om zoveel mogelijk te voldoen aan het landelijke beleid en om gemeenten een gunstig tarief te bieden.

Hier vind je het installatiedocument OpenSource-README