次の方法で共有

カスタム Dataverse ロジックのバイパス

  • [アーティクル]

Dataverse でカスタム ビジネス ロジックを適用することなくデータ操作を実行したい場合があります。 これらのシナリオには、通常、多数のレコードが作成、更新、または削除される一括データ操作が含まれます。

ビジネス ロジックを呼び出さないように Dataverse に指示する方法がない場合は、ビジネス ロジックを含む個別のカスタム プラグインとワークフローを見つけて無効にする必要があります。 プラグインとワークフローを無効にすると、これらのプラグインとワークフローが無効になっている間、すべてのユーザーに対してロジックが無効になります。 また、適切なプラグインとワークフローのみを無効にし、完了したら忘れずに再度有効にする必要もあります。

この手動プロセスの代わりに、クライアント アプリケーションまたはプラグインの開発者は、リクエストに特別な オプション パラメーター を渡して、次の表に示すように 2 種類のカスタム ビジネス ロジックを制御できます。

ロジックの種類 いつバイパスするか
同期ロジック 一括データ操作をできる限り迅速に完了できるようにする。 変更するデータが組織の要件を満たしていることがわかっている場合、または他の手段でこのロジックを実現する計画がある場合は、同期ロジックをバイパスします。 すべてのカスタム同期ロジックをバイパスして、各操作がより速く完了し、一括操作の合計時間を短縮できるようにします。
非同期のロジック 非同期ロジックを処理するために作成されたシステム ジョブが多数あると、Dataverse 内でバックアップが発生し、パフォーマンスに影響する可能性があります。 一括操作の実行中に非同期ロジックをトリガーしないことで、このパフォーマンスの問題を軽減できます。

注意

Power Automate フローは、個別に管理できる別の種類の非同期ロジックを表します。 詳細情報: Power Automate フローをバイパスする

オプション パラメーター

Dataverseで実行されるビジネス ロジックを制御するには、次のオプション パラメータを使用します:

オプション パラメーター プロパティ
BypassBusinessLogicExecution CustomSync、CustomAsync、または CustomSync,CustomAsync の値をこのオプション パラメーターに渡すと、同期ロジック、非同期ロジック、またはその両方をバイパスします。
BypassBusinessLogicExecutionStepIds プラグイン ステップ登録のコンマ区切りリストを渡すと、指定されたプラグイン ステップのみをバイパスします。
BypassCustomPluginExecution 同期ロジックのみをバイパスします。 このオプション パラメータはサポートされていますが、推奨されません。 同じ結果を得るには、BypassBusinessLogicExecution を CustomSync 値と共に使用します。

BypassBusinessLogicExecution

BypassBusinessLogicExecution オプション パラメーターは、同期ロジック、非同期ロジック、またはその両方をバイパスするかどうかを選択できることを除いて、BypassCustomPluginExecution オプション パラメーターと同様に機能します。

この オプション パラメーター は、組織に適用されているカスタム ビジネス ロジックを対象としています。 カスタム ビジネス ロジックをバイパスする要求を送信すると、以下を除くすべてのカスタム プラグインとワークフローが無効になります:

  • コア Microsoft Dataverse システムの一部であるプラグイン、またはマイクロソフトが発行元であるソリューションの一部であるプラグイン。
  • Microsoft が発行者であるソリューションに含まれるワークフロー。

システム プラグインは、特定のエンティティのコア動作を定義します。 これらのプラグインがないと、データの不整合が発生し、簡単に修正できない場合があります。

Microsoft Dynamics 365 Customer Service や Dynamics 365 Sales Solutions などの Dataverse を使用するマイクロソフトが提供するソリューションには、このオプションではバイパスできない重要なビジネス ロジックも含まれています。

重要

独自のビジネス ロジックを含む他の独立系ソフトウェア ベンダー (ISV) からソリューションを購入してインストールしたことがあるかもしれません。 これらのソリューションによって適用されるロジックはバイパスされます。 このオプションを使用する前に、これらの ISV に確認して、ソリューションが使用するデータでこのオプションを使用した場合にどのような影響があるかを理解する必要があります。

次の表は、BypassBusinessLogicExecution でパラメーター値を使用する場合について示しています。

