Process Activities / Active Directory tab
Parent topic: Active Directory tab

Retrieve User activity

An activity that gets user information from Active Directory.



Configure the Retrieve User activity

To configure the Retrieve User activity, do the procedure in this topic.

Good to Know

How to Start

  1. On the Organizer, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Active Directory tab.
      2. On the Active Directory tab, drag the Retrieve User activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Retrieve User .
  3. Complete the fields on the Retrieve User Configuration screen.

    For more information, refer to Get User Information from Active Directory.

  4. (Optional) Click Advanced > E-mail Notification .

    For more information, refer to Configure E-mail Notifications for Any Activity

General Configuration

Specifies the common information for a system activity.



Fields

Field Name Definition

Display Name
Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No

Description
Function:
Specifies an optional description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Retrieve User Configuration

Specifies the user information in Active Directory.



Fields

Field Name Definition

Active Directory
Function:
Specifies the access token that connects to your Active Directory.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No

Add Token

Opens this Screen:
New Active Directory Access Token
Function of this Screen:
Configures a new access token for Active Directory.

User Name (Login ID)
Function:
Specifies the name of the user to create in Active Directory.
Accepted Values:
Default Value:
None
Accepts Process Data Variables:
Yes

Property Name
Function:
Specifies the properties of the selected user in Active Directory.
Accepted Values:
Read-only

Variable
Function:
The process data variable to store user information and organization details.
Accepted Values:
Read Only.

Filter
Function:
Specifies the file name or a set of files expressed with the filter expression to search within the specified source location.
Accepted Values:
  • A file name.
  • A filter string that uses asterisks (*) as wildcards.
Default Value:
None
Accepts Process Data Variables:
No
Example:
These are some examples of filter expressions:
  • *.* - All files are searched.
  • *.xml - The files that have the .xml file extension are searched.
  • *.doc - The files that have the .doc file extension are searched.
  • MyFile.xml - Only the specific file MyFile.xml is searched.

The filter action is done at the source location specified in the activity.
Parent topic: Active Directory tab

Quick Links:

Send Feedback

Quick Start

Process Activities

eForm Controls

AgilePoint NX Online Help

AgilePoint NX Technical Documentation

Support Portal

AgilePoint

AgilePoint NX

Documentation Updated: December 3, 2015

© 2015 AgilePoint, Inc. All rights reserved.