clsRemoveTenant Step

Use this step to remove a tenant.

Last published at: June 27th, 2023


Removes the selected tenant and delete its FlowWright database.   


  • 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 RemoveTenantDef example.              

  • Create a new definition called “RemoveTenantDef”
  • Select the definition and click the “design” button
  • Drag a "clsRemoveTenant" step to the canvas
  • Connect the dots between the start and "clsRemoveTenant" step
  • Click on the "clsRemoveTenant" step to configure its “Settings” properties. Provide a name to the step. Select the connection string. Provide the Tenant Name or GUID value. 
  • Click on the "clsRemoveTenant" step to configure its "Logging" properties (optional). Provide the description, log message and documentation info. Click on "Save" to confirm the changes.
  • Save the process definition, create a process instance and execute. The process step should remove the selected tenant and its FlowWright database, as configured.