| Name | Description | |
|---|---|---|
 | ActiveRoleId | Get or set the ID (name) of the active role. Setting the ActiveRoleId will also activate the role. |
| AliasAllEntities | As of v2017.2, Entity (Data Object) names may no longer be unique, the entity Id property (which must always be unique) can be used as a table alias in any application generated SQL. This can be enabled by setting this property to True. The default value is False, meaning all entities will not be aliased with the ID property. Setting to True will enable the aliasing behavior. Set to True to always use the Exago data object ID as table aliases in application generated SQL, rather than auto-generated aliases. |
| AllowCsvOutput | Enable or disable this type as one of the allowed file export types throughout the application. |
| AllowDependantFilters | Causes filter drop downs to retrieve values dependent on the filters above them in the menu. For a full description of how this feature works, review the Filter Dependency section of the Filters article. This setting only works for Data Objects from databases and will not change drop downs from Web Services, .NET Assemblies and stored procedures. Determines the default type of window that appears when prompting users for filter execution input. |
| AllowEarlyPageBreak | Set to True to allow users to insert a page break at the beginning of a report, which would cause the first page to be empty. |
| AllowExcelOutput | Enable or disable this type as one of the allowed file export types throughout the application. |
| AllowExecuteNewFilters | Controls the creation of new filters when a user is prompted for a filter value at the time of report execution. Set to False to disable new filters from being created at execution.Determines the default type of window that appears when prompting users for filter execution input. |
| AllowExecuteSaveToDesign | Set to False to prevent users from saving changes to a report made in the Report Viewer back to the original report design. This effectively removes the Save Changes To This Report and Save Changes to New Report options in the Report Viewer. |
| AllowHomeDirect | Permit or deny access to the Exago user interface without going through the API. Attempting to access the user interface directly with this setting True will display an Access Denied message to the user. |
| AllowHtmlInScheduledEmails | Set to True to allow users to insert HTMLtags within the body of scheduled emails. |
| AllowHtmlOutput | Enables or disables running reports in the Report Viewer. |
| AllowInteractiveHtml | Set to False to disable Interactive Report Viewer capabilities, including: changing column width, styling output, and interactive filters. |
| AllowMD5OnFIPS | Allows a FIPS-compliant server to encrypt PDF files by using an alternate MD5 library to the built-in System.Cryptography. |
| AllowMultipleSessions | Allows multiple sessions of Exago per user. Set to True to enable this behavior. |
| AllowNonHtmlOutput | Enable or disable this type as one of the allowed file export types throughout the application. |
| AllowPdfOutput | Enable or disable this type as one of the allowed file export types throughout the application. |
| AllowReportTreeRootAccess | Enables/disables the ability for users to create new folders in the root folder, and to move existing folders to the root. |
| AllowRtfOutput | Enable or disable this type as one of the allowed file export types throughout the application. |
| ApplyGeneralCurrencyRightAlignment | Set to True to cause currency values to appear right-aligned in report cells by default. |
| ApplyGeneralFormatDecimalPlaces | Set to true to apply the DecimalPlaces Property to any cell that its Cell Formatting set to General but contains a number. Default value is False. |
| CacheVisibilityLevel | Controls what visibility permissions users can assign to Execution Caches. Available levels utilize the parameters companyId and userId. There are three possible values from the wrCacheVisibility Enumeration.
|
| CallTypeParamName | The Programmable Object Settings enable you to specify names for special parameters that will be passed from Exago to identically named parameters in stored procedures or .NET Assemblies. Using these parameters will allow filtering to be done before the data is sent to Exago. This can increase performance and reduce server resources when using Programmable Objects. For more information on these types of Data Objects see Web Services & .NET Assemblies. Reminder
If an Exago .NET API application needs to access reports with an assembly data source, it must include a reference to the assembly WebReportsAsmi.dll. Provide a parameter name in the programmable object that will direct the object to change its output based on one of the possible values:
|
| ChainedReportMaxCollationExecutions | When executing a collated chained report, the application will run each report for each filtered group. A non-collated chained report containing two reports will only execute those two reports. A collated chained report with the same two reports sorted on a field with 100 values will execute 200 individual reports. Set the maximum number of individual report executions that are allowed when exporting a collated Chained Report. Setting a limit will prevent very long chains from being executed that could cause performance reductions. If the number of executions exceeds this limit, the chain will be cancelled and an error message displayed to the user (and an e-mail sent to the The default value is 0, indicating no limit to the number of collated report executions. |
| ChartColors | Lists the values used for default chart colors, except for heatmap charts. Hexadecimal values should be separated by commas or semicolons. |
| ClientTimeZoneName | Default geopolitical location of the client as determined by the IANA time zone database (e.g., America/New_York). Utilized by Exago to properly combat scheduling issues centering around DST and other non-linear time zone conflicts. |
| ColumnParamName | The Programmable Object Settings enable you to specify names for special parameters that will be passed from Exago to identically named parameters in stored procedures or .NET Assemblies. Using these parameters will allow filtering to be done before the data is sent to Exago. This can increase performance and reduce server resources when using Programmable Objects. For more information on these types of Data Objects see Web Services & .NET Assemblies. Reminder
If an Exago .NET API application needs to access reports with an assembly data source, it must include a reference to the assembly WebReportsAsmi.dll. Provide a parameter name in the programmable object that will hold:
|
| CrossTabMaximumFields | Specify the maximum allowed fields in a CrossTab header or tabulation source. Adding a large number of data fields to a CrossTab will significantly increase the execution time of the report. |
| CssTheme | Choose from a selection of available user interface themes, or choose Create New Application Theme... to create a new theme. See Application Themes for more information. After choosing a theme, users should clear their browser cache and refresh the user interface in order for the theme change to take effect. The UseSVGForAppIcons Property should be True when applying a custom application theme. |
| CurrencyDecimalPlaces | The default number of decimal places to show when a when column metadata or the data source identifies the value is a currency data type. Default is -1 which will show two decimal places. |
| CurrencySymbol | Symbol prepended to numeric values to represent currency. The default is the US currency symbol ($). |
| CustomCode | Used for custom functionality. Do not set a value for this field unless directed by Exago Support, Client Services or Engineering teams. |
| CustomHelpSource | Specifies the URL that contains custom context-sensitive help content. See Custom Context Sensitive Help for more details. |
| DashboardAutomaticallyRefreshTiles | In the Dashboard Designer, enable/disable automatically loading data into the tiles, requiring the end user to manually refresh the tile in order to see any data in it. When True, reports and visualization tiles will automatically load data when the Dashboard Designer is first opened, and whenever changes are made to the Dashboard or the tiles on the canvas. This is the pre-v2021.1 behavior. When False, reports and visualization tiles will display placeholder data until either the Refresh This functionality is referred to as the Refresh Reminder feature in the Dashboards documentation. When False, the default value, tiles do not automatically load and therefore the Refresh Reminder feature is enabled. |
| DataCategoryParamName | The Programmable Object Settings enable you to specify names for special parameters that will be passed from Exago to identically named parameters in stored procedures or .NET Assemblies. Using these parameters will allow filtering to be done before the data is sent to Exago. This can increase performance and reduce server resources when using Programmable Objects. For more information on these types of Data Objects see Web Services & .NET Assemblies. Reminder
If an Exago .NET API application needs to access reports with an assembly data source, it must include a reference to the assembly WebReportsAsmi.dll. Provide a parameter name in the programmable object that will hold the Data Object’s name. Can be used in conjunction with the Data Object ID Parameter (ObjectIdParamName Property). |
| DataFieldsSearchMode | Whether or not a Search field appears in the Data Objects pane, and if so, how the search field should behave. |
| DateFormat | The format of date values. May be any .NET standard (e.g., MM/dd/yyyy). |
| DateTimeFormat | The format of time values. May be any .NET standard (e.g., h:mm:ss tt).The format of DateTime values. May be any .NET standard (e.g. M/d/yy h:mm tt). |
| DateTimeTreatedAs | Defines how the application should treat DateTime values, either as Dates or DateTimes. |
| DbRowLimit | Maximum number of rows returned on an execution. This only applies to Tables, Views and Functions. Set to 0 to return all rows. |
| DbRowLimitParamName | The Programmable Object Settings enable you to specify names for special parameters that will be passed from Exago to identically named parameters in stored procedures or .NET Assemblies. Using these parameters will allow filtering to be done before the data is sent to Exago. This can increase performance and reduce server resources when using Programmable Objects. For more information on these types of Data Objects see Web Services & .NET Assemblies. Reminder Provide the name of a parameter holding the Database Row Limit, the maximum number of rows returned on an execution.Maximum number of rows returned on an execution. This only applies to Tables, Views and Functions. Set to 0 to return all rows. If an Exago .NET API application needs to access reports with an assembly data source, it must include a reference to the assembly WebReportsAsmi.dll. |
| DbRowLimitStepSize | Maximum number of rows returned on an execution. This only applies to Tables, Views and Functions. Set to 0 to return all rows.Maximum number of rows returned on a query. Set to 0 to return all rows. Set greater than 0 to enable Incremental Loading for Advanced Reports and ExpressView. The value determines how many rows are returned for each user-initiated data query. |
| DbTimeout | Maximum number of seconds for a single data source query to run. This value is passed on to the data source driver as the CommandTimeout property when the report is executed. Each data source driver, data source or individual database may interpret this setting slightly differently. Consult the official product documentation associated with your data source implementation for complete details how this setting will impact your environment. This setting will also control the maximum number of seconds that a Web Service API method can run. If set to 0 the Web Service API time out will be infinite.e your Note Box content here. |
| DecimalPlaces | The number of places to show after the decimal for numbers that are not currency. |
| DecimalSymbol | Symbol used for numeric decimal values. The default is a period (.). |
| DefaultChartFont | Specifies a default font for charts created in the Advanced Report Designer. This setting can be overridden on a per-Report basis. |
| DefaultClientTimeZoneName | Default geopolitical location of the client as determined by the IANA time zone database (e.g., America/New_York). Utilized by Exago to properly combat scheduling issues centering around DST and other non-linear time zone conflicts. |
| DefaultFont | Specifies a default font for reports created in the Express Report Wizard, Advanced Report Designer and Dashboard Designer. This setting can be overridden on a per-report basis. End-users must have the selected font installed locally in order to display. Otherwise, Exago will default to Sans Serif. |
| DefaultFontSize | Specifies a default font for reports created in the Express Report Wizard, Advanced Report Designer and Dashboard Designer. This setting can be overridden on a per-report basis. End-users must have the selected font installed locally in order to display. Otherwise, Exago will default to Sans Serif. Specifies a default font size for reports created in the Express Report Wizard, Advanced Report Designer, and Dashboard Designer. This setting can be overridden on a per-report basis. Does not apply to CrossTabs. |
| DefaultIsDockOpen | Set to True to have the Interactive Dock opened by default when a report is executed in the Report Viewer. |
| DefaultOutputType | The export format that appears when a new report is selected, unless a specific export format is set in the Report Designer's Options Menu. The Default Output Type must be one of the available Allowed Output Types. |
| DockPlacement | Specify if the Interactive Dock should appear on the left or right of the Report Viewer. |
| EffectiveDbRowLimit | Maximum number of rows returned on an execution. This only applies to Tables, Views and Functions. Set to 0 to return all rows. |
| EvaluateFormulasInDatabase | If True, formula filters and sorts will be converted to SQL when possible. The converted SQL statements will be placed in the WHERE (for formula filters) and ORDER BY (for formula sorts) clauses when querying data for the report. If set to False, all formula filtering and sorting will occur in-memory. Due to innate difference between Exago's formula engine and SQL database engines, there may be discrepancies in data returned between two methods. Additionally, because the converted SQL formulas may contain arbitrary input, the connection string must be read-only access. For more information please see the Database Settings article. |
| ExcelExportTarget | Choose the type of Excel export you would like. Choosing 2003 will automatically split the workbook into multiple worksheets when Excel’s row limit is reached. |
| ExcludeDataSourcesReportCustomSQL | When Allow Creation of Custom SQL Objects is enabled, enter the data sources to exclude from Report-Level SQL. Write each data source in double quotation marks ("), and separate sources by a comma (,). Example: "Northwind","AdventureWorks". |
| ExpressViewDefaultFormatTheme | Select a default ExpressView theme. Provide the name of the file in the \Themes directory or the name of the theme as it appears in the content table of the Storage Management database. |
| ExpressviewJoinAlgorithm | Select the join path algorithm to use when running ExpressViews with multiple data objects. |
| ExternalInterface | Provide a Web Service URL or .NET Assembly to interface with the external module. This is a deprecated extensibility feature that should not be used in new installations. |
| FilterDropdownObjectTenancy | Set to False to disable tenanting on filter and parameter dropdown objects. If this is disabled and a tenant column limits the dataset for a data object, then a filter or parameter dropdown list within a report will show the full dataset for the data object rather than its intended limited subset. USE CASE EXAMPLE A tenant column limits the dataset of an Employees data object so that only data for an employee with the last name "King" appears. A report that uses this data object will only output data associated with King. If this setting is True (default), then a filter on Employees.LastName added to this report will only allow King to be selected. However, if it is set to False, the filter on Employees.LastName will allow all employee last names to be selected even though only data for King will appear. |
| FilterParamName | The Programmable Object Settings enable you to specify names for special parameters that will be passed from Exago to identically named parameters in stored procedures or .NET Assemblies. Using these parameters will allow filtering to be done before the data is sent to Exago. This can increase performance and reduce server resources when using Programmable Objects. For more information on these types of Data Objects see Web Services & .NET Assemblies. Reminder
If an Exago .NET API application needs to access reports with an assembly data source, it must include a reference to the assembly WebReportsAsmi.dll. Provide a parameter name in the programmable object that will hold:
|
| FullFilterParamName | The Programmable Object Settings enable you to specify names for special parameters that will be passed from Exago to identically named parameters in stored procedures or .NET Assemblies. Using these parameters will allow filtering to be done before the data is sent to Exago. This can increase performance and reduce server resources when using Programmable Objects. For more information on these types of Data Objects see Web Services & .NET Assemblies. Reminder
If an Exago .NET API application needs to access reports with an assembly data source, it must include a reference to the assembly WebReportsAsmi.dll. Provide a parameter name in the programmable object that will hold:
Provide a parameter name in the programmable object that will hold:
|
| GaugeColors | List the values used for default gauge colors. Hexadecimal values or CSS color names should be separated by commas (or semicolons). |
| GeochartMapKey | Optional Google Maps license key for GeoCharts permissions. License must contain the Google Maps Javascript API service. See Legacy Maps (Geocharts) for more information. |
| GoogleMapColors | List the values used for default Google Maps visualization colors. |
| GoogleMapGeocodeAPIKey | License key for Google Maps permissions. If GoogleMapJSAPIKey Property contains a key limited to the JavaScript API service, supply a limited Geocoding API service key in this field, given server IP addresses. Otherwise leave this blank. |
| GoogleMapJSAPIKey | License key for Google Maps permissions. Must contain either:
|
| GoogleMapsEnabled | Enables/Disables the Google Maps  icon in the Insert   menu. |
| HeatmapColors | Lists the values used for default heatmap chart colors, either as CSS color names or hexadecimal color codes with a leading # sign. Values must be separated by commas or semicolons. This list of colors will be applied to a heatmap when selecting Default from the Theme dropdown in the chart wizard. |
| IgnoreInaccessibleReportFolders | If False, Exago throws an error message if a folder has an accessibility issue. Set to True to ignore the error and hide the inaccessible folder. |
| IsAccessDataSourcesRemotely |
When True, all calls, including populating Filter Value dropdowns and retrieving Data Object/Data Object schemas made to the Data Sources are handled by the Remote Execution Remoting Host, or the Schedule Remoting Host if no Remote Execution Remoting Host is defined. When False, the Scheduler Services will only make calls to the Data Sources during report execution. All other calls are handled by the Web Application. Enabling this feature is helpful when white listing connections to the Data Sources, and connections should only originate from the the designated Remote Execution Remoting or Schedule Remoting Hosts as opposed to the Web Application servers; or when the Scheduler Services and the databases are on the same firewall level but the Web Application is not. |
| IsAggregateAndGroupInDatabase | If True, aggregate and grouping calculations will be done in the database when possible. This will provide a performance boost for reports with group sections. Before enabling this, you must ensure that all One-To-Many Joins in your environment are correctly identified and set as One-To-Many in the Join options menu. If these joins are not properly identified, reports which utilize them will return incorrect aggregate data. See Database Aggregation for more information. |
| IsAggregateRecordLevel | The |
| IsAllowExpressViewLiveEdit | When True, users are allowed to make changes to an ExpressView when the in Live Data (Run) mode. When False, users must click the Stop button on the toolbar before changes may be made. The default value is false for pre-v2021.1.1 or true for v2021.1.1+ |
| IsAllowReportCustomSQLObjects | Allow end-users to write Custom SQL Data Objects at the report level. |
| IsCacheServices | Caches external Web Services and .NET Assemblies. Setting to False may reduce performance due to loading/unloading of services. |
| IsDashboardAutomaticallyRefreshTiles | In the Dashboard Designer, enable/disable automatically loading data into the tiles, requiring the end user to manually refresh the tile in order to see any data in it. When True, reports and visualization tiles will automatically load data when the Dashboard Designer is first opened, and whenever changes are made to the Dashboard or the tiles on the canvas. This is the pre-v2021.1 behavior. When False, reports and visualization tiles will display placeholder data until either the Refresh This functionality is referred to as the Refresh Reminder feature in the Dashboards documentation. When False, the default value, tiles do not automatically load and therefore the Refresh Reminder feature is enabled. |
| IsDashboardPromptAtExecution | Default setting indicating whether to prompt the user for filter and/or parameter values when executing a Dashboard. The option can be overridden on an individual dashboard in the corresponding Filters or Parameters menus. |
| IsDashboardPromptKeywordByDefault | |
| IsDashboardShowUrlItemButton | Display/Hide the URL item in the New Tile Menu of the Dashboard Designer. When False, users will not be able to add URL tiles to the Dashboard canvas. |
| IsDataMapping | Allows .NET Assembly Data Source methods to replace Data Field names. |
| IsDataMappingActual | Allows .NET Assembly Data Source methods to replace Data Field names. |
| IsDebugging | Set to True to enable debugging. For more information see Submitting a Debug Package. |
| IsDeleteSchedulesUponReportDeletion | When a report is deleted corresponding schedules can be deleted automatically by Exago. Set to True to enable this behavior. |
| IsDetectJoinedObjects | If True users are not able to add Data Objects to a report that do not have a join path with at least one other Data Object on the report. Set to False to disable this restriction. This setting does not have an affect for ExpressView unless Feature/UI Settings > ExpressView Settings > Fields Enabled in Data Fields Tree (ExpressViewDataFieldsDisplay Property) is set to Direct Joins Only. |
| IsEmailScheduledReports | Set to False to have the Scheduling Service save reports to a file repository instead of attaching them to emails. For more details see Saving Scheduled Reports to a Repository. |
| IsEnableBatchReports | Set to True to allow users to schedule reports which are filtered separately for each recipient user. Batch reporting requires a table or other data structure containing email addresses for the intended recipients associated with a key used to filter the reports. For more information see Scheduling Reports. |
| IsEnableReportsTreeDragAndDrop | Set to False to disable the dragging of reports and folders in the Report Tree. |
| IsEnableRightClickMenus | Set to False to disable right click menus. |
| IsEnableScheduling |
Enables/Disables scheduling and remote execution functionality in the application. If False, will override Show Report Scheduling Option, Show Email Report Options, & Show Schedule Manager also to False. If False, Enable Remote Report Execution is ignored. |
| IsEnableSpecialCartesianProcessing | If True any one-to-many Joins will cause special processing to avoid data repeating on the report. Set to False to disable this behavior. |
| IsExecuteRemotely |
Set to True to enable Remote Execution of reports by one or more Scheduler Services. Enable Report Scheduling (IsEnableScheduling Property) must also be True and a value must be provided for the Remote Execution Remoting Host. Set to False to disable this behavior. For more information, review the Remote Execution article. |
| IsHtmlPaging | Controls when data for Report Viewer output is sent to the client. Set to True to send data as each page is requested. If this is set to False, it restricts the interactive HTML hide/show column option in the Report Viewer. Set to False to send all the data to the client browser at once. |
| IsIncludeNotFilterNullValues | Determines the default type of window that appears when prompting users for filter execution input.Indicates to include NULL values for filters with using the operators ‘not equal’ or ‘not one of’. |
| IsMapTermsSigned | |
| IsOneCategoryLimit | Limits reports and visualizations to fields within a single Data Object. Set to true to restrict reports and visualizations to one object, or false to allow fields from multiple data objects. |
| IsPerformanceTesting | Set to True to set Ctrl+Alt+A to allow for running a report a specified number of times simultaneously for performance testing. Must be run from the report designer for the desired report. |
| IsReadFilterValues | Enable/Disables filter dropdowns to read possible values from the Data Objects. Set to False only if retrieving values for the dropdown will take more than a couple of seconds.
Enables/Disables filter dropdowns to contain values from the filter field's data object. Set to False only if retrieving the values for the dropdown will take more than a few seconds. Determines the default type of window that appears when prompting users for filter execution input. |
| IsRenewSession | This setting is used to bypass the session timeout property set in This will only work if the timeout period set in web.config is greater than two minutes. |
| IsSaveOnExecute | Set to False to disable automatic saving of reports when executing from the Report Designer. |
| IsSaveOnFinish | Set to False to disable automatic saving of reports when finish button is pressed in a wizard. |
| IsSchedulerShowReplyTo | Displays the email address specified in the userEmail parameter in the Recipients tab when scheduling a report. Any replies to the scheduled report will be sent to this email address instead. |
| IsShowAdvancedJoins | Enables/Disables additional options in the Report Designer's Joins dialog. Set to True to enable advanced users to create, delete, and modify joins. |
| IsShowAdvancedReports | Displays/Hides the Report Designer. |
| IsShowAutosum | Enable/Disable the AutoSum  icon in the Advanced Report Designer's toolbar. |
| IsShowBrowserOutOfDateWarning | Set to False to prevent a popup error message from appearing if a user accesses Exago with an unsupported browser. |
| IsShowCategoryAlias | Data Object aliasing allows users to add Data Objects multiple times on the same report. This may be necessary for some advanced join operations. Data Objects were previously referred to as Categories in Exago. |
| IsShowChainedReports | Enables/Disables the Chained Report wizard. |
| IsShowChartWizard | Enables/disables the Chart Wizard  icon from the Insert menu. |
| IsShowComplexJoins | Select whether to show complex join options in the report Joins menu. |
| IsShowCrosstabReports | Set to True to allow CrossTab widgets to be added to Advanced Reports in the Designer, or False not to. |
| IsShowCrosstabWizard | Enables/disables the creation of new CrossTab reports from the main menu. |
| IsShowDashboardNewVisualizationButton | Display/Hide the Visualization item in the New Tile Menu and Tile Properties Pane of the Dashboard Designer.Display/Hide the Visualization item in the New Tile Menu and Tile Properties Pane of the Dashboard Designer. |
| IsShowDashboardReports | Enables/Disables the Dashboard Designer. Both this setting and General > Main Settings > Allow Execution in Viewer (AllowHtmlOutput Property) must be True to enable the Dashboard Designer. |
| IsShowEnhancedTooltips | Sets the style of tooltips to display. If True, enhanced tooltips which support HTML will be displayed. If False, standard browser tooltips will be shown. |
| IsShowEventsWindow | Enables/Disables the Events dialog in the Report Designer's Advanced  menu. Set to True to allow users to apply Server Event Handlers in the report. See Server Events for more information. |
| IsShowExportsInTab | Set to True to open PDF reports in an Exago tab. Set to False to prompt the user to download the PDF. |
| IsShowExpressReports | Enables/Disables the Express Report wizard. Express Reports are a legacy version of Advanced Reports, and are not the same as ExpressViews. |
| IsShowExpressReportsFormulaButton | Enables/Disables the formula editor button in the Layout tab of the legacy Express Report wizard. |
| IsShowExpressReportsGrouping | Enables/Disables the grouping tools in the Layout tab of the Express Report wizard. |
| IsShowExpressReportsStylingToolbar | Enables/Disables the styling tools in the Layout tab of the Express Report wizard. |
| IsShowExpressReportsThemes | Enables/Disables the Theme dropdown in the Layout tab of the Express Report wizard. |
| IsShowExpressViews | Enables/Disables the ExpressView Designer. |
| IsShowFilterDescription | Enables/Disables reports to have description text for the filters menu. The filter description is set in the Description tab of the New Report Wizard or from the Description item on the Report Designer's Settings menu. A Help |
| IsShowGaugeWizard | Enables/Disables the Gauge Wizard  on the Insert menu. Set to False to disable users from creating or editing gauges. |
| IsShowGoogleMapWizard | Enables/Disables the Google Maps In order to use Google Maps, a license key must be obtained from Google, a polygon file must be downloaded from our support site and the Exago server must have an Internet connection. See Installing Optional Features for more information. |
| IsShowGrid | Sets the default output to show grid lines or not in the Report Viewer. This can be overridden on a per-report basis. |
| IsShowGroupFilters | |
| IsShowGroupHeadersFormulaButton | Enables/disables users to create groups on non-sort formulas. When enabled, a formula icon will appear in the Group Header and Group Footer dialogs. Grouping on non-sort formulas is deprecated and unsupported. |
| IsShowHelp | Enables/Disables the Help  icon in the top right corner of the user interface. Set to False to disable users from accessing the context-sensitive help system. |
| IsShowHtmlToolbar | Specify if Report Viewer should display paging, search, and export options. |
| IsShowIeDownloadButton | Set to True if Internet Explorer is not automatically prompting users to download PDF, XLS, RTF or CSV export files. |
| IsShowInsertImage | Enables/Disables the Image icon in the Insert menu. Set to False to disable users from inserting images. |
| IsShowJoinFields | Enables/Disables any Data Fields that are used as Unique Keys or Joins. Set to False to hide all unique key and join Data Fields from users. To hide specific Data Fields see Column Metadata. |
| IsShowJoinsWindow | Enables/Disables the Joins dialog on the Report Designer's Advanced menu. Set to False to disable users from modifying joins. |
| IsShowLinkAction | Enables/Disables the Linked Action Event  icon in the Advanced Report Designer's toolbar. When True, users will be able to add Action Events to reports. |
| IsShowLinkReport | Enables/Disables the Linked Report  icon in the toolbar. Set to False to disable users from linking reports. |
| IsShowLinkReportFields | Enables/Disables the Fields tab in the Linked Report dialog. |
| IsShowLinkReportFormula | Enables/Disables the Formula tab in the Linked Report dialog. |
| IsShowMapWizard | Enables/Disables the GeoCharts  icon from the Insert menu Set to False to disable users from creating or editing GeoCharts. |
| IsShowPdfTemplate | Enables/Disables working with document templates. Set to False to disable users from using the Document Template menu. |
| IsShowReportParametersWindow | Enables/Disables the Parameters dialog on the Report Designer's Advanced menu. Set to True to allow users to view system-parameters and define their own report-level parameters for use within reports. See Advanced Options for more information. |
| IsShowReportUploadDownloadOptions | Set to True to enable users to upload and download report files by right clicking on folders and reports. Default value is False. |
| IsShowScheduleDeliveryTypeOptions | Enables/disables user option to choose the output type (i.e. email or save report to repository) with each schedule. When True, the default value will reflect whatever is set in the Email Scheduled Reports setting. |
| IsShowScheduleIntradayRecurrence | Enables/Disables options in the Recurrence tab of the Schedule Wizard to allow a schedule to repeat throughout the day. |
| IsShowScheduleNoEndDate | Enables/Disables users ability to create a schedule that never ends. Set to False to force users to set an end date limit to the schedule. |
| IsShowScheduleReports |
|
| IsShowScheduleReportsEmail | Displays/Hides the  E-Mail Report icon on the report's context menu in the Report Tree.
|
| IsShowScheduleReportsManager | Show/Hide the  Scheduler Manager icon on the Main Menu. Set to False to disable users from seeing the Schedule Manager and editing existing schedules.
|
| IsShowSQLWindow | Enables/Disables the Show SQL dialog on the Report Designer's Advanced menu. Set to True to allow users to view the SQL that will be sent to the data sources upon execution. See Advanced Options for more information. |
| IsShowTemplateUploadButton | Set to True to allow users to upload document template files to the system from their local computer. Set to False to prevent users from uploading Document Templates. |
| IsShowTipsExpressView | |
| IsShowTopN | Enables/Disables the Top/Bottom Filters menu in the ExpressView and Advanced Report designer. Top N filters allow users to see the highest or lowest values for a data set. Set to False to disable users from using Top N filters.Determines the default type of window that appears when prompting users for filter execution input. |
| IsShowTutorialExpressView | |
| IsSilentDashboardRefresh | Set to True to disable the refresh hourglass animation for timed automatic dashboard reloads. |
| IsUseSecureRemotingChannel | Enables/disables encrypting of data. Set to True to cause data sent to remote schedulers to be encrypted. Each scheduler config file must also have <secure_channel> set to true. |
| IsVisualizationShowKeyword | |
| IsWebFarmSupport | If not using sticky sessions in a web farm environment, should be True. More temp information will be written to disk when True allowing other nodes in the farm to read it. Should be False if sticky sessions is configured or when Exago runs in a single node to stop unnecessary costly disk writes and keep information in memory instead. |
| IsWriteLog | Enable/Disable logging. This is obsolete; use LoggingLevel EX-9911 |
| LanguageFile | List of the XML files that specify language strings. See Modifying Select Language Elements for more details. |
| LinkedReportDisplay | Specify where to display drilldowns for linked reports. |
| LoadImageFuncParamPrefix | A string that is prepended to the LoadImage function when the report is run. This setting allows an administrator to hide the report path of images on your server. This field is ignored for images loaded from a database. |
| LoggingLevel | Set the level of detail logged in the Exago log file. See Application and Performance Logging for information about the different log levels. This setting will be overridden by a log4net.config file. |
| MapColors | List the values used for default GeoChart map colors. |
| MapsEnabled | Enables/Disables the GeoCharts icon in the toolbar in the Insert menu |
| MaxJobExecutionMinutes | Specify how long, in minutes, reports should run before timing out. Default is 240 minutes (4 hours). |
| MaxNumberOfChartPoints | Upper limit on the number of data points visible on a chart. If the limit is exceeded, a warning will be displayed to the user. Charts with large numbers of data points could cause browser performance issues. |
| MaxTempFileAge | Determines the maximum number of minutes a temp file can exist before Exago's automatic cleanup removes it. |
| MinDesktopWidth | Specifies the minimum window size where Dashboard Reflow will begin to take effect. Please see the Canvas section of the Dashboard Designer article for more information. |
| MinTileWidth | Specifies the minimum width a tile will be drawn when Dashboard Reflow is enabled. Please see the Canvas section of the Dashboard Designer article for more information. |
| ObjectIdParamName | The Programmable Object Settings enable you to specify names for special parameters that will be passed from Exago to identically named parameters in stored procedures or .NET Assemblies. Using these parameters will allow filtering to be done before the data is sent to Exago. This can increase performance and reduce server resources when using Programmable Objects. For more information on these types of Data Objects see Web Services & .NET Assemblies. Reminder
If an Exago .NET API application needs to access reports with an assembly data source, it must include a reference to the assembly WebReportsAsmi.dll. Provide a parameter name in the programmable object that will hold the Id of Data Object being called. For more information see Calling a Single Web Service/.Net Assembly/Stored Procedure. |
| PasswordRequirement | Requires a password for PDF or Excel file export. |
| ReportPath | This property is deprecated as of v2020.1. Configure Storage Management instead. |
| ReportScheduleEmailBody | Sets a default body that will be displayed in the schedule report wizard. |
| ReportScheduleEmailSubject |
Set a default subject that will be displayed in the schedule report wizard. |
| ReportTreeShortcutRun | Whether the report execute button in the Report Tree defaults to Run the report in the Report Viewer, or Export the report to the default format. |
| RESTKey | Set a key to authenticate REST requests. Review the Authorization section of the Introduction to REST article for more information. |
| ScheduleManagerViewLevel | Controls what information the user can see in the Schedule Manager. These levels refer to the Parameters companyId and userId.
|
| ScheduleRemotingHost |
Sets the orgin(s) to the Scheduler Service. Separate multiple remoting hosts with a comma or semicolon. The protocol and port must match the Scheduler Service's |
| SchedulerQueueService | Specifies the web or assembly queue service for custom scheduler management and load balancing. |
| SchemaAccessType | Specifies whether to query the Data Source for an object’s schema or to read it from Column Metadata. See Retrieving Data Object Schemas for more information. |
| SeparatorSymbol | Symbol used to separate 3 digit groups (ex. thousandths) in numeric values. The default is a comma (,). |
| ServerTimeZoneOffset | For versions pre-v2019.1, a decimal value used to convert server to client time. This offset is not applied to data coming from Data Sources. It is utilized by Exago features like the Scheduler Service. Leave blank to use server time. For versions v2019.1+, this value is only used to set an initial client time zone name if one is not set but is otherwise not used. Use Client Time Zone Name for all time zone changes.
|
| SortParamName | The Programmable Object Settings enable you to specify names for special parameters that will be passed from Exago to identically named parameters in stored procedures or .NET Assemblies. Using these parameters will allow filtering to be done before the data is sent to Exago. This can increase performance and reduce server resources when using Programmable Objects. For more information on these types of Data Objects see Web Services & .NET Assemblies. Reminder
If an Exago .NET API application needs to access reports with an assembly data source, it must include a reference to the assembly WebReportsAsmi.dll. Provide a parameter name in the programmable object that will hold the sort string for the report. If using call type 2, it can indicate which direction the user is scrolling a filter dropdown. ASC indicates scrolling down or DESC indicates scrolling up. |
| SqlGenerationLevel | Set the level of in-database formula grouping used by Exago. This value should be 1 unless otherwise directed by Exago Support. |
| SynchronousRemotingHost |
Specifies the Scheduler Services to use for remote execution. Separate multiple servers with commas or semicolons. The protocol and port must match the Scheduler Service's |
| TempCloudService | Web Service, .NET Assembly, or Azure Authentication string used to integrate into a cloud environment. For more information see Cloud Environment Integration. This is Exago's built-in solution for handling multiple instances. Specifying a Temp Cloud Service causes each instance to push its temporary files to a shared Blob container. Then if a subsequent user call reaches a separate instance, that instance will pull the relevant files from the Blob to its local temp directory. Temp files may only be stored in blob storage. |
| TempPath | The absolute path that Exago BI uses to store temporary files. Warning: Do not change the TempPath value in the API. Changing this value will cause sessions to fail due to a reference path mismatch, because the API object representation is stored in the original TempPath upon instantiation. |
| TempUrl | Overrides the portion of the temporary URL used to store images from HTML exports. Temp URL can override just the scheme (i.e. https) or the full URL. |
| TimeFormat | The format of time values. May be any .NET standard (e.g., h:mm:ss tt). |
| UseExecutionCache |
Enables/disables users to use an execution cache for their reports. An execution cache refreshes report data on a schedule, and report execution calls use the cached data instead of querying the data source each time the report is executed. This dropdown will only display False until all conditions in the Enabling Execution Caching section of the Execution Caching article are met. Then, this setting can be changed to True to enable the feature. |
| UserAllowUserReports | Set to False to prevent users from saving changes made to reports in the Report Viewer as User Preferences. Set to True to allow changes in the Report Viewer to be stored in User Preferences and applied to future report executions. |
| UserPreferenceStorage | How to store User Preferences such as which Dashboards and/or Reports to execute when a user enters Exago. A user is identified by the values of the system parameters @userId@ and @companyId@. |
| UserStartupReportMaxNum | Sets the number of Dashboards and/or Reports that can be executed when a user enters Exago. |
| UserStartupReportOverwriteGettingStarted | Set to False to display both the Getting Started Content and any Dashboard and/or Reports that were set to run at startup. Set to True to hide the Getting Started Content if any Dashboards and/or Reports execute when a user enters Exago. |
| UseSVGForAppIcons | Set to True to se SVG icons instead of the default PNG icons in user interface elements. SVG icons look nicer on high-pixel density screens, but they may not be compatible with some web browsers. |
| VisualizationDbRowLimit | Maximum number of rows returned on an execution. This only applies to Tables, Views and Functions. Set to 0 to return all rows. |
| WebRequestKeepAlive | Set to True to allow the use of a single TCP connection to send and receive multiple HTTP requests. If set to False, a new TCP connection will be opened for every HTTP request. This flag only applies to Google Maps widgets. |
| WriteBOMtoCsv | Attaches a Byte Order Mark (BOM), an optional abstract character used to declare and recognize Unicode encoding of a text file, to the beginning of CSV file exports. Set to True to enable. |
Exago .NET API Documentation
General Class Properties
icon on the tile, or the Refresh 
will appear in the tile and toolbar. By limiting the frequency of calls to the Data Sources and execution engine, responsiveness of the Dashboard Designer can increase especially for very complex and data intensive Dashboards.