Skip to main content

How do I add Commentary to Reports?

Use the Calxa Report Publisher to add commentary and other notes to your reports.

Written by Shem Bogusz

Create professional management report packs with the Calxa Report Publisher. Annotate your reports and add notes using footnotes, inline notes and custom text boxes to provide context, explain results and deliver more meaningful insights.

In short: run your bundle, click COMMENT AND PUBLISH and save it as a draft, add notes columns or text boxes in the Publisher, write your commentary, then review and publish the report package.

Looking for comments in the Budget screen instead? See the Budget Comments article.

Prerequisites

To get started with the Report Publisher, you'll first need to create a Report Bundle. A bundle defines the reports, dashboards and other documents that will be included in your published report package.

Refer to the Report Bundle help article to learn more.

How to add commentary to reports

Step 1: Save a Bundle as a Draft

Once you're happy with your Report Bundle and the underlying report data, publish it as a Draft. This creates a working copy in the Report Publisher, where you can add commentary, footnotes and other annotations.

Each reporting period, simply publish a new draft from the same Report Bundle. You can then choose to import notes and commentary from previously published reports from that bundle, making it easier to update recurring management reports.

💬 Updating a recurring report? When you choose Save as Draft, tick Import notes from previously published bundle and select the version you want to import from. This brings forward commentary, footnotes and other notes from an earlier published version of the same bundle.

💬 Commentary can only be added while the package is a draft. Once a package is published it becomes an uneditable snapshot and can no longer be changed.

  1. To publish a bundle, go to the Bundles screen and run the bundle

    1. Review the bundle content and report data to ensure everything is accurate and complete before publishing

  2. After running the bundle, click COMMENT AND PUBLISH

  3. After clicking COMMENT AND PUBLISH, select Save as Draft

    1. (Optional) Tick Import notes from previously published bundle to bring forward commentary, footnotes and other notes from an earlier published version of the same bundle

      1. Select the version you want to import notes from

  4. To continue saving the draft, click NEXT STEP

  5. Enter a unique name and choose a target folder where it will be saved

  6. Click SAVE AS DRAFT

  7. The draft will open in the Publisher, where you can review reports, add commentary, insert footnotes and make other annotations before final publication

Step 2: Add notes columns or text boxes

If you've just published a bundle as a draft, the Publisher will automatically open in preview and edit mode. You can also open any previously saved draft from the Publisher folder navigation.

💬 Notes columns or text boxes provide the elements that you can interact with in the body of the report to add commentary and notes. Use Footnotes to add a reference number column, Inline Notes to add notes to a column within the report and Text Boxes for general commentary. For further details on the different note types, see Which note types are supported in the Publisher?

If you haven't already added these elements, follow these steps to add them to reports in your package:

  1. In the Publisher, use the navigation bar at the top of the screen to select individual reports within the package

  2. With the report open in the Publisher, click ADD NOTES

  3. After clicking ADD NOTES, choose a note type and click NEXT STEP. For details on note types, see Which note types are supported in the Publisher?

  4. Drag the new notes column or text box to the desired position in the report

    1. For footnotes and inline notes click INSERT COLUMN

    2. For text boxes click INSERT TEXT BOX

Step 3: Add or edit notes in columns or text boxes

Assuming that you have added notes columns or text boxes to the report, follow these steps to add commentary and notes to your report package:

💬 You can add commentary to most Calxa reports, but some reports are currently unsupported. See Which reports do not support comments? for further information.

  1. In the Publisher, click a supported note cell or text box then choose Add new note

  2. Enter your commentary, notes or observations, then click the green Enter button to apply your changes and refresh the report

  3. For more information about formatting notes, see How do I format text in the Note Editor?

  4. Repeat this process for all required reports and notes sections

  5. In the Publisher, to edit an existing note click on the note, reference or use the notes list in the notes editor

⚠️ Important: Due to Excel's text-formatting limitations, we recommend avoiding Tables if you plan to export your content to Excel. Although the text will be exported, the formatting will not be preserved as expected.

Step 4: Review and Publish

Once you've finished adding commentary, footnotes and other annotations, review the report package as a whole to ensure it is ready for distribution. When you're satisfied with the content and presentation, publish the package as a final report.

💬 After a report package has been published, it becomes a permanent snapshot and can no longer be edited. If further changes are required, a new draft must be created and published.

  1. When you have finished adding commentary, click REVIEW or use the dropdown to view the complete report package without editable controls or note markers

  2. Review the final presentation and click PUBLISH

💬 Refer to Publish your Reports help article to learn more.

Did this answer your question?