Slackでデジタル・アシスタント(またはスタンドアロン・ボット)を使用できるようにするには、Slackワークスペースが使用可能になっており、そこでSlackアプリケーションの作成に必要な権限を持っている必要があります。

そのようなワークスペースが使用可能になっていない場合は、独自のワークスペースを作成できます。SlackのCreate a new workspaceページを参照してください。

1. Slackの「Your Apps」ページに移動します。

2. 「Create a Slack App」をクリックします。

3. 「Create a Slack App dialog」ダイアログで、「App Name」および「Development Slack Workspace」の各フィールドに入力し、「Create App」をクリックします。

   アプリケーションが作成されると、その「Basic Information」ページが表示されます。

4. ページの「App Credentials」セクションまでスクロールし、「Client ID」、「Client Secret」および「Signing Secret」の値を書き留めます。

   デジタル・アシスタントでチャネルを設定する際、これらの資格証明が必要になります。

ボットおよびユーザーに付与する権限のOAuthスコープを追加します。

1. SlackアプリケーションのWebコンソールの左側のナビゲーションで、「Features」セクションから「OAuth and Permissions」を選択します。

2. ページの「Scopes」セクションにスクロールします。

3. スコープは次のカテゴリに分類されます:

   • Bot Token Scopes
   • User Token Scopes

4. 「Bot Token Scopes」セクションで、許可するボットレベルの権限に対応するスコープを追加します。少なくとも、次のボット・トークン・スコープが必要です:

   • chat:write
   • im:history
   • users:read

   スキルの機能によっては、他のスコープが必要になる場合があります。たとえば、添付の操作には、次のスコープが必要です。

   • files:read
   • files:write

5. 「User Token Scopes」セクションで、許可するユーザーレベルの権限に対応するスコープを追加します。次のユーザー・トークン・スコープが必要です:

   • files:read
   • files:write

ボットの要件によっては、他のスコープの追加が必要になる場合があります。

1. 「OAuth& Permissions」ページの上部までスクロールして戻ります。

2. OAuth「トークンとリダイレクトURL」セクションで、「ワークスペースにインストール」をクリックします。

   アプリケーションが実行できることを示したページが表示されます。

3. ページの下部で、「Allow」をクリックします。

このステップを完了すると、左側のナビゲーションで「Apps」を選択して、Slackワークスペースにアプリケーションを表示できるようになります。

1. デジタル・アシスタントで、左側のメニューの「チャネル」をクリックして、「ユーザー」を選択します。

2. 「+チャネル」をクリックして「チャネルの作成」ダイアログを開きます。

3. チャネルの名前を指定します。

4. チャネル・タイプとして「Slack」を選択します。

5. 「クライアントID」、「クライアント・シークレット」および「署名シークレット」に、Slackアプリケーションの作成時に取得した値を入力します。

   これらの値はSlackアプリケーションの「Settings」ページから取得できます。

6. グループ・チャット用にチャネルを設定し、Slackアプリケーション名を指定せずにメッセージをグループに移動する場合は、「グループ・チャットでのアプリケーション・メンションのないメッセージの許可」を選択します。

7. 「作成」をクリックします。

8. 「チャネル」ページで、WebフックURLをコピーして、システム上の便利な場所に貼り付けます。Slackアプリケーションの設定を完了するには、これが必要です。

9. をクリックし、チャネルに関連付けるデジタル・アシスタントまたはスキルを選択します。

10. 「ルート先」ドロップダウンで、チャネルに関連付けるデジタル・アシスタントまたはスキルを選択します。

11. 「チャネル有効」コントロールをオンに切り替えます。

1. SlackアプリケーションのWebコンソールの左側のナビゲーションで、「Interactivity & Shortcuts」を選択します。

2. 「Interactivity」スイッチを「ON」にします。

3. 「Request URL」フィールドと「Options Load URL」フィールドの両方に、デジタル・アシスタントでチャネルを作成したときに生成されたWebフックURLを貼り付けます。

4. 「Save Changes」をクリックします。

5. 左側のナビゲーションで、「OAuth & Permissions」を選択します。

6. 「Redirect URLs」フィールドで、「Add New Redirect URL」をクリックします。

7. WebフックURLを貼り付け、/authorizeV2を追加して、「Add」をクリックします。

8. 「Save URLs」をクリックします。

9. 左側のナビゲーションで、「App Home」を選択します。

