WISA API Service. 5 maart WISA helpdesk

Transcriptie

1 WISA API Service 5 maart 2012 WISA helpdesk

2 Inhoudsopgave 1 Inleiding 2 2 Installatie 3 3 Configuratie 4 4 Starten en stoppen van de service 5 5 Testen van de WISA API Service 6 6 Windows Logboek berichten 8 7 Gebruik van de service in andere toepassingen 9 1

3 1 Inleiding De WISA API service staat toe, via een standaard Webservice formaat, gegevens te exporteren uit een WISA Administratie of boekhouding databank. De webservice staat beschreven in het WisaAPIService.wsdl bestand dat wordt meegeleverd met de administratie. De WISA API Service bestaat uit 3 delen: De service applicatie. Dit is een standaard Windows Service programma, dat in de achtergrond draait. Het luistert op een TCP/IP poort naar client requests. Deze poort moet open staan in de Windows Firewall instellingen. Het service configuratie programma. Dit programma dient gebruikt te worden om de service applicatie te configureren. Een service test client applicatie. Dit programma kan gebruikt worden om de service te testen. 2

4 2 Installatie Het installatieprogramma installeert de 3 programmadelen in een map naar uw keuze. Standaard is dit de map C:\WISA\APIService. Het installatieprogramma maakt ook icoontjes aan in het Windows Start menu voor het configuratieprogramma en het testprogramma. Standaard komen deze in het menu WISA API Service. Het installatieprogramma registreert dadelijk de WISA API service. Indien deze service reeds bestaat is het mogelijk dat er een foutboodschap getoond wordt. Behoudens speciale gevallen mag deze boodschap genegeerd worden. Bij installatie wordt aangeboden het configureren dadelijk te starten. 3

5 3 Configuratie Alvorens de configuratie te verrichten, moet de WISA API service gestopt worden. Dit kan via het Wisa API service configuratie programma (zie 4) of via het Windows Configuratie menu. Er zijn 3 zaken die geconfigureerd dienen te worden. Je kan dit doen d.m.v. het WISA API service configuratieprogramma. De WISA API service leest het configuratiebestand uit het bestand settings.cfg in de map conf onder de installatiemap. Indien het configuratieprogramma wordt opgestart, wordt deze bestandsnaam automatisch ingesteld. Project: Dit is CSWisadmin voor de WISA Administratie, WisAcc voor de Wisa Boekhouding, of Count-E voor de bedrijfsboekhouding. Poort: De poort waarop de service luistert naar vragen van client programma s. Hou ermee rekening dat deze poort in de firewall instellingen van Windows moet openstaan. Queries loggen: Indien gewenst kan de service de queries die door client programma s gevraagd worden loggen naar de windows systeemlog. 4

6 4 Starten en stoppen van de service De service kan gestart en gestopt worden vanuit het configuratie programma op volgende wijze: via laatste knop op de knoppenbalk via het menu Service. Indien deze mogelijkheden niet beschikbaar zijn, is het WISA API Service programma niet correct geinstalleerd. Het starten en stoppen kan ook gebeuren vanuit het Windows configuratieprogramma System Services, de service wordt getoond met de naam WISA API Service. Bij elke wijziging van de configuratie dient de service gestopt en opnieuw gestart te worden, zodat de nieuwe configuratie-instellingen worden ingelezen. 5

7 5 Testen van de WISA API Service De WISA API service kan gestest worden met de WISA API Service test client. De WISA API Service test client kan uitgevoerd worden op de machine waar de service geinstalleerd is, maar mag ook op een andere machine uitgevoerd worden om b.v. de verbinding te testen. Het testprogramma wordt opgestart met de gegevens die bij het laatste gebruik van het 6

8 HOOFDSTUK 5. TESTEN VAN DE WISA API SERVICE 7 programma waren ingevuld. Indien de WISA API Service op de locale machine geinstalleerd is, worden de Server en Poort reeds ingevuld met de correcte gegevens. De volgende gegevens moeten worden ingevuld: Server: De naam (of het IP adres) van de server waarop de WISA API Service luistert. Poort: De poort waarop de WISA API Service luistert. (merk op dat de Windows Firewall TCP/IP verkeer op deze poort moet toestaan) Databank: Databank naam waarop gestest moet worden. Gebruikersnaam: Naam van een geldige WISA gebruiker. (hoofdlettergevoelig) Wachtwoord: Wachtwoord van de WISA gebruiker. (hoofdlettergevoelig) Formaat: Formaat waarin de gegevens moeten geschreven worden. Bestand: Bestandsnaam waarin de gegevens moeten geschreven worden. Scheidingsteken: Bij het formaat tetext (CSV, of comma-gescheiden formaat) is dit het teken dat tussen de verschillende velden geplaatst moet worden. Veldnamen in 1-ste lijn: Bij het formaat tetext (CSV, of comma-gescheiden formaat) bepaalt dit vinkje of de veldnamen in de eerste lijn van het bestand geschreven worden. XML formaat: Bij het formaat texml (XML bestanden) wordt hier het formaat van XML bestand opgegeven. Query: De code van een query zoals gedefinieerd in het query-beheer van de databank. (hoofdlettergevoelig) Parameters: Parameters die nodig zijn bij het uitvoeren van de query. Indien je meer dan 1 parameter wil toevoegen kan je dit doen met de pijltjestoets naar omlaag. Nadat dit alles is ingevuld, kan op de knop Start gedrukt worden, en wordt het bestand geschreven. Indien alles goed verlopen is wordt er een boodschap getoond met de naam van het geschreven bestand en de grootte van het bestand.

9 6 Windows Logboek berichten De WISA API Service schrijft een aantal berichten naar het Windows toepassings logboek: Bij het inlezen van de configuratie wordt een bericht geschreven met de bestandsnaam. Bij het starten van de service worden de projectnaam en poort waarop geluisterd wordt, gelogd. Indien in de configuratie de optie Queries loggen aanstaat, worden alle queries en hun parameters gelogd. Dit zijn potentieel veel berichten, zorg er dus voor dat de logboeken van windows voldoende schrijfruimte ter beschikking hebben. 8

10 7 Gebruik van de service in andere toepassingen De WISA API service is een standaard webservice. De webservice is beschreven in het WSDL bestand WISAAPIService.wsdl in de installatiemap. Dit bestand kan gebruikt worden om een client te configureren. De URL om de service aan te spreken is afhankelijk van de machine en poort waarop de server luistert, en is steeds van de vorm: Servernaam moet vervangen worden door de DNS naam van de server (bijvoorbeeld testserver.wisa. net), poort door de poort waarop de WISA API service luistert (bv. 8080). De URL moet steeds eindigen op /SOAP/. Een voorbeeld van een correcte URL is dus: 9