Dokumentieren von Datenbankschemata

Hinweis  Diese Funktion ist verfügbar, wenn die allgemeine Einstellung Erweiterte Werkzeuge verwenden ausgewählt ist. Weitere Informationen finden Sie unter Verwenden von erweiterten Werkzeugen.

FileMaker Pro bietet zwei Möglichkeiten zum Dokumentieren der Details Ihrer eigenen App, indem wahlweise Folgendes gespeichert wird:

  • eine Kopie der Datei im XML-Format

  • ein Datenbank-Design-Report

Speichern einer Kopie als XML

Sie können eine Kopie einer FileMaker Pro-Datei in einem XML-Format speichern, das die Schemata, Layouts, Scripts und andere Teile der Datei darstellt. Dieses XML-Format enthält die meisten Details zur Datei, doch sie enthält keine Datensatzdaten.

Da die XML-Datei in Textform vorliegt, können Sie sie in Versionsverwaltungssystemen wie Git speichern und die Versionen mit textbasierten Standardwerkzeugen vergleichen.

So speichern Sie eine Kopie einer Datei als XML:

  1. Öffnen Sie die Datei, die als XML gespeichert werden soll.

    Sie benötigen volle Zugriffsrechte für die Datei.

  2. Wählen Sie Werkzeuge > Kopie als XML speichern.

  3. Ändern Sie den Standarddateinamen und wählen Sie ggf. einen anderen Ordner aus.

  4. Um zusätzliche Informationen in die XML-Datei aufzunehmen, klicken Sie auf Details für Analysewerkzeuge einschließen.

    Diese Option fügt das Element DDR_INFO hinzu, das zusätzliche Informationen bereitstellt, die für Drittanbieter-Werkzeuge nützlich sind, mit denen Sie Ihre eigene App analysieren können. Je nach App kann diese Option zu einer deutlich größeren XML-Datei führen.

  5. Klicken Sie auf Speichern (Windows) bzw. Sichern (macOS).

Hinweise

  • Dieses XML-Format kann sich von einer Version von FileMaker Pro zur nächsten ändern. Wenn Sie das XML verwenden, um zwei Versionen einer FileMaker Pro-Datei zu vergleichen, stellen Sie sicher, dass dieselbe Version von FileMaker Pro verwendet wird, um eine Kopie jeder Datei als XML zu speichern. Wenn Sie das XML mit anderen Tools verwenden, stellen Sie sicher, dass diese Tools so konzipiert sind, dass sie das XML verwenden, das von Ihrer Version von FileMaker Pro gespeichert wurde.

  • Aus Sicherheitsgründen sollten Sie den Zugriff auf die XML-Datei einschränken, um unbefugten Zugriff auf vertrauliche Daten in der Datei zu verhindern.

Erstellen eines Datenbank-Design-Reports

Verwenden Sie die Funktion Datenbank-Design-Report, um das Schema Ihrer Datenbank zu dokumentieren und als HTML- oder XML-Datei zu speichern.

Mit der Funktion „Datenbank-Design-Report“ können Sie:

  • Berichte für beliebige Datenbanken erzeugen, die derzeit geöffnet sind.

  • Statistiken über die Struktur Ihrer Datenbank generieren.

  • die Informationen im Report verwenden, um die Struktur Ihrer Datenbank wieder zu erstellen, falls die originalen Datenbankdateien verloren gehen.

  • eine Textdarstellung Ihres Datenbankschemas analysieren.

  • wählen, welche Elemente (Felder, Beziehungen, Scripts usw.) und Tabellen der Datenbank dokumentiert werden sollen.

  • Probleme in Bezug auf fehlende Verweise, unterbrochene Beziehungen, Formeln u. v. m. überprüfen.

Ein Datenbank-Design-Report in HTML-Format enthält eine Reportübersicht, die einen Überblick über die meisten Elemente in jeder Datenbankdatei enthält. Die Reportübersicht enthält Hyperlinks zu Details der Elemente in jeder Datenbankdatei.

Ein Datenbank-Design-Report in XML-Format enthält Informationen über die Elemente in jeder Datenbankdatei und kann direkt in ein anderes benötigtes Format konvertiert werden.

So erstellen Sie einen Datenbank-Design-Report:

  1. Öffnen Sie alle Datenbankdateien, für die Sie einen Datenbank-Design-Report erstellen möchten.

    Sie benötigen die vollen Zugriffsrechte für jede der Dateien, für die Sie einen Datenbank-Design-Report erstellen möchten, und die Dateien müssen in FileMaker Pro geöffnet sein.

  2. Wählen Sie Werkzeuge > Datenbank-Design-Report.

  3. Entfernen Sie alle Dateien aus der Liste Verfügbare Dateien, die Sie aus dem Report ausschließen möchten, indem Sie das Markierungsfeld für die jeweilige Datei deaktivieren.

  4. Wenn es Dateien gibt, die Tabellen enthalten, die Sie aus dem Report ausschließen möchten, wählen Sie den Dateinamen zusätzlich zu dem Markierungsfeld in der Liste Verfügbare Dateien aus.

  5. Entfernen Sie aus In Report aufnehmen Elemente, die Sie aus dem Report ausschließen möchten.

  6. Wenn der Report statt im Standard-HTML-Format im XML-Format veröffentlicht werden soll, wählen Sie XML im Abschnitt „Reportformat“.

  7. Klicken Sie auf Erstellen und anschließend auf Speichern (Windows) bzw. Sichern (macOS), um den Datenbank-Design-Report zu speichern.

Hinweise

  • Die im HTML-Report bereitgestellten Informationen sind nur eine Untermenge der in der XML-Version bereitgestellten Informationen.

Weiterführende Themen