Data API Explorer Add-On

Sinds FileMaker 19 is het mogelijk via een Add-on functionaliteit aan database toe te voegen.

Aanpassingen gemaakt naar aanleiding van suggesties op de dotfmp in Berlijn – Duitsland
[2022-06-06 nieuwe versie van Add-on (v1.8): JSONSetElements-formule toegevoegd tbv Insert/Update payloads. SuperHeroes voorbeeld bijgewerkt]

Dit is geen stukje over het maken van een Add-on, want dat is eigenlijk vrij eenvoudig en je vind daarover veel informatie op: Claris FileMaker help , Claris instructie-PDF , DBServices , Luminfire , Geistinteractive en AppWorks

 

Dit artikel gaat over de Add-on die je hier kunt downloaden: de Data API Explorer Add-On (download) Pak het bestand dat je hier download uit en gebruik de informatie in “ReadFirst.txt” om de Add-on te installeren.

Je kan een bestand met voorbeeld-/test-gegevens downloaden: SuperHeroes, daarin is de DAE reeds geïnstalleerd. De voorbeeld-data komt van Fun-Sample-DataSets van domo.com

Een werkend voorbeeld is te zien in de volgende korte film: SuperHeroes demo (3min)

Je hebt hier FileMaker 19 voor nodig, in oudere versies ontbreekt de mogelijkheid om Add-on’s toe te voegen en je mist in de oudere versies ook de script-stap “Execute Data-API”.

Als je deze Add-on installeert, worden er een aantal zaken aan je database toegevoegd waarvan de namen allemaal beginnen met “DAE_”:

  • 5 tabellen / tables
  • 6 tabelweergaven / table-occurrences toegevoegd, zij staan bovenaan in de relatiegrafiek en ongeveer 50 cm uit de kantlijn. In de meeste gevallen zullen zij dus niets overlappen en anders weet je waar ze staan.
  • 11 keuzelijsten / valuelists
  • 4 eigen functies / custom-functions
  • 5 lay-outs, in een map waarvan alleen de layout “Data Api Explorer” in de lijst selecteerbare lay-outs staat
  • 7 scripts, ook in een map “Data API Explorer”

Deze Add-on koppelt verder met helemaal niets, hij is volledig autonoom. Als je er op enig moment klaar mee bent, hoef je Add-on alleen maar te verwijderen en dan is er geen spoor meer van terug te vinden.

Dan de belangrijkste vraag: Wat voegt de Add-on nou eigenlijk toe? Nou, dat is heel eenvoudig en de naam geeft het eigenlijk al weg: je kan de mogelijkheden voor de Data API onderzoeken.

Zodra je naar de lay-out “DataApiExplorer” toe gaat, haalt de Add-on meteen de beschikbare lay-outs op en vult daarmee een keuzelijst. Je kan vervolgens een layout kiezen en meteen op de knop “RUN” drukken, je krijgt dan de eerste 100 (standaard limiet) records van die betreffende lay-out te zien.

Als je een lay-out heb gekozen, dan haalt FileMaker in de achtergrond direct alle zoekbare velden die niet in een portaal op de lay-out staan op en zet die ook in een keuzelijst. Die keuzelijst kan je dan gebruiken om de query aan te passen en/of het resultaat dat je terugkrijgt te sorteren.

Onderaan kan je nog kiezen welke portalen je wilt terugkrijgen. Laat je die leeg, dan krijg je ze allemaal terug.

Alle waarden en instellingen die je hier aanpast resulteren in het veld “Query” onderaan de waarde die aan “Execute Data-API” gebruikt om gegevens op te zoeken. Hetzelfde object “query” van de JSON uit dat veld kan je ook in de echte Data-API gebruiken om gegevens op te vragen.

De opvraagbare gegevens hangen natuurlijk af van de rechten/privileges waarmee je de database benadert. Jij zit nu met “[Full Access]” toegang te testen terwijl een doorsnee gebruiker veel minder mag. Houdt er daarom rekening mee dat je nog de juiste “Extended-Privileges” in moet instellen.

Aan de rechterzijde op deze lay-out heb je de mogelijkheid om een veld te kiezen en die geeft je dan een lijst terug met de inhoud van dat veld voor alle gevonden record. Dit is slechts bedoeld als voorbeeld en is voor de functionaliteit van de DAE niet belangrijk.

[06-06-2022] Toevoeging bij de MetaData-informatie. Op de dotfmp-meeting in Berlijn – Duitsland van Juni 2022 stelde iemand voor om een JSONSetElements() voorbeeld-formule toe te voegen. Die formule is toegevoegd vanaf versie 1.8 en geeft bij de weergave van MetaData een voorbeeld voor alle velden en 1 portaalrij voor elke portaal op de lay-out. Deze versie van de DAE is ook in de nieuwste download van “SuperHeroes” opgenomen.

Dat is het wel zo’n beetje, veel plezier met het onderzoeken van jouw eigen databases met de DAE 🙂


Top