Referencias de metadatos de Orchestrator

En el cuerpo y el encabezado de las tareas HTTP de tus planes, puedes hacer referencia a los siguientes elementos de metadatos de la ejecución del plan para obtener información contextual adicional.

Nota

En una tarea, puedes hacer referencia a los metadatos del plan general y de las tareas anteriores a la tarea actual. Si implementaste una estructura de ramificación en tu plan, las tareas de una rama no pueden hacer referencia a los metadatos de las tareas de la otra rama. Todas las tareas pueden hacer referencia a los metadatos de la ejecución del plan general.

Sintaxis general

Todas las referencias de metadatos del plan siguen la siguiente sintaxis básica:

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

Todas las referencias se pueden ingresar con $ in Alteryx One Platform. Estas referencias se convierten en {{$ en la definición del código. Las llaves dobles forman el entorno para la sustitución de metadatos.
Sugerencia
En Alteryx One, puedes comenzar escribiendo $.
Los nodos del árbol se separan con un punto ..

Los valores de referencia que contienen espacios en blanco deben aparecer de la siguiente manera:

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

Notas:

En Alteryx One, puedes utilizar comillas dobles al especificar un valor con espacios en blanco. Sin embargo, estas comillas dobles se escapan en la solicitud real. Es más seguro y coherente usar comillas simples.

Los valores con espacios en blanco suelen aparecer cuando se hace referencia a los nombres para mostrar de los activos subyacentes.

Referencias del $plan

Estas referencias se aplican a la definición del plan o a la ejecución actual del plan.

Texto para ingresar:

$plan.

Referencia	Descripción
nombre	Nombre del plan en ejecución.
duración	Duración del plan hasta el momento. Sugerencia Para obtener una forma más legible de este valor de duración, utiliza la siguiente referencia: {{$plan.duration\|humanizeDuration}}
id	Identificador interno del plan.
startTime	Marca de fecha y hora que indica cuándo comenzó la ejecución del plan.
url	URL del plan en Alteryx One.
runId	Identificador interno de esta ejecución del plan.
usuario	Identificador interno del usuario que inició esta ejecución.
taskCount	Número de tareas en la ejecución del plan.

Referencias de $http

Estas referencias se aplican a las tareas HTTP en la ejecución del plan.

Ingresa lo siguiente; a continuación, podrás ver los códigos de dos letras de las tareas HTTP que ya se han ejecutado durante la ejecución actual del plan:

$http_ax.

Referencia	Descripción
nombre	Nombre de la tarea de HTTP.
condición	Estado actual de la ejecución de la tarea.
duración	Duración de la tarea hasta el momento.
startTime	Marca de fecha y hora que indica cuándo comenzó la tarea. Un valor nulo si la tarea no ha comenzado.
endTime	Marca de fecha y hora que indica cuándo finalizó la tarea. Un valor nulo si aún no ha finalizado.
statusCode	Código de estado (si lo hubiera) devuelto desde el punto de conexión receptor.
respuesta	Información de respuesta. Ver más abajo.

Referencias de respuesta

Estas referencias se aplican a la respuesta devuelta durante la ejecución de la tarea.

Ingresa lo siguiente; a continuación, podrás ver los códigos de dos letras de las tareas HTTP que ya se han ejecutado durante la ejecución actual del plan:

$http_ax.response.

Referencia	Descripción
cuerpo	Cuerpo de la respuesta
json	Versión de la respuesta en formato JSON
encabezados	Encabezados devueltos con la respuesta

Referencias de $slack

Puedes hacer referencia a los metadatos de las tareas de Slack en la ejecución actual del plan mediante los siguientes tipos de referencia:

$slack_ax.

Los metadatos admitidos son idénticos a los metadatos de las tareas HTTP. Consulte la sección anterior para obtener más detalles.

Referencias del $flujo de trabajo

Estas referencias se aplican a las tareas de flujo de trabajo en la ejecución del plan.

Ingresa lo siguiente; a continuación, podrás ver los códigos de dos letras de las tareas de flujo de trabajo que ya se han ejecutado durante la ejecución actual del plan:

$wf.

Referencia	Descripción
nombre	Nombre de la tarea de flujo de trabajo.
condición	Estado actual de la ejecución de la tarea.
duración	Duración de la tarea hasta el momento.
startTime	Marca de fecha y hora que indica cuándo comenzó la tarea. Un valor nulo si la tarea no ha comenzado.
endTime	Marca de fecha y hora que indica cuándo finalizó la tarea. Un valor nulo si aún no ha finalizado.

Referencias de $desktopworkflow

Estas referencias se aplican a las tareas de flujo de trabajo de Desktop en la ejecución del plan.

Ingresa lo siguiente; a continuación, podrás ver los códigos de dos letras de las tareas de flujo de trabajo que ya se han ejecutado durante la ejecución actual del plan:

$designer_desktop.

Referencia	Descripción
nombre	Nombre de la tarea de flujo.
condición	Estado actual de la ejecución de la tarea.
duración	Duración de la tarea hasta el momento.
startTime	Marca de fecha y hora que indica cuándo comenzó la tarea. Un valor nulo si la tarea no ha comenzado.
endTime	Marca de fecha y hora que indica cuándo finalizó la tarea. Un valor nulo si aún no ha finalizado.
URL de salida	URL para acceder a la salida en Designer Desktop.

Referencias de $aidataset

Estas referencias se aplican a las tareas de Auto Insights en la ejecución del plan.

Ingresa lo siguiente; a continuación, podrás ver una lista de las tareas de Auto Insights que ya se han ejecutado durante la ejecución actual del plan:

$ai.

Referencia	Descripción
nombre	Nombre de la tarea de Auto Insights.
condición	Estado actual de la ejecución de la tarea.
duración	Duración de la tarea hasta el momento.
startTime	Marca de fecha y hora que indica cuándo comenzó la tarea. Un valor nulo si la tarea no ha comenzado.
endTime	Marca de fecha y hora que indica cuándo finalizó la tarea. Un valor nulo si aún no ha finalizado.

Referencias de $flujo

Estas referencias se aplican a las tareas de flujo en la ejecución del plan.

Ingresa lo siguiente; a continuación, podrás ver los códigos de dos letras de las tareas de flujo que ya se han ejecutado durante la ejecución actual del plan:

$flow_ax.

Referencia	Descripción
nombre	Nombre de la tarea de flujo.
condición	Estado actual de la ejecución de la tarea.
duración	Duración de la tarea hasta el momento.
startTime	Marca de fecha y hora que indica cuándo comenzó la tarea. Un valor nulo si la tarea no ha comenzado.
endTime	Marca de fecha y hora que indica cuándo finalizó la tarea. Un valor nulo si aún no ha finalizado.
jobIds	Identificadores internos de los trabajos ejecutados como parte de esta tarea de flujo
jobUrl	URL para la tarea en Alteryx One.
flowName	Nombre del flujo subyacente a esta tarea de flujo
salida	Metadatos de la salida de la tarea de flujo. Ver más abajo.
params	Los parámetros creados en el flujo se pueden referenciar en la tarea.

Referencias de salida

Estas referencias se aplican a las salidas generadas en las tareas de flujo de la ejecución del plan.

Ingresa lo siguiente para la tarea de flujo 7p con la salida Mi nombre de salida:

$flow_7p['My Output Name'].

Referencia	Descripción
nombre	Nombre del flujo.
condición	Estado actual del flujo.
duración	Duración de la ejecución del flujo hasta el momento.
startTime	Marca de fecha y hora que indica cuándo comenzó la ejecución del flujo. Valor nulo si la ejecución aún no ha comenzado.
endTime	Marca de fecha y hora que indica cuándo finalizó la ejecución del flujo. Un valor nulo si aún no ha finalizado.
lastUpdate	Marca de fecha y hora que indica la última modificación del flujo.
jobIds	Identificadores internos del trabajo que se ejecutó o se está ejecutando para el flujo. Puede contener varios identificadores.
usuario	Identificador interno del usuario que ejecutó el trabajo.
jobType	El tipo de trabajo ejecutado. Valores: `manual`: ejecutado mediante Alteryx One. `programado`: ejecutado según una programación definida `api:`: ejecutado mediante API
tamaño de archivo	Si la salida genera uno o varios archivos, este valor indica el tamaño en KB de la salida.
entorno	Entorno de ejecución en el que se ejecutó el trabajo.
columnCount	Recuento de columnas generadas en la salida.
rowCount	Recuento de filas generadas en la salida.
dataTypeCount	Recuento de tipos de datos Alteryx detectados en la salida.
validValuesCount	Recuento de valores válidos en la salida.
mismatchedValuesCount	Recuento de valores que no coinciden en la salida.
emptyValuesCount	Recuento de valores faltantes o vacíos en la salida.
columnas	Información de columna de la salida seleccionada para el flujo. Ver más abajo.
fuentes	Nombre del archivo de origen e información de la tabla de los conjuntos de datos importados. Ver más abajo.
acciones de publicación	Datos sobre las acciones de publicación definidas para la salida. Ver más abajo.

Referencias de columnas de salida

Sugerencia

Las métricas calculadas para las columnas de salida también pueden aparecer en los perfiles de los datos de salida.

Estas referencias están disponibles para las columnas de salida con la siguiente sintaxis:

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

Referencia	Descripción
nombre	Nombre de la columna
type	Tipo de datos de la columna
validValuesCount	Recuento de valores válidos en la columna
mismatchedValuesCount	Recuento de valores no coincidentes en la columna
emptyValuesCount	Recuento de valores vacíos en la columna
topValues	Lista de los valores más altos en la columna
minimumValue	Valor más bajo en la columna
lowerQuartileValue	Valor del percentil 25 en la columna
medianValue	Valor del percentil 50 en la columna
upperQuartileValue	Valor del percentil 75 en la columna
maximumValue	Valor máximo en la columna

Referencias de fuente

Estas referencias se aplican a los archivos o tablas de fuente de datos que se utilizaron para generar la salida.

Referencia	Descripción
nombre	Nombre del archivo o tabla de fuente de datos.

Referencias de acciones de publicación

Estas referencias se aplican a las acciones de publicación definidas para la salida.

Referencia	Descripción
nombre	Nombre de la acción de publicación.
acción	Definición de la acción de publicación.
ubicación	Ubicación donde se publica la acción de publicación.
type	Tipo de acción de publicación.

Explorar metadatos

Puedes usar las siguientes funciones y técnicas para explorar con más detalle los metadatos devueltos por la ejecución de tu plan.

Funciones de metadatos

Las siguientes funciones se pueden aplicar a determinadas referencias de metadatos para filtrar aún más los valores sin procesar.

humanizeDuration

En forma sin procesar, las referencias de metadatos de duración dan lugar a valores similares a los siguientes:

PT7.523S

Puedes aplicar la función HumanizeDuration para convertir lo anterior en un formato más legible:

{{ $plan.duration | humanizeDuration }}

El resultado de lo anterior aplicado al primer valor es el siguiente:

7.523 seconds

uuid

Puedes generar un identificador único universal, que se puede entregar como parte de la carga de un mensaje:

{{ uuid() }}

Estructura de metadatos

Algunas referencias de metadatos devuelven objetos complejos o anidados, lo que puede dar lugar a datos con un aspecto similar al siguiente:

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

En estos casos, los datos anidados dentro del objeto no se exponen mediante la referencia básica. Para profundizar, puedes utilizar cualquiera de las siguientes soluciones:

Texto: Crea un bucle for a través de los objetos devueltos.

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

JSON: Agrega el comando | dump al final de tu referencia. Puedes modificar el siguiente ejemplo de referencia e intentar insertarlo en el cuadro de texto Cuerpo:

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

Sugerencia

Cuando se devuelvan los datos, puedes usar estructuras de bucle para recuperar valores específicos para su visualización.

Para obtener más información, consulta https://mozilla.github.io/nunjucks/templating.html#dump.

Referencias de parámetros

Parámetros de flujo

Para hacer referencia a parámetros de flujo como parte de una tarea de flujo, usa el siguiente patrón:

$plan.params.<myParamName>

Parámetros del entorno

Puedes hacer referencia a parámetros del entorno por nombre en los metadatos de la tarea de tu plan. Por ejemplo:

env.MyEnvironmentParameter1

Referencias adicionales

La información de referencia de metadatos del plan utiliza el lenguaje de plantillas Nunjucks, que proporciona capacidades adicionales como bucles, condiciones, filtros y funciones auxiliares.