Submit a ticketCall us

Looking to compare latest NPM features with previous versions of NPM?
The NPM new feature summary offers a comparison of new features and improvements offered with this release.

 

Home > Success Center > Log & Event Manager (LEM) > SolarWinds LEM 6.3 User Guide > LEM Reports > Running and scheduling reports

Running and scheduling reports

Updated March 11th, 2016

 

This section explains how to run reports. You can run reports two different ways:

  • On-demand reports are those reports that you run only when you need them.
  • Scheduled Reports are reports that you configure to automatically run on their own, on a particular schedule, and without intervention.

All Reports are scheduled and run in the same manner. The following procedures explain the methods for running on-demand reports and scheduled reports.

Reports can take quite a bit of time to run. The larger the report, the longer it takes to run. For that reason, it is recommended you schedule any reports you intend to run frequently.

Running Reports on Demand

  1. Open Reports.
  2. On the Settings tab, in the Preferences group, click the Data Source list and then select the Manager that is to be the data source for the report. This step is only needed if you are selecting a data source that is different from the Primary (default) Data Source.

                

  1. In the Report Categories group, click the Category list and select the report category you want to work with.

    The report list displays all of the reports in the category you have selected.

  2. In the report list, locate the report you want to run. Then do any of the following:

    Depending on the report you selected, you may be prompted to enter certain report parameters, such as a start date/time, an end date/time, and a range. In this case, the Enter Parameter Values form appears.

    • Double-click the report.
    • Right-click the report and then click Run Report.
    • Click to select the report. Then on the Settings tab, in the Report Selection group, click Run.
    • Click to select the report. Then on the Quick Access Toolbar, click the Run button.

  3. To complete the Enter Parameter Values form, select an item in the Parameter Fields box. Then, in the lower half of the form, type or select the appropriate value for that parameter. The following table explains how to complete each parameter field.

    Parameter field Description

    Start Date/Time

    Type or select the report’s start date and time. The time is optional. Click the Now button to populate these fields with the current date and time.

    End Date/Time

    Type or select the report’s ending date and time. The time is optional. Click the Now button to populate these fields with the current date and time.

    Top N

    Type the number of items you want reported, such as the “top 5” or the “top 10.”

  4. Click OK. The report appears in the Preview pane and the Ribbon changes to the View tab. You can use the View tab to print, export, view, resize, and search the various pages of the report.

Report Errors 

If you receive the following error, it is possible that your database server for your data warehouse or your SolarWinds appliance is offline, or that you need to run the restrictreports CMC command.

  1. First, check to make sure that your servers are online.
  2. Then check your restrictreports settings.

If you receive any other errors, or if you are uncertain about how to properly perform these procedures, please refer to the SolarWinds Knowledgebase or contact SolarWinds Technical Support.

Scheduling Reports (process overview)

Scheduling a report requires several steps. But once you configure a report schedule, SolarWinds does the rest. You can create more than one schedule for the same report. This allows you to run the same report on different Managers, and to run the same report in different intervals (daily, weekly, monthly, etc.), each with a different scope.

Scheduling a report is basically a seven-step process:

  1. First, select the report you want to schedule and then click Schedule.
  2. Name the scheduled task. You need to name the scheduled task to distinguish it from other similar tasks. For example, the same scheduled report needs to be configured separately for each data source (Manager). Therefore, you will name each task to readily distinguish between the scheduled tasks for each data source.
  3. Set the schedule parameters. This states when the scheduled report is to run.
  4. Apply any advanced scheduling options, if desired.
  5. Select settings that define when the SolarWinds system can and cannot run the task.
  6. Apply the scheduled report to the data source (Manager) for which you want a report. Then define the scope, which is the period you want to the report to cover. When the system runs the report, it retrieves any pertinent events that occurred within the period defined by the scope.
  7. Finally, select any export options for the report. This allows you to export to the folder of your choice, and in a format that is easy to read and print. If you do not export the report, it will automatically print to your default printer.

