Riferimenti ai metadati di Orchestrator
Nel corpo e nell'intestazione delle attività HTTP di un piano è possibile referenziare i seguenti metadati relativi all'esecuzione del piano, per ottenere ulteriori informazioni contestuali.
Nota
In un'attività è possibile referenziare sia i metadati dell'intero piano, sia quelli per le attività a monte di quella corrente. Se nel tuo piano hai implementato una struttura ad albero, le attività che si trovano su un determinato ramo non possono referenziare i metadati delle attività appartenenti a un ramo diverso. Tutte le attività possono referenziare i metadati relativi all'esecuzione del piano in generale.
Sintassi generale
Tutti i riferimenti ai metadati di un piano utilizzano la seguente sintassi di base:
{{$plan.path.to.reference}}Per tutti i riferimenti in Alteryx One Platform è possibile inserire il simbolo
$, che viene convertito in{{$nella definizione del codice, aggiungendo le doppie parentesi graffe richieste dall'ambiente per la sostituzione dei metadati.Suggerimento
In Alteryx One, è possibile iniziare digitando
$.I nodi nell'albero sono separati da un punto (
.).
I valori di riferimento che contengono spazi vuoti devono essere indicati come segue:
{{$plan.path['path with white space in it'].rest.of.path}}Note:
In Alteryx One, per specificare un valore costituito da uno spazio vuoto è possibile utilizzare le virgolette doppie. Tuttavia, poiché nella richiesta effettiva le virgolette doppie prevedono un carattere di escape, è consigliabile utilizzare le virgolette singole, che garantiscono risultati più coerenti e sicuri.
I valori costituiti da spazi vuoti vengono solitamente utilizzati per fare riferimento al nome visualizzato di una risorsa sottostante.
Riferimenti $plan
Questi riferimenti si applicano alla definizione del piano o all'esecuzione corrente del piano.
Testo da inserire:
$plan.
Riferimento | Descrizione |
|---|---|
name | Nome del piano in esecuzione. |
duration | Tempo richiesto per l'esecuzione del piano o tempo trascorso dall'inizio della sua esecuzione. Suggerimento Per restituire questo valore di durata in un formato più leggibile, puoi utilizzare il riferimento seguente: {{$plan.duration|humanizeDuration}} |
id | Identificatore interno del piano. |
startTime | Timestamp di inizio dell'esecuzione del piano. |
url | URL del piano in Alteryx One. |
runId | Identificatore interno per l'esecuzione corrente del piano. |
user | Identificatore interno dell'utente che ha avviato l'esecuzione corrente. |
taskCount | Conteggio delle attività incluse nell'esecuzione del piano. |
Riferimenti $http
Questi riferimenti si applicano alle attività HTTP incluse nell'esecuzione del piano.
Inserendo quanto segue puoi visualizzare i codici di due lettere per le attività HTTP che sono già state eseguite durante l'esecuzione corrente del piano:
$http_ax.
Riferimento | Descrizione |
|---|---|
name | Nome dell'attività HTTP. |
status | Stato di esecuzione dell'attività nel momento attuale. |
duration | Tempo richiesto per l'esecuzione dell'attività o tempo trascorso dall'inizio della sua esecuzione. |
startTime | Timestamp di inizio dell'attività. Se l'attività non è ancora iniziata, viene restituito un valore nullo. |
endTime | Timestamp di fine dell'attività. Se l'attività non è ancora finita, viene restituito un valore nullo. |
statusCode | Eventuale codice di stato restituito dall'endpoint ricevente. |
risposta | Informazioni relative alla risposta. Consulta il testo di seguito. |
Riferimenti per le risposte
Questi riferimenti si applicano alla risposta restituita nell'ambito dell'esecuzione di un'attività.
Inserendo quanto segue puoi visualizzare i codici di due lettere per le attività HTTP che sono già state eseguite durante l'esecuzione corrente del piano:
$http_ax.response.
Riferimento | Descrizione |
|---|---|
body | Corpo della risposta. |
json | Versione della risposta in formatto JSON. |
headers | Intestazioni restituite insieme alla risposta. |
Riferimenti $slack
Per fare riferimento ai metadati delle attività Slack incluse nell'esecuzione del piano corrente, puoi utilizzare i tipi di riferimento seguenti:
$slack_ax.
I metadati supportati sono identici a quelli per le attività HTTP. Per i dettagli, consulta la sezione precedente.
Riferimenti $workflow
Questi riferimenti si applicano alle attività del flusso di lavoro incluse nell'esecuzione del piano.
Inserendo quanto segue puoi visualizzare i codici di due lettere per le attività del flusso di lavoro che sono già state eseguite durante l'esecuzione corrente del piano:
$wf.
Riferimento | Descrizione |
|---|---|
name | Nome dell'attività del flusso di lavoro. |
status | Stato di esecuzione dell'attività nel momento attuale. |
duration | Tempo richiesto per l'esecuzione dell'attività o tempo trascorso dall'inizio della sua esecuzione. |
startTime | Timestamp di inizio dell'attività. Se l'attività non è ancora iniziata, viene restituito un valore nullo. |
endTime | Timestamp di fine dell'attività. Se l'attività non è ancora finita, viene restituito un valore nullo. |
Riferimenti $desktopworkflow
Questi riferimenti si applicano alle attività del flusso di lavoro Desktop incluse nell'esecuzione del piano.
Inserendo quanto segue puoi visualizzare i codici di due lettere per le attività del flusso di lavoro che sono già state eseguite durante l'esecuzione corrente del piano:
$designer_desktop.
Riferimento | Descrizione |
|---|---|
name | Nome dell'attività del flusso di lavoro. |
status | Stato di esecuzione dell'attività nel momento attuale. |
duration | Tempo richiesto per l'esecuzione dell'attività o tempo trascorso dall'inizio della sua esecuzione. |
startTime | Timestamp di inizio dell'attività. Se l'attività non è ancora iniziata, viene restituito un valore nullo. |
endTime | Timestamp di fine dell'attività. Se l'attività non è ancora finita, viene restituito un valore nullo. |
output URL | URL da utilizzare per accedere all'output in Designer Desktop. |
Riferimenti $aidataset
Questi riferimenti si applicano alle attività Auto Insights incluse nell'esecuzione del piano.
Inserendo quanto segue puoi visualizzare l'elenco delle attività Auto Insights che sono già state eseguite durante l'esecuzione corrente del piano:
$ai.
Riferimento | Descrizione |
|---|---|
name | Nome dell'attività Auto Insights. |
status | Stato di esecuzione dell'attività nel momento attuale. |
duration | Tempo richiesto per l'esecuzione dell'attività o tempo trascorso dall'inizio della sua esecuzione. |
startTime | Timestamp di inizio dell'attività. Se l'attività non è ancora iniziata, viene restituito un valore nullo. |
endTime | Timestamp di fine dell'attività. Se l'attività non è ancora finita, viene restituito un valore nullo. |
Riferimenti $flow
Questi riferimenti si applicano alle attività del flusso di lavoro incluse nell'esecuzione del piano.
Inserendo quanto segue puoi visualizzare i codici di due lettere per le attività del flusso di lavoro che sono già state eseguite durante l'esecuzione corrente del piano:
$flow_ax.
Riferimento | Descrizione |
|---|---|
name | Nome dell'attività del flusso di lavoro. |
status | Stato di esecuzione dell'attività nel momento attuale. |
duration | Tempo richiesto per l'esecuzione dell'attività o tempo trascorso dall'inizio della sua esecuzione. |
startTime | Timestamp di inizio dell'attività. Se l'attività non è ancora iniziata, viene restituito un valore nullo. |
endTime | Timestamp di fine dell'attività. Se l'attività non è ancora finita, viene restituito un valore nullo. |
jobIds | Identificatori interni per i processi che sono stati eseguiti nell'ambito dell'attività del flusso di lavoro |
jobUrl | URL del processo in Alteryx One. |
flowName | Nome del flusso di lavoro sottostante l'attività del flusso di lavoro |
output | Metadati contenuti nell'output dell'attività del flusso di lavoro. Consulta il testo di seguito. |
params | I parametri creati nel flusso di lavoro possono essere referenziati nell'attività. |
Riferimenti output
Questi riferimenti si applicano agli output generati dalle attività del flusso di lavoro incluse nell'esecuzione del piano.
Per l'attività del flusso di lavoro 7p con output My Output Name, inserisci quanto segue:
$flow_7p['My Output Name'].
Riferimento | Descrizione |
|---|---|
name | Nome del flusso di lavoro. |
status | Stato attuale del flusso di lavoro. |
duration | Tempo richiesto per l'esecuzione del flusso di lavoro o tempo trascorso dall'inizio della sua esecuzione. |
startTime | Timestamp di inizio dell'esecuzione del flusso di lavoro. Se l'esecuzione non è ancora iniziata, viene restituito un valore nullo. |
endTime | Timestamp di fine dell'esecuzione del flusso di lavoro. Se l'esecuzione non è ancora finita, viene restituito un valore nullo. |
lastUpdate | Timestamp dell'ultima modifica apportata al flusso di lavoro. |
jobIds | Identificatori interni dei processi che sono stati eseguiti o sono attualmente in esecuzione per il flusso di lavoro. Può contenere più di un identificatore. |
user | Identificatore interno dell'utente che ha eseguito il processo. |
jobType | Tipo del processo che è stato eseguito. Valori:
|
fileSize | Se l'output genera uno o più file, questo valore acquisisce le dimensioni in KB di tale output. |
environment | Ambiente in esecuzione in cui è stato eseguito il processo. |
columnCount | Numero delle colonne generate nell'output. |
rowCount | Numero delle righe generate nell'output. |
dataTypeCount | Numero dei tipi di dati Alteryx rilevati nell'output. |
validValuesCount | Numero dei valori validi contenuti nell'output. |
mismatchedValuesCount | Numero dei valori senza corrispondenza presenti nell'output. |
emptyValuesCount | Numero dei valori mancanti o vuoti all'interno dell'output. |
colonne | Informazioni relative alle colonne dall'output selezionato per il flusso di lavoro. Consulta il testo di seguito. |
sources | Informazioni relative ai nomi dei file e delle tabelle di origine per i set di dati importati. Consulta il testo di seguito. |
publishing actions | Dati relativi alle azioni di pubblicazione definite per l'output. Consulta il testo di seguito. |
Riferimenti alle colonne di output
Suggerimento
I profili dei dati di output possono contenere anche le metriche calcolate delle colonne di output.
Per le colonne di output sono disponibili questi riferimenti, con la sintassi indicata di seguito:
$flow_7p['My Output Name'].output.
Riferimento | Descrizione |
|---|---|
name | Nome colonna |
tipo | Tipo di dati della colonna |
validValuesCount | Numero dei valori validi presenti nella colonna |
mismatchedValuesCount | Numero dei valori senza corrispondenza presenti nella colonna |
emptyValuesCount | Numero dei valori vuoti nella colonna |
topValues | Elenco dei valori principali presenti nella colonna |
minimumValue | Valore minimo presente nella colonna |
lowerQuartileValue | Valore del 25° percentile della colonna |
medianValue | Valore del 50° percentile della colonna |
upperQuartileValue | Valore del 75° percentile della colonna |
maximumValue | Valore massimo presente nella colonna |
Riferimenti delle origini
Questi riferimenti si applicano ai file o alle tabelle delle origini dati che sono stati utilizzati per generare l'output.
Riferimento | Descrizione |
|---|---|
name | Nome del file o della tabella dell'origine dati. |
Riferimenti alle azioni di pubblicazione
Questi riferimenti si applicano alle azioni di pubblicazione definite per l'output.
Riferimento | Descrizione |
|---|---|
name | Nome dell'azione di pubblicazione. |
azione | Definizione dell'azione di pubblicazione. |
posizione | Posizione in cui viene pubblicata l'azione di pubblicazione. |
tipo | Tipo dell'azione di pubblicazione. |
Esplorazione dei metadati
Per esplorare ulteriormente i metadati restituiti dall'esecuzione del piano, puoi utilizzare le funzioni e le tecniche illustrate di seguito.
Funzioni per i metadati
Per selezionare i riferimenti ai metadati, allo scopo di filtrare ulteriormente i valori non elaborati, puoi utilizzare le funzioni illustrate di seguito.
humanizeDuration
I valori non elaborati restituiti dai riferimenti duration per i metadati hanno un aspetto simile al seguente:
PT7.523S
Al fine di renderli più comprensibili, puoi utilizzare la funzione HumanizeDuration:
{{ $plan.duration | humanizeDuration }}Applicandola al primo dei valori precedenti si ottiene:
7.523 seconds
uuid
È possibile generare un identificatore univoco universale, che può essere incluso nel payload dei messaggi:
{{ uuid() }}Struttura dei metadati
Alcuni riferimenti relativi ai metadati restituiscono oggetti complessi o annidati, che possono avere un aspetto simile al seguente:
[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
In questi casi, il riferimento di base non espone i dati annidati all'interno dell'oggetto. Per esplorare ulteriormente tali dati, puoi utilizzare una delle soluzioni seguenti:
Testo: crea un ciclo For per esaminare i singoli oggetti restituiti:
{% for value in $flow_6f.Job.columns.MyColumnName.topValues %}[{{value.key}}, {{value.count}}] {% endfor %}JSON: aggiungi il comando | dump alla fine del riferimento. Puoi modificare il riferimento di esempio seguente e inserirlo nella casella di testo Corpo:
{{$flow_6f.Job.columns.MyColumnName.topValues | dump | replace('"', '\"')}}Suggerimento
Quando i dati vengono restituiti, puoi utilizzare un ciclo per recuperare e visualizzare i valori specifici.
Per ulteriori informazioni, consulta la pagina https://mozilla.github.io/nunjucks/templating.html#dump.
Riferimenti per i parametri
Parametri del flusso di lavoro
Per referenziare i parametri di un flusso di lavoro nell'ambito di un'attività del flusso di lavoro, puoi utilizzare questo pattern:
$plan.params.<myParamName>
Parametri ambientali
Nei metadati delle attività di un piano puoi referenziare i parametri ambientali per nome. Per esempio:
env.MyEnvironmentParameter1
Altri riferimenti
Per referenziare i metadati di un piano puoi utilizzare il linguaggio di templating Nunjucks, che fornisce capacità aggiuntive come cicli, condizioni, filtri e funzioni helper.
Nota
Queste capacità aggiuntive sono accessibili tramite il linguaggio, ma la relativa implementazione in Alteryx One non è stata certificata. Per le capacità Nunjucks non elencate in questa pagina, prima di utilizzarle è consigliabile sperimentarle in un ambiente di sviluppo.
Per ulteriori informazioni, consulta la pagina https://mozilla.github.io/nunjucks/templating.html.