Références des métadonnées Orchestrator

Dans le corps et l'en-tête des tâches HTTP de vos plans, vous pouvez référencer les éléments de métadonnées suivants provenant de l'exécution du plan pour obtenir des informations contextuelles supplémentaires.

Note

Dans une tâche, vous pouvez référencer les métadonnées du plan global et des tâches en amont de la tâche actuelle. Si vous avez déployé une structure de branchement dans votre plan, les tâches d'une branche ne peuvent pas référencer les métadonnées des tâches de l'autre branche. Toutes les tâches peuvent faire référence aux métadonnées de l'exécution globale du plan.

Syntaxe générale

Toutes les références de métadonnées de plan suivent la syntaxe de base suivante :

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

Toutes les références peuvent être saisies avec $ dans Alteryx One Platform. Ces références sont converties en {{$ dans la définition du code. Les doubles accolades forment l'environnement de remplacement des métadonnées.
Astuce
Dans Alteryx One, vous pouvez commencer en tapant $.
Les nœuds de l'arborescence sont séparés par un point ..

Les valeurs de référence contenant des espaces doivent être répertoriées de la manière suivante :

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

Remarques :

Dans Alteryx One, vous pouvez utiliser des guillemets doubles lors de la spécification d'une valeur contenant un espace. Cependant, ces guillemets doubles sont échappés dans la requête réelle. Il est plus sûr et plus cohérent d'utiliser des devis uniques.

Les valeurs contenant des espaces apparaissent généralement lors de la référence aux noms d'affichage des actifs sous-jacents.

Références $plan

Ces références s'appliquent à la définition du plan ou à l'exécution du plan en cours.

Texte à saisir :

$plan.

Référence	Description
nom	Nom du plan exécuté.
duration	Durée pendant laquelle le plan s'est exécuté ou s'est exécuté jusqu'à présent. Astuce Pour renvoyer une forme plus lisible de cette valeur de durée, utilisez la référence suivante : {{$plan.duration\|humanizeDuration}}
id	Identifiant interne du plan.
startTime	Horodatage du début de l'exécution du plan.
URL	URL du plan dans Alteryx One.
runId	Identifiant interne de cette exécution du plan.
utilisateur	Identifiant interne de l'utilisateur qui a lancé cette exécution.
taskCount	Nombre de tâches dans l'exécution du plan.

Références $http

Ces références s'appliquent aux tâches HTTP dans l'exécution du plan.

Saisissez ce qui suit, après quoi vous pouvez voir les codes à deux lettres des tâches HTTP déjà exécutées dans l'exécution du plan actuel :

$http_ax.

Référence	Description
nom	Nom de la tâche HTTP.
statut	État actuel de l'exécution de la tâche.
duration	Durée d'exécution de la tâche jusqu'à présent.
startTime	Horodatage de début de la tâche. Valeur nulle si la tâche n'a pas commencé.
endTime	Horodatage de fin de la tâche. Une valeur nulle si elle n'a pas encore terminé.
statusCode	Code de statut (le cas échéant) renvoyé par le point de terminaison destinataire.
réponse	Informations de réponse. Voir ci-après.

Références de réponse

Ces références s'appliquent à la réponse renvoyée dans le cadre de l'exécution de la tâche.

Saisissez ce qui suit, après quoi vous pouvez voir les codes à deux lettres des tâches HTTP déjà exécutées dans l'exécution du plan actuel :

$http_ax.response.

Référence	Description
body	Corps de la réponse
json	Version au format JSON de la réponse
headers	En-têtes renvoyés avec la réponse

Références $slack

Vous pouvez référencer les métadonnées des tâches Slack dans l'exécution du plan en cours à l'aide des types de référence suivants :

$slack_ax.

Les métadonnées prises en charge sont identiques aux métadonnées des tâches HTTP. Reportez-vous à la section précédente pour plus de détails.

Références $workflow

Ces références s'appliquent aux tâches de workflow dans l'exécution du plan.

Saisissez ce qui suit, après quoi vous pouvez voir les codes à deux lettres des tâches de workflow déjà exécutées dans l'exécution du plan actuel :

$wf.

Référence	Description
nom	Nom de la tâche de workflow.
statut	État actuel de l'exécution de la tâche.
duration	Durée d'exécution de la tâche jusqu'à présent.
startTime	Horodatage de début de la tâche. Valeur nulle si la tâche n'a pas commencé.
endTime	Horodatage de fin de la tâche. Une valeur nulle si elle n'a pas encore terminé.

Références $desktopworkflow

Ces références s'appliquent aux tâches de workflow desktop dans l'exécution du plan.

Saisissez ce qui suit, après quoi vous pouvez voir les codes à deux lettres des tâches de workflow déjà exécutées dans l'exécution du plan actuel :

$designer_desktop.

Référence	Description
nom	Nom de la tâche de flux.
statut	État actuel de l'exécution de la tâche.
duration	Durée d'exécution de la tâche jusqu'à présent.
startTime	Horodatage de début de la tâche. Valeur nulle si la tâche n'a pas commencé.
endTime	Horodatage de fin de la tâche. Une valeur nulle si elle n'a pas encore terminé.
URL de sortie	URL pour accéder à votre sortie dans Designer Desktop.

Références $aidataset

Ces références s'appliquent aux tâches Auto Insights de l'exécution du plan.

Saisissez les informations suivantes, après quoi vous pouvez voir une liste des tâches Auto Insights qui ont déjà été exécutées dans l'exécution du plan en cours :

$ai.

Référence	Description
nom	Nom de la tâche Auto Insights.
statut	État actuel de l'exécution de la tâche.
duration	Durée d'exécution de la tâche jusqu'à présent.
startTime	Horodatage de début de la tâche. Valeur nulle si la tâche n'a pas commencé.
endTime	Horodatage de fin de la tâche. Une valeur nulle si elle n'a pas encore terminé.

Références $flow

Ces références s'appliquent aux tâches de flux dans l'exécution du plan.

Saisissez ce qui suit, après quoi vous pouvez voir les codes à deux lettres des tâches de flux déjà exécutées dans l'exécution du plan actuel :

$flow_ax.

Référence	Description
nom	Nom de la tâche de flux.
statut	État actuel de l'exécution de la tâche.
duration	Durée d'exécution de la tâche jusqu'à présent.
startTime	Horodatage de début de la tâche. Valeur nulle si la tâche n'a pas commencé.
endTime	Horodatage de fin de la tâche. Une valeur nulle si elle n'a pas encore terminé.
jobIds	Identifiants internes des tâches exécutées dans le cadre de ce workflow
jobUrl	URL de la tâche dans Alteryx One.
flowName	Nom du flux sous-jacent à cette tâche de flux
sortie	Métadonnées issues de la sortie de la tâche de flux. Voir ci-après.
params	Les paramètres créés dans le flux peuvent être référencés dans la tâche.

Références de sortie

Ces références s'appliquent aux sorties générées dans les tâches de flux de l'exécution du plan.

Saisissez ce qui suit pour la tâche de flux 7p avec la sortie Mon nom de sortie :

$flow_7p['My Output Name'].

Référence	Description
nom	Nom du flux.
statut	État actuel du flux.
duration	Durée pendant laquelle l'exécution du flux s'est déroulée ou s'est déroulée jusqu'à présent.
startTime	Horodatage de début de l'exécution du flux. Valeur nulle si l'exécution n'a pas commencé.
endTime	Horodatage heure de fin de l'exécution du flux. Une valeur nulle si elle n'a pas encore terminé.
lastUpdate	Horodatage de la dernière modification de la planification.
jobIds	Identifiant(s) interne(s) de la tâche qui a été exécutée ou est en cours d'exécution pour le flux. Peut contenir plusieurs identifiants.
utilisateur	Identifiant interne de l'utilisateur qui a exécuté la tâche.
typeTâche	Type de tâche exécutée. Valeurs : `manual` — exécuté via Alteryx One. `scheduled` - exécuté selon un calendrier défini `api` - exécuté via API
fileSize	Si la sortie génère un ou plusieurs fichiers, cette valeur capture la taille en Ko de la sortie.
environment	Environnement dans lequel la tâche a été exécutée.
columnCount	Nombre de colonnes générées dans la sortie.
rowCount	Nombre de lignes générées dans la sortie.
dataTypeCount	Nombre de types de données Alteryx détectés dans la sortie.
validValuesCount	Nombre de valeurs valides dans la sortie.
mismatchedValuesCount	Nombre de valeurs non correspondantes dans la sortie.
emptyValuesCount	Nombre de valeurs manquantes ou vides dans la sortie.
colonnes	Informations de colonnes provenant de la sortie sélectionnée pour le flux. Voir ci-après.
sources	Informations sur le nom de fichier source et la table des jeux de données importés. Voir ci-après.
publishing actions	Données sur les actions de publication définies pour la sortie. Voir ci-après.

Références de colonnes de sortie

Astuce

Les mesures calculées pour les colonnes de sortie peuvent également apparaître dans les profils de vos données de sortie.

Ces références sont disponibles pour les colonnes de sortie dans la syntaxe suivante :

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

Référence	Description
nom	Nom de la colonne
type	Type de données de la colonne
validValuesCount	Nombre de valeurs valides dans la colonne
mismatchedValuesCount	Nombre de valeurs non correspondantes dans la colonne
emptyValuesCount	Nombre de valeurs vides ou vides dans la colonne
topValues	Liste des valeurs les plus élevées dans la colonne
minimumValue	Valeur la plus basse dans la colonne
lowerQuartileValue	Valeur du 25e percentile dans la colonne
medianValue	Valeur du 50e percentile dans la colonne
upperQuartileValue	Valeur du 75e percentile dans la colonne
maximumValue	Valeur maximale dans la colonne

Références des sources

Ces références s'appliquent aux fichiers ou tables de source de données qui ont été utilisés pour générer la sortie.

Référence	Description
nom	Nom du fichier ou de la table de la source de données.

Références d'actions de publication

Ces références s'appliquent aux actions de publication définies pour la sortie.

Référence	Description
nom	Nom de l'action de publication.
action	Définition de l'action de publication.
emplacement	Emplacement où l'action de publication est publiée.
type	Type d'action de publication.

Exploration des métadonnées

Vous pouvez utiliser les fonctions et techniques suivantes pour explorer davantage les métadonnées renvoyées par l'exécution de votre plan.

Les fonctions de métadonnées

Les fonctions suivantes peuvent être appliquées pour sélectionner des références de métadonnées afin de filtrer davantage les valeurs brutes.

humanizeDuration

Sous forme brute, les références de métadonnées duration renvoient des valeurs ressemblant à ce qui suit :

PT7.523S

Vous pouvez appliquer la fonction HumanizeDuration pour rendre ce qui précède plus lisible :

{{ $plan.duration | humanizeDuration }}

La sortie des éléments ci-dessus appliquée à la première valeur est la suivante :

7.523 seconds

uuid

Vous pouvez générer un identifiant universel unique, qui peut être inclus dans la charge utile d'un message :

{{ uuid() }}

Structure des métadonnées

Certaines références de métadonnées renvoient des objets complexes ou imbriqués, ce qui peut renvoyer des données qui ressemblent à ce qui suit :

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

Dans ce cas, les données imbriquées à l'intérieur de l'objet ne sont pas accessibles par la référence de base. Pour approfondir votre recherche, vous pouvez utiliser l'une des solutions suivantes :

Texte : créez une boucle for à travers les objets renvoyés :

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

JSON : ajoutez la commande | dump à la fin de votre référence. Vous pouvez modifier l'exemple de référence suivant et essayer de l'insérer dans la zone de texte Body :

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

Astuce

Lorsque les données sont renvoyées, vous pouvez utiliser des structures de boucle pour récupérer des valeurs spécifiques à afficher.

Pour plus d'informations, consultez la page https://mozilla.github.io/nunjucks/templating.html#dump.

Références des paramètres

Paramètres de flux

Pour référencer les paramètres de flux dans le cadre d'une tâche de flux, utilisez le pattern suivant :

$plan.params.<myParamName>

Paramètres d'environnement

Vous pouvez référencer les paramètres d'environnement par nom dans les métadonnées de la tâche de plan. Par exemple :

env.MyEnvironmentParameter1

Références supplémentaires

Les informations de référence des métadonnées de plan utilisent le langage de mise en modèle Nunjucks, qui fournit des capacités supplémentaires telles que les boucles, conditions, filtres et fonctions utilitaires.