10. 「Your App's Presence in Slack」セクションで、「Always Show My Bot as Online」スイッチをオンにします。

11. ページを下にスクロールして「タブの表示」セクションに移動し、「メッセージ」タブ・スイッチをオンにします。

12. 「ユーザーにメッセージ・タブからのスラッシュ・コマンドおよびメッセージの送信を許可」チェック・ボックスを選択します。

13. 左側のナビゲーションで、「Event Subscriptions」を選択します。

14. 「Enable Events」スイッチを「ON」に設定します。

15. 「Request URL」フィールドに、WebフックURLを貼り付けます。

    URLを入力した後、緑色の「Verified」ラベルが「Request URL」ラベルの横に表示されます。

16. ページの「サブスクライブ・オブ・ボット・イベント」セクションを展開し、「ボット・ユーザー・イベントの追加」をクリックして、次のイベントを追加します:

    • message.im
17. ボットをグループ・チャットで使用できるようにするには、次のイベントも追加します:
    • app_mention
    • message.mpim
    • message.channels

18. 「Save Changes」をクリックします。

19. 左側のナビゲーションで、「Manage Distribution」を選択します。

20. 「Add to Slack」ボタンをクリックし、「Allow」をクリックします。

    この時点で、メッセージ「You've successfully installed your App in Slack」が表示されます。

Slackチャネルとメッセージングの構成が完了したら、Slackでボット(デジタル・アシスタントまたはスキル)をテストできます。

1. アプリケーションをインストールしたSlackワークスペースを開きます。

2. 左側のナビゲーション・バーで、デジタル・アシスタントに関連付けられているアプリケーションを選択します。

3. 「Message」フィールドにテキストを入力して、デジタル・アシスタントとの通信を開始します。

Oracle Digital Assistantのバージョン20.6以降、Slackチャネルの作成は、Slackアプリケーションの更新されたOAuthフローに基づいています。この更新されたフローにより、より詳細なスコープが使用できるようになります。このガイドのチャネル設定の手順は、新しいOAuthフローに基づいています。

更新されたOAuthフローの詳細は、https://api.slack.com/authentication/oauth-v2を参照してください。

デジタル・アシスタントのSlackチャネルでは、次の機能がサポートされています:

• テキスト(送信と受信の両方)
• イメージ(送信と受信の両方)
• ファイル(送信では一部サポート、受信では完全サポート)
• 絵文字(送信では一部サポート、受信では完全サポート)
• リンク
• ポストバック
• カスタム・プロパティ
• カルーセル・コンポーネント(ただし、レンダリングは水平方向ではなく垂直方向)
• リスト・コンポーネント

Slackでは、Markdownを使用してメッセージを書式設定できます。Slack APIドキュメントのhttps://api.slack.com/reference/surfaces/formattingを参照してください。

異なる書式設定機能および構文を使用してスキルを複数のチャネルにターゲット指定する場合は、メッセージで基本的なHTMLマークアップを使用できます。その場合、メッセージがチャネルに送信されると、そのマークアップは自動的にSlackのマークダウン形式に変換されます。これは、Slackに加えて他のチャネルにスキルをターゲットにしている場合に特に役立ちます。チャネルでのリッチ・テキスト形式を参照してください。

デジタル・アシスタントのSlackチャネルには、次のようなメッセージの制約があります:

• テキスト・メッセージ
  • テキスト・メッセージの最大長: 3000文字。長さが3000を超えると、テキストは複数のメッセージに分割されます。
  • テキスト・アクション・ラベルの最大長: 30文字
  • 許可されるテキスト・アクションのタイプ: ポストバック、URL
• 水平カード
  • サポートの有無: いいえ。カードのレイアウトは垂直に変換されます。
• 垂直カード
  • タイトルの最大長: 3000文字
  • 説明の最大長: 3000文字
  • カード・アクション・ラベルの最大長: 30文字
  • カードの最大数: 100
  • 許可されるカード・アクションのタイプ: ポストバック、URL
  • 許可されるカード・リスト・アクションのタイプ: ポストバック、URL
• アタッチメント・メッセージ
  • サポートの有無: はい
  • 許可されるアクションのタイプ: ポストバック、URL
• アクション・ボタン
  • グローバル・アクション・ラベルの最大長: 30文字
  • 許可されるグローバル・アクションのタイプ: ポストバック、URL

Slackチャネルの場合、Slackに固有の機能でCommon Responseコンポーネントの機能を拡張できます。

