Working with Report Scheduler

(From UIM 20.3.3) You can use Report Scheduler to schedule Metric views or Service Level Agreement (SLA) reports to run at specified times. The reports can be delivered as a PDF through email or FTP, or can be stored on a server. This article explains how you can work with jobs in Report Scheduler. It describes how to create, edit, delete, preview, copy, and run jobs. It also provides information on how to view the history for a job and how to view the log file for each job run.
The following illustration provides an overview:
The following topics provide the required information:
2
  • You must have the Report Scheduler ACL permission to work with the Report Scheduler functionality.
  • The reportscheduler webapp (uim_reportscheduler) must be deployed only to one node in your UIM environment. Therefore, if you have a multi-node OC setup, you need to explicitly perform this configuration, because the webapp is deployed to multiple nodes. For a multi-node OC environment, the Report Scheduler functionality in UIM 20.3.3 no longer supports the job_refresh_secs configuration property in the /webapps/reportscheduler section of wasp.cfg. Now, it supports the execute_email_action configuration property in the /webapps/reportscheduler section of wasp.cfg. The execute_email_action property lets you prevent the duplicate reports by stopping the execution of the email actions on one or more OC servers. On each OC server where you want to stop executing email actions, add the execute_email_actions property with a value of false. Therefore, with this property, you can resolve the issue of users receiving duplicate reports in a multi-node OC environment.
The following illustration helps you quickly understand how you can access and create a report schedule:
Create a Job
To schedule a report, you must create a job. The complete job creation process includes three steps: configure schedule details, specify when to schedule the job, and provide information about the delivery mechanism.
Follow these steps:
  1. Access the
    Settings
    option in the OC UI.
  2. Click the
    Report Schedules
    tile.
    The
    Report Schedules
    page opens.
  3. Click the
    Create New
    button.
    The
    Create Schedule
    dialog opens.
  4. Provide the following information in the
    Schedule Details
    section:
    1. Enter a name for the report in the
      Save As
      field.
    2. Select the
      Enabled
      option to allow the job to run.
    3. Enter a meaningful description in the
      Description
      field.
    4. Assign the job to an account from the
      Account
      drop-down list.
    5. Select the type of report from the
      Report Type
      drop-down list. You can select Metric Views or SLA.
    6. Select the required report from the
      Report
      drop-down list.
    7. If you selected the report type as SLA, make a selection from the
      SLA Depth
      drop-down list. The default is Full SLA. Similarly, if you selected the report type as Metric Views, make a selection from the
      Report Time Frame
      drop-down list. The default is Last Full Day.
      The
      Full SLA
      option provides the most detail, but is more resource intensive than the other options.
    8. (For Metric Views) If necessary, select a different data
      Aggregation Interval
      . The default is Automatic. To print the job at the report settings, you must change the
      Report Time Frame
      value to match the report time frame and the
      Aggregation Interval
      value to match the report aggregation interval.
      You can change the data aggregation interval for each new job. This will not change the aggregation interval in the saved report. Saving a job saves the time frame and aggregation interval selections for that job.
    9. Click
      Next
      .
      The
      Scheduling
      section is displayed.
  5. Provide the following information in the
    Scheduling
    section:
    1. Select an option from the
      Run
      drop-down list. The
      Run On
      area updates dynamically based on your selection.
    2. Specify the time and date to run the report. Use the
      Time Zone
      drop-down list to select the time zone for the report. The time zone that you select determines when the job is executed, and which time zone the report displays. If you do not select a time zone, the local time zone is used by default.
      The job will run at the first specified time after the starting time you set.
    3. Click
      Next
      .
      The
      Delivery
      section is displayed.
  6. Provide the following information in the
    Delivery
    section:
    1. If you select
      Email
      , enter information in the
      To
      ,
      Subject
      , and
      Message
      fields. Also, ensure that the SMTP server settings are already configured.
    2. If you select
      FTP
      , enter information in the required fields. You can use the
      FTP Location
      field to specify a subdirectory in which to save the report. For example, enter reports/monthly to save the report in a subdirectory named monthly. The
      FTP Passive
      option allows you to set passive or active FTP mode. The passive mode is recommended if the OC server and FTP server are separated by a firewall. Click
      Test Connection
      to validate the FTP connection.
    3. Select
      Store on server
      if you want to save the reports on the OC server (..\webapps\reportscheduler\archive). You can also configure the report storage location on a server.
    4. Select the layout orientation for the report from the
      Report Orientation
      drop-down list.
    5. Select the layout size for the report from the
      Report Size
      drop-down list.
  7. Click
    Create
    .
