MicroStrategy ONE

Configuring the template details auto text code

Auto text codes are document or dataset variable information. The template of a report contains:

  • The group of objects (attribute, metrics, custom groups, and so on) that defines the columns of data to be included in the report

  • The layout and format of these objects

The template details auto text code displays the complete template details, including attribute details and metric details, unless the template details have been configured differently at the report or project level. For more information about the different levels and their order of precedence, see Levels of auto text code configuration.

You can choose whether to include or omit the following:

  • Base template name, which is the template name of the dataset report. You can also select how to identify an embedded template. See Displaying the base template name for a more detailed description and examples.

  • Template Description, which is the short description of the template. If the template is embedded or does not have a description, the template description line is not displayed.

  • Non-metric template units, which are the objects on the dataset report other than metrics, such as attributes and consolidations.

  • Metrics.

If you choose to display metrics, you can select whether or not to display each of the following:

  • Conditional metrics only

  • Formula

  • Dimensionality

  • Conditionality

  • Transformation

If metrics are not displayed, the information is of course also not displayed. If you choose to inherit the Metrics setting, these settings are also inherited.

For each of the settings listed above, you can also choose to inherit the setting instead. If you are configuring the auto text codes in a specific text field, the setting is inherited from the document setting. If you are configuring all the auto text codes in the document, the setting is inherited from the report setting. For more information on the levels of inheritance, see Levels of auto text code configuration.

For the procedure to configure the template details auto text code for a document, see Steps to configure the template details auto text code.

Displaying the base template name

Some reports are created using a stand-alone template; this is referred to as a base template. If a base template was used to create the dataset report of a document, you can select whether or not to display the name of that template.

If you choose to display the template name, you can also select whether or not to identify an embedded template as a local template. An embedded template is one that is part of the dataset report, as opposed to a template saved as a stand-alone object.

  • If you set Base Template name to Yes, the template name is displayed for a stand-alone template on a dataset report, but the words "Local Template" are displayed for an embedded template.

  • If you set Base Template name to Automatic, the template name is displayed for a stand-alone template, but the template name is blank for an embedded template.

  • If you set Base Template name to No, the template name is not displayed, whether or not the template is stand-alone or embedded.

For a more detailed description of this setting and embedded vs. stand-alone templates, including examples, see the Document Creation Help.

Prerequisite

The following procedure assumes you have already added a template details auto text code to your document. For instructions, see Displaying document and dataset report information: Auto text codes.

To configure the template details auto text code

  1. Open the document in the Document Editor. How?

  2. You can configure either:

    • The auto text code in a specific text field:

      • Right-click the text field containing the auto text code and select Properties. The Properties dialog box opens.

      • On the General tab, click Format in the Report Details Properties area.

    • All the template details auto text codes in the document:

      • Select Document Properties from the Format menu. The Document Properties dialog box opens.

      • Click Advanced in the list on the left.

      • Click Format in the Report Details Properties area.

    The Report Details Properties dialog box opens.

  3. Click the Template Details tab.

    By default, each setting on this tab inherits the document or report setting, as described in Levels of auto text code configuration. You can return to this default by selecting Inherit from the drop-down list for the specific setting.

  4. To select whether the template name of the dataset report is displayed, choose one of the following from the Base Template name drop-down list:

    • To display the template name for a stand-alone template on a dataset and "Local Template" for an embedded template, select Yes.

    • To display the template name for a stand-alone template, but leave it blank for an embedded template, select Automatic.

    • To omit the template name, whether or not the template is stand-alone or embedded, choose No.

  5. To determine whether or not the short description of the template is included, select Yes or No from the Template Description drop-down list.

    If the template is embedded or does not have a description, the template description line is not displayed.

  6. To determine whether or not dataset objects other than metrics (such as attributes, consolidations, and custom groups) are listed, select Yes or No from the Non-metric template units drop-down list.

  7. To determine whether or not the metrics on the dataset are listed, select Yes or No from the Metrics drop-down list.

  8. If metrics are displayed, select whether or not to display each of the following:

    • Only Conditional Metrics

    • Formula

    • Dimensionality

    • Conditionality

    • Transformation

    If you choose to inherit whether metrics are displayed, these settings are also inherited.

  9. Click OK to close the Report Details Properties dialog box.

  10. Click OK to return to the document.

Related Topics