Parameters

Description

TYPE

Type of task that the action is to perform:
DEVICES: Number devices.
PAGES: Number pages.
TERMINALS: Number terminals.
CABLES: Number cables.
CONNECTIONS: Number connections.

PROJECTNAME

Project name with complete file path (optional).
If nothing is entered, the selected project will be used if the action is to be run over the user interface (e.g. via the script or ribbon). When executing from the Windows command line, PROJECTNAME must be specified or ProjectAction has to be used before that. Otherwise a system message will appear.

USESELECTION

Specifies whether the current selection in the user interface is to be taken into account during numbering (optional, 0 = No, 1 = Yes).
Default value: 0. Can only be used if the parameter PROJECTNAME is not used.

FILTERSCHEME

Name of the filter scheme (optional).
Default value: most recently used filter scheme. If this parameter is not available no filtering takes place. Only available if the TYPE parameter has one of the following values: DEVICES.

CONFIGSCHEME

Numbering scheme (optional).
Default value: numbering scheme last used. Only available if the TYPE parameter has one of the following values: DEVICES, TERMINALS, CABLES, CONNECTIONS.

STARTVALUE

Start value for the numbering (optional).
Default value: 1. Only available if the TYPE parameter has one of the following values: DEVICES, PAGES, TERMINALS, CABLES.

STEPVALUE

Increment; value by which the counter is increased (optional). Default value: 1. Only available if the TYPE parameter has one of the following values: DEVICES, PAGES, TERMINALS, CABLES.

POSTNUMERATE

Renumbering of the devices that are marked with a flag "?" (optional, 0 = No, 1 = Yes).
Default value: 0. Only available if the TYPE parameter has one of the following values: DEVICES, TERMINALS.

ALSONUMERATEDBYPLC

Corresponds to the setting Also number those controlled by PLC (optional, 0 = No, 1 = Yes).
Default value: 0. Only available if the TYPE parameter has one of the following values: DEVICES, TERMINALS.

PERMITSORTCHANGE

Corresponds to the setting Allow change in sorting (optional, 0 = No, 1 = Yes).
Default value: 0. Only available if the TYPE parameter has the following value: TERMINALS.

FILLGAPS

Corresponds to the setting Fill gaps (optional, 0 = No, 1 = Yes).
Default value: 0. Only available if the TYPE parameter has the following value: TERMINALS.

IDENTIFIER

Identifiers (e.g. "X*", optional).

If this parameter is used, all devices from the project which correspond to the identifier are renumbered, irrespectively of whether the USESELECTION parameter is used or not. Only available if the TYPE parameter has the following value: DEVICES.

NUMERATECABLES

Corresponds to the setting Also number cables whose DT contain source / target: (optional, 0 = No, 1 = Yes).
Default value: 0. Only available if the TYPE parameter has the following value: DEVICES.

STRUCTUREORIENTED

Corresponds to the setting Structure-oriented numbering (optional, 0 = No, 1 = Yes).
Default value: 0. If this parameter is set, the numbering is carried out per structure identifier. If the parameter is not set, the pages are numbered consecutively.
Only available if the TYPE parameter has the following value: PAGES.

KEEPINTERVAL

Corresponds to the setting Keep interval (optional, 0 = No, 1 = Yes).
Default value: 0. In combination with STARTVALUE this parameter specifies that the increments between the selected pages is retained for the target pages. In this way you can move any desired number of selected pages by a specified increment. Entering the increment size is not possible in this case.
Only available if the TYPE parameter has the following value: PAGES.

KEEPTEXT

Corresponds to the setting Keep text (optional, 0 = No, 1 = Yes).
Default value: 0. If this parameter is set, the alphabetical part of the page name is not overwritten. If the parameter is not set, the text part is deleted.
Only available if the TYPE parameter has the following value: PAGES.

SUBPAGES

Corresponds to the Subpages setting (optional).
Possible values are:
0 = Retain: Existing subpages are adopted unchanged into the target pages.
1 = Consecutive numbering: Existing subpages are renumbered using the starting value "1" and an increment of "1". At every change of the main page, the subpage numbering begins again from "1".
2 = Convert into main pages: Subpages are converted into main pages and renumbered.
Only available if the TYPE parameter has the following value: PAGES.

PREFIX

Corresponds to the setting Prefix (optional, 0 = No, 1 = Yes).
Default value: 0. Only available if the TYPE parameter has the following value: TERMINALS.

SUFFIX

Corresponds to the setting Suffix (optional, 0 = No, 1 = Yes).
Default value: 0. Only available if the TYPE parameter has the following value: TERMINALS.

SEQUENCE

Corresponds to the Sequence setting (optional).
Possible values are:
0 = Like sorting: The terminal / pin sorting sequence displayed in the terminal strip or plug navigator is used. Select this option if you would like to number existing terminals / pins but retain the existing numbering sequence.
1 = Page-based.
2 = Cable-based.
3 = Level-based.
Only available if the TYPE parameter has the following value: TERMINALS.

EXTENT

