Pigeon連絡履歴のパラメータについて

回答済み

フォローする

原井麻有

• 2021年10月12日 10:29

お世話になっております。

Pigeonが連絡履歴で自動的に表示しているパラメータがあると存じます。
以下のパラメータについて、その内容の役割をご教示いただきたいと思います。
今回WEBHOOKアクションに切り替えるため、以下のパラメータは表示できないと思っており、その不足によるデグレードを防ぐ目的です。

event

message

scope  (displayName はparameters に指定して表示、scopeIdも同じく表示）

scopeSeverities

space

trigger

0

• 

  Kompiraサポートチーム

  • 2021年10月12日 12:35

  ご質問ありがとうございます。
  回答させていただきます。

  ■ Pigeonの「パラメータ」について

  本題に移る前にまずPigeonにおける「パラメータ」について整理させていただきますが、これは事前に「ガイダンス」に設定した読み上げテンプレートに対して連絡実行時に値を埋め込むための機能となります。この「パラメータ」への指定は音声読み上げの内容にのみ関係し、連絡実行の成否には影響致しません。

  逆に、個々の連絡により行われた音声読み上げの内容を完全に知るには「ガイダンス」に設定されたテンプレート文面と、実行時に渡された「パラメータ」の両方を知る必要がございます。そのため連絡結果画面には「ガイダンス」だけでなく「パラメータ」を併せて表示しております。

  なおこの「パラメータ」の指定は特に制約なく自由に行うことができ、「ガイダンス」に設定されたテンプレート文面に存在しない名称で値を渡すことも可能です。このとき該当するパラメータは音声読み上げ内容に影響しませんが、そういったものも含めて連絡結果画面には全て表示されます。

  ■ AlertHubのPigeonアクションにより暗黙で渡されるパラメータについて

  AlertHubのPigeonアクションではPigeon連絡実行APIのリクエストに必要な大部分の情報を自動的に判断して指定いたします。ここには先の「パラメータ」も含まれ、Pigeonの「ガイダンス」のテンプレート文面をこの仕様に合わせて記述することでAlertHubのスコープ・メッセージ等に関する様々な情報を音声読み上げに含めることができます。

  ご質問中にて挙げていただいたパラメータはこのPigeonアクションの機能により暗黙で渡されるパラメータです。このアクション実行の一般的な流れとしては、

  1. 受信スロットによりメッセージが受信される
  2. 受信スロットに関連するルールの判定が行われる
  3. ルール判定に基づき、スコープに対してイベントが発行される
  4. スコープが持つトリガーの実行条件が判定される
  5. 実行条件に一致するトリガーに設定されたアクションが実行される

  となり、この一連の流れに関連する情報が暗黙のパラメータとしてPigeonへ渡されます。

  • message: 1にて受信したメッセージの情報
  • event: 3にて発行されたイベントの情報
  • scope: 3にてイベント発行先となったスコープの情報
  • scopeSeverities: スコープが持つ全ての深刻度の情報
  • trigger: 5にて条件に一致したトリガーの情報
  • space: スペースの名称・ドメイン名など

  以上、よろしくお願いいたします。

  0

  コメントアクション Permalink

サインインしてコメントを残してください。