Each step of this process is fully explained in the following numbered topics. You must repeat this process for each report you want to schedule.

Step 1: Selecting the report you want to schedule

In this step, you will select the report you want to schedule, then open the Report Scheduler Tasks window.

To begin scheduling:

  1. Open Reports.
  2. On the Settings tab, in the Report Categories group, click the Category list and select the report category you want to work with.

    The report list displays all of the reports in the category you have selected.

  3. In the Report Title column, locate the report you want to schedule. Then do any one of the following:
    • Click the report and then click the Schedule button.
    • Right-click the report and then select Schedule Report.
    • Click the report you want to schedule. Then on the Menu Button menu, select Schedule Report.

    The Report Scheduler Tasks window appears. Use this window to add, edit, and delete your scheduled report tasks.

    Note that the Event Summary box shows only the tasks that apply to the report you selected in Step 3.

Step 2: Adding a new scheduled report task

Here, you will name and configure the new scheduled task that is associated with this report.

To create a scheduled task:

  1. To add a new report schedule, click the Add button.

    The Enter Scheduler Task Description form appears.

  2. In the Task Description box, type a name for the report, then click OK.

    At this point, the task scheduler form appears. The form takes the name of the report to indicate which report you are scheduling.

  3. Complete the Task tab as described in the following table.

    Field Description

    Run

    Normally, you will not change the default setting. But if you do, use this box to type the path to the argument that initiates the task settings for this report. If needed, click the Browse button to locate the correct folder and file.

    Start in

    Normally, you will not change the default setting. But if you do, use this box to type the path to the Reports executable file (.exe).

    Comments

    Type a description of the report schedule you are configuring, such as “Monthly SolarWinds Event Summary Graphs.”

    Run as

    By default, this box displays the current user. To change the user, type the domain and user name as follows: [Domain]\[UserName].

    Then click the Set password button to set up a password for the current user to run the report. This step is required for the scheduler to work properly.

    Enabled (scheduled task runs at specified time)

    Select this check box to run the scheduled task to the schedule you will specify in the Schedule tab. If you clear this check box, the report will not run on that schedule.

  4. Click Apply to save your changes to the tab.

Step 3: Scheduling the Report

Now you will create the actual report schedule. The settings on the Schedule tab tell the system when to run the report.

If needed, you can create multiple schedules for each report that are within the same scope. For example, perhaps you would like to run an event summary report for the current week and have it display the running total for the week at each hour. You could set the report to “Week: Current” and have multiple schedules that run on an hourly schedule and on a twice-daily schedule.

To schedule a report:

  1. Click the Schedule tab. For new tasks, the tab states that the task is not scheduled.
  2. Click the New button to create a new schedule for the report.

    The schedule shown above appears by default. You will create a new schedule by modifying this default schedule with the various boxes in the Schedule tab.

  3. Complete the Schedule tab as described in the following table.

    Field Description

    Schedule Task

    Select how often the system is to run the report—daily, weekly, etc.

    Start time

    Type or select the time the system is to run the report.

    For more detailed scheduling, click the Advanced button.

    Every

    Type or select how often you want to run the task based on your selection in the Schedule Task box above. For example, for a daily report, you can run the report every day, every 2 days, every 3 days, etc. For a weekly report, you can run the report every week, every 2 weeks, etc.

    Show multiple schedules

    Select this check box if you will have more than one schedule for this task, where each schedule has the same scope.

    If you are going to create more than one schedule with different scopes, then you will need to create a different task for each schedule.

    If the report is to have only one schedule, then clear this check box.

  4. Click Apply to save your changes.

    The new report schedule appears in the list box near the top of the tab.

  5. If desired, repeat Steps 2 – 4 to set up each new schedule for this task.

Step 4: Selecting Advanced Scheduling Options

If you clicked the Schedule tab’s Advanced button, then the Advanced Schedule Options form appears (shown here). This form provides you with complete control over your report schedules. For example, you can schedule start and end dates for the report, or set a task to repeat for a set period of time.

