キューの取得

指定されたキューをキュー・プロバイダーから取得します。

コマンドの可用性: IBM RPA SaaS および IBM RPA オンプレミス

Description

指定されたキューをキュー・プロバイダーから取得します。 IBM RPA Control Centerに登録されているキュー、またはキュー・プロバイダーからキューを取得できます。 キューが存在しない場合は、このコマンドでキューを作成することもできます。

スクリプト構文

IBM RPA の専有スクリプト言語の構文は、他のプログラミング言語と似ています。 スクリプト構文は、スクリプト・ファイル内のコマンドの構文を定義します。 この構文は、 IBM RPA Studioの 「スクリプト」 モードで操作できます。

getQueue --connection(QueueConnection) [--fromconfiguration(Boolean)] --queue(String) --name(String) (Boolean)=success (MessageQueue)=value

依存関係

  • キュー・サーバーへのアクティブな接続が必要です。 以下のコマンドを使用して、キュー・サーバーに接続できます。
  • 既存のキューの名前が必要です。 この名前は固有であり、キューを識別するために使用されます。
  • キューが存在しない場合、コマンドは指定された名前で新しいキューを作成しようとします。 キューの名前に関連する制限については、制限セクションを参照してください。
  • Storaged Configuration パラメーターが有効になっている場合は、キューが IBM RPA Control Centerに登録されていることを確認してください。

入力パラメーター

以下の表は、このコマンドで使用可能な入力パラメーターのリストを示しています。 この表では、 IBM RPA Studioのスクリプト・モードで作業しているときのパラメーター名と、それに相当する Designer モードのラベルを確認できます。

「デザイナー」モードのラベル 「スクリプト」モードの名前 必須 使用可能な変数タイプ Description
キュー接続 connection Required Queue Connection キュー・プロバイダーとの接続変数。
保管された構成 fromconfiguration Optional Boolean 有効にすると、 IBM RPA Control Centerで以前に構成したキューを選択できます。
待ち行列 queue Required when the Storaged Configuration parameter is enabled Text IBM RPA Control Centerに既に登録されているキューの名前。
名前 name Required when the Storaged Configuration parameter is not enabled Text キューを識別する名前。

出力パラメーター

「デザイナー」モードのラベル 「スクリプト」モードの名前 使用可能な変数タイプ Description
成功 success Boolean キューが正常に取得された場合は True を返し、それ以外の場合は False を返します。
取得されたキュー value Message Queue 指定されたキューを持つ変数を返します。

例

キュー・プロバイダーへの接続後、キューはサーバーから取得され、 ログ・メッセージ (logMessage) コマンドを実行すると、取得したキューが IBM RPA Studioのコンソールに表示されます。

defVar --name queueConnection --type QueueConnection
defVar --name obtainedQueue --type MessageQueue
connectActiveMQ --queueprovider Training --fromconfiguration  queueConnection=value
getQueue --connection ${queueConnection} --name Return obtainedQueue=value
logMessage --message "Queue obtained from the queue provider:${obtainedQueue}" --type "Info"

制限

コマンドが新しいキューを作成しようとする場合、キュー名に下線 (_) を含めることはできません。一部のキュー・プロバイダーはこの文字をサポートしていないため、指定された名前での新規キューの作成に失敗します。