Systeemdocumentatie

Uit ZaaksysteemWiki
Versie door Admin (overleg | bijdragen) op 5 mrt 2012 om 14:38 (Catalyst Web Framwork)
Ga naar: navigatie, zoeken

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.

Catalyst Web Framwork

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

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


Kenmerken

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

Wanneer een kenmerk wordet aangemaakt dat moet er een invoertype 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:

  • Tekstveld
  • Keuzemenu (dropdown)
  • Meervoudige keuze (Checkbox)
  • Maps (Google prikkaart)
  • Valuta
  • Etc.

Tevens wordt er voor elk kenmerk direct een 'magic sting' 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.

Zaaktypen

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)

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.


Beheeracties

Algemene tips voor zaaktypebeheer

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:

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

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

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

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

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


Een kenmerk aanmaken

1. Zorg ervoor dat je in het dashboard zit
2. Klik in het menu op Zaaktypecatalogus
3. Ga naar de map waarin je het kenmerk wilt aanmaken
4. Klik op nieuw kenmerk
5. Vul de benodigde gegevens in van het kenmerk
6. Klik op Opslaan

Bekijk eventueel de instructievideo voor een voorbeeld.


Een sjabloon aanmaken en testen

1. Zorg ervoor dat je in het dashboard zit
2. Klik in het menu op Zaaktypecatalogus
3. Ga naar de map waarin je het sjabloon wilt aanmaken
4. Klik op nieuw sjabloon
5. Vul de benodigde gegevens in van het sjabloon
6. Klik op Opslaan

7. Voeg het sjabloon toe binnen een fase in het zaaktype 8. Publiceer het zaaktype
9. Start een nieuwe zaak
10. Klik vanuit het zaakdossier op het tabblad Documenten
11. Klik op de knop Sjabloon
12. Start de magic...

Bekijk eventueel de instructievideo voor een voorbeeld.