removeUser Step
Description:
This step removes a selected user from the FlowWright Users Group.
Inputs
- workflowUserID – user id of the user
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
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” steps and other steps, as shown above.
- 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. Click the process step to view its properties. The step shows the user name removed from the FlowWright users group. Navigate to the Users menu—Users to confirm that this user has been removed.
Before:
After:
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after the import. Then, save the definition to confirm the changes.