Anypoint Studio を使用した Slack Connector l.0 の設定 - Mule 4

Anypoint Studio (Studio) エディターは、Mule アプリケーション、プロパティ、および設定ファイルの設計と更新に役立ちます。

Studio でコネクタを追加および設定する手順は、次のとおりです。

「アプリケーションログの表示」​で説明されているように、コネクタを実行するときに、リアルタイムでアプリケーションログを表示して問題を確認できます。

Studio で初めてコネクタを設定する場合は、​「Anypoint Studio を使用したコネクタの設定」​を参照してください。このトピックを参照した後、コネクタ項目についての詳細情報が必要な場合は、​「Slack Connector リファレンス」​を参照してください。

Slack Connector の設定に関するエンドツーエンドのデモについては、Max の友人の動画 「Setting Up Slack Connector in Anypoint Studio (Anypoint Studio での Slack Connector のセットアップ)」Leaving the Site​をご覧ください。

Mule プロジェクトを作成する

Studio で、コネクタを追加および設定する新しい Mule プロジェクトを作成します。

  1. Studio で、​[File (ファイル)] > [New (新規)] > [Mule Project (Mule プロジェクト)]​ を選択します。

  2. Mule プロジェクトの名前を入力して、​[Finish (完了)]​ をクリックします。

コネクタを Mule プロジェクトに追加する

Slack 用 Anypoint Connector (Slack Connector) を Mule プロジェクトに追加して、XML コードにコネクタの名前空間およびスキーマの場所を自動的に入力し、プロジェクトの ​pom.xml​ ファイルに必須の連動関係を追加します。

  1. [Mule Palette (Mule パレット)]​ ビューで、​[(X) Search in Exchange ((X) Exchange 内を検索)]​ をクリックします。

  2. [Add Dependencies to Project (連動関係をプロジェクトに追加)]​ ウィンドウで、検索項目に「​slack​」と入力します。

  3. [Available modules (使用可能なモジュール)]​ で ​[Slack Connector]​ をクリックします。

  4. [Add (追加)]​ をクリックします。

  5. [Finish (完了)]​ をクリックします。

Studio でコネクタを Mule プロジェクトに追加しても、Studio ワークスペースの他のプロジェクトはそのコネクタを使用できません。

ソースの設定

ソースは、指定された条件が満たされたときにフローを開始します。 Slack Connector で使用するように次の入力元のいずれかを設定します。

  • HTTP Listener (HTTP リスナー)

    設定されたホストとポートで要求を受信するたびにフローを開始する

  • スケジューラー

    時間ベースの条件が満たされたときにフローを開始する

たとえば、HTTP Listener ソースを設定する手順は、次のとおりです。

  1. [Mule Palette (Mule パレット)]​ ビューで、​[HTTP] > [Listener]​ を選択します。

  2. [Listener]​ を Studio キャンバスにドラッグします。

  3. [Listener (リスナー)]​ 設定画面で、必要に応じて ​[Display Name (表示名)]​ 項目の値を変更します。

  4. [Path (パス)]​ 項目の値を指定します。

  5. [Connector configuration (コネクタ設定)]​ 項目の横にあるプラス記号 (​+​) をクリックして、アプリケーション内の HTTP Listener ソースのすべてのインスタンスで使用できるグローバル要素を設定します。

  6. [General (一般)]​ タブで、コネクタの接続情報を指定します。

  7. [TLS]​ タブで、必要に応じてコネクタの TLS 情報を指定します。

  8. [Advanced (詳細)]​ タブで、必要に応じて再接続戦略を含む再接続情報を指定します。

  9. [Test Connection (接続をテスト)]​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。

  10. [OK]​ をクリックします。

フローにコネクタの操作を追加する

フローにコネクタの操作を追加するときは、そのコネクタで実行するアクションを指定しています。

Slack Connector の操作を追加するには、次の手順に従います。

  1. [Mule Palette (Mule パレット)]​ ビューで ​[Slack]​ を選択し、目的の操作を選択します。

  2. その操作を Studio キャンバスのソースの右にドラッグします。

