Using Dashboard Reports

Overview

The SAS Model Manager Dashboard can provide reports that show the overall state of all projects that are being monitored. The dashboard reports are produced from existing performance monitoring reports. For each project, a user can define dashboard report indicators that are then used to create the dashboard reports. The dashboard reports are not displayed through the SAS Model Manager user interface. Instead, use a browser window to view the dashboard reports that are located on the SAS Workspace Server. These reports are generated in HTML by SAS Model Manager.
Note: The dashboard reports can be defined and generated only by SAS Model Manager administrators and advanced users.
In this exercise, you will define dashboard report indicators, generate the dashboard report, and view the dashboard reports.

Prerequisites

Models Used in Tutorial 3

The exercises in this tutorial depend on some of the properties of the specific models that were added in Tutorial 3. Use the projects, versions, or models that are specified here. This tutorial is designed to follow Tutorial 3: Importing and Exporting Models.

The Required Tutorial Files

The exercises in this tutorial depend on the performance task data sets that were created using the tutorial files in Create the Champion Model Performance Data Sets.

Prepare to Use Dashboard Reports

The dashboard report directory is configured during the installation of SAS Model Manager. The default directory is \SASConfigDir\Lev#\AppData\SASModelManager3.1\Dashboard.
To configure a different directory to store the SAS Model Manager dashboard reports, follow these steps:
  1. Connect to the SAS Workspace Server.
  2. Create a new directory (for example, C:\Dashboard).
    Note: The directory must be located on a SAS Workspace Server or a network drive that is accessible by the SAS Workspace Server. Do not include special characters or spaces in the name of the directory.
  3. Grant user permissions for the new directory. For example, perform the following tasks:
    • Grant Full Control permission to users who need to create subdirectories, write content, or delete content. This type of user includes a user who you will be adding (using SAS Management Console) to the Model Manager Administrator Users group or a user who is a SAS Administrator.
    • Grant Read, Write, and Execute permissions to users who need to create performance indicators and execute dashboard reports. This type of user includes a user who you will be adding (using SAS Management Console) to the Model Manager Advanced Users group.
    • Grant Read and Execute permissions to users who need only to view the dashboard reports. This type of user includes a user who you will add (using SAS Management Console) to the Model Manager Users group.
    Note: In a UNIX environment all SAS Model Manager users must be part of a group that has the appropriate group permissions. For more information, see Creating Operating System Accounts in UNIX Environments in SAS Model Manager: Administrator's Guide and Configuring Users, Groups, and Roles in SAS Model Manager: Administrator's Guide.
  4. From SAS Management Console, expand the Application Management node on the Plug-ins tab.
  5. Select and expand Configuration Managerthen selectSAS Application Infrastructure.
  6. Right-click Model Manager JavaSvcs 3.1 and select Properties.
  7. (optional) Click the Settings tab and then select Model Manager Dashboard Options. This setting enables you to modify formats, styles, and the indicator override. The indicator override configuration enables indicators that have conditions to be available when you add dashboard report indicators using the SAS Model Manager 3.1 Client.
  8. Click the Advanced tab to modify the application dashboard directory. Change the property value for App.DashboardDir to the directory path that was configured.
  9. Click OK.

Define Dashboard Report Indicators

