< Anterior | Próximo >

Configurando e Instalando o ClearQuest CM API

Antes que possa usar o ClearQuest CM API, você deve incluir arquivos no caminho da classe e ter uma versão licenciada do Rational ClearQuest instalada.
A API é um componente comum para executar operações sobre produtos Rational. Para usar esta API com um produto Rational, você deve ter esse produto instalado em seu sistema. Você também deve copiar os arquivos da API que são instalados em seu sistema ao instalar o produto Rational no caminho da classe.
Os seguintes pacotes Java são necessários para executar operações do Rational ClearQuest usando a API.
  • javax.wvcm: O pacote Workspace Versioning and Configuration Management (WVCM).
  • com.ibm.rational.wvcm.stp: O Rational Software Team Package é uma extensão do pacote WVCM. Este pacote contém as interfaces da API e fornece o modelo de objeto comum para recursos do produtoRational. Este pacote é independente do repositório específico do produto ou dos limites de implementação.
  • com.ibm.rational.wvcm.stp.cq: Uma extensão específica do produto que fornece acesso aos bancos de dados do ClearQuest. Este pacote contém funções que fornecem acesso mais completo (específico do produto) da funcionalidade de um banco de dados ClearQuest e seus recursos subjacentes.

Embora você deva ser capaz de recortar e colar os exemplos de código neste documento no Java compilável, ele não foi compilado e pode conter erros tipográficos que impedem a compilação. As versões completas e compiláveis desses exemplos podem ser localizadas no projeto Eclipse nomeado amostras localizado no archive complementar distribuído com a documentação da API.

Por padrão, o arquivo JAR do ClearQuest CM API e outros arquivos JAR necessários são instalados nos seguintes locais, em que install-dir representa o diretório no qual os arquivos do produto Rational foram instalados. Por padrão, esse diretório é /opt/rational nos sistemas UNIX® e Linux® e C:\Program Files\IBM Rational nos sistemas Windows®.
  • Nos sistemas Windows:
    • <install-dir>/Common/stpwvcm.jar: O arquivo JAR da interface do ClearQuest CM API.
    • <install-dir>/Common/stpcmmn.jar: Um arquivo JAR de implementação comum.
    • <install-dir>/ClearQuest/stpcq.jar: Extensão para o produto ClearQuest.
    • <install-dir>/ClearQuest/cqjni.jar: Um arquivo Rational ClearQuest JAR.
  • Em sistemas UNIX e 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

Você deve incluir os locais do arquivo JAR da API no caminho da classe antes que possa usar a API.

Execute as seguintes etapas para acessar o ClearQuest CM API a partir de um plug-in do Eclipse:

  1. Crie um plug-in do Eclipse utilizando os arquivos localizados no diretório \plugins\com.ibm.rational.stp.cmapi no archive %RATIONAL_INSTALL%\common\cm\teamapi.zip.
  2. Para incluir o plug-in do ClearQuest CM API na configuração de tempo de execução, copie o plug-in na instância do Eclipse ou crie um novo site de instalação da extensão. Isso cria um novo diretório para a API (por exemplo, C:\eclipse\plugins\com.ibm.rational.stp.cmapi). O novo plug-in abrange os arquivos JAR do ClearQuest CM API e os arquivos JAR do Rational ClearQuest.
  3. Após criar o diretório de plug-in, você deverá copiar cada arquivo JAR instalado a partir do local da instalação no diretório. Os arquivos JAR do ClearQuest requerem o arquivo JAR do ClearQuest CM API. O plug-in estará disponível para uso da próxima vez que você iniciar o Eclipse.
  4. Para usar o ClearQuest CM API a partir do plug-in, identifique com.ibm.rational.stp.cmapi como uma dependência.
Agora você está pronto para começar a gravar programas Java usando o ClearQuest CM API.
Você deve ter uma versão licenciada e instalada do Rational ClearQuest antes que possa usar a API com recursos do ClearQuest. Se você instalar e configurar os arquivos JAR, mas não tiver o produto correspondente instalado, as chamadas para esse pacote Java irão falhar.

Ponto de verificação da lição

Agora que você configurou seu sistema para programação com o ClearQuest CM API, está pronto para começar a aprender o modelo de programação e o modelo de objeto da API.
Nesta lição, você aprendeu o seguinte:
  • O relacionamento entre o ClearQuest CM API e o Rational ClearQuest
  • Como configurar seu sistema para programação com o ClearQuest CM API
  • Quais arquivos no ClearQuest CM API são necessários para seu sistema
< Anterior | Próximo >

Feedback