データセレクターについて

本ページの内容

  • データセレクターの概要とマッピングの方法について紹介します。
 

データセレクターとは

  • データセレクターとはワークフロー内において、ピースで出力された値の中から、どのデータを処理対象とするのかを指定する機能です。
  • データセレクターの情報は、ピースのテストトリガーを実行(サンプルデータの生成)することでデータを取得できます。
  • 取得したデータをデータセレクターの中から選択(※マッピング)することで、受け取りたい情報の範囲や条件を指定することができます。

マッピングの方法

  • ここでは「ferret Oneでアクションがあったら、Slackに通知する」のワークフローを参考に、マッピングの方法について説明をします
  • 「Webhookを受信する」のピースで、テストトリガーを実行する
  • テストトリガーの実行中にアクションを実行する
    • ferret One側で実際にフォーム送信をおこなうことで、サンプルデータの生成をおこなうことができます。フォーム送信からサンプルデータ生成まで数分ほど、時間がかかる場合があります
  • 「テスト成功」と表示されれば、テストトリガーは成功です。サンプルデータの生成がされました
  • データの送信先のピースへ移動し、「メッセージ」の欄をクリックするとデータセレクターが開きます
  • 「Webhookを受信する」のトグルを展開し、「body」の中から使いたいデータを選択していきましょう
  • 「挿入」をクリックするとメッセージの欄にデータブロックを追加できます
  • メッセージの体裁を整えましょう。
    • ブロックを挿入しただけの状態だと、そのままの形でデータが送信されてしまいます
    • そのため、メッセージ欄で、改行や項目のテキストを入れて体裁を整えることを推奨いたします。アウトプットを確認したい時は「ステップをテスト」をクリックすることで、出力イメージを確認できます。

データセレクターを利用する場合の注意点

  • 送信するデータの形状(ピース)によって、取得データの内容が異なります。
  • データセレクターはテスト送信をしないと利用できません。
  • データセレクターで選択する以外にも変数を使った書き方があります。
 

変数(データ参照)の書き方

workrun では、前のピース(トリガーやアクション)の出力データを、変数(データ参照)として次のピースで利用できます。 データセレクターに表示されない項目も、出力データの構造が分かっていれば、変数を直接記述することで参照できます。

1. 基本構文

変数は次の形式で記述します。
  •  で囲む
  •  はピースの識別子
  • (ドット)でデータの階層を指定

2. step_slug(識別子)の確認方法

各ピースには内部識別子(step_slug)があります。これは ピースの上にマウスを載せると表示されます。
例①:トリガー
このピースにマウスを載せると右側にと表示されています。つまり、このピースの識別子は  です。
例②:通常ピース
このピースにマウスを載せると右側に と表示されています。つまり、このピースの識別子は  です。

3. Slackトリガーを例にしたデータ参照

※ここではデータセレクターの理解を深めるため、Slackイベントの出力構造を例に説明します。
3-1. Slackトリガーの出力例
Slackでメッセージを受信した場合、トリガーの出力は次のような構造になります。
3-2. この中の  を参照する場合
上記の例では、 は次の階層にあります。
Slackトリガーの識別子がの場合、記述は次のようになります。

4. その他の記述例

トリガー の body を参照する場合
トリガー の body 内の siteId を参照する場合
step_4 の出力値 result を参照する場合

5. 重要な注意点

  •  や  のような表記は アンダースコア(_)を使用します
  •  のようなハイフン形式は使用しません
  • 必ず ピースにマウスを載せて表示される識別子をそのまま使用してください
  • データセレクターに表示されない項目も、正しいパスであれば手入力可能です

6. データが表示されない場合

変数候補が表示されない場合は、
  1. トリガーをテスト実行する
  1. 前のピースを一度実行する
ことでサンプルデータが生成され、選択可能になります。