Configuratiebestanden
De configuratie van EekBoek wordt vastgelegd in
configuratiebestanden. Deze bestanden zijn gemodelleerd naar een va de
vele de-facto standaards, die van de INI files.
Bij het opstarten zal EekBoek de volgende configuratiebestanden
verwerken indien ze aanwezig zijn:
- Het systeem-globale configuratiebestand. Op een Unix of Linux
systeem is dit het bestand
/etc/eekboek/eekboek.conf .
In dit bestand kan bijvoorbeeld de systeembeheerder de
instellingen voor de databases opnemen.
- Het gebruikers-specifieke configuratiebestand. Op een Unix of Linux
systeem is dit het bestand
.eekboek/eekboek.conf in de home-directory van de
gebruiker.
In dit bestand kan een gebruiker bijvoorbeeld
taalinstellingen en andere voorkeuren opnemen.
Wanneer er met slechts één administratie wordt gewerkt
kan hier ook de naam van de te gebruiken database worden opgenomen.
- Het administratie-specifieke configuratiebestand. Op een Unix of Linux
systeem is dit het bestand
.eekboek.conf in de huidige directory.
Wanneer met meerdere administraties wordt gewerkt is dit een
goede plek om de naam van de te gebruiken database op te nemen.
De gegevens uit de specifieke bestanden hebben voorrang boven die uit
meer generieke bestanden.
De EekBoek shell ebshell kan bovendien op de command
line een configuratie-optie
worden meegegeven. Met deze optie wordt een extra configuratiebestand
aangewezen dat weer voorrang heeft boven alle andere.
De configuratiebestanden zijn verdeeld in secties, die elk een of
meer variabelen kunnen bevatten. Bijvoorbeeld
[Database]
name = demoadmin
In dit kleine voorbeeldje is er sprake van een sectie,
‘Database’, met een variabele ‘name’ met de
waarde ‘demoadmin’. Voor meer details, zie b.v. WikiPedia.
Omdat in de configuratiebestanden onder meer de
internationalisatie-gegevens kunnen worden bepaald, kunnen deze
bestanden zelf geen gebruik maken van internationalisatie. De
gebruikte namen van secties en variabelen in de configuratiebestanden
zijn daarom voor alle talen vast, en enigszins taal-neutraal (lees:
engels-achtig).
Verschillende configuratiegegevens hebben een fallback naar
environment variabelen. Het gebruik van environment variabelen voor
configuratiegegevens wordt echter afgeraden en zal wellicht in een
toekomstige versie komen te vervallen.
Sectie "Locale"
lang |
Deze variable kan worden gebruikt om de door EekBoek te
gebruiken taal (locale) te selecteren. Standaard wordt de
instelling van het systeem overgenomen.
Fallback: EB_LANG .
Taalinstelling is alleen effectief in de
internationale versie van EekBoek, en niet in de standaardversie.
|
decimalpt |
Deze variable kan worden gebruikt om de door EekBoek te
gebruiken decimaalpunt te wijzigen.
|
Sectie "Database"
name |
De naam van de te gebruiken database.
De command line optie --dataset (zie hierboven)
prevaleert over het
zetten van deze configuratievariabele.
Let op! De werkelijke naam wordt, indien nodig, voorzien van
het voorvoegsel eekboek_ . Dit om de EekBoek
databases te kunnen onderscheiden van de overige databases.
Fallback: EB_DB_NAME .
|
user |
De naam van de database-gebruiker.
Indien deze configuratievariabele niet is gezet, wordt de
loginnaam gebruikt.
Fallback: EB_DB_NAME .
|
password |
De toegangscode van de database-gebruiker, indien nodig.
Fallback: EB_DB_PASSWORD .
|
host |
De naam van het systeem waarop de database draait.
Indien deze configuratievariabele niet is gezet wordt de
database verondersteld op het lokale systeem te draaien.
Fallback: EB_DB_HOST .
|
port |
De poort waarlangs de database is te benaderen.
Indien deze configuratievariabele niet is gezet wordt een
database-specifieke standaardwaarde genomen.
Fallback: EB_DB_PORT .
|
Sectie "CSV"
separator |
Deze variable kan worden gebruikt om de kolom-scheider in te
stellen voor de in de vorm van CSV bestanden aangemaakte
rapporten. Standaard staat de kolom-scheider ingesteld op
‘, ’.
|
Sectie "Internal"
Het gebruik van deze variabelen is strict intern en kan tot
ongewenste problemen leiden.
now |
Deze variable kan worden gebruikt om de 'huidige' datum te
zetten. Dit is enkel relevant voor regressietests, waarin
de gegenereerde rapporten worden vergeleken met
standaardversies en het onwenselijk is als steeds de
rapportage-datum zou wijzigen.
Fallback: EB_SQL_NOW .
|
|