Exago Logo
Search
Generic filters
Exact matches only

REST – Config Settings

The Settings endpoint allows you to access many relevant settings for the current configuration.

Settings JSON

Settings are represented as JSON objects with the following properties. Each corresponds with a setting in the Admin Console and/or Config file.

Some settings appear both in the Settings JSON (Table A) and in General Settings JSON (Table B). When this happens, the setting contained in Table B should be used in lieu of the one in Table A.

NameTypeWritable
GeneralGeneral Settingsyes
DateFormat
Deperecated. Use General/DateFormat instead.
stringyes
TimeFormat
Deprecated. Use General/TimeFormat instead.
stringyes
DateTimeFormat
Deprecated. Use General/DateTimeFormat instead.
stringyes
SeparatorSymbol
Deprecated. Use General/SeperatorSumbol instead.
stringyes
CurrencySymbol
Deprecated. Use General/CurrencySymbol instead.
stringyes
DecimalSymbol
Deprecated. Use General/DecimalSymbol insread.
stringyes
ShowGrid
Deprecated. Use General/IsShowGrid instead.
booleanyes
ShowCrossTabReports
Deperecared. Use General/IsShowCrossTabReports instead.
booleanyes
ShowExpressReports
Deprecated. Use General/IsShowExpressReports instead.
booleanyes
ShowExpressReportsGrouping
Deprested. Use General/IsShowExpressReportsGrouping instead.
booleanyes
ShowExpressReportsFormulas
Deprecated. Use General/IsShowExpressReportsFormulaButton instead.
booleanyes
ShowExpressReportsStyling
Deperecated. Use General/IsShowExpressReportsStylingToolbar instead.
booleanyes
ShowExpressReportsThemes
Deprecated. Use General/IsShowExpressReportsThemes instead.
booleanyes
ShowAdvancedReports
Deprecated. Use General/IsShowAdvancedReports instead.
booleanyes
ShowScheduleReports
Deperecated. Use General/IsShowScheduleReports instead.
booleanyes
ShowScheduleReportsManager
Deperecated. Use General/IsShowScheduleReportsManager instead.
booleanyes
ShowScheduleReportsEmail
Deperecated. Use General/IsShowScheduleReportsEmail instead.
booleanyes
ReadFilterValues
Deprecated. Use General/IsReadFilterValues instead.
booleanyes
ShowTabsbooleanyes
WebReportsBaseUrlstringyes
DefaultFolderNamestringyes
DefaultReportNamestringyes
Table A

General Settings JSON

Some settings appear both in the Settings JSON (Table A) and in General Settings JSON (Table B). When this happens, the setting contained in Table B should be used in lieu of the one in Table A.

NameTypeWritable
ReportPathstringyes
AllowHomeDirectbooleanyes
AllowHtmlOutputbooleanyes
AllowExcelOutputbooleanyes
AllowPdfOutputbooleanyes
AllowRtfOutputbooleanyes
AllowCsvOutputbooleanyes
DefaultOutputTypewrExportTypeyes
IsWriteLogbooleanyes
CustomCodestringyes
LicenseKeystringyes
DateFormatstringyes
TimeFormatstringyes
DateTimeFormatstringyes
DateTimeTreatedAsinteger

 

  1. Date
  2. Time
  3. DateTime
