HeaderEntry

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

The TXD version number.

Currently there are only two versions of the TXD format:

• If VERSION does not appear at the start of the TXD file then the TXD will be treated as TXD version 1.
• If VERSION 2 appears at the start of the TXD file then it will be treated as version 2.

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.

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)

• ITEM_BY_CODE – All items in the txd are referred to by their code.
• ITEM_BY_NAME – All items in the txd are referred to by their 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')}

• Alignments for the table, column, row and wafer headings and the table footer. The table header may contain one alignment statement for each of row, column, wafer, header and footer.
• The optional part( 'TOP' | 'CENTRE' | 'BOTTOM') is only for the row alignment.

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.

• IdentifierString(1) - contains output format strings delimited by '|'
  • Output format strings are:
    • 'SuperCROSS (.SCS)'
    • 'Tab-delimited table (.TXT)'
    • 'Comma-separated table (.CSV)'
    • 'Tabular Macro-data (.CSV)'
    • 'Recode (.RCD)'
    • 'Textual Recode (.TXT)'
    • 'Parameter Log (.TXT)'
    • 'HTML - single file (.HTM)'
    • 'Summary Record Database (.SRD)'
    • 'Excel (.XLS)'
    • 'Textual Table Definition (.TXD)'
• IdentifierString(2) - name of the file to save the resulting tables to.

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

• PositiveInteger(1) – Margin (in points) to leave at the top of each page when the table is printed.
• PositiveInteger(2) – Margin (in points) to leave at the bottom of each page when the table is printed.
• PositiveInteger(3) – Margin (in points) to leave at the left of each page when the table is printed.
• PositiveInteger(4) – Margin (in points) to leave at the right of each page when the table is printed.

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:

• ConfidTxt,
• ZeroTxt,
• NoContributorsTxt,
• DecPlaces

Others are preserved as string values

Pass-through

Pass-through

StorageType

'STORAGE' ('PREFER' | 'DENSE' | 'SPARSE')

• PREFER – Data will be stored in a dense data cube until all memory is used and will then switch to use a sparse data cube.
• DENSE – Data will be stored in a dense data cube.
• SPARSE – Data will be stored in a sparse data cube.

Yes

Yes

Ignored

Pass-through

Pass-through

LargeAxes

'LARGE' ('MEM' | 'NUM' PositiveInteger)

• MEM - Set to large axis mode when memory runs out.
• NUM - Set to large axis mode when the number of items in the axis exceeds PositiveInteger.
• PositiveInteger – Maximum number of items allowed in an axis.

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

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

Yes

Yes

Ignored

Pass-through

Pass-through

RowWrap

'ROW_WRAP' PositiveInteger

Yes

Yes

Ignored

Pass-through

Pass-through

WaferIndent

'WAFER_INDENT' PositiveInteger

Yes

Yes

Ignored

Pass-through

Pass-through

AnnotWidth

'ANNOT_WIDTH' PositiveInteger

Yes

Yes

Ignored

Pass-through

Pass-through

ZeroSuppress

{'REVEAL_ALL_FIRST'} {'SUPPRESS_ALL_FIRST'} {'SUPPRESS_ROWS'} {'SUPPRESS_COLUMNS'} {'SUPPRESS_WAFERS'}

• SUPPRESS_ROWS – Suppress all rows with 0 cells after crosstabulation.
• SUPPRESS_COLUMNS - Suppress all columns with 0 cells after crosstabulation.
• SUPPRESS_WAFERS - Suppress all wafers with 0 cells after crosstabulation.

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.

AutoFormat

'AUTO_FORMAT'

Yes

Yes

Ignored

Pass-through

Pass-through

AutoConfid

'AUTO_CONFID'

Yes

Yes

Ignored

Pass-through

Pass-through

AutoRowWidth

'AUTO_ROW_WIDTH'

Yes

Yes

Ignored

Pass-through

Pass-through

NumberFormat

'NUMBERS_WITH_COMMAS' | 'NUMBERS_NO_COMMAS'

Yes

Yes

Ignored

Pass-through

Pass-through

DecPlaces

'DEC_PLACES' PositiveInteger

Yes

Yes

Yes

Pass-through

Pass-through

WaferHeading

'WAFER_HEADING' IdentifierString

Yes

Yes

Ignored

Pass-through

Pass-through

RowHeading

'ROW_HEADING' IdentifierString

Yes

Yes

Ignored

Pass-through

Pass-through

ColHeading

'COL_HEADING' IdentifierString

Yes

Yes

Ignored

Pass-through

Pass-through

TableFormat

'TABLE_FORMAT_ON' | 'TABLE_FORMAT_OFF'

Yes

Yes

Ignored

Pass-through

Pass-through

TableConfid

'TABLE_CONFID_ON' | 'TABLE_CONFID_OFF'

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

Yes

Yes

Yes

Yes

Yes

HeaderEnd

'END HEADER'

Yes

Yes

Yes

Yes

Yes

&a

The cell/field/field value annotations.

&c

The derivation's footnotes.

&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.

&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.