Os parâmetros no nível do workspace permitem definir um par chave-valor uma única vez e reutilizá-lo em todas as tarefas de um workspace, evitando a configuração repetitiva do mesmo valor em tarefas individuais. Utilize esse recurso quando várias tarefas compartilharem um valor de configuração comum, como uma string de conexão de banco de dados ou um intervalo de datas compartilhado.
Os parâmetros no nível do workspace diferem dos parâmetros de agendamento no nível da tarefa. Os parâmetros no nível da tarefa aplicam-se apenas a uma tarefa específica, enquanto os parâmetros no nível do workspace aplicam-se a todas as tarefas dentro dele.
Pré-requisitos
Antes de começar, verifique se você possui:
Um workspace. Consulte Gerenciar workspaces
A função Workspace Administrator nesse workspace. Apenas administradores do workspace podem criar parâmetros no nível do workspace. Consulte Adicionar um usuário RAM a um workspace como membro e atribuir funções ao membro
DataWorks Professional Edition ou uma edição superior. Consulte Diferenças entre as edições do DataWorks
Um grupo de recursos exclusivo para agendamento. O grupo de recursos compartilhado não oferece suporte a este recurso.
Se o seu grupo de recursos exclusivo foi criado antes de 1º de janeiro de 2024, entre em contato com o suporte técnico para atualizar a configuração do grupo de recursos antes de usar parâmetros no nível do workspace.
Como funciona
Durante a execução de uma tarefa, o DataWorks substitui cada variável no código da tarefa pelo valor do parâmetro no nível do workspace atribuído. A substituição segue as mesmas regras dos parâmetros de agendamento no nível da tarefa. Consulte Formatos suportados de parâmetros de agendamento.
Em um workspace no modo padrão, é possível definir valores diferentes para o mesmo parâmetro nos ambientes de desenvolvimento e produção. Por exemplo, direcione um parâmetro db.endpoint para um banco de dados de teste no desenvolvimento e para um banco de dados de produção no ambiente produtivo, sem alterar nenhum código de tarefa.
Crie parâmetros no nível do workspace
Faça login no console do DataWorks. Na barra de navegação superior, selecione a região de destino.
No painel de navegação à esquerda, escolha Data Development and O&M > Operation Center. Selecione o workspace desejado na lista suspensa e clique em Go to Operation Center.
No painel de navegação à esquerda da página do Operation Center, escolha Other > Tenant Schedule Setting e clique na aba Workspace-level Parameters.
-
Clique em Create Workspace-level Parameter.
NotaPara criar vários parâmetros simultaneamente, clique em Batch Create Workspace-level Parameters.
-
Na caixa de diálogo Create Workspace-level Parameter, configure os seguintes campos.
NotaOs valores dos parâmetros podem incluir caracteres especiais específicos. Verifique o conjunto de caracteres suportado no console do DataWorks. Um valor de parâmetro no nível do workspace não pode referenciar outro parâmetro no nível do workspace.
Campo
Descrição
Parameter name
Nome exclusivo para o parâmetro. Os nomes têm o prefixo
workspace.por padrão.Owner
Membro do workspace proprietário deste parâmetro. Um administrador do workspace pode atribuir qualquer membro como proprietário. Somente um administrador do workspace pode modificar ou excluir qualquer parâmetro, independentemente da propriedade.
Workspace
Workspace onde o parâmetro está disponível. Todas as tarefas neste workspace podem referenciar o parâmetro. Cada parâmetro tem escopo limitado a um único workspace. A lista suspensa mostra apenas os workspaces onde você é o administrador.
Parameter type
Controla como o valor é armazenado e exibido. Consulte a tabela abaixo.
Parameter value (development environment)
Valor utilizado no ambiente de desenvolvimento. Disponível apenas em workspaces no modo padrão.
Parameter value (production environment)
Valor utilizado no ambiente de produção. Disponível apenas em workspaces no modo padrão.
Parameter types:
Tipo
Comportamento
Exemplo
Constant (Plaintext)
O valor é armazenado e exibido exatamente como inserido, visível para todos os membros do workspace.
cn-hangzhou.oss.aliyuncs.comConstant (Ciphertext)
O valor é mascarado como
******no console. Recomendado para valores de configuração sensíveis, como senhas ou chaves de acesso.Uma senha exibida como
******Variable
O valor é substituído dinamicamente em tempo de execução com base em uma expressão de agendamento.
$[yyyy-mm-dd]resolve para o horário de execução agendada da tarefa;${yyyy-mm-dd}resolve para o timestamp de dados da tarefa. Consulte Formatos suportados de parâmetros de agendamento.$[yyyy-mm-dd] Clique em OK.
Utilize parâmetros no nível do workspace em um nó
No editor de código do nó, defina uma variável usando a sintaxe padrão de parâmetro de agendamento.
Na aba de configuração do nó, clique em Properties no painel direito. Na seção Scheduling Parameter, atribua o parâmetro no nível do workspace a essa variável.
Visualize o valor resolvido do parâmetro para confirmar se atende às suas expectativas.
Salve e envie a configuração do nó usando a barra de ferramentas superior.
Para obter detalhes sobre a sintaxe e o uso de parâmetros de agendamento, consulte Configurar e usar parâmetros de agendamento e Tipos de nó suportados.
Gerencie parâmetros no nível do workspace
Na aba Workspace-level Parameters, visualize, modifique, compare versões e exclua parâmetros no nível do workspace.
Permissões de função:
|
Ação |
Função necessária |
|
Visualizar detalhes do parâmetro, tarefas referenciadas e versões |
Desenvolvimento, O&M ou Administrador do Workspace |
|
Modificar ou excluir parâmetros |
Exclusivamente Administrador do Workspace |
Para adicionar um usuário RAM a um workspace e atribuir funções, consulte Adicionar um usuário RAM a um workspace como membro e atribuir funções ao membro.
Visualizar
Clique em um parâmetro para ver seus detalhes, o workspace ao qual se aplica e as tarefas que o referenciam. Clique em um ID de tarefa para ir diretamente à aba de configuração desse nó.
Modificar
É possível modificar apenas o proprietário, o valor e a descrição de um parâmetro. Cada modificação cria uma nova versão. As alterações entram em vigor em até 10 minutos.
A modificação de um parâmetro no nível do workspace afeta todas as tarefas que o referenciam. Revise as tarefas dependentes antes de fazer alterações.
Comparar versões e reverter
Visualize o histórico completo de versões de um parâmetro, compare duas versões lado a lado e reverta para uma versão anterior, se necessário.
Excluir
A exclusão de um parâmetro no nível do workspace causa falha em todas as tarefas que o referenciam. A exclusão entra em vigor imediatamente. Dentro de 10 minutos após a exclusão, as tarefas que fazem referência ainda podem resolver o valor do parâmetro. Não é possível excluir um parâmetro referenciado por tarefas ativas.