MSMQ - Set Permissions

Declaration

<AMMSMQ REMOTEMACHINE="text" QUEUENAME="text" 
TRANSACTIONAL="YES/NO" RESULTDATASET="text (dataset name)" />

Description: Adds permissions to the current set. This controls who has access rights to queue properties and messages in the queue.

IMPORTANT: MSMQ 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.

General Parameters

Property

Type

Required

Default

Markup

Description

LDAP Path

Text

Yes

(Empty)

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

The Lightweight Directory Access Protocol (LDAP) path of the Active Directory object to retrieve. The LDAP is an application protocol for querying and modifying data of directory services implemented in IP networks.

Click the Select Object button to launch a standard Windows Active Directory dialog box that allows for the selection an Active Directory object.

Click the Select Container button to select the parent container from the domain in which to select an Active Directory object from.

Create and populate dataset

Text

Yes

(Empty)

RESULTDATASET="theDataset"

The name of the dataset to be created which will be populated with the Active Directory object's Property Name and Property Value. More on the field names that this dataset creates can be found below under Additional Notes.

Credentials Parameters

Property

Type

Required

Default

Markup

Description

Username

Text

No

(Empty)

USERNAME="username"

The username of the Active Directory user.

NOTE: Leave the Username and Password fields blank to use the logon user's credentials. If only accessing Active Directory information, then any Domain user is valid. However, a Domain Administrator is required to modify an Active Directory user or group. We recommend using the credentials of a Domain Administrator for all Active Directory actions.

Password

Text

No

(Empty)

PASSWORD="encrypted"

The password of the Active Directory user.

NOTE: Leave the Username and Password fields blank to use the logon user's credentials. If only accessing Active Directory information, then any Domain user is valid. However, a Domain Administrator is required to modify an Active Directory user or group. We recommend using the credentials of a Domain Administrator for all Active Directory actions.

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

Number

Returns the Active Directory Object's Property Name.

theDataset.PropertyValue

Number

Returns the Active Directory Object's Property Value.

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="AM2PBmOg3vfcdsoGZuDe99x2" 
RESULTDATASET="theDataset" />