This documentation is for the legacy Izenda 6 product. Documentation for the new Izenda 7 product can be found at https://www.izenda.com/docs/
What kinds of caching does Izenda use? Can I update the cache?
Izenda caches your queries, reports and schema information automatically per browser session. By default, caching is stored in memory and in the temp folder of the server that Izenda is hosted on.
Since Izenda 188.8.131.52, Izenda checks the Database Schema cache available to it against the VisibleDataSources array set in InitializeReporting() to make sure it has every data sources it needs, and will update the cache accordingly, if necessary. This eliminates the need for AdHocSettings.PerUserCaching = true, which tells Izenda to store a separate copy of the database schema cache for each user in session.
Here is a list of the caching methods - and links to their individual articles - that are available in case you wish to manipulate the different caches, although generally the caches will self-update as needed:
The AdHocConfig.FilteredListReports method will return a list of reports that are guaranteed to be available to the current user. This means that the reports were found in storage, identified as available to the current user, successfully loaded from storage into cache, and ready for use.
The AdHocConfig.InvalidateFilteredCaches() method will clean up the results cached in the FilteredListReports method and can be called manually if needed. For instance, when the XML definitions of one or more reports change outside the environment.
AdHocSettings.DataCacheInterval sets the number of minutes between cache refreshes for FUSION (HTML) cache. Example:
AdHocSettings.DataCacheInterval = 60 * 24 * 30;
The AdHocContext.Driver.InvalidateSchemaCache() method will update the schema for database changes on, all filtered report lists, queries to the database that were cached, cached HTML results of reports, and cached XML report definitions.
AdHocSettings.InvalidateSchemaOnNew is a Boolean which tells the system if it should should update the schema for database changes when a new report is being created. This is useful for environments where the database is constantly changing.
The AdHocSettings.CacheQueries setting is a Boolean (default is true) which tells Izenda whether or not the result set of a particular query should be cached. You can manipulate how long the query is cached using AdHocContext.Driver.QueryCachingTime (see the CacheQueries article for more).
The AdHocSettings.CacheReports setting is Boolean (default = true) which gets or sets the value indicating whether all loaded reports should be cached.
The AdHocSettings.PerUserCaching setting is another Boolean value (default = false) which determines whether or not a user-specific DatabaseSchema object is cached in the session for each user.
AdHocSettings.CacheSchema (default = true) is a Boolean setting which tells Izenda whether or not the DatabaseSchema object should be cached. By default, it is cached in application memory and on the filesystem. The cache file name is generated using the database connection string and VisibleDataSources.
Note: Use PerUserCaching to store the schema in session memory. This will also generate a folder per user on the server using the database connection string, VisibleDataSources, CurrentUserName, and CurrentUserTenantId as the hash for the cache folder name.
AdHocSettings.SchemaCacheTimeout (default 1 day) is a TimeSpan setting that controls how long the database schema cache files will remain on the server before data should be re-obtained from the database.
AdHocSettings.StoreImagesToCache will inform Izenda whether to store images to the disk (true) or session (false) during the rendering of a report.
FusionCache.CleanUpCache method is part of the Izenda Fusion Driver suite and will clear all cached XML reports and dashboards.
FusionCache.RefreshAllCachedReports method can be called to update the cache of XML reports and dashboards based on whether the time period specified in the DataCacheInterval setting has elapsed since the last time the report was cached. Unlike CleanUpCache above, this will NOT clear the cache. It will include changes made to all HTML reports for the current user. You can call this method yourself to update the cache based on your unique business logic (such as daily, during downtime hours).
The ``FusionCache.RefreshAllCachedDashboards method will update the cache of XML dashboards, but not reports, based on whether the time period specified in the DataCacheInterval setting has elapsed since the last time the dashboard was cached. This can be called based on your unique business logic.
The StaticSharedStorage class is used to implement a completely static memory mode for the entire application. This must be set before any calls to the Izenda API if it is to be used. This means that it must come before even the license key declaration. Otherwise, Izenda will automatically store much of its configuration data in Session. Here is how to initialize the class:
Izenda Reports is a web application. Therefore, caching is susceptible to the client state. For example, do not have Izenda Reports running in separate windows or tabs of Internet Explorer. Otherwise, you could get the following behavior: by loading a report in one window and then loading a different report in another window, you may have unknowingly cached the second report, overriding the first. To properly enforce caching, only have a single instance of Izenda Reports running at a time per browser session. If you do open other browser windows and create/modify reports in that window, be sure you do not go back to the previous tab to continue modifying reports. Otherwise, you may see the newly cached report in your viewer instead of the one you were expecting to see.
Last edited by Joseph Adams, 2017-09-25 17:36:23