キューおよびトランザクションについて

キューとは、無制限にアイテムを保持できる収納機能です。キュー アイテムには、インボイスの情報や顧客情報などさまざまな種類のデータを格納できます。この情報は、例として SAP や Salesforce などの他のシステムで処理することもできます。

キュー アイテムに格納され、キュー アイテムから出力されるデータは、既定では自由形式です。他のアプリケーションとの連携、マシン生成フォームの処理、分析など、特定のスキーマが必要な状況では、カスタム JSON スキーマをアップロードして、すべてのキュー アイテム データが適切な形式になっていることを確認できます。

Orchestrator で新規に作成されるキューは、既定では中身は空です。キューへのアイテムの設定を行う場合は、Orchestrator のアップロード機能または Studio アクティビティを使用することができます。Studio アクティビティを使用すると、アイテムのステータスを変更したり、アイテムを処理したりすることもできます。キュー アイテムが処理されると、それらのアイテムはトランザクションになります。

キューの概要

キューでは、複雑なロジックによって明示される大型のオートメーション プロジェクトを作成できます。たとえば、すべての請求書情報を収集して、各データを格納するキュー アイテムを作るプロセスを作成できます。続いて、Orchestrator からその情報を収集し、それを使用して追加のタスク (別のアプリケーションで請求書の支払いをする、支払期日または値にもとづいて支払いを延期する、請求書の支払いが行われるたびに会計チームにメールを送信するなど) を実行する別のプロセスを作成できます。

[キュー] ページでは、新しいキューを作成したり、以前に作成したキューを表示したり、グラフにアクセスして、トランザクション ステータスの経時的な進行状況やその他のさまざまな詳細 (平均実行時間、成功したトランザクションの総数など) を確認したりできます。

キュー グリッドで利用可能なデータは定期的に更新されます。つまり、必ずしもリアルタイムに表示されるとは限らず、わずかな遅延が発生する可能性があります。さらに、アイテム保持ポリシーの影響も受けないため、データベースの項目をアーカイブしても、グリッドに表示される情報は変更されません。

アイテム ステータスは、オートメーション プロジェクトを作成する際に RPA 開発者が管理します。それに対して、リビジョン ステータスは Orchestrator により管理され、バージョン管理を可能にしますが、アプリケーションまたはビジネス例外により破棄された、または失敗したキュー アイテムのみが対象となります。

失敗または破棄されたアイテムもレビュー担当者に割り当てることができます。レビュー担当者は、それらのアイテムを必要に応じて変更またはクリアできます。こうした変更はそれぞれ、[監査の詳細] ウィンドウの [履歴] タブで追跡されます。レビュー担当者は、割り当てられたトランザクションの現在のステータスの評価とレビュー ステータスの変更を担当します。リビジョン前のキュー アイテムのステータスは、[レビュー リクエスト] ページで変更できます。

重要: キュー アイテムを正常に処理するため、参照によってキューから削除する場合は、キュー レベルで一意の参照が設定されている必要があります。参照を一意に保たないと、同時アクセスの問題が発生します。たとえば、トランザクション データが見つからないことによるエラー (「No Transaction Data」というエラー メッセージ) が発生します。

参照を一意にすることができない場合は、参照を使用せずにキューから削除することをお勧めします。

スキーマ定義

キューを作成または編集する場合、特定データ、出力データ、分析データのカスタム JSON スキーマをアップロードできます。スキーマを配置すると、すべてのトランザクションが指定された形式に対して検証され、結果のデータがそのアイテムに適合しない場合、ビジネス例外で失敗します。

重要:

• スキーマは、既存のトランザクションに遡及的に適用されるのではなく、スキーマをアップロードした後に実行されるトランザクションにのみ適用されます。
• スキーマには、配列を含めることはできません。
• 検証のために、DateTime は string 型として受け入れられます。
• 分析データスキーマの使用と検証には、バージョン 19.10 以降のロボットとアクティビティが必要です。
• アップロードしたスキーマに有効な URI スキーマ定義がない場合、以下の例に示すように、draft-07 がフォールバックとして使用されます。

注:

To achieve better control in terms of Orchestrator performance, the Specific Data size of queue items is limited to 1 MB with the help of the Queue.MaxSpecificDataSizeInKiloBytes app setting. Anything beyond this limit cannot be added to a queue, and it returns the 403 - Payload Too Large error code. If you need to upload larger items, store the large data in an external storage and only reference the link in the item.

サンプル スキーマ:

{
  "definitions": {},
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://example.com/root.json",
  "type": "object",
  "title": "The Root Schema",
  "additionalProperties": { "type": "string" },
  "required": [
    "stringTest",
    "intTest",
    "boolTest"
  ],
  "properties": {
    "stringTest": {
      "$id": "#/properties/stringTest",
      "type": "string",
      "title": "The Stringtest Schema",
      "default": "",
      "examples": [
        "stringTest"
      ],
      "pattern": "^(.*)$"
    },
    "intTest": {
      "$id": "#/properties/intTest",
      "type": "integer",
      "title": "The Inttest Schema",
      "default": 0,
      "examples": [
        30
      ]
    },
    "boolTest": {
      "$id": "#/properties/boolTest",
      "type": "boolean",
      "title": "The Booltest Schema",
      "default": false,
      "examples": [
        false
      ]
    }
  }
}

トランザクションの概要

[トランザクション] ページでは、対象のキューのトランザクションを表示します。また、そのステータスや処理日、処理を実行するロボット、また、例外および参照情報がある場合は、その種類も表示されます。

特定のトランザクションまたはそのグループを独自の参照に基づいて検索できます。独自の参照は、[キュー アイテムを追加] アクティビティと [トランザクション アイテムを追加] アクティビティの [参照] プロパティで追加されます。参照を使用して、オートメーション プロジェクト内で使用されている他のアプリケーションにトランザクションをリンクすることができます。さらにこの機能を使用することで、Orchestrator 内で指定された独自の参照に基づいて特定のトランザクションを検索できます。

トランザクション参照をキュー レベルで一意とするようにすることもできます。この機能はキュー作成時に有効となり、削除またはリトライされたものを除き、すべてのトランザクションに適用されます。この設定により特定のアイテムの識別が容易になり、またレビュープロセスが簡素化されます。

キューへのアイテムの追加時に重複参照が発生した場合には、ジョブは [エラー] ステータスで失敗し、Execution error: UiPath.Core.Activities.OrchestratorHttpException: Error creating Transaction. Duplicate Reference. というエラー メッセージが [ジョブの詳細] ウィンドウに表示されます。

キュー アイテムに格納されている情報が、Orchestrator の [トランザクション詳細] ウィンドウの [詳細] タブの [固有データ] に表示されます。さらに、アイテムが失敗してリトライされた場合は、アイテムの履歴が同じウィンドウに表示されます。

目的のトランザクションに対応する行を選択すると、トランザクションの詳細を表示できます。最初はサイド パネルとしてレンダリングされ、サイズを変更したり、フルサイズのウィンドウに拡張したりすることができます。階層リンクにトランザクションの参照があります。

トランザクションの詳細ウィンドウには 3 つのタブが含まれます。

• 詳細 - トランザクションに追加された正確な情報、およびトランザクションのステータス履歴、リトライ回数を確認できます。このタブのフィールドのデータ制限は次のとおりです。
  • 固有データ - 1 MB
  • 出力データ - 1 MB
  • 分析データ - 1 MB
  • 例外の理由 - 524,288 文字
  • 例外の詳細 - 524,288 文字
  • 進行状況 - 1,048,576 文字
• [コメント] タブ - 特定のトランザクションに関する情報をチーム メンバーと共有する必要がある場合に、トランザクション関連のコメントを表示したり追加したりできます。キューおよびトランザクションに関する[表示]、[編集]、[削除] 権限を持つすべてのユーザーは、権限に応じてコメントの追加、編集、削除を実行できますが、変更を加えることができるのは自分のコメントのみです。
• [履歴] - 実行されたアクションとその実行者、レビュー担当者、および現在のレビュー ステータスを確認できます。

処理順序

任意のキュー内で、トランザクションは次の順序に従って階層的に処理されます。

1. 次のように処理期限のあるアイテム。
   • [優先度] の順序と
   • [優先度] が同じアイテムについては、設定された [処理期限] に従います。
2. 処理期限のないアイテムは [優先度] の順序。
   • [優先度] が同じアイテムについては、先入れ先出しのルール

処理期限および延期の日付を設定するには、それぞれのフィールドに相対的な日時を入力することが推奨されます。たとえば、DateTime.Now.AddHours(2)、DateTime.Now.AddDays(10)、DateTime.Now.Add(New System.TimeSpan(5, 0, 0, 0)) です。また、米国表記を使用して、10/10/2019 07:40:00 などの正確な時刻を追加することができます。この日付は自動的に修正することができます。たとえば、12 10 2019 9:0 と記述すると、自動的に 12/10/2019 09:00:00 に変換されます。

