Scheduling a report

Last Updated : Oct 29, 2024 |

About this task

When creating a report in the CMS Supervisor Web Client, you can configure scheduling. You can schedule a one-time report or run reports at regular intervals.

Procedure

  1. On the Reports tab, select the report you want to schedule.

    For example, click Graphical Information under Realtime > Agent.

  2. Complete the fields in the Inputs window and then click Schedule.

    The Schedule Report window is displayed.

  3. In the Job Name field, type a name for the job you are scheduling.
  4. Select one of the following Schedule Type options:
    • Once: To schedule a single, one-time report for a specific date and time.

    • Daily: To schedule a report at the same time every day or every few days. For example, you can configure the job to run every two days.

    • Weekly: To schedule a report on one or more days every week.

    • Monthly: To schedule a report on the months and days you specify. Select the month or months when you want to run reports, and specify the day. For example, you can schedule reports to be run on the last Friday in June, July, and August.

  5. If you set Schedule Type to Once, do the following:
    1. In the Date and Time fields, specify when the report will run.
    2. In the Retain results for field, type the number of days for which report results will be retained.
    3. When you finish scheduling the report, click Schedule to return to the Inputs window and then click OK.
  6. If you set Schedule Type to Daily, do the following:
    1. Under the First Run heading, complete the Date and Time fields to specify when the report will run for the first time.
    2. In the Run every field, type a number to specify how many days apart the report job will run.

      You can specify any number of days. For example, if you type 1, a report will run every day. If you type 3, it will run every 3 days.

    3. Under the Expire heading, specify an end date and time after which the report will no longer run.
    4. In the Retain results for field, type the number of days for which report results will be retained.
    5. When you finish scheduling the report, click Schedule to return to the Inputs window and then click OK.
  7. If you set Schedule Type to Weekly, do the following:
    1. Under the First Run heading, complete the Date and Time fields to specify when the report will run for the first time.
    2. Under the Run on heading, select one or more days of the week.

      For example, you can select the check boxes for Tuesday, Thursday, and Friday. The report jobs run every week on the specified days.

    3. Under the Expire heading, specify an end date and time after which the report will no longer run.
    4. In the Retain results for field, type the number of days for which report results will be retained.
    5. When you finish scheduling the report, click Schedule to return to the Inputs window and then click OK.
  8. If you set Schedule Type to Monthly, do the following:
    1. Under the First Run heading, complete the Date and Time fields to specify when the report will run for the first time.
    2. Under the Months heading, select one or more months.

      For example, you can select the check boxes for February, June, and September.

    3. Select one of the following options to specify when the report will be generated:
      • Select Days to select one or more dates. For example, select 2 and Last to run the report on the second and last days of the specified months.

      • Select On to specify which week and day to run the report. For example, you can run the report on the second Friday of the specified months.

    4. Under the Expire heading, specify an end date and time after which the report will no longer run.
    5. In the Retain results for field, type the number of days for which report results will be retained.
    6. When you finish scheduling the report, click Schedule to return to the Inputs window and then click OK.

Next Steps

After setting up scheduling, navigate to the Scheduler page to view and manage your scheduled jobs.