Conventions Table

Overview

With the Conventions Table, you can select conventions that have to be met by your application.

The Conventions Table provides two parts:

Conventions (left-hand side)

List of the available conventions.

Refer to chapter Convention Queries Tab.
Results window (right-hand side)

List of elements that do not meet the conventions selected on the left side.

Conventions

The Conventions tree lists and groups convention rules that are available by default (by EcoStruxure Machine Expert installation) and the user-defined rules created with the Query editor. Use the check boxes to activate/deactivate convention rules.

After clicking the Enable and start querying button of the Results window toolbar, additional information is displayed in the Conventions tree:

Element	Description
Filter by convention names	Enter text to filter the conventions by name.
Rule Set	Select a rule set for filtering the conventions to display.
(<Number>) behind a convention name	Indicates how many hits this convention created. If no number is displayed, this query was not executed.
(Querying...) behind a convention name	This query is being executed.

Toolbar

Element	Description
Analyze Code	Click this button to start the analysis process of the application this Conventions Table belongs to. If analysis has already been started and state of analysis is up-to-date, this button is disabled.
Stage x/y (Required: z)	Stage information assigned to the Analyze Code button: Number of stages available (y) Currently reached stage (x) Required stage (z) to use this editor
Querying	Enable and start querying button: Click this button to start querying. Disable and pause querying button: Click this button to pause querying. Click the button again to restart querying from the point you stopped querying.
Export	Click this button to export the displayed list as a CSV, HTML, or XML file.
Scope	Displays the folder of which the Conventions Table is a part. Only this folder is taken into account for analysis. For a table that is a subnode of the Code Analysis Manger the whole application is taken into account for analysis. Only visible if a Conventions Table is placed in a folder.

Result List

Element	Description
Filter by ...	Enter text to filter the results. The filter applies to all columns.
Sort a column	To sort a column, click the column header: Convention Severity FullName Message
Double-click a table entry	Opens the associated element in its corresponding editor.
Contextual Menu Commands on a table entry	Right-click a table entry and select one of the contextual menu commands: Go to definition Opens the associated element in its corresponding editor. Start Rename Refactoring Opens the Rename dialog box to enter the new name of the object. After confirming with OK, the Refactoring dialog box opens, highlighting the objects of your application that are affected by the renaming. Click OK to start the renaming. This contextual menu command is available for name verification conventions, for example, Complex Type Name Checks. Add to dependency graph Adds the element to an existing or new dependency graph. Add to block list Adds the element to a block list and removes that element form all Conventions Tables until it is deleted from block list again.