Define Naming Conventions Window - Intergraph Smart Electrical - Help - Hexagon

Intergraph Smart Electrical Options Manager

Language
English
Product
Intergraph Smart Electrical
Search by Category
Help
Smart Electrical Version
2019 (9.0)

In this window, you can define a naming convention for each item type that is in use in Smart Electrical. Also, for item types that support multiple naming conventions, you can define several naming conventions.

Plant group

Displays the target plant group for which the naming convention applies. A plant group is a specific group available within a plant hierarchy, for example, Plant1, Area1, Unit1. Plant, area and unit are examples of plant group types. The available plant group types depend on the plant hierarchy you define in Engineering Manager. Selecting Browse beside the Plant group box opens the Select Plant Group dialog, where you can select the target group for defining naming convention.

Item type

Allows you to select the item type for which you define a naming convention, for example, motor, starter, cable, and so forth. The availability of item types in the list depends on the plant group type to which you assigned the item types in the Item Types Window.

Copy From

Opens the Copy Naming Conventions for Item Type dialog to select the required plant group and item type as a source for copying a naming convention.

Copy from reference data

Allows you to copy a naming convention to the current item type using the naming convention defined for this item type in a reference plant group. After you select this check box and select Copy From, you can select as a source a reference plant group only.

Naming convention properties

Allows you to define multiple naming convention properties that you want to assign to the item type displayed in the Item type box. Multiple naming convention properties consist of a convention label, convention description, and priority number. For each convention label assigned to the item type, you can assign a filter and set segment definitions.

The options under Naming convention properties are only available for item types that support multiple naming conventions, for example, the Cable item type.

Convention

Allows you to do the following:

  • For a new naming convention, type an appropriate naming convention label.

  • For an existing naming convention, type or select a naming convention label which you assigned to the item type selected from the Item type list.

SHARED Tip A label can be any name that can designate an actual item type category. For example, for the Cable item type, you can specify labels that designate cables with different functions: Power Cables, Control Cables, Grounding Cables, and so forth.

Priority number

For a new naming convention, allows you to type a priority value that will prioritize the naming conventions if multiple naming conventions exist for the same item type. For existing naming conventions, displays the priority number of the current convention. The software associates a priority number automatically with the label displayed under Convention.

You can change the convention priority in the Set Convention Priorities dialog.

Convention description

Allows you to type a description for the label displayed under Convention.

New

Adds an empty row in the Convention list, where you can type a new naming convention label.

Delete

Deletes the entire naming convention: the currently displayed label and description, and the corresponding segment definitions. Also, the software dissociates the convention from the priority number and automatically promotes the priority numbers assigned to the conventions with lower priorities.

Priorities

Enables you to change the order of priority numbers assigned to the labels available in the Convention list.

Filter

Displays a filter that you want to assign to the naming convention label displayed under Convention. Selecting Browse beside the Filter box opens the Select Filter dialog, where you can select an existing filter or create a new filter.

Browse

Opens the Select Filter dialog, where you can select an existing filter or create a new filter.

Clear Filter

Clears the filter assigned to the naming convention label displayed under Convention.

Apply current naming convention only to parallel cables

Instructs the software to create a naming convention for parallel cables by applying the current settings only to parallel cables. If you do not select this check box, parallel cables will not have a naming convention. See Define a Naming Convention for Parallel Cables.

Apply current naming convention only to cables belonging to single-core cable assemblies

Instructs the software to create a naming convention for cables in single-core cable assemblies by applying the current settings only to cables belonging to single-core cable assemblies. If you do not select this check box, cables in single-core cable assemblies will not have a naming convention. Note that you can also select the Apply current naming convention only to parallel cables check in addition to the Apply current naming convention only to cables belonging to single-core cable assemblies check box if you need a naming convention for parallel cables within single-core cable assemblies. See Define a Naming Convention for Cables in Single-Core Cable Assemblies.

  • For an item type with multiple naming conventions, Smart Electrical filters the naming conventions automatically, depending on your filter settings, and creates an item tag according to the naming convention to which the filter is assigned.

  • If you do not assign any filter, Smart Electrical can only create a new item tag using segment definitions specified for the label that you created first.

Sample of item tag naming convention

Displays a dynamic preview of the naming convention using your definitions for each segment.

Segment definitions

Displays the characteristics and definitions of each segment in the naming convention. Each row of the table represents the definition of a single segment. The options under Segment definitions are available after selecting Define naming conventions per item type.

In Smart Electrical, each item type has a tag property Comply with Naming Convention, which determines the behavior of an item tag name. When the property is set to True, the protection masks and segment properties behave according to the item naming convention settings. When the property is set to False, you can edit the tag name value for the item freely. Whether you set this property to True or False, the software ensures compliance with uniqueness if you select the Is unique property in the Item Types window.

Segment Type

Indicates whether the segment is text, a property, or a hierarchy type. The selection you make affects what you can do in the Property/Text column.

Property/Text

Allows you to type default text if the segment type is Text, to select a property appropriate to the item type if the segment type is Property, or to select the section of the hierarchy to be used in the naming convention. When you use a property as the segment type, the software updates the segment data dynamically if you change the value of the property.

Apart from the properties that also appear in the Properties window for item tags in Smart Electrical, there are properties that only appear in the Naming Conventions window. The following table lists and describes these properties.

Cableway.Item Tag

Designates the name of the cableway which the cableway segment is associated with. For example, if the name of the cableway is EW-1, the cableway segment name can be EW-1-100.

Electrical Equipment.Item Type

Designates the name of the electrical equipment item tag which the control station is associated with. This property is only available for control stations. You can include as a naming convention segment the name of the motor which the control station is associated with. If the name of the associated motor is U1-M-2, the control station's name can be CS of U1- M-2.

Equipment.Item Tag

Designates the name of the associated equipment item tag. For example, when creating a naming convention for cells, you can include as a naming convention segment the name of the motor that the cell feeds. If the name of the associated motor is M-2, the cell name can be Cell of - M-2. This property is available for the following item types: Cell, Circuit, Instrument, and Signal Run.

Plant Group Name

Designates the plant group of item tags belonging to the selected item type. For example, if your unit name is U1, you can use U1 as a naming convention segment. In Smart Electrical, you can then filter item tags by plant or by unit in the EDE and for report generation.

Tag Sequence Number

Designates the sequence number of items tags belonging to the selected item type.

Cable.Item Tag

For conductor naming conventions, designates the cable that the conductor belongs to.

Side 1.Terminal Strip.Equipment.Item Tag

For conductor naming conventions, designates the electrical equipment that is connected on Side 1 of the conductor (for example, motor).

Side 1.Terminal Strip.Item Tag

For conductor naming conventions, designates the terminal strip that is connected on Side 1 of the conductor.

Side 1.Terminal.Item Tag

For conductor naming conventions, designates the name of the terminal strip that is connected on Side 1 of the conductor.

Side 2.Terminal Strip.Equipment.Item Tag

For conductor naming conventions, designates the electrical equipment that is connected on Side 2 of the conductor (for example, motor).

Side 2.Terminal Strip.Item Tag

For conductor naming conventions, designates the terminal strip that is connected on Side 2 of the conductor.

Side 2.Terminal.Item Tag

For conductor naming conventions, designates the name of the terminal strip that is connected on Side 2 of the conductor.

Parallel Cable Suffix

For parallel cables, designates the name of the parallel cables.

When the selected Segment Type is Hierarchy Type, in the Property/Text column, the software displays a list of possible selections that you can choose for use in the naming convention. These selections are based on the hierarchy template which is defined for the current plant. You can select any plant group level name to be part of the naming convention. You make your selection starting with the plant group level name of the selected item type and up to the highest plant group level. For example, defining a naming convention for a motor which is defined on a Unit plant group type level in a Plant-Area-Unit structure, allows you to select any name of the plant groups starting with Unit and up to the highest level. Furthermore, you can select Unit code if the selected item type is defined as the Unit plant group type.

SHARED Tip The property name is taken from the Display Name field in Data Dictionary. This name is not unique but is associated with its own unique Data Dictionary name. If two property display names are identical in the Property/Text field, the software displays the unique Data Dictionary name in parenthesis after the display name, to differentiate between the two names.

Protect

Determines whether a text segment is protected, in which case the user cannot change the values in the segment. All segments are protected by default.

Protection is useful to prevent the user from overwriting the segments. Protect the segments that contain fixed text or text that you want to use as separators. All property segments are protected by default.

Start

Specifies the position of the character in the property name that appears at the start of the segment.

Length

Specifies the length of the string starting from the value you specify in the Start column. For the Text segment type, the maximum length is 99 characters. For the Property segment type, the maximum length depends on the property definition in the Data Dictionary.

Autofit

Select Yes to trim the empty spaces before and after the current segment. Select No to keep existing empty spaces before and after the current segment. You can use this feature to accommodate varying segment lengths of dynamic segments so that only the actual name values are shown without any spaces. Note that this feature does not affect any text within a segment that contains spaces. It only trims the spaces before and after segments.

Autofit All Segments

Sets the Autofit option to Yes for all the segments in the current naming convention.

Delete

Deletes the selected segment from the naming convention.

Up

Moves the selected segment one position up relative to the previous segment.

Down

Moves the selected segment one position down relative to the following segment.