Al desarrollar código para una extensión, DataWorks ofrece parámetros integrados y personalizados que mejoran la eficiencia del desarrollo. Por ejemplo, puede utilizar estos parámetros para activar una extensión únicamente en espacios de trabajo específicos.
Contexto
Para desarrollar código mediante parámetros de extensión, debe definir dichos parámetros en la información de registro de la extensión. Agregue a esta información los parámetros integrados o personalizados que pueda necesitar durante el proceso de desarrollo. Los desarrolladores de extensiones pueden obtener la configuración de parámetros llamando a la API GetExtension. En el cuadro de diálogo Register Extension, seleccione un evento en el lado izquierdo, como un evento previo a la ejecución de código, a la eliminación de archivos, al envío de tablas al entorno de desarrollo o de producción, o a la publicación de archivos. En el lado derecho, complete el formulario con información como Associated Event, Applicable Module, Owner, Test Workspace, Extension Details URL, Extension Documentation URL, Extension Parameter Configuration y Description. En el área de texto Extension Parameter Configuration, introduzca los parámetros con el formato key=value, uno por línea.
Agregue cada parámetro en una nueva línea.
-
Al agregar un parámetro integrado:
Los parámetros integrados siguen el formato
key=value. Se admiten los siguientes parámetros integrados:Built-in parameter 1: extension.project.disabled — workspace blocklist
Built-in parameter 2: extension.project.disabled.append — append to workspace blocklist
Built-in parameter 3: extension.project.{eventCode}.disabled — extension point blocklist
Built-in parameter 5: extension.fileType.{fileType}.{eventCode}.enabled
-
Parámetro integrado 6:
extension.manualPass.enabled. Este parámetro controla la visibilidad del botón Mark as Passed de la extensión.extension.manualPass.enabled=trueEsta configuración muestra el botón Mark as Passed en la columna de acciones de la extensión.
-
Al agregar un parámetro personalizado:
Se recomienda utilizar el formato
key=value.
Parámetro integrado 1: extension.project.disabled — lista de bloqueados de espacios de trabajo
-
Caso de uso:
Utilice este parámetro para deshabilitar una extensión en espacios de trabajo específicos.
-
Descripción del parámetro:
extension.project.disabled=projectId1,projectId2,projectId3projectId es el ID del espacio de trabajo donde se deshabilita la extensión. Puede obtener este ID llamando a la API ListProjects o consultándolo en la página de configuración del espacio de trabajo en la consola de DataWorks.
NotaPuede especificar varios ID de espacios de trabajo en un solo parámetro. Separe los ID con comas (,).
-
Ejemplo de código:
extension.project.disabled=projectId1 -
Nota:
No configure la misma clave más de una vez. Si lo hace, solo surtirá efecto la última configuración.
Parámetro integrado 2: extension.project.disabled.append — Lista de bloqueados de espacios de trabajo (agregar)
-
Caso de uso:
Utilice este parámetro para agregar espacios de trabajo a la lista de bloqueados sin sobrescribir la lista definida por
extension.project.disabled. La extensión se deshabilitará en los espacios de trabajo indicados por ambos parámetros. -
Descripción del parámetro:
extension.project.disabled.append=projectId1,projectId2,projectId3projectId es el ID del espacio de trabajo donde se deshabilita la extensión. Puede obtener este ID llamando a la API ListProjects o consultándolo en la página de configuración del espacio de trabajo en la consola de DataWorks.
NotaPuede especificar varios ID de espacios de trabajo en un solo parámetro. Separe los ID con comas (,).
-
Ejemplo de código:
extension.project.disabled.append=projectId1
Parámetro integrado 3: extension.project.{eventCode}.disabled — lista de bloqueados de puntos de extensión
-
Caso de uso:
Utilice este parámetro para deshabilitar una extensión en un punto de extensión específico dentro de ciertos espacios de trabajo.
-
Descripción del parámetro:
extension.project.{eventCode}.disabled=projectId1,projectId2,projectId3Donde:
eventCode: El tipo de evento del punto de extensión que se desea deshabilitar. Para consultar la lista de valores válidos, consulte Appendix: Event details (eventType).
-
projectId: El ID del espacio de trabajo donde se deshabilita la extensión. Puede obtener este ID llamando a la API ListProjects o consultándolo en la página de configuración del espacio de trabajo en la consola de DataWorks.
NotaPuede especificar varios ID de espacios de trabajo en un solo parámetro. Separe los ID con comas (,).
-
Ejemplo de código:
extension.project.commit-file.disabled=projectId1 extension.project.delete-file.disabled=projectId2,projectId3 -
Nota:
No configure la misma clave más de una vez. Si lo hace, solo surtirá efecto la última configuración.
Parámetro integrado 4: extension.project.{eventCode}.disabled.append — Lista de bloqueados de puntos de extensión (agregar)
-
Caso de uso:
Utilice este parámetro para agregar espacios de trabajo a la lista de bloqueados del punto de extensión sin sobrescribir la lista definida por
extension.project.{eventCode}.disabled. La extensión se deshabilitará en el punto de extensión especificado para los espacios de trabajo indicados por ambos parámetros. -
Descripción del parámetro:
extension.project.{eventCode}.disabled.append=projectId1,projectId2,projectId3Donde:
eventCode: El tipo de evento del punto de extensión que se desea deshabilitar. Para consultar la lista de valores válidos, consulte Appendix: Event details (eventType).
-
projectId: El ID del espacio de trabajo donde se deshabilita la extensión. Puede obtener este ID llamando a la API ListProjects o consultándolo en la página de configuración del espacio de trabajo en la consola de DataWorks.
NotaPuede especificar varios ID de espacios de trabajo en un solo parámetro. Separe los ID con comas (,).
-
Ejemplo de código:
extension.project.commit-file.disabled.append=projectId1 extension.project.delete-file.disabled.append=projectId2,projectId3
Parámetro integrado 5: extension.fileType.{fileType}.{eventCode}.enabled
-
Caso de uso:
Utilice este parámetro para habilitar o deshabilitar una extensión según tipos específicos de tareas de nodo.
-
Descripción del parámetro:
extension.fileType.{fileType}.{eventCode}.enabledDonde:
fileType: El código de tipo correspondiente a una tarea de nodo específica. Puede llamar a la API ListFileType para obtener dicho código.
eventCode: El tipo de evento del punto de extensión que se desea deshabilitar. Para consultar la lista de valores válidos, consulte Appendix: Event details (eventType).
-
Ejemplos de código:
Los siguientes ejemplos muestran cómo configurar una extensión para tareas de nodo ODPS SQL (tipo 10) y ODPS MR (tipo 11).
-
Si todos los tipos de archivo especificados se establecen en
true, los tipos no configurados tomaránfalsecomo valor predeterminado.extension.fileType.10.run-file.enabled=true extension.fileType.11.run-file.enabled=trueLa extensión estará activa para las tareas de nodo ODPS SQL (10) y ODPS MR (11). Al ejecutarse estas tareas, activarán la extensión.
Otras tareas de nodo, como una tarea de nodo DI de sincronización por lotes, no activarán la extensión.
-
Si todos los tipos de archivo especificados se establecen en
false, los tipos no configurados tomarántruecomo valor predeterminado.extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=falseLa extensión no estará activa para la tarea de nodo ODPS SQL (10) ni para la ODPS MR (11). Al ejecutarse, estas tareas no activarán la extensión.
Todas las demás tareas de nodo, como una tarea de nodo DI de sincronización por lotes, activarán la extensión.
-
En una configuración mixta donde como mínimo un tipo de archivo se establece en
true, los tipos no configurados tomaránfalsecomo valor predeterminado.extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=trueLa extensión estará activa para la tarea de nodo ODPS MR (11). Al ejecutarse esta tarea, activará la extensión.
La extensión no estará activa para la tarea de nodo ODPS SQL (10) ni para ninguna otra tarea, como una de nodo DI de sincronización por lotes. Estas tareas no activarán la extensión.
-