Updating to the Latest Version

If you are updating your version of Exago, please consult this guide to be notified of any potential breaking changes. Note that if you are updating from more than one version behind the current one, then the information from that section and all sections above it will apply to you.

Note: Please also review the Updating Recommendations article to ensure a smooth updating process.

If your version is not listed, then we do not support a direct update path to the latest version. Please file a support ticket.

Note: To ensure a smooth upgrade when overwriting a previous installation, ensure that the web server (IIS/Apache/Nginx), the Monitoring Service, and any Scheduling Services are turned off before running the installer.


Updating from v2019.1.1 and earlier

When updating from v2019.1.1 and earlier, the following topics may require your attention.

New method for managing the dbconfigs.json file

The dbconfigs.json file contains database specific syntax related to formulas, data types, primary and foreign key discovery, datetime casting, and row limiting and range selection. This file is overwritten after each new installation of Exago and, as such, any changes made to this file will be lost.

In order to prevent the loss of such information after each update, a 'dbconfigs.overrides.json' file may be created and populated with these changes. For more information on the dbconfigs.json and dbconfigs.overrides.json files, please see the Managing the dbconfigs JSON file article.

ETL "Report" renamed to "Transform"

Within the Exago web application, ETL Report has been renamed to ETL Transform in order to differentiate between the processes of designing reports and designing transformations for ETL Jobs. This change has been reflected in the relevant ETL documentation.


Updating from v2018.2 and earlier

When updating from v2018.2 and earlier, the following topics may require your attention.

Updated Linux Scheduler Installer

The Linux Scheduler installer has been updated in order to allow systemd compatibility and customization of service names. With these enhancements come a few changes in behavior for Scheduler installation including the replacement of start, stop, restart and status checks with a single new script named by default.

The behavior of the Linux installer will not change for overwriting existing installs; however, any new installation of the Scheduler will function according to these changes. For more information please see the Installing the Scheduler Service on Linux (v2019.1+) article.

Unique IDs and aliases are now required for Data Objects

Data Objects are now required to have unique IDs and aliases (names). These IDs will have automatically been assigned if the Data Objects were created using the Automatic Database Discovery tool. However, Data Objects created manually or via the API (as Entities) will need to be manually assigned IDs and aliases.

When upgrading to v2019.1, it is imperative that each Data Object is assigned a unique ID and alias if they are not already set. Any new Data Objects created without the use of the Automatic Database Discovery tool must now be assigned unique IDs. If they are not assigned a distinct ID value, a warning message will appear preventing these Data Objects from being created.

Furthermore, any existing API code that dynamically creates new Data Objects should be examined to ensure that unique ID and alias values are being assigned.

Time zone enhancements and changes to scheduling

Enhancements have been made to how Exago considers daylight saving time and other non-linear scheduling issues related to geopolitical time zones. In order to implement these enhancements, the Client Time Zone Name setting has been added where the client's geopolitical IANA time zone may be specified. Furthermore, changes have been made to scheduling calculations with the inclusion of the Noda Time library within Exago, allowing the Scheduler tool and Scheduler Queue to accurately consider DST and other time zone related issues.

For detailed information on these enhancements please see the Time Zone Calculation Enhancements in v2019.1 article.

Upon updating, it is recommended that the Next Execute Date of existing Schedules is reviewed for accuracy. If Client Time Zone Name is being utilized, existing schedules may need to be manually edited or recreated in order to reflect these changes.

Furthermore, certain DateTime values may have been assigned different meanings in the Scheduler Job XML following the implementation of Noda Time. Depending on the modifications made to your implementation of the Scheduler Queue, changes may have to be made to its code:

  • If you have not implemented the Scheduler Queue, then your v2019.1 upgrading process will not be affected.
  • If your implementation of the Scheduler Queue utilizes the QueueAPI object from WebReports.Api.Scheduler, then there should be no required for the Scheduler Queue to function properly after upgrading to v2019.1.
  • If your implementation of the Scheduler Queue has been modified to directly parse the Job XML, then some DateTime values may have been assigned a different meaning and will need to be adjusted for. It is recommended that you contact our Services team at for help in determining which values will need to be adjusted.

Changes to Entity creation via the .NET API

In the .NET WebReportsAPI class, the NewEntity() function now requires the string parameter entityName. This parameter represents the name (alias) of the data object, functionally replacing the Entity.Name argument, and must be unique. The Entity.Name argument, however, is still writable.

Ex. Entity etlEnt = api.Entities.NewEntity("New Entity");

