Working with Reports

This guide walks through the everyday tasks on the Reports page: generating a report and publishing it, downloading it, and shaping what reports contain with templates, chapters and metrics. For how these things work and why, see Reports and Metrics; common questions are answered in the Reports FAQ.

Before You Start

• Generating and publishing a plant's reports is open to the job roles Operator, Technical Manager, Asset Manager and Viewer on that plant. Regenerate needs Operator, Technical Manager or Asset Manager; deleting a report needs Operator.
• A template with money chapters (revenue, compensation, settlement) additionally needs the accounting permission on the plant: Operator or Asset Manager.
• Templates, chapters and metrics are created and changed by an organization Admin; every other member uses them.
• Your organization role gives you a job role on the organization's plants — see Permission System.

Generate a Report

Open in Mirox: Reports ▸ Reports

1. Click Generate report at the top of the page. As a shortcut, click an ended month in the Data readiness calendar: the dialog opens with the template and the month filled in.
2. Pick the Plant. The dialog now offers only the templates that apply to this plant.
3. Pick the Report language. It starts at the language of your interface.
4. Choose the Period — month, quarter or year — and which one, then the Template.
5. Read the lines under your choice:
   • whether the period's data is final — if not yet, the report will be marked Preliminary (you can still generate it);
   • which chapters this plant will not get, and what they need.
6. Click Generate to build the report straight from the template, or Customize first to change the chapters of this one report in the editor before generating — the template stays as it is.

After a few seconds the report opens in the preview as a Draft.

Review and Publish

A draft is complete but not released. Publish it once you have checked it.

1. Open the draft: it opens by itself after generating; later, click its row in the list or Review & publish in the Downloads column.
2. Page through the preview.
3. To add your own words, click Edit in editor. The editor shows the report's pages as they print. There you can write a note on the cover, add a comment or text between blocks, add a footnote, rename a title, hide a block, or give this report its own header and footer. Numbers are computed and cannot be edited. Your changes are saved as you type; Pages shows the result paginated exactly like the PDF.
4. Click Publish and confirm. The report is frozen as it looks, and its downloads become available to everyone in your organization who may read this plant's reports. In the editor, Published now stands where the button was, until you change something. The list shows under the date in the Published column who published the report.

To update a published report later — after a late settlement, a revised market value, or once preliminary data is final — choose Regenerate in the row's menu or in the report's Details. The report goes back to draft; its last published version stays downloadable until you publish again. Your written text is kept.

Download a Report

1. In the list, use the buttons in the Downloads column: PDF, Word, Excel, CSV (a ZIP archive with one file per table) or JSON. The same buttons are in the preview and in the report's Details.
2. For every value behind the report at full resolution, use Full data export next to the downloads: choose the format and click Prepare; the file is ready to download after a moment.

Downloads always give the last published version, also while a newer draft waits. A report that was never published has neither downloads nor Full data export yet — publish it first.

Build a Template

Open in Mirox: Reports ▸ Templates

1. On the Templates tab, click New template — or Duplicate an existing one, such as the shipped Plant Overview, and change the copy.
2. The report editor opens with a preview plant and period, on pages that look like the printed report. Add chapters: take one From the chapter library, or write a new chapter right in the template.
3. In a chapter, add blocks: pick the data, then choose next to the live preview how it prints — as a table, a graph or a list. Add text blocks for your own paragraphs.
4. Drag chapters in the chapter list to reorder them; give a chapter its own title in this template if you like.
5. Check the chapter list: a chapter the preview plant does not get is struck through, with what it needs. Switch the preview plant to see how the template reads on other plants.
6. Click Save template, and give it a name and a description. Its plant types are shown read-only — they follow from the chapters. On a narrow screen, the template actions sit in the ⋯ menu next to the main button.

A template can have its own header and footer — see Edit header and footer. A report you customized can become a template too: in the report editor, Save as template turns the chapters on screen into a new template.

Edit Header and Footer

The header and footer print on every page but the cover, in the PDF and in the Word file. Set them on a template for every report generated from it, or on one report only. How they work: Header and footer.

1. Open the pages:
   • for a template, open it from the Templates tab — changing a template needs the organization role Admin;
   • for one report, open the report and click Edit in editor.
