clsDisableTenant Step

Use this step to disable a selected tenant

Last published at: September 13th, 2024

Description:

The step disables the selected tenant.

 

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 “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 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 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 new process instance, and execute.  The process step should disable the selected tenant as configured.

 

Definition Sample:

You may download the sample definition from the link here and later import it (drag-drop) to your FlowWright Process (XML) and Form Definition (HTML) page. After import, you must verify the process steps and complete the database configuration, if any. 

 

https://github.com/FlowWrightCode/FW10Steps/blob/main/DisableTenantDef.xml