Furthermore, the Add() function of the Entities class requires the new Boolean parameter addEntityData, which is set to false by default. In order to add the Entity Data to the local collection, its value must be set to true.

Ex. api.Entities.Add(etlEnt, true);

Each instance of the NewEntity() and Add() functions in use in current .NET API code, must be modified to reflect these changes.

Recommended configuration architectural changes

With v2019.1, major architectural changes have been made to the configuration with the intention of optimizing the system. The system has been modified allowing a portion of the configuration to be extracted into a static configuration, which will be loaded into static memory and made available to all sessions. The contents of this parent configuration extend its specified attributes to the child (dynamic) configuration, which will contain the remainder of the configuration information and will be loaded at each user session.

Caution: If using a static configuration with one or more scheduler or remote execution services, all static configuration .xml files must be added to the Config subdirectory of all scheduler instances.

These optimizations will considerably decrease configuration processing time, as well as decrease overhead in storing and executing scheduled reports, and are strongly recommended. However, these changes are entirely optional and do not need to be implemented. The directive for each configuration file will be defaulted to Dynamic status, requiring no additional set up if these changes are not desired.

New warnings regarding Metadata in the Admin Console

The use of full metadata across all data objects is strongly recommended in v2019.1 as it will reduce the frequency in which the databases are queried whenever metadata is required. As such, new warning icons will appear in the Admin Console next to data objects that do not have metadata properly implemented.

Changes to Active Role settings in the Admin Console

The setting in the configuration indicating the currently active role has changed. The Active Role setting under the Main Settings of the Admin Console retains the Id of the role to be made active upon session start. The active role may now be changed manually using the dropdown.

Changes to Null Tenant Parameters

Following changes made to nullable parameters in v2019.1, in order to disable tenancy on a tenant column, the parameter value for each tenant column now must be set to “{disabletenancy}.” Previously, to ignore tenancy, this parameter value could be left as an empty string; however, in v2019.1, any empty tenant parameters currently in use within the system will be identified as empty string tenant filters.

In order to continue disabling tenancy, the value must be set to “{disabletenancy}” across all instances of tenant parameter values set to empty strings.

For more information, please see the Multi-Tenant Environment Integration article.

Corrected spelling of REST Folder.Propagate property

In previous versions of Exago BI, the REST Folder.Propagate property was incorrectly spelled as "Propogate." This spelling has been corrected and as such will affect any REST API code using the previous spelling of the Propagate property. Any instance of the incorrect spelling of the Propagate property should be corrected after updated.

Report Management Caching & Database Aggregation enabled by default

The report management interface caches (GetReportList, GetReportXml, and GetTheme/ExistTheme/GetThemeList) and Aggregate and Group in Database setting have been enabled by default in newer versions of Exago in order to ensure that clients are reaping the performance benefits associated with these options without having to explicitly activate them.

Note: The userId and companyId parameters are used in the generation of the unqiue key created for the report management interface caches of user sessions. In order to take full advantage of report management caching, it is recommended that these parameters are properly set up. For more information, please see the User Identification article.


Updating from v2018.2.5 and earlier

When updating from v2018.2.5 and earlier, the following topics may require your attention.

New Required Field Added for Custom Functions

The Return Type field has been added to custom function objects. This field has been added to support the conversion of filter formulas to SQL so that they may be evaluated in the database using the Convert Filter Formulas to SQL flag in the Admin Console.

Note: For more information, please see the Database Formulas article.

This field is required for all custom functions, and, upon updating, all custom functions will need to be assigned a return value of either String, Integer, Decimal, or Date. Return values for all custom functions already existing before the upgrade will default to String.

LoadAssemblyInExternalDomain Moved to AppSettings

The <loadassemblyinexternaldomain> tag has been moved to the appsettings.config file and has been defaulted to true. This change will rarely affect Exago instances; however, it is important to take note of its new location.

SQLUtils.dll Moved to WebReportsApi.dll

The SQLUtils.dll file has been removed from the base Exago install and has been built into the WebReportsApi.dll file. In order to continue to use its methods, WebReports.Api.SqlUtils will need to be referenced.


Updating from v2018.2.1 and earlier

When updating from v2018.2.1 and earlier, the following topics may require your attention.

New Parameters for Conditional Drop Pin Formatting

The @metric_label@ and @metric_value@ parameters within the Conditional Drop Pin Formatting option of the Google Maps wizard are no longer valid. These parameters have been replaced with the serializing parameters @metric_value_<index>@, which automatically receive the values of each map metric in the order of their creation (e.g., @metric_value_1@, @metric_value_2@, and so on).

