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

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Active Directory tab.
On the Active Directory tab, drag the Retrieve User activity onto your process.

General Configuration

Specifies the basic settings for the Retrieve User 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 Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
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

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:

Example:

This is a common configuration field that is used in many examples. Refer to:

Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

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
Create	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: A valid user name in Active Directory. A process data variable. 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
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 Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Variable	Function: The process data variable to store user properties. Accepted Values: A process data variable. Default Value: None Accepts Process Data Variables: Yes

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
Limitations:: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Variable

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