Orchestrator-Metadatenreferenzen

Im Text und Header von HTTP-Aufgaben in Ihren Plänen können Sie auf die folgenden Metadatenelemente aus der Planausführung verweisen, um zusätzliche Kontextinformationen bereitzustellen.

Anmerkung

In einer Aufgabe können Sie auf Metadaten für den gesamten Plan und für Aufgaben verweisen, die der aktuellen Aufgabe vorgelagert sind. Wenn Ihr Plan eine Verzweigungsstruktur umfasst, können Aufgaben in einer Verzweigung nicht auf die Metadaten für Aufgaben in der anderen Verzweigung verweisen. Alle Aufgaben können auf die Metadaten für die gesamte Planausführung verweisen.

Allgemeine Syntax

Alle Planmetadatenreferenzen folgen der folgenden grundlegenden Syntax:

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

Alle Referenzen können mit $ in Alteryx One Platform eingegeben werden. Diese Referenzen werden in der Code-Definition in {{€ umgewandelt. Die doppelten geschweiften Klammern bilden die Umgebung für das Ersetzen von Metadaten.
Tipp
In Alteryx One können Sie beginnen, indem Sie $ eingeben.
Knoten werden im Strukturbaum durch einen Punkt (.) voneinander getrennt.

Referenzwerte, die Leerzeichen enthalten, müssen wie folgt aufgelistet werden:

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

Anmerkungen:

In Alteryx One können Sie doppelte Anführungszeichen verwenden, wenn Sie einen Leerzeichenwert angeben. Diese doppelten Anführungszeichen werden jedoch in der tatsächlichen Anfrage mit Escape-Zeichen versehen. Wir empfehlen einfache Anführungszeichen, sie sind sicherer und konsistenter.

Beim Referenzieren von Werten des Anzeigenamens für zugrundeliegende Assets werden üblicherweise Leerzeichen angezeigt.

$plan-Referenzen

Diese Referenzen gelten für die Plandefinition oder die aktuelle Planausführung.

Text zum Eingeben:

$plan.

Referenz	Beschreibung
Name	Name des Plans, der ausgeführt wird.
duration	Wie lange der Plan insgesamt oder bisher ausgeführt wurde. Tipp Verwenden Sie die folgende Referenz, um eine besser lesbare Form dieses Werts für die Dauer zurückzugeben: {{$plan.duration\|humanizeDuration}}
id	Die interne Kennung für den Plan.
startTime	Der Zeitstempel für den Beginn der Planausführung.
url	Die URL für den Plan in Alteryx One.
runId	Die interne Kennung für diese Ausführung des Plans.
Benutzer	Interne ID des Benutzers bzw. der Benutzerin, der/die diese Ausführung gestartet hat.
taskCount	Die Anzahl der Aufgaben in der Planausführung.

$http-Referenzen

Diese Referenzen gelten für HTTP-Aufgaben in der Planausführung.

Geben Sie Folgendes an, um die zweistelligen Codes für HTTP-Aufgaben anzuzeigen, die in der aktuellen Planausführung bereits ausgeführt wurden:

$http_ax.

Referenz	Beschreibung
Name	Name der HTTP-Aufgabe.
Status	Aktueller Status der Aufgabenausführung.
duration	Wie lange die Aufgabe insgesamt oder bisher ausgeführt wurde.
startTime	Zeitstempel für den Beginn der Aufgabe. Ein Nullwert, wenn die Aufgabe noch nicht begonnen hat.
endTime	Zeitstempel für das Ende der Aufgabe. Ein Nullwert, wenn die Aufgabe noch nicht beendet wurde.
statusCode	Statuscode (falls vorhanden), der vom Empfangsendpunkt zurückgegeben wird.
Antwort	Die Antwortinformationen. Siehe unten.

Antwortreferenzen

Diese Referenzen gelten für die Antwort, die im Rahmen der Aufgabenausführung zurückgegeben wird.

Geben Sie Folgendes an, um die zweistelligen Codes für HTTP-Aufgaben anzuzeigen, die in der aktuellen Planausführung bereits ausgeführt wurden:

$http_ax.response.

Referenz	Beschreibung
body	Text der Antwort
json	JSON-formatierte Version der Antwort
headers	Header, die mit der Antwort zurückgegeben wurden

$slack-Referenzen

Sie können auf Metadaten aus Slack-Aufgaben in der aktuellen Planausführung mit den folgenden Referenztypen verweisen:

$slack_ax.

Unterstützte Metadaten sind identisch mit den Metadaten für HTTP-Aufgaben. Weitere Informationen finden Sie im vorherigen Abschnitt.

$workflow-Referenzen

Diese Referenzen gelten für Workflow-Aufgaben in der Planausführung.

Geben Sie Folgendes an, um die zweistelligen Codes für Workflow-Aufgaben anzuzeigen, die in der aktuellen Planausführung bereits ausgeführt wurden:

$wf.

Referenz	Beschreibung
Name	Name der Workflow-Aufgabe.
Status	Aktueller Status der Aufgabenausführung.
duration	Wie lange die Aufgabe insgesamt oder bisher ausgeführt wurde.
startTime	Zeitstempel für den Beginn der Aufgabe. Ein Nullwert, wenn die Aufgabe noch nicht begonnen hat.
endTime	Zeitstempel für das Ende der Aufgabe. Ein Nullwert, wenn die Aufgabe noch nicht beendet wurde.

$desktopworkflow-Referenzen

Diese Referenzen gelten für Desktop-Workflow-Aufgaben in der Planausführung.

Geben Sie Folgendes an, um die zweistelligen Codes für Workflow-Aufgaben anzuzeigen, die in der aktuellen Planausführung bereits ausgeführt wurden:

$designer_desktop.

Referenz	Beschreibung
Name	Der Name der Flow-Aufgabe.
Status	Aktueller Status der Aufgabenausführung.
duration	Wie lange die Aufgabe insgesamt oder bisher ausgeführt wurde.
startTime	Zeitstempel für den Beginn der Aufgabe. Ein Nullwert, wenn die Aufgabe noch nicht begonnen hat.
endTime	Zeitstempel für das Ende der Aufgabe. Ein Nullwert, wenn die Aufgabe noch nicht beendet wurde.
Ausgabe-URL	Die URL für den Zugriff auf Ihre Ausgabe in Designer Desktop.

$aidataset-Referenzen

Diese Referenzen gelten für Auto Insights-Aufgaben in der Planausführung.

Geben Sie Folgendes ein, woraufhin Sie eine Liste der Auto Insights-Aufgaben sehen können, die bereits in der aktuellen Planausführung ausgeführt wurden:

$ai.

Referenz	Beschreibung
Name	Name der Auto Insights-Aufgabe.
Status	Aktueller Status der Aufgabenausführung.
duration	Wie lange die Aufgabe insgesamt oder bisher ausgeführt wurde.
startTime	Zeitstempel für den Beginn der Aufgabe. Ein Nullwert, wenn die Aufgabe noch nicht begonnen hat.
endTime	Zeitstempel für das Ende der Aufgabe. Ein Nullwert, wenn die Aufgabe noch nicht beendet wurde.

$flow-Referenzen

Diese Referenzen gelten für Flow-Aufgaben in der Planausführung.

Geben Sie Folgendes an, um die zweistelligen Codes für Flow-Aufgaben anzuzeigen, die in der aktuellen Planausführung bereits ausgeführt wurden:

$flow_ax.

Referenz	Beschreibung
Name	Der Name der Flow-Aufgabe.
Status	Aktueller Status der Aufgabenausführung.
duration	Wie lange die Aufgabe insgesamt oder bisher ausgeführt wurde.
startTime	Zeitstempel für den Beginn der Aufgabe. Ein Nullwert, wenn die Aufgabe noch nicht begonnen hat.
endTime	Zeitstempel für das Ende der Aufgabe. Ein Nullwert, wenn die Aufgabe noch nicht beendet wurde.
jobIds	Interne Kennungen für die Aufträge, die im Rahmen dieser Flow-Aufgabe ausgeführt wurden.
jobUrl	Die URL für den Auftrag n Alteryx One.
flowName	Name des Flows, der dieser Flow-Aufgabe zugrunde liegt
Ausgabe	Metadaten aus der Ausgabe der Flow-Aufgabe. Siehe unten.
params	Im Flow erstellte Parameter können in der Aufgabe referenziert werden.

Ausgabereferenzen

Diese Referenzen gelten für die Ausgaben, die in den Flow-Aufgaben der Planausführung generiert werden.

Geben Sie Folgendes für die Flow-Aufgabe 7p mit der Ausgabe Mein Ausgabename an

$flow_7p['My Output Name'].

Referenz	Beschreibung
Name	Der Name des Flows.
Status	Aktueller Status des Flows.
duration	Wie lange die Flow-Ausführung insgesamt oder bisher ausgeführt wurde.
startTime	Zeitstempel für den Beginn der Flow-Ausführung. Ein Nullwert, wenn die Ausführung noch nicht begonnen hat.
endTime	Zeitstempel für den Zeitpunkt, zu dem die Ausführung des Flows beendet wurde. Ein Nullwert, wenn die Ausführung noch nicht beendet wurde.
lastUpdate	Der Zeitstempel für die letzte Änderung am Flow.
jobIds	Interne Kennungen für den Auftrag, der für den Flow ausgeführt wurde bzw. noch ausgeführt wird. Kann mehrere Kennungen enthalten.
Benutzer	Interne Kennung für den/die Benutzer:in, der/die den Auftrag ausgeführt hat.
JobTyp	Der Typ des ausgeführten Auftrags. Werte: `Manuell` – ausgeführt über Alteryx One. `Geplant` – ausgeführt gemäß einem definierten Zeitplan `API` – ausgeführt über die API
fileSize	Wenn die Ausgabe eine Datei oder mehrere Dateien generiert, erfasst dieser Wert die Größe der Ausgabe in KB.
environment	Die Ausführungsumgebung, in der der Auftrag ausgeführt wurde.
columnCount	Anzahl der in der Ausgabe generierten Spalten.
rowCount	Anzahl der in der Ausgabe generierten Zeilen.
dataTypeCount	Anzahl der in der Ausgabe erkannten Alteryx-Datentypen.
validValuesCount	Anzahl der gültigen Werte in der Ausgabe.
mismatchedValuesCount	Anzahl nicht übereinstimmender Werte in der Ausgabe.
emptyValuesCount	Anzahl der fehlenden oder leeren Werte in der Ausgabe.
Spalten	Die Spalteninformationen aus der ausgewählten Ausgabe für den Flow. Siehe unten.
sources	Quelldateiname und Tabelleninformationen der importierten Datasets. Siehe unten.
publishing actions	Daten zu den für die Ausgabe definierten Veröffentlichungsaktionen. Siehe unten.

Referenzen in der Ausgabespalte

Tipp

Die für Ausgabespalten berechneten Metriken werden ggf. auch in Profilen Ihrer Ausgabedaten angezeigt.

Diese Referenzen stehen für Ausgabespalten in der folgenden Syntax zur Verfügung:

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

Referenz	Beschreibung
Name	Spaltenname
Typ	Datentyp der Spalte
validValuesCount	Anzahl der gültigen Werte in der Spalte
mismatchedValuesCount	Anzahl nicht übereinstimmender Werte in der Spalte
emptyValuesCount	Anzahl der leeren Werte in der Spalte
topValues	Liste der höchsten Werte in der Spalte
minimumValue	Niedrigster Wert in der Spalte
lowerQuartileValue	Der 25. Perzentilwert in der Spalte
medianValue	Der 50. Perzentilwert in der Spalte
upperQuartileValue	Der 75. Perzentilwert in der Spalte
maximumValue	Maximalwert in der Spalte

Quellenreferenzen

Diese Referenzen gelten für die Datenquelldateien oder Tabellen, die zur Generierung der Ausgabe verwendet wurden.

Referenz	Beschreibung
Name	Name der Datenquellendatei oder -tabelle.

Referenzen für Veröffentlichungsaktionen

Diese Referenzen gelten für die Veröffentlichungsaktionen, die für die Ausgabe definiert wurden.

Referenz	Beschreibung
Name	Name der Veröffentlichungsaktion.
Aktion	Definition der Veröffentlichungsaktion.
Standort	Speicherort, an dem die Veröffentlichungsaktion veröffentlicht wird.
Typ	Art der Veröffentlichungsaktion.

Metadaten erkunden

Sie können die folgenden Funktionen und Techniken verwenden, um sich mit den Metadaten, die von Ihrer Planausführung zurückgegeben werden, weitergehend zu beschäftigen.

Metadatenfunktionen

Die folgenden Funktionen können auf ausgewählte Metadatenreferenzen angewendet werden, um die Rohwerte weiter zu filtern.

humanizeDuration

In roher Form geben die Metadatenreferenzen zu duration verschiedene Werte zurück, die wie folgt aussehen:

PT7.523S

Sie können die Funktion humanizeDuration anwenden, um die obigen Daten besser lesbar darzustellen:

{{ $plan.duration | humanizeDuration }}

Die Ausgabe der obigen Funktion, die auf den ersten Wert angewendet wird, lautet wie folgt:

7.523 seconds

uuid

Sie können eine universell eindeutige Kennung generieren und im Rahmen einer Messaging-Nutzlast bereitstellen:

{{ uuid() }}

Metadatenstruktur

Einige Metadatenreferenzen geben komplexe oder verschachtelte Objekte zurück. Die dabei zurückgegebenen Daten können wie folgt aussehen:

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

In diesen Fällen werden die verschachtelten Daten innerhalb des Objekts nicht durch die Basisreferenz dargestellt. Um weitere Informationen zu erhalten, können Sie eine der folgenden Lösungen verwenden:

Text: Erstellt eine FOR-Schleife durch die zurückgegebenen Objekte:

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

JSON: Fügt den Befehl | dump zum Ende Ihrer Referenz hinzu. Sie können die folgende Beispielreferenz ändern und versuchen, sie in das Textfeld „Text“ einzufügen:

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

Tipp

Wenn die Daten zurückgegeben werden, können Sie Schleifenstrukturen verwenden, um bestimmte Werte für die Anzeige abzurufen.

Weitere Informationen finden Sie unter https://mozilla.github.io/nunjucks/templating.html#dump.

Parameterreferenzen

Flow-Referenzen

Verwenden Sie das folgende Muster, um Flow-Parameter als Teil einer Flow-Aufgabe zu referenzieren:

$plan.params.<myParamName>

Umgebungsparameter

Sie können Umgebungsparameter in den Metadaten Ihrer Planaufgabe nach Namen referenzieren. Beispiel:

env.MyEnvironmentParameter1

Weitere Referenzen

Die Referenzinformationen für Planmetadaten nutzen die Nunjucks-Vorlagensprache. Sie bietet Ihnen zusätzliche Funktionen, wie Schleifen, Bedingungen, Filter und Hilfsfunktionen.