Variable Name Converter Rules

Function: The Variable Name Converter Rules dialog displays the rules of the currently selected set of rules. It can be used to select a path to another set of rules or to make final changes to existing rules before import. All changes are adopted in the set of rules when the dialog is confirmed. These rules can also be changed in the Convert PLC variable names plugin.

Call: The dialog is automatically called when executing the command Import via XCAD... if the Convert PLC variable names plugin and the corresponding setting Always show variable name converter rules dialog have been activated.

Variable Name Converter Rules 1:

Variable name converter rules file path

In this section you can select the path to the file with the JSON format from which the rules for converting variable names will be loaded.

Note: By default, this path points to the plugin folder in the directory %USERPROFILE%\Documents\Beckhoff\TE1120 - TC3 XCAD Interface\Plugins.

Variable Name Converter Rules 2:/Variable Name Converter Rules 3: Always show variable name converter rules dialog, before executing the plugin

Use this checkbox to select whether the Variable Name Converter Rules dialog is automatically opened before the plugin is executed.

  • Variable Name Converter Rules 4:: The dialog will open automatically.
  • Variable Name Converter Rules 5:: The dialog will not open automatically.

Rule collections

Variable Name Converter Rules 6: New Rule Collection

You can add a new rule collection using this button. The new rule collection is automatically added to the end of the list.

Numbering

The order in which the individual rule collections are executed is shown here. The numbering is derived from the position in the list. You can change the order by dragging and dropping the rule collection to a new position.

Variable Name Converter Rules 7:/Variable Name Converter Rules 8:

This button allows you to select whether the plugin settings should be displayed or hidden.

  • Variable Name Converter Rules 9:: The plugin settings are collapsed. Pressing the button expands and displays them.
  • Variable Name Converter Rules 10:: The plugin settings are expanded. Pressing the button collapses them, so that they are no longer displayed.

Variable Name Converter Rules 11:/Variable Name Converter Rules 12:

Use this checkbox to enable or disable the corresponding rule collection. If it is enabled, your rules will be applied automatically when the plugin is executed.

  • Variable Name Converter Rules 13:: The rule collection is enabled.
  • Variable Name Converter Rules 14:: The rule collection is disabled.

Name

The name of the rule collection is displayed here.

Variable Name Converter Rules 15:

With this button you can open a dialog that allows you to adapt the name of the rule collection and change the description.

Variable Name Converter Rules 16:

With this button you can delete the rule collection including its rules.

Description

Here you will find the short description of the rule collection.

Settings

Variable Name Converter Rules 17:/Variable Name Converter Rules 18: Enable advanced mode

You can enable the advanced mode with this checkbox. It offers further setting options for the rules.

  • Variable Name Converter Rules 19:: Advanced mode is enabled.
  • Variable Name Converter Rules 20:: Advanced mode is disabled.

Variable Name Converter Rules 21:/Variable Name Converter Rules 22: The execution of the converter rules collection is stopped, after one of its rules is applied.

Use this checkbox to select whether all rules in the rule collection should always be applied or whether execution of the rule collection should be stopped once one of the rules has been applied.

  • Variable Name Converter Rules 23:: Execution is aborted.
  • Variable Name Converter Rules 24:: Execution continues.

Rules

Here you will find a list of all the rules that have been added to the rule collection.

Variable Name Converter Rules 25: New Rule

You can add a new rule using this button. The new rule is automatically added to the end of the list.

Numbering

The order in which the individual rules are executed is shown here. The numbering is derived from the position in the list. You can change the order by dragging and dropping the rule to a new position.

Variable Name Converter Rules 26:

With this button you can open a menu via which a rule can be deleted or copied. If you copy the rule, the copy will be added to the end of the list.

Predefined rule collections

Input / Output Prefix

The rules of this collection add a defined prefix for inputs and outputs to the variable name.

Data Type Prefix

The rules in this collection add a defined prefix for the variable data type to the variable name.

Numeric Start

The rules of this collection check whether the first character of the variable name is numeric and, if so, add a defined prefix.

Replace special characters

The rules in this collection search for special characters in the variable name and replace them with defined characters.

Replace double underscores

The rules in this collection search for double underscores in the variable name and replace them with single underscores.

Rule types

Each rule is graphically represented as an If-Then construct. With the condition, you can query various attributes (name, comment, data type, I/O address) of the tags from the AML file with the help of various rule types. Depending on the configured condition, you can then influence the name or comment:

See also