Después de registrar, publicar y habilitar una extensión en DataWorks Open Platform, DataWorks envía un mensaje de evento a la extensión cada vez que se activa un evento de punto de extensión en el espacio de trabajo correspondiente. Con base en la respuesta de la extensión, DataWorks determina si permite la operación. Este tema describe los eventos de punto de extensión compatibles con Data Studio y explica cómo utilizarlos para activar una extensión.
Requisitos previos
Habilite la suscripción de mensajes. Para obtener más información, consulte Enable message subscription.
Desarrolle y despliegue la extensión. Para obtener más información, consulte Develop and deploy an extension using Function Compute.
Contexto
-
Habilite la extensión.
En la página Management Center, consulte Extensions para habilitar o deshabilitar la comprobación de extensiones del espacio de trabajo actual.
-
Eventos de punto de extensión en el desarrollo de datos.
El módulo Data Studio de DataWorks es compatible con eventos de punto de extensión como los eventos previos a la publicación de archivos, al envío de archivos y al envío de tablas. Para consultar la lista detallada de eventos de punto de extensión y los conceptos relacionados, consulte List of supported extension point events.
DataWorks puede enviar notificaciones de mensajes para los eventos de punto de extensión. De este modo, las extensiones validan y responden automáticamente a estos eventos. Para obtener más información sobre el proceso de activación, consulte Supported extension point events.
Límites
Cuando se habilita una extensión, se aplican los siguientes límites a las notificaciones de mensajes y a las respuestas de los eventos activados durante el desarrollo de datos.
-
Una extensión integrada habilitada solo es compatible con nodos ODPS SQL.
Esto significa que, cuando se activa un evento de punto de extensión para un nodo ODPS SQL, el proceso se bloquea. La extensión integrada valida la lógica y devuelve un resultado. Si el evento se activa para un nodo distinto de ODPS SQL, el proceso también se bloquea, pero la extensión integrada no ejecuta ninguna validación y devuelve de inmediato un resultado exitoso.
Los eventos pre-publish table event y pre-submit table event son eventos de punto de extensión que se activan únicamente para tablas de MaxCompute.
En los nodos compuestos que contienen nodos internos, como do-while nodes y for-each nodes, todos los nodos internos deben aprobar la comprobación antes de continuar con la siguiente operación.
Descripción general de las capacidades
Registre un servicio o programa local como extensión de DataWorks para recibir mensajes de eventos de punto de extensión específicos en el módulo Data Studio. Esto le permite implementar lógica personalizada para gestionar estos eventos y devolver los resultados a la plataforma mediante una devolución de llamada a la API UpdateIDEEventResult. Este método habilita el control de procesos en DataWorks. Los puntos de extensión compatibles son los siguientes:
Operaciones de archivo: ejecutar, enviar, publicar y eliminar archivos.
-
Operaciones de tabla: enviar y publicar tablas.
NotaLos eventos de extensión para operaciones de tabla en Data Studio solo se pueden activar para tablas de MaxCompute.
Eventos de punto de extensión compatibles
En Data Studio, utilice extensiones para validar y responder a los siguientes eventos de punto de extensión.
DataStudio - Run File
En el editor de código de DataStudio, haga clic en el botón Run para activar un evento de comprobación previa de la extensión. Aparece una superposición Checking con el mensaje: "The operation will be automatically executed after the check is passed. You can view the results in [Operation Check]." En el panel Operation Check de la izquierda, consulte todos los registros de comprobación (que incluyen tipos como ejecución, envío de archivo y eliminación). Haga clic en un registro para abrir su cuadro de diálogo de detalles, donde se muestra el tipo de comprobación, el estado y los detalles de cada extensión.
DataStudio - Submit File
Al enviar un archivo en DataStudio, el sistema activa una comprobación del evento previo al envío del archivo. Haga clic en el botón Submit de la barra de herramientas para activar la comprobación de la extensión. El editor muestra el aviso "Checking" y la operación se ejecuta automáticamente después de aprobar la comprobación. Consulte el estado de cada elemento de comprobación en el panel Operation Check de la izquierda. La lista muestra "Trigger file pre-commit event check".
DataStudio - Publishing a file
Después de hacer clic en el botón Publish del editor de código para enviar un archivo, el sistema activa una comprobación de extensión. Aparece la interfaz Create Deployment Package, donde el estado del nodo correspondiente en la lista de archivos se muestra como Checking and validating. Haga clic en el estado del nodo para abrir el cuadro de diálogo Operation Check y consultar el tipo de comprobación, el estado y los detalles de validación.
DataStudio - Delete file
En el árbol de archivos de Data Studio, haga clic con el botón derecho en el nodo de destino y seleccione Delete. Esta acción activa un evento de comprobación previa desde el programa de extensión. Aparece una notificación azul en la parte inferior de la página con el texto: "This operation has triggered a check. The operation takes effect automatically after the check passes. Please view the check result in 'Operation Check'." Vaya a la página Operation Check para consultar una lista de registros de comprobación. La lista incluye las columnas Name/Operation Time, Type y Status. Haga clic en un registro específico para ver los detalles de la comprobación de la operación. Los detalles incluyen el tipo de comprobación, como "Pre-delete combination test", y el estado actual, como "Checking". La página también proporciona los enlaces View Details y View Document.
DataStudio: Submit table
Cuando envíe una tabla (como xc_table_prod) a un entorno de desarrollo o de producción, el sistema activa automáticamente una comprobación previa desde un programa de extensión. Aparece un cuadro de diálogo Checking con el mensaje: "The operation runs automatically after the check passes. Please view the results in Operation Check." En la barra lateral Operation Check de la izquierda, filtre y consulte todos los registros de comprobación por tipo y estado. Haga clic en un registro específico para abrir el cuadro de diálogo de detalles de Operation Check. Este cuadro de diálogo muestra la lista de validaciones de programas de extensión activadas por la operación actual (como el tipo de comprobación "Pre-submission check for table - Test program") y sus estados de validación. Admite las operaciones View Details y Re-check.
DataStudio - Publish Table En la página de configuración de la tabla, haga clic en la pestaña Submit to Production Environment para activar una comprobación de extensión. A continuación, el sistema muestra el aviso: "Checking - The operation will be automatically executed after the check passes. Please view the results in 'Operation Check'." Vaya a la página Operation Check para consultar una lista de registros de comprobación. La lista contiene el nombre de la tabla, la hora de envío, el tipo de comprobación y el estado. Haga clic en un registro para ver sus detalles. Los detalles incluyen el tipo de comprobación (como Pre-publish Check for Table) y el estado actual. También puede hacer clic en View Details y View Documentation. Esta operación activa la validación de las extensiones habilitadas para el tipo de evento previo a la publicación de tablas en el espacio de trabajo.
Referencias
Para obtener más información sobre el uso de extensiones, consulte Use extensions.
Data Studio es compatible con eventos de punto de extensión adicionales. Para obtener más información, consulte List of supported extension point events.
Para obtener más información sobre el formato de entidad de mensaje de los eventos de cambio de archivo, consulte File change events (commit, publish, run, delete, and code review).
Para obtener más información sobre el formato de entidad de mensaje de los eventos de cambio de tabla, consulte Table change events (submit table to development environment and publish table to production environment).