Any reports containing an interactive map with Conditional Drop Pin Formatting that uses either the @metric_label@ or @metric_value@ will need to be recreated using the new parameters or an error will be thrown upon execution of the report.


Updating from v2018.1 and earlier

When updating from v2018.1 and earlier, the following topics may require your attention.

New uses of User Preferences

The new Tutorial Mode feature relies upon User Preferences. Depending on your User Preference Storage Method you may or may not need to take action:

  • None: No action needed but Tutorial Mode will be disabled.
  • Local Storage: No action will be required.
  • External Interface or Server Events: No action required if you are following the sample code provided by Exago. If you have made customizations to the GetUserPreferences() or SetUserPreferences() method, we recommend reviewing that code to make sure it properly handles the new values being passed.

New Configuration Settings

With v2018.2 there are new configuration settings for Exago. Below we’ve listed those that are enabled by default and may warrant consideration or action as you upgrade:

<Showtipsexpressview> and <Showtutorialexpressview>: These settings enable the new Tutorial Mode feature. They are True by default but will have no impact if your User Preference Storage Method is set to None. Be sure to set values for the Parameter userId or disable these features.

See the section Configuration Changes below for a complete list.

Disable the old Monitoring Service

The installer will install the new Monitoring Service as a separate service instead of overwriting the existing one. If installing over an existing installation, the installer will detect and halt any older services running against the monitoring executable.

In order to prevent older services from restarting on system startup, you should remove or disable them. Otherwise there can be multiple services running against the same installation, which will cause duplicate entries to be written to the monitoring database.

This command line command can be used to delete specified monitoring services:

sc delete ExagoMonitoringService.full_version_number


sc delete ExagoMonitoringService.v2017.2.1.117

Back up settings files

Some settings files may be overwritten when updating. Make sure to back up the following files before running the installation:

<SCHEDULER>/eWebReportsScheduler.exe.config <WEBSERVICE>/appSettings.config

Application settings files for the web application and monitoring service will not be overwritten.

'Name' Property of Filter Objects Deprecated

The Name property of Filter Objects has been deprecated. This property has been obsoleted by the property FilterText.

This change may affect any references to Filter Objects made within the .NET API. For more information please see .NET API General Reference - Sorts and Filters.


Updating from v2017.3 and earlier

When updating from v2017.3 and earlier, the following topics may require your attention.

Cartesian Processing Disabled

Special Cartesian Processing is now disabled by default when creating a new configuration file. This change was made to better support certain database-processing features.

If you are starting a new configuration, please be aware that reports with Cartesian products with Special Cartesian Processing set to Default will now behave differently on execution. To retain the legacy behavior, either set the Admin Console flag back to True, or set each report-level flag to True (instead of Default).

Vertical Table behavior change

Vertical Table transformations are now done in the database instead of in application memory. This results in much faster processing as well as the ability to use database-processing features, such as Advanced Joins, with transformed tables.

If you are experiencing issues you can revert to the legacy behavior by setting the configuration file flag <canjointransformobjectsindb> to False.

web.config file

Certain application settings now require editing the <WebApp>\web.config file directly instead of the appSettings.config file. If you use a non-default web.config file, make sure that you are tracking your changes so that future upgrading and scaling can occur without error.


The .NET API method ReportObjectFactory.SaveToApi() has been altered. This method used to return bool to indicate whether the save succeeded or failed. This method now returns void. If the save failed it throws an exception with the details of the failure.

Ensure that you wrap calls to this method within try-catch blocks and properly handle exceptions.


Updating from v2017.2 and earlier

When updating from v2017.2 and earlier, the following topics may require your attention.

If you use Application Themes, also see Application Theme Updates for relevant style changes.

REST authorization key field has changed

Upon updating to this version, existing REST web applications will be unauthorized, and most REST calls will fail until action is taken.

The REST web service no longer uses the "Password" field to generate the authorization header key. The new "REST Key" field supplants the Password field for this purpose.

The REST Key field is blank by default upon installation. For security reasons, the Password and REST Key should not be the same key. Either migrate the old "Password" to the new field and choose a different Password, or choose a new REST Key and make sure that the new authorization header is being sent.

In the Admin Console you can click the Generate button in the REST Key field to generate a randomized REST key. This is NOT the encoded version - it must still be encoded according to the authentication method in use.

See REST Authentication for more information.

Internet Explorer 10 is no longer supported

