Report Configuration

The Report Configuration Screen is used to create, edit, and delete Reports. These reports are PDF versions of tables and reports generated in certain OmniVista applications (e.g., Discovery, Locator, Analytics). Basically, in addition to viewing information in real-time in OmniVista (e.g., Discovery Inventory List, Analytics Utilization Reports), you can generate PDFs of the screens. When a report is generated, it takes a current snapshot of the application information. These reports can be generated immediately or you can schedule them to be generated at regular times/intervals (e.g., Daily, Weekly). You can also configure a report to be e-mailed when it is generated. These generated reports are then displayed on the Report List Screen, where they can be downloaded and viewed as PDFs.

Note: There is a limit of 1000 records for a generated report; any records over that limit are not included in the report.

Creating a Report

There are two steps to creating a report. First you must configure the report in the Report Application (report name, schedule, e-mail), then you must go to an application that supports the Report Feature (e.g., Discovery, Locator, Analytics), click on the Add to Report button at the top of a screen, and link that report to a Report Configuration.

1. Click on the Add icon and complete the fields as described below. After completing the fields, click on the Create button.

• Report Title - Enter a title for the report.
• Schedule Settings
  • Purging Policy - The report purging frequency. Select an option from the drop-down menu (7, 30, or 365 Days After Creation). The report will be removed from the server at the selected interval. (Default = 30 Days)
  • Schedule - The report creation schedule.
    • Now - Select this option to generate a single report immediately.
    • Periodically - Schedule periodic reports as described below. Note that when you schedule a report, an initial report is also immediately generated.
      • Simple - Select this option to configure a repeating report. Set an Interval using the Days/Hours fields.
      • Cron - Select this option to schedule a recurring cron job to generate the report.
        • Execute At Server Time - Select the time when you want to begin the cron job. This is the OmniVista Server time (Pacific Time) (e.g., 12:00 AM).
        • Recurrence Pattern - Select the interval for a recurring cron job.
          • Daily - The report will be generated sent every day at the configured start time. By default, the report will be generated every day ("Every 1 Day").
          • Every Day(s) - Customize a daily report by entering the number of days you want to generate the report during the month (Range = 1 - 30 days). For example, you could enter "2" to generate the report every other day.
          • Weekly - The report will be generated once a week on the selected day at the configured start time. Select the day of the week on which you want generate the report. The report will be generated every week on that day. You can select more than one day to generate the report on multiple days of the week.
          • Every Weekday - The report will be generated every day of the week at the configured start time.
          • Monthly - The report will be generated monthly on the configured day at the configured start time.
            • Select the first radio button to schedule the report for a specific day of the month, and number of months. By default, the report will be generated on the first day of every month ("Day 1 of every 1 Month"). However, you can customize it. For example, you could schedule the report for the 15th day every other month ("Day 15 of every 2 Months").
            • Select the second radio button and select a number (e.g., First, Second) day (Weekday, Monday, Tuesday) and number of months. By default, the report will be generated on the first day of every month ("First Day of every 1 Month"). However, you can customize it. For example, you could generate the report on the Second Tuesday of every other month "The Second Tuesday of every 2 Months").
  • E-Mail - Enter an address to e-mail an attached PDF of a report as configured in the Schedule field above. Each time a report is generated, an attached PDF of the report will be sent to the recipient. You can designate only one (1) e-mail recipient. Note that the E-Mail Preferences (Preferences - System Settings - E-Mail) must be configured for OmniVista to generate report e-mails.

2. After creating the report, go a supported application (e.g., Discovery, Locator, Analytics) and click on the Add to Report button at the top of the screen. The Add to Report Window will appear with the report/report view displayed in the Widget Name field (e.g., Inventory, Top N Ports Utilization Report Widget). Select the Report you configured in Step 1 from the Report Configuration drop-down list and click OK. A report for that screen will now be generated according to that report configuration.

You can generate reports for other applications based on the same report configuration by going to those applications and clicking on the Add to Report button and selecting the report from the Report Configuration drop-down list.

Note: The first time you configure a report (Step 1), a blank report is automatically generated and appears in the Report List. The report is blank because you have not yet associated the report with an application (Step 2). Once you complete Step 2, reports will be generated for that application based on the report configuration.

Note: Sending a report email will fail if the email size exceeds the size limit of the email server. For example, Gmail does not allow sending emails larger than 25MB.

Note: You can also manually generate a report at any time by selecting the report and clicking on the Generate Report button on the Report Details Screen. You can only manually generate a report configured with the Schedule set to "Now". You cannot manually generate a report configured with a "Periodic" schedule.

Editing a Report

Select the report and click on the Edit icon to bring up the Edit Report Configuration Screen. Edit the fields as described above then click on the Apply button to save the changes to the server. Note that you cannot edit the report title. You can edit the Report Settings, and/or click on the Other Settings button to edit the print parameters. You can also remove a report from this Report Configuration by clicking on the "X" next to the field.

Deleting a Report

Select a report and click on the Delete icon, then click OK at the confirmation prompt. At the prompt, you have the option of deleting all reports associated with the report configuration. To delete them, select the "Also delete all generated reports" checkbox.