A sequência comum para usar a API do ClearQuest começa com estas etapas:
- Inicie uma sessão do ClearQuest.
- Efetue logon no banco de dados do ClearQuest
- Trabalhe com os registros do ClearQuest.
- Termine a sessão do ClearQuest.
Para aplicativos externos, é necessário cria um objeto
Session e usá-lo para efetuar login em um banco de dados do usuário.
Sintaxe para a criação de um objeto
Session:
require CQPerlExt;
$CQsession = CQSession::Build();
Depois, é possível efetuar o login em um banco de dados
chamando o método
UserLogon do objeto Session recentemente criado ou obtendo primeiramente uma lista
dos bancos de dados acessíveis.
Quando tiver terminado seu trabalho com a sessão, exclua o objeto Session
com o método
Unbuild. Sintaxe para liberação de um objeto Session:
CQSession::Unbuild($session);
Os ganchos são anexados aos eventos que ocorrem quando um
usuário interage com o IBM Rational ClearQuest. Já que os ganchos executam em horários predefinidos durante o
meio de uma sessão, seu código de gancho não termina uma sessão. A sessão termina automaticamente quando o
usuário efetua o logoff. Entretanto, ao escrever um aplicativo externo, é necessário terminar a sessão atual
por meio da exclusão do objeto Session que foi criado. Exclua quaisquer objetos que tenha criado
explicitamente e que não precisa mais, incluindo um objeto Session.