データベースのスキーマのドキュメント化

メモ  この機能は [設定] ダイアログボックスの [一般] タブで [高度なツールを使用する] が選択されている場合に使用できます。高度なツールの使用を参照してください。

FileMaker Pro にはカスタム App の詳細をドキュメント化する方法が 2 つあり、次の方法で保存できます:

  • XML 形式のファイルのコピー

  • データベースデザインレポート

XML としてコピーを保存

FileMaker Pro ファイルのコピーをテーブル、フィールド、リレーションシップ、レイアウト、スクリプトなどの各部分を表す XML 形式で保存できます。この XML 形式にはファイルに関する詳細のほとんどが含まれていますが、レコードデータは含まれません。

XML ファイルはテキストのため、それを Git などのバージョン管理システムに保存し、標準的なテキストベースのツールを使用して各バージョンを比較することができます。

ファイルのコピーを XML として保存するには:

  1. XML として保存するすべてのファイルを開きます。

    ファイルに対して完全アクセス権が必要です。また、ファイルを FileMaker Pro で開く必要があります。

  2. [ツール] > [名前を付けて XML として保存...] を選択します。

  3. [使用できるファイル:] の一覧で、除外するファイルの選択を解除します。

  4. [含めるカタログ] から、除外するカタログの選択を解除します。

    カタログはカスタム App のスキーマをともに定義するさまざまなタイプの要素 (テーブル、フィールド、リレーションシップ、スクリプト、レイアウトなど) です。

  5. 追加オプションを選択します。

    選択項目 目的

    分析ツールの詳細を含める

    XML ファイルに詳細情報を追加します。

    このオプションはカスタム App の分析に使用できるサードパーティ製のツールに役立つ追加情報を含む DDR_INFO 要素を追加します。カスタム App によっては、このオプションでは非常に大きな XML ファイルが生成されます。
    各レイアウトオブジェクトのバイナリデータをノード下に保存

    すべてのレイアウトオブジェクトのバイナリデータ (イメージなど) を XML ファイルのレイアウトオブジェクトのノード下に保存します。これにより一部のツールで XML をより簡単に使用できるようになりますが、XML ファイルのサイズが大きくなる可能性があります。

    このオプションの選択を解除すると、各レイアウトオブジェクトのノードには、バイナリデータが保存されているライブラリデータカタログを指す参照のみが保存されます。これにより同じバイナリデータが多くのレイアウトオブジェクトに使用されている場合のファイルサイズを小さくすることができます。

    カタログごとに別の XML ファイルを作成する場合、このオプションが選択されて変更することはできません。

    各データベースでカタログごとに別の XML ファイルを作成

    データベース内の選択したカタログごとに個別の XML ファイルを作成します。XML ファイルはデータベースごとに別々のフォルダに保存されます。

    選択を解除すると、このオプションはデータベースごとに 1 つの XML ファイルを作成します。

    完了時に自動的に概要を開く

    複数の XML ファイルを作成する場合、関連するアプリケーションで「概要.xml」ファイルを開きます。

  6. [作成] をクリックします。

  7. 必要に応じてデフォルトのファイル名を変更し、別のフォルダを選択します。

    複数の XML ファイルを保存する場合、「概要.xml」ファイルのファイル名になります。

  8. [保存] をクリックします。

メモ

  • この XML 形式は、FileMaker Pro のバージョンごとに変更されることがあります。XML を使用して FileMaker Pro ファイルの 2 つのバージョンを比較する場合、必ず同じバージョンの FileMaker Pro を使用して各ファイルのコピーを XML として保存してください。他のツールで XML を使用する場合は、それらのツールが、ご使用の FileMaker Pro バージョンで保存された XML を使用するように設計されていることを確認してください。

  • セキュリティ上の理由で、XML ファイル内の機密情報への不正なアクセスを防止するため、XML ファイルへのアクセスを制限することを検討してください。

データベースデザインレポートの作成

データベースデザインレポート機能を使用すると、データベースのスキーマをドキュメント化して HTML または XML ファイルに保存することができます。

データベースデザインレポートを使用して、次の操作を行うことができます:

  • 現在開いているデータベースのレポートを生成する

  • データベースの構造に関する統計を収集する

  • 元のデータベースファイルが失われた場合に、レポートの情報を使用してデータベースの構造を再作成する

  • データベーススキーマをテキストで表して確認する

  • ドキュメント化するデータベースの要素 (フィールド、リレーションシップ、スクリプトなど) とテーブルを選択する

  • 破損した参照、リレーションシップ、計算式などのトラブルシューティング

HTML 形式のデータベースデザインレポートには、各データベースファイルのほとんどの要素のスナップショットを提供するレポートの概要が含まれます。レポートの概要には、各データベースファイル内のすべての要素に関する詳細情報へのハイパーリンクが設定されています。

XML 形式のデータベースデザインレポートにも各データベースの要素についての情報が含まれており、必要な形式に変換することができます。

データベースデザインレポートを生成するには:

  1. データベースデザインレポートを生成するすべてのデータベースファイルを開きます。

    データベースデザインレポートを生成するすべてのファイルに対して、完全アクセス権が必要です。また、ファイルを FileMaker Pro で開く必要があります。

  2. [ツール] メニュー > [データベースデザインレポート...] を選択します。

  3. [使用できるファイル] の一覧で、レポートから除外するファイルに対応するチェックボックスの選択を解除します。

  4. レポートから除外するテーブルが含まれるファイルがある場合は、[使用できるファイル] の一覧のチェックボックスに加えてファイル名を選択します。

  5. [レポートに含める] で、レポートから除外する要素を解除します。

  6. デフォルトの HTML 形式ではなく、XML 形式でレポートを発行する場合は、[レポート形式] セクションで [XML] を選択します。

  7. [作成] をクリックしてから [保存] をクリックして、データベースデザインレポートを保存します。

メモ

  • HTML レポートで提供される情報は、XML バージョンで提供される情報のサブセットです。

関連項目