Changes between Version 19 and Version 20 of Documentatie/Beheerder/Modules

Timestamp:

07/14/16 13:33:15 (10 years ago)

Author:

adriaan

Comment:

--

Documentatie/Beheerder/Modules

@@ -5 +5 @@
 = Moduleconfiguratie =
 
-Dit hoofdstuk in de beheerdershandleiding beschrijft de inrichting van modules in OpenAC. De inhoudsopgave rechts toont alle modules waarvoor configuratie vereist, gewenst of mogelijk is.
+Dit hoofdstuk in de beheerdershandleiding beschrijft de inrichting van modules in OpenAC. De inhoudsopgave rechts toont die modules waarvoor configuratie vereist, gewenst of mogelijk is.
 
-Diverse modules van OpenAC hebben ''schakelaars'' die het gedrag beïnvloeden.  Mogelijk heeft u ook niet alle modules ingeschakeld die voor uw locatie handig zijn.
+OpenAC is modulair opgebouwd. Een adaptatie kan een eigen selectie van kernmodules inschakelen (in gebruik hebben).
 
-De meeste actuele lijst modules vindt u in de [https://www.fenac.nl/openac/downloads/documentatie/ systeemdocumentatie] onder [https://www.fenac.nl/openac/downloads/documentatie/namespacekern.html Kern].
+Diverse modules van OpenAC hebben ''module-parameters'' die het gedrag beïnvloeden.
 
-Met name de modules in de reeksen '''d040''', '''d045''', '''s040''' bevatten veel instellingen.
-De modules '''e080''', '''f080''' en '''s080''' zijn met name interessant omdat deze optionele functionaliteit aanbieden.
-
-De instelbare parameters van elke module vindt u door te klikken op de naam van de module.  De parameters staan beschreven direct onder het kopje 'gedetailleerde beschrijving'.
+Vanaf OpenAC v2.016 is de manier waarop modules worden aangezet, en hoe de module-parameters per module worden ingevoerd, gewijzigd. Deze pagina beschrijft de manier vanaf v2.016.
 
 
 == Module-Instellingen ==
 
-Welke modules gebruikt worden door OpenAC wordt door het (adaptatie) script geregeld. Maar de modules hebben hun eigen instellingen die programmatisch kunnen worden doorgegeven (nog los van instellingen die ze via het instellingenscherm kunnen hebben).
+Welke modules gebruikt worden door OpenAC wordt door een configuratiebestand `modules.ini` geregeld (en nog een klein beetje door de adaptatie-init). De modules hebben hun eigen instellingen die ook in `modules.ini` worden ingesteld (of programmatisch worden doorgegeven), nog los van instellingen die ze via het instellingenscherm kunnen hebben.
+
+Het bestand `modules.ini` heeft een ini-achtige structuur. Dat betekent dat er kopjes zijn van de vorm `[section-name]` en onder een kopje, instellingen van de vorm `key = value`.
+
+== Modules Aanzetten ==
+
+Onder het kopje `[modules]` in het configuratiebestand staat een lijst van modules die geactiveerd is in de adaptatie. Modules die niet genoemd worden, staan niet aan '''tenzij''' ze nodig zijn voor het functioneren van andere modules die wel aan staan. Zo is het niet nodig om module `d010_systeem` aan te zetten, want die is nodig voor alle andere modules.
+
+Elke module kan optreden als ''key'' onder dit kopje. Als ''value'' geef `True` of `False` op. Modules met value `False` staan uit (dat kan handig zijn als je een module wilt testen, of even niet wilt gebruiken maar de verdere instellingen wel wilt behouden).
+
+Als voorbeeld van een eenvoudige configuratie met alleen een medewerker-dossier (geen patienten):
+
+{{{
+[modules]
+kern.s030_medewerkers = True
+kern.s040_dossier = False
+kern.f050_excel = True
+}}}
+
+Om modules uit te zetten zijn er diverse mogelijkheden:
+ - verwijder de regel uit het `modules.ini` bestand,
+ - zet een hekje (#) voor de regel zodat het commentaar wordt,
+ - of verander de ''value'' in `False` om de module uit te zetten.
+
+== Modules Configureren ==
+
+De module-parameters worden per module geconfigureerd onder een kopje dat overeenkomt met de naam van de module (bijvoorbeeld `[kern.s030_medewerkers]` voor de module-parameters voor die module).
+
+Welke parameters beschikbaar zijn hangt af van de module. Dat is makkelijk op te zoeken in het [attachment:modules.ini voorbeeldbestand], waar alle mogelijke modules en module-parameters in terug te vinden zijn.
+
+Als voorbeeld van de configuratie voor de module `d030_planning`, deze instellingen:
+
+{{{
+[kern.d030_planning]
+planhorizon_afstand = '365d'
+zaterdag_overslaan = True
+}}}
+
+Hier zijn twee module-parameters gezet. De een is ingesteld op de string ''365d''. Nalezen van de documentatie in het voorbeeldbestand leert dat hiermee de planhorizon automatisch wordt ingesteld op 365 dagen vanaf vandaag (elke keer dat je OpenAC opstart). De andere module-parameter wordt ingesteld op `True`, waarmee aangegeven wordt dat het AC op zaterdag gesloten is (dat is overigens de default voor die parameter).
+
+De module-parameters kunnen worden teruggevonden in de broncode van OpenAC. Die broncode wordt gebruikt om het [attachment:modules.ini voorbeeld modules-configuratiebestand] te maken, waardoor dat voorbeeldbestand gevuld is met meer modules en meer instellingen dan je redelijkerwijs aan zou willen zetten.
+
+== Starten Oude-Stijl ==
+
+Het `modules.ini` bestand wordt gebruikt '''naast''' de bestaande adaptatie-init. Het is dus mogelijk om ook configuratie te doen via de `start()` functie in de adaptatie, en daar modules op te starten. Het verdient de voorkeur om dat via `modules.ini` te regelen, maar dat is niet altijd mogelijk -- dan is de oude stijl nog bruikbaar.
+
+== Voorbeeldbestand ==
+
+Dit [attachment:modules.ini voorbeeldbestand] wordt gegenereerd aan de hand van de OpenAC broncode. Alle mogelijke modules staan er in onder het kopje `[modules]`. Voor elke module is er een kopje aangemaakt voor de module-parameters van die module. Alle module-parameters hebben tekst en uitleg en staan ingesteld op hun default-waarden.
+
+Het is aan te raden om configuratie te knippen-en-te-plakken van het voorbeeldbestand naar de eigen `modules.ini`. Denk er daarbij aan om de gewenste modules aan te zetten door ''module'' `= True` op te nemen onder het kopje `[modules]`.