Description:

The Remove User step removes the selected user from the workflow environment during execution.

The step supports:

• Specifying the process user ID of the user to be removed.
• Supplying the user ID as a workflow string value.
• Dynamically determining the user to remove.
• Using the step as part of user or workflow administration.
• Routing subsequent workflow processing through True or False return paths.

Usage: 

The Remove User step is typically placed in a workflow when a selected process user needs to be removed based on information available during workflow execution.

The workflow first identifies the user and obtains the corresponding process user ID. That ID is then supplied to the Remove User step.

A typical workflow pattern is:

Identify User → Remove User → Continue Process

The step can be useful in workflows that perform user management activities or need to remove a user after a specific business or workflow condition is met.

Because the operation acts on a supplied user ID, ensure that the value passed to workflowUserID identifies the intended user.

Typical Workflow Suggestions:

Remove a Selected User

Use this step when workflow logic has identified a particular user to be removed.

Example:

Identify User → Remove User → Continue Process

The workflow determines the process user ID and passes it to the Remove User step.

Remove a User Based on a Workflow Condition

Use a decision or evaluation step before Remove User to determine whether the user should be removed.

Example:

Evaluate User Status → Remove User → Continue Process

This allows the workflow to make the removal decision before executing the user-removal operation.

Use a Variable to Supply the User ID

The workflowUserID property uses the string data type, allowing the user ID to be supplied dynamically.

Example:

Get User ID → Remove User → Continue

This is useful when the user to be removed is determined during workflow execution.

Remove a User Identified by Previous Workflow Processing

Use the preceding workflow activities to identify the user to be removed.

Example:

Retrieve User Information → Determine User → Remove User

The resulting process user ID can then be supplied to the Remove User step.

Perform User Cleanup

Use the step as part of a workflow that performs cleanup associated with a particular user or workflow process.

Example:

Complete Process → Identify User → Remove User

This pattern can be used when removal is part of the workflow's final processing.

The XML confirms that the step removes a selected user, but does not define a specific cleanup scenario or lifecycle policy.

Use Dynamic User Selection

A workflow can determine the target user at runtime rather than configuring a fixed user ID.

Example:

Retrieve User Data → Store User ID → Remove User → Continue Process

This allows the same process definition to operate on different users for different workflow instances.

Route Processing After User Removal

Use the True and False return paths to control what happens after the step executes.

Example:

Remove User

→ True: Continue Process

→ False: Handle Result

The step provides both return paths in its XML definition.

Handle an Unsuccessful Result

Connect the False return path to an appropriate workflow activity when the expected removal result is not obtained.

Example:

Remove User → False → Handle Removal Result

This provides a defined workflow path for the non-True result.

Record the User-Removal Operation

Where workflow administration requires it, place appropriate logging or documentation around the removal operation.

Example:

Identify User → Remove User → Record/Continue

This can make the workflow's intent easier to understand when reviewing workflow execution.

Use the Step in User Administration Workflows

The Users category classification makes this step appropriate for workflows that contain user-related operations.

Example:

Evaluate User → Remove User → Complete Administration Process

The exact criteria for removing a user should be implemented by the surrounding workflow logic.

Example:

Let’s build and execute the “removeUserDef” example.          

• Create a new definition called “removeUserDef” and open it in Designer mode.
• Drag the “getWorkflowUserID, removeUser” step to the canvas.
• Connect the dots between the “Start” step and other steps, as shown above.
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, additional values are available for configuration.
• Define a variable or a global to store the User-ID. 
• Click the “getWorkflowUserID” step to configure its “Required” properties. Provide a name for the step. Enter the user name to fetch. Specify a variable or a global reference to store the user ID. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• Click the “removeUser” step to configure its “Required” properties. Provide a name for the step. Provide a variable or a global reference that contains the user ID from the previous steps. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• 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 instance, and execute it. Render the process instance and click the process step to view its properties. When the workflow reaches the Remove User step, FlowWright uses the supplied workflowUserID to identify the selected user. The step is explicitly defined as “Removes a selected user.” The workflow can then follow the True-or-False return path defined for the step. Navigate to the Users menu—Users to confirm that this user has been removed.

Before:

After:

Tips:

• Verify that workflowUserID contains the intended process user ID before the step executes.
• Use a meaningful Variable name when storing the user ID.
• Use a dynamically supplied user ID when the target user is determined during workflow execution.
• Test the workflow with a representative user before deploying it.
• Verify that preceding workflow activities correctly identify the intended user.
• Avoid hard-coding a user ID when the target user can change between workflow instances or environments.
• Make sure the value supplied to process user id is the correct ID expected by the step.
• Consider connecting both the True and False return paths to appropriate subsequent workflow activities.
• Provide appropriate handling for a False result.
• Use Logging to document the operation when user-removal activity needs to be traceable within workflow execution.
• Test the workflow when the supplied user ID is missing or invalid.
• Test scenarios in which the selected user is unavailable or cannot be processed as expected.
• Review workflows using this step when user-management requirements change.
• Keep user-selection logic separate from the removal operation where possible. This makes the workflow easier to understand and maintain.
• Use meaningful workflow step names that describe why the user is being removed.
• Do not assume additional behavior, such as the removal of related workflow data, forms, assignments, or other records, unless confirmed by the FlowWright implementation.
• Do not assume that the False return value represents a particular error condition unless confirmed by the FlowWright implementation.
• Exercise particular care when the user ID is determined dynamically because an incorrect ID could cause the operation to target an unintended user.

Notes:

• The Remove User step is defined in the Users category with the internal name removeuser, label “Removes a selected user”, namespace FlowWright.Workflow.RemoveUser, and display name “Remove User.”
• The step is implemented by FlowWright.Workflow.RemoveUser in FlowWright.Workflow.dll and is defined as a Process step with 2 incoming connections and 2 outgoing connections.
• The step defines one required property:
  • workflowUserID – process user ID. 
• The workflowUserID property uses the string data type, implemented by FlowWright.DataTypes.ClsTextBox in FlowWright.DataTypes.dll.
• The step provides two return values:
  • False
  • True

Definition Sample:

You may provide a sample definition for the Remove User step for download and later import it into the FlowWright Process Definition XML page.

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

• Process user ID.
• Variable or workflow value containing the user ID.
• Workflow Variable references.
• Environment-specific settings.
• Target user.
• Downstream True and False workflow paths.
• Logging configuration.

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

Click here to download the sample file.