Documentation des schémas de base de données

Remarque  Cette fonction est disponible lorsque le réglage général Utiliser les outils avancés est sélectionné. Consultez la section Utilisation des outils avancés.

FileMaker Pro permet de documenter les détails de votre app personnalisée  de deux manières différentes :

  • l'enregistrement d'une copie du fichier au format XML ;

  • la création d'un rapport sur la structure des bases de données.

Enregistrement d'une copie au format XML

Vous pouvez enregistrer une copie d'un fichier FileMaker Pro au format XML qui représente le schéma, les modèles, les scripts et d'autres éléments du fichier. Ce format XML contient la plupart des détails du fichier, mais aucune donnée d'enregistrement et les informations de compte sont cryptées.

Comme le fichier XML contient du texte, vous pouvez le stocker dans les systèmes de contrôle de versions, tels que Git, et utiliser des outils texte standard pour comparer les versions.

Pour enregistrer une copie d'un fichier au format XML :

  1. Ouvrez le fichier pour l'enregistrer au format XML.

    Vous devez disposer de privilèges d'accès intégral au fichier.

  2. Sélectionnez le menu Outils > Enregistrer en XML.

  3. Modifiez le nom de fichier par défaut et choisissez un autre dossier si nécessaire.

  4. Pour inclure des informations supplémentaires dans le fichier XML, cliquez sur Inclure les détails pour les outils d'analyse.

    Cette option ajoute l'élément DDR_INFO, qui fournit des informations supplémentaires utiles aux outils tiers d'analyse de votre application personnalisée. En fonction de votre application, cette option est susceptible de générer un fichier XML très volumineux.

  5. Cliquez sur Enregistrer.

Remarques

  • Ce format XML peut changer d'une version de FileMaker Pro à la suivante. Lorsque vous utilisez le XML pour comparer deux versions d'un fichier FileMaker Pro, assurez-vous que la même version de FileMaker Pro est utilisée pour enregistrer chaque fichier au format XML. Si vous utilisez le XML avec d'autres outils, veillez à ce que ces outils soient conçus pour utiliser le XML enregistré par votre version de FileMaker Pro.

  • Pour des raisons de sécurité, envisagez de restreindre l'accès au fichier XML afin d'empêcher l'accès non autorisé aux informations sensibles du fichier.

Création d'un rapport sur la structure des bases de données

La fonction Rapport sur la structure des bases de données vous permet de documenter le schéma de votre base de données et de l'enregistrer dans un fichier HTML ou XML.

La fonction Rapport sur la structure des bases de données vous permet de :

  • générer des rapports sur les bases de données actuellement ouvertes ;

  • de réunir des statistiques sur la structure de votre base de données ;

  • d'utiliser les informations du rapport pour recréer la structure de votre base de données en cas de perte des fichiers de base de données d'origine ;

  • d'examiner la représentation textuelle du schéma de votre base de données ;

  • choisir les éléments (rubriques, liens, scripts, etc.) et les tables de la base de données pour lesquels créer des informations ;

  • de dépanner les références manquantes, les liens rompus, les calculs, etc.

Le Rapport sur la structure des bases de données au format HTML comprend une Présentation du rapport qui fournit un instantané de la plupart des éléments de chaque fichier de base de données. Cette Présentation du rapport contient des liens hypertexte pointant vers les détails relatifs aux éléments de chaque fichier de base de données.

Le Rapport sur la structure des bases de données au format XML contient des informations sur les éléments de chaque fichier de base de données et est prêt à être converti dans le format dont vous avez besoin.

Pour créer un rapport sur la structure des bases de données :

  1. Ouvrez tous les fichiers de bases de données pour lesquels vous souhaitez générer le Rapport.

    Vous devez pour cela disposer de privilèges d'accès intégral pour chaque fichier concerné et ce fichier doit être ouvert dans FileMaker Pro.

  2. Sélectionnez le menu Outils > Rapport sur la structure des bases de données.

  3. Dans la liste Fichiers disponibles, retirez les fichiers à exclure du rapport en désactivant les cases à cocher associées au fichier.

  4. Si certains fichiers contiennent des tables à exclure du rapport, sélectionnez le nom du fichier ainsi que sa case à cocher dans la liste Fichiers disponibles.

  5. Dans Inclure au rapport, désactivez les éléments à exclure du rapport.

  6. Si vous ne souhaitez pas publier le rapport au format HTML par défaut, activez l'option XML dans la section Format du rapport.

  7. Cliquez sur Créer, puis sur Enregistrer pour enregistrer le rapport sur la structure de la base de données.

Remarques

  • L'information fournie dans le rapport HTML est un sous-ensemble de l'information fournie dans la version XML.

Rubriques connexes