Changes to Configuration Options in this Release

From version 9.0 onwards, a number of changes have been made to how SuperWEB2 is configured:

• Some options that were previously set in <tomcat_home>\webapps\webapi\WEB-INF\faces-config.xml and <tomcat_home>\webapps\webapi\WEB-INF\web.xml are now defined in a new configuration file, <tomcat_home>\webapps\webapi\WEB-INF\classes\configuration.properties.

• Some options that were previously set in the configuration files are now set in SuperADMIN.

The following is a summary of some of the changes. If you are upgrading from an older version then you will not be able to use your existing configuration files. You will need to follow the new instructions to recreate any previous configuration adjustments.

Annotations

Whether configured annotations display and whether to automatically expand the annotations panel.

Blacklisted Mapping Fields

It is possible to prevent users from accessing Map View if specific fields exist in the table. This feature was previously configured in <tomcat_home>\webapps\webapi\WEB-INF\classes\dumpcodes.properties but is now configured in SuperADMIN.

Branding on User Interface

The options for customising the branding on the SuperWEB2 user interface, including the header, the footer and the logos displayed within them, are now configured in layout.xml. Text strings within both the header and footer text are now configured in messages.properties, rather than the layout configuration file.

Branding PDF, PNG and KMZ Downloads

SuperWEB2 is now supplied with separate PDF templates for graphs and maps by default (SWDownloadGraph.pdf and SWDownloadMap.pdf). You can continue to use a single template for both if you prefer, but you will need to change the configuration settings to tell SuperWEB2 where to find your template.

Both templates now support an additional form field, Database Label, which will contain the name of the database in the downloaded PDF.

In addition, the configuration properties for branding downloads from Graph View and Map View have moved.

Cells with No Contributors

Whether to show 0 or a custom string when a cell has no contributing values.

Disable Automatic Totals

Whether to automatically show totals when adding fields to a table or loading a saved table.

This setting was moved in version 9.2.1

Field Drop-Down Labels

The field labels in the Select all at level drop-down list were previously configured in <tomcat_home>\webapps\webapi\WEB-INF\classes\schemaValueSetNodeLabels.properties but these are now defined in SuperADMIN.

Field Exclusion Rules

Field exclusion rules allow you to limit the number of fields from a defined group that can be added to the table at any one time. This feature was previously configured in <tomcat_home>\webapps\webapi\WEB-INF\classes\fieldExclusionRule.properties but is now configured in SuperADMIN.

Footer Images and Links

The options for customising images, image links and text links within the SuperWEB2 footer is now configured in layout.xml. Footer text is now configured in messages.properties (see Footer Text.)

Footer Text

To support multiple languages in the SuperWEB2 user interface, the text in the footer is now configured in messages.properties, rather than in a layout configuration file.

Guest Access

The username and password for guest access are now configured in the configuration.properties file, rather than web.xml.

Job Queue Manager

The configuration options that control whether to use Job Queue Manager, and whether to allow duplicate table names in the job queue have been moved to configuration.properties.

Job Queue Manager

An additional step is required. A resource reference in web.xml is now commented out by default and needs to be uncommented when you set up Job Queue Manager.

Large Table Mode

The number of cells to show in the table preview when in large table mode.

Large Table Mode

The thresholds for entering large table mode.

Large Table Mode

There has been a change to the rule you need to configure if you want to change the maximum number of cells in a table. The applicableOperation attribute is now applicableOperations, and includes two additional criteria for where the rule applies (drill up and drill down). This ensures that the rule continues to apply if the user navigates up and down through a hierarchical field.

Mandatory Fields

Configuration of mandatory fields in tables. The set of mandatory fields was previously defined in <tomcat_home>\webapps\webapi\WEB-INF\classes\mandatoryfields.json but this is now done through SuperADMIN.

Map View

Whether to enable Map View.

Mapping

The configuration for the thematic map layers and the integration with your external mapping service has moved to SuperADMIN.

Maximum Tree Node Selection

The setting that controls the maximum number of levels of hierarchy to show in the Select all at level drop-down list has moved.

Previously this was configured using the maxTreeNodeSelectionLevel property in faces-config.xml. It is now set using the schemaTree.hierarchicalFieldDepthLimit property in configuration.properties.

Metadata

The base URL for SuperWEB2 metadata.

Online Help Links

The parameters that store the URLs for the links to the online help have moved from faces-config.xml to configuration.properties.

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

Record View

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

Enable or disable Record View:

SDMX Downloads

The survey date and scaling description for use in SDMX downloads have changed.

In versions 9.0 and 9.1 these are configured in SuperADMIN.

From version 9.2 onwards these are configured in database_labels.properties.

Select all at level

Whether to automatically expand a field when using the Select all at level option.

Session Poll Time

The polling interval used to keep the connection to the Table View and Map View REST endpoints active.

Summation Options

Whether to show summation options.

Suppress Sum

Whether to suppress the ability to add "Sum" to a table.

TXD File Encoding

The default encoding for TXD files loaded into SuperWEB2.

Relative Standard Error

The default table view when Relative Standard Error is enabled.