Exago Logo
Generic filters
Exact matches only

Multi-Tenant Environment Integration

Exago supports a variety of approaches to make sure that users can only access the data that is assigned to them. These approaches can eliminate the need to create different reports for each user. This can be done in one of four ways. Using either column, schema, database, or custom SQL based tenancy.

Column-Based Tenancy

The most basic multi-tenant environment is when each table, view and stored procedure has one or more columns that indicate which users have access to each row.

To set column based tenancy in Exago:

  1. Create a Parameter for each tenant column.


    For these parameters set Hidden to False.

  2. For each Data Object click the Tenant Columns dropdown. Use the Tenant Columns menu to match each tenant column in the data object with its corresponding parameter.
  3. When initializing Exago through the API, set the value of each tenant parameter for the current user.

Disabling Column Tenancy

While disabling tenancy on any tenant columns of a data object is a noted security risk, it proves useful for administrators to be able to briefly disable tenancy for testing purposes. Disabling tenancy simplifies testing by allowing administrators to troubleshoot the dataset without having to remove and re-add tenant columns on each data object.


Tenancy should be disabled for testing purposes only. Do not allow non-administrative users to access data objects with disabled tenancy columns. Doing so can potentially expose sensitive data.

In versions prior to v2019.1, column tenancy can be disabled by leaving the Tenant Parameters value empty causing tenancy to be ignored for that Tenant Column.

Following changes to tenant parameter values in v2019.1+, any Tenant Parameters values set to an empty value will be recognized as an empty string rather than a null value. To continue disabling tenancy in these versions, the parameter value must be set to {disabletenancy}.

Row-Based Tenancy

With Roles, security filters can be added to data objects so that users can only view specific rows in the data object.

In the example below, this role will only be able to see data on reports where the EmployeeID field is equal to 4.

Row Based Filter dialog in Admin Console Role configuration tab

To set row-based tenancy in Exago via the Admin Console, visit the Filters Access section of the Roles article.

Row based filters can also be added with the REST Web Service API and .NET API.

To delete a row based filter, click the Delete DeleteItem.png icon at the end of the associated row.

Schema-Based Tenancy

Some multi-tenant environments create multiple tables/views/stored procedures with the same name and columns but different database schema. Information is then stored in the appropriate table based on database schema.

To set schema based tenancy in Exago:

  1. On the Data Source set Schema/Owner Name to any valid value.
  2. For each table/view/stored procedure create a data object. In the Name dropdown select the object that utilizes the schema value used in step (1). This will tell Exago that for this data object it should retrieve the schema from the data source.
  3. When initializing Exago through the API, set the schema on the data source for the current user.

Database-Based Tenancy

Another way to assure that each user can only access their data is to provide a separate database for each user. In this situation each database should have the same tables, views and stored procedures.

To support database based tenancy in Exago:

  1. Create a data source and corresponding data objects using any one of the databases.
  2. When initializing Exago through the API, set the connection string on the Data Source to access the appropriate database for the current user.

Custom SQL Based Tenancy

Multi-Tenant security can also be assured by using Custom SQL for all data objects. Exago can pass parameter values into each SQL statement to filter data based on user.

To set Custom SQL based tenancy in Exago:

  1. For each data object open the Custom SQL menu and create the desired SQL utilizing parameters to assure only appropriate information is available.
  2. When initializing Exago through the API, set the value of any parameters utilized in the SQL for the current user.


    Parameters should be surrounded by single quotes.

Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents