How did your report run?

Execution occurs in a "Report Batch Job" with the batch containing one or more "Report Jobs". The run time for a batch depends on report complexity and system load. Some Batches finish in seconds, but complex reports may take hours. If a scheduled report fails, see which macro(s) are responsible by viewing the report's Progress Page. This gives error and duration information about a report that has run:

1. Click Schedules
2. Select a Schedule and then click:
• Latest Progress button to view the Progress page for the last run
• Batch Jobs to see previous runs and information about the success and timing of the run, and then for a required Batch Job, click View Progress to see the Progress page for that run.
3. As you would with a still-running report, you can click each macro to view further information.

When Macros Fail

Macros are coloured as follows:

• Warnings are shown in yellow
• Macro errors are shown in red
• System errors are shown in dark red
• Deferred macros - such as [EndEmail:] and [EmailReport:] macros, which are processed at the end of the report, are shown in grey until they are finally processed
• Still-running macros are shown in blue

If you see a failed macro:

1. Click the macro and see the problem in the Macro Details pane as below.

2. Click Copy to copy the macro to Report Studio to work on and replicate the problem.

Viewing Emailed Output

If you are an Administrator, you can check the Notifications page to see what has been emailed out from ReportMagic including success or failure status, recipients, whether there was an attachment and its size, the subject and text of the email, duration taken for the email to be sent and more. You can also download the attachments from the Notification page by clicking on the View button to view the email and details.

To choose which columns are displayed, click the Columns button and select the required columns.

To view the actual email content, click to select a row then click the View button or double-click a row.

Re-Running Report Jobs

The Re-Run feature allows you to re-execute one or more Report Jobs that have already completed. This is useful when you need to regenerate reports with different settings, or when a previous run encountered issues that have since been resolved.

Note: the feature is only available in the 4.1 release, and only using the 'new' ReportMagic app (report.magicsuite.net), rather than docs.magicsuite.net.

How to Re-Run Report Jobs

1. Navigate to the Progress Page for any Batch Job.
2. Select one or more completed Report Jobs from the table by clicking the checkboxes. Only Report Jobs that are not Running or Pending can be selected.
3. The Batch Progress section contains a Re-Run Pop-up button and an adjacent drop-down with options (All Selected, All Failed..., etc.). Choose the desired option
4. Click the button to open the re-run dialog.
5. Configure your re-run options in the dialog (or use the defaults).
6. Review your selections on the Review screen.
7. Click Submit to start the re-run.
8. Once created, click View Progress to monitor the new Batch Job (or use CTRL + click) to open that in a new browser tab.

Re-Run Options

Reporting Period

By default, the re-run uses the same reporting period as the original Report Jobs. You can override this to select a different calendar month.

• The reporting period defaults to the month before the original Batch Job ran.
• You can select any month from the last 12 months, except the current month.
• The reporting period primarily affects the monthly output sub-folder (e.g., Output/2025-01) if configured on the Schedule.
• Report content is typically controlled by macros in your input documents, which may override dates.

Output Document Formats

By default, the re-run produces the same output formats as the original Report Jobs. You can override this to enable or disable specific formats.

• Available formats: Word (DOCX), PDF, HTML, Excel (XLSX), and PowerPoint (PPTX).
• PowerPoint output is always produced if the input document is a PowerPoint template, regardless of this setting - the PowerPoint checkbox is therefore always checked and cannot be changed.
• You can disable all formats if you only want to test macros without generating output files (except for PowerPoint files, which are always produced).

Folder Paths (Admins Only)

Administrators can override the input folder used for the re-run.

• The default input folder is the one currently set on the Schedule.
• You can change this to any existing folder in your Tenant's file system, except the root folder.
• Use the validation button to verify the folder exists before submitting.
• If the Schedule's input folder is inside the Report Library, the folder path cannot be changed.

Additional Variables (Admins Only)

Administrators can inject additional variables that will be available to macros during the re-run.

• Variables must be entered as valid JSON, e.g., { "MyVar1": "Value", "MyVar2": 123, "MyVar3": true }
• These variables are added at the start of processing for every Report Job in the re-run.
• Variables from the original Report Jobs (from batch variables or forms) are preserved in the re-run.
• The reserved variables BatchIndex, BatchSize, and BatchVariable cannot be overridden as they are calculated dynamically.

When Can You Re-Run?

You can re-run Report Jobs at any time, even while the parent Batch Job is still running. The only requirement is that the individual Report Jobs you want to re-run must have completed (i.e., they are not Running or Pending).

Example: If a Batch Job has 10 Report Jobs, and 5 have completed while 5 are still running, you can immediately re-run any of the 5 completed Report Jobs without waiting for the entire Batch Job to finish.

Limitations

• Running or Pending Report Jobs: You cannot re-run Report Jobs that are still Running or Pending. The checkboxes for these Report Jobs are disabled in the table. Wait for them to complete first.
• Output Folder: The output folder cannot be changed. Re-runs always use the Schedule's configured output folder.
• Month Selection: You can only select complete calendar months from the past 12 months. Custom date ranges are not supported.
• Re-Running a Re-Run: You can re-run a Report Job that was itself a re-run. However, any additional variables you specified in the first re-run will not automatically carry over. You must specify them again if needed. The original variables from the initial run are always preserved.
• Library Folders: If the Schedule's input folder is inside the Report Library, the folder path cannot be changed, even by administrators.

Permissions

• All Users: Can change the reporting period and output document formats.
• Administrators Only: Can change folder paths and add additional variables.

Tips

• Re-Run During Execution: You don't need to wait for the entire Batch Job to complete. If some Report Jobs have finished and you notice they need to be re-run, you can do so immediately while other Report Jobs are still processing.
• Ctrl + Click: On the success screen, hold Ctrl and click "View Progress" to open the new Batch Job in a new browser tab. The dialog will then close, however you click.
• Validate Folders: When changing the input folder, click the validation button to ensure the folder exists before submitting. A folder picker may be added in future.
• Review Screen: Always check the Review screen before clicking Submit to confirm your selections are correct.
• Batch Selection: You can select multiple Report Jobs at once to re-run them all with the same options in a single new Batch Job.

Identifying Re-Run Report Jobs

Re-run Batch Jobs and Report Jobs are clearly marked in the system:

• The Batch Job name will be prefixed with "Re-run:"
• The Batch Jobs table includes an "Is Re-Run" column (sortable and filterable) that indicates if it was a re-run
• The Report Jobs table includes an "Is Re-Run" column (sortable and filterable) that indicates if it was a re-run
• The original Report Job's message is updated to reference the new re-run Report Job ID