The Run Report wizard guides you through running either a standard report or a custom report.
Available via REPORTS > Run Report.
Before you start the wizard, you must do or have the following:
- To run a report in general, you need the Run Report privilege.
- To run a report immediately or with default values, you additionally need the View Task and the View Report File privileges.
Select Report
On this page you can select the report you want to run.
- Select a report in the list.
Do one of the following:
- Click RUN WITH DEFAULTS to run the report automatically with default settings (see Run Report wizard – Default settings). The subsequent wizard pages are not displayed and you are redirected directly to the Summary page (see Summary).
- Click NEXT if you want to configure the report before creating it.
Settings
The Report Settings page allows you to define various settings for the report.
- Select the report template via Template to use, either HTML, XML, PDF, CSV (list reports only), or one of the custom templates (if available).
- Select the output time zone, which will be used for all date and time records in the report.
Select the time period.
- If you select Last, enter a number and select a unit of time from the drop-down list. The report will contain data between the exact moment you run the report and the moment minus the interval you specified. For example, if you run a report on December 31 at 09:00 with Last 2 Days specified, the report will contain data from 09:00, December 29, to 09:00, December 31.
- If you select For the following period, enter the start and end dates and times that you want the report to cover.
- The start date and time of a report are inclusive. The end date and time are exclusive.
The Time Period field is available only if the query definition for this report does not contain an Audit:Timestamp condition.
- Click NEXT to continue.
Runtime Queries
The Runtime Queries page allows you to define a query for this run of the report only. Both, the run-time query and the queries defined with the report will be used. For more information about query rules, see Report query commands and rules.
On this page you can select one of the following:
- No runtime query required. Select this option to use only the query defined in the report.
Define new runtime query. Select this option to define a new run-time query from the options available.
Create a run-time query by doing the following:
- Click ADD NEW.
- Select the field that you want to enter from the drop down list.
- Select the condition from the drop down list.
- Enter the value, e.g. Serial Number Equals 390000.
- To add another filter, click ADD NEW.
- To remove a filter, click REMOVE.
Click NEXT to continue.
Schedule Task
Enter details to run or schedule this task.
| Field name | Description |
|---|---|
| Run immediately | Runs the task now. This will lock the Administration Web Interface session. You will not be able to perform other operations until the task has finished. |
| Run in background | Runs the task in the background without locking the Administration Web Interface session. You will be able to perform other operations in the Administration Web Interface. It will also allow you to schedule and run the task at a later time. |
| Notify me of completion by | Specifies whether and how to send notifications when completing the task. Possible values:
|
| Attach Report to notification | Attaches a copy of the report to the notification. This option is only available, if Notify me of completion by is set to Email. |
| Scheduled | Select No to run the task immediately in background, or Yes to schedule the task to run at a later time. |
| Hour | The time for the task to be run in the 24-hour time format. Note that this is the server-based time. The format should be hh:mm:ss. |
| Date | The date for the task to be run. Note that this is the server-based date. The format should be YYYY-MM-DD. |
| Recurrence Type | Specifies whether the task should be run recurrently. Possible values:
|
Click NEXT to continue.
Summary
This page shows the result of the report.
If you selected Run immediately in the Schedule Task page, you can open the report now. If the report has been generated successfully and does not exceed the configured open in browser size limit, click OPEN REPORT to display the results in a new window. Otherwise, click DOWNLOAD REPORT to download it to disk. We recommend to download reports, especially large ones, instead of opening them directly from the Administration Web Interface.
If you selected Run in background in the Schedule Task page, you can retrieve the report once completed via REPORTS > Retrieve report.
If the report has not been generated successfully, click Click here to see a list of errors to see the errors generated for this report.