UiPath Orchestrator

UiPath Orchestrator ガイド

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

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

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

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

キューの概要 (Queues Overview)

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

[キュー (Queues)] ページでは、新しいキューを作成できます。以前作成されたキュー、トランザクションステータス進行状況の時系列チャート、さまざまな他の詳細 (平均実行時間、成功したトランザクションの総数など) を視覚的に見ることもできます。

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

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

スキーマ定義

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

重要!

スキーマは、既存のトランザクションに遡及的に適用されるのではなく、スキーマをアップロードした後に実行されるトランザクションにのみ適用されます。

Your schema(s) must not contain an array.

For validation purposes, DateTime is accepted as string type.

Use of and validation of an Analytics Data schema requires Robots and Activities of version 19.10 or greater.

If the uploaded schema(s) do not contain a valid schema definition URI, then the draft-07 definition, as in the below example, is used as the fallback.

サンプルスキーマ:

{
  "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
      ]
    }
  }
}

トランザクションの概要 (Transactions Overview)

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

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

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

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

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

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 parameter in web.config. 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 within the item.

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

  • 詳細 (Details) - トランザクションに追加された正確な情報、およびトランザクションのステータス履歴、リトライ回数を確認できます。
  • コメント - 特定のトランザクションに関する情報をチームメンバーと共有する必要がある場合に、トランザクションに関連するコメントを確認したり、追加したりできます。キューおよびトランザクションに関する閲覧編集削除権限を持つすべてのユーザーは、権限に応じてコメントの追加、編集、削除を実行できますが、変更を加えることができるのは自分のコメントのみです。
  • 履歴 - 実行されたアクションとその実行者、レビュー担当者、および現在のレビュー ステータスを確認できます。詳細については、「トランザクションの管理」および「トランザクションのフィールドの説明」ページを参照してください。

処理順序

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

  1. 処理期限設定されているアイテム。以下の順序で処理されます。
    a. 優先度の順序
    b. 優先度が同じアイテムの場合は、設定されている処理期限の順序
  2. 処理期限なしのアイテム。優先度に従って以下のように処理されます。
    a. 優先度が同じアイテムの場合は、先入れ先出しのルール

処理期限および延期の日付を設定するには、それぞれのフィールドに相対的な日時を入力することが推奨されます。たとえば、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 に変換されます。

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

トランザクションのエクスポート

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

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

キュー SLA の予測

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

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

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

重要

The Priority of the items added in a queue after enabling SLA predictions is automatically set to High, regardless of how it was set in Studio or in the .csv file used for upload.

SLA 予測が有効化されているキューに関連付けられているプロセスは削除できません。

If at least one queue item exceeds its deadline, Over Capacity is displayed in the Necessary Robots (SLA) column and predictions are no longer calculated.

Predictions are made for queue items with deadlines in the next 24 hours (can be changed using the Queue.SlaReadaheadTimeLimitHours parameter in web.config), 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 を構成するため)

アイテムの一括アップロード (Bulk Uploading Items)

.csv ファイルから直接キュー アイテムを特定のキューに一括アップロードできます。そのためには、まず特定のキューの Orchestrator インスタンスにファイルをアップロードします。ファイルが正常に処理された後、選択されたストラテジーに従って、含まれているアイテムがキューにアップロードされます。アップロード操作が正常に実行されるためには、あらかじめこのファイルにデータを定義済みの形式で読み込んでおく必要があります。

.csv ファイルの作成時に使用できる一連の定義済みの列ヘッダーがありますが、他のカスタム ヘッダーを使用することもできます。.csv ファイルのアップロードに成功すると、ヘッダーが事前定義された列に含まれる情報が Orchestrator で見つかった列にマップされます。カスタム ヘッダーの列に含まれる情報は、Orchestrator の対応する項目の [特定のデータ (Specific Data)] セクションの下に配置されます。列マッピングの詳細についてはこちら、例についてはこちらをご覧ください。

アップロードは、ファイルごとに 15,000 アイテムに制限されています。web.configUpload.Queues.MaxNumberOfItems パラメーターを使用して、制限値を少なくすることができます。

列のマッピング

ファイルの列ヘッダー
Orchestrator のフィールド

