Tenant based dataset cache provides an on-demand data cache generation approach for each tenant, rather than generating a single cache for all tenants. By using this feature, the cache generation process will not retrieve all the data rows from the remote data source and will save time, as generating the full data cache takes a long time. This way the tenant users will get access to a subset of relevant data rows. You can use the Generate tenant (Organization context)-based caches setting to generate the data caches for each tenant. By default, this setting is disabled. You can enable it to create separate caches for each organization having adequate permission on the dataset.

Note: The setting Generate tenant(Organization context)-based caches appears under the Options tab after adding at-least one Organization-context based parameter.

Generate Tenant Based Dataset Cache

Follow the below steps to generate a tenant-based dataset cache:

In the below example, we have taken an organization context State defined in the admin portal. It is multivalued and has values as Victoria and Queensland.

1. On the dataset designer, click the Parameters tab, and click the + Add Parameter option. Select the Parameter Type as Organization Context. Select the Multivalue checkbox, and Context Field as State.

   
   

2. Click the Options tab, you will be able to see the Generate tenant(organization context)-based caches setting.

   
   

   
   

3. Enable the Generate tenant(organization context)-based caches setting. Now we will use organization-context based Parameter in the filter. Click the Filters tab, under the Table section, and click Add Filter. Select State as the organization context-based filter.

   
   

   
   

4. Now save the dataset and preview it. You will be able to view the organization context-based filtered data.

   
   

   
   

   So, if the property Generate tenant(organization context)-based caches is set to True, then we will be able to see the multiple caches being created in the Admin portal (System Management-> Dataset Cache page) as shown below.

   
   

   
   

   If this property is set to False, then we will be able to see only a single cache being created in the Admin portal (System Management-> Dataset Cache page) as shown below.

   
   

Backward Compatibility

If an existing dataset is modified by changing the setting from False to True, the auto cache generation will adhere to the new setting. This means that it will generate a tenant-based cache for the current user's tenant. Subsequent refresh operations triggered by scheduled tasks, administrators, or manual refreshes will also recognize the updated setting value.

Conversely, if an existing dataset is modified by changing the setting from True to False, any cache refresh operation will generate a single cache that encompasses all tenants together.

Important Points

1. When the Generate tenant(organization context)-based caches setting item is turned on, the organization context parameters can be used in the table filter.

2. If the organizational context is modified, the cache will not be triggered to be refreshed. You need to refresh the cache manually.

3. When editing the dataset, if the organization context parameter is used in the filter, and the Generate tenant-based caches switch is enabled in the Options and then saved:

• The cache will be refreshed.

• The Dataset Cache of the admin portal only displays the tenant-based cache.

4. When editing the dataset again, if the organization context parameter is used in the filter, turn off the Generate tenant-based caches switch in the Options and click save.

• The cache will be refreshed.

• The Dataset Cache of the admin portal only displays a non-tenant-based cache.

5. The cache generation of a dataset with tenant-based security filters can be triggered in the following situations:

• The dataset is shared with another tenant.

• The dataset is modified and saved.

• The user manually clicks the Refresh cache button in the document portal.

• A scheduled task is triggered to refresh the dataset cache.

• An administrator initiates the 'refresh caches (for existing related tenants)' function in the admin portal.

6. Separate caches for separate organizations appear for a single dataset in the System Management -> Dataset Cache page in the Admin portal.