Analytics Module Part 5: Viewing , Editing, and Sharing Correlation Analysis and Alerts


Overview

 

Viewing, Sharing, and Deleting Analyses

Analyses can be controlled from the main Analytics page. 

 

 

1. Getting to Analytics- Navigate to the Analytics main page by selecting the Analytics icon on the left side toolbar. 

2. Analysis Selection Options- Clicking an Analysis name will take you back into the Analysis. Clicking the checkbox to the left of the Analysis name enables the sharing and deletion controls explained below. 

3. Share- Clicking the share button opens up the Sharing settings window. The three options will be explained below. 

 

 

a. Private- By default, all profiles are set to private until they are shared. This means only the creator of the profile has access and visibility to the profile.

b. Restricted- By selecting Restricted, you can choose the users that you would like to have access to the profile by using the search bar or scrolling through the user list. A checkbox next to their name means they will have access. Unchecking a user means they will lose access and no longer be able to see a profile.

c. Project-wide- Project-wide access will give all users on the project access to the profile. 

d. Save- Click the "Save" button to save your changes. 

 

4. Delete- The delete button, or trashcan, allows you to delete the selected Analysis.

 

Editing and Rerunning an Existing Analysis

1. Getting to Analytics- Navigate to the Analytics main page by selecting the Analytics icon on the left side toolbar. 

2. Analysis Selection Options- Clicking an Analysis name will take you back into the Analysis.

 

 

3. Opening Analysis Edit- Once on the Analysis Correlation Matrix page, click the "Edit" button in the upper right. 

 

 

 

4. You can review your analysis settings, change sensors, or adjust parameters from this page.

5. Once complete, you can rerun the analysis with the "Save and Run" button in the upper right corner.

 

 

Viewing, Editing, and Sharing Correlation Alerts in the Alerts Module

Correlation alerts created in the Analysis module will be housed in the Alerts module as well. The steps below will show you how to view the Correlation alert from the Alerts module. 

 

 

1. Navigate to the Alerts module by clicking on the Alerts icon on the left sidebar. 

2. Correlation alerts can be found by looking at the Alert Type column. Click on the name of the alert to go to the Alert page shown below. This page offers a variety of information about the alert, including sharing options. 

 

 

3a. Sharing Alert- Clicking the share button in the upper toolbar opens the sharing settings window shown below. The three options will be explained below. 

 

 

a. Private- By default, all profiles are set to private until they are shared. This means only the creator of the profile has access and visibility to the profile.

b. Restricted- By selecting Restricted, you can choose the users that you would like to have access to the profile by using the search bar or scrolling through the user list. A checkbox next to their name means they will have access. Unchecking a user means they will lose access and no longer be able to see a profile.

c. Project-wide- Project-wide access will give all users on the project access to the profile. 

d. Save- Click the "Save" button to save your changes. 

 

3b. Alert Threshold Formula and Graphs- The alert thresholds are provided as an equation via the alert thresholds card in the middle of the page, or you can visualize the thresholds via the graph at the bottom of the page. The red shaded areas represent the alert threshold boundaries.

3c. Trigger History- Information about the trigger history can be visualized two ways on the Alert page. The Trigger History card on the upper left provides in-depth information about the times that the alert has triggered and the data that triggered it. The Trigger count in the upper right provides a quick reference of how many times the alert has been triggered.

3d. Alert Edit- Clicking the "Edit" pencil icon takes you to the Alert configuration window below, where you can adjust sensors, alert thresholds, and other elements of the alert. 

 

 

Viewing Alert Thresholds in Analysis Module

You can also view multiple alerts on the same graph within the Analysis Module.

1. Getting to Analytics- Navigate to the Analytics main page by selecting the Analytics icon on the left side toolbar. 

2. Analysis Selection Options- Clicking an Analysis name will take you back into the Analysis.

 

 

3. Sensor Pair Selection- Select the sensor pair you've set alerts for by clicking on the tile.

 

 

4. Alerts- Click the Alerts tab on the upper right side of the analysis window. 

5. Turning on Alerts- If there are alerts configured for the sensor pair, they will show up in the Alerts list. To toggle them on, click the eyeball icon next to the alerts you want to visualize. The example image below shows  linear and quadratic equation alerts simultaneously turned on.