Users will now see an error message when attempting to launch Exago BI in Internet Explorer 10. Please advise your users to upgrade to a supported browser.


Updating from v2017.1 and earlier

When updating from v2017.1 and earlier, the following topics may require your attention.

Back Up Your Dashboards

Dashboards created or saved in version v2017.2 are not compatible with older versions of Exago BI. Old dashboards will be updated to the new format when they are saved in the Dashboard Designer. Back up your dashboards in case of the need for a rollback.

Action Events

The Dashboard Viewer has undergone significant overhaul. Dashboard action events created for previous versions may no longer work as expected. These should be retested and modified if necessary.

Note: The Resizable Dashboards action event will no longer work in version 2017.2.

When using the OnParameterValueChange action event, the clientInfo.parameterValuesCtrl object will no longer be available in the context of dashboards.

Internet Explorer 9 is no longer supported

Users will now see an error message when attempting to launch Exago BI in Internet Explorer 9. Please advise your users to upgrade to a supported browser.

Function enhancements

Nine new functions were added, including four aggregate functions and five miscellaneous functions. Additionally, the built-in functions have had their descriptions overhauled, and their arguments have also been given names and descriptions.

This has some implications for how custom functions are created in the configuration and/or the API.

If you build functions in the API, please note that the MinArgs and MaxArgs properties of UdfFunction objects are no longer valid. Instead specify argument information in the ArgumentsJson property. See .NET API General Reference and Config File XML Referencefor more information.

The functions MonthName, QuarterName, and QuarterNumber were added as custom functions in the configuration file. This is to provide administrators with the ability to customize how these functions work.

Interface updates

Many icons and CSS have been updated to a new color scheme. If you use the default Basic application theme or any of the default icons and CSS, please be aware that you may have to make changes in your styling to reflect the new look.

Several new ExpressView themes were added to the application, and several miscellaneous themes have been updated as well. If you use folder management, you will have to manually update these files in your database.

Data Fields pane

The data fields pane for ExpressViews, Dashboards, and Advanced/Express/Crosstab Reports has been consolidated into a single pane in the left most application toolbar (underneath the Reports Tree icon). The settings to enable the Data Fields Search Bar for Dashboards and ExpressViews were consolidated into one setting. See Configuration Changes for more information.

Application themes may require some adjustment to match the new layout.

As always, please be aware that you should turn on Column Metadata if you are to enable the Data Fields Search Bar.

Monitoring Schema Change

The Monitoring database schema has been tweaked. The SystemStatistics table has had a new TransactionId column added to associate memory and CPU rows across common transactions. This was done to facilitate a vertical table transform, in order to report off both memory and CPU usage in the same report or chart.

When the monitoring service is restarted after updating, it will assess the schema in the monitoring service's Monitoring.sqlite table and add the TransactionId column. The scheduler and web application local databases will not be altered. The service will henceforth record a TransactionId for scheduler statistics. No existing monitoring data will be modified.

If, for some reason, the table cannot be altered, the monitoring service will abort.

The SystemStatistics table schema should be altered in the configuration file to reflect this change. You can add the TransactionId column to an existing definition, or create a new vertical definition for the table:



Updating from v2016.3 and earlier

When updating from v2016.3 and earlier, the following topics may require your attention:

Standard Reports renamed to Advanced Reports

Standard Reports have been renamed to Advanced Reports throughout the application. 'Standard' has been changed to 'Advanced' in the following areas:

  • Some translations were changed to reflect the new report type name to the end user.
    • NewStandardReport
    • NewStandardReportTab
    • ReportTreeContextMenuStandardReport
    • ExpressViewOptionsMenuConvertToStandard
    • ExpressViewOptionsMenuConvertToStandardDisabledInfo
    • SimpleDesignConvertReportBtn
    • AdminGeneralStandardReportSettings
    • AdminGeneralShowStandardReports
    • AdminGeneralShowGroupHeadersFormulaButton
  • Some language IDs themselves were changed from referencing "standard" to referencing "advanced."
    • NewStandardReport => NewAdvancedReport
      • Found in: New report menu in the main left pane
    • NewStandardReportTab => NewAdvancedReportTab
      • Found in: Tab title when launching the new advanced report wizard
    • ReportTreeContextMenuStandardReport => ReportTreeContextMenuAdvancedReport
      • Found in: Right-click folder context menu in the main tree
    • ExpressViewOptionsMenuConvertToStandard => ExpressViewOptionsMenuConvertToAdvanced
      • Found in: ExpressView settings menu
    • ExpressViewOptionsMenuConvertToStandardDisabledInfo => ExpressViewOptionsMenuConvertToAdvancedDisabledInfo
      • Found in: ExpressView settings menu tooltip
    • AdminGeneralStandardReportSettings => AdminGeneralAdvancedReportSettings
      • Found in: Admin Console General settings section title
    • AdminGeneralShowStandardReports => AdminGeneralShowAdvancedReports
      • Found in: Admin Console General settings setting title
  • Some image names were changed from referencing "standard" to referencing "advanced."
    • CopyAsStandard => CopyAsAdvancedReport
      • Found in: ExpressView settings menu
    • NewStandardReport => NewAdvancedReport
      • Found in: Right-click folder context menu in the main tree
    • NewStandardReportItem => NewAdvancedReportItem
      • Found in: New report menu in the main left pane
    • TreeStandardReport => TreeAdvancedReport
      • Found in: Reports tree next to any standard report

