Anypoint Studio を使用した DocuSign Connector 1.0 の設定 - Mule 4

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ソースの設定

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

  • 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]​ をクリックします。

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

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

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

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

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

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

コネクタを設定する場合、アプリケーション内のそのコネクタのすべてのインスタンスで使用できるグローバル要素を設定します。グローバル要素を設定するには、コネクタが対象の DocuSign システムにアクセスするために必要な認証ログイン情報を指定する必要があります。DocuSign Connector は、認証接続プロバイダー (暗黙的許可) による認証と、OAuth 接続プロバイダー (認証コード許可) による認証をサポートします。

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

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

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

  3. [General (一般)]​ タブの ​[Connection (接続)]​ で、設定する認証方式を選択します。

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

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

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

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

認証接続プロバイダー (暗黙的許可)

  1. [Global Element Properties (グローバル要素のプロパティ)]​ 画面の ​[General (一般)]​ タブで次の情報を入力し、認証接続プロバイダー (暗黙的許可) を設定します。

    項目 ユーザーアクション

    名前

    設定名。

    Base Uri (ベース URI)

    各インスタンスまたはテナントのパラメーターベース URI。

    Authorization (認証)

    接続種別の認証。

    次のスクリーンショットは、​[General (一般)]​ タブでの認証接続プロバイダー (暗黙的許可) の設定例を示しています。

    認証接続プロバイダー (暗黙的許可) 認証の [General (一般)] タブ
  2. [Advanced (詳細)]​ タブで、必要に応じて ​[Response timeout (応答タイムアウト)]​、​[Response timeout unit (応答タイムアウト単位)]​、​[Streaming type (ストリーミング種別)]​、​[Expiration policy (有効期限ポリシー)]​ の各項目の値を変更します。

    次のスクリーンショットは、​[Advanced (詳細)]​ タブでの認証接続プロバイダー (暗黙的許可) の設定例を示しています。

    認証接続プロバイダー (暗黙的許可) 認証の [Advanced (詳細)] タブ

OAuth 接続プロバイダー (認証コード許可)

OAuth 2.0 を使用して、ユーザーアカウントをホストするサービスにユーザー認証を委任します。詳細は、​「コネクタの OAuth 2.0 の設定」​または​「CloudHub でのコネクタの OAuth 2.0 の設定」​を参照してください。

  1. [Global Element Properties (グローバル要素のプロパティ)]​ 画面の ​[General (一般)]​ タブで次の情報を入力し、OAuth 接続プロバイダー (認証コード許可) を設定します。

    項目 ユーザーアクション

    名前

    設定名。

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

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

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

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

    Listener config (リスナー設定)

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

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

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

    Authorize path (認証パス)

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

    次のスクリーンショットは、​[General (一般)]​ タブでの OAuth 接続プロバイダー (認証コード許可) の設定例を示しています。

    OAuth 接続プロバイダー (認証コード許可) 認証の [General (一般)] タブ
  2. [Advanced (詳細)]​ タブで、必要に応じて ​[Response timeout (応答タイムアウト)]​、​[Response timeout unit (応答タイムアウト単位)]​、​[Streaming type (ストリーミング種別)]​、​[Expiration policy (有効期限ポリシー)]​ の各項目の値を変更します。

    次のスクリーンショットは、​[Advanced (詳細)]​ タブでの OAuth 接続プロバイダー (認証コード許可) の設定例を示しています。

    OAuth 接続プロバイダー (認証コード許可) 認証の [Advanced (詳細)] タブ

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

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

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

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

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

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

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