Scripts de registro

En este tema se explica el concepto de scripts de registro de ClearQuest.

Los scripts de registro son un formulario genérico de enganche a los que se llama como respuesta a un suceso en un formulario o desde otros enganches. Puede escribir un script que se comporte de forma personalizada en el contexto de un registro. Los scripts se ejecutan en el contexto del registro seleccionado actualmente. Una subrutina de script de registro es específica de un tipo de registro.

Normalmente, los scripts de registro se utilizan para implementar una acción que se realiza como respuesta a un suceso de pulsación de un pulsador o de un elemento del menú contextual asociado a un campo determinado de un formulario. Por ejemplo, un script de registro puede enviar datos a otro sistema acerca del registro actual.

Puede ejecutar un script de registro de tres formas:

En el ejemplo siguiente se muestra la sintaxis del script del registro de Visual Basic:

 Function RecordName_HookName(param) 
   ' param como Variant 
   ' RecordName_HookName como Variant 
   ' ...
 End Function 
 

Cuando se llama a un script de registro desde otro enganche, el parámetro que se pasa al enganche es un elemento Variant que contiene los datos apropiados. Si el enganche devuelve información al enganche que lo llama, devuelve dicha información en un elemento Variant.

Cuando está asociado a un control de formulario, el parámetro que se pasa en el método contiene una instancia de la clase EventObject. Esta instancia contiene información sobre el suceso que ha ocasionado la llamada al enganche. (Consulte Sucesos de control de formulario). El software Rational ClearQuest no espera ningún valor de retorno procedente de los scripts de registro cuando están asociados a controles de formulario. Un valor de retorno no nulo procedente de un enganche de registro se interpreta como un error y el cliente de Rational ClearQuest lo puede ver en un recuadro de mensaje.

Los scripts de registro pueden estar asociados a pulsadores, campos de texto y listas. Cuando están asociados a un botón, el hecho de pulsarlo provoca la ejecución del enganche. Cuando están asociados a campos de texto y a controles relacionados de lista, el enganche se añade al menú contextual del control.

También puede asociar un script de registro con una acción cuyo tipo sea RECORD_SCRIPT_ALIAS. Esta asociación permite colocar un botón personalizado en el menú Acción de un formulario de Rational ClearQuest.

Para obtener más información, consulte:

Utilización de scripts de registro en Rational ClearQuest Web

Rational ClearQuest Web consulta el valor de retorno de un script de registro invocado por un pulsador. Si el valor de retorno es una serie, se considera un mensaje de error y el enganche falla.

Si no establece explícitamente el valor de retorno de la función del script de registro, se devuelve un valor nulo o vacío que indica que el enganche se ha ejecutado satisfactoriamente.

Para habilitar los enganches de registro para la web, seleccione Habilitar para web en el separador Ampliado de la hoja de propiedades del control.

En la web Rational ClearQuest, los enganches de registro se ejecutan en el servidor web Rational ClearQuest. Por este motivo, no llame a las rutinas de Windows que hagan que se abra una ventana; la ventana se abrirá en el servidor en lugar de hacerlo en el cliente. El servidor de web de Rational ClearQuest establece un objeto Session.NameValue denominado CQ_WEB_SESSION cuando inicia una sesión de servidor para que los scripts puedan habilitarse para la web.

Sucesos de control de formulario

Cuando un script de registro se desencadena mediante un control de formulario, el software Rational ClearQuest pasará al script de registro un objeto EventObject como su parámetro. Este objeto contiene información sobre el tipo de suceso que se ha producido. Distintos controles pueden generar distintos tipos de sucesos, que incluyen pulsaciones de botones, selecciones de elementos, etc. Debe utilizar la información del objeto EventObject para determinar cómo manejar el suceso.

Los siguientes tipos de sucesos se generan para controles de formulario:

La tabla siguiente muestra el tipo de suceso al que se da soporte para cada control y la información extraordinaria que proporciona EventObject. Las constantes que se muestran bajo la columna de tipo de suceso soportado forman parte del tipo enumerado de EventType.

Tipo de control Tipo de suceso soportado Más información
Pulsador AD_BUTTON_CLICK Nombre de botón
Recuadro combinado AD_CONTEXMENU_ITEM_SELECTION Serie nula
Recuadro de lista desplegable AD_CONTEXMENU_ITEM_SELECTION Serie nula
Recuadro de lista AD_CONTEXMENU_ITEM_SELECTION Selección de valor de campo actual
Vista de lista AD_CONTEXMENU_ITEM_SELECTION Selección de valor de campo actual
Recuadro de texto AD_CONTEXMENU_ITEM_SELECTION Selección de valor de campo actual
Recuadro combinado desplegable AD_CONTEXMENU_ITEM_SELECTION Serie nula

Comentarios