GetTenantId Step

Use this step to get tenantID by the tenant name.

Last published at: September 22nd, 2024

Description:

Gets 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 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 a string 
  • Click the "clsGetTenantID" step to configure its "Settings" properties. Give the step a name. Select the connection string. Provide the Tenant Name or GUID value. Provide a variable or global to store the tenant ID. 

 

  • Click on the "clsTenantTest" step to configure its "Logging" properties (optional). Provide the description, log message, and documentation. 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 the tenant ID as configured.

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-drop) to 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 import. Then, save the definition to confirm the changes.

Click here to download the sample file.