clsGetTenantId Step

Use this step to get tenantID by the tenant name.

Last published at: January 2nd, 2024


Gets the Tenant ID information from the tenant name. 



  • TnConnection – Tenant manager connection string
  • TnName – Tenant/Host Name
  • TnID – Variable / Global to store the tenant ID



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






Let’s build and execute the GetTenantIdDef example.    

  • Create a new definition called “GetTenantIdDef”
  • Select the definition and click the “design” button
  • Drag a "clsGetTenantID" step to the canvas
  • Connect the dots between the start and "clsGetTenantID" step
  • Configure variable "tenantID" as string 
  • Click on the "clsGetTenantID" step to configure its "Settings" properties. Provide a name to the step. Select the connection string. Provide the Tenant Name or GUID value. Provide a variable/global to store the tenant ID. 
  • Click on the "clsTenantTest" step to configure its "Logging" properties (optional). Provide the description, log message and documentation info. Click on "Save" to confirm the changes.
  • Save the process definition, create a new process instance and execute. The process step should update the variable/global with tenant ID as configured.