Options Manager Guide
Options Manager Guide
User's Guide
Version 2018 (8.0)
June 2018
Copyright
Copyright © 2002-2018 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
This computer program, including software, icons, graphic symbols, documentation, file formats, and audio-visual displays; may be
used only as pursuant to applicable software license agreement; contains confidential and proprietary information of Hexagon AB
and/or third parties which is protected by patent, trademark, copyright law, trade secret law, and international treaty, and may not be
provided or otherwise made available without proper authorization from Hexagon AB and/or its subsidiaries and affiliates.
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the Software License Agreement ("SLA") delivered with the software
product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the Licensee has
a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and
govern the use of this software product and Documentation. Subject to the terms contained within the applicable license
agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the Documentation as
defined in the applicable license agreement and delivered with the software product for Licensee's internal, non-commercial
use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a SLA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial use. The Other Documentation
may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and
for any reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the SLA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.
Export Controls
Intergraph Corporation’s commercial-off-the-shelf software products, customized software and/or third-party software, including any
technical data related thereto (“Technical Data”), obtained from Intergraph Corporation, its subsidiaries or distributors, is subject to
the export control laws and regulations of the United States of America. Diversion contrary to U.S. law is prohibited. To the extent
prohibited by United States or other applicable laws, Intergraph Corporation software products, customized software, Technical Data,
and/or third-party software, or any derivatives thereof, obtained from Intergraph Corporation, its subsidiaries or distributors must not
be exported or re-exported, directly or indirectly (including via remote access) under the following circumstances:
a. To Cuba, Iran, North Korea, the Crimean region of Ukraine, or Syria, or any national of these countries or territories.
b. To any person or entity listed on any United States government denial list, including, but not limited to, the United States
Department of Commerce Denied Persons, Entities, and Unverified Lists, the United States Department of Treasury Specially
Designated Nationals List, and the United States Department of State Debarred List
(https://build.export.gov/main/ecr/eg_main_023148).
c. To any entity when Customer knows, or has reason to know, the end use of the software product, customized software,
Technical Data and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors is related to the
design, development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or
sensitive nuclear uses.
d. To any entity when Customer knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export/re-export of relevant Intergraph Corporation software product, customized software, Technical Data
and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors, should be addressed to PPM’s
Export Compliance Department, 305 Intergraph Way, Madison, Alabama 35758 USA or at [email protected].
Customer shall hold harmless and indemnify PPM and Hexagon Group Company for any causes of action, claims, costs, expenses
and/or damages resulting to PPM or Hexagon Group Company from a breach by Customer.
Trademarks
Intergraph®, the Intergraph logo®, Intergraph Smart®, SmartPlant®, SmartMarine, SmartSketch®, SmartPlant Cloud®, PDS®,
FrameWorks®, I-Route, I-Export, ISOGEN®, SPOOLGEN, SupportManager®, SupportModeler®, SAPPHIRE®, TANK, PV Elite®,
CADWorx®, CADWorx DraftPro®, GTSTRUDL®, and CAESAR II® are trademarks or registered trademarks of Intergraph Corporation
or its affiliates, parents, subsidiaries. Hexagon and the Hexagon logo are registered trademarks of Hexagon AB or its subsidiaries.
Microsoft and Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley
Systems, Inc. Other brands and product names are trademarks of their respective owners.
Clear Audit Trail Log File Command (Tools Menu) ............................................................................ 104
Clear Document Locking Command (Tools Menu) ............................................................................. 104
Import Typical Reference Data Command (Tools Menu) ................................................................... 104
Update Reference Data > Create Package Command (Tools Menu) ................................................ 104
Update Reference Data > Update from Package Command (Tools Menu) ....................................... 105
Item Type Symbology > Define (Options menu) ................................................................................. 105
Item Type Symbology > Linear Styles (Options Menu) ...................................................................... 105
Item Type Symbology > Linear Patterns (Options Menu) ................................................................... 105
ETAP > Export Reference Cables (Interfaces Menu) ......................................................................... 105
ETAP > Import Reference Cables (Interfaces Menu) ......................................................................... 106
ETAP > Build Mapping XML (Interfaces Menu) .................................................................................. 106
Status Bar Command (View Menu) .................................................................................................... 106
Set Cable Properties for Synchronization (Options Menu) ................................................................. 106
Toolbar Command (View Menu) ......................................................................................................... 106
▪ Expand the plant hierarchy and then select the required plant group located on the
lowest hierarchy level.
▪ Click Select Plant and then, under Available plant structures, select a plant to connect.
If you want to connect to a plant in a different database, in the Open Plant
Structure dialog box, click Site Server and from the Files of type list, select the required
.ini file.
For some cells in the Options Manager windows, an ellipsis button appears when you
select the cell. Clicking the button opens the appropriate dialog box that enables you to specify
the information required for that field. For instance, when specifying file locations in the
Locations window, the Browse for Folder dialog box might be displayed so that you can
choose the correct file more easily.
You can save changes to database definitions and close a session of Options Manager using
the File menu commands.
▪ The software uses a format defined in Options Manager only if the format for a specific
property belonging to the same data type is not defined in the Data Dictionary.
▪ The Format Manager defines the possible formats for each data type.
▪ When you select a default format in Options Manager, the data type appears in the selected
format in drawings.
In This Section
Define File Locations ..................................................................... 13
Cut and Move Values to the Clipboard .......................................... 14
Copy File Location Settings ........................................................... 14
Paste File Location Settings .......................................................... 14
Replace File Location Settings ...................................................... 14
3. Click the ellipsis button to navigate to the storage folder or resource file.
You can type the path, if you know it, in the Location column.
▪ Click to find the storage directory or resource file and display it in the Replace with
field.
5. Click Replace All to replace all the file location settings that match the selection in the Find
what field.
In This Section
Downloading and Importing Reference Data................................. 16
Download Reference Data ............................................................. 16
Import Typical Reference Data ...................................................... 17
▪ If a reference item has been used in the current plant, the software marks this reference
item as mandatory and it is recommended that you include it in the package.
▪ Click Save Session to save your selections if you want to pause the current session. Click
Open Session to resume your selections. You can open a saved session from a package or
session file.
Click Open Session to open a saved session. On the Open dialog box, from the Files of type
list, select one of the following:
▪ Reference Data Selection Session (xml) — to open a saved selections session.
▪ Reference Data Package (zip) — to open a session from an existing package.
▪ Click Report to generate an Excel file that will contain all the selections that you have made.
▪ Once the software finishes creating the package, a message is displayed informing you
whether or not the package has been created successfully. Click the Log button to open the
package creation log file to see if there are any reference items that failed to be included in
the package.
▪ In the Items grid, child items that were included with their parent items are not shown by
the software. For example, if the package contains a reference motor with a space
heater, both items are included in the package without displaying the space heater in
the grid.
▪ It is not possible to select existing items to be included in the update. In this version of
the software, only new items can be included in the update process.
▪ Make sure that you click Save Selections after making a change in the selection. This
way the package will retain all the selections.
5. Click the Report button to generate an Excel file that shows all the items that you have
selected from the current package.
6. Click the Update Data button to start the update process.
▪ If a reference item has been used in the current plant, the software marks this reference
item as mandatory and it is recommended that you include it in the package.
▪ Click Save Selections to save your selections if you want to pause the current session. The
software saves your selections in the current package. Click Open Package and navigate to
the package file to resume your selections.
▪ Once the software finishes the update process, a message is displayed informing you
whether or not the update has been completed successfully. Click the Log button to open
the update log file to see if there are any package items that failed to be included in the
update.
Naming Conventions
You can assign an optional naming convention for each Smart Electrical item type. In Smart
Electrical, naming conventions consist of a number of segments, with each segment being a text
string or the value of a property of the item type. You define segments as protected segments
or allow users to modify the segments as needed. If you define a text segment as a protected
segment, you can use this segment as a separator. For further details, see Naming Convention
Example.
You can either define or copy a naming convention per item type - alternatively, you can copy
naming conventions for the entire plant group that you select. When copying naming
conventions, you can use a reference plant group as a source. Prior to defining or copying
naming conventions, you must select a target plant group, for example Plant1, Area1, Unit1, and
so forth. Source and target plant groups must belong to the same plant group type. For
example, if your target plant group is a unit, your source plant group must be a unit too.
Also, for item types that support multiple naming conventions, you can specify several naming
convention properties and assign a filter to each convention label (you need to access Filter
Manager to select or create filters). When working with multiple naming conventions, you need
to specify the order of priorities. When a user creates an item tag in Smart Electrical, the
software applies naming conventions in the specified order of priorities.
We recommend that you do not change a naming convention which is already in use. Naming
conventions do not apply to existing items. If you change an existing naming convention, the
software applies the new convention only to new item tags that users create in Smart
Electrical. This means that after you change a naming convention which was already used
when creating item tags, new item tags might be not unique in a plant group.
If you do need to change a naming convention which is in use, in Smart Electrical, for the
appropriate item tags, it is advisable that users change the Comply with Naming Conventions
flag to False and then switch it back to True. This way the software can update the names of
the existing item tags.
When opening Options Manager, you may see a message informing you that
changes were made to the plant group hierarchy names. These changes were made in . Smart
Engineering Manager To complete the name changes the Apply Naming Conventions
command must be run in Smart Electrical. This message continues to appear each time you
open Options Manager, until the Apply Naming Conventions command is run, or you select
the Don't remind me again of these changes check box.
6. Under Convention, type an appropriate name for the current naming convention. It 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.
7. To change the priority displayed under Priority number, click the Priorities button to set a
priority value that prioritizes the naming conventions if multiple naming conventions exist for
the same item type. The value under Priority number is displayed automatically.
8. Under Convention description, type a short description if needed,
9. To set a filter for the current convention (if needed), click Browse beside the Filter list. You
can select an existing filter or create a new one that will be assigned to the naming
convention label displayed under Convention.
10. To define a naming convention for parallel cables, select the Apply current naming
convention only to parallel cables check box. For details, see Define a Naming
Convention for Parallel Cables (on page 26).
11. To define a naming convention for cables in single-core cable assemblies, click the Apply
current naming convention only to cables belonging to single-core cable assemblies
check box. For details, see Define a Naming Convention for Cables in Single-Core Cable
Assemblies (on page 27).
For parallel cables within single-core cable assemblies, select both the Apply
current naming convention only to parallel cables and Apply current naming
convention only to cables belonging to single-core cable assemblies check boxes.
12. Under Segment definitions, in the Segment Type column, select Text, Property, or
Hierarchy Type.
13. Do one of the following:
▪ For a text segment, leave the Property/Text column blank or type the text that will
appear as the default.
▪ For a property segment, select a property from the list in the Property/ Text column.
▪ For a hierarchy type segment, select a property from the list in the Property/ Text
column.
14. For a text segment, select whether you want to protect the segment.
If you want to use the text as a separator between segments, you should select Yes
to protect the segment. All property segments are protected by default. For further details,
see Naming Convention Example.
15. Type values for the position of the starting character in the text or property name string, and
the required length of the string to appear in the tag.
16. To trim the empty spaces before and after a particular segment, select Yes from the Autofit
list. 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.
Alternatively, you can click the Autofit All Segments button to change the Autofit
setting to Yes for all the segments in the current naming convention.
17. For additional segments, repeat the last three steps as required.
18. To change the order of the segments, select a segment as required, and then click Up or
Down.
19. To delete the selected segment, click Delete.
▪ Renaming of plant item for which a naming convention has been defined is only
possible according to the mask based on the defined naming convention.
▪ When renaming a plant item, you will be able to change only those segments of the
plant item tag that have been set as not protected.
Setting Description
Identical Sets the tag sequencing of the parallel cables to be identical in the group
and the cable uniqueness identifier is the parallel suffix. Examples:
Cable - 174/0A; Cable - 174/0B; Cable - 174/0C
Consecutive Sets the tag sequencing of the parallel cables to be consecutive and the
cable uniqueness identifier is the cable tag number. Examples:
Cable - 181/0A; Cable - 182/0B; Cable - 183/0C
Changing the parallel cable tag sequencing method does not affect the
tag sequencing of existing parallel cables.
4. Define the composition of the naming convention by selecting the appropriate naming
convention segments and their definitions in the Segment definitions grid. For details, see
steps 12-17 in the Define a New Naming Convention (on page 24) topic.
5. To determine whether to include the parallel cable suffix in the naming convention, select
the Parallel Cable Suffix property in the Segment definitions grid.
▪ To determine where in the cable tag name you want to include the parallel cable suffix,
define the parallel cable suffix in the Segment definitions section. You can move the
parallel cable suffix property up or down the list to set the position of this property in the
segment definition.
▪ When renaming a parallel cable and a naming convention has been defined, you can
rename all unprotected segments of the item tag. The protected segments of the item
tag cannot be renamed. If no naming convention has been defined, all segments of the
item type can be renamed.
Setting Description
Identical Sets the tag sequencing of the cables in a single-core cable assembly to
be identical in the group and the cable uniqueness identifier is a number.
Examples:
Cable - 174-1; Cable - 174-2; Cable - 174-3
Consecutive Sets the tag sequencing of the cables in a single-core cable assembly to
be consecutive. This setting makes the names of the cables in the
assembly unique without the need of a uniqueness identifier. Examples:
Cable - 181; Cable - 182; Cable - 183
▪ For a label, you can type any name or 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.
▪ Beside Convention description, click New to add an empty row in the Convention
box. Type a new label and description.
▪ The software automatically assigns a priority number to each new convention
label. The convention label that is created first receives the highest priority (number
1). Each additional label receives a lower priority (number greater than 1). To change
the order of priorities, click Priorities.
6. To assign a filter to a naming convention, beside Filter, click Browse to access Filter
Manager, and then select an existing filter or create a new one.
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.
7. Under Segment definitions, for each label that appears in the convention list, make
segment definitions. For more information, see Define Naming Conventions (see "Define a
New Naming Convention" on page 24).
To save naming convention to the database, click , or click File > Save.
▪ The plant group hierarchy levels of the source pant group and the target plant group
must be the same. For example, if the selected source plant group level is unit, the
target plant group level must also be unit. This is true for both options in the Source
group box.
▪ When copying naming conventions, the software overwrites the naming conventions
that exist in the target plant group item.
▪ If the source plant group hierarchy item that you selected does not contain any naming
conventions, the naming conventions in the target will remain unchanged.
5. Click Apply.
▪ When you select an item type that supports multiple naming conventions, under
Naming convention properties, the software allows you to select a convention label,
displays the description, priority number, and filter definition.
▪ Apart from the options that allow you to select a plant group, item type, or convention
label, all the other options in this window are not accessible.
5. Under Segment definitions, view the settings defined for the current item type (or for a
convention label if the item type that you selected supports multiple naming conventions).
For this naming convention, you should define the individual segments as shown:
▪ If you do not define a naming convention for an item type, the software assigns a default
naming convention to all the item tags belonging to this item type. The default naming
convention consists of an item type identifier and the item tag last sequence number. For
example, for a motor, the default naming convention is M-1. You define the item type
identifier and last sequence number values in the Item Types window.
▪ For reference items that appear in the Reference Data Explorer in Smart Electrical, the
software always uses the default naming conventions.
1. Select Apply also for existing users to apply all the defined preferences for all new and
existing users.
2. Type or select the required value for the property.
3. Click , or click File > Save to save the changes to the database.
If you open more than one instance of the window and make changes for
several window instances, the software only applies changes in the window instance for which
you last saved the data, and not in any of the other currently open window
instances. Furthermore, the software discards any changes that you saved previously in other
window instances. For example, you can open one window instance for buses and another
instance for circuits. If you change a property value and save the changes in the window
instance opened for buses, the changes do not appear in the window instance opened for
circuits. If you now make a change in the window instance opened for circuits and save the
change, the software discards all the changes you made in the window instance opened for
buses.
Your source and target plant groups must belong to the same type within the same
plant. For example, if the target group is a unit, your group type can only be another unit in
the same plant.
6. Under Source item types, do one of the following:
▪ Under the Select column, beside each required item type, select the check box to use
the item type as a source for copying property values.
▪ Select the Select all check box to use all the available item types as sources for
copying property values.
7. Click Copy to copy and save the property values to the database.
5. Click , or click File > Save to save the changes to the database.
When changing the unit of measure for the SLD margins or for SLD internals, the
software does not convert the values that you defined. You need to update the values
manually.
5. Select the Apply also for existing users check box to apply all the defined preferences for
all new and existing users.
6. Click , or click File > Save to save the changes to the database.
5. Click , or click File > Save to save the changes to the database.
5. Click , or click File > Save to save the changes to the database.
The following restrictions apply regarding the governing case in your plant:
▪ Publishing is possible only if the governing case is set as the active case of your plant.
▪ Retrieved data is moved to the governing case only.
▪ When populating data from the Reference Electrical Engineer using a source plant, the
software takes the governing case data of the source plant to populate the governing case
of the target plant.
▪ If you import a new pattern or style that has the same name as a pattern or style that is
already listed on the Linear Patterns dialog box, the new information immediately overwrites
the older pattern or style.
▪ As soon as you import linear patterns or styles, the new information is immediately written
into the project styles file. There is no option to save the changes later.
You can also import linear styles, which incorporate linear patterns, for heat tracing
symbology. The words heat trace must appear in the name of the style in order for Smart
Electrical Options Manager to import the style.
a. Under Item Type Filter, click the ellipsis to open the Select Filter dialog box.
b. Define the filter as you require.
5. To narrow down the drawing type to specific drawing properties, do the following:
a. Under Drawing Type Filter, click the ellipsis to open the Select Filter dialog box.
b. Define the filter as you require.
6. Under Symbol File, click on the cell and choose the symbol file you want to use.
7. Under Initial Style, from the list choose a style. The Color, Width, and Pattern cells are
filled with the default settings of the selected style.
You can change the Color, Width, and Pattern, by clicking in their cells and
choosing from the list the required value. The styles default setting will not be affected by
these changes.
8. Use the Move Up and Move Down buttons to move the row higher or lower. The higher
the row is positioned, the higher the priority. The priority rules are set by the filter. The
priority determines which rule applies first when rules conflict with each other. For example,
filter A is the first row. The filter's rules state to use a red broken line to represent cables
that are between 2 to 10 cm in diameter. Filter B is below filter A in the Define Item Type
Symbology window and its rules state to use a blue continuous line when the cable is
between 8 to 20 cm in diameter. If a cable is 9 cm in diameter the software assigns to the
cable the symbol with the higher priority, in this case a red broken line.
9. Close the Define Item Type Symbology window when you have completed defining
symbols for the selected item type.
▪ If you import a new pattern or style that has the same name as a pattern or style that is
already listed on the Linear Styles dialog box, the new information immediately overwrites
the older pattern or style.
▪ As soon as you import linear patterns or styles, the new information is immediately written
into the project styles file. There is no option to save the changes later.
1. Click Options > Item Type Symbology > Linear Patterns.
2. On the Linear Styles dialog box, click Import.
3. On the Import Linear Styles From dialog box, browse to the .sym file that contains your
linear style.
4. Click Open.
5. Click Close on the Linear Styles dialog box.
▪ Any supporting styles referenced by the pattern that you choose to import are also imported.
▪ When you import a linear pattern or heat tracing style, you must close the Linear Styles
dialog box and re-open it in order to see the newly imported information.
▪ You can also import linear styles, which incorporate linear patterns, for heat tracing
symbology. The words heat trace must appear in the name of the style in order for Smart
Electrical Options Manager to import the style.
▪ If you import a new pattern or style that has the same name as a pattern or style that is
already listed on the Linear Patterns dialog box, the new information immediately overwrites
the older pattern or style.
▪ As soon as you import linear patterns or styles, the new information is immediately written
into the project styles file. There is no option to save the changes later.
1. Click Options > Item Type Symbology > Linear Patterns.
2. On the Linear Patterns dialog box, click Import.
3. On the Import Linear Patterns From dialog box, browse to the .sym file that contains your
linear pattern.
4. Click Open.
5. Click Close on the Linear Patterns dialog box.
▪ Any supporting styles referenced by the pattern that you choose to import are also imported.
▪ When you import a linear pattern or heat tracing style, you must close the Linear Patterns
dialog box and re-open it in order to see the newly imported information.
▪ You can also import linear styles, which incorporate linear patterns, for heat tracing
symbology. The words heat trace must appear in the name of the style in order for Smart
Electrical Options Manager to import the style.
4. Under Filter Name, click on an empty cell, and then on the ellipsis to open the Select
Filter dialog box.
5. On the Filter dialog box, create a new simple filter with the following properties:
▪ Definition equals Match any
▪ Property equals Secondary Element
▪ Operator equals =
▪ Value equals 0 (two-winding), 1 (left three-winding), 2 (right three-winding)
6. Click OK to close the Filter dialog box.
7. Under Symbol File, click on the cell and choose the required Transformer Component
symbol file.
8. Under Initial Style, from the list choose a style. The Color, Width, and Pattern cells are
filled with the default settings of the selected style.
You can change the Color, Width, and Pattern, by clicking in their cells and
choosing from the list the required value. The styles default setting will not be affected by
these changes.
9. Use the Move Up and Move Down buttons to move the row higher or lower. The higher
the row is positioned, the higher the priority. The priority rules are set by the filter. The
priority determines which rule applies first when rules conflict with each other. For example,
filter A is the first row. The filter's rules state to use a red broken line to represent cables
that are between 2 to 10 cm in diameter. Filter B is below filter A in the Define Item Type
Symbology window and its rules state to use a blue continuous line when the cable is
between 8 to 20 cm in diameter. If a cable is 9 cm in diameter the software assigns to the
cable the symbol with the higher priority, in this case a red broken line.
10. Close the Define Item Type Symbology window when you have completed defining
symbols for the selected item type.
Name — Specifies the filter name. The name can be any combination of characters and has no
length limit. Filter names within a plant must be unique. This name appears as the filter name in
the Filter Manager interface.
Description — Specifies a phrase or sentence about the filter. The description can be any
combination of characters and has no length limit. The description appears as a ToolTip when
you point to the filter name in the Filter Manager interface.
Filter method
Allows you to decide whether items must meet all or only one criterion to pass through the filter.
Match all — Specifies that items matching ALL of the filtering criteria pass through the filter.
Match any — Specifies that items matching any one or more of the filtering criteria pass through
the filter. Match any is the default matching method.
Copy to single plant group hierarchy item — Allows you to copy the selected source
naming conventions to a single plant group hierarchy item which is indicated in the box
below. Click Browse to select a target plant group hierarchy item (which will then appear in
the box).
Copy to multiple plant group hierarchy items — Allows you to copy the selected source
naming conventions to multiple plant group hierarchy items which you select in the data
window below. In the data window, select the check boxes next to the plant group hierarchy
items to which you want to copy the source naming conventions.
Select all — Allows you to copy the selected source naming conventions to all the target
plant group hierarchy items that appear in the data window above.
▪ The plant group hierarchy levels of the source pant group and the target plant group must
be the same. For example, if the selected source plant group level is unit, the target plant
group level must also be unit. This is true for both options in the Source group box.
▪ When copying naming conventions, the software overwrites naming conventions that exist
in the target plant group item.
▪ If the source plant group hierarchy item that you selected does not contain any naming
conventions, the naming conventions in the target will remain unchanged.
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.
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 box.
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. Clicking Browse beside the Filter box opens the Select Filter dialog box, where
you can select an existing filter or create a new filter.
Browse — Opens the Select Filter dialog box, 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. For details,
see Define a Naming Convention for Parallel Cables (on page 26).
▪ 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 clicking 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.
Property Description
Electrical Equipment.Item Designates the name of the electrical equipment item tag
Type which the control station is associated with. This property
is only available for control stations. You can include as a
Property Description
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.
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.
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.
Add — Opens the Add Plant Operating Case dialog box that allows you to add another plant
operating case, which will then make it possible to add load data specific to that case.
Edit — Opens the Edit Plant Operating Case dialog box that allows you to edit the name and
description of the selected plant operating case. Also, allows you to set the selected operating
case as the governing case in your plant.
There can be only one governing operating case in your plant.
Delete — Deletes the selected plant operating case.
You cannot delete the active or governing operating cases.
If you delete a plant operating case, all the data entered for that case for all
the loads will also be deleted.
Reference Data
This section contains all item type folders that are available in the Reference Data Explorer.
You use these folders to display the existing reference items that you can select to be included
in the package. Expand or collapse the tree view and then click a folder to display its reference
items in the grid on the right.
Items
Allows you to specify the reference items that you want to include in the package. The grid
contains all the reference items that exist in the folder that you selected in the Reference Data
tree view. The view of the reference items in the grid depends on the layout and filter that you
select in the Folder view group box. If you do not select any layout or filter, the grid displays the
item tag names and item tag descriptions.
Select — Allows you to select a reference item to be included in the package file. When cleared,
the software excludes the reference item from the package.
If you select an item that has child items (for example a motor with a
space heater), the software selects the child items automatically without displaying them in
the Items grid.
Mandatory — Indicates whether a reference item is in use in the current plant or project and, in
which case it is recommended that you include this item in the package.
If a reference item has been used in the current plant, the software marks this
reference item as mandatory and it is recommended that you include it in the package.
▪ All types of cables
▪ Glands
▪ Cableway components
▪ Profiles
▪ Typical circuits
▪ Typical schematics
▪ I/O sets
▪ Lookup tables
Item Tag — Displays the name of the reference item.
Description — Displays the description of the reference item.
Project/Session information
Plant/Project — Displays the name of the plant or project that you are currently connected to.
This is the host plant or project whose reference data you are going to include in the package.
Session — Displays the path and file name of the open session.
Layout — Allows you to select an appropriate layout that has been created in the EDE of the
current plant or project.
You set the view for each folder that you select in the Reference Data tree view.
If you do not select any layout, the grid displays the basic view that includes the item tag
names and their descriptions.
Current view
Allows you to determine the view of the Items grid and select the required reference items that
belong to the current folder.
Layout — Allows you to select an appropriate layout that has been created in the EDE of the
current plant or project.
You set the view for each folder that you select in the Reference Data tree view.
If you do not select any layout, the grid displays the basic view that includes the item tag
names and their descriptions.
Select all shown items — Allows you to select all the reference items that exist in the current
Reference Data folder. When cleared, the software cancels the selection of the reference items
belonging to the current folder.
Check Boxes
Select all reference items — Allows you to select all the reference items that exist in the
current plant or project. When cleared, the software cancels the selection of all reference items.
Select all mandatory items — Allows you to select all the reference items that have been used
to create plant items in the current plant or project. When cleared, the software cancels the
selection of all mandatory items. We recommend that you keep this check box selected. Items
belonging to the following item types can be mandatory:
▪ All types of cables
▪ Glands
▪ Cableway components
▪ Profiles
▪ Typical circuits
▪ Typical schematics
▪ I/O sets
▪ Lookup tables
Command Buttons
Open Session — Opens an existing session that you have saved previously. You can open a
session from a saved session file or a package. On the Open dialog box, from the Files of type
list, select one of the following:
Items
Allows you to specify the reference items that you want to include in the import. The grid
contains all the reference items that exist in the folder that you selected in the Package
Reference Data tree view of the current package. The view of the reference items in the grid
depends on the layout and filter that you select in the Folder view group box. If you do not
select any layout or filter, the grid displays the item tag names and item tag descriptions.
Select — When cleared, the software excludes the reference item from the import. By default,
all the new package items are selected to be included in the update process. Keep this check
box selected if you want to include the package item in the update process. Note that in this
version of the software existing items cannot be included in the update.
If you select an item that has child items (for example a motor with a
space heater), the software selects these child items automatically without displaying them
in the grid.
Mandatory Package Item — Indicates whether the package item is a mandatory item in the
current package. A reference item is mandatory if it is in use in the plant or project where the
package was created. We recommend that you select all the mandatory items. An item is
considered in use if it is referenced in a plant item. For example, reference cables, loads used in
a profile, and so on. Items belonging to the following item types can be mandatory:
▪ All types of cables
▪ Glands
▪ Cableway components
▪ Profiles
▪ Typical circuits
▪ Typical schematics
▪ I/O sets
▪ Lookup tables
Package Item Status — Indicates whether the package item exists in the current project. If a
package item has the same item tag as a reference item in your plant, the software checks if the
SP_ID property of these two items is the same. If the SP_ID property is the same, the package
item is marked as Existing, in which case the item is not imported.
There may be a situation where there will be items with duplicate names.
This can happen if package item and a plant reference item have the same item tag but
different SP_ID properties.
Item Tag — Displays the name of the reference item.
Description — Displays the description of the reference item.
Project/Package Information
Target Plant/Project — Displays the name of the target plant or project that you are currently
connected to. This is the plant or project into which you are going to import the package
reference data.
Package — Displays the path and file name of the open package.
Source plant/project — Displays the name of the source plant or project in which the current
package was created.
Current view
Allows you to determine the view of the Items grid and select the required package items that
belong to the current folder.
Layout — Allows you to select an appropriate layout that has been created in the EDE of the
current plant or project.
You set the view for each folder that you select in the Package Reference Data
tree view. If you do not select any layout, the grid displays the basic view that includes the
item tag names and their descriptions.
Select all shown items — Allows you to select all the reference items that exist in the current
Reference Data folder. When cleared, the software cancels the selection of the reference items
belonging to the current folder.
Check Boxes
Select all package items — When selected, the software selects all the items that exist in the
current package. When cleared, the software, clears all the selections of the package items.
Select all mandatory package items — Allows you to select all the reference items that have
been used to create plant items in the current plant or project. When cleared, the software
cancels the selection of all mandatory items. We recommend that you keep this check box
selected. Items belonging to the following item types can be mandatory:
▪ All types of cables
▪ Glands
▪ Cableway components
▪ Profiles
▪ Typical circuits
▪ Typical schematics
▪ I/O sets
▪ Lookup tables
Command Buttons
Open Package — Opens an existing package so that you can start selecting the reference
items that you want to import.
Save Selections — Saves the selections that you have made. The software saves your
selections in the current package file which you can open later and continue the current session.
When saving your selections, the software prompts you to save the current
package. We recommend that you save it under a different name so that you can preserve
the contents of the original package.
Report — Generates an Excel report that shows all the package items that you have selected.
Update Data — Starts the import process of all the reference items that you have selected from
the current package.
Log — Opens the log file created by the software. The log lists the package items that failed to
be imported. You can try to correct the problems indicated in the log file. Then, open the
package and import these items again.
Formats Window
Enables you to define or modify the default formats associated with various data types in the
application database.
Data Type
Displays all the available data types for which you can specify a format. You cannot modify the
data types. The formats appear in the Smart Electrical data model, as defined in the Data
Dictionary.
Format
Contains lists of format values you can associate with data types.
▪ The software uses a format defined in Options Manager only if the format for a specific
property belonging to the same data type is not defined in the Data Dictionary.
▪ The formats associated with the data types can change for different plants. You can use
the default data type formats, or you can create new formats in the Format Manager, which
is available with the Smart Engineering Manager installation.
Definition
Displays all defined criteria associated with a filter. To add to or modify the definition list, you
must select a line in the list and then define or edit the property in the Edit group. If you are
defining the EDE, the criteria that you enter on the Filter tab on the Advanced Table
Properties dialog box are combined with the base filter that you select.
Match all — Items matching ALL of the filtering criteria pass through the filter.
Match any — Items matching any one or more of the filtering criteria pass through the filter.
Match any is the default matching method.
Add — Places a new entry at the end of the existing definition list. Enables the fields in the Edit
group so that you can edit the new entry.
Delete — Removes the selected criterion from the definition list. This button is active only when
you select a criterion in the definition list.
Edit
Allows you to define or edit a single line of filter definition criteria.
Property — Displays a list of all properties for a certain item type. Examples of properties
include Rated Power, Rated Voltage, and Frequency. You define or modify filtering criteria by
selecting a property, an operator, and a value.
Operator — Specifies the relationship between the property and its value. Relationships
include, for example, greater than, >, equal to, =; not equal to, <>, and so forth.
Value — Lists appropriate values for the property specified in the Property column. If a list of
properties is not already associated with the Value box, you must type a value, which can be
free text, or specify null. You can type a percent sign (%) as a wildcard character to find multiple
characters or an underscore (_) as a wildcard character for a single character. Do not use an
asterisk (*) in the Value box.
Setting Description
Allows you to enter a value for the maximum number of parallel cables in
Numeric value
the range of 1 to 99.
Setting Description
Numeric value with Allows you to select a different value for the minimum cross-section
unit of measure of parallel cables.
When you select a setting for the minimum conductor cross-section of parallel cables,
a reference cable with that exact conductor cross-section must exist in Smart Electrical for the
software to be able to use parallel cables when sizing. If no such cable can be found, the
software uses a reference cable that has at least the indicated cross-section size.
Setting Description
▪ When defining naming conventions for parallel cables, you can determine where in the cable
tag name you want to include the parallel cable suffix. In Options Manager, on the Define
Naming Conventions dialog box (Options > Naming Conventions > Define), define the
parallel cable suffix in the Segment definitions section. You can move the parallel cable
suffix property up or down the list to set the position of this property in the segment
definition. If you do not select this check box, the suffix for the parallel cables will appear at
the end of the cable tag name.
▪ Changing the suffix method for existing parallel cables does not replace the existing suffix
but rather concatenates the old and new suffixes when resizing the cables.
Setting Description
0 Denotes a character position in the parallel cable name suffix mask. For example if
000 is entered in the Parallel Cable Input Suffix field and 1,2,3 is selected in the
naming method, then the suffix for the first cable appears as 001, the second 002
and so forth. You can have up to 10 characters in the suffix.
Changing the suffix input mask for existing parallel cables does not replace
the existing mask but rather concatenates the old and new suffix masks when resizing the
cables.
Setting Description
Text Denotes the default separator between the parallel cable name and its suffix.
(one character) You can type in a single character or insert an empty space (by pressing the
space bar on your keyboard). If you do not want any separator, leave this
setting undefined.
Changing the parallel cable separator for existing parallel cables does not
replace the existing separator but rather concatenates the old and new separators when resizing
the cables.
Setting Description
Yes Allows the cable routing of parallel cables via different routes.
No Does not allow the cable routing of parallel cables via different routes. Parallel
cables must be routed via the same route.
Setting Description
Text Denotes the default separator between the single core cable name and the
(one character) phase suffix. You can type in a single character or insert an empty space (by
pressing the space bar on your keyboard). If you do not want any separator,
leave this setting undefined.
Setting Description
Yes Includes phase labels in the names of cables in single-core cable assemblies
Does not include phase labels in the names of cables in single-core cable
No
assemblies
Setting Description
Identical Sets the tag sequencing of the cables in a single-core cable assembly to be
identical in the group and the cable uniqueness identifier is a number.
Examples:
Cable - 174-1; Cable - 174-2; Cable - 174-3
Consecutive Sets the tag sequencing of the cables in a single-core cable assembly to be
consecutive. This setting makes the names of the cables in the assembly
unique without the need of a uniqueness identifier. Examples:
Cable - 181; Cable - 182; Cable - 183
Setting Description
Identical Sets the tag sequencing of the parallel cables to be identical in the group and
the cable uniqueness identifier is the parallel suffix. Examples:
Cable - 174/0A; Cable - 174/0B; Cable - 174/0C
Consecutive Sets the tag sequencing of the parallel cables to be consecutive and the
cable uniqueness identifier is the cable tag number. Examples:
Cable - 181/0A; Cable - 182/0B; Cable - 183/0C
Changing the parallel cable tag sequencing method does not affect the tag
sequencing of existing parallel cables.
Setting Description
Text Denotes the default separator between cableways and their segments. You
(up to two can type in a single character or insert an empty space (by pressing the
characters) space bar on your keyboard). If you do not want any separator, leave this
setting undefined.
Setting Description
Text Denotes the default separator between cableway segments. You can type in
(up to two a single character or insert an empty space (by pressing the space bar on
character) your keyboard). If you do not want any separator, leave this setting undefined.
Setting Description
Allows you to calculate the overall cable de-rating factor without taking a
No
temperature correction factor into account.
Setting Description
Apply naming Applies the appropriate naming conventions when users of Smart
conventions Electrical duplicate PDB internals.
Keep source names Enables users of Smart Electrical to change the name of the item used
as a source for duplication and keep the original names of PDB
Setting Description
internals that are sub-items of the source item.
This setting does not affect circuit internals. Names of duplicated circuit internals
always remain the same as in the source PDB.
SAP interface
Allows you to enable or disable the export of data to SAP.
Setting Description
Activates data export from Smart Electrical to SAP. From the moment that you select
this setting, when you run the SAP Export Utility (SPELSapWiz.exe), the exported
Enable
data includes any new updates or deletions for items that were created when you
began your project.
Deactivates data export from Smart Electrical to SAP. For the period during which
Disable data export is deactivated, the software does not recognize any updates or deletions
that you make for items in the database for the purpose of exporting data to SAP.
Archive documents
Allows you to archive SLD and schematic drawing data in your Smart Electrical database.
Setting Description
Enables the use of the archive options so that users of Smart Electrical can view and
Enable compare an archived version of a document with the data in the current version of that
document.
Consistency rules
Allows you to apply consistency rules created in Rule Manager. These rules determine how
items act and interact in a project.
Setting Description
Enables the use of consistency rules, the display of messages on detecting a rule
inconsistency, and generation of rule inconsistency reports. When a rule
Enable inconsistency is found, depending on the action associated with a rule consistency
setting, the software records an inconsistency in a log file, warns the user about the
inconsistency, or rejects the inconsistency automatically.
Setting Description
Disable Disables the implementation of the rules and generation or rule inconsistency reports.
Setting Description
▪ The Consistency rules for batch operations option only takes effect when you select Yes for
the Consistency rules option.
▪ The Consistency rules for batch operations option only applies when a consistency setting
(logical expressions) is associated the Warn action. For details on the actions that can be
associated with rules, see Rule Manager Online Help.
▪ Regardless of the Consistency rules for batch operations setting, the software records rule
inconsistency details into a log file, which you can generate from Smart Electrical.
Enable text indicator for labels with undefined plant item property
values
Allows you to set the software to display a text indicator (that you define below) on labels that
contain no plant item property value or labels that are not associated with graphical elements
(auxiliary graphics or symbols).
Setting Description
Enables the definition of a text indicator for labels that contain no plant item property
Yes
values.
Disables the definition of a text indicator for labels that contain no plant item property
No
values.
Text indicator for labels with undefined plant item property values
Allows you to define the text indicator on labels that contain no plant item property value or
labels that are not associated with graphical elements (auxiliary graphics or symbols).
Setting Description
Allows you to type the text that will appear on labels that contain no plant item property
value. This text appears only if the Enable text indicator for labels with undefined
Text string
plant item property values setting is set to Yes. If the above-mentioned setting is set to
No, the labels with undefined plant item properties do not display any text.
Setting Description
ETAP Sets the format of the .xml file in accordance with ETAP.
Setting Description
Allows you to type the name of the project as it appears in the external analyzing
Text string
application.
Setting Description
Yes Allows Smart Electrical users to run the Enhanced Report Utility.
No Prevents Smart Electrical users from running the Enhanced Report Utility.
If you want to include enhanced reports in schematic drawings, you must also enter
the name of the domain for the setting Smart Instrumentation default domain.
Setting Description
Allows you to enter the name of the Smart Instrumentation default domain. The characters
Text string
that you enter are not case-sensitive.
Setting Description
Sets the software to define the From side of a control station cable or instrument cable
automatically. The From side definition of a control station cable or instrument cable
Yes becomes the same as the circuit name of the associated equipment. Note that the automatic
association is implemented even if the feeder circuits are connected to the loads via
converting equipment.
Setting Description
Makes the From side of the control station cable or instrument cable available for manual
No
definition.
Setting Description
Does not record any history records in the table CHANGES_LOG. If previously the setting
No
was Yes, the accumulated history records remain available in the table CHANGES_LOG.
History records in the changes_log table do not include records of new items that
users create.
Setting Description
Allows users working in As-Built to add, edit, or delete items, or make other change as in any
other project. After you select the Yes setting, specific user access rights apply. For example,
Yes
if access privileges do not allow a certain user to delete items in Smart Electrical, this user can
add or edit items in As-Built but cannot delete the items.
Prevents users from making any data change in As-Built, other than merging project data with
As-Built. In As-Built, all data becomes read-only. It is possible, however, to generate an SLD
but it is not possible to save it. Selecting the No setting is useful when there are users who
No work with As-Built data scoped and claimed for a specific project and then intend to merge the
project data with As-Built to implement only those changes that were made in the
project. Also, if your plant is registered with SmartPlant Foundation, you must select the No
setting.
If the current plant does not have As-Built and projects, the No setting functions as an
additional super access privilege. This means that users of the current plant can only work in
read-only mode.
Setting Description
Reject the document The current document will not be merged into As-Built
Increment the revision number The software will raise the revision number in As-Built
Use the existing number and overwrite the The software will retain the revision number in As-Built
revision but will overwrite the revision information
Claim mode
Determines whether an As-Built item can be claimed for one or all projects defined in the
plant. This option only applies to plants that have As-Built projects.
Setting Description
Exclusive Allows a Smart Electrical user to claim an As-Built item only for one project.
Any Allows the same As-Built item to be claimed for more than one project.
If your plant is registered, the software only applies the Exclusive mode, regardless
of the setting you define in Options Manager.
KKS mode
Activates propagation of KKS names when KKS naming conventions are used in the project.
Setting Description
Setting Description
Calculates fill parameters for the cables that you add to the segment as part of the routing
Yes
and validates the values of these parameters against NEC fill regulations.
Smart Electrical calculates fill parameters for the cables that you add to the segment as part
No of the routing and validates the values of these parameters against the maximum allowed
values that you specify.
Setting Description
Allows you to enter the characters you wish to exclude from a PDB layout when a row
Alphanumeric naming type has been selected. For example, the characters I and O could be excluded so
there would be no confusion with the numbers 1 and 0.
Setting Description
Yes
No
Setting Description
Instructs the software to add new revisions using Smart Electrical revision
Smart Electrical
management tools.
Setting Description
Yes Sets the software to retrieve electrical equipment items published by Smart 3D.
No Sets the software not to retrieve electrical equipment items published by Smart 3D.
Setting Description
Yes Instructs the software to publish plant items without any spaces in their item tag names.
No Instructs the software to publish plant items with existing spaces in their item tag names.
Setting Description
Only plant items contained in Publishes the document and all the plant items contained in the published
the published document document
Publishes the document, all the plant items contained in the document, and
Plant items and their first-level
the first-level related items of the plant items contained in the published
related items
document.
Setting Description
Plant items and all their related Publishes the document, all the plant items contained in the document, and
items the related items of the plant items contained in the published document
If you select the Plant items and all their related items option, it can take a
very long time to publish a large set of data.
Setting Description
Row sequence and names Displays both the row sequence and row name.
Setting Description
Yes In RAD documents, displays item tag names without any whitespace characters.
No In RAD documents, displays item tag names with the whitespace characters if they exist.
Setting Description
Descending Sorts the cables starting with the longest cable and then all the way to the shortest one.
Sorts the cables starting with the longest cable, then with the shortest, then with the second
Alternate
longest and then back to the shortest again, and so on.
Setting Description
Allows you to enter the name of the lookup table that holds the values needed to calculate
Text string
the custom basic ampacity. The characters that you enter are not case-sensitive.
Setting Description
Numeric value with Allows you to type a numeric value with an appropriate unit of
unit of measure measure.
Cable details
This data window displays a list of ETAP library cables that are available in the selected .mdb
file. The list becomes available after selecting an ETAP library in the ETAP cable library
location box.
Select — Allows you to select the ETAP library cables that you want to import.
Cable Conductor — Displays the conductor value of the ETAP cables.
Size — Displays the size of the ETAP cables.
Rated kV — Displays the rated kV value of the ETAP cables.
Source Name — Displays the source name of the ETAP cables.
Make sure that before you start the import process, all the source names of
the ETAP library cables that you want to import have been added to the Source name select list
in the Data Dictionary.
Cable Specification — Displays the cable specifications that you select for the ETAP cables.
You must specify an appropriate cable specification for each ETAP library
cable before you import the cables to Smart Electrical. To do so, highlight the cables you require
and click Update Cable Specification.
Update Cable Specification — Opens the Cable Specification dialog box that allows you to
select an appropriate cable specification.
OK — Starts the import process.
Cancel — Closes the Import ETAP Library Cables dialog box without importing any cables.
Cable details
This data window displays a list of reference power cables and their properties. The list
depends on the selection method that you chose on the previous page. If you selected the All
power cables option, the list contains all available reference power cables. If you selected the
Power cables with selected cable specifications option, the list contains only those reference
power cables that have the cable specifications that you selected on the previous page.
Select — Allows you to select a particular cable for export.
Cable Tag — Displays the name of a particular reference power cable.
Cable Specification — Displays the cable specification for a specific reference power cable.
Cable Formation — Displays the cable formation value for a specific reference power cable.
Finish — Exports the selected reference power cables.
▪ The software exports the reference cables to the cable library file that you specified in
Options Manager and appends the new cables to the list of the existing cables in that library.
▪ If you export reference cables that already exist in the cable library, the software overwrites
the old cables with the newly exported cables.
▪ There are certain cable properties that must be defined for the reference cables prior to
exporting them. These properties form the ETAP cable headers and they are all mandatory
for ETAP. Any reference cable that lacks even one of these property definitions is rejected
by the software after the export process. The following properties must be defined before
starting export:
▪ Conductor Arrangement
▪ Conductor Material
▪ Conductor Size
▪ Frequency
▪ Base Temperature
▪ Installation
▪ Insulation Material
▪ Insulation Temperature Rating
▪ Insulation Voltage Rating
▪ kV Class
▪ Length Unit of Measure
▪ Number of Conductors
▪ Source Name
▪ SP_TaBaseAboveGround
▪ Ta Base Under Ground
▪ Tc Base Above Ground
▪ Tc Base Under Ground
▪ Unit System
▪ RHO
▪ A plant group type is a level of plant hierarchy. The available plant group types depend on
the plant hierarchy you define in Engineering Manager.
▪ After assigning an item type to a plant group type, you can define a naming convention for
this item type in the Define Naming Conventions window and define default property
values in the Project-Wide Parameters window.
▪ Smart Electrical displays items from all the units in a specified plant.
▪ When you specify a plant group type for the Power Distribution Board (PDB) item type, the
software automatically assigns all PDB internals such as buses, circuits, cells, fuses, circuit
breakers, and so forth, to the same plant group type. You can only change the plant group
type of PDB internals by changing the plant group type of the PDB itself. Other item types
that inherit their plant group type from their parent item are, transformer components and
circuit internals.
▪ Metering equipment, even when part of PDB internals, have their own plant group type and
do not inherit the plant group type from the PDB.
Item type uniqueness level — Defines the plant group type in which the item type tag must be
unique per plant group. This command applies only if you set the Is unique option to Yes. For
example, if you select Unit as the uniqueness level, then in a unit where you create the tag for
the item type, this tag name must be unique. In other units in the same plant, you can use the
same tag.
The available levels depend either on the plant group types or on the parent item
types. For details, see the Uniqueness Level (see "Uniqueness Level Table" on page 83) table.
Default block — Indicates the drawing block file name that the software uses as the default
symbol for typical schematic blocks.
Is unique — Indicates that the item type must be unique in a plant group that belongs to the
plant group type you specify under Item type uniqueness level.
Item type identifier — Specifies a default prefix that the software uses in the item tag when you
do not define a naming convention for the item type. The software uses the item name by
default as the identifier.
Last created sequence number — Specifies a starting sequence number that the software
applies to a new item. The software automatically increments this number by one each time
you create a new item of the specified item type. The software also uses this sequence number
in the item tag when you do not define a naming convention for the item type to enable
uniqueness validation.
We recommend that you do not make the value of the next sequence number lower
than the current value, to avoid the possibility of the software creating duplicate item tags.
Locations Window
In this window, you specify various reference file locations. These settings define where to find
and store particular types of data. Also, you can specify various default settings used in
creating power distribution board layouts, single line diagrams, and schematics.
The following table lists and describes the location options that you can define.
Option Description
Default file path for batch Specifies the default folder where batch generated
generated PDBs SLDs PDBs single line diagrams are stored.
Default file path for schematic Specifies the default folder where generated schematic
drawings files are stored.
Default path for conventional Specifies the default folder where the template files for
drawing templates conventional drawings are stored.
Option Description
ETAP - Smart Electrical Specifies the storage location and the name of the MDB
reference exchange file file that contains the ETAP reference cables.
ETAP Smart Electrical mapping Specifies the storage location of the ETAP - Smart
file Electrical mapping file.
Default file path for Specifies the folder where the software generates and
miscellaneous drawings stores miscellaneous drawings.
Default file path for wiring Specifies the storage location of the reference symbols
diagram symbols for wiring diagrams.
Default file path for cable block Specifies the storage location of the reference symbols
diagram symbols for cable block diagrams.
Conventional CBD default Specifies the storage location and the name of the
template file name and location default template for conventional cable block diagrams.
Option Description
PDB layout default template file Specifies the storage location and the name of the
name and location default template for PDB layouts.
Default file path for PDB layout Specifies the storage location for symbols used in the
symbols PDB layout.
Composite SLD default template Specifies the file name of the default template for
file name and location composite SLDs.
Composite drawing default Specifies the file name of the default template for
template file name and location composite drawings.
Site Server — Opens the Open Site Server dialog box, where you can select an initialization
file from local and network directories. Plants that correspond to the initialization file you
choose are subsequently displayed in the list of available plants in the database.
Category
Contains preference categories available for selection.
General — Allows you to set general preferences. For more information, see General
Preferences: Option Description.
SLD — Allows you to set preferences related to single line diagram (SLD) options. For more
information, see SLD Generation Preferences: Option Description.
Reports — Allows you to set preferences related to all feeder load summary reports. For more
information, see Load Summaries and Reports (Plant Default Preferences Window).
Delete Loads — Allows you to set preferences related to the deletion of main items and their
related items. For more information, see Delete Loads Preferences: Option Description.
Preferences
Displays preference options, values, and units (where applicable) that you can set as default for
all new users in the plant. The software displays the preference options dynamically, according
to the category that you select.
Option — Displays a list of preference options for which you can specify values and units for
numeric values.
Value — Allows you to select or type a default value for a preference option.
Units — Allows you to select a unique unit of measure for all of SLD margins and units of
measure for SLD internals (buses, circuits and circuit internals).
Apply also for existing users — Applies the preference settings for all new and existing users.
▪ Setting the preference to No only affects the recording of errors in log files; it does not
prevent the software from displaying error messages.
▪ If an error is caused by a violation of engineering rules, the software does not display any
error message and therefore does not write any records to the relevant log file.
SLD margins
Allow you to define the default unit of measure for SLD margins and distance between the page
edges and the SLD drawing so that the drawing does not overlap the title block. The unit of
measure for top, bottom, left and right margins changes dynamically, according to the
preference for margin units.
Drawing options
Allow you to set general preferences for SLD generation.
Save settings of last generated drawing — The following options are available:
▪ Yes — Saves and then applies all the settings that users define on the Single Line
Diagram Options dialog box (SLD margins and Distance for SLD internals). This
preference takes effect after generating an SLD and applies to all subsequent SLD
generations in the current Smart Electrical session.
▪ No — For subsequent generations in the current Smart Electrical session, saves only the
SLD margin preferences and returns all the other SLD options to the application defaults.
After moving electrical items in a generated drawing, moving and resizing the
frames that the software draws around items belonging to PDBs and around circuits in each cell,
the software always retains the position of all electrical items in saved drawings without the need
to instruct the software to do so.
Use bus tie symbols — The following options are available:
▪ Yes — Shows a horizontal representation between two connected buses using the
BusTie.sym file. In this case, the software shows the connection between the two buses as
a straight bus-tie connection without showing the items connected between and within the
circuits. The BusTie symbol is a "circuit" type symbol and has its first connection point on
the rightmost side and the second connection point at the leftmost side.
▪ No — Shows a vertical representation of a connection between two buses. This is the
standard bus coupler-riser circuit connection representation that includes both coupler and
the riser circuits and displays them as vertical objects, connected to each other. The
software displays both circuits as standard arrows.
▪ Do not include coupled buses — Includes in the calculation only those loads that are
connected to the current bus and does not include the loads that are connected on the
redundant buses.
▪ Include coupled buses connected by couplers only — Includes in the calculation the
loads connected on the current bus as well as loads connected on all the redundant buses
that are connected to the current bus by a coupler circuit.
▪ Include coupled buses connected by couplers and bus risers — Includes the loads of
the current bus as well as the loads on all the redundant buses that are connected to the
current bus by coupler and riser circuits.
Preferences
Delete feeding power cables — Allows you to delete feeding power cables.
Delete associated control, grounding, and instrument cables — Allows you to delete
associated control, ground, and instrument cables.
Delete associated control station/instruments — Allows you to delete the associated control
station and instruments.
Delete feeding circuit and cell — Allows you to delete the feeding circuit and cell.
Value
Yes — Allows related item to be deleted with the main item.
No — Does not allow related item to be deleted with the main item.
Apply also for existing users
Allows you to apply the default settings to existing users, not just new users.
▪ You can copy property values only within the same item type. Therefore, if in the
Plant-Wide Parameters window, you select a plant, you cannot use the Copy From option.
▪ The software only copies property values if the source and target item types are assigned to
the same plant group type, for example, to area. Therefore, source and target groups must
belong to the same type. You assign item types to plant group types in the Item Types
window.
Item types
Lists all item types item types which you can select for property value definition for the specified
plant group. The availability of item types which you can select for property value definition
depends on the plant group type to which you assigned the item types.
Item Type — Allows you to select one specific item type.
Properties
Displays a two-column data window that provides the common properties of the selected item
type. You use this table to define default property values for new item types created in Smart
Electrical.
At the top of the Properties data window, a display mode button appears. By clicking
the button, you can customize data display. For more information, see Customize Data
Display in the Properties Data Window (on page 37).
▪ 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 no filter is assigned, Smart Electrical can only create a new item tag using segment
definitions specified for the convention label that was 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.
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 or a property.
Property/Text — Displays default text if the segment type is Text or displays a property
appropriate to the item type if the segment type is Property.
Protect — Shows 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 — Shows the position of the character in the property name that appears at the start of the
segment.
Length — Shows 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.
Drawing Type Filter — Click in an empty cell to open the Select Filter dialog box. The Select
Filter dialog allows you to select a filter that will narrow down the selected drawing type to a
specific drawing type where the symbol will be used. You can select, modify, or create a new
filter in the Select Filter dialog box. For more details, see Select Filter Dialog Box (on page 94).
Symbol File — Click Browse to open the symbol folder and select the required symbol.
Initial Style — Displays a list of available style names. The style sets the color, weight, and
pattern of the symbol as defined in the Catalog Manager. For more details, see the Using the
Smart Line Style Editor topic in the Catalog Manager Help.
Color — Displays the color associated with the chosen style. Clicking on the color opens a list
where you can change the style color. Changing the color does not affect the default settings
for the chosen symbol, it only affects the symbol for the item type and document type selected.
Width — Displays the line width associated with the chosen style. Clicking on the line width
opens a list where you can change the line width. Changing the line width does not affect the
default settings for the chosen symbol, it only affects the symbol for the item type and document
type selected.
Pattern — Displays the line pattern associated with the chosen style. Clicking on the line
pattern opens a list where you can change the line pattern. Changing the line pattern does not
affect the default settings for the chosen symbol, it only affects the symbol for the item type and
document type selected.
Move Up — Moves the selected row one row higher, making the priority of the selected item
type higher (the top row has the highest priority.) The priority rules are set by the filter. The
priority determines which rule applies first when rules conflict with each other. For example,
Filter A is the first row. The filter's rules state to use a red broken line to represent cables that
are between 2 to 10 cm in diameter. Filter B is below Filter A in the Define Item Type
Symbology window and its rules state to use a blue continuous line when the cable is between
8 to 20 cm in diameter. If a cable is 9 cm in diameter the software assigns the cable the symbol
that has the higher priority, in this case a red broken line.
Move Down — Moves the selected row one row lower, making the priority of the selected item
type lower.
The settings in this window apply to both conventional and composite drawings.
Patterns — Lists all the available linear patterns. This list supports single entry selection only.
Import — Opens the Import Linear Patterns From dialog box, where you can browse to the
file that is your linear style and import it. Linear patterns and styles are stored in symbol (.sym)
files. When you import a linear pattern or heat tracing style, you must close the Linear
Patterns dialog box and re-open it in order to see the newly imported information.
Delete — Deletes the pattern you have selected in the Patterns list. If a style is in use, it cannot
be deleted.
_
Linear Styles — Lists all the available linear styles. This list supports single entry selection only.
Import — Opens the Import Linear Styles From dialog box, where you can browse to the file
that is your linear style and import it. Linear patterns and styles are stored in symbol (.sym)
files. When you import a linear style or heat tracing style, you must close the Linear Styles
dialog box and re-open it in order to see the newly imported information.
Delete — Deletes the style you have selected in the Linear Styles list. If a style is in use, it
cannot be deleted.
▪ You can group the display of the grid according to Category by dragging the Category
header to the area above the grid.
▪ You can filter out some of the categories by clicking the filter icon in the Category
header.
Property — Displays the cable property name as it appears in the Properties window or
Common Properties dialog box.
You can filter out some of the properties by clicking the filter icon in the Property
header.
Selection Check Box — Allows you to select a cable property for synchronization. You can
select the top check box in the header to select all the cable properties that exist in the grid.
Note that not all cable properties are available for selection in the grid,
depending on the property type. Some properties cannot be selected and some are selected all
the time.
▪ Cable properties which are available for selection — these are shipped and user-defined
cable properties and they will be synchronized once they are selected.
▪ Hard-coded system properties which are always selected — these are shipped properties
and they are always set for synchronization. You cannot clear these selections.
▪ Cable properties which cannot be selected for synchronization — these properties are only
displayed in the grid and they appear as unavailable for selection.
▪ Some cable properties are hidden as they are not applicable for synchronization.
Menu Commands
Saves to the database any changes that you have made in a plant group.
Copies the file location setting or part of a setting selected in the Locations window to the
Clipboard.
Inserts the file location settings from the Clipboard into the cell selected in the Locations
window.
Deletes a naming convention and all its segments for an item type that you select in the Define
Naming Conventions window.
Opens the Formats window, where you can define or change the default formats for various
data types.
Opens the Define Naming Conventions window, where you can define a naming convention for
each item type or copy a naming convention for an item type from a source to a target plant
group, for example, for a cable from Unit1 to Unit2 within the same plant.
Opens the Locations window, where you can specify the locations of various library, file, and
path names for your project.
Opens the General Settings window, where you define settings for the parameters that the
software uses in cable sizing. Also, you define a setting for duplication of PDB internals.
Opens the Plant Default Preferences window, where you can set default preferences for new
users and, if needed, apply preference settings for all new and existing users.
Opens the Plant-Wide Parameters window, where you can select an item type and define
default values for item type properties.
Using Help
Options Manager user assistance makes command information available as you perform tasks.
You can access different kinds of information any time you are running the software. This
information could include reference topics, narrative descriptions, or general overviews. Also,
you can find information about the software version numbers and legal information by using
commands available on the Help menu.
▪ Click Help > Smart Electrical Options Manager Help to display online Help topics for Options
Manager.
Displays the online Help for Options Manager, which includes topics about commands, dialog
boxes, tasks, and workflow scenarios.
I deleting • 32
order of priorities • 94
importing • 44, 97, 98
priority numbers • 94
heat tracing styles • 44
linear patterns • 44, 97, 98
linear styles • 44 N
interfaces • 21 naming conventions
enabling access to SAP • 21 copying • 29, 30
item types • 24, 29, 34, 37, 51, 52 copying for item types • 52
copying naming conventions • 29, 52 copying for plant groups • 31, 52
copying property values • 37, 51 copying to reference data • 31
defining default values • 37 defining • 24
naming conventions • 24 overwriting • 31, 52
overview • 34 source item types • 52
new filters • 50
L
line • 47, 48 O
linear • 44, 47, 48, 97, 98 online Help • 106
patterns • 44, 47, 48, 97, 98 opening • 97, 98
styles • 44, 47, 48 plant structures • 86
opening plant structures • 86, 97, 98
M linear patterns • 97, 98
Options Manager • 8, 9, 10
Match all • 51
exiting • 10
Match any • 51
navigating • 9
menus and commands • 101, 102, 103,
plants • 8
104, 105, 107
associate symbol • 105
Close • 101 P
Copy • 101 parallel cables • 21
Copy Naming Conventions for Plant settings • 21
Group • 103 pasting file location settings • 14
Copy Naming Conventions to Reference patterns • 44, 47, 48, 97, 98
Data • 103 linear • 97
Cut • 101 plant group types • 34, 83
Define Naming Conventions • 102 definition • 34
Delete • 102 uniqueness level • 83
Exit • 101 plant groups
Formats • 102 copying naming conventions • 30, 31, 52
General Settings • 103 hierarchy • 86
Locations • 103 item types • 37
Open Plant Group • 101 opening • 8
Paste • 102 plants
Plant Default Preferences • 104 structure • 8
Printable Guides • 107 preferences
Project-Wide Parameters • 104 settings defaults • 39
Reference Data Import • 104 priorities • 31, 94
Replace • 102 changing • 31
Save • 101 order of priorities • 94
View Naming Conventions in Reference priority numbers • 94
Data • 103 project-wide parameters • 37
multiple naming conventions • 31, 32, 94 copying • 37
changing priorities • 31 defining • 37
R
reference data • 31, 52, 93
reference data naming conventions • 31,
52, 93
copying naming conventions • 31
reference plant groups • 52
replacing • 93
replacing • 14, 93
file locations • 14
reference data settings • 93
S
saving • 12
servers • 86
settings • 21
parallel cables • 21
PDB internals • 21
site server • 8
connecting • 8
plant structure • 8
sites • 86
source • 31, 37, 51, 52
item types • 37, 51
naming conventions • 31, 52
plant group • 31, 37, 52
plant groups • 51
styles • 47, 48
lines • 47, 48
symbols
defining item type symbol • 45
overview • 44
removing a symbol from an item type • 46
T
target • 31, 52
naming conventions • 31, 52
plant group • 31, 52
U
uniqueness level • 83
circuit internal components • 83
circuits • 83