HELP

Hieronder volgt informatie over het gebruik van dit programma, hoe configuratieparameters ingesteld kunnen worden en hoe extra queries kunnen worden toegevoegd. Voor dagelijks gebruik is enkel de informatie onder het kopje "gebruik" interessant. De configuratie moet slechts één maal gebeuren. De informatie om queries toe te voegen is gericht aan personen die SQL kennen.

Use

This program can be used to fetch data from a database. The data can be exported as a CSV-file Onder andere Microsoft Excel en OpenOffice.org Calc kunnen overweg met CSV-bestanden. Er zijn twee manieren om gegevens op te vragen.
  1. Eerst en vooral kan er gebruik gemaakt worden van de tab "Queries" om voorgedefinieerde queries af te vuren. Afhankelijk van de geselecteerde query moeten er geen of meer parameters ingevoerd worden zoals bijvoorbeeld het seizoen, een voorstelling, een datum, ...
  2. Daarnaast bestaat er de mogelijkheid om zelf SQL-queries manueel in te voeren in het tabblad "SQL".
Op die twee tabbladen zijn onderaan twee knoppen te vinden. De knop "Uitvoeren" haalt de gegevens op. Meteen daarna worden ze in tabelvorm zichtbaar. De knop "Exel Export" haalt de gegevens eveneens op. Meteen daarna worden ze weggeschreven naar een CSV-bestand en pas daarna worden ze in tabelvorm zichtbaar. De map waarin de CSV-bestanden terecht komen is te configureren (zie onder).

Let op: afhankelijk van de hoeveelheid opgevraagde gegevens kan het ophalen van de gegevens zeer snel gaan of iets langer duren.

In het tabblad "Log" is te vinden wat de applicatie allemaal gedaan heeft. Als er bijvoorbeeld iets fout gaat tijdens het uitvoeren van een query komt daar meer informatie.

In het tabblad "Configuratie" kunnen configuratieparameters ingesteld worden en emailgarage profielen opgehaald worden.

Op laatste tabblad "Help" is deze informatie te vinden.

Configuratieparameters

De configuratie van dit programma wordt bewaard in het register (op windows). Er wordt automatisch een standaardconfiguratie aangemaakt die nadien aangepast kan worden. Vooral de configuratie van de mappen is hierbij belangrijk. De registersleutel is: HKEY_CURRENT_USER\Software\JavaSoft\Prefs. Voorbeelden voor de queries en export folder zijn (laatste / is verplicht):
queries_folder = C:/queries/
export_folder = C:/exports/
Naast de configuratie van de folders is het ook mogelijk om de database en databasedriver te configureren. Dit is waarschijnlijk bijna nooit nodig. De configuratie van die parameters verloopt analoog. Op linux is de configuratie te vinden in een tekstbestand in ~/.Java/Prefs/prefs.xml

Queries toevoegen

Er kunnen queries toegevoegd worden aan dit programma door SQL-bestanden in een map te plaatsen. Na het correct toevoegen van een query komt de titel ervan in de lijst van queries. Die directory is te configureren (zie boven). Een *.sql bestand bevat:


TITEL van het script
----
OMSCHRIJVING van het script
----
SQL-INSTRUCTIE met nul of meer !{PARAMETERS}!

bijvoorbeeld:

Klanten per postcode
----
selecteert alle klanten in de database met
een bepaalde postcode
----
SELECT * FROM Klanten where klanten.postcode=!{geheel_getal postcode}!

De TITEL komt in de lijst van queries en is best niet te lang. De OMSCHRIJVING komt in een textarea na selecteren van de titel. Dit zou de titel moeten verduidelijken. De SQL-INSTRUCTIE is een geldige SELECT instructie voor de database. De PARAMETERS zijn arbitraire parameters die gegeven kunnen worden. Enkele parameters zijn voorgedefinieerd:

Deze parameters hebben een eigen UI-element: seizoen is een lijst van seizoenen, evenement een lijst van evenementen enzovoort. Aangezien evenement en verkoopformule seizoensafhankelijk zijn moeten ze samen gebruikt worden met !{seizoen}! en dus nooit apart. Naast die voorgedefineerde parameters zijn er ook te kiezen parameters: