Ao desenvolver código para uma extensão, o DataWorks oferece parâmetros integrados e personalizados para aumentar a eficiência do desenvolvimento. Por exemplo, você pode usar parâmetros para ative uma extensão apenas em workspaces específicos.
Informações básicas
Para desenvolver código com parâmetros de extensão, defina-os nas informações de registro da extensão. Adicione os parâmetros integrados ou personalizados necessários durante o desenvolvimento às informações de registro. Desenvolvedores podem obter a configuração de parâmetros chamando a API GetExtension. Na caixa de diálogo Register Extension, selecione um evento à esquerda, como antes da execução do código, exclusão de arquivo, commit de tabela no ambiente de desenvolvimento, commit de tabela no ambiente de produção ou publicação de arquivo. À direita, preencha o formulário com informações como Associated Event, Applicable Module, Owner, Test Workspace, Extension Details URL, Extension Documentation URL, Extension Parameter Configuration e Description. Na área de texto Extension Parameter Configuration, insira os parâmetros no formato key=value, um por linha.
Adicione cada parâmetro em uma nova linha.
-
Ao adicionar um parâmetro integrado:
Os parâmetros integrados seguem o formato
key=value. Os seguintes parâmetros integrados são suportados:Parâmetro integrado 1: extension.project.disabled — lista de bloqueios de workspace
Parâmetro integrado 2: extension.project.disabled.append — anexar à lista de bloqueios de workspace
Parâmetro integrado 5: extension.fileType.{fileType}.{eventCode}.enabled
-
Parâmetro integrado 6:
extension.manualPass.enabled. Este parâmetro controla a visibilidade do botão Mark as Passed da extensão.extension.manualPass.enabled=trueEssa configuração exibe o botão Mark as Passed na coluna de ações da extensão.
-
Ao adicionar um parâmetro personalizado:
Recomendamos usar o formato
key=value.
Parâmetro integrado 1: extension.project.disabled — lista de bloqueios de workspace
-
Caso de uso:
Use este parâmetro para desativar uma extensão em workspaces específicos.
-
Descrição do parâmetro:
extension.project.disabled=projectId1,projectId2,projectId3projectId é o ID do workspace onde a extensão está desativada. Obtenha esse ID chamando a API ListProjects ou visualizando-o na página de configuração do workspace no console do DataWorks.
NotaVocê pode especifique vários IDs de workspace em um único parâmetro. Separe os IDs com vírgulas (,).
-
Exemplo de código:
extension.project.disabled=projectId1 -
Observação:
Não configure a mesma chave mais de uma vez. Caso contrário, apenas a última configuração terá efeito.
Parâmetro integrado 2: extension.project.disabled.append — Lista de bloqueios de workspace (anexar)
-
Caso de uso:
Use este parâmetro para adicionar workspaces à lista de bloqueios sem sobrescrever a lista definida por
extension.project.disabled. A extensão será desativada nos workspaces especificados por ambos os parâmetros. -
Descrição do parâmetro:
extension.project.disabled.append=projectId1,projectId2,projectId3projectId é o ID do workspace onde a extensão está desativada. Obtenha esse ID chamando a API ListProjects ou visualizando-o na página de configuração do workspace no console do DataWorks.
NotaVocê pode especifique vários IDs de workspace em um único parâmetro. Separe os IDs com vírgulas (,).
-
Exemplo de código:
extension.project.disabled.append=projectId1
Parâmetro integrado 3: extension.project.{eventCode}.disabled — lista de bloqueios de ponto de extensão
-
Caso de uso:
Use este parâmetro para desativar uma extensão em um ponto de extensão específico para determinados workspaces.
-
Descrição do parâmetro:
extension.project.{eventCode}.disabled=projectId1,projectId2,projectId3Onde:
eventCode: Tipo de evento do ponto de extensão a desativar. Para obter uma lista de valores válidos, consulte Apêndice: Detalhes do evento (eventType).
-
projectId: ID do workspace onde a extensão está desativada. Obtenha esse ID chamando a API ListProjects ou visualizando-o na página de configuração do workspace no console do DataWorks.
NotaVocê pode especifique vários IDs de workspace em um único parâmetro. Separe os IDs com vírgulas (,).
-
Exemplo de código:
extension.project.commit-file.disabled=projectId1 extension.project.delete-file.disabled=projectId2,projectId3 -
Observação:
Não configure a mesma chave mais de uma vez. Caso contrário, apenas a última configuração terá efeito.
Parâmetro integrado 4: extension.project.{eventCode}.disabled.append — Lista de bloqueios de ponto de extensão (anexar)
-
Caso de uso:
Use este parâmetro para adicionar workspaces à lista de bloqueios do ponto de extensão sem sobrescrever a lista definida por
extension.project.{eventCode}.disabled. A extensão será desativada no ponto de extensão especificado para os workspaces indicados por ambos os parâmetros. -
Descrição do parâmetro:
extension.project.{eventCode}.disabled.append=projectId1,projectId2,projectId3Onde:
eventCode: Tipo de evento do ponto de extensão a desativar. Para obter uma lista de valores válidos, consulte Apêndice: Detalhes do evento (eventType).
-
projectId: ID do workspace onde a extensão está desativada. Obtenha esse ID chamando a API ListProjects ou visualizando-o na página de configuração do workspace no console do DataWorks.
NotaVocê pode especifique vários IDs de workspace em um único parâmetro. Separe os IDs com vírgulas (,).
-
Exemplo 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:
Use este parâmetro para ative ou desativar uma extensão para tipos específicos de tarefas de nó.
-
Descrição do parâmetro:
extension.fileType.{fileType}.{eventCode}.enabledOnde:
fileType: Código de tipo para uma tarefa de nó específica. Chame a API ListFileType para obter o código de tipo de uma tarefa de nó.
eventCode: Tipo de evento do ponto de extensão a desativar. Para obter uma lista de valores válidos, consulte Apêndice: Detalhes do evento (eventType).
-
Exemplos de código:
Os exemplos a seguir mostram como configure uma extensão para tarefas de nó ODPS SQL (tipo 10) e ODPS MR (tipo 11).
-
Se todos os tipos de arquivo especificados estiverem definidos como
true, os tipos não configurados assumirão o valor padrãofalse.extension.fileType.10.run-file.enabled=true extension.fileType.11.run-file.enabled=trueA extensão permanece ativa para a tarefa de nó ODPS SQL (10) e para a tarefa de nó ODPS MR (11). A execução dessas tarefas aciona a extensão.
Outras tarefas de nó, como sincronização em lote DI, não acionam a extensão.
-
Se todos os tipos de arquivo especificados estiverem definidos como
false, os tipos não configurados assumirão o valor padrãotrue.extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=falseA extensão fica inativa para a tarefa de nó ODPS SQL (10) e para a tarefa de nó ODPS MR (11). A execução dessas tarefas não aciona a extensão.
Todas as outras tarefas de nó, como sincronização em lote DI, acionam a extensão.
-
Em configurações mistas com pelo menos um tipo de arquivo definido como
true, os tipos não configurados assumirão o valor padrãofalse.extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=trueA extensão fica ativa para a tarefa de nó ODPS MR (11). A execução dessa tarefa aciona a extensão.
A extensão fica inativa para a tarefa de nó ODPS SQL (10) e para qualquer outra tarefa de nó, como sincronização em lote DI. Essas tarefas não acionam a extensão.
-