Analytics is an add-on module to Web Port whose purpose is to analyze data and behaviors of connected systems. This is to give the opportunity to work proactively instead of reactively.
Analytics is just like Web Port built to be adaptable and able to solve different needs.
This first version has two different analysis functions, Performance Analysis and System Analysis.
Installation
Analytics is an add-on that needs to be selected when installing Web Port (ExtAnalytics).
Permission management
To give users permission to Analytics, the following functional rights are available:
| Function: | Description: |
| Analytics | General permission for the entire Analytics |
| Analytics - Performance | Permission for Performance Analysis |
| Analytics - System | Performance for System Analysis |
Tip!
Permissions can be linked to both users and groups. For more information on this, see Chapter "Access Management" in the Main Manual.
In order for Analytics to appear in the menu, at least VIEW rights are needed for either Analytics or Analytics - Performance.
Analytics - System requires at least SYSTEM right.
To be able to create Performance Analyzes, a SYSTEM right is required.
Performance analysis is usually linked to pages and directories where the user needs at least ADVANCED to create analyzes. VIEW is enough to be able to look at analyzes.
Performance analysis
Performance analysis is used to see how different types of systems work over time. An analysis is based on one or more sub-analyzes. Sub-analyzes can be of several different types (See Analysis types) that are set up to monitor, for example, regulation or stability. Each sub-analysis generates a grade which is then weighted together into a total grade for the entire analysis.
The overview for Performance Analysis can be found in the menu via Analytics / Performance. This view lists all the analyzes to which the user is authorized. The sorting is such that analyzes with large changes are listed first and then depending on grades.
The table shows the current grade and a graph for the last 30 days. It also shows how much the grade has changed in the last day, the last 30 and 7 days respectively. Color markings are also used to indicate major changes according to:
| Color: | Description: |
| RED | Greater reduction in grade (more than 2 grading units) |
| GREEN | Larger increase in the grade (more than 2 grading units) |
| BLUE | Less than 2 rating units change |
Tip!
The table can be sorted manually by clicking on the respective column heading.
To search/filter the table, use the search bar in the toolbar at the top right.
Manage analyzes
To create new analyzes, SYSTEM permission is required for either Analytics or Analytics - Performance. The user also needs at least ADVANCED permission for the pages or directories to which the analyzes are to be linked.
Add:
To add a new analysis, use the Add analysis button in the toolbar. The following settings can be specified on the analysis:
| Setting: | Description: |
| Name | The name of the analysis |
| Description | Description of the analysis |
| Category | Category for grouping analyzes into different types |
| Link to | Link to page or directory |
Tip!
Think through how analyzes are named, how descriptions are set and how grouping into categories is made. This will make it easier in the long run when you want to filter out similar systems, or search the table.
When the desired fields have been filled in, click save to add the analysis.
Edit:
To edit an analysis, click its name in the table to open the side menu. In the side menu, you can either navigate further into the sub-analyzes via the Show button, or select Edit to change overall settings.
Tip!
To access sub-analyzes faster, the icon to the left of the analysis name can be clicked.
Delete:
To delete an analysis, click its name in the table to open the side menu. In the side menu, then click the Delete button. Another question comes up to confirm that the analysis will be removed.
Sub-analyzes
The view for the sub-analyzes is where most of the configuration and analysis is done. This view is accessed by navigating further from the overall analysis by either clicking on the icon to the left of the name in the table or via the side menu.
This view consists of the following parts:
- A pie chart that shows how much the various sub-analyzes affect the overall rating.
- Rating diagrams of the various sub-analyzes and how they vary over the past year.
- Information box that shows daily data when clicking in the rating diagram.
- Table of detailed sub-analyzes.
Information:
When clicking on one of the curves in the rating diagram, information about the analysis is displayed in the information box. The information available varies depending on the analysis. There is also a button to reach trends if available.
The table shows the current grade for each sub-analysis and a graph for the last 30 days. It also shows how much the grade has changed in the last day, the last 30 and 7 days respectively. Color markings are also used to indicate major changes according to:
| Color: | Description: |
| RED | Greater reduction in grade (more than 2 grading units) |
| GREEN | Larger increase in the grade (more than 2 grading units) |
| BLUE | Less than 2 rating units change |
Tip!
The table can be sorted manually by clicking on the respective column heading.
To search/filter the table, use the search bar in the toolbar at the top right.
Add:
To add a new sub-analysis, use the Add subanalysis button in the toolbar.
Settings are made in two steps where the first involves choosing the type of sub-analysis to be added. See chapter on Analysis types for more information. The following settings can be specified on the analysis:
| Setting: | Description: |
| Name | The name of the analysis |
| Description | Description of the analysis |
| Category | Category for dividing sub-analyzes into different types |
| Color | Indicates what color the sub-analysis should have in diagrams etc |
| Score Weight | Indicates how the grade from one sub-analysis is to be weighted in relation to the others |
| Valid from | Specifies a time from when trend data is valid to use for analysis |
Tip!
Think through how analyzes are named, how descriptions are set and how grouping into categories is made. This will make it easier in the long run when you want to filter out similar systems, or search the table.
Information:
Each sub-analysis has additional settings that depend on the type of analysis selected. See the respective chapters for the Analysis type where these settings are described.
When the desired fields have been filled in, click save to update the partial analysis.
Edit:
To edit a sub-analysis, click its name in the table to open the side menu. In the side menu you can reach Trend, Edit or Delete selected analysis.
Tip!
To deactivate sub-analyses from the grading chart, the gray box on the left of the table can be clicked.
Delete:
To delete a sub-analysis, click its name in the table to open the side menu. In the side menu, then click the Delete button. Another question arises to confirm that the sub-analysis is removed.
Types of analysis
This chapter describes the different types of analysis that can be used as sub-analyses. Many types of analysis can have several uses.
Control analysis:
This analysis is used to evaluate regulations.
The following settings are available in addition to the standard for rule analyzes:
| Setting: | Description: |
| Analysis active when | Expression for when the analysis should be active |
| Process value | Tag for process value |
| Setpoint | Setpoint tag |
| Controller output | Controller output tag (optional) |
| Adjacent signals | Comma-separated list of adjacent signals (displayed in trend) |
Information:
The expression for when the analysis is active is given as a Boolean expression. For example, TAG> 0, where TAG is the name of a trend tag in the system.
The following comparisons can be made (>, <, =).
Information:
Adjacent signals support * (one or more optional characters) and # (one or more optional digits). For example. VS01_ * to include all trend tags starting with VS01_
Power analysis:
Power analysis is used to produce a power signature based on a power meter and an outdoor temperature. This signature can then be used to evaluate how well the system follows the signature over time.
The following settings are available in addition to the standard for effect analyzes:
| Setting: | Description: |
| Tag temperature | Tag for outdoor temperature |
| Tag power | Tag for current power output |
| Base power | Base power (optional) |
| Limit temperature for signature | Limit temperature for signature calculation (optional). Example: <17 |
| Custom signature inclination | Possibility to specify manual slope for signature |
| Custom signature offset | Possibility to specify manual offset for signature |
Stability analysis:
Analysis intended to rate signals that must be within a given range.
The following settings are available in addition to the standard for stability analyzes:
| Setting: | Description: |
| Analysis active when | Expression for when the analysis is active |
| Tag | Tag on which the analysis is to be performed |
| Target value | Target value for the tag |
| Lower limit | Lower limit (gives 0 in rating) |
| Upper limit | Upper limit (gives 0 in rating) |
| Lower 20% limit | Lower breakpoint at which 20% deduction is given |
| Upper 20% limit | Upper breakpoint at which 20% deduction is made |
| Adjacent signals | Comma-separated list of adjacent signals (displayed in trend) |
Information:
The expression for when the analysis is active is given as a Boolean expression. For example, TAG> 0, where TAG is the name of a trend tag in the system.
The following comparisons can be made (>, <, =).
Balance analysis:
Analysis intended to evaluate systems where incoming and outgoing quantities should be in balance.
The following settings are available for balance analysis in addition to the general settings:
| Setting: | Description: |
| Analysis active when | Expression for when the analysis is active |
| Tags in | Comma-separated list of incoming tags |
| Tags out | Comma-separated list of outgoing tags |
| Expected loss | Expected loss (optional) |
| Maximum loss | Maximum loss where 0 score is given |
Information:
The expression for when the analysis is active is given as a Boolean expression. For example, TAG> 0, where TAG is the name of a trend tag in the system.
The following comparisons can be made (>, <, =).
Custom analysis:
Analysis based on a call script. This can be used to solve analysis cases where other analyzes are not sufficient.
The following settings are available in addition to the standard for custom analyzes:
| Setting: | Description: |
| Call script | Name of the called script to be used |
| Parameter 1 | Value sent as a parameter to the script (par1) |
| Parameter 2 | Value sent as a parameter to the script (par2) |
| Parameter 3 | Value sent as a parameter to the script (par3) |
Actions
Actions are used to register changes so that you can follow score development after work has been performed. Actions appear as a blue vertical bar in the rating chart at the time the action was performed.
Add:
To add a new action, use the New action button in the toolbar. The following settings can be specified on the action:
| Setting: | Description: |
| Heading | Short title for the action |
| Description | Possibility for a longer description of what has been done |
| Executed | Date of when the action was performed |
Edit:
To edit an action, click the blue triangle at the bottom of the blue vertical bar that shows the action performed in the rating chart. In the side menu that appears, it is possible to adjust the title and description. Here you can also see who created the action and when it was carried out.
Delete:
To delete an action, click the blue triangle at the bottom of the blue vertical bar that shows the action performed in the rating chart. Then click Delete in the side menu and confirm.
System analysis
System Analysis is a dashboard that provides an overview of the Web Port and shows how the program works and is used. The view can be time-adjusted by selecting the day, month or year in the toolbar at the top.
The following information boxes are displayed:
| Infobox: | Description: |
| Summary | Displays information about the current version and license |
| Statistics | Displays information about different quantities in the system |
| System status | Displays information CPU, memory and storage and how Web Port affects |
| Frequent users | Displays information about most / least active users |
| Frequently changed systems | Displays information about the systems where most tags have been changed |
| Recent events | Displays excerpts from the system log |
| Recent changes | Displays excerpts from the change log |
| Recent errors | Displays excerpts from the error log |
Tip!
Frequent users and frequently changed systems can be sorted by clicking on any of the MOST, MINIMUM and ALL buttons.
The system status graph can be customized to display CPU, MEMORY or DISK by clicking the respective button. The graph moves from right to left where the x-axis is in time and the y-axis is given in %.