clsCreateNewTenant Step

Use this step to create a new tenant using a template

Last published at: January 2nd, 2024


This step creates a new tenant from the template.



  • Tnconnection – Tenant manager connection string
  • Tnname – Tenant/Host Name
  • Tndbname – Tenant Database name
  • tnid-- Variable/Global to hold Tenant ID



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






Let’s build and execute the createNewTenantDef example. 

  • Create a new process definition called “CreateNewTenantDef”
  • Select the definition and click the “design” button
  • Drag a clsCreateNewTenant step to the canvas
  • Connect the dots between the start and  clsCreateNewTenant step
  • Define a variable/global to store the result after execution
  • Click on the "clsCreateNewTenant" step to configure its "Settings" properties. Provide a name to the step. Provide the tenant manager connection from the drop down list. Provide the new tenant name. Provide the database name. Provide the variable/global reference to store the new tenant 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 generate a new tenant as configured.