yes
IsReadFilterValuesbooleanyes
DbTimeoutintegeryes
DbRowLimitintegeryes
DbRowLimitStepSizeintegeryes
VisualizationDbRowLimitintegeryes
CallTypeParamNamestringyes
ColumnParamNamestringyes
FilterParamNamestringyes
FullFilterParamNamestringyes
SortParamNamestringyes
DataCategoryParamNamestringyes
ObjectIdParamNamestringyes
IsShowGridbooleanyes
ActiveRoleIdstringyes
IsDebuggingbooleanyes
IsShowPdfTemplatebooleanyes
IsDashboardPromptAtExecutionbooleanyes
IsDashboardShowUrlItemButtonbooleanyes
IsVisualizationShowKeywordbooleanyes
IsShowChartWizardbooleanyes
IsShowMapWizardbooleanyes
IsShowGoogleMapWizardbooleanyes
IsShowGaugeWizardbooleanyes
IsSaveOnExecutebooleanyes
IsSaveOnFinishbooleanyes
IsEnableRightClickMenusbooleanyes
IsEnableReportsTreeDragAndDropbooleanyes
IsShowLinkReportFieldsbooleanyes
IsShowLinkReportFormulabooleanyes
IsShowLinkActionbooleanyes
IsShowInsertImagebooleanyes
ExpirationDateStrstringyes
IsHtmlPagingbooleanyes
WindowHeightintegeryes
WindowWidthintegeryes
SeparatorSymbolstringyes
CurrencySymbolstringyes
DecimalSymbolstringyes
IsDataMappingbooleanyes
IsShowJoinFieldsbooleanyes
IsDetectJoinedObjectsbooleanyes
IsEnableSpecialCartesianProcessingbooleanyes
IsIncludeNotFilterNullValuesbooleanyes
TempPathstringno
TempCloudServicestringyes
DataCloudServicestringyes
IsShowScheduleReportsbooleanyes
IsShowScheduleReportsManagerbooleanyes
ScheduleManagerViewLevelSchedule Manager View Levelyes
IsShowScheduleReportsEmailbooleanyes
ScheduleRemotingHoststringyes
SynchronousRemotingHoststringyes
SchedulerQueueServicestringyes
ReportScheduleEmailSubjectstringyes
ReportScheduleEmailBodystringyes
IsRenewSessionbooleanyes
PasswordRequirementstringyes
IsExecuteRemotelybooleanyes
IsAccessDataSourcesRemotelybooleanyes
MaxTempFileAgeintegeryes
AllowExecuteNewFiltersbooleanyes
ExternalInterfacestringyes
DecimalPlacesintegeryes
CurrencyDecimalPlacesintegeryes
ApplyGeneralFormatDecimalPlacesbooleanyes
ApplyGeneralCurrencyRightAlignmentbooleanyes
ChartColorsstringyes
GeochartMapKeystringyes
MapColorsstringyes
GoogleMapKey pre-v2018.1stringyes
GoogleMapJSAPIKey v2018.1+stringyes
GoogleMapGeocodeAPIKey v2018.1+stringyes
GoogleMapColorsstringyes
GaugeColorsstringyes
IsShowGroupFiltersbooleanyes
IsShowJoinsWindowbooleanyes
IsShowAdvancedJoinsbooleanyes
IsShowEventsWindowbooleanyes
IsShowReportParametersWindowbooleanyes
IsShowCrosstabReportsbooleanyes
IsShowDashboardReportsbooleanyes
IsShowChainedReportsbooleanyes
IsAllowExpressViewLiveEditbooleanyes
IsShowExpressViewsbooleanyes
IsShowDashboardNewVisualizationButtonbooleanyes
IsShowDashboardDataFieldsSearchbooleanyes
IsShowExpressViewDataFieldsSearchbooleanyes
IsUseSampleDataForDashboardVisualizationDesignbooleanyes
IsDashboardPromptKeywordByDefaultbooleanyes
IsShowExpressReportsbooleanyes
IsShowExpressReportsGroupingbooleanyes
IsShowExpressReportsFormulaButtonbooleanyes
IsShowExpressReportsStylingToolbarbooleanyes
IsShowExpressReportsThemesbooleanyes
IsShowAdvancedReportsbooleanyes
IsShowGroupHeadersFormulaButtonbooleanyes
IsOneCategoryLimitbooleanyes
IsCacheServicesbooleanyes
SchedulerRecipientWindowstringyes
FilterExecutionWindowstringyes
IsShowIeDownloadButtonbooleanyes
IsDeleteSchedulesUponReportDeletionbooleanyes
AllowMultipleSessionsbooleanyes
AllowMD5OnFIPSbooleanyes
WriteBOMToCSV v2019.1.1+booleanyes
IsShowScheduleNoEndDatebooleanyes
IsShowScheduleIntradayRecurrencebooleanyes
TempUrlstringyes
UserPreferenceStorageintegeryes
UserStartupReportOverwriteGettingStartedbooleanyes
UserStartupReportMaxNumintegeryes
ExcelExportTargetinteger

 

  1. 2003
  2. 2007
  3. 2010
  4. 2013
  5. 2016
yes
AllowDependantFiltersbooleanyes
LinkedReportsInNewTabbooleanyes
LoadImageFuncParamPrefixstringyes
LanguageFilestringyes
IsShowHelpbooleanyes
CustomHelpSourcestringyes
IsEmailScheduledReportsbooleanyes
IsEnableBatchReportsbooleanyes
IsShowScheduleDeliveryTypeOptionsbooleanyes
IsUseSecureRemotingChannelbooleanyes
IsShowTemplateUploadButtonbooleanyes
UseSVGForAppIconsbooleanyes
CrossTabMaximumFieldsbooleanyes
IsShowExportsInTabbooleanyes
IsShowHtmlToolbarinteger

 

  1. auto
  2. show always
  3. hide always
yes
IsEnableSchedulingbooleanyes
IsShowFilterDescriptionbooleanyes
DefaultFilterExecutionWindowinteger

 

  1. standard
  2. operator
  3. simple
  4. custom
yes
IsChangeableFilterExecutionWindowbooleanyes
IgnoreInaccessibleReportFoldersbooleanyes
SchemaAccessTypeinteger

 

  1. datasource
  2. metadata
yes
ServerTimeZoneOffsetdecimal

 

Note

Set to 0 to use the ClientTimeZoneName. If null, Exago will use the External Interface (a deprecated extensibility feature) to calculate the time zone change.

yes
ClientTimeZoneNamestringyes
IsShowEnhancedTooltipsbooleanyes
IsShowReportUploadDownloadOptionsbooleanyes
AllowInteractiveHtmlbooleanyes
AllowHtmlInScheduledEmailsbooleanyes
DefaultIsDockOpenbooleanyes
DockPlacementinteger

 

  1. left
  2. right
yes
CssThemestringyes
AllowExecuteSaveToDesignbooleanyes
UserAllowUserReportsbooleanyes
MaxNumberOfChartPointsintegeryes
DefaultFontstringyes
DefaultFontSizeintegeryes
DefaultChartFontstringyes
IsWebFarmSupportbooleanyes
IsSilentDashboardRefreshbooleanyes
MaxJobExecutionMinutesintegeryes
ChainedReportMaxCollationExecutions v2021.1.8+integeryes
IsAggregateAndGroupInDatabasebooleanyes
IsEvaluateFormulasInDatabasebooleanyes
IsShowBrowserOutOfDateWarningbooleanyes
AreDateFunctionsLoadedbooleanyes
VersionNumberstringno
DbRowLimitParamName v2018.1stringyes
DbRowRangeStartParamNamev2018.1+stringyes
DbRowRangeEndParamName v2018.1+stringyes
ExpressviewJoinAlgorithm v2018.1+string

 

“Standard” or “Legacy”

yes
ExcludeDataSourcesReportCustomSQL v2018.1+booleanyes
LoadAssemblyInExternalDomain v2018.1+booleanyes
ShowTipsExpressView v2018.2+)booleanyes
ShowTutorialExpressView v2018.2+booleanyes
IsShowSQLWindow v2019.1+booleanyes
SqlGenerationLevel v2020.1+integeryes
Table B

Example:

