DataWorks:Usar parâmetros em nível de workspace

Contexto

Um parâmetro de agendamento é uma variável utilizada no agendamento de tarefas do DataWorks. Com base nas regras configuradas, o DataWorks substitui automaticamente o valor do parâmetro a cada execução da tarefa. Para mais informações sobre parâmetros de agendamento, consulte Scheduling parameters.

Pré-requisitos

• Um workspace já deve existir. Para mais informações sobre como crie um workspace, consulte Configure a workspace.

• Você deve possuir a função Workspace Administrator no workspace. Somente membros com a função Workspace Administrator e o proprietário podem crie, modifique, exclua ou reverter parâmetros em nível de workspace, bem como visualize valores de parâmetros secretos. Para mais informações, consulte Add workspace members and gerencie their roles.

• É necessário o DataWorks Professional Edition ou superior. Para mais informações, consulte Purchase or upgrade a DataWorks edition.

Limitações

• Parâmetros em nível de workspace são compatíveis apenas com o uso de um grupo de recursos serverless.

Precauções

• O recurso de texto cifrado (mascaramento) dos parâmetros em nível de workspace oferece mascaramento básico para parâmetros sensíveis. Esse mascaramento se aplica apenas a código e logs dentro do DataWorks e não constitui uma capacidade de segurança global. Por exemplo, ele pode ser contornado quando os dados são acessados por meio de outros motores de computação. Esse recurso não substitui o Key Management service (KMS).

• Para dados altamente sensíveis, como chaves e credenciais, utilize o KMS para gerenciamento centralizado. Tipos de nó do DataWorks como PyODPS, Shell, Notebook e PAI DLC oferecem acesso a serviços cloud por meio de funções. Conceda as permissões necessárias à função de execução para recuperar segredos do KMS dinamicamente durante a execução da tarefa, em vez de armazená-los em código ou em parâmetros em nível de workspace.

Crie um parâmetro em nível de workspace

1. Acesse a página de criação de parâmetros em nível de workspace.

   1. Faça logon no console do DataWorks. Na região desejada, clique em Data Development and O&M > Operation Center no painel de navegação à esquerda. Selecione um workspace na lista suspensa e clique em Go to Operation Center.

   2. No painel de navegação à esquerda do Operation Center, clique em Others > Scheduling Configuration e, em seguida, clique em na aba Workspace-level Parameters.

2. Crie um parâmetro em nível de workspace.

   1. Na aba Workspace-level Parameters, clique em Create Workspace-level Parameter e configure o parâmetro.

      Nota

      Para crie vários parâmetros de uma só vez, clique em Batch Create Workspace-level Parameters.

      Parâmetro	Descrição
      Parameter Name	Especifique um nome personalizado para o parâmetro. O nome deve ter o prefixo workspace. e ser único.
      Owner	Defina o proprietário do parâmetro em nível de workspace. Nota Um Workspace Administrator pode designar qualquer membro do workspace como proprietário do parâmetro. Somente um Workspace Administrator pode modifique ou exclua parâmetros em nível de workspace. Caso precise execute essas operações de gerenciamento, adicione um usuário ao workspace e conceda a função necessária. Para mais informações, consulte Add workspace members and gerencie their roles.
      Applicable Workspace	Selecione o workspace onde este parâmetro será utilizado. Após a configuração, todas as tarefas no workspace poderão referenciar o parâmetro. Nota A lista exibe apenas os workspaces nos quais o usuário atual é Workspace Administrator. Um parâmetro em nível de workspace pode ser usado em apenas um workspace.
      Parameter Type e Parameter Value	Defina o valor de substituição quando uma tarefa é executada. Os seguintes tipos são compatíveis: Constante (texto simples): um valor fixo visível para todos os usuários. Exemplo: 123. Constante (texto cifrado): um valor fixo mascarado (exibido como por padrão). Use este tipo para dados sensíveis. Por exemplo, ao insira 123, o valor será exibido como . Variável: um valor gerado dinamicamente com base em uma variável do sistema. Por exemplo, defina o valor como $[yyyy-mm-dd] para obter o horário de agendamento de uma tarefa, ou como ${yyyy-mm-dd} para obter o timestamp de dados de uma execução. Para mais formatos compatíveis, consulte Supported formats for scheduling parameters. Nota O campo Parameter Value aceita alguns caracteres especiais. Para detalhes, consulte as orientações na interface. Não é possível referenciar outro parâmetro em nível de workspace no valor de um parâmetro. Em um workspace no modo padrão, é possível configure valores diferentes para o mesmo parâmetro nos ambientes de desenvolvimento e produção. Para mais informações sobre modos de workspace, consulte Differences between workspace modes.

   2. Clique em OK para crie o parâmetro.

Usar parâmetros em nível de workspace

Após crie um parâmetro em nível de workspace, referencie-o em qualquer nó dentro do workspace autorizado. O uso é idêntico ao dos parâmetros de agendamento padrão:

1. Defina uma variável no código do nó.

2. Na página de configuração do nó, acesse a seção Scheduling > Scheduling Parameters e atribua o parâmetro em nível de workspace à variável.

Após a configuração, visualize o valor do parâmetro para verifique a saída e ajuste conforme necessário. Para mais informações sobre o uso de parâmetros de agendamento, consulte configure and use scheduling parameters.

No campo de valor de Scheduling Parameters, clique em para abrir um popover, alterne para a aba Workspace Parameters e selecione o parâmetro em nível de workspace desejado (como ${workspace.test}) para concluir a atribuição.

Gerencie parâmetros em nível de workspace

Na página Workspace-level Parameters, você pode execute as seguintes operações:

• Visualize parâmetros: consulte os detalhes do parâmetro, o workspace associado e as tarefas que o referenciam. Você pode acesse uma tarefa pelo ID para execute operações de desenvolvimento.

• Modifique parâmetros:

  • Apenas o proprietário, o valor e a descrição do parâmetro podem ser modificados. Cada modificação gera uma nova versão.

  • Se o parâmetro for referenciado por tarefas, a modificação afetará essas tarefas. Prossiga com cautela.

  • As alterações entram em vigor em até 10 minutos.

• Comparar e reverter versões: visualize o histórico de versões de um parâmetro, compare versões e reverta para uma versão anterior.

• Exclua parâmetros:

  • Não é possível exclua um parâmetro referenciado por outras tarefas.

  • A exclusão de um parâmetro causa falha nas tarefas relacionadas. Prossiga com cautela.

  • Embora a exclusão seja imediata na página Workspace-level Parameters, as tarefas que referenciam o parâmetro ainda poderão recuperar seu valor em tempo de execução por até 10 minutos.