Metrics and Scorecards Deployment
Deploy Metrics and Scorecards for the First Time
The following table outlines the steps that you must complete to deploy and configure this module for the first time. These instructions assume that you have completed the steps for deploying the basic system architecture.
These tasks may be completed by multiple people in your organization. GE Vernova recommends, however, that the tasks be completed in the order in which they are listed.
Step | Task | Notes |
---|---|---|
1 | Deploy SQL Server Analysis Services 2016. Ensure that the SQL Server Analysis Services machine meets the system requirements.
Deploying SQL Server Analysis Services on the SQL Server Analysis Server machine includes the following steps:
| This step is required. This step assumes that you have read the Metrics and Scorecards hardware and software requirements and that you have obtained the SQL Server Analysis Services software installer. |
2 | Verify that your event and asset criticality data meet the standard classification requirements, and modify the Event or Asset Criticality Data for the Work History cube as needed. | This step is required. |
3 | Localize the event and asset criticality values in the application. | This step is optional. |
4 | Schedule cubes for processing on the SQL Server Analysis Server. | This step is required. |
5 | Assign Security Users to one or more of the Metrics and Scorecards Security Groups and Roles. | This step is required. |
6 | Create Analysis Services Cube records for each cube that has been defined in SQL Server Analysis Services. Since APM uses HTTP connection to connect to the cube, in addition to server address, you need to provide credentials of the user created in Step 1 Task 3. | This step is required. |
7 | Grant Security Users and Groups access rights to Analysis Services Cube records . | This step is required. |
8 | Configure privileges for KPI. | This step is required. |
9 | Configure privileges for Scorecards. | This step is required. |
10 | Configure a cube for usage metrics tracking on the SQL Server Analysis Server. | This step is required only if you use Metrics and Scorecards to view the usage metrics in a cube. |
About Configuring a Cube for Usage Metrics Tracking
You can track the activity of the users in your system. Usage metrics are stored in the MI_SEC_LOG_EVENTS system table. When a user logs in to APM, actions of the user are stored in batches for that session in the MI_SEC_LOG_EVENTS table.
- Successful logins
- Failed logins
- Password changes
- User account creation, activation, deactivation, modification
- Session expiry
Column ID | Description |
---|---|
SECL_KEY | Stores the values that identify the events in the MI_SEC_LOG_EVENTS table. |
SECL_EVENT_NM | Stores the names of the events. |
SECL_USER_ID | Stores the user IDs of the users who attempt to log in to APM. |
SECL_ADMIN_ID | Stores the user IDs of the Administrators who create, update, and delete users. |
LAST_UPDT_DT | Stores the value that identifies the date and time when a record was last updated. |
To view the usage metrics that have been tracked for your system, you must create a cube based upon the MI_SEC_LOG_EVENTS table. After you create the cube, you must join the MI_SEC_LOG_EVENTS and the MIV_MI_IS_A_USER tables. You must also join the MIV_MI_IS_A_USER and MIV_MI_HUMAN_RESOURCE tables.
About Scheduling Cubes for Processing
An Analysis Services cube is a combination of measures and dimensions that together determine how a set of data can be viewed and analyzed. A cube is a static object and initially represents the data that existed in Analysis Services for the selected measures and dimensions when the cube was created. To keep a cube current, it must be processed regularly, whereby the cube is updated with the most current data in Analysis Services.
To make sure that a cube always provides users with the most current data, you should schedule it for processing regularly, usually on a daily basis. One way to process cubes and shared dimensions successfully is to do so manually on the Analysis Server. Using this method, you can process shared dimensions first, and then process the related cubes. Processing cubes manually, however, is not a viable option if you have many cubes that you want to process on a daily basis.
Instead, a preferable option would be to schedule cubes for processing using Data Transformation Services (DTS). This functionality is available in the SQL Server Business Intelligence Development Studio, which is included in SQL Server Standard Edition. For details on creating a DTS package that can be used to process objects according to a custom schedule, see your SQL Server documentation.
Install SQL Server Analysis Services on the Server
SQL Server Analysis Services is the foundation for the APM Metrics and Scorecards module because it serves as a storage and management mechanism for cubes, which can then be accessed and viewed via APM. To support Metrics and Scorecards features, SQL Server Analysis Services must be installed on the machine that will serve as the Analysis Server. The Analysis Server must be set up as a machine that is separate from the APM Application Server.
Where Does This Software Need to Be Installed?
SQL Server Analysis Services must be installed on the machine that will function as the Analysis Server. You do not need to install any SQL Server components on the Application Server to support the Metrics and Scorecards functionality.
Performing the Installation
SQL Server Analysis Services can be installed using the SQL Server Standard Edition installation package, which you may have received from APM or from a third-party vendor, depending upon the licensing options you selected when you purchased the APM product. Instructions for performing the installation can be found in the documentation included in the SQL Server Standard Edition installation package.
Creating the Analysis Services Database, Data Source, and Cubes
In addition to creating the Analysis Services database, data source, and cubes, the cubes must be processed before they will be available for use in the APM system. For details on completing these tasks, consult your SQL Server documentation.
Deploy the Work History Cube
Procedure
About Modifying the Work History Cube
The baseline Work History cube provided with the Metrics and Scorecards module uses the following standard classifications for event and asset criticality data. If the event or asset criticality data in your database cannot be classified as one of following the standard IDs, the data, by default, will be classified as Unknown.
- Event Type
- Standard Event Types
- ID: Miscellaneous; Caption: Miscellaneous
- ID: PM/PdM; Caption: PM/PdM
- ID: Repair; Caption: Repair
- ID: Unknown; Caption: Unknown
- Standard Event Types
- Event Breakdown Indicator
- Standard Event Breakdown Indicators
- ID: N, Caption: N
- ID: Y, Caption: Y
- ID: Unknown, Caption: Unknown
- Standard Event Breakdown Indicators
- Event Priority
- Standard Event Priorities
- ID: 1, Caption: Very Low
- ID: 2, Caption: Low
- ID: 3, Caption: Medium
- ID: 4, Caption: High
- ID: 5, Caption: Emergency
- ID: Unknown, Caption: Unknown
- Standard Event Priorities
- Event Detection Method
- Standard Event Detection Methods
- ID: 0001, Caption: Continuous Condition Monitoring
- ID: 0002, Caption: Corrective Maintenance
- ID: 0003, Caption: Formal Inspection
- ID: 0004, Caption: Operator Routine Observation
- ID: 0005, Caption: Periodic Condition Monitoring
- ID: 0006, Caption: Preventive Maintenance
- ID: 0007, Caption: Production Interference
- ID: 0008, Caption: Radar Operator Observation
- ID: Unknown, Caption: Unknown
- Standard Event Detection Methods
- Asset Criticality Data
- Standard Asset Criticality Data
- ID: A, Caption: High
- ID: B, Caption: Medium
- ID: C, Caption: Low
- ID: Unknown, Caption: Unknown
- Standard Asset Criticality Data
Modify the Event or Asset Criticality Data for Work History Cube
If the event or asset criticality data in your database does not match with the standard IDs used for the work history cube, then you have to modify the corresponding views on the server or map the event or asset criticality data to the standard event or asset criticality data using the corresponding families.
Modify the Non-Standard Event Type Data Using the View
Before You Begin
- Log in to SQL Server Management Studio and connect to the database.
- Verify the standard classification defined for event or asset criticality data.
Procedure
Example
CASE MI_EVENT_TYP_CHR
WHEN 'Miscellaneous' THEN 'Miscellaneous'
WHEN 'PM/PdM' THEN 'PM/PdM'
WHEN 'Repair' THEN 'Repair'
WHEN 'Inspection' THEN 'PM/PdM'
ELSE 'Unknown'
END AS EventType
Modify the Non-Standard Event Priority Data Using the View
Before You Begin
- Log in to SQL Server Management Studio and connect to the database.
- Verify the standard classification defined for event or asset criticality data.
Procedure
Example
CASE ISNULL(MI_EVWKHIST_ORDR_PRTY_C, MI_EVWKHIST_RQST_PRTY_C)
WHEN 'Very Low' THEN '1'
WHEN 'Low' THEN '2'
WHEN 'Medium' THEN '3'
WHEN 'High' THEN '4'
WHEN 'Emergency' THEN '5'
WHEN '1' THEN '1'
WHEN '2' THEN '2'
WHEN '3' THEN '3'
WHEN '4' THEN '4'
WHEN '5' THEN '5'
WHEN 'M' THEN '3'
ELSE 'Unknown'
END AS Priority
Modify the Non-Standard Event Detection Method Data Using the View
Before You Begin
- Log in to SQL Server Management Studio and connect to the database.
- Verify the standard classification defined for event or asset criticality data.
Procedure
Example
CASE MI_EVWKHIST_DETCT_MTHD_CD_C
WHEN 'Continous Condition Monitoring' THEN '0001'
WHEN 'Corrective Maintenance' THEN '0002'
WHEN 'Formal Inspection' THEN '0003'
WHEN 'Operator Routine Observation' THEN '0004'
WHEN 'Periodic Condition Monitoring' THEN '0005'
WHEN 'Preventive Maintenance' THEN '0006'
WHEN 'Production Interference' THEN '0007'
WHEN 'Radar operator Observation' THEN '0008'
WHEN '0001' THEN '0001'
WHEN '0002' THEN '0002'
WHEN '0003' THEN '0003'
WHEN '0004' THEN '0004'
WHEN '0005' THEN '0005'
WHEN '0006' THEN '0006'
WHEN '0007' THEN '0007'
WHEN '0008' THEN '0008'
WHEN '0009' THEN '0001'
ELSE 'Unknown'
END AS DetectionMethod
Modify the Non-Standard Event Breakdown Data Using the View
Before You Begin
- Log in to SQL Server Management Studio and connect to the database.
- Verify the standard classification defined for event or asset criticality data.
Procedure
Example
CASE MI_EVWKHIST_BRKDN_IND_F
WHEN 'Y' THEN 'Y'
WHEN 'N' THEN 'N'
WHEN 'No' THEN 'N'
ELSE 'Unknown'
END AS Breakdown
Modify the Non-Standard Equipment Criticality Data Using the View
Before You Begin
- Log in to SQL Server Management Studio and connect to the database.
- Verify the standard classification defined for event or asset criticality data.
Procedure
Example
CASE MI_EQUIP000_CRITI_IND_C
WHEN 'HIGH' THEN 'A'
WHEN 'Medium' THEN 'B'
WHEN 'Low' THEN 'C'
WHEN 'A' THEN 'A'
WHEN 'B' THEN 'B'
WHEN 'C' THEN 'C'
WHEN 'H' THEN 'A'
ELSE 'Unknown'
END AS EquipmentCriticality
Modify the Non-Standard Functional Location Criticality Data Using the View
Before You Begin
- Log in to SQL Server Management Studio and connect to the database.
- Verify the standard classification defined for event or asset criticality data.
Procedure
Example
CASE A.MI_FNCLOC00_CRTCAL_IND_C
WHEN 'HIGH' THEN 'A'
WHEN 'Medium' THEN 'B'
WHEN 'Low' THEN 'C'
WHEN 'A' THEN 'A'
WHEN 'B' THEN 'B'
WHEN 'C' THEN 'C'
WHEN 'M' THEN 'B'
ELSE 'Unknown'
END AS FunctionalLocationCriticality
Map the Non-Standard Event Type Data to Standard Event Type IDs Using Queries for Event Type Dimension Family
This topic describes how to map the event type data available in your database to the standard event type data defined for a work history cube.
Procedure
Map an Event Type to a Standard Event Type ID
EventType | EventTypeCaption |
---|---|
Miscellaneous | Miscellaneous |
PM/PdM | PM/PdM |
Repair | Repair |
Unknown | Unknown |
- INSPECTION
- PM/PdM
- Reading
- Repair
- Run the query
UPDATE [MI_DIM_EVENT_TYPE] SET [MI_DIM_EVENT_TYPE].[EventTypeCaption] = 'INSPECTION' WHERE [MI_DIM_EVENT_TYPE].[EventTypeCaption] = 'Miscellaneous'
.The event type INSPECTION is mapped to the standard event type ID Miscellaneous.
Map the Non-Standard Event Priority Data to Standard Event Priority IDs Using Queries for Event Priority Dimension Family
This topic describes how to map the event priority data available in your database to the standard event priority data defined for a work history cube.
Procedure
Map Event Priority Data to a Standard Event Priority ID
Priority | PriorityCaption |
---|---|
1 | Very Low |
2 | Low |
3 | Medium |
4 | High |
5 | Emergency |
Unknown | Unknown |
- 1
- 2
- 3
- 4
- Run the query
UPDATE [MI_DIM_EVENT_PRIORITY] SET [MI_DIM_EVENT_PRIORITY].[PriorityCaption] = '1' WHERE [MI_DIM_EVENT_PRIORITY].[PriorityCaption] = 'Emergency’
.The event priority data 1 is mapped to the standard event priority ID 5.
Map the Non-Standard Event Detection Methods to Standard Event Detection Method IDs Using Queries for Event Detection Method Dimension Family
This topic describes how to map the event detection methods available in your database to the standard event detection methods defined for a work history cube.
Procedure
Map an Event Detection Method to a Standard Event Detection Method ID
DetectionMethod | DetectionMethodCaption |
---|---|
0001 | Continuous Condition Monitoring |
0002 | Corrective Maintenance |
0003 | Formal Inspection |
0004 | Operator Routine Observation |
0005 | Periodic Condition Monitoring |
0006 | Preventive Maintenance |
0007 | Production Interference |
0008 | Radar Operator observation |
- Inspection
- Observation
- Preventive Maintenance
- Production Interference
- Run the query
UPDATE [MI_DIM_EVENT_DETECTION] SET [MI_DIM_EVENT_DETECTION].[DetectionMethod] = 'Inspection' WHERE [MI_DIM_EVENT_DETECTION].[DetectionMethod] = '0001'
.The event detection method Inspection is mapped to the standard event detection method ID 0001.
Map the Non-Standard Event Breakdown Data to Standard Event Breakdown IDs Using Queries for Event Breakdown Dimension Family
This topic describes how to map the event breakdown data available in your database to the standard event breakdown data defined for a work history cube.
Procedure
Map an Event Breakdown Indicator to a Standard Event Breakdown ID
Breakdown | BreakdownCaption |
---|---|
N | N |
Unknown | Unknown |
Y | Y |
- No
- Yes
- Unknown
- Run the query
UPDATE [MI_DIM_EVENT_BREAKDOWN] SET [MI_DIM_EVENT_BREAKDOWN].[BreakdownCaption] = 'Yes' WHERE [MI_DIM_EVENT_BREAKDOWN].[BreakdownCaption] = 'Y'
.The event breakdown indicator Yes is mapped to the standard event breakdown ID Y.
Map the Non-Standard Asset Criticality Data to Standard Asset Criticality IDs Using Queries for Asset Criticality Dimension Family
This topic describes how to map the asset criticality data available in your database to the standard asset criticality IDs defined for a work history cube.
Procedure
Map Asset Criticality Data to a Standard Asset Criticality ID
Criticality | CriticalityCaption |
---|---|
A | High |
B | Medium |
C | Low |
Unknown | Unknown |
- X
- Y
- Z
- H
- Run the query
UPDATE [MI_DIM_ASSET_CRITICALITY] SET [MI_DIM_ASSET_CRITICALITY].[CriticalityCaption] = 'X' WHERE [MI_DIM_ASSET_CRITICALITY].[CriticalityCaption] = 'High'
.The asset criticality data X is mapped to the standard asset criticality ID A.
Localize the Event or Asset Criticality Values
By default, the Meridium Work History cube displays the event and asset criticality data in English. However, you can modify the event or asset criticality values to other languages supported by APM. The examples in this topic explain how to modify event and asset criticality values, and how you can verify, in APM, that those modifications have been implemented.
Before You Begin
- Log in to SQL Server Management Studio and connect to the database.