Queue コネクタのメソッド
Queue コネクタを使用すると、RPA Hub のキューに対して作業アイテムを作成し、管理できます。
必須条件
- RPA デスクトップデザインスタジオ のツールバーにある [ボットプロセスのアサイン (Assign bot process)] オプションを使用して、ボットプロセスに自動化をアサインします。
- 次の手順を実行して、プロパティを設定します
- 移動先 .
- [プロジェクトエクスプローラー (Project Explorer)] ペインの Global Objects の下に Queue コネクタをドラッグします。
- Queue コネクタをダブルクリックします。
- [プロパティ] ペインの [QueueName] フィールドに、キューの名前を入力します。注:キューの名前は、RPA Hub で定義されているものと同じである必要があります。
CreateJSONWorkItem
キューの作業アイテムを JSON 形式で作成します。
- 入力
- Name
JSON オブジェクトにキーと値のペアを作成するには、次の手順を実行します。
- CreateJSONWorkItem コンポーネントバーで、コンポーネント設定アイコン (
) をクリックします。
- キーを追加するには、キーを追加アイコン (
) をクリックします。
- フィールドにキーの名前を入力します。
- さらにキーを追加するには、上記の手順を繰り返します。
- [OK] をクリックします。
- キーフィールドをダブルクリックし、キーの値を入力します。
- 出力
- WorkItemId
CreateStringWorkItem
文字列を受け取って、RPA Hub のキューに作業アイテムを作成します。
- 入力
- RequestContent
- 出力
- WorkItemId
GetWorkItems
指定された基準に基づいて、キューの下に作成された作業アイテムの数と詳細を返します。メソッドでは、既にデフォルトの基準が提供されていますが、追加の基準を指定することもできます。
- 入力
- 制限
- 出力
- TotalCount
作業アイテムを識別して取得するための追加の基準を指定するには、次の手順を実行します。
- メソッド設定アイコン (
) をクリックします。
- 必要に応じてフィルターを設定します。フィルターは必須ではありません。
表 : 1. 作業アイテムの構成 フィールド 説明 名前 作業アイテムの名前です。次のいずれかのフィルターを指定できます。 - [Equals]:作業アイテムの名前は、指定した基準とまったく同じです。
- [Contains]:作業アイテムの名前は、指定した文字を含んでいます。
- [StartsWith]:作業アイテムの名前は、指定した文字で始まります。
- [EndsWith]:作業アイテムの名前は、指定した文字で終わります。
タイプ 文字列形式の作業アイテムのタイプです。次のいずれかのフィルターを指定できます。 - [Equals]:作業アイテムのタイプは、指定した基準とまったく同じです。
- [Contains]:作業アイテムのタイプは、指定した文字を含んでいます。
- [StartsWith]:作業アイテムのタイプは、指定した文字で始まります。
- [EndsWith]:作業アイテムのタイプは、指定した文字で終わります。
ステータス 作業アイテムのステータスです。 ステージ 作業アイテムのステージです。 優先度 作業アイテムの優先度です。 DateType 作業アイテムの日付タイプです。このフィールドに入力する場合は、[FromData] フィールドと [ToDate] フィールドにも入力する必要があります。 FromDate メソッドが日付範囲内の作業アイテムを選択する場合は、範囲内の開始日です。 ToDate メソッドが日付範囲内の作業アイテムを選択する場合は、範囲内の終了日です。 オフセット 設定された制限値を超えて取得される作業アイテムの数です。たとえば、上限が 20 の場合、次に取得される作業アイテムは 21 からになります。 OutRecords 作業アイテムの詳細をオブジェクト形式で返します。 - [OK] をクリックします。注:設定されたフィールドごとに、データ入力ポートが作成されます。
PickWorkItem
指定された基準に基づいてボットが作業アイテムを選択できるようにします。選択される作業アイテムの追加の基準を設定することもできます。
PickWorkItem コンポーネントに含まれる queryConditions は、ボットプロセスがロボットプールで有効になっている場合、無人のボットプロセスの実行を完了するために必要なロボットの数を計算するために考慮されます。ロボット数の計算の詳細については、「」を参照してください RPA Hub のロボット数の計算。ロボットプールの概念の詳細については、次を参照してください。RPA Hub のロボットプール
- 入力
- 優先度
- 出力
- WorkItemID
- メソッド設定アイコン (
) をクリックします。
- 下表に従って、基準を入力します。
表 : 2. 選択アイテムの構成 フィールド 説明 名前 次のフィルターに基づく作業アイテムの名前です。 - [Equals]:作業アイテムの名前は、指定した基準とまったく同じです。
- [Contains]:作業アイテムの名前は、指定した文字を含んでいます。
- [StartsWith]:作業アイテムの名前は、指定した文字で始まります。
- [EndsWith]:作業アイテムの名前は、指定した文字で終わります。
選択すると、データ入力ポートが公開されます。
タイプ 次のフィルターに基づく作業アイテムのタイプです。 - [Equals]:作業アイテムのタイプは、指定した基準とまったく同じです。
- [Contains]:作業アイテムのタイプは、指定した文字を含んでいます。
- [StartsWith]:作業アイテムのタイプは、指定した文字で始まります。
- [EndsWith]:作業アイテムのタイプは、指定した文字で終わります。
選択すると、データ入力ポートが公開されます。
ステージ 次のフィルターに基づく作業アイテムのステージです。 - [Equals]:作業アイテムのステージは、指定した基準とまったく同じです。
- [Contains]:作業アイテムのステージは、指定した文字を含んでいます。
- [StartsWith]:作業アイテムのステージは、指定した文字で始まります。
- [EndsWith]:作業アイテムのステージは、指定した文字で終わります。
選択すると、データ入力ポートが公開されます。
名前 作業アイテムの名前を返すデータ出力ポートです。 タイプ 作業アイテムのタイプを返すデータ出力ポートです。 注釈 作業アイテムの注釈を返すデータ出力ポートです。 ステージ 作業アイテムのステージを返すデータ出力ポートです。 JSON パス表記 JSON パス表記の作業アイテムを返すデータ出力ポートです。
UpdateWorkItem
指定された基準に基づいて、PickWorkItem メソッドで作業アイテムを選択した後、ボットが作業アイテムを更新できるようにします。選択される作業アイテムの追加の基準を設定することができます。このメソッドを実行する前に、PickWorkItem メソッドを実行する必要があります。設定するには、次の手順を実行します。
- メソッド設定アイコン (
) をクリックします。
- 下表に従って、基準を入力します。
表 : 3. 更新アイテムの構成 フィールド 説明 ステージ 作業アイテムのステージを更新します。 DeferredTill 同じ作業アイテムが選択されない期間を指定するオプションです。たとえば、5 分です。 名前 作業アイテムの名前です。 タイプ 作業アイテムのタイプです。 注釈 作業アイテムに関する補足の注釈です。 SLA 作業アイテム完了の SLA です。 ResponseContent 応答で返されるコンテンツです。 JSON パス表記 JSON パス表記です。
- 入力
- WorkItemID
ReleaseWorkItem
ボットによって受け取られ、実行された作業アイテムをリリースします。このメソッドを実行する前に、PickWorkItem メソッドを実行する必要があります。
- 入力
- WorkItemId
- 出力
- 戻る