MSMQ - List Queues

Declaration

<AMMSMQ ACTIVITY="list_queues" RESULTDATASET="text" 
MACHINE="text" LISTYPE="text (options)" />

Description: Retrieves a listing of queues by type and populates a dataset with information regarding those queues.

Property

Type

 Required

Default

 Markup

Description

List type

Text (options)

Yes

All public queues

  1. LISTYPE="all"

  2. LISTYPE="public_by_machine"

  3. LISTYPE="public_by_label"

  4. LISTYPE="public_by_category"

  5. LISTYPE="private_by_machine"

The type of list to retrieve. The available options are:

  • Public by machine - Retrieve public queues by machine name.

  • Public by category - Retrieve public queues by category.

  • Private by machine - Retrieve private queues by machine name.

Computer name

Text

Yes if List type is Public by machine

(Empty)

LDAPPATH=

LDAP://DC=netauto,DC=com"

The name of the computer in which to retrieve public or private queue information from. This parameter is active only if the List type parameter is set to Public by machine or Private by machine.

Label

Text

Yes if List type is Public by label

(Empty)

LABEL="text"

The label name of the public queue to retrieve information from. This parameter is active only if the List type parameter is set to Public by label.

Category (guid)

 

Yes if List type is Public by category

(Empty)

CATEGORY="text"

The category of the public queue to retrieve information from. This parameter is active only if the List type parameter is set to Public by category.

Create and populate dataset

Text

Yes

(Empty)

RESULTDATASET="theDataset"

The name of the dataset to create and populate with information pertaining to the retrieved queue(s). More on datasets below under Datasets.

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.)

Datasets

A dataset is a multiple column, multiple row container object. This action creates and populates a dataset with the following fields (rows):

Name

Type

Return Value

theDataset.AccessMode

Text

Returns the path to the newly created queue.

theDataset.Authenticate

Text

Specifies whether the queue accepts only authenticated messages.

theDataset.BasePriority

Number

Specifies the priority level of the queue.

theDataset.CanRead

True/False

Specifies whether read access permissions are allowed for the queue.

theDataset.CanWrite

True/False

Specifies whether write permissions are allowed for the queue.

theDataset.Category

Text

The category level of the queue.

theDataset.CreateTime

Date/Time

The date and time when the public or private queue was created.

theDataset.DenySharedReceive

True/False

Specifies whether the queue requires encryption.

theDataset.EncryptionRequired

True/False

Specifies whether the queue requires encryption.

theDataset.FormatName

Text

The format name of the queue.

theDataset.ID

Number

The unique ID of the queue.

theDataset.Label

Text

A user defined description of the queue.

theDataset.LastModifyTime

Date/Time

The date and time when the queue was last modified.

theDataset.MachineName

Text

The name of the machine where the queue resides.

theDataset.MaximumJournalSize

Number

The maximum size of the queue journal.

theDataset.MaximumQueueSize

Number

The maximum size of the q ueue.

theDataset.MulticastAddress

Text

The multicast address associated with the queue

theDataset.QueueName

Text

The name of the queue.

theDataset.QueuePath

Text

The path name of the queue.

theDataset.Transactional

True/False

Indicates whether the queue supports transactions.

theDataset.UseJournalQueue

True/False

Indicates whether the queue is a journal queue.

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: Get properties of Active Directory object at ""LDAP://OU=MyCompany,DC=mycompany,DC=com"" and create and populate dataset "theDataset" with the properties.

<AMCREATEADPROPERTYDATASET LDAPPATH="&quot;
LDAP://OU=MyCompany,DC=mycompany,DC=com&quot;" 
USERNAME="theUserName" 
PASSWORD="AM2PBmOg3vfcdsoGZuDe99x2z8ZjoN532bbKBnogx3fFdk=aME" 
RESULTDATASET="theDataset" />