The Remove participant block removes a participant from a work item as a step in a visual workflow. The block removes the participant from every role that they hold on that work item.

Common uses

• Remove a third party from a matter after their involvement ends, for example an insurer after a claim settles.
• Remove a participant that an earlier step added for a temporary purpose.
• Pair the block with the Add participant block to replace one participant with another.

Before you start

• You need access to Modeller > Workflow > Workflows to edit the visual workflow.
• The workflow must have a variable that holds the ID of the work item. The variable must have the type Work Item Identifier. You define variables on the Data tab of the workflow.
• The workflow must have a variable that holds the ID of the participant to remove. The variable must have the type Participant Identifier.
• The execution engine runs the block as the ee-app client. That client must hold the Update any sharedo and Read any sharedo permissions. Most environments have both already. To check, see Check the execution engine permissions below.

Load the participant ID

Add a Load work item data block before the Remove participant block, and map the participant ID of the role that the participant holds.

1. In the Load work item data properties, set Source work item variable and Expected source Work Item Type.
2. Under Variables, select Map variable. The Context Browser opens.
3. Select Work Item, then Participant Roles, then the role, for example ATE Insurer.
4. Select ParticipantId, then select the + icon. The path is, for example, workitem.roles.ate-insurer.participantId.
5. Select Confirm.
6. In the list under the path, select the Participant Identifier variable that holds the value.

Add the Remove participant block

1. Navigate to Modeller > Workflow > Workflows and open the visual workflow.
2. In the panel to the right of the canvas, select the Toolbox tab.
3. In the Data category, drag Remove participant onto the step where the removal must happen.
4. In the step, drag the block so that it sits after the Load work item data block and before any Go to action. Actions in a step run from top to bottom.
5. Select the block. The Properties tab displays its configuration.
6. Complete the fields described in the table below.
7. Select Save and Publish.
8. In the Publish Version dialog, enter a Version, then select Publish.

If a required field is empty, the field displays a validation message, and the step displays "Step has errors". You cannot save the workflow until you complete the fields. The messages are "Select the variable holding the work item to remove a participant from" and "Select the variable holding the participant to remove".

How the block removes a participant

• The block removes the participant from the work item, including every role that they hold on it. The block cannot remove a single role.
• The person, organisation or team stays in the ODS. You can add them to the work item again later.
• Other participants on the work item are not affected.
• The step log records the participant ID, the work item ID and the status that the removal returned.

Mandatory roles

A work item must always have a holder for each mandatory role. If the participant is the last holder of a mandatory role, the block refuses the removal and the step fails. If another participant also holds that role, the block removes the participant.

To replace the holder of a mandatory role, add the new participant first with an Add participant block. Then remove the old participant.

Check the execution engine permissions

You need the Administer identity server permission to open the identity server settings.

1. Navigate to Admin > Integrations > Manage Identity Server.
2. Find the ee-app card. The card displays Sharedo Event Engine and Client credentials flow.
3. Select Edit on that card. Do not use the ee-app-impersonate card, which is a different client.
4. In the Client permissions section, check that the list includes Update any sharedo and Read any sharedo.

5. If a permission is missing, enter its name in the permission search field and select it from the results.
6. Select Save.

Clio Operate displays "Client was updated successfully". The change applies to the next workflow run.

Error messages

If the block cannot remove the participant, the step fails and the workflow does not continue past the block. The step log displays one of these messages. To view the log, navigate to Modeller > Workflow > Workflow Instances and open the instance. In Process Info, select the menu icon on the failed step to open the Execution Log.

Related articles

• Add Participant - Workflow Toolbox
• Load work item data - Workflow Toolbox
• Everything you need to know about Configuring Participants
• Calling Clio Operate APIs from an external application