Configuring the Report Executor task

You can use the Report Executor task to perform the following tasks on the basic and advanced reports:

• Automate the creation of reports 
• Schedule the execution of reports.

The Report Executor task belongs to the Reporter task type. Depending on the type of TrueSight Capacity Optimization deployment, there can be several tasks that belong to this category, that can be scheduled to generate reports at different intervals. For more information, see Viewing-report-groups-and-report-results.

The following image shows an example of the System tasks table showing all tasks of type Reporter.

The following video explains how to set up a reporter task to automate report creation and upload.

 https://youtu.be/AozPAP7JmnA

Editing the run configuration

To edit the run configuration of a particular task of type Reporter, perform the following task:

1. Navigate to Administration > ETL & SYSTEM TASKS > System tasks and click the appropriate task name (with the Type as Reporter) in the System tasks table.
2. In the task details page, click  (Edit) under Run configurations.

3. In the Edit run configuration page, click Advanced located towards the bottom of the tab structure, and set each property under the following tabs that are displayed: 

   • General configuration
   • Post generation
   • Upload methods
   • Execution configuration
   • Scheduling options

   Set the following properties under this tab:

   • Name: Enter a name of the run configuration.
   • Environment: Select Production or Test.
   • (Optional) Description: A brief description for the run configuration.

   Set the following properties under this tab:

   • Transfer generated files: Select any one of the following options:
     • Yes: Transfer generated files to a remote host using one of the available transfer methods. Selecting this option adds the Upload methods tab to the tab structure.
     • No: Do not transfer generated files.

   This tab is displayed only if you select Yes for the Transfer generated files property under the Post generation tab.

   Set the following properties under this tab:

   • Method: Select any one of the following methods – FTP, SCP, CIFS, or SFTP.
   • Host address: The URL or address of the host to which the generated files have to be transferred.
   • Workgroup: The workgroup of the host. Applicable only if the CIFS method is selected.
   • Remote folder: The address (path) of the remote folder.
   • Username: The username to use to log on to the selected method.
   • Use password: Applicable only for SCP and SFTP methods. Select any one of the following options:
     • Yes: Require a password to log on to the method.
     • No: Do not use a password to log on and use a SSH key directoryinstead.
       • SSH key directory: By default, key files are loaded from user home .ssh directory. Enter a value here to override the default.
   • Password: The password to log on to the selected method.

   Set the following properties under this tab:

   • Execution parallelism: 
     • Blank (default): Reports are generated one at a time (single threaded). There is one ReportThread shown in the system task logs.
     • Specified value of 0: The Report Task runs but does not generate any reports. The task starts and quickly ends with the Execution terminated. Generated OK=0, FAILED=0 message. 
     • Specified value > 0: The Report Task appears to execute many report threads in parallel. The logs display multiple ReportThread-# threads running reports in parallel.
       Note: This property is only applicable for scheduled tasks, and does not take effect in case of On Demand Reports (since that is not a scheduled task). 
   • Type: Select the type of reports that can be run.
   • Execute report in a separate JVM: Enable or disable executing the report in a separate JVM.
     Note: When enabling or disabling this option, ensure that you unschedule and reschedule the associated Report Executor Task from the respective Report Executor Task configuration setting.

   Set the following properties under this tab:

   • Hour mask: Schedule to run the report for a particular hour.
   • Day of week mask: Schedule to run the report on selected days of the week.
   • Day of month mask: Schedule to run the report on particular days of a month. For example, 11, 15, 21-25.
   • Apply mask validation: Set the mask validation to True or False.
   • Execute after time: The time period after which the scheduler task must be executed.
   • Enqueueable: Select whether or not you want the task to be enqueued if other tasks are being executed.

4. Click Save.