Retrieve User (Active Directory) 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 Application Explorer screen, 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 Notifications .

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

General Configuration

Specifies the common information for a system activity.

Screen



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
Example:
Refer to:

Description

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

Retrieve User Configuration

Configures the user properties to get for the Active Directory user.



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:
Access Token for Active Directory
Function of this Screen:
Configure an access token to connect to 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

Add Custom Property

Opens this Screen:
Add Custom Property
Function of this Screen:
Creates new user properties that do not show in the default list of user properties

User Properties - Property Name

Function:
Shows a list of user properties.
Accepted Values:
The default list of user properties.

Selected Properties - Property Name

Function:
Specifies the user property for the selected user.
Accepted Values:
Read-only

Variable

Function:
The process data variable to store user properties.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

File Name/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:
  • File Name - Specifies the name of the file in your storage source location.
  • Filter - Specifies a file name or a filter string that uses asterisks (*) as wildcards.
Default Value:
Filter
Accepts Process Data Variables:
Yes
Example:
These are some examples of filter expressions:
  • *.* - All files are searched.
  • *.txt - The files that have the .txt file extension are searched.
  • *.pdf - The files that have the .pdf file extension are searched.
  • MyFile.* - All files start with MyFile are searched.
  • *[part of file name]* - All files that contain the specified part of file name 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.

Add Custom Property

Creates new user properties that do not show in the default list of user properties.



Fields

Field Name Definition

Property Name

Function:
Specifies the user property for the selected user.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

Variable

Function:
The process data variable to store user properties.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes