Configuring Ensemble Productions
Creating Dashboards
[Back] [Next]
   
Server:docs1
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

This chapter describes how to create dashboards that display Ensemble business metrics. It contains the following topics:

For information on defining Ensemble business metrics, see Developing Ensemble Productions.
Introduction to Dashboards
A dashboard displays business metrics or other data (such as DeepSee pivot tables). InterSystems dashboards are web-based. You can display them with the Dashboard Viewer (which is a web page) or you can embed them in Zen pages.
To see the dashboards provided in the ENSDEMO namespace, do the following:
  1. In the Management Portal, switch to the ENSDEMO namespace.
  2. Click [DeepSee] > [User Portal]. This launches the DeepSee User Portal, which is a separate web-based application.
    Note:
    For your end users, you would probably provide a direct link to the User Portal page.
You then see the DeepSee User Portal (which is intended for general use, despite its specific name). In ENSDEMO, the User Portal looks like this:
The right area of this page lists all dashboards to which you have access. (For workflow users, the right area also includes the Workflow Inbox, with which users display and manage their workflow tasks.)
The left area displays items such as the following:
The DeepSee End User Guide explains how to use this user interface and how to work with dashboards.
If you click the link for a dashboard in the User Portal, the Dashboard Viewer then displays the dashboard. The following shows a simple example:
You create dashboards in the User Portal. If you want users to have access to the User Portal but not have the ability to create their own dashboards, see the chapter Setting Up Security in the DeepSee Implementation Guide.
You can instead embed individual dashboards in Zen pages. In this case, the users would not need the User Portal. For information, see Accessing Dashboards from Your Application in the DeepSee Implementation Guide.
Creating Dashboards
The following is an example procedure of how to create a simple dashboard in DeepSee. Note that not all options you see are described in these steps. (See Creating DeepSee Dashboards for full details.)
  1. In the ENSDEMO namespace, start the Demo.Dashboards.Production from the [Ensemble] > [Configure] > [Productions] page.
  2. In the Management Portal, click DeepSee, click User Portal, and then click Go.
  3. From the User Portal, click New Dashboard on the Menu.
    The system displays a dialog box that prompts you for basic information about the new dashboard.
  4. For Dashboard Name, type the name of the dashboard.
  5. Optionally provide values for the following options:
  6. Click OK.
    The system creates, saves, and displays the dashboard, which is initially empty.
  7. Click Add New Widget on the Menu and then click Bar Chart on the left from the list of Pivots and Charts.
  8. Click the magnifying glass to the right of the Data source.
  9. Click Business Metrics on the left of the Finder Dialog.
  10. Click Demo.Dashboard.Production and then SalesMetrics to choose this metric as the data source. Click OK to add this widget to the dashboard. You now see this widget in the dashboard work space. Resize the widget graphic out so you can see what it contains.
  11. Click Save on the Menu to save the dashboard.
  12. Click Home to see the list of dashboards and then click the dashboard name you just added to view it.
  13. Click the clipboard icon at top left of the bar chart, to edit the appearance of the widget you added using the Widget Designer.
  14. Click the Data Properties tab.
  15. Click the plus sign icon at right, click Sales in the Data Value list, and click OK.
  16. Click the plus sign icon again, click Units in the Data Value list, and click OK.
  17. Click Save on the Menu.
  18. Refresh the browser to see the display change as the production runs.
Location of Dashboard Definitions
When you create a dashboard, its definition is visible in the Studio Workspace window, within the Other folder. You can export and import this definition as you do with other items in Studio.
A dashboard definition is not a class definition but can be copied and pasted into a special container class if needed; this container class can contain multiple dashboards and other items. For details, see Packaging DeepSee Elements into Classes in the DeepSee Implementation Guide.
For More Information
InterSystems dashboards are documented more fully within the DeepSee documentation. See the following books: