非同期サービス

[アーティクル]
03/30/2022

注意

エンティティとテーブルの違いがわかりませんか？ Microsoft Dataverse で「開発者: 用語を理解する」を参照してください。

非同期サービスは、Microsoft Dataverse のメインのコア操作から独立して長時間の操作を実行します。そのため、システム全体のパフォーマンスとスケーラビリティが向上します。非同期サービスの機能として、非同期の登録プラグイン、ワークフロー、および大容量メール、一括インポート、キャンペーン活動の伝達などの非同期の操作を実行するための管理された先入先出 (FIFO) キューがあります。これらの操作は非同期サービスに登録され、サービスによってキューが処理されるときに定期的に実行されます。

イベントが発生し、すべての同期拡張機能が処理された後、プラットフォームは非同期エクステンションのコンテキストをシリアル化し、AsyncOperation テーブルの システムジョブ としてデータベースに保存します。システムジョブは非同期操作の実行を定義および追跡します。リソースが利用可能になると、システムジョブが処理され、定義する操作が実行されます。拡張で定義された任意のデータ操作は、イベント実行パイプラインにより再度処理されますが、今回は同期操作として処理されます。

実行順序および依存関係

CreatedOn 日付を使用するキューとして、システムジョブは評価されます。実行を遅らせる条件がない場合、リソースが利用可能になるとすぐに実行されます。異なるタイプの操作には異なるリソースが必要となるため、CreatedOn 日付で設定された順序で実行されることは保証されていません。

システムジョブは別のシステムジョブに依存するため、他のシステムジョブが完了した後にのみ開始されます。この依存関係は、DependencyToken列の値によって確立されます。システムジョブが作成されると、依存関係が確立されます。 DependencyToken 値が null の場合、システムジョブには依存関係がありません。依存しているシステムジョブには同じ DependencyToken 値があり、作成された順序で実行されます。システムジョブが延期された場合、それ以降のすべての依存システムジョブは延期されたシステムジョブが実行されるまで待機し続けます。

注意

依存関係システムのシステムジョブはシステムによって作成されるため、この依存関係システムは非同期で実行するように登録されたプラグインでは使用できません。

システムジョブの管理

次の操作を実行して、AsyncOperation テーブルを使用してシステムジョブを管理できます。

システムジョブの取得
システムジョブの削除
システムジョブ状態の管理
システムジョブの延期

注意

コードでのシステムジョブの作成はサポートされていません。 AsyncOperation テーブルでは、書き込み可能な複数のカラムと create 操作がサポートされていますが、update では以下のカラムのみがサポートされています :

システムジョブの取得

設定 > システム > システムジョブ の順に移動してアプリケーションのシステムジョブを表示でき、高度な検索を使用して検索もできます。

コードを使用すると、他のテーブルと同じようにシステムジョブを取得できます。次の表は、システムのジョブを理解する上で重要な列の一覧です :

Column	説明
`AsyncOperationId`	システムジョブを表す一意識別子です。
`CompletedOn`	システムジョブが完了した日時です。
`CreatedBy`	システムジョブを作成したユーザーを表す一意識別子です。
`CreatedOn`	システムジョブが作成された日時です。
`Data`	システムジョブに関連付けられている構造化されていないデータです。
`DependencyToken`	同じ依存関係トークンを持つすべての操作の実行がシリアル化されます。詳細: 実行順序および依存関係
`Depth`	最初の呼び出し以降の SDK 呼び出しの数です。
`ErrorCode`	取り消したシステムジョブから返されたエラーコードです。
`ExecutionTimeSpan`	システムジョブの実行にかかった時間です。
`FriendlyMessage`	システムジョブによって提供されるメッセージです。
`IsWaitingForEvent`	システムジョブがイベントの待機中であることを示します。
`Message`	システムジョブに関連するメッセージです。
`MessageName`	このシステムジョブを開始したメッセージの名前です。
`ModifiedBy`	システムジョブを最後に修正したユーザーを表す一意の識別子です。
`ModifiedOn`	システムジョブが最後に修正された日時です。
`Name`	システムジョブの名前です。
`OperationType`	システムジョブの種類です。詳細: 操作の種類
`OwnerId`	システムジョブを所有するユーザーまたはチームを表す一意識別子です。
`OwningBusinessUnit`	システムジョブを所有する部署を表す一意の識別子です。
`OwningExtensionId`	システムジョブが関連付けられている所有する拡張を表す一意識別子です。
`OwningTeam`	レコードを所有するチームを表す一意識別子です。
`OwningUser`	レコードを所有するユーザーを表す一意識別子です。
`PostponeUntil`	システムジョブの実行時期を、指定された日時の後のみに制限するかどうかを表します。詳細: システムジョブの延期
`PrimaryEntityType`	システムジョブが主に関連付けられているテーブルの種類です。
`RecurrencePattern`	システムジョブの定期的なアイテムのパターンです。詳細: 定期的なアイテムの開始時刻とパターン
`RecurrenceStartTime`	定期的なアイテムのパターンの開始時間 (UTC) です。詳細: 定期的なアイテムの開始時刻とパターン
`RegardingObjectId`	システムジョブが関連付けられているオブジェクトを表す一意の識別子です。
`RetryCount`	システムジョブの再試行回数です。
`Sequence`	操作が提出された順序です。
`StartedOn`	システムジョブが開始された日時です。
`StateCode`	システムジョブの状態です。詳細: システムジョブ状態の管理
`StatusCode`	システムジョブの状態の理由です。詳細: システムジョブ状態の管理
`UTCConversionTimeZoneCode`	レコードが作成されたときに使用中だったタイムゾーンコードです。
`WorkflowStageName`	ワークフロー段階の名前です。

例

システムジョブデータを取得する次の例を使用できます。

Web API

次の Web API クエリを使用して、上記の表の列を取得します。詳細: Web API を使用するクエリデータ

<organization URL>/api/data/v9.0/asyncoperations?
$select=
asyncoperationid,
completedon,
createdon,
data,
dependencytoken,
depth,
errorcode,
executiontimespan,
friendlymessage,
iswaitingforevent,
message,
messagename,
modifiedon,
name,
operationtype,
_ownerid_value,
postponeuntil,
primaryentitytype,
recurrencepattern,
recurrencestarttime,
_regardingobjectid_value,
retrycount,
sequence,
startedon,
statecode,
utcconversiontimezonecode,
workflowstagename
&$expand=
createdby($select=fullname),
modifiedby($select=fullname),
owningbusinessunit($select=name),
owningextensionid($select=name),
owningteam($select=name),
owninguser($select=fullname)

注意

Web API では、システムジョブをサポートするテーブルごとに単一値のナビゲーションプロパティがあります。このナビゲーションプロパティの名前は、パターン regardingobjectid_<table logical name> に従います。

FetchXml

次の FetchXML を使用して、上記の表の列を取得します。詳細: FetchXML の使用によるクエリの作成

<fetch>
  <entity name="asyncoperation" >
    <attribute name="asyncoperationid" />
    <attribute name="completedon" />
    <attribute name="createdby" />
    <attribute name="createdon" />
    <attribute name="data" />
    <attribute name="dependencytoken" />
    <attribute name="depth" />
    <attribute name="errorcode" />
    <attribute name="executiontimespan" />
    <attribute name="friendlymessage" />
    <attribute name="iswaitingforevent" />
    <attribute name="message" />
    <attribute name="messagename" />
    <attribute name="modifiedby" />
    <attribute name="modifiedon" />
    <attribute name="name" />
    <attribute name="operationtype" />
    <attribute name="ownerid" />
    <attribute name="owningbusinessunit" />
    <attribute name="owningextensionid" />
    <attribute name="owningteam" />
    <attribute name="owninguser" />
    <attribute name="postponeuntil" />
    <attribute name="primaryentitytype" />
    <attribute name="recurrencepattern" />
    <attribute name="recurrencestarttime" />
    <attribute name="regardingobjectid" />
    <attribute name="retrycount" />
    <attribute name="sequence" />
    <attribute name="startedon" />
    <attribute name="statecode" />
    <attribute name="utcconversiontimezonecode" />
    <attribute name="workflowstagename" />
  </entity>
</fetch>

注意

システムジョブをサポートするすべてのテーブルは、RegardingObjectId ルックアップカラムを介して AsyncOperation テーブルとの多対一の関係がリストアップされています。この関係の名前は、パターン <table schema name>_AsyncOperations に従います。

操作の種類

OperationType 列には、システムジョブのカテゴリが記載されています。これらの種類の多くは、メンテナンス作業を実行するためのプラットフォームによって開始されます。

注意

プラットフォームによりで生成されるシステムジョブで、操作のキャンセル、一時停止、または再開を実行することはできません。

これらのプラットフォーム生成ジョブの種類の一部は、次の表に含まれています。

OperationType 値	OperationType ラベル
9	SQM データ収集
16	組織統計の収集
18	組織の記憶域サイズの計算
19	組織のデータベース統計の収集
20	組織規模統計の収集
22	組織の最大記憶域サイズの計算
24	統計の更新間隔
25	組織のフルテキストカタログインデックス
27	契約の状態の更新
31	記憶域制限の通知

定期実行の開始時刻とパターン

定期実行のシステムジョブには、開始時期および頻度に関する情報が必要です。これらの値は、AsyncOperationテーブル、RecurrenceStartTime および RecurrencePattern 列に保存されます。

AsyncOperation テーブルをコードで直接作成するわけではないので、データを照会する際には、これらの値を解釈する必要があります。新しいシステムジョブを作成するメッセージを使用して、間接的にこれらのプロパティのみを設定します。 BulkDelete および BulkDeleteDuplicates メッセージの両方には、対応する Web API アクションまたは組織サービス要求クラスのパラメータまたはプロパティが含まれます。詳細: BulkDetectDuplicatesRequest クラス、BulkDetectDuplicates Action、BulkDeleteRequest クラス、および BulkDelete Action

RecurrenceStartTime は、単にシステムジョブがいつ開始されるべきかを示す日時の値です。それが設定されていない場合、システムジョブはすぐに開始すると想定されます。

