Workbot でダイアログを使用する

この記事では、Workbot を使用して Slack にダイアログを表示する方法について説明します。

ダイアログを使用することで、よりインタラクティブにユーザーから情報を収集することができます。

コンセプト

ダイアログワークフローを作成するには、3 つのレシピが必要です。

ダイアログを表示する Recipe をトリガーする (トリガー Recipe)
トリガーされると、この Recipe のアクションは 2 番目の Recipe をトリガーし、2 番目の Recipe がダイアログを呼び出します。
ダイアログを表示する
トリガーされると、この Recipe のアクションがダイアログを表示します。
アクションを実行する
ダイアログが送信されると、この Recipe のアクションは続けて行うアクションを実行します。

3 つの Recipe を作成する

1. ダイアログの表示をトリガーする Recipe

ダイアログを表示する Recipe をトリガーするには、Post command reply もしくは Post message Workbot アクションを使用します。

どちらの Workbot アクションでも、ダイアログ Recipe は次の 2 つの方法でトリガーできます。

1-1. ボタン

Submit button command フィールドには、このボタンが押されたときに実行されるコマンドを入力します。

1-2. メニューオプション

Submit button command フィールドには、このメニューオプションが押されたときに実行されるコマンドを入力します。

Slack のボタンやメニューオプションをクリックすると、ダイアログを呼び出すために必要な Trigger ID がついたイベントがトリガーされます。

上記の例では、いずれも collect issue details といったコマンドを呼び出しています。

2. ダイアログを表示する Recipe

ダイアログが確実に呼び出されるようにするには、トリガー Recipe 内のボタンやメニューオプションのコマンドをこのダイアログを表示する Recipe の Post command トリガーに紐づける必要があります。

ダイアログを表示する Recipe は、トリガー Recipe 内のボタンやメニューオプションからのコマンドを受け取るために Post command トリガーを使用します。

ダイアログを表示する Recipe の例では、ボタンやメニューオプションの collect issue details コマンドと Post command トリガーの collect issue details コマンドが紐づけられています。

ダイアログを設定するには、Post dialog アクションを使用します。

以下の表は、Post dialog アクションで使用可能なフィールドの一覧です。

フィールド	説明	入る値
Trigger ID	ボタンやメニューオプションがトリガーしたイベントの ID。	Post command トリガーの Trigger ID データピルを使用します。
Callback ID	ダイアログの識別子。最大長は 255 文字です。	トリガーレシピで定義されたボタンまたはメニューオプションコマンドからのコマンド入力値を渡します。トリガー Recipe のパラメーター名が、ダイアログを表示する Recipe の command input フィールドと一致することを確認してください。
Dialog title	呼び出されたダイアログのタイトル。最大長は 24 文字です。	ダイアログの目的を説明してください。例: チケットを作成する
Submit button label	ダイアログの Submit ボタンに表示するテキスト。	空のままにした場合は、”Submit" となります。すべてのダイアログは、既定で Cancel ボタンがあります。
Submit button command	Slack ユーザーがダイアログ内の Submit ボタンをクリックしたときに実行する Workbot コマンド。	実行したい Recipe の Post command トリガーと一致する Workbot コマンドを使用します。
Dialog form fields	これは Submit button command フィールドでコマンドを選択すると自動的に生成されます。最大は 5 フィールドです。	ダイアログに表示されるフィールドを定義します。これを変更して、ダイアログのヒント、エラー処理、選択リストオプションなどを含めます。 name の値は、上記の Submit button command から実行したレシピのコマンド入力フィールドの値と一致する必要があるため、変更しないでください。 Post dialog Recipe の JSON の例をご覧ください。

Submit button command フィールドは特に重要です。
このコマンドは、アクションを実行する Recipe をトリガーします。

3. アクションを実行する Recipe

この Recipe が確実に呼び出されるようにするには、ダイアログを表示する Recipe 内の Submit button command フィールドの値と
この Recipe の Post commandトリガーを紐づける必要があります。

この Recipe は、Workbot Post command トリガーを使用して
ダイアログを表示する Recipe 内の Submit button command からコマンドを受信します。

たとえば、ダイアログを表示する Recipe の Submit button command で使用されている github new issue は
アクションを実行する Recipe の Post command トリガーと紐づけられるようになっています。

ダイアログを使用する際の注意点

ダイアログで複数のレシピを使用することを考えると、いくつかの問題に直面することがあります。
ダイアログを使用する際の注意点は以下のとおりです。

1. 同じ Post command を使用する Recipe が一意である

Recipe 内で使用されるコマンドは、Workato のアカウント全体で一意である必要があります。
複数の Recipe にマッピングすることはできません。

2. ボタン、メニューオプションのコマンドを正しく紐づける

ダイアログの表示をトリガーする Recipe のボタンやメニューオプションに設定されているコマンドは、
ダイアログを表示する Recipe の Post command トリガーと同じである必要があります。

3. ダイアログ Submit 時のコマンドを正しく紐づける

ダイアログを表示する Recipe の Submit button command は、
アクションを実行する Post command トリガーと同じである必要があります。