This is the documentation for SuperSTAR 9.8

SuperSTAR 9.9 is now available.
View this page in the SuperSTAR 9.9 documentation or visit the SuperSTAR 9.9 documentation home.

Skip to end of metadata
Go to start of metadata
SummaryStores SuperCROSS display settings. SuperCROSS updates the settings in this file every time the user closes the client so that it can apply the same settings next time.
Default Location

C:\ProgramData\STR\SuperCROSS

[Preferences]

This section stores a number of SuperCROSS user preferences, as well as the most recent X and Y coordinates and size of many of the SuperCROSS windows and dialogs. Settings in this section include:

EntryDescriptionEquivalent Setting in SuperCROSS Client
AddTotal

Whether or not to automatically add a total with default recodes:

  • 0 - Do not automatically add a total.
  • 1 - Automatically add a total.
Add Total With Default Recodes check box in the Fields window.
FieldBoxFont
The font used in the Fields window.Edit > Options > General > Field List Box (the setting is only saved to cross.ini when Use As Default is selected).
Footnote

The default format of the table footer. You can use the following special codes to display dynamic information about the table:

CodeRepresents

&a

The cell/field/field value annotations.

&c

The derivation's footnotes.

&d

The database name.

&e

The standard annotation table footnotes. See Weighted Databases - SuperCROSS for more information.

&f

The total set of table footnotes defined in the database for this table.

&nA newline.

&o

The organisation name (as defined in SuperCROSS under Edit > Options > General).

&p

Details of any columns that have custom power of ten settings applied.

&r

A description of the randomisation applied (for example using a data control plugin). For example "Confidentially rules have been applied to all cells in this table, including randomly rounding to base 3".

&s

The summation option in use.

&t

The filename of the table file.

&v

The details of the fields in use in the table (for example "Martial Status by Occupation").

&x

The table method annotation (if the administrator has configured this). See Confidentiality - SuperCROSS for more information.

&z

The database annotations.

  1. Double-click the table footer.
  2. Modify the default format.
  3. Select the Use As Default check box.
  4. Click OK.

See Modify Table Header, Table Footer and Field Heading - SuperCROSS for more information.

ForceCrossTab

Whether to always allow cross tabulation.

  • 0 - Cross tabulation is not always available. For example if the table has just been cross tabulated, the option is greyed out until something changes in the table.
  • 1 - Always allow cross tabulation, even if the table has not changed.
Edit > Options > General > Always Allow Cross-tabulation
Heading

The default format of the table header. You can use the following special codes to display dynamic information about the table:

CodeRepresents

&a

The cell/field/field value annotations.

&c

The derivation's footnotes.

&d

The database name.

&e

The standard annotation table footnotes. See Weighted Databases - SuperCROSS for more information.

&f

The total set of table footnotes defined in the database for this table.

&nA newline.

&o

The organisation name (as defined in SuperCROSS under Edit > Options > General).

&p

Details of any columns that have custom power of ten settings applied.

&r

A description of the randomisation applied (for example using a data control plugin). For example "Confidentially rules have been applied to all cells in this table, including randomly rounding to base 3".

&s

The summation option in use.

&t

The filename of the table file.

&v

The details of the fields in use in the table (for example "Martial Status by Occupation").

&x

The table method annotation (if the administrator has configured this). See Confidentiality - SuperCROSS for more information.

&z

The database annotations.

  1. Double-click the table header.
  2. Modify the default format.
  3. Select the Use As Default check box.
  4. Click OK.

See Modify Table Header, Table Footer and Field Heading - SuperCROSS for more information.

NumThreads
The number of threads to use. This setting applies to SXV3 files only. 
Organisation
The organisation name displayed in the table header section.Edit > Options > General > Organisation
Quantile Label

The default label used when creating a quantile user defined field. By default, this is set to Values from {Min} to {Max} make up Quantile Range {Num}.

This label applies to all quantiles except those created from weighted databases that use SuperSERVER weightings. These have a separate default label, Weighted Quantile Label.

See Create a Quantile Field - SuperCROSS for more information.

Cross > Define Fields > Quantile
Quantile Label Value Precision

The number of decimal places used to display the quantile range boundaries in the labels of quantile user defined fields. The setting applies to all types of quantiles and affects the precision of the {Min} and {Max} values in both the Quantile Label and Weighted Quantile Label strings.