パラメーター プロパティ
CustomSync 同期カスタム ロジックのみをバイパスします。
同期ロジックに必要な計算時間は、各データ操作を実行するために必要な合計時間になります。 このオプションを使用すると、操作を一括して完了するのに必要な時間を短縮できます。
CustomAsync Power Automate フローを除く、非同期カスタム ロジックのみをバイパスします。
Dataverse は、操作が完了した後に非同期ロジックを適用します。 多数の操作が非同期ロジックをトリガーすると、Dataverse はカスタム ロジックを処理するにはより多くのリソースを必要とし、このリソースの消費はパフォーマンスに影響をおよぼす可能性があります。 多数の操作が非同期ロジックをトリガーするときに発生する可能性のある一般的なパフォーマンスの問題を回避するには、このオプションを使用します。
CustomSync,CustomAsync Power Automate フローを除く、同期と非同期の両方のカスタム ロジックをバイパスします。

BypassBusinessLogicExecution オプション パラメータを使用するための条件

BypassBusinessLogicExecution オプション パラメータはどのように使用するのですか？

このオプションは、.NET 用 SDK または Web API のいずれかで使用できます。

次の例では、.NET 用 SDK CreateRequest クラス を使用して、新しいアカウント レコードを作成するときに、同期および非同期のカスタム ロジックの両方に BypassBusinessLogicExecution オプション パラメーター を設定します。

static void DemonstrateBypassBusinessLogicExecution(IOrganizationService service)
{
    Entity account = new("account");
    account["name"] = "Sample Account";

    CreateRequest request = new()
    {
        Target = account
    };
    request.Parameters.Add("BypassBusinessLogicExecution", "CustomSync,CustomAsync");
    service.Execute(request);
}

BypassBusinessLogicExecutionStepIds

BypassBusinessLogicExecutionStepIds オプションパラメータを使用すると、すべての同期および非同期カスタムロジッ クの代わりに、指定された登録済みプラグインステップをバイパスします。 このパラメーターで登録済みプラグイン ステップ登録の GUID 値を渡します。 渡されたステップ ID が指定した要求で実行されない場合、無視されます。

BypassBusinessLogicExecutionStepId オプションを使用するには?

このオプションは、.NET 用 SDK または Web API のいずれかで使用できます。

次の例では、CreateRequest クラス を使用して新しい取引先企業レコードを作成するときに、オプションの BypassBusinessLogicExecutionStepIds パラメーターを設定します。

static void DemonstrateBypassBusinessLogicExecutionStepIds(IOrganizationService service)
{
   Entity account = new("account");
   account["name"] = "Sample Account";

   CreateRequest request = new()
   {
         Target = account
   };
   request.Parameters.Add("BypassBusinessLogicExecutionStepIds", "45e0c603-0d0b-466e-a286-d7fc1cda8361,d5370603-e4b9-4b92-b765-5966492a4fd7");
   service.Execute(request);
}

バイパスするステップを特定する

プラグイン ステップ登録の GUID 値を見つける方法はいくつかあります。

プラグイン登録ツールを使用する

  1. 表示 メニューから、 エンティティ別に表示 を選択します。

  2. エンティティとメッセージを選択します

  3. ステップを選択します。

    詳細ペインの プロパティ タブに StepId が表示されます。 そこから値をコピーします。

    StepId 値を見つけるには、プラグイン登録ツールを使用します

プラグイン登録ツールについて

Web API を使用して環境のクエリを実行する

次のようなクエリを使用して、特定のテーブルとメッセージに設定されたプラグイン ステップ登録を取得します。 次の例では、テーブル論理名を使用して、account テーブルを指定します。 Create はメッセージの名前です。 これらの値を必要なテーブルとメッセージに置き換えます。

Request

GET [Organization URI]/api/data/v9.2/sdkmessagefilters?$select=sdkmessagefilterid
&$filter=primaryobjecttypecode eq 'account' 
and sdkmessageid/name eq 'Create'
&$expand=sdkmessagefilterid_sdkmessageprocessingstep($select=name;
$filter=statecode eq 0 
and customizationlevel eq 1 
and iscustomizable/Value eq true)
Accept: application/json   
OData-MaxVersion: 4.0   
OData-Version: 4.0

回答

応答で sdkmessageprocessingstepid 値を探します。 name 値を使用して、バイパスするプラグインを識別します。

