View source for Customising web config


There are several settings that administrators can edit in the web.config file to alter the default behaviour of XLCubedWeb.

If these don't exist in the <appSettings> section they can be added.

{| class="wikitable" style="margin:0 auto; overflow-wrap: anywhere"
! scope="col" style="width: 35%;" | Setting name
! scope="col" style="width: 40%;" | Description
! scope="col" style="width: 25%;" | Valid values
|-
|{{Code|AllowGuest}}||Not currently used.|| 
|-
|{{Code|AllowHtmlColon}}||Allows outputting or raw html into workbooks.||True/False
|-
|{{Code|AlwaysHideButtons}}||Comma delimited list of toolbar buttons to hide.||SubmitChanges, Print, SaveToExcel, SaveToPowerPoint, SaveToRepository, SaveParameters, Refresh, ToggleSlicerTaskPane
|-
|<span style="font-size: 70%">{{Code|AnalysisServicesAzureAlwaysPromptUserNameAndPassword}}</span>||Forces the logon prompt On/Off even if the published report did not require a password. Useful if Excel connections are integrated with AAD but web requires users to enter their credentials.||True/False
|-
|{{Code|ApplicationUrl}}||The URL that the users use to access the application. Can usually be left blank.||e.g. <nowiki>https://myapplication.example.org/xlcubedweb</nowiki><br />e.g. <nowiki>/xlcubedweb</nowiki>
|-
|{{Code|AutoReloadOnSessionTimeout}}||Allows the report to be automatically reloaded if a user allows their session to time out.||True/False
|-
|{{Code|ClearLevelsMovedToFilters}}||Where an entire level is selected on an axis (potentially a large number of members), and is dragged onto the slicer, the selection is changed to the default member (Typically 'All'). This is to prevent users accidentally creating a very slow running query by individually aggregating all the members dragged to the slicer||True/False
|-
|{{Code|CommentReverseChronology}}||Change the order comments are displayed.||True/False
|-
|{{Code|CustomHelpUrl}}||Allows you to direct your users to a custom help portal you have created.||e.g. <nowiki>https://otherserver.example.org/xlcubedhelp</nowiki>
|-
|{{Code|CustomerLogo}}||Allows you to include a custom logo in the XLCubedWeb header area. The image must be under 32px in height.||e.g. <nowiki>https://otherserver.example.org/companylogo.png</nowiki>
|-
|{{Code|DefaultChartSeries}}||The default number of series to chart on an ad-hoc report.||Integer
|-
|{{Code|DefaultCulture}}||The backup culture where it cannot be retrieved from the browser.||e.g. en-US
|-
|{{Code|DefaultFormatString}}||The default format string to use before the user has set one.||e.g. 0.00
|-
|{{Code|DirectoryServicesSizeLimit}}||Not currently used.|| 
|-
|{{Code|DisableAdhocGrids}}||Adhoc Grids functionality is disabled.||True/False
|-
|{{Code|DisableAnalyticBooks}}||Analytic Books functionality is disabled.||True/False
|-
|{{Code|DisableSettingsButton}}||Preferences functionality is disabled.||True/False
|-
|{{Code|DisableHelpButton}}||Help functionality is disabled.||True/False
|-
|{{Code|DisplaySystemMemProps}}||Show system member properties available for selection.||True/False
|-
|{{Code|DocumentDomain}}||Used when embedding XLCubed within an iframe on a different server.||e.g. otherservice.example.org
|-
|{{Code|DrillthroughAbsoluteMaxRows}}||maximum permitted rows on a drillthrough||Integer
|-
|{{Code|DrillthroughDefaultMaxRows}}||default maximum rows on a drillthrough||Integer
|-
|{{Code|GoogleMapsJavascriptUri}}||Allows specifying a non-default location for the map javascript. Useful when google.com is not reachable, e.g. in China. (from [[Version 8.1]])||e.g. maps.google.com/maps/api/js?sensor=false&v=3.9
|-
|{{Code|GoogleMapsMarkerManJavascriptUri}}||Allows specifying a non-default location for the map javascript. Useful when google.com is not reachable, e.g. in China. (from [[Version 8.1]])||e.g. google-maps-utility-library-v3.googlecode.com/svn/tags/markermanager/1.0/src/markermanager_packed.js
|-
|{{Code|KeepAlive}}||New in [[Version 8.1]]. Set to True to allow XLCubed to make a web request to the server every minute to keep the session alive, and stop open reports from expiring.||True/False
|-
|{{Code|LogErrors}}||Write errors to the Error.log file.||True/False
|-
|{{Code|LogPerformance}}||For debug only.||True/False
|-
|{{Code|MapUseHttps}}||Specifies that XLCubed should use HTTPS links to map scripts. Can usually be left blank.||True/False
|-
|{{Code|MaxChartSeries}}||The maximum number of series to chart on an ad-hoc report.||Integer
|-
|{{Code|MemberRetrieveCount}}||The number of members to retrieve at a time when a tree is expanded. Default is 250.||Integer
|-
|{{Code|PdfConverterPassword}}||Not currently used.|| 
|-
|{{Code|PdfConverterUserName}}||Not currently used.|| 
|-
|{{Code|PdfHostWebBrowser}}||Not currently used.|| 
|-
|{{Code|PdfRenderer}}||Not currently used.|| 
|-
|{{Code|PdfSetCookie}}||Not currently used.|| 
|-
|{{Code|PdfUseAppPoolUserForPdfConversion}}||True to use the IIS configured application pool user for creating the PDF during the PDF print; false uses the impersonated user. Must be true for 64-bit application pools.||True/False
|-
|{{Code|PdfUseAppPoolUserForXpsPrint}}||True to use the IIS configured application pool user for creating the XPS during the PDF print; false uses the impersonated user. Must be true for 64-bit application pools.||True/False
|-
|{{Code|PdfXpsDriver}}||The XPS driver for creating the XPS during the PDF print.||Usually Microsoft XPS Document Writer
|-
|<span style="font-size: 70%">{{Code|PowerBiCloudAlwaysPromptUserNameAndPassword}}</span>||Forces the logon prompt On/Off even if the published report did not require a password. Useful if Excel connections are integrated with AAD but web requires users to enter their credentials.||True/False
|-
|<span style="font-size: 70%">{{Code|PowerBiCloudAuthenticationType}}</span>||Set the authentication type to use.||UsernamePassword/OAuth
|-
|<span style="font-size: 70%">{{Code|AnalysisServicesAzureAlwaysPromptUserNameAndPassword}}</span>||Same as Power BI.||True/False
|-
|<span style="font-size: 70%">{{Code|AnalysisServicesAzureAuthenticationType}}</span>||Same as Power BI.||UsernamePassword/OAuth
|-
|{{Code|PrimaryColor}}||Change the primary color (including top bar). Should be a hex value. For use in the new [[XLCubed Web Portal]] UI only. ||e.g. #1a82c5
|-
|{{Code|ProgressBarCss}}||Custom css class for the progress image. Built in values are "xl3-progress" (the standard position) and "xl3-progress-center" (which centers the image).||e.g. xl3-progress-center
|-
|{{Code|ProgressBarUrl}}||Sets a custom image for the progress bar.||e.g. <nowiki>https://otherserver.example.org/progress.gif</nowiki>
|-
|{{Code|QueryActiveDirectory}}||Used to display the user name on homepage.||True/False
|-
|{{Code|RepositioryRootUNC}}||No longer supported - listed for compatibility reasons. To create a shared repository, use [https://en.wikipedia.org/wiki/NTFS_symbolic_link MKLink] to replace the folder with a Symbolic Link to a network share.|| 
|-
|{{Code|RespositoryFileMenu}}||New in Version 8.1.23. Enable or disable "Delete/Rename" right-click options on a file.||True/False
|-
|{{Code|RespositoryFolderMenu}}||New in Version 8.1.23. Enable or disable "Delete/Rename" right-click options on a folder.||True/False
|-
|{{Code|SearchDefaultType}}||The default search type to be used in the member selector quick search.||Possible values are Equals, BeginsWith, Contains. Default value is BeginsWith.
|-
|{{Code|SQLRepositoryConnectionString}}||The connection string used to connect to the [[SQL Repository]].||e.g. Data Source=sql.example.org;Initial Catalog=XLCubedWeb;Integrated Security=True
|-
|{{Code|SharePointOnlyEncryptedUrls}}||If enabled then only encrypted paths are allowed for showing embedded SharePoint report.||True/False
|-
|{{Code|SharePointUseRepository}}||Whether to use SharePoint for the repository.||True/False
|-
|{{Code|SharePointServerUrl}}||The SharePoint server to use for the repository.||e.g. <nowiki>http://sharepoint</nowiki>
|-
|{{Code|ShowErrorMessages}}||Show detailed error messages or just a reference to the log file.||True/False
|-
|{{Code|ShowReportNameInTooltip}}||From v10.0.98. Set to True to show the full report name when hovering over a report in the repository bar.||True/False
|-
|{{Code|ShowReportsBeforeFolders}}||New in [[Version 8.1]]. Set to True to display reports before sub-folders.||True/False
|-
|{{Code|StartupReport}}||Replaces the default startup page with the specified report.||e.g. Reports/StartupReport.xml
|-
|{{Code|StopImpersonatingDuringDataAccess}}||Stops impersonation during multidimensional data access. Connection will be made as the AppPool user instead.||True/False
|-
|<span style="font-size: 70%">{{Code|StopImpersonatingDuringRelationalDataAccess}}</span>||Stops impersonation during relational data access. Connection will be made as the AppPool user instead.||True/False
|-
|{{Code|TwoPassQueryMaxTupleCount}}||The maximum number of tuples to submit at once for formula queries.||Integer
|-
|{{Code|UnmapConnectionsOnExport}}||Controls whether connections are unmapped when a user downloads a file, default is True.||True/False
|-
|{{Code|UseAppPoolUserForSQLRepository}}||Whether to use the application pool user to connect to the [[SQL Repository]].||True/False
|-
|{{Code|UseAppPoolUserForSharepointDownload}}||Whether to use the application pool user to download from SharePoint.||True/False
|-
|{{Code|UsePathsForSQLRepository}}||New in [[Version 8.1]]. Set to True so that the "Get URL" of reports selected in the web user interface or the SharePoint web part are referred to using the path rather than a Guid when running the [[SQL Repository]].||True/False
|-
|{{Code|V5FormatFileLocation}}||Not currently used.|| 
|-
|{{Code|WebSiteTitle}}||(V10.0.125+) Override the default web site title.||String 
|-
|{{Code|WithMembersOnWhere}}||Formula engine option to control MDX generation, puts aggregates in the where clause. Mimics the same option from Excel.||True/False
|-
|{{Code|WritebackTimeout}}||Writeback timeout in milliseconds||Integer
|-
|{{Code|XL3LastCubeUpdateVolatile}}||Whether the [[XL3LastCubeUpdate]] formula should be volatile.||True/False
|-
|{{Code|X_UA_Compatible_IE}}||Sets the X-UA-Compatible meta tag, which forces compatibility rendering in Internet Explorer.||e.g. Edge
|-
{{TableFooter}}

===Standard IIS Options===

The following are standard IIS/.Net options which may be of interest
*<code>executionTimeout</code> Extends the request timeout in case of long running queries.
** Amend the httpRuntime element, e.g. <code><httpRuntime ... executionTimeout="120" /></code>

=== PDF Printing Configuration ===
''To configure the web edition to use the impersonated user instead of the application pool user, see [[XLCubed Web Edition Installation Guide/Version 7.1#PDF Printing Configuration|Version 7.1 instructions]].''

# Set {{Code|PdfUseAppPoolUserForXpsPrint}} and {{Code|PdfUseAppPoolUserForPdfConversion}} to true
# Ensure the application pool user has Modify access to the "Temp" folder, \inetpub\wwwroot\xlcubedweb\temp

=== Data Configuration Settings ===
Updating [[Data Configuration Settings]] may be done to affect connection behaviour by advanced users, although it is ''not'' recommended to do this without advice from XLCubed support.

[[Category:Web Edition]]
[[Category:Installation]]