Overview

After a check has been made, the extension provides the results separated by tabs (Alarms, Hists, Points, Nodes, and Others) showing the '✓' symbol in the found error column, and an empty field where there are no errors. The column of the table containing the errors is separated by abbreviations, where E1 corresponds to error 1, E2 corresponds to error 2, and so on. The description of what are the errors of the columns of the tables is available above, in a region with the legend of the abbreviations of the errors.

At all times the options of checking or generating a report are available to the user, and only after the first check is available the option to export the scan results to an Excel file '.csv', which will contain all errors found by the analysis separated by areas (alarms, hiss, points and nodes).

Prerequisites

For the current version the prerequisites for this guide are:

• Action.Net an-9.1.3 or higher version installed on the machine;

Detailed description

Extension name:  Project Reviewer

Current Version: 1.3

The Project Reviewer extension is a project checker that collects data from alarms, historians, points, and nodes, analyzes the data collected without saving or modifying any project data, and only informs the designer about the errors found, making no changes or corrections to the project. The extension checks the design elements following the criteria described below:

• Alarms: The formatting of alarms is checked (checking for the existence of 'Tag.', names with spaces or totally blank), the existence of duplicates (the criterion being to be a duplicate have more than one alarm with the TagName, Condition, Limit, Limit 1, Limit 2 equal sums at the same time), the existence of tag alarm in Tags Objects (being checked including all templates), the existence of the alarm area in Alarms Areas, the existence of alarm groups in Alarms Groups and the correlation of the references of the tags used in the descriptions of alarm items, analyzing whether they are from the tag itself.

• Historians: The formatting of historicalities (checking names with spaces or totally blank), the existence of duplicates (the criterion being to be a duplicate has more than one history with the tagName and historiantable equal to the same time), the existence of the historian tag in Tags Objects (being checked including all templates), the existence of historians tables in HistorianTables Tags.

• Points: The formatting of the points (checking names with spaces or totally blank), the existence of duplicates (the criterion being to be a duplicate has more than one point with the TagName, Node, Address equal at the same time), the existence of tag point in Objects Tags (being checked including all templates), the existence of the nodes of points in Devices Nodes, the existence of the points accessTypes in Devices AccessTypes.

• We: The existence of the Channel of the nodes in Device Channels is checked.

• Others: The ID, name of all alarm groups, nodes, and Channels that are not used in the project or that have a space in their names is shown.

The results of all analysis are computed at once, with just one click of the 'Check' button, and are organized by tabs (Alarms, Hiss, Points, Nodes and Others). Within each tab, there is a legend region describing what each error abbreviation means and the error count found (available only after a scan). Below is a table that contains the columns 'ID', 'TagName' (or 'Name' in the case of nodes) and the abbreviations of the errors, where E1 means error 1, E2 means error 2, and so on. If after analyzing one or more tables in the tabs are empty, then there are no errors in this area (it can also be seen in the name of the tab that will have the number zero). There is also a total project error counter, available at the top right, 'Total Errors'. If there are any errors in the tab, the '✓' symbol will be shown in the found error column, and an empty field in the columns where there are no errors. After the first analysis done, the 'Export' button is available to the user, which exports a log of all errors found separated by areas, to an Excel file '.csv'. The location where this Excel log will be saved is chosen by the user, as is the file name, which by default is 'Project Reviewer Analysis day-month-year hour-minutes-seconds'. In addition, the "Report" button is available at all times, which generates a report of all tags created in the server domain project, exporting this data to an Excel file.

Use

Check the project

To check the project, simply select the desired options in the options area and click the Check button once (Figure 1.0), and wait for analysis. The 'Check' button automatically checks all areas (Alarms, Hiss, Points, Knots), and it takes only one click to check the project completely. The analysis may take depending on the size of the project, your analysis progress can be tracked by the progress bar at the bottom of the extension window that will be visible when you start the process (Figure 1.1).

Open

Open

View results

After the project has been first verified (as described in Verify the project), the user can view the results of the analysis. The window is separated into 4 areas.

• The first area (highlighted in Figure 2.0) has the option to select the result you want to view. The options are Alarms, Hiss, Points, Knots and Others by simply clicking on the tab to select it.

• The second area (highlighted in Figure 2.1) shows the caption of the abbreviations of the errors, the amount of errors found in the selected tab, and the total number of errors found in the project.

• The third area (highlighted in Figure 2.2) is a table with the results of the analysis, the columns being separated by 'ID', 'TagName' (or 'Name' in the case of Nodes and Others) and the abbreviations of errors, where E1 means error 1, E2 means error 2, and so on. If no errors have been found in a specific tab, the tab name will have a zero next to it, and the table is empty (example in Figure 2.3). If an error is found, the fields in the 'ID' and TagName table (or 'Name' in the case of Nodes and Others) will be filled in with the faulty tag, and will be indicated with a '✓' symbol in the found error column, and an empty field in the columns where there are no errors (example in Figure 2.2). The total amount of errors found in the project is available above the tab errors, by the identifier 'Total errors' (example in Figure 2.3). You can filter the view of the errors found by ID, tag name, or errors, so simply drag the table title column to the 'Drag a column header here to group by that column. (example in Figure 2.4).

• The fourth area (highlighted in Figure 2.5) is the options session. It features extra options for analyzing data and exporting the Tags report, such as allowing duplicates for points and hist. Whenever a change in options is made, it will only take effect after a new check or export of the report is made.

Export errors

After the project has been first verified, the user can export the results to an Excel file '.csv'. To do this, simply click the 'Export' button (highlighted in figure 3.0). After the click, a new window will open in which you can choose the location that the file will be saved, and the file name (which by default is 'Project Reviewer Analysis day-month-year hour-minutes-seconds'). After choosing the file name and location, simply click 'Save' to save or 'Cancel' to not save (example in Figure 3.1).

Generate report

To generate a complete project Tags report, simply click the 'Report' button (highlighted in Figure 4.0). When you click, a window opens to choose a location and file name to save the report (by default the name is 'Project Reviewer Report day-month-year hour-minutes-seconds'). After choosing the file name and location, simply click 'Save' to save or 'Cancel' to not save and not run the report process (example in Figure 4.1), and then automatically start the process of generating the report, which can take time depending on the size of the project, and your progress can be tracked by the progress bar at the bottom of the extension window that will be visible when you start the process.