This page describes how to install and configure the reporting apps. You can also discover how to uninstall the reporting apps.

Installation of Reporting Apps

Follow the below steps to install any of the Reporting Apps:

  1. Go to Reports > Reporting Apps.
  2. Click the Available tab to see all the available Reporting apps.
  3. Click ADD to install the required Reporting app.
    Event Management
  4. Now, if you want to see the installed apps click the Installed tab.

Configurations of Reporting Apps

Configuration process is the same for all the apps except for a few minor changes, so given examples for two different types of apps to configure with all the required steps.

Before you start configuring the apps, make sure you have installed the specific apps from the Available tab.

Example-1: Asset Insights

To configure the Asset Insights app, follow the below steps:

  1. Go to the Installed tab.
  2. To configure the Asset Insights app, click on the app card to open it.
  3. In configuration Parameter section:
    • Analysis Period: Default analysis period as Snapshot is selected.
    • Format: Choose the format (PDF or XLSX) of your report to be generated.
  4. Once you have selected the configuration parameters, click Run.
Event Management

Example-2: Alert Listing

To configure the Alert Listing app, follow the below steps:

  1. Go to the Installed tab.
  2. To configure the Alert Listing app, click on the app card to open it.
  3. In configuration Parameter section:
    • Add Query: Using an OpsQL query, you can customize the report result. If users did not select “updatedTime” attributes in the query string, in that case the user selection query would be appended by default. For example: If a user only selects the alertType attributes, the query will automatically append with AND updatedTime > ‘-7d’ The query will look like below: (alertType = “MONITORING”) AND updatedTime > ‘-7d’
    • Select Client: You can select Single client / All clients from dropdown the list. Only selected client data will get into report.
    • Select Attributes: Only selected attributes related data will be included in the report. If no attributes are selected, the default attributes data will be included in the report.
    • Format: Choose the format (XLSX) of your report to be generated.
  4. Once you have selected the configuration parameters, click Run.
Event Management

Save the Configured Analysis

This section describes how to save the configured Apps. Procedure to save the analysis is the same for all the apps.

  1. Once run has successfully completed, you will be able to save and download the report in (PDF and XLSX) format.
  1. To save your run as analysis, click the Save button.
apps
  1. Next, fill in the following details in the Save as Analysis page:

    • Analysis Name: Give the name to your analysis. When giving a name to an analysis, make sure it is unique and not duplicated for the same type of app at user level.
    • Run on Schedule: If you want to schedule your run, enable this option and configure the following fields. (This is optional)
      • Daily: Select this option to run your analysis on a daily basis and can configure by choosing the available time preference.
      • Weekly: Select this option to apply to run your analysis on a weekly basis. Configure weekly schedule by selecting the available time preference.
      • Monthly: Select this option to apply to run your analysis on monthly wise only. Configure this by selecting the number of days in a month.
      • Recipient Users: Select the users from the list to send the report notification.
      • Message: You can add your message here, if not added anything the system will send with a default message subject. Date and time in subject is referred to completion of time.
      • Subject: The user will receive an email notification with this subject heading.
  • Set Time Zone: You can run the schedule in a specific time zone. When you choose a time zone, it ignores the different local time zones and uses the time zone specified in the configuration.
    apps
  1. Finally, click the Save button to finish. You can find your saved analysis under the Analysis section.
  2. Click Back To Overview at the upper right corner to return to the Overview page.

View the Saved Analysis

This section describes how to modify the saved analysis and where to find the most recent run progress.

You will have the following options to take action against each saved analysis:

  • Run Now: Use to run the individual analyses again.
  • Copy: Use this option if you want to duplicate this analysis.
  • Edit/View: This option allows you to view or edit the configure parameters.
  • View Run: Click to see the current status of the run.
  • Add Schedule: This option allows you to add and configure a schedule period for the analysis to run.
  • Remove: Use this option to delete an analysis from the list if it is no longer relevant.
apps

To see the status of your run, click the Recent tab. You will have following information in the Recent Runs page:

  • Created date: You can see when this run has been created. You can sort the list based on the created date.
  • Created By: You can see who has created this run.
  • Status: View the status of run such as: Pending, Running, Completed, or Failed. You can sort and search the list based on status.
  • Download: Click on either PDF or XLSX to download the reports.
  • Refresh: Click the Refresh button to refresh the page.
  • Search: Use the search field to filter runs based on their status.
apps

Uninstallation of Reporting Apps

If you do not want to use the Reporting app, you can uninstall it from your system by following the steps below:

  1. Go to Reports > Reporting Apps.
  2. Click the Installed tab to see all the installed apps.
  3. Click the three-dot symbol that appears below the apps, and then click the Remove button.
    Reporting apps
  4. Now a dialogue box will appear, enter the reason for the uninstallation and then click Uninstall.
    Once you uninstalled the app, its associated analyses and runs can not be reversible.
    Reporting apps
  5. You have now successfully uninstalled the Reporting app.