Databaseschema's documenteren

Opmerking  Deze functie is beschikbaar als de algemene instelling Geavanceerde tools gebruiken is ingeschakeld. Raadpleeg Geavanceerde tools gebruiken.

FileMaker Pro biedt twee mogelijkheden om de gegevens van uw app op maat te documenteren, namelijk door het volgende op te slaan:

  • een kopie van het bestand in XML-indeling

  • een Database Design Report

Kopie opslaan als XML

U kunt een kopie van een FileMaker Pro-bestand opslaan in een XML-indeling waarin het schema, de lay-outs, de scripts en andere onderdelen van het bestand naar voren komen. In deze XML-indeling worden de meeste gegevens van het bestand opgenomen, maar de indeling bevat geen recordgegevens.

Omdat het XML-bestand uit tekst bestaat, kunt u het opslaan in versiebeheersystemen zoals Git en standaard, op tekst gebaseerde tools gebruiken om versies met elkaar te vergelijken.

Zo slaat u een kopie van een bestand op als XML:

  1. Open het bestand dat u als XML wilt opslaan.

    U moet over volledige toegangsprivileges beschikken voor het bestand.

  2. Kies Gereedschappen > Kopie opslaan als XML.

  3. Wijzig de standaardbestandsnaam en kies indien nodig een andere map.

  4. Als u aanvullende informatie wilt opnemen in het XML-bestand, klikt u op Inclusief gegevens voor analysetools.

    Met deze optie wordt het DDR_INFO-element toegevoegd, dat extra informatie biedt die nuttig is voor tools van derden die u kunt gebruiken om uw aangepaste app te analyseren. Afhankelijk van uw app kan deze optie een aanzienlijk groter XML-bestand produceren.

  5. Klik op Opslaan.

Opmerkingen

  • Deze XML-indeling kan variëren tussen opeenvolgende versies van FileMaker Pro. Wanneer u de XML gebruikt om twee versies van een FileMaker Pro-bestand te vergelijken, zorg er dan voor dat u dezelfde versie van FileMaker Pro gebruikt om van elk bestand een XML-kopie op te slaan. Als u de XML gebruikt met andere tools, moeten deze tools ondersteuning bieden voor de XML die wordt opgeslagen door uw versie van FileMaker Pro.

  • Uit veiligheidsoverwegingen kan het zinvol zijn om de toegang tot het XML-bestand te beperken om onbevoegde toegang tot vertrouwelijke gegevens in het bestand te voorkomen.

Een Database Design Report maken

Gebruik de functie Database Design Report om het schema van uw database te documenteren en het als een HTML- of XML-bestand op te slaan.

Met Database Design Report kunt u:

  • rapporten maken voor elke database die op dat ogenblik is geopend

  • statistische gegevens verzamelen over de structuur van uw database

  • de informatie in het rapport gebruiken om de structuur van uw database opnieuw te maken als u ooit de originele databasebestanden zou verliezen

  • een tekstuele voorstelling van uw databaseschema onderzoeken

  • een selectie maken van de elementen (velden, relaties, scripts, enz.) en tabellen in de database die u wilt documenteren

  • problemen met ontbrekende verwijzingen, verbroken relaties, berekeningen, en nog veel meer oplossen

Een Database Design Report in HTML-formaat bevat een Rapportoverzicht dat een snapshot bevat van de meeste elementen in elk databasebestand. Het Rapportoverzicht bevat hyperlinks naar details over elementen in elk databasebestand.

Een Database Design Report in XML-indeling bevat informatie over de elementen in elk databasebestand en is klaar om naar de gewenste indeling te worden geconverteerd.

Zo maakt u een Database Design Report:

  1. Open alle databasebestanden waarvoor u een Database Design Report wilt opstellen.

    U moet beschikken over volledige toegangsprivileges voor elk bestand waarvoor u een Database Design Report wilt opstellen en het bestand moet in FileMaker Pro geopend zijn.

  2. Kies Gereedschappen  > Database Design Report.

  3. In de lijst Beschikbare bestanden schakelt u alle bestanden uit die u niet in het rapport wilt opnemen door het overeenkomstige selectievakje uit te schakelen.

  4. Als er bestanden zijn die tabellen bevatten die u niet in het rapport wilt opnemen, selecteert u het bestand naast het selectievakje in de lijst Beschikbare bestanden.

  5. In de lijst Opnemen in rapport schakelt u elementen uit die u uit het rapport wilt uitsluiten.

  6. Als u het rapport niet in het standaard HTML-formaat maar in het XML-formaat wilt publiceren, selecteert u de optie XML in het gebied Rapportformaat.

  7. Klik op Maken en daarna op Opslaan om het Database Design Report op te slaan.

Opmerkingen

  • De informatie in het HTML-rapport is een deel van de informatie die in de XML-versie wordt geleverd.

Verwante onderwerpen