処理期限は、同じ優先順位のタスクを並べ替える場合に便利です。一方延期では、指定した時刻より前にタスクが開始されないようにします。ただし、この 2 つのパラメーターは一緒に使用するようには設計されていません。

Studio で [処理期限] および [延期] フィールドに追加された日付は、Orchestrator の [トランザクション] ページの [処理期限] および [延期]列の下に表示されます。

トランザクションをエクスポートする

[トランザクション] ページの [エクスポート] ボタンを選択すれば、指定のキューに関連するすべてのトランザクションや情報を .csv ファイルにエクスポートできます。ページの絞り込みオプションはすべて、生成されたファイルにも適用されます。

図 1. CSV ファイル

最高のパフォーマンスを得るためにエクスポートされたエントリは日付の新しい順に並んでいないため、注意が必要です。

キュー SLA の予測

このツールを使用すると、キューに新しく追加されたアイテムに SLA (アイテム期限) を設定できます。これにより、追加されたアイテムをタイムリーに処理できるかどうか、および SLA に違反しないように割り当てる必要があるリソースを評価できます。SLA が満たされない危険性がある場合は、適切に通知され、それに応じて調整を行うことができます。

SLA は、期限が設定されていないアイテムにのみ適用されます。つまり、期限が事前に定義されていない新しいアイテムは、SLA として設定された値が自動的に適用されたうえでキューに追加されます。具体的には、アイテムがキューに追加された瞬間から、そのキューに対して SLA で設定された値がそれぞれのアイテムの期限として適用されます。たとえば、SLA を 2 時間に設定し、午後 4 時、5 時、および 6 時に 3 つのアイテムをキューに追加すると、アイテムの期限はそれぞれ午後 6 時、7 時、8 時になります。

SLA 違反アラートは、毎時 7 分から 30 分ごとにトリガーされます。

The cron expression which dictates this interval is configurable via the SystemJobs.QueueSlaAlerting.Cron parameter. However, we do not recommend triggering the alert more frequently than the default if you have a large amount of queues or queue items. You can configure this parameter via the appSettings file.

期限のあるアイテム (Studio またはアップロードに使用される .csv ファイルのいずれかで設定) は SLA の設定による影響は受けません。

重要:

• Studio またはアップロードに使用される .csv ファイルでの設定に関係なく、SLA 予測を有効化した後にキューに追加されたアイテムの優先度は自動的に [高] に設定されます。
• SLA 予測が有効化されているキューに関連付けられているプロセスは削除できません。
• 少なくとも 1 つのキュー アイテムがその処理期限を超えている場合、[必要なロボットの台数 (SLA)] 列に [キャパシティ オーバー] と表示され、予測値は算出されなくなります。
• Predictions are made for queue items with deadlines in the next 24 hours (can be changed using the Queue.SlaReadaheadTimeLimitHours), and do not take into account the items' defer dates.

キュー トリガーと SLA 予測値は、キューとプロセスの関連付けに関して互いに依存しています。したがって、一方を構成すると、設定が一致するように、もう一方は自動入力されます。たとえば、キュー Y に対するキュー トリガーを、プロセス X を使用するように 定義します。キュー Y の SLA 予測値はプロセス X のみを使用して決まるので、Y のキュー SLA を有効化すると、X には値が事前入力され、読み取り専用になります。

リスク SLA (Risk SLA)

アイテムのリスク SLA を定義することもできます。これは、SLA の前のバッファーゾーンのように機能します。明示的に、アイテムのリスク期限は、キュー アイテムがキューに追加された時点からのリスク SLA に基づいて計算されます。SLA を 2 時間に設定し、4:30、5:15、および 6:45 PM に 3 つのアイテムをキューに追加すると、アイテムのリスク期限はそれぞれ 6:30、7:15、8:45 PM になります。

リスク SLA が経過し、キュー アイテムが処理されない場合、アイテムは期限に間に合わないリスクが発生します。ユーザーには適切に通知され、それに応じて調整を行うことができます。

キュー SLA の権限

キューの SLA 予測値を構成できるようにするには、次の権限が付与されている必要があります。

• プロセスの表示
• キューの表示
• キューの編集権限 (キューの編集時に SLA を構成するため)
• キューの作成権限 (キューの作成時に SLA を構成するため)