To define dashboard report indicators, follow these steps:
  1. You must have at least one project that contains performance data before you continue to the next step. For more information, see Create the Champion Model Performance Data Sets.
  2. Right-click the project folder in the Project Tree, and select Define Dashboard Report Indicators from the pop-up menu. The Define Dashboard Report Indicators window appears.
    Set Indicators window
  3. Click Add. The Add Indicator window appears.
    Note: If you want to copy indicators from an existing project, click Copy Indicators instead of Add, follow the prompts, and then skip to step 5.
    Add Indicators window
    1. Select a template from the Template drop-down list.
      Note: Click Detail to view information about the selected indicator template.
    2. Enter values for the Normal, Warning, and Alert range definitions.
      Example Performance Indicator Values
      Indicator Name
      Category
      Normal
      Warning
      Alert
      CHAR_P1
      Characteristic
      0 – 1
      1 – 2
      2 – 3
      GINIDECAY
      Model Assessment
      0 – 0.2
      0.2 – 0.4
      0.4 – 0.6
      STAB_P1
      Stability
      0 – 1
      1 – 2
      2 – 3
    3. Click OK. The Define Dashboard Report Indicators window appears with information about the new indicator.
    Set Indicators window
  4. Repeat step 3 for each indicator that you want to add. To edit an existing indicator, select the indicator, and click Edit.
  5. Select one Category Indicator for each category, and then select one indicator as the Project Indicator.
    Note: The indicator that you select as a project indicator must also be a category indicator.
    Set Indicators window
  6. Click Next. The Define Dashboard Report Indicators window appears with information about setting up notifications.
    Set Notifications window
  7. Select a value from the Project status drop-down list, enter a value for E-mail address, and click Add. Repeat this step for each recipient who you want to send an e-mail notification to about a status. If you want an individual recipient to receive an e-mail notification for each status, you must repeat this step for each status. To delete an e-mail notification, select a project status, and click Delete.
  8. Click Next. The Define Dashboard Report Indicators window appears with information about setting report types.
    Set Report Types window
  9. By default, all of the report types are selected. To change report types, follow these steps:
    1. To add a report type, select a value from the Report type drop-down list, and click Add.
    2. To delete a report type, select a value from the Report Description list, and click Delete.
  10. Click Finish. An informational message is displayed indicating that the dashboard indicator was defined successfully.
    Dashboard Indicator Success message
Note: You must define dashboard report indicators for all projects that you want to include in your dashboard reports.

Generate Dashboard Reports

To generate the dashboard reports, follow these steps:
Note: Before you generate dashboard reports, you must have at least one project that contains performance data. That project must have at least one dashboard report indicator that has been defined.
  1. Select Toolsthen selectGenerate Dashboard Reports from the menu. The Generate Dashboard Reports window appears.
    Generate Dashboard Reports window
  2. Select a style for the report from the Select a style drop-down list.
  3. Select one of the following report options:
    • Create reports and data tables for projects that have new performance monitoring data.
    • Update the style for all reports, using the existing data tables.
    • Update all reports and data tables for projects whose performance monitoring data or report indicator definitions have changed.
  4. (Optional) Select one or more project types that you want to exclude from the dashboard reports.
  5. Click OK. You can view the progress of the dashboard reports in the status bar. A message appears that indicates whether the report was created successfully. The message also displays the location of the dashboard reports on the SAS Workspace Server. Here is an example: C:\SAS\Config\Lev1\AppData\SASModelManager3.1\Dashboard.
    Dashboard Report Success message
    Note: SAS Model Manager administrators can configure a different location for the dashboard reports directory. If you set up notifications when you defined the dashboard indicators, the recipients will receive e-mail notifications for the configured statuses.
For more information about executing dashboard reports, see the SAS Model Manager: User's Guide.

View the Dashboard Reports

To view the dashboard reports, follow these steps:
  1. Navigate to the report folder in the dashboard report directory on the SAS Workspace Server. Here is an example, C:\SAS\Config\Lev1\AppData\SASModelManager3.1\Dashboard.
    Dashboard report directory view
  2. Open the index.html file in your browser window. The SAS Model Manager Dashboard appears.
    Dashboard Reports All projects page
  3. Select a project name or a status to view the associated dashboard reports. The Project Reports Index appears in a new window. If you select a status, only the dashboard reports for that time frame are displayed.
    Dashboard Project Reports Index page
  4. Select a report to view report details. The report details appear in the same window.
    Dashboard KPI Detail Report
    Note: To return to the Project Reports Index, select the browser's back button.
For more information about dashboard reports, see the SAS Model Manager: User's Guide.
Copyright © SAS Institute Inc. All rights reserved.