Header and footer fields

You can insert a number of fields into table headers and footers to add information about the tables, filters, weighting, data set, population date and time, and so on. You can use more than one field in a single header or footer, and you can combine the fields with plain text.

The internal name of the CDSC, such as “mrXmlDsc”.

The table’s cell contents. If there is more than one, they are separated by line breaks.

Information about symbols displayed in the table cells.

The user context being used, such as “Analysis”.

The current date and time. By default this is in the long date format for the current language’s default regional setting (locale). Use the \s switch to use the short date format.

The name and location of the case data.

The description of the table document, such as “Analysis of age and education against interest in the various galleries”.

The descriptions of all of the filters, concatenated with the word “AND” in bold. If the filters are at different levels, details of the levels are shown. If the filter does not have a description, its expression is shown.

You can use one or more of a number of optional switches. These are described in the table below.

Switches: \e \t \g \i+ \i- \n \p

The label type being used, such as “Label”.

The metadata language being used, such as “English (United States)”.

The name of the table’s population level. For example, “Person[..].Trip". Use the \l switch to use the level’s description instead of the name. For example, “Overseas trips taken by each person”.

Switches: \l \n \p \s

The internal name of the MDSC being used, such as “mrQvDsc”.

The name and location of the metadata.

The versions of the metadata being used in the form of a version expression. In UNICOM Intelligence Reporter - Survey Tabulation 2.3 and earlier, this is always "{..}", which indicates a combination of all versions. For more information, see Working with versions.

Displays warnings generated during the generation of statistical tests, for example, if the type of test requested is not valid for the type of table.

The description of the data set, such as “Museum Survey”.

When you are using a CDSC that supports multiple projects (such as RDB DSC), you can show the name of the project being used, such as “short_drinks”.

The rules defined for the table. Each rule is separated by a line break. For example, “Hide cells where Count equals 0”.

The population date and time for the current language’s default regional setting (locale). By default this is in the long date format. Use the \s switch to use the short date format.

The specification of the side axis. For example, “age”. Use the \l switch to display descriptions instead of names, for example, “Age of respondent”.

Switches: \l \n \p \s

The column by which the table is sorted. For example, “Gender{Male}”.

The row by which the table is sorted. For example, “Age{Base}”.

Notes relating to the statistical tests, separated by a line break. This field should always be used in tables that include a statistical text. For example, “Column Proportions: Columns Tested (5%) A/B”. If a statistic is invalid, the annotation indicates this. The \i- switch suppresses annotations for invalid statistics.

The table's base value. For example, “602”.

The table description, such as “Age by gender for all respondents”.

The name of the table, such as “MyTable”.

The index of the table in the table document, such as “5”.

The table specification, such as “age * gender”. Use the \l switch if you want to replace variable names with their descriptions. For example, “Age of respondent * Gender of respondent”.

Switches: \l \n \p \s

The specification of the top axis. For example, “gender”. Use the \l switch if you want to replace variable names with their descriptions. For example, “Gender of respondent”.

The total number of tables in the table document, such as “10”.

The name of the weighting variable. For example, “agebalance”. Use the \l switch if you want to display the weighting variable's description. For example, “Weighting factor for age balance”.

Switches: \l \n \p \s

Always use the filter expression instead of the description.

(Used with Filters field) Include only global filters (that is, ignore any filters applied directly to the table).

(Used with TableNumber field) Add hierarchical numbering if the tables are stored in folders (for example, 2.1, 2.1.1, and so on).

Also reorder the table index, from the top to the end, in the table document that is presented in the Survey Reporter Table List Pane.

Include only Interview filters.

(Used with Filters field) Include only filters that are not Interview filters.

(Used with Statistics field) Suppress annotations for invalid statistics.

A more “friendly” version in which variable names are replaced by their descriptions (labels).

When combining more than one field in a header or footer position, you can use this option to add a conditional line break after the text inserted by the field. The line break will only be inserted if the field inserts some text.

This option can be used with all fields to add a text prefix. For example, when used with the Filters field, it inserts the text “Filters: " in front of the details of the filters.

Used with the CurrentTime and RunTime fields, displays the short date format rather than the long date format.

Used with the Level, SideSpec, SortColumn, SortRow, TableSpec, TopSpec, and WeightVariable fields, displays the short name of the field instead of the full name. This option is ignored if you use the \l option.

Include only filters applied directly to the table (that is, ignore global filters).