The config file keys under General and Roles/General have changed from "showstandardreports" to "showadvancedreports." Existing configs with showstandardreports will load just fine.

New API enumerations are available: wrApiAction.NewAdvancedReport supersedes wrApiAction.NewReport. wrReportType.Advanced supersedes wrReportType.Standard. Please adjust your code accordingly.

Changes to home page

The 'Main Menu' section of the home page has been redesigned. Several icons have undergone changes, and there is now no logo in the upper left corner. If you are using a custom application theme, you may have to make some changes to your css and images.

The 'Browse Reports' menu is more easily collapsible. Additionally, its expanded or collapsed state is preserved per user, via a new user preference.

ExpressView default theme with folder management assembly

ExpressViews now support custom theme files, which have the extension .wrtev. These are JSON files, unlike previous themes. To create a custom theme, style an ExpressView, then hold Alt-Ctrl-Shift and press the Save icon. The theme is saved to the Reports folder, but you can move it to the Themes folder if you wish; it is accessible from either location. The theme type "ExpressView" has been added to the relevant folder management methods.

If you are using a folder management assembly to store report and theme data, you need to manually add the file {Exago}\Themes\Legacy.wrtev to your theme storage. This is the default ExpressView theme. Otherwise users will encounter errors with ExpressViews.

Furthermore, as of v2017.1, the methods GetReportListXmlGetReportXml, and GetThemeXml are obsoleted by the methods GetReportListGetReport, and GetTheme, respectively.

If Folder Management is being used, the methods GetThemeList and GetTheme need to be updated to return values for ExpressViews.

Top N filters enabled by default

A new way to filter reports, called Top N or Top/Bottom, has been added and is enabled by default. If you want to disable this feature, change the admin setting Filter Settings > Show Top N Filters to False.


New Features


  • ETL
  • Configuration Optimizations
  • Formula Sorts in the Database
  • Report Execution Performance Enhancements
  • Building Metadata in Bulk
  • Time Zone Calculation Enhancements
  • Show SQL
  • Dashboard Reflow Added by Default
  • Setting Filters and Parameters via the JavaScript API
  • Boolean Parameters
  • Defaulting Parameters to Null

