Description:

The Create New Tenant workflow step creates a new FlowWright tenant from a workflow and stores the resulting tenant ID for use by subsequent workflow activities.

The step supports:

• Selecting a Tenant Manager connection.
• Specifying the new tenant name.
• Specifying the tenant database name.
• Storing the generated tenant ID in a Variable or Global variable.
• Continuing the workflow through the True return path when the operation succeeds.
• Using the False return path when the operation does not succeed.
• Using the step as part of automated tenant provisioning workflows.

Usage:

The Create New Tenant step is typically used when a workflow needs to provision a new tenant as part of an automated administrative or onboarding process.

The workflow provides the Tenant Manager connection, tenant name, and tenant database name. The workflow then performs the tenant creation operation and stores the resulting tenant ID in the configured Variable or Global variable for subsequent workflow activities.

A typical workflow pattern is:

Collect Tenant Information → Create New Tenant → Use Tenant ID

The resulting tenant ID can then be used by later workflow steps to:

• Track the newly created tenant.
• Perform additional tenant-related processing.
• Pass the tenant identifier to subsequent workflow activities.
• Record the created tenant in workflow data.
• Continue tenant provisioning or onboarding activities.
• Determine the next workflow path based on the True or False result.

Typical Workflow Suggestions:

Provision a Tenant During Customer Onboarding

Use the step to automatically create a tenant after receiving the required customer or tenant information.

Example:

Customer Onboarding → Create New Tenant → Continue Provisioning

The tenant name and database name can be supplied from workflow Variables, while the generated tenant ID can be stored for subsequent onboarding activities.

Create Tenants from an Administrative Request

Use the step when an administrator submits a request to create a new tenant.

Example:

Tenant Creation Request → Validate Request → Create New Tenant → Notify Administrator

The workflow can use the True path to continue the successful provisioning process and the False path for an alternative handling path.

Automate Tenant Provisioning

Use the step as part of a larger automated tenant provisioning workflow.

Example:

Collect Configuration → Create New Tenant → Store Tenant ID → Configure Tenant

The step-stored tenant ID can serve as an identifier for subsequent workflow activities.

Create Multiple Tenants from Workflow Data

Use the step in a workflow that processes tenant information supplied from another source.

Example:

Read Tenant Data → Create New Tenant → Record Tenant ID → Process Next Tenant

Each workflow execution can supply the tenant name and tenant database name required by the step.

Route the Workflow Based on Tenant Creation

Use the True and False return paths to control what happens after the tenant creation operation.

Example:

Create New Tenant → True: Continue Process / False: Handle Failure

The success path can continue tenant provisioning, while the alternative path can connect to an appropriate administrative or error-handling activity.

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. 
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• 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. Configure 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. When the workflow reaches the Create New Tenant step, FlowWright uses the configured Tenant Manager connection and tenant information to perform the operation. The resulting tenant ID is stored in the configured Variable or Global variable for use by subsequent workflow activities.

Tips:

• Use a meaningful tenant name that clearly identifies the tenant.
• Use a consistent naming convention for tenant database names.
• Verify that the selected Tenant Manager connection is the intended environment.
• Define the tenant ID destination Variable or Global before configuring downstream activities.
• Use a meaningful Variable or Global name such as newTenantID.
• Connect the True path to the next provisioning activity.
• Connect the False path to appropriate alternative or failure-handling logic.
• Validate tenant names and database names before invoking the step.
• Avoid hard-coding environment-specific values when you can supply them through workflow configuration.
• Test the workflow with representative tenant information before deploying it.

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.