This setting does not appear in the cross.ini file by default, so you will need to add it if you want to set a custom precision for these labels.

The precision for quantile labels is not saved in TXDs. SuperCROSS will always use the setting from the cross.ini file.

 
Quantile Label Rse Precision

The number of decimal places used to display the RSE value in the labels of weighted quantile user defined fields. This setting changes the precision of the {Rse} , {Rse_Min}, and {Rse_Max} values that are substituted into the Weighted Quantile Label string.

This setting does not appear in the cross.ini file by default, so you will need to add it if you want to set a custom precision for these labels.

The precision for RSE values in quantile labels is not saved in TXDs. SuperCROSS will always use the setting from the cross.ini file.

 
Recode Indent
The indentation displayed on sub items in the Define Recode window.Edit > Options > General > Recode Indent
RecodeOpenPATH
The default directory for loading recodes when using the Load option in the Fields window.Edit > Options > Configuration > Location > Open Recode
RecodeSavePATH
The default directory for saving recodes when using the Save option in the Fields window.Edit > Options > Configuration > Location > Save Recode
RVDateFormat

The format to use for date fields in Record View. You can use the following codes to specify the date format:

CodeRepresents
%y2 digit year without the century (00-99).
%Y4 digit year.
%m2 digit month (01-12).
%bAbbreviated month name (3 characters).
%BFull month name.
%d2 digit day of the month (01-31).
%aAbbreviated weekday name (3 characters).
%AFull weekday name.
%w

1 digit decimal value for the weekday: 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday, 6 - Saturday

%j3 digit decimal value for the day of the year (001-366).
%W2 digit decimal value for the week of the year (01-53).

For example:

RVDateFormat=%Y-%m-%d

By default, this setting does not appear in cross.ini. When this setting is not in the configuration file, SuperCROSS uses the default format, which is equivalent to %d/%m/%Y (e.g. 15/01/2014).

 
RVTimeFormat

The format to use for time fields in Record View. You can use the following codes to specify the time format:

CodeRepresents
%HHour in 24 hour format (00-23).
%IHour in 12 hour format (00-12).
%M2 digit minutes (00-59).
%S2 digit seconds (00-59).
%pAM or PM.

By default, this setting does not appear in cross.ini. When this setting is not in the configuration file, SuperCROSS uses the default format, which is equivalent to %H:%M:%S (e.g. 17:35:59).

 
Show Fields Box

Whether or not to show the Fields window by default when opening a new dataset.

  • 0 - Do not show the Fields window by default.
  • 1 - Show the Fields window by default.
Edit > Options > General > Display Fields Dialog Automatically
Show Time

Whether or not to display the time taken to complete the cross tabulation.

  • 0 - Do not display the cross tabulation time (default).
  • 1 - Display the cross tabulation time in a popup window following completion of the cross tabulation:

 
ShowMessageDivisionByZero

Whether to show a warning message if there are rows of unclassifiable data that are referenced by a classification User Defined Field and have not been included in the tabulation results.

This can occur if the table contains a classification User Defined Field that references NULL values (either NULL values in the unit records or as a result of a calculation such as a division by zero).

  • 0 - Do not show a warning message (default).
  • 1 - Show a warning message.

When this option is set to 1, SuperCROSS will display a warning message similar to the following:

 
TableBackgroundColour
A system RGB value for the table background colour.Edit > Options > General > Table Background (the setting is only saved to cross.ini when Use As Default is selected).
TableOpenPATH
The default directory for opening save tables (via File > Open).Edit > Options > Configuration > Location > Open Table
TableSavePATH
The default directory for saving tables (via File > Save As).Edit > Options > Configuration > Location > Save Table
UDFOpenPATH
The default directory for opening user defined fields (using the Load option on the Define Fields window).Edit > Options > Configuration > Location > Open UDF
UDFSavePATH
The default directory for saving user defined fields (using the Save option on the Define Fields window).Edit > Options > Configuration > Location > Save UDF
User Guide
The location of the SuperCROSS user guide, accessible through the Help > Online User Guide menu option in the SuperCROSS client. 
Weighted Quantile Label

