clsTenantTest Step

Use this step to test the tenant database for readiness.

Last published at: July 3rd, 2023


Test if tenant database is ready or not. 


  • Tnconnection – Tenant manager connection string
  • Tnnameid – Tenant/Host Name or ID
  • Message – Variable/Global to hold the message



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




Let’s build and execute the TenantTestDef example.      

  • Create a new process definition called “TenantTestDef”
  • Select the definition and click the “design” button
  • Drag a "clsTenantTest" step to the canvas
  • Connect the dots between the start and clstenanttest step
  • Configure variable "tenantTest" as string
  • Click on the "clsTenantTest" step to configure its "Settings" properties. Provide a name to the step. Select the connection string. Provide the Tenant Name or GUID value. Provide a variable/global to hold the message after execution. 
  • Click on the "clsTenantTest" 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 new process instance and execute.  The step should display a message whether the tenant database is ready or not, as configured.