この場合、1 つしかありません: 4ab978b0-1d77-ec11-8d21-000d3a554d57

{
   "@odata.context": "[Organization URI]/api/data/v9.2/$metadata#sdkmessagefilters(sdkmessagefilterid,sdkmessagefilterid_sdkmessageprocessingstep(name))",
   "value": [
      {
         "@odata.etag": "W/\"31434372\"",
         "sdkmessagefilterid": "c2c5bb1b-ea3e-db11-86a7-000a3a5473e8",
         "sdkmessagefilterid_sdkmessageprocessingstep": [
            {
               "@odata.etag": "W/\"115803276\"",
               "name": "BasicPlugin.FollowupPlugin: Create of account",
               "_sdkmessagefilterid_value": "c2c5bb1b-ea3e-db11-86a7-000a3a5473e8",
               "sdkmessageprocessingstepid": "4ab978b0-1d77-ec11-8d21-000d3a554d57"
            }
         ],
         "sdkmessagefilterid_sdkmessageprocessingstep@odata.nextLink": "[Organization URI]/api/data/v9.2/sdkmessagefilters(c2c5bb1b-ea3e-db11-86a7-000a3a5473e8)/sdkmessagefilterid_sdkmessageprocessingstep?$select=name&$filter=statecode%20eq%200%20and%20customizationlevel%20eq%201%20and%20iscustomizable/Value%20eq%20true"
      }
   ]
}

Web APIを使用したデータのクエリの詳細

FetchXml を使用して環境のクエリを実行する

次のようなクエリを使用して、特定のテーブルとメッセージに設定されたプラグイン ステップ登録を取得します。 次の例では、テーブル オブジェクト型コード を使用して、account テーブルを表す 1 を指定します。

注意

オブジェクト型コードが 10000 を超えるテーブルの場合、テーブルの作成時にこの値に増分値が割り当てられるため、値はすべての環境で同じにはなりません。

テーブルの論理名がわかっている場合は、Web API 要求を使用してオブジェクト型コードを取得できます。 この要求は、account テーブルのオブジェクト型コードである値 1 を返します。

GET [Organization URI]/api/data/v9.2/EntityDefinitions(LogicalName='account')/ObjectTypeCode/$value

Create はメッセージの名前です。 これらの値を必要なテーブルとメッセージに置き換えます。

この FetchXml クエリを使用して、BypassBusinessLogicExecutionStepIds オプション パラメーターで使用できる step.sdkmessageprocessingstepid 値を返します。

<fetch>
  <entity name='sdkmessagefilter'>
    <filter>
      <condition attribute='primaryobjecttypecode'
        operator='eq'
        value='1' />
    </filter>
    <link-entity name='sdkmessage'
      from='sdkmessageid'
      to='sdkmessageid'
      link-type='inner'
      alias='message'>
      <filter>
        <condition attribute='name'
          operator='eq'
          value='Create' />
      </filter>
    </link-entity>
    <link-entity name='sdkmessageprocessingstep'
      from='sdkmessagefilterid'
      to='sdkmessagefilterid'
      link-type='inner'
      alias='step'>
      <attribute name='name' />
      <filter>
        <condition attribute='statecode'
          operator='eq'
          value='0' />
        <condition attribute='customizationlevel'
          operator='eq'
          value='1' />
        <condition attribute='iscustomizable'
          operator='eq'
          value='1' />
      </filter>
    </link-entity>
  </entity>
</fetch>

FetchXml を使用したデータの取得について

ステップ数の制限

パラメーターのサイズが大きくなりすぎないように、渡すことができるステップ数のデフォルトの制限は 3 です。 制限は、組織テーブルの OrgDbOrgSettings 列 のデータを使用して制御されます。 BypassBusinessLogicExecutionStepIdsLimit 値を変更するには、Microsoft Dynamics CRM 用の OrgDBOrgSettings ツール または OrgDbOrgSettings アプリ を使用します。

この制限の推奨最大サイズは 10 ステップです。

BypassCustomPluginExecution

BypassCustomPluginExecution オプションのパラメータを使用して、カスタム同期ロジックをバイパスします。

注意

これは、ビジネス ロジックを制限できる最初のオプション パラメーターでした。 サポートは継続されますが、同じ結果を得るには、CustomSync 値で BypassBusinessLogicExecution を使用することをお勧めします。