拡張機能にアクセスするには、共通レスポンス・コンポーネントのメタデータのchannelCustomProperties要素を使用し、適切なプロパティを設定します。コードのフォーマットは次のとおりです:

...
            channelCustomProperties:
            - channel: "slack"
              properties:
                PROPERTY_NAME: "PROPERTY_VALUE"
...

Slackチャネルで使用可能なカスタム・プロパティを次に示します:

次に、renderActionsAsDropDownカスタム・プロパティの使用例を示します。

responseItems:
- type:
 "text"
  text: "Here is a list of the UI features of the Common Response Component:"
  actions:
  - ...
  channelCustomProperties:
  - channel: "slack"
    properties:
      renderActionsAsDropDown: false

次に、postbackActions、cardPostbackActionsおよびglobalPostbackActionsのネストされたプロパティを持つrenderActionsAsDropDownカスタム・プロパティの使用例を示します。

responseItems:
- type: "text"
  text: "Here is a list of the UI features of the Common Response Component:"
  actions:
  - ...
  channelCustomProperties:
  - channel: "slack"
    properties:
      renderActionsAsDropDown:
        postbackActions: false
        cardPostbackActions: true
        globalPostbackActions: true

channelCustomPropertiesの全般的な情報は、チャネル固有の拡張機能を参照してください。

共通レスポンス・コンポーネントでSlackモーダルを起動するボタンを作成できます。そのためには、ボタンのactionプロパティをsystem.openModalに設定し、タイプmapのsystem.dialogPayloadという名前の変数を含めます。アクション・メタデータは、次のスニペットのようになります:

          actions:
          - label: "Open Dialog"
            type: "postback"
            payload:
              action: "system.openModal" 
              variables:
                system.dialogPayload: ${dialogPayload}

system.dialogPayloadの値は通常、カスタム・コンポーネントで設定されますが、インラインで定義することも、変数の設定コンポーネントを使用して定義することもできます。

ユーザーがSlackダイアログで入力を送信すると、共通レスポンス・コンポーネントは、system.dialogSubmitted遷移を、送信された値を処理する状態に移動するように設定します。送信された値は、同名の変数に格納されます。

送信されたフィールド値の処理方法は、ユーザーが決定します。共通レスポンス・コンポーネントでは、エンティティ値の自動更新は実行されません。変数に値のみが格納されます。通常、これらの値はカスタム・コンポーネントで処理するため、必要に応じて追加の検証を実行できます。最も単純な形式では、送信されたフィールド値を文字列変数に格納し、エンティティの照合コンポーネントを使用してエンティティ値を更新できます。

Slackダイアログ・ペイロードでサポートされている要素タイプの詳細は、https://api.slack.com/reference/block-kit/block-elementsを参照してください。ダイアログ・ペイロードで指定する構造は、Slackのドキュメントで説明されている構造と同じである必要があります。

共通レスポンス・コンポーネントでSlackダイアログを起動するボタンを作成できます。これを行うには、ボタンのactionプロパティをsystem.openDialogに設定し、system.dialogPayloadという名前の変数を含めます。アクション・メタデータは、次のスニペットのようになります:

            actions:
              - label: "Edit"
                type: "postback"
                payload:
                  action: "system.openDialog"
                  variables:
                    system.dialogPayload: ${dialogPayload}

system.dialogPayloadの値は通常、カスタム・コンポーネントで設定されますが、インラインで定義することも、変数の設定コンポーネントを使用して定義することもできます。

ユーザーがSlackダイアログで入力を送信すると、共通レスポンス・コンポーネントは、system.dialogSubmitted遷移を、送信された値を処理する状態に移動するように設定します。送信された値は、同名のダイアログ・フロー変数に格納されます。

送信されたフィールド値の処理方法は、ユーザーが決定します。共通レスポンス・コンポーネントでは、エンティティ値の自動更新は実行されません。値はダイアログ・フロー変数にのみ格納されます。通常、これらの値はカスタム・コンポーネントで処理するため、必要に応じて追加の検証を実行できます。最も単純な形式では、送信されたフィールド値を文字列変数に格納し、エンティティの照合コンポーネントを使用してエンティティ値を更新できます。

Slackダイアログ・ペイロードでサポートされている他のプロパティおよび要素タイプに関するドキュメントは、https://api.slack.com/dialogs#top-level_dialog_attributesを参照してください。ダイアログ・ペイロードの構造は、Slackのドキュメントで説明されている構造と同じである必要があります。