You can use the supplied scaling plugin, outputscaling to set a scale value to be applied to each cell in the table, or to apply rounding to values.
The outputscaling plugin has a number of properties that you can configure.
The scaling factor to apply. Every cell value in the table will be divided by 10^n (where n is the scale_factor).
For example, if you set the scale_factor to 2 then each cell value in the table will be divided by 100 (10^2 = 100).
The default value of scale factor is 0 (i.e. no scaling applied to the table).
|The default scaling factor for measures. If this is not explicitly set, measures will use whatever is set for the |
The rounding to apply to count values:
|The rounding to apply to measures. This can be set to either a positive or negative integer value, and works in the same way as the |
Whether to propagate 0 rounded counts to measures:
Can be used in conjunction with the
If you set this to
This property can be used to turn off the default annotation settings for measures:
A string value used to annotate the scaled results. For example,
|The default annotation symbol for measures. If not explicitly set, measures will use whatever is set for the |
|A string value used for the annotation description. For example, |
|The default annotation description for measures. If not explicitly set, measures will use whatever is set for the |
The name of a file to log information from the scaling plugin to.
This is optional. If you do not set the property, then the plugin will use a default value: outputscaling.log.txt, and save the log file to the SuperSERVER program data logs directory (if you installed to the default location the file will be saved as C:\ProgramData\STR\SuperSERVER SA\logs\outputscaling.log.txt).
If you choose to specify a log file name, then you can either:
The name of a configuration file for per measure scaling. This is optional.
By default the
The configuration file must be in Comma Separated Values (CSV) format, with the following fields (the file must not include any header row):
How do I find out the measure ID?
This ID takes the following format:
These IDs are also visible in SuperCROSS. Go to the Define Recode window and click Use Codes.
The function name can be one of the following:
You can either specify the filename using an absolute path or a path relative to the location of the plugin. You must escape any Windows style directory separators (\) in the path with a backslash.
Apply the Plugin
Login to SuperADMIN and create a new method:
Add the Data Control plugin to the method:
Set the plugin properties:
Assign the method to a dataset (in this example we are assigning the method to a dataset with the ID
You can review the method details using the command
cat <dataset_id> methods details <method_id>:
Configure Log Output
The Data Control plugins do not log any output by default. To activate log output:
- Open C:\ProgramData\STR\SuperSERVER SA\log4j.scsa.xml in a text editor.
Locate the following section:
By default, the above section is commented out. Uncomment the section.
- Restart SuperSERVER.
The plugin logs the configuration parameters and the input and output value for each value in the table.