RecurrencePattern 列には、定期的に発生するシステムジョブの頻度に関する情報が格納されています。この値は、新しい非同期操作テーブルを作成する際に、プラットフォームが設定する場合があります。この値を設定してパターンを変更することができます。

この列の値は、 RFC2445 インターネット標準 (Internet Calendaring and Scheduling Core Object Specification) の一部を使用しています。

以下の表で、例を示します。

定期的なパターン	ジョブ実行の頻度
`FREQ=MONTHLY;`	1 か月に 1 回
`FREQ=WEEKLY;`	1 週間に 1 回
`FREQ=DAILY;`	1 日に 1 回
`FREQ=DAILY;INTERVAL=3;`	3 日ごと
`FREQ=HOURLY;`	1 時間に 1 回

INTERVAL 値が設定されていない場合、1 として解釈されます。

システムジョブの削除

システムジョブの削除は、必要な権限を持っている場合は、他のテーブルと同様にアプリケーションやコード上で行うことができます。

注意

非同期プラグインを登録する場合、成功した操作を自動的に削除するオプションがあります。そのオプションを使用することをお勧めします。詳細: プラグインを記述する

一般的な方法は、成功したジョブを削除する定期的な一括削除ジョブを作成することです。詳細: 大容量の特定の対象データを一括削除で削除する

システムジョブ状態の管理

システムジョブの状態は、操作が完了するまで何度か変更されます。以下は使用可能な状態およびステータス値を表す StateCode および StatusCode オプションです。

StateCode 値	StateCode ラベル	StatusCode 値	StatusCode ラベル
`0`	準備完了	`0`	リソースの待機中
`1`	中止	`10`	待機中
`2`	Locked	`20`	処理中
`2`	Locked	`21`	一時停止の処理中
`2`	Locked	`22`	取り消し中
`3`	完了	`30`	成功
`3`	完了	`31`	失敗
`3`	完了	`32`	キャンセル

設定 > システム > システムジョブ の順に移動して、および その他の操作 メニューで利用可能なコマンドを使用して、アプリケーションのシステムジョブの状態を表示できます。

アプリケーションのシステムジョブに対して使用可能なアクションコマンド。

注意

この UI 経由で実行できる任意のアクションは、コードを使用して実行することもできます。プラットフォームによりで生成されるシステムジョブで、操作のキャンセル、一時停止、または再開を実行することはできません。詳細: 操作の種類

ビューを管理するオプションと共に、システムジョブを管理するための次のオプションが利用できます。

回答内容	内容
Delete キー	コントロール ID およびカスタムアクションの場所でビルドします。システムジョブを削除します
一括削除	その他の操作メニューを使用しています。条件を定義するウィザードを開き、一致するシステムジョブを削除する新しい一括削除システムジョブを作成します。
キャンセル	その他の操作メニューを使用しています。システムジョブをキャンセルします。
[再開]	その他の操作メニューを使用しています。一時停止したシステムジョブを再開します。
[後で再起動]	その他の操作メニューを使用しています。システムジョブのスケジュール変更
[一時停止]	その他の操作メニューを使用しています。システムジョブを一時停止します。

要求された操作が実行されるかどうかは、システムジョブの状態によって異なります。たとえば、すでに完了した、またはまだ開始していないジョブを一時停止することはできません。以下の表は、各変更の条件と、変更が選択されたときに何が起こるかを示しています。

オプション	有効な StateCode 値	変更
削除	指定なし	システムジョブを削除します
キャンセル	0 (準備完了) 1 (中止) 2 (ロック)	`StateCode` が 3 (完了済み) に変更され、`StatusCode` が 32 (キャンセル済み) に変更されました
[再開]	1 (中止)	StateCode が 0 (準備完了) に変更されました
[後で再起動]	0 (準備完了) 2 (ロック)	ジョブの延期ダイアログでは、ユーザーは日時の値に関してシステムジョブを延期するよう求められます。詳細: システムジョブの延期
[一時停止]	2 (ロック)	StateCode が 1 (中止) に変更されました

システムジョブの延期

PostPoneUntil カラムには、システムジョブの状態が 1 (一時停止) から 0 (準備完了) に変更する日時の値が含まれています。 StateCode 列、StatusCode 列と合わせて、AsyncOperation テーブルを使用する際に更新をサポートする唯一の列です。

非同期サービス

実行順序および依存関係

システムジョブの管理

システムジョブの取得

例

Web API

FetchXml

操作の種類

定期実行の開始時刻とパターン

システムジョブの削除

システムジョブ状態の管理

システムジョブの延期

関連項目

フィードバック

非同期サービス

実行順序および依存関係

システム ジョブの管理

システム ジョブの取得

例

Web API

FetchXml

操作の種類

定期実行の開始時刻とパターン

システム ジョブの削除

システム ジョブ状態の管理

システム ジョブの延期

関連項目

フィードバック

システムジョブの管理

システムジョブの取得

システムジョブの削除

システムジョブ状態の管理

システムジョブの延期