< 上一個課程 | 下一個課程 >

設定及安裝 ClearQuest CM API

在可以使用 ClearQuest® CM API 之前,您必須新增檔案至類別路徑,並已安裝 Rational® ClearQuest 的授權版本。
API 是對 Rational 產品執行作業的一般元件。若要對 Rational 產品使用這個 API,您必須將該產品安裝在系統上。您還必須把在安裝 Rational 產品時已安裝在系統上的 API 檔案複製到類別路徑。
需要下列 Java 套件,才能使用 API 執行 Rational ClearQuest 作業。
  • javax.wvcm:工作區版本化及配置管理套件 (WVCM)。
  • com.ibm.rational.wvcm.stp:Rational 軟體小組套件是 WVCM 套件的延伸規格。此套件包含 API 的介面,並為 Rational 產品資源提供一般物件模型。此套件與產品專用儲存庫或實作界限無關。
  • com.ibm.rational.wvcm.stp.cq:產品專用延伸規格,提供 ClearQuest 資料庫的存取權。此套件包含的功能,對 ClearQuest 資料庫及其基礎資源的功能提供更完整的(產品專用)存取權。

雖然您可以將此文件中的程式碼範例剪下並貼到可編譯的 Java 中,但它沒有編譯過,有可能因為包含印刷錯誤而無法編譯。這些範例的完整可編譯版本,可在補充保存檔中的 samples Eclipse 專案中找到,該保存檔是隨 API 文件而分送的。

依預設,ClearQuest CM API JAR 檔和其他必要的 JAR 檔會安裝在下列位置,其中 install-dir 代表已安裝 Rational 產品檔案的目錄。依預設,此目錄在 UNIX® 系統及 Linux® 上為 /opt/rational,在 Windows® 系統上則為 C:\Program Files\IBM Rational。
  • 在 Windows 系統上:
    • <install-dir>/Common/stpwvcm.jar:ClearQuest CM API 介面 JAR 檔。
    • <install-dir>/Common/stpcmmn.jar:一般實作 JAR 檔。
    • <install-dir>/ClearQuest/stpcq.jar:ClearQuest 產品的延伸規格。
    • <install-dir>/ClearQuest/cqjni.jar:Rational ClearQuest JAR 檔。
  • 在 UNIX 及 Linux 系統上:
    • <install-dir>/common/stpwvcm.jar
    • <install-dir>/common/stpcmmn.jar
    • <install-dir>/clearquest/cqweb/lib/stpcq.jar
    • <install-dir>/clearquest/cqweb/lib/cqjni.jar

您必須新增 API JAR 檔位置至類別路徑,然後才能使用 API。

請執行下列步驟,從 Eclipse 外掛程式存取 ClearQuest CM API:

  1. 使用位於保存檔 %RATIONAL_INSTALL%\common\cm\teamapi.zip 中目錄 \plugins\com.ibm.rational.stp.cmapi 的檔案,來建立 Eclipse 外掛程式。
  2. 若要將 ClearQuest CM API 外掛程式新增至執行時期配置中,請將外掛程式複製到 Eclipse 實例中,或建立新的延伸規格安裝網站。這樣會為 API 建立新目錄(例如,C:\eclipse\plugins\com.ibm.rational.stp.cmapi)。 新的外掛程式包含 ClearQuest CM API JAR 檔及 Rational ClearQuest JAR 檔。
  3. 在建立外掛程式目錄之後,必須將每一個已安裝的 JAR 檔從其安裝位置複製到這個目錄。ClearQuest JAR 檔需要 ClearQuest CM API JAR 檔。 下次啟動 Eclipse 時,即可使用此外掛程式。
  4. 若要從外掛程式使用 ClearQuest CM API,請將 com.ibm.rational.stp.cmapi 識別為相依關係。
現在您準備好使用 ClearQuest CM API 來開始撰寫 Java 程式。
您必須已安裝 Rational ClearQuest 的授權版本,才能使用 API 與 ClearQuest 資源搭配。如果您安裝及配置 JAR 檔,但沒有安裝對應的產品,則對該Java 套件的呼叫會失敗。

課程檢查點

現在您已設定系統來使用 ClearQuest CM API 進行程式設計,您就可以開始學習 API 物件模型及程式設計模型。
在這一課,您學到下列各項:
  • ClearQuest CM API 與 Rational ClearQuest 之間的關係
  • 如何設定系統使用 ClearQuest CM API 進行程式設計
  • 您系統需要 ClearQuest CM API 中的哪些檔案
< 上一個課程 | 下一個課程 >

意見