Update User (Active Directory) activity

An activity that changes the specified user information in Active Directory.

Configure the Update User activity

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

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 or higher.

Good to Know

To send an e-mail notification, click Advanced > E-mail Notifications .
For more information, refer to Configure E-mail Notifications for Any Activity.
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?
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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

On the Application Explorer screen, do one of these:
- Open a Process.
- Create a Process.
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 Update User (Active Directory) activity onto your process.
- Change an activity:
  1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Update 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

Update User Configuration

Specifies the change to 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: Access Token for Active Directory. Function of this Screen: Configure an access token to connect to Active Directory.
User Name (Common Name)	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
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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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 change the user information and organization details. Accepted Values: A process attribute. 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 Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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