获取队列
从队列提供程序获取指定的队列。
命令可用性: 本地 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
依赖关系
- 您需要与队列服务器的活动连接。 可以使用以下命令来连接到队列服务器：
- 连接到活动 MQ (
connectActiveMQ) - 连接到 Azure Storage (
connectAzureStorage) - 连接到 IBM MQ (
connectIbmMQ) - 连接到 JMS MQ (
connectJmsMQ) - 连接到 Microsoft MQ (
connectMicrosoftMQ) - 连接到 Rabbit MQ (
connectRabbitMQ) - 连接到 SQL MQ (
connectSqlMQ) - 连接到 IBM RPA 队列服务器 (
connectSystemMQ)
- 连接到活动 MQ (
- 您需要现有队列的名称。 此名称是唯一的，且用于标识队列。
- 如果该队列不存在，那么此命令将尝试创建具有给定名称的新队列。 请参阅限制部分以了解与队列名称相关的限制。
- 如果启用了
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"
限制
如果该命令尝试创建新队列，那么队列名称不能包含下划线 (_)。某些队列提供程序不支持此字符，将无法创建具有给定名称的新队列。