コネクタのグローバル要素を設定する

コネクタを設定する場合、アプリケーション内のそのコネクタのすべてのインスタンスで使用できるグローバル要素を設定することをお勧めします。グローバル要素を設定するには、コネクタが対象の Slack システムにアクセスするために必要な認証ログイン情報を指定する必要があります。Slack Connector でサポートされている OAuth 2.0 では、ユーザーアカウントをホストするサービスにユーザー認証を委任します。

Slack Connector のグローバル要素を設定する手順は、次のとおりです。

  1. Studio キャンバスでコネクタの名前を選択します。

  2. Studio キャンバスで操作を選択します。

  3. 操作の設定画面で、​[Connector configuration (コネクタ設定)]​ 項目の横にあるプラス記号 (​+​) をクリックし、グローバル要素設定項目にアクセスします。

  4. [General (一般)]​ タブで、次の項目に入力して OAuth 2.0 認証をセットアップします。

    項目 説明

    Consumer key (コンシューマーキー)

    サービスプロバイダーに登録されている OAuth コンシューマーキー。

    Consumer secret (コンシューマーシークレット)

    サービスプロバイダーに登録されている OAuth コンシューマーシークレット。

    Authorization url (認証 URL)

    サービスプロバイダーの認証エンドポイント URL。

    Access token url (アクセストークン URL)

    サービスプロバイダーのアクセストークンエンドポイント URL。

    Scopes (スコープ)

    OAuth ダンス時に要求する Oauth スコープ。指定されていない場合、デフォルトとしてアノテーション内のスコープが使用されます。

    Resource owner Id (リソースオーナー ID)

    各コンポーネントが他を参照しない場合に使用する必要があるリソースオーナー ID。

    Before (前)

    OAuth ダンスを開始する直前に実行するフローの名前。

    After (後)

    アクセストークンが受信された直後に実行するフローの名前。

    Listener config (リスナー設定)

    アクセストークンコールバックエンドポイントを受信するリスナーの作成に使用する HTTP リスナー設定への参照。

    Callback path (コールバックパス)

    アクセストークンコールバックエンドポイントのパス。

    Authorize path (認証パス)

    OAuth ダンスをトリガーするローカル HTTP エンドポイントのパス。

    External callback url (外部コールバック URL)

    コールバックエンドポイントがプロキシの背後にあるか、直接 URL 以外でアクセスする必要がある場合、このパラメーターを使用して OAuth プロバイダーに、コールバックへのアクセスに使用すべき URL を指示します。

    Object store (オブジェクトストア)

    各リソースオーナー ID のデータの保存に使用するオブジェクトストアへの参照。指定されていない場合、Mule が自動的にデフォルトのオブジェクトストアをプロビジョニングします。

    ANT スタイルのプロパティプレースホルダーを含む設定ファイルを参照するか (推奨)、グローバル設定プロパティに認証ログイン情報を入力できます。プロパティプレースホルダーを使用する利点とその設定方法については、​「Anypoint Connector 設定」​を参照してください。

  5. [Advanced (詳細)]​ タブで、必要に応じて再接続戦略を含む再接続情報を指定します。

  6. [Test Connection (接続をテスト)]​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。

  7. [OK]​ をクリックします。

その他のコネクタ項目の設定

Slack Connector のグローバル要素を設定したら、コネクタの他の必須項目を設定します。必須項目は、使用するコネクタ操作によって異なります。

アプリケーションログの表示

問題を確認するため、アプリケーションログを次の方法で表示できます。

  • アプリケーションを Anypoint Platform から実行している場合、出力は Anypoint Studio のコンソールウィンドウに表示される。

  • コマンドラインから Mule を使用してアプリケーションを実行している場合、アプリケーションログは OS コンソールに表示される。

アプリケーションのログファイル (​log4j2.xml​) でログファイルパスがカスタマイズされていない場合、デフォルトの場所 ​MULE_HOME/logs/<app-name>.log​ でアプリケーションログを表示することもできます。

次のステップ

Studio でアプリケーションを設定したら、​「Slack の例」​セクションを参照して Slack Connector をお試しください。