Description:

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

The Get Tenant URL step uses a configured Tenant Manager connection, along with a tenant name or ID, to retrieve the tenant URL. The resulting URL is stored in a specified Variable or Global variable.

The step supports:

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

This step can be used for:

• Tenant-aware workflow processing
• Tenant URL resolution
• Multi-tenant application integration
• Building tenant-specific API or integration requests
• Determining the destination URL for tenant operations
• Tenant provisioning and administration workflows
• Passing tenant URLs to subsequent workflow steps

Usage:

The Get Tenant URL step is typically placed after the workflow has obtained a tenant name or ID and before any operation that requires the tenant's URL.

The workflow can dynamically supply the tenant name or ID from:

• Workflow Variables
• Global variables
• Form values
• Previous workflow outputs
• Tenant-related processing
• Data retrieved from external systems

The retrieved URL can then be used by later workflow steps to:

• Build tenant-specific requests
• Identify a tenant endpoint
• Invoke integrations
• Route processing
• Populate Variables
• Support tenant administration
• Continue tenant-specific automation

Example:

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

• Create a new definition named “GetTenantURLDef” and open it in designer mode. 
• Drag a "clsGetTenantURL" step to the canvas.
• Connect the dots between the “Start” and "clsGetTenantURL" steps, as shown above. 
• Define a variable or a global variable to store the tenant URL.
• Click the "clsGetTenantURL" step to configure its "Required" properties. Provide a name for the step. Select the connection string. Enter the Tenant Name or GUID value. Specify the variable or global reference to store the tenant URL. Click the Save button. Note: Click the "AI Predict" button to have the 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 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 URL step, the configured Tenant Manager connection is used to retrieve the URL for the supplied tenant name or ID. The resulting tenant URL is stored in the configured Variable/Global, and the workflow follows the appropriate execution path.

Tips:

• Select the correct Tenant Manager connection before executing the workflow.
• Use either the tenant name or the tenant ID based on the information already available.
• Store the result in a clearly named Variable/Global such as TenantURL.
• If the tenant ID is already available, use it rather than unnecessarily resolving the tenant name again.
• Use the True and False paths to implement appropriate handling of success and failure.
• Test the workflow with representative tenant names and IDs before deployment.
• When using the URL in downstream integrations, validate that the receiving step expects the tenant URL to be returned in the same format as this step.
• Store the resolved URL when it will be needed by several downstream operations rather than repeatedly retrieving it.
• Keep tenant resolution separate from the business logic that consumes the tenant URL where practical.

Notes:

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

Get Tenant URL vs. Get Tenant ID:

Both steps are Tenant Manager lookup operations, but they resolve different tenant attributes.

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

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

When to Use Get Tenant URL.

Use Get Tenant URL when the workflow needs the tenant endpoint/URL.

When to Use Get Tenant ID.

Use Get Tenant ID when the workflow has the tenant name and needs its internal identifier.

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 or ID
• Tenant URL Variable/Global
• Environment-specific settings
• Workflow connections

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

Click here to download the sample file.