Viewing and Troubleshooting Finished Reports

Whether you scheduled a time for a report to run, or you just clicked the Run button, you will find your generated report(s) stored in the Output folder specified in your Schedule. This might be in your Sharepoint or our Files system.

To view a generated report for a Schedule which uses File protocol:

Click Files.
Navigate to the output folder for your Schedule.
Open or download the required docx, pdf, html or xlsx file.

If you have used an SFTP Connection in the Files area to store your output files, you can access them via the Files browser, or use your own SFTP client.

There are various levels of detail available to you about reports that have run, that will allow you to troubleshoot any issues. You can also view the raw data from graphs.

Viewing information about the most recent run of a schedule

To see how long a report took to run, how long each macro took to run, and a visualisation of whether each macro completed successfully, or with a warning or error:

Click Schedules.
Next to the relevant schedule, click the last result button, for example.
View the information on timings for the Report Batch Job, Report Job(s) and macros.
Hover over a macro icon to see a popup of how long that macro took to run.
Click on an individual icon for more information about the macro.
Click on the hyperlink to paste the macro into Report Studio.

Viewing historical information on runs of a schedule

Information on previous runs of scheduled reports is kept for the length of time specified by the data ageing global setting, with aged-out data being deleted. To view information about previous runs:

Click Schedules and click the Results button next to the relevant schedule. (Or you can click Show Results button on the Progress page for a report.)
Information is displayed for each time the report was run, including whether report generation was successful or failed, and a message describing any problems. For example:
Click the button to drill down further into a particular run of a schedule.
This details the number of successful and errored macros and the time taken to generate the report.
Again, click Results next to one of the rows shown to get information about each macro, whether it was substituted and what the output was.
Finally, you can click to view the same information per macro in a different form, together with an Id number.

Troubleshooting individual macros

When there have been problems with a report running, it is best to start with the first problematic macro in the template (the one nearest the top of the file) and work forwards from there. Problematic macros will be shown on the Progress page as yellow, orange or red.

For example:

Yellow macros are warnings only and the output will not be affected. However, you should still investigate these to ensure that the macro is having the desired effect and that you are not using any deprecated macros that may not work in future. If you are still unable to determine the issue, use the Feedback button to get support.

Viewing the raw data from graphs

If you want to view the raw data from your graphs in a spreadsheet:

Click Schedules.
Click Edit Schedule button for the required schedule.
Ensure that you have selected the xlsx check box to save the report as that format.
Ensure that you have set one of the following in the report template:
[Settings:graph.writeToSpreadsheet=true]
or
Each relevant graph macro has writeToSpreadsheet=true in its definition

Viewing and Troubleshooting Finished Reports

Viewing information about the most recent run of a schedule

Viewing historical information on runs of a schedule

Troubleshooting individual macros

Viewing the raw data from graphs

Search