参照
一意の参照キューの場合は必須です。
二重引用符 (") を除く、すべての特殊文字をサポートしています。

参照
注: 参照は、2016.2 以前のバージョンの Orchestrator または Robot には対応していません。

Deadline
Must be populated with a date in one of the following formats:
YYYY-MM-DD
YYYY/MM/DD
YYYY MM DD
YYYY-MM-DD HH:mm
YYYY/MM/DD HH:mm
YYYY MM DD HH:mm
YYYY-MM-DD HH:mm:ss
YYYY/MM/DD HH:mm:ss
YYYY MM DD HH:mm:ss

処理期限

Postpone
Must be populated with a date in one of the following formats:
YYYY-MM-DD
YYYY/MM/DD
YYYY MM DD
YYYY-MM-DD HH:mm
YYYY/MM/DD HH:mm
YYYY MM DD HH:mm
YYYY-MM-DD HH:mm:ss
YYYY/MM/DD HH:mm:ss
YYYY MM DD HH:mm:ss

延期 (Postpone)

Priority
Must be populated with one of the following values:
Low or 1
Normal or 2
High or 3
If the priority is not specified in the file, the items are uploaded with a high priority, by default.

Priority
Mapped to the following values, respectively:
Low
Normal
High

[カスタム名]
名前には、英数字 (0-9、a-z)とアンダースコアしか使えません。

固有データ
JSON 形式にマッピングされます。
例:
当行払い小切手 (On-Us Check): 5540

ファイルには、空白の列ヘッダーを含めることはできません。フィールドの詳細な説明については、こちらを参照してください。

重要!

定義済みの列ヘッダーでは大文字と小文字が区別されます。必ず上記のマッピングルールに従ってください。reference という名前の .csv の列は参照 (Reference) 列の代わりに特定のデータ (Specific Data)セクションにマッピングされています。

ストラテジーのアップロード

アップロードの処理には、2 種類のストラテジーがあります。

  • 個別にすべてを処理 (ProcessAllIndependently) - すべてのアイテムを個別に処理し、処理が正常に完了したアイテムをキューに追加します。この一覧は、.csv ファイルでダウンロードできます。このファイルには、当初アップロードしたファイルと同じフィールドにデータが読み込まれています。
  • 一括 (すべて成功/すべて失敗) で処理 (AllOrNothing) - すべてのアイテムが正常に処理された場合にのみアイテムが追加されます。または、何にも追加されません。

次に示す .csv ファイルの内容をキューにアップロードするとします。このようなファイルを容易に作成するには、データを Excel ファイルに入力して .csv ファイルとして保存します。

 

csv_file


または、すべての列ヘッダーを入力済みの .csv ファイルをダウンロードして、ニーズに合わせてカスタマイズすることもできます。


ファイルをダウンロード

このファイルには、Orchestrator に存在するアイテムと名前が同じ 3 つの既定の列 ([参照]、[処理期限]、および [優先度] - 緑でハイライト) と 2 つのカスタム列 (Customer および Color - 赤でハイライト) が存在します。
 

csv_highlighted

  1. アップロード先のキューに対する [アイテムをアップロード (Upload Items)] をクリックして、この .csv ファイルを選択します。Orchestrator によってファイルが解析され、値がフォーマット ルールを満たしていることが確認されます。
  2. 適切なアップロード ストラテジーを選択して [アップロード] をクリックし、プロセスを完了します。

csv_file


[その他のアクション (More Actions)] > [トランザクションを表示 (View Transactions)] を選択して、アップロードしたキュー アイテムを表示します。

csv_file


[トランザクション] ページに、ファイルからアップロードした各アイテムが表示されます。ファイルの既定の列の情報は、Orchestrator にある同じ名前の列 ([参照][処理期限]、および [優先度] - 緑でハイライト) にマップされています。


 

csv_transactions_highlighted


カスタム列の情報は、JSON 形式で各アイテムの [固有データ (Specific Data)] セクションにマップされています。その内容を表示するには、アイテムの [詳細を表示 (View Details)] をクリックします。


 

csv_specific_data

Updated 5 days ago



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


改善の提案は、API 参照ページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。