Description:

The Get Tenant ID workflow step belongs to the Tenants category in FlowWright. Its internal name is clsgettenantid, its label is Gets the tenant id information, and its display name is Get Tenant ID. The step uses the FlowWright.Workflow.ClsGetTenantID namespace and FlowWright.Workflow.dll. It is defined as a Process step with two input connections and two output connections.

The Get Tenant ID workflow step uses a configured Tenant Manager connection and a tenant name to retrieve the corresponding tenant ID. The resulting tenant ID is stored in a specified Variable or Global variable.

The step supports:

• Retrieving a tenant ID using a tenant name
• Selecting a Tenant Manager connection
• Storing the tenant ID in a Variable or Global variable
• True/False workflow branching 

This step can be used for:

• Tenant-aware workflow processing
• Customer or tenant identification
• Tenant provisioning workflows
• Retrieving a tenant identifier before subsequent tenant operations
• Passing tenant IDs to other workflow operations
• Building tenant-specific integrations
• Supporting automated multi-tenant administration

Usage:

The Get Tenant ID step is typically placed after the workflow has obtained or generated a tenant name and before operations that require the tenant's identifier.

The retrieved tenant ID can subsequently be used to:

• Identify the tenant
• Retrieve additional tenant information
• Perform tenant-specific processing
• Build tenant-aware API or integration requests
• Continue tenant provisioning
• Store tenant information for later workflow steps

Example:

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

• Create a new definition named “GetTenantIdDef” and open it in designer mode. 
• Drag a "clsGetTenantID" step to the canvas.
• Connect the dots between the “Start” and "clsGetTenantID" steps, as shown above. 
• Define a variable or a global to store the tenant ID.
• Click the "clsGetTenantID" step to configure its "Required" properties. Provide a name for the step. Select the tenant manager connection string from the drop-down list. Enter the Tenant Name or GUID value. Specify the variable or global reference to store the tenant ID. Click the Save button. Note: Click the "AI Predict" button for the Copilot to 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 in the images below. Configure the “Logging” using the following properties.

• Save the Process Definition. Create a new Process Instance and execute it. When the workflow reaches the Get Tenant ID step, the configured Tenant Manager connection is used to retrieve the tenant ID for the supplied tenant name. The resulting tenant ID is stored in the configured Variable/Global, and the workflow follows the appropriate execution path.

Tips:

• Configure the correct Tenant Manager connection.
• Ensure the tenant name matches the tenant that should be identified.
• Store the result in a clearly named Variable/Global such as TenantID.
• Use the resulting tenant ID in downstream tenant-specific processing.
• Handle the False path explicitly rather than allowing tenant-resolution failures to go unnoticed.
• Test the workflow with representative tenant names before deployment.
• If tenant names are generated dynamically, ensure the generated name corresponds to an existing tenant before attempting to retrieve its ID.
• Avoid unnecessarily repeating the lookup when the tenant ID is already available in a workflow Variable/Global.
• Keep tenant identification separate from subsequent tenant configuration or business logic where practical.

Notes:

• Category: Tenants. 
• Internal name: clsgettenantid. 
• Label: Gets the tenant ID information. 
• Display name: Get Tenant ID. 
• Namespace: FlowWright.Workflow.ClsGetTenantID. 
• DLL: FlowWright.Workflow.dll. 
• Step definition type: Process. 
• Input connections: 2. 
• Output connections: 2. 
• Tenant Manager connection: Required. 
• Tenant name: Required. 
• Tenant ID destination: Required. 
• Returns: True and False.

Get Tenant ID vs. Get Tenant URL:

Both steps are closely related Tenant Manager lookup operations, but they retrieve different pieces of tenant information.

Get Tenant ID accepts a tenant name and stores the resulting tenant ID.

Get Tenant URL accepts a tenant name or ID and stores the resulting tenant URL

When to Use Get Tenant ID.

Use Get Tenant ID when the workflow knows the tenant's name and needs the corresponding tenant identifier.

When to Use Get Tenant URL.

Use Get Tenant URL when the workflow needs the URL associated with a tenant.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them into the FlowWright Process Definition (XML file) page.

Note: Verify and complete any missing configuration after importing the sample, including:

• Tenant Manager connection
• Tenant name
• Tenant ID Variable/Global
• Environment-specific settings
• Workflow connections

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.