Corresponds to the Extent setting (optional).
Possible values are:
0 = Selected: Only the selected terminals or pins are numbered.
1 = All of the selected terminal strips / plugs: All terminals of the selected terminal strip, or all pins of the selected plug are numbered.
Only available if the TYPE parameter has the following value: TERMINALS.

POTENTIAL_N

Corresponds to the N terminals / pins setting (optional).
Possible values are:
0 = Do not modify.
1= Do not modify, include in sequence: N terminals are not modified during numbering but are taken into account when numbering the other terminals. This means that the designations of the other terminals are assigned as though the N terminals were being included in the numbering.
2 = Number: All N terminals or pins are numbered.
Only available if the TYPE parameter has the following value: TERMINALS.

POTENTIAL_PE

Corresponds to the PE terminals / pins setting (optional).
Possible values are:
0 = Do not modify.
1= Do not modify, include in sequence: PE / PEN terminals are not modified during numbering but are taken into account when numbering the other terminals. This means that the designations of the other terminals are assigned as though the PE / PEN terminals were being included in the numbering.
2 = Number: All PE / PEN terminals or pins are numbered.
Only available if the TYPE parameter has the following value: TERMINALS.

POTENTIAL_SH

Corresponds to the SH terminals / pins setting (optional).
Possible values are:
0 = Do not modify.
1= Do not modify, include in sequence: SH terminals are not modified during numbering but are taken into account when numbering the other terminals. This means that the designations of the other terminals are assigned as though the SH terminals were being included in the numbering.
2 = Number: All SH terminals or pins are numbered.
Only available if the TYPE parameter has the following value: TERMINALS.

MULTIPLETERMINALS

Corresponds to the Multiple terminals setting (optional).
Possible values are:
0 = Do not modify.
1 = Number same: Terminals with the same designation with the property Allow same designations are given the same number.
2 = Number individually: Terminals with the property Allow same designations are each given their own number. Therefore, multiple terminals which had the same number before numbering will have different numbers after numbering.
Only available if the TYPE parameter has the following value: TERMINALS.

KEEPALPHA

Corresponds to the Terminals with alphabetical characters setting (optional).
Possible values are:
0 = Do not modify: Terminals or pins with alphabetical elements in the designation are ignored during numbering.
1 = Keep alphabetical elements: The alphabetical elements of the terminal or pin designation are retained. The first numeric elements are renumbered. If the designation only has alphabetical elements, the old designation is attached to the new numbering. Sequential terminals with different counters but the same numerical component receive the same numerical component in the counter even after the numbering.
2 = Number: All terminals / pins are renumbered. In doing so, the old designation is overwritten.
Only available if the TYPE parameter has the following value: TERMINALS.

KEEPEXISTING

Corresponds to the setting Keep existing cable DTs (optional, 0 = No, 1 = Yes).
Default value: 0. If this parameter is set, newly generated or copied cables are renumbered. The DT of the already numbered cables is retained. The cables with "?" in the identifier will be numbered.
Only available if the TYPE parameter has the following value: CABLES.

STARTVALUE_n

Start value for the numbering of connection groups (optional).
Default value: 1. Only available if the TYPE parameter has the following value: CONNECTIONS.

STEPVALUE_n

Increment for the numbering of connection groups; value by which the counter is increased (optional). Default value: 1. Only available if the TYPE parameter has the following value: CONNECTIONS.

GROUP_n

Connection group (optional). Only available if the TYPE parameter has the following value: CONNECTIONS.

OVERWRITE

Overwrite mode (optional).
Possible values are:
0 = All: The designations are overwritten for all connection definition points that can possess a connection designation.
1 = Except for 'manually set': Connection designations with the Manually set property will not be overwritten.
2 = None: Connections that already have a designation remain unchanged and are not redesignated.
Only available if the TYPE parameter has the following value: CONNECTIONS.

AVOIDIDENTICALDESIGNATIONS

Corresponds to the Avoid identical designations setting (optional).
Possible values are:
0 = In entire project: Identical designations are avoided in the entire project, i.e. every connection has a unique connection designation within the project.
1 = In the selection: Each connection in the selection is given a unique connection designation. The connection designations are only unique within the selection, otherwise identical designations are permitted in the project.
2 = None: Identical designations are generally permitted.
3 = Per counter reset range (structure / page): Identical designations are only avoided within the range defined for counter resetting. The connection designations are only unique within a counter reset range, otherwise identical designations are permitted in the project. The counter reset range only affects counters but not subcounters.
Only available if the TYPE parameter has the following value: CONNECTIONS.

VISIBILITY

Corresponds to the Visibility setting (optional).
Possible values are:
0 = All visible: This setting makes all designations visible, even ones specified as "hidden".
1 = Do not modify: The designations are displayed how they are defined, that is, connection designations defined as hidden will not be displayed. This is the default setting.
2 = Once per page and range: This setting switches on visibility for connection designation of the graphically first connection and switches it off for all others with the same scope.
Only available if the TYPE parameter has the following value: CONNECTIONS.

MARKASMANUAL

Corresponds to the Mark as 'manually set' setting (optional). Only available if the TYPE parameter has the following value: CONNECTIONS.