Description:

The Disable Tenant workflow step disables a selected tenant in FlowWright. The tenant is identified by tenant name or tenant ID, and the step uses a configured Tenant Manager connection to perform the operation.

The step supports:

• Selecting a Tenant Manager connection.
• Specifying the tenant by name or ID.
• Disabling a selected tenant from within a workflow.
• Using workflow variables for dynamic tenant identification.
• Routing the workflow based on whether the tenant-disable operation returns True or False.
• Integrating tenant administration into automated workflow processes.

Usage:

The Disable Tenant step is typically used in workflows that automate tenant administration or tenant lifecycle activities.

A workflow can determine the tenant to disable, select the appropriate Tenant Manager connection, and then pass the tenant name or ID to this step.

A typical workflow pattern is:

Identify Tenant → Disable Tenant → Evaluate Result → Continue or Handle Failure

The tenant name or ID can be supplied directly or populated dynamically from workflow data, allowing the same workflow definition to operate on different tenants.

Typical Workflow Suggestions:

Disable Tenant During Tenant Decommissioning

Use the step when a tenant is being removed from active use, and the workflow needs to automate the tenant-disabling operation.

Example:

Tenant Decommission Request → Validate Tenant → Disable Tenant → Record Completion

The workflow can identify the tenant from the decommission request and pass its tenant name or ID to the Disable Tenant step.

Disable Tenant After Subscription or Service Termination

Use the step as part of a workflow that processes the termination of a tenant's service or subscription.

Example:

Service Termination → Validate Request → Disable Tenant → Send Confirmation

The tenant identifier can come from the termination request and be supplied to the step.

Disable Tenant for Administrative Operations

Use the step when an administrative workflow needs to disable a tenant as part of a controlled operational procedure.

Example:

Admin Request → Approval → Disable Tenant → Log Result

Use the True and False paths to distinguish successful and unsuccessful execution.

Disable Tenant Based on a Business Rule

Use the step after workflow logic determines that a particular tenant should no longer remain active.

Example:

Evaluate Tenant Status → Disable Tenant → Continue Administrative Process

The tenant name or ID can be populated from a workflow variable before the step executes.

Disable Multiple Tenants Through a Controlled Workflow

Use the step as part of a workflow that processes tenant records individually.

Example:

Get Tenant List → For Each Tenant → Disable Tenant → Record Result

The tenant identifier for the current iteration can be supplied to the Tenant Name or ID input.

Example:

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

• Create a new definition named “DisableTenantDef” and open it in designer mode. 
• Drag a “clsDisableTenant” step to the canvas.
• Connect the dots between the “Start” and “clsDisableTenant” 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, you can configure additional values.
• Click the "clsDisableTenant" step to configure its "Required" properties. Provide a name for the step. Select the tenant manager connection from the drop-down list. Enter the tenant name or GUID. Click the Save button. Note: Click the "AI Predict" button to have the 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. Configure the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it.  The process step should disable the selected tenant as configured.

Tips:

• Always configure the required Tenant Manager connection before executing the step.
• Verify that the Tenant Name or ID identifies the intended tenant.
• Use a workflow variable when the tenant is determined dynamically.
• Use the True return path for the normal continuation of the workflow.
• Use the False return path for failure handling or an alternate workflow path.
• Validate tenant-related input before executing the step when the value originates from user input.
• Use meaningful workflow logging when tenant administration actions need auditing.
• Avoid hard-coding tenant identifiers when the same workflow needs to operate on multiple tenants.
• Consider placing approval or validation activities before the Disable Tenant step when the operation is part of a controlled administrative process.
• Test both True and False paths before deploying the workflow to production.
• Ensure that the configured Tenant Manager connection is appropriate for the environment in which the workflow executes.
• When processing multiple tenants, pass the current tenant's name or ID to the step for each workflow iteration.

Definition Sample:

A process definition containing the Disable Tenant step can be created and configured in the FlowWright Process Designer.

When configuring the sample, verify:

• Tenant Manager connection.
• Tenant name or ID.
• Workflow variable references, if used.
• The True workflow path.
• The False workflow path.
• Any required logging or documentation settings.
• Environment-specific connection configuration.

After verifying the configuration, save the process definition before executing a process instance.

Click here to download the sample file.