The job is created and is listed in the Report Schedules jobs table.
View the Report Schedules Table
The Report Schedules jobs table lists the jobs that you create.
Click a column heading to sort the list of jobs by that column, and click again to switch between ascending and descending order. You can also enter text in the filter field to find the relevant job. This icon indicates that the job is enabled. This icon indicates that the job is disabled.
You can perform appropriate operations on the created jobs based on your requirements.
Configure Storage Location on a Server
One of the delivery options in Report Scheduler is to store reports on a server. By default, the reports are stored under the root directory \webapps\reportscheduler\archive, but you can define the root directory for storing reports. If the report is associated with an account, the report is stored in a directory with that account name under the specified root directory.
Follow these steps:
  1. Open Infrastructure Manager.
  2. Click the robot for the primary hub in the tree view.
  3. Click the wasp probe to select it in the top-right pane.
  4. Press CTRL and right-click, then select Raw Configure from the popup menu.
  5. Expand the webapps folder in the tree view of the Raw Configure window.
  6. Click reportscheduler in the tree view. The Report Scheduler keys are displayed in the right pane.
  7. Click New Key. The New Key dialog is displayed.
  8. Enter file_store_root in the Enter key name field.
  9. Enter the directory path that you want to use as the root directory for storing reports in the Enter value field.
  10. Click OK, then click OK again to close the Raw Configure window.
  11. Restart the wasp probe.
Manage Jobs
After you create a job, you can perform various operations on the job to manage them efficiently. The following screenshot shows the options that you can perform as part of managing the jobs:
Follow these steps:
  1. Run a job
    You can run a job at any time. The report is sent to the specified delivery method(s). Running a job does not affect the regular schedule for the job.
    1. Locate the job that you want to run.
    2. Click the
      Run Job
      icon (play icon) available in the Actions column.
    The job runs and the report is sent to the specified delivery methods. The report is named <job_name>_<yearmonthdate>_<hoursminutesseconds>.pdf. Any invalid symbols or characters in the job name are removed.
  2. Copy a job
    You can make a copy of an existing job. This is useful if you want to create another job with similar settings.
    1. Locate the job that you want to copy.
    2. Click the copy job icon.
    The copy of the job is created, named as Copy of <job name>, and is listed in the table. You can edit the settings of the copy.
  3. Delete a job
    You can delete jobs that you no longer want. When you delete a job, all runs of the job and the job history are also deleted.
    1. Locate the job that you want to delete.
    2. Click the delete job icon (trash icon).
    3. Confirm to delete the job.
    The job is deleted and is removed from the table.
  4. Preview a report
    You can view a PDF of a report without sending it to the selected delivery methods. This also provides an easy way to save the report on your computer.
    1. Locate the job for which you want to preview the report.
    2. Click the three dots in the Actions column.
    3. Click Preview Report.
    A PDF of the report is generated in your browser.
  5. View job history
    You can view the job history. For example, you want to view the log file for each run of a job. The log file includes information such as actions taken, time, status, and errors.
    1. Locate the job for which you want to view the history.
    2. Click the three dots in the Actions column.
    3. Click Show History.
    The Schedule History dialog opens. It contains the job history. Click the status of the required entry. The log is displayed. You can also access the log file from a message if a job is unsuccessful. The successful/unsuccessful error message along with a link for viewing the log file is displayed.
You have successfully performed the required actions.
Configure Email Server Settings
To deliver reports by email, Report Scheduler must be configured to use your SMTP server.
Follow these steps:
  1. Open the Report Scheduler UI.
  2. Click the Email Setup option in the top-right section. The
    Email Setup
    dialog opens.
  3. Enter an email address that your SMTP server can use in the
    From Address
    field.
  4. Enter the name (
    SMTP Server
    ) and port number (
    SMTP Port
    ) of your SMTP server.
  5. Enter a valid user name (
    User Name
    ) and password (
    Password
    ) for your SMTP server.
  6. If necessary, select one or more of the security options:
    • Use authentication
    • Use STARTTLS
  7. Click
    Done
    to save your changes.
The email server settings are configured successfully.