UserTenant (PQL)

Returns the name of the Pyramid tenant that houses the currently logged in user.

  • Returned Output: Text
  • Library: PQL \ Granular \ Identity
  • Version: 2023.00.000
  • Compatibility: Pyramid Query Language (PQL) data sources

Syntax

UserTenant()

Comments
  • The function returns a value, rather than performing an operation on a given column.The value can then be used to drive derivative logic. The various Identity values are often used to secure data based on the current end user or create personalized values for the end user.
  • For details on how to employ and use this function see the custom column overview.
Different Function types
  • This function is similar to the PQL common functions of the same name. However, it operates inside the query at the grain.
  • As a granular function, it is used in the base SQL query itself.

Examples

This example injects the current user's tenant name into a another function (IF) to derive each items values in a column. If the values in the tenant column of the security table match the current user's tenant, then it returns true, otherwise it returns false.

If([Security].[tenant]==UserTenant(), true, false)