Managing Report Schedules


Report schedules can generate reports at the specified time every quarter, month, week, or day. Alternatively you can manually trigger schedules to generate reports. The flexible configuration capability of report schedules can meet the requirements of different user scenarios and improve the efficiency of report management. With Reporting Tool, you can manage report schedules in a unified list, including to view, enable/disable, edit, copy and delete schedules.

Prerequisites


  • You need to be assigned the required asset permission and operation permission, and a menu group containing the Schedules menu. If not assigned, contact the application administrator.
  • Reporting Tool controls if users are authorized to access and manage a template and its related schedules and subscriptions by assigning report template permissions, so you need to be assigned the required template permissions. If not assigned, contact the template creator. For more information, see Template Permission Control Rules.

Creating a Report Schedule


  1. Select Schedules from the left navigation pane.

  2. Click New Schedule and enter the following information:

    • Schedule Name: Enter up to 20 characters as the schedule name.

    • Related Template: Select the report template to be related from the drop-down list. The parameters of the template will be displayed in the Parameters section.

    • Language: Select a language from the drop-down list, which displays all languages of the related template.

    • Format: Select a report format from the drop-down list. The following formats are supported: HTML, Excel, Word, and PDF.

    • Generation Method: If Manual Trigger is selected, you can manually trigger a schedule on the Schedule Record page. If Scheduled is selected, the system will generate reports at the designated time.

    • Frequency: When Generation Method is set to Scheduled, select the frequency (Every Day, Every Week, Every Month, Every Quarter) and specific time for the reports to be generated. Note that for a quarterly schedule, reports will be generated in the first month of each quarter, and the specific date and time can be configured as required.

    • Parameters: The parameters come from the previously selected Related Template. Enter all parameter values ​​to decide the display data of generated reports.

    • Report Name: Enter the name of the generated reports. You can insert parameters of the related template in the name.

    • Email Notification: When this option is selected, the system will send the generated reports by email. You can customize email sender, content and internal/external recipients.

      Note

      After you select the Email Notification option, the system creates a subscription in the Subscriptions menu to save all the email configurations you have specified. The subscription name is “{scheduleName} subscription”. For example, if the current schedule name is “Demo”, the created subscription name is “Demo subscription”. To modify the subscription configurations, see Editing Report Subscriptions.

  3. Click Save.


After the schedule is created, the system will generate reports at the set time or after you manually trigger the schedule.

Viewing a Report Schedule


  1. Select Schedules from the left navigation pane. The schedule list displays all report schedules that you have access to.
  2. To locate a target schedule, select a specific schedule status, generation method, and creator in the filter box, or enter a specific schedule name in the search box.
  3. Click any field of the target schedule to open the Schedule Details page, which displays the following information.
    • Schedule Name: The name defined when the schedule is created.
    • Template: Click the template name to view template configurations on the Template Details page. For more information about template configurations, see Viewing Report Templates.
    • Language: The language defined when the schedule is created.
    • Format: The format defined when the schedule is created.
    • Frequency: The frequency defined when the schedule is created.
    • Parameters: The parameters defined when the schedule is created.
    • Report Name: The report name defined when the schedule is created.
    • Related Subscriptions: Click New Subscription to create a subscription and relate it to the schedule.
    • Changelog: View edit history for the schedule.

Enabling/Disabling a Report Schedule


  1. Select Schedules from the left navigation pane. The schedule list displays all report schedules that you have access to.
  2. To locate a target schedule, select a specific schedule status, generation method, and creator in the filter box, or enter a specific schedule name in the search box.
  3. Switch on or off the Enable toggle enable of the target schedule to enable or disable the schedule.

Editing a Report Schedule


  1. Select Schedules from the left navigation pane. The schedule list displays all report schedules that you have access to.
  2. To locate a target schedule, select a specific schedule status, generation method, and creator in the filter box, or enter a specific schedule name in the search box.
  3. Hover over the ellipsis icon more of the target schedule and select Edit to modify the schedule configurations. For more information about schedule configurations, see Creating Report Schedules.

Copying a Report Schedule


  1. Select Schedules from the left navigation pane. The schedule list displays all report schedules that you have access to.
  2. To locate a target schedule, select a specific schedule status, generation method, and creator in the filter box, or enter a specific schedule name in the search box.
  3. Hover over the ellipsis icon more of the target schedule and select Copy to duplicate the configurations of the target schedule to a new schedule. For more information about schedule configurations, see Creating Report Schedules.

Deleting a Report Schedule


  1. Select Schedules from the left navigation pane. The schedule list displays all report schedules that you have access to.

  2. To locate a target schedule, select a specific schedule status, generation method, and creator in the filter box, or enter a specific schedule name in the search box.

  3. Hover over the ellipsis icon more of the target schedule and select Delete. Deleted schedules cannot be restored.

    Note

    Before deletion, make sure the schedule is not related to any subscription.