To select advanced scheduling options:

  1. Click the Advanced button on the Schedule tab.

    The Advanced Schedule Options form appears.

  2. Complete the Advanced Schedule Options form as described in the following table.

    Field Description

    Start Date

    Type or select the date you want the system to begin running the report.

    End Date

    Select this check box if there is a date on which you want the system to stop running the report. Then type or select the end date.

    If there is no end date, then leave this check box blank.

    Repeat task

    Select this check box if you want the system to repeat running the scheduled report at regular intervals.

    Every

    Type or select the interval. In the example shown above, this task will run every 4 hours.

    Time

    Type or select the time you want the system to stop running the repeated task.

    Duration

    Type or select how long you want the task to run. By limiting the time the task can run, you can prevent the task from running forever, should a problem occur. Reports can be very time consuming; therefore, use this configuration option with caution.

    If the task is still running, stop it at this time.

    Select this check box to have the system stop running a report that is running when the Time or Duration setting occurs.

    Keep the check box clear to have the system finish running a report that overlaps the Time or Duration setting.

    Note: The following image displays the valid and invalid date formats for reports.

    In the example shown above, the configured report will run every four hours, starting on Monday, August 18, and running through Sunday, August 30. Each time the task runs, the system will stop it if it continues to run for more than one hour.

  3. Click OK to save your changes and exit the form; otherwise, click Cancel.

    You return to the task scheduler form.

Step 5: Stating when the system can or cannot run the task

In this topic, you will use the Settings tab to select options that state when the system can and cannot run the task.

To define when the system can or cannot run the task:

  1. Click the Settings tab to fine tune the options for this task.

  2. Complete the Settings tab as described in the following table.

    Field Description

    Scheduled Task Completed

    Select Delete the task if it is not scheduled to run again to have the system delete a task that has run its course. For example, you may want the system to delete a task that has a definite end date. Leave this check box clear to keep the task.

    Select Stop the task if it runs for [xxx] hour(s) [xxx] minute(s) to specify a maximum allowable time limit for the system to accomplish a task. Use the hour(s) and minute(s) boxes to specify a maximum allowable time. In the example shown, the system will stop the task if it exceeds 72 hours. If you leave this check box clear, then the system continues running the task until it is complete.

    Idle Time

    These options allow you to run tasks when the computer is idle.

    Select Only start the task if the computer has been idle for at least [xxx] minute(s) to begin running a task only if the computer is idle for the specified time. Use the minute(s) box to specify a minimum idle time. If you leave this check box clear, then the system will run the task when the computer is in use.

    In the If the computer has not been idle for that long, retry for up to [xxx] minute(s) box, use the minutes(s) box to specify how often you want the system to check to see if the computer has reached its minimum idle time requirement for beginning the task.

    Select Stop the task if the computer ceases to be idle to have the system stop running a task when the computer is once again in use. If you leave this check box clear, then the system will continue running the task until it is complete.

    Power Management

    Select Don’t start the task if the computer is running on batteries to prevent the system from running the task when the computer is running with a battery as its power source. If you leave this check box clear, then the system will run the task even when the computer is on batteries.

    Select Stop the task if battery mode begins to have the system stop the task when the computer switches to a battery as its power source. If you leave this check box clear, then the system will continue running the report even when the computer switches to battery power.

    Select Wake the computer to run this task to have the system run the computer at normal power to run the scheduled report task. If you leave this check box clear (not checked), then the report will not run until the next scheduled time after the computer is removed from “sleep.”

  3. Click Apply to save your changes.
  4. Click OK to close the task scheduler form and return to the Report Scheduler Tasks window.

Step 6: Assigning the data source and scope

Once you have added your scheduled report tasks, you can assign the task to a particular data source (a Manager) and define the task’s scope. The scope is the event period you want the report to cover. When the system runs the report, it retrieves any pertinent events (that the report covers) that occurred within the period defined by the scope.

