Returns the tenant ID that is recorded in the client-principal object for an OpenEdge multi-tenant database. A tenant ID is returned if this client-principal instance has been used to set the connection identity for the specified multi-tenant database. The association of this tenant ID and multi-tenant database persists for this instance of the client-principal and cannot be removed for the duration of the user login session identified by this client-principal.

Return type: INTEGER

Applies to: Client-principal object handle

Syntax

TENANT-ID ( [db-exp] )
db-exp
An optional character expression that evaluates to a case-insensitive logical or alias name of a multi-tenant OpenEdge RDBMS. This expression can be unspecified or evaluate to the Unknown value (?) only if the client-principal object has been used to establish identity for a single OpenEdge database connection.

The method can return the following values:

  • A recorded tenant ID — If tenant information is stored in the client-principal for the database specified by db-exp
  • The Unknown value (?) —
    • If no tenant information is stored in the client-principal for the database specified by db-exp, or
    • If the specified database has multi-tenancy enabled and the client-principal object has not been used to set its connection identity, or
    • If the client-principal object is generated by an external security system
  • Zero (0) — If the database specified by db-exp does not have multi-tenancy enabled
    Note: Zero (0) can also be the ID of a valid tenant in a database configured for multi-tenancy. Therefore, the tenant ID return value is not a reliable indicator if a database has multi-tenancy enabled.

ABL raises ERROR if:

  • The client-principal object is in the INITIAL or FAILED state (see the LOGIN-STATE attribute entry)
  • The expression specified by db-exp evaluates to the Unknown value (?) and multiple OpenEdge databases are connected

See also

DB-LIST attribute, TENANT-NAME( ) method