HeaderEntry
SuperCROSS | Production System | SuperWEB2 | |||||
---|---|---|---|---|---|---|---|
Element | Format | Description | Save | Load | Load | Save | Load |
HeaderEntry | 'HEADER' { Version } { Unicode } { StandardHeader } DatabaseId {LoadStdRcd} {TableHeading} {TableFooter} {Alignment}* {SaveOption} {PrintOptions} {Preferences} {Includes}* HeaderEnd | Yes | Yes | Yes if the header items are in the correct sequence (same order as they are in this document). | Pass-through | Pass-through | |
Version | VERSION 2 | The TXD version number. Currently there are only two versions of the TXD format:
| Yes | Yes | Yes | Yes | Yes |
Unicode | UNICODE | Optional. If UNICODE appears in the header, it indicates that the file is UTF-8 instead of the current system locale codepage. Only valid if the TXD is version 2. | Yes | Yes | Yes | Yes | Yes |
StandardHeader | {RecodeEscapeChar} {ItemFlag} | ||||||
RecodeEscapeChar | 'ESCAPE_CHAR' AnyChar | AnyChar – Escape character used throughout the file. | Yes | Yes | Yes | Yes | Yes |
AnyChar | char(0 – 255) | ||||||
ItemFlag | (ITEM_BY_CODE | ITEM_BY_NAME) |
| Yes | Yes | Yes | Yes | Yes ITEM_BY_CODE: No |
DatabaseId | 'DBID' IdentifierString | IdentifierString – Identifies the database that the txd is associated to. | Yes | Yes | Yes | Yes | Yes |
IdentifierString | (AnyChar)* | ||||||
ReportCode | 'REPORTCODE' IdentifierString | IdentifierString – Identifies a report within the meta data from which meta data for the txd report elements is to be retrieved. | Yes | Yes | Yes | Pass-through | Pass-through |
Language | 'LANGUAGE' IdentifierString | IdentifierString – Identifies the language to display meta data for. | Yes | Yes | Yes | No | No |
LoadStdRcd | 'LOAD_STD_RCD' | Indicates that when loading this txd it should load all the standard recodes, so that the textual table can use those recodes. | Yes | Yes | Ignored | Pass-through | Pass-through |
TableHeading | 'HEADING' IdentifierString | IdentifierString - Heading of the table. See the note below for details of the notation used by SuperCROSS inside the identifier string. | Yes | Yes | Ignored | Pass-through | Pass-through |
TableFooter | 'FOOTER' IdentifierString | IdentifierString - Heading of the table. See the note below for details of the notation used by SuperCROSS inside the identifier string. | Yes | Yes | Ignored | Pass-through | Pass-through |
Alignment | 'ALIGN' ('ROW' | 'COLUMN' | 'WAFER' | 'HEADING' | 'FOOTER' ) ('LEFT' | 'RIGHT' | 'CENTRE') {('TOP' | 'CENTRE' | 'BOTTOM')} |
| Yes | Yes | Ignored | Pass-through | Pass-through |
SaveOption | 'SAVE' IdentifierString IdentifierString | Save option specifies the file formats the server needs to save after cross-tabulation. You must use the exact string you get from output DLLs as SaveFormat… (take note of spaces in between). If other output DLLs exist, then their output format strings can also be used.
| Yes | Yes | Ignored | Pass-through | Pass-through |
PrintOptions | {'CENTRE_TABLE'} {PageNo} {Margins} | CENTRE_TABLE – Indicates that the table will be centered when it is printed. | Yes | Yes | Ignored | Pass-through | Pass-through |
PageNo | 'PAGE_NO' ('TOP' | 'BOTTOM') ('LEFT' | 'CENTRE'| 'RIGHT') | Indicates that a page number is to be displayed on each page of the printed table and the location of the page number. | Yes | Yes | Ignored | Pass-through | Pass-through |
Margins | 'MARGIN' 'TOP' PositiveInteger 'BOTTOM' PositiveInteger 'LEFT' PositiveInteger 'RIGHT' PositiveInteger |
| Yes | Yes | Load fails. | Pass-through | Pass-through |
PositiveInteger | ('0' - '9')+ | ||||||
Includes | ('INCLUDE' IdentifierString) * | IdentifierString – Indicates additional files to load when loading the TXD. The additional files may contain UDFs and/or recodes in the binary or textual format. | Yes | Yes | Files must have full paths. RCD files are not supported. | Pass-through | Pass-through |
Preferences | {StorageType} {LargeAxes} {ConfidTxt} {ZeroTxt} {NoContributorsTxt} {ColWidth} {RowWidth} {RowIndent} {RowWrap} {WaferIndent} {AnnotWidth} {ZeroSuppress} {AutoFormat} {AutoRowWidth} {AutoConfid} {NumberFormat} {DecPlaces} {WaferHeading} {RowHeading} {ColHeading} {TableFormat} {TableConfid} {PowerTen} { ManualRowWidth} | Supported:
Others are preserved as string values | Pass-through | Pass-through | |||
StorageType | 'STORAGE' ('PREFER' | 'DENSE' | 'SPARSE') |
| Yes | Yes | Ignored | Pass-through | Pass-through |
LargeAxes | 'LARGE' ('MEM' | 'NUM' PositiveInteger) |
| Yes | Yes | Ignored | No | Ignored ( ??? ) |
ConfidTxt | 'CONFID' IdentifierString | IdentifierString – String to use in confidential cells. | Yes | Yes | Yes | Pass-through | Pass-through |
ZeroTxt | 'ZERO' IdentifierString | IdentifierString – String to use in zero cells. | Yes | Yes | Yes | Pass-through | Pass-through |
NoContributorsTxt | 'NO_CONTRIBUTORS' IdentifierString | IdentifierString – String to use in no contributes cells. | Yes | Yes | Ignored | No | Ignored |
ColWidth | 'COL_WIDTH' PositiveInteger | PositiveInteger – Width of the columns. | Yes | Yes | Ignored | Pass-through | Pass-through |
RowWidth | 'ROW_WIDTH' PositiveInteger | PositiveInteger – Width of the rows. | Yes | Yes | Ignored | Pass-through | Pass-through |
RowIndent | 'ROW_INDENT' PositiveInteger | PositiveInteger – Indentation of sub items in the rows. | Yes | Yes | Ignored | Pass-through | Pass-through |
RowWrap | 'ROW_WRAP' PositiveInteger | PositiveInteger – Indentation of wrapped items. | Yes | Yes | Ignored | Pass-through | Pass-through |
WaferIndent | 'WAFER_INDENT' PositiveInteger | PositiveInteger – Indentation of sub items in the wafer. | Yes | Yes | Ignored | Pass-through | Pass-through |
AnnotWidth | 'ANNOT_WIDTH' PositiveInteger | PositiveInteger – Width of the annotations. | Yes | Yes | Ignored | Pass-through | Pass-through |
ZeroSuppress | {'REVEAL_ALL_FIRST'} {'SUPPRESS_ALL_FIRST'} {'SUPPRESS_ROWS'} {'SUPPRESS_COLUMNS'} {'SUPPRESS_WAFERS'} |
| Yes SUPPRESS_ALL_FIRST is not saved. | Yes Load fails if SUPPRESS_ALL_FIRST is specified. | Ignored | SUPPRESS_ROWS and SUPPRESS_COLUMNS are supported; other settings are Pass-through. | SUPPRESS_ROWS and SUPPRESS_COLUMNS are supported; other settings are Pass-through. |
AutoFormat | 'AUTO_FORMAT' | Automatically format the table for best viewing. | Yes | Yes | Ignored | Pass-through | Pass-through |
AutoConfid | 'AUTO_CONFID' | Yes | Yes | Ignored | Pass-through | Pass-through | |
AutoRowWidth | 'AUTO_ROW_WIDTH' | Automatically resize the rows to fit the labels of the items in the row. | Yes | Yes | Ignored | Pass-through | Pass-through |
NumberFormat | 'NUMBERS_WITH_COMMAS' | 'NUMBERS_NO_COMMAS' | NUMBERS_WITH_COMMAS - Add a comma separator after every third digit. | Yes | Yes | Ignored | Pass-through | Pass-through |
DecPlaces | 'DEC_PLACES' PositiveInteger | PositiveInteger – Number of decimal places to display in each cell. | Yes | Yes | Yes | Pass-through | Pass-through |
WaferHeading | 'WAFER_HEADING' IdentifierString | IdentifierString - Headings to display in wafers if the wafer axis is empty. | Yes | Yes | Ignored | Pass-through | Pass-through |
RowHeading | 'ROW_HEADING' IdentifierString | IdentifierString - Headings to display in rows if the row axis is empty. | Yes | Yes | Ignored | Pass-through | Pass-through |
ColHeading | 'COL_HEADING' IdentifierString | IdentifierString - Headings to display in columns if the column axis is empty. | Yes | Yes | Ignored | Pass-through | Pass-through |
TableFormat | 'TABLE_FORMAT_ON' | 'TABLE_FORMAT_OFF' | Indicates if the table should be formatted. | Yes | Yes | Ignored | Pass-through | Pass-through |
TableConfid | 'TABLE_CONFID_ON' | 'TABLE_CONFID_OFF' | Turns the confidentiality on or off for tables that have removable confidentiality. | Yes | Yes | Ignored | Pass-through | Pass-through |
PowerTen | 'POWER_TEN PositiveInteger | PositiveInteger – Number of power ten to display in each cell. Not saved by default: see the note below. | Yes | Yes | Ignored | Pass-through | Pass-through |
ManualRowWidth | 'MANUAL_ROW_WIDTH_ON' | Resize the rows to fit the labels of the items in the row. Not saved by default: see the note below. | Yes | Yes | Ignored | Pass-through | Pass-through |
TableMethod | 'TABLE_METHOD' IdentifierString | IdentifierString – method ID from SuperADMIN method catalogue | Yes | Yes | Yes | Yes | Yes |
HeaderEnd | 'END HEADER' | Yes | Yes | Yes | Yes | Yes |
Notes
TableHeading and TableFooter Notation
The notation used by SuperCROSS for the TableHeading and Table Footer is as follows:
Code | Represents |
---|---|
&a | The cell/field/field value annotations. |
&c | The derivation's footnotes. |
&C | The table cell count. |
&d | The database name. |
&e | The standard annotation table footnotes. See Weighted Datasets for more information. |
&f | The total set of table footnotes defined in the database for this table. |
&n | A 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 for more information. |
&z | The database annotations. |
This notation is used in SuperCROSS only. It does not apply to SuperWEB1/SuperWEB2.
PowerTen and ManualRowWidth
SuperCROSS does not save these flags to the TXD file by default.
To change this, you need to add a setting to the super.ini configuration file:
- Make sure SuperCROSS is not running.
- Open super.ini in a text editor. If you installed to the default location, this file is located at C:\Program Data\STR\SuperCROSS\super.ini.
Search the file to check whether it already includes a
[TXD]
section.If the file already includes a
[TXD]
section, set the value of theSaveExtraUserSettings
parameter to 1.If there is no
[TXD]
section in super.ini, add the following section to the end of the file:CODE[TXD] SaveExtraUserSettings=1
- Save your changes to super.ini and restart SuperCROSS.