#レスポンスメッセージ

#はじめに

レスポンスメッセージノードは、特定の種類のワークフローにおいて、アクションを送信したクライアントに対し、ワークフロー内でカスタマイズされたメッセージをフィードバックとして返すために使用されます。

#ノードの作成

対応しているワークフロータイプでは、ワークフロー内の任意の場所に「レスポンスメッセージ」ノードを追加できます。ワークフロー内のプラス（「+」）ボタンをクリックして、「レスポンスメッセージ」ノードを追加してください。

レスポンスメッセージは、リクエスト処理全体を通して配列として存在します。ワークフロー内でレスポンスメッセージノードが実行されるたびに、新しいメッセージ内容が配列に追加されます。サーバーがレスポンス内容を送信する際、すべてのメッセージがまとめてクライアントに送信されます。

#ノードの設定

メッセージ内容は全体としてテンプレート文字列であり、変数も挿入できます。ノード設定でこのテンプレート内容を自由に構成できます。

ワークフローがこのノードに到達すると、テンプレートが解析され、メッセージ内容の結果が生成されます。上記の構成では、変数「ローカル変数 / 全製品をループ / ループオブジェクト / 製品 / タイトル」は、実際のワークフローで特定の値に置き換えられます。例えば、次のようになります。

製品「iPhone 14 pro」の在庫が不足しています

#ワークフローの設定

レスポンスメッセージのステータスは、ワークフローの実行が成功したか失敗したかによって決まります。いずれかのノードの実行が失敗すると、ワークフロー全体が失敗します。この場合、メッセージ内容は失敗ステータスとしてクライアントに返され、表示されます。

ワークフロー内で失敗ステータスを明示的に定義する必要がある場合は、「終了ノード」を使用し、失敗ステータスに設定できます。このノードが実行されると、ワークフローは失敗ステータスで終了し、メッセージは失敗ステータスとしてクライアントに返されます。

ワークフロー全体で失敗ステータスが発生せず、最後まで正常に実行された場合、メッセージ内容は成功ステータスとしてクライアントに返されます。

#利用シーン

#「操作前イベント」ワークフロー

「操作前イベント」ワークフローでレスポンスメッセージを使用すると、ワークフロー終了後にクライアントへ対応するメッセージフィードバックを送信できます。詳細は操作前イベントを参照してください。

#「カスタムアクションイベント」ワークフロー

同期モードの「カスタムアクションイベント」でレスポンスメッセージを使用すると、ワークフロー終了後にクライアントへ対応するメッセージフィードバックを送信できます。詳細はカスタムアクションイベントを参照してください。