• Documentation
  • Quickstart: Generating and Subscribing to Reports based on a Custom Report Template

Quickstart: Generating and Subscribing to Reports based on a Custom Report Template


This page describes how to build a custom report template and create a report schedule and report subscription based on the template.


Prerequisites


  • Reporting Tool needs to be obtained, authorized, and enabled in the current OU. If not, contact the application creator.

  • You need to be assigned the required asset permission and operation permission, and a menu group containing the Templates, Schedules, and Subscriptions menus. 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. This page assumes all steps are performed by the template creator, thus no template permission is required. If the steps are completed by non-creator users, the template creator needs to assign the required template permissions to the corresponding users. For more information, see Template Permission Control Rules.

  • EnOS Common Data Service is the built-in data source of the online editor, which is used to build a custom template on this page. Therefore, Common Data Service needs to be set up in the current OU. For more information, see Setting up Common Data Service.


Workflow


The workflow to use Reporting Tool is as below.


../_images/RPT-Setup-Flow.png


  1. Decide how to build a custom template depending on whether there is an existing BIRT template.

    • If there is a BIRT template, upload it as a custom template.

    • If no BIRT template exists, use the online editor to create a custom template. This page assumes no BIRT template exists.

    Note

    You can upload or create custom templates only. If you need to create standard templates, contact the system administrator.

  2. Create a report schedule to generate reports based on the template.

  3. Create a report subscription based on the schedule to send the generated reports to specified recipients.


Step 1: Creating a Report Template


  1. Log in to EnOS Application Portal and select Reporting Tool from the application list.

  2. Select Templates from the left navigation pane.

  3. Click New Template > Create.

  4. Fill in the template name and language in the pop-up window and click Create.

  5. In the opened online editor, add widgets and configure parameters and styles as required, and then click Operations > Publish.


For more information, see Creating a Custom Report Template.

Step 2: Creating a Report Schedule


  1. Select Schedules > New Schedule from the left navigation pane.

  2. Fill in the basic information, frequency, and other information of the schedule as required, and click Save. Note that you need to select the template created in step 1 as Related Template.


Once created, the schedule generates reports at the specified frequency based on the related template. For more information, see Creating a Report Schedule.

Step 3: Creating to a Report Subscription


  1. Select Subscriptions > New Subscription from the left navigation pane.

  2. Fill in the frequency, email content, recipients, and other information of the subscription as required, and click Save. Note that you need to select the schedule created in step 2 as Main Related Schedules.


Once created, the subscription sends the reports generated by the related schedule to the designated recipients at the specified frequency. For more information, see Creating a Report Subscription.