To assign the task’s data source:

  1. In to the Report Scheduler Tasks window’s Task Description list, select the report schedule you want to assign.

  2. Click the Load to View or Edit button.

    The window’s Report Execution Settings For Selected Task section becomes enabled. You will use this section to configure the report execution settings for the task (report schedule) you selected above.

  3. Use the Select the report data source list to select the Manager or to which you want to assign this task.

    Note: You can only assign a task to a single Manager. If you need to assign a similar or identical task to another Manager, then you must create a new task for that other Manager.

To assign the task’s scope:

In the Report Scope area, you will set up the task’s scope for this data source. The scope is the event period, or time frame, for the events you want the report to cover.

  1. In the Date Range list, select the date range you want the report to cover for this task and this data source.

    In the example shown above, the date range is Day: Today. This means the report will cover the period from 12:00:00 AM to 11:59:59 PM of the current date.

    For a more complex example, suppose you chose Week: Previous as the date range. The scheduled report would contain information from the last full week, from 12:00:00 AM the last Monday to 11:59:59 PM the last Sunday. For example, if today is Wednesday the 11th, the task runs from 12:00:00 AM on the 2nd to 11:59:59 PM on the 8th.

    The following table describes each option in the Date Range list.

    Date range Description

    Day: Today

    Run for the specified timeframe on the current (today’s) date.

    Day: Yesterday

    Run for the specified timeframe on the previous (yesterday’s) date.

    Week: Current

    Run from one week ago to the current time.

    Week: Previous

    Run from 12:00:00 AM last Monday to at most 11:59:59 Sunday. This report will capture the last full week of data.

    Month: Current

    Run from one month ago to the current time.

    Month: Previous

    Run from 12:00:00 AM on the first of the month until 11:59:59 PM on the last day of the month. This will report will capture the last full month of data.

    User Defined

    Use this option to run any other report scopes. You can use this option to schedule reports for arbitrary periods, or for periods that are outside of the conventional scope of a day, week, or month.

  2. In the Start Time and End Time boxes, type or select a start time and end time for reporting events that occurred on this Manager. The report will only show those events that occurred on the Manager within this period.

    Note: If you select a Week or a Month scope, you cannot edit the Start Date/Time and End Date/Time.

  3. The Count Settings area only applies to count-based reports, such as “Top 20” reports. In the Number of Items box, type or select the number of items you want the report to track.
  4. To configure the report so that it automatically exports to a file, continue to Running and Scheduling Reports below. Otherwise, click Save.

Step 7: Exporting a scheduled report

Finally, you can have the report utility automatically export a scheduled report in Adobe’s Portable Document Format (.PDF) to the folder of your choice. If you do not choose to export a scheduled report, then the system will print the report to your default printer each time it runs.

To export a scheduled report to a file:

  1. Open the Report Scheduler Tasks window, if you have not already done so.
  2. In the Task Description box, select the scheduled report task you want to export.
  3. On the Report Settings tab, select the Export check box. This enables the other fields in this section. This section allows you to name and export this report in the format and folder of your choice when the task scheduler runs this report.

  4. In the Format list, select the file format in which you want to export the report.
  5. Click the folder icon next to the File Name box. Browse to the folder where you want to save the report, then type a unique file name for the report.

    If the report has multiple schedules, then give each schedule’s exported report a different name. Otherwise, the exported filenames files will overwrite each other, or they will increment according to the If File Exists setting, causing it to be difficult to readily identify the different schedules’ reports.

  6. In the If File Exists list, choose one of the following options:
    • Select Increment to store the new report along with any previous versions of the report in the folder. The Report Console increments each report by appending the report filename with an underscore and a digit. For example, the first increment is [FileName]_1.pdf, the second is [FileName]_2.pdf, and so on.
    • Select Overwrite to have each new version of the report overwrite the previous version of the report in the folder.
  7. Click Save.
  8. Click Close to close the Report Scheduler Tasks window and return to the Reports window.
  9. Repeat sections Running and Scheduling Reports through Running and Scheduling Reports for each report you want to schedule and assign to a particular data source.
Last modified
13:16, 9 Feb 2017

Tags

Classifications

Public