Microsoft Dynamics アプリケーション スコープ

UiPath.MicrosoftDynamics.Activities.MicrosoftDynamicsScopeActivity

Microsoft Dynamics 365 アクティビティは、Common Data Service で OAuth プロトコルを使用して、UiPath と Dynamics 365 アプリケーションの間に認証済み接続を確立します。この接続では、ロボットが Web API を呼び出して、ユーザーの代わりにリソースにアクセスできるようになります。

認証を有効化するには、Azure Active Directory (AAD) を使用して Dynamics 365 アプリケーションをアカウント テナントに登録します。アプリケーションを登録すると、アプリケーション (クライアント) ID が生成され、他の識別子とともに、インスタンスへの認証済み接続を確立するために使用されます。詳しくは「セットアップ」をご覧ください。オートメーション プロジェクトをはじめて構築する前にもこちらのページをご覧ください。

アプリケーションの登録が完了したら、使用する認証の種類 ([認証の種類]) を選択し、アプリケーション (クライアント) ID ([クライアント ID])、Dynamics 365 アプリケーションのエンドポイント ([エンドポイント URL])、ディレクトリ (テナント) ID ([テナント ID])、および選択した認証の種類に応じてクライアント シークレット ([クライアント シークレット]) を入力します。

動作のしくみ

以下の手順とメッセージ シーケンス ダイアグラムは、設計時 (つまり、アクティビティの依存関係と入/出力プロパティ) から実行時に至るまでの、アクティビティの動作のしくみの例を示したものです。

1. 「セットアップ」の手順を完了します。

2. [認証の種類] が ClientCredentials の場合、アクティビティを追加します。それ以外の場合は、追加不要です。

   • 詳細については、このガイドの「資格情報管理」をご覧ください。
3. プロジェクトに [Microsoft Dynamics アプリケーション スコープ] アクティビティを追加します。
4. [接続] 入力プロパティの値を入力します。
5. [出力] プロパティの MicrosoftDynamicsConnection 変数を作成し、入力します。

   • この変数は、後続の [ Microsoft Dynamics アプリケーション スコープ] アクティビティで使用できます。

     
     

     

     
     

アクティビティの本体

プロジェクトをビルドし、他のアクティビティでオブジェクト ウィザードを有効化するには、[設定] ボタンをクリックして接続ウィザードを使用する必要があります。

接続ウィザードの詳細については、「ビジネス アクティビティ フレームワーク」のページをご覧ください。

注: 接続ウィザードのフィールドを設定しても、[Microsoft Dynamics アプリケーション スコープ] のプロパティは設定されません。ウィザードは、設計時にのみ Microsoft Dynamics 365 アプリケーションへの接続を確立します。他の Microsoft Dynamics 365 アクティビティで オブジェクト ウィザード を有効化します。

プロパティ

共通

• 表示名 - アクティビティの表示名です。 このフィールドでは Strings 型または String 型変数のみがサポートされます。

コネクション

• 認証の種類 - Dynamics 365 アプリケーションへの接続に使用する認証の種類です。ドロップダウン リストから項目を選択します。次の 2 つのオプションがあります。

  • PasswordCredentials - このオプションを選択すると、Dynamics 365 アカウントのパスワードを入力するための ([プロンプト] プロパティで選択したオプションに応じた) ユーザー プロンプトを使用して認証が行われます。このオプションは、有人オートメーションに対してのみ使用できます。
  • ClientCredentials - このオプションを選択すると、クライアント シークレットを使用して認証が行われます。このオプションは、有人オートメーションと無人オートメーションの両方で使用できます。クライアント資格情報の詳細については、Microsoft ドキュメントの「クライアント シークレット & 証明書の使用」をご覧ください。
• クライアント ID - 登録アプリケーションに割り当てられた自動生成のアプリケーション (クライアント) ID です。このフィールドでは String 型の変数のみがサポートされています。
  • クライアント ID は、Azure Active Directory (AAD) を使用してアプリケーションを登録するときに生成されます。詳細については、「セットアップ」ガイドの「アプリケーションを登録する」のセクションをご覧ください。
  • [認証の種類] の値が ClientCredentials の場合、[クライアント ID] は [クライアント シークレット] に関連付けられます。こうした関係があることから、このプロパティの String 変数は、「セットアップ」ガイドの「資格情報アセットを作成する」セクションの手順に従って作成することをお勧めします。
  • このプロパティの String 変数を作成および入力するには、[資格情報を取得] アクティビティを使用して資格情報アセットを出力します (以下の例を参照)。
