Configure Relative Standard Error - SuperWEB2

The Relative Standard Error (RSE) function lets users view the relative standard error figures for weighted databases.

This information is only available if:

The database is weighted.
The SuperSERVER has been configured to support the RSE feature. Learn how to configure the Data Control plugin for Relative Standard Error .

Configure the Default Table View for Relative Standard Error

When RSE is enabled, you can configure what gets displayed in the default table view. You can choose to show the data values, the RSE values or both.

Open <tomcat_home>\webapps\webapi\WEB-INF\faces-config.xml in a text editor.

Make a backup copy of this file before making any changes.

Locate the following section:

XML

<managed-property>
  <description>selected RSE view, this parameter determines the default view if table contains RSE, the options are: 0:DATA_ONLY,1:COMBINED,2:RSE_ONLY</description>
  <property-name>selectedRSEView</property-name>
  <value>0</value>
</managed-property>

Change the value to either 0, 1, or 2:

Value Show
0 Data values only (the default).
1 Data values and RSE values next to each other.
2 RSE values only.
Save your changes to the file.
Restart Tomcat or the SuperWEB2 service.

Configure the Calculation Formula

When the percentages are calculated, the RSE values for the percents for the cells are also calculated based on one of the following two formula options:

Option A (default)	RSE%(x/y) = sqrt( RSE(x)^2 - RSE(y)^2 )
Option B	SQRT((1-2r)(Ry^2))+(Rx^2)
Option B (alternative)	SQRT ((Ry^2))+(Rx^2)

Where:

y is the cell value
x is the row / column total
Rx is the RSE of x
Ry is the RSE of y
r = y/x

Notes

The alternative option B formula is only used if SuperWEB2 is configured to use option B but the calculation results in a negative number under the square root.

The RSE algorithm options are configured in <tomcat_home>\webapps\webapi\WEB-INF\data\.repository\CubeCatalog.xml.

You can change the following parameters:

Parameter	Description
covarianceString	If Option B is enabled, there is a chance it can output NaN (not a number). If it does so, an annotation will be added to that cell, advising the user that the cell has an unexpected or unexplained cell covariance. This parameter sets the annotation symbol that will be displayed in the cell.
covarianceDescription	This parameter sets a description that will be displayed in the table footnotes when the cell has an unexpected or unexplained cell covariance.
rsesuppressstring	A string to display in the cell when the RSE value is suppressed.
rsesuppressStringDescription	A string to display in the footnotes when the table contains suppressed RSE values.
rsePercentageAlgorithm	The RSE formula to use. Set this to either `optionA` or `optionB`.

When you have finished making changes to CubeCatalog.xml, save the file and restart Tomcat or the SuperWEB2 service.

Footnote Text for Percentage View

A footnote is displayed when you switch to view a table as percentages with RSE values. The default text is "NOTE: In percentage view, RSE Annotations are not available."

To change this value, edit <tomcat_home>\webapps\webapi\WEB-INF\classes\message_en.properties in a text editor. Change the following value:

XML

page.tableView.annotationPanel.hideRSEAnnotation=NOTE: In percentage view, RSE Annotations are not available.

Value	Show
0	Data values only (the default).
1	Data values and RSE values next to each other.
2	RSE values only.