For more detailed description see What's New in Version 2019.1.


  • Tutorial Mode in Express Views - Provides a guided introduction to the ExpressView designer
  • Filter by Formula - Use formulas in the Filter Menu of advanced reports
  • Google Map Enhancements - New abilities to process and format data on Google Maps
  • Exporting Dashboards - Dashboards can now export their content as Chained Reports
  • Group Headers Repeat on New Pages - Group headers have an option to repeat if their corresponding detail continues onto additional pages
  • PDF Template Unflattening - PDF Document Templates now persist unmapped form fields allowing for user activity on the output
  • Schedules Reply-To Address - Set a Reply-To address when sending scheduled reports
  • CData Support / MongoDB - Direct support for MongoDB and CData as Data Sources


  • ExpressView Formulas – Make columns and groups using Exago formulas.
  • Report-Level Custom SQL – Write reports using custom SQL statements.
  • Cookieless Sessions – Embed the JavaScript API into cross-origin environments.
  • OnScheduledReportExecuteStart server event – Intercept and modify scheduled and remote executions before they run.
  • Infinite Scrolling – Allows Report Viewer to load rows incrementally by paging.
  • Enhancements to OnDataCombined server event, Programmable Data Objects, Vertical Table transformations, ExpressViews, and more.


  • End-user interface for Complex Joins and Category Aliasing


  • Secure Credential Storage – The Admin Console password can now be encrypted in the configuration file.
  • ExpressView Database Aggregation – For ExpressViews and dashboard visualizations, detail information can be omitted, allowing performant aggregate calculations to be made in the database.
  • Hide ExpressView Aggregates – Aggregate type 'None' can be selected for ExpressViews and dashboard visualizations.
  • Hide Excel Gridlines – Grid lines can be hidden for Excel output reports.
  • Filter Dropdown Enhancements – Filter dropdown lists can be narrowed down to values that 'contain' the typed text. Dropdowns will now continue to pull values incrementally on-demand after the first hundred.
  • Linked Report Display Options – More config options for how linked reports display when opened.


  • Dashboards Overhaul – Dashboards have undergone a complete redesign. The interface is more modern and similar to the ExpressView interface. Filters, Parameters, Style, and Settings are consolidated into one pane. Drag reports onto the dashboard directly from the report tree. Make ExpressView Visualizations directly on the dashboard. Scale and fit to different screen sizes.
  • JavaScript API – Use JavaScript to embed Exago elements directly into HTML DIV elements, without needing to use iFrames.
  • Incremental Loading – Step through a report execution, one set of rows at a time.
  • New Chart Types – Statistical Process Control (SPC), Zoom Line, and Zoom Scatter charts.
  • Dynamic Chart Benchmark Lines – Chart benchmark lines based on data. Several different formulas available.
  • Analytical Aggregate Functions – Mean, Median, Mode, Standard Deviation, and Variance functions
  • ExpressView updates – Now usable in dashboards and chained reports, and can be scheduled.
  • Formula Editor enhancements – Interactive description tooltips for functions and arguments; type-to-search for functions, parameters, data fields, and cells; auto-complete; and argument placeholders.
  • Freezing Rows & Cols for Excel export
  • Complex Joins & Entity Cloning – Join to constants, sub-selects, and expressions; Use join formulas with inequality operators and nested expressions.
  • New built-in Custom Functions and Date Filter Functions


  • ExpressViewupdates – Charts, Styling, Data Formatting, and Themes are now available in the ExpressView designer.
  • Top/Bottom Filtering – Now available in ExpressView and Report Designer. Also known as Top N filtering. Allows users to filter the data to the highest or lowest values in a data set. This also allows for sorting based on an aggregate formula.
  • Monitoring – Ability to track application metrics and system performance. Off by default, completely configurable, and all data stored locally.
  • Execution Caching – Reports can use a data cache, which stores report execution data and refreshes it on a schedule. Running a report uses the cache instead of querying the database.
  • Conditional Chart Filtering – Change chart colors based on a data condition.
  • Supply "canned" SQL for new reports (through API)
  • More page sizes available in export settings
  • Double underline font formatting available


  • ExpressView ExpressView is a new concept for working with data which is quick and easy for new users to pick up and learn. This is a brand new interface designed from the ground-up to minimize the number of steps needed to create data views. The interface is drag-and-drop and touchscreen capable. New users should find ExpressView to be much more intuitive than the Standard Report Designer.
  • New Mapping – Mapping has been completely overhauled with a new designer, better appearance, and more precise location capabilities. Users can now drill down to the county or zip code level.
  • Multi-Axis Charts – Added ability for Admins to add up to two additional Y-axes for several chart types.
  • Combination Charts – A new chart type is available, which allows users to combine several different types of charts into one.
  • Application Themes Administrators can now apply prebuilt downloadable themes, which are an easy way to change the look of the application.
  • Scalable Vector Icons Each theme comes with a set of optional SVG icons for a better appearance on high resolution screens.
  • Database Aggregation Added option to perform certain aggregate calculations in the database. This will improve the performance of compatible reports.
  • Custom Columns Added ability for admins to create custom columns in a data object, based on a formula.
  • Column Metadata enhancements Added "currency" data type. Added the ability to specify whether a column is sortable, and the ability to specify a formula by which a column should be sorted and grouped. Admins can also add description hovertext to data fields.
  • Launching Non-Exago Reports Admins can now add additional capabilities to the main menu. This can be used to let users view non-Exago reports, and to launch external applications.
  • Scheduler EnhancementsData sent to and from schedulers can now be encrypted. Schedule jobs can be more easily managed through the API. Added a timeout option to automatically kill hung executions.
  • Amazon S3 Reports, folders, config, and temp data can now be stored in an Amazon S3 cloud drive.
  • FIPS Compliance Encryption is now FIPS Compliant.
  • Improved memory consumption Exago will now run garbage collection at specified intervals to reduce memory consumption.


