Uitleg over OnsDB 5

Wat is OnsDB?

OnsDB is een applicatie waarmee data vanuit verschillende Ons-applicaties naar een lokale database gekopieerd kunnen worden. Hierdoor heb je zelf beschikking tot veelgebruikte gegevens voor bijvoorbeeld het maken van rapportages en dashboards (t.b.v. Business Intelligence).

De gegevens die opgehaald worden is data in tabelvorm; je kunt geen bestanden (zoals foto's of documenten) met OnsDB downloaden.

Voor hulp bij het maken van de juiste toepassing, het maken van rapportages of het aansluiten van achterliggende tooling, kun je contact opnemen met een business partner.

Toepassingsmogelijkheden

Er zijn grofweg twee manieren waarop OnsDB gebruikt wordt: incidenteel gebruik zonder achterliggende tooling of structureel gebruik met achterliggende tooling. Doordat de uitgangspunten van beide manieren verschillen, kennen ze ook een andere benadering van de configuratie van OnsDB:

• Structureel gebruik: je wilt elke dag een gestructureerd overzicht met gedetailleerde gegevens over de productiviteit binnen je organisatie. Je wilt deze gegevens inzien in een Business intelligence tool (BI-tool).

• Incidenteel gebruik: je wilt in Excel eenmalig een overzicht genereren waarmee je bepaalde gegevens in een oogopslag kunt zien. Je weet op dat moment nog niet precies welke tabellen nodig zijn om dit overzicht te kunnen maken. Je wilt alle gegevens opvragen die op dit moment in de applicatie beschikbaar zijn, zodat je daarna deze gegevens zelf via een SQL-programma in kunt zien en naar Excel kunt kopiëren.

De mogelijkheden hieronder helpen je een passende configuratie te kiezen. Gebruik je al OnsDB 4? Volg dan de migratiegids naar OnsDB 5.

Mogelijkheden van OnsDB 5

De configuratiereferentie legt alle instellingen en hun standaardwaarden uit. De gebruiksaanwijzing beschrijft certificaten, herhaalde downloads en het controleren van de uitkomst.

Configuratiestappen

Om OnsDB te kunnen gebruiken dienen er diverse stappen te worden doorlopen. Doorloop de volgende stappen in de aangegeven volgorde om het installeren, configureren en gebruiken uit te kunnen voeren.

1. Regel eerst toegang tot het Ons API Dashboard via de route voor jouw organisatie. Bepaal daarna via het Dashboard welke gegevens je wilt ophalen. Selecteer alleen de benodigde tabellen. Zie OnsDB Toegang configureren via Ons API Dashboard. Raadpleeg bij het bepalen van de benodigde tabellen ook OnsDB: datamodellen.

2. Download het programma en zet dat op een server. Zie Installatie van OnsDB.

3. Zorg dat je een databaseserver beschikbaar hebt of maak deze aan. Zie Databaseconfiguratie voor OnsDB.

4. Stel het configuratiebestand in. Zie Configuratiebestand voor OnsDB.

5. Zet de eerste connectie met OnsDB op. Zie Gebruiken van OnsDB.

Snel starten met SQLite

Met dit voorbeeld kun je na het regelen van Dashboard-toegang en het installeren van OnsDB één tabel downloaden zonder een databaseserver in te richten.

1. Open je koppeling in het Ons API Dashboard, selecteer de tabel clientsen noteer de Technical name. Kies de omgeving volgens je toegangsroute:
   • Als koppelpartner kun je het voorbeeld hieronder op de ontwikkelomgeving TE1002 uitvoeren. Dit zijn niet de gegevens van je eigen klantomgeving.
   • Als medewerker van een zorgorganisatie gebruik je een eigen omgeving. Vervang in het voorbeeld development door staging of production en TE1002 door de klantcode van die omgeving. Zet de versie eerst vast en regel toestemming zoals beschreven in Toegang tot klantomgevingen.
2. Maak in de map met de executable een bestand onsdb.cfg met de onderstaande inhoud. Vervang jouw_connector door de technische naam van je koppeling: 
   
   Controleer op Windows dat het bestand werkelijk onsdb.cfg heet, niet onsdb.cfg.txt.

   
   

   [onsdb]
   stage = development
   customer-code = TE1002
   connector = jouw_connector
   include = clients
   report-file = onsdb-report-{date}.txt
   
   [database]
   type = sqlite3
   database = onsdb

   
   

3. Open een terminal in deze map en start onsdb.exe --config onsdb.cfg op Windows, of ./onsdb --config onsdb.cfg op Linux/macOS. De eerste start maakt een certificaataanvraag. Volg de link in de uitvoer om die in het Dashboard te bevestigen en start daarna opnieuw. Zie Eerste certificaataanvraag.

4. Na een geslaagde download staat de tabel clients in onsdb.db. Controleer dat de opdracht exitcode 0 heeft, de uitvoer Completed successfully vermeldt en het rapport geen downloadfouten bevat. Je kunt het bestand bijvoorbeeld openen met DB Browser for SQLite.

5. Voor je eigen test- of productieomgeving stel je de bijbehorende stage en customer-code in en regel je toestemming via Ons Podium. Gebruik een aparte map en doel-database per omgeving. Selecteer in het Dashboard en je configuratie de tabellen die je nodig hebt.

Zonder eigen datuminstellingen gebruiken tabellen met datumfilters de periode van 1 januari van het vorige jaar tot en met gisteren. Tabellen zonder datumfilters worden volledig opgehaald. Voor alle historie en toekomstige gegevens zet je in [onsdb] zowel start = als end =. De configuratiereferentie beschrijft ook hoe je dit per tabel instelt.