Scripts de registros são um forma genérica de gancho que são chamados em resposta a uma evento em um formulário ou em outros ganchos. Você pode gravar um script que desempenhe um comportamento customizado no contexto de um registro. Os scripts são executados no contexto do registro atualmente selecionado. Uma sub-rotina de script de registro é específica de um tipo de registro.
Geralmente, scripts de registros são utilizados para implementar uma ação que é desempenhada em resposta a um evento de clique em um botão de comando ou em um item de menu de contexto item que está associado a um determinado campo em um formulário. Por exemplo, um script de registro pode enviar dados sobre o registro atual para um outro sistema.
Você pode executar um script de registro de três formas:
Por exemplo, no esquema TeamTest, o script de registro Build_Properties permite que os usuários visualizem as propriedades da construção selecionada. O script é associado a um botão que executa o script. O script de registro Build_Properties recupera as informações de construção do repositório do Rational ClearQuest e as exibe em uma janela.
O exemplo a seguir mostra a sintaxe do script de registro do Visual Basic:
Function RecordName_HookName(param) ' param As Variant ' RecordName_HookName As Variant ' ... End Function
Ao chamar um script de registro a partir de um outro gancho, o parâmetro transmitido para o gancho é uma variante que contém os dados apropriados. Se o gancho retornar informações para o gancho de chamada, retorne essas informações em uma Variante.
Quando associado a um controle de formulário, o parâmetro transmitido para o método contém uma instância da classe EventObject. Essa instância contém informações sobre o evento que causou a chamada do gancho. (Consulte Eventos de Controle de Formulário). O software Rational ClearQuest não espera um valor de retorno dos scripts de registro quando associados a controladores de formulários. Um valor de retorno não-nulo de um gancho de registro é interpretado como um erro e pode ser visualizado em uma caixa de mensagem pelo cliente Rational ClearQuest.
Os scripts de registros podem ser associados a botões de comandos, campos de texto e listas. Quando associados a um botão, clicar o botão faz com que o gancho seja executado. Quando associados a campos de texto e controles relacionados a listas, o gancho é incluído no menu de contexto para o controle.
Também é possível associar um script de registro a uma ação cujo tipo é RECORD_SCRIPT_ALIAS. Esta associação permite colocar um botão customizado no menu Ação de um formulário do Rational ClearQuest.
O Rational ClearQuest Web examina o valor de retorno de um script de registro chamado por um botão de comando. Se o valor de retorno for uma cadeia, ele será considerado como uma mensagem de erro e o gancho falhará.
Se você não configurar explicitamente o valor de retorno da função do script de registro, ele retornará um valor nulo ou vazio, o que indica que o gancho foi executado com êxito.
Para ativar os ganchos de registros para a Web, selecione Ativar para Web na guia Estendido da folha de propriedades de controle.
No Rational ClearQuest Web, os ganchos de registros são executados no servidor do Rational ClearQuest Web. Por este motivo, não chame rotinas do Windows que fazem uma janela abrir; a janela é aberta no servidor em vez de abrir no cliente. O servidor do Rational ClearQuest Web configura um objeto Session.NameValue chamado CQ_WEB_SESSION ao iniciar uma sessão do servidor para que seus scripts possam ser ativados para Web.
Quando um script de registro é acionado por um controle de formulário, o software Rational ClearQuest transmite o script de registro para um objeto EventObject como seu parâmetro. Esse objeto contém informações sobre o tipo de evento que ocorreu. Diferentes controles podem gerar diferentes tipos de eventos, incluindo cliques de botões, seleções de itens e assim por diante. Você deve utilizar as informações no objeto EventObject para determinar como manipular o evento.
O seguintes tipos de eventos são gerados para os controles de formulários:
A tabela a seguir lista o tipo de evento suportado para cada controle e as informações extra fornecidas pelo EventObject. As constantes listadas sob a coluna de tipo de evento suportado fazem parte do tipo enumerado EventType.
Tipo de Controle | Tipo de Evento Suportado | Informações Adicionais |
---|---|---|
Botão de comando | AD_BUTTON_CLICK | Nome do botão |
Caixa de combinação | AD_CONTEXMENU_ITEM_SELECTION | Cadeia nula |
Lista de opções suspensa | AD_CONTEXMENU_ITEM_SELECTION | Cadeia nula |
Lista de opções | AD_CONTEXMENU_ITEM_SELECTION | Seleção de valor de campo atual |
Visualização em lista | AD_CONTEXMENU_ITEM_SELECTION | Seleção de valor de campo atual |
Caixa de texto | AD_CONTEXMENU_ITEM_SELECTION | Seleção de valor de campo atual |
Caixa de combinação suspensa | AD_CONTEXMENU_ITEM_SELECTION | Cadeia nula |