Config File and API Setting Reference
If you build your config files directly, without using the Admin Console, or if you change settings in the API, use this reference to map Admin Console settings to the relevant config file node or API key.
Note: For other config file elements, see Config File XML Reference.
Format:
Setting Name : type
-
<config_file_node>
(within the <general> element)
-
Api_Key (within the Api.SetupData.General namespace)
Use Ctrl-F to find a specific setting.
Main Settings
See Main Settings for more information.
Report Path : string
Temp Path : string
Temp Cloud Service : string
<tempcloudservice>
- TempCloudService
Language File : string
<languagefile>
- LanguageFile
Temp URL : string
Allow direct access to Exago (bypassing API) : bool
<allowhomedirect>
- AllowHomeDirect
Allow Execution in Viewer : bool
<allowhtmloutput>
- AllowHtmlOutput
Allowed Export Types - Excel : bool
<allowexceloutput>
- AllowExcelOutput
Allowed Export Types - PDF : bool
<allowpdfoutput>
- AllowPdfOutput
Allowed Export Types - RTF : bool
<allowrtfoutput>
- AllowRtfOutput
Allowed Export Types - CSV : bool
<allowcsvoutput>
- AllowCsvOutput
Default Output Type : constant
Possible values: excel, pdf, rtf, csv
<defaultoutputtype>
- DefaultOutputType
Report Tree Shortcut
-
<reporttreeshortcut>
: constant, possible values: Run, Export
- ReportTreeShortcutRun : bool
Culture Settings
See Culture Settings for more information.
Date Format : string
Time Format : string
DateTime Format : string
<datetimeformat>
- DateTimeFormat
DateTime Values Treated As : constant
Possible values: date, datetime
<datetimetreatedas>
- DateTimeTreatedAs
Numeric Separator Symbol : string
<separatorsymbol>
- SeparatorSymbol
Numeric Currency Symbol : string
<currencysymbol>
- CurrencySymbol
Numeric Decimal Symbol : string
<decimalsymbol>
- DecimalSymbol
Numeric Decimal Places : int
<decimalplaces>
- DecimalPlaces
Currency Decimal Places : int
<currencydecimalplaces>
- CurrencyDecimalPlaces
Apply Numeric Decimal Places to General Cell Formatting : bool
<applygeneralformatdecimalplaces>
- ApplyGeneralFormatDecimalPlaces
Apply General Currency Right Alignment : bool
<applygeneralcurrencyrightalignment>
- ApplyGeneralCurrencyRightAlignment
Server Time Zone Offset : int
<servertimezoneoffset>
- ServerTimeZoneOffset
Feature/UI Settings
See Feature/UI Settings for more information.
Allow Creation/Editing of Express Reports : bool
<showexpressreports>
- IsShowExpressReports
Allow Creation/Editing of Advanced Reports : bool
<showadvancedreports>
- IsShowAdvancedReports
Allow Creation of Crosstab Reports : bool
<showcrosstabreports>
- IsShowCrosstabReports
Allow Creation/Editing of Dashboards : bool
<showdashboardreports>
- IsShowDashboardReports
Allow Creation/Editing of Chained Reports : bool
<showchainedreports>
- IsShowChainedReports
Allow Creation/Editing of ExpressViews : bool
<showexpressviews>
- IsShowExpressViews
Allow Editing ExpressView with Live Data : bool
<allowexpressviewliveedit>
- IsAllowExpressViewLiveEdit
(pre-v2017.2) Show Data Fields Search Box : bool
<showexpressviewdatafieldssearch>
- IsShowExpressViewDataFieldsSearch
(pre-v2017.2) Fields Enabled in Data Fields Tree : bool
<expressviewdatafieldsdisplay>
- IsExpressViewDataFieldsDisplay
(v2017.2+) Fields Enabled in Data Fields Tree : bool
<showdatafieldssearch>
- IsShowDataFieldsSearch
Show Styling Toolbar : bool
<showexpressreportsstylingtoolbar>
- IsShowExpressReportsStylingToolbar
Show Themes : bool
<showexpressreportsthemes>
- IsShowExpressReportsThemes
Show Grouping : bool
<showexpressreportsgrouping>
- IsShowExpressReportsGrouping
Show Formula Button : bool
<showexpressreportsformulabutton>
- IsShowExpressReportsFormulaButton
Show Chart Wizard : bool
<showchartwizard>
- IsShowChartWizard
Chart Colors : string
<chartcolors>
- ChartColors
Maximum Number of Chart Data Points : int
<maxnumberofchartpoints>
- MaxNumberOfChartPoints
Default Chart Font : string
<defaultchartfont>
- DefaultChartFont
Show Geochart Map Wizard : bool
<showmapwizard>
- IsShowMapWizard
Geochart Map Key (optional) : string
<geochartmapkey>
- GeochartMapKey
Geochart Map Colors : string
Show Google Map Wizard : bool
<showgooglemapwizard>
- IsShowGoogleMapWizard
(pre-v2018.1) Google Map Key : string
<googlemapkey>
- GoogleMapKey
(v2018.1+) Google Map Key (unlimited or JS API restricted) : string
<googlemapjsapikey>
- GoogleMapJSAPIKey
(v2018.1+) Google Map Key (optional Geocode API restricted) : string
<googlemapgeocodeapikey>
- GoogleMapGeocodeAPIKey
Google Map Colors : string
<googlemapcolors>
- GoogleMapColors
Show Gauge Wizard : bool
<showgaugewizard>
- IsShowGaugeWizard
Gauge Colors : bool
<gaugecolors>
- GaugeColors
Show Document Template : bool
<showpdftemplate>
- IsShowPdfTemplate
Show Document Template Upload Button : bool
<showtemplateuploadbutton>
- IsShowTemplateUploadButton
Show Linked Report : bool
<showlinkreport>
- IsShowLinkReport
Show Linked Report Fields : bool
<showlinkreportfields>
- IsShowLinkReportFields
Show Linked Report Formula : bool
<showlinkreportformula>
- IsShowLinkReportFormula
Show Linked Action : bool
<showlinkaction>
- IsShowLinkAction
Show Insert Image : bool
<showinsertimage>
- IsShowInsertImage
Show Joins Window : bool
<showjoinswindow>
- IsShowJoinsWindow
Show Advanced Joins : bool
<showadvancedjoins>
- IsShowAdvancedJoins
(v2017.3.1+) Advanced Joins Display : bool
<showcomplexjoins>
- IsShowComplexJoins
(v2017.3.1+) Allow Category Aliasing : bool
<showcategoryalias>
- IsShowCategoryAlias
Show Events Window : bool
<showeventswindow>
- IsShowEventsWindow
(pre-v2017.3) Show Linked Reports in New Tab : bool
<linkedreportsinnewtab>
- LinkedReportsInNewTab
(v2017.3+) Linked Report Display : constant
Possible values: Cursor, NewTab, ScreenCenter
<linkedreportdisplay>
- LinkedReportDisplay
Allow Grouping on non-Sorts : bool
<showgroupheadersformulabutton>
- IsShowGroupHeadersFormulaButton
Prompt user for Parameters/Filters on Execution : bool
<dashboardpromptatexecution>
- IsDashboardPromptAtExecution
Show URL Item Button : bool
<dashboardshowurlitembutton>
- IsDashboardShowUrlItemButton
Allow Creation/Editing of Dashboard Visualizations : bool
<showdashboardnewvisualizationbutton>
- IsShowDashboardNewVisualizationButton
Show Data Fields Search Box : bool
<showdashboarddatafieldssearch>
- IsShowDashboardDataFieldsSearch
Use Sample Data for Dashboard Visualization Design : bool
<usesampledatafordashboardvisualizationdesign>
- IsUseSampleDataForDashboardVisualizationDesign
Visualization Database Row Limit : int
<visualizationdbrowlimit>
- VisualizationDbRowLimit
Refresh Reports/Visualizations on Dashboards Silently : bool
<silentdashboardrefresh>
- IsSilentDashboardRefresh
Default Designer Font : string
<defaultfont>
- DefaultFont
Default Designer Font Size : int
<defaultfontsize>
- DefaultFontSize
Show Help Button : bool
Custom Help Source : string
<customhelpsource>
- CustomHelpSource
Show Exports in Tab : bool
<showexportsintab>
- IsShowExportsInTab
Show IE Download Button : bool
<showiedownloadbutton>
- IsShowIeDownloadButton
Show Join Fields : bool
<showjoinfields>
- IsShowJoinFields
Show Grid Lines in Report Viewer : bool
Show Enhanced Tooltips : bool
<enhancedtooltips>
- IsShowEnhancedTooltips
Save on Report Execution : bool
<saveonexecute>
- IsSaveOnExecute
Save on Finish Press : bool
<saveonfinish>
- IsSaveOnFinish
Enable Right-Click Menus : bool
<enablerightclickmenus>
- IsEnableRightClickMenus
Enable Reports Tree Drag And Drop : bool
<enablereportstreedraganddrop>
- IsEnableReportsTreeDragAndDrop
Show Report Upload/Download Options : bool
<showreportuploaddownloadoptions>
- IsShowReportUploadDownloadOptions
Allow interactivity in report viewer : bool
<interactivehtml>
- AllowInteractiveHtml
Show Toolbar in Report Viewer : constant
Possible values: Auto, Show, Hide
<showhtmltoolbar>
- IsShowHtmlToolbar
Default interactive report viewer dock is open : bool
<defaultisdockopen>
- DefaultIsDockOpen
Interactive report viewer default dock placement : constant
Possible values: Left, Right
<dockplacement>
- IsEnableScheduling
Allow save to report design from the report viewer : bool
<executesavetodesign>
- AllowExecuteSaveToDesign
Maximum number of fields in a crosstab header or tabulation source : int
<crosstabmaximumfields>
- CrossTabMaximumFields
Use SVG for Application Icons : bool
<usesvgforappicons>
- UseSVGForAppIcons
Application Theme Selection : string
(v2018.1+) Join Path Algorithm : const
<expressviewjoinalgorithm>
- ExpressviewJoinAlgorithm
(v2018.1+) Allow Creation of Custom SQL Objects : bool
<allowreportcustomsqlobjects>
- IsAllowReportCustomSQLObjects
(v2018.1+) Data Sources to Exclude from Custom SQL Object Creation : string
<excludedatasourcesreportcustomsql>
- ExcludeDataSourcesReportCustomSQL
Programmable Object Settings
See Programmable Object Settings for more information.
Call Type Parameter Name : string
<calltypeparamname>
- CallTypeParamName
Column Parameter Name : string
<columnparamname>
- ColumnParamName
Filter Parameter Name : string
<filterparamname>
- FilterParamName
Full Filter Parameter Name : string
<fullfilterparamname>
- FullFilterParamName
Sort Parameter Name : string
<sortparamname>
- SortParamName
Data Category Parameter Name : string
<datacategoryparamname>
- DataCategoryParamName
Data Object ID Parameter Name : string
<objectidparamname>
- ObjectIdParamName
(v2018.1+) DB Row Limit Parameter Name : string
<dbrowlimitparamname>
- DbRowLimitParamName
(v2018.1+) DB Row Start Index Parameter Name : string
<dbrowrangestartparamname>
- DbRowRangeStartParamName
(v2018.1+) DB Row End Index Parameter Name : string
<dbrowrangeendparamname>
- DbRowRangeEndParamName
Filter Settings
See Filter Settings for more information.
Show Group (Min/Max) Filters : bool
<showgroupfilters>
- IsShowGroupFilters
Show Top N Filters : bool
Allow New Filters at Execution : bool
<allowexecutenewfilters>
- AllowExecuteNewFilters
Read Database for Filter Values : bool
<readfiltervalues>
- IsReadFilterValues
Allow Filter Dependencies : bool
<allowdependantfilters>
- AllowDependantFilters
Show Filter Description : bool
<showfilterdescription>
- IsShowFilterDescription
Default Filter Execution Window : constant
Possible values: Standard, SimpleWithOperator, Simple, Custom
<defaultFilterExecutionWindow>
- DefaultFilterExecutionWindow
Allow User to Change Filter Window : bool
<changeableFilterExecutionWindow>
- IsChangeableFilterExecutionWindow
Include Null Values for 'NOT' Filters : bool
<includenotfilternullvalues>
- IsIncludeNotFilterNullValues
Custom Filter Execution Window : string
<filterexecutionwindow>
- FilterExecutionWindow
Database Settings
See Database Settings for more information.
Database Timeout : int
Database Row Limit : int
(v2017.2+) Row Limit Step Size : int
<dbrowlimitstepsize>
- DbRowLimitStepSize
Disable Non-Joined Data Objects : bool
<detectjoinedobjects>
- IsDetectJoinedObjects
Enable Special Cartesian Processing : bool
<enablespecialcartesianprocessing>
- IsEnableSpecialCartesianProcessing
Aggregate and Group in Database : bool
<aggregateandgroupindatabase>
- IsAggregateAndGroupInDatabase
Scheduler Settings
See Scheduler Settings for more information.
Enable Report Scheduling : bool
<enablescheduling>
- IsEnableScheduling
Show Report Scheduling Option : bool
<showschedulereports>
- IsShowScheduleReports
Show Email Report Options : bool
<showschedulereportsemail>
- IsShowScheduleReportsEmail
Show Schedule Reports Manager : bool
<showschedulereportsmanager>
- IsShowScheduleReportsManager
Show Schedule No End Date Option : bool
<showschedulenoenddate>
- IsShowScheduleNoEndDate
Show Schedule Intraday Recurrence Option : bool
<showscheduleintradayrecurrence>
- IsShowScheduleIntradayRecurrence
Scheduler Manager User View Level : constant
Possible values: User, Company, All
<schedulemanagerviewlevel>
- ScheduleManagerViewLevel
Email Scheduled Reports : bool
<emailscheduledreports>
- IsEmailScheduledReports
Enable Batch Reports : bool
<enablebatchreports>
- IsEnableBatchReports
Show Schedule Delivery Type Options : bool
<showscheduledeliverytypeoptions>
- IsShowScheduleDeliveryTypeOptions
Use Secure Scheduler Remoting Channel : bool
<usesecureremotingchannel>
- IsUseSecureRemotingChannel
Schedule Remoting Host : string
<scheduleremotinghost>
- ScheduleRemotingHost
Enable Remote Report Execution : bool
<executeremotely>
- IsExecuteRemotely
Enable Execution Cache : bool
<executioncache>
- UseExecutionCache
(v2017.3+) User Cache Visibility Level : constant
Possible values: Global, Company, User
- <cachevisibilitylevel>
- CacheVisibilityLevel
Enable Access to Data Sources Remotely : bool
<accessdatasourcesremotely>
- IsAccessDataSourcesRemotely
Remote Execution Remoting Host : string
<synchronousremotinghost>
- SynchronousRemotingHost
Custom Queue Service : string
<schedulerqueueservice>
- SchedulerQueueService
Delete Schedules upon Report Deletion : bool
<deleteschedulesuponreportdeletion>
- IsDeleteSchedulesUponReportDeletion
Default Email Subject : string
<reportscheduleemailsubject>
- ReportScheduleEmailSubject
Default Email Body : string
<reportscheduleemailbody>
- ReportScheduleEmailBody
Password Requirements (for pdf and excel documents) : string
<passwordrequirement>
- PasswordRequirement
Custom Scheduler Recipient Window : string
<schedulerrecipientwindow>
- SchedulerRecipientWindow
User Settings
See User Settings for more information.
User Preference Storage Method : constant
Possible values: None, Cookie, ExternalInterface, ServerEvent
<userprefstorage>
- UserPreferenceStorage
Startup Report(s) Replace Getting Started : bool
<userstartupreportoverwritegettingstarted>
- UserStartupReportOverwriteGettingStarted
Maximum Number of Startup Reports : int
<userstartupreportmaxnum>
- UserStartupReportMaxNum
Allow User Reports : bool
<userallowuserreports>
- UserAllowUserReports
Other Settings
See Other Settings for more information.
Excel Export Target : constant
Possible values: v2003, v2007, v2010
<excelexporttarget>
- ExcelExportTarget
External Interface : string
<externalinterface>
- ExternalInterface
Enable Paging in Report Viewer : bool
<htmlpaging>
- IsHtmlPaging
Renew Session Automatically : bool
<renewsession>
- IsRenewSession
(pre-v2017.2) Write Log File : bool
(v2017.2+) Write Log File : constant
Possible values: NONE, ERROR, INFO, DEBUG
<logginglevel>
- LoggingLevel
Enable Debugging : bool
Max Report Execution Time (minutes) : int
<maxjobexecutionminutes>
- MaxJobExecutionMinutes
Maximum Age for Temp Files : int
<maxtempfileage>
- MaxTempFileAge
Enable Web Service / Assembly Data Mapping : bool
<datamapping>
- IsDataMapping
Limit Reports and Visualizations to One Category : bool
<onecategorylimit>
- IsOneCategoryLimit
Cache External Services : bool
<cacheservices>
- IsCacheServices
Global Schema Access Type : constant
Possible values: Datasource, Metadata
<schemaaccesstype>
- SchemaAccessType
Allow Multiple Sessions : bool
<allowmultiplesessions>
- AllowMultipleSessions
Allow MD5 Hashing on FIPS server : bool
<allowmd5onfips>
- AllowMD5OnFIPS
'LoadImage' Cell Function Parameter Prefix : string
<loadimageprefix>
- LoadImageFuncParamPrefix
Ignore Inaccessible Report Folders : bool
<ignoreinaccessiblereportfolders>
- IgnoreInaccessibleReportFolders
User ID : string
Password : string
Debug Password : string
<debugextractionpassword>
- DebugExtractionPassword
(v2017.3+) REST Key : string
Exago Expiration Date : string
<expirationdate>
- ExpirationDate
Custom Code Supplied by Exago : bool
Hidden Flags
These settings are not accessible in the Admin Console. See Hidden Flags for more information.
Show CrossTab Wizard : bool
<showcrosstabwizard>
- IsShowCrosstabWizard
ExpressView Default Theme : string
<expressviewdefaultformattheme>
- ExpressViewDefaultFormatTheme
Allow HTML in Scheduled Email Body : bool
<allowhtmlinscheduledemails>
- AllowHtmlInScheduledEmails
Web Farm Support : bool
<webfarmsupport>
- IsWebFarmSupport
Show Browser Out-Of-Date Warning : bool
<showbrowseroutofdatewarning>
- IsShowBrowserOutOfDateWarning
(v2017.2+) Alias All Entities : bool
<aliasallentities>
- AliasAllEntities
(v2017.2+) Safe Mode : bool
(v2017.3+) Allow Early Page Break : bool
- <allowearlypagebreak>
- AllowEarlyPageBreak
Unsupported
These settings are not accessible in the Admin Console. Changing these settings is not supported.
(v2017.2+) Formula functions loaded : bool
<formulafunctionsloaded>
- AreFormulaFunctionsLoaded
Date functions loaded : bool
<datefunctionsloaded>
- AreDateFunctionsLoaded
Version Number : string
<versionnumber>
- VersionNumber
Data Cloud Service : string
<datacloudservice>
- DataCloudService
Window Height : int
<windowheight>
- WindowHeight
Window Width : int
<windowwidth>
- WindowWidth
Map Terms Signature : string
<maptermssignature>
- MapTermsSignature
(v2018.1+) Load Assembly in External Domain : bool
<loadassemblyinexternaldomain>
- LoadAssemblyInExternalDomain
(v2018.1+) Join Transform Objects in Database : bool
<canjointransformobjectsindb>
- CanJoinTransformObjectsInDb
(v2018.1+) Cache Configuration Data : bool
<cacheconfig>
- IsCacheConfig