This is the documentation for SuperSTAR 9.8

SuperSTAR 9.9 is now available.
View this page in the SuperSTAR 9.9 documentation or visit the SuperSTAR 9.9 documentation home.

Skip to end of metadata
Go to start of metadata
Location<tomcat_home>\webapps\webapi\WEB-INF\classes\configuration.properties

The following properties are available in this configuration file.

Each property has a default value (indicated in the tables below). If you do not give the property an explicit value then it will use its default.
PropertyDescriptionMore Information
cube.showNaNAsZero

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

true
(Default). Show cells that have no contributors as 0.
false
Display the notANumberString string configured in CubeCatalog.xml.
Configure Settings for Concealment and Cells with No Contributors - SuperWEB2
global.enableMapView

Whether to display the Map View tab:

true
(Default). Enable Map View.
false
Do not enable Map View.
 
global.enableGuidedTutorial

Whether to enable the guided tour:

true
(Default). Enable the tour. It will be displayed on first login and accessible from the top-right menu.
false
Users will not be shown the tour on first login and will not be able to access the tour from the menu.
Customise the Interactive Tour - SuperWEB2
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
(Default). Enable the new features popup.
false
Do not enable the new features popup.
 
catalogue.sortDatabases

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

true
(Default). Datasets will be sorted in alphabetical order.
false
Datasets will be shown in the order they were added to the catalogue in SuperADMIN
Change the Sort Order of Tables and Datasets - SuperWEB2
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
SuperWEB2 will look for a description in the <id>_desc column of the db_domain table in the metadata database and use this if it is present. It will fall back to using the static HTML pages if there is no description available.
false
(Default). SuperWEB2 will use the static HTML pages saved on the server.
Use the Metadata Server to Store the Data Catalogue Information Pages - SuperWEB2
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
Automatically expand the field.
false
(Default). Do not automatically expand the field.
Automatically Expand the Fields when Selecting All - SuperWEB2
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
(Default). Show the summation options.
false
Do not show the summation options.
 
schemaTree.selectAtLevelShowsValuesetName

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

true
(Default). Show the valueset label.
false
Show the label of the first item in each valueset. Changing this property to false means that SuperWEB2 more closely matches the behaviour of SuperCROSS (when selecting all the Subitems from a level of the hierarchy in the Define Recode window).
Configure Field Drop-down Labels - SuperWEB2
schemaTree.schemaFolderExpansionDepth

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

-2

All folders that contain a field in use in the table will be expanded.

This setting is recommended if your datasets have very large schemas and are typically accessed through saved tables.

-1

(Default). All folders will be expanded.

This setting is recommended for all cases except very large schemas (datasets that have a large number of fields or a large number of folders).

0
No folders will be expanded.
Integer value of 1 or above

Folders will be expanded to the specified level (for example, set this to 2 to expand the first two levels of folders).

This setting is recommended for large schemas with lots of folders.

 
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
(Default). Display annotations if available.
false
Do not display annotations.
Configure Display of Annotations - SuperWEB2
table.annotationPanelExpanded

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

true
(Default). Automatically expand the annotations.
false
Do not automatically expand annotations.
Configure Display of Annotations - SuperWEB2
table.defaultRSEView

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

0(Default). Show data values only.
1Show data values and RSE values next to each other.
2Show RSE values only.
Configure Relative Standard Error - SuperWEB2
table.autoRetrieveDataDefault

Whether to retrieve data in Table View automatically by default:

true
The Auto check box on the Retrieve Data button will be selected by default.
false
(Default). Do not automatically select the Auto check box.
 
table.enableConcatenation

Whether to allow users to concatenate fields in tables:

true
(Default). Concatenation is enabled.
false
Concatenation is disabled. Fields will be nested in the table axes instead.
Disable Concatenation - SuperWEB2
table.enablePrintButton

Whether to display the Print Table button in Table View:

true
(Default). Show the Print Table button.
false
Do not show the Print Table button.
 
table.enableAddToWafer

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

true
(Default). Allow users to add fields to wafers.
false
Do not allow users to add fields to wafers.
 
table.totalsInitialState

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

nototals
Hide all totals initially.
alltotals
Show all totals initially.
outermosttotals
(Default). Show totals for outermost fields only.
Disable Automatic Totals - SuperWEB2
table.enableDrillUpAndDrillDown

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

true
(Default). Allow users to drill up and down through hierarchical fields in tables.
false
Do not allow users to drill up and down through hierarchical fields in tables.
 
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
When a user opens a saved system table, SuperWEB2 will use the dataset language saved in the TXD, rather than the user's currently selected dataset language.
false
(Default). When a user opens a saved system table, SuperWEB2 will continue to use the currently selected dataset language.
 
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
SuperWEB2 will scan for descriptive metadata and display it at the bottom of Table View in an annotations table.
false
(Default). SuperWEB2 will not display the descriptions at the bottom of the table.
Display Metadata as Annotations Below the Table - SuperWEB2
table.enableDerivations

Whether to allow users to create derivations in tables:

true
(Default). Allow users to create derivations.
false
Do not allow users to create derivations.
Derivations - SuperWEB2
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).

Configure Settings for Large Tables - SuperWEB2
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).

Enable or Disable Record View - SuperWEB2
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
Use the Job Queue Manager.
false
(Default). Do not use the Job Queue Manager.
Configure - Job Queue Manager
download.allowDuplicateQueueManagerTableNames

Whether to allow duplicate table names in the job queue:

true
(Default). Allow duplicate table names.
false
Do not allow duplicate table names.
Configure - Job Queue Manager
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
(Default). Cells will be formatted according to the configured precision settings for the summation options.
false
No formatting will be applied. Turning off formatting will speed up the download of very large tables.
Set Precision for Summation Options - SuperWEB2
configServer.failOnUnknownProperties

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

true
(Default). If there are unknown properties in the configuration, this will cause an error and none of the SuperWEB2 configuration from SuperADMIN will be applied.
false
If there are unknown properties in the configuration, these will be ignored, but valid configuration properties will still be applied.
SuperADMIN cfg command
  • 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.

Customise the Online Help - SuperWEB2
metadata.scanForDescriptions

Whether to scan for metadata in the metadata database:

true

SuperWEB2 will scan the metadata database for descriptions, and automatically display a metadata link in the field list if a description is present for the current dataset language.

The first time you open a particular dataset in SuperWEB2 it may take some time to display the field list while SuperWEB2 scans the metadata database.

false
(Default). SuperWEB2 will not scan for metadata.
Display Metadata Icons in the Field List - SuperWEB2
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 dhm, 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
Clear Metadata Cache - Metadata Server
externalLink.dataConfidentialityURL

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

 
externalLink.metaInfoBaseURL
The base URL to link to for SuperWEB2 metadata.Metadata - SuperWEB2
externalLink.loginURL
The URL of the SuperWEB2 login page. 
externalLink.logoutURL
The URL of the SuperWEB2 logout page. 
login.requireTerms

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

true
Show a terms and conditions screen.
false
(Default). Do not show a terms and conditions screen.
Add a Terms and Conditions Screen - SuperWEB2
externalLink.STRWebSiteURL
A link used in the standard footer section at the bottom of SuperWEB2.Customise Header, Footer and Logo - SuperWEB2
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).

Branding PDF Downloads - SuperWEB2
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.

Branding PDF Downloads - SuperWEB2
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
Branding PDF Downloads - SuperWEB2
kmz.author 
The author name that will be embedded in KMZ files downloaded from Map View.Branding KMZ Downloads - SuperWEB2
kmz.atomLink
A web link that will be embedded in the extended parameters field in KMZ files downloaded from Map View.Branding KMZ Downloads - SuperWEB2
kmz.copyright
A copyright statement that will be embedded in KMZ files downloaded from Map View.Branding KMZ Downloads - SuperWEB2
kmz.logoOverlayPath
The full path to the location of a logo image on the server. This will be embedded in KMZ files downloaded from Map View.Branding KMZ Downloads - SuperWEB2
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).

Branding PDF Downloads - SuperWEB2
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.

Branding PDF Downloads - SuperWEB2
map.mapPdfDocumentPropertyAuthor
The value to set for the Author document property in PDF map downloads.Branding PDF Downloads - SuperWEB2
map.mapPdfDocumentPropertyKeywords
The Keywords to set in the document properties in PDF map downloads.Branding PDF Downloads - SuperWEB2
map.mapPdfDocumentPropertyApplication
The value to set for the Application document property in PDF map downloads.Branding PDF Downloads - SuperWEB2
map.mapPdfMaxCacheItemSize
The number of PDFs to cache on the server after generating them.Branding PDF Downloads - SuperWEB2
map.mapPdfRastersSupportHttps

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

true
Use HTTPs to connect to the base map server.
false
(Default). Do not use HTTPs.
Branding PDF Downloads - SuperWEB2
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]*?).*

Caching Map Data - SuperWEB2
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

Caching Map Data - SuperWEB2
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
(Default). Users can access the Preferences options in SuperWEB2 (located on the main menu).
false
Users can not access the Preferences options in SuperWEB2.
Change the Sort Order of Tables and Datasets - SuperWEB2
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
Use the custom number formatting and precision defined in numberFormat.customUDFValueFormat.
false
(Default). Use the default number formatting and precision.
Configure Quantiles and Ranges - SuperWEB2
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.
Configure Quantiles and Ranges - SuperWEB2
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. 

Configure Performance Settings - Open Data API
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.

Configure Performance Settings - Open Data API
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.

Configure Performance Settings - Open Data API
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.

Configure Performance Settings - Open Data API
  • No labels