Referências de metadados do Orchestrator

No corpo e no cabeçalho das tarefas HTTP em seus planos, você pode consultar os seguintes elementos de metadados da execução do plano para obter informações contextuais adicionais.

Nota

Em uma tarefa, você pode referenciar metadados para o plano geral e para tarefas que estão em etapas anteriores à tarefa atual. Se você implantou uma estrutura de ramificação em seu plano, as tarefas em uma ramificação não podem referenciar os metadados para tarefas na outra ramificação. Todas as tarefas podem referenciar os metadados para a execução geral do plano.

Sintaxe geral

Todas as referências de metadados do plano seguem essa sintaxe básica:

{{$plan.path.to.reference}}

Todas as referências podem ser inseridas com $ no Alteryx One Platform. Essas referências são transformadas em {{$ na definição do código. As chaves duplas formam o ambiente para substituição de metadados.
Dica
No Alteryx One, você pode começar digitando $.
Os nós na árvore são separados por um ponto ..

Os valores de referência que contêm espaços em branco devem ser listados da seguinte maneira:

{{$plan.path['path with white space in it'].rest.of.path}}

Observações:

No Alteryx One, você pode usar aspas duplas ao especificar um valor de espaço em branco. No entanto, essas aspas duplas somem na solicitação real. É mais seguro e consistente usar aspas simples.

Os valores de espaço em branco geralmente aparecem ao referenciar os valores de nome de exibição para ativos subjacentes.

Referências $plan

Essas referências se aplicam à definição do plano ou à execução atual do plano.

Texto a ser inserido:

$plan.

Referência	Descrição
nome	Nome do plano que está sendo executado.
duração	Período de tempo em que o plano foi executado ou que está sendo executado até o momento. Dica Para retornar uma forma mais legível desse valor de duração, use a seguinte referência: {{$plan.duration\|humanizeDuration}}
ID	Identificador interno para o plano.
startTime	Carimbo de data/hora de quando a execução do plano começou.
url	URL para o plano no Alteryx One.
runId	Identificador interno para esta execução do plano.
usuário	Identificador interno do usuário que iniciou esta execução.
taskCount	Contagem de tarefas na execução do plano.

Referências $http

Essas referências se aplicam a tarefas HTTP na execução do plano.

Insira o seguinte, após o qual você pode ver os códigos de duas letras para as tarefas HTTP que já foram executadas na execução atual do plano:

$http_ax.

Referência	Descrição
nome	Nome da tarefa HTTP.
status	Status atual da execução da tarefa.
duração	Período de tempo em que a tarefa foi executada ou que está sendo executada até o momento.
startTime	Carimbo de data/hora de quando a tarefa começou. Um valor nulo se a tarefa não tiver começado.
endTime	Carimbo de data/hora de quando a tarefa terminou. Um valor nulo se ainda não tiver terminado.
statusCode	Código de status (se houver) retornado do ponto de extremidade de recebimento.
resposta	Informações da resposta. Veja abaixo.

Referências da resposta

Essas referências se aplicam à resposta retornada como parte da execução da tarefa.

Insira o seguinte, após o qual você pode ver os códigos de duas letras para as tarefas HTTP que já foram executadas na execução atual do plano:

$http_ax.response.

Referência	Descrição
corpo	Corpo da resposta
json	Versão formatada em JSON da resposta
cabeçalhos	Cabeçalhos retornados com a resposta

Referências $slack

Você pode referenciar metadados de tarefas do Slack na execução atual do plano usando os seguintes tipos de referência:

$slack_ax.

Os metadados compatíveis são idênticos aos metadados de tarefas HTTP. Consulte a seção anterior para obter detalhes.

Referências $workflow

Essas referências se aplicam a tarefas do fluxo de trabalho na execução do plano.

Insira o seguinte, após o qual você pode ver os códigos de duas letras para as tarefas do fluxo de trabalho que já foram executadas na execução atual do plano:

$wf.

Referência	Descrição
nome	Nome da tarefa do fluxo de trabalho.
status	Status atual da execução da tarefa.
duração	Período de tempo em que a tarefa foi executada ou que está sendo executada até o momento.
startTime	Carimbo de data/hora de quando a tarefa começou. Um valor nulo se a tarefa não tiver começado.
endTime	Carimbo de data/hora de quando a tarefa terminou. Um valor nulo se ainda não tiver terminado.

Referências $desktopworkflow

Essas referências se aplicam a tarefas do fluxo de trabalho do Desktop na execução do plano.

Insira o seguinte, após o qual você pode ver os códigos de duas letras para as tarefas do fluxo de trabalho que já foram executadas na execução atual do plano:

$designer_desktop.

Referência	Descrição
nome	Nome da tarefa de fluxo.
status	Status atual da execução da tarefa.
duração	Período de tempo em que a tarefa foi executada ou que está sendo executada até o momento.
startTime	Carimbo de data/hora de quando a tarefa começou. Um valor nulo se a tarefa não tiver começado.
endTime	Carimbo de data/hora de quando a tarefa terminou. Um valor nulo se ainda não tiver terminado.
URL de saída	URL para acessar sua saída no Designer Desktop.

Referências $aidataset

Essas referências se aplicam a tarefas do Auto Insights na execução do plano.

Insira o seguinte, após o qual você pode ver uma lista das tarefas do Auto Insights que já foram executadas na execução atual do plano:

$ai.

Referência	Descrição
nome	Nome da tarefa do Auto Insights.
status	Status atual da execução da tarefa.
duração	Período de tempo em que a tarefa foi executada ou que está sendo executada até o momento.
startTime	Carimbo de data/hora de quando a tarefa começou. Um valor nulo se a tarefa não tiver começado.
endTime	Carimbo de data/hora de quando a tarefa terminou. Um valor nulo se ainda não tiver terminado.

Referências $flow

Essas referências se aplicam a tarefas de fluxo na execução do plano.

Insira o seguinte, após o qual você pode ver os códigos de duas letras para as tarefas de fluxo que já foram executadas na execução atual do plano:

$flow_ax.

Referência	Descrição
nome	Nome da tarefa de fluxo.
status	Status atual da execução da tarefa.
duração	Período de tempo em que a tarefa foi executada ou que está sendo executada até o momento.
startTime	Carimbo de data/hora de quando a tarefa começou. Um valor nulo se a tarefa não tiver começado.
endTime	Carimbo de data/hora de quando a tarefa terminou. Um valor nulo se ainda não tiver terminado.
jobIds	Identificadores internos para os trabalhos que foram executados como parte desta tarefa de fluxo
jobUrl	URL para o trabalho no Alteryx One.
flowName	Nome do fluxo subjacente a esta tarefa de fluxo
saída	Metadados da saída da tarefa de fluxo. Veja abaixo.
params	Parâmetros criados no fluxo podem ser referenciados na tarefa.

Referências de saída

Essas referências se aplicam às saídas geradas nas tarefas de fluxo da execução do plano.

Insira o seguinte para a tarefa de fluxo 7p com a saída Nome da minha saída:

$flow_7p['My Output Name'].

Referência	Descrição
nome	Nome do fluxo.
status	Status atual do fluxo.
duração	Período de tempo em que a execução do fluxo foi executada ou que está sendo executada até o momento.
startTime	Carimbo de data/hora de quando a execução do fluxo começou. Um valor nulo se a execução não tiver começado.
endTime	Carimbo de data/hora de quando a execução do fluxo terminou. Um valor nulo se ainda não tiver terminado.
lastUpdate	Carimbo de data/hora de quando o fluxo foi modificado pela última vez.
jobIds	Identificadores internos para o trabalho que foi executado ou que está em execução para o fluxo. Pode conter múltiplos identificadores.
usuário	Identificador interno do usuário que executou o trabalho.
jobType	O tipo de trabalho que foi executado. Valores: `manual` – executado através do Alteryx One. `agendado` – executado de acordo com um agendamento definido `api` – executado por meio da API
fileSize	Se a saída gerar um arquivo ou arquivos, esse valor captura o tamanho em KB da saída.
ambiente	Ambiente de execução onde o trabalho foi executado.
columnCount	Contagem de colunas geradas na saída.
rowCount	Contagem de linhas geradas na saída.
dataTypeCount	Contagem de tipos de dados de Alteryx detectados na saída.
validValuesCount	Contagem de valores válidos na saída.
mismatchedValuesCount	Contagem de valores incompatíveis na saída.
emptyValuesCount	Contagem de valores ausentes ou vazios na saída.
colunas	Informações de coluna da saída selecionada para o fluxo. Veja abaixo.
origens	Nome de arquivo de origem e informações da tabela dos conjuntos de dados importados. Veja abaixo.
ações de publicação	Dados sobre as ações de publicação definidas para a saída. Veja abaixo.

Referencias de coluna de saída

Dica

As métricas calculadas para colunas de saída também podem aparecer em perfis dos seus dados de saída.

Estas referências estão disponíveis para colunas de saída na seguinte sintaxe:

$flow_7p['My Output Name'].output.

Referência	Descrição
nome	Nome da coluna
tipo	Tipo de dados da coluna
validValuesCount	Contagem de valores válidos na coluna
mismatchedValuesCount	Contagem de valores incompatíveis na coluna
emptyValuesCount	Contagem de valores vazios na coluna
topValues	Lista dos valores superiores na coluna
minimumValue	Menor valor na coluna
lowerQuartileValue	Valor do percentil 25 na coluna
medianValue	Valor do percentil 50 na coluna
upperQuartileValue	Valor do percentil 75 na coluna
maximumValue	Valor máximo na coluna

Referências de fontes

Essas referências se aplicam aos arquivos ou tabelas de fonte de dados que foram usados para gerar a saída.

Referência	Descrição
nome	Nome do arquivo ou tabela da fonte de dados.

Referências de ações de publicação

Essas referências se aplicam às ações de publicação definidas para a saída.

Referência	Descrição
nome	Nome da ação de publicação.
action	Definição da ação de publicação.
localização	Local onde a ação de publicação é publicada.
tipo	Tipo de ação de publicação.

Explorar os metadados

Você pode usar as seguintes funções e técnicas para explorar ainda mais os metadados retornados da execução do plano.

Funções dos metadados

As funções a seguir podem ser aplicadas para selecionar referências de metadados para filtrar ainda mais os valores brutos.

humanizeDuration

No formato bruto, as referências de metadados de duração retornam valores similares ao seguinte:

PT7.523S

Você pode aplicar a função HumanizeDuration para renderizar as informações acima em um formato mais legível:

{{ $plan.duration | humanizeDuration }}

A saída da função acima aplicada ao primeiro valor é a seguinte:

7.523 seconds

uuid

Você pode gerar um identificador universalmente exclusivo, que pode ser entregue como parte de um payload de mensagem:

{{ uuid() }}

Estrutura dos metadados

Algumas referências de metadados retornam objetos complexos ou aninhados, que podem retornar dados semelhantes aos seguintes:

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Nesses casos, os dados aninhados dentro do objeto não são expostos pela referência básica. Para explorar mais, você pode usar uma das seguintes soluções:

Texto: crie um loop através dos objetos retornados:

{% for value in $flow_6f.Job.columns.MyColumnName.topValues %}[{{value.key}}, {{value.count}}] {% endfor %}

JSON: adicione o comando | dump ao final da referência. Você pode modificar a seguinte referência de exemplo e tentar inserir na caixa de texto "Corpo":

{{$flow_6f.Job.columns.MyColumnName.topValues | dump | replace('"', '\"')}}

Dica

Quando os dados são retornados, você pode usar estruturas de loop para recuperar valores específicos para exibição.

Para obter mais informações, acesse https://mozilla.github.io/nunjucks/templating.html#dump.

Referências de parâmetro

Parâmetros de fluxo

Para referenciar parâmetros de fluxo como parte de uma tarefa de fluxo, use o seguinte padrão:

$plan.params.<myParamName>

Parâmetros do ambiente

Você pode referenciar aos parâmetros do ambiente pelo nome nos metadados da tarefa do seu plano. Por exemplo:

env.MyEnvironmentParameter1

Referências adicionais

As informações de referência de metadados do plano usam a linguagem de modelos do Nunjucks, que fornece capacidades adicionais, como loops, condições, filtros e funções auxiliares.