The default label used when creating a quantile user defined field for a weighted database (SuperSERVER weightings only). Unweighted databases, and databases using SuperCROSS client-side weightings use the Quantile Label instead.

By default, this is set to Values from {Min} to {Max} make up Quantile Range {Num} with RSE of {Rse}.

In addition to using the {Rse} placeholder, which will be replaced with the maximum Relative Standard Error of the range, you can also choose to show the RSE in more detail using the placeholders {Rse_Min} and {Rse_Max} in your Quantile Label.

See Create a Quantile Field - SuperCROSS for more information.

Cross > Define Fields > Quantile

This section also stores the X and Y coordinates and size of various SuperCROSS windows and dialogs. SuperCROSS stores these values so that it can reopen the windows at the same size and position the next time.

Most of these settings do not appear in cross.ini by default (SuperCROSS adds them as you use the windows). You can reset to the default values by removing these settings from cross.ini.

Windows whose size and position are stored in cross.ini include:

SettingsSize and Position for...
ClassifyWeight_Pos
ClassifyWeight_Size
Define Recode window for summation options.
DbTreeDlgPos
DbTreeDlgSize
Catalogue - Select Database or Table window.
DEFPos
DEFSize
Define Fields window.
FBPos
FBSize
Fields window.
MATH_UDFPos
MATH_UDFSize
Math user defined field window.
Multiple_UDFPos
Multiple_UDFSize
Multiple user defined field window.
Quantile_UDFPos
Quantile_UDFSize
Quantile user defined field window.
Range_UDFPos
Range_UDFSize
Range user defined field window.
RCDPos
RCDSize
Define Recode window for fields.
RVFieldPos
RVFieldSize
Record View Options window.
SegmentationPos
SegmentationSize
Segmentation window.
ServerMonitorDlgPos
ServerMonitorDlgSize
Client/Server Monitor window.
Single_UDFPos
Single_UDFSize
Single user defined field window.
Time_UDFPos
Time_UDFSize
Time user defined field window.
Unique_UDFPos
Unique_UDFSize
Unique user defined field window.

[Export Limits]

This section stores the settings for the Limit Number section in the Record View Options. The user can override these settings by changing the values in the Record View Options dialog.

EntryDescription
SetLimit

Whether or not to limit the number of records returned:

  • 0 - No limit.
  • 1 - Set limit.
Limit

The number of records to limit RecordVIEW to. Can be any integer between 1 and 32000.

[Cross-tabulation]

This section applies to SXV2 and SXV3 format files only; it stores the tabulation method for these datasets.

Do not modify this section.

[Edit Log File]

This section applies to SXV2 and SXV3 format files only. It sets the name of a log file to be updated every time a dataset is edited.

EntryDescription
<dataset_id>
The path and filename to the log file to use for this dataset.

[MetaData Cache]

This section applies to SXV2 and SXV3 format files only. It sets access to SuperCROSS folders for caching meta information when in Network-User mode.

The Metadata cache settings can be useful if SuperSERVER and SuperCROSS are connected by a low bandwidth connection. SuperSERVER can be configured to cache fields and/or field items and mappings on a persistent disk cache. Multiple SuperCROSS clients can take advantage of this cache. Metadata retrieval and caching are carried out on demand, rather than by pre-loading.

EntryDescription
CacheAll

Enables caching and specifies where the cache should be stored.

  • 0 - SuperCROSS will cache value set item metadata only.
  • 1 - SuperCROSS will cache value set item metadata and fields (default).
Path

The path to the folder to cache. This setting can appear multiple times if there are multiple folders to be cached.

It is also possible to use a system environment variable to set the path, for example %applications%.

SXV2Metadata
A list of SXV2 metadata to be cached, separated by the | character.
SXV3Metadata
A list of SXV3 metadata to be cached, separated by the | character.

For example:

[MetaData Cache]
Path=c:\ProgramData\STR\SuperCROSS\Cache
Path=%applications%
SXV2metadata=.I|.L|.N|.TL|.S|.CNF|.HPP|.INI|
SXV3metatdata=.I|.L|.S|.TL|.BL|.VL|.CNF|.DSC|.INF|.INI|.SRT|.STR

The [Metadata Cache] settings can also be defined in the CrossModule.ini configuration file. If the section appears in both files then the settings in cross.ini take precedence.

  • No labels