If you are using UNICOM Universal Gateway (UniGW), you can indicate status at table level. The UniGW dashboard can display information about interviewing reports: a list of tables which are highlighted according to their status. For example, you might configure the “Queue Status” report to appear in the dashboard so that you can see at a glance if any participant/sample queue needs attention.

(Table status can also be used when integrating with third‑party applications. It is not used in Reporter or Survey Tabulation).

To integrate with UniGW, set Table.Status to “ok”, “warning”, or “error”. For example, you might decide that if any cell in the table is red (see Highlighting cells: Status cell item), the table status should be “error”. To check the status of a cell, use the Table.HasCellStatus() method.

See also:

The following script could be run after every table population, so it can be used in the OnAfterPopulate event. The script is then stored in the .mtd file to be run by Reporter or Survey Tabulation, or through the Interviewing Reports web service to to integrate with UniGW or other dashboard systems.

The Properties collection on the Table object contains a collection of Property objects. Each property consists of a name and value and controls a table option, such as what to display for percentage values that are rounded to zero. The table properties automatically take their values from the corresponding properties in the Document.Default.Properties collection. This means that you can set up default properties for all new tables and optionally overwrite one or more of them on individual tables. Changing the default properties does not change the properties of tables that have already been created.

Events are predefined objects that specify actions that are to take place at certain points in the script.

The only event available is OnAfterPopulate.

The OnAfterPopulate event runs directly after population occurs. Use it to run a script in Reporter after a table is generated. For example, you can use it to:

This example shows how to set the Table.Status.

When you work with the Table Object Model, you can access the metadata in the MDM Document using the Table Object Model Document.DataSet.MDMDocument property. The MDM Document is returned in no-save mode, which means that any changes you make are not saved.

The MDM Document, part of the Metadata Model, is documented in the Data Model section of the UNICOM Intelligence Developer Documentation Library. See Working with the Metadata Model.

Sample Script Files: WorkingWithVersions.mrs, RDBTables.mrs.

These example scripts are based on the Short Drinks sample data set. To run examples using the Short drinks sample data set, you need access to a SQL Server installation on which the Short Drinks sample database has been restored, and appropriate user access rights. For more information, see Restoring the Short Drinks sample database. For information on running the example scripts, see Running the sample table scripts.

As a survey progresses, changes are sometimes made to the questionnaire. For example, questions and categories might be added and deleted. Typically a new version is created in the metadata each time a change is made to the questionnaire and each version corresponds to a variation of the questionnaire used for some of the interviews.

By default, when you load a data set that contains more than one version, all of the versions are combined to form a superset (sometimes called a superversion). This means that all of the variables and categories from all of the versions are available. When there is a conflict between, for example, a text in one or more of the versions, the more recent versions generally take precedence over the older versions. It is possible to load a particular version or versions and to change the order of precedence. However the order of questions and categories is always taken from the most recent version.

You select the metadata version you want to load by specifying a version expression (see Version expressions) in the sixth parameter of the DataSet.Load method. The order in which you specify the versions in the expression defines the order of precedence. For example, the following loads version 2:

The following script loads a superset of versions 2 through 4, with the older versions taking precedence over the newer ones:

It is important to understand that the version of the metadata you select does not affect the case data that is loaded. However, case data collected using UNICOM Intelligence Interviewer - Server Admin has the name of the version used to collect it stored in the DataCollection.MetadataVersionNumber system variable (see System variables).

Sample script file: PercentageOnElementsAsked.mrs

This example script is based on the Short Drinks sample data set. To run examples using the Short drinks sample data set, you need access to a SQL Server installation on which the Short Drinks sample database has been restored, and appropriate user access rights. For more information, see Restoring the Short Drinks sample database. For information on running the example scripts, Running the sample table scripts.

You indicate that you want the formatting to be controlled by styles by setting the UseExcelStyles export property to True:

See Microsoft Excel tables export formatting for more information.

By default, each table in your script is exported as a single table to a separate Excel worksheet. However, you can optionally choose to export each type of cell contents to a separate table. All of the tables are placed on the same worksheet. This option is useful if you want to perform calculations on the output or set up your own charts in Excel. You select this option by setting the SplitCells export property to True: