< Précédent | Suivant >

Configuration et installation de l'API CM ClearQuest

Avant de pouvoir utiliser l'API CM ClearQuest, vous devez ajouter des fichiers à votre chemin d'accès aux classes et disposer d'une version sous licence installée de Rational ClearQuest.
L'API est un composant commun destiné à exécuter des opérations sur les produits Rational. Pour utiliser cette API avec un produit Rational, ce produit doit être installé sur votre système. Vous devez également copier les fichiers de l'API qui sont installés sur votre système lorsque vous installez le produit Rational dans votre chemin d'accès aux classes.
Les packages Java ci-après sont requis pour effectuer des opérations Rational ClearQuest à l'aide de l'API.
  • javax.wvcm : le package Workspace versioning and configuration management (WVCM).
  • com.ibm.rational.wvcm.stp : le package Rational software team est une extension du package WVCM. Ce module contient les interfaces de l'API et fournit le modèle d'objet commun pour les ressources des produits Rational. Ce package est indépendant des limites de référentiel ou d'implémentation spécifiques au produit.
  • com.ibm.rational.wvcm.stp.cq : extension spécifique au produit qui fournit un accès aux bases de données ClearQuest. Ce package contient des fonctions qui fournissent un accès (spécifique au produit) plus complet à la fonctionnalité d'une base de données ClearQuest et à ses ressources sous-jacentes.

Bien que vous devriez pouvoir couper et coller les exemples de code dans ce document au format Java compilable, il n'ont pas été compilés et pourraient contenir des erreurs typographiques qui les empêchent d'être compilés. Les versions complètes et compilables de ces exemples sont disponibles dans le projet Eclipse nommé samples, qui se trouve dans le fichier archive supplémentaire fourni avec la documentation de l'API.

Le fichier JAR de l'API CM ClearQuest et d'autres fichiers JAR requis sont installés par défaut aux emplacements suivants, où rép-install représente le répertoire dans lequel les fichiers du produit Rational ont été installés. Par défaut, ce répertoire est /opt/rational sur le système UNIX® et sur Linux® et C:\Program Files\IBM Rational sur les systèmes Windows®.
  • Sur les systèmes Windows :
    • <rép-install>/Common/stpwvcm.jar : Le fichier JAR de l'API CM ClearQuest.
    • <rép-install>/Common/stpcmmn.jar : un fichier JAR d'implémentation commun.
    • <rép-install>/ClearQuest/stpcq.jar : extension du produit ClearQuest.
    • <rép-install>/ClearQuest/cqjni.jar : un fichier JAR Rational ClearQuest.
  • Sur les systèmes UNIX et Linux :
    • <rép-install>/common/stpwvcm.jar
    • <rép-install>/common/stpcmmn.jar
    • <rép-install>/clearquest/cqweb/lib/stpcq.jar
    • <rép-install>/clearquest/cqweb/lib/cqjni.jar

Vous devez ajouter les emplacement su fichier JAR de l'API à votre chemin d'accès aux classes avant de pouvoir utiliser l'API.

Procédez comme suit pour accéder à l'API CM ClearQuest à partir d'un plug-in Eclipse :

  1. Créez un plug-in Eclipse en utilisant les fichiers situés dans le répertoire \plugins\com.ibm.rational.stp.cmapi du fichier archive %RATIONAL_INSTALL%\common\cm\teamapi.zip.
  2. Pour ajouter le plug-in de l'API CM ClearQuest à votre configuration d'exécution, copiez le plug-in dans votre instance Eclipse ou créez un site d'installation d'extension. Un nouveau répertoire est créé pour l'API (par exemple, C:\eclipse\plugins\com.ibm.rational.stp.cmapi). Le nouveau plug-in inclut les fichiers JAR de l'API CM ClearQuest et les fichiers JAR de Rational ClearQuest.
  3. Après avoir créé le répertoire du plug-in, vous devez copier chaque fichier JAR installé depuis l'emplacement dans lequel il est installé dans ce répertoire. Les fichiers JAR ClearQuest nécessitent le fichier JAR de l'API CM ClearQuest. Le plug-in est prêt à être utilisé la prochaine fois que vous démarrez Eclipse.
  4. Pour utiliser l'API CM ClearQuest depuis votre plug-in, identifiez com.ibm.rational.stp.cmapi en tant que dépendance.
Vous êtes désormais prêt à commencer à écrire des programmes Java avec l'API CM ClearQuest.
Vous devez disposer d'une version sous licence et installée de Rational ClearQuest avant de pouvoir utiliser l'API avec les ressources ClearQuest. Si vous installez et configurez les fichiers JAR mais que vous n'avez pas le produit correspondant installé, les appels à ce module Java échoueront.

Résumé de la leçon

Maintenant que vous avez configuré votre système pour une programmation avec l'API CM ClearQuest, vous êtes prêt à en savoir plus sur le modèle d'objet et le modèle de programmation de l'API.
Dans cette leçon, vous avez appris les notions suivantes :
  • La relation entre l'API CM ClearQuest et Rational ClearQuest
  • Comment configurer votre système pour une programmation avec l'API CM ClearQuest
  • Les fichiers de l'API CM ClearQuest requis pour votre système
< Précédent | Suivant >

Retour d'informations