MSMQ - Queue Exists

Declaration

<AMMSMQ ACTIVITY="queue_exist" QUEUE="text" 
REMOTEMACHINE="text" 
RESULTVARIABLE="text" />

Description: Determines whether a specific queue exists on the local machine or on a remote machine and populates a variable with the result. If the queue exists, this activity returns TRUE. Otherwise, it returns FALSE.

IMPORTANT: TMSMQ activities are performed using the Microsoft Message Queuing engine; therefore, MSMQ must be installed on the computer that will run such operations. MSMQ software comes bundled with all Microsoft Windows operating systems from Windows 2000 up to, and including Windows 8, however, it is not installed by default. For more details regarding the installation of MSMQ, see MSMQ Installation & Overview.

Practical Usage

Ideally used as a conditional step that can perform different actions depending on whether the condition results to TRUE or FALSE. For example, if this activity returns TRUE, execute steps to send messages to the existing queue. If FALSE, execute steps to create a new queue in which to store new messages.

Queue Parameters

Property

Type

Required

Default

Markup

Description

Local computer

 

 

 

 

If enabled, specifies that this activity will be performed on the local computer (enabled by default). This is a visual mode parameter used only during design time, therefore, contains no markup.

Another computer

Text

No

(Empty)

  1. REMOTEMACHINE="CompName"

  2. REMOTEMACHINE="xxx.xxx.xxx.xxx

If enabled, specifies the host name or IP address of the remote computer that this activity will be performed on. When this parameter is enabled, the Local computer parameter is ignored.

Queue path

Text

Yes

(Empty)

QUEUENAME="CompName\QueueName"

The full path and name of the message queue. The message queue name consists of the computer name, an optional PRIVATE$ keyword that indicates whether it is a private queue and the name of the queue. See examples below:

Public queue sample: ComputerName\QueueName

Private queue sample: ComputerName\PRIVATE$\QueueName

Populate variable with result

Yes/No

No

No

RESULTVARIABLE="theResult"

The name of the variable in which to populate with the results of this activity.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)