Generate a calculation data trail report (preview)

Important

Some or all of this functionality is available as part of a preview release. The content and the functionality are subject to change. Preview features aren't intended for production use and might have restricted functionality. These features are subject to supplemental terms of use, and are available before an official release so that customers can get early access and provide feedback.

Microsoft Sustainability Manager provides a calculation data trail for all calculation profiles to help with effective decision-making and to ensure compliance with sustainability goals. You can gain insights into your data's progression and export those insights into a detailed report, making it easier to track your data's history and monitor user changes.

This article walks you through enabling the data trail on a calculation profile, running that profile, and generating a downloadable CSV report from Reporting.

What the calculation data trail report includes

The calculation data trail report captures snapshots of essential data used in a particular calculation. The report includes:

  • All input sources
  • Calculation models and profiles
  • Emissions outputs
  • Greenhouse gases
  • Emission factors
  • Factor mappings

Prerequisites

An environment variable controls the data trail feature. Before the Data trail (preview) toggle appears on your calculation profiles, an administrator must enable the feature for your environment:

  1. In the Power Apps maker portal, select your environment.
  2. Go to Settings > Setting definitions and locate the Show data trail setting.
  3. Add an environment variable that overrides the setting value to enable it.

After the feature is enabled for the environment, a data trail status is shown for your calculation profiles, and the Data trail (preview) toggle becomes available in the calculation profile edit experience.

Before you generate the report

You must turn on the Data trail toggle on a calculation profile before you run that profile. If you run the calculation profile without turning on the toggle first, the data trail isn't captured for that run. Turn on the toggle, and then run the profile, as described in the following steps.

Enable data trail on a calculation profile

  1. In the left navigation pane, under Calculations, select Profiles.

    Screenshot of the Profiles option within the Calculations section in the left navigation pane.

  2. Select a calculation profile and edit it. You can also create a new calculation profile.

  3. On the last page of the calculation profile, turn on the Data trail (preview) toggle.

    Screenshot of the Data trail toggle enabled on the last page of the calculation profile edit experience.

  4. A confirmation dialog explains how data trail snapshots are captured. Review the information and confirm to give your consent and enable the feature for the profile.

This experience is the same whether you're creating a new calculation profile or editing an existing one.

Note

To turn off data trail for a profile, disable the same toggle. A dialog explains the effect of disabling the feature before you confirm.

Run the calculation profile

After turning on the Data trail (preview) toggle, run the calculation profile. The data trail is captured as part of this calculation run. Wait for the calculation run to finish before you generate the report.

Important

Regenerate the calculation data trail report if the underlying data changes or if new calculation job runs change the output.

Generate the report

  1. In the left navigation pane, select Reporting.

  2. On the top menu, select New.

  3. In the Report type dropdown, select Calculation data trail, and then select the language for the report.

  4. Enter a Report name and select the Calculation profile that you ran in the previous step, and then generate the report.

    Screenshot of the new report form showing the Report name and Calculation profile fields for a calculation data trail report.

  5. When the report is ready, the Active reports page displays its status.

    Screenshot of the Active reports page showing the status of a calculation data trail report.

Download the report

  1. On the Active reports page, select the report.

  2. Select Download report.

    Screenshot of the Download report option used to export the calculation data trail report as a CSV file.

This action generates a CSV file that contains all the attributes defined in the data trail report.

Compare calculation runs

The first column of the report is the calculation job ID, which uniquely identifies each calculation run. Use this ID to compare two consecutive runs for the same calculation profile and identify what changed in the underlying data between them. Comparing runs this way is currently a manual step.

Troubleshooting

No qualified calculation job for the selected profile: If you generate a report for a calculation profile that has no qualified calculation run, the report isn't produced and a detailed error message is shown instead of a blank report. This error typically happens when you don't enable the Data trail (preview) toggle before running the calculation profile. To resolve the error, enable the toggle on the calculation profile, run the profile again, and then regenerate the report.

View report versions

Every time you regenerate an existing data trail report, Sustainability Manager creates a new report version. To view all versions of a report, open the report and select the Report version tab.

Screenshot of the Report version tab showing the list of versions for a data trail report.

Note

You can view report versions on the Report version tab, but you can't edit the contents of a report version.

Edit report attributes

To edit data trail report attributes, open the report and select the Report settings tab. You can only edit report attributes on the Report settings tab.

Screenshot of the Report settings tab where data trail report attributes can be edited.

  • Last updated on