Version 2021

Template Dependency Validator

Altering a report template can affect reports. If a metric is removed from a template, the change may affect all, some, or none of the dependent reports. (Dependent reports are those that use the template as a shortcut.) The reports can be adversely affected if, for example, the metric is removed from the template, but remains on the view template of the dependent report. It depends entirely on how the metric is included in the view definition of reports. The Template Dependency Validator allows you to conduct a quick impact analysis before saving any changes to a template.

The tool helps you to prevent the view and data definition of your reports from becoming unsynchronized. By alerting you to a potential problem, you can resolve the issue before any reports are affected.

When a template is modified or saved, the Template Dependency Validator is triggered. The Validator lists:

  • Reports that depend on the template

  • Reports that will not run if the change is completed

To resolve the problem, do one of the following:

  • Cancel the change and re-evaluate.

  • Open each dependent report and remove the dependencies, then make your changes to the template definition.

The changes to the template are not saved until the Template Dependency Validator is closed.

Layout

This dialog box lists the reports and HTML documents that are based on the template.

If you have made any changes to the template that cause any of these reports or HTML documents to no longer execute properly, the bottom of the dialog box displays all reports that will not run after the template is changed. This area also provides a description of the issues that have been detected, including the following:

  • Name: The name of the report that will not execute properly after the template change is saved. This field can be expanded to display any of the following information:

  • Invalid Derived Metric Expression: The derived metric expression cannot take an attribute or an attribute form as input.

  • Invalid Attribute Form (Template): The attribute form on the view template is not found in the report objects.

  • Invalid Filtering Expression (Attribute Form): The attribute form in a filtering expression is not found in the report objects.

  • Missing Template Unit: The unit on the view template is not found in the report objects. The unit can be an attribute, metric, custom group or consolidation.

  • Invalid Filtering Expression (Metric): The metric in a filtering expression is not found in the report objects.

  • Broken object: The name of the object that is causing the issue.

  • Location: The area of the report where the problem has been detected.

  • Location Object: The container object whose definition is no longer valid. For example, if you have an object that includes another object in its definition, such as a compound metric made up of several metrics, or a filter made up of a metric qualification, then the location object is the container object whose definition is no longer valid because the contained object is no longer available to the report.

  • Do not show this dialog box in the future check box: You can disable the Template Dependency Validator by selecting this check box. It will no longer display when a template is modified or saved.

If you disable the Template Dependency Validator but then find that you need to see it, you can enable it using the Display Template Dependency Validator option in Developer Preferences. For information on how to enable it, see Enabling the Template Dependency Validator below.

Accessing the Template Dependency Validator

The Template Dependency Validator opens automatically when a template is saved or when a shortcut template is modified inside a report. You cannot open it manually.

Enabling the Template Dependency Validator

If you have disabled the Template Dependency Validator but want to see it again, enable it by following the directions below:

  1. In MicroStrategy Developer, select Developer Preferences from the Tools menu. The MicroStrategy Developer Preferences dialog box opens.

  2. Expand the Optional Actions category. The General subcategory opens automatically.

  3. Select the Display Template Dependency Validator check box.

  4. Click OK to return to MicroStrategy Developer.

Related Topics