Queue コネクタのメソッド

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：12分

    • Queue コネクタのメソッドを使用して、RPA ハブ のキューに対して作業アイテムを作成し、管理できます。

    前提条件

    1. RPA デスクトップデザインスタジオの [デザイン] タブの [ボットプロセスをアサイン (Assign bot process)] オプションを使用して、ボットプロセスを自動化プロジェクトにアサインし、作業アイテムにアクセスします。詳細については、「自動化プロジェクトへのボットプロセスのアサイン」を参照してください。
    2. 次の手順に従って、QueueName プロパティを設定します。
      1. RPA デスクトップデザインスタジオで、 ツールボックス > RPA ハブ > 順番待ち.
      2. [プロジェクトエクスプローラー (Project Explorer)] ペインの Global Objects の下に Queue コネクタをドラッグします。
      3. Queue コネクタをダブルクリックします。
      4. [プロパティ] ペインの [QueueName] プロパティに、キューの名前を入力します。
        注:
        キューの名前は、RPA ハブ で定義されているものと同じである必要があります。

    CreateJSONWorkItem

    キューの作業アイテムを JSON 形式で作成します。
    入力
    Name (名前)
    優先度
    出力
    WorkItemId
    IsNameExists
    JSON オブジェクトにキーと値のペアを作成するには、次の手順を実行します。
    1. CreateJSONWorkItem メソッドバーで、メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. 下表に従って、基準を入力します。
      表 : 1. アイテム構成の作成
      フィールド 説明
      構成
      入力フィールド
      タイプ 作業アイテムのタイプです。

      たとえば、会計システムキューの場合、預金と当座が口座のタイプです。

      入力フィールドを設定するには、「ポートのプロパティを設定する」を参照してください。
      ステージング 作業アイテムのステージを更新します。

      トランザクションのさまざまなステージを管理するためのカスタムフィールド。
      SLA 作業アイテム完了のサービスレベルアグリーメント (SLA)。
      JSON のプロパティ
      JSON パス表記
      名前 要求コンテンツのキーと値のペア (JSON コンテンツ)。
      キーを追加するには、次の手順を実行します。
      1. [キーを追加] アイコン ([キーを追加] アイコン) をクリックします。
      2. フィールドにキーの名前を入力します。
      3. さらにキーを追加するには、上記の手順を繰り返します。
      4. これらのフィールドに値を渡すには、「ポートのプロパティを設定する」を参照してください。
      機密 作業アイテムの作成時に渡される機密コンテンツ。

      このオプションを機密として選択すると、データは暗号化され、RPA ハブ の新しい作業アイテムの [機密要求コンテンツ (Sensitive Request Content)] フィールドに保存されます。作業アイテムフォームの詳細については、「の作業アイテムフォーム RPA ハブ」を参照してください。

      この機能を使用して、キューを介して機密情報を渡すことができます。

      たとえば、キュー内の顧客データを暗号化する場合は、[機密] フィールドを使用して、クレジットカード番号や住所などの顧客の詳細を保存する必要があります。
    3. [OK] をクリックします。

    CreateStringWorkItem

    文字列を受け取って、RPA ハブ のキューに作業アイテムを作成します。
    入力
    RequestContent
    名前
    出力
    WorkItemId
    IsNameExists

    文字列の作業アイテムを作成するための追加の基準を指定するには、次の手順を実行します。

    1. CreateStringWorkItem メソッドバーで、メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. 下表に従って、基準を入力します。
      表 : 2. アイテム構成の作成
      フィールド 説明
      入力フィールド
      SensitiveRequestContent 機密コンテンツを暗号化された形式で新しい作業アイテムに保存します。

      入力フィールドを設定するには、「ポートのプロパティを設定する」を参照してください。

      この機能を使用して、キューを介して機密情報を渡すことができます。

      たとえば、キュー内の顧客データを暗号化する場合は、[SensitiveRequestContent] フィールドを使用して、クレジット カード番号や住所などの顧客の詳細を保存する必要があります。
      ステージング 作業アイテムのステージを更新します。

      トランザクションのさまざまなステージを管理するためのカスタムフィールド。
      タイプ 作業アイテムのタイプです。

      たとえば、会計システムキューの場合、預金と当座が口座のタイプです。

      入力フィールドを設定するには、「ポートのプロパティを設定する」を参照してください。
      SLA 作業アイテム完了のサービスレベルアグリーメント (SLA)。
    3. [OK] をクリックします。

    GetWorkItems

    指定された基準に基づいて、キューの下に作成された作業アイテムの数と詳細を返します。メソッドでは、既にデフォルトの基準が提供されていますが、追加の基準を指定することもできます。

    入力
    制限
    出力
    TotalCount

    作業アイテムを識別して取得するための追加の基準を指定するには、次の手順を実行します。

    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. 必要に応じてフィルターを設定します。フィルターは必須ではありません。
      表 : 3. 作業アイテムの構成
      フィールド 説明
      入力フィルター
      名前 作業アイテムの名前です。次のいずれかのフィルターを指定できます。
      • [Equals]：作業アイテムの名前は、指定した基準とまったく同じです。
      • [Contains]：作業アイテムの名前は、指定した文字を含んでいます。
      • [StartsWith]：作業アイテムの名前は、指定した文字で始まります。
      • [EndsWith]：作業アイテムの名前は、指定した文字で終わります。
      タイプ 文字列形式の作業アイテムのタイプです。次のいずれかのフィルターを指定できます。
      • [Equals]：作業アイテムのタイプは、指定した基準とまったく同じです。
      • [Contains]：作業アイテムのタイプは、指定した文字を含んでいます。
      • [StartsWith]：作業アイテムのタイプは、指定した文字で始まります。
      • [EndsWith]：作業アイテムのタイプは、指定した文字で終わります。
      ステータス 作業アイテムのステータスです。
      ステージング 作業アイテムのステージを更新します。

      トランザクションのさまざまなステージを管理するためのカスタムフィールド。
      優先度 実行の優先度：
      • 重大
      • 高
      • 中
      • 低 
      アサインされたロボットは、作業キュー内の定義された優先度に従ってボットプロセスを実行します。デフォルトの優先度は常に [高] です。
      DateType 作業アイテムの日付タイプです。このフィールドに入力する場合は、[FromData] フィールドと [ToDate] フィールドにも入力する必要があります。
      FromDate メソッドが日付範囲内の作業アイテムを選択する場合は、範囲内の開始日です。
      ToDate メソッドが日付範囲内の作業アイテムを選択する場合は、範囲内の終了日です。
      オフセット 設定された制限値を超えて取得される作業アイテムの数です。たとえば、上限が 20 の場合、次に取得される作業アイテムは 21 からになります。
      出力フィールド
      OutRecords 作業アイテムの詳細をオブジェクト形式で返します。
    3. [OK] をクリックします。
      注:
      設定されたフィールドごとに、データ入力ポートが作成されます。

    PickWorkItem

    指定された基準に基づいて、ロボットが作業アイテムを選択できるようにします。選択される作業アイテムの追加の基準を設定することもできます。

    PickWorkItem コンポーネントに含まれる queryConditions は、ボットプロセスがロボットプールで有効になっている場合、割り当てられた作業を完了するために必要なロボットの数を計算する際に考慮されます。ロボット数の計算の詳細については、「RPA ハブ のロボット数の計算」を参照してください。ロボットプールの概念の詳細については、「RPA ハブ のロボットプール」を参照してください。

    入力
    優先度
    出力
    WorkItemId
    RequestContent

    作業アイテムを選択するための追加の基準を指定するには、次の手順を実行します。

    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. 下表に従って、基準を入力します。
      表 : 4. 選択アイテムの構成
      フィールド 説明
      構成
      入力フィルター
      名前 次のフィルターに基づく作業アイテムの名前です。
      • [Equals]：作業アイテムの名前は、指定した基準とまったく同じです。
      • [Contains]：作業アイテムの名前は、指定した文字を含んでいます。
      • [StartsWith]：作業アイテムの名前は、指定した文字で始まります。
      • [EndsWith]：作業アイテムの名前は、指定した文字で終わります。

      選択すると、データ入力ポートが公開されます。
      タイプ 次のフィルターに基づく作業アイテムのタイプです。
      • [Equals]：作業アイテムのタイプは、指定した基準とまったく同じです。
      • [Contains]：作業アイテムのタイプは、指定した文字を含んでいます。
      • [StartsWith]：作業アイテムのタイプは、指定した文字で始まります。
      • [EndsWith]：作業アイテムのタイプは、指定した文字で終わります。

      選択すると、データ入力ポートが公開されます。
      ステージ 次のフィルターに基づく作業アイテムのステージです。
      • [Equals]：作業アイテムのステージは、指定した基準とまったく同じです。
      • [Contains]：作業アイテムのステージは、指定した文字を含んでいます。
      • [StartsWith]：作業アイテムのステージは、指定した文字で始まります。
      • [EndsWith]：作業アイテムのステージは、指定した文字で終わります。

      選択すると、データ入力ポートが公開されます。
      ステータス ロボットが選択する作業アイテムのステータス。
      出力フィールド
      名前 作業アイテムの名前を返すデータ出力ポートです。
      タイプ 作業アイテムのタイプを返すデータ出力ポートです。
      注釈 作業アイテムの注釈を返すデータ出力ポートです。
      ステージ 作業アイテムのステージを返すデータ出力ポートです。
      RequestContent 作業アイテムの文字列コンテンツです。作業アイテムの作成時に保存されたコンテンツを選択します。
      SensitiveRequestContent このフィールドの機密コンテンツが選択され、復号化され、RPA デスクトップデザインスタジオまたはロボットに渡されます。
      JSON のプロパティ
      JSON パス表記 作業アイテムの JSON パス表記を返すデータ出力ポート。

      キーを追加アイコン ([キーを追加] アイコン) をクリックします。

      JSON は、[RequestContent] フィールドと [SensitiveRequestContent] フィールドの両方で渡すことができます。

      作業アイテムの選択中に、JSON データが作業アイテムから選択されます。たとえば、キーと値のペア「City: Mumbai」(City がキーで Mumbai が値) が [RequestContent] フィールドにあり、「City: Delhi」(City がキーで Delhi が値) が [SensitiveRequestContent] フィールドに作成されているとします。同じ作業アイテムを選択しようとすると、キーが両方のフィールドで同じであるため、[SensitiveRequestContent] フィールドが優先され、その出力がこのフィールドから取得されます。
    3. [OK] をクリックします。

    ReleaseWorkItem

    ボットによって受け取られ、実行された作業アイテムをリリースします。このメソッドを実行する前に、PickWorkItem メソッドを実行する必要があります。
    入力
    WorkItemId
    出力
    戻る

    UpdateWorkItem

    指定された基準に基づいて、PickWorkItem メソッドで作業アイテムを選択した後、ロボットがそのアイテムを更新できるようにします。更新する作業アイテムの追加の基準を設定することができます。このメソッドを実行する前に、PickWorkItem メソッドを実行する必要があります。
    入力
    WorkItemId
    RequestContent
    ReleaseMode
    優先度
    ステータス
    例外タイプ

    作業アイテムを更新するための追加の基準を指定するには、次の手順を実行します。

    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. 下表に従って、基準を入力します。
      表 : 5. 更新アイテムの構成
      フィールド 説明
      構成
      入力フィールド
      ステージング 作業アイテムのステージを更新します。

      トランザクションのさまざまなステージを管理するためのカスタムフィールド。
      DeferredTill 同じ作業アイテムが選択されない期間を指定するオプションです。たとえば、5 分です。
      名前 作業アイテムの名前です。
      タイプ 作業アイテムのタイプです。

      たとえば、会計システムキューの場合、預金と当座が口座のタイプです。

      入力フィールドを設定するには、「ポートのプロパティを設定する」を参照してください。
      注釈 作業アイテムに関する補足の注釈です。
      SLA 作業アイテム完了のサービスレベルアグリーメント (SLA)。
      ResponseContent 作業アイテムの文字列コンテンツです。作業アイテムの保存されたコンテンツを更新します。
      SensitiveRequestContent 作業アイテムの機密コンテンツを更新します。
      JSON のプロパティ
      JSON パス表記
      名前 要求コンテンツのキーと値のペア (JSON コンテンツ)。
      キーを追加するには、次の手順を実行します。
      1. [キーを追加] アイコン ([キーを追加] アイコン) をクリックします。
      2. フィールドにキーの名前を入力します。
      3. さらにキーを追加するには、上記の手順を繰り返します。
      4. これらのフィールドに値を渡すには、「ポートのプロパティを設定する」を参照してください。
      機密 作業アイテムの機密コンテンツが更新されます。

      この機能を使用して、キューを介して機密情報を渡すことができます。

      たとえば、キュー内の顧客データを暗号化する場合は、[機密] フィールドを使用して、クレジットカード番号や住所などの顧客の詳細を保存する必要があります。

      [SensitiveRequestContent] フィールドにキーと値のペア「City: Mumbai」を追加し、別のキーと値のペア「Country: India」を JSON パス表記で追加すると、UpdateWorkItem が実行されます。すると、[SensitiveRequestContent] フィールドで、出力が「City: Mumbai」と「Country: India」に結合されます。