CommonGuide PDF
CommonGuide PDF
User's Guide
Version 2014 R1 (10.1) - UPDATED
June 2014 / February 2018
Copyright
Copyright © 1999-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.
Portions of this software are owned by Spatial Corp. © 1986-2018. All Rights Reserved.
Portions of the user interface are copyright © 2012-2018 Telerik AD.
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.
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 exportcompliance@intergraph.com.
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. ACIS is a registered trademark of SPATIAL
TECHNOLOGY, INC. Infragistics, Presentation Layer Framework, ActiveTreeView Ctrl, ProtoViewCtl, ActiveThreed Ctrl,
ActiveListBar Ctrl, ActiveSplitter, ActiveToolbars Ctrl, ActiveToolbars Plus Ctrl, and ProtoView are trademarks of Infragistics, Inc.
Incorporates portions of 2D DCM, 3D DCM, and HLM by Siemens Product Lifecycle Management Software III (GB) Ltd. All rights
reserved. Gigasoft is a registered trademark, and ProEssentials a trademark of Gigasoft, Inc. VideoSoft and VXFlexGrid are either
registered trademarks or trademarks of ComponentOne LLC 1991-2018, All rights reserved. Oracle, JD Edwards, PeopleSoft, and
Retek are registered trademarks of Oracle Corporation and/or its affiliates. Tribon is a trademark of AVEVA Group plc. Alma and
act/cut are trademarks of the Alma company. Other brands and product names are trademarks of their respective owners.
Best Practices.......................................................................................................................................... 36
Using multiple graphics windows ........................................................................................................ 37
Using clipping...................................................................................................................................... 38
Saving views ....................................................................................................................................... 41
Using transparent styles...................................................................................................................... 42
Using system folders to manage styles ............................................................................................... 44
Using surface style rules ..................................................................................................................... 45
Using enhanced edges render modes ................................................................................................ 46
Changing default colors ...................................................................................................................... 47
Using the Reference Geometry aspect ............................................................................................... 47
Documentation Comments
For the latest support information for this product, comments or suggestions about this
documentation, and documentation updates for supported software versions, please visit
Intergraph Smart® Support (https://smartsupport.intergraph.com).
filter properties. For more information, see System Tab (Filter Properties Dialog Box) (on
page 373).
Corrected notes on the behavior of original systems when using the Past and Restore
command. For more information, see Paste and Restore (on page 136) and Paste Dialog
Box (on page 135). (P4 CP:273368)
The Publish > UpdatePublish command is now called Publish > Update and Publish.
Common Overview
The various software tasks share some common operations like the View and File menu
commands. You use the Common task commands and functionality in the same
way—regardless of the active task; however, some of the commands and functionality are
unique to a particular task. For example, some commands within the Piping task are not
available in the Equipment and Furnishings task.
The Workspace
The workspace represents the portion of the model data on which you perform your intended
task, and it includes view properties for modeling. The Common task allows you to define that
workspace and perform common operations on it. For more information, see Workspace
Explorer (on page 243) and Viewing Your Work (on page 215).
Access Permissions
The left-most control on the main toolbar is the Active Permission Group
box, which allows you to set the permission group for the objects you are creating or editing.
The drop-down list contains all of the permission groups to which you belong. You can perform
specified functions, depending on your access permissions. For more information, see Access
Control (on page 20).
Locate Filter
You can use locate filters in the software to assist in selection of objects in the workspace. The
Locate Filter box on the main toolbar displays the active filter. For more information, see Locate
Filter (on page 148).
Main Toolbar
The main toolbar in each task displays horizontally at the top of the page and contains the same
controls and buttons—regardless of the active task.
New - Creates a new session based on a template. For more information, see
New (on page 52).
Open - Opens an existing session. If you have a session open when you click
this command, you receive a message asking if you would like to save the
changes to the active session. For more information, see Open (on page 54).
Save - Saves the active workspace as a session (.ses) file with its currently
defined name and location. For more information, see Save (on page 56).
Refresh Workspace - Updates all the views in the workspace with the most
current information from the database. Use this command to see changes that
other users in your permission group have made to objects visible in your
workspace, such as repositioning of equipment or adding new objects. You
can press F5 to refresh your workspace. For more information, see Refresh
Workspace (on page 69).
Delete - Removes the selected object from the database and deletes any
relationships and notes placed on the object. For more information, see Delete
(on page 150).
Move - Moves objects from one location to another. You specify the original
location of the object and then indicate the destination location. For more
information, see Move (on page 151).
Rotate Object - Rotates or turns selected objects after the initial placement of
the objects. For precision needs, you can define the angle and an incremental
step value. For more information, see Rotate Object (on page 157).
Pin Point - Helps you move, place, or modify objects with precision by
displaying coordinate data at the pointer. When you turn PinPoint on, the
PinPoint ribbon displays coordinates relative to a target position you set. You
can reset the target position at any time. For more information, see PinPoint
(on page 389).
Add to SmartSketch List - Adds an object that you select to the locate list of
SmartSketch 3D. For more information, see Add to SmartSketch List (on page
403).
Point Along - Helps you insert objects at specific locations along a path. A
path can be along a pipe, duct, cableway, or the intersection line between two
surfaces. For more information, see Point Along (on page 412).
Clip by Object - Isolates an object or group of objects in your model for closer
viewing or more detailed work. For more information, see Clip by Object (on
page 185).
Clip by Volume or Plane - Sets the view clipping volume. The software hides
all objects not inside the clipped area. This command also lets you edit the
clipped volume by dragging clipping planes in a graphic view. For more
information, see Clip by Volume or Plane (on page 187).
Clear View Clipping - Restores the view to its original state. Any objects
hidden by clipping redisplay. This command displays any objects in the view
that were hidden by the Clip by Volume or Clip by Object commands. Use
this command to restore the view before you define a new clipping volume or
object. For more information, see Clear Clipping (on page 195).
View by Points - Provides options for specifying the view plane by three
points or along a line. For more information, see View by Points (on page 205).
Rotate View - Rotates or turns a view freely about a point or about an axis
parallel to one of the axes in the global coordinate system. For more
information, see Rotate View (on page 209).
Named Views - Assigns a name and description to a view so you can apply
the settings later to the active window. For more information, see Named
Views (on page 201).
Zoom Tool - Increases or decreases the display size of objects in the model.
You can zoom in to get a closer view of an object or zoom out to see more of
the model at a reduced size. You can use the mouse scroll wheel to zoom in
and out and to pan at any time without having to select this command. For
more information, see Zoom Tool (on page 235).
Navigate View - Starts 3D navigation in the active window allowing you to fly
around the model in a fluid, multi-directional motion. For more information, see
Navigate View (on page 217).
Zoom Area - Magnifies an area of the model. Click and drag to create a fence
around an object or area of the model that you want to enlarge. For more
information, see Zoom Area (on page 238).
Fit - Fits all visible or selected objects in the active view. If you select one or
more objects before clicking Fit , the software fits only the selected objects
in the view. However, if you do not select any objects, then all visible objects in
the clipping volume display in the view. For more information, see Fit (on page
239).
Pan - Moves the view up, down, left, or right to let you see other areas of the
model. The pointer displays as a hand when this command is active. For more
information, see Pan (on page 240).
Center View by Object - Centers a view based on a given point or object. For
more information, see Center View by Object (on page 241).
Design Objects
When you design in Smart 3D, you create various design objects with discipline-specific
properties, behavior rules, and geometry. Specifications and catalog reference information
assist you as you create these objects.
There are many types of objects ( such as equipment, piping, HVAC, and structure). The
software lists these types on the Object tab of the Filter Definition Property dialog box.
Different object types are depicted by distinct icons in the Workspace Explorer. For more
information, see Icons in the Workspace Explorer (on page 246). You can select design objects
based on their type by using Select (on page 347) in combination with a Locate Filter (on
page 148).
Each task has specific commands for creating and editing the design objects needed by that
engineering discipline. For more information, see Tasks Menu (on page 612). These commands
provide a logical interface that steps you through the design process based on the object you
have selected. You use these commands to create and modify objects using the same intuitive
steps and workflows.
The software stores design and reference data objects in standard relational databases
(Microsoft SQL Server or Oracle). Designers and engineers can access any portion of the model
required for their specific design activities, regardless of the discipline. When you create or edit
an object, the software immediately commits that object or change to the database so that it is
available to others. Access control is managed at the individual object level. Managers have the
flexibility to increase the number of users working on an area of the design while still giving
individual users control over their own objects. You are not limited by the access control
constraints of the design files in file-based design systems.
Administrators create and maintain the databases used by Smart 3D as well as the access
control to the data using Project Management.
Access Control
Smart 3D manages access to design objects rather than to the application commands that
create the objects. For each model database, the site administrator creates a set of permission
groups in that model database. The permission groups typically represent the management
structure of an organization, such as design disciplines, working groups, or even an individual.
However, the software does not constrain you to this pattern. Your company might have other
ideas on using this access control grouping.
When you create a design object, the software assigns it to a permission group. The
administrator assigns a list of Windows users or user groups and the levels of access (Read,
Write, Modify, or Full) each user has to the objects within that permission group.
The Active Permission Group list on the Common toolbar identifies the
permission group that the software assigns a new object when you create it. This control does
not change the permission group of existing objects when you edit them. For more information,
see Permissions Overview (on page 22).
You can change the Permission Group property of existing objects on the Configuration tab
of the Properties dialog box. For more information, see Properties (on page 176).
The Status property of the design object overrides the Write access. This property can have the
values Working, In Review, Rejected, and Approved. You can only edit a design object if the
status is Working. This allows you to incrementally lock down the design. The status can also
be used as an indicator of when review is wanted or changes are needed.
To change the permission group for an object, you must have Write access to the current
permission group as well as to the permission group assigned to the object.
Only a user with Full (or approval) permission can set an object to Approved or change from
Approved to another status. A user with Write access to an object can change the status from
the other states to any state except Approved. In many organizations, only an administrator has
Full access.
You must also have Write access to the immediate system parent of a design object to create
an object in the system. This is analogous to the access control for creating files in Windows
folders. A separate set of permission groups is created in the catalog database for managing
access to the catalog data.
Permissions Overview
A site administrator can configure permission groups and levels of access in Project
Management (Start > Intergraph Smart 3D > Project Management). Your assigned
permission group, and your level of access (Read, Write, or Full Control) in that permission
group, defines the actions that are available to you when working with the software. The
following list shows some of the actions that permission groups affect:
Creating objects
Modifying objects
Deleting objects
Accessing menu commands
Changing properties of objects
Pasting and restoring objects from a backup
Claiming objects
Creating relationships between objects
Consider the following example of interaction between permission groups and your work to
modify the model.
The My Filters folder is assigned to Permission Group One with Full Control access;
however, unannounced to you, access to Permission Group One is changed to Read
Only.
Create a filter called Surface Style Rule Two in the My Filters folder.
Click Format > Surface Style Rules to assign this surface style rule.
Select Surface Style Rule Two, and click Copy.
Click Paste to add the rule; however, the software displays the following message: You do
not have permissions to access this object.
You cannot successfully complete the filter command because Permission Group One, which
contains Surface Style Rule Two, now has Read Only access and does not allow you to add
the rule.
Another example involves access to systems in the software. When you create a piping run, you
must have Write access to the pipeline system parent.
Approval Status of Objects
In addition to permission groups, the approval status of an object controls change during the
phases of a project. The approval status for an object can range from Working, In Review,
Rejected, or Approved. For example, in the Drawings and Reports task, or through the Tools >
Drawing Console command, you can specify the propagation of properties down the hierarchy,
from parents to children. However, if any of the objects in the hierarchy are set to Approved
status, the properties are not propagated. Likewise, objects set to Approved status cannot be
deleted or updated. For example, if an isometric drawing is approved, you cannot re-extract the
drawing from the model.
You can change the permission group for an object only if you have Write access to that
permission group and to the permission group in which you plan to place the object. The
permission group is set on the Configuration tab of the Properties dialog box for an object.
The Active Permission Group box on the main toolbar allows you to change the
permission group when you are placing or editing objects in the model. The list contains all
of the permission groups to which you belong.
Example Configuration A
In this example, two users, John and Peter, are working on the same run with exclusive access.
John is responsible for part of the run, and Peter is responsible for the other part of the run.
Neither John nor Peter should be able to modify the work of the other person.
The administrator should configure the permission groups as follows:
Create three different permission groups: PG-Run, PG-John, and PG-Peter.
Both John and Peter should have full control access to PG-Run.
John should have full control access to PG-John while Peter should have read-only access
to PG-John.
Peter should have full control access to PG-Peter while John should have read-only access
to PG-Peter.
The run should be created using the PG-Run permission group. When John works on his parts
of the run, he should use PG-John as the active permission group. When Peter works on his
parts of the run, he should use PG-Peter as the active permission group. The two halves of the
run should connect at a component such as a valve (piping) or a union (electrical).
For example, John routes his part of the run, places a flange, and then places a gate valve.
Peter then places a flange manually connecting to the open port of the gate valve, and then
continues his part of the run.
Example Configuration B
In this example, two users, John and Peter, are working on different but in-line connected runs
with exclusive access. For example, John places an elbow, a straight piece, and a union, then
stops. Peter connects to the open port of the union, and then continues routing. The
administrator should configure the permission groups as follows:
Create two different permission groups: PG-John and PG-Peter.
John should have full control access to PG-John while Peter should have read-only access
to PG-John.
Peter should have full control access to PG-Peter while John should have read-only access
to PG-Peter.
John should create the run using the PG-John permission group and route his part of the run.
When Peter works on his part of the run, he should use PG-Peter as the active permission
group. The Intermediate End Features will handle the connection between the two parts of the
run.
Example Configuration C
In this example, two users, John and Peter, are working on different runs connected by
branching components such as a tee. The administrator should configure the permission groups
as follows:
Create two permission groups: PG-John and PG-Peter.
John should have full control access to PG-John; Peter should have read-only access to
PG-John.
Peter should have full control access to PG-Peter; John should have read-only access to
PG-Peter.
John creates an initial header run using PG-John as the active permission group and routes it
as needed. Peter now wants to branch from John's run. Peter sets PG-Peter as the active
permission group and selects the header in John's run from which to branch. Instead of creating
the header component (such as a tee), the software generates a To Do List item for John.
When John updates the out-of-date To Do List item, the software modifies the header to add
the tee, and then generates a To Do List item for Peter.
When Peter updates his out-of-date To Do List item, the software fixes the branch leg (the end
of the branch leg is adjusted to the tee port). This is called a double hand-shaking mechanism.
Example Configuration D
In this example, an administrator has created two separate Windows® Active Directory groups,
each with different permissions, under the model.
The first Windows® Active Directory group, Group A, has been assigned write privileges to
the permission group, PG-1. A user, John, is a member of this group.
The second Windows® Active Directory group, Group B, has been assigned read-only
access privileges to PG-1. John is also a member of this group.
Because John is a member of Group A, which has write privileges, John therefore has write
privileges to PG-1.
Global Workshare
A Global Workshare Configuration (GWC) allows you to work on a model from several remote
locations. Designed for companies running facilities from multiple sites (EPCs or
Owner/Operators, for example) or for multiple companies that are working on a model, the
Global Workshare function involves a single, central database, called the Host, in which all the
changes come together as if they were created at a single geographic location. Changes to the
databases are automatically distributed to the locations using the underlying database
replication technology (SQL Server or Oracle).
The host location maintains the master site and catalog databases. Administrators at the remote
locations can edit the site and the catalog database directly on the host through authorized
remote logons because the editing operations do not include interactive graphics that consume
high bandwidth. Changes made to the site and catalog databases on the host are automatically
replicated to duplicate databases at remote satellite locations.
You can reference the objects created and owned by other locations as inputs for your designs.
You can change the ownership of the objects through the Configuration tab on the Properties
dialog box. For more information, see Configuration Tab (on page 144).
You can only modify those model objects that are assigned to the permission groups owned by
your workshare location. When you transfer objects from a permission group owned by one
location to a permission group owned by another location, you must also transfer any related
objects that cannot be edited without also editing their required parent. In most cases, Smart 3D
automatically changes such objects into the same permission group. Change the permission
group of one and the software automatically changes the other. Piping features and piping parts
are examples. However, you must manually assure that some objects are kept in the same
permission group when in the workshare configuration.
For more information, see the Global Workshare User's Guide.
Design Session
You begin a design session for the first time by starting Smart 3D and then selecting a session
template. The session template contains settings and defaults for the commands of all
application areas. Use Define Workspace (on page 62) to select the model to access, and
then define or select a filter that identifies the specific data to see. Your administrator will have
some standard filters already defined for use. You can also create personal filters that are stored
for you in the database.
The software retrieves the data that you want to see from the model database to your computer
memory, and displays that data in the graphic windows. Each time you create or edit a design
object, the change is immediately committed to the Model database on the database server. No
design data is temporarily saved on your computer. You can see the data that was created by
others after you run Define Workspace by using Refresh Workspace (on page 69) .
Refresh Workspace reruns the filter and retrieves only the new or changed data that
meets the filter criteria.
Session File
When you exit Smart 3D, the software saves the graphics that you see and all the defaults that
you established while modeling in a session file on your computer. You can quickly start another
design session later by opening the saved session file. This restores you to exactly the same
views of the model as when you exited Smart 3D.
Opening a saved session file and running Refresh Workspace is much faster than running
Define Workspace with a new filter in a new session file. It also reduces the load on the
database server. So, as a rule, begin working in Smart 3D by opening an existing session file.
Use Define Workspace only after you have created a new filter. If you experience many
unexpected modeling problems, try starting a design session using a new session file created
using a template.
Save session files that use the different filters needed for your daily work to a folder for easy
access. You can identify this folder as the default location for Open (on page 54) by using
Options (on page 494).
For example, a piping designer and an equipment designer could be working concurrently in the
model. The equipment designer might move a piece of equipment, and then the piping designer
attempts to modify the pipe without refreshing the data in his workspace. The edit of the piping is
controlled by the current equipment model on the database server. The position of the straight
feature is defined by its connection to the equipment nozzle. When the piping user selects the
pipe to edit, the position of the feature is updated based on the current equipment nozzle
position in the database. The graphic display of equipment, however, continues to be that from
the last time the software synchronized the session file with the Model database. This can be
confusing, so good practice is to click Refresh Workspace before editing when you are
working in a concurrent design area. For more information, see Refresh Workspace (on page
69).
Modifying Objects
When you select an object in the model, a ribbon displays with tools for editing those design
objects. Usually, the ribbon for a single object is the same or very similar to the create command
for that object. You can edit any design properties of the object by clicking the appropriate
options to select new inputs.
You must click Finish when you change an option or property associated with an object. Smart
3D commits changes to the object properties immediately to the model database. Placement
options are typically on the left side of the ribbon. Object properties are typically on the right side
of the ribbon.
In some cases, a create command places multiple design objects. In these cases, the modify
ribbon for each object is different from the ribbon used to create those objects. The ribbon
provides tools that focus on the modification of the specific object you have selected. For
example, Smart 3D creates turns automatically as you use Route Pipe . There is no place
turn command. You can, however, select and edit the turns.
Design Aids
PinPoint (on page 389) / is active when any command prompts you to enter a point.
The PinPoint options allow you to enter precision coordinates relative to the selected coordinate
system and precision coordinate offsets relative to any point in the model.
The SmartSketch 3D tool is active whenever a command prompts you to enter a point. When
you position your cursor over geometry, it locates the precision points on the geometry
intersection points.
When your cursor is close to a SmartSketch 3D point, the geometric objects providing the
precision are highlighted and a small glyph near the cursor displays the specific type of precision
point found. For more information, see SmartSketch Options (on page 401). When you click to
enter the point, the coordinates of that precision point, the type of precision point, and the
objects providing the point are supplied to the command prompting for the point. Many
commands create relationships that maintain the point at the precision point location when the
related objects are modified.
To Do List
When multiple designers work in a single model, there will inevitably be inconsistencies that
must be resolved. Smart 3D keeps track of these issues with the To Do List (on page 264). This
tool shows you issues or inconsistencies identified by the relationships that you must resolve in
your model. Individual designers are expected to review and resolve To Do List issues for their
design objects as part of the normal modeling activity.
Interference Detection
When set up by an administrator, Smart 3D interference detection runs in the background, much
like the spell checking found in many word processing applications. Because of this, the
software identifies interferences so that you can resolve them quickly as they are created.
For example, you can activate a local interference detection process to immediately identify
interferences with objects in your workspace as you create or modify objects. These local
interference indicators are temporary design aids that the software removes when you refresh
your workspace.
A server-based interference process evaluates all objects in the model as they are created or
edited and creates permanent interference records. The server-based interference checking
(Database Detect) process runs directly on the Model database. This concurrent process can
be run on any computer on which the Database Interference Detection service is installed.
After the database administrator starts the service, Smart 3D automatically checks all existing
objects that have not been checked and all new or modified objects for interference. You never
have to be concerned about when to run Interference Check; it runs all the time. The process
can be stopped and restarted later. The system knows which objects need to be checked. When
you clear an interference by editing an object, the related interference record is automatically
deleted from the database.
You can see and select the interferences in the graphic view or in a list view to approve or add
notes. A paper-based interference review process is not needed. Individual designers are
expected to review and resolve interference issues for their design objects as part of the normal
modeling activity.
For more information, see Checking Interferences (on page 426).
Best Practices
You might encounter situations where you do not know the best technique for using views,
styles, and aspects. The following best practices guide you through these processes. Because
your modeling environment is unique, specific instructions are not possible. However, enough
detail is provided so that you can work through the solutions.
In This Section
Using multiple graphics windows .................................................. 36
Using clipping ............................................................................... 37
Saving views ................................................................................. 40
Using transparent styles ............................................................... 42
Using system folders to manage styles ........................................ 43
Using surface style rules ............................................................... 44
Using enhanced edges render modes .......................................... 46
Changing default colors ................................................................ 47
Using the Reference Geometry aspect ......................................... 47
Using clipping
You can use clipping planes to focus your view on specific objects in the model. The following
procedure displays figures from an example model.
Rotating the display of a clipped view rotates about the center of that clipping volume.
Because of this, objects are less likely to rotate out of the display area. Unclipped volumes
rotate the entire model, which can cause unexpected results.
For more information, see Active View Control (on page 196).
Saving views
Saving a view allows you to quickly restore your display with your specified zoom and clipping
settings. Named views are saved in the session file. For more information, see Named Views
(on page 201).
For more information, see Surface Style Rules (on page 338).
1. Click Format > Surface Style Rules.
The Surface Style Rules dialog box displays.
2. Select the style rule to use. You can modify an existing rule, or create a new one.
The Surface Style Rule Properties dialog box displays.
3. Name the style rule, if necessary.
4. Select a filter that meets your needs.
5. Select a translucent style from the Style applied list.
6. Click Properties next to the Style applied list.
The Modify Style dialog box displays.
7. Change the Opacity box to 0.25.
8. Click OK on the Modify Style dialog box.
Changing the style changes the display for everyone using the model.
9. In the Select all aspects to which the style will be applied list, select the boxes for the
aspects to display in the transparent style.
The mores aspects you select, the larger the session file becomes.
Shaded with Enhanced Edges uses software to create the enhancement. Models may
take longer to refresh with this option.
Shaded with Hardware Enhanced Edges refreshes more quickly. This option is only
available if your graphics card supports it.
File Menu
The File menu provides commands for managing session files, updating and defining the
workspace, printing, importing, and exporting. Some of the commands on this menu may
change depending on the active task. The Most Recent File list at the bottom of the menu
provides quick access to the session files you use most.
In This Section
Managing Sessions ...................................................................... 48
Defining Workspace Content ........................................................ 58
Importing and Exporting Data ....................................................... 69
Print .............................................................................................. 124
Most Recently Used List ............................................................... 125
Exit ................................................................................................ 126
Managing Sessions
Each time you use the software, you use a session that allows you to save certain properties,
such as window size, layout, and view orientation from one work session to the next. One of the
settings saved in the session is the workspace. During a session, you define a workspace to
view and work with certain objects in the model data. Defining a workspace also allows you to
create and name filters that restrict the data of the entire model into more manageable subsets
for working.
Therefore, we recommend that you save your session and use this saved session to open your
model in Smart 3D. This practice saves you the effort of defining your workspace from scratch.
You need only use the Refresh Workspace command to update all the views in the
workspace with the most current information from the database.
The name of the current session file appears in the title bar of the application, along with the
name of the task, model name, and active filter. You can also see this information on the
Windows task bar. This information is helpful when multiple instances of the software are
running, such as during a Paste and Restore operation.
The workspace you define appears in the Workspace Explorer, which allows you to move
throughout the hierarchy of your workspace. You can view the workspace using the System,
Assembly, Space, WBS (Work Breakdown Structure), Analysis, PDS, Reference, and
Reference 3D views. Each view corresponds to a tab at the bottom of the Workspace
Explorer. You can use the Tools > Options command to specify the tabs to show in the
Workspace Explorer. For more information, see Change the Displayed Workspace Explorer
Tabs (on page 497).
Whenever you create a new session, you are working with templates. In this context, a template
is a standard Workspace file that you have placed in the Templates folder; you use a template
as a pattern to assemble the parameters you want for a new work session.
The New command creates a new session using any of the available templates. Three standard
templates are delivered with the application: Empty, English Units, and Metric Units. These
templates are in the [Product Folder]\CommonApp\SessionTemplates folder.
You have the option to modify any template to satisfy specific requirements for a site. You can
create a new template by copying one of the delivered templates and renaming it. Then, open
the copied template in the software to specify the views, styles, and other properties.
When the New dialog box appears, the Empty template is selected by default. By storing the
default templates for these session files in sub-directories, the software can supply named tabs
on the New dialog box. This dialog box can expand to accommodate multiple tiers of tabs as
necessary for particular product configurations.
Optionally, you can determine an alternative default selection or configuration. Using multiple
tabs, each tab on the New dialog box has a unique Empty template and other tab-specific
templates for the environment. Template files do not have a special extension. They are regular
workspace documents you have placed in the proper folder on your system.
The Open dialog box allows you to access any saved session to continue working, to make
changes, or to review completed work. Indicate the location in which you want to find an existing
session using the Look in list. If necessary, filter the displayed files using the Files of type list.
Then, select the file you want to open in the file list and click Open.
You can receive context-sensitive information about commands and dialog boxes by
pressing F1.
See Also
Create a new session (on page 52)
Create a session template (on page 53)
Define a workspace using a new filter (on page 63)
Define a Workspace Using an Available Filter (on page 63)
Open (on page 54)
Open a Session
You can open a session you previously saved. For more information, see Open a session.
Save a Session
You can save a session so you can return to it later. This is helpful when you have setup
complicated views and filters in the session file.
Global Workshare
When working in a global workshare environment, refresh the workspace after opening a
session file.
New
Creates a new session based on a template.
You can choose from any of the standard templates or any custom templates created for
your site. Standard templates include the default Empty template, the English Units
template, and the Metric Units template.
The delivered Nominal Piping Diameter (NPD) default unit in both English and Metric
templates is Native (fractional). The NPD unit default is mm (millimeters) with precision set
to zero.
The Workspace Templates path is specified on the File Locations tab of the Tools >
Options dialog box. If the path includes subfolders within a hierarchy, the name of each
subfolder appears as a separate tab on the New dialog box. For example, you can have
tabs named by project or by task.
The delivered NPD default unit in both English and Metric templates is Native
(fractional). Also, the NPD unit default is mm (millimeters) with precision set to zero.
3. Click OK.
4. If you select the Empty template, click Tasks > Configure Task List to configure the task
list to meet your needs. If you selected another template, you do not need to perform this
step.
Configure Tasks (on page 617)
5. Click File > Define Workspace.
The shortcut key for the Define Workspace command is CTRL+W.
6. In the Model list, select the name of the model database.
7. In the Filter list, select an existing filter or create a new one.
8. Click OK.
9. Click File > Save to save the new session.
10. Type a name for the session file.
11. Define a location where you want to save the file.
12. Click Save.
The software names your new session Untitled by default until you save the new
session and assign it a new name.
The Workspace Templates path is specified on the File Locations tab of the Tools >
Options dialog box. The default location is [Product
Folder]\CommonApp\SessionTemplates.
You can store the session templates in subfolders within the template folder. The
software can supply named tabs on the New dialog box. If the path includes subfolders
within a hierarchy, the name of each subfolder appears as a separate tab on the New
dialog box. For example, you can have tabs named by project or by task. In this way,
the New dialog box can expand to accommodate multiple tiers of tabs as necessary for
particular product configurations.
7. In the File name box, specify the name of the session template.
8. Click Save.
Open
Opens an existing session. If you have a session open when you click this command, you
receive a message asking if you would like to save the changes to the active session.
The software examines the file permissions assigned to a session before it opens a session. If
you do not have the necessary permissions to open a session, or if another user has the
session opened exclusively, a warning message indicates why you cannot open the session.
1. Click File > Open.
2. Click Yes to save the current session, or click No to close the current session without
saving.
3. In the Look in box, browse to locate a session.
4. Select a session to open.
5. Click Open.
You can also open a session file by double-clicking it, or right-click the session file and
select Open.
If the session connection fails, use the Modify Database and Schema Location utility to
set the Site database and schema. Click Start > All Programs > Intergraph Smart 3D >
Database Tools > Modify Database and Schema Location.
Open a session
1. Click File > Open.
2. Click Yes to save the current session, or click No to close the current session without
saving.
3. In the Look in box, browse to locate a session.
4. Select a session to open.
5. Click Open.
You can also open a session file by double-clicking it, or right-click the session file and
select Open.
If the session connection fails, use the Modify Database and Schema Location utility to
set the Site database and schema. Click Start > All Programs > Intergraph Smart 3D >
Database Tools > Modify Database and Schema Location.
Close
Closes the active session. If you have changed data since you last saved, or if you have not
saved a new session, the software prompts you to save the file.
Close a session
Click File > Close.
If a session is open when you click this command, you receive a message that asks if
you want to save changes to the active session.
Save
Saves the active workspace as a session (.ses) file with its currently defined name and
location. If you are saving the session for the first time, the Save As dialog box appears, so you
can specify the location, which could be a local or network drive or a UNC path, as well as the
name of the session. The software adds an .ses extension to the file name to indicate that it is a
session file.
The shortcut key for the Save command is CTRL+S.
Save a session
While working in a session, click File > Save, or press CTRL+S.
See Also
Managing Sessions (on page 48)
Save As
Saves the active workspace session file with a different name or in a different location. A dialog
box prompts you to specify the location, which could be a local or network drive or a UNC path,
as well as the name of the session. The software saves all session files with an .ses extension
to the file name. Saving your session file to the desktop creates a session icon that provides you
with the fastest method for returning to your session.
File names cannot contain the following characters: \, /, :, *, ?, ", <, >, |
If the session connection fails, use the Modify Database and Schema Location utility to
set the Site database and schema. Click Start > All Programs > Intergraph Smart 3D >
Database Tools > Modify Database and Schema Location.
You can use the Save As command to save a copy of your session file to your desktop or to
another drive (local or network). You can also save a session to a UNC location. Saving
your session file to the desktop creates a session icon that provides you with the fastest
method for returning to your session.
The software adds the .ses extension to the file name to indicate it is a session file.
File names cannot contain the following characters: \, /, :, *, ?, ", <, >, |
If the session connection fails, use the Modify Database and Schema Location utility to
set the Site database and schema. Click Start > All Programs > Intergraph Smart 3D >
Database Tools > Modify Database and Schema Location.
Send
Sends a session file to one or more recipients through your e-mail application. When you select
the Send command, the software generates a new mail message and embeds your session
document in the message as an attachment. You can then choose your recipients, add a
descriptive phrase in the Subject box, and add text in the message area to accompany the
attached session document as needed.
For the Send command to work, you must first have a default e-mail client defined on your
computer.
The session document must have been saved at least once before it can be sent.
Selecting a role does not modify the workspace file definition. Commands that make use of
the active workspace filter, such as Snapshot View (on page 444), continue to use the filter
definition in the database.
Roles and their included object classes and subclasses are defined in the
OptimizationForRole.xml file in the [Reference Data Folder]\SharedContent\XML folder. If
the file is missing, the Define Workspace dialog box does not display the Role box. Your
administrator can customize OptimizationForRole.xml. For more information, see Define
roles (on page 64). For more information, see Define roles (on page 64).
The software retrieves all the objects to your active session that match the criteria defined in the
filter and role for the selected model. Then, when you save your session, the software stores
your workspace definition so you will see the same data the next time you open the session.
Before loading the query results to your workspace, the software determines whether your
computer has enough virtual memory to contain the results. If you do not have adequate
memory available, the software displays a warning that your workspace size is likely to exceed
the available memory of your computer. You can continue by clicking Yes. If you click No, the
query load stops, and the Define Workspace dialog box returns so that you can redefine your
search criteria.
Due to the 32-bit precision limitations of graphic cards, you may need to
create several design coordinate systems so that the objects being modeled are within 10,000
meters (6.2 miles) of the global coordinate system. Objects modeled outside this limit will not
display correctly. If your model coordinate values are larger than this limit (for example, E =
20,000, N = 30,000), to get the coordinate readout that you want, you should define a coordinate
system at correspondingly large negative values (example, E = -20,000, N = -30,000). Then, use
the coordinate system that you created as your active coordinate system for modeling and
output. Do not bring this new coordinate system into your workspace, or you will have the
display problems that you are trying to avoid. In addition to the 10,000 meter global coordinate
system limit described above, the marine mode is limited to a 5,000 meter cube.
See Also
Define a workspace using a new filter (on page 63)
Define a Workspace Using an Available Filter (on page 63)
Define roles (on page 64)
Define Workspace (on page 62)
Define Workspace Dialog Box (on page 68)
Define Roles
You--or an administrator, if you do not have permissions--can define, in the
OptimizationForRole.xml file in the [Reference Data Folder]\SharedContent\XML folder, a list of
roles for selection in the Role box in the Define Workspace dialog box. For more information,
see Define roles (on page 64).
Refresh a Workspace
After defining the workspace, you can use File > Refresh Workspace to keep the workspace
objects up-to- date. For more information, see Refresh Workspace (on page 69).
Define Workspace
Selects a model in which to work, a filter designed for that model, and a role. The filter and role
retrieve from the database the objects that you want to appear in your workspace. For more
information, see Select by Filter (on page 354).This command is on the File menu. The shortcut
key for Define Workspace is CTRL+W.
The first thing you must do after starting Smart 3D is to define the contents of your workspace.
The workspace contains only those objects that you want to work with from the database.
Keeping an uncluttered workspace allows you to work faster.
You can also select a role to further refine the workspace filter. Each role is defined with a set of
disciplines and subclass object types. The role filter is applied to the workspace filter so that only
the object types that are included in the selected role are brought into the workspace.
Selecting a role does not modify the workspace file definition. Commands that make use of
the active workspace filter, such as Snapshot View (on page 444), continue to use the filter
definition in the database.
Roles and their included object classes and subclasses are defined in the
OptimizationForRole.xml file in the [Reference Data Folder]\SharedContent\XML folder. If
the file is missing, the Define Workspace dialog box does not display the Role box. Your
administrator can customize OptimizationForRole.xml. For more information, see Define
roles (on page 64). For more information, see Define roles (on page 64).
The software retrieves all the objects to your active session that match the criteria defined in the
filter and role for the selected model. Then, when you save your session, the software stores
your workspace definition so you will see the same data the next time you open the session.
Before loading the query results to your workspace, the software determines whether your
computer has enough virtual memory to contain the results. If you do not have adequate
memory available, the software displays a warning that your workspace size is likely to exceed
the available memory of your computer. You can continue by clicking Yes. If you click No, the
query load stops, and the Define Workspace dialog box returns so that you can redefine your
search criteria.
Due to the 32-bit precision limitations of graphic cards, you may need to
create several design coordinate systems so that the objects being modeled are within 10,000
meters (6.2 miles) of the global coordinate system. Objects modeled outside this limit will not
display correctly. If your model coordinate values are larger than this limit (for example, E =
20,000, N = 30,000), to get the coordinate readout that you want, you should define a coordinate
system at correspondingly large negative values (example, E = -20,000, N = -30,000). Then, use
the coordinate system that you created as your active coordinate system for modeling and
output. Do not bring this new coordinate system into your workspace, or you will have the
display problems that you are trying to avoid. In addition to the 10,000 meter global coordinate
system limit described above, the marine mode is limited to a 5,000 meter cube.
If the Database Detect option is running for the selected model, the filter automatically
includes all the associated interferences for the objects in the Workspace Explorer
(although interferences are not included for the filter). For more information, see Checking
Interferences (on page 426).
Before loading the query results to your workspace, the software determines whether your
computer has enough virtual memory to contain the results. If you do not have adequate
memory available, the software displays a warning that your workspace size is likely to
exceed the available memory of your computer. It then asks if you want to continue. If you
want to continue anyway, click Yes. If you click No, the query load stops, and the Define
Workspace dialog box returns so that you can refine your search criteria.
The Filter box displays up to the last ten filters selected for the selected model. If the filter
you want is not on this list, you can select the More option to display all the available filters.
If you are the first person to define a workspace for this task, then no previous filters are
listed in the Filter box. In this case, click the More option and select a filter in the tree view,
or click the Create New Filter option to create a new one. For more information, see Create
a New Filter (on page 360).
When you save a session, the software saves the workspace definition.
Define roles
The list of roles for selection in the Role box in the Define Workspace dialog box is defined in
the OptimizationForRole.xml file in the [Reference Data Folder]\SharedContent\XML folder.
Each role is defined with a set of disciplines and subclass object types. The role XML format
mimics the object classification hierarchy used in Smart 3D. You can see a tree view of the
object hierarchy in the Object Type tab of the Filter Properties dialog box.
Roles applied to filters that pull in referenced files or referenced 3D files must include the
classification nodes for these specific classes to populate the Workspace Explorer tree
view. If these classes are missing from the role definition, references are pulled in but the
Workspace Explorer cannot be populated.
<Discipline ClassName="Reference 3d File" />
<Discipline ClassName="Referenced File" />
The discipline names and discipline sub-node names must match those defined in the Smart
3D object classification hierarchy. If in a role definition any of these node names do not
match an existing classification, an error message similar to the following example is shown
when the role filter is loaded. Click OK to continue, but the error node is excluded from the
workspace.
Equipment Designer Equipment and Furnishing All Equipment and Furnishing objects
The shortcut keys for the Define Workspace command are CTRL+W.
You can also access the Select Filter dialog box by clicking Tools > Select by Filter.
Before loading the query results to your workspace, the software determines whether your
computer has enough virtual memory to contain the results. If you do not have adequate
memory available, the software displays a warning that your workspace size is likely to
exceed the available memory of your computer. You can continue by clicking Yes. If you
click No, the query load stops, and the Define Workspace dialog box returns so that you
can redefine your search criteria.
See Also
Create a new filter (on page 360)
Define a workspace using a new filter (on page 63)
Define a Workspace Using an Available Filter (on page 63)
Define roles (on page 64)
Define Workspace (on page 62)
Edit Filter Properties (on page 367)
Refresh Workspace
Updates all the views in the workspace with the most current information from the database.
Use this command to see changes that other users in your permission group have made to
objects visible in your workspace, such as repositioning of equipment or adding new objects.
You can press F5 to refresh your workspace.
During the update, a small progress dialog box displays that allows you to cancel the update at
any time before it is finished. If another command was active before you selected Refresh
Workspace, the software stops the active command.
You are prompted to refresh your workspace if you select an object that is visible in
your workspace but another user has deleted from the model.
Creates XML data that is compatible with This XML corresponds with XMpLant
the Intergraph (Ingr) schema. schema.
Mapping files for Intergraph schema Mapping files for XMpLant schema
XMLs are written in Excel workbooks. XMLs are written in XML format.
The PDS Model Data Exporter utility is XMpLant Samples and XMPlant
delivered separately from Smart 3D.a mapping files are delivered with Smart
3D for Piping, HVAC, Electrical, and
b
Equipment.
a
In the delivered-sample mapping workbook, for example, ElectricalTranslationMap.xls,
several sheets describe the mapping used for raceway, while the ConduitSpec sheet maps
the XML conduit run specifications. The CabletraySpec sheet specifies the mapping of all
the XML cableway specifications.
b
Use the corresponding Import dialog boxes to browse for the XMPlant XMLs and their
mapping files. The XMpLant mapping files to be used to import XMPlant XMLs for each
discipline are listed below:
Electrical - [Product Reference Data
Folder]\Translators\XMPlantS3DImport\ConfigurationFiles\Electrical\S3DXMpLantElectrical
Main.xml
Equipment - [Product Reference Data
Folder]\Translators\XMPlantS3DImport\ConfigurationFiles\Equipment\S3DXMpLantEquipMa
in.xml
HVAC - [Product Reference Data
Folder]\Translators\XMPlantS3DImport\ConfigurationFiles\HVAC\S3DXMpLantHVACMain.x
ml
Piping - [Product Reference Data
Folder]\Translators\XMPlantS3DImport\ConfigurationFiles\Piping\Map_XMpLant_S3D_Attrib
utes.xml
You can temporarily import geometry data in ACIS or IGES format from other software
packages, such as Tribon, NAPA, or Rhino. You can compare the temporary geometry to the
geometry of objects in the Model.
During the import process, the software applies LGF attributes to patches, if they are present.
This information is used later during a copy and mirror operation, if the hull is symmetrical.
You can also export geometry data in ACIS or IGES format. The export operation operates
against selected sheetbody and wirebody objects.
If you are exporting in IGES format, you can set the output data units using the Tools > Options
command.
You must have a license for IGES in order to use the Import > IGES or Export > IGES
command.
The data in the Geometry Analysis and Repair task is not saved in a session file or in the
database. If you delete geometry, or define or refresh the workspace, the imported geometry
is lost. You must export the data to an external file to save it. The imported geometry cannot
be used to create objects in the database.
The Import and Export ACIS/IGES commands are available in the Molded Forms and Geometry
Analysis and Repair tasks. The Structural Detailing task allows you to export ACIS and IGES
data.
Topics
PDS Model Data Exporter............................................................. 71
Import Electrical ............................................................................ 75
Import Equipment ......................................................................... 77
Import Grids .................................................................................. 81
Import HVAC................................................................................. 83
Import Piping................................................................................. 85
Import Structure ............................................................................ 89
Export Grids .................................................................................. 102
Export Structure ............................................................................ 104
Export Smart 3D Models to PDMS ............................................... 108
PDMS Export Validation ............................................................... 112
PDS Export ................................................................................... 117
Electrical (Raceway) - When you import the data in Smart 3D, you use the Import
Electrical command to import the route data and the Import Equipment command to
import the electrical equipment data. For the Raceway (Electrical) discipline, the PDS Model
Data Exporter behaves much the same as with Equipment. However, two XML files are
created, one for the route and one for the equipment. When you import the data in Smart
3D, you use the Import Electrical command to import the route data and the Import
Equipment command to import the electrical equipment data.
HVAC - For the HVAC discipline, the PDS Model Data Exporter does not have access to the
HVAC_PROJ_NODE or HVAC_PROJ_PATH environment variables. Instead, the
executable sets the HVAC_PROJ_PATH to the path of the default HVAC model location as
obtained from pdtable_115. The executable requires that a projlist.txt file reside in the
parent folder. For example, an HVAC project named stdeng is integrated with a PDS project
as follows:
PDS Project Location : PDSServer E:\stdeng\project.
HVAC Models location : PDSServer E:\stdeng\models\hvac\stdeng.
This information is in pdtable_115.
In this configuration, the PDS Model Data Exporter sets the HVAC environment variables as
follows:
HVAC_PROJ_NODE : PDSServer
HVAC_PROJ_PATH : E:\stdeng\model\hvac
The HVAC project list file named projlist.txt should be available in this folder for the export
process to work.
Because you can have HVAC networks connected across models, you specify a single XML
file for a set of model files to be exported.
The PDS Model Data Exporter is not used to export Structure data from
FrameWorks Plus. You must use the CIS/2 interface to move data from FrameWorks Plus to
Smart 3D.
You can define export configuration files for each discipline. The configuration files include both
user-configurable attributes and user attributes. Sample export configuration files are delivered
with the PDExportToSP3D utility to be customized as needed.
Project
Specifies the PDS project to export. The drop-down provides a list of available PDS
projects.
Discipline
Specifies the discipline to export. You can select: Pipeline, Raceway (Electrical), Equipment,
and HVAC.
Area list
Displays a checkbox list of all the design areas in the selected discipline. You check the
boxes within the list to select the models in those Areas that will be exported.
Model Name list
Shows a list of the models in the selected Areas.
New Session
Resets the dialog box to start fresh from Project selection.
Open Session
Displays the Select Export Set File dialog from which to select a different PDS export set
file (.exp).
Next
Displays the next dialog box for exporting. This dialog shows a summary of the selected
PDS project and models. You specify the output XML file/folder as applicable, the export
configuration file, and the export set file entries.
Summary
Displays what you have selected to export.
Output XML file
Define the path and filename for the XML file to write. This is the XML file that Smart 3D
uses to import the data.
Export configuration file
Specify the path and file name of the export configuration file to use. There are configuration
files delivered in the \PDShell\PDExportToSP3D\config folder for the "out-of-the-box" PDS
attributes. If you have added custom attributes to PDS, you need to edit the configuration
files before you can use them. For more information about the export configuration files, see
the Plant Design System (PDS) User's Guide.
Export set file
Specify the path and file name for the export set file. This file is a settings file that you can
use with the Open Session command in case you need to rerun the export process. The
PDS Model Data Exporter also creates an export log file in the same folder as the Export
Set file.
Finish
Exports the data to the specified XML file using the configuration file specified.
Import Electrical
Imports Electrical data from an XML file, using mapping defined in an XLS (Microsoft Excel
workbook) file or an XMpLant XML mapping file. The input XML file is validated against the
defined electrical import schema to make sure the file is valid for import.
Actions Taken
When you import electrical data, the command does the following:
Creates cableways and conduit runs
Imports the route network
Imports branching configurations
Imports components
Imports attributes and user attributes
You should import Electrical Equipment using File > Import > Equipment.
You can use the PDS Model Data Exporter to create the input XML file for importing. For
more information, see PDS Model Data Exporter (on page 71).
If there is an item in the XML file that has the model system set to blank or Undefined, the
Import Electrical command creates a generic system under the root with the naming
convention xxxxxxImport-Date-Time.
For example, the name might be ElectricalImport-6-27-2005 09:09:57AM. All objects with
the blank or Undefined parent system import to this new system. After import, you can
move the objects to your own System hierarchies.
Topics
Import Electrical Data Dialog Box ................................................. 76
Import XMpLant Formatted Electrical Data ................................... 76
Import Electrical Data Using PDS Model Data Exporter ............... 77
5. Click OK or Apply to import the electrical data as specified. If problems occur, check the
import log file created in the same location as the input XML file.
6. Check the To Do List for items that require attention after importing.
If an item in the XML file has the parent system set to blank or Undefined, the Import
Electrical command creates a generic system under the root with the naming convention
xxxxxxImport-Date-Time. For example, the name might be ElectricalImport-6-27-2005
09:09:57AM. All objects with the blank or Undefined parent system import to this new system.
After import, you can move the objects to your own System hierarchies.
See Also
Importing and Exporting Data (on page 69)
Import Electrical (on page 75)
To Do List (on page 264)
The input XML file is validated against the defined electrical import schema to make sure the
file is valid for import.
If an item in the XML file has the model system set to blank or Undefined, the Import
Electrical command creates a generic system under the root with the naming convention
xxxxxxImport-Date-Time. For example, the name might be ElectricalImport-6-27-2005
09:09:57AM. All objects with the blank or Undefined parent system import to this new
system. After import, you can move the objects to your own System hierarchies.
See Also
Importing and Exporting Data (on page 69)
Import Electrical (on page 75)
To Do List (on page 264)
Import Equipment
Imports Equipment data from an XML file, using mapping defined in an XLS (Microsoft Excel
workbook) file or an XMpLant XML mapping file. The input XML file is validated against the
defined equipment import schema to make sure the file is valid for import.
Actions Taken
When you import equipment data, the command does the following:
Creates the design equipment
Adds shapes, nozzles, and parametrics to the design equipment
Imports equipment attributes, nozzles, shapes, parametric dimensional attribute, and
orientation
Imports user attributes for equipment and nozzles
You can use the PDS Model Data Exporter to create the input XML file for importing. For
more information, see PDS Model Data Exporter (on page 71).
If there is an item in the XML file that has the model system set to blank or Undefined, the
Import Equipment command creates a generic system under the root with the naming
convention xxxxxxImport-Date-Time. For example, the name might be
EquipmentImport-6-27-2005 09:09:57AM. All objects with the blank or Undefined parent
system import to this new system. After import, you can move the objects to your own
System hierarchies.
Topics
Import Equipment Data Dialog Box............................................... 79
Import XMpLant Formatted Equipment Data ................................ 80
Import Equipment Data Using PDS Model Data Exporter ............. 80
Cancel
Cancels the operation.
View Log File
Opens the log file for viewing.
View Ingr File
Opens the Intergraph file for viewing.
XML Editor installs along with MS Office. When the default software for opening the
XML file is XML Editor, the View Ingr File command does not open the XML file. The XML file
opens when the default software is a text editor such as Notepad.
See Also
Import Equipment (on page 77)
Import XMpLant Formatted Equipment Data (on page 80)
5. Click OK to import the equipment data as specified. If problems occur, check the import log
file created in the same location as the input XML file.
6. Check the To Do List for items that require attention after importing.
If there is an item in the XML file that has the model system set to blank or Undefined, the
Import Equipment command creates a generic system under the root with the naming
convention xxxxxxImport-Date-Time. For example, the name might be
EquipmentImport-6-27-2005 09:09:57AM. All objects with the blank or Undefined parent
system import to this new system. After import, you can move the objects to your own
System hierarchies.
The input XML file is validated against the defined equipment import schema to make
sure the file is valid for import.
See Also
Import Equipment (on page 77)
Import XMpLant Formatted Equipment Data (on page 80)
Import Grids
The File > Import > Grids command imports a coordinate system into the model. This
command recognizes XML and XLS files that have been exported from a different model. The
software prompts you to change duplicate coordinate system names before importing.
You can modify the distance and angles in the exported XML or XLS in any accepted Units of
Measure format and then import. It is easier to modify the inputs in XLS than in XML. Refer to
the AvailableUnitFormats sheet in the exported XLS file to understand the accepted Units of
Measure formats.
Grids exported to XLS from versions 2014 or older will import successfully into versions 2014 R1
and newer; however, no grid lines will display. You must modify the grid lines and define the
associated planes for the grid lines to display. We recommend you manually edit these older
version XLS files (those exported by version 2014 or earlier) to include the AssociatePlanes
column that is present in the newer XLS versions. Export grids to XLS from your current version
and use that file as an example for editing your old version XLS files.
Topics
Import coordinate system.............................................................. 81
General Tab (Import Grids Dialog Box) ........................................ 82
Settings Tab (Import Grids Dialog Box) ........................................ 82
Import HVAC
Imports HVAC data from an XML file, using mapping defined in an XLS (Microsoft Excel
workbook) file or an XMpLant XML mapping file. The input XML file is validated against the
defined HVAC import schema to make sure the file is valid for import.
Actions Taken
When you import HVAC data, the command does the following:
Creates duct runs
Imports the route network
Imports branching configurations
Imports components
Imports attributes and user attributes
You can use the PDS Model Data Exporter to create the input XML file for importing. For
more information, see PDS Model Data Exporter (on page 71).
If there is an item in the XML file that has the model system set to blank or Undefined, the
Import HVAC command creates a generic system under the root with the naming
convention xxxxxxImport-Date-Time. For example, the name might be
HVACImport-6-27-2005 09:09:57AM. All objects with the blank or Undefined parent system
import to this new system. After import, you can move the objects to your own System
hierarchies.
Topics
Import HVAC Data Dialog Box ...................................................... 84
Import XMpLant Formatted HVAC Data ....................................... 84
Import HVAC Data Using PDS Model Data Exporter .................... 85
5. Click OK or Apply to import the electrical data as specified. If problems occur, check the
import log file created in the same location as the input XML file.
6. Check the To Do List for items that require attention after importing.
If an item in the XML file has the parent system set to blank or Undefined, the Import
HVAC command creates a generic system under the root with the naming convention
xxxxxxImport-Date-Time. For example, the name might be HVACImport-6-27-2005 09:09:57AM.
All objects with the blank or Undefined parent system import to this new system. After import,
you can move the objects to your own System hierarchies.
See Also
Import HVAC (on page 83)
Import HVAC Data Using PDS Model Data Exporter (on page 85)
Import Piping
Imports Piping data from an XML file, using mapping defined in an XLS (Microsoft Excel
workbook) file or an XMpLant XML mapping file. The input XML file is validated against the
defined Piping import schema to make sure the file is valid for import.
Actions Taken
When you import piping data, the command:
Creates pipeline systems if they do not already exist. If the parent piping system is identified
in the input XML file, the pipelines are created under the Piping system(s). Otherwise, the
pipelines are created under the model root.
Creates piperuns, route network, branching.
Imports piping components along the network. However, items not listed in the mapping
XLS are not imported. Some PDS instruments and specialties might not have equivalents in
Smart 3D. Also, some Smart 3D implied parts are handled differently than in PDS.
Therefore, some mapping entries might be hard-coded to take care of them. Examples
include branching components like flanges around valves.
Creates Smart 3D supports using G-Type graphics for PDS Physical Pipe Supports. In order
to import G-Type graphics using Pipe Import, load the HS_System.xls file located in
[Product Folder]\CatalogData\Bulkload\DataFiles to the existing catalog database.
Imports tap information, specified as GenericNotes added on associated piperun ends
indicating tap details.
Places supports (logical only).
Joins pipeline ends to specified nozzles that have already been imported.
Attempts to correct eccentric reducer offset mismatches between input data and Smart 3D.
You need to re-establish piping connectivity as it is not maintained across XML files.
To maintain connectivity, export all models to a single XML file at once.
You can use the PDS Model Data Exporter to create the input XML file for importing. For
more information, see PDS Model Data Exporter (on page 71).
Topics
Import Piping Data Dialog Box ...................................................... 87
Import XMpLant Formatted Piping Data ........................................ 87
Import Piping Data Using PDS Model Data Exporter .................... 88
Import Structure
The File > Import > Structure > CIS/2 command imports a CIS/2 file into the model. This
command recognizes Global User Identities (GUIDs) to uniquely identify objects and manages
the electronic exchange with the other software package.
Members imported by this command are either standard or designed members depending on
the cross-section specified in the import file. Assembly connections are created if that
information is provided in the CIS/2 file and the appropriate import option is selected. Frame
connections are always created and connect the members in the import file if the connection
information is specified. Otherwise, the frame connections are set to "Unsupported".
If you have any questions about using this translator, please contact Intergraph Support. You
can find support information on our web site: http://support.intergraph.com.
Import of Attributes/Properties
User-defined attributes that were defined in the third-party software and exported from that
application to the CIS/2 file can be mapped and imported to Smart 3D properties using the
UserAttribute_Map.xml file. A sample UserAttribute_Map.xml file is delivered with Smart 3D in
the [Product Folder]\SmartPlantStructure\Symbols\StructureImportExportMaps folder.
If the third-party attribute that you want to map does not have an equivalent property in Smart
3D, you need to add that property to Smart 3D (using bulkload) before you can map to it in the
xml file.
If the third-party attribute does not have an entry in the mapping files but a property with the
same name exists in the Smart 3D, then that third-party attribute will still import and populate the
Smart 3D property even though it is not in the mapping file.
New - Loads any object in the CIS/2 file that is not in the model. Use the All On or All Off
commands to select or clear all check boxes.
Modified - Loads any object that exists in both the CIS/2 file and the model that has changed in
the CIS/2 file. Use the All On or All Off commands to select or clear all check boxes.
Members - Select to read into the model the members defined in the CIS/2 file. Openings on
members are not imported. Members defined with a built-up cross-section are imported as
designed members with these limitations:
The member must be linear.
The material and dimensions are defined by the build-up cross-section defined in the
catalog. Any material or dimension values specified in the import file are ignored.
The designed member parts must be imported along with the parent member system.
Stand-alone designed member parts (such as connection parts and clip angles) are not
imported.
Slabs/Plates - Select to read into the model the slabs and plates defined in the CIS/2 file. Slabs
are always read into the model using a sketch 3-D path. You can edit the slab path after the
import, if needed. No grid lines associated with the slab are imported, and there are no
constraints assigned to the slab.
Walls - Select to read into the model the walls defined in the CIS/2 file. All walls are imported as
slabs.
Openings - Select to read into the model the openings (holes) defined in the CIS/2 file for slabs,
walls, grating, and checker plates.
Connections - Select to read into the model the gusset plates, clip angles, and other plates and
standard sections used to connect members. The detailing software marks these objects as
connection parts in the CIS/2 schema during export.
Assemblies - Select to read into the model the assemblies defined in the CIS/2 file.
All On - Click to activate all New and Modified check boxes.
All Off - Click to clear all New and Modified check boxes.
Defaults - Activates a dialog box where you define properties to use when the object being
imported does not have a recognized property.
Member Defaults
Type Category
Select the type category to use when a member being imported does not have a recognized
type category. You can define a custom member type category on the Structural Member
Type sheet in the AllCodeLists.xls workbook.
Type
Select the type to use when a member being imported does not have a recognized type.
The properties change depending on the member type that you select. You can define a
custom member type on the Structural Member Type sheet in the AllCodeLists.xls
workbook.
Section Name
Select the cross-section to use when a member being imported does not have a recognized
section. Sections are defined in the reference data. See the Structure Reference Data Guide
for more information about reference data.
Material Name
Select the material to use when a member being imported does not have a recognized
material.
Material Grade
Select the material grade to use when a member being imported does not have a
recognized material grade.
Slab Defaults
Type
Select the slab type to use when a slab being imported does not have a recognized slab
type.
Composition
Select the slab composition to use when a slab being imported does not have a recognized
slab composition.
Material Name
Select the material to use when a slab being imported does not have a recognized material.
Material Grade
Select the material grade to use when a slab being imported does not have a recognized
material grade.
Plate Defaults
Type
By default, all plates are imported as General plate systems. You cannot change this value.
Naming Category
Select a category for the plate system. Categories specify the role of the plate system in the
model. The category is also used by the naming rule to name the plate part that is a child to
the plate system.
Tightness
Select the level of tightness as it applies to the entire plate system.
Continuity
Select the continuity type for the plate system. Continuity defines how the plate system
should react when it intersects another plate or profile system. Select Continuous to indicate
that the plate system should penetrate the other system. Select Intercostal to indicate that
the plate system should be penetrated by the other system.
Priority
Specify the continuity priority. This priority is used to specify which plate system is
penetrated when two plate systems intersect, but have the same Continuity value. Plate
systems with a lower continuity priority (1, 2, 3, for example) penetrate plate systems with a
higher continuity priority (7, 8, 9, for example).
Material
Specifies the object material type, such as Steel - Carbon or Steel - High Strength.
Grade
Specifies the object material grade, such as A36 or A529.
Thickness
Specifies the material thickness for the plate system.
Specification
Select the structural specification for the plate system.
CIS file - Define the file name and folder path of the CIMsteel Integration Standard file to read.
Include mapping file - Select this option to use a mapping file when importing the members
from the CIS file. You use a mapping file to:
Swap the third-party software name for a section (for example, L3.5X2.5X1/4) with the
Smart 3D name for a section (for example, L3-1/2X2-1/2X1/4). You must create the section
mapping file using the File > New Mapping File Command before you can use the
mapping file in this command. Sample mapping files for the FrameWorks Plus AISC table
are delivered with the software in [Product
Folder]\SmartPlantStructure\Symbols\StructureImportExportMaps. For more information,
see New Mapping File (on page 99).
Swap the third-party material and material grade name with the Smart 3D name. A sample
material mapping file for AISC is delivered with the software in [Product
Folder]\SmartPlantStructure\Symbols\StructureImportExportMaps.
Swap the third-party user-attributes (properties) with the Smart 3D properties names. A
sample user attribute mapping file is delivered with the software in [Product
Folder]\SmartPlantStructure\Symbols\StructureImportExportMaps.
You must bulkload (create) properties in the Smart 3D catalog for those third-party attributes
that you want to map. For example, the third-party application has an attribute called
"Expected Service Life" for members. Because Smart 3D does not have a property called
"Expected Service Life", you need to add that property to members using reference data
bulkload. See the Reference Data Guide and the Catalog User's Guide for more information
on bulkloading.
Mapping file - Specify the mapping file to use if Include mapping file option is selected.
Log file - Specify a log file name. You can view the log file after processing by clicking View
Log.
Action - Select whether to import or preview the contents of the CIS/2 file.
Select Import to import objects from the CIS/2 into the model. This option checks the unique
identification numbers in the CIS/2 file with the identification numbers of the model objects
finding matching objects. This option allows you to update model objects that had been
imported previously. Plate objects in the CIS/2 file are imported as slabs.
Select Import Ignore IDs to import objects from the CIS/2 into the model. This option does
not compare identification numbers in the CIS/2 file with the identification numbers of model
objects. This option allows you to import the CIS/2 objects as new, unique objects to the
model. In marine or material handling models, plate objects in the CIS/2 file are imported as
plates. In plant models, plates in the CIS/2 file are imported as slabs.
Select Preview to identify problems with the CIS/2 file before the actual import is attempted.
Objects in the CIS/2 file that have not been imported cannot be previewed.
Filter - Specifies how you want to preview the CIS/2 file. This option is only available when
Action is set to Preview.
Objects in CIS file with unknown sections, material, or type - Select this option to help
identify potential problems with the CIS/2 file before you attempt the import. After using this
option, you can add unknown sections, materials, and types to the mapping file.
Objects in DB that exist in CIS File - Select this option to identify objects that are in both
the model workspace and the CIS/2 file.
Objects in DB that are modified in CIS File - Select this option to identify objects that are
in both the model workspace and in the CIS/2 file but have different attributes (such as
section size) in the CIS/2 file. This option is useful when "round tripping" between Smart 3D
and another software package when you want to see which objects were modified in the
other software package.
Objects in DB that do not exist in CIS File - Select this option to highlight objects in the
model workspace that do not have a corresponding object in the CIS/2 file. This option is
useful when the CIS/2 file was originally exported from Smart 3D and you are "round
tripping" between Smart 3D and another software package. Using this option, you can
locate members in the model that may have been deleted in the other software package
(and therefore, were not exported to the CIS/2 file.) This option is also useful for verifying
that all members in the other software package were exported to the CIS/2 file.
Objects in DB that are not modified in CIS File - Select this option to identify objects that
are in both the model workspace and in the CIS/2 file that have the same attributes (such as
section size). This option is useful when "round tripping" between Smart 3D and another
software package when you want to see what objects in the Smart 3D model were not
modified by the other software package.
Option - Specifies how you want to import objects from the CIS/2 file. This option is only
available when Action is set to Import.
Use no defaults - Select this option to import only those objects known to Smart 3D (known
either in the software or in the specified mapping file) sections. Objects with unknown
sections are not imported into the model but are noted in the log file.
Use defaults if needed - Select this option to import all objects in the CIS/2 to the model.
Objects with sections not found in the software or in the mapping file will be given the
sections defined in the Defaults dialog box. Objects imported with default sections are
noted in the log file.
Submit Job - Activates the Schedule [Task] dialog box, which is used to define the batch
import of CIS/2 files using SmartPlant Batch Services. For more information on the batch
settings, see Schedule [Task] Dialog Box (on page 98).
View Log - Displays the import log file. You must click Apply when importing in order to view
the log at the end of processing or to use the Preview option. If you click OK, the dialog box is
closed at the end of processing and you cannot click View Log.
Address Book
Selects the name of the person to be notified by e-mail of the job status, if Outlook is set up.
If Outlook is not available, this option does not work. You can also type the address
manually. The person you define here receives an email with the job log files after the job
finishes.
The Batch Services SMTP option must be configured on the batch server for this to work.
For more information, see the Intergraph Smart Batch Services documentation.
The WinZip application is no longer required on the batch server to compress any emailed
attachments. Compression is now done with functionality included in Smart 3D.
Section standard
Select the section standard table for which to create a mapping file.
Include material
Select to include material name mappings in addition to the section name mappings.
Mapping file
Specify a name and folder path for the XML mapping file.
Section Mapping
The <SectionStandard> area maps the software section names to the third-party section names.
The software section names are labeled section name. The third-party section names are
labeled externalname. When the XML file is created, the software section name is duplicated
for the third-party section name. You must verify that the correct third-party section name is
defined for externalname by manually editing the XML file.
<xml>
<!-- Comment Line -->
<SectionStandard>
<Standard name="AISC-LRFD-3.0" externalname="AISC" externalorganization="user"
externaldate="2002" externalversion="1.0" />
<Sections>
<Section name="W10x39" externalname="W10x39" />
<Section name="W10x33" externalname="W10x33" />
<Section name="W10x30" externalname="W10x30" />
...
</Sections>
</SectionStandard>
</xml>
Material Mapping
The <MaterialStandard> area maps the software material grade names to the third-party
material grade names. You must have selected the Include material option when you created
the XML file to see the material grade name mappings. The software materials are labeled
Material type and grade. The third-party material names are labeled externalname. You must
verify that the correct third-party material grade name is defined for externalname by manually
editing the XML file. You must provide the external material standard name information by
manually editing the XML file.
<xml>
<!-- Comment Line -->
<MaterialStandard>
<Standard name="" externalname="" externalorganization="" externaldate="" externalversion="" />
<Materials>
<Material type="Steel - Carbon" grade="A36" externalname="A36" />
<Material type="Steel - Carbon" grade="A529" externalname="A529" />
<Material type="Steel - Carbon" grade="A588" externalname="A588" />
...
</Materials>
</MaterialStandard>
</xml>
Export Grids
The File > Export > Grids command exports the coordinate system to an XLS or XML file. The
exported file contains all needed information to import the coordinate system into a different
model. All the distance and angle values are exported with the Units and Precision as set in
Tools > Options... > Units of Measure window.
Topics
Export coordinate system ............................................................. 103
General Tab (Export Grids Dialog Box) ........................................ 104
Settings Tab (Export Grids Dialog Box) ........................................ 104
Export Structure
The File > Export > Structure command exports the structural physical model to a CIS/2 or IFC
file. For more information, see Importing and Exporting Structure.
You must create the filter before you can export the physical model.
You can create a mapping file using the File > New Mapping File Command that can be
used when exporting the physical model.
You can also use the delivered mapping files located in the [Product
Folder]\SmartPlantStructure\Symbols\StructureImportExportMaps folder.
You can export only concrete objects such as slabs, walls, structural systems, openings on
slabs and walls, footings, equipment foundations, and design equipment (with an equipment
classification of civil elements or structural elements) to the IFC format.
Linear and curved concrete members cannot be exported to IFC. We recommend the CIS/2
format for transferring linear and curved members.
The International System of Units (SI) is used in the exported CIS/2 file regardless of the
settings on the Tools > Options > Units of Measure tab.
If you have any questions about using this translator, please contact Intergraph Support. You
can find support information on our web site: http://support.intergraph.com.
Be sure to check the Compatibility Matrix before you export data. Open
https://smartsupport.intergraph.com https://smartsupport.intergraph.com, select View
Downloads at the top, and then select Product Compatibility under Useful Links on the right.
Export Standard
Select the industry standard to export.
IFC Options
Defines data, display, and organizational information for the IFC file. For more information,
see Export Options Dialog Box (on page 107).
Filter
Select the filter to use to identify the model objects to export.
Description
Type a description of the model. This description is included in the export file.
Author
Specifies the person who created the export file. The default is the current system user
name.
Organization
Specifies your company or organization name to use in the export file.
Export file
Define the file name and folder path of the export file to write. CIS/2 files have a .stp
extension while IFC files have an .ifc extension.
Include mapping file
Select this option to use a mapping file when exporting the members to the CIS/2 file. You
use a mapping file to:
Swap the third-party software name for a section (for example, L3.5X2.5X1/4) with the
Smart 3D name for a section (for example, L3-1/2X2-1/2X1/4). You must create the
section mapping file using the File > New Mapping File Command before you can use
the mapping file in this command. Sample mapping files for the FrameWorks Plus AISC
table are delivered with the software in the [Product
Folder]\SmartPlantStructure\Symbols\StructureImportExportMaps folder. For more
information, see New Mapping File (on page 99).
Swap the third-party material and material grade name with the Smart 3D name. A
sample material mapping file for AISC is delivered with the software in the [Product
Folder]\SmartPlantStructure\Symbols\StructureImportExportMaps folder.
Specify the user-attributes that need to be exported and to swap the Smart 3D property
names with the third-party user-attributes (properties) names. A sample user attribute
mapping file is delivered with the software in the [Product
Folder]\SmartPlantStructure\Symbols\StructureImportExportMaps folder.
Mapping file
Specify the mapping file to use if Include mapping file option is selected.
Log file
Specify a log file name. You can view the log file by clicking View Log.
Submit Job
Activates the Schedule [Task] dialog box, which is used to define the batch export of files
using SmartPlant Batch Services. For more information on the batch settings, see Schedule
[Task] Dialog Box (on page 98).
View Log
Displays the export log file. You must click Apply when exporting to view the log at the end
of processing. If you click OK, the dialog box is closed at the end of processing, and you are
not able to click View Log.
You must create the filter before you can export the model objects. Otherwise, the export
process might fail.
The mapping file is a Microsoft Excel workbook that is used to map all the objects and their
properties in Smart 3D and PDMS. This workbook is delivered to the [Reference Data
Folder]\SharedContent\Translators\S3DPDMSExport folder during setup.
If you want the software to create a separate datal file for each discipline, you must select
Generate separate file for each discipline.
To export profile parts when working in Marine mode, the plate parts that connect to the
profile parts must be selected in the filter.
View Log
Displays the export log file. To view the log file, you must click Apply to begin the export
process. If you click OK, the dialog box closes at the end of processing and View Log is
unavailable.
See Also
Export Smart 3D model data to PDMS (on page 109)
2. Click Browse , and select the filter. By default, the software displays the active filter for
the current session file.
3. Select Validate from mapping file.
4. In the Validation criteria list, select the object types for which mapping is to be validated.
You must select at least one criterion from the list.
5. In the Log file details box, type the name and folder location of the log file.
6. Click Validate.
By default, the validation tool updates the mapping file located in [Product
Folder]\3DRefData\SharedContent\Data\Translators\S3DPDMSExport. To specify a
mapping file in a different location, select Specify alternative location and then type the full
path location and file name in the Datal/Mapping file to validate box.
If the mapping file is read-only, the software creates a copy of the mapping file with the
name <Mapping file name>_COPY.xls, and saves it in the same location as the original
mapping file. The software updates the copy of the mapping file with the missing mapping
details.
Displays the active filter of the session file. Click Browse to navigate to and select a
different filter.
Target (PDMS) object selection criteria
Specify the selection criteria. The current release of the software supports only the Validate
from mapping file option.
Specify alternative location
Allows you to specify a mapping file other than the one in the default location. By default, the
software updates the mapping file located in [Product
Folder]SharedContent\Data\Translators\S3DPDMSExport. To specify a different location,
select this option and then type the full path location and file name in the Datal/Mapping file
path box. Alternatively, click the browse button , and then navigate to the location.
Datal/Mapping file path
Type the full path location and name of the mapping file to validate. This option is available
only if you select Specify alternative location. Updating DATAL files is not supported in the
current release of the software.
Validation criteria
Select the Smart 3D objects whose mapping you want to validate. Objects are listed by
discipline. For each criterion that you select, the software validates the corresponding
worksheet in the mapping file. You must select at least one object in the Validation criteria
list.
Equipment Models
For more information about any of the equipment mapping sheets referenced in the
following rows, see Equipment Translation Maps.
Piping Models
For more information about any of the piping mapping sheets referenced in the
following rows, see Piping Translation Maps.
Reports missing mapping for the end connection of pipe parts in the
End Connection
PipingEndConnectionMap sheet.
Reports missing mapping for gaskets and field fitted welds SpecRef
Connections attributes in the CatalogComponentSPREFMap sheet and in the
NPDSpecificSPREFMap sheet.
Structure Models
For more information about any of the structure mapping sheets referenced in the
following rows, see Structure Translation Maps.
HVAC Models
For more information about any of the HVAC mapping sheets referenced in the
following rows, see HVAC Translation Maps.
Reports missing mapping for the end connection of duct parts in the
EndConnection
HVACEndConnectionMap sheet.
Supports
Reports the missing mapping for a support component's GType
attribute in the SupportGTYPE sheet.
Reports the missing mapping for a support component's
Attributes in the SupportUserAttributes sheet.
Electrical Models
For more information about any of the electrical mapping sheets referenced in the
following rows, see Electrical Translation Maps.
Reports missing mapping for conduit and cable tray parts in the
Components ElectricalPartIdentifierMap and ElectricalComponentSPREFMap
sheets.
Reports missing mapping for conduit and cable tray stock parts in
ElectricalStockParts the ElectricalPartIdentifierMap and
ElectricalComponentSPREFMap sheets.
PDS Export
The File > Export > PDS Export command exports model data from Smart 3D into PDS. The
process involves transferring Smart 3D objects and their attribute values to PDS file format. For
information about the types of Smart 3D model data that you can export to PDS, see Export to
PDS Workflow.
Please refer to the Export to PDS Guide or help file for detailed information about exporting
Smart 3D data to PDS.
Prior to using the export to PDS functionality, you must perform the following
tasks:
1. Edit the options in the delivered initialization file to define the parameters used in the export
process. For more information about the initialization file, see Configure the PDS Export
Initialization File.
2. Edit the mapping workbooks to reflect the customizations that you have made to the Smart
3D model object attributes. For more information about the mapping worksheets, see
Appendix: Export to PDS Workbook.
3. Ensure that the mapping and PDSExportTranslator.ini files are in the same file path before
exporting model data to PDS.
Export Settings
The File > Export > PDS Export > Export Settings command edits the [Product
Folder]\Smart3D\3DRefData\SharedContent\Data\Translators\S3DPDSExport\PDSExportTransl
ator.ini file. You can also edit the PDSExportTranslator.ini file directly with any ASCII file editor.
Global
The Global settings are used to define the MicroStation symbology for each Smart 3D display
aspect.
Aspect Symbology Name
Select the Smart 3D aspect for which to define MicroStation symbology.
Level
Enter the MicroStation level for the selected aspect. Valid levels are 1 to 63.
Color
Select a color for the selected aspect.
Weight
Enter the MicroStation line weight for the selected aspect. Valid weights are 0 to 31.
Style
Select the MicroStation line style for the selected aspect.
Equipment
Number of equipment per model
Enter the maximum number of equipment to put into a single MicroStation design file
(.DGN).
Piping
Number of pipelines per model
Enter the maximum number of pipelines to put into a single Alphanumeric Piping Language
(APL) file.
Structure
Number of structures per model
Enter the maximum number of structural objects (beams, columns, braces, and slabs) to put
into a single CIS/2 file.
Number of structural equipment per model
Enter the maximum number of walls, ladders, and stairs to put into a single equipment
MicroStation design file (.DGN).
Wall Level
Enter the MicroStation level for walls. Valid levels are 1 to 63.
Wall Color
Select a color for walls.
Wall Weight
Enter the MicroStation line weight for walls. Valid weights are 0 to 15.
Wall Style
Select the MicroStation line style for walls.
Wall Opening Level
Enter the MicroStation level for the wall openings. Valid levels are 1 to 63.
Wall Opening Color
Select a color for the wall openings.
Wall Opening Weight
Enter the MicroStation line weight for the wall openings. Valid weights are 0 to 15.
Wall Opening Style
Select the MicroStation line style for the wall openings.
HVAC
Number of HVAC ducts per model
Enter the maximum number of ducts per MicroStation design file (.DGN).
Duct Level
Enter the MicroStation level for ducts. Valid levels are 1 to 63.
Duct Color
Select a color for ducts.
Duct Weight
Enter the MicroStation line weight for ducts. Valid weights are 0 to 15.
Duct Style
Select the MicroStation line style for ducts.
Duct Component Level
Enter the MicroStation level for the duct component. Valid levels are 1 to 63.
Duct Component Color
Select a color for the duct component.
Duct Component Weight
Enter the MicroStation line weight for the duct component. Valid weights are 0 to 15.
Duct Component Style
Select the MicroStation line style for the duct component.
Print
Sends a copy of the active window to a specified plotter or printer. What you see in the active
window is what appears on the printed document.
The software uses the standard Microsoft Windows Print dialog box. To access additional
printer properties, click Properties. The settings that are available in the dialog box depend on
the type of printer that is currently selected in the Print dialog box.
The software automatically produces the view snapshot on a white background, regardless
of the settings currently defined for the default background color.
The shortcut key for the Print command is CTRL+P.
You must install and select a printer or plotter before you use this command. For help on
installing a printer or plotter, see Windows Help.
You can set additional options for the printer by clicking Properties.
Save your current session before you print. If a printer error or other problem occurs, you
will not lose any work completed since the last time you saved the session.
What you see in the active window is what appears on the printed document. Be sure to
make any necessary changes to the view before printing, such as adjusting the orientation
of the view or the zoom.
The software automatically produces the view snapshot on a white background, regardless
of the settings currently defined for the default background color.
Status
Displays the current status of the selected printer. This area is read-only.
Type
Displays the type of printer currently selected. This area is read-only.
Where
Displays the printer path or location for the currently selected printer. This area is read-only.
Comment
Displays any comments you input during printer configuration. This area is read-only.
Print to file
Prints the document to a file instead of a printer. Specify the name of the file on the Print to
file dialog box after you select this check box, and click OK on the Print dialog box. Using
this option saves a document to a file instead of routing it directly to a printer or plotter. You
can then print from a computer that does not have the application installed, or print to a
printer other than the one you have currently installed.
Print Range
Displays options for selecting the print range. The Pages and Selection options are not
supported by the software. The default option is All.
Number of copies
Specifies the number of copies you want to print.
Collate
Organizes sheets when you print multiple copies. This option is available only when
Number of copies exceeds 1.
Exit
Closes the open session and exits the software. If you have changed data since the session
was last saved, or if you have not saved a new session, the software prompts you to save your
changes.
Edit Menu
The Edit menu provides commands for undoing incorrect actions, copying and pasting,
modifying objects, and opening hyperlinks. Some of the commands on this menu might change
depending on the active task.
In This Section
Undo ............................................................................................. 128
Copy ............................................................................................. 131
Paste ............................................................................................ 132
Paste and Restore ........................................................................ 136
Copying and Pasting Using the Catalog ....................................... 140
Locate Filter .................................................................................. 148
Delete ........................................................................................... 150
Move ............................................................................................. 151
Rotate Object ................................................................................ 157
Mirror Copy ................................................................................... 169
Update Names .............................................................................. 176
Properties ..................................................................................... 176
Go to Hyperlink ............................................................................. 182
Undo
Reverses all changes of your transactions on information in the model database. This
command does not affect data stored in your session file. For example, it does not undo view
manipulation commands such a fit, zoom, or pan.
You can undo Reference 3D object Exclude and Include command operations. For more
information, see Exclude and Include Reference 3D Objects.
Actions you can undo fall into three categories:
Modification - You do not want to keep the modifications you made.
Entity Creation - You want to remove something you created. You can remove the object
with Delete or undo.
Entity Deletion - You want to restore objects that you deleted.
The software creates a private undo list for you when you open a session. When you close the
session, the software deletes the undo list. Selecting Save or Save As has no effect on your
Undo list.
To prevent the Undo data from continually increasing, you have the option to limit the number of
transactions the software must remember by going to Tools > Options > General. You can
disable the Undo command is clearing the Make Undo available option. For more information,
see General Tab (Options Dialog Box) (on page 500).
You can use Undo by selecting Edit > Undo, by clicking Undo on the toolbar, or by using
the shortcut keys CTRL+Z.
You cannot undo the Claim command. In addition, the Undo history is cleared after you run
Claim, meaning actions taken prior to claiming cannot be undone.
Most dialog box actions cannot be undone. For example, if you delete a named view using
Views > Named Views, you cannot use Undo to recreate the named view.
You can use Undo by selecting Edit > Undo, by clicking Undo on the toolbar, or by
using the shortcut keys CTRL+Z.
On the General tab of the Tools > Options dialog box, you can enable or disable Undo.
You can also specify how many previous actions can be canceled. For more information,
see Options Dialog Box (on page 500).
When you enable the Make Undo available feature, you can specify the number of
previous actions that can be cancelled in the Number of undo actions list.
You can use Undo by selecting Edit > Undo, by clicking Undo on the toolbar, or by
using the shortcut keys CTRL+Z.
Copy
Copies selected objects and their associated relationships to the Clipboard. The Clipboard
retains the format of the copied objects and converts them to other formats as required when
you paste them using Paste (on page 132).
When you copy more than one object at a time, the software copies all relationships shared
among the objects. If there is a relationship between a selected object and an object that you did
not select, then the copied set of objects is expanded automatically to include the excluded
object. The Copy command also copies the current permission groups of the copied objects.
You can copy an object from one workspace and paste it into another. The workflow for the
Copy command is the same. However, you use Paste and Restore (on page 136) to paste into
the other workspace.
Paste
Inserts the Clipboard contents in a selected document or a selected area of the model.
The contents of the Clipboard can be pasted into another document in several supported
formats. The supported formats are:
Native to the three-dimensional software
Picture/Enhanced Metafile (GDI)
Text/OEM
Text/RTF/Unicode (only the selected text)
The Paste command inserts an object as a new object. The name rule for the object also
updates, so the object has a new name. You can specify whether you want the software to place
the new object directly on top of the copied object, or if you want to define the new position for
the pasted objects.
You might need to copy an object from one workspace and paste it into another. Use Paste and
Restore (on page 136) to insert an object with the same identity and name.
You can select any reference point to use to later position the pasted objects. For
example, you can click a coordinate system, control point on a piece of equipment or
use PinPoint to specify the coordinates.
Some logical objects such as Systems and Pipelines, do not prompt you for a reference
point. In these cases, the Paste command only allows Paste in place.
4. Right-click to select Paste or click Paste on the toolbar.
Press Ctrl+V or click Edit > Paste.
5. On the Paste dialog box, assign target relationships, review the options, and adjust as
needed.
You can select options to keep the original permission groups and to paste the
objects in place. For example, you might want to keep the original permission groups when
pasting large data sets containing different types of objects (piping, equipment, and
structure).
6. Click OK, and click in the model to place the objects.
When copying across models or pasting modules from the catalog, the software
attaches a red outline of the select set to the cursor.
After you copy a large data set, the data remains in memory until you copy
another set of objects, copy data in another application, or exit Smart 3D. If you copy a large
data set and then continue working in Smart 3D, your computer's performance may be impacted
due to memory usage. Smart 3D displays the following warning message after you paste a large
data set:
Click Yes to keep clipboard data available, and click No to clear your clipboard.
Partial Restore
To use Paste and Restore for a partial restore, your project administrator must back up the
current model in the Project Management task. When you need to restore objects from a backup
of the model data, the project administrator makes the backup data available as an additional
model in the Project Management tree using the Restore model for selective recovery of
model objects option in the Restore Wizard. For more information, see Restore a Backup
Model for Selective Recovery in an Active Model in the Project Management User's Guide.
Paste and Restore does not support selective recovery of marine and material
handling model objects.
The process for restoring selected objects from a backup is a simple copy-and-paste from one
model to another. The behavior is as follows:
Property Values
All property values from the backup are restored to the object with the following exceptions:
Modified Date and Modified By, both of which reflect the current values when you use Paste
and Restore.
Permission Groups
To use Paste and Restore, you must have write access to the permission group for both the
active and the backup versions.
Paste and Restore uses the active permission group if the original permission group of the
object is not in the target model. The original permission group may have been deleted from the
target model or may never have been in the target model. This situation can arise when you are
importing objects from other models to reference.
Status
If an object in the backup version has an Approved status, the Paste and Restore command
sets the status back to Working in the active model. If any object selected for Paste and
Restore in the active model has an Approved status, you cannot use the Paste and Restore
command.
Design Basis
When you run Paste and Restore, the software sets the correlation relationship to the state
from the backup. If the object was not correlated, the relationship is removed.
If problems occur when using Paste and Restore, refer to the Troubleshooting Reference
Guide accessed with Help > Printable Guides for additional information.
When using Paste and Restore, the Selection column of the Paste dialog box displays the
original system associated with the object. You can change the association by selecting a
different system in the Workspace Explorer. If the original system associated with the
object has been deleted from the active model, then the Selection column of the Paste
dialog box is blank. You can create a new association by selecting a system in the
Workspace Explorer.
You need write access to both the current and backup versions of the model to use Paste
and Restore.
If any object selected for Paste and Restore in the current model has an Approved status,
you cannot use Paste and Restore.
1. Open a session in Smart 3D that points to a model restored from a backup of the current
model.
To use Paste and Restore for a partial restore, your project administrator must
back up the current model in the Project Management task. When you need to restore
objects from a backup of the model data, the project administrator makes the backup data
available as an additional model in the Project Management tree using the Restore model
for selective recovery of model objects option in the Restore Wizard. For more
information, see Restore a Backup Model for Selective Recovery in an Active Model in the
Project Management User's Guide.
2. In a graphic view or the Workspace Explorer, select objects in the backup model.
3. In the Common task, select Edit > Copy.
4. Click a reference point (From point) on an object in the select set.
You can click a From point in space, but it is more common to define the From point
on an object in the select set. For example, you can click a control point on a piece of
equipment.
5. Open another session in Smart 3D that points to your current model.
6. In the Common task, select Edit > Paste and Restore.
The Paste dialog box displays. The Selection column shows the original system and
relationships associated with the object.
7. Provide information as required to complete the paste operation, and then click OK.
Backup versions of the objects are restored to the current model. Relationships are
adjusted, depending on permissions. The To Do List is updated if necessary.
8. Delete any restored objects that are not needed.
It is often helpful when using this command to verify which session is active. You can view
the name of the current session, task, Model, and filter on the title bar of the application and
on the Windows task bar.
You can change the graphic display in the backup model graphic view to show a clear visual
difference between the two models by changing the background in Tools > Options.
When using Paste and Restore, the Selection column of the Paste dialog box displays the
original system associated with the object. You can change the association by selecting a
different system in the Workspace Explorer. If the original system associated with the
object has been deleted from the active model, then the Selection column of the Paste
dialog box is blank. You can create a new association by selecting a system in the
Workspace Explorer.
Topics
Copy to Catalog ............................................................................ 141
Paste from Catalog ....................................................................... 145
Copy to Catalog
Copies a set of objects to the Catalog in a module that you designate. After you complete the
command, the copied objects are available to all users to access as needed. The objects you
copy do not need to share any type of functional relationship. The type of module you select
determines the properties of the objects.
If the associated specification data, part data, symbols, or other reference data are
not also copied from the source catalog into the target catalog, an error message displays when
you use the Paste from Catalog command. Possible error messages are listed below:
The PasteFromCatalog command succeeded. However some external objects
are missing and may impact the final result. For more information, please
refer to the ‘SP3D_Paste_MissingExternalObject.log’ file. Would you
like to view the file now?
The catalog information required by this module is not found. The module
should be deleted and recreated using your current catalog data.
The modules exist in the reference data as defined by the bulkload of module types. The
reference data stores the following information for the module:
Name, description, and type of module that stores the data in the Catalog
Properties associated with the model type that allow you to search in the Catalog for a
select set
The copied objects, which the software assigns to a common permission group for reference
data
Identity of the input objects
Parent objects of the copied objects
Graphics for the inputs that display in the placement window
List of permission groups to which each copied object belonged
Stored object in the Catalog that controls all of this data as a row in a user folder
For more information about the modules that the Copy to Catalog command uses, refer to the
Reference Data Guide available from the Help > Printable Guides command in the software.
You must have write permission to the permission group of the catalog module folder
to which you are copying the objects.
Select
Specifies the objects to copy.
Placement Point
You can select the objects before clicking Edit > Copy to Catalog.
Before clicking Finish, you can click Properties on the ribbon to define values for the
properties of the module.
Configuration Tab
Displays the creation, modification, and status information about an object.
You cannot define the filters using the Configuration tab.
Model
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the object belongs. You can select another
permission group, if needed. Permission groups are created in Project Management.
Transfer
Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group. This option is only available if the active model or
project is replicated in a workshare configuration. The option is not available if all of the
objects in the select set already belong to another location and are non-transferable. For
more information, see Transfer Ownership Dialog Box in the Common User's Guide.
Approval State
Specifies the status of the selected object or filter. The display depends on your access
level. You might be unable to change the status of the object. The list is defined by the
ApprovalStatus codelist.
You can only edit or manipulate an object with a status of Working.Status
Specifies the location of the object in the workflow process. Changing this property sets the
Approval State. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file. For more information, see
ApprovalReason in the Reference Data Guide.
Date Created
Specifies the creation date of the object.
Created by
Specifies the name of the person who created the object.
Date Last Modified
Specifies the date of the last modification to the object.
Last Modified by
Specifies the name of the person who last modified the object.
Before selecting Edit > Paste from Catalog, select the destination system in the
Workspace Explorer.
If the associated specification data, part data, symbols, or other reference data are not also
copied from the source catalog into the target catalog, an error message displays when you
use the Paste from Catalog command. Possible error messages are listed below:
The PasteFromCatalog command succeeded. However some external
objects are missing and may impact the final result. For more
information, please refer to the
‘SP3D_Paste_MissingExternalObject.log’ file. Would you like to view
the file now?
The catalog information required by this module is not found. The
module should be deleted and recreated using your current catalog
data.
When you select the Paste from Catalog command, the Catalog browser opens in the folder
you last accessed with the command. When you open a module in the Catalog, you use the
Paste dialog box to insert the module information in the target module. The software generates
the required part numbers and occurrence names for the individual objects.
The type of module you select determines the properties of the objects. The modules exist in the
reference data as defined by the bulkload of module types.
For more information about the modules that the Paste from Catalog command uses, refer to
the Reference Data Guide available from the Help > Printable Guides command in the
software.
Delete
Deletes the selected object. This command is available only in the Catalog task.
Undo
Reverses the most recent operation. This command is available only in the Catalog task.
Insert Row
Inserts a blank row into the grid view. This command is available only in the Catalog task.
Move Up
Moves the select list entry up one row in the editable grid. This command is available only in
the Catalog task.
Move Down
Moves the select list entry down one row in the editable grid. This command is available
only in the Catalog task.
Properties
Displays the properties of the selected object. The properties on this dialog box are read-
only.
Preview
Opens a bitmap file that was assigned to a part or part class in the reference data.
Filter
Filters the data in the content view to quickly find what you are looking for. This command is
available only in the Catalog task.
Sort
Sorts data in the content view by multiple columns to quickly find what you are looking for.
This command is available only in the Catalog task.
Customize Current View
Controls which property columns display in the content view and in what order. This
command is available only in the Catalog task.
List View
Displays the information in the content view in a list format.
Grid View
Displays the information in the content view in a table format.
Check Data
Checks the consistency of the data in the grid against other data in the Catalog. This
command is available only in the Catalog task.
Address
Specifies your exact location within the displayed hierarchy.
Locate Filter
Changes the active Select command filter without clearing the select set. You can use locate
filters in the software to assist in selection of objects in the workspace. The Locate Filter box on
the main toolbar displays the active filter.
Each task provides a unique list of available filter options. You can use these filters to perform
the following:
Control the selection of compound (or owner) objects versus selection of the constituent
components. For example, in the Piping task, you have the option to locate the run, the
parts, or the features of the run.
Filter on any object independent of the current task.
You can apply locate filters to the highlighting and selection in both the graphic and Workspace
Explorer views.
Select the More... option at the bottom of the list to display the Select Filter dialog box. The
Select Filter dialog box displays all of the simple filters that are set up to accept object type or
system objects as discrimination data. You can then select additional filters to add them to this
list. Only the selection of filters is available; all other options are disabled. For more information,
see Select Filter Dialog Box (on page 369).
After you add filters to the list, you can use them just as you would any other filter. For example,
you could do the following:
Select the objects in a 3D view.
Select the name of the object in the Workspace Explorer.
Fence and select the objects in a 3D view.
Any filters that you add from the Select Filter dialog box remain available even if you change
tasks. Filters that you add are available only in the active session. These filters are not saved in
the session file.
These options are also available when you use CTRL+E to display the Locate Filter dialog box
or by selecting Edit > Locate Filter.
The objects in the Locate Filter list for the Select command are defined by the software.
They are not the user-defined filters that you can create through the Define Workspace or
Select by Filter commands.
Another way to specify a locate filter is in the field on the Select (on page 347) command
ribbon.
When you use the Edit > Locate Filter command, the current command stays active, and
the software retains all selected objects.
Another way to specify a locate filter is in the field on the Select (on page 347) command
ribbon.
Inside
Specifies that all objects located entirely inside the fence be selected. This setting is the
default for the Select command.
Inside/Overlapping
Specifies that all objects located entirely inside the fence and those outside the fence but
touching the fence at some point are selected.
Delete
Removes the selected object from the database, and deletes any relationships and notes
placed on the object.
Deleting objects can create inconsistencies in your design. However, you can retrieve the data
and reconcile the inconsistencies by immediately clicking the Undo command. You can refer to
the To Do List for a list of any inconsistencies created by deleting an object.
You can select and delete an object in any task if you have the appropriate permissions.
You can also restore deleted objects from backup using the Paste and Restore (on page 136)
command.
You can also press the DELETE key to delete objects.
See Also
Cancel Your Last Action (on page 129)
Undo (on page 128)
Move
Moves objects from one location to another. You specify the original location of the object
and then indicate the destination location. You can move one object or select multiple objects to
move simultaneously.
The software maintains persistent relationships that exist between objects during a move. For
example, if a pump has been mated to a surface that relationship continues to exist even after
the pump is moved to another location within the workspace. Remember that relationships may
prevent you from moving an object to where you want. For example, the pump cannot be moved
off the surface, only to another location on the surface. You may need to delete relationships to
move an object to its new location.
Move Ribbon
Provides commands and options for relocating any object that supports moving. This command
gives functionality for a generic move. You can move more than one object at the same time.
Move From
Identifies the starting point of the move. If you do not define a starting point, the current
location of the selected object is assumed to be the starting point.
Move To
Identifies the end point of the move. During the move operation, you can use PinPoint,
Point Along, and SmartSketch 3D relationship indicators. The SmartSketch indicators help
with moving parallel to other objects or along a major axis to offset from an object. If you do
not want the selected objects to move with the pointer during the Move To step, press F10.
Plane
Activates options for selecting a working plane for the move. The icon on the ribbon
changes depending on your selection. The default selection is No Plane. The options
include:
Plan Plane
Defines the work surface as the XY plane. You can also press CTRL+1 to select this
option.
Elevation Plane: East-West (Z Plane: X-Axis)
Defines the work surface as the XZ plane. You can also press CTRL+2 to select this
option.
Section Plane: North-South (Z Plane: Y-Axis)
Defines the work surface as the YZ plane. You can also press CTRL+3 to select this
option.
No Plane
Clears any work surfaces. The software does not project points that you place to any
plane. You can also press CTRL+6 to select this option.
Lock Pinpoint
Locks object coordinates for the Move To point if the PinPoint ribbon bar is active when the
Move command is started. If PinPoint is not enabled when the Move command is
activated, the Lock PinPoint option is disabled. By default, Lock Pinpoint is not selected.
If Rectangular Coordinates is selected on the PinPoint ribbon, the E, N, and El
values are locked.
If Spherical Coordinates is selected on the PinPoint ribbon, the Distance,
Horizontal, and Vertical values are locked.
Smart 3D generates the move set based on the connections and relationships in the
model. The software automatically applies Fast move to a select set that contains:
An object that does not support computed previews.
More than one thousand objects.
The Fast move check box remains clear when the software applies the mode
automatically.
8. Press F6, and type the X delta distance for the move.
9. Press F7, and type the Y delta distance for the move.
10. Press F8, and type the Z delta distance for the move.
The objects move to the new coordinates and display as a preview.
Rotate Object
Rotates or turns the view so that you can see your model from a different perspective. If
you have objects selected, Smart 3D rotates about the center of those objects. If nothing is
selected, the software rotates about the center of the view.
To change the position of the rotation triad:
Use Reposition rotation triad . For more information, see Advanced Rotation
Options.
Use Set rotation triad to center of view . For more information, see Advanced
Rotation Options.
Hover your cursor over the rotation triad until all of the axes turn green. Then, use the
left mouse button to drag and drop the triad at a new location.
If you have SmartSketch Options turned on, you can use the location glyphs to help you
position the triad at a specific location. In dense areas of the model, these location
glyphs can provide more feedback than you need. Press and hold L to temporarily hide
the SmartSketch location glyphs. The glyphs redisplay when you stop pressing L.
For precision needs, you can define the angle and an incremental step value. To view objects
in the model from a different angle, use the Rotate View command instead.
To use this command, select an object, and click Rotate Object . Then, specify the axis of
rotation by a point (the axis position point) and a direction. You can also relocate the position
point for the axis of rotation, if necessary.
After defining the axis of rotation and position point, define the angle of rotation. One way to
define the angle is by moving the mouse in a drag-and-drop operation. Another way to define
the angle is to type a value in the Angle box. You can also specify a Step value that represents
an incremental angle value. A third way to define the angle is by comparing and changing the
angle between a reference plane or line on the rotation object with a reference plane or line on a
stationary object in the model. In this mode, you use the Reference on Rotation Object and
Reference on Stationary Object buttons on the ribbon.
If the component has more than one constraint, you cannot rotate it. If the object is not fully
constrained, you can rotate it at any time.
If the object has a mate relationship to a surface, you can only rotate the object about the
axis that is perpendicular to the surface, which the software selects by default. The default
point of rotation is the origin of the object.
If you are rotating structural members, be sure to select all the members and the coordinate
system that you want to rotate. If you select just the coordinate system, the members will
rotate but the rotation angle of the members themselves will not change.
To choose a different axis direction, you can complete one of the following actions:
Select one of the axis directions parallel with the active coordinate system (Up/Down,
N/S, or E/W) from the Axis direction box. Or, select an axis directly on the rotation triad
graphic in a graphic view.
Select Perpendicular to both References to use the rotation axis direction
perpendicular to both a reference on the object and a reference in the model. This
allows a single rotation about the axis at the rotation point to make the two references
parallel. Generally, the Angle will be set to 0.
Select Select Graphically, and then click the line or port about which to rotate the
object in the graphic view. You can also select a cylinder to define the axis of the
cylinder as the axis of rotation. If a line is selected, the line becomes the axis of rotation
for the object. If a port is selected, the axis position point changes to the coordinate
system origin of the port.
Bearing
Specifies the bearing angle for the object. The Bearing angle is measured between the
local x-axis of the object and the Y-axis (North) of the global coordinate system in the
XY-plane. The local x-axis is the default axis of primary symmetry for all symbols in the
catalog. The bearing measurement direction is clockwise from the active coordinate system
North looking in the negative active coordinate system direction; that is, down from 0 to 360
degrees. You can enter negative bearing angles, but the software automatically converts
them to the positive equivalents. If the pitch is set to +/- 90 degrees, then the bearing
measure displays 0 degrees.
Pitch
Specifies the pitch angle for the object. The Pitch angle measures between the x-axis of the
object and the X-axis of the global coordinate system in the XZ-plane. This option sets the
reference in the model to a line that is the intersection of the vertical plane through the
X-axis of the local coordinate system and the active coordinate system horizontal plane. The
angle is measured in the positive direction from the horizontal plane in the active coordinate
system up direction regardless of the current bearing. Another way to describe pitch is the
rotation of the object about its y-axis. Pitch angles are limited to between -90 degrees and
+90 degrees, with 0 indicating horizontal.
Roll Angle
Specifies the roll angle for the object. The Roll angle measures between the local z-axis of
the object and the Z-axis of the global coordinate in the YZ-plane. Another way to describe
roll is the rotation of the object about its x-axis. This option sets the reference in the model to
a line that is perpendicular to the local coordinate system x-axis and in the horizontal plane.
Roll angles are measured clockwise from horizontal to the y-axis of the local coordinate
system. The roll angle is between 0 and 360 degrees. You can enter negative roll angles,
but the software automatically converts them to the positive equivalents. If the pitch is set to
+/- 90 degrees, then the reference in the model is the North axis.
Angle
Allows you to type the number of degrees for the angle of rotation to apply to the object.
This option also dynamically displays the current angle during manual rotation. This option is
helpful if you need to have a precise value for the rotation angle.
When you use a reference plane or line on the rotation object and a reference plane or line
on a stationary object in the model, the Angle box shows the angle between these two
references.
Step
Defines an incremental or step value for dynamic rotation. When you rotate objects, the
object rotates to an angle equal to some multiple of the step value.
Close
Completes the command.
Fast rotate
Displays a range box around the objects that you are rotating instead of the wireframe
outline of each object. This option enhances performance when working with large select
sets.
If you do not want to view all of the objects in your workspace during rotation, you
can use Tools > Hide to remove unwanted objects from the view. To restore the objects to
the display, click Tools > Show.
3. In the Axis direction box, select one of the axis directions parallel with the active coordinate
system: N/S-, E/W-, or the Up/Down-axis. Or, select an axis directly on the rotation triad
graphic in a graphic view.
4. If necessary, move the axis of rotation to a different location in the model by clicking Axis
Position Point , and then click in the graphic view at the location of the origin.
5. In the Angle box, define the degree of the angle of rotation by typing a value or by dragging
the object to define the angle.
As you drag the object, the software displays the rotation about the axis. The Angle
box dynamically displays the value of the angle.
6. In the Step box, you can type the increment value used for the dynamic rotation input. The
default value is blank.
7. Click Close.
3. Select Perpendicular to both References from Axis direction. This option uses the
rotation axis direction that is perpendicular to both a reference on the object and a reference
in the model.
A dashed line appears representing the rotation axis on the object.
5. If the reference is on the object, click Reference on Rotation Object , and select a line
or plane to use as a reference on the object being rotated.
6. Click Reference on Stationary Object , and select a line or plane to use as a reference
on another object in the model.
A second line appears and the angle between the two lines displays in the Angle field.
7. Click Rotate by precision graphic input on the ribbon. This option allows you to click a
point in the model to orient graphically the object using a reference on the object. You can
use the SmartSketch relationship indicators to locate the point.
-OR-
In the Angle box, type the angle that you want between the reference plane (dashed line)
on the rotation object and the reference plane (dashed line) on the stationary object.
8. Click Close.
3. In the Axis direction box, select the Select Graphically option, and then click a line or port
about which to rotate the object in the graphic view. For example, you can select a nozzle to
specify that the axis of the nozzle cylinder is the axis of rotation.
4. In the Angle box, define the rotation by typing a value or by dragging the object to define the
angle.
The Bearing, Pitch, and Roll options set both the axis of rotation and default
measurement references.
When the pitch is +/- 90 degrees, the bearing measure is indeterminate.
4. If necessary, move the axis of rotation to a different location in the model by clicking Axis
Position Point , and then click in the graphic view at the location of the origin.
5. For more precision in rotating, you can click Rotate by precision graphic input on the
ribbon.
This option allows you to click a point in the model to graphically orient the object
using a reference on the object. You can use the SmartSketch relationship indicators to
locate the point.
6. In the Angle box, define the rotation by typing a value or by dragging the object to define the
angle.
7. In the Step box, you can type the increment value used for the dynamic rotation input. The
default value is blank.
8. Click Close when you are finished rotating the object.
Mirror Copy
Produces a duplicate image of an object or a set of objects at a location you specify in the
model. The mirrored objects are identical in form, but the image is reversed and copied to the
selected destination. However, certain settings, particularly the properties for rotation and part
replacement, can cause differences between the original object and the mirrored object.
The command is especially useful when you need to copy multiple, connected objects to the
opposite side of a symmetrical configuration. For example, you can select an array of pipe runs
and generate mirrored images of all their components, geometrical structure, and properties
assigned to the pipe runs.
The direction of the mirrored objects is perpendicular from the mirror plane (the plane about
which the software flips the selected objects). The mirror plane and its location determine the
exact location of the objects. The software places the mirrored objects at a point that is an equal
distance from, and perpendicular to, the mirror plane.
You cannot use the Mirror Copy command on hangers and supports objects.
The command processing includes the following functions:
Copy and flip the copy
Flip in the direction that you specify
Move or copy the flipped object to a position you specify
Change or copy properties appropriately
The mirroring and flipping is based on settings in the reference data. The result is a mirrored
object that is identical to the object at the origin, but the mirrored object is reversed, moved, and
copied. The only exceptions can occur from restrictions that exist in reference data settings for
rotation or part replacement. The select list, Mirror Behavior Option, appears on the part class
sheets for reference data. The option has various settings:
Component may be mirrored
Component may be rotated 180 degrees, but not mirrored
Component cannot be mirrored or rotated, but can be copied and translated
Component must be replaced rather than mirroring, rotating, or copying
Mirror origin - Corresponds to the Move From point, or the origin of the objects you want to
mirror. In the picture, the mirror origin is labeled (D).
Mirror plane - Plane about which the software flips the selected objects. In the picture, the
mirror origin is labeled (F).
The following picture explains the nature of the processing by the software.
(A) - Centerline
(B) - Centroid
(C) - Direction of flip
(D) - Mirror origin (or Move From point)
(E) - Mirror destination (or Move To point)
(F) - Mirror plane
The command processing requires a series of steps. First, you identify one or more objects you
want to mirror and copy. Then you define the mirror plane, which is the plane about which the
software flips the objects you select. Also, the software prompts you to specify the starting point
(or move from) and the destination point (or move to). The following graphic summarizes the
processing:
Select
Selects objects to mirror and copy.
From Point
Sets a starting point for the mirroring and copying operation. This point is also called the
from point.
To Point
Sets an end point for the mirroring and copying operation. This point is also called the to
point.
Direction
Selects the direction of the mirror plane.
Plane by From-To Vector
Defines the mirror plane as normal to a vector between the from point and the to point.
You can also press CTRL+6 to select this option.
Plan Plane
Defines the mirror plane as the XY plane. You can also press CTRL+1 to select this
option.
Elevation Plane: East-West (Z Plane: X-Axis)
Defines the mirror plane as the XZ plane. You can also press CTRL+2 to select this
option.
Elevation Plane: North-South (Z Plane: Y-Axis)
Defines the mirror plane as the YZ plane. You can also press CTRL+3 to select this
option.
Destination Mode
Specifies the destination, which can be the to point or a point to mirror about.
8. Click OK on the dialog box, and then click Finish on the ribbon.
You cannot use the Mirror Copy command on hangers and supports objects.
To select objects for this command, you can use a filter, fence, or directly select the
object within a space. If objects already are selected and you select the Mirror Copy
command, the selected objects are the select set.
If you set the destination mode to Point to Mirror About and the direction of the mirror
plane to an option other than Plane by From-To Vector, the software does not require
the From Point designation. The To Point command starts automatically.
If errors occur, the software tracks these discrepancies and records them in the View >
To Do List. Possible errors concern flow direction and listing of left- and right-handed
parts. For example, if you mirrored a piping configuration and connected it to another
object with a different flow direction, the software would report an error. Also, left- and
right-handed parts must appear correctly on parts lists.
Based on reference data settings (the option Component must be replaced rather
than mirroring, rotating, or copying is in the mirror behavior select list), you can
replace a part with another part listed in the part properties data. If the replacement part
is not available for the active specification, the command continues with the original part
rotated but not mirrored.
Properties of the modified objects match the original objects with some exceptions.
Standard revision and status properties are updated. The software updates named
objects, based on the name rule (that is, the software does not update the named
object if you defined the name rule, while the software does update the named object
for system-defined name rules). The software automatically updates properties that
track location or orientation.
If you select the same point for the Move From position (or origin) and the Move To
point, the software displays a message that prompts you to select a different Move To
point. However, if you must specify only one point, you can complete the Mirror Copy
command using the Point to Mirror About option in the Destination list and select a
plane in the Direction list.
If errors occur, the software tracks these discrepancies and records them in the View > To
Do List. Possible errors concern flow direction and listing of left- and right-handed parts. For
example, if you mirrored a piping configuration and connected it to another object with a
different flow direction, the software would report an error. Also, left- and right-handed parts
must appear correctly on parts lists.
Based on reference data settings (the option Component must be replaced rather than
mirroring, rotating, or copying is in the mirror behavior select list), you can replace a part
with another part listed in the part properties data. If the replacement part is not available for
the active specification, the command continues with the original part rotated but not
mirrored.
Update Names
Updates objects with name rules that are not automatically updated. You use this command
when an object is moved to a different naming parent, causing a change in the relationship or
hierarchy within the model.
For example, a pipeline is the naming parent for a weld. The name of the weld is the same as
the pipeline it is in.
However, if the pipe run that holds the actual weld object in the system hierarchy is moved to a
different pipeline. The weld name does not know to update because it does not know the
change occurred.
You run Edit > Update Names to update the names automatically. The weld name updates to
reflect the new pipeline to which it is associated.
Update Names
1. Select objects that need to be updated.
2. Select Edit > Update Names.
The selected objects are updated according to their name rules.
Properties
Edits the properties of a selected object. If you select multiple objects, you can edit only the
properties shared by the group.
You can edit the properties of a selected object from any task. The occurrence and definition
properties of these objects are defined in the Catalog database and the specific values of these
properties, such as relationships, are stored in the Model database. The Properties dialog box
for each object type can be different, but most dialog boxes have the following in common:
Grids with controls
An OK, Cancel, and Apply button
Notes, Relationship, and Configuration tabs
The grid controls typically display catalog-defined properties for the selected object. Most
information in the grids is read-only, but you can modify information in the grid on the
Occurrence tabs. While the Properties dialog box is open, you can select other objects in the
workspace. When you select another object, the edit ribbon for that object appears, and the
content of the Properties dialog box shows the values of the new selection.
Transferring Ownership
In a global workshare configuration, you can re-assign ownership of model objects from their
current permission group to another satellite or host permission group using the Transfer button
on the Configuration tab.
The following rules exist for this functionality:
Only the location that currently owns the object can transfer its ownership of the object to
another location. A location that does not have ownership of an object cannot directly take
ownership of an object from another location.
To transfer ownership from one location to another, you must have physical write permission
on the current permission group and virtual write permission on the target permission group.
Virtual permission means that if location were not a factor, you would have write access to
that permission group. The host location must set up permissions for each of the satellite
locations ahead of time.
Edit Properties
1. Select one or more objects to edit.
2. Click Edit > Properties.
3. Select the tabs that contain the properties to edit.
4. Edit the properties as needed.
5. Click Apply.
You must have physical write permission to the permission group where the objects
currently reside.
You cannot undo the transfer of ownership.
The other location receives the change when the database replication process for the
objects takes place.
Notes Tab
Creates and edits user-definable text placed by the designer on an object in the model. The
notes provide special instructions related to the object for the fabricator and are available in
downstream tasks. For example, the notes appear in two-dimensional drawings and within
design review sessions.
Only one note of a given kind from a given object can be shown on a drawing. For
example, if there are two fabrication notes on a piping part, then only one of the notes shows on
the drawing. It is important to know about and to consider this situation when defining notes on
an object in the modeling phase. For example, you can display one Fabrication note and one
Installation note by defining two separate labels for the two kinds of notes.
Key point
Specifies the key point on the object to which you want to add a note.
Notes at this location, listed by name
Lists all notes for the selected key point on the object.
Date
Displays the date that the note was created. The system automatically supplies the date.
Time
Displays the time that the note was created. The system automatically supplies the time.
Purpose of note
Specifies the purpose of the note.
Author
Displays the login name of the person who created the note. The system automatically
supplies this information. You cannot change this information.
Note text
Defines the note text. The software does not limit the length of the note text.
Show dimension
Indicates that the note generates a dimension.
If you are displaying the properties for a Support component, then a dimension can be
included for the component in the Support drawings, if you select the Show dimension
option. The note must be associated with one of the key points for the Support component.
It is recommended that you set the Purpose of note as Fabrication, but this is not a
requirement. The note Name and Note text are not used when you select this option.
New Note
Creates a new note on the object.
Standard Note
Displays a list of standard notes from which you can select. This feature is not available in
this version.
Highlight Note
Highlights the note in the graphic view so that you can easily find the note and the object to
which it is related. This feature is not available in this version.
Delete Note
Deletes the currently displayed note.
Relationships Tab
Displays all objects related to the selected object for which you are viewing properties. For
example, if you are viewing the properties of a pipe run, the related pipeline, features, parts,
associated control points, hangers or supports, and equipment display on this tab. All WBS
assignments, including project relationships, appear on this tab.
Configuration Tab
Displays the creation, modification, and status information about an object.
You cannot define the filters using the Configuration tab.
Model
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the object belongs. You can select another
permission group, if needed. Permission groups are created in Project Management.
Transfer
Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group. This option is only available if the active model or
project is replicated in a workshare configuration. The option is not available if all of the
objects in the select set already belong to another location and are non-transferable. For
more information, see Transfer Ownership Dialog Box in the Common User's Guide.
Approval State
Specifies the status of the selected object or filter. The display depends on your access
level. You might be unable to change the status of the object. The list is defined by the
ApprovalStatus codelist.
You can only edit or manipulate an object with a status of Working.Status
Specifies the location of the object in the workflow process. Changing this property sets the
Approval State. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file. For more information, see
ApprovalReason in the Reference Data Guide.
Date Created
Specifies the creation date of the object.
Created by
Specifies the name of the person who created the object.
Date Last Modified
Specifies the date of the last modification to the object.
Last Modified by
Specifies the name of the person who last modified the object.
Go to Hyperlink
Displays a file or a web page associated with an object in your model. This command opens the
appropriate software for viewing the file or web page. For example, if the hyperlink is
file://computer/folder/file.bmp, this command launches the software your system associates
with the .bmp file extension. If your computer does not have the necessary software to open the
target file of the hyperlink, you are prompted to select an application in which to open it. If you
select an object that does not have a hyperlink associated with it, the Go to Hyperlink
command is not available.
You can use the Insert > Hyperlink command to create, edit, and unlink hyperlink addresses
attached to objects in a workspace. Hyperlinks are stored in the Site database so that any user
working with that object can access them.
Follow a hyperlink
1. Select an object in your workspace.
2. Click Edit > Go to Hyperlink.
View Menu
The View menu provides commands for clipping views, managing views, applying view styles,
and displaying viewing tools. Some of the commands on this menu might change depending on
the active task.
You can manipulate the windows and views in the software to affect the way you see the model.
For example, you can compare a window to a camera. When you look through the camera lens,
you see a real-world view of the objects in the database. You can change the view by zooming
in and out, and focusing on different parts of the model. You can also zoom or pan views.
With the commands on the Window menu, you can create and arrange new windows that allow
you to see more than one section of a model. You can minimize and maximize open windows in
the software.
A view consists of the contents of a window in the software. Using the commands on the View
menu, you can quickly manipulate the views of the model.
In This Section
Clipping ......................................................................................... 184
Active View Control ....................................................................... 196
Previous View ............................................................................... 200
Next View...................................................................................... 200
Named Views................................................................................ 201
Common Views ............................................................................. 203
View by Points .............................................................................. 205
Rotate View .................................................................................. 209
Look at Surface............................................................................. 214
Viewing Your Work ....................................................................... 215
Workspace Explorer ..................................................................... 243
Rulers ........................................................................................... 264
To Do List ..................................................................................... 264
Clipping
The Clip by Object and Clip by Volume or Plane commands isolate objects or
portions of objects you need for more detailed modeling or viewing. When you use the clipping
commands, the software displays only the identified volume or objects in the active view.
However, you can also display the clipped volume or objects in additional views.
Objects connected to a rotated coordinate system are clipped according to the global
coordinate system.
Clip by Object (on page 185) fits the active view to selected objects while hiding all
non-selected objects or to objects bounded by selected objects. For example, if you select a
valve and a pump, the Clip by Object command also includes the pipe that connects the pump
and valve in the active view.
Clip by Volume or Plane (on page 187) sets the view clipping volume by entering two area
definition points (the cross section of the volume) and two depth points (the extent of the
volume). The Clip by Volume or Plane command also lets you edit the clipped volume by
dragging clipping planes.
Clear Clipping (on page 195) restores all hidden objects to the view in the active window.
You must use Clear Clipping before you can isolate another object or volume by clipping.
Clip by Object
Isolates an object or group of objects in your model for closer viewing or more detailed work.
If you have already selected the objects when you click Clip by Object , the clipped objects
immediately appear in the active view. The clipping planes are positioned according to the active
coordinate system, rather than the global coordinate system. Objects connected to a rotated
coordinate system are clipped according to the global coordinate system. To restore the view,
click Clear Clipping (on page 195) .
Below is a selected pump before clipping.
After clipping, only object bounded by the selected objects, in this case the pump, display in the
active view. You can click Select View on the Clip by Object ribbon to apply the clipping to
additional views.
Select Objects
Specifies the objects to clip such as pipes, equipment, duct, and so forth. The objects define
the clipping boundaries. If you have already selected objects before selecting the Clip by
Object command, you can proceed by accepting the selected objects or add more
objects to the select list.
Select View
Selects and applies the clipping to windows other than your active window. The clipping
boundary based on the selected objects is applied to each view you select.
Reject
Clears the objects you select with the Select Objects command. Use this command when
you want to start over. This button is not available when the Select View button is active.
Accept
Hides all objects except the selected objects in the active view. This button is not available
when the Select View button is active.
Close
Displays the clipping in the active view, completes the Clip by Object command, and
returns you to the last command you used before you selected Clip by Object .
Fit View
Controls whether to fit the view to the graphics when you run the Clip by Object command.
By default, the Fit View option is checked, and the command clips the view and fits the view
to the graphics. If the option is off, the command only clips the view but does not fit the view
to the graphics. A change to the option setting takes effect the next time you run the
command.
Objects connected to a rotated coordinate system will be clipped according to the
global coordinate system.
Clip by object
1. Click View > Clip by Object.
2. Click the object you want to clip.
You can also drag a fence around a group of objects or press CTRL as you click
multiple objects you want to clip in the view.
3. Click Accept .
4. Click Close.
Clip by volume
1. Click View > Clip by Volume or Plane.
2. Click Clip by Volume .
5. Select the first depth point to define the extent of the volume. You can see depth points best
in an isometric view.
6. Select the second depth point to define the extent of the volume. You cannot clip objects to
a zero depth.
8. Click Finish.
You can modify the view volume of all selected windows by dragging the clipping planes.
The movement is normal to the plane. The software assigns the edited clipping volume to
the active view and to all views selected after you start the command.
To restore the view, click Clear Clipping .
The clipping planes are positioned according to the active coordinate system, rather than
the global coordinate system.
Clip by plane
6. Click Finish.
You can modify the view volume of all selected windows by dragging the clipping planes.
The movement is normal to the plane. The software assigns the edited clipping volume to
the active view and to all views selected after you start the command.
To restore the view, click Clear Clipping .
The clipping planes are positioned according to the active coordinate system, rather than
the global coordinate system.
Clear Clipping
Restores the view to its original state by displaying any objects in the view that were hidden
by the Clip by Volume or Plane (on page 187) or Clip by Object commands. Use this
command to restore the view before you define a new clipping volume or object.
Below shows a pump that was clipped using Clip by Object (on page 185).
Below shows the same pump after using the Clear Clipping command.
To display objects hidden by clipping in other windows, click the additional windows. To end
the Clear Clipping command, right-click a view, press ESC, or click another command.
You can also click Clear Clipping on the main toolbar.
Top View , Side View , and Front View change the vantage point.
The Pan , Zoom Tool , and Zoom Area buttons allow you to move to another
part of the view or enlarge certain parts of the model.
4. Drag the Target / Focus Point in the dialog box view to change the camera angle and
the clipping orientation in the active graphic view.
5. Drag clipping boundaries to change the clipping in the active graphic view.
Ribbon Commands
The following commands control display of objects in the Active View Control dialog box, but
do not affect the active graphic view.
Top View
Displays objects in the dialog box from above. When selected, Top is displayed in the dialog
box title.
Side View
Displays objects in the dialog box from the side. When selected, Side is displayed in the
dialog box title.
Front View
Displays objects in the dialog box from the front. When selected, Front is displayed in the
dialog box title.
Pan
Moves objects in the dialog box up, down, left, or right so you can see other areas of the
model. The pointer appears as a hand when this command is active.
Zoom Tool
Changes the display size of objects in the dialog box. The pointer appears as a magnifying
glass when this command is active. Move the pointer up to zoom in, and down to zoom out.
Zoom Area
Increases the display size of objects in the dialog box. Click and hold the left mouse button
to drag a fence around an area. The dialog box view zooms in to that area.
Fit
Fits all visible objects in the dialog box. The clipping box and the camera location are
ignored.
Fit to Camera
Fits all visible objects, the clipping box, and the camera location in the dialog box.
Always on Top
Keeps the Active View Control window on top of all other windows.
/ Shade/Wireframe Mode
Toggles object display in the dialog box between solid shaded objects and wireframe
outlines of the objects. Wireframe is the default display.
Graphic Icons
The following icons appear in the Active View Control dialog box and control display of the
active graphic view.
Camera / Eye Point
Position of the camera or eye point in the active graphic view. You usually do not move the
camera.
If the active graphic view is isometric, then the clipping box is a cube:
You can drag the clipping boundaries to change clipping in the active graphic view.
The clipping boundary orientation changes as you move the Target / Focus Point
.
See Also
Active View Control (on page 196)
Previous View
Replaces the current view with the previous view, similar to the back command in your internet
browser. Smart 3D remembers up to 10 previous or next views for every graphic window. This
command can restore only view properties for scale and orientation. This command has no
effect on display operations (such as the Show and Hide commands), styles, or other view
properties. The shortcut key for Previous View is ALT+F5.
When 10 view modifications have been made, any subsequent view modifications result in the
oldest view modification step being erased to make room for the newest modification.
When you use the View > Named Views command, you are recalling a saved view and
applying it to the active window. This action differs from restoring a view using the View >
Previous View command because the previous view does not have to be a saved view. If you
exit a session file and then open it again, the previous view is unavailable unless it was saved.
When you use the View > Navigate View command, any view modifications that occur are
captured as a single view modification step. For example, if you click View > Previous View
after exiting the Navigate View command, the last view prior to the Navigate View changes is
restored.
Next View
Replaces the current view with the next view. This command is unavailable until you use
Previous View at least once and works similarly to the forward command in your internet
browser. Smart 3D remembers up to ten previous or next views for every graphic window. Next
views are abandoned when a change is made to the view. For example, if you click Previous
View four times, there are four Next views available until you edit the view. This edit erases all
the saved Next views. This command can restore only view properties for scale and orientation.
It has no effect on display operations (such as the Show and Hide commands), styles, or other
view properties. The shortcut key for Next View is ALT+SHIFT+F5.
When ten view modification steps have been made, any subsequent view modifications result in
the oldest view modification step being erased to make room for the newest step.
When you use the View > Named Views command, you are recalling a saved view and
applying it to the active window. This action differs from restoring a view using the View >
Previous View command because the previous view does not have to be a saved view. If you
exit a session file and then open it again, the previous view is unavailable unless it was saved.
When you use the View > Navigate View command, any view modifications that occur are
captured as a single view modification step. For example, if you click View > Previous View
after exiting the Navigate View command, the last view prior to the Navigate View changes is
restored.
Named Views
Assigns a name and description to a view so you can apply the settings later to the active
window. A saved view contains all view information required to restore the view volume, eye
point, and target point. However, a saved view does not define the perspective angle of the view
or its rendering characteristics. Additionally, if you want to rename a view, change the
description, delete the view, or even change the settings that make up a view, those tasks can
be accomplished from the Named Views Dialog Box (on page 203).
Default views include Top, Front, Right, and Isometric. You can access these views by
clicking the down arrow beside the Named Views button on the main toolbar.
Save a view
1. Click a view to make it active.
2. Click View > Named Views.
3. In the blank line indicated by an asterisk, type a name and description for the saved view.
Named views are useful for resetting the view after you have used other commands to
change the way you see the area. For example, if you change the angle from which you are
viewing an area, or change the magnification to see a particular object more clearly, you can
then select a named view to quickly return to a standard set of view settings without
changing each setting one at a time.
Common Views
Displays a two-dimensional or isometric orientation of objects in the active view. The
command opens the Views dialog box, which displays a three-dimensional outline box. This box
consists of white circles on each corner and three white arrows that point to the faces. Each
corner circle, arrow, or face of the box highlights in yellow as you pause the pointer over it. You
can select one of the six faces of the 3D box to change your view to a 2D view, or you can
select one of the eight corner circles to change your view to an isometric view. A message at the
bottom of the dialog box indicates the direction or type of your selection, such as Plan,
Isometric, and so forth.
The text at the bottom of the Common Views dialog box provides a description of the view that
you select.
View by Points
Provides options for specifying the view plane by three points or along a line. When you
select View > View by Points, a ribbon with two options appears.
View by 3 Points
Creates a plane based on three points you choose. This plane is parallel to the view plane,
which can be thought of as the computer screen. This is the default option.
4. Click to designate point 2. Points 1 and 2 form a vector in the view plane.
The three points form a plane that is parallel to the view plane.
4. Click to designate point 2. This point is the To point, and it forms a vector with point 1.
After you place point 2, the software adjusts your line of sight into the model to go through
the two points you placed.
Rotate View
Rotates or turns a view freely about a point or about an axis parallel to one of the axes in the
global coordinate system. Unlike Common Views (on page 203) that only allows you to
rotate a view by a predefined set of points, this command allows you to rotate the view in any
direction. The rotation graphic is shown as a dashed green triad in the view with the selected
rotation axis in red (the default highlight color).
Angle
Specifies the degrees about the selected axis to rotate the view. Type the value in the box,
and press ENTER. When you rotate a view with the mouse, you can use the Angle box to
monitor the current angle of rotation. Positive rotation is clockwise, and negative rotation is
counter-clockwise.
Locate Objects
Locates the graphic objects in the view. When Locate Objects is ON, the view rotates
around a selected object. When Locate Objects is OFF, the view rotates around the
selected axis line.
Move Point of Rotation
Allows you to select a point or a line of rotation. Click Move Point of Rotation, and then
select any point or line in the view about which to rotate.
Close
Closes the Rotate View command and the ribbon. If another command was active when
you clicked Rotate View, that command resumes.
You can rotate a view at any time, even when you are using another command.
2. Define a focus of rotation by pausing the pointer over one of the axes on the rotation graphic
to highlight and accept it as shown in the graphic.
4. If you want a specific degree of rotation, type a value in the Angle box on the Rotate ribbon,
and press ENTER.
5. Right-click to end the command, or click Close on the ribbon.
When you end the Rotate View command, the previous command and its ribbon,
if any, resumes.
4. Drag over the axes of the rotation graphic to rotate the view about the new center point.
When you end the Rotate View command, the previous command and its ribbon,
if any, resumes.
2. Select a linear object in the model and drag your cursor to start the rotation.
The linear object that you rotate around can be a pipe run, duct run, or cableway
run, or a grid line or structural member, for example.
3. If you want a specific degree of rotation, type a value in the Angle box on the Rotate ribbon,
and press ENTER.
Look at Surface
Defines a view of any surface in the model. When you select a surface or reference plane, the
selected surface appears in the front and is displayed as two-dimensional. The E-axis (X-axis)
and N-axis (Y-axis) maintain an orientation that is related to the active coordinate system. This
command allows you to bring a selected surface to the front.
Look at a surface
1. Click View > Look at Surface.
2. Select a surface or reference plane in a view.
Navigate View
Starts 3D navigation in the active window. Smart 3D provides several ways to navigate
through your 3D model data so that you can pick a scheme that is most comfortable or familiar
to you. There is a fly mode navigation that provides a fluid, multi-directional motion for moving
and looking around the model.
When you enter 3D navigation, the current model view (defined in the Format View
settings) automatically changes to a Perspective projection mode with a Smooth Shaded
render mode. The current aspect setting does not change. For 3D navigation, a perspective
view shows the three dimensions of an object and provides a more real-life representation of
objects because it conveys depth. The further the object surface is from the eye, the smaller
it appears in the view. When you exit 3D navigation, the view switches back to the original
Format View settings.
The camera focal point is determined by the view depth of the object closest to the screen
center point when entering or exiting 3D navigation. The focal point of 3D navigation is the
center point of the display window. When you enter and exit 3D navigation and the view
transitions to and from perspective projection mode, the center focal point stays in the same
location. However, objects that were not at the center of the window could display closer or
further away. To make the projection mode transitions appear smoother, you can modify the
view so the object of interest is at or near the center focal point when entering and/or exiting
3D navigation.
When you use 3D navigation, the Next View and Previous View commands do not record
the view changes. The Next View and Previous View commands only remember the state
of the view before and after the 3D navigation changes.
You can enable 3D navigation in each window you have open. After you click Navigate
View, the 3D Navigator displays in the active window. When you click on another window
with 3D navigation still enabled, the 3D Navigator moves from the previous window to the
currently-selected window.
The Navigate View command always sets the current tilt angle to 0 when it is enabled. The
system does not restore the previous tilt angle when 3D navigation is turned off. To get back to
the rotated view you were using before entering 3D navigation, select View > Previous View.
3D Navigation Controls
Select navigation controls that are most comfortable or familiar to you. To access
navigation-specific help at any time, press Q or click Help in the 3D Navigator. To access
additional product help, press F1 or go to the Help menu.
Application-Specific Information
The 3D Navigator component is integrated into the following Intergraph Process, Power &
Marine applications:
Intergraph Smart™ 3D
SmartPlant Review
SmartPlant Construction
SmartPlant Markup Plus
Any information or behavior that is specific to an application is noted. If your application is not
listed, then there is no additional information.
See Graphics Card Information (on page 230) for the basic requirements needed for 3D
navigation.
You can press and hold the 3D Navigator Look and Move controls for continuous motion.
Press and hold the center Move control to drag the 3D Navigator to a different location
on/off the view window.
To... Use...
Move in W
Move Left A
Move out S
Move right D
Move up E
Move down C
To move or walk through your model in a first-person perspective. Press and hold the
designated direction key. Move left and right is a sidestepping motion.
To... Use...
Walk at various angles through your model. Hold down the needed two direction keys
simultaneously.
To... Use...
Look up I
Look left J
Look down K
To... Use...
Look right L
Look around the model as if you were turning your head. Simply move the mouse
up/down, left/right from the crosshair point.
To... Use...
Press the H key if you are 'lost' in the model or need to return to the default model view.
Application-Specific Information
Smart 3D Fly Mode Information
When you exit Fly mode, right-click or press ESC twice to exit 3D navigation.
SmartPlant Construction Fly Mode Information
To encircle or rotate around a selected object, use the SmartPlant Construction Encircle
Model command in the Toolbox. In SmartPlant Construction, you will not be able to use the
left-mouse drag operation to encircle objects.
Exit fly mode, cancel all fly F again (Toggle on/off), ESC or
mode operations right-click
Enter and exit fly mode to use mouse and keyboard combination navigation controls.
To... Use...
Move left A
Move right D
Move up E
Move down C
Walk through your model in the direction of the crosshair. Roll the middle mouse wheel
forward and back, or press and hold the designated WASD key. A left or right move is a
sidestepping motion.
A middle mouse click moves you halfway in to your target point. Use SHIFT + middle mouse
click to move back out the distance of the eye point from the target. The perspective angle
does not change.
To... Use...
To... Use...
Walk at various angles through your model. Roll the mouse wheel forward and backward
while holding down the designated direction key. Or, hold down the needed two direction
keys simultaneously.
In a key combination move, if you release one directional key, you still continue
moving in the direction of the other key.
Press and hold the middle mouse button to side-step left or right. This enables you to move
the model without changing the direction in which you are looking.
To... Use...
Look around the model as if you were turning your head. Simply move the mouse up/down,
left/right from the crosshair point.
To... Use...
Press the H key if you are 'lost' in the model or need to get back to a known view.
To... Use...
When rotating around an object, the encircle point is the current center point; not the center of
the selected object.
Application-Specific Information
Smart 3D Navigator Information
To start 3D navigation in Smart 3D applications, press CTRL+SHIFT+F, or click Navigate
View on the main toolbar.
Select on the 3D Navigator is not available. To select an object, navigate to the required
location in your model and click Navigate View to disable the 3D Navigator. Click Select on
the Smart 3D toolbar to select objects. Use Smart 3D commands to perform required
operations.
When you right-click to end fly mode, right-click again to exit 3D navigation.
The Close button on the 3D Navigator removes it from the display. You can still use the
keyboard for navigation.
3D Navigator Controls
Quick Help - Displays help specific to 3D navigation.
Home (Default View) - Returns to the startup view of the model. You can also create your
own home view.
Fly Mode - Enters Fly mode where you use the mouse and/or keyboard to interactively
move and look through the model. When you are in Fly mode, the 3D Navigator does not
display, and your cursor changes to a crosshair located at the center of your view. You can
press F or ESC to exit Fly mode. The 3D Navigator then displays at its last position.
Look - Changes your view direction as if you were turning your head. You can look around
in all directions.
Move In/Out - Takes you closer to or further away from model objects.
Move (Up/Down/Left/Right) - Changes your position in the model at the crosshair cursor
level as if you are 'walking' around in the model. You can move in any direction.
Fit - Places all visible elements in the view window if no objects are currently selected. If any
objects are selected, the control zooms to the selected objects.
Select - Turns Select mode on and off (not available in the Smart 3D applications).
After you move your cursor off of the 3D Navigator, it fades into a transparent shadow so that it
does not distract from the current view. The 3D Navigator reappears when you move the cursor
back over it. You can select and move the 3D Navigator to place it wherever you want in or out
of your view window. To use the 3D Navigator, just click on the needed action. A single click
causes short movements while a click + hold action on the look and move controls enables you
to move continuously.
While you are using 3D Navigator controls, you can use the following mouse operations:
Mouse wheel forward/backward
Middle-mouse drag to move sideways and up/down in the model.
You can also use the keyboard in conjunction with the 3D Navigator to move in one direction
while looking in another. This can simulate walking through the plant as you are looking on
either side.
The 3D Navigator controls are synchronized with the mouse and keyboard movements to
display the current move or look action. For example, if you are pressing W to move in, the
Move In button in the 3D Navigator is highlighted.
When you are in Fly mode, the 3D Navigator does not display.
Application-Specific Information
Smart 3D Fly Mode Information
When you exit Fly mode, right-click or press ESC twice to exit 3D navigation.
Look Around
Press and hold any of the four Look controls to continuously look or turn in that direction as if
you were turning your head. Use the Look control in the 3D Navigator to look around from your
current position in the model.
Move
Move vs. Zoom: a Move operation changes the eye point as you get closer or further from the
target. A Zoom operation is a perspective angle change.
Use the Move controls in the 3D Navigator to walk smoothly in left/right/up/down directions.
Use Move In/Out controls to get closer to or further away from model objects. The
perspective angle does not change during a move operation.
Press and hold any of the Move controls to continuously move in that direction.
As you move through the model, the closer you get to your target, the slower the movement
rate becomes. The further away from the target, the faster the movement rate.
The Move operations enable you to move through solid objects such as walls, doors and
slabs.
Fit to Object(s)
The Fit tool places all visible objects in the active view if no objects are currently selected. If any
objects are selected, the command zooms to the selected elements. Because the display is
adjusted independently of the current view orientation, the objects in that display area are not
clipped when performing rotate operations.
In addition, the Fit tool zooms or fits to any objects that were selected before running
3D navigation.
Application-Specific Information
SmartPlant Review Fit Behavior
In SmartPlant Review, the Navigator Fit command is a conditional fit. It performs a fit based on
the objects that are selected.
Fits to the selected object.
Fits to selected item(s) in the SmartPlant Review Project Manager.
Fits to the whole model and any visible objects.
1. Select one or more objects in the current view.
If no objects are selected, the system fits all objects into the current view.
You can also perform a SHIFT + Fit operation that enables you to view the entire
selected object within the current window size. Any rotation operations later performed
in that view do not clip the selected object.
3. When you perform a Fit operation, you can continue selecting other objects as well as
moving from the fitted location.
3D Navigation Tips
Motion Tips
As you move through the model, the closer you get to your target, the slower the movement
rate becomes. The further away from the target, the faster the movement rate.
The Move operations enable you to move through solid objects such as walls, doors and
slabs.
Press ESC to end a navigation operation.
To make small left/right/up/down movements, click and hold the middle mouse button as
you move in the needed direction. It can sometimes be difficult to make small movements
with the mouse and keyboard because the distance of motion for each key press is greater
than what is needed. This is especially true when you are close to objects within the 3D
model.
Application-Specific Information
Smart 3D Navigation Tips
The Navigate View command always sets the current tilt angle to 0 when it is enabled. The
system does not restore the previous tilt angle when 3D navigation is turned off. To get back to
the rotated view you were using before entering 3D navigation, select View menu > Previous
View.
Fine Tuning/Customization
You can change the Repeat Delay and Repeat Rate keyboard settings to fine-tune your
keyboard motion during navigation. For more information, refer to your operating system's
documentation on setting keyboard properties.
Messages
The color scheme has been changed to [Windows 7]. A running program isn't compatible
with certain visual elements of windows.
Meaning: This message may display when you open a 3D model. To correctly display the
cross hair (in fly mode) as well as support all capabilities of this operating system, the
application automatically unchecks the Enable desktop composition setting. This setting is
in Control Panel > System > Advanced system settings > Advanced tab > Performance
Settings > Visual Effects.
Recovery: If you click to see more information on the message, the Windows information
dialog box displays. Check the Don't show me this again option if you do not want the
above message to display each time a 3D model is opened.
Minimum Recommended
(for systems with large
models)
Troubleshoot 3D Navigation
Graphics Card Troubleshooting
You do not see graphics in the window display of a dual-monitor setup when using an
ATI V3600 FireGL (driver ver. 8.62 released on 7/21/2009) card.
Follow the steps below to configure graphics card.
1. Select Start > Catalyst Control Center.
2. Select Workstations > Settings.
3. Click Shared Front/Back/Z Dual Screen Mode.
4. Click OK and then exit the application.
5. Reboot your system.
3. Click Effects and select Scroll Effect under the Use the following transition effect for
menus and tooltips setting.
General Messages
The color scheme has been changed to [Windows 7]. A running program isn't compatible
with certain visual elements of windows.
Meaning: This message may display when you open a 3D model. To correctly display the
cross hair (in fly mode) as well as support all capabilities of this operating system, the
application automatically unchecks the Enable desktop composition setting. This setting is
in Control Panel > System > Advanced system settings > Advanced tab > Performance
Settings > Visual Effects.
Recovery: If you click to see more information on the message, the Windows information
dialog box displays. Check the Don't show me this again option if you do not want the
above message to display each time a 3D model is opened.
If your driver does not allow changes (as shown in the above image), you may
have to contact your video card manufacturer for instructions on turning on/off hardware
acceleration.
Zoom Tool
Increases or decreases the display size of objects in the model. You can zoom in to get a
closer view of an object or zoom out to see more of the model at a reduced size. Click the left
mouse button and drag the pointer upward in the window to increase the view of an object as
though you were moving closer to it. Drag the pointer downward in the window to reduce the
view as though you were moving farther away from the object.
When you use the Microsoft IntelliMouse® pointing device with the Zoom Tool, you can zoom in,
zoom out, zoom area, and pan, all with a click of the mouse.
In the table below, "middle" can mean either the middle mouse button or the wheel
button.
When you do this while Zoom Tool The view does this:
is active:
Middle-click Zooms in 2x
Rotate wheel forward or backward Zooms in or out at the current pointer location
Zoom in
1. Click View > Zoom Tool, or click Zoom Tool on the main toolbar.
2. Click a starting point and drag upward in the window to increase the view size of an object in
the active window.
The shortcut key for the Zoom Tool command is CTRL+SHIFT+Z. The shortcut key for the
Pan command is CTRL+SHIFT+P.
Click View > Previous View to return the screen to its original view. The shortcut key for the
Previous View command is ALT+F5.
Zoom out
1. Click View > Zoom Tool, or click Zoom Tool on the main toolbar.
2. Click a starting point and drag downward in the window to reduce the view size of an object
in the active window.
The shortcut key for the Zoom Tool command is CTRL+SHIFT+Z. The shortcut key for the
Pan command is CTRL+SHIFT+P.
Click View > Previous View to return the screen to its original view. The shortcut key for the
Previous View command is ALT+F5.
Zoom Area
Magnifies an area of the model. Click and drag to create a fence around an object or area of
the model that you want to enlarge.
Magnify an area
1. Click View > Zoom Area. The pointer changes to a crosshair in the graphic view.
2. Click a start point and drag to an end point in the active view to fence the area to enlarge.
You can also click two separate points to fence an area.
When you release on the end point, the graphic view updates to show the selected area.
You can also activate this command by clicking Zoom Area on the main toolbar.
Click View > Fit to see all objects in the active workspace again.
Click View > Previous View to return to the previous view. The shortcut key for the
Previous View command is ALT+F5.
You can also click Zoom Tool and then click (not drag) to enter two points to zoom an
area. A dynamic fence appears after you click the first point. Used this way, the Zoom Tool
command operates the same as the Zoom Area command.
Fit
Fits the selected objects in the active view. If there are no selected objects, this
command works like SHIFT + Fit and fits all visible objects in the workspace in the
active view.
If you select any objects before clicking Fit , the software fits only the selected objects in
the view. In this situation, the software fits all objects, including those marked as Hidden in
the Workspace Explorer, or those clipped from the view.
Press CTRL + Fit to display the selected objects in all open graphic views.
Click Fit to display all of your selected objects in the active view.
Press SHIFT and click Fit to display the visible objects in the active view.
Press CTRL and click Fit to display the selected objects in all views.
Press SHIFT + CTRL and click Fit to display all visible objects in all views.
None of these combinations cancels any previous command. When the software finishes
the fit, it returns to the previously active command.
Press ALT + F5 to return to the previous active view.
Pan
Moves the view up, down, left, or right to let you see other areas of the model. The pointer
displays as a hand when this command is active.
Pan views
1. Click View > Pan, or click Pan on the main toolbar.
2. Click and drag a point in the view to a different position.
The shortcut key for the Pan command is CTRL+SHIFT+P. The shortcut key for the Zoom
Tool command is CTRL+SHIFT+Z.
You can also use this feature without dragging by clicking on a point in the window, and then
clicking again where you would like to place the first point that you clicked.
To stop the repainting of objects in the window, right-click or press ESC. This option is
convenient if you are working with a large workspace. To refresh the window, press F5.
To exit the command, right-click or press ESC.
Applying Styles
The style type determines the type of object to which you can apply a style. The software
applies styles automatically, and you can change the styles that apply to objects.
In the Drawings and Reports task, you can apply a text style to text. You can apply a fill style to
a fill and a line style to lines, arcs, circles, and ellipses. You can apply a dimension style to
dimensions or text balloons.
In the design tasks, you can apply view styles to three-dimensional views of a model. You can
also apply surface styles to the faces of objects.
To define a view style, click Format > Style, and then click New on the 3D View tab. To
modify an existing style, select it on the 3D View tab, and click Modify. For more
information, see Format View (on page 307).
You can also apply a style to the active view by clicking Format > Style and then clicking
Apply on the 3D View tab.
Workspace Explorer
Displays and hides the Workspace Explorer window. The Workspace Explorer displays the
contents of the workspace in a classification hierarchy that reflects the various relationships
defined for the design objects. The content represents the current objects loaded from the
database into the active workspace.
System tab
Displays all the objects in the workspace according to the hierarchy of the system. Usually,
the model is the first system and subordinate systems can include anything that is in your
workspace definition, such as piping or equipment. You can change the owning object for a
System object by selecting More in the System box on the ribbon that appears when you
select an object.
Assembly tab
Displays all the objects in the workspace, grouped by assemblies.
Space tab
Displays all the volumes in the workspace.
Work Breakdown Structure (WBS) tab
Shows the objects in the workspace grouped by project, contract, area, and so forth.
Analysis tab
Displays the structural analysis models in the workspace. An analysis model is a
non-graphical and logical grouping of member systems that can be sent to a third- party
analysis and design solver package.
Reference tab
Displays the files attached in the workspace. This tab appears after you attach a file by
clicking Insert > File. For more information, see Insert File (on page 273).
PDS tab
®
Displays the PDS (Plant Design System) data in the workspace. This tab appears on client
machines that have a PDS Data Access component installed, and after the administrator
attaches a PDS Project using New PDS Model Reference command in Project
Management.
Reference 3D tab
Displays hierarchy of Reference 3D projects and files attached as well as their objects in the
workspace. This tab appears after administrator attached a R3D Model by using New R3D
Reference command in Project Management.
Drawings tab
Displays the drawings related to the workspace. For more information, see Drawing Console
(on page 441)..
The Workspace Explorer view allows you to identify or select objects or sets of objects by
name. Icons appear at the left of the window objects to indicate the type of the object. For
example, a file folder icon represents a system, an equipment icon represents equipment, an
I-beam icon represents a structural system, and so forth. Point to objects in the Workspace
Explorer to highlight them, and click objects to select them. If you hide objects using the Tools
> Hide command, the object names appear in italics. For more information on hiding objects,
see Hide (on page 386).
If you are in the Drawings tab, and you select objects in the Workspace Explorer,
the objects are not highlighted in the model. To find an object in the model, select an object and
press ENTER.
If you pause the pointer over an object in the Workspace Explorer, the object is highlighted
with the highlight color in the graphic view and in the Workspace Explorer. If you pause the
pointer over an object in a graphic view or in the To Do List dialog box, the object is highlighted
with the highlight color in the Workspace Explorer. However, if you select certain objects such
as features in a graphic view, they do not highlight in the Workspace Explorer (because
features do not appear in the Workspace Explorer). Foundation ports also do not appear in the
Workspace Explorer, but nozzles do.
If you select an object in the Workspace Explorer, it appears highlighted with the select color in
the graphic view. However, if you are in the Drawings tab and you select a drawing, no objects
are highlighted in the graphic view. If you select an object in a graphic view, it is highlighted with
a gray background in the Workspace Explorer. The Workspace Explorer automatically scrolls
when objects are highlighted if the object is outside the Workspace Explorer window.
Automatic scroll is not available if the object is already in the Workspace Explorer window.
If you select a set of objects, but the set contains objects you do not want, press CTRL and click
to cancel the selection of unwanted objects. For multiple selections, press CTRL+SHIFT. If you
select a parent object and then press SHIFT and click the last listed child of the parent, you get
the parent and immediate child objects belonging of the parent. A right-click allows you to select
the parent and all nested children of the parent.
If you are currently working in a command, you can select multiple objects in the Workspace
Explorer without holding CTRL or SHIFT.
In the Workspace Explorer, you can select or type a name in the box at the top of the view.
The list displays the last 15 objects you selected that satisfy the current select filter. Also, you
can use the wildcard * (asterisk character) when typing the name in the box at the top of the
view. If you are in the Drawings tab, the search results display one at a time. Press ENTER to
navigate through these search results.
You can widen or narrow the Workspace Explorer window for better viewing.
You can also display or hide the window by selecting the Workspace Explorer command
on the View menu.
If you choose to close the window, when you reopen it, the window displays identically as
when you closed it.
You can complete basic command functions, such as copy, paste, and delete in the
Workspace Explorer window. Drag and drop is not currently supported by the Workspace
Explorer.
You can create a new system in the Workspace Explorer by right-clicking an existing
system on the System tab.
If you select an object in the Workspace Explorer that another user has deleted, the
following message appears in the graphic view: Removing the object from working set
because it was not located in the database. Please refresh data.
The list of child objects under the Assembly hierarchy root appear sorted when a workspace
is defined, but can become unsorted during modeling. To sort this list, use the Refresh
Workspace Explorer command from the Workspace Explorer shortcut menu. To display
this menu, right-click in the Workspace Explorer white space area. This behavior applies
only to child objects of the Assembly hierarchy root. All other hierarchies and nodes in the
Assembly hierarchy are not affected by this change.
Analysis Folder
Analysis Model
Assembly
Assembly Connection
Block
Boundary Condition
Coordinate System
Designed Equipment
Designed Handrail
Edge Treatment
Equipment
Equipment Component
Equipment Foundation
Equipment Shape
Equipment Solid
Feature (includes corner feature, edge feature, face feature, slot, and so on)
Footing
Footing Components
Foundation Port
Frame Connection
Handrail
Ladder
Load Case
Load Combination
Member Fireproofing
Member Part
Member System
Opening
Panel - manufactured
Physical Connection
Planning Joint
Plate - light
Seam - Design
Seam - Intersection
Seam - Planning
Seam - Straking
Slab
Stair
Wall Part
Wall Run
Wall System
Icon Relationships
The following table describes the relationships indicated by the icons in the Workspace Explorer.
In general, there is a base icon for each type of entity. This base icon is then embellished
depending upon the role that entity plays in the model. Using the system plate part as an
example:
- Base icon for plate parts. Base parts use blue icons
- Light (not detailed) plate part. Light parts use white icons. Not all entities have this version.
- Light plate part that has been manufactured. The plus symbol indicates that the part has
manufacturing data. This only occurs if the detail part is deleted after manufacturing has been
done.
- Detailed plate part without manufacturing data. Detailed parts use red icons.
- Detailed plate part with manufacturing data. The plus symbol indicates that the part has
manufacturing data.
Common part grouping is also indicated by the icons. Under common part grouping, a master
part is used as the basis for deciding commonality. Other parts that compare themselves to the
master part are part of that common part group.
Selecting a grouped part for manufacturing automatically transfers the selection to the master
part. When you manufacture the master part, all corresponding parts in the group are also
manufactured. However, only the master part contains the manufacturing object.
- Detailed member of the common group. Member entities display a blue background.
- Detailed master part of the common group. Master entities display a yellow background.
Group Member,
Group Member
manufactured,
Group master,
manufactured
manufactured
manufactured
manufactured
Group master
HasMFBearin
Detailed,
Detailed,
Detailed
Light,
Child
Light
Base
Bearing Plate
Bracket Part
GPartAsAssembly
Group Member,
Group Member
manufactured,
Group master,
manufactured
manufactured
manufactured
manufactured
Group master
HasMFBearin
Detailed,
Detailed,
Detailed
Light,
Child
Light
Base
Bearing Plate
Collar Plate
Insert Plate
N/A
N/A
N/A
N/A
Bearing Plate
Designed Member
Light,
manufactured
Detailed
Detailed,
manufactured
Detailed,
manufactured,
N/A
HasMFBearin
GPartAsAssembly
Child
Group Member
Group Member,
manufactured
Group master
Group master,
manufactured
View Menu
256
View Menu
Workspace Explorer
Displays and hides the Workspace Explorer window. The Workspace Explorer displays the
contents of the workspace in a classification hierarchy that reflects the various relationships
defined for the design objects. The content represents the current objects loaded from the
database into the active workspace. The names of objects appear in alphabetical order within
the hierarchy.
The Workspace Explorer window allows you to identify or select objects or sets of objects by
name. Icons appear at the left of the objects to indicate the type of object. For example, a file
folder icon represents a system, an equipment icon represents equipment, and so forth. Move
the mouse over objects in the Workspace Explorer to highlight, and click objects to select
them. If you hide objects using the Tools > Hide (on page 386) command, the object names
appear in italics.
You can narrow or widen the Workspace Explorer window for better viewing. When you
place the pointer on the line that divides the Workspace Explorer from the graphical
windows, it becomes an arrow that you can use to drag the dividing line to the left or right.
When you select objects in a graphical view, the software also selects the objects in
Workspace Explorer. To cancel selection of objects in the Workspace Explorer window,
select the object again while holding CTRL.
If you select an object in the Workspace Explorer that another user has deleted, the
following message appears in the graphic view: Removing the object from working set
because it was not located in the database. Please refresh data.
You can complete basic command functions, such as copy, paste, and delete in the
Workspace Explorer window. The shortcut keys for the Copy command are CTRL+C and
for the Paste command are CTRL+V.
You can create a new system in the Workspace Explorer by right-clicking an existing
system on the System tab.
You can create a new WBS item in the Workspace Explorer by right-clicking on the WBS
tab.
The drop-down list in the Workspace Explorer window has a shortcut menu. Depending on
the commands that you have completed, the menu includes the Undo, Copy, Paste,
Delete, and Select All commands. To open the shortcut menu, right-click the dropdown list.
To select several objects at once, press CTRL or SHIFT while you click. If you are currently
working in a command, you can select multiple objects in the Workspace Explorer without
holding CTRL or SHIFT.
If you close the window, when you reopen it, the window appears at the same width as
when you closed it.
See Also
Define a workspace using a new filter (on page 63)
Define a workspace using an available filter (on page 63)
Workspace
Displays WBS projects and items retrieved to the workspace based on the current Define
Workspace filter.
Database
Displays WBS projects and items that are in the current active database.
See Also
Workspace Explorer (on page 243)
Topics
General Tab (Reference 3D Model Properties Dialog Box) .......... 258
Configuration Tab ......................................................................... 259
Levels and Layers Tab ................................................................. 260
Configuration Tab
Displays the creation, modification, and status information about an object.
Model
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the object belongs. You can select another
permission group, if needed. Permission groups are created in the Project Management
task.
Approval State
Indicates the approval state of the object.
Status
Specifies the current status of the selected object or filter. Depending on your access level,
you may not be able to change the status of the object.
Date Created
Displays the date and time that the object was created.
Created by
Displays the user name of the person who created the object.
Date Last Modified
Displays the date and time when the object was modified.
Last Modified by
Displays the user name of the person who modified the object.
New System
Creates new systems in the Workspace Explorer without switching to the Systems and
Specifications task. You can access this command by right-clicking a system on the System tab
of the Workspace Explorer.
The system you are creating inherits specifications from the parent system. To remove or add
specifications, you must switch to the Systems and Specifications task.
You can narrow or widen the Workspace Explorer window for better viewing. When you
place the pointer on the line that divides the Workspace Explorer from the graphical
windows, it becomes an arrow that you can use to drag the dividing line to the left or right.
You can create a new system in the Workspace Explorer by right-clicking an existing
system on the System tab.
Rulers
Turns the display of rulers on and off. Rulers control the display of coordinate systems loaded in
the workspace. Using rulers is helpful in locating a reference plane, or a point on a plane, when
you place objects in the model. When you place objects in the model, you can use rulers to help
you locate the exact point along a plane.
Display rulers
1. Click View > Rulers.
2. Select a coordinate system or axis from the Coordinate systems box.
You can select multiple coordinate systems or axes by holding CTRL or SHIFT.
To turn the display of rulers off, hold CTRL and click a coordinate system or axis in the
Coordinate systems box.
To Do List
Provides a list of objects in the workspace that include inconsistent data. To open the To Do
List, click View > To Do List, or you can use the shortcut keys, which are CTRL+T.
The To Do List allows you to view, edit, and set review status for inconsistent data objects from
the To Do List dialog box.
You must activate the native task for the object. Otherwise, if you are working
outside the native task for the object, a generic ribbon appears and you cannot edit the object in
error. For example, if the object is an HVAC feature, click Tasks > HVAC to open the HVAC
task to correct inconsistencies.
After you open the appropriate task, you can select the row with the object you want to edit. This
action causes the appropriate Edit ribbon to appear above the active window and lets you
change the data required to fix the errors. If you have write permission to an object, you can
simply direct an Out-of-date object to update itself using its current input. Object that you
cannot edit display in gray.
When you completely correct an Out-of-date object, the software updates all other dependent
objects. You can select multiple objects from the list when you correct Out-of-date objects.
Objects in an Error state are usually selected individually and corrected. After you successfully
update an object, the software removes the object from the list.
If the list on the To Do List dialog box is long, you can click Filter To Do List by Select Set
on the To Do List dialog box to only list the items related to currently selected objects in the
workspace.
You can continue to display the To Do List as you complete other commands.
Two methods are available to change a write permission relationship between user and object.
The first method is assigning each object to a group that defines a list of users; for each user,
that list specifies the level of access for the objects. Your administrator sets these permissions in
the Project Management task.
The choices for access permissions include:
Read - The user can read only.
Write - The user can read, create, change, and delete.
Full Access - The user can read, write, and assign approval (move status as defined
below).
This method allows users with Write and Full Access permissions to write to the object. Users
with Read cannot.
The second method for changing the relationship is assigning each object with a status of work
progress. You can view or change these statuses on Properties dialog boxes. The possible
statuses include:
Working
In Review
Rejected
Approved
For Working status, all access permissions listed earlier might apply (Read, Write, or Full
Access). However, other work statuses block even a user with Write access permission.
For example, Approved status blocks a user with Write access from changing the relationship
(except for the user designated as an approver). Therefore, the processing stops, and the
software lists the object on the To Do List as Out-of-date.
Working is the only status that is not read-only. You cannot add a new status or revise its
characteristics. For example, a designer, who has write access, changes the status from
Working to In Review. An administrator, who has full control access, can change the status
from In Review to either Approved or Rejected.
Error objects are usually edited one at a time. However, you can also select more than one
Error object if an Edit command supports multiple objects.
If a constraint system fails and objects enter the Error state and are not recomputed, the
objects of the constraint system are displayed in nested order on the To Do List. Each
nested object displays values for its properties.
When you update an object in the Out-of-date state, the software refreshes the object using
its current input. In addition, the software updates all objects that depend on the object.
You can select more than one Out-of-date object at the same time, and then update by
clicking Update .
2. Click Properties to open the To Do List Properties dialog box (on page 270).
You can also open the To Do List Properties dialog box by right-clicking outside
the grid area on the To Do List dialog box and selecting Properties on the shortcut menu.
3. In the Display field, select the types of objects that you want to display on the To Do List.
For example, you can isolate objects that exist in a permission group in which the user has a
minimum of Write access permission (Write or Full Control) by selecting the option labeled
Only objects which the user has permission to resolve. You can filter the To Do List by
user by selecting the Only objects last changed by option and then specifying a user. In
addition, you can determine whether ignored objects are displayed in the To Do List by
checking or clearing the Ignored items option.
4. In the List field, select the columns that you want to display on the To Do List.
5. Click OK.
If the list on the To Do List dialog box is long, you can click Filter To Do List by Select Set
on the To Do List dialog box to only list the items related to currently selected objects in the
workspace.
You can use Auto Fit to view objects on the list in the active graphic view.
Properties
Opens the To Do List Properties dialog box, which allows you to choose the objects that
appear in the To Do List, as well as choosing display options. For more information, see To
Do List Properties Dialog Box (on page 270).
Update
Updates the selected out-of-date objects. This option is disabled if:
The object has a non-working approval status. Working status is set on the
Configuration Tab (on page 144) of the object's properties.
The object belongs to another global workshare site.
You do not have sufficient permissions to edit the object.
Auto Fit
Automatically fits in a graphic view the object associated with the To Do List entry that you
selected in the listing.
Note
Provides an expanded description of the problem. Point to the text in this field to display the
informational note as a ToolTip. The software automatically creates the note and its
contents.
Object name
Lists the name of an object, if assigned (for example, Pump No. 42). For an entry in a
nested constraint system, Constraint Set is displayed.
State
Specifies if the objects on the list are in an Out of date or Error state.
Changed by
Lists the user name of the person who changed the object that caused the Out of date or
Error state.
Date modified
Displays the date and local time when the object was modified, which resulted in a failure to
recompute.
Discipline
Displays the discipline of the object with the To Do List entry.
Review status
Displays the review status of the To Do List entry. The status is either blank or Ignored. By
default, this field is blank. To change the Review status of an entry, select the entry and
click the Review Status button .
Display
Designates the contents in the To Do List dialog box.
Error objects
Occurs when relationships between two objects are discrepant. The computation process
for the objects does not complete.
Out-of-date objects
Occurs when you have write permission to edit an object but do not have write permission to
edit associated objects. If you select both the Error objects and Out-of-date objects
boxes, all objects appear in the To Do List dialog box.
Warning objects
Occurs when relationships between two objects are discrepant, but the computation process
for the objects is complete. You must check the objects and correct any discrepancies.
Ignored items
Determines whether to display To Do List entries that have a Review status of Ignored. By
default, this option is not selected.
Only objects which the user has permission to resolve
Includes only those To Do List objects to which the user has write access.
Only objects last changed by
Allows you to filter the To Do List by the user who last modified objects. You can choose
from the "modified by" users who have a To Do List record within the collection. This option
is useful when the To Do List is very long, and you want to see your own entries only (not
necessarily all entries you can fix). The default setting for this option is unchecked.
Discipline Information
Determines whether to display To Do List entries based on which disciplines that you select
in the drop-down menu. This option is useful when you want to only see entries from a
particular discipline or if you want to exclude entries from a particular discipline.
List
Specifies the columns of information to include on the To Do List dialog box. You must select at
least one option listed in the Display section.
Note
Provides an expanded description of the problem. Point to the text in this field to display the
informational note as a ToolTip. The software automatically creates the note and its
contents.
Object name
Lists the name of an object (for example, PUMP001A_IMP_Asm-1-0001).
State
Identifies if the objects on the list are Out of Date or in an Error state.
Changed by
Lists the user name of the person who changed the object that caused the Error or Out of
Date state.
Date modified
Displays the date the change occurred.
Discipline
Displays the discipline of the object with the To Do List entry.
Review status
Displays the review status of To Do List entries.
To Do Record Meter
The To Do Record Meter appears in the status bar of the software. The meter gives quick
feedback on the number of new records created on the To Do List in the current session.
The meter uses a rate of to do record (TDR) generation based on total TDRs created in the
session per total number of objects modified in the session. Error and Warning records are
included in the TDR count, but Out-of-date records are not included. By default, Warnings are
weighted less heavily than Errors; two Warnings count as one. The following equation is used:
TDR rate = ((0.5*Warnings + Errors)/Activity)*100
The To Do Record Meter has the following components:
Meter
Graphically displays the TDR rate. The pointer starts on the left at the start of a new
session, and moves to the right — from green to red — as new TDRs are generated.
Tooltip
Appears when you pause the cursor over the meter. The tooltip displays:
To Do Records - The total number of Error and Warning to do records created in the
session.
Activity - The total number of objects modified in the session.
Rate - The TDR rate expressed as a percentage.
Message
Shows the number of TDRs created by the last completed command.
Insert Menu
The Insert menu provides commands for adding additional information to the workspace, such
as reference files, control points, hyperlinks, and construction graphics. Some of the commands
on this menu may change depending on the active task.
In This Section
Insert File ...................................................................................... 273
Hyperlink ....................................................................................... 282
Note .............................................................................................. 286
Control Point ................................................................................. 289
Insert File
Use the Insert > File command to add reference files (objects) to the Workspace Explorer.
After these objects are added to the Workspace Explorer, you can include them in your model.
Although these reference files can be located anywhere that is accessible from the network, we
recommend that you add them into the SharedContent folder for a Global Workshare
environment. The reference files can only be of the following types:
Non-PDS (Plant Design System) MicroStation V7-format files (.dgn)
AutoCAD 2D and 3D files (.dxf and .dwg)
Smart 3D versions before V2009 only support 2D AutoCAD files.
Smart 3D version V2009 and V2009.1 support 2D and 3D files of AutoCAD version
2008 or earlier.
Smart 3D Version V2011 supports 2D and 3D files of AutoCAD version 2009 or earlier.
After inserting the reference files, the Workspace Explorer displays a Reference tab that
shows the hierarchy of the referenced data. If you do not have the Reference tab in your
Workspace Explorer, see Change the displayed Workspace Explorer tabs (on page 497).
A Reference tab also appears on the Filter Properties dialog box.
MicroStation Units
MicroStation design files use the concept of MU:SU:PU (master units:sub-units:positional units)
to express distances and to define the precision of operations. All distances in Smart 3D are
stored in terms of meters. When you insert a reference file into Smart 3D, the MU:SU:PU
working units are used in the unit conversion. If the MU:SU:PU are not defined within the
MicroStation file, an error appears. The recommended working units in a reference file are
1:1000:80 for the metric system (m:mm) and 1:12:2032 (ft:in) for the English system.
Reference file objects are supported in interference checking. For more information, see
Checking Interferences (on page 426).
MicroStation SmartSolids are not rendered when they are included in a reference file.
When troubleshooting reference files, check that the file or folder is shared with the proper
permissions. Also, be sure the working units are supported; that is, the file must have units
that the software can read and convert.
To detach a reference file, select it in the Workspace Explorer, delete it, and then refresh
the workspace.
AutoCAD Units
Units for the 3D AutoCAD files are defined in Smart3D\Core\Runtime\SPFSPRB\Translator.ini.
For more information, see Translator.ini File Options (on page 277).
You can insert non-PDS (Plant Design System) MicroStation V7-format files (.dgn),
which can be saved from MicroStation V7 and V8. You can also insert 2D and 3D
AutoCAD files (.dxf and .dwg).
You can insert multiple files by holding CTRL or SHIFT while selecting the files.
3. Click Open to insert the reference file.
The location and orientation of the inserted files match the currently active coordinate
system.
After you insert the files, a Reference tab appears in the Workspace Explorer to display
the hierarchy of the referenced data. A Reference tab also appears on the Filter Properties
dialog box.
You can define your workspace to include the reference file objects.
Reference file objects are supported in interference checking. For more information, see
Checking Interferences (on page 426).
MicroStation SmartSolids are not rendered when they are included in a reference file.
To detach a reference file, select it in the Workspace Explorer, delete it, and then refresh
the workspace.
When troubleshooting reference files, check that the file or folder is shared with the proper
permissions. Also, be sure the working units are supported. The file must have units that the
software can read and convert.
Master Units
Possible values for the Master Units field:
59 = meters
61 = millimeters
62 = centimeters
63 = kilometers
64 = inches
65 = feet
66 = yards
67 = miles
Sub Units
Possible values for the Sub Units field are the same as those for the Master Units. The Sub
Units should be defined the same as the Master Units unless the Positional Units Per Master
Unit are greater than the conversion factor between the defined Master Unit and the defined
Sub Unit. For example, if the Master Units are in meters, then the Sub Units should also be in
meters. If the number of Positional Units Per Master Unit is 100, then the Sub Units should
be defined as centimeters. If the number of positional units per master unit is 1000, then the
Sub Units should be defined as millimeters.
For most situations, the Sub Units can be set equal to the Master Units to simplify
the equation.
To simplify, the Sub Units can be set equal to the Master Units, and Sub Units Per
Master Units set to 1.
The Sub Units Per Master Units field can only have whole integer values (no decimals) of
1 or larger.
Display Proxy
In AutoCAD, to cancel the proxy translation, add the option below to the AutoCAD section:
Display Proxy Entities = 0
AutoCAD applications that create proxy objects must be able to export their graphics
into a standard AutoCAD file, or into another format that can be read by SmartPlant Review
Publisher. Otherwise, the converters cannot read the graphics for display in SmartPlant
Review. An example of this is if graphic entities are generated using object enablers. If you have
AutoCAD formats that cannot be converted, please contact the application provider for a
solution to export the graphics into a readable format.
Client
Use the setting in this section to support multiple clients. Set the Client Code as SP3D or
SPRPub (SmartPlant Review Publisher).
Global Options
Enable Logging
If this option is set to 1, the software generates the log file in the Temp folder with the name
ReaderLogFile.txt. If the option is set to zero (0), then no log file is generated.
LogSetting
If this option is set to 1, the software generates a detailed log with the detailed information of
all the graphic objects in the file, such as handle information, color, and layer. If the option is
set to 0, the software only generates a summary of all the graphic objects, such as the
number of graphic objects that passed or failed.
AutoCAD Conversions
No Scaling Required
If the source data is in known working units, then set up the working units to match those used
in the source data.
Source Data: 1 positional unit = 1 mm
Output: 1 positional unit = 1 mm
Settings:
Master Units = 61 (mm)
Sub Units = 61 (mm)
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1
Settings:
Master Units = 63 (km)
Sub Units = 63 (km)
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 39370 (39370.07874 in per km)
Hyperlink
Adds hyperlinks to selected objects, such as equipment and pipe runs. You can type a link to a
file or a web page. Use Edit > Go to Hyperlink to follow the hyperlink. If you select an object
that does not have a hyperlink associated with it, the Go to Hyperlink command is not
available.
Hyperlinks are stored in the Site database so that any user working with that object can access
them.
Insert a hyperlink
1. Click the objects that needs a hyperlink.
2. Click Insert > Hyperlink.
3. Type the description and URL of the hyperlink.
4. Click OK.
If you are unsure about the URL, click Browse to open the Browse to Address dialog box.
Remove a hyperlink
1. Select the object from which you want to remove the hyperlink.
2. Click Insert > Hyperlink.
3. Click Unlink.
Stop
Ends any command the software is performing. Click this button if a page is taking too long
to load.
Refresh
Displays the latest version of a page.
Home
Opens the Web page defined as the starting page of your browser.
Search
Opens a standard search tool to help you find the page you want.
Favorites
Adds a location to saved list of pages, views your list of saved pages, or opens a saved
page from that list.
Select
Associates the displayed location with the object selected in your model.
See Also
Insert a hyperlink (on page 283)
Insert Hyperlink Dialog Box (on page 283)
Note
Adds notes to objects, such as equipment and pipe parts. You can type special instructions or
requirements related to a given component for the fabricator.
When you select the Note command, you are prompted to select a key-point, insertion point, tap
point, or control point. Notes are associated with individual component key points and can be
used with many objects in the software, including instruments, pipe, piping components,
specialty items, pipe support assemblies, HVAC fittings, and cableway fittings. The software
associates notes with parts, not features.
Notes contain user-definable text that provides special instructions or requirements for a given
component. Notes are a form of communication with the fabricator of the system.
The software associates notes with parts, not features. To view the properties of notes, select
an object with corresponding notes and use the Properties command on the Edit menu. When
you create a note, you can include a hyperlink in the Note text box. The Edit Properties dialog
box includes a Notes tab after you have added a note. For more information, see Notes Tab (on
page 179).
Insert a note
1. Click the object that needs a note.
2. Click Insert > Note.
3. Select a key point, insertion point, tap point, or control point for associating the note.
4. In the Key point box, select a point to which to attach the note.
5. In the Note name box, type or select a name.
6. In the Purpose of note box, select a purpose.
7. In the Note text box, type descriptive text about the note.
Notes are stored in the Site database so any user working with that object can access
them.
Follow a note
1. Select an object with an associated note.
2. Click Edit > Properties to access the Properties dialog box for the object.
3. Change to the Note tab to view the note text and other properties on the Notes tab.
You can add or delete notes using the buttons on the Notes tab.
3. Position the control point on the centerline of the pipe part. For precision placement, use
commands like Measure , PinPoint , or Point Along.
4. In the Type box, verify that Control Point is selected.
5. Confirm or change the option in the Subtype box on the ribbon.
6. In the Name box, define a name for the control point.
7. Click Properties .
8. Under the Notes tab, click New Note.
9. In the Key point box, select the control point to which to attach the note.
10. In the Notes at this location, listed by name box, type or select a name.
11. In the Purpose of note box, select Fabrication so that the note is picked up for inclusion in
the drawing.
12. In the Note text box, type descriptive text for the note.
13. Check the Show dimension box if you want a dimension to appear on the drawing.
Control Point
Places a control point on an object in the model. The software translates the control point on
volume and composed drawings and depicts its own symbol and coordinate callout. If part of an
assembly, the control point controls the location of the drawing leader line for that assembly.
When a control point is inserted, it is added to the System hierarchy in the Workspace
Explorer beneath the system and object to which it is associated.
The Drawings and Reports task uses control points for the following reasons:
To drive coordinate and label locations.
To generate notes on volume and composed drawings, isometric drawings, and reports.
To use as a reference for dimensioning schemes based on a monument, or coordinate
system, and to give directions for the dimensions. You can define coordinate systems and
monuments in the Grids task.
You define the location of a control point with the Insert > Control Point command. You
designate the control point relative to a parent object, such as along a centerline or on a surface.
Examples of parent objects are route objects, equipment, structures, grids, and coordinate
systems. If you delete the parent object, the software also deletes the control point.
The parent object drives the relationship of the control point as part of an assembly. That is, the
control point and its parent object share the same relationships. The control point and parent
object also are in the same permission group and have the same approval status. While you can
assign multiple control points to a parent object, each control point has only one parent object.
You can use the SmartSketch relationship indicators or commands like Measure , PinPoint
, and Point Along to define an associative position, setting the control point as a child object
to the associative point constraint that locates the exact position. For example, you can place a
control point two meters from a key point along a pipe. During a move or modification, the
software maintains the control point location at the same distance from the key point. Therefore,
if you modify the pipe length, the control point remains at two meters from the key point. If you
modify the pipe length to equal less than two meters, the software automatically deletes the
point.
The software does not contain a filter for control points; however, you can select a control point
in the model by applying the All locate filter and then clicking the Select command. You can
also select a control point from the Workspace Explorer if the filter is set to All.
Definitions for drawing filters and rules control the symbolization of control points. The location
of the control point symbol corresponds to the 3D control point.
The following graphic depicts five control points that are positioned near labels in a P&ID:
The control point is not a physical object and does not support interference checking.
A control point is a 3D graphic object with properties that represents a point in the model.
The software translates the object on volume and composed drawings and depicts its own
symbol and coordinate callout. If part of an assembly, the control point controls the location
of the drawing leader line for that assembly.
A monument is an object, such as a post or stone, fixed in the ground to mark a boundary or
position. A coordinate system defines a monument to provide measurement directions.
A key point is any point that you can locate on a symbol or an object.
If a control point is not defined for a symbol, the default control point is the center of the
symbol.
Each piece of equipment must have at least one control point.
When you place a control point, you can specify a control point subtype to provide a further
breakdown for the type of control point. To customize subtypes, you can use the
functionality in the Catalog task. Possible subtypes are Process Equipment, Mechanical
Equipment, Foundation, Structure, Pipe Mfg Limit Point, Spool Break, Duct Break
Point, WBS Pipe Break - Fabrication, WBS Break Point Type 1, WBS Break Point Type
2, WBS Break Point Type 3, WBS Break Point Type 4, WBS Pipe Break - Stress, WBS
Break Point Type 5, WBS Pipe Break - Tracing, WBS Pipe Break - Generic, WBS Pipe
Break - System, Elevation Callout, Ad Hoc Note, CAD Detail, Key Plan Callout,
Support Notes, Isometric Reference Dimension, Isometric Start Point, and Pipe Stress
Delimiter. You can use the control point subtypes to classify the control point for use in the
Drawings and Reports task. For more information, see Control Point Subtype Sheet in the
Reference Data Guide available from the Help > Printable Guides command in the
software.
You can use control point subtypes to classify the control point for use in drawings and
reports. For more information, see Control Point Subtype Sheet in the Reference Data
Guide available from the Help > Printable Guides command in the software.
Control point subtypes are used in drawings in several ways. They can indicate a point
on a piece of equipment or a structure to be used in dimensioning. The subtype can
indicate the position of a grating symbol on a structure planning drawing. Another way
the subtype is used is to place notes at a very specific point on an object, making the
control point drawable so it can be labeled.
You can use the CAD Detail control point subtype to classify the control point for use in
the HgrSup3View package in drawings and reports. For more information, see the
Smart 3D Drawings and Reports Reference Data Guide.
Name
Identifies the control point with a name, which you can define, or use the selection that a
rule defines. The GenericNamingRules.xls workbook lists the naming rules used in the
software. For more information about naming rules, see the Reference Data Guide available
from the Help > Printable Guides command in the software.
You can use control point subtypes to classify the control point for use in drawings and
reports. For more information, see Control Point Subtype Sheet in the Reference Data
Guide available from the Help > Printable Guides command in the software.
Control point subtypes are used in drawings in several ways. They can indicate a point
on a piece of equipment or a structure to be used in dimensioning. The subtype can
indicate the position of a grating symbol on a structure planning drawing. Another way
the subtype is used is to place notes at a very specific point on an object, making the
control point drawable so it can be labeled.
Name
Identifies the control point with a name, which you can define, or use the selection that a
rule defines. The GenericNamingRules.xls workbook lists the naming rules used in the
software. For more information about naming rules, see the Reference Data Guide available
from the Help > Printable Guides command in the software.
E
Displays the coordinate of the control point along the E-axis (East).
N
Displays the coordinate of the control point along the N-axis (North).
EL
Displays the coordinate of the control point along the EL-axis (Elevation).
Using the Format View dialog box, you can see the control point in the model by
selecting Reference Geometry from the Render Selected Aspects list.
You can use QuickPick and a locate filter to assist in selection of control points.
2. On the ribbon, specify a parent in the Parent Object box. You can choose from the last five
parent objects, or you can select an object graphically in the model or from a tree view.
3. Confirm or change the option in the Type box on the ribbon.
4. Confirm or change the option in the Subtype box on the ribbon.
5. Confirm or change the assigned phrase in the Name box on the ribbon.
Click Properties on the ribbon to view or edit additional properties of the control point.
You can view the coordinates of the control point in the boxes on the ribbon. However, you
cannot edit these coordinates.
5. Place the control point as a location point for the drawing and PCF. For example, you might
want to place it on a weld.
6. Update the drawing for the pipeline.
The updated drawing shows a label for the Location Point that has a label pointing to the
Distribution Connection.
The Piping Component File (PCF) includes the line LOCATION-POINT followed by the x, y, and
z coordinates (units in millimeters) of the control point.
You can create rules to use the control point subtypes to classify the control point for
use in drawings and reports. For more information, see Control Point Subtype Sheet in the
Smart 3D Reference Data Guide available from the Help > Printable Guides command in the
software.
4. Create a note associated with the control point. The text of the note is appended to the label
before the elevation.
a. Open the Control Point Properties dialog box for the control point.
b. Click the Notes tab.
c. Click New Note.
d. Specify the Key Point, in this example ControlPoint1, to add the note, specify Elevation
Callout for Notes at this location, listed by name, select Fabrication for Purpose of
Note, and specify EL for Note Text.
5. Go to the Drawings and Reports task and update the drawing for the structure.
The updated drawing shows a label that has the elevation value of the control point location
and the note added.
You can create rules to use the control point subtypes to classify the control point for
use in drawings and reports. For more information, see Control Point Subtype Sheet in the
Smart 3D Reference Data Guide available from the Help > Printable Guides command in the
software.
5. Go to the Drawings and Reports task and update the drawing for the structure.
The updated drawing shows a label with the note added at the control point location.
You can create rules to use the control point subtypes to classify the control point for
use in drawings and reports. For more information, see Control Point Subtype Sheet in the
Smart 3D Reference Data Guide available from the Help > Printable Guides command in the
software.
4. Create a note associated with the control point, specifying the location of the .sym file.
a. Open the Control Point Properties dialog box for the control point.
b. Click the Notes tab.
c. Click New Note.
d. Specify the Key Point, in this example Control Point3, to add the note, specify CAD
Detail for Notes at this location, listed by name, select Fabrication for Purpose of
Note, and specify \HangersAndSupports\CAD Details\Utility four hole plate.sym for Note
Text.
5. Go to the Drawings and Reports task and update the drawing for the support component.
The updated drawing shows the graphic detail of the associated control point note text in the
view, where the HngSup – CAD Details view style is activated.
You can create rules to use the control point subtypes to classify the control point for
use in drawings and reports. For more information, see Control Point Subtype Sheet in the
Smart 3D Reference Data Guide available from the Help > Printable Guides command in the
software.
5. Go to the Drawings and Reports task and update the drawing for the support component.
The updated drawing shows the Key Plan coordinate label at the specified control point
location in the drawing.
You can create rules to use the control point subtypes to classify the control point for
use in drawings and reports. For more information, see Control Point Subtype Sheet in the
Smart 3D Reference Data Guide available from the Help > Printable Guides command in the
software.
Naming Rule
Displays the available name rules for the selected object. Specify the naming rule to use to
name the object. You can select one of the listed rules, or you can select User Defined to
specify a custom name in the (Name) box.
Diameter
Displays the diameter of the object.
Parent Object
Specifies the object to which the control point is associated.
Associativity
Sets the associativity of the control point. You can select True or False.
E
Displays the coordinate of the control point along the E-axis (East).
N
Displays the coordinate of the control point along the N-axis (North).
EL
Displays the coordinate of the control point along the EL-axis (Elevation).
Format Menu
The Format menu provides commands for formatting views and styles and maintaining surface
style rules. Some of the commands on this menu may change depending on the active task.
In This Section
Format View.................................................................................. 307
Format Style ................................................................................. 321
Surface Style Rules ...................................................................... 338
Format View
Formats a view according to settings on the Format View dialog box. You access this command
by selecting Format > View.
When you define three-dimensional views, you can format the views with effects. You can use
several techniques, such as rendering, to enhance model views. You can apply these settings to
more than one view using a view style, or you can format a single view.
Setting Projection
The projection of a view determines how close and at what angle objects appear in the
workspace.
Specifying Rendering
Rendering provides a more realistic view of a model. You can apply different rendering methods
to the model such as smooth shading or outline images.
Applying Formats
When you format a view, you can easily control what objects look like in a view. You can format
views in the following ways:
To apply unique settings to a view, you use the Format > View command. The formats you
apply with this command override the view style of the active window.
If you select one of the shaded edges rendering options (Shaded with Enhanced Edges or
Shaded with Hardware Enhanced Edges), you can set the edge colors for objects in the
current view in the Enhanced Edges tab of the Format View dialog box.
To apply the same settings to more than one view quickly and efficiently, you can apply a
view style with the Apply View Style command on the View menu. For more information,
see Apply View Style (on page 241).
You can also format the styles used within each view using the Format > Style command.
For more information, see Format Style (on page 321).
Format a view
1. Click Format > View. For more information on the dialog box, see Format View Dialog Box
(on page 311).
2. Set the Projection Mode to specify the projection style to use in the graphic window. Select
Orthographic to produce a parallel projection. Select Perspective to give the displayed
objects a vanishing point in the graphic window.
3. Select a Render Mode for the physical appearance of three-dimensional objects in the
workspace.
If you select Shaded with Enhanced Edges or Shaded with Hardware Enhanced
Edges as the Render Mode, the Enhanced Edges tab displays so that you can select the
edge color. For more information, see Set enhanced edge color (on page 310).
4. Select the View Axis to display the coordinate triad in the workspace, with respect to the
active coordinate system. By default this option is set to None.
5. Select the Aspects you want applied to the view formatting.
6. To define custom lighting, clear the Use default lights check box, and select the Lights
tab. For more information, see Lights Tab (Format View Dialog Box) (on page 318).
To display the Lights tab, clear the Use default lights box on the Display tab.
7. Click OK to apply the changes and dismiss the dialog box, or click Cancel to dismiss
without making the changes.
The Preview area shows graphically the options you select on this dialog box.
When there are 500 or more objects from the selected aspects, Smart 3D displays a
message box similar to the one below. This message box shows the progress of the objects
as they are being loaded.
To define or modify a view style, you can click Format > Style. This command allows you to
apply the same view settings to more than one view easily. For example, if you wanted to
shade a model, you can save a view style with the shading options you want. Then, you can
apply the view style to more than one view of the model. For more information, see Format
Style (on page 321).
To change the view style of a window, you can click View > Apply View Style. You can
apply a view style to several views with this command. For more information, see Apply
View Style (on page 241).
3. Click the Enhanced Edges tab. For more information on color options provided in the tab,
see the Enhanced Edges Tab (Format View Dialog Box) (on page 320).
4. Select the color option to use. If you select Use a single Specified Outline Color, click
Edit, and then set the color.
5. Use the Contrast slider to lighten or darken the edges of objects. Move the slider to the left
to make the edges lighter or to the right to make them darker.
The Preview window dynamically displays your settings on example objects. The text
description shows the selected rendering mode and other display options.
The Edit button applies only to the Use a single Specified Outline Color option. If
you click the Edit button and select a color, the Use a single Specified Outline Color
option is automatically selected.
6. Click OK to apply the changes and dismiss the dialog box, or click Cancel to dismiss
without making the changes.
Your settings are saved in the session file.
Perspective - Select this option if you want the display to include a vanishing point.
Render Mode
Determines the physical appearance of 3D objects in the workspace. The available options
are described below.
When you select the Smooth Shaded or Shaded with Hardware Enhanced
Edges rendering option in Orthographic mode, you may encounter an issue in which not all
objects are visible. To correct this, you can add the line DisplayEdgeOnGraphics = 1
under the [ViewSettings] section in the product-specific display configuration file located
in [Product Folder]/Core/Shared/bin. The value "1" turns on the option; a "0" value turns the
option off. When enabled, this configuration setting can affect the overall display
performance. Smart 3D delivers three product-specific configuration files:
CoreDisplaySettings.ini (plant), S3D-MarineCoreDisplaySettings.ini (Marine), and
S3D-MHECoreDisplaySettings.ini (Mining). Edit the configuration file for your Intergraph
product. For more information, we recommend that you contact customer support.
Outline - Displays objects with edges as a single line and the surfaces solid. Edge lines
and faces not within the normal view are hidden. This setting provides a fast and simple
way to review spacing relationships between objects. Because this view involves hidden
lines, the display is less cluttered.
Smooth Shaded - Displays objects in a solid format with smooth shaded surfaces.
Smooth Shaded with Enhanced Edges - Displays objects the same as the Smooth
Shaded option but with a dark line emphasizing the edges of the objects.
Smooth Shaded with Hardware Enhanced Edges - Provides a faster solution for
displaying enhanced edges. This option is an alternate display option to Smooth
Shaded with Enhanced Edges in that it uses the software running on your system's
video card.
The Smooth Shaded with Hardware Enhanced Edges mode does not support the
high quality, anti-alias smooth edge display.
This option may not be supported by your graphics driver and/or graphics card.
Smart 3D checks your system information and does not display this option if it is not
supported. Loading a new graphics driver could make this option available.
View Axis
Indicates the orientation of active view. Following are the positions available:
None - View axis is not visible in the active view (default option).
Lower Left - Select this option to position view axis in lower left corner of the active
view.
Upper Left - Select this option to position view axis in upper left corner of the active
view.
Lower Right - Select this option to position view axis in lower right corner of the active
view.
Upper Right - Select this option to position view axis in upper right corner of the active
view.
The view axis can be enabled and positioned independently for each view. Because the
active coordinate system is a global setting, every view has the same active coordinate
system.
If view axis is set to None, then there is no indication shown for Preview and
Description.
Selected aspects
Provides a list of available aspects to which you can apply the view formatting. Aspects are
parameters that represent additional information needed for placement, such as safety or
maintenance clearances.
An aspect is a geometric area or space related to an object. The aspect represents
information about the object, such as its physical shape or the space required around the
object. Aspects are associated parameters for an object, representing additional information
needed for placement. Aspects can represent clearances for safety or maintenance,
additional space required during operation, or simple and detailed representations of the
object. You define aspects when you model a part class for the reference data.
Simple physical - Includes primitive shapes. This aspect creates a less cluttered view
of the object, showing only the body of equipment or a simplified cross-section for
structure, as shown below.
Detailed physical - Provides a more detailed view of an object. This aspect shows all
the graphical details associated with the equipment or structure. For example, certain
types of equipment may include legs and lugs. For marine structure, this aspect uses all
geometry in the cross-section, as shown below.
Operation - Includes the area or space around the object required for operation of the
object. This space shows in the model but not in drawings. For example, this aspect
leaves enough space around a motor for a person to operate the motor or the overhead
space needed for someone to walk up a stairway.
Maintenance - Includes the area or space around the object required to perform
maintenance on the object. This space may appear in the model but not in drawings.
For example, this aspect leaves enough space around a motor to perform maintenance
on a motor, including space to remove the motor.
Reference Geometry - Allows you to construct or add graphical objects that do not
participate in interference checking. For example, a reference geometry object could be
a spherical control or the obstruction volume for a door. For marine structure, this
aspect allows you to control the display of landing curves for design seams, profile
systems, reference curves, and knuckle curves.
Centerline - Displays objects as a single line representation. For example, this aspect is
useful for when you want to display handrails or structural members as a single-line on
drawings. For structure, the centerline is determined from the cardinal point used to
place the member. That cardinal point is not always the center of the object.
Molded Forms - Displays plate, profile, and beam systems for marine structure.
Equipment Hole - Displays holes for marine structure created in the Hole Management
task.
* - Matches all cross-sections.
For piping and equipment objects in plant mode, Insulation, Equipment Hole,
Maintenance, and Operation aspects displaying in the 3D graphic view also display in the
Sketch 2D environment.
Preview
Previews graphically the options you select on this dialog box.
Description
Provides a text description of the specified rendering style.
Use default lights
Specifies whether you want to use the default lights in the model, or use the Lights tab to
define custom lighting. The Lights tab is hidden when this box is checked.
Point Grid Display
Allows you to select or clear the Point Grid display option for styles and views or both.
See Also
Format View (on page 307)
Lights Tab (Format View Dialog Box) (on page 318)
Enhanced Edges Tab (Format View Dialog Box) (on page 320)
Ambient
Controls the ambient reflectivity of a material, that is, the degree to which the ambient
lighting in the overall model is reflected by the surface of the material. The total ambient light
value of a surface is calculated by multiplying the ambient reflectivity value by the model
ambient light setting. The ambient reflectivity value can range from 0 to 1, where 0 is no
ambient light reflected and 1 is full ambient reflectivity.
For example, if the overall ambient light setting for the model is set to 1.0, and a material
has an ambient reflectivity value of 0.10, model elements using that material have an
effective ambient lighting value of 10%. A lower ambient light value causes the shadows that
fall on the material to be dark, with a high contrast between the directly and indirectly lit
areas. A higher ambient light value results in a more uniformly lit surface, fainter shadows,
and less overall contrast in lighting. This setting would be desirable, for example, if you
wished to create a bright, uniformly lit ceiling in a room.
You can use the color mixer to select the color of the ambient light.
Light
Provides eight parallel light sources with a predefined angular position around the view
vector. You can select each light and then define its color using the color mixer. The color of
each light bulb represents its true color, which is user-definable.
Light angle
Defines the angle of light to the view vector for a selected light. The default value is 30.
Red, Green, Blue
Adjusts the amount of red, green, and blue by typing values in the value box or using the
sliders.
Hue, Saturation, Intensity
Adjusts the amount of color saturation and intensity to apply by typing values in the value
box or using the sliders.
This tab is only shown when the Use default lights check box on the Rendering
tab is cleared in the Format View dialog box.
See Also
Format View Dialog Box (on page 311)
New View Style Dialog Box (on page 336)
You can minimize, maximize, or close the message box. The message box automatically closes
when the process is completed.
When you close the message box, you cannot re-open it.
Format Style
Creates, modifies, and applies styles to views or selected objects to make them appear the way
you want if you have the permission to do so. You can also define or modify the style override
for currently selected objects.
The software incorporates two types of styles: view styles and surface styles. View styles affect
the way that all objects appear in the active view, such as whether they appear in solid or outline
mode. When you apply a view style, all objects in the active view change. For example, when
you set the rendering mode to outline for a view, all objects in that view are shown in outline
form.
Surface styles impact the appearance of specific objects in your workspace. If you want a
filtered group of objects to appear consistently in certain colors, textures, and other formats in
your workspace, you can define their appearance by applying surface style rules. These rules
apply to all existing objects in your workspace that meet the filter requirements and to any new
objects you place in the workspace that meet the rules filter.
The appearance properties of three-dimensional elements include curves, surfaces, and groups
of surfaces. The properties of a curve include color and line style. The properties of a surface
include specular and diffuse color and rendering mode. The software treats the edges of a
surface as curves, and these curves can have appearance properties that are different from
their parent surface. You can define the appearance properties of curves and surfaces using
surface style rules.
Each of the color settings in the style responds to the corresponding component in light. It is
very important to balance the style colors with the light settings.
We recommend that you use lighter colors for the Ambient color setting. Black or dark
Ambient color settings can distort the lighting model with dark areas.
We recommend that you use Specular settings sparingly. Specular causes "white-hot"
areas on surfaces. The larger the specular areas are, the brighter and stronger the specular
response to light is.
You can apply a surface style to multiple objects at once by using the Tools > Select by
Filter command.
If you do not select an object in the workspace, the Apply button on the Modify Style dialog
box is not available.
If you select several objects from different style types, the Styles list is blank.
To add additional styles to your workspace, click Format > Style, and then click New.
You can rename styles only if you have the appropriate permissions. See your system
administrator or site manager to grant the appropriate permissions for renaming styles.
You can see how the style changes affect the appearance of an object by checking the
picture under Preview.
You can see how the style affects the way an object looks by checking the picture under
Preview.
If you do not want any of the perspective views listed in the Perspective box on the
Rendering tab, you can select None (Orthogonal) in the Perspective box.
After you create a new view style, you can apply the style to the active view. Click the view
style name in the list, and then click Apply.
Topics
Surface Tab (Style Dialog Box)..................................................... 328
3D View Tab (Style Dialog Box) .................................................... 329
Topics
General Tab (New/Modify Style Dialog Box)................................. 330
Edges Tab (New/Modify Style Dialog Box) ................................... 331
Faces Tab (New/Modify Style Dialog Box).................................... 333
Description
Provides a text description of the specified style.
See Also
New/Modify Style Dialog Box (on page 329)
Style Dialog Box (on page 328)
Smooth Shaded - Displays objects in a solid format with smooth shaded surfaces.
Shaded with Enhanced Edges - Displays objects the same as the Smooth Shaded
option but with a dark line emphasizing the edges of the objects.
Smooth Shaded - Displays objects in a solid format with smooth shaded surfaces.
Shaded with Enhanced Edges - Displays objects the same as the Smooth Shaded
option but with a dark line emphasizing the edges of the objects.
Topics
Name Tab (New View Style Dialog Box) ...................................... 336
Rendering Tab (New View Style Dialog Box)................................ 337
Smooth Shaded - Displays objects in a solid format with smooth shaded surfaces.
Shaded with Enhanced Edges - Displays objects the same as the Smooth Shaded
option but with a dark line emphasizing the edges of the objects.
Shaded with Hardware Enhanced Edges - Provides a faster solution for displaying
enhanced edges. This option is an alternate display option to Shaded with Enhanced
Edges in that it uses the software running on your system's video card.
This option may not be supported by your graphics driver and/or graphics
card. Smart 3D checks your system information and does not display this option if it is
not supported. Loading a new graphics driver could make this option available.
The software applies surface style rules to parts only, not to features or runs. This concept is
important to remember when working in routing tasks.
You can add new surface styles to apply through rules on the Format > Style dialog box.
After creating a new surface style rule, you can apply it to the workspace by selecting a rule
in the Style rule library box and clicking Add to add the rule to the Workspace box.
Because the software processes the rules in descending order, you should list the most
specific rules at the top of the list. Click Move Up and Move Down to change the order of
the rules in the Workspace list.
You can also add a new rule or modify an existing one from the Surface Style Rules dialog
box.
The software stores the list of applied surface style rules in the workspace.
Because the software processes the rules in descending order, you should list the most
specific rules at the top of the list. Click Move Up or Move Down to change the order of the
rules in the Workspace list.
If the model into which you paste the rule already contains a rule by the same name, the
software adds "Copy of" to the rule name to avoid duplicating names.
The software removes any filter data specific to the object identifier when you copy a
surface style rule into another model. The software converts the filter into a parameterized
filter that prompts you for input for any areas that were removed.
When you copy a style rule, the software renames its associated copied filter with the name
of the surface style rule and prefixes the style rule name with "Copy of".
Move Down
Moves the selected style rule down one step in the Workspace list.
New
Activates the Surface Style Rule Properties dialog box on which you can create a new
surface style rule and add it to the database. This button is available only if you have write
permission to the surface style rules.
Modify
Activates the Surface Style Rule Properties dialog box on which you can modify an
existing surface style rule and add it to the database.
Copy
Creates a copy of the selected rule on the Clipboard. You use Copy to create a copy of a
surface style rule in the Model database so you can modify the rule rather than create a new
one.
If you try to copy a style rule associated with a deleted filter, the style cannot be
copied. A message box displays.
Paste
Pastes the copied rule from the Clipboard so it can be modified.
Delete
Removes the selected Surface Style Rule from the database.
Apply
Applies changes in surface style rules to the workspace.
Double-clicking a surface style rule also activates the Surface Style Rule
Properties dialog box on which you can create or modify a surface style rule if you have
permission.
See Also
Add a Surface Style Rule to the Workspace (on page 340)
Copy a Surface Style Rule from One Model to Another (on page 341)
Create a Surface Style Rule (on page 340)
Modify a Surface Style Rule (on page 342)
Remove a Surface Style Rule from the Database (on page 342)
Remove a Surface Style Rule from the Workspace (on page 341)
Topics
Surface Style Rule Properties Tab (Surface Style Rule Properties Dialog
Box) .............................................................................................. 344
Configuration Tab ......................................................................... 345
Configuration Tab
Displays the creation, modification, and status information about an object.
You cannot define the filters using the Configuration tab.
Model
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the object belongs. You can select another
permission group, if needed. Permission groups are created in Project Management.
Transfer
Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group. This option is only available if the active model or
project is replicated in a workshare configuration. The option is not available if all of the
objects in the select set already belong to another location and are non-transferable. For
more information, see Transfer Ownership Dialog Box in the Common User's Guide.
Approval State
Specifies the status of the selected object or filter. The display depends on your access
level. You might be unable to change the status of the object. The list is defined by the
ApprovalStatus codelist.
You can only edit or manipulate an object with a status of Working.Status
Specifies the location of the object in the workflow process. Changing this property sets the
Approval State. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file. For more information, see
ApprovalReason in the Reference Data Guide.
Date Created
Specifies the creation date of the object.
Created by
Specifies the name of the person who created the object.
Date Last Modified
Specifies the date of the last modification to the object.
Last Modified by
Specifies the name of the person who last modified the object.
Tools Menu
The Tools menu provides commands for setting software options, showing and hiding objects,
and displaying objects by filter. It also provides access to PinPoint and measure-related tools.
You can add objects to the SmartSketch list, run reports, check interferences, and access
custom commands. Some of the commands on this menu may change depending on the active
task.
In This Section
Select............................................................................................ 347
Select by Filter .............................................................................. 354
Show ............................................................................................. 386
Hide .............................................................................................. 386
Show All ........................................................................................ 388
PinPoint ........................................................................................ 389
SmartSketch Options .................................................................... 401
Add to SmartSketch List ............................................................... 403
Get Point ....................................................................................... 408
Point Along ................................................................................... 412
Measure ........................................................................................ 415
Checking Interferences ................................................................. 426
Run Report ................................................................................... 434
Drawing Console .......................................................................... 441
Snapshot View .............................................................................. 444
Custom Commands ...................................................................... 450
Utility ............................................................................................. 462
Options ......................................................................................... 494
Weight & CG ................................................................................. 514
Select
Locates one or more objects to apply a specific command. When you choose the Select
command, the ribbon displays the default filter for the task and the Inside and
Inside/Overlapping fence commands. The fence commands allow you to select groups of
objects by drawing a dashed rectangle around them. The selectable objects are based on your
existing permissions, as well as the available locate filters in that task. After you select an object
or group of objects, the software replaces the selection ribbon with an edit ribbon for the select
set.
Locate Filter
Specifies a filter for the selection of specific object types. Filters allow you to select specific
types of objects, or all objects. Filter options are unique for each task. Unlike the
user-defined filters that you create through the Define Workspace command, the locate
filter options are defined by the software.
Inside
Specifies that all objects located entirely inside the fence be selected. This setting is the
default for the Select command.
Inside/Overlapping
Specifies that all objects located entirely inside the fence and those outside the fence but
touching the fence at some point are selected.
Using Filters
When you click the Select command, the Locate Filter box displays the active filter for your
task, and each task provides a unique list of available filter options. You can use these filters to:
Control the selection of compound (or owner) objects versus selection of the constituent
components. For example, in the Piping task, you have the option to locate the run, the
parts, or the features of the run.
Filter on any object in the current task.
You can apply locate filters to the highlighting and selection in both the graphic and Workspace
Explorer views. You can also use the Edit > Locate Filter command to change the locate filter
when you are in the middle of a command, without canceling the command.
Selecting Graphically
Regardless of the filter you use, you can select objects using the Fence Inside Only or
Fence Inside Overlap commands, or you can add objects to or remove objects from the
select set by pressing CTRL or SHIFT and then selecting the object.
If you are in the SmartStep of a command, you do not need to press CTRL or SHIFT
to multi-select.
When you pass the cursor over objects in the workspace, they highlight in a predefined color.
When you select an object, the color changes to show that the object has been selected. You
can change the colors used to distinguish highlighted and selected objects on the Colors tab of
the Tools > Options dialog box.
After you select one or more objects, the Select ribbon is replaced by another ribbon. If you are
in the appropriate task to edit the selected objects, a ribbon specific to that task displays.
Otherwise, the new ribbon contains only a Name box and a System list. The specific edit ribbon
that appears for each object varies from one task to another. In other words, the ribbon that
appears when you select a segment of pipe in the Piping task contains different lists and boxes
than when you select a member in the Structure task.
If you select an object that has been deleted from the database or is not in the database, the
software displays a message that the object cannot be found. Click File > Refresh
Workspace to update the session.
In addition to graphical selection, you can also select objects by clicking their names in the
Workspace Explorer, or use Tools > Select by Filter to create a filter to select objects.
You can select and delete an object from any task, as long as you have the necessary
security permissions to make that change.
Using QuickPick
When the cursor moves over an area that contains multiple objects, the cursor changes to the
QuickPick icon .
Single mouse click when is displayed to activate QuickPick and help you select a specific
object. QuickPick displays as a list box near your cursor location.
The QuickPick list displays the located model objects. Scroll your mouse wheel, or use the
keyboard arrow keys, to highlight the corresponding object in the graphic view. If the software
locates any nested geometric elements, it displays the icon. Click your mouse wheel to display
the secondary list of the nested geometric elements.
Click your mouse wheel again to select the highlighted item from the QuickPick list.
Press ESC or move your cursor away from the list to exit QuickPick without making a
selection.
You can specify the number of seconds the pointer must rest on an object before the
QuickPick feature is available. For more information, see Set the activation time for
QuickPick (on page 499).
3. Pass the cursor over the object that you want to select until the object highlights.
4. Click the highlighted object to accept it.
5. Click the command that you want to apply to the selected object.
Some commands you can apply include: Hide - to exclude the objects in the active view;
Format > Style - to change the surface style of the objects; Format > View - to change the
way the objects appear; Delete - to delete all the selected objects.
When you are working in a specific task, you can select objects in other disciplines by
changing the locate filter to All. For example, if you are working in the Equipment task, you
can set the filter to All, and then select and modify a structural member.
Typical commands you can apply include: Hide - to exclude the objects in the active view;
Format > Style - to change the surface style of the objects; Format > View - to change the
way the objects are displayed; Delete - to delete all the selected objects.
When you are working in a specific task, you can select objects in other disciplines by
changing the locate filter to All. For example, if you are working in the Equipment task, you
can set the filter to All and then select and modify a structural member.
2. Using the mouse scroll wheel, the keyboard arrow keys, or the mouse, move through the list
to highlight the item in the graphic view.
Press ESC or move your cursor away from the list to exit QuickPick without making a
selection.
Use the gray border to drag the list to another location in the graphic view.
Select by Filter
Selects objects from the workspace using a filter. The filter queries objects in the workspace and
select these to retrieve the specified objects and displays them in the workspace. You define the
search criteria for the filter by selecting specific tabs on the Filter Properties dialog box. After
the software retrieves the objects, you can apply commands such as Copy, Paste, Delete, and
Apply View Style to the entire group.
The Select Filter dialog box allows you to create, edit, delete, and manage different types of
filters in the software. This dialog box appears when you are selecting objects by filter, defining
a workspace, and creating or editing surface style rules. These actions are different, but all of
them use filters as part of their workflow.
Using Filters
A filter is a set of search criteria that helps to select or retrieve data in the model. You use filters
in many ways:
Define the objects you want to include in your workspace. For more information, see Define
Workspace (on page 62).
Select or locate objects based on specific criteria. For more information, see Select by Filter
(on page 354). For example, you can use a filter to locate all hot water tanks in the model,
and then apply a property change to all the tanks.
Apply surface style rules to a group of objects. For more information, see Surface Style
Rules (on page 338).
Create drawings and reports. For more information, see the Drawings and Reports Help.
You can create a new filter by selecting Create New Filter in the Filter box on the Define
Workspace dialog box as you begin a new session. When at least one filter is defined for the
session, you can create a new filter using the Tools > Select by Filter command.
Permission groups and user access levels in the software control the operations you can do with
filters. For example, creating, editing, and deleting filters are subject to access control. To create
filters, you must have Write permissions in the applicable permission group. To view filters, you
must have a minimum of Read permission.
When filters are created, they belong by default to the permission group associated with their
folder. However, you can later modify the filters to belong to a permission group other than the
permission group of the parent folder.
Filter Types
Filters are classified into different groups based on the criteria described in the following table.
Organizing Filters - Filters can be grouped into sub folders under three main delivered Filter
Folders.
Catalog Filters Shared outside the model by multiple models that use the same
catalog. The filter definition must be model independent, and cannot
contain model specific data such as System, Assembly, Named
Space, Permission Group, Work Breakdown Structure, and so
on.
In general, you can reuse catalog filters with Drawing View Styles
and Surface Style Rules commands, and you can also use them
with the Define Workspace and Select by Filter commands. These
filters are generic, and contain only metadata criteria such as object
types and properties, and are shared more extensively than model
filters.
Model Filters Shared by all users within the model, and are saved in the model
database. The filter definition can contain any model specific data.
Most users have read-only permissions to model filters.
My Filters (Personal Filters) A subset of model filters available only to the user who created the
filter within the model. The filter definition can contain model specific
data, and you can modify the definition of any filters you create.
Because these are private filters, you cannot use them with the
Drawing View Styles and Surface View Styles commands. However,
you can use them with the Define Workspace and Select by Filter
commands. My Filters contains the filters you create or modify.
Personal filters are also saved in the model database.
In a Global Workshare configuration, users in different domains who have the same
login could encounter problems with write access in My Filters. For example, this situation can
occur with hostdomain\JohnSmith at the host and satellitedomain\JohnSmith at the satellite. In
this scenario, the user with write access (hostdomain\JohnSmith) should create a child folder
under the original My Filters folder and transfer that child folder to a permission group owned by
the satellite location where satellitedomain\JohnSmith has write access. This operation allows
the satellitedomain\JohnSmith user in the satellite location to create filters and folders within that
child folder.
Simple Filters Prompts for specific values or properties. The properties you select
determine the extent of your search.
Simple filters define all the queries in one form. The default
extension and restriction is sufficient to complete the search.
Compound Filters Combines entire simple filters using logical conditions, such as
AND, OR, or NOT to define complex queries. You can also
combine any catalog filter with any predefined asking model filter
and so on.
You create compound filters in My Filters or Model Filters using
constituent filters folders from Catalog Filters, Model Filters, or My
Filters. The Compound Filters dialog box has Union, Intersection,
and Negation buttons you can use to build statements.
Predefined Queries Filters Uses simple filter definition with some typical predefined queries.
You can select Hierarchical Queries (System, Assembly, Named
Space, Permission Group, Work Breakdown Structure, Reference
3D, Reference, Analysis, and so on), Object Types Query,
Properties Query, or Volume Query (or by Coordinate System
Planes).
Standard Query Language Used when predefined queries are not sufficient. You can create a
(SQL) Filters query using SQL syntax. Type the query text in the SQL Filter
Properties dialog box and click OK. The SQL Filter Properties
dialog box stores the SQL filter in the Model or the Catalog folder.
The SQL filters are listed in the tree view under the appropriate
parent filter folder in the Select Filter dialog box.
Filters Execution - If an asking filter is used with Define Workspace or Select by Filter, the
Filter Properties for Asking Filters dialog box displays. The Asking Filter – user of filter will
supply value option is selected by default when the filter is defined.
Asking Filter Reduces the need for multiple specific individual filters. These
parametric filters prompt for specific values or selection. Filters
such as Catalog or Model have an incomplete definition that
requires user intervention during run time.
Because of this behavior, you can use asking filters with Define
Workspace and Select by Filter. Asking filters provide universal
and flexible usage. These filters are optimal for Model filters which
cannot be modified by most of the users, but can be used easily.
Asking filters are identified with a green question mark.
Silent Filter Silent (non-parametric) filters are exactly opposite to Asking filters.
These filters have complete definition and can be run directly, and
are used in non-interactive modes such as Drawing View Styles
and Surface Style Rules.
You can use asking filters interactively. Their use is limited in commands and
features. You can use bulk filters to execute queries in batch mode or by background process.
Some examples are Surface Style Rules with many rules using filters, or Drawing View Styles
where filters are used for respective tests during run time.
When you create or modify a filter, you must specify the search criteria on the Filter Properties
dialog box. The properties you select determine the extent of the search. For example, the
System, Assembly, or Named Space tabs on the Filter Properties dialog box provide for
extensive searches, while the Properties, Volume, Permission Group, and Object Type tabs
assist with more restrictive searches. The Configuration tab specifies the permission group
assignment of the filter. The Work Breakdown Structure (WBS) tab identifies objects in the
selected WBS for the filter. For example, you can select projects, contracts, or documents from
the WBS.
You cannot create new folders under the Model Filters folder unless you have permission.
The typical purpose for creating a new folder is to place one or more filters within it. You can
place your filters in the folder before you exit the Select Filter dialog box. Otherwise, click
Cancel to exit the Select Filter dialog box without applying a filter to the view. The new
folder remains in the tree view.
5. Select the Include nested objects option if you want the search to include all objects within
a category. Otherwise, you must separately select each category and individual object.
6. Use the System tab to navigate the tree list to the systems to include in the query. These
systems include the model root at the highest point of the hierarchy, as well as all
subsystems, and specific types of objects. Select the Include nested objects option, if you
want to include all objects under specified System nodes.
7. Use the Assembly tab to navigate the tree view and select the assemblies to include in the
search. Select the Include nested objects option, if you want to include all objects under
specified Assembly nodes.
8. Use the Named Space tab to indicate the named spaces and drawing volumes to include in
the search. Select the Include nested objects option, if you want to include all objects
under specified Space nodes.
The Select Properties dialog box browses the data model to select properties on types.
In the Property column, click More.
The Select Object Type dialog box specifies an object type for a property. You access
this dialog box by clicking More in the Object type box on the Select Properties dialog
box.
15. Use the PDS tab (if available) to include objects from PDS.
16. Use the Reference 3D tab (if available) to include any attached reference 3D models,
folders or files in the query.
17. Click OK on the New Filter dialog box to save the new filter and apply it to the selected
objects in the workspace.
Use the Configuration tab to designate the options and configuration information for the
filter. You can specify filter status and the associated permission group. These settings have
no effect on the objects that the search returns. They govern the access permissions on the
filter itself.
An asking filter can have specific selection of filter definitions excluded, but have the Asking
Filter - user of filter will supply value selected. You can specify these values when you
use the filter. For more information about creating an asking filter, see Create a new asking
filter (on page 362).
A compound filter combines two or more filters by using an operator, such as not, union, or
intersection, between the filters to explain the relationship between the filters. For more
information about creating a compound filter, see Create a New Compound Filter (on page
363).
When you apply the asking filter, the software displays the Filter Properties dialog box to
specify the search criteria. Also, the software sequentially presents each tab for which you
selected the Asking Filter - user of filter will supply value option when you created the
filter. You select values to define the filter at runtime. For example, you selected the Asking
Filter - user of filter will supply value option on the System and Permission Group tabs
when you created the filter.
When you apply the filter, the Filter Properties dialog box opens. You must select some
systems from the hierarchy on the System tab and permission groups from the hierarchy on
the Permission Group tab.
If you use SQL or Oracle reserved keywords in your query, you must place square brackets
[] around the words. Also, if you include spaces in property names, you must place brackets
around the names.
You can use SQL filters inside compound filters. A compound filter combines two or more
filters by using an operator, such as not, union, or intersection, between the filters to
explain the relationship between the filters.
5. Click Add to String to place the filter name in the text box at the bottom of the New
Compound Filter dialog box. To build the filter string, use the operator buttons for a union,
intersection, the not operator, and parentheses for priorities in sequencing.
For example, if you want a string that builds a filter to include objects found by both the
Company_Filter1 and Company_Filter2, and you want all of the objects found by
Gate_Valve_0902, one of your personal filters, then the statement reads
(Company_Filter1 and Company_Filter2) or Gate_Valve_0902.
To remove a filter or a SQL operator from the compound filter definition, click the filter or
operator in the text box, and then click Delete or press Backspace.
6. To review the properties of a filter, select the filter name in the query statement and click
Properties on the New Compound Filter dialog box. Also, you can right-click the filter in
the tree view of the Select Filter dialog box and click Properties. The Compound Filter
Properties dialog box opens.
After you click OK, the Select Filter dialog box opens and now includes the new
compound filter in the tree view.
A compound filter combines two or more filters by using an operator, such as not, union, or
intersection between the filters to explain the relationship between the filters.
You can create a compound filter in the My Filters folder or Model Filters folder using
constituent filters folders from any of the Catalog Filters, Model Filters, or My Filters
folders. Command buttons such as Union, Intersection, and Negation are available on the
Compound Filters dialog box for assistance in building statements.
You must use the and operator together with the not operator. Do not use the not operator
by itself. The following example shows the correct syntax: Create a new model filter and
select the root node for the model on the System tab. Name the filter All System. Create
another model filter and select a part (a unit) from the Model list on the System tab. Name
this second filter Part Unit. In the Filter box, click More. In the New Filter section, click
Compound and select the All System filter. Type the following string: All System AND
NOT Part unit.
Rename a filter
1. Open the Select Filter dialog box.
You can either click Tools > Select by Filter, or select More from the Filter list in
the Define Workspace dialog box or the Surface Style Rule properties.
2. Select the filter you want to rename on the Select Filter dialog box.
You cannot rename filters in the Model Filters folder unless you have permission.
3. Click Rename .
4. Type a new name for the filter.
Filter names must be unique within the folder. You can have a filter in your My
Filters folder with the same name as a filter in another folder. If you move a filter into a
folder that already contains a filter of the same name, the software adds a numeric suffix to
the filter name to keep the filter names unique.
5. Click elsewhere in the view on the dialog box to save the new name.
Click Cancel to exit the Select Filter dialog box. The filter you renamed remains in
the tree view.
There are several commands available in the right-click shortcut menu when renaming a filter.
Below is a list of shortcut commands:
Cut - Cuts the selected text to the Clipboard.
Copy - Copies the selected text to the Clipboard.
Paste - Inserts the Clipboard contents. This command is enabled after you copy text.
Delete - Removes the selected text.
Move a filter
1. Open the Select Filter dialog box.
You can either click Tools > Select by Filter, or select More from the Filter list in
the Define Workspace dialog box or the Surface Style Rule properties.
2. In the Select Filter dialog box, click the folder you want to move and drag it to the target
folder.
You cannot move a filter unless you have the required permissions.
When you move a model filter to the Catalog Filters folder, all of the
model-specific definitions are removed and the model filter is changed to an asking filter.
This restricts its usage to interactive only.
Copy a filter
1. Open the Select Filter dialog box.
You can either click Tools > Select by Filter, or select More from the Filter list in
the Define Workspace dialog box or the Surface Style Rule properties.
2. In the Select Filter dialog box, CTRL+ click and drag the folder you want to copy to the
target folder.
You can also use the shortcut menu Copy and Paste commands to copy the filter.
You cannot copy a filter unless you have the required permissions in the target folder.
When you copy a model filter to the Catalog Filters folder, all of the
model-specific definitions are removed and the model filter is changed to an asking filter.
This restricts its usage to interactive only.
Delete a filter
1. Open the Select Filter dialog box.
You can either click Tools > Select by Filter, or select More from the Filter list in
the Define Workspace dialog box or the Surface Style Rule properties.
2. Select the filter you want to delete, and click Delete .
You cannot edit a model filter unless you have permission.
The list displays these types of filters: catalog filters, model filters, and personal filters.
Choose from any of the filters.
In the My Filters list, you can maintain your own filters and modify them for ad-hoc filter
definition.
You can select multiple filters by holding down the SHIFT and CTRL keys.
Delete
Removes a filter or folder from the Select Filter list. If you delete a folder, the software also
deletes its contents.
Rename
Changes the name of an existing filter or folder from the Select Filter list.
Properties
Displays the Filter Properties dialog box so you can select the properties that determine
your filter search criteria.
If this dialog box is activated from the Select by Filter command, you can select multiple
filters on this dialog box. Hold CTRL or SHIFT, and click each filter. When you click OK, all
objects that fit the selected filters are selected.
If this dialog box is activated from the Select by Filter command, it clears the select set
before adding objects to the select set.
See Also
Select by Filter (on page 354)
Select Objects by Filter (on page 367)
When the New dialog box appears, the default is always the last selected option.
When you double-click a filter on the Select Filter dialog box, the software applies the filter
and dismisses the dialog box.
Topics
System Tab (Filter Properties Dialog Box) .................................... 373
Assembly Tab (Filter Properties Dialog Box) ................................ 374
Named Space Tab (Filter Properties Dialog Box) ......................... 375
Analysis Tab (Filter Properties Dialog Box) .................................. 375
Work Breakdown Structure Tab (Filter Properties Dialog Box) ..... 376
Permission Group Tab (Filter Properties Dialog Box) ................... 377
Object Type Tab (Filter Properties Dialog Box) ............................ 377
Volume Tab (Filter Properties Dialog Box).................................... 378
Properties Tab (Filter Properties Dialog Box) ............................... 379
PDS Tab (Filter Properties Dialog Box) ........................................ 380
Reference Tab (Filter Properties Dialog Box) ............................... 380
Reference 3D Tab (Filter Properties Dialog Box).......................... 381
Configuration Tab ......................................................................... 381
You can select the Include nested objects option to specify whether you want your search
criteria to include all objects within a System. For example, if you select this option, the software
selects all children objects when you select a parent system. If you do not select this option, you
select only the systems. You can also use the CTRL and SHIFT keys to select multiple objects
on this tab.
Nodes with more than 1000 children display in bold type rather than auto-expanding if some of
their children are selected in the filter properties. The selected child nodes highlight when you
expand the parent node.
You can select the Include nested objects option to specify whether you want your search
criteria to include all objects within a category. For example, if you select this option, the
software selects all objects when you select a category. If you do not select this option, you
select the assembly objects separately. You can also use the CTRL and SHIFT keys to select
multiple objects on this tab.
The Include nested assemblies only option includes all nested assemblies, assembly blocks,
blocks, spools, and penetration spools under the selected assemblies, but not the parts.
The Include nested assemblies only option explicitly includes the assemblies and
assembly parents that you are working on so that the Refresh Workspace command
updates the assembly information without including all of the many parts nested under the
selected assemblies, such as plate parts, that are not of interest.
Only one of the Include nested objects and Include nested assemblies only options can
be selected. Both options can be unchecked.
Named spaces are regions in the model, like fire or blast zones. Filtering on named spaces is
useful particularly when you work in the Space Management task and need to see the size,
shape, and position of the named spaces that already exist. Drawing volumes are used in the
Drawings and Reports task in the drawing creation process.
You can select the Include nested objects option to specify whether you want your search
criteria to include all objects within a category. For example, if you select this option, the
software selects all objects when you select a category. If you do not select this option, you
select the category and individual objects separately. You can also use the CTRL and SHIFT
keys to select multiple objects on this tab.
Analysis models are associated with the Structural Analysis task in the software. An analysis
model is a non- graphical and logical grouping of member systems that can be sent to a
third-party analysis and design solver package.
You can select the Include nested objects option to specify whether you want your search
criteria to include all objects within a category. For example, if you select this option, the
software selects all objects when you select a category. If you do not select this option, you
select the category and individual objects separately. You can also use the CTRL and SHIFT
keys to select multiple objects on this tab.
A simple filter shows only objects that have been assigned to the selected WBS items
and the WBS items themselves. To see WBS objects on the Workspace Explorer tab, you
must create a compound filter. In other words, if a filter is defined that contains only one WBS
project, this filter would return the WBS project selected on the WBS tab of the Workspace
Explorer and any objects assigned to that particular WBS project on the Systems tab in the
Workspace Explorer. To see all WBS objects on the WBS tab in the Workspace Explorer,
you must create a compound filter. For example, you might create a filter that contains All
Systems OR WBS Objects. This filter would return all objects on the Systems tab and all WBS
objects.
The WBS is the breakdown of the model by the construction work to be performed. The
breakdown can consist of the model at the top level, as well as projects, contracts, and
documents. You can modify a property for an object to associate it to a project. You can
associate published documents to a contract and then reassign the document from one contract
to another. Objects are associated to a document.
You can select the Include nested objects option to specify whether you want your search
criteria to include all objects within a category. For example, if you select this option, the
software selects all objects when you select a category. If you do not select this option, you
select the category and individual objects separately. You can also use the CTRL and SHIFT
keys to select multiple objects on this tab.
This tab provides a list of all the major object types you can include in your search. The filter
selects the objects you highlight. If you do not select any objects, the filter includes all objects in
the list. To include one or more object types in your filter, press CTRL and click the name of
each object type that you want to include.
Define by
Named spaces
Displays a tree view of the Space hierarchy from which you can choose one or more spaces
to include in your search. This option is useful for filtering all objects located within specific
spaces. In addition to selecting all the objects inside the specified named spaces, the
software retrieves the space itself. You do not need to select the object on the Named
Space tab as well. To select a particular named space, press CTRL and click as many
spaces as you want to include in your search. If you do not select any named spaces, the
filter includes all objects in all named spaces.
Planes
Displays a tree view of the reference coordinate system hierarchy in the window, and a
group of first and second position coordinate boxes at the bottom. The coordinate system
hierarchy is a list of predefined coordinate systems for the model, each having a different
origin point. For example, one coordinate system might have an origin point at the corner of
a boiler room, another at the center of the building, and so forth.
When you select one of these coordinate systems, the software displays a list of coordinate
planes for that system. By selecting a plane and specifying the first and second positions
along that plane, your filter selects all objects that fall between the two positions on that
plane. The positions automatically appear in the first and second position boxes at the
bottom of the dialog box. This option is useful when you want to select objects that are all on
a specific level or plane. You can hold CTRL to select the first and second positions in the
tree view.
Coordinate system
Specify a coordinate system in this box. You can define coordinate systems in the Grids
task.
Filter Method
You can combine multiple properties on individual rows.
Match All
Returns only those objects matching ALL of the properties listed in the grid. This method is
the same as using the Boolean operator AND.
Match Any
Returns objects matching any one or more of the properties listed in the grid. This method is
the same as using the Boolean operator OR.
Property
Lists the properties of objects in the data model. To select properties and set their data type,
select More in the field drop-down. For more information, see Select Properties Dialog Box
(on page 384).
Operator
Select an operator such as <> (not equal) or = (equal).
If you are using a wildcard character (asterisk *), you must use the Contains
comparison operator. For example, pumps P-1000A and P-1000B exist in the model. To
query for the pumps using properties, select Match All and type Name Contains P*.
If your query involves PDS objects, use the <> and = operators only.
Value
Select the value of the property.
Ask
Creates Asking Filter that allows you to specify a value for the property when you run the
filter. The Ask column is so named because the software asks or prompts you to type a
value. An administrator or other user with the required permissions establishes the asking
filter and defines a default value. While defining a workspace, you can type a different value
for the property. This is not a valid option for Model Data Reuse.
Remove
Removes the selected property from the grid.
You can also use the CTRL and SHIFT keys to select multiple objects on this tab.
To view this tab, you must first insert a file using the Insert > File command. For more
information, see Insert File (on page 273).
When you copy a filter that contains Reference tab information into the Catalog or into a
different Model database, the software removes the Reference tab information. Because of
this, you cannot create a compound filter that uses Reference tab information. Filters that
use Reference tab information are hidden from the tree view on the Compound Filter
dialog box. You can specify PDS information when you edit an individual filter used by a
compound filter, but the compound filter ignores any Reference tab information.
You can also use the CTRL and SHIFT keys to select multiple objects on this tab.
When you copy a filter that contains Reference 3D tab information into the Catalog or
into a different Model database, the software removes the Reference 3D tab information.
Configuration Tab
Displays the creation, modification, and status information about an object.
You cannot define the filters using the Configuration tab.
Model
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the object belongs. You can select another
permission group, if needed. Permission groups are created in Project Management.
Transfer
Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group. This option is only available if the active model or
project is replicated in a workshare configuration. The option is not available if all of the
objects in the select set already belong to another location and are non-transferable. For
more information, see Transfer Ownership Dialog Box in the Common User's Guide.
Approval State
Specifies the status of the selected object or filter. The display depends on your access
level. You might be unable to change the status of the object. The list is defined by the
ApprovalStatus codelist.
You can only edit or manipulate an object with a status of Working.Status
Specifies the location of the object in the workflow process. Changing this property sets the
Approval State. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file. For more information, see
ApprovalReason in the Reference Data Guide.
Date Created
Specifies the creation date of the object.
Created by
Specifies the name of the person who created the object.
Date Last Modified
Specifies the date of the last modification to the object.
Last Modified by
Specifies the name of the person who last modified the object.
)
Specifies or inserts the right parenthesis, which ends a priority for the operators. The
software inserts the parenthesis at the location you indicate in the string in the text box.
Place pointer in the text box where you want to add a filter name or operator
Instructs you to click the text box at the location to add a filter or SQL operator to the
compound filter definition, and allows you to remove a filter or SQL operator from the
compound filter definition.
To remove a filter or SQL operator from the compound filter definition, click the filter
or SQL operator in the text box, and then click Delete or press Backspace.
Delete
Removes the selected filter or operator from the compound filter definition.
Clear All
Removes the object definition.
You are not required to use parentheses in a statement, but parentheses provide
structure that is easier to follow, especially in a complex statement. Without the parentheses, an
SQL statement follows a default order of operations. Specify Not operators first, followed by
And operators and then the Or operators. For example, in the statement X And Y Or Not Z, the
Not operator is processed first, followed by And and finally Or. To change this order, you must
use parentheses.
Compounding is not supported on filters containing filtering criteria on PDS,
Reference Files tab, and Reference 3D tab.
See Also
Create a new filter (on page 360)
Create a new filter folder (on page 360)
Select by Filter (on page 354)
Show
Turns on the graphical display of objects in the select set. To select a hidden object, select its
name in the Workspace Explorer. The names of hidden objects appear in italics in the
Workspace Explorer.
You must use Tools > Show All to redisplay a hidden reference 3D object.
Hide
Turns off the graphical display of selected objects in the workspace. The names of hidden
objects appear in italics in the Workspace Explorer.
If you hide an object while the related tab of the Workspace Explorer is active, the
child objects are automatically hidden. For example, if the System tab is active when you hide a
system object, then all of the children objects are also hidden. If the related WSE tab is not
active, only the object that you specifically select is hidden. For example, if you hide a pipe run
while the Space tab is active, the child parts of the pipe run are not hidden.
Hide an object
The Tools > Hide command makes all selected objects in the current workspace invisible.
1. In a graphic view or in the Workspace Explorer, select the object(s) you want to hide.
2. Click Tools > Hide.
You can use the Select by Filter command to place a group of objects in the select set.
Show All
Displays all graphically hidden objects in the workspace without having to select them
individually. You must use this command to redisplay a hidden Reference 3D object.
PinPoint
(Plant) or (Ship) Helps you move, place, or modify objects with precision by displaying
coordinate data at the pointer. The PinPoint command is located on the Tools menu. When you
turn PinPoint on, the PinPoint ribbon displays coordinates relative to a target position you set.
You can reset the target position at any time. Also, PinPoint provides a way to define a
temporary coordinate system with a new origin and axis directions different from those of the
global coordinate system.
You can use the PinPoint command while other commands such as Place Equipment are
running.
PinPoint Orientation
In its default orientation, the axes are set by the active coordinate system. You can re-orient the
axes by defining a temporary coordinate system using the Define Coordinate System by 3
Points or command on the PinPoint ribbon.
If you select a different coordinate system in Coordinate System box, then you must
click Set Target to Origin or to set the selected coordinate system as the origin.
PinPoint Ribbon
Sets options for moving or placing objects with precision.
Changes the location of the target point. The E (X), N (Y), and EL (Z) coordinates are
relative to the previous position of the target. Also, you can reposition the PinPoint target by
pressing F12.
Rectangular Coordinates
Rectangular Coordinates
Specifies the rectangular coordinates mode for the PinPoint command. This is the default
PinPoint mode. The following settings are added to the right side of the ribbon:
Step - Specifies the PinPoint step value, which is an incremental distance along the
PinPoint coordinate axes. As you use PinPoint, your pointer snaps to locations
corresponding to the step value. You can select a step value from the list in this box, or
you can type your own value.
E or X - Sets the distance along the E-axis or X-axis of the active coordinate system
between the target point and the current pointer location to the value that you type. The
shortcut key to lock/unlock this box is F6.
N or Y - Sets the distance along the N-axis or Y-axis of the active coordinate system
between the target point and the current pointer location to the value that you type. The
shortcut key to lock/unlock this box is F7.
EL or Z - Sets the distance along the EL-axis or Z-axis of the active coordinate system
between the target point and the current pointer location to the value that you type. The
shortcut key to lock/unlock this box is F8.
Use single or double quotation marks to enclose the reference name plane. The reference
plane must belong to the active coordinate system.
Multiplication is supported. Parentheses are not supported as part of input, but the software
uses standard computation operator precedence. However, expressions involving
multiplication should use only one length unit. Examples include 'F13' + 2*4m*3 and
"F13"-2*3*4m, - 3*4cm-3m*2+6".
If an error occurs because of an invalid expression, see the Troubleshooting Reference
Guide available from Help > Printable Guides for more information.
Spherical Coordinates
Spherical Coordinates
Specifies the spherical coordinates mode for the PinPoint command. The following settings
are added to the right side of the ribbon:
Distance - Sets the distance between the target and the pointer location. The shortcut
key to lock/unlock this box is F6.
Horizontal - Sets the horizontal angle, which is measured clockwise from the N-axis or
Y-axis. This angle is in the horizontal plane. The shortcut key to lock/unlock this box is
F7.
Vertical - Sets the vertical angle, which is measured counter-clockwise from plan
horizontal. This angle is from the horizontal plane. The shortcut key to lock/unlock this
box is F8.
When you use spherical coordinates and lock the absolute distance, you must also
lock at least one of the angle boxes on the ribbon. You cannot unlock an angle while the
absolute distance is locked and no other angle is locked.
Cylindrical Coordinates
Cylindrical Coordinates
Specifies the cylindrical coordinates mode for the PinPoint command. The following
settings are added to the right side of the ribbon:
Radius - Sets the radius of the cylinder. The shortcut key to lock/unlock this box is F6.
Theta - Sets the horizontal angle, measured from North and clockwise. The shortcut key
to lock/unlock this box is F7.
Z - Sets the height of the cylinder. The shortcut key to lock/unlock this box is F8.
The following graphic represents how the cylindrical measurements are set:
4. On the Common toolbar, click PinPoint to activate the PinPoint ribbon bar.
Click Display On/Off to turn the PinPoint display on and off. You can also
press F9 to toggle the PinPoint display on and off.
5. In the Coordinate System box, select a coordinate system in the list as the reference point.
Global - Global coordinate system is the default option. You cannot modify a global
coordinate system.
Select Graphically - Allows you to specify a coordinate system graphically in the active
window. Follow the instructions that appear in the status bar.
More - Displays the Select Coordinate System dialog box. Select a coordinate system
from the Workspace or Database.
6. After you select an active coordinate system, click Set Target to Origin (plant) or
(ship).
The software considers the targeted position as the new origin from which the distance
will be measured. The target position does not change when you change the active
coordinate system.
The Rectangular Coordinates is the default mode for PinPoint.
7. Set the distance along E-axis (plant) or X-axis (ship), and then click Lock/Unlock Absolute
Distance to lock the value.
9. Click in the graphic view to place the object at the pin-pointed location.
The software places the object at the pin-pointed location.
4. On the Common toolbar, click PinPoint to activate the PinPoint ribbon bar.
Click Display On/Off to turn the PinPoint display on and off. You can also
press F9 to toggle the PinPoint display on and off.
5. In the Coordinate System box, select a coordinate system in the list as the reference point.
Global - Global coordinate system is the default option. You cannot modify a global
coordinate system.
Select Graphically - Allows you to specify a coordinate system graphically in the active
window. Follow the instructions that appear in the status bar.
More - Displays the Select Coordinate System dialog box. Select a coordinate system
from the Workspace or Database.
6. After you select an active coordinate system, click Set Target to Origin (plant) or
(ship).
The software considers the targeted position as the new origin from which the
distance will be measured. The target position does not change when you change the active
coordinate system.
7. Click Spherical Coordinates .
The spherical value settings display on the right side of the ribbon.
8. Set the Distance value, and then click Lock/Unlock Absolute Distance to lock the
value. Absolute distance is the distance between the target and the pointer location.
The shortcut key to lock/unlock this value is F6.
When you lock the Distance value, the software automatically locks the
Vertical angle with a default value. You cannot unlock an angle while the absolute distance
is locked and no other angle is locked.
9. Set the Horizontal angle, and then click Lock/Unlock Absolute Distance to lock the
value. This angle is in the horizontal plane and is measured clockwise from the N-axis
(plant) or Y-axis (ship).
The shortcut key to lock/unlock this value is F7.
10. If necessary, set the Vertical angle. Click Lock/Unlock Absolute Distance to unlock
the value, and then lock after specifying a new value. This angle is measured
counter-clockwise from horizontal plane.
The shortcut key to lock/unlock this value is F8.
11. Click in the graphic view to place the object at the pin-pointed location.
The software places the object at the pin-pointed location.
The PinPoint command uses the highlight and selected element colors. You can set these
colors on the Tools > Options dialog box. For more information, see Change a Default
Color (on page 496).
Click Display On/Off to turn the PinPoint display on and off. You can also
press F9 to toggle the PinPoint display on and off.
5. In the Coordinate System box, select a coordinate system in the list as the reference point.
Global - Global coordinate system is the default option. You cannot modify a global
coordinate system.
Select Graphically - Allows you to specify a coordinate system graphically in the active
window. Follow the instructions that appear in the status bar.
More - Displays the Select Coordinate System dialog box. Select a coordinate system
from the Workspace or Database.
6. After you select an active coordinate system, click Set Target to Origin (plant) or
(ship).
The software considers the targeted position as the new origin from which the
distance will be measured. The target position does not change when you change the active
coordinate system.
7. Click Cylindrical Coordinates .
The cylindrical value settings display on the right side of the ribbon.
8. Set the Radius value for the cylinder, and then and then click Lock/Unlock Absolute
Distance to lock the value.
The shortcut key to lock/unlock this value is F6.
9. If necessary, set the Z value. Click Lock/Unlock Absolute Distance to unlock the
value, and then lock after specifying a new value. This is the height of the cylinder.
The shortcut key to lock/unlock this value is F8.
10. Set the Theta value, and then click Lock/Unlock Absolute Distance to lock the value.
This angle is in the horizontal plane and is measured clockwise from the N-axis (plant) or
Y-axis (ship).
The shortcut key to lock/unlock this value is F7.
11. Click in the graphic view to place the object at the pin-pointed location.
The software places the object at the pin-pointed location.
The PinPoint command uses the highlight and selected element colors. You can set
these colors on the Tools > Options dialog box. For more information, see Change a Default
Color (on page 496).
SmartSketch Options
Displays a floating toolbar of SmartSketch options. You can click the options to turn them on
and off as you make selections in the graphic view for other commands.
Intersection
Displays when you move the pointer over points where two or more objects overlap.
Key point
Displays when you move the pointer over the end of an element to which you can attach
other elements.
Parallel
Displays when you place an object parallel to another object in your workspace. When
this indicator appears, the software highlights the parallel objects. For example, if you add a
section of pipe that runs parallel to another piece of pipe anywhere in your workspace, this
indicator appears, and both objects are highlighted.
Perpendicular
Displays when you move the pointer so that a perpendicular relationship between two
objects is recognized. For instance, when you connect two pipes at a 90 degree angle, this
indicator appears.
Center point
Displays when you move the pointer over the center of a circle or arc.
Point on curve
Displays when you move the pointer over any connection point on an object, such as a
nozzle on a piece of equipment.
Reference axis aligned
Displays when you move the pointer so that the object that you are placing is aligned
with either the E-, N-, EL-axis (X-, Y-, Z-axis) of the active coordinate system. For example,
if you are routing a pipe that moves parallel to the E-axis (X-axis), this indicator appears.
Show me
Displays when you move the pointer over an equipment nozzle or other port. Press F2
to toggle this option on and off.
Point on surface
Displays when you move the pointer over any location point on a surface object, such as
a slab. Press F3 to toggle the option on and off.
Edges on solids
Displays when you move the pointer over the edge of a solid object.
Silhouette edges
Displays when you move the pointer over the silhouette edges of surfaces. The
silhouette edges are the outside edges of the surface with respect to your view.
Divisor point
Displays when you move the pointer to the points where a line divides equally for the
number of divisions that you set. A drop down list lets you choose from 2 to 7 divisions for
the line. For example, if you select 4 for the number of divisions, you get a divisor point at ¼,
½, and ¾ of the length.
Offset
Displays when you move the pointer to a location that is the specified offset from a
selected element or line. Offset also displays Offset from surface.
You must define a projection plane to use Offset.
Offset from surface - Displays when you point to the location of a line that is offset from
the intersection of your selected projection plane with a surface that is in the SmartSketch
locate list. For example, if you are locating the end of a pipe, the indicator appears along the
line that is offset from the intersection of the projection plane with the web plane.
The offset line is often easiest to locate if your view direction is perpendicular to the
projection plane.
Locate only from list
Specifies that the software locates objects on the SmartSketch list defined when you use
Add to SmarkSketch List . For more information, see Add to SmartSketch List (on page
403).
Select
Selects objects in the model. You can also click the other buttons on this ribbon to set
SmartSketch options.
Clears the List
Removes all objects from the locate list.
Locate on List Only
Specifies that the software locates objects on the SmartSketch list from the bottom of the list
up, which means that surfaces, ports, and so forth are all available for location.
List size
Specifies the number of objects on the list.
Dwell time
Specifies the time that you must pause the pointer over the object to add it to the list.
Displays when you move the pointer to a location that is the specified offset from a
selected element or line. Offset also displays Offset from surface.
You must define a projection plane to use Offset.
Offset from surface - Displays when you point to the location of a line that is offset from
the intersection of your selected projection plane with a surface that is in the SmartSketch
locate list. For example, if you are locating the end of a pipe, the indicator appears along the
line that is offset from the intersection of the projection plane with the web plane.
The offset line is often easiest to locate if your view direction is perpendicular to the
projection plane.
Key point
Displays when you move the pointer over the end of an element to which you can attach
other elements.
Show me
Displays when you move the pointer over an equipment nozzle or other port. Press F2
to toggle this option on and off.
Show me nozzles
Show me pipe ends
Divisor point
Displays when you move the pointer to the points where a line divides equally for the
number of divisions that you set. A drop down list lets you choose from 2 to 7 divisions for
the line. For example, if you select 4 for the number of divisions, you get a divisor point at ¼,
½, and ¾ of the length.
Show me
Center point
Displays when you move the pointer over the center of a circle or arc.
Point on curve
Displays when you move the pointer over any connection point on an object, such as a
nozzle on a piece of equipment.
Point on surface
Displays when you move the pointer over any location point on a surface object, such as
a slab. Press F3 to toggle the option on and off.
Show me
Edges on solids
Displays when you move the pointer over the edge of a solid object.
Perpendicular
Displays when you move the pointer so that a perpendicular relationship between two
objects is recognized. For instance, when you connect two pipes at a 90 degree angle, this
indicator appears.
Tangent
Displays when you move the pointer over a point of tangency to an object.
Silhouette edges
Displays when you move the pointer over the silhouette edges of surfaces. The
silhouette edges are the outside edges of the surface with respect to your view.
Minimum/maximum point
Displays when you move the pointer over a point that is the given offset in the locked
direction from the minimum/maximum point on a curve. A projection plane must be defined,
and a line or axis constraint must be locked.
Locate only from list
Specifies that the software locates objects on the SmartSketch list defined when you use
Add to SmarkSketch List . For more information, see Add to SmartSketch List (on page
403).
Many of the Add to SmartSketch List controls also are available on the SmartSketch tab
of the Options dialog box.
You can press F3 to toggle the relationship indicator for locating surfaces on and off.
Press and hold X to temporarily disable SmartSketch.
The shortcut keys to turn on SmartSketch select mode are CTRL+D.
To clear the SmartSketch list, press CTRL + SHIFT + D.
The shortcut keys to set a lock constraint in SmartSketch are CTRL+L.
4. Click Locate on List Only to specify that the software locates objects on the list from the
bottom of the list up.
5. Select a number in the List size box to change the maximum number of objects on the
locate list.
6. Type a number in the Dwell time box to specify the time in seconds that you pause over an
object to add it to the locate list.
7. Click Select to choose objects in the graphic view you want to add to the locate list.
8. Click Finish to complete the selection and close the command.
Many of the Add to SmartSketch List controls also are available on the SmartSketch tab
of the Options dialog box.
Press CTRL+D to add the selected object to the SmartSketch List.
Press CTRL+L to lock the constraint in SmartSketch.
Get Point
Locates the centroid of planar faces, cylinders, curves, spheres, boxes, circles, and lines
and places a sphere that provides visual feedback. The Tools > Get Point command prompts
you to select a surface, and then it generates the point that can be used as a SmartSketch
glyph.
View manipulations are currently not possible with the Get Point command.
If you click in the Workspace Explorer, the command continues to wait for a graphical
point on a surface.
If you click in an empty graphical space, the command continues to wait for a graphical
point on a surface.
If you move the pointer over various objects in the model, whole objects highlight.
If you pause over the object where you want to select a specific surface, the QuickPick
question mark appears. Click, and then the QuickPick bar appears.
If you right-click, the command ends.
If you click another major command, the command ends.
2. Click on a surface.
The centroid of the surface gets stored as a SmartSketch glyph. The point can then be
picked for any active command that uses the point glyph.
Example Workflow
1. Click Tools > Get Point or use the button on the toolbar.
The Get Point command prompts you to select a surface.
2. Pause over the object where you want to select a specific surface.
The QuickPick question mark appears.
Point Along
Use the Tools > Point Along command to help you place an object at a specific location
along a path. A path can be along a pipe, duct, cableway, or the intersection line between two
surfaces. You can measure:
Along object, which is the distance along an element, such as along the surface of a pipe
Orthogonal, which is the distance in the E-, N-, or EL-axis (X-, Y-, or Z-axis) direction from
the reference point of the active coordinate system last defined by PinPoint.
Select a reference point from which to start measuring. As you move your pointer, the Distance
box on the Point Along ribbon indicates the exact distance from the reference point to the
location of your pointer. Key in a distance in the Distance box to lock your pointer that far from
the reference point.
Reference Point
Identifies a point from which to measure. This point should be located on the reference
element. You can use SmartSketch relationship indicators to assist you when setting the
reference point. To turn on the SmartSketch relationship indicators, use the SmartSketch
tab on the Tools > Options dialog box.
Direction
Identifies the direction in which to measure. You can select Along object, which measures
along a selected element, or you can select the E, N, EL or X, Y, Z-direction to measure
orthogonally.
Step
Specifies a step distance from a reference point. The step distance is the incremental
distance at which the software finds points. For example, if you want to insert valves at
five-foot increments along a pipe, you can use this feature. This value must be a positive
number. This option is not available if you type a value in the Distance box.
Distance
Specifies the distance that you want to measure from the reference point in the specified
direction. Typing a value in this box is optional. If you type a value, it must be greater than
zero. If you do not type a value, the distance from the Reference Point to your pointer
displays.
Measure
Measures distances and angles between objects in the model, including edges, faces, and
key points.
With the Tools > Measure command, you can:
Measure the actual 3D linear distance between two points.
Measure the delta E- (X), N- (Y), and EL- (Z) distance using the last active coordinate
system defined in the PinPoint or Measure commands.
Measure distance along an object, like the Point Along command, or the entire length of an
object.
Measure minimum distance between two objects, using the outside surface and not just the
axis.
Measure the minimum distance between two objects as projected to a selected plane.
Measure and display hole radius and diameter as well as measure and display fillet radius.
Measure the actual angle defined by three points.
Measure angle between lines, using cylinder axes or nozzle axes as reference lines.
Find SmartSketch points when the software prompts you to locate a start or end point to
measure.
Copy measurement values from the ribbon. The Measure command also sums repeated
measurements and displays the cumulative results on the ribbon.
When you move the pointer over a key point, the distance between the current location of the
pointer and the last point that you clicked displays next to the pointer in text and on the ribbon
along with the delta values. The delta values are the distances, as measured along the E- (X),
N- (Y), and EL- (Z) axes.
You can change the displayed units of measure for distance or angle by using the Tools >
Options command.
You can use the Measure command to set the active coordinate system,
which is a temporary coordinate system with a new origin and axis directions different from
those of the global coordinate system. The active coordinate system affects certain calculations,
such as weight and CG.
Measure Ribbon
Sets options for measuring distances and angles by three-dimensional representation of the E-,
N-, and EL-axes (X-, Y-, and Z-axes).
Elevation Plane - East West - Calculates the minimum distance along the north
and elevation coordinates and displays it on the ribbon bar. The distance also displays
in the graphic view using the annotation texts at the middle point of the solid yellow
lines.
Elevation Plane - North South - Calculates the minimum distance along the east
and elevation coordinates and displays it on the ribbon bar. The distance also displays
in the graphic view using the annotation texts at the middle point of the solid yellow
lines.
Clear
Resets the Cumulative box to zero.
Cumulative
Sums repeated measurements until you clear this box or switch between angle and distance
modes.
The remaining controls on the ribbon (defined below) depend on your selection of measuring
distance, minimum distance, or angle.
Measuring Distance
Distance
Displays the distance value. You can specify the units by clicking Tools > Options and
selecting the Units of Measure tab. For more information, see Change a displayed unit of
measure (on page 497).
East (X)
Displays the distance along the E-axis (X-axis).
North (Y)
Displays the distance along the N-axis (Y-axis).
Elevation (Z)
Displays the distance along the EL-axis (Z-axis).
Diameter
Displays the diameter of the object.
Measuring Angles
Angle
Displays the angle measurement. You can specify the units by clicking Tools > Options
and selecting the Units of Measure tab.
Apparent angle
Measures the angle of the lines projected onto the active view plane. If lines intersect
(coplanar), then both the Angle and Apparent angle boxes display values. If lines do not
intersect (are not coplanar), then only the Apparent angle box displays a value.
Copy Measurement
Copies the measurement values from the ribbon.
You can change the units of measure by clicking Tools > Options. For more information,
see Change a displayed unit of measure (on page 497).
The measurement information only appears while the command is active. This command
does not write any dimensions or information to the database.
When you change the coordinate system with the Measure command, you also change it
for the PinPoint command.
The following details appear on the screen: minimum distance, name of the active
coordinate system, delta along the E-axis (X-axis), delta along the N-axis (Y-axis), and delta
along the EL-axis (Z-axis).
If you select a third object while in this mode, the software starts a new minimum distance
measurement with the selected object as the first object selection.
The software recognizes all objects that are displayed. For example, if insulation is
displayed in the active graphic view, the software measures the minimum distance from the
outside surface of the insulation.
4. Click the reference point, or press A to measure the whole object length.
The software prompts you to select a point along the edge to which to measure.
Measure an angle
1. Click Tools > Measure .
2. On the ribbon, click Measure Angle Between 3 Points.
3. Place the three points in the model.
The angle between the points appears next to the pointer.
When you measure an angle, the Angle and Apparent angle boxes appear on the ribbon.
The Apparent angle box displays the angle of the lines projected onto the active view
plane. If lines intersect (coplanar), then both the Angle and Apparent angle boxes display
values. If lines do not intersect (are not coplanar), then only the Apparent angle box
displays a value.
Checking Interferences
Interference checking (IFC) ensures that parts do not occupy the same volumetric space and
that each part meets the design criteria for clearance. A successful interference check ensures
that there is sufficient space around the parts so that they can operate properly, be serviced
properly, and be easily installed or removed when necessary. The IFC process can look at all
model data, including data from a referenced 3D model, a referenced PDS project (32-bit only),
referenced MicroStation and 3D AutoCAD files, and Point Clouds from third-party software with
valid connections.
There are two methods for interference checking:
Server-based interference checking called Database Detect. For more information, see
Server-Based Interference Checking (Database Detect).
Interactive interference checking called Local Detect. For more information, see
The major differences between the two methods are:
Runs continuously (System Administrator Works only within the current session
choice)
A dedicated server takes care of the IFC Provides immediate graphical feedback (works
process, minimizing impact on users and immediately after commit.)
improving performance
Provides feedback on how much has been Checks only created and modified objects in a
checked in the entire plant model session
Interference markers associate and come Clears dynamic interferences after refreshing
into the workspace along with the object workspace
participating in the interference
Includes a referenced point cloud when the Receives the point cloud specification via the
Smart 3D Point Cloud Compare option is File > Define Workspace workflow in Smart
selected in the Project Management 3D when the Smart 3D Point Cloud Compare
interference checking settings. option is selected.
The Database interference checking objects, or markers, appear in the model until other objects
are moved so the interferences no longer exist, or the aspects for the interference process are
changed. It is not possible to delete an interference object in the same way you can delete other
objects in the model. However, you can tailor the display to hide acceptable interferences.
Interference checking can be used with rules in the reference data. The delivered rules include
post-processing rules and clearance rules. For more information about the delivered IFC rules,
see Interference Checking Reference Data in the Interference Checking Guide available from
the Help > Printable Guides command in the software.
The Local Detect process marks any interference it finds with a cube interference marker. For
example, the software finds an interference and places a cube interference marker where there
is an interference between a pipe and the floor.
For both processes, the color of the marker indicates the type of the interference: red for severe,
green for clearance, and yellow for optional. You can modify the default interference marker
colors with the Format > Surface Style Rules command. You can change the size of both the
Database Detect and Local Detect interference markers using the Marker size option on the
Interference Server Setting dialog box in Project Management task and the Interference
Checking Settings dialog box in the Common task, respectively.
You can clear the acceptable interferences from your workspace by changing the required
action on the Interference List Dialog Box, and then editing the display properties on the
Interference Checking Settings Dialog Box.
In general, the software checks the parts involved in interfering objects to find and report the
interferences. For example, if you have a pipe run that consists of a pipe, an elbow, and a pipe,
each intersecting another pipe. The interfering pipe intersects the pipe run at each of the three
positions. The software generates three interferences, and then displays them in the
Interference List dialog box.
If an object has an interference with two other objects, these interferences are listed as two
separate interferences in the Interference List. You can view all possible associated
interferences (selected aspects) of an interference by right-clicking the interference row in the
List view. This action opens the Interference Settings dialog box, and you can then click Other
Aspects to see a list of all the aspects at the interfering location.
When an object is brought into the workspace, all of its associated interferences
appear, even if they are not part of the filter used to define the workspace.
The IFC service does not consume a license when it starts. It consumes a license only while
processing the model.
IFC consumes a license for every five models.
IFC cannot process a new model if a new license is not available.
If IFC fails to consume or release a license, the software logs error messages in the error
log and in the Event Viewer Application log with the source name IfcNtSvc.
You cannot set a number for processing models in the registry.
See Also
Checking Interferences Common Tasks (on page 433)
Database detection options are set in the Project Management task. You can also start and stop
the interference detection service in the Project Management task.
Interference detection requires disk space for the file cache that temporarily stores the
interference data. Before starting the interference process, the interference server checks to see
if enough space exists in the TMP location for the file cache. The server also checks to see if
you have the proper permissions to write, read, and delete files in the TMP location. During the
process, if the space becomes too low, the software stops IFC, and then displays an error
message. These checks primarily apply to the server-based interference process. Although,
they can apply to the local checking process if extremely low or no disk space is available for the
temporary folder on the local computer.
Configure automatic disk defragmentation in order to free space for the file
cache.
After you start the process, use the Status tab on the Interference Server Settings dialog box
to monitor the start time, progress of the interference checking, time when the last part was
modified, and the status of the checking. A box at the top of the dialog box identifies the model
that you are checking.
The software automatically checks new or modified objects apart from existing objects. When
you create or modify an object, the software checks for interference against all objects in the
Model database. The interferences generated by this process are persistent; that is, the
interferences are stored in the database like any other objects in the software. You can also
modify these objects by changing the properties. Interferences are also assigned to a
permission group; thereby the entire process is under the control and restrictions of an
administrator.
You can interrupt the automatic interference checking process during a work session without
forcing a recheck of all parts in the database when the process is brought back online. When
you restart the interference check process, the software begins checking where it left off when
the process went offline. However, if you change any of the options on the Interference Server
Settings dialog box for Database Detect, all pre-existing interference checking processes are
cleared from the database, and checking restarts from the beginning.
The server-based interference checking runs continuously. Therefore, you can perform an
interference check at any time and view the interferences of interest that result from the
background check by refreshing the workspace. After you have reviewed the interferences, you
can remove an interference automatically from the database by editing the objects so that the
interference no longer exists. You can then see the results of your edit by refreshing the
workspace. Because certain types of interferences are allowable, you also have the capability to
mark such interferences as acceptable.
Be aware that there is a four minute interval between the time you make your edits and the time
that the database detect service rechecks the objects. After the database detect process
reaches 100%, the software issues a query only every two minutes to locate newly modified
objects. Therefore, it is possible that there is a six minute delay before a modified object is
processed. We do not recommend changing the default four minute interval. However, if you are
in Project Management with the Interference Server Setting dialog box open, press
CTRL+SHIFT+F12 to change the default four minute interval.
When the Database Detect process reaches 100%, it does not mean that all clashes between
Smart 3D and other foreign objects, such as PDS, referenced MicroStation objects, 3D
AutoCAD files, or referenced point cloud objects, have been processed. Here, 100% indicates
that all Smart 3D objects have been processed against each other.
You must run the Database Detect process before running an interference report.
The report is not intended to run on local interferences.
Displaying Interferences
You can control the display of interferences as follows:
Show all the interferences or only those related to selected objects.
Hide all the interferences or only those related to selected objects.
Fit the interferences detected by the software in a view.
For more information, see Control Interference Display.
List Interferences
You can display the list of detected interferences and edit the objects to correct the problem. For
more information, see List interferences.
Run Report
Runs an existing catalog or personal report. By default, all reports generated with this command
are in Microsoft® Excel format (.xlsx). You can use Tools > Run Report to generate reports in
any of the 3D tasks.
Reports are divided into two overall categories: catalog reports and personal reports. Catalog
reports include report templates delivered with the software and templates that a reports
designer has created. Personal reports use templates you create and save.
Depending on the report definition, you may need to specify additional information such as filters
or parameters when running a report. Here are some examples.
Specifying a filter on the Select Filter Dialog Box (on page 369).
Specifying inputs for an asking filter on the Filter Properties Dialog Box (on page 371).
Specifying parameters on the Report Parameters Dialog Box (on page 438).
If a required filter does not exist, a message appears asking you to create the required filter.
When you have provided the necessary information, the command displays the report in Excel.
The Tools > Options command allows you to specify the location of personal report templates
and report output. On the File Locations tab, you can specify Personal Report Templates and
Reports Output locations. You can change these locations to identify any folder accessible
from your computer.
If any errors occur during the processing of a report, the command generates an error log called
SP3DReports.log in your local Temp folder.
For information about creating the Report databases, see the Smart 3D Installation Guide
available from the Help > Printable Guides in the software.
In the Drawings and Reports task, you can create, modify, update, save as another file,
print, and run personal reports. Also, you can save reports to the catalog to be used by other
users or publish the reports in an integrated environment. For information on creating report
templates or report deliverables, see the Reports User's Guide.
Microsoft Excel 32-bit is the supported version for the Drawings and Reports task. Click File
> Excel Options. Go to the Trust Center category and select the Trust Center Settings
button. Select the Macro Settings category and check Trust access to the VBA project
object model.
For more information about Microsoft Office and service packs, refer to the Microsoft web
site (http://www.microsoft.com/).
Topics
Catalog Reports Tab (Run Report Dialog Box) ............................. 436
My Reports Tab (Run Report Dialog Box) .................................... 437
For some reports, several dialog boxes requiring report parameters appear. The dialog
boxes take the form of a wizard with Back, Next, and Finish buttons at the bottom.
The query you set up for running a report can generate dialog boxes that prompt for certain
report parameters. In this way, your query can customize the report creation.
See Also
Run Report (on page 434)
Topics
Definition Tab (Properties Dialog Box) .......................................... 438
Configuration Tab ......................................................................... 439
Configuration Tab
Displays the creation, modification, and status information about an object.
You cannot define the filters using the Configuration tab.
Model
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the object belongs. You can select another
permission group, if needed. Permission groups are created in Project Management.
Transfer
Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group. This option is only available if the active model or
project is replicated in a workshare configuration. The option is not available if all of the
objects in the select set already belong to another location and are non-transferable. For
more information, see Transfer Ownership Dialog Box in the Common User's Guide.
Approval State
Specifies the status of the selected object or filter. The display depends on your access
level. You might be unable to change the status of the object. The list is defined by the
ApprovalStatus codelist.
You can only edit or manipulate an object with a status of Working.Status
Specifies the location of the object in the workflow process. Changing this property sets the
Approval State. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file. For more information, see
ApprovalReason in the Reference Data Guide.
Date Created
Specifies the creation date of the object.
Created by
Specifies the name of the person who created the object.
Date Last Modified
Specifies the date of the last modification to the object.
Last Modified by
Specifies the name of the person who last modified the object.
Before running a report, confirm your system administrator has created the necessary
reporting databases; that is, the Reports database must exist before you can run a report.
If you attempt to run a report template but the Reports database does not exist, the software
displays the message Cannot get Reports Database connection. Contact your system
administrator for the prerequisite databases.
You can define the path to your output report in advance by clicking Tools > Options and
then selecting the File Locations tab.
Some templates require you provide some additional information. This information is based
on the particular criteria you select for your report.
Reports in .xls format can have a maximum of 65,536 rows. If a report reaches the
maximum, a message in the error log of the software alerts you: Excel sheet limit (65,536
rows) was reached. Change the format to .xls to avoid the row limit.
If you click No to avoid overwriting an existing report, the software displays the Browse
dialog box so you can specify a different report name.
See Also
Run Report (on page 434)
6. To access folders with available reports you have created, click the Browse button and
locate the file with the Select Report dialog box.
7. Click Run. If the report requires additional input, such as a filter or parameter, the command
displays the necessary dialog boxes, such as the Select Filter Dialog Box (on page 369),
Filter Properties Dialog Box (on page 371), and Report Parameters Dialog Box (on page
438).
If you attempt to run a report template but the Reports database does not exist, the software
displays the message Cannot get Reports Database connection. Contact your system
administrator for the prerequisite databases.
Because each user can generate personal reports, the My Reports folder is initially empty.
You can add report files to the personal report template folder either by copying the files to
the folder or with the Save Report Template As command. For more information, see Save
Report Template As (File Menu) in the Smart 3D Reports User's Guide.
If you click No to avoid overwriting an existing report, the software displays the Browse
dialog box so you can specify a different report name.
Reports in .xls format can have a maximum of 65,536 rows. If a report reaches the
maximum, a message in the error log of the software alerts you: Excel sheet limit (65,536
rows) was reached. Change the format to .xls to avoid the row limit.
See Also
Run Report (on page 434)
Drawing Console
Allows you to create new drawings and manage existing drawings without switching to the
Drawings and Reports task. You can edit and update drawing documents through using the
Tools > Drawing Console command. The Drawing Console is a free-floating, resizable form
which shows you the same hierarchy of folders and components as you see in the Management
Console in the Drawings and Reports task. Unlike the Drawings and Reports task where the
documents are displayed in the Detail View, drawing and report documents are included in the
Drawing Console hierarchy.
The Drawing Console allows you perform the same operations as the Management Console
with a few exceptions:
Spreadsheet report documents have no Edit Template command. Go to the Drawings and
Reports task to edit the templates.
The Open command is not available on drawing documents. Right-click a drawing and
select Edit to open it in SmartSketch Drawing Editor.
You create new composed drawings by right-clicking the composed drawing component and
selecting New Drawing on the shortcut menu.
Copy Copies the Console hierarchy from the selected component down. The
copy command does not copy documents.
Copy Report to Copies a modified report template to the catalog so it can be used by
Catalog other users.
Create Document Generates the drawings that have not previously been created.
Create Report Specifies a report template and then generates a report for the selected
spreadsheet component.
Delete Removes an item and its sub-items from the hierarchy and the
database.
Edit Options Sets various options that affect piping isometric drawing output, such as
dimension styles, layers, drawing frame text, material lists, and weld
lists. Displays the Isometric Style Options Browser.
Edit Template Allows you to modify a template for a volume drawing component in
SmartSketch Drawing Editor.
Command Description
New Drawing Creates a new composed drawing. This command is only available on
the shortcut menu for a selected Composed Drawing component.
Parameters Specifies the parameters for a report, such as units of measure and
coordinate systems.
Paste Inserts the last-copied contents into the hierarchy, modifies the template
information, or creates drawing volumes, depending on the component
you have selected.
Print The simple Print command sends a print request for the selected
Batch > Print documents to the default printer. The Batch > Print command allows you
to submit document files directly to a print queue for a printer or
schedule the document files to be sent to the print queue at a later date
or at recurring intervals. If the Batch command is not available, you are
not configured to use batch processing. Contact your administrator for
more information.
Publish Publishes the information in the selected documents. You can access
the Publish Documents command by right-clicking a component or
document. This command is only available if you are registered to work
in an integrated environment.
Refresh Compares the date of the last update of the document with the
Batch > Refresh modification date in the model for any object that has a positive (can be
seen) resymbolization in the drawing. The Batch > Refresh command
allows you to refresh documents on a Batch Server while you continue
to work on other tasks. If the Batch command is not available, you are
not configured to use batch processing. Contact your administrator for
more information. The Refresh and Batch > Refresh commands are not
available for Spreadsheet Report documents.
Rename Activates the name of an item in the hierarchy so you can type a
different name.
Revise Reserves revision numbers. This command is only available if you are
registered to work in an integrated environment.
Run Query Runs the query associated with the selected Drawings by Query
Manager component.
Command Description
Save Package Saves the console hierarchy from the selected component down. The
package saves the setup information and any template definitions that
may exist on nodes within the selected hierarchy.
Setup Defines the options for a component, such as the Drawings by Query
components or the 3D Model Data component.
Update The Update Document(s) and Update commands query the model to
Update Now regenerate a single document or multiple documents. The Update Now
Update Documents command always performs a complete regeneration on the local
Batch > Update machine for a single selected drawing. The Batch > Update command
Batch > Local Update allows you to update documents on a Batch Server while you continue to
work on other tasks. The Batch > Local Update command is a special
batch command available on a document, allowing you to
background-process the update of the document. If the Batch
commands are not available, you are not configured to use batch
processing. Contact your administrator for more information.
View Log Displays the log information for the selected document.
View Extraction Data Displays part and report information for a line that has been processed.
You can view the log file and Piping Component File (PCF) data for the
extraction. This command is available for Piping Isometric Drawings
only.
See Also
Snapshot View (on page 444)
Snapshot View
Creates a view and a volume you can place on a drawing sheet when editing a composed
drawing. You can choose a snapshot view by selecting the available snapshot commands:
All Objects - Displays all objects in the view.
Visible Objects Only - Displays only the visible objects in the view. Objects that are
partially visible when the snapshot is taken are captured in the drawing, even if it includes
hidden edges. For example, if a pipe has visible and hidden edges, the hidden edges are
also included in the view.
When you select Tools > Snapshot View > All Objects, a ribbon appears allowing you to pick
a composed drawing component, name the snapshot view, and assign a view style. When you
select Tools > Snapshot View > Visible Objects Only, a composed drawing sheet must be
selected, and a ribbon appears allowing you to name the snapshot view and assign a view style.
After you select the information you want, the software captures the view when you click Finish.
The view is associated with the composed drawing component you selected on the ribbon, or
with the selected composed drawing sheet.
You can create additional snapshot views by updating the graphic view contents and then
clicking Finish again.
You must have appropriate permissions to access composed drawing types, or you cannot
use the Snapshot View command. If you have only read permission, you receive a
message that alerts you to this condition.
We highly recommend you use clipping to produce better results in your snapshot views. If
the graphic view is clipped, the volume created uses the clipping boundaries as its volume
boundaries. If the view is not clipped, then the command uses the extents of the graphic
view window as its top/bottom/left/right boundaries and the range of the objects as its front
and back boundaries.
After you create the snapshot views, you can use the Tools > Drawing Console command to
edit a composed drawing in SmartSketch Drawing Editor, then place snapshot views using
SmartSketch Drawing Editor Place Snapshot View command. For more information on creating
drawings in a 3D task, see Drawing Console (on page 441). For additional information on the
SmartSketch Drawing Editor commands, see the SmartSketch Drawing Editor Help.
Selected Set
Indicates that the snapshot view should only include selected objects. For example, if a view
contains a pipe and a pump, but this toggle is activated and only the pump is selected, only
the pump is included in the updated drawing. This option is only available for the All
Objects command.
Drawing type
Displays the last ten composed drawing selections you have made. Select a composed
drawing type to associate with the snapshot view. Select More for an extended list of
composed drawing types. This option is only available for the All Objects command.
View name
Specifies a name for the snapshot view. You can type a maximum of 40 characters for the
view name. When you place the snapshot view in a drawing open in SmartSketch Drawing
Editor, this is the view name you want to associate with your snapshot drawing view. For
information on the Place Snapshot View command, see the SmartSketch Drawing Editor
Help.
Naming rule
Select a naming rule to name the snapshot view. The last rule that you selected is displayed
as the default. To override this default, you can select a different naming rule. Select More
for an extended list of naming rules.
View style
Displays the last style you selected. You can specify a different view style to control the
appearance of objects in the finished drawing. Select More for an extended list of view
styles. You can create and edit view styles in the Drawings and Reports task.
Space folder
Specifies the Space folder where you want to store the drawing volume created by the
command.
Generate Preview
If checked, displays a preview of the snapshot view when you click Finish. This option is
only available when you create a snapshot view with the All Objects command.
5. Select a drawing view style in the View style box. You can use any orthographic view style.
6. In the Space folder field, specify where you want the snapshot view volume stored. Select
More to display the Select Space Folder dialog box for a list of available folders.
7. Click Finish to store the snapshot view.
The software creates a volume for the view. You can view the volume listed on the Space
tab of Workspace Explorer.
You can create additional snapshot views by updating the graphic view contents
and then clicking Finish again.
You can now open an existing composed drawing or create a new composed drawing and place
snapshot views using the Place Snapshot View command in SmartSketch Drawing Editor. For
more information on creating drawings in a 3D modeling task, see Drawing Console (on page
441). For additional information on the SmartSketch Drawing Editor commands, see the
SmartSketch Drawing Editor Help.
You must have appropriate permissions to access composed drawing types, or you cannot
use the Snapshot View command. If you have only read permission, you receive a
message that alerts you to this condition.
We highly recommend you use clipping to produce better results in your snapshot views. If
the graphic view is clipped, the volume created uses the clipping boundaries as its volume
boundaries. If the view is not clipped, then the command uses the extents of the graphic
view window as its top/bottom/left/right boundaries and the range of the objects as its front
and back boundaries.
4. Select a drawing view style in the View style box. You can use any orthographic view style.
5. In the Space folder field, specify where you want the snapshot view volume stored. Select
More to display the Select Space Folder dialog box for a list of available folders.
6. Click Finish to store the snapshot view.
The selected composed drawing sheet opens.
7. Use the Place Snapshot View command to place the snapshot view on the drawing sheet.
Click and drag the mouse on the drawing sheet to place the view.
8. Specify the snapshot view properties in the Snapshot View ribbon displayed above the
drawing area.
You can right-click the view, and then select Properties to change the style or
scale used in the snapshot view.
When the view is placed, it is automatically updated.
We highly recommend you use clipping to produce better results in your snapshot
views. If the graphic view is clipped, the volume created uses the clipping boundaries as its
volume boundaries. If the view is not clipped, then the command uses the extents of the
graphic view window as its top/bottom/left/right boundaries and the range of the objects as
its front and back boundaries.
Custom Commands
Provides end-user application programming capability for the 3D software. Using Microsoft®
Visual Basic, you can create a custom command that groups a series of commands and
instructions into a single command that runs as an operation in the 3D software. As a result, you
can access the customized commands that directly relate to the work routine in your operation.
Use the Visual Basic Command Wizard to help you build a custom command. For example,
the wizard's first step prompts you to identify general information including command name,
project name, author, and company. Start the wizard in Visual Basic by clicking Command
Wizard on the Add-Ins menu. For more information about installing the Command Wizard and
other programming resources, see the Intergraph SmartTM 3D Installation Guide, available by
clicking Help > Printable Guides in the software.
After adding a custom command in the 3D software, you can edit it using the Edit Custom
Command dialog box which requires you to specify the program identifier (prog_id), command
name and description, command priority, and a command line of arguments in a string.
ProgID SP3DCheckDatabaseIntegrity.CCheckObj
Description Creates records for the objects that need to be cleaned. Run this
custom command directly on a database (Site, Catalog, or Model).
Then, you can generate a report to review the errors that the Check
Database Integrity command generated.
For more information on this command, see the Database Integrity
Guide.
ProgID SP3DCleanDatabaseCmd.CCheckObj
Description Deletes or cleans an object. Use this command when an action on the
Check Database Integrity report is To Be Removed or To Be
Repaired.
For more information on deleting and cleaning objects in the database,
see the Database Integrity Guide.
ProgID MenuDrawView.CMenuDrawView
ProgID DuplicatePartNumbers,Ingr.SP3D.ProjectMgmt.Client.Commands.Dup
licatePartNumbersCommand
Description Repairs duplicate parts that exist in the catalog, including any proxies
that might also exist in all the associated models. The command is
available only when you have selected a catalog in the Project
Management tree.
In a Global Workshare environment, you must run
this command only from the Host location.
ProgID SP3DFindObjectByReport.FindObjects
Description Finds objects with integrity problems in a graphic view. Before running
this command, you must define your workspace to include these
objects. Run a database integrity report, and use the reported OIDs of
the objects in the workspace definition.
For more information on this command, see the Database Integrity
Guide.
ProgID SP3DPRJMGTRepairCmd.FixCnfgProjectRoot
Description Synchronizes the model name in the Model database and the Site
database. The name in the Site database prevails.
You must run this command from a task in the model, not from Project
Management.
ProgID DwgBinaryEditorCmd.FixSectorSize
ProgID MDRValidation.CValidateGeometry
Description Helps you in analyzing the MDR results. If MDR is performed across
models, you must run this tool on both the source and the destination
models to enable analysis of the results. The tool locates the objects in
the model that failed to copy as well as the objects that have a data
mismatch with the source and the destination.
ProgID ModifyStyleCmd.ModifyStyles
ProgID PileFoundation,PileFoundation.PileFoundation
ProgID PlacingSupportsFromXLS,PlacingSupportsFromXLS.PlacingSupports
FromXLS
Description Places support information from an .xls file into Smart 3D. You must
run this command from Smart 3D, and not from Project Management.
For more information, see Placing Supports from XLS Command in
the Smart 3D Hangers and Supports User's Guide.
ProgID IMSEngFrameworkCmd.RemoveDsgnBasis
Description Removes all correlation relationships and then deletes all design basis
objects in the 3D model.
This command is useful when you want to register to a different
SmartPlant foundation database.
After running this command, you must register the model, retrieve
information, and correlate the objects again.
You must run this command from a task in the model, not from Project
Management.
ProgID DwgRepairCmd.RepairDocuments
ProgID RepairDuplicatePermissionGrpID,Ingr.SP3D.ProjectMgmt.Client.Com
mands.
RepairDuplicatePermissionsGrpIDCommand
Description Lists all catalogs and models that have a duplicate permission group
ID.
Select the catalogs and models to repair. You cannot select all of the
databases under a particular duplicate permission group ID.
This command can only be invoked from Project Management.
This command cannot be run from a Satellite location. You should run
this command only from the Host location.
ProgID PermissionGroupsAndLocations,Ingr.SP3D.ProjectMgmt.Client.Comm
ands.PermissionGroupsAndLocationsCommand
Description Repairs the corrupted relationship between permission groups and the
location for both catalog and model permission groups.
If a permission group has lost the relationship with a location or has
multiple relationships, then this command re-establishes a proper
relation. This command cannot be run from a Satellite location. You
should run this command only from the Host location.
Users with full permissions in the corrupted permission
group can only re-establish the relationship.
ProgID DwgRepairCmd.RepairDocuments
ProgID IMSEngFrameworkCmd.EngFrameworkCmdArgument=ResetDesignB
asisTime
Description Modifies the Design Basis timestamp. Use this command to set the
time and date back to a point in the past. This command is useful if, for
any reason, delete instructions could not be processed.
ProgID SymbolTestCmds.CResetSymbolDefinition
Description Resets the input, aspect, and output information of a symbol definition
in the model database, which is useful for symbol development. After
the symbol is in production, this command should not be used to reset
the symbol definition data.
This command should not be used in production databases.
ProgID DwgSynchTemplatesCmd.SynchTemplates
ProgID DwgSynchTemplatesCmd.SynchTemplates
ProgID SP3DDisplayPIDService.VerifyPIDCmd
ProgID mhprofileautobound.AutoBoundProfile
ProgID stAnalysisTool.AuditTool
Description Compares two databases using an SQL query. The databases can be
on different servers and have different catalog schema. Changed
objects can be displayed in the workspace of the current model. This
command is useful after performing a migration, synchronization, or
hull swap.
ProgID CompartQuery.CCompartQueryCmd
ProgID StructCopyFamilyFind.ManualFindCMD
Description Manually finds structural objects that are similar and meet the criteria
of the Source Group and the Target group in Family Definition. For
more information, see Copy By Family Manual Find Custom in the
Molded Forms User's Guide.
ProgID GCMenu.Activate
Description Places the GC menu on the software toolbar. This menu contains
commands for creating geometric constructions, GC sets, and GC
macros. For more information, see Geometric Construction Macros
(GC Menu) in the Molded Forms User's Guide.
ProgID SplitCommands.VerifySeamPatternToSplit
Description Checks the status of seams and plates split by the seams. This
command provides a count of successful and failed splits, and
modified, new, identical, and deleted leaf systems. You can also
display the objects affected by the seams by selecting one or more of
the following options: Identical Bodies (Green), Modified Bodies
(Yellow), New Bodies (Red), Deleted Bodies (White), or Bad
Splitters (Blue). This command is useful when swapping an old
imported hull system with a new hull. For more information, see Swap
Hulls on a Detailed Model Using Molded Forms Delay in the Molded
Forms User's Guide.
You do not create custom commands within the software. You create them in Visual
Basic using the Command Wizard.
You must install the Command Wizard software in Visual Basic. The setup for the
Command Wizard (SP3DCommandWizardV2.exe) is located in the [Product
Folder]\Programming\Tools\CommandWizard folder.
Add
Installs the custom command into the software. For more information, see Add custom
commands (on page 459).
Delete
Removes the custom command from the software. For more information, see Delete a
custom command (on page 460).
Clear
Deletes the information you have typed in the boxes on the Custom Commands dialog
box.
Description
Contains an identifying phrase so you can better recognize the custom command with which
you are working
Priority
Changes priority to High, Normal, or Low.
Argument
Change the command line arguments in a string.
Reset Default
Returns the dialog box to its default settings.
Utility
Provides specialized utility and maintenance commands. To access the commands, select
Tools > Utilities, and then click the needed command.
Select Show objects with To Do Records to also display items on the To Do List that are
also out-of-date.
Select an item in the grid to highlight it in the graphic views and the Workspace Explorer.
Fields selected in the grid can be copied.
To stop the synchronization process, click Cancel. Processing ends after synchronization of
the current item is complete.
When processing is complete, a summary of the results is displayed. The summary shows
the number of successful and failed updates. You can also choose to display a log file
containing more details.
Reason
Explanation of why the item is out-of-date.
Catalog Object Name
Name of the related item in the Catalog. The out-of-date item is synchronized to the catalog
item.
Status
Status of the synchronize process.
Update
Click to start the synchronize process on items in the grid.
Cancel
Click to stop the synchronize process and close the dialog box.
Show objects with To Do Records
Click to display items on the To Do List that are also out-of-date.
See Also
To Do List (on page 264)
Synchronize All Objects in the Workspace (on page 464)
Synchronize Selected Objects (on page 464)
Unselect
Removes objects that makeup the select set (original or copy). You can also click
anywhere in the graphical view to clear the select set. This option is only available after you
select objects.
Classes
Shows the results and the classes included or excluded in the MDR Results Report. Check
the ones to include and remove the check from those you want to exclude.
See Also
Filter MDR Results (on page 466)
Create an MDR Results Report (on page 465)
Use Windows Explorer or another browser to locate the MDR log file, which is stored at
%temp%. The name of the log file is MDR[file_number].log where file_number is replaced by a
number to make it unique. The text file appears similarly to the one shown in the following
illustration.
User-defined Forms
User-defined forms are powerful custom forms that contain illustrations of objects. For example,
user-defined forms can contain illustrations of equipment or an equipment component, as well
as their properties. These custom forms are applicable to Add Part and Place Support
commands in Hangers and Supports and to the Place Equipment command in the Equipment
and Furnishings task. In addition, after you define the form, you can view it in the modeling
window, and as you make changes, you can see the result on the screen. You can create
user-defined forms in Microsoft® Visual Studio 2010 or by using the form definition wizard.
As you modify the values in the form, changes made to the attributes on the form automatically
update the corresponding attribute in the Property pages.
The advantage of creating and using this form is that the picture of the object and its properties
appear in the same form. If necessary, you can also create multiple or nested forms that hold
similar properties that can be called from the main form.
Save your first project as a template for all other user-defined forms. You can make changes
on this project for other symbols instead of creating the form from scratch each time.
Properties such as Name, Weight and CG, Surface Treatment, and so forth, are common for
most of the symbols. Therefore, these properties need not be modified each time.
You can make minor changes on the form for similar symbols. For example, in Equipment
and Furnishings task, the delivered pumps Horiz Centrifugal Pump With Flush and Drain
Nozzles and Horiz Centrifugal Pump With StructureSteel or Polyshield Base are similar
equipment but have different symbols. They may have common properties like
MotorLength, CouplingLength, and so forth. Therefore, the same form can be used for
both.
If there is some similarity between equipment, for example, Complex Horizontal
Cylindrical Vessel and Storage Tank, you can keep the common properties like Vessel
Diameter and Vessel Length, and modify, add, and remove the remaining properties,
including the background of the form.
You can modify the form by changing the interface name and the property name on the
Properties window of the user control in .NET.
3. In the Solution Explorer, right-click Properties under the new form you created.
4. On the Properties window, select Build.
5. To change the output path, click Browse. For example, to create user defined equipment
forms, change the output path to $Symbols\bin\Equipment\UserDefinedForms\Release.
CustomFormDefinitionControls.dll
4. Click OK.
The selected references are appended to the list of existing references.
7. Click OK.
The user controls are added to the SP3D Controls tab of the Toolbox.
2. Go to the Properties window of the control placed in Step 1, and fill in the InterfaceName
and PropertyName values under Misc. Similarly, place the user controls at all the required
locations on the form.
The InterfaceName and PropertyName for each of the properties are found on
the delivered spreadsheet: [Product Folder]\CatalogData\BulkLoad\DataFilesEquipment.xls
or from the metadata browser. For example, in this step the property at control 'A' is 'Dome
Height 1'. Equipment.xls provides you with the InterfaceName and the
PropertyName(AttributeName) on the Custom Interface sheet.
Check Validation
1. Select the control at 'C', and open the Events window.
2. On the Events window, type the value for Load as sp3DUOmCtrl11_Load. You can select
this value from the drop-down list.
Check the name of the control, and type the values accordingly. In this case, the
control at 'C' is sp3DUOmCtrl1. Check the controls with your form, and type the values
accordingly (sp3DUOmCtrlxxx).
try
{
UserControl oCntl = (UserControl)sender;
if (oCntl != null)
{
double odblVal =System.Convert.ToDouble(e.NewPropertyValue);
if (odblVal < 0.5)
{
MessageBox.Show("Value should be > 0.5");
e.SuccessfullyValidated = false;
}
else
{
e.SuccessfullyValidated = true;
}
}
}
catch (Exception)
{
e.SuccessfullyValidated = false;
}
See Also
Create Multiple Forms (on page 486)
2. Change the background of the form to any image, as shown in the following illustration, and
add controls.
For more information, see Design the Symbol Background (on page 478) and
Place a Control on the Form (on page 481).
3. Go to the main TestForm, Add a Button, and rename the button as Insulation.
4. Double-click the button to be directed to the code page, and type the following text:
TestForm1.TestForm2 oTestForm2 = null;
oTestForm2 = new TestForm1.TestForm2();
Form oFrm = (Form)oTestForm2;
oFrm.ShowDialog();
7. Go to the Equipment and Furnishings task, and place the vertical complex vessel.
When placing the vessel, you can observe that the form appears.
Ensure that the System Variable Path in the Environment Variables dialog box contains
[Product Folder]\Smart3D\Core\Runtime.
Install the Programming Resources in the same location as the product.
Install Microsoft Visual Studio 2010 or a higher version.
1. Right-click FormDefWizard.exe in the [Product
Folder]/Core/Container/Bin/Assemblies/Release folder, and select Run as administrator.
The S3D Custom Form Definition Wizard is displayed.
2. Specify the form definition location details. See S3D Custom Form Definition Wizard Dialog
Box (on page 493).
3. Click Next
The Properties on form Definition window is displayed.
4. Choose the part properties to be displayed on the form definition. See Choose Part
Properties Dialog Box (on page 494).
5. Click Next.
The Creating the final Project window is displayed.
This dialog box shows the steps to be performed after you click Finish. It also displays the
new project location and a list of files that are created in the project.
6. Click Finish.
The Creating the final project window is displayed to open the created user-defined form.
7. Click Open to open the solution of the .Net project. Click Close to close the form definition
wizard.
Plant name - Specifies the plant name that you want to work on.
Project Location - Specifies the location where the .Net project needs to be created. You
can click the browse button to select the location.
Project Name - Specifies the name of the project.
Form Name - Specifies the name of the form.
Namespace - Displays the Project Name that you specified previously.
Options
Specifies options to configure the software. The options are grouped by topic on tabs on the
Tools > Options dialog box.
General
Enables the Undo command and the status bar. In addition to allowing you to toggle these
features on and off, these options specify the number of actions you can cancel using the Undo
command and set the time allowed before activating QuickPick. You can also define the locate
zone for the software to find SmartSketch points and for the tabs displayed in the Workspace
Explorer.
Colors
Selects the colors the software uses for the background, highlighted and selected objects, and
handles.
Units of Measure
Determines the units of measure that appear in the readout and key in boxes of the software.
Additionally, you can specify how precisely the software displays these units.
All the data (length, angle, volume, mass, and so forth) are stored with the unit of
measure defined in the metadata. For example, the unit of measure for length is defined as
meters in the metadata. If you set the length unit as ft on this tab, then the software displays the
length readout as ft by default but stores the value as meters in the database.
ToolTips
Defines ToolTips for a selected object type. ToolTips are based on catalog labels, but they are
saved to the session file. To create a label to use as a ToolTip, go to the Catalog task.
File Locations
Sets the default path to the folder where the software saves Workspace session files,
Workspace Templates, Personal Report Templates, Report Output files, and Custom
Documentation.
SmartSketch
Selects the standard SmartSketch relationship indicators you want the software to use.
Selected PG
Restricts the edits and propagation to objects in the selected permission group.
Any changes you make appear in the Preview box on the right side of the tab.
Any changes you make are applied to all views in your workspace.
You can change the default file locations for Workspace, Workspace Template, Personal
Report Template, Report Output files, and Custom Documentation.
The software saves these file locations within the workspace, so each workspace can have
its own default locations for saving files.
You can also change the number of digits after a decimal. Click in the Precision field, and
type the number of digits you want to appear after the decimal point. The Precision field is
not available if the units are fractional.
The units of measure you select here appear in all ribbons, dialog boxes, PinPoint values,
and other unit displays within your workspace. However, because the setting is saved in the
workspace, your selections have no effect on the displays of other users.
Manage ToolTips
ToolTips are created and managed within the session file. Any changes you make to the labels
assigned to ToolTips are only seen within the session file. They are not saved to the catalog.
1. Click Tools > Options.
2. Click the ToolTips tab.
3. To turn the display of ToolTips on in the graphic views, check Show object ToolTips.
4. To create a new ToolTip, click an empty Object type cell, then click the ellipsis button. The
Select Object dialog box appears.
5. Select an object type from the hierarchy, expanding folders as needed. Click OK to accept
the selected object type.
6. On the ToolTips tab, select Catalog Data Labels in the Label to Use for the ToolTip
drop-down. The Select Label dialog box appears.
7. Select a label type from the Label hierarchy, expanding folders as needed.
8. Use the Grid View and List View buttons to adjust the display of available labels.
9. Select a label from the available labels and click OK.
10. To edit a ToolTip, select it in the Label to Use for the ToolTip cell, and then click Edit
ToolTip. The Edit Label dialog box appears.
11. Edit the ToolTip label properties as needed.
The Edit Label dialog box provides specific properties depending on the type of
label associated with the ToolTip, either SQL label or COM label. However, the editing
capabilities are similar.
12. Click OK to save the changes to the ToolTip label to the session file.
13. On the ToolTips tab, click OK or Apply to save all the ToolTip assignments to the session
file.
To enable recursive expansion of embedded labels, the report RFM file must set the
ToParse flag to Yes, as in the following example:
<DATA
Column="ShortMaterialDescription"
ToParse="yes"
Visible="yes"/>
The QuickPick feature is available when a question mark appears beside the pointer while
resting on an object.
Using the dwell time you set, the software displays the QuickPick question mark when the
pointing device has rested after a move to indicate it has found multiple objects. This action
occurs even if the pointer is not paused for an object. When the QuickPick feature is active, the
software highlights each object in the graphic view as you cycle through the QuickPick choices.
For more information, see Select objects using QuickPick (on page 352).
Topics
General Tab (Options Dialog Box) ................................................ 500
Colors Tab (Options Dialog Box) .................................................. 502
Units of Measure Tab (Options Dialog Box).................................. 502
ToolTips Tab (Options Dialog Box) ............................................... 503
File Locations Tab (Options Dialog Box) ...................................... 510
SmartSketch 3D Tab (Options Dialog Box)................................... 511
Selected PG Tab (Options Dialog Box) ........................................ 514
Undo
Make Undo available
Makes the Undo command on the toolbar and menu available. When you clear this check
mark, you cannot reverse commands you perform, such as accidentally deleting an object
from the model.
Number of undo actions
Select the number of previous actions that can be cancelled using the Undo command. The
values in this box can range from 1 to 20. The initial value is 3.
Status Bar
Status Bar Location
Specifies where the status bar appears. Top (shown below) displays the status bar above
the graphic views and below the command ribbon. Bottom displays the status bar at the
bottom of the Smart 3D window.
Locate
Locate Zone
Sets the size of the locate zone radius. The locate zone is a region around a pointer. The
software finds SmartSketch points within the locate zone so you do not have to move the
pointer to an exact position. Values from 3 to 12 pixels are valid.
QuickPick Dwell Time
Specifies the number of seconds the pointer must rest on an object before the pointer
changes to a question mark indicating that the QuickPick feature is available.
You can also right-click a tab in the Workspace Explorer, and select Hide to hide the
tab.
Restart the software to see the changes to the Workspace Explorer tabs.
Theme
Floating
Select to configure the software interface for ship building. Select this option to use X, Y,
and Z coordinates labels in commands such as the Grids Wizards and the Tools > Measure
command.
Fixed
Select to configure the software interface for offshore modeling, such as the top side of
offshore platforms. Select this option to use North, East, and Elevation coordinate labels in
commands.
See Also
Change the displayed Workspace Explorer tabs (on page 497)
Set the activation time for QuickPick (on page 499)
Set the Locate Zone (on page 499)
Turn the Status Bar on or off (on page 500)
If the selected Readout is fractional rather than decimal, the Precision field is not
available. The precision values are not valid with fractional units.
If the selected Readout includes (fractional), values will display appropriate fractional
measures.
See Also
Change a displayed unit of measure (on page 497)
Specifies a three-dimensional object type. Click to display the Select Object Type
dialog box. For more information, see Select Object Type Dialog Box (on page 385).
Label to Use for the ToolTip
Specifies the label content for the ToolTip that displays when the corresponding object type
is selected in the model. Click Catalog Data Labels to display the Select Label dialog box.
For more information, see Select Label Dialog Box (on page 504).
Edit Tooltip
Displays the Edit Label dialog for the selected ToolTip. This functionality is not available if a
ToolTip is not selected. For more information, see Label Editor Dialog Box (on page 505).
To enable recursive expansion of embedded labels, the report RFM file must set
the ToParse flag to Yes, as in the following example:
<DATA
Column="ShortMaterialDescription"
ToParse="yes"
Visible="yes"/>
See Also
Manage ToolTips (on page 498)
Properties
Displays properties associated with the label. The options available are different depending on
the type of label, either COM or SQL Query.
If you are working with a COM Label, you can add or delete property rows as needed.
If you are working with an SQL Query Label, the definition provides the following capabilities:
Show Results Pane - Adds a results pane to the Properties section. The results update
when you execute the query.
Execute Query - Runs the query as specified. If the Results pane is shown, the results
display.
Properties - Displays the Query Parameters Designer dialog box.
Name - Specifies a name for the query.
Layout
Provides a text field for typing text and fields to be used in the label. The options available are
described as follows:
Conditional Block
Not available in this version.
Field Formatting
Displays the Field Formatting dialog box so you can define specific formatting for a
selected field. This button is disabled unless a field is selected in the Layout text box. For
more information, see Format Field Dialog Box (Label Editor) (on page 506).
Unit Formatting
Displays the Select Rule dialog box for specifying a Unit of Measure formatting rule. This
button is disabled unless a unit of measure field is selected in the Layout text box. For more
information, see Select Rule Dialog Box (Label Editor - Unit of Measure) (on page 506).
Position Definition
Displays the Position Definition dialog box for defining the display of the positional
information within the label. This button is disabled unless a positional field is selected in the
Layout text box. For more information, see Position Definition Dialog Box (on page 509).
Orientation Definition
Not available in this version.
Description
Lists the descriptions of the rules.
New
Displays the Unit of Measure dialog box for creating a new unit of measure rule. For more
information, see Unit of Measure Dialog Box (Label Editor) (on page 507).
Delete
Deletes the selected rule.
Rename
Renames the selected rule.
Properties
Displays the Unit of Measure dialog box to review or edit the selected rule.
Properties
Unit
Displays the type of unit, such as distance.
Primary
Specifies the primary unit of measure, such as yards in yards, feet, inches.
Secondary
Specifies the secondary unit of measure, such as feet in yards, feet, inches.
Tertiary
Specifies the tertiary unit of measure, such as inches in yards, feet, inches.
Displayed Unit
Turns the display of the units on and off.
Precision Type
Specifies Decimal, Fractional, or Scientific. Your selection in this box determines the
availability of the remaining boxes on this dialog box.
Decimal Precision
Specifies the number of places after the decimal point. This value can be 0 or greater.
Leading Zero
Places a zero before the decimal point, if applicable.
Trailing Zeros
Places zeros after the last significant digit, if applicable.
Fractional Precision
Specifies a fraction for the precision. The highest value that you can specify is 1/2. This box
is available only if you select Fractional in the Precision Type box.
Reduce Fraction
Reduces the fraction. For example, displays 3/4 instead of 6/8. This box is available only if
you select Fractional in the Precision Type box.
New
Displays the Matrix Rule dialog box for creating a position matrix rule. For more information,
see Matrix Rule Dialog Box (on page 508).
Delete
Deletes the selected rule.
Rename
Renames the selected rule.
Properties
Displays the Unit of Measure dialog box to review or edit the selected rule.
Displays when you move the pointer to a location that is the specified offset from a
selected element or line. Offset also displays Offset from surface.
You must define a projection plane to use Offset.
Offset from surface - Displays when you point to the location of a line that is offset from
the intersection of your selected projection plane with a surface that is in the SmartSketch
locate list. For example, if you are locating the end of a pipe, the indicator appears along the
line that is offset from the intersection of the projection plane with the web plane.
The offset line is often easiest to locate if your view direction is perpendicular to the
projection plane.
Key point
Displays when you move the pointer over the end of an element to which you can attach
other elements.
Nozzle or other port point
Displays when you move the pointer over an equipment nozzle or other port. Press F2
to toggle this option on and off.
Divisor point
Displays when you move the pointer to the points where a line divides equally for the
number of divisions that you set. A drop down list lets you choose from 2 to 7 divisions for
the line. For example, if you select 4 for the number of divisions, you get a divisor point at ¼,
½, and ¾ of the length.
Center point
Displays when you move the pointer over the center of a circle or arc.
Point on curve
Displays when you move the pointer over any connection point on an object, such as a
nozzle on a piece of equipment.
Point on surface
Displays when you move the pointer over any location point on a surface object, such as
a slab. Press F3 to toggle the option on and off.
Edges on solids
Displays when you move the pointer over the edge of a solid object.
Displays when you move the pointer over a point of tangency to an object.
Silhouette edges
Displays when you move the pointer over the silhouette edges of surfaces. The
silhouette edges are the outside edges of the surface with respect to your view.
Minimum/maximum point
Displays when you move the pointer over a point that is the given offset in the locked
direction from the minimum/maximum point on a curve. A projection plane must be defined,
and a line or axis constraint must be locked.
Locate only from list
Specifies that the software locates objects on the SmartSketch list defined when you use
Add to SmarkSketch List . For more information, see Add to SmartSketch List (on page
403).
Dwell time for stack
Specifies the number of seconds that should lapse as you pause the pointer over an object
in the graphic view before that object is added to the stack.
Stack size
Specifies how many objects are added to the stack before the software begins removing
previously added objects. The value in this box must be an integer greater than 1.
Many of the Add to SmartSketch List controls also are available on the SmartSketch
Properties dialog box accessible from the Add to SmartSketch List ribbon.
You can press F3 to toggle the relationship indicator for locating surfaces on and off.
The shortcut keys to turn on SmartSketch select mode are CTRL+D.
The shortcut keys to set a lock constraint in SmartSketch are CTRL+L.
See Also
Turn a SmartSketch Relationship Indicator on or off (on page 499)
Weight & CG
Determines the weight and center-of-gravity of an object or set of objects.
The Weight & CG command is similar to the PinPoint command: it remains active as you work
in the model and can be toggled on and off. You add objects to the select set, specify a
coordinate system, and specify dry or wet weight. The software displays the total weight,
coordinates of the center-of-gravity, and optionally, visual markers in the model at the coordinate
system reference and center-of-gravity. You can also view a list of parts in the select set with
corresponding weights and center-of-gravity coordinates.
Select
Selects objects for the calculation. You can click multiple objects (without holding the CTRL
key) for inclusion in the select set.
The software adds all the select set objects that support the Selection Filter.
Coordinate (X, Y, Z)
Displays the center-of-gravity of the selected objects. You can specify units on the Units of
Measure tab on the Tools > Options dialog box.
Close
Ends the command. You can also end the command by clicking Tools > Weight & CG
again.
Selection Filter
Selects the hierarchy filter for objects.
Weight and CG calculation requires one hierarchy to avoid duplicate addition of
weight for sub-parts.
All: Objects that belong to any hierarchy can be selected.
Selecting this filter might result in double counting of Weight & CG. The
Weight & CG values might not be reliable.
Auto Selection: Automatically selects objects belonging to any hierarchy.
The order in which you select objects determines the hierarchy. Selection of more
objects gets restricted to the hierarchy that belongs to the selected objects. If all the objects
support multiple hierarchies, the software gives preference to the System Hierarchy for
Weight & CG calculation.
System Filter: Select only objects that belong to the System hierarchy.
Assembly Filter: Select only objects that belong to the Assembly hierarchy.
Analysis Filter: Select only objects that belong to the Analysis hierarchy.
Select Nested
Select this option to add all the recursive hierarchical children to the selected objects for
Weight & CG computation.
6. Click Toggle Center of Gravity to see the coordinate reference and center-of-gravity
markers in the graphic view.
7. Click Toggle List of Parts to see a table of the parts in the select set with their
corresponding weights and centers-of-gravity.
8. In the Condition box, select dry or wet weight.
9. View the weight and coordinate data in the boxes in the ribbon.
If the Caution icon displays beside Weight or CG, this indicates that there are
some parts that have invalid Weight or CG values. Otherwise, the Correct icon displays.
Click Toggle List of Parts to see the items that have invalid Weight or CG. The
Weight & CG Display List shows the list of parts that have invalid Weight or CG in yellow
font.
10. To end the command, click Close on the ribbon. Alternatively, click Tools > Weight & CG
again.
The Weight & CG command is similar to the PinPoint command. It remains active as
you work in the model and can be toggled on and off.
Project Menu
The Project menu provides commands for managing project-related objects, including claiming
objects to projects, releasing objects, and specifying relationships for Work Breakdown Structure
(WBS) items. Some of the commands on this menu may change depending on the active task.
In This Section
WBS Items and Projects ............................................................... 519
Claim ............................................................................................ 537
Release Claim .............................................................................. 540
Assign to WBS .............................................................................. 541
Update WBS Assignments............................................................ 544
Each time you create a new session, a blank row is the default. This blank row indicates
that the active project or WBS item is set to "none."
Work Breakdown Structure grouping is hierarchical. Objects are assigned at lower levels in the
hierarchy, and higher levels automatically provide consolidation. The first level of grouping
object is the project. Under the project level, you can nest additional types of groupings called
WBS items. Typically, WBS grouping is used for activities at the end of the engineering phase,
such as activities related to the generation of deliverables and construction techniques. The
following are some examples of the practical usage of WBS functionality in the software:
Manual Piping Isometric Sheet Management - Normally when a pipeline isometric is
generated using ISOGEN, the software automatically breaks the pipeline into multiple
sheets; however, in order to reduce the number of drawings to be issued in case of
revisions, many companies control the sheet assignment manually. Smart 3D provides
functionality to automatically group and assign objects to a WBS item that represents a
single sheet of piping isometric drawing.
Modularization of Pipe Racks - In many projects, pipe racks are pre-fabricated in sections
and shipped to the site for installation. A number of sections could be large on a project. You
can use WBS grouping to define modules representing pipe rack sections.
Work Package Definition - Although the definition of Work Package varies widely, Smart
3D WBS functionality can be applied in most situations. Typically, design objects belong to
multiple work packages, which is allowed by WBS assignment logic.
Use of 3D models in Operation and Maintenance – In a typical plant, the actual plant and
3D model representation keep changing due to small and large projects to improve the
plant. The as-built project is used to maintain current state of the model. You can either copy
or move 3D objects to different WBS projects to manage changes being made. The Smart
3D Drawings and Reports task provides functionality to distinguish objects on the drawing
based on their association with the WBS project. For example, as-built objects can be
shown in one color/line style and upcoming changes related to a project can be shown in a
different color/line style.
In the Common task, you can create new WBS projects and items or edit existing ones. The
New WBS Project and New WBS Items commands appear on the shortcut menu when you
right-click a WBS project folder or a WBS item on the WBS tab in the Workspace Explorer.
Workspace
Displays WBS projects and items retrieved to the workspace based on the current Define
Workspace filter.
Database
Displays WBS projects and items that are in the current active database.
See Also
Workspace Explorer (on page 243)
Status Description
Correlated with Represents objects that have a data match between the design basis
data match data and the objects in the three-dimensional model.
Correlated with Represents objects that have a correlation with the design basis.
data mismatch However, these objects have a discrepancy, which generates the
mismatch. The cause of the discrepancy can result from changes in the
P&ID or the 3D model.
Correlated with Represents objects that have a correlation with the design basis.
approved data However, these objects have approved data discrepancies.
mismatch
Correlated with Represents objects that have a correlation with the design basis.
approved topology However, these objects have approved topology discrepancy.
mismatch
Not correlated yet Objects that have either not been modeled from the P&ID or that have
been modeled but have not been correlated with design basis data.
Ignored or not Shows that the object either is not claimed (that is, it exists in the
claimed (Project as-built condition), or that the software ignores the object (for example,
Management revision clouds and labels).
environment only)
Correlation Basis
Specifies if the object is correlated to a corresponding design basis. Select Correlate
Object to associate the objects in three-dimensional model with the design basis. Select No
correlation is required if the objects do not have a correlating design basis data.
Correlation Approval Status
Specifies if the component is approved with discrepancies in the three-dimensional data
compared with design basis data. Select Topology mismatch approved if components
topology mismatch can be ignored. Select Data and Topology mismatches approved if
the components data and topology mismatches can be ignored. Select None if you do not
want to approve a mismatch.
See also
Create WBS Project (on page 522)
Status Description
Correlated with Represents objects that have a data match between the design basis
data match data and the objects in the three-dimensional model.
Correlated with Represents objects that have a correlation with the design basis.
data mismatch However, these objects have a discrepancy, which generates the
mismatch. The cause of the discrepancy can result from changes in the
P&ID or the 3D model.
Correlated with Represents objects that have a correlation with the design basis.
approved data However, these objects have approved data discrepancies.
mismatch
Correlated with Represents objects that have a correlation with the design basis.
approved topology However, these objects have approved topology discrepancy.
mismatch
Not correlated yet Objects that have either not been modeled from the P&ID or that have
been modeled but have not been correlated with design basis data.
Ignored or not Shows that the object either is not claimed (that is, it exists in the
claimed (Project as-built condition), or that the software ignores the object (for example,
Management revision clouds and labels).
environment only)
Correlation Basis
Specifies if the object is correlated to a corresponding design basis. Select Correlate
Object to associate the objects in three-dimensional model with the design basis. Select No
correlation is required if the objects do not have a correlating design basis data.
Correlation Approval Status
Specifies if the component is approved with discrepancies in the three-dimensional data
compared with design basis data. Select Topology mismatch approved if components
topology mismatch can be ignored. Select Data and Topology mismatches approved if
the components data and topology mismatches can be ignored. Select None if you do not
want to approve a mismatch.
See also
Create WBS Project (on page 522)
Configuration Tab
Displays the creation, modification, and status information about an object.
You cannot define the filters using the Configuration tab.
Model
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the object belongs. You can select another
permission group, if needed. Permission groups are created in Project Management.
Transfer
Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group. This option is only available if the active model or
project is replicated in a workshare configuration. The option is not available if all of the
objects in the select set already belong to another location and are non-transferable. For
more information, see Transfer Ownership Dialog Box in the Common User's Guide.
Approval State
Specifies the status of the selected object or filter. The display depends on your access
level. You might be unable to change the status of the object. The list is defined by the
ApprovalStatus codelist.
You can only edit or manipulate an object with a status of Working.Status
Specifies the location of the object in the workflow process. Changing this property sets the
Approval State. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file. For more information, see
ApprovalReason in the Reference Data Guide.
Date Created
Specifies the creation date of the object.
Created by
Specifies the name of the person who created the object.
Date Last Modified
Specifies the date of the last modification to the object.
Last Modified by
Specifies the name of the person who last modified the object.
Notes Tab
Creates and edits user-definable text placed by the designer on an object in the model. The
notes provide special instructions related to the object for the fabricator and are available in
downstream tasks. For example, the notes appear in two-dimensional drawings and within
design review sessions.
Only one note of a given kind from a given object can be shown on a drawing. For
example, if there are two fabrication notes on a piping part, then only one of the notes shows on
the drawing. It is important to know about and to consider this situation when defining notes on
an object in the modeling phase. For example, you can display one Fabrication note and one
Installation note by defining two separate labels for the two kinds of notes.
Key point
Specifies the key point on the object to which you want to add a note.
Notes at this location, listed by name
Lists all notes for the selected key point on the object.
Date
Displays the date that the note was created. The system automatically supplies the date.
Time
Displays the time that the note was created. The system automatically supplies the time.
Purpose of note
Specifies the purpose of the note.
Author
Displays the login name of the person who created the note. The system automatically
supplies this information. You cannot change this information.
Note text
Defines the note text. The software does not limit the length of the note text.
Show dimension
Indicates that the note generates a dimension.
If you are displaying the properties for a Support component, then a dimension can be
included for the component in the Support drawings, if you select the Show dimension
option. The note must be associated with one of the key points for the Support component.
It is recommended that you set the Purpose of note as Fabrication, but this is not a
requirement. The note Name and Note text are not used when you select this option.
New Note
Creates a new note on the object.
Standard Note
Displays a list of standard notes from which you can select. This feature is not available in
this version.
Highlight Note
Highlights the note in the graphic view so that you can easily find the note and the object to
which it is related. This feature is not available in this version.
Delete Note
Deletes the currently displayed note.
The grid on this dialog box has two columns. The Property column identifies the
properties for the project. The Value column either displays a value that you can review
but cannot change, or a value that you can type or select from a list.
The Name cell is required. You cannot complete the command until you type a name.
You cannot edit the cells that have grey shading.
5. Click OK.
The new project is added to the WBS tab of the Workspace Explorer.
6. Add WBS items to the new project as needed. For more information, see Create a New
WBS Item (on page 537).
You can create as many WBS Project type projects as necessary; however, only one WBS
As-Built type project is allowed per model.
You can delete a WBS object even if objects are related to it. However, the software deletes
only the relationships, not the related objects.
You can change a design object (that is, any object that supports the relationship to a
project) from one project to another by selecting the project on the WBS tab and using the
WBS Project Edit ribbon.
Standard
WBS Type
Specifies the type of WBS item. Available options are defined in the current active Catalog
database. The list is defined by the WBSItemType codelist.
WBS Purpose
Specifies the purpose of the WBS item. You cannot change this property after you create
the WBS item. Available options are defined in the current active Catalog database and
depend on which WBS Type you selected. The list is defined by the WBSItemPurpose
codelist.
If you intend to create multiple WBS Items under the same WBS Project that use
more than one type of WBS Purpose > Iso Drawing (codelist entries 195-215), you must
create a separate label for each style of Iso Drawing used in the project. For more
information on creating labels, see the Piping Isometric Drawings User's Guide.
Exclusive
Specifies whether an object can be related to more than one Work Breakdown Structure
(WBS) object of the same type and purpose.
True indicates that the given object cannot be assigned to another WBS item of the same
type and purpose.
False indicates that the given object can belong to multiple WBS items of the same type and
purpose.
After the WBS item has an assigned object, this property becomes read-only.
All WBS items of the same type and purpose in a given project must have the
same setting for the Exclusive property.
WBS Assignment
Specifies the assignment type. The assignment type you select here controls the behavior of
the Assign to WBS command in the software. The list is defined by the
WBSItemAssignment codelist.
System indicates that Smart 3D automatically assigns all nested children of the system
object to the WBS item. As you add or remove objects from that system, you can update the
assignment with Update WBS Assignment.
Assembly indicates that Smart 3D automatically assigns all nested children of the assembly
object to the WBS item. As you add to or remove objects from that assembly, you can
update the assignment with Update WBS Assignment.
Manual indicates that Smart 3D only assigns the selected object to the WBS item. There is
no automatic assignment based on system parent or assembly. The software does not
automatically update WBS assignments for objects belonging to this WBS when you run
Update WBS Assignments or Assign to WBS. This is the default setting.
For any given WBS type or purpose, you can assign all systems or all assemblies, but not a
mixture of both. After the WBS item has an assigned object, this property becomes
read-only. To modify the assignment type, you must create a new WBS item. This option is
enabled only when Exclusive is set to True.
WBS Parent
Identifies the higher-level object that is associated with the WBS item that you are creating.
When the WBS item is created, this property is set to read-only.
Name
Specifies a name for the WBS item.
Correlation Status
Displays the correlation status assigned by the software. This value is read-only. The
following table provides a description of the correlation statuses:
Status Description
Correlated with Represents objects that have a data match between the design basis
data match data and the objects in the three-dimensional model.
Correlated with Represents objects that have a correlation with the design basis.
data mismatch However, these objects have a discrepancy, which generates the
mismatch. The cause of the discrepancy can result from changes in the
P&ID or the 3D model.
Correlated with Represents objects that have a correlation with the design basis.
approved data However, these objects have approved data discrepancies.
mismatch
Correlated with Represents objects that have a correlation with the design basis.
approved topology However, these objects have approved topology discrepancy.
mismatch
Not correlated yet Objects that have either not been modeled from the P&ID or that have
been modeled but have not been correlated with design basis data.
Ignored or not Shows that the object either is not claimed (that is, it exists in the
claimed (Project as-built condition), or that the software ignores the object (for example,
Management revision clouds and labels).
environment only)
Correlation Basis
Specifies if the object is correlated to a corresponding design basis. Select Correlate
Object to associate the objects in three-dimensional model with the design basis. Select No
correlation is required if the objects do not have a correlating design basis data.
Correlation Approval Status
Specifies if the component is approved with discrepancies in the three-dimensional data
compared with design basis data. Select Topology mismatch approved if components
topology mismatch can be ignored. Select Data and Topology mismatches approved if
the components data and topology mismatches can be ignored. Select None if you do not
want to approve a mismatch.
Administrator
Restriction Criteria
Controls the behavior of object assignment to a WBS item. The list is defined by the
WBSAssignmentRestriction codelist.
Allow assignment of all objects to WBS indicates that the software does not enforce any
restrictions based on the approval status. When this setting is active, you can assign any
object, even an object with a non-working approval state, to a WBS item. This is the default
setting.
Only allow assignment of objects in working status to WBS restricts the assignment of
objects with a non-working approval state to a WBS item. When this setting is active, the
software prevents assignment and removal of any object that is in a non-working state.
Clear all
Disassociates all previously selected objects in the model with the WBS item.
Finish
Commits the changes to the database.
Type
Displays the type of the WBS item.
Purpose
Displays the purpose of the WBS item.
Name
Displays the name of the WBS item. You can type a different name if necessary.
WBS Parent
Displays the parent of the WBS item. You can select a different parent if necessary.
See Also
WBS Items and Projects (on page 519)
Standard
WBS Type
Specifies the type of WBS item. Available options are defined in the current active Catalog
database. The list is defined by the WBSItemType codelist.
WBS Purpose
Specifies the purpose of the WBS item. You cannot change this property after you create
the WBS item. Available options are defined in the current active Catalog database and
depend on which WBS Type you selected. The list is defined by the WBSItemPurpose
codelist.
If you intend to create multiple WBS Items under the same WBS Project that use
more than one type of WBS Purpose > Iso Drawing (codelist entries 195-215), you must
create a separate label for each style of Iso Drawing used in the project. For more
information on creating labels, see the Piping Isometric Drawings User's Guide.
Exclusive
Specifies whether an object can be related to more than one Work Breakdown Structure
(WBS) object of the same type and purpose.
True indicates that the given object cannot be assigned to another WBS item of the same
type and purpose.
False indicates that the given object can belong to multiple WBS items of the same type and
purpose.
After the WBS item has an assigned object, this property becomes read-only.
All WBS items of the same type and purpose in a given project must have the
same setting for the Exclusive property.
WBS Assignment
Specifies the assignment type. The assignment type you select here controls the behavior of
the Assign to WBS command in the software. The list is defined by the
WBSItemAssignment codelist.
System indicates that Smart 3D automatically assigns all nested children of the system
object to the WBS item. As you add or remove objects from that system, you can update the
assignment with Update WBS Assignment.
Assembly indicates that Smart 3D automatically assigns all nested children of the assembly
object to the WBS item. As you add to or remove objects from that assembly, you can
update the assignment with Update WBS Assignment.
Manual indicates that Smart 3D only assigns the selected object to the WBS item. There is
no automatic assignment based on system parent or assembly. The software does not
automatically update WBS assignments for objects belonging to this WBS when you run
Update WBS Assignments or Assign to WBS. This is the default setting.
For any given WBS type or purpose, you can assign all systems or all assemblies, but not a
mixture of both. After the WBS item has an assigned object, this property becomes
read-only. To modify the assignment type, you must create a new WBS item. This option is
enabled only when Exclusive is set to True.
WBS Parent
Identifies the higher-level object that is associated with the WBS item that you are creating.
When the WBS item is created, this property is set to read-only.
Name
Specifies a name for the WBS item.
Correlation Status
Displays the correlation status assigned by the software. This value is read-only. The
following table provides a description of the correlation statuses:
Status Description
Correlated with Represents objects that have a data match between the design basis
data match data and the objects in the three-dimensional model.
Correlated with Represents objects that have a correlation with the design basis.
data mismatch However, these objects have a discrepancy, which generates the
mismatch. The cause of the discrepancy can result from changes in the
P&ID or the 3D model.
Correlated with Represents objects that have a correlation with the design basis.
approved data However, these objects have approved data discrepancies.
mismatch
Correlated with Represents objects that have a correlation with the design basis.
approved topology However, these objects have approved topology discrepancy.
mismatch
Not correlated yet Objects that have either not been modeled from the P&ID or that have
been modeled but have not been correlated with design basis data.
Ignored or not Shows that the object either is not claimed (that is, it exists in the
claimed (Project as-built condition), or that the software ignores the object (for example,
Management revision clouds and labels).
environment only)
Correlation Basis
Specifies if the object is correlated to a corresponding design basis. Select Correlate
Object to associate the objects in three-dimensional model with the design basis. Select No
correlation is required if the objects do not have a correlating design basis data.
Correlation Approval Status
Specifies if the component is approved with discrepancies in the three-dimensional data
compared with design basis data. Select Topology mismatch approved if components
topology mismatch can be ignored. Select Data and Topology mismatches approved if
the components data and topology mismatches can be ignored. Select None if you do not
want to approve a mismatch.
Administrator
Restriction Criteria
Controls the behavior of object assignment to a WBS item. The list is defined by the
WBSAssignmentRestriction codelist.
Allow assignment of all objects to WBS indicates that the software does not enforce any
restrictions based on the approval status. When this setting is active, you can assign any
object, even an object with a non-working approval state, to a WBS item. This is the default
setting.
Only allow assignment of objects in working status to WBS restricts the assignment of
objects with a non-working approval state to a WBS item. When this setting is active, the
software prevents assignment and removal of any object that is in a non-working state.
See Also
Create a New WBS Project (on page 528)
WBS Item Properties Dialog Box (on page 532)
Configuration Tab
Displays the creation, modification, and status information about an object.
You cannot define the filters using the Configuration tab.
Model
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the object belongs. You can select another
permission group, if needed. Permission groups are created in Project Management.
Transfer
Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group. This option is only available if the active model or
project is replicated in a workshare configuration. The option is not available if all of the
objects in the select set already belong to another location and are non-transferable. For
more information, see Transfer Ownership Dialog Box in the Common User's Guide.
Approval State
Specifies the status of the selected object or filter. The display depends on your access
level. You might be unable to change the status of the object. The list is defined by the
ApprovalStatus codelist.
You can only edit or manipulate an object with a status of Working.Status
Specifies the location of the object in the workflow process. Changing this property sets the
Approval State. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file. For more information, see
ApprovalReason in the Reference Data Guide.
Date Created
Specifies the creation date of the object.
Created by
Specifies the name of the person who created the object.
Date Last Modified
Specifies the date of the last modification to the object.
Last Modified by
Specifies the name of the person who last modified the object.
Notes Tab
Creates and edits user-definable text placed by the designer on an object in the model. The
notes provide special instructions related to the object for the fabricator and are available in
downstream tasks. For example, the notes appear in two-dimensional drawings and within
design review sessions.
Only one note of a given kind from a given object can be shown on a drawing. For
example, if there are two fabrication notes on a piping part, then only one of the notes shows on
the drawing. It is important to know about and to consider this situation when defining notes on
an object in the modeling phase. For example, you can display one Fabrication note and one
Installation note by defining two separate labels for the two kinds of notes.
Key point
Specifies the key point on the object to which you want to add a note.
Notes at this location, listed by name
Lists all notes for the selected key point on the object.
Date
Displays the date that the note was created. The system automatically supplies the date.
Time
Displays the time that the note was created. The system automatically supplies the time.
Purpose of note
Specifies the purpose of the note.
Author
Displays the login name of the person who created the note. The system automatically
supplies this information. You cannot change this information.
Note text
Defines the note text. The software does not limit the length of the note text.
Show dimension
Indicates that the note generates a dimension.
If you are displaying the properties for a Support component, then a dimension can be
included for the component in the Support drawings, if you select the Show dimension
option. The note must be associated with one of the key points for the Support component.
It is recommended that you set the Purpose of note as Fabrication, but this is not a
requirement. The note Name and Note text are not used when you select this option.
New Note
Creates a new note on the object.
Standard Note
Displays a list of standard notes from which you can select. This feature is not available in
this version.
Highlight Note
Highlights the note in the graphic view so that you can easily find the note and the object to
which it is related. This feature is not available in this version.
Delete Note
Deletes the currently displayed note.
The Exclusive property controls whether objects can belong to more than one WBS item
that has the same type and purpose.
All WBS items of the same type and purpose in a given project must have the same settings
for the Exclusive property.
The WBS Assignment property controls the behavior of the Assign to WBS command. For
example, you can define properties that allow you to use the system or assembly hierarchy
to automatically assign objects to the WBS item.
When a WBS item is created in Smart 3D, the following properties are set to read-only:
WBS Parent and Correlation Status. After a WBS item has an assigned object, the
following properties become read-only: Exclusive and WBS Assignment.
You can undo the creation of a new WBS item.
You can copy and paste a new WBS item.
Claim
Claims objects exclusively to the active project.
The Claim command requires that at least one as-built project exists. For
more information, see WBS Items and Projects (on page 519).
To claim objects to a project, you must have Write permission to the project. You can, however,
modify the objects without having Write permission to the project object. For example, piping
designers only need Write permission to the piping features and parts, not to the project.
Certain objects require Write permission to other related objects for modifications, but the
related objects are not claimed automatically when you claim the primary object, such as
nozzles on equipment. If you try to modify the relationship between the objects, the software
displays a permission error stating that you have not claimed both objects.
In other cases, the software automatically claims objects that are related to the object that you
are claiming. For example, control points are claimed when you claim the parent object, such as
a piece of equipment. This behavior goes both ways. If you claim the equipment, the associated
control points are also claimed. Other examples are supports/support components, member
systems/member parts, member systems/frame connections, slabs/openings, and slabs/slab
assembly connections.
To reassign a claim, use Project > Release Claim. This command moves the claimed objects
back to as-built and releases any relationships to other WBS objects. Another project can then
claim the object with the Claim command.
When selecting objects to claim, make sure that you select only the objects that you want to
claim. For example, when you "fence select" a pump, you might accidentally select more
than the pump object. You select the nozzles associated with the pump. You can also select
the foundation under the pump, even though the foundation is not nested under the pump in
the Workspace Explorer.
Exclusive claim means that the active project is the only project that can modify the claimed
object.
If errors occur when using the Claim command, refer to the Troubleshooting Reference
Guide in Help > Printable Guides for additional information.
Claiming Objects
When you work in an integrated environment, you must identify the objects that will be modified
and associate them with a project. This identification is also known as claiming.
The Claim command creates a relationship between the selected object and a project object.
In an integrated environment, exclusive claims are specific to the tool. Although a Smart 3D
project has exclusive claim on a piece of equipment, SmartPlant P&ID and Aspen Basic
Engineering users can still claim and modify the 2D version of the object in their respective
tools.
You should publish the model prior to claiming. For more information on publishing the
model, see the Drawings and Reports Help.
You can claim objects in the software by selecting objects in the model, choosing an active WBS
project, and then clicking the Claim command. You can also use the View P&ID command or
create a select filter to choose objects for claiming.
To claim objects to a project, you must have Write permission to the project. However, Write
permission to the project is not necessary in order to modify those objects. For example, piping
designers only need Write permission to the piping features and parts, not to the project.
Certain objects require Write permission to other related objects for modifications, but the
related objects are not claimed automatically when you claim the primary object, such as
nozzles on equipment. If you try to modify the relationship between the objects, the software
displays a permission error stating that you have not claimed both objects.
In other cases, the software automatically claims objects that are related to the object that you
are claiming. For example, control points are claimed when you claim the parent object, such as
a piece of equipment. This behavior goes both ways. If you claim the equipment, the associated
control points are also claimed. Other examples are supports/support components, member
systems/member parts, member systems/frame connections, slabs/openings, and slabs/slab
assembly connections.
To reassign a claim to the as-built, use Project > Release Claim. This command moves the
claimed objects back to as-built, as well as releasing any relationships to other WBS objects.
For more information, see Releasing Claims. Reassigning a claim is a two-step process. First,
you use Release Claim to set the relationship back to as-built, and then you claim to a new
project. To release a claim in an integrated environment, you must switch to the Drawings and
Reports task and publish at least one document containing the released objects.
Claim Objects
1. Select the objects that you want to claim. For example, when you "fence select" a pump,
you might accidentally select more than the pump object. You select the nozzles associated
with the pump. You can also select the foundation under the pump, even though the
foundation is not nested under the pump in the Workspace Explorer.
2. In the Active Project box on the main toolbar, specify a project.
If the appropriate WBS project does not appear in the list, click More to open the
Select Active Project dialog box (on page 258).
3. Click Project > Claim.
The software associates the objects with the active project. If no as-built projects are
available, an error message requests that you create a project in the Workspace Explorer
and choose As-built in the Project Purpose field. You can then re-run the command.
You must have an as-built project for the Claim command to run. For more information, see
WBS Items and Projects (on page 519).
You must have Write access to the active project in order to claim an object to it. For more
information, see WBS Items and Projects (on page 519).
An object can be related to only a single project. If you attempt to claim an object that
belongs to another project, the claim will fail. You must use the Release Claim command to
set the relationship back to the as-built and then re-run the Claim command to claim it to the
new project. For more information, see Release Claim (on page 540).
You can create a filter of objects by project and set a style rule, so objects belonging to a
certain project are easily distinguished.
If errors occur when using the Claim command, refer to the Troubleshooting Reference
Guide in Help > Printable Guides for additional information.
Release Claim
Reassigns the selected objects back to as-built so that another project can claim them.
You claim objects to the active project for the purpose of editing or modifying the objects.
Sometimes you need to release a claim on an object. For example, you may have claimed an
object by mistake, or another project may need to work on the object. The Release Claim
command reassigns a claim from the active project back to as-built so that another project can
claim it.
To remove a new object from the active project, you can delete the object.
If problems occur when using the Release Claim command, refer to the Troubleshooting
Guide in Help > Printable Guides for additional information.
You must have Write permission to both the project and the as-built to release an object,
and the status of both the project and the as-built must be Working.
Assign to WBS
Creates a relationship in the database between each object in the select set and the selected
Work Breakdown Structure (WBS) item in the Workspace Explorer. These relationships display
on the Relationships tab of the object Properties dialog box.
WBS assignment is controlled by the software to enforce certain conditions. Rules for
assignment to WBS items are defined by properties of the WBS item. For more information, see
General Tab (WBS Item Properties Dialog Box) (on page 532). To support automatic
assignments and updates, the Assign to WBS command uses the following rules:
For a given WBS item with a specific type and purpose, you can assign all systems or all
assemblies, but not a mixture of both. In the following example, because the first type of
assignment under Painting is a system assignment, the Assign to WBS command only
allows you to assign other systems (or individual objects) to the Painting WBS item.
When you assign a system or an assembly to a WBS item, the Assign to WBS command
automatically assigns all associated objects to the WBS item as well. For example, suppose
you assign MemberSystem-1-0101 to the Painting WBS item. The Assign to WBS
command assigns FrameConnection-1-0101, FrameConnection-1-0102, and
MemberPartPrismatic-1-0101 to the Painting WBS item automatically.
When you assign a higher-level system or an assembly object to a different WBS item, the
Assign to WBS command prompts you to move the sub-objects to the new WBS item.
You can manually assign objects to WBS items after they have been created. You can
determine which object classes are assigned during the manual assignment by editing the
object class list in the WBSAssignableNames_Manual.txt file delivered in the SharedContent
share. Only object classes in this file are assigned during the manual assignment. If the
WBSAssignableNames_Manual.txt file is deleted, all selected objects are assigned to WBS.
You can also have the objects assigned automatically as you create them by setting the active
WBS project or WBS item during modeling. If a WBS project is identified in the Active Project
box on the main toolbar, all new objects are claimed to that active project when they are
created. If a WBS item is identified, objects are first claimed to the parent project of the WBS
item and then assigned to the WBS item. Only lowest-level objects, commonly termed as parts,
are automatically assigned. For example, design objects like piping features or grouping objects
like pipelines are not assigned, but piping parts are assigned. The automatic assignment of
objects to WBS is controlled by the WBSAssignableNames.txt file located in the SharedContent
share. You can modify the file to determine which object classes are automatically assigned.
The Update WBS Assignments command handles cases where you add new objects to a
system or an assembly as part of the 3D modeling tasks, or when you move systems or
modify the system hierarchy.
The Assign to WBS command always checks to make sure that, at the time of assignment,
a system or assembly and all sub-objects are valid for assignment.
When assigning a pipe run to the WBS item, you must select the entire pipe run. Use the
Locate Filter (on page 148) or QuickPick to help with selecting the entire pipe run.
See Also
Assign Objects to a WBS Item (on page 543)
WBS Items and Projects (on page 519)
6. Click OK to create the relationships between the objects in the select set and the selected
WBS item.
7. Verify the relationship by selecting an object and doing one of the following:
Select an object and view the Relationship tab on its Properties dialog box.
Select the WBS item in the Workspace Explorer and click Select objects to assign
on the WBS Item Edit ribbon. All of the associated objects highlight in the graphical
view.
Right-click the WBS item in the Workspace Explorer and click Select Nested. All of
the associated objects highlight in the graphical view.
If no as-built project exists, then a message indicates that the command requires an as-built
project. You can create an as-built project in the Workspace Explorer by setting As-built in
the Project Purpose field. For more information, see WBS Items and Projects (on page
519).
If the select set contains objects that are already claimed to the parent project of the
selected WBS item, or the objects are not claimed to another project through another WBS
assignment, then the command highlights the objects and displays a message asking if you
want to continue with the assignment on the other objects.
If some objects cannot be assigned because of assignment type problems, a message
appears. Click Yes to continue with the valid objects.
If some of the objects are not valid because they are assigned exclusively, a message
appears. Click Yes to change the assignment of the highlighted objects.
See Also
Assign to WBS (on page 541)
If any of the objects have WBS assignment conflicts, then a confirmation message appears.
In cases where one of the assignments requires exclusive membership, the command
changes the object and its children to the more restrictive assignment. Click Yes to continue
processing the update.
If an object belongs to an assigned system or assembly object (or both), then the software
assigns the object to the same WBS item as the owning object. Any nested objects are
assigned.
If an object belongs to more than one WBS item and one of the WBS items is set to
exclusive, then the object is put on the To Do List in an error state to be resolved. You can
modify the WBS item to clear assignments when there are conflicts.
See Also
Update WBS Assignments (on page 544)
SmartPlant Menu
The SmartPlant menu provides commands for publishing documents or retrieves revisions from
engineering documents. It also provides the tools for correlating and comparing with the design
basis. Some of the commands on this menu may change depending on the active task. The
SmartPlant menu is only available in the Common, Electrical, Equipment, and Piping tasks.
In This Section
Smart 3D in an Integrated Environment ........................................ 546
Publish documents ....................................................................... 555
Find Documents to Publish ........................................................... 564
Retrieving Data ............................................................................. 565
Viewing P&IDs .............................................................................. 571
Correlate with Design Basis Command ........................................ 584
Correlate Automatically Command ............................................... 594
Compare Design Basis Command ................................................ 599
Design Basis Viewer Command ................................................... 605
Remove Correlation with Design Basis Command ....................... 610
The following graphic shows a more detailed view of the publish and retrieve operations. You
can see the flow of data and the different types of data.
See Also
Retrieve Documents (on page 569)
You can run a report in Smart 3D that lists items on the SmartPlant To Do List. Click Tools
> Run Report and open the Diagnostic folder; select Diagnostic 3D To Do List Entries,
and click Run. Before running the report, you need to check data consistency on the model
database server. For more information, see the Database Integrity Guide, available from
Help > Printable Guides.
There are other reports in the Diagnostic folder such as the Diagnostic P&ID
Correlated 3D Object that can be used in an integrated environment.
After retrieving piping and instrumentation data, you can use the colors in the P&ID Viewer
to see what objects have been modified or added to the drawing. After retrieving cable data,
you can view a cable schedule document.
Ports
SmartPlant Instrumentation uses physical ports, while SmartPlant P&ID uses logical ports.
When the workflow goes from SmartPlant P&ID to SmartPlant Instrumentation, a Same As
relationship is created between the ports in SmartPlant. That Same As relationship is required
by Smart 3D to correctly match the design basis ports to the 3D representation of the ports.
When the workflow goes from SmartPlant Instrumentation to SmartPlant P&ID, however, a
Same As relationship is not created in SmartPlant. Without this Same As relationship, the result
may be additional ports in Smart 3D. The result also depends on the way SmartPlant P&ID and
SmartPlant Instrumentation synchronize the retrieval of data.
If Smart 3D retrieves the DDP before it retrieves the P&ID, there could be four ports in the
design basis after the P&ID is retrieved. This causes a design basis mismatch in the 3D model.
This is commonly referred to as "the four-port issue". After the four port issue has appeared for
an instrument in a 3D model, it cannot be resolved. There will always be mismatched items on
the Compare Design Basis dialog box for the affected instrument.
To avoid the issue, always retrieve the DDP after you have retrieved the P&ID. If you are unable
to avoid the issue and it does appear, synchronize SmartPlant Instrumentation and SmartPlant
P&ID, and then have SmartPlant Instrumentation republish the DDP. Smart 3D can then
re-retrieve the newly republished DDP and this resolves the issue.
Piping Hierarchy
You can configure the plant breakdown structure (PBS) in the 3D model in two ways:
Before retrieving P&IDs into the model, retrieve the PBS document to set up the
plant/area/unit (PAU) hierarchy. The first three levels of the hierarchy must match between
the tools. For more information, see Retrieving Data (on page 565) in the Integration
Reference Guide.
Configure the PBS directly within the model without retrieving the PBS document. For more
information, see Creating a Plant Breakdown Structure without Retrieving a PBS Document
in the Integration Reference Guide.
Piping Data
If you define a piping hierarchy and route pipe before retrieving piping data on a P&ID, you must
correlate the existing runs to runs on the P&ID. Here is an example workflow.
1. Model the pipe run before the P&ID is available.
2. Select the existing pipe run in the 3D model.
3. Click SmartPlant > Correlate with Design Basis.
4. Select the corresponding run on the P&ID.
5. On the Compare Design Basis dialog box, click Update. The software moves the pipe run
from its existing parent to its new parent.
You can browse the Workspace Explorer to check the system assignment of the
run.
For detailed information on using the Piping task in an integrated environment, see the Piping
User's Guide.
Equipment Data
You correlate and update equipment in the Equipment and Furnishings task.
You must correlate existing equipment using a two-step process. Correlate the equipment body
first, and then correlate nozzles separately.
Nozzles correlate at the same time as equipment if they have the same names on the
equipment and P&ID.
As with piping, equipment can be built on the fly. For more information about correlating and
updating equipment, see the Correlate Existing Equipment for Use in an Integration
Environment topic in the Equipment and Furnishings User's Guide.
Claiming
Smart 3D provides the ability to exclusively claim objects to a project. Auto-claiming in Smart 3D
as a result of claims initiated in SmartPlant P&ID is not supported. Also, SmartPlant P&ID does
not support auto- claiming based on claims from other tools. Therefore, you must manually
maintain consistent claim scopes between SmartPlant P&ID and Smart 3D.
For example, when objects are shared between tools, the object is typically claimed first in
SmartPlant P&ID. In Smart 3D, use Project > Claim to claim the correlated object. When Smart
3D claims a correlated object first, SmartPlant P&ID does not auto-claim the object during a
retrieve. You must manually claim the object in SmartPlant P&ID.
Permissions
We recommend that you or your administrator create a separate permission group for users that
perform the retrieve operation. Only users from the retrieve permission group should retrieve
documents. Following this recommendation prevents ownership issues related to design basis
objects.
Smart 3D requires that you have Write permission in order to claim objects to a project. You are
not required to have Write permission to the project to modify claimed objects; you only need
Write permission to the objects themselves. You must also have Write permission to as-built,
which must be in a Working status to claim and release claims in Smart 3D.
Retrieve Documents
Retrieve documents such as PBS, P&IDs, and instrument DDPs (Dimensional Data for Piping).
The software allows you to retrieve the documents that pertain to the active model only. For
more information, see Retrieve Documents (on page 569). To retrieve an electrical cable
schedule, go to the Electrical task to perform the retrieve. For more information, see the
Electrical User's Guide.
Publish Documents
Create and publish drawings and reports, if necessary. You can also publish 3D model data in
the Drawings and Reports task or using the Tools > Drawing Console command. For more
information, see the Drawings and Reports Help.
After publishing the 3D Model Data, you can view the data in SmartPlant Foundation
and SmartPlant Review.
Publish documents
Before you can publish documents, you must ensure that your computer is configured properly.
The configuration includes installing the SmartPlant Client and the SmartPlant Schema
Component and registering the model through the SmartPlant Registration Wizard.
You must use the SmartPlant > Retrieve command in one of the 3D tasks to import published
data.
When you publish a 3D model, you must now enable the Scheduler and
Loader in SmartPlant Foundation to make the 3D model data document retrievable. The load,
consolidate, and merge tasks must complete successfully before the 3D model document can
be retrieved.
The SmartPlant menu is not available in all tasks.
1. Right-click a component and select Publish. The Publish dialog box displays.
If the Publish command is not available on the shortcut menu for the component or
document, check the document properties and make sure that the documents are
up-to-date and have been revised first.
You can use the Publish > Update and Publish command to update drawings and
publish them in one step. This command is available only if the model is registered with
SmartPlant Foundation.
2. Edit information as necessary for the selected documents.
When multiple documents are selected, only property values shared by all of the selected
documents display in the table. Changing a value in the table changes that value for all of
the selected documents.
3. Select the Publish Type.
Smart 3D supports Publish Type for delta publish.
The default setting for Publish Type is Changes Only. If the 3D model has not
been published before, the software automatically selects All and performs a
complete publish to ensure all filtered data is published and loaded into SmartPlant
Foundation.
For subsequent publishes, select All to publish all filtered data in the 3D model,
even if it is unchanged. Select Changes Only to publish only the changes in the 3D
model since the last successful publish.
If the 3D model does not publish successfully during a delta publish, select All so
that data from the previous publish is published and loaded into SmartPlant
Foundation.
Other SmartPlant applications do not support Publish Type. For these SmartPlant
applications, the default setting for Publish Type is All, and it cannot be changed.
You can verify the publishing process by starting the SmartPlant Client on your computer
and searching for the published document.
When publish is complete, the following message displays: Documents have been
published successfully. If the View Log button is enabled, messages are available
concerning the operation. These messages include errors, warning, and informational
messages. Click View Log to review these messages.
Publish
Publishes the information in the selected documents. You can access the Publish Documents
command by right- clicking a component or document.
The Publish and Update and Publish commands are available for the following types of
documents:
3D Model Data (SmartPlant Review file type)
Orthographic Drawings, including Volume and Composed drawings (viewable file with links
to data)
Piping Isometric Drawings (viewable file with links to data)
Reports (viewable Microsoft Excel workbook file with links to data)
The viewable files created when you publish drawings and reports provide relationship links
to the 3D Model Data. You must also publish the 3D Model Data to provide the navigation
between the viewable files and the 3D Model Data.
The Publish > Update and Publish command updates and then immediately publishes the
selected documents in one step. This command is available only if the model is registered
with SmartPlant Foundation.
When you publish a 3D model, you must now enable the Scheduler and
Loader in SmartPlant Foundation to make the 3D model data document retrievable. The load,
consolidate, and merge tasks must complete successfully before the 3D model document can
be retrieved.
Define the Discipline and Document Type properties to enable publishing for the documents.
For more information see Set properties for publishing documents.
For 3D model data, the Discipline and Document Type properties are already
populated.
You may also want to specify documents to be revised, not published, or reserve revision
numbers. For more information, see Revising.
To generate a list of documents that need to be published, you can use SmartPlant > Find
Documents to Publish. For more information, see Find Documents to Publish (on page 564).
You can publish isometric drawings to SmartPlant Foundation in additional file formats other
than the SHA drawing file format. These additional files along with the SHA drawing are
generated by the update process. When publishing isometric drawings you can also publish
other available data files and reports generated by the update process. For more information,
see Published Files (S3D Supplementary).
Publish Dialog Box (on page 558)
File System
Opens a standard Microsoft dialog box that allows you to select documents to add to the
Selected documents list. When you select a file with this Select File dialog box, the
Document Properties dialog box displays, allowing you to specify information about the
file, such as whether it is a new file; the category, type, and subtype of the document; and
the name, description, and title of the document.
Find
Opens the Find Documents to Publish dialog box, which allows you to search for
documents to add to the Selected documents list. For more information, see Find
Documents to Publish Dialog Box (on page 564).
Last Published
Indicates the date on which the document or documents were last published.
Name
Displays the name of the document.
Source
Indicates the authoring tool in which the document was created.
Type
Displays the type of document or documents selected.
Comment
Allows you to type information about the selected documents that are publishable.
Issue Only
Allows you to issue request documents without, necessarily, republishing them. Use this
option when no changes were made to a drawing and you only want to add it to a contract.
Even with this option set, you can still publish the documents. If any of the documents
have never been published, they must be published, regardless of this setting.
You will receive an error message if you select multiple documents and activate this
option when one or more of the selected documents cannot be changed. For example,
the error message displays if the selected set of documents includes both a new
document (for which this field can be set only to No) and current or locked documents
(for which this field can be set only to Yes). The error message prompts you to select a
smaller set of documents.
Owning Group
Select an owning group from the drop down list to which the document belongs.
By default, the owning group selected for the previous version, if any, is shown.
All the owning groups configured in SmartPlant Foundation are listed.
Revision
Displays the current revision number of the selected document or documents.
You will receive an error message if you attempt to change the value in this field
when you have selected one or more documents that have conflicting revision schemes or
different possible revisions. The error message prompts you to select a smaller set of
documents.
Revision Scheme
Displays the revision scheme applied to the selected document or documents.
Only revision schemes that are applicable to the configuration (plant) or
classification (document type) are available in the shortcut menu. The revision schemes
related to a configuration or classification are not available for any other configurations or
classifications. If none of the revision schemes are related to the configuration or
classification, then all revision schemes are available unless they are related to any other
configuration or classification. For more information on revision scheme configuration, see
Configuring Different Revision Scheme Strategies in the How to Configure Document
Management guide.
You will receive an error message indicating that this field cannot be edited if one or
more of the documents that you have selected are not new or will have a revision scheme
supplied by the authoring tool. The error message prompts you to select a smaller set of
documents.
Version
Indicates the current version of the document or documents.
Workflow
Indicates the workflow to which the selected document or documents are assigned.
Publish Type
Allows you to publish all data in a 3D model or only the changes to the model since the last
successful publish. If the 3D model has not been published before, the software
automatically selects All and performs a complete publish to ensure all filtered data is
published and loaded into SmartPlant Foundation.
First publish after creating the document All objects All objects
Subsequent publish with changes to the model All objects Changed objects
Subsequent publish with changes to the model All objects Changed objects
(after changing the Publish Type)
You will receive an error message indicating that this field cannot be edited if one or
more of the documents that you have selected have conflicting sets of possible workflows.
The error message prompts you to select a smaller set of documents.
Check and publish released claims for previously deleted items
Specifies that you want to resolve issues where deleted items were restored from an earlier
version and the claim on them was released. This check takes additional time and should
only be used when deleted items have been restored. This option is not supported in this
release.
This check box should also be activated when publishing after a backup is restored
or when releasing the claim on an object forces another tool to release the claim on a
related object that was previously deleted. In this specific case, the tool fetches the object
from As-Built again and releases the claim.
Operation
Specifies the operation to perform on the selected documents.
Publish - Selected documents are published immediately.
Background publish - Selected documents are published immediately as a separate
process, allowing you to perform other tasks at the same time.
Scheduled publish - Selected documents are published in the batch mode by the
authoring tool. This option is available only for tools that support batch mode and are
processed by the authoring tool, not the SmartPlant Client. The documents are not
published immediately. Instead, the selected documents are scheduled for publish at a
later time and may be scheduled as a recurring operation.
If the software cannot make a SmartPlant Foundation server connection
when you use Scheduled Publish, you are prompted to provide a valid SmartPlant
Foundation login and password.
Custom
Opens the Custom dialog box. This functionality is available only if defined by your project
implementation team.
Check for deleted objects no longer on documents
Select Check for deleted objects no longer on documents option if you want to process
the move instructions while publishing.
See Also
Publish documents (on page 555)
Find Documents to Publish (on page 564)
Publish (on page 557)
Document Name
Displays the names of all documents associated with the object in the Issue to field.
Retrieving Data
When you retrieve documents in an integrated environment, you are retrieving the document
data that was previously published. For example, in SmartPlant Instrumentation, you can
retrieve engineering information from a published P&ID into the SmartPlant Instrumentation
database.
To retrieve a document, you can use the SmartPlant > Retrieve command to open a dialog box
that assists you in retrieving the applicable documents.
The Retrieve command is available only if you have registered the model using the
Project Management task. You must also install the SmartPlant Client and SmartPlant
Schema Component to use the Retrieve command.
When you use the Retrieve command, the software searches the integrated environment for
documents to retrieve, and the Retrieve dialog box lists these documents.
You can retrieve a document in the following ways:
As published - Retrieves only the data that the authoring tool originally published with the
selected revision and version of the document. Retrieving as-published data retrieves the
.XML file that the authoring tool published.
With the latest data - Retrieves the latest data associated with the selected document. If
another, more recently published document contains updates to objects in the selected
document, then the software retrieves the most current data for those shared objects. When
you retrieve the latest data, an .XML file containing the published data is generated.
CDW data - Retrieves the data by updating the property values contained in a published
XML with those contained on the corresponding CDW (consolidated warehouse) object.
In Smart 3D, the types of documents and data that you can retrieve include:
P&IDs
Project Breakdown documents
Electrical
Dimensional Datasheets (DDPs)
Plant Breakdown Document
You must have write permissions to the model to use the Retrieve command.
Retrieving P&IDs
You can retrieve piping, instrumentation, and equipment data from a P&ID in an integrated
environment.
To use a P&ID in Smart 3D, the piping designer should have defined specific properties on the
objects in the P&ID. These properties include fluid code, tag sequence number, piping material
class, and nominal piping diameter. In addition, the nozzles should be labeled on the P&ID.
You should retrieve the SmartPlant Instrumentation data before placing
instrumentation in the model.
Retrieve Command
Provides a list of the published documents that are available for retrieval. This list is displayed
on the Retrieve dialog box, from which you can select the documents that you want to retrieve,
bringing the information from the integrated environment into Smart 3D.
The Retrieve command is available only if you have registered the model using the Project
Management task. For more information on registering, see the Project Management User's
Guide. You must also install the SmartPlant Client and SmartPlant Schema Component
to use the Retrieve command. For more information, see the Intergraph SmartTM 3D
Installation Guide and the Integration Setup Guide.
The Retrieve command requires that you have write permissions to the model. Otherwise,
error messages are displayed. For example, when you are retrieving the Plant Breakdown
Structure (PBS), the command displays an error that says it is unable to create the Plant
Breakdown Structure (PBS) systems when retrieving the PBS. For all errors, you have the
option of continuing the retrieve process and cleaning up the design basis, or you can
cancel the retrieve process and fix the permissions and status, then re-run the Retrieve
command.
See Also
Retrieving Data (on page 565)
Batch retrieve - Indicates that the system will retrieve the selected documents in batch mode, in
other words, in the background. When you use this feature, an e-mail message alerts you when
the process is complete. Otherwise, the retrieval process begins as soon as you click OK. This
option is not available in this release.
Work Breakdown Structure (WBS) documents, such as the Plant Breakdown
Structure (PBS) documents are considered administrative documents by the software and must
be retrieved by all tools that subscribed to these types of documents. So, even when these
documents are new to the tools (have not been retrieved by the tool before), they are still listed
in the Documents to be retrieved only list, because they must be retrieved.
See Also
Retrieve Documents (on page 569)
Retrieving Data (on page 565)
Retrieve Documents
1. Click SmartPlant > Retrieve. The Retrieve dialog box appears.
This command is available only if you have registered the active model using the
SmartPlant Registration Wizard. For more information, see the Project Management
User's Guide. You must also install the SmartPlant Client and SmartPlant Schema
Component to use the Retrieve command. For more information, see the Intergraph
SmartTM 3D Installation Guide and the Integration Setup Guide.
If you are logged on with a user name that is not defined in the integrated environment,
you are prompted to log on when you use this command.
The Retrieve command searches the SmartPlant Foundation model for documents that
are ready to be retrieved. These documents appear in the Documents to retrieve list
on the Retrieve dialog box.
2. In the Document type box, specify the type of document to be retrieved.
3. In the Show section, select Documents to be retrieved only to include documents that
have been retrieved previously and have been published again since the last retrieval.
Select All documents to include all revisions and types of documents. Select New
documents only to retrieve documents that have not been retrieved yet.
4. In the Documents to retrieve list, select the check box beside each document that you
want to retrieve. To help identify the documents, review the details in the Type, Revision,
Version, and Last Retrieved columns.
To quickly select the entire list, click Select All. To quickly cancel the selections,
click Clear All.
5. For each document that you checked, use the Retrieve Option column to specify whether
you want to retrieve the document with the latest data or retrieve it as published.
6. Click OK to retrieve the specified documents.
In the Project Management environment, the Deleted and Unclaimed Objects document is
retrieved automatically every time you retrieve, if there is a newer version of this document
since the last retrieval. The document is not included in the list, but it is retrieved
automatically to ensure that the applicable information is updated.
When the retrieval process is complete, the following dialog box appears. If the View Log
button on the dialog box is enabled, then messages are available concerning the operation.
These messages may include errors or warnings or even information messages. Click the
View Log button to see these messages.
After retrieving, you can use the View P&ID command and the P&ID Viewer to review data
that requires attention. Any items that need to be addressed appear in green, red, and
purple in the P&ID Viewer. For more information about colors, see Set Correlation Status
Colors Dialog Box (on page 577). You can use the Compare Design Basis command to
see property differences. For example, if you have custom equipment in your model, you
may need to modify select list values in the Custom Equipment reference data. You may
have to perform routing tasks from the P&ID and place inline components and instruments.
Refer to task-related documentation for assistance in correcting data from the P&ID.
To allow the placement of piping components from a retrieved P&ID, you must specify the
value SmartPlant 3D for the Use Piping Specification property in SmartPlant P&ID
Options Manager.
Examples of documents that the software can retrieve include Plant Breakdown Structure
(PBS) documents, SmartPlant® Instrumentation dimensional data sheets, electrical cable
schedules, and P&IDs. In the Project Management environment, other possible documents
available for retrieval are deleted and unclaimed object documents.
See Also
Retrieving Data (on page 565)
Viewing P&IDs
The SmartPlant > View P&ID command allows you to display a P&ID that has been retrieved
into the model.
Using a P&ID from the two-dimensional (2D) environment within the three-dimensional (3D)
environment is an example of the integration of disciplines. Beyond the display functionality, the
software allows you, the designer, to retrieve objects that correlate between the P&ID and the
model. This process helps you to create the appropriate 3D design objects.
The P&ID objects you can select and place in the 3D model include pipe runs, equipment, piping
components, cables, and instrument components. You can assign 3D objects to Work
Breakdown Structure (WBS) projects and later change the assignments to different projects.
In the Piping task, the Route Pipe command includes the option Select from P&ID to
graphically select a run from a P&ID to route. You must set the Locate Filter box to All or Pipe
Run before selecting a run from a P&ID. When you select a run on a P&ID, the software checks
to see if the run already exists in the model. If the run does exist and is correlated, then the
software locates the existing run in the model from the correlated run on the selected P&ID. If
the run does not exist, then the Create New Run dialog appears, allowing you to create the new
run. For most components, you can add them during routing or after routing is complete. Some
components, like reducers, must be inserted during routing.
The Equipment and Furnishings task also provides commands that work with placing objects
from a P&ID. These commands include the Place Equipment, Place Equipment Component,
Place Designed Equipment, Place Designed Equipment Component, Place Shape, and
Place Nozzle commands.
A picture of the P&ID File Viewer window appears below. You can resize the window with
standard Windows commands on the title bar, like Minimize, Expand, and Close. The window
has its own toolbar with viewing commands, such as Zoom Tool, Window Area, Fit, and Pan.
The colors of various objects in a P&ID reflect the correlation status between the P&ID and the
3D model. You can consider this a graphical To Do List that helps you identify additional work
after using the Retrieve command. Use the P&ID Viewer in conjunction with the Compare
Design Basis command to see property differences. You can specify the colors using Options
> Set Correlation Status Colors in the P&ID File Viewer menu bar.
The Select Correlated command on the P&ID File Viewer Tools menu selects 3D objects that
match with objects in the P&ID. You can select objects with data match, data mismatch,
topology mismatch, and unknown data match. You can also select correlated objects in as-built.
The objects must satisfy the parameters of the active locate filter. When you complete a Select
Correlated command, the software highlights the objects in the 3D view and places them in the
select set.
You can use the P&ID to access items, such as equipment, piping information, and SmartPlant
Instrumentation dimension data, to help create the appropriate 3D design objects. Also, you can
select a correlated object within the model and display the P&ID from which the object was
drawn. You can do this by selecting the object in the model and then selecting the Smart 3D >
View P&ID command. This opens the drawing in which the correlated object exits. If the
correlated objects span multiple P&IDs (such as a split equipment), then the software displays a
list of P&IDs that you can choose from.
If there is a problem displaying a P&ID or selecting objects on the P&ID, you can consider
running a custom command for troubleshooting purposes (this command does not resolve any
errors). The ProgID for this command is SP3DDisplayPIDService.VerifyPIDCmd. For more
information, see Verify P&ID Integrity Command (on page 581).
See Also
Viewing P&IDs (on page 571)
Toolbar
Zoom Out
Decreases the display size of selected objects.
Zoom Area
Magnifies an area of the model. Drag or click two points to create a fence around an object
or area of the model that you want to enlarge.
Fit
Fits all visible objects in the active view.
Pan
Moves the view up, down, left, or right to display other areas of the model. The pointer
appears as a hand when this command is active.
View Menu
This menu contains the Fit, Zoom In, Zoom Out, Zoom Area, and Pan commands to assist in
orienting the P&ID view.
Tools Menu
Magnify
Displays a small zoomed-in view of a portion of the P&ID.
Overview
Displays a small view of the entire P&ID.
Select Correlated
Selects the 3D objects that are correlated to the design basis objects. The selection of
objects is based on the locate filter that is currently specified. The Select Correlated
command highlights the correlated objects in the model and provides a way to quickly see
areas where you need to do more work, such as highlighting all objects that have Data -
mismatch.
Some of these objects may not have corresponding objects on the P&ID (for
example, the pipeline object). These commands also select objects regardless of whether
the objects are loaded in the current workspace or not. It will not change the workspace
definition. These objects can then be manipulated by commands. If they do not match the
workspace filter, then they will be removed from the workspace on the next workspace
refresh.
The Select Correlated command includes the following options: Correlated - data match,
Correlated - data mismatch, Correlated - topology mismatch, Correlated - that are in
as-built, Approved - topology mismatch, and Approved - all mismatches. For more
information about the first three options, see Set Correlation Status Colors Dialog Box (on
page 577). The Correlated - that are in as-built option selects objects in the 3D model that
are related to as-built and also are on the currently active P&ID.
Options Menu
Set Correlation Status Colors
Specifies the colors of various objects in the P&ID. The colors reflect the correlation status
between P&ID objects and the corresponding objects in the 3D model.
Set Highlight Color
Sets the color of highlighted objects on the P&ID Viewer.
Set Select Set Color
Sets the color of selected objects on the P&ID Viewer.
You can use the P&ID that the software displays in the P&ID File Viewer window as a
reference when you model objects and thus create the appropriate 3D design objects.
Among P&ID objects that you can select are a pipe run, equipment, cable, piping
component, instrument component, branch point, and an attribute break point. Piping
components and instrument components result in along-leg features in the 3D model. A
branch point results in a branch feature in 3D, and an attribute break point results in a run
change feature in 3D.
If there is a problem displaying a P&ID or selecting objects on the P&ID, then you can
consider running a custom command for troubleshooting purposes (this command does not
resolve any errors). The ProgID for this command is
SP3DDisplayPIDService.VerifyPIDCmd.
Publishing 3D Data
You can publish 3D model data in the Drawings and Reports task or using the Tools > Drawing
Console command. The model can then be viewed through SmartPlant Foundation or
SmartPlant Review. For more information, refer to the Drawings and Reports Help.
Not correlated Objects that have either not been modeled from
yet the P&ID or that have been modeled but have not
been correlated with design basis data.
Ignored or not Shows the object either is not claimed (that is, it
claimed exists in the as-built condition), or the software
ignores the object (for example, revision clouds
and labels).
See Also
Retrieving Data (on page 565)
Category
States the category for the property. Properties are listed in alphabetical order according to
the interface of the category that you selected for the property pages of the 3D model.
Select All to list all the properties in alphabetical order.
The read-only field beside the Category box provides the following information about the
correlation for the object that you selected in the 3D model:
Property Match - Indicates that the object that you selected in the model has all
properties matching those of its correlated design basis object.
Property Mismatch - Indicates that the object that you selected in the model has one or
more properties with values not matching the value of the mapped property in the
correlated object.
The check box beside the Model Property Name allows you to selectively update the
properties in the list. You must select Copy properties from design basis to enable the
selective update check boxes.
indicates select state. All the properties in the list are selected for update.
indicates mixed state. One or more properties in the list are either read-only or not
selected for update.
indicates read-only. You cannot update this property.
You must check the selective update check box of the corresponding property to set its
correlation status to Property Match.
The software remembers the last saved selective update preference for an object type
such as a pipe run, equipment, and pipeline system. For example, if you do not want to
update Name for piperun1, clear the checkbox corresponding to Name, and then click
Update. When you correlate piperun2, the dialog box displays your preference from the
piperun1 you last correlated.
Model Property Name
States the name of the property for the model object.
Design Basis Value
States the value of the property for the design basis object.
To view the difference between design basis value and model value, set the
Precision value to 4 or more for the properties you defined for comparison, such as
pressure and temperature. For more information, see Units of Measure Tab (Options Dialog
Box) (on page 502).
Model Value
States the value of the property for the three-dimensional model object.
To view the difference between design basis value and model value, set the
Precision value to 4 or more for the properties you defined for comparison, such as
pressure and temperature. For more information, see Units of Measure Tab (Options Dialog
Box) (on page 502).
Select
Selects a row in the grid. The object highlights in the model.
Close
Closes the Compare with Design Basis dialog box.
If a discrepancy exists on the Topology tab after clicking Update on the
Properties tab, you can trace the discrepancy and attempt to resolve it. For example, a
discrepancy might be an object routed or placed out of order.
See Also
Compare Design Basis with the Model (on page 604)
Compare with Design Basis Dialog Box (on page 600)
b. The 3D object does not support one-to-many correlation, and the corresponding P&ID
object and 3D object correlation already exists. The following message is displayed:
You are trying to correlate to the same object again.
Click Ok to display the Compare Design Basis dialog box with the correlation objects
highlighted. Proceed to step 6.
-OR-
Click Cancel to exit and cancel the correlation.
c. The 3D object does not support one-to-many correlation, and the corresponding P&ID
or 3D object are already correlated. The following message displays:
You are trying to correlate to an object that is already correlated. Would you like to
remove the existing correlation and correlate again?
Click Yes to remove the existing correlation and correlate the selected objects. After the
new correlation, the software displays the Compare Design Basis dialog box with the
newly correlated objects highlighted. Proceed to step 6.
-OR-
Click No to display the Compare Design Basis dialog basis with the correlated objects.
Proceed to step 6.
-OR-
Click Cancel to exit and cancel the correlation.
6. Review the Properties tab for highlighted objects that have a discrepancy between the
P&ID and the 3D model. Objects that do not match are displayed in a different background
color.
7. Review the Topology tab to understand the differences in shapes between the 3D model
and the design basis.
8. Select Copy properties from design basis if you want to update the 3D object properties.
Clear this option to prevent overwriting the 3D object properties from design basis.
9. Click Update to correlate the 3D object with design basis object.
You can also select the Correlate with Design Basis command after activating a
model object, a design basis object, or both types of objects. If you select an object before
starting the command, follow the prompts on the status bar at the lower left of the application
window.
The filter capability provides a means to query all piping objects based on their correlation
status with one operation.
In addition to the filter for piping components, you can create a filter to select all pipes with a
specific correlation status. For more information, see Create a Filter to Select Pipes Based
on Correlation Status (on page 593).
The filter capability provides a means to query all piping objects based on their correlation
status with one operation.
In addition to the filter for pipes, you can create a filter to select all piping components with a
specific correlation status. For more information, see Create a Filter to Select Piping
Components Based on Correlation Status (on page 592).
If no 3D objects are selected, then the command runs the correlations for all selected P&ID
drawings against all 3D objects in the workspace.
Nozzles are correlated automatically when the parent equipment is correlated.
You can correlate one P&ID pipeline to many 3D pipelines. You can also correlate one P&ID
pipe run to many 3D pipe runs.
Parent
Displays the name of the parent to which the P&ID belongs. Click , and select the parent
from the list to filter.
[All] - Displays all the available P&IDs. This option is selected by default.
[Custom Filter] - Allows you to customize the object filtering. Displays AutoCorrelate
Custom Filter when you select this option. To filter, type the exact parent name or type
* and % special characters as the first or last characters in the AutoCorrelate Custom
Filter box.
Copy properties from design basis
Copies properties from the design basis objects to the corresponding 3D objects. This
option is not selected by default. Changes made to this option are saved to the session file.
Selecting this option overwrites the 3D object properties with the
corresponding correlated design basis object values. Therefore, do not select this option if
you do not want to modify the properties of a 3D object.
Changes made to this option are applied to all the commands that use it. For
example, if you select this option in the Correlate Automatically dialog box, then this option
is also selected in the Correlate with Design Basis and Compare with Design Basis
dialog boxes.
See Also
Automatically Correlate with the 3D Model (on page 595)
Correlate Automatically Command (on page 594)
The log file is stored in the temporary folder of your Documents and Settings folder.
The software ignores objects that are already correlated in the 3D model.
Auto-Correlate Report
This report is divided into three sections that allow you to review and resolve any correlation
discrepancies. You can edit 3D objects, 3D object properties, compare with design basis,
manually correlate, and review your edits in the auto-correlate report while it is open.
Ambiguous Objects
This section contains a list of 3D objects with one or more possible matching design basis
objects.
3D Objects
Displays the name of the 3D object. Click , and select the 3D object from the list to filter
not correlated objects based on the 3D object.
[All] - Displays all the objects. This option is selected by default.
[Custom Filter] - Allows you to customize the object filtering. Displays AutoCorrelate
Custom Filter when you select this option. To filter, type the exact object name or type
* and % special characters as the first or last characters in the AutoCorrelate Custom
Filter box.
3D Type
Displays the object type. Click , and select the object type from the list to filter not
correlated objects based on the object type.
[All] - Displays all the objects. This option is selected by default.
[Custom Filter] - Allows you to customize the object filtering. Displays AutoCorrelate
Custom Filter when you select this option. To filter, type the exact 3D type name or
type * and % special characters as the first or last characters in the AutoCorrelate
Custom Filter box.
A 3D object is not correlated for the following possible reasons:
3D object has no design basis object.
3D object does not have a design basis object with matching properties and topology.
3D object's parent and the design basis object are not correlated.
You do not have write permission to update the 3D object.
Correlated Objects
Contains a list of 3D objects with matching design basis objects. This list contains both newly
correlated objects and existing correlated objects.
3D Objects
Displays the name of the correlated 3D object. Click , and select the 3D object from the
list to filter not correlated objects based on the 3D object.
[All] - Displays all the objects. This option is selected by default.
[Custom Filter] - Allows you to customize the object filtering. Displays AutoCorrelate
Custom Filter, when you select this option. To filter, type the exact object name or a
special character as the last character in the AutoCorrelate Custom Filter box.
Correlate Result
Specifies whether the object is already correlated or newly correlated. Click , and select
the result type from the list to filter the correlated object list based on the correlate result.
[All] - Displays both newly correlated and existing correlated results. This option is
selected by default.
New Correlated - Displays only objects that are newly correlated results.
Existing Correlated - Displays only objects that are manually correlated, and the
objects that are correlated prior to auto correlation.
[Custom Filter] - Allows you to customize the object filtering. Displays AutoCorrelate
Custom Filter, when you select this option. To filter, type the exact text in the
AutoCorrelate Custom Filter box.
3D Type
Displays the object type. Click , and select the object type from the list to filter not
correlated objects based on the object type.
[All] - Displays all the objects. This option is selected by default.
[Custom Filter] - Allows you to customize the object filtering. Displays AutoCorrelate
Custom Filter, when you select this option. To filter, type the exact 3D type name or a
special character as the last character in the AutoCorrelate Custom Filter box.
Topology Checker
The topology checker simply starts at one end of the pipeline and moves to the end of the line.
There are some rules that you should be aware of in order to make sure the topology checker is
running properly.
Tees and reducers have the unique ability to belong to three different runs. For the purpose
of topology comparison, any piping component can be considered to be in two runs.
A pipe run must be continuous for the topology to be checked properly. This means that no
component (tees included) can belong to a different run along that line. For example, if the
third component along a pipe run was a tee that belonged to the branch run, then the
topology checker would not give proper results because the tee breaks the run. There are
piping components that are still members of that first run, but the run is not continuous (left
image: tee is not highlighted). After this tee is made a member of the original run, the
topology checker gives proper results (right image: tee is highlighted).
For more information on the topology checker, see the Piping User's Guide.
Work Breakdown Structure (WBS) relationships (project or as-built) are shown on the
Property tab of the Compare with Design Basis dialog box. However, the Update button does
not update project membership for 3D objects to match the design basis. Use the Claim
command to claim objects to the project.
See Also
Retrieving Data (on page 565)
The check box beside the Model Property Name allows you to selectively update the
properties in the list. You must select Copy properties from design basis to enable the
selective update check boxes.
indicates select state. All the properties in the list are selected for update.
indicates mixed state. One or more properties in the list are either read-only or not
selected for update.
indicates read-only. You cannot update this property.
You must check the selective update check box of the corresponding property to set its
correlation status to Property Match.
The software remembers the last saved selective update preference for an object type
such as a pipe run, equipment, and pipeline system. For example, if you do not want to
update Name for piperun1, clear the checkbox corresponding to Name, and then click
Update. When you correlate piperun2, the dialog box displays your preference from the
piperun1 you last correlated.
Model Property Name
States the name of the property for the model object.
Design Basis Value
States the value of the property for the design basis object.
To view the difference between design basis value and model value, set the
Precision value to 4 or more for the properties you defined for comparison, such as
pressure and temperature. For more information, see Units of Measure Tab (Options Dialog
Box) (on page 502).
Model Value
States the value of the property for the three-dimensional model object.
To view the difference between design basis value and model value, set the
Precision value to 4 or more for the properties you defined for comparison, such as
pressure and temperature. For more information, see Units of Measure Tab (Options Dialog
Box) (on page 502).
Correlation Approval Status
Specifies if the object is approved with discrepancies in the 3D model data compared with
design basis data. Select Topology mismatch approved if the object topology mismatch
can be ignored. Select Data and Topology mismatches approved if the object data and
topology mismatches can be ignored. Select None if you do not want to approve a
mismatch.
Copy properties from design basis
Controls copying of properties from the design basis object to the 3D model object. Select
this option to allow the update of 3D object properties during manual correlation. Clearing
this option clears and disables all the selective update check boxes.
Update
Transfers data from the design basis object (in the P&ID, for example) to match the 3D
model object. Clicking Update changes entire property values if selective update check box
is disabled.
Close
Closes the Compare with Design Basis dialog box.
Work Breakdown Structure (WBS) relationships (project or as-built) are shown on the
Property tab. However, the Update button does not update project membership for 3D objects
to match the design basis. In the Command task, use the Project > Claim command to claim
objects to the project.
See Also
Compare Design Basis with the Model (on page 604)
Compare with Design Basis Dialog Box (on page 600)
6. Review the Topology tab to check for differences in shapes between the P&ID and the 3D
model. This tab is available only for objects that support correlation.
When you select a pipe run or a duct run, the Topology tab indicates objects that
are correlated and in the same order on the pipe run or duct run, as well as objects that are
correlated and not in the same order on the pipe run or duct run.
7. Click Close if you do not want to update the properties from design basis.
-OR-
After you correct the errors that cause the discrepancy, click Update on the Compare with
Design Basis dialog box to transfer data from the design basis object to the 3D model
object and update properties that are out-of-date. The Design Basis Value and the Model
Value columns change to show the new values.
Clicking Update changes the property values. You can selectively update properties by
selecting associated check boxes. For more information see, Properties Tab (Compare
with Design Basis Dialog Box) (on page 586).
For certain exceptions, the software does not process an update. For example, an
object that is not mapped with properties is not updated.
When you have finished your review, click Close.
Filter
Displays a pop up menu with more filter options for further refined filtering. For example,
above filter criterion may display a long list of possible matches. In such a scenario you may
want to refine your search by narrowing down the filter criteria. This filter menu allows you to
customize your search query to improve the results.
See Also
Correlate a design basis object with 3D object (on page 609)
Compare a design basis object with 3D object (on page 608)
Clicking Update changes the property values. You can selectively update properties by
selecting associated check boxes. For more information see, Properties Tab (Compare
with Design Basis Dialog Box) (on page 586).
For certain exceptions, the software does not process an update. For example, an
object that is not mapped with properties is not updated.
9. After you finish reviewing, click Close.
8. If the software detects that the design basis object is already correlated to one or more 3D
objects, the following information message displays. Click Yes to continue.
Selected Design Basis object is already correlated to another 3D object. Are you sure you
want to correlate more than one 3D object the same Design Basis object?
9. Review the Properties tab for highlighted objects that have a discrepancy between the
design basis object and the 3D object. Objects that do not match are displayed in a different
background color (red).
10. Review the Topology tab to understand the differences in shapes between the 3D model
and the design basis.
11. Select Copy properties from design basis option if you want to update the 3D object
properties. Clear this option to prevent overwriting the 3D object properties from design
basis.
12. Click Update to correlate the 3D object with design basis object.
Tasks Menu
The software uses tasks to separate its user interface into discipline-specific user environments.
Tasks are sets of commands focused on a particular engineering discipline, such as routing pipe
or placing equipment. You usually need only a few of these tasks to accomplish your particular
job. For example, if you are a piping designer, you probably only need to use the tasks that
allow you to route pipe or create isometric drawings.
You define the tasks that appear on the Tasks menu by using the Configure Task List
command. This command allows you to specify the tasks and the sequence you want them to
appear on the Tasks menu. The software saves the selected tasks in the active workspace.
Each workspace can display a different list of tasks on the Tasks menu. You can configure the
Tasks menu for the workspace at any time.
To switch to a different task, click the task you want on the Tasks menu. When you activate a
new task, the views remain unchanged, but the menu commands and tool bars are replaced by
the new task. The software does not create new views of the model when you switch to another
task. The Catalog, Systems and Specifications, and Project Management tasks do not have
views of the model. Also, some tasks do not appear in the list if you did not install them.
In This Section
Catalog ......................................................................................... 613
Common ....................................................................................... 613
Drawings and Reports .................................................................. 613
Electrical ....................................................................................... 614
Equipment and Furnishings .......................................................... 614
Grids ............................................................................................. 614
Hangers and Supports .................................................................. 615
HVAC ............................................................................................ 615
Piping ............................................................................................ 615
Space Management ...................................................................... 615
Structural Analysis ........................................................................ 616
Structure ....................................................................................... 616
Systems and Specifications .......................................................... 616
Configure Task List ....................................................................... 617
Catalog
Switches to the Catalog task.
The Catalog task allows you to view and edit the Catalog database. Under the root for the
Catalog database, you can select from catalogs such as Piping, Equipment, and Duct. You can
create and edit select lists, piping specifications, and part data in this task. There are also tools
to help you validate catalog data.
Common
Switches to the Common task.
The Common task refers to the functions shared with other tasks and identifies the commands
required to accomplish these functions. Each task user must use these commands when they
need to perform certain functions. This guideline ensures that everyone using the numerous
tasks of the software performs common operations in the same way.
The task allows you to define a workspace and perform common operations on that workspace,
also known as your session. The workspace represents the portion of the model data you need
to perform your intended task. This workspace also includes the view settings for user modeling.
Many other tasks on the Tasks menu are not available until you have defined and saved your
workspace.
After defining your workspace, you can use the Tasks menu to move among the various design
tasks. You can perform specified functions, depending on your access permissions. After you
select a task, the interface and available functionality appear. Some of the commands and
functionality are unique to the particular task. For example, some commands for the Piping task
are not available in the Equipment and Furnishings task. However, most of the Common task
commands are available in all of the various design tasks. You use the Common task
commands and functionality the same way regardless of the active task. For example, the View
and File menu commands function the same way in every task.
Electrical
Switches to the Electrical task.
The Electrical task provides a workspace for distributed cableway system design and routing of
conduit and cable. The task creates a three-dimensional representation or model of a distributed
system. You can create a fully rendered 3D model of the various cableway systems in your
model.
The Electrical task uses point-by-point route design and inserts cableway components and splits
during design. Also, the task includes placement of conduit, the hollow tubing used to house and
protect cables.
After you complete a cableway design and route conduit, you then route cables through existing
conduit and cableways. The Electrical task provides commands that allow you to create cables
and their properties, edit cable routes, which includes defining where cables enter and exit
cableway, and display the existing route of a cable.
The Electrical task also provides a command for retrieving cable schedules in an integrated
environment.
Grids
Switches to the Grids task.
The Grids task creates and manipulates coordinate systems, elevation grid planes, vertical grid
planes, and grid lines.
Coordinate systems provide a locating scheme when working in the model. The grid lines of a
coordinate system represent the relative positioning requirements for a specific design purpose.
HVAC
Switches to the HVAC task.
The HVAC task provides a workspace for distributed duct system design. The task creates a
three-dimensional representation or model of a distributed system. You can create a fully
rendered 3D model of the various duct systems.
The HVAC task uses point-by-point route design and inserts HVAC components and splits
during design. Complete specification control selects exactly the type of parts you need. You
can also modify HVAC features as design needs arise.
Piping
Switches to the Piping task.
The Piping task is used to model distributed pipelines in your model using a point-by-point
design method. Using the Piping task, you can create a fully rendered three-dimensional model
of the various pipelines in your model. You can also use this task to insert piping components,
instruments, and splits during design and then spool the pipe.
Space Management
Switches to the Space Management task.
This task creates and manages named spaces in your design. Using volumes, you can define
safety zones, areas set aside for distinct processes, maintenance regions, or any other
conceptual spaces that you need. A zone can refer to one or more space systems and areas,
while an area can be entirely or partially part of several different zones.
Several methods are available for you to define the geometry of a volume. You can define
spaces by two points, four points, or by reference to existing spaces. In addition to these
functions, you can also merge existing spaces together.
The Space Management task also provides the commands necessary to create drawing
volumes.
See Also
Tasks Menu (on page 612)
Structural Analysis
Switches to the Structural Analysis task.
The Structural Analysis task places and modifies pre-analysis objects such as load cases and
load combinations, loads, and boundary conditions. Also in this task, you can use the model
geometry created in Smart 3D to generate a CIMsteel Integration Standards Release 2
analytical model for structural analysis and design. Results from analysis and design can be
imported back into the model for immediate update of the members.
Structure
Switches to the Structure task.
The Structure task places and modifies structural objects. Using this task, you can place beams,
columns, braces, truss elements, cables, equipment foundations, column footings, openings,
slabs, and connections in your model. You can also create custom section shapes using 2D
Symbols and place those custom sections in the model.
The Structure task also provides for traffic needs by placing stairs, ladders, and handrails.
Although not required, it is recommended that you place grids using the Grids task
before placing structural members.
Configure Tasks
1. Click Tasks > Configure Task List.
2. Select the tasks you want to add to the menu from the Available task environments list.
3. Click Add.
4. If you want to remove tasks in the task list, click the task names under Task list, and then
click Remove.
After you configure the Tasks menu, you can switch to a different task by clicking the task
name on the Tasks menu.
Tasks appear on the Tasks menu in the sequence that they appear on the task list. You can
use the Move Up and Move Down buttons on the Configure Task List dialog box to
change the order of the tasks.
Each time that you open a new workspace, you can configure a new Tasks menu.
Remove
Deletes the selected tasks from the Task list box. Tasks in the Task list appear on the
Tasks menu. You must select one or more tasks in the Task list box before clicking this
button.
Move Up
Moves the selected tasks up in the Task list box and changes the order of the commands
on the Tasks menu. You can move multiple tasks simultaneously by selecting more than
one task in the Task list.
Move Down
Moves the selected tasks down in the Task list box and changes the order of the
commands on the Tasks menu.
Windows Menu
Sometimes you need to see several parts of a workspace at once. You can have several
windows open at one time. Each window can display a different view of the data in the
workspace.
The Window menu contains commands that let you manage open windows. You can create
new windows, or tile or cascade the open windows.
In This Section
New Window ................................................................................. 619
Cascade........................................................................................ 621
Tile Horizontally ............................................................................ 621
Tile Vertically ................................................................................ 622
New Window
Opens a new graphical window. Opening multiple windows is useful for tasks like routing pipe,
when you often need to view an object from several angles or to zoom in on different parts of a
model at the same time. The new window appears on top of all the other windows and becomes
the active window.
You can cascade the windows to see only the active window and the title bars of all the other
windows, or tile horizontally or tile vertically to see all the windows at the same time. If you
change the contents in one window, the other windows that contain the same information reflect
the changes automatically without refreshing the view.
The software saves the number, size, and arrangement of all open windows in your
workspace when you save the session.
Cascade
Cascades all open windows diagonally across the screen so you can see the title bar of each
window. The active window always appears in the bottom right front with the rest of the windows
behind it. The windows appear at close to full window size and stack down and to the right from
the active window. The rest of the windows appear in the order they appear in the Window
menu. You can view the title bars of several windows in this way. When you have more windows
open than will fit in the view, then a second group of windows stacks on top of the first group.
Cascade windows
Click Window > Cascade.
The software displays all the open windows overlapping so you can read the title
bars, keeping the active window in the front.
Tile Horizontally
Arranges multiple windows to fit horizontally on the screen without overlapping. The windows
appear in roughly equal rectangular sizes to fill the application window. The active window
appears on the top or the upper left. The software saves the number, size, and arrangement of
all open windows in your workspace.
Tile Vertically
Arranges multiple tall, thin windows to fit side-by-side on the screen without overlapping. The
windows appear in roughly equal sizes to fill the application window. The active window appears
in the upper left corner of the screen.
Help Menu
The Help menu contains commands that provide information about the task. For example, you
can open the online Help from the Help menu. The Help contains procedures, reference
information, and conceptual overviews that can be accessed through a table of contents,
keyword index, or full text search engine.
You can also get context-sensitive information about commands and dialog boxes in the
software by pressing F1.
If you want information on a specific topic, you can use the Index and Search tabs in the online
Help and type key words to narrow the search.
For documentation that you can print, use the Printable Guides command to display a list of all
the delivered guides. You must have Adobe® Reader® installed to open and print the guides.
If you have added Help topics, which are customized to the day-to-day procedures and practices
in your operation, the Custom Documentation command allows you to access this material in
the software. The command opens a Web page that lists the customized files, which can be in
formats like HTML Help (.chm), Microsoft Word documents (.doc), and Microsoft Excel
workbooks (.xls). Other possible file types include HTML (.htm), SmartSketch (.igr), and text
(.txt). A Web page is available for each task.
Lastly, you can find out the software version number and copyrights on the About dialog box.
This dialog box also contains a Tech Support button to aid in getting customer assistance for
troubleshooting problems.
In This Section
Help .............................................................................................. 624
Printable Guides ........................................................................... 626
Custom Documentation ................................................................ 628
About ............................................................................................ 628
Help
Opens the online Help. The Help contains procedures, reference information, and
conceptual overviews that can be accessed through a table of contents, keyword index, or full
text search engine.
See Also
Display License Information (on page 629)
Help Menu (on page 624)
You can view conceptual overviews and work through procedures while using the software.
You can look up keywords on the Index tab and search for keywords or phrases on the
Search tab.
To bookmark a topic, you can add it to the list on the Favorites tab.
Press F1 to display help on a dialog box or command.
See Also
Display Help Topics (on page 626)
Display License Information (on page 629)
Help Menu (on page 624)
Printable Guides
Opens a page in your default browser that includes links to the user's guides in portable
document format. Click a link and the corresponding guide opens in Adobe Reader, which
allows you to print the guide. The guides contain the same information that is in the online Help.
See Also
Access the Printable Guides (on page 627)
Help Menu (on page 624)
The printable guides include administrative guides, user's guides, reference data guides,
and third-party software guides.
You must have Adobe Reader installed to open and print the guides.
If pages in the PDF file display very slowly, configure Adobe Acrobat or Adobe Reader to be a
helper application. To do this, start Adobe Acrobat or Adobe Reader, click Edit > Preferences,
select the Internet category, and clear the Display PDF in browser option.
See Also
Help Menu (on page 624)
Custom Documentation
Provides access to customized Help files and other material that documents the daily
operations, specific to your operation. The command opens a Web page for the active task in
the software and lists available files. The custom documentation can consist of HTML Help files
(.chm), Microsoft Word documents (.doc), Microsoft Excel workbooks (.xls), HTML files (.htm),
SmartSketch files (.igr), text files (.txt), or any other file type for which you have defined a default
application.
You define the path to the custom documentation using the File Locations tab of the Tools >
Options dialog box. For more information, see Change a Default File Location (on page 496).
The Custom Documentation command provides a method to integrate custom Help files
that relate to the daily practices in your operation.
You define the path to the custom documentation using the File Locations tab of the Tools
> Options dialog box. For more information, see Change a Default File Location (on page
496).
See Also
Help Menu (on page 624)
About
Displays information about your copy of the software, including the version number and the
copyright, legal, and licensing notices.
See Also
About Dialog Box (on page 629)
Display License Information (on page 629)
Appendix: Shortcuts
In This Appendix
Shortcut Keys ............................................................................... 630
Shortcut Menus............................................................................. 633
Shortcut Keys
The following table lists the shortcut key combinations for various commands in the software.
Copy CTRL+C
Help F1
Hyperlink CTRL+K
Pan CTRL+SHIFT+P
Pan (using mouse wheel) Drag the middle mouse wheel to pan the view
Paste CTRL+V
Print CTRL+P
Refresh Workspace F5
Rotate about the current active axis Left and Right Arrow keys
(equipment objects)
Save CTRL+S
To Do List CTRL+T
Undo CTRL+Z
Zoom CTRL+SHIFT+Z
See Also
PinPoint (on page 389)
Shortcut Menus
Shortcut menus are menus that appear when you right-click certain areas or objects in the user
interface. You can access shortcut menus by right-clicking an object in a graphical view or in the
Workspace Explorer. The following commands appear on the shortcut menus.
New System
Creates a new system without switching to the Systems and Specifications task. This
command only appears in the Workspace Explorer.
Select Nested
Selects the object and all nested children of the object.
Copy
Copies the selected object and associated relationships to the Clipboard.
Paste
Inserts the Clipboard contents in the model. This command is enabled after you copy an
object.
Create WBS Project
Initializes a new Work Breakdown Structure (WBS) project. This command only appears in
the Workspace Explorer.
Create WBS Item
Initializes a new Work Breakdown Structure (WBS) item. This command only appears in the
Workspace Explorer.
Select WBS Assignment Method
Specifies the Work Breakdown Structure (WBS) assignment method. This command only
appears in the Workspace Explorer.
Delete
Removes the selected object from the database and deletes any relationships and notes on
the object.
Show
Turns on the display of a selected object.
Hide
Turns off the display of a selected object.
Claim
Identifies objects in the model for modification in a project.
Go to Hyperlink
Views a file or a Web page associated with an object in the model. This command is
available after you insert a hyperlink on an object.
Properties
Edits the properties of a selected object.
If you exit S3D Memory Monitor while the dialog box is displayed, the next time you start S3D
Memory Monitor, the dialog box will be displayed. If you exit while S3D Memory Monitor is an
icon, it will be an icon the next time you start S3D Memory Monitor.
When a process goes into a warning or critical state, S3D Memory Monitor displays a small
window along the bottom of the screen. These alert boxes display even if S3D Memory Monitor
itself is minimized in the System Tray.
The alert boxes will remain for a few seconds (the default is 10), then fade away. If you hover
over an alert box, a tooltip similar to that shown on the main application window displays.
If a process is in a Warning or Critical state and then goes to the Okay state, then the alert box
immediately disappears. You can also dismiss the alert box by clicking the red X on the title bar.
If a reporting process exits while in a Warning or Critical state, the row on the main dialog box
corresponding to that process will not go away. Instead, the process name highlights.
Process
Displays the name of the process. Hover the pointer over a process name to display a
tooltip with the Main Window caption for the reporting process.
Proc ID
Displays the process identification number for the process.
Status
Displays the status (Okay, Warning, or Critical) for the process.
...
Displays a continuously updated S3D Memory Stats dialog box for the process. S3D
Memory Monitor can simultaneously display a dialog box for each monitored process. For
more information, see S3D Memory Stats Dialog Box (on page 644).
Options
Displays the Options dialog box. For more information, see Options Dialog Box (on page
644).
Exit
Closes the S3D Memory Monitor dialog box.
axis
An imaginary line used to define the orientation of a system or object normally defined in terms
of an x-, y-, and z-axis. Some 3-D graphic objects have an associated axis used to define the
center or axis for rotations.
basic design
Engineering definition of the model and its systems.
bill of material (BOM)
Hierarchical decomposition of a product into constituent assemblies and parts. Specific types of
BOMs exist (for example, an EBOM is a bill of material from the point of view of an engineering
department; an MBOM is a bill of material from the point of view of manufacturing).
built ships
Complete database of NGC information after completion of the ship contract.
bulkload
The process by which reference data in Microsoft Excel workbooks is loaded into the Catalog
database.
catalog
Repository of information about components and materials used in construction. When you use
catalog parts in the model, the software places an occurrence of the catalog part in the project.
This occurrence is a copy of the actual catalog part.
Catalog database
The database that contains the reference data. Each Plant/Ship database can reference a
different Catalog database.
ceiling
Overhead design of the cabin area, including distribution systems for power, water, and
ventilation.
chain
A set of continuous and tangent segments.
change history
Process of recording information such as who, when, and why for any given modification.
change management
Software features or manual procedures for managing the consequence of change. For
example, software can support a change management feature to report drawings that need
updating as a result of a change in a 3-D model.
change propagation
Ability of the software to intelligently modify dependent design information to reflect change in a
higher order object.
class
Grouping of individual objects that share some very significant, common characteristics.
class rule check
Verification that the developing design meets the rules of a particular classification society, such
as ABS, Lloyd's, or DNV.
Class Rules
Classification Society Design Rules.
classification folder
A folder in the Catalog hierarchy that contains part classes. Classification folders are one level
above part classes. The ClassNodeType and R-ClassNodeDescribes sheets in the Microsoft
Excel workbooks define the classification folders.
codelist
A set of acceptable values for a particular property that can be referred to by an index number or
selected in a combo box. For example, the codelist for the material specification allows you to
select from a set of standard entries, such as ASTM A183-F316 Stainless Steel.
commodity code
A user-defined code that provides an index to parts in a catalog.
commodity item
A standard component found in a manufacturer catalog (an off-the-shelf component).
component
Physical part that a feature generates.
concurrent access
Ability of the software to allow multiple users to simultaneously access and modify the design of
a model.
consolidated tasks
A collection of tasks that can be run in batch. For example, the software allows you to extract a
set of drawings immediately or to schedule the batch extraction for a future time.
constraints
A logical restriction that controls how part symbols' ports relate to each other and to reference
ports. There are four constraints: parallel, perpendicular, coincident, and distance.
contract
A Work Breakdown Structure object representing a scope of work, usually performed by an
external supplier. The contract is related to a project and appears in the Work Breakdown
Structure hierarchy.
control point
A point that is used to control the shape of a NURBS (non-uniform rational basis spline) curve or
surface. Curves have a one-dimensional array of control points, while surfaces have a
two-dimensional array.
coordinate
The location of a point along the X-, Y-, or Z-axis.
coordinate system
A geometric relation used to denote the location of points in the model. The most common
coordinate system is the rectangular coordinate system, whereby points are located by
traversing the X-, Y-, and Z-axes of the model. Normally, coordinate systems have their origin
defined as 0,0,0.
cutting plane
A plane that cuts through an object.
damage records
Data relating to the damage and repair of structure or components that occurred during or after
construction of a model.
data interchange
Capability to output the design, or portions of the design, in a standard format for use or
movement to another computer software system.
database
Repository for the product model data. The database contains information to describe individual
objects in the data model and the relationships between objects as appropriate.
database backup
Process of recording a backup copy of the complete database or the incremental changes after
the date that the last complete copy was created.
database break and recovery
Utilities used to restore a database after files are corrupted.
database copy
Functionality to copy large collections of model objects from one design project to another
design project.
database management
Functionality related to managing a product model database.
database monitor record
Transactions that occur in order to provide database (DB) recovery after a stop in response with
a minimum of lost data.
degree
The highest polynomial factor in the curve or surface mathematical definition. A line is a degree
1 curve, while a cubic B-spline is a degree 3 curve.
design alternative
Difference in a design represented by a separate version. A design alternative can be a new
design prepared as a proposed change, or one of several elective options that the builder or
customer selects. Each design alternative has an identification assigned so you can uniquely
refer to the design alternatives.
design approval log
Record of review and approval of parts of the design.
design data auto input
Automation in loading existing design data into a new design database.
design documents
Drawings, sketches, material lists, procedures, and so forth that are generated during the design
phase.
design object
Any object with properties that you can select. A design object can be related to one or more
contracts of different types, but related only to one contract of a given type.
design progress check
Analysis of the content of the design to some metric unit that gives an idea of the degree of
completion.
design review
Functionality to support rapid viewing of the design and markup of features with comments.
design service
Any general system services related to the design function.
design standard
Feature or object used in model design that has been determined to the normal or approved
way of accomplishing a design requirement. In the context of computer software, the term refers
to computer functionality to support standards, not the standard itself.
detail schedule
Lowest level of schedule used to manage and track work progress.
distributed systems
Systems consisting of sequential parts with a distributive characteristic (for example, pipes
distribute fluids, HVAC distributes air, cabling distributes power, and structure distributes loads).
distribution systems
Term synonymous and used interchangeably with the term distributed systems.
documentation
Drawings and other records that you must produce to document, obtain approval, or build the
design.
drawing tool
Tool that helps in the process of creating, modifying, or manipulating objects. Examples are
PinPoint and SmartSketch.
easting
A term that describes an east coordinate location in a coordinate system.
edge
A topological object that represents a trimmed curve bounded by a start and end vertex.
edge distance
The distance from the center of a bolt or rivet to the edge of a plate or flange.
equipment catalog
Catalog of equipment geometry and limited properties that the software uses to identify and
visualize equipment and its placement in the model. The catalog is not the source for the total
specification and ordering data for the object.
external appendages
External structure attached to the hull, such as the propeller nozzle, shaft struts, bilge keel, and
so forth.
fabricate
To cut, punch, and sub-assemble members in the shop.
face
A topological object that represents a trimmed surface bounded by a loop of edges.
face plate
An edge reinforcement type that places a plate or profile at the selected plate edge.
face-to-face
The overall length of a component from the inlet face to the outlet face.
fasteners
Bolts and rivets used to connect structural members.
element
Primitive geometric shape such as a line, circle, or arc.
fence
Boundary or barrier that separates or closes off an area. To surround or close like a fence.
field adjustment
Material added to the neat design geometry of piping or structural parts to allow for extra
material when it is required due to uncontrolled variance in the manufacturing and construction
process.
fire integrity
Deck and bulkhead treatments and fire and smoke blocks for fire control and retardation.
flavor
A different variation of a symbol. Each variation has different occurrence property values.
focus of rotation
A point or line about which an object or view turns.
full penetration weld
A type of weld in which the weld material extends through the complete thickness of the
components being joined.
function points
Part of the requirements documentation, function points are the smallest granularity of a
requirement statement that describe specific detailed actions that the software performs.
functional block diagram
Schematic representation of a system (piping, electrical, ventilation) showing system parts and
their relationship. You use symbols to represent equipment and components. A connecting
network of lines illustrates their relationship. Taken together, the symbols and the network
illustrate the function of the system.
furnishings
Parts such as movable articles and fittings that normally are not associated with a system (for
example, a chair).
generic specific
Object that is parametrically defined or defined to suit a family of specific parts (for example,
International Standards parametrics). For example, a 100 - 200 gpm pump in the catalog can
provide a general shape to appear in the model until a specific object has been identified.
GUIDs
Acronym that stands for Globally Unique Identifiers. The software automatically creates the
GUIDs sheet in the Excel workbooks when you create the Catalog database and schema. The
purpose of storing GUIDs within Excel workbooks is to help you keep track of what has been
loaded into the database. Storing GUIDs also helps to avoid the situation in which a
replacement Catalog database causes existing models to become invalid.
host location
The first location created for a Site. This host location is defined when the Database Wizard
creates the Site database.
host server
The database server on which the Site database was created using the Database Wizard.
Alternatively, if it is a restored database set, the Host Server is the database server where the
Site database is restored. The Host Server in a Workshare environment contains the origin for
the Site, Site Schema, Catalog, and Catalog Schema databases. Consequently, most Project
Management and reference data work must take place at the Host.
initial design
Early stage of design work, generally before contract, used to estimate construction costs and
provide a rough concept of the intended model. Contains information relating to a model created
during its initial (concept) design period.
initial structural plan
Principal structural plan for the model; also called a construction profile.
instantiation
Occurrence of a catalog object at a specific geometric location in the model.
interference checking
A process that identifies possible collisions or insufficient clearance between objects in the
model.
job order
Industrial authorization for accomplishing work; synonymous with a work order.
joiner
Non-structural bulkheads, and trim and built-in furnishings.
kinematics analysis
Analysis of mechanical motion.
ksi
Kips per square inch.
leg length analysis
Preferred term is welding length analysis.
library
Resource of reference information that you can access in developing a model design.
life cycle database
Information developed to assist in the maintenance and modernization of delivered models.
link
Way to store information about another file in your document. You can update a link so that
changes in the file appear in your document.
lintel
A horizontal member used to carry a wall over an opening.
load group
A grouping in which all components feature uniform load limits and stress safety characteristics.
For example, if a pipe clamp from load group 5 has a maximum nominal load of 20kN, then so
does a threaded rod from load group 5.
location
A Location is defined by three user-defined inputs: 1) a unique name, 2) a unique name rule ID,
and 3) the server where the Site databases reside for that Location. A Location is defined and
created when the Site database is created using the Database Wizard. Additional Locations can
be created in the Project Management task. Each Location is a Site-level object, thus other
Models within the same Site collection can use the Locations when the Models are configured
for Workshare.
logical member
An object in the model used to represent the design topology.
machinery
Major pieces of equipment installed in a model.
macro
A sequence of actions or commands that can be named and stored. When you run the macro,
the software performs the actions or runs the commands. You can create the macros in Visual
Basic or other OLE-aware programming applications. Some of the other OLE-aware
programming applications are Visual Basic for Applications, Visual C++, and so forth.
maintenance envelope
A rectangular box around the part for clearance during maintenance operations.
maintenance parts
Required material for depot or on-board repair or overhaul of equipment, as determined by
engineering study. Generally at a level below the purchased construction object of the model.
maintenance records
Records of breakdown, repair, and overhaul of equipment.
material analysis
Analysis of a completed design work for extracting detailed material requirements; also called
material lists.
material list
An option category that controls the format and content of the bill of materials.
methods
Objects in the database that describe the manufacturing methods to the component parts of a
model.
move from point
Starting point for an action. For example, when you move an equipment object, the Move From
point determines the point of origin for the move.
move to point
Ending point for an action. For example, when you move an equipment object, the Move To
point determines where you want the move to stop.
MTO neutral file
A non-graphic output file that can be fed into a material control system. MTO stands for Material
Take-Off.
natural surface
A surface without a boundary curve.
node
One of the set of discrete points in a flow graph.
A terminal of any branch of a network or a terminal common to two or more branches of a
network.
An end point of any branch or a network or graph, or a junction common to two or more
branches.
northing
A term that describes a north coordinate location in a coordinate system.
nozzle
A piping connection point to a piece of equipment.
nozzle standout
The shortest allowable distance between the connection point of a nozzle and the start point of a
turn on the leg connected to the nozzle.
NPD (Nominal Piping Diameter)
The diameter of a pipe.
object
A type of data other than the native graphic format of the application.
occurrence (of part or equipment)
Instantiation of a part of equipment in the plant that refers to the part library; an instance of a
specific object. The design can be built several times, and therefore the occurrence can apply to
more than one hull. Typically, an occurrence points back to a specific object, either for its
complete definition, as in the case of a particular valve, or for its made from material, as in the
case of a steel plate part cut from sheets. Thus, when a designer selects a component from the
catalog and places it at a location in the space of the plant, the software creates an occurrence
of that object in the plant design.
occurrence property
A characteristic that applies to an individual object in the model. Occurrence properties are
designated with 'oa:' in the reference data workbooks. You can view and modify occurrence
properties on the Occurrence tab of the properties dialog boxes in the software. Depending on
the object, some occurrence properties are read-only.
origin
In coordinate geometry, the point where the X-, Y-, and Z-axes intersect.
origin point
The point at which the coordinate system is placed, providing a full Cartesian coordinate system
with positive and negative quadrants. Points are placed at coordinates relative to the origin
point, represented by the X, Y, and Z values.
orthogonal
The characteristic of an element consisting completely of elements positioned at 90-degree
angles. A square is an orthogonal element.
orthographic
A depiction of an object created by projecting its features onto a plane along lines perpendicular
to the plane.
P&ID
Diagram that shows the topology, functional components, and special requirements of a piping
system; generally represents the engineering design of the system.
package
Set of closely related classes. (UML)
painting
Computation of paint surface and recording of paint system requirements.
parameter
A property whose value determines the characteristics or behavior of something.
part class
A group of similar objects. You can define part classes in the Excel workbooks. A part class can
have multiple parts. For example, a heat exchanger part class can contain heat exchangers with
different dimensions.
part number
Unique identifier of a part.
reference data
The data that is necessary to design plants or ships using the software. Reference data includes
graphical information, such as symbols. It also contains tabular information, such as physical
dimensions and piping specifications.
resource estimation
Rough estimate of material, manpower, and facility utilization for the design and construction of
the model.
route
1) A line connecting a series of points in space and constituting a proposed or traveled route. 2)
The set of links and junctions joined in series to establish a connection.
satellite server
The database server where the replicated databases reside for Workshare. The Satellite Server
is not used unless Workshare is activated.
schema
A database that creates the structure of another database. For example, a schema specifies the
queries, tables, fields, and data types in a database.
schema update utility
Functionality used to assist in processing existing product models to an updated database
structure after you modify or add to the database structure.
sheetbody
A topological object that represents a collection of faces joined along their common edges
(stitched).
shell structure
External portion of the surface of the model.
ship
A collection of modeled objects that can be simultaneously displayed and edited in a workspace.
A Ship points to a Catalog (optionally shared with other Ships). Access control is managed at
the Ship level.
site
The top level in the Project Management hierarchy. A Site configuration may contain several
Catalogs, each shared by multiple Models.
site administrator
Person responsible for managing the standards and general parameters for a given model site
within a Site database.
site setup
Functionality associated with establishing a new model site or hull for design development.
tolerant geometry
A type of ACIS geometry - either an edge or a vertex - that is outside the tolerance for ACIS and
requires special handling.
transverse
At right angles to the fore-and-aft center line.
transverse frames
The athwartship members that form the ribs of the ship.
trim
The difference between the forward draft and the aft draft.
trimmed surface
A surface whose boundary is fully or partially inside the "natural" geometric definition of the
surface. Some or the entire control polygon extends outside the face boundary.
trunk
Feature that quickly reserves space for the distributive systems and other systems that have a
path. Along the trunk are stations that define the cross section and identify part or system
membership.
tumble home
The inboard slope of the side of a ship, usually above the designed waterline.
unit/module modeler
Facility of the system to structure collections of equipment and components into a single
identifiable object.
user attributes
A customized property in the reference data. The Custom Interfaces sheets in the Excel
workbooks define these properties. You can list the customized properties on the individual part
class sheets.
version control
Ability of the system to manage multiple versions of a single part of the design. Version control
should support conditional analysis and promotion status, as well as alternate design features
among hulls within a model site.
vertex
A topological object that represents a point in the three-dimensional model.
vertical keel
A row of vertical plates extending along the center of the flat plate keel.
viewset
Set of objects (usually a subset of the entire database) that a view operation uses. Membership
or lack of membership for any object in a viewset does not affect the actual stored
representation of the object, but only its availability or desirability for viewing in the current
scenario.
water line
A line parallel with the base line that depicts the water.
watertight door
A door that when closed prevents the passage of water.
weather deck
A deck exposed to the weather.
weathertight door
A door that when closed prevents the passage of rain and spray.
weight and CG analysis
Routines that compute the weight of commodity materials as configured in a given design (for
example, plate and pipe) and determine total weight and center of gravity (CG) for a collection of
material and equipment, as well as the complete model.
welding
Weld requirements for joining materials. Welding length analysis is the calculation of required
weld dimensions; also called leg length analysis.
windlass
The machine used to hoist and lower anchors.
wirebody
A topological object that represents a collection of edges jointed at their common endpoints.
wizard
Software routine attached to an application that provides guidance and expert help to you to
complete one of the functionalities of the application.
work content
Estimation development of metrics from the database that relates to the work hour content of the
various construction units.
work order
Plant authorization for completing work; synonymous with a job order.
working plane
The available 2-D plane of movement for endpoint selection.
workset
Set of objects (usually a subset of the entire database) used in an interactive change, add, or
delete operation. Membership or lack of membership for any object in a workset does not
necessarily affect the actual stored representation of an object. However, you can change or
delete an object in a workset that also results in a change or deletion of the stored object.
Similarly, when you add a new object (not currently stored) to a workset, the software also adds
the object container.
workspace
Area that represents the portion of the model data needed to perform the intended task and
includes the user modeling settings.
workspace document
Document into which you can extract a portion of the model data for a user task.
Workspace Explorer
Tree or list representation of objects in your workspace.
I J
job order • 653
Icon Relationships • 254 joiner • 653
Icons in the Workspace Explorer • 246
Import coordinate system • 81
Import Electrical • 75 K
Import Electrical Data Dialog Box • 76 kinematics analysis • 653
Import Electrical Data Using PDS Model ksi • 653
Data Exporter • 77
Import Equipment • 78 L
Import Equipment Data Dialog Box • 79
Import Equipment Data Using PDS Model Label Editor Dialog Box • 505
Data Exporter • 80 leg length analysis • 653
Import Grids • 81 Levels and Layers Tab • 260
Import HVAC • 83 library • 653
Import HVAC Data Dialog Box • 84 life cycle database • 653
Import HVAC Data Using PDS Model Data Lights Tab (Format View Dialog Box) • 319
Exporter • 85 link • 654
Import Piping • 86 lintel • 654
Import Piping Data Dialog Box • 87 load group • 654
Import Piping Data Using PDS Model Data Locate Filter • 149
Exporter • 88 Locate Filter Dialog Box • 150
Import Structure • 89 location • 654
Import Structure Dialog Box • 90 logical member • 654
Import structure model • 89 Look Around • 226
Import XMpLant Formatted Electrical Data • Look at a surface • 215
76 Look at Surface • 215
Import XMpLant Formatted Equipment Data
• 80 M
Import XMpLant Formatted HVAC Data • 84 machinery • 654
Import XMpLant Formatted Piping Data • 88 macro • 654
Importing and Exporting Data • 70 Magnify an area • 239
Indicate elevation on drawings • 297 maintenance envelope • 654
initial design • 653 maintenance parts • 654
initial structural plan • 653 maintenance records • 654
Insert a hyperlink • 283 Manage ToolTips • 498
Insert a note • 286 Managing Sessions • 49
Insert a note at a precise place on an Managing Sessions Common Tasks • 50
isometric drawing • 287 Manipulate the active view • 197
Insert a reference file • 275
Insert File • 274
Insert Hyperlink Dialog Box • 284
Review design basis object properties • 610 Select Naming Rules Dialog Box • 449
Review MDR Results • 465 Select Object Type Dialog Box • 385
Review MDR Results Dialog Box • 466 Select objects by fence for a work session •
Rotate a view around a linear object • 213 351
Rotate a view around a new center point • Select objects by filter • 369
212 Select objects by locate filter for a work
Rotate a view around an axis • 210 session • 351
Rotate an Object about a Line or Port • 167 Select objects using QuickPick • 353
Rotate an object about an axis • 164 Select Properties Dialog Box • 384
Rotate an object using bearing, pitch, or roll Select Rule Dialog Box (Label Editor -
• 169 Position Definition) • 508
Rotate an object using perpendicular to Select Rule Dialog Box (Label Editor - Unit
references mode • 165 of Measure) • 506
Rotate Object • 158 Select Space Folder Dialog Box • 450
Rotate View • 209 Select System Dialog Box • 157, 263
route • 658 Select View Style Dialog Box • 449
Rulers • 264 Selected PG Tab (Options Dialog Box) •
Rulers Dialog Box • 264 514
Run a custom command • 459 Send • 58
Run an Existing Catalog Report • 440 Send a session to another user • 58
Run an Existing Personal Report • 440 Server-Based Interference Checking
Run Report • 435 (Database Detect) • 431
Run Report Dialog Box • 436 Session Files Best Practices • 51
Run the S3D Memory Monitor automatically Set Correlation Status Colors Dialog Box •
• 639 577
Run the S3D Memory Monitor manually • Set enhanced edge color • 310
638 Set isometric break control points for
drawings • 295
S Set options for the S3D Memory Monitor •
641
S3D Custom Form Definition Wizard Dialog Set the activation time for QuickPick • 499
Box • 493 Set the Locate Zone • 499
S3D Memory Monitor Dialog Box • 642 Settings Tab (Export Grids Dialog Box) •
S3D Memory Stats Dialog Box • 644 104
satellite server • 658 Settings Tab (Import Grids Dialog Box) • 82
Save • 56 sheetbody • 658
Save a session • 56 shell structure • 658
Save a view • 202 ship • 658
Save As • 56 Shortcut Keys • 631
Saving views • 41 Shortcut Menus • 634
Scaling Data Examples • 280 Show • 386
Schedule [Task] Dialog Box • 98 Show All • 388
schema • 658 Show all invisible objects • 388
schema update utility • 658 Show an invisible object • 386
Select • 348 Show or Hide Workspace Explorer • 257
Select a standard isometric or orthographic Show session properties • 57
view • 204 site • 658
Select Active Project Dialog Box • 258, 521 site administrator • 658
Select by Filter • 355 site setup • 658
Select Directory Dialog Box • 510 sketch and trace • 659
Select Drawing Type Dialog Box • 449 Smart 3D in an Integrated Environment •
Select Filter Dialog Box • 370 547
Select Label Dialog Box • 504 SmartPlant Menu • 546
W
water line • 661
watertight door • 661
WBS Item Edit Ribbon • 531
WBS Item Properties Dialog Box • 532
WBS Items and Projects • 520
WBS Project Edit Ribbon • 523
WBS Project Properties Dialog Box • 524
weather deck • 661
weathertight door • 661
Weight & CG • 515
Weight & CG Display List • 517
weight and CG analysis • 661
welding • 661
What's New in Common • 13
windlass • 661
Windows Menu • 619
wirebody • 661
wizard • 661
Work Breakdown Structure Tab (Filter
Properties Dialog Box) • 376
work content • 661
work order • 661
Workflow for Smart 3D in an Integrated
Environment • 554
working plane • 661
workset • 662
workspace • 662
workspace document • 662