2. Point at the header or the footer of any page and click it (Edit header / Edit footer). Its settings open next to it. The badge at the top says whose it is now: Platform default, From the template or This report’s own.
3. Type into the places — Left, Centre and Right in the header; Left, Right and Second line, centred in the footer. A place marked default shows the platform text until you type; the arrow next to a place brings the default back, and a place you empty prints nothing. The line under each place shows what it prints.
4. For a value that changes from report to report, put the cursor where it belongs and click a button under Insert at the cursor: Plant, Period, Template, Report title, Organization, Data as of, Year, Page number or Page count.
5. Set the switches if needed: Print the header or Print the footer, Logo at the right edge, Page numbers at the right end.
6. Click Done. The header and footer of every page already show the result.
7. Keep it:
   • in a template, click Save template — every report generated from it from now on prints this header and footer;
   • in a report, it is saved as you type and the template stays as it is. Publish the report so that its downloads carry the new header and footer.

To undo a report's own header and footer, open the settings again and click Use the template’s — or Back to the platform default when the template has none. In a template, Back to the platform default removes its own. A report's own header and footer can be set by everyone who may generate and publish the plant's reports; with Customize first, the header and footer you set go into the new report when you click Generate report.

Create a Chapter

A library chapter can be placed in any template, and a change to it shows in all of them.

1. On the Templates tab, under Chapter templates, click New chapter.
2. Give it a name, then add blocks: Pick data, and choose its form beside the preview.
3. Decide what happens when a plant cannot deliver the data (If unavailable): the report says the data is missing, or leaves the chapter out.
4. Watch Appears on: it shows the plant types the chapter needs as you add data. If the preview plant does not qualify, the sheet says "Not included for plant: needs …" — pick another plant to see the content.
5. Click Create chapter. It is now in the chapter library, and any template can add it.

To change a library chapter, click its row. To store a chapter you wrote inside a template in the library, use its badge in the report editor and choose Save as a new library chapter.

Create a Metric

Open in Mirox: Reports ▸ Metrics

1. On the Metrics tab, click New metric — or open a shipped Example and Duplicate it.
2. At the top, under Evaluate on, pick the plant to check the metric against. The check, yesterday's sample, the preview, the building blocks and the assistant all use this plant; the metric itself belongs to no plant.
3. Fill in the name, the id, the unit and the description, and write the expression — or describe the figure to the Assistant and let it write the expression with you. Every change is saved as you type.
4. Read the verdict. While the expression has a problem, the metric shows Not validated and cannot be used anywhere; fix what the editor lists.
5. Check Works on: the plant types the metric needs. A chapter that uses it only appears on those plants.
6. Click Run preview to see the values over a month, a quarter or a year.
7. Use it: in a chapter's data picker your metric appears as my metric.

Restore a Version

Templates and library chapters keep a history of their versions. Everyone in the organization can read it; restoring needs the organization role Admin.

1. Open the Version history: on the Templates tab, open the menu of the template's row — or of the chapter's row under Chapter templates — and choose Version history. In the report editor or the chapter editor, click History in the header.
2. Read the list, newest first: each version shows its number, the date, who saved it and what changed. Current marks the version in use.
3. Click a version to open it. You see its chapters or blocks as they were; a library chapter shows which of its versions it had then and whether a restore places its current content or brings this copy back as the template's own chapter. All versions takes you back to the list.
4. Click Restore version 3 and confirm with Restore. If data the version reads no longer exists, the dialog names it first: Restore without them leaves it out, Cancel changes nothing.
5. A note above the list confirms the new version number and names anything Mirox had to adjust — a name that was kept, a chapter that came back as the template's own, data that was left out.

The restore adds a new version; nothing is lost, and you can go back the same way. Restoring in an editor replaces what is on screen, so save your changes first. Restoring a library chapter changes every template that places it. Reports already generated keep their own chapters; the ones made from an older version show Out of date, and What changed in the template in their Details opens this history. A shipped template or chapter cannot be restored — Duplicate to edit gives you a copy to work on.

See Who Did What

• Who published a report, and who generated it: in the list, under the date in the Published column; in the report's Details (Published, Last generated, Draft last edited); and in the line under the description in the preview.
• Everything that happened to a plant's reports — generated, regenerated, published, deleted, exported: open the plant's Core Data page and its Activity tab, or the Activity page for all your plants, and filter by the category Report.
• Every change to templates, chapters and metrics: Organization ▸ Activity. This tab is open to the organization roles Admin and Moderator.

What each entry records is described under Activity trail.

Clean Up

• Retire a template or chapter you no longer need: it stays, but is no longer offered; Activate brings it back.
• Delete is only possible while nothing depends on it. The dialog lists what still does — the reports made from a template, or the templates and chapters that use a chapter or a metric — each with a link to open it. Remove the use first, then delete.

Related Pages

• Reports — templates, plant types, drafts, readiness, versions, header and footer, downloads, languages and the activity trail
• Metrics — defining your organization's own figures
• Reports FAQ — common questions
• Permission System — roles and job roles
• Activity & Audit Trail — who did what, and when