configuration.properties

cube.showNaNAsZero

Whether to display 0 or a custom string if there are cells with no records contributing to the result:

true

false

global.enableMapView

Whether to display the Map View tab:

true

false

global.enableGuidedTutorial

Whether to enable the guided tour:

true

false

global.enableNewFeatureTutorial

Whether to enable the new features popup. This can be used to display information about new data or new features that have been added to SuperWEB2.

true

false

catalogue.sortDatabases

Whether to sort the list of Datasets shown in the catalogue screen:

true

false

catalogue.databaseFolderExpansionDepth

How many levels of folders should initially be expanded when a user opens the Catalogue page in SuperWEB2:

-1	(Default). All folders expanded. Recommended for small catalogues or catalogues with no folders. For example:
0	The tree will initially be fully collapsed. Not recommended. For example:
1 or more	The tree will initially be expanded to the specified number of levels. For example: 1 level: 2 levels:

catalogue.infoPanel.displayDatabaseMetadataDescription

Whether to read the text for the catalogue page from the metadata database. This setting only applies when metadata server has been set up and is only used for datasets that have been set to multilingual in SuperADMIN.

true

false

schemaTree.expandOnSelection

Whether to automatically expand a field in the tree when a user selects the Select all at level drop-down list. This property takes the following values:

true

false

schemaTree.hierarchicalFieldDepthLimit

The maximum number of levels of hierarchy to show in the Select all at level drop-down list.

Set this to a negative value if you do not want to limit the levels of hierarchy. The default setting is -1.

schemaTree.showSummationOptions

Whether to show the summation options in the customise table panel in Table View.

true

false

schemaTree.selectAtLevelShowsValuesetName

Which labels to show in the Select all at level drop-down:

true

false

schemaTree.schemaFolderExpansionDepth

How many levels of folders (field groups) to expand automatically when opening a dataset:

-2

-1

0

table.maximumFootnoteLength

When you have recodes (custom groups) in your table, a footnote automatically appears at the bottom of the table indicating which individual items make up the recode. You can use this setting to control whether this recode footnote is truncated.

This setting specifies the maximum length of recode footnotes in a table prior to truncation. The default is 120.

table.annotations

Whether to display annotations beneath the table. This property takes the following values:

true

false

table.annotationPanelExpanded

Whether to automatically expand annotations. This property takes the following values:

true

false

table.defaultRSEView

The default display mode for tables with Relative Standard Error values. This property takes the following values:

table.autoRetrieveDataDefault

Whether to retrieve data in Table View automatically by default:

true

false

table.enableConcatenation

Whether to allow users to concatenate fields in tables:

true

false

table.enablePrintButton

Whether to display the Print Table button in Table View:

true

false

table.enableAddToWafer

Whether to allow users to add fields to wafers in Table View:

true

false

table.totalsInitialState

Whether to show totals by default when adding fields to the table or loading a saved table.

nototals

alltotals

outermosttotals

table.enableDrillUpAndDrillDown

Whether to allow users to drill up and down (navigate) through hierarchical fields in tables.

true

false

table.useSavedTableLanguage

Whether to use the saved table language when opening a saved system table (a TXD saved from SuperCROSS and stored in the txd directory on the SuperWEB2 server).

true

false

table.displayMetadataAsAnnotations

Whether to display metadata as annotations at the bottom of the table. This setting only applies to multilingual datasets that have been configured to use metadata server for descriptive metadata.

true

false

table.enableDerivations

Whether to allow users to create derivations in tables:

true

false

table.largeTableMode.previewDataSize

The number of row and column cells to show in the table preview when SuperWEB2 enter large table mode.

You can set this property to any integer value. If you do not give the property a value, it will use the default (3).

recordview.maxCells

The maximum number of cells of data that a user can download at a time from Record View.

You can set this property to any integer value. If you do not give the property a value, it will use the default (100,000).

graphView.maxCells

The maximum size of a table that can be visualised in Graph View. By default, there is a limit of 1,000 cells; if users create tables with more than this number of cells then they will not be able to access Graph View.

If necessary, you can increase the cell limit to a higher amount.

The limit only applies to the number of cells in the currently selected wafer, not the number of cells in the table as a whole.

download.enableQueueManager

Whether to enable the Job Queue Manager. This property takes the following values:

true

false

download.allowDuplicateQueueManagerTableNames

Whether to allow duplicate table names in the job queue:

true

false

download.formatNumbers

Whether to format cell data in downloads. This setting is intended to be used if your users are working with extremely large tables (millions of cells), as it can provide a performance boost that dramatically reduces the time taken to download a table.

true

false

configServer.failOnUnknownProperties

What to do if any invalid or unknown SuperWEB2 configuration properties have been set using the SuperADMIN cfg command.

true

false

• externalLink.helpUserGuideURL

• externalLink.helpIconURL

• externalLink.helpCatalogueURL

• externalLink.helpCustomiseTableURL

• externalLink.helpGraphViewURL

• externalLink.helpMapViewURL

• externalLink.helpMyCustomDataURL

• externalLink.helpMyTablesURL

These parameters define the URLs for the online help.

You should not need to change these settings unless you want to replace the supplied user guide with your own customised version.

metadata.scanForDescriptions

Whether to scan for metadata in the metadata database:

true

false

metadata.cacheSpec

The cache settings for metadata in SuperWEB2. By default, SuperWEB2 is configured to cache data from the Metadata Server for 1 day. You can change this by editing this setting.

There are a number of options you can set (see http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/cache/CacheBuilderSpec.html for full details of the syntax), but the main change you are likely to want to make is to change how often SuperWEB2 automatically refreshes its cache. To do this, use the following setting:

metadata.cacheSpec=expireAfterAccess=<duration>

Replace <duration> with the time between cache refreshes. Use the values d, h, m, or s to denote days, hours, months, or seconds.

For example, the following setting configures SuperWEB2 to refresh its cache every 10 minutes:

metadata.cacheSpec=expireAfterAccess=10m

externalLink.dataConfidentialityURL

The URL to link to from the data confidentiality footnote in Table View.

externalLink.metaInfoBaseURL

externalLink.loginURL

externalLink.logoutURL

login.requireTerms

Whether to show a terms and conditions screen during login. The user must accept the terms in order to log in.

true

false

externalLink.STRWebSiteURL

graph.graphPdfTemplateLocation

The full path to the directory on the file system where the PDF template for graph downloads is located.

You must escape any backslashes in the file path with an additional slash. For example:

graph.graphPdfTemplateLocation=C:\\templates\\

If you leave this blank the PDF template will be loaded from the context directory (by default this is <tomcat_home>\webapps\webapi).

graph.graphPdfTemplateName

The name of the PDF template file to use for graph downloads. Do not include the .pdf extension. For example:

graph.graphPdfTemplateName=SWDownloadGraphTemplate

If you leave this blank SuperWEB2 will expect the template file to be called SWDownloadGraph.pdf.

externalLink.pdfTemplateFonts

A list of fonts to embed in the downloaded PDF, separated by commas.

You may need to configure font embedding if your PDF template uses a font that is not one of the default Adobe fonts. If you use a non standard font, then you can embed this in the PDF to ensure that it will display correctly regardless of whether users have that font installed on their computer.

Specify the full path to the font file. If you want to embed multiple fonts, use commas to separate them. For example:

externalLink.pdfTemplateFonts=C:/Windows/Fonts/ARIALUNI.TTF,C:/Windows/Fonts/mingliu.ttc

kmz.author 

kmz.atomLink

kmz.copyright

kmz.logoOverlayPath

map.mapPdfTemplateLocation

The full path to the directory on the file system where the PDF template for map downloads is located.

You must escape any backslashes in the file path with an additional slash. For example:

map.mapPdfTemplateLocation=C:\\templates\\

If you leave this blank the PDF template will be loaded from the context directory (by default this is <tomcat_home>\webapps\webapi).

map.mapPdfTemplateName

The name of the PDF template file to use for map downloads. Do not include the .pdf extension. For example:

map.mapPdfTemplateName=SWDownloadMapTemplate

If you leave this blank SuperWEB2 will expect the template file to be called SWDownloadMap.pdf.

map.mapPdfDocumentPropertyAuthor

map.mapPdfDocumentPropertyKeywords

map.mapPdfDocumentPropertyApplication

map.mapPdfMaxCacheItemSize

map.mapPdfRastersSupportHttps

Whether the PDF service supports HTTPs calls to the base map server:

true

false

map.mapArcGISEndpointPattern

The pattern to use when setting the ArcGIS endpoint URI. This is used to extract the service name and layer index for caching.

The default value is .*?\/services\/(.*?)\/.*?\/([0-9]*?).*

map.mapCacheLocation

The location of the directory to store cache information for mapping. Make sure that the directory exists and that the user running Tomcat has permission to write to it.

You must escape any backslashes in the file path with an additional slash. For example:

map.mapCacheLocation=c:\\str\\sw2MapCache

Forward slashes do not need to be escaped. For example:

map.mapCacheLocation=/STR/sw2MapCache

If no directory is specified, then SuperWEB2 will use the default location: <tomcat_home>\work\Catalina\localhost\webapi

preferences.usersCanEditPreferences

Whether users can access the user preferences options in SuperWEB2. Currently the only user preference option is the ability to change the sort order of saved tables in the Saved Tables tab.

true

false

csv.outputEncodingPreference

The output encoding to use for CSV files downloaded from SuperWEB2. By default, CSV files will be downloaded in UTF-8 encoding. You may need to change this to use a specific Windows codepage in some cases.

For example, some versions of Microsoft Excel (including Excel 2003) have a bug that causes them not to support UTF-8 encoding when CSV files are opened either by double clicking the file or selecting Open from the download option in a web browser.

If your users are experiencing problems opening downloaded CSV files in Excel, you may need to set SuperWEB2 to use a specific Windows codepage.

See this page for a list of available codepages. When configuring SuperWEB2, you need to use the value from the Name column.

For example, to use the Windows CP-1252 codepage, you would configure SuperWEB2 using one of the following values:

csv.outputEncodingPreference=CP1252

Or:

csv.outputEncodingPreference=Windows-1252

numberFormat.enableCustomUDFValueFormat

Whether to use custom number formatting for values in range and quantile labels.

true

false

numberFormat.customUDFValueFormat

The number formatting to use for values in range and quantile labels. See http://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html for details of how to specify the number formatting. Note that:

• This format will only be applied if numberFormat.enableCustomUDFValueFormat is set to true.
• The formatting applies to Table View only; it is not applied to table downloads.
• The number formatting and precision setting only apply to the {Min} and {Max} values. They do not apply to any {Rse} value in the label.

udr.maxQueryParams

The size of chunks to use when connecting to the user data repository.

Some relational databases have a limit on the number of parameters that can be used in the WHERE clause of a SELECT query. Queries that are likely to overrun this limit are broken up into chunks and run in parts to avoid errors.

The default setting for this value is 1000, which should work for all supported databases.

openDataApi.schema.pageSize

If a query to the Open Data API returns a large number of results then it will be paginated. By default, this occurs when there are more than 100 objects in the result set. You can use this setting to increase of decrease the limit for pagination.

The Open Data API has its own copy of the configuration.properties file. To change this setting, you must edit that version of the file, not the one in the SuperWEB2 directory. 

openDataApi.schema.numberOfRateLimitPerPeriod

The number of requests that any given API key can make within any given one hour period.

The Open Data API has its own copy of the configuration.properties file. To change this setting, you must edit that version of the file, not the one in the SuperWEB2 directory.

openDataApi.table.maximumResponseCellLimit

The maximum number of cells that can be returned to a client via the /table API endpoint. By default this is set to 1,000,000. It is designed to prevent excessively large tables from being sent to the client.

The Open Data API has its own copy of the configuration.properties file. To change this setting, you must edit that version of the file, not the one in the SuperWEB2 directory.

openDataApi.table.maximumRequestItemLimit

The maximum number of field items that a user can query via the /table API endpoint. By default this is set to 1,000,000. It is designed to prevent clients from overwhelming the server with large requests.

The Open Data API has its own copy of the configuration.properties file. To change this setting, you must edit that version of the file, not the one in the SuperWEB2 directory.