このオプション パラメーターは、BypassBusinessLogicExecution と同じように使用します。ただし、別の特権 (prvBypassCustomPlugins) が必要となります

BypassCustomPluginExecution オプションを使用するには?

このオプションは、.NET 用 SDK または Web API のいずれかで使用できます。

.NET 用 SDK でこのオプション パラメータを使用するには 2 つの方法があります。

値をオプションのパラメータとして設定します

次の例では、CreateRequest クラス を使用して新しい取引先企業レコードを作成するときに、オプションの BypassCustomPluginExecution パラメーターを設定します。

static void DemonstrateBypassCustomPluginExecution(IOrganizationService service)
{
    Entity account = new("account");
    account["name"] = "Sample Account";

    CreateRequest request = new()
    {
        Target = account
    };
    request.Parameters.Add("BypassCustomPluginExecution", true);
    service.Execute(request);
}

プラグインで開始するデータ操作のこのメソッドは、通話ユーザーが prvBypassCustomPlugins 特権を持つ時に使用できます。

CrmServiceClient.BypassPluginExecution プロパティを設定します

次の例では、新しい取引先企業レコードを作成するときに CrmServiceClient.BypassPluginExecution プロパティを設定します。

var service = new CrmServiceClient(connectionString);  

service.BypassPluginExecution = true;

var account = new Entity("account");
account["name"] = "Sample Account";

service.Create(account);

この設定はサービスに適用されるため、false に設定されるまで、サービスを使用して送信されるすべてのリクエストに対して設定されたままになります。

注意

このプロパティは、Dataverse.Client.ServiceClient では使用できませんが、 Dataverse.Client.Extensions.CRUDExtentions メソッド では使用できます。

必要な権限を別のロールに追加する

この記事で説明するオプションのパラメーターには、システム管理者のセキュリティ ロールにのみ追加される権限が必要です。 これらの権限は、セキュリティ ロール デザイナーで他のセキュリティ ロールに追加することはできません。 この権限を別のセキュリティ ロールに付与する必要がある場合は、API を使用する必要があります。 たとえば、システム カスタマイザー セキュリティ ロールを持つユーザーにこの権限を付与する場合があります。

別のセキュリティ ロールに権限を追加するには、権限の ID が必要です。

件名 ID オプション パラメーター
prvBypassCustomBusinessLogic 0ea552b0-a491-4470-9a1b-82068deccf66 BypassBusinessLogicExecution
BypassBusinessLogicExecutionStepIds
prvBypassCustomPlugins 148a9eaf-d0c4-4196-9852-c3a38e35f6a1 BypassCustomPluginExecution

これらの ID 値はすべての Dataverse 環境で同じです。

AddPrivilegesRoleRequest を使用して prvBypassCustomBusinessLogic 権限をセキュリティ ロールに関連付けます。

static void AddprvBypassCustomPluginsToRole(IOrganizationService service, Guid roleId)
{
    var request = new AddPrivilegesRoleRequest
    {
        RoleId = roleId,
        Privileges = new[]{
            new RolePrivilege{
                PrivilegeId = new Guid("0ea552b0-a491-4470-9a1b-82068deccf66"),
                Depth = PrivilegeDepth.Global
            }
        }
    };
    service.Execute(request);
}

ビジネス ロジックのバイパスに関するよくある質問 (FAQ)

以下は、同期ビジネス ロジックをバイパスするためのオプション パラメータの使用に関するよくある質問です。

これらのオプションのパラメータは、マイクロソフトのプラグインによるデータ操作のためにプラグインをバイパスしますか？

いいえ Microsoft ソリューションのプラグインまたはワークフローが、他のレコードに対して操作を実行する場合、それらの操作のロジックはバイパスされません。 特定の操作に適用されるプラグインまたはワークフローのみがバイパスされます。

プラグイン内で実行するデータ操作にこれらのオプション パラメーターを使用できますか?

ただし、必要な権限を持つユーザーのコンテキストでプラグインが実行されている場合に限ります。 プラグインの場合、OrganizationRequest クラス から派生したクラスのオプション パラメーターを設定します。 プラグインでは、CrmServiceClient クラスや ServiceClient クラスを使用することはできません。

参照

Power Automate フローをバイパスする
オプションのパラメーターを使用する

注意

ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。