• ClientSecret - ServiceNow インスタンスの ([ユーザー名] に関連付けられた) パスワードです。SecureString 型変数を入力します。
  • クライアント シークレット は、Azure Active Directory (AAD) を使用してアプリケーションを登録するときに生成できます。詳細については、「セットアップ」ガイドの「クライアント シークレットを作成する」のセクションをご覧ください。
  • SecureString 変数を作成するには、「セットアップ」ガイドの「資格情報アセットを作成する」のセクションをご覧ください。
  • SecureString 変数を入力するには、資格情報アセットを出力する [資格情報を取得] アクティビティを使用します (以下の例を参照)。
• エンドポイント URL - 接続先の CRM インスタンスの URL です。このフィールドでは Strings 型または String 型変数のみがサポートされます。

• プロンプト - PasswordCredentials 認証の場合のパスワード プロンプトの動作を指定します。ドロップダウン リストから項目を選択します。以下の 3 つのオプションがあります。

  • 自動 - 資格情報が必要な場合にのみプロンプトを表示します。
  • SelectAccount - ユーザーにアカウントを選択し、続いてその資格情報を入力するように指示するプロンプトを表示します (複数のアカウントが存在する場合に使用します)。
  • 常時 - アクティビティを実行するたびにプロンプトを表示します (キャッシュ内にトークンが存在する場合も表示します)。
• テナント ID - Azure Active Directory (AAD) テナントに割り当てられたディレクトリ (テナント) ID です。このフィールドでは Strings 型または String 型変数のみがサポートされます。

既存の接続

• 既存の Microsoft Dynamics 接続 - 親の [Microsoft Dynamics アプリケーション スコープ] アクティビティから取得した接続レコードです。新しい接続を確立する代わりに使用できます。MicrosoftDynamicsConnection 型変数を入力します。
  • MicrosoftDynamicsConnection 変数には、以前に実行されて、まだアクティブな接続を維持している [Microsoft Dynamics アプリケーション スコープ] アクティビティ (親) のものを使用する必要があります。
  • このプロパティを使用して接続を確立できない場合は、親の [Microsoft Dynamics アプリケーション スコープ] アクティビティを再実行してみてください。

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

オプション

• API エラーを例外として報告 - 選択すると、このアプリケーション スコープを使用するすべての子アクティビティにより API エラー応答がビジネス アクティビティ実行例外として報告されます。選択しないと、子アクティビティは API エラー メッセージを [応答ステータス] 出力プロパティに追加し、ワークフローの実行を続行します。ワークフローが正常に実行されたかどうかを確認するには [応答ステータス] プロパティを確認します。

出力

• Microsoft Dynamics 接続 - このスコープ アクティビティに含まれる、他の [Microsoft Dynamics アプリケーション スコープ] アクティビティで使用できる、確立済み接続のレコードです。MicrosoftDynamicsConnection 型変数を入力します。この変数は、親スコープ アクティビティ内から呼び出される、ワークフロー内のスコープ アクティビティに渡すことができます。
  • たとえば、3 つのワークフローを使用するとします。最初のワークフローには、登録アプリケーションへの接続を確立する親スコープ アクティビティ (つまり親ワークフロー) が含まれます。第 2 のワークフローは新しい連絡先レコードを作成し、第 3 のワークフローは新しいアカウント レコードを作成します。いずれも親スコープ アクティビティに含まれています。
  • ワークフローを実行すると、親スコープ アクティビティは、第 2、第 3 のワークフローの [既存の Microsoft Dynamics 接続] プロパティに、MicrosoftDynamicsConnection 変数を渡します (下の図を参照)。
    
    

    

    
    

例

次の画像は、アクティビティの依存関係と入力/出力プロパティの値の例です。