Change History

• Unicode

• Record Count - Data Control
• Perturbation - Data Control

• Creating Data Control Plugins

• Installation Requirements, Compatibility and Supported Platforms

This release introduces the configuration server. This is a JSON configuration system that stores a number of internal settings. Most of these settings are used by SuperWEB2, and were previously configured in XML and .properties files within SuperWEB2 itself. These settings can now be set and checked using the cfg command in the SuperADMIN console.

If you are upgrading from an earlier release you will need to check the list of settings that have moved to the configuration server and manually reapply any that are required for your deployment.

The configuration server communicates on port 9000, so you will need to ensure your network firewalls are properly configured to allow this communication: this port must be accessible by SuperWEB2 and any machines running the SuperADMIN console.

We recommend you do not make port 9000 publicly accessible, even if your SuperWEB2 server is publicly accessible.

• The cfg command
• Port usage
• List of SuperWEB2 settings that have moved to Configuration Server

• Batch Insert Mode - SuperCHANNEL

• ColourMatrix - SuperCROSS

• Update a Dataset

• Bulk Selection - SuperWEB2

• Change the Sort Order of Tables and Datasets - SuperWEB2

A new SuperWEB2 configuration file, configuration.properties, has been added, and many settings have moved to this file. When upgrading from an earlier release you will need to manually reapply any required settings by editing the new configuration.properties file.

• List of SuperWEB2 settings that have moved to configuration.properties

• Configure a Default Table for your Datasets - SuperWEB2

• Getting Started - SuperWEB2

• Graph View - SuperWEB2

It is now possible to navigate up and down the levels of a hierarchical field from with the table.

In addition, the default settings have been changed so that it is now possible to mix items from different levels of a hierarchy within a table (for example adding both Victoria and Melbourne from an Area hierarchy to the table at the same time). In previous releases, this behaviour was disabled by default. You can revert to the previous behaviour by editing the rules in the RulesEngine.xml configuration file.

• Working With Hierarchies - SuperWEB2
• RulesEngine.xml

• Mandatory Fields - SuperWEB2

• How to configuring mapping

• Multilingual and Localisation Support - SuperWEB2

• Configure Quantiles and Ranges - SuperWEB2

• Zero Suppression - SuperWEB2

• Target Attributes - SuperCHANNEL

• Add Defined Fields - SuperWEB2

• The record type hierarchy graph menu option

The following setting has been added to the configuration.properties file:

• graphView.maxCells

• configuration.properties

• Configuration Options for Graph View

• Setup a Metadata Database - SuperWEB2

The following settings have been added to the configuration.properties file:

• catalogue.databaseFolderExpansionDepth
• table.totalsInitialState

• configuration.properties

The following setting has been added to the configuration.properties file:

• table.enableDrillUpAndDrillDown

• configuration.properties

The following settings have been added to the configuration.properties file:

• download.formatNumbers
• login.requireTerms
• map.mapCacheLocation

• configuration.properties

• Caching Map Data - SuperWEB2

• Set Precision for Summation Options - SuperWEB2

• Add a Warning Message to Printed Tables - SuperWEB2

• Add a Terms and Conditions Screen - SuperWEB2

A new property has been added to the mapping configuration: localFeatureUrlHostName.

This property sets the host name of the Tomcat instance that mapping will use when it needs to make a request to another of the REST endpoints.

• Mapping Property Reference - SuperWEB2

• Configure Field Level Security

This release adds the ability to load TXDs into the User Data Repository through SuperADMIN. This means you can save a TXD from SuperCROSS and then load it into the SuperADMIN catalogue so that SuperWEB2 users can access that table (in previous releases this required you to save the TXD file to a location within SuperWEB2 itself).

Once you have loaded a TXD into the catalogue, you can use the cat command in SuperADMIN to manage that table (for example you can move it to a folder, rename it, or delete it).

• Configure Folders and Shared Tables - SuperWEB2

• The server command

• How It Works - Perturbation

A new option has been added to the config.txt configuration file allowing you to set the encoding to use when channelling with the TDD driver.

You may need to change this setting if you are channelling data that contains characters that are not supported by the current system codepage.

• config.txt

Additional logging is now available when SuperCROSS is running in server mode. SuperCROSS will now log the following events to the Super.logs.txt file (located in C:\ProgramData\STR\SuperCROSS\logs):

• Errors loading a TXD:
  • Invalid dataset ID.
  • Missing dataset ID.
  • Invalid column name.
  • Invalid value sets.
• Saving output:
  • Invalid Output Module defined in SuperModule.ini.
  • Invalid Function in the Output Module.
  • Save failed.

• Set Up Batch Processing - SuperCROSS

• SuperModule.ini

• Performance Considerations - SuperSERVER

Some changes have been made to audit logging:

• SuperSERVER now logs additional events: tabulation.request, tabulation,started and tabulation.retrieved.
• All SuperSERVER audit events now log duration in milliseconds (this includes tabulation.complete, which previously logged duration in seconds.
• SuperSERVER audit logging is now enabled by default.

Some changes have been made to SuperSERVER and Metadata Server logging:

• The logs are now configured to roll to a new file every day, by default.
• The log settings are now configured in an XML file, rather than a .properties file.

• Logged Events - Audit Logging
• Configure - Audit Logging
• Logging - SuperSERVER
• Logging - Metadata Server

The following settings have been added to the configuration.properties file:

• catalogue.infoPanel.displayDatabaseMetadataDescription
• schemaTree.selectAtLevelShowsValuesetName
• table.useSavedTableLanguage
• table.displayMetadataAsAnnotations
• metadata.scanForDescriptions
• udr.maxQueryParams

• configuration.properties

• Configure a Default Table for your Datasets - SuperWEB2

The information pages that are displayed on the dataset catalogue screen in SuperWEB2 now support more options:

• It is now possible to create static HTML pages for different languages, by including the language code in the filename of the HTML page.
• It is now possible to configure SuperWEB2 to retrieve the information page from the metadata server, rather than using static HTML pages.
• It is now possible to display metadata links (retrieved from the metadata database) on the dataset information pages.

• Configure the Text on the Data Catalogue Page - SuperWEB2
• Use the Metadata Server to Store the Data Catalogue Information Pages - SuperWEB2
• Display Link Metadata on the Data Catalogue Page - SuperWEB2

Some settings in the basemaps.properties file have changed. This file that is used to configure the base map images (the map imagery itself, such as the street map images or the satellite view).

• The urllist property is now two related properties: url and subdomains
• An additional option, BLANK, is now available for the type property.
• The order of the map types has changed, so that satellite imagery is now the default type of map (previously the street map was the default).
• The default base map image for street maps now uses imagery from ArcGIS online (previously the default street map imagery was provided by Map Data Services).

• Configure Base Map Properties - SuperWEB2
• Troubleshooting Mapping - SuperWEB2

• Map View - SuperWEB2

A number of new features have been added to metadata:

• There is now a configuration setting that instructs SuperWEB2 to automatically scan for metadata descriptions in the metadata database, and display metadata links in the field list against fields that have descriptions in the metadata database.
• There is now an option to automatically retrieve descriptions from the metadata database for any fields in the current table, and display them as annotations below the table.
• A new REST endpoint has been introduced to enable administrator users to flush SuperWEB2's local metadata cache.

• Display Metadata Icons in the Field List - SuperWEB2
• Display Metadata as Annotations Below the Table - SuperWEB2
• Clear Metadata Cache - Metadata Server

In some cases, precision settings in TXDs now override the SuperWEB2 precision settings.

In previous releases, the summation options precision setting (defined using the displayoptions command in SuperADMIN), and SuperWEB2's global dataprecision setting took precedence. Now, custom decimal place settings in TXDs saved from SuperCROSS that are loaded into SuperWEB2 will take precedence.

• Set Precision for Summation Options - SuperWEB2

• Configure Field Drop-down Labels - SuperWEB2

A new configuration option has been added that allows you to prevent users from sorting a field alphabetically in SuperWEB2.

By default, when a field has been added to the table rows, SuperWEB2 allows users to sort it into ascending and descending alphabetical order. In some cases, this will not make sense (for example, a date field where it does not make sense to sort the months alphabetically).

• Prevent Fields from Sorting Alphabetically - SuperWEB2

• Perturbation - Data Control

• Open Data API

The following settings have been added to the configuration.properties file:

• externalLink.helpCatalogueURL
• externalLink.helpGraphViewURL
• externalLink.helpMyTablesURL
• map.mapArcGISEndpointPattern
• openDataApi.schema.pageSize
• openDataApi.schema.numberOfRateLimitPerPeriod
• openDataApi.table.maximumResponseCellLimit
• openDataApi.table.maximumRequestItemLimit

• configuration.properties

• Setup Static Metadata Pages - SuperWEB2

A number of usability changes have been made to the SuperWEB2 user interface.

Some on screen elements have moved or been renamed. For example:

• The Catalogue option on the SuperWEB2 menu bar has moved from the top-right of the screen to the top left, and has been renamed to Datasets).
• The My Tables tab has been moved to the drop-down menu in the top-right of the screen.
• The Custom Data tab has been moved to a button at the bottom of the field list in Table View.

If you have added your own UI languages, then some translation changes may be required.

• SuperWEB2

Additional configuration options have been added to the confidentiality rule data control module:

• You can now configure the confidentiality rule so that it only applies when specific fields are in the table.
• You can now set different thresholds and frequency rules for totals and non totals.

• Advanced Confidentiality Rule Options

Grand totals are now calculated using recode totals by default. This means that they now correctly handle non additive tables without double counting.

Grand totals can also now be added to tables that have multiple summation options and return correct results for the total Relative Standard Error (RSE) as well as the RSE of percentages based on the grand total.

If you wish to keep the behaviour from previous releases, set UseRecodeTotalsForGrandTotal to 0 in the super.ini configuration file.

If you load a saved table, it will use the behaviour it was created with, until the grand total is switched off.

As a result of this change, when using the new functionality if you select any of the total options from the Calculations menu your table results will be reset and you will need to run the cross tabulation again.

If you have weighted databases and you are using the SuperSERVER weighting option, then you must use the new grand total behaviour.

• super.ini
• Row and Column Totals and Percentages - SuperCROSS

• Create a Quantile Field - SuperCROSS

It is now possible to configure the precision used when displaying quantile range boundaries and RSE values in the labels of quantile user defined fields.

The precision of these values is controlled by two new settings that you can add to the [Preferences] section of the cross.ini configuration file: Quantile Label Value Precision and Quantile Label Rse Precision.

• cross.ini

When using weighted databases:

• Relative Standard Error for user defined fields is now calculated correctly and added to tables in the same way as standard measures.
• Relative Standard Error values are now recalculated correctly if perturbation is turned off in SuperCROSS.

The statistics.xml file defines the statistical formulas used by SuperCROSS for its summation options.

• Prior to version 9.7 the formulas in statistics.xml applied to unweighted summations only.
• From 9.7 onwards, if you are using SuperSERVER weightings then statistics.xml is now used for both weighted and unweighted functions.
• From 9.7 onwards, if you are using SuperCROSS client weightings then the unweighted functions will be loaded from statistics.xml and the weighted functions will be loaded from the formulas.xml file (this is consistent with the behaviour in previous releases).

As a result of changes to the statistics.xml file that is provided with SuperCROSS, the default set of functions available for some summation options has changed.

In previous releases, the Define Recode window displayed a number of functions for counts, such as Mean and Standard Deviation, even though these are not meaningful calculations for a record count (for example, the mean of a record count will always be 1). Sum is now the only function available by default for counts. If you wish to revert to the previous behaviour, you can modify the statistics.xml file.

• statistics.xml

It is now possible to display both weighted and unweighted values in the same table when using SuperSERVER weightings in SuperCROSS.

In previous versions, changing between a weighted and unweighted option in the Weight By drop-down list in the Define Recode window would change all of the functions in the Recode Values list to be either weighted or unweighted. Now, you can add a combination of weighted and unweighted functions to the Recode Values list.

• Weighted Databases - SuperCROSS
• Understanding SuperSERVER, SuperCROSS and SuperWEB2 Weighting Differences

Quantile perturbation requires three configuration files. In previous releases these had to be located in the same directory as the SXV4 file.

New properties have been added to the data control modules so that it is now possible to configure the location of these files.

• Quantiles and Ranges - Perturbation

Prior to version 9.7, it was necessary to configure a data control plugin to calculate RSE values. From 9.7 onwards this now runs automatically for all SuperSERVER weighted databases, and will use the jackknife formula for calculating the RSE. You can still configure the plugin if you wish to change some of its other settings, such as the formula, thresholds and unreliable table message, although if you just want to change the formula used then you can do this by editing a setting in the weightings file (if both are configured then the plugin settings take precedence).

As a result of this change, RSE values are now available for SuperSERVER weighted databases in SuperCROSS when confidentiality has been turned off using the padlock button.

• Relative Standard Error - Data Control
• sa_weightings.xml - SuperSERVER

New configuration options have been added to enable consistent weighting configuration across SuperCROSS and SuperWEB2.

• Understanding SuperSERVER, SuperCROSS and SuperWEB2 Weighting Differences

Since version 9.0 SuperCROSS has been using a particular formatting function from a third-party library when generating Excel files. This function adjusts the row height in the downloaded Excel file to fit the text in the row. This function has been found to cause performance issues when downloading very large tables.

SuperCROSS now runs the function only once per row when downloading very large tables, so in some cases it may be necessary to manually adjust the row height in the downloaded Excel file in order to see the full heading text.

A new setting has been added to the super.ini configuration file: AutoFitCellLimit=90

This setting controls the threshold for the new behaviour. Its value is the table cell count in millions.

For example, when this is set to 90:

• Any table under 90 million cells will use the auto formatting option on every header cell.
• Any table above this size will not have any custom row heights applied. You may need to manually adjust the row heights in the downloaded Excel file.

• super.ini

SuperWEB2 now allows users to create derivations within tables.

Derivations are automatically enabled by default, but you can disable them globally by changing the table.enableDerivations setting in the configuration.properties file.

• Derivations - SuperWEB2
• configuration.properties

• RulesEngine.xml

It is now possible to control the formatting of annotations in Excel downloads. This is particularly useful if you have long annotations as you can now control how the text wraps beneath the table.

In addition, the default Excel download templates have been updated to match the current default SuperWEB2 branding.

• Branding Excel and CSV Templates - SuperWEB2

A new setting (schemaTree.schemaFolderExpansionDepth) has been added that allows you to choose how many levels of folders to expand in the list of fields when opening a dataset.

In previous releases, the list of fields was always fully collapsed when opening the dataset (so only the names of the top level folders would be visible initially). Now you can choose how many levels to expand.

By default, all folders will now be expanded when you open a dataset.

• configuration.properties

The configuration setting for specifying the PDF template for downloads from Graph View has changed. Previously this used a single setting (externalLink.pdfTemplateURL) that specified the full path to the template PDF file.

This setting has been replaced by two individual settings in the configuration.properties file: graph.graphPdfTemplateLocation and graph.graphPdfTemplateName.

• Branding PDF Downloads - SuperWEB2
• configuration.properties

• sw2-chart-config-options.js

The location of the HTML info pages (which are displayed on the right of the database catalogue screen) has changed.

Previously these pages were located in <tomcat_home>\webapps\webapi\WEB-INF\resources\info\

Now, they are located in <tomcat_home>\webapps\webapi\info\

• Configure the Text on the Data Catalogue Page - SuperWEB2

• Setup a Metadata Database - SuperWEB2

• Customise the Interactive Tour - SuperWEB2

A number of usability changes have been made to the SuperWEB2 user interface:

• Some on screen elements have moved or been renamed.
• New icons have been added to help users distinguish between datasets, tables, folders and fields.
• By default, the logo in the top-left of SuperWEB2 is now displayed within the navigation bar, rather than above it. This change is fully backwards compatible, so you can choose to continue to display the logo above the navigation bar if you prefer. Your existing branding customisations can continue to be used with this version of SuperWEB2.

• User Guide - SuperWEB2
• Understanding the Field List - SuperWEB2
• Customise Header, Footer and Logo - SuperWEB2