clsDisableTenant Step

Use this step to disable a selected tenant

Last published at: January 2nd, 2024


The step disables the selected tenant.



  • TnConnection – Tenant manager connection string
  • TnNameID – Tenant/Host Name or ID



  • True – step executed successfully
  • False - step failed to execute






Let’s build and execute the DisableTenantDef example.  

  • Create a new definition called “DisableTenantDef”
  • Select the definition and click the “design” button
  • Drag a “clsDisableTenant” step to the canvas
  • Connect the dots between the start and “clsDisableTenant” step
  • Click on the "clsDisableTenant" step to configure its "Settings" properties. Provide a name to the step. Select the tenant manager connection from the drop down list. Provide the tenant name or GUID information. 
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived 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.  The process step should disable the selected tenant as configured.