RemoveTenant Step

Use this step to remove a tenant.

Last published at: September 22nd, 2024

Description:

Removes the selected tenant and deletes its FlowWright database.   

 

Inputs

  • Tnconnection – Tenant manager connection string
  • Tnnameid – Tenant/Host Name or ID
 

 

Returns

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

 

Usage:

 

 

Example:

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

  • Create a new definition called “clsRemoveTenantDef”
  • 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 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. 

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the 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 process instance, and execute. As configured, the process step should remove the selected tenant and its FlowWright database.

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-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 import. Then, save the definition to confirm the changes.

Click here to download the sample file.