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
A extensão Project Reviewer é um verificador de projetos que coleta os dados de alarmes, historiadores, pontos e nós, analisa os dados coletados sem salvar ou modificar qualquer dado do projeto, e apenas informa ao projetista sobre os erros encontrados, não fazendo nenhuma alteração ou correção no projeto. A extensão verifica os elementos do projeto seguindo os critérios descritos abaixo:
Alarmes: É checada a formatação dos alarmes (verificando a existência de ‘Tag.’, nomes com espaços ou totalmente em branco), a existência de duplicados (sendo o critério para ser um duplicado ter mais de um alarme com o TagName, Condição, Limite, Limite 1, Limite 2 iguais ao mesmo tempo), a existência da Tag alarm em Tags Objects (sendo verificado inclusive todos os templates), a existência da área dos alarmes em Alarms Areas, a existência de grupos dos alarmes em Alarms Groups e a correlação das referências das tags utilizadas nas descrições dos Alarm Itens, analisando se são da tag em si.
Historiadores: É checada a formatação dos históricos (verificando nomes com espaços ou totalmente em branco), a existência de duplicados (sendo o critério para ser um duplicado ter mais de um histórico com o TagName e a HistorianTable iguais ao mesmo tempo), a existência da Tag historian em Tags Objects (sendo verificado inclusive todos os templates), a existência das tabelas dos historians em Tags HistorianTables.
Pontos: É checada a formatação dos pontos (verificando nomes com espaços ou totalmente em branco), a existência de duplicados (sendo o critério para ser um duplicado ter mais de um ponto com o TagName, Node, Address iguais ao mesmo tempo), a existência da Tag Point em Tags Objects (sendo verificado inclusive todos os templates), a existência dos nodes dos points em Devices Nodes, a existência dos accessTypes dos points em Devices AccessTypes.
Nós: É checada a existência do Channel dos nodes em Device Channels.
Outros: É mostrado o ID, o nome de todos os grupos de alarmes, dispositivos nodes e Channels não utilizados no projeto ou que possuem um espaço em seus nomes.
Os resultados de toda análise são computados de uma vez, com apenas um click do botão ‘Verificar’, e é organizado por abas (Alarmes, Históricos, Pontos, Nós e Outros). Dentro de cada aba, há uma região de legenda descrevendo o que cada abreviação de erro significa e a contagem de erros encontrados (disponível apenas depois de uma verificação). Abaixo há uma tabela que contém as colunas ‘ID’, ‘TagName’ (ou ‘Name’ no caso de nós) e as abreviações dos erros, em que E1 significa erro 1, E2 significa erro 2 e assim por diante. Caso após a análise uma ou mais tabelas nas abas estejam vazias, então não há erros nessa área (podendo ser visualizado também no nome da aba que terá o número zero). Há também um contador de erros totais do projeto, disponível na parte superior direita, ‘Total de erros’. Caso haja algum erro na aba, será mostrado o símbolo ‘✓’ na coluna do erro encontrado, e um campo vazio nas colunas em que não há erros. Após a primeira análise feita, fica disponível para o usuário o botão ‘Exportar’, que exporta um log de todos os erros encontrados separados por áreas, para um arquivo Excel ‘.csv’. O local em que esse log de Excel será salvo é escolhido pelo usuário, assim como o nome do arquivo, que por padrão é ‘Análise do Revisor de Projeto dia-mês-ano hora-minutos-segundos’. Além disso, fica disponível a todo momento o botão “Relatório”, que gera um relatório de todas as Tags criadas no projeto de domínio do servidor, exportando esses dados para um arquivo de Excel.
Utilização
Verificar o projeto
Para verificar o projeto, basta selecionar as opções desejadas na área de opções e clicar uma única vez no botão ‘Verificar’ (Figura 1.0), e aguardar a análise. O botão ‘Verificar’ automaticamente verifica todas as áreas (Alarmes, Históricos, Pontos, Nós), sendo necessário apenas um click para verificar o projeto por completo. A análise pode demorar dependendo do tamanho do projeto, seu progresso de análise pode ser acompanhado pela barra de progressos na parte inferior da janela da extensão que ficará visível ao iniciar o processo (Figura 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).
(Figura Figure 1.0)
(Figura Figure 1.1)
Visualizar os resultados
Após o projeto ter sido verificado pela primeira vez (como descrito em Verificar o projeto), o usuário poderá visualizar os resultados da análise. A janela é separada em 4 áreas.
A primeira área (destaque na Figura 2.0) possui a opção de selecionar o resultado que se deseja visualizar. As opções são Alarmes, Históricos, Pontos, Nós e Outros, bastando clicar em cima da aba para selecioná-la.
(Figura 2.0)
A segunda área (destaque na Figura 2.1) mostra a legenda das abreviações dos erros, a quantidade de erros encontrados na aba selecionada e o total de erros encontrados no projeto.
(Figura 2.1)
A terceira área (destaque na Figura 2.2) é uma tabela com os resultados da análise, sendo as colunas separada por ‘ID’, ‘TagName’ (ou ‘Name’ no caso de Nós e Outros) e as abreviações dos erros, em que E1 significa erro 1, E2 significa erro 2 e assim por diante. Caso não tenham sido encontrados erros em uma aba específica, o nome da aba terá um zero ao lado, e a tabela estará vazia (exemplo na figura 2.3). Caso algum erro seja encontrado, será preenchido os campos da tabela ‘ID’ e TagName (ou ‘Name’ no caso de Nodes e Outros) com a Tag defeituosa, e será indicado com um símbolo ‘✓’ na coluna do erro encontrado, e um campo vazio nas colunas em que não há erros (exemplo na figura 2.2). A quantidade de erros total encontrada no projeto está disponível acima dos erros da aba, pelo identificador ‘Total de erros’ (exemplo na figura 2.3). É possível filtrar a visualização dos erros encontrados por ID, nome da Tag ou erros, para isso, basta arrastar a coluna do título da tabela para a área ‘Drag aView 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.
(Figure 2.0)
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.
(Figure 2.1)
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. ’ (exemplo na Figura (example in Figure 2.4).
(Figura Figure 2.2)
(Figura Figure 2.3)
(Figura Figure 2.4)
A quarta área (destaque na Figura The fourth area (highlighted in Figure 2.5) é a sessão de opções. Nela fica disponível opções extras na análise dos dados e na exportação do relatório de Tags, como permitir duplicados para pontos e históricos. Sempre que for feita uma mudança nas opções, ela só tomará efeito após ser feita uma nova verificação ou exportação do relatóriois 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.
(Figura Figure 2.5)
| Info |
|---|
Caso apareça a mensagem ‘Erro de versão do projeto! Importe seu projeto para If the message 'Project version error' appears! Import your project to an-2016.2.70’ ou alguma outra mensagem de erro na segunda área (onde deveria ser mostrada a quantidade de erros encontrados), nem todas as verificações foram feitas pela extensão devido à versão do projeto. É necessário que o Action.NET esteja na versão 70' or some other error message in the second area (where the amount of errors found should be shown), not all checks were made by the extension due to the project version. The version must Action.NET in version an-2016.2.70 ou superior para que a extensão funcione adequadamente. Caso o projeto esteja na versão or higher for the extension to function properly. If the project is in version an-2016.2.70 e a mensagem de erro foi mostrada, a importação do projeto pode não ter sido feita de forma adequada. (Referência do erro Figura and the error message was shown, the project import may not have been done properly. (Error reference Figure 2.6) |
(Figura Figure 2.6)
Exportar os erros
Após o projeto ter sido verificado pela primeira vez, o usuário poderá exportar os resultados para um arquivo Excel ‘.csv’. Para isso, basta clicar no botão ‘Exportar’ (destaque na figuraExport 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). Após o clique, será aberta uma nova janela em que se pode escolher o local que o arquivo será salvo, e o nome do arquivo (que por padrão é ‘Análise do Revisor de Projeto dia-mês-ano hora-minutos-segundos’). Após escolher o nome e o local do arquivo, basta clicar em ‘Salvar’ para salvar ou ‘Cancelar’ para não salvar (exemplo na figura 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).
(Figura Figure 3.0)
(Figura Figure 3.1)
Gerar relatório
Para gerar um relatório completo das Tags do projeto, basta clicar no botão ‘Relatório’ (destaque na FiguraGenerate report
To generate a complete project Tags report, simply click the 'Report' button (highlighted in Figure 4.0). Ao clicar, é aberta uma janela para escolher um local e nome do arquivo para salvar o relatório (por padrão o nome é ‘Relatório do Revisor de Projeto dia-mês-ano hora-minutos-segundos’). Após escolher o nome e o local do arquivo, basta clicar em ‘Salvar’ para salvar ou ‘Cancelar’ para não salvar e não executar o processo do relatório (exemplo na Figura 4.1), e em seguida, automaticamente é iniciado o processo de gerar o relatório, que pode demorar dependendo do tamanho do projeto, e seu progresso pode ser acompanhado pela barra de progressos na parte inferior da janela da extensão que ficará visível ao iniciar o processo.
| Info |
|---|
Não é necessário realizar uma verificação do projeto para gerar o relatório. |
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.
| Info |
|---|
You do not need to perform a project scan to generate the report. |
(Figure 4.0)
(Figura Figure 4.1)
| Panel | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Table of Contents | ||||||||||||||||
| maxLevel | 2 | |||||||||||||||
| outline | true | printable | ||||||||||||||
| Scroll ignore | ||||||||||||||||
| ||||||||||||||||
On this page: |