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 GE Digital 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 GE Digital APM:
- Microsoft SQL Server Analysis Services 2012
- Microsoft SQL Server Analysis Services 2014
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 GE Digital APM. Note that the data warehouse can be created as a separate database, combining information from GE Digital APM and other data sources. Alternatively, dimensional cubes can be created by accessing the GE Digital APM database directly.

Together, Microsoft SQL Server Analysis Services and the Metrics and Scorecards module functionality provide GE Digital APM users with the ability to analyze data in the GE Digital APM database using the features of Analysis Services through the GE Digital APM interface. To use the Metrics and Scorecards functionality, you must incorporate SQL Server Analysis Services into your GE Digital 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 GE Digital APM Server. This deployment scenario most accurately reflects the GE Digital APM testing environment. The following illustration shows how the SQL Server Analysis Services Server connects to the basic GE Digital APM System architecture.

Note: While this image depicts only a single, dedicated GE Digital 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 GE Digital APM components, not to provide details on the basic components themselves. While your GE Digital APM system may contain multiple dedicatedGE Digital APM Servers, it will contain only a single SQL Server Analysis Server that all of those GE Digital APM Servers will access.

Deploying Metrics and Scorecards

After you have installed and configured the basic GE Digital 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.

Supported Features in APM Now

In the APM Now GE Digital APM Unified V1.0.5.0 environment, cube registration and modification is unavailable. All other standard GE Digital APM product features for this module are available.

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 Site Filtering 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 Group

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.


Family	MI Metrics Administrator	MI 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 GE Digital APM application.
Can manage privileges for all KPIs in the GE Digital APM application.
Can manage privileges for all Scorecards in the GE Digital APM application.
Have full access to all KPIs, Scorecards, and Cubes without needing to be granted additional privileges via the GE Digital 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.


Element	Description	Accepted Value(s)	Notes
metrics/home: Opens the Metrics and Scorecards page, displaying the Scorecards, KPIs, and the Metric Views.
metrics/register-cube: Opens the Manage Cubes page.
metrics/<WorkspaceName>/<EntityKey>: Opens the existing Metric Views, Scorecard, and the KPIs.
<Workspace>	Specifies the workspace in which you want to open a Scorecard, KPI, or a Metric View.	scorecard-tile-view	The specified Scorecard will appear in the details workspace.
		scorecard-designer	The specified Scorecard will appear in the design workspace.
		kpi-viewer	The specified KPI will appear in the details page.
		kpi-designer	The specified KPI will appear in the design page.
		metric-view-designer	The 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, KPI, or a Metric View.	N/A
<EntityKey>		0	Opens a new design page for a Scorecard, KPI, or Metric View.

Example URLs


Example URL	Destination
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.