GetTenantId Step
Description:
This step retrieves the Tenant ID information from the tenant's name.
Inputs
- TnConnection – Tenant manager connection string
- TnName – Tenant/Host Name
- TnID – Variable / Global to store the tenant ID
Returns
- True – step executed successfully
- False – step failed to execute
Usage:

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 instance, and execute it. The process step should update the variable or global with the tenant ID 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 process steps for any missing configurations, such as file path references and database connections, after the import. Then, save the definition to confirm the changes.
Click here to download the sample file.