CreateNewTenant Step

Use this step to create a new tenant using a template.

Last published at: January 19th, 2026

Description:

This step creates a new tenant using the template.

 

Inputs

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

  

Returns

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

 

 

Usage:

 

 

Example:

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

  • Create a new process definition named “CreateNewTenantDef” and open it in Designer mode.
  • Drag a clsCreateNewTenant step to the canvas.
  • Connect the dots between the “Start” and  “clsCreateNewTenant steps, as shown above. 
  • Define a variable or a global to store the result.
  • Click the "clsCreateNewTenant" step to configure its "Required" properties. Provide a name for the step. Select the tenant manager's connection from the drop-down list. Enter the new tenant's name. Enter the database name. Enter a variable or global reference to store the new tenant GUID. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

 

  • The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. This is achieved by configuring the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a new instance, and execute it. The process step should create a new tenant as configured.

 

Definition Sample:

You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Note: Please verify and complete the import process steps for any missing configurations, such as file path references and database connections. Then, save the definition to confirm the changes.

Click here to download the sample file.