{
  "General": {
    "ReportPath": "C:ExagoReports",
    "AllowHomeDirect": true,
    "AllowHtmlOutput": true,
    "AllowExcelOutput": true,
    "AllowPdfOutput": true,
    "AllowRtfOutput": true,
    "AllowCsvOutput": true,
    "DefaultOutputType": 2,
    "IsWriteLog": true,
    "CustomCode": "",
    "LicenseKey": "", 
    "DateFormat": "",
    "TimeFormat": "",
    "DateTimeFormat": "",
    "DateTimeTreatedAs": 0,
    "IsReadFilterValues": true,
    "DbTimeout": 600,
    "DbRowLimit": 0,
    "DbRowLimitStepSize": 1000,
    "VisualizationDbRowLimit": 0,
    "CallTypeParamName": "",
    "ColumnParamName": "",
    "FilterParamName": "",
    "FullFilterParamName": "",
    "SortParamName": "",
    "DataCategoryParamName": "",
    "ObjectIdParamName": "",
    "IsShowGrid": true,
    "ActiveRoleId": "",
    "IsDebugging": false,
    "IsShowPdfTemplate": true,
    "IsDashboardPromptAtExecution": false,
    "IsDashboardShowUrlItemButton": false,
    "IsVisualizationShowKeyword": false,
    "IsShowChartWizard": true,
    "IsShowMapWizard": false,
    "IsShowGoogleMapWizard": false,
    "IsShowGaugeWizard": true,
    "IsSaveOnExecute": true,
    "IsSaveOnFinish": true,
    "IsEnableRightClickMenus": true,
    "IsEnableReportsTreeDragAndDrop": true,
    "IsShowLinkReport": true,
    "IsShowLinkReportFields": true,
    "IsShowLinkReportFormula": false,
    "IsShowLinkAction": false,
    "IsShowInsertImage": true,
    "ExpirationDateStr": "",
    "IsHtmlPaging": true,
    "WindowHeight": 0,
    "WindowWidth": 0,
    "SeparatorSymbol": ",",
    "CurrencySymbol": "$",
    "DecimalSymbol": ".",
    "IsDataMapping": false,
    "IsShowJoinFields": true,
    "IsDetectJoinedObjects": true,
    "IsEnableSpecialCartesianProcessing": true,
    "IsIncludeNotFilterNullValues": false,
    "TempPath": "",
    "TempCloudService": "",
    "DataCloudService": "",
    "IsShowScheduleReports": false,
    "IsShowScheduleReportsManager": false,
    "ScheduleManagerViewLevel": 0,
    "IsShowScheduleReportsEmail": false,
    "ScheduleRemotingHost": "",
    "SynchronousRemotingHost": "",
    "SchedulerQueueService": "",
    "ReportScheduleEmailSubject": "",
    "ReportScheduleEmailBody": "",
    "IsRenewSession": true,
    "PasswordRequirement": "",
    "IsExecuteRemotely": false,
    "IsAccessDataSourcesRemotely": false,
    "MaxTempFileAge": 1440,
    "AllowExecuteNewFilters": true,
    "ExternalInterface": "",
    "DecimalPlaces": -1,
    "CurrencyDecimalPlaces": -1,
    "ApplyGeneralFormatDecimalPlaces": false,
    "ApplyGeneralCurrencyRightAlignment": true,
    "ChartColors": "#e85d61, #e5d08f, #00d995",
    "GeochartMapKey": "",
    "MapColors": "Lightblue,Navy",
    "GoogleMapKey": "",
    "GoogleMapColors": "Lightblue,Navy",
    "GaugeColors": "#e85d61, #e5d08f, #00d995",
    "IsShowGroupFilters": true,
    "IsShowJoinsWindow": true,
    "IsShowAdvancedJoins": true,
    "IsShowEventsWindow": false,
    "IsShowReportParametersWindow": true,
    "IsShowCrosstabReports": true,
    "IsShowDashboardReports": true,
    "IsShowChainedReports": true,
    "IsAllowExpressViewLiveEdit": false,
    "IsShowExpressViews": true,
    "IsShowDashboardNewVisualizationButton": true,
    "IsShowDashboardDataFieldsSearch": false,
    "IsShowExpressViewDataFieldsSearch": true,
    "IsUseSampleDataForDashboardVisualizationDesign": true,
    "IsShowDashboardExistingVisualizationReportButton": false,
    "IsDashboardPromptKeywordByDefault": false,
    "IsShowExpressReports": true,
    "IsShowExpressReportsGrouping": true,
    "IsShowExpressReportsFormulaButton": true,
    "IsShowExpressReportsStylingToolbar": true,
    "IsShowExpressReportsThemes": true,
    "IsShowAdvancedReports": true,
    "IsShowGroupHeadersFormulaButton": false,
    "IsOneCategoryLimit": false,
    "IsCacheServices": true,
    "SchedulerRecipientWindow": "",
    "FilterExecutionWindow": "",
    "IsShowIeDownloadButton": false,
    "IsDeleteSchedulesUponReportDeletion": false,
    "AllowMultipleSessions": true,
    "AllowMD5OnFIPS": false,
    "WriteBOMToCSV": false,
    "IsShowScheduleNoEndDate": true,
    "IsShowScheduleIntradayRecurrence": true,
    "TempUrl": "",
    "UserPreferenceStorage": 0,
    "UserStartupReportOverwriteGettingStarted": false,
    "UserStartupReportMaxNum": 1,
    "ExcelExportTarget": 1,
    "AllowDependantFilters": false,
    "LinkedReportsInNewTab": false,
    "LoadImageFuncParamPrefix": "",
    "LanguageFile": "en-us,en-us-getting-started,en-us-tooltips",
    "IsShowHelp": true,
    "CustomHelpSource": "",
    "IsEmailScheduledReports": true,
    "IsEnableBatchReports": false,
    "IsShowScheduleDeliveryTypeOptions": false,
    "IsUseSecureRemotingChannel": false,
    "IsShowTemplateUploadButton": false,
    "UseSVGForAppIcons": true,
    "CrossTabMaximumFields": 5,
    "IsShowExportsInTab": true,
    "IsShowHtmlToolbar": 0,
    "IsEnableScheduling": true,
    "IsShowFilterDescription": false,
    "DefaultFilterExecutionWindow": 0,
    "IsChangeableFilterExecutionWindow": true,
    "IgnoreInaccessibleReportFolders": false,
    "SchemaAccessType": 1,
    "ServerTimeZoneOffset": 0,
    "ClientTimeZoneName": "America/New_York",
    "IsShowEnhancedTooltips": true,
    "IsShowReportUploadDownloadOptions": false,
    "AllowInteractiveHtml": true,
    "AllowHtmlInScheduledEmails": false,
    "DefaultIsDockOpen": false,
    "DockPlacement": 0,
    "CssTheme": "Basic",
    "AllowExecuteSaveToDesign": true,
    "UserAllowUserReports": true,
    "MaxNumberOfChartPoints": 300,
    "DefaultFont": "Arial",
    "DefaultFontSize": 8,
    "DefaultChartFont": "Arial",
    "IsWebFarmSupport": false,
    "IsSilentDashboardRefresh": false,
    "MaxJobExecutionMinutes": 240,
    "IsAggregateAndGroupInDatabase": false,
    "IsEvaluateFormulasInDatabase": true,
    "IsShowBrowserOutOfDateWarning": true,
    "AreDateFunctionsLoaded": true,
    "VersionNumber": "2016.3.4.100"
  },
  "DateFormat": "",
  "TimeFormat": "",
  "DateTimeFormat": "",
  "SeparatorSymbol": ",",
  "CurrencySymbol": "$",
  "DecimalSymbol": ".",
  "ShowGrid": true,
  "ShowCrossTabReports": true,
  "ShowExpressReports": true,
  "ShowExpressReportsGrouping": true,
  "ShowExpressReportsFormulas": true,
  "ShowExpressReportsStyling": true,
  "ShowExpressReportsThemes": true,
  "ShowAdvancedReports": true,
  "ShowScheduleReports": false,
  "ShowScheduleReportsManager": false,
  "ShowScheduleReportsEmail": false,
  "ReadFilterValues": true,
  "ShowTabs": true,
  "WebReportsBaseUrl": null,
  "DefaultFolderName": "",
  "DefaultReportName": ""
}

Note

All requests require a Session ID URL parameter and basic request headers. In the following document, headers are omitted in the interest of brevity.

Show Settings

GET /rest/Settings

Show the available settings for the current configuration.

Using curl

curl http://{webservice}/rest/Settings?sid={sid} -X GET

Example response

Status: 200 OK

{
  "General": {
    "ReportPath": "C:ExagoReports",
    ...
  }
  "DateFormat":                 "MM/dd/yyyy",
  "TimeFormat":                 "hh:mm:ss a",
  "DateTimeFormat":             "MM/dd/yyyy hh:mm:ss a",
  "SeparatorSymbol":            ",",
  "CurrencySymbol":             "$",
  "ShowGrid":                   true,
  "ShowCrossTabReports":        true,
  "ShowExpressReports":         true,
  ...
}

Edit Settings

PATCH /rest/Settings

Only supply the properties to be edited.

Using curl

curl http://{webservice}/rest/settings?sid={sid} -X PATCH ^
	-d "{
             'General':
              {
                'ReportPath':'C:ExagoReports',
                'IsShowLinkReportFormula':false,
                ...
              }
             'ShowScheduleReports':false,
             'ShowExpressReports':false,
             ...
            }"

Example response

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