Configuration Changes

The following section details the changes made to the configuration xml file.


Added to <webreports>

  • <config> Specify directive information for different config types.
    • <lifespan> How long, in seconds, the configuration should be retained.
    • <type> Whether the configuration file is dynamic or static.
    • <parent> The name of the parent configuration.
  • <etl> ETL Job object information
    • <name>
    • <id>
    • <datasource_id>
    • <schema>
    • <object_name>
    • <report_name>
    • <job_id>
    • <schedule_info>
    • <enabled>

Added to <general>

  • <activeroleid> Set or view the currently active Role.
  • <showsqlwindow> If True, users will be able to preview the SQL that will be sent to the database when executing Advacned Reports.
  • <clienttimezonename> Set the client's default geopolitical time zone.
  • <useexternaltimezoneconverter>
  • <mintilewidth> Set the minimum tile width during automatic resizing.
  • <mindesktopwidth> Set the minimum desktop width during automatic resizing.
  • <reportxmlcacheenabled>
  • <reportxmlcachetimeout>
  • <etlreportpath> Report path where the ETL Reports Folder should be stored, defaulted to standard report path.
  • <etlreportfolder> Folder within the specified report path where ETL reports will be stored.
  • <licensekey> Licensing information to enable purchasable features.

Added to <column_metadata>

  • <col_dateformat> Date field formatting (e.g., dd-MM-yyyy). For use with vertical table transformations only.


Added to <general>

  • <evaluateformulasindatabase> If True, Exago will convert formula filters to SQL to be evaluated in the database.

Added to <function>

  • <filter_return_type> Required field specifying the return type of a function. Can be set to String, Integer, Decimal, or Date.

Moved to <appsettings.config>

  • <loadassemblyinexternaldomain>

Moved to <webreportsapi.dll>

  • SQLUtils.dll
Note: SQLUtils.dll has been removed from the base install. To continue using its methods, it must now be referenced from WebReports.Api.SqlUtils


Added to <general>

  • <schedulershowreplyto> Allows a user to specify a “Reply To” address when creating Scheduled Reports.
  • <showtipsexpressview> Enable or Disable “Tips” in the ExpressView designer.
  • <showtutorialexpressview> Enable or Disable the tutorial as a new user enters the ExpressView designer.
  • <reportlistcacheenabled> If True, Exago will cache the report list returned by Folder Management’s method GetReportList() to reduce the number of calls being made.
  • <filterdropdownobjecttenancy>
  • <cacheconfig> (HIDDEN FLAG) Cache the SetupData in the session.
  • <evaluateformulasindatabase> (HIDDEN FLAG) Currently hard coded to false pending future enhancement.


Moved to <appsettings.config>

  • <loadassemblyinexternaldomain>

Moved to <webreportsapi.dll>

  • SQLUtils.dll
Note: SQLUtils.dll has been removed from the base install. To continue using its methods, it must now be referenced from WebReports.Api.SqlUtils


Added to <general>

  • <googlemapjsapikey> Specify the Google Maps API key for the JS API, for restricted or unrestricted keys, and optionally the Geocode API for unrestricted keys. Replaces <googlemapkey>.
  • <googlemapgeocodeapikey> Specify the Google Maps Geocode API key for restricted keys.
  • <expressviewjoinpathalgorithm> Specify the standard or legacy algorithm for finding join paths between fields on ExpressViews.
  • <allowreportcustomsqlobjects> Allow Report-Level Custom SQL objects.
  • <excludedatasourcesreportcustomsql> Exclude data sources from Report-Level Custom SQL.
  • <dbrowlimitparamname> Programmable object parameter name for Database Row Limt.
  • <dbrowrangestartparamname> Programmable object parameter name for Row Range Start Index.
  • <dbrowrangeendparamname> Programmable object parameter name for Row Range End Index.
  • <loadassemblyinexternaldomain> (HIDDEN FLAG) Load assemblies in external domain.
  • <canjointransformobjectsindb> (HIDDEN FLAG) Use database to transform vertical tables.
  • <cacheconfig> (HIDDEN FLAG) Cache the SetupData in the session.

Removed from <general>

  • <googlemapkey> Replaced by <googlemapjsapikey>

Added to <entity>

  • <affinity> For entities created in the API, whether they have affinity to the report or the configuration.
  • <suppress_sort_filter> Suppress application sorting and filtering for programmable objects.

Added to <join>

  • <affinity> For joins created in the API, whether they have affinity to the report or the configuraiton.

Added to <role> • <rolegeneral>

  • <allowreportcustomsqlobjects> Allow this role to create, edit, and execute report-level SQL, if it is enabled in the configuration.

Added to <role> • <security>

  • <includereportcustomsqlobjects> Allow this role to execute report-level SQL, if it is enabled in the configuration and if <allowreportcustomsqlobjects> is False.


Added to <general>

  • <showcomplexjoins> Specify whether the report Joins window shows options for creating complex joins.
  • <showcategoryalias> Specify whether the report Categories window allows for categories to be aliased.


Added to <general>

  • <linkedreportdisplay> Specify the position which linked report drilldowns display when opened. Replaces <linkedreportsinnewtab>
  • <restkey> Specify the REST web service authorization key. Supersedes <password> for this purpose (does not replace <password> for Admin Console authentication).
  • <allowearlypagebreak> (HIDDEN FLAG) Allow page breaks to be inserted at the beginning of reports.
  • <cachevisibilitylevel> Control what visibility permissions users can assign to execution caches. Supersedes <schedulemanagerviewlevel> for this purpose.

Removed from <general>

  • <linkedreportsinnewtab> replaced by <linkedreportdisplay>


Added to <general>

  • <formulafunctionsloaded> (HIDDEN FLAG) Whether the default functions are loaded in the config
  • <aliasallentities> (HIDDEN FLAG) Use all entity IDs as SQL aliases (default: False)
  • <safemode> (HIDDEN FLAG) Add additional entity verification at runtime; set True unless otherwise instructed
  • <reporttreeshortcut> Default "Run" shortcut button for report tree (default: Run)
  • <logginglevel> The severity level at which events are logged (default: INFO); replaces <writelog>
  • <showdatafieldssearch> replaces <showdashboarddatafieldssearch> and <showexpressviewdatafieldssearch>

Removed from <general>

  • <visualizationdbrowlimit>
  • <writelog> replaced by <logginglevel>
  • <showdashboarddatafieldssearch> replaced by <showdatafieldssearch>
  • <showexpressviewdatafieldssearch> replaced by <showdatafieldssearch>

Added to <function>

  • <arguments_json> details about the function arguments; replaces <min_args> and <max_args>
  • <variable_arguments> whether the last argument is a list

Removed from <function>

  • <min_args> replaced by <arguments_json>
  • <max_args> replaced by <arguments_json>


Added to <general>

  • <executioncache> Enable or disable execution caching (default: False)
  • <showtopn> Enable or disable Top N filters (default: True)
  • <showadvancedreports> 'Standard' reports were renamed to 'Advanced' reports. Replaces <showstandardreports>

Removed from <general>

  • <showstandardreports> replaced by <showadvancedreports>


Added to <general>

  • <showgooglemapwizard> Enable the new Google Maps Wizard.
  • <googlemapcolors> Google maps default colors, as hex or html color names, separated by commas.
  • <googlemapkey> Google Maps API key for new Google mapping.
  • <geochartmapkey> Google Maps API key for Geochart (legacy) mapping.
  • <currencydecimalplaces> Number of decimal places for currency-formatted data fields.
  • <applygeneralcurrencyrightalignment> Automatically right-align currency-formatted data fields.
  • <usesecureremotingchannel> Enable secure channel for scheduler remoting.
  • <usesvgforappicons> Enable or disable SVG icons for application themes.
  • <showexpressviews> Enable or disable the ExpressView designer.
  • <allowexpressviewliveedit> Allow editing ExpressViews in live mode.
  • <showexpressviewdatafieldssearch> Enable or disable the ExpressView data field search bar.
  • <csstheme> Select application theme.
  • <maxjobexecutionminutes> Max time to run an execution job before timing out.
  • <aggregateandgroupindatabase> Enable calculating aggregates in the database.
  • <allowmd5onfips> Allow a FIPS-compliant server to encrypt PDF files.

Added to Scheduler configuration file

  • <secure_channel> Enable secure channel for scheduler remoting.
  • <max_job_execution_minutes> Max time to run an execution job before timing out.

Hidden Article Information

Article Author
Exago Development
created 2017-04-06 14:57:45 UTC
updated 2019-07-09 20:36:31 UTC

updating, update, upgrading, upgrade, 17.1, 2017.1, v2017.1, release, 17.2, 2017.2, v2017.2, 18.1, v2018.1, 2018.1,
Have more questions? Submit a request