Orchestratorメタデータの参照

プラン内のHTTPタスクの本文とヘッダーでは、プラン実行から以下のメタデータ要素を参照して詳細なコンテキスト情報を確認できます。

注記

タスクでは、プラン全体と現在のタスクの上流にあるタスクのメタデータを参照できます。プランに分岐構造をデプロイしている場合、一方のブランチのタスクはもう一方のブランチのタスクのメタデータを参照できません。すべてのタスクは、プラン実行全体のメタデータを参照できます。

一般的な構文

すべてのプランメタデータの参照は、次の基本構文に従います。

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

Alteryx One Platformでは、すべての参照を$を使用して入力できます。これらの参照は、コード定義で{{$に変換されます。二重中括弧は、メタデータの置換を実行する環境を形成します。
ヒント
Alteryx Oneでは、最初に$を入力します。
ツリー内のノードは. (ピリオド)で区切られます。

空白を含む参照値は、次の方法で記述する必要があります。

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

注：

Alteryx Oneでは、空白値を指定するときに二重引用符を使用できます。ただし、これらの二重引用符は実際のリクエストでエスケープされます。一重引用符を使用する方が安全で一貫性を保つことができます。

空白値は通常、基盤となるアセットの表示名値を参照するときに表示されます。

$plan参照

これらの参照は、プラン定義または現在のプラン実行に適用されます。

入力するテキスト:

$plan.

参照	説明
name	実行されるプランの名前。
duration	プランが実行された、またはこれまでに実行されている時間の長さ。ヒントこの期間値を読みやすい形式で返すには、次の参照を使用します。 {{$plan.duration\|humanizeDuration}}
id	プランの内部識別子。
startTime	プランの実行が開始されたときのタイムスタンプ。
url	Alteryx OneのプランのURL。
runId	プランのこの実行の内部識別子。
user	この実行を開始したユーザーの内部識別子。
taskCount	プラン実行内のタスクの数。

$http参照

これらの参照は、プラン実行のHTTPタスクに適用されます。

次のように入力すると、現在のプラン実行ですでに実行されているHTTPタスクの2文字のコードが表示されます。

$http_ax.

参照	説明
name	HTTPタスクの名前。
ステータス	タスク実行の現在のステータス。
duration	タスクが実行された、またはこれまでに実行されている時間の長さ。
startTime	タスクが開始されたときのタイムスタンプ。タスクが開始されていない場合はNull値。
endTime	タスクが終了したときのタイムスタンプ。まだ終了していない場合はNull値。
statusCode	受信エンドポイントから返されたステータスコード(存在する場合)。
応答	応答情報。下記を参照してください。

応答参照

これらの参照は、タスク実行の一部として返される応答に適用されます。

次のように入力すると、現在のプラン実行ですでに実行されているHTTPタスクの2文字のコードが表示されます。

$http_ax.response.

参照	説明
body	応答の本文
json	応答のJSON形式バージョン
headers	応答と一緒に返されるヘッダー

$slack参照

次の参照タイプを使用して、現在のプラン実行のSlackタスクからメタデータを参照できます。

$slack_ax.

サポートされているメタデータは、HTTPタスクのメタデータと同じです。詳細については、前のセクションを参照してください。

$workflow参照

これらの参照は、プラン実行のワークフロータスクに適用されます。

次のように入力すると、現在のプラン実行ですでに実行されているワークフロータスクの2文字のコードが表示されます。

$wf.

参照	説明
name	ワークフロータスクの名前。
ステータス	タスク実行の現在のステータス。
duration	タスクが実行された、またはこれまでに実行されている時間の長さ。
startTime	タスクが開始されたときのタイムスタンプ。タスクが開始されていない場合はNull値。
endTime	タスクが終了したときのタイムスタンプ。まだ終了していない場合はNull値。

$desktopworkflow参照

これらの参照は、プラン実行のデスクトップワークフロータスクに適用されます。

次のように入力すると、現在のプラン実行ですでに実行されているワークフロータスクの2文字のコードが表示されます。

$designer_desktop.

参照	説明
name	フロータスクの名前。
ステータス	タスク実行の現在のステータス。
duration	タスクが実行された、またはこれまでに実行されている時間の長さ。
startTime	タスクが開始されたときのタイムスタンプ。タスクが開始されていない場合はNull値。
endTime	タスクが終了したときのタイムスタンプ。まだ終了していない場合はNull値。
output URL	Designer Desktopの出力にアクセスするためのURL。

$aidataset参照

これらの参照は、プラン実行のAuto Insightsタスクに適用されます。

次のように入力すると、現在のプラン実行ですでに実行されているAuto Insightsタスクのリストが表示されます。

$ai.

参照	説明
name	Auto Insightsタスクの名前。
ステータス	タスク実行の現在のステータス。
duration	タスクが実行された、またはこれまでに実行されている時間の長さ。
startTime	タスクが開始されたときのタイムスタンプ。タスクが開始されていない場合はNull値。
endTime	タスクが終了したときのタイムスタンプ。まだ終了していない場合はNull値。

$flow参照

これらの参照は、プラン実行のフロータスクに適用されます。

次のように入力すると、現在のプラン実行ですでに実行されているフロータスクの2文字のコードが表示されます。

$flow_ax.

参照	説明
name	フロータスクの名前。
ステータス	タスク実行の現在のステータス。
duration	タスクが実行された、またはこれまでに実行されている時間の長さ。
startTime	タスクが開始されたときのタイムスタンプ。タスクが開始されていない場合はNull値。
endTime	タスクが終了したときのタイムスタンプ。まだ終了していない場合はNull値。
jobIds	このフロータスクに含まれる実行されたジョブの内部識別子
jobUrl	Alteryx OneのジョブのURL。
flowName	このフロータスクの基盤となるフローの名前
出力	フロータスクの出力から取得するメタデータ。下記を参照してください。
params	フローで作成されたパラメーターは、タスクで参照できます。

出力参照

これらの参照は、プラン実行のフロータスクで生成される出力に適用されます。

フロータスクが7pで出力がMy Output Nameの場合は次のように入力します。

$flow_7p['My Output Name'].

参照	説明
name	フローの名前。
ステータス	フローの現在のステータス。
duration	フロー実行が実行された、またはこれまでに実行されている時間の長さ。
startTime	フローの実行が開始されたときのタイムスタンプ。実行が開始されていない場合はNull値。
endTime	フローの実行が終了したときのタイムスタンプ。まだ終了していない場合はNull値。
lastUpdate	フローが最後に変更されたときのタイムスタンプ。
jobIds	実行されたジョブまたはフローに対して実行されているジョブの内部識別子。複数の識別子を含めることができます。
ユーザー	ジョブを実行したユーザーの内部識別子。
jobType	実行されたジョブのタイプ。値: `manual` - Alteryx Oneを介して実行 `scheduled` - 定義されたスケジュール設定に従って実行 `api` - APIを介して実行
fileSize	出力で1つまたは複数のファイルが生成される場合、この値は出力のサイズをKB単位で示します。
environment	ジョブが実行された実行環境。
columnCount	出力で生成された列の数。
rowCount	出力で生成された行の数。
dataTypeCount	出力で検出されたAlteryxデータ型の数。
validValuesCount	出力内の有効な値の数。
mismatchedValuesCount	出力内の不一致値の数。
emptyValuesCount	出力内の欠落値または空の値の数。
列	フローの選択した出力から取得した列情報。下記を参照してください。
sources	インポートされたデータセットから取得したソースファイル名とテーブル情報。下記を参照してください。
publishing actions	出力用に定義された公開アクションに関するデータ。下記を参照してください。

出力列参照

ヒント

出力列に対して計算されたメトリックは、出力データのプロファイルにも表示される場合があります。

これらの参照は、次の構文を使用して出力列で使用できます。

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

参照	説明
name	列名
type	列のデータ型
validValuesCount	列の有効な値の数
mismatchedValuesCount	列の不一致値の数
emptyValuesCount	列の空の値の数
topValues	列内の上位値の数
minimumValue	列の最小値
lowerQuartileValue	列の25パーセンタイル値
medianValue	列の50パーセンタイル値
upperQuartileValue	列の75パーセンタイル値
maximumValue	列の最大値

ソース参照

これらの参照は、出力の生成に使用されたデータソースファイルまたはテーブルに適用されます。

参照	説明
name	データソースファイルまたはテーブルの名前。

公開アクション参照

これらの参照は、出力用に定義された公開アクションに適用されます。

参照	説明
name	公開アクションの名前。
アクション	公開アクションの定義。
場所	公開アクションが公開されている場所。
type	公開アクションのタイプ。

メタデータの詳細情報

次の関数と方法を使用して、プランの実行から返されるメタデータをさらに詳しく表示することができます。

メタデータ関数

次の関数を適用して、メタデータ参照を選択し、生の値をさらにフィルタリングできます。

humanizeDuration

生の形式では、期間メタデータは次のような戻り値を参照します。

PT7.523S

HumanizeDuration関数を適用して、上記をより読みやすい形式にレンダリングできます。

{{ $plan.duration | humanizeDuration }}

最初の値に適用される上記の出力は次のとおりです。

7.523 seconds

uuid

メッセージペイロードの一部として配信できる、汎用一意識別子を生成できます。

{{ uuid() }}

メタデータ構造

一部のメタデータ参照は、複雑なオブジェクトまたはネストされたオブジェクトを返します。これらのオブジェクトは、次のようなデータを返す場合があります。

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

このような場合、オブジェクト内のネストされたデータは基本参照では公開されません。さらに詳しく表示するには、次のいずれかのソリューションを使用します。

テキスト: 返されたオブジェクトを介してforループを作成します。

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

JSON:| dumpコマンドを参照の最後に追加します。次の参照例を変更して、本文テキストボックスに挿入することができます。

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

ヒント

データが返されると、ループ構造を使用して特定の値を取得して表示できます。

詳細については、https://mozilla.github.io/nunjucks/templating.html#dumpを参照してください。

パラメーター参照

フローパラメーター

フロータスクの一部としてフローパラメーターを参照するには、次のパターンを使用します。

$plan.params.<myParamName>

環境パラメーター

プランタスクメタデータで、環境パラメーターを名前で参照できます。例:

env.MyEnvironmentParameter1

その他の参照

プランメタデータの参照情報は、ループ、条件、フィルター、ヘルパー関数などの追加機能を提供するNunjucksテンプレート言語を利用します。

注記

これらの追加機能は言語を介して利用できますが、Alteryx Oneでの実装は認証されていません。このページに記載されていないNunjucksの機能については、まず開発環境で試行してください。

詳細については、https://mozilla.github.io/nunjucks/templating.htmlを参照してください。

このセクションの内容: