Suppress Ability to Add Sum to a Table
In circumstances where perturbation is applied to a table, it may be possible to impute unperturbed values if an unperturbed measure such as mean is available in conjunction with the sum measure.
To prevent this from happening, there is a configuration setting that administrators can modify to remove the sum measure from the table selection tree.
Default Behaviour (Sum Options Available): | SuperWEB2 Modified to Suppress Sum: |
To make this change, you need to edit the file <tomcat_home>\webapps\webapi\WEB-INF\configuration.properties.
Make a backup copy of this file before making any changes.
To suppress the ability to add "Sum" to a table:
- Open configuration.properties in a text editor.
Locate the following section:
configuration.properties
CODEschemaTree.suppressSum=
Set
schemaTree.suppressSum=true
- Save configuration.properties.
- Restart Tomcat.
This setting applies to all datasets available on the SuperSERVER instance. It is not possible to configure the setting on a per-dataset basis.
schemaTree.suppressSum=true
is not applied for sum of main weights in a weighted database. Sum of main weight will not be suppressed by suppress SUM.
Open Data API
It is also possible to apply this configuration to the Open Data API.
The API has its own version of the configuration.properties file, located at <tomcat_home>\webapps\webapi#rest#v1\WEB-INF\classes\configuration.properties, so you will also need to make the change to that configuration file if you wish to apply the restriction to API queries.
If you enable the suppress sum feature, then any API queries that request an explicit sum in the request will result in a 422 error.