Description:

This step retrieves the details of an existing Active Directory user account.

The Read Active Directory User workflow step connects to Microsoft Active Directory via a configured LDAP connection and reads the properties of the specified user account.

The step identifies the user by the specified username and retrieves the configured Active Directory attributes. The retrieved values are mapped directly to FlowWright Variables or Global Variables using the User Attributes Mapping configuration, making them available to subsequent workflow steps.

This step provides an efficient way to retrieve user information for validation, reporting, synchronization, approval routing, or identity lifecycle workflows.

The step supports:

• Active Directory user account lookup
• Retrieval of user account attributes
• Configurable LDAP connections
• Dynamic username input using workflow variables
• Mapping Active Directory attributes to FlowWright Variables and Global Variables
• Integration with Microsoft Active Directory

This step can be used for:

• User profile retrieval
• Identity synchronization
• Employee onboarding
• User account validation
• HR system synchronization
• Access reviews
• Business process automation

Usage:

The Read Active Directory User step is typically placed before validation, synchronization, reporting, or account management activities within a workflow.

The workflow retrieves the specified Active Directory user using the configured LDAP connection and populates the configured workflow variables with the user's directory attributes.

A typical workflow might look like this:

Once the user information has been retrieved, later workflow steps can:

• Validate user information
• Update user attributes
• Generate audit reports
• Synchronize identity systems
• Route approvals based on user properties
• Populate forms and notifications
• Continue identity lifecycle management processes

You need to set up an LDAP connection before using this step.

Go to:

Integration → Connections → Generic Connections

On the Manage Generic Connections page, click:

Actions → Create

Configure an Active Directory connection before using this workflow step.

A sample connection is provided here for reference. 

Example:

Let’s build and execute the “clsReadADUserDef” example:

• Create a new process definition named “clsReadADUserDef” and open it in designer mode. 
• Drag a “clsReadADUser” step to the canvas.
• Connect the dots between the “Start” and “clsReadADUser” steps.
• Click the "clsReadADUser" step to configure its "Required" properties. Provide a name for the step. Select the LDAP connection from the drop-down list. Enter the “User name”. Click the button to configure the user attributes mapping. Click the Save button to confirm. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the button to configure user attribute mapping. Click the Add Row (+) button to insert an empty row. Enter the variable or global reference and the Active Directory attribute reference. Click the Save button. You may map multiple attributes by using the Add Row function. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

• Save the Process Definition. Create a new Process Instance and execute it. When the workflow reaches the Read User step, FlowWright connects to the configured Active Directory server using the selected LDAP connection and retrieves the specified user account. If the directory query completes successfully, the configured Active Directory attributes are mapped to the specified workflow variables, and the workflow follows the True return path. If the user account cannot be found or the LDAP connection cannot be established, the workflow follows the False return path.

• Click the process step to view its properties. The step should retrieve the specified Active Directory user account and return True upon successful completion. Verify that the configured workflow variables contain the expected user attribute values.

Tips:

• Verify that the LDAP connection has been configured before using this step.
• Ensure that the LDAP account has permission to read Active Directory user objects.
• Verify that the specified user account exists before attempting to retrieve it.
• Configure the User Attributes Mapping carefully to ensure each Active Directory attribute maps to the correct FlowWright Variable or Global Variable.
• Use workflow variables to dynamically provide the username.
• Use the True and False return paths to implement appropriate success and error handling.
• Combine this step with Update User Attributes, Enable User, Disable User, or Add Users to Group steps to automate complete Active Directory identity management workflows.

Notes:

• A valid LDAP connection must exist before this step can execute.
• The configured LDAP account must have sufficient permissions to read Active Directory user objects.
• The specified user account must already exist in Active Directory.
• Only the configured Active Directory attributes are retrieved and mapped to workflow variables.
• Network connectivity or authentication issues may prevent successful retrieval.
• The workflow should include appropriate error handling for the False return path.
• Retrieved attribute values are stored in the configured FlowWright Variables or Global Variables for use by subsequent workflow steps.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Note: Verify and complete any missing configuration after importing the sample, including:

• LDAP connection
• Username mapping
• User Attributes Mapping
• Workflow variable mappings
• Active Directory permissions
• Environment-specific settings

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.