Systeemdocumentatie: verschil tussen versies

Uit ZaaksysteemWiki
Ga naar: navigatie, zoeken
(→‎Generieke systeemdocumentatie)
(→‎Databasemodellen)
 
(75 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 4: Regel 4:
 
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.
 
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.
  
−
=== Catalyst Web Framwork ===
+
=== Docker ===
  
−
[[Bestand:wiki_ztc+.png|thumbnail|left]]
+
[[Bestand:knop_docker.png|left|link=https://www.docker.com/]]
  
−
Wellicht het belangrijkste component van het zaaksysteem is het Catalyst Web Framework. Een krachtig en stabiel MVC wat het hart van het zaaksysteem is.
+
<p>
 +
Website:<br>
 +
https://www.docker.com/
 +
</p>
 +
 
 +
<p>
 +
Webdocumentatie:<br>
 +
https://www.docker.com/
 +
</p>
 +
 
 +
<br clear="all" />
 +
 
 +
=== NginX Web Server ===
 +
 
 +
[[Bestand:knop_nginx.png|left|link=http://httpd.apache.org]]
 +
 
 +
<p>
 +
Website:<br>
 +
http://nginx.org/
 +
</p>
 +
 
 +
<p>
 +
Webdocumentatie:<br>
 +
http://wiki.nginx.org
 +
</p>
 +
 
 +
<br clear="all" />
 +
 
 +
 
 +
=== Catalyst Web Framework (Perl Backend) ===
 +
 
 +
[[Bestand:knop_catalyst.png|left|link=http://httpd.apache.org]]
 +
 
 +
<p>
 +
Website:<br>
 +
http://www.catalystframework.org/
 +
</p>
 +
 
 +
<p>
 +
Webdocumentatie:<br>
 +
http://search.cpan.org/dist/Catalyst-Manual/lib/Catalyst/Manual.pm
 +
</p>
  
 
<br clear="all" />
 
<br clear="all" />
  
−
=== Kenmerken ===
+
=== Pyramid Web Framework (Python Backend) ===
  
−
Kenmerken zijn informatieobjecten die centraal worden opgeslagen, maar meervoudig kunnen worden gebruikt. Het verschil met een kenmerk uit de Gemma ZTC is dat ze niet voor alle zaaktypen gelden. Een voorbeeld. Elke zaak heeft registratiedatum of een zaaknummer, maar niet elke zaak heeft het kenmerk 'Meldingencategorie'. Dit is een specifiek kenmerk voor het zaaktype Melding Openbare Ruimte. Desondanks zijn er kenmerken die meervoudig te gebruiken zijn, zoals het kenmerk 'subsidiebedrag'.
+
[[Bestand:knop_pyramid.png|left|link=https://trypyramid.com/]]
  
−
[[Bestand:wiki_kenmerken1.png|thumbnail|right]]
+
<p>
 +
Website:<br>
 +
https://trypyramid.com/
 +
</p>
  
−
Wanneer een kenmerk wordet aangemaakt dat moet er een <b>invoertype</b> worden bepaald voor dit kenmerk. Het invoertype geeft aan wat het zaaksysteem moet doen wanneer dit kenmerk wordt gebruikt bij een zaaktype. Voorbeelden van invoertypen zijn:
+
<p>
−
* Tekstveld
+
Webdocumentatie:<br>
−
* Keuzemenu (dropdown)
+
https://trypyramid.com/
−
* Meervoudige keuze (Checkbox)
+
</p>
−
* Maps (Google prikkaart)
 
−
* Valuta
 
−
* Etc.
 
  
−
Tevens wordt er voor elk kenmerk direct een <b>'magic sting'</b> aangemaakt. Dit is een variable die het systeem voor verschillende doeleinden gebruikt. Deze kunnen bijvoorbeeld gebruikt worden in de sjablonen en de berichten die naar aanvragers worden verstuurd. Uiteraard vult het zaaksysteem dan de inhoudt in van het betreffende kenmerk.
 
 
<br clear="all" />
 
<br clear="all" />
−
<br />
 
  
−
=== Zaaktypen ===
+
=== Angular Javascript Library (Legacy frontend) ===
  
−
[[Bestand:wiki_ztb_editmilestones.png|thumbnail|right]]
+
[[Bestand:knop_angular.png|left|link=https://angularjs.org/]]
  
−
Een zaaktype is een andere, algemene term voor een proces dat als zaak wordt behandeld, bijvoorbeeld het behandelen van een aanvraag voor een nieuw paspoort. Bij een feitelijke aanvraag van een paspoort door een persoon ontstaat dan een zaak: Paspoort aanvragen door X in het jaar Y’. Elke zaak leidt tot één dossier, een zaakdossier dus. Het onderscheid tussen het begrip ‘proces’, zoals het meestal wordt gebruikt, en het begrip zaaktype is erg belangrijk. Bij zaaktypen spelen het bewaken van de doorlooptijd èn documenten een belangrijke rol. (Passage uit de stukken van Egem)
+
<p>
 +
Website:<br>
 +
https://angularjs.org/
 +
</p>
  
−
Binnen een zaaktype worden uiteindelijk alle legoblokjes (zwaaronder kenmerken en sjablonen)  bij elkaar gebracht en gemodelleerd tot een werkend iets waarmee burgers een aanvraag kunnen en behandelaars de aanvraag af kunnen handelen. Binnen een zaaktype wordt bijvoorbeeld aangegeven welke fasen een aanvraag doorloopt, wat de controlemomenten zijn, welke documenten verplicht zijn en wordt een koppeling met DigiD geactiveerd.
+
<p>
 +
Webdocumentatie:<br>
 +
https://angularjs.org/
 +
</p>
  
−
<br />
+
<br clear="all" />
  
−
== Beheeracties ==
+
=== React Javascript Library (current frontend) ===
  
−
=== Algemene tips voor zaaktypebeheer ===
+
[[Bestand:knop_react.png|left|link=https://reactjs.org/]]
  
−
<p>Het zaaksysteem heeft een eenvoudig zaaktypebeheer wat volledig webbased te gebruiken is. Dit heeft een hoop voordelen. Zo is het niet nodig om software te installeren op je computer en werkt het bijvoorbeeld ook op een iPad. Helaas zijn er ook wat beperkingen. Zo is ook het zaaksysteem gebonden aan de mogelijkheden van de verschillende webbrowsers zoals Internet Explorer, Chrome of Firefox. Om er zeker van de zijn dat je met vol enthousiasme zaaktype kan blijven configureren, hieronder wat tips:</p>
+
<p>
 +
Website:<br>
 +
https://reactjs.org/
 +
</p>
  
 
<p>
 
<p>
−
* '''Publiceer tussentijds.''' Het kan gebeuren dat je sessie verloopt binnen het zaaksysteem. Als je een behoorlijke tijd bezig bent met het bouwen van een zaaktype, is het erg vervelend om te ontdekken dat daardoor je wijzigingen zijn verloren. Vergeet niet zo nu en dan je wijzigingen te publiceren. Op die manier worden de wijzigingen opgeslagen en voorkom je tevens dat je sessie verloopt.
+
Webdocumentatie:<br>
 +
https://reactjs.org/docs/getting-started.html
 
</p>
 
</p>
 +
 +
<br clear="all" />
 +
 +
=== LibreOffice (Headless Mode) ===
 +
 +
[[Bestand:knop_libre.png|left|link=http://www.openoffice.org]]
  
 
<p>
 
<p>
−
* '''Test tussentijds.''' Er zijn veel mogelijkheden binnen het zaaksysteem. Met name bij complexe zaaktypen is het mogelijk dat je door de bomen het bos niet meer ziet. Als je dan een configuratiefout moet opzoeken, kan het een aardige zoektocht worden. Dit is deels te voorkomen door tussentijds je resultaten te testen en je zaaktype stapje voor stapje te bouwen. Als er dan iets gout zit, zie je dit direct en kan je het aanpassen.
+
Website:<br>
 +
http://www.openoffice.org
 
</p>
 
</p>
  
 
<p>
 
<p>
−
* '''Werken met tabbladen.''' Werken met tabbladen in een browser is geen probleem, maar het is te adviseren om niet meerdere tabbladen met hetzelfde zaaktype tegelijk open te hebben. Omdat het zaaksysteem met sessies werkt, kan het voorkomen dat bepaalde instellingen door elkaar worden gehaald. Mocht je dus hetzelfde zaaktype in twee vensters willen, open dit dan in twee verschillende browsers.
+
Headless documentatie:<br>
 +
http://www.openvpms.org/documentation/install-openoffice-headless-service-ubuntu
 
</p>
 
</p>
 +
 +
<br clear="all" />
 +
 +
=== Aurora Database (AWS PostGreSQL) ===
 +
 +
[[Bestand:knop_aurora.png|left|link=https://aws.amazon.com/rds/aurora/]]
  
 
<p>
 
<p>
−
* '''Kenmerken publiceren voor gebruik regels.''' Een mooie functionaliteit is het kunnen toepassen van regels op de kenmerken. Om een regel te kunnen gebruiken moet eerst alle kenmerken zijn gepubliceerd. Als je dus een paar nieuwe kenmerken in een fase zet, zul je het zaaktype eerst moeten publiceren.
+
Website:<br>
 +
https://aws.amazon.com/rds/aurora/
 
</p>
 
</p>
  
 
<p>
 
<p>
−
* '''Werkende sjablonen.''' Het zaaksysteem maakt gebruik van OpenOffice voor het gebruiken van documentsjablonen. Het formaat wat hiervoor gebruikt wordt is ODF. Om een sjabloon te maken in het ODF-formaat heb je niet per definitie OpenOffice nodig. Ook Microsoft Office 2010 is in staat om in ODF-bestanden op te slaan. Dit betekent dat de documenten in XML worden opgeslagen. Het wil wel eens voorkomen dat met 'Copy-paste' acties of uitwisseling tussen programma's de xml net even anders wordt gezet. Het resultaat is dat het kan voorkomen dat Magic Strings niet goed worden ingevuld. Geen paniek. Verwijder de tekst en vul de Magic String handmatig in, sla opnieuw op. Naar alle waarschijnlijkheid werkt het nu wel.
+
Webdocumentatie:<br>
 +
https://aws.amazon.com/rds/aurora/
 
</p>
 
</p>
  
 
<br clear="all" />
 
<br clear="all" />
  
−
=== Een kenmerk aanmaken ===
+
== Specifieke documentatie==
 +
 
 +
=== Databasemodellen ===
 +
 
 +
 
 +
[[Bestand:knop_db.png|left]]
 +
<p>
 +
Gegevensmagazijn:<br>
 +
https://drive.google.com/file/d/14b7EkMjtQVxb2r-5qoCh38LXln7MKkyi/view?usp=sharing
 +
</p>
 +
 
 +
<p>
 +
Zaaktypecatalogus:<br>
 +
https://drive.google.com/file/d/1bpv47A84KH8NC28uFmXTq_yyL44UWwAg/view?usp=sharing
 +
</p>
 +
 
 +
<p>
 +
Zakenmagazijn:<br>
 +
https://drive.google.com/file/d/1u6ZAEe9vao4od1ouLSHz5_kk1Q4ga81O/view?usp=sharing
 +
</p><br>
 +
 
 +
<p>
 +
De bovenstaande modellen zijn indicatief. Zaaksysteem.nl is een softwareproduct waarbij het databasemodel op regelmatige basis wijzigt. Een [https://gitlab.com/zaaksysteem Actueel databasemodel] is te vinden in de broncode die publiekelijk toegangkelijk is.
 +
 
 +
</p>
  
−
[[Bestand:wiki_youtubevideo2.png|left|link=http://www.youtube.com/watch?v=EbBrljvHE-U]]
+
<br clear="all" />
  
−
1. Zorg ervoor dat je in het dashboard zit<br />
+
=== NEN2082 ===
−
2. Klik in het menu op Zaaktypecatalogus <br />
+
 
−
3. Ga naar de map waarin je het kenmerk wilt aanmaken <br />
+
[[Bestand:knop_nen2082.png|left]]
−
4. Klik op nieuw kenmerk <br />
+
<p>
−
5. Vul de benodigde gegevens in van het kenmerk <br />
+
Meer informatie over de NEN2082 Norm:<br>
−
6. Klik op Opslaan <br /> <br />
+
http://www.nen2082.nl
 +
</p>
  
−
Bekijk eventueel de instructievideo voor een voorbeeld.
+
<p>
 +
Uitwerking van de NEN2082 norm binnen het zaaksysteem kan opgevraagd worden: [http://www.mintlab.nl#footer Mintlab B.V.]
 +
</p>
  
 
<br clear="all" />
 
<br clear="all" />
  
−
=== Een sjabloon aanmaken en testen ===
+
== Beheertools ==
  
−
[[Bestand:wiki_youtubevideo2.png|left|link=http://www.youtube.com/watch?v=R1Zyv4UH1SM]]
+
=== LibreOffice ===
  
−
1. Zorg ervoor dat je in het dashboard zit<br />
+
[[Bestand:knop_libre.png|left]]
−
2. Klik in het menu op Zaaktypecatalogus <br />
+
<p>
−
3. Ga naar de map waarin je het sjabloon wilt aanmaken <br />
+
Voor het beheren van de sjablonen kan LibreOffice worden gebruikt. Hiermee kunnen sjablonen worden gemaakt en gewijzigd worden. Daarnaast is het met LibreOffice altijd mogelijk om alle toegestane bestandsformaten te lezen.
−
4. Klik op nieuw sjabloon <br />
+
<br>
−
5. Vul de benodigde gegevens in van het sjabloon <br />
+
http://www.libreoffice.org/download/
−
6. Klik op Opslaan <br /> <br />
+
</p>
−
7. Voeg het sjabloon toe binnen een fase in het zaaktype
+
<br clear="all" />
−
8. Publiceer het zaaktype<br />
 
−
9. Start een nieuwe zaak<br />
 
−
10. Klik vanuit het zaakdossier op het tabblad Documenten<br />
 
−
11. Klik op de knop Sjabloon<br />
 
−
12. Start de magic...<br /><br />
 
  
−
Bekijk eventueel de instructievideo voor een voorbeeld.
+
=== Evince PDF Reader ===
 +
[[Bestand:knop_evince.png|left]]
 +
<p>
 +
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.
 +
<br>
 +
http://live.gnome.org/Evince/Downloads
 +
</p>
 +
<br clear="all" />
  
 +
=== JDigest MD5, SHA-1 calculator and verifier ===
 +
[[Bestand:knop_jdigest.png|left]]
 +
<p>
 +
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.
 +
<br>
 +
http://code.google.com/p/jdigest/
 +
</p>
 
<br clear="all" />
 
<br clear="all" />
 +
 +
== 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.

Huidige versie van 14 mrt 2020 om 13:01

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.

Docker

Knop docker.png

Website:
https://www.docker.com/

Webdocumentatie:
https://www.docker.com/


NginX Web Server

Knop nginx.png

Website:
http://nginx.org/

Webdocumentatie:
http://wiki.nginx.org



Catalyst Web Framework (Perl Backend)

Knop catalyst.png

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

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


Pyramid Web Framework (Python Backend)

Knop pyramid.png

Website:
https://trypyramid.com/

Webdocumentatie:
https://trypyramid.com/


Angular Javascript Library (Legacy frontend)

Knop angular.png

Website:
https://angularjs.org/

Webdocumentatie:
https://angularjs.org/


React Javascript Library (current frontend)

Knop react.png

Website:
https://reactjs.org/

Webdocumentatie:
https://reactjs.org/docs/getting-started.html


LibreOffice (Headless Mode)

Knop libre.png

Website:
http://www.openoffice.org

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


Aurora Database (AWS PostGreSQL)

Knop aurora.png

Website:
https://aws.amazon.com/rds/aurora/

Webdocumentatie:
https://aws.amazon.com/rds/aurora/


Specifieke documentatie

Databasemodellen

Knop db.png

Gegevensmagazijn:
https://drive.google.com/file/d/14b7EkMjtQVxb2r-5qoCh38LXln7MKkyi/view?usp=sharing

Zaaktypecatalogus:
https://drive.google.com/file/d/1bpv47A84KH8NC28uFmXTq_yyL44UWwAg/view?usp=sharing

Zakenmagazijn:
https://drive.google.com/file/d/1u6ZAEe9vao4od1ouLSHz5_kk1Q4ga81O/view?usp=sharing


De bovenstaande modellen zijn indicatief. Zaaksysteem.nl is een softwareproduct waarbij het databasemodel op regelmatige basis wijzigt. Een Actueel databasemodel is te vinden in de broncode die publiekelijk toegangkelijk is.


NEN2082

Knop nen2082.png

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

Uitwerking van de NEN2082 norm binnen het zaaksysteem kan opgevraagd worden: Mintlab B.V.


Beheertools

LibreOffice

Knop libre.png

Voor het beheren van de sjablonen kan LibreOffice worden gebruikt. 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/


Evince PDF Reader

Knop evince.png

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

Knop jdigest.png

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/


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.

Overgenomen van "http://wiki.zaaksysteem.nl/index.php?title=Systeemdocumentatie&oldid=10095"