General Reference

Metrics and Scorecards System Requirements

License Requirements

The Metrics Manager license is required to use the Metrics and Scorecards module.

Additional Components Required

In addition to the basic APM system architecture, your system must also contain the following additional components:

  • A SQL Server Analysis Services Server machine that will host the Microsoft SQL Server Analysis Services software. The following versions of SQL Server Analysis Services are supported in this version of APM:

    • Microsoft SQL Server Analysis Services 2016

  • If you are using an Oracle database, in order to process the Work History cube, you must install ODP.NET (Oracle Data Provider.NET), an Oracle Data Access Component, on the machine where the Work History cube is deployed.

System Architecture

Microsoft SQL Server Analysis Services provides the ability to analyze large amounts of data quickly and easily. Analysis Services provides the means to access warehouses of data by letting you create dimensional cubes from information in the database and dimension tables. Numeric measures can be summed into pre-aggregated values while cubes are being created. Cubes can contain data that is summarized, copied, or read directly from the data warehouse. Cubes, dimensions, and partitions can be processed (i.e., updated) to incorporate new or changed data from the data warehouse. Time, location, equipment type, or sizes are common dimensions against which measures are calculated and displayed in APM. Note that the data warehouse can be created as a separate database, combining information from APM and other data sources. Alternatively, dimensional cubes can be created by accessing the APM database directly.

Together, Microsoft SQL Server Analysis Services and the Metrics and Scorecards module functionality provide APM users with the ability to analyze data in the APM database using the features of Analysis Services through the APM interface. To use the Metrics and Scorecards functionality, you must incorporate SQL Server Analysis Services into your APM system.

If you choose to implement the Metrics and Scorecards module within your system, we recommend using a configuration in which the Analysis Server exists on a machine that is separate from the APM Server. This deployment scenario most accurately reflects the APM testing environment. The following illustration shows how the SQL Server Analysis Services Server connects to the basic APM System architecture.

Note: While this image depicts only a single, dedicated APM Server, your implementation may contain one or more of these machines. The purpose of this image is to depict the interaction of the SQL Server Analysis Server with the basic APM components, not to provide details on the basic components themselves. While your APM system may contain multiple dedicatedAPM Servers, it will contain only a single SQL Server Analysis Server that all of those APM Servers will access.

Deploying Metrics and Scorecards

After you have installed and configured the basic APM system architecture, you will need to perform some configuration steps specifically for Metrics and Scorecards.

Note: For more information about performing the configuration steps, refer to the Deployment section of the Metrics and Scorecards documentation.

Metrics and Scorecards Security Groups

The following table lists the baseline Security Groups available for users within this module, as well as the baseline Roles to which those Security Groups are assigned.

Important: Assigning a Security User to a Role grants that user the privileges associated with all of the Security Groups that are assigned to that Role. To avoid granting a Security User unintended privileges, before assigning a Security User to a Role, be sure to review all of the privileges associated with the Security Groups assigned to that Role. Also, be aware that additional Roles, as well as Security Groups assigned to existing Roles, can be added via Security Manager.
Security GroupRoles
MI Metrics Administrator

MI Foundation Admin

MI Metrics User

MI  Foundation Power

MI Foundation User

MI Metrics ViewerMI APM Viewer
Everyone

MI Foundation Admin

MI Foundation Power

MI Foundation User

The baseline family-level privileges that exist for these Security Groups are summarized in the following table.

Family

MI Metrics Administrator

MI Metrics User

MI Metrics Viewer
Entity Families
Analysis Services CubeView, Update, Insert, DeleteViewView
KPIView, Update, Insert, DeleteView, Update, Insert, DeleteView

KPI Measurement

 View, Update, Insert, Delete View, Update, Insert, Delete View
ScorecardView, Update, Insert, Delete View, Update, Insert, Delete View
Relationship Families
Has KPI MeasurementView, Update, Insert, DeleteView, Update, Insert, DeleteView
Has PrivilegesView, Update, Insert, DeleteView, Update, Insert, DeleteView
Has Sub IndicatorsView, Update, Insert, DeleteView, Update, Insert, DeleteView
Is Used By ScorecardView, Update, Insert, DeleteView, Update, Insert, DeleteView

In addition to performing functions associated with the family-level privileges described in this table, members of the MI Metrics Administrator Security Group:

  • Can manage cube privileges by granting view access to the users.
  • Has full access to all KPIs, Scorecards, and Cubes without needing to be granted additional privileges via the APM.

Metrics and Scorecards Data Model

The following diagram illustrates how the entity and relationship families that are used in Metrics and Scorecards are related to one another. The shaded boxes represent entity families, and the arrows represent relationship families. You can determine the predecessor and successor in each relationship definition from the direction of the arrow head:
  • The box from which the arrow originates is the predecessor in that relationship definition.
  • The box to which the arrow head points in the successor in that relationship definition.

This family is not enabled for site filtering, which means that records in this family can be accessed by any user with the appropriate license and family privileges. For more information, refer to the Sites section of the documentation.

In this image, you can see that:

  • KPI records can be related to other KPI records through the Has Sub-Indicators relationship.
  • The SSAS Servers family is not related to any other families. SSAS Servers record support Metric Views.
  • The Analysis Services Cube family is not linked to any other KPI families. Analysis Services Cube records support Metric Views.

Metrics and Scorecard Security Groups

The following baseline Security Groups are provided for the Metrics and Scorecards module:

  • MI Metrics Administrator: Provides users with full access to all Metrics and Scorecards features and functions.
  • MI Metrics User: Provides users with view-only access to Metrics and Scorecards functionality, provided that they have been granted the necessary entity-level permissions.

The baseline privileges for these Security Groups are summarized in the following table.

FamilyMI Metrics AdministratorMI Metrics User
Analysis Services Cube View, Update, Insert, Delete View
KPI View, Update, Insert, Delete View, Update, Insert, Delete
KPI Measurement View, Update, Insert, Delete View, Update, Insert, Delete
Has KPI Measurement View, Update, Insert, Delete View, Update, Insert, Delete
Scorecard View, Update, Insert, Delete View, Update, Insert, Delete
Has Privileges View, Update, Insert, Delete View, Update, Insert, Delete
Has Sub Indicators View, Update, Insert, Delete View, Update, Insert, Delete
Is Used By Scorecard View, Update, Insert, Delete View, Update, Insert, Delete

In addition to performing functions associated with the family-level privileges described in the previous table, members of the MI Metrics Administrator Security Group:

  • Can see the Manage Cubes button on the Metrics and Scorecards page in the APM application.
  • Can manage privileges for all KPIs in the APM application.
  • Can manage privileges for all Scorecards in the APM application.
  • Have full access to all KPIs, Scorecards, and Cubes without needing to be granted additional privileges via the APM application.

Metrics and Scorecards URLs

There is one URL route associated with Metrics and Scorecards: metrics. The following table describes the various paths that build on the route, and the elements that you can specify for each.

Tip: For more information, refer to the URLs section of the documentation.
ElementDescriptionAccepted Value(s)Notes
metrics/home: Opens the Metrics and Scorecards page, displaying the Scorecards, the Metric Views, and the KPIs.
metrics/register-cube: Opens the Manage Cubes page.
metrics/<WorkspaceName>/<EntityKey>: Opens the existing Scorecard, Metric Views, and the KPIs.
<Workspace>Specifies the workspace in which you want to open a Scorecard, Metric View, or a KPI.scorecard-tile-viewThe specified Scorecard will appear in the details workspace.
kpi-viewerThe specified KPI will appear in the details page.
kpi-designerThe specified KPI will appear in the design page.
metric-view-designerThe details of the specified Metric Views will appear in the workspace.
<EntityKey>Specifies the level of the asset hierarchy for which you want to view health information. Any numeric Entity Key that corresponds to an existing Scorecard, Metric View, or a KPI.N/A
0Opens a new design page for a Scorecard, Metric View, or a KPI.

Example URLs

Example URLDestination
metrics/home The Metrics and Scorecard page.
metrics/scorecard-designer/0 The design page for a new Scorecard.
metrics/kpi-designer/0 The design page for a new KPI.
metrics/metric-view-designer/0 The design page for a new Metric View.
metrics/scorecard-tile-view/64253576972 The Scorecard details page for the specified scorecard.
metrics/kpi-viewer/64253550109 The KPI details page for the specified KPI.
metrics/metric-view/64253518247 The Metric View details page for the specified Metric View.