Reporting: Schedule a Report

Document created by RSA Information Design and Development on Nov 23, 2016Last modified by RSA Information Design and Development on Feb 10, 2017
Version 5Show Document
  • View in full screen mode
  

This topic provides instructions on how to schedule a report.  After a report is defined with the required formatting components and rules, you can configure its execution properties by scheduling a report. Here, you can quickly view, add, and edit the schedule details for a report.

When you schedule a Warehouse report, you can use a supported task scheduler to allocate specific resources in a cluster for the scheduled job. For more information on supported task schedulers, see Task Scheduler for Warehouse Reporting.

Prerequisites

Make sure that:

  • You have understood the components of the Build Report view. For more information, see Build Report View.
  • You have understood the components of the Schedule a Report view. For more information, see Schedule Report Panel.
  • If you want to use resource pools, you must set up the pools or queues in Reporting Engine. For more information, see Step 5: Configure Task Scheduler for a Reporting Engine topic in Host and Services Configuration Guide.

Procedure

Perform the following steps to schedule a report:

  1. In the Security Analytics menu, select Reports.
    The Manage tab is displayed.
  2. Click Reports.
    The Report view is displayed. 
  3. In the Build Rulepage, click run_config_add.pngto create a rule. 
  4. Click Save.
  5. Click Use.
  6. Select the New report or Existing Report.
    106_UseRule.png
  7. Select a report group and click Select.
  8. Enter the Report name and select the rule.
  9. Click Schedule.
    The Schedule Report view is displayed.

Note: If you provide another user with access permissions to a report, you must also provide permissions for the report group, the rules used in the report, and the rule groups otherwise an error message is displayed.

  1. To execute the reports as per the schedule, select the Enablecheckbox.
  2. In the Schedule Name field, enter a name for the schedule report configuration.
  3. From the Data Source field, select the data source.

Note: If the data source is not listed, then ensure you have Read permissions set for the data source. This is applicable for NWDB, Warehouse DB and IMDB data source. For more information, see Configure Data Source Permissions topic in Host and Service Configuration Guide.

  1. (Optional) From the Warehouse Resource Pool drop-down, select the pools or queues available in the cluster to schedule the report to run on either the pool or queue. This drop-down is available only if you select a Warehouse DB report.

    Note: All the queues or pools you specified in the Explore page for the Reporting Engine are listed. If no pools or queues are configured in the Explorer page, this drop-down is disabled and the jobs are submitted to the clusters without any a queue or pool name. 

    Note: If the pool or queue configured in the report schedule is removed from the Cluster, then in the Capacity Scheduler, the queue name remains undefined. However, in the Fair Scheduler, the specified pool name will be created using the property mapred.fairscheduler.allow.undeclared.pool.

  2. From the Time Zone drop-down, select a time zone to display all the time-related data in a report output in the specified format.This setting is configurable from the Reporting Engine Explore view (/com.rsa.soc.re/configuration/reportoutputformatterconfig/reportoutputformatterconfig).
  3. From the Run field, select the type of run schedule. (For example, Now or Hourly).
    Depending on the type of run schedule, do either of the following:
  • If you select a Later or Monthly run schedule, you must provide a value for the day and time in the respective field provided.
  • If you select an Hourly run schedule, you must specify the minutes in the At Minute field.
  • If you select a Daily run schedule, you must enter a value in the At field.
  • If you select a Weeklyrun schedule, you must enter a value in the At field and also select the week days.

Note: While scheduling a report, if you select Past option or Range (specific/generic) option or an end time range very close to the current time, you must ensure that the aggregate data in the data source is returned. If there is an aggregation delay in the data source, the end time you choose must account for the delay, otherwise reports lose non-aggregate data for that time range.

For information on how to generate a report with variables, see Use Variables for Parameterized Reporting.

  1. (Optional) In the Output Actions panel, do the following:
    1. Type the email address and subject.
    2. Edit the body of the message for the report.
    3. Select the format of the attachment.
    4. Type a value for the CSV and Multi-value delimiters.
    5. (Optional) In the Other Options field, do the following:
      1. Click other_options_button_104.png and select SFTP, URL, or Network Share output action.
        A row gets added with the selected output action.
      2. Select the appropriate options to send the report in PDF or CSV format, or both to the RE configured SFTP, or URL, or Network Share output action.
  2. (Optional) To add a list in the Dynamic List panel, see Generate a List from the Scheduled Report section.
  3. (Optional) To choose a logo in the Logo panel, see Manage and Select a Report Logo section.

    Note: If you do not specify a logo, the default RSA logo will be used. 

  4. Click Schedule.
    The scheduled report executes as scheduled and provides the configured outputs.
    106_ReportResult.png

Next Steps

Perform the following tasks:

  1. You can notify the email recipient when the report execution completes and send reports in PDF and CSV formats as attachments in the email.
  2. You can generate a list based on the scheduled report and view them in the Listsmodule.
  3. You can send a scheduled report in PDF or CSV format, or both to the RE configured SFTP  location, or URL, or Network Share.
  4. You can change the default logo and view them in the scheduled report.
  5. You can modify the Security Analytics Reporting Engine config details, by navigating to the Reporting Engine General Tab. See the Reporting Engine General Tab topic in the Host and Service Configuration Guide.

Examples

When you schedule reports in the Schedule Report view, by default, the results for the Past option are presented based on the user specified time zone. The following examples provide a clear picture on what results to expect when you select Hours, Days, Weeks, Months, or Years for the Past option based on the absolute or relative duration.

Note: By default, the relative duration checkbox is de-selected. This implies that the results for the Past option are presented based on the absolute duration.

Based on Absolute duration:

Absolute Duration allows a report to be scheduled at an absolute time with respect to the current time, excluding the seconds and considering the time interval as a whole. For example, 12.00pm is the absolute time with respect to the current time (12.45 pm).

Hours

Suppose that you select Hours and specify one hour. If the current user specified time is 4.20PM, the report is generated for the time range, 3.00PM to 4.00PM.

Days

Suppose that you select Days and specify one day. If the current date is August 27, 2014 and the current user specified time is 10.15AM, the report is generated for the range: August 26, 2014, 12.00AM to August 27, 2014, 12.00AM.

Weeks

Suppose that you select Weeks and specify one week. If the current date is August 27, 2014 2.30PM and the day is Wednesday, the report is generated for the range: Saturday, August 16, 2014, 12.00AM to Saturday, August 23, 2014, 12.00AM.

Months

Suppose that you select Months and specify one month. If the current date is August 27, 2014 2.30PM, the report is generated for the range:
July 01, 2014, 12.00AM to July 31, 2014, 12.00AM.

Years

Suppose that you select Years and specify one year.If the current date is August 27, 2014 2.30PM, the report is generated for the range:
January 01, 2013, 12.00AM to December 31, 2013, 12.00AM.

Based on Relative duration:

Relative Duration allows a report to be scheduled at a time relative to the current time which might vary based on the current time. For example, 12.45 pm is the relative time with respect to the current time (12.45 pm).

Hours

Suppose that you select Hours and specify one hour. If the current  user specified time is 4.20PM, the report is generated for the time range, 3.20PM to 4.20PM.

Days

Suppose that you select Days and specify one day. If the current date is August 27, 2014 and the current user specified time is 10.15AM, the report is generated for the range: August 26, 2014, 10.15AM to August 27, 2014, 10.15AM.

Weeks

Suppose that you select Weeks and specify one week. If the current date is August 27, 2014 12.30PM and the day is Wednesday, the report is generated for the range: Thursday, August 21, 2014 12.30PM to Wednesday, August 27, 2014 12.30PM.

Months

Suppose that you select Months and specify one month. If the current date is August 27, 2014, 2.30PM the report is generated for the range:
July 27, 2014 2.30PM to August 27, 2014 2.30PM.

Years

Suppose that you select Years and specify one year.If the current date is August 27, 2014 2.30PM, the report is generated for the range: August 27, 2013 2.30PM to August 27, 2014 2.30PM.

Previous Topic:View a Report
You are here
Table of Contents > Working with Reports in the Reporting Module > Schedule Reports > Basic Procedures > Schedule a Report

Attachments

    Outcomes