Référence bfexport

La commande bfexport vous permet d'exporter des données de projet vers un fichier XML nommé ou d'envoyer des données de projet vers le terminal d'affichage (stdout) pour consultation. Un fichier d'exportation contient les données de configuration du projet d'un projet individuel ou d'un cliché de projet.

Syntaxe

bfexport

bfexport [-l]

bfexport [-l] <nom_projet>
bfexport [-c
"<commentaire>"] [-f <nom_fichier>] [-g] [-s] [-C]
[-L ] [-n ] 
<nom_projet> | <nom_projet>
<nom_cliché> | <ID_projet>

Syntaxe

Pour effectuer des tâches d'exportation de projet usuelles, utilisez les options de commande suivantes :
  • Pour afficher la syntaxe de commande, utilisez la commande bfexport sans option.
  • Pour répertorier les noms de projet et les ID de projet stockés dans la base de données Build Forge, utilisez bfexport -l.

    Les noms de cliché sont ajoutés au nom de projet dans le résultat de la commande : <ID_projet>: <nom_projet> – <nom_cliché>

  • Pour envoyer des données de projet vers un fichier XML, entrez bfexport -f <nom_fichier>. Vous devez indiquer l'option -f <nom_fichier> pour générer un fichier pouvant être utilisé pour importer les données de projet.
  • Sur la plate-forme z/Linux, vous devez exécuter la commande sous la forme bfexport.pl. Sur les autres plates-formes, la commande ne requière aucune extension.

Pré-requis et restrictions

Recherchez l'utilitaire bfexport dans votre répertoire d'installation Build Forge.

Les mots de passe d'autorisation d'accès au serveur ne sont pas inclus au fichier d'exportation ; à l'issue de l'importation, vous devez entrer les mots de passe d'autorisation d'accès au serveur manuellement dans l'interface utilisateur.

La commande bfexport doit pouvoir rechercher le fichier buildforge.conf et accéder à la base de données Build Forge. Exécutez la commande bfexport à partir du répertoire dans lequel se trouve buildforge.conf, c'est-à-dire <rép_install_bf> sous Windows et <rép_install_bf>/Platform sous UNIX et Linux.

Exemples

Pour écrire des résultats dans un fichier, utilisez l'option -f <nom_fichier>. Dans l'exemple suivant, helloworld correspond au nom du fichier de sortie et l'ID projet est utilisé à la place du nom de projet.

bfexport -c "Sauvegarde d'une copie du projet avant d'effectuer les changements" 
 -f helloworld 675B57CC-8366-11DD-B2E0-043C04E44E1A

Pour exporter uniquement le cliché de projet par défaut, utilisez le <nom_projet>.

bfexport -f helloworld projet_test

Pour exporter un cliché d'un projet, utilisez le <nom_projet> <nom_cliché>.

bfexport -f helloworld cliché_1_projet_test

Si le cliché parent du projet ne correspond pas au projet par défaut, vous devez indiquer le <nom_projet> suivi du mot clé parent pour exporter le cliché parent du projet.

bfexport -f helloworld parent du projet_test

Descriptions des options

Option Description
<nom_projet> Nom du projet à exporter. Le nom de projet ou l'ID du projet est obligatoire. Si le nom de projet contient des espaces, vous devez mettre le nom entre guillemets.

Indiquez le nom du projet après les options de commande.

<nom_cliché> Nom du cliché du projet à exporter ; le nom du projet est obligatoire, comme indiqué dans la syntaxe suivante :
<nom_projet>
<nom_cliché>

Indiquez le nom du projet et le nom du cliché après les options de commande. Si le nom du projet ou du cliché contient des espaces, vous devez mettre le nom entre guillemets.

<ID_projet> Identificateur du projet à exporter. L'ID du projet est un identificateur unique universel. L'ID du projet ou le nom du projet est obligatoire.

Indiquez l'ID du projet après les options de commande.

-f <nom_fichier> Nom de fichier XML pour les résultats de la commande bfexport. Si vous n'indiquez pas de nom de chemin, le répertoire de travail en cours est utilisé. Si le nom de fichier contient des espaces, vous devez mettre le nom entre guillemets.

Si vous n'indiquez pas de nom de fichier, les résultats de la commande bfexport sont envoyés vers la sortie standard (stdout).

Remarque : Utilisez la sortie standard uniquement à des fins de consultation. Ne réacheminez pas la sortie standard vers un fichier ; le fichier généré contient des messages de consignation et ne peut pas être utilisé comme fichier d'importation pour la commande bfimport ou l'utilitaire d'importation de l'interface utilisateur.
parent Mot clé obligatoire pour exporter un cliché de projet parent si le parent n'est pas le cliché du projet par défaut.

Indiquez le mot clé parent après le nom du cliché du projet :

bfexport -f helloworld parent du projet_test
-l Répertorie les projets de la base de données par nom et ID de projet. Vous ne pouvez pas utiliser l'option -l avec d'autres options.
-c "<commentaire>" Inclut un commentaire. Vous devez mettre le commentaire entre guillemets (par exemple, "mon projet version 50"). Le commentaire est ajouté à l'élément XML <buildforge>.
-g Sauvegarde dans le fichier XML les utilisateurs membres des groupes d'accès désignés pour la réception des notifications. Les utilisateurs et leurs propriétés sont répertoriés dans l'élément XML <user>. Nécessite -s.
-s Sauvegarde dans le fichier XML les serveurs définis dans la console de gestion. Les serveurs et leurs propriétés sont répertoriés dans l'élément XML <server>, avec toutes les informations concernant <auth> et <collector> associées.
-L Sauvegarde dans le fichier XML les contrôleurs de domaine LDAP définis dans l'interface utilisateur. Les contrôleurs de domaine LDAP ainsi que leurs propriétés sont répertoriés dans l'élément XML <ldap>.
-n Sauvegarde dans le fichier XML les modèles de notification attribués au projet et aux étapes. Les modèles de notification et leurs propriétés sont répertoriés dans l'élément XML <mail-template>.
-C Sauvegarde dans le fichier XML les collecteurs attribués aux serveurs pour le projet. Les collecteurs et leurs propriétés sont répertoriés dans l'élément XML <collector>. Nécessite -s.

Identification et résolution des problèmes

Si vous rencontrez des erreurs indiquant que des fichiers de rapport ou des bibliothèques sont introuvables, assurez-vous que le chemin d'accès de bibliothèque est correctement défini.

Les paramètres appropriés se trouvent dans <rép_install_bf>/rc/buildforge. Vérifiez la variable de chemin d'accès de bibliothèque et les autres variables définies dans ce fichier. Définissez-les à nouveau si nécessaire, puis exportez-les.


Commentaires en retour