SPPID Users Guide
SPPID Users Guide
User’s Guide
Trademarks
Intergraph, the Intergraph logo, SmartSketch, FrameWorks, SmartPlant, INtools, MARIAN, PDS, and IntelliShip
are registered trademarks of Intergraph Corporation. Microsoft and Windows are registered trademarks of Microsoft
Corporation. Other brands and product names are trademarks of their respective owners.
Table of Contents
Table of Contents
Customer Support and Documentation Comments......................................................10
Using the Catalog Index in SmartPlant P&ID and TEF Integration............................... 374
The SmartPlant P&ID Framework Adapter and Tool Schema ................................376
Publish ............................................................................................................................ 376
Retrieve........................................................................................................................... 377
SmartPlant P&ID Mapping Rules and Limitations......................................................... 378
Tool Schema Location..............................................................................................379
The Tool Schema Data Model..................................................................................380
MapClass ........................................................................................................................ 381
MapProperty ................................................................................................................... 383
MapEnumList ................................................................................................................. 384
MapEnum........................................................................................................................ 385
MapUoMList .................................................................................................................. 386
MapUoM......................................................................................................................... 387
Property Conversions................................................................................................389
Hierarchical Enumerated Lists .................................................................................391
Catalog Index............................................................................................................392
Drawing ....................................................................................................................393
Equipment.................................................................................................................394
Instrument .................................................................................................................395
PipeRun.....................................................................................................................396
PipeLine....................................................................................................................397
Glossary ..........................................................................................................................438
Index................................................................................................................................455
SmartPlant P&ID is vastly different from graphic-driven P&ID solutions of today. All
data from the P&ID is stored in the plant database and adheres to plant standards. The
graphical representation of the P&ID is a view or a report of the data. The strong data
import and export facilities of SmartPlant P&ID allow users to populate the system
with relevant plant data, such as process data from process simulation databases
based on Aspen Zyqad from Aspen Technologies, Inc. or equipment and line lists.
You can then use this information in the SmartPlant P&ID Stockpile to design the
P&ID.
SmartPlant P&ID has several programs and utilities for running and managing your
plant data.
Opens the Help viewer where you can read topics about commands, procedures,
dialog boxes, and so forth.
Opens a page in your default browser that includes links to the user's guides in
portable document format. Click a link, and the guide opens in the appropriate
application. You can print it if necessary. The user's guides contain the same
information as the online Help.
Activates your web browser and opens the SmartPlant P&ID World Wide Web page.
On this page, you can access registration and support information, learning tools, and
other items to help you use SmartPlant P&ID more efficiently.
Opens your web browser to the Intergraph Process & Power Client Community web
page. On this page you can learn about international and regional conferences, online
forums, informal networking, structured product feedback, and more. Follow the
instructions and links on this web page to find your information.
Displays information about your copy of the software, including the version number
and the copyright, legal, and licensing notices.
Note
• Programming with SmartPlant P&ID is the method by which you can use
the Automation layer to customize the software to meet your own
particular requirements. This documentation consists of a programmer's
guide and reference guides for placement automation and the logical
model.
Design Window
The Design window displays Drawing views and the Engineering Data Editor. Each
of these views provides a way for you to enter information for the plant model into
the database. The two views also provide a way for you to view information in the
database in different ways. In the Drawing view, you can see the traditional diagram
of a plant containing equipment, instrumentation, and piping in a graphical
representation. The Engineering Data Editor allows you to see the same information
in a tabular format, and it can also display items in the plant and drawing stockpiles.
Catalog Explorer
The Catalog Explorer displays all available catalog items for you to use in drawings
and plant models. The Catalog Explorer contains a hierarchical representation of the
selected catalog. You can navigate through the nodes in a catalog by clicking the + or
– icons by the selected node. In addition, you can double-click nodes in the tree view
to open them.
Properties Window
When you select an item in a plant model, you can enter, view and modify the
properties associated with that item in the Properties window. Your system
administrator defines customized properties and their defaults for each item in Data
Dictionary Manager.
Related Topics
• Add an Item to the Stockpile from Catalog Explorer, page 67
• Place an Item from Catalog Explorer, page 66
• Place an Item from the Stockpile, page 250
Miscellaneous shortcuts
To Press
Cancel a command Esc
Note
• To get shortcut mnemonics on a Windows® 2000 system, you must
choose a specific setting. Right-click the desktop, choose Properties,
select the Effects tab, and clear the selection of Hide keyboard
navigation indicators until I use the Alt key.
You can define one or more Engineering Data Editors for a drawing. The
Engineering Data Editor displays drawing information in a table, much like a
Properties window. In the Engineering Data Editor, you can specify filters and
layouts to define the table information and even edit some item properties.
By using commands on the Window menu, you can cascade or tile views to more
easily navigate among them.
• (B) Engineering Data Editor - A tabular view that presents the plant data
in a tabular format.
SmartPlant P&ID provides multiple views of a central, unified data structure that
represents the plant model. A view is a visual presentation of the data that composes
the plant model and can be a schematic drawing or a table. The plant model is the
computer representation of the conceptual design in its entirety, including all plant
components and their relationships. By manipulating model views, you can organize
the information within the plant model to better understand and maintain the data.
Caution
• The software continually updates the database as you edit a drawing;
however, the software does not update the drawing file until you actually
save the file (when you click File > Save or when you quit the program).
Occasionally, the software can end in an abnormal way, for example, due
to power outage. As a result, the database is up-to-date with changes that
you posted to the drawing, but the drawing file reflects the status when
you last saved the drawing. When you re-open the drawing, the software
recognizes that the drawing file is different from the database and displays
a message: One or more items in this drawing are inconsistent with the
database. Click OK to re-create the drawing from the database.
For more information about the data model, see Using the Properties Glossary: An
Overviewin the SmartPlant P&ID Help
Related Topics
• Define a New Engineering Data Editor View, page 54
• Define a New Filter for an Engineering Data Editor View, page 54
• Define a New Layout for the Engineering Data Editor, page 55
• Open a New Drawing View, page 39
• Open an Existing Drawing, page 107
Show Command
Available on the Drawing View Shortcut menu, the Show command allows you to
choose to display drawing elements, such as notes, labels, grids, and so forth.
Related Topics
• Change the Properties of a Drawing View, page 37
Options Command
Tools > Options
Changes settings that control recently used files, screen appearance, placement
information, export formats, and so forth. Opens the Options dialog box.
Related Topics
• Customize the Software With the Options Command, page 26
• Customizing the Software: An Overview, page 90
• Linking and Embedding Objects: An Overview, page 266
Related Topics
• Customize the Software With the Options Command, page 26
Recently used files list - Sets the number of entries for the recently used files list on
the File menu.
Display as printed - Displays the drawing as it appears when you print it.
Show status bar - Displays the status bar at the bottom of the main window. When
you point at the command button on the toolbar, the description appears in the status
bar at the bottom of the window. Also, prompts that explain what to do at each step of
the command appear in the status bar, and messages about the operations the software
is performing appear in the status bar.
Related Topics
• Break a Link, page 276
• Change a Link, page 275
• Customize the Software With the Options Command, page 26
• Embed a New Object, page 270
• Link or Embed a Previously Existing Object, page 271
Background - Sets the default background color for all Drawing views in the active
drawing.
Selected items - Sets the color of selected items. The connect points in the drawing
appear in this color, too.
Use Defaults - Sets all the colors listed above to the default display value.
Note
• To set the symbology, (for example, the line weight and color) for item
types throughout a plant structure, use Options Manager.
Related Topics
• Customize the Software With the Options Command, page 26
• Options Command, page 22
Default construction status - Assigns the selected construction status to all placed
items. This list contains the following options: New, Existing, and Future. The plant
administrator sets the plant-wide default at setup, but this option allows you to change
the default on a drawing-by-drawing basis. The construction status for an item
appears in the Properties window when the item is selected. Also, the construction
status can be set for individual drawing items by changing its value in the Properties
window.
Locate - Specifies the range, called the locate zone, at which a candidate item is
highlighted when another item approaches. A candidate item is any item in the
drawing that meets the placement rules of the approaching item. For example, a pipe
run can be a candidate item, and a valve can be an approaching item to that pipe run.
The pipe is highlighted when the valve is within the locate tolerance. If you are not
placing an item but only selecting drawing items, the locate tolerance defines how
close that the pointer must approach in order to select the item.
Break-away - Sets the number of pixels at which an item disconnects from its parent
item. For example, to move a valve, you drag the valve. If you keep the pointer within
the break-away tolerance from the line, the valve does not disconnect from the line.
Place partner OPC in Stockpile - Indicates that when a new off-page connector,
OPC, is placed, the partner OPC is automatically stored in the Stockpile. If you clear
this option, the Set Stockpile Location of Partner OPC dialog box appears after you
place a new OPC. Using this dialog box, you can indicate the drawing in which the
partner OPC is stored until you place it in that drawing.
Related Topics
• Change Default Storage Location for Partner Connector, page 192
• Customize the Software With the Options Command, page 26
• Options Command, page 22
Plant Hierarchy - Displays the hierarchical tree representation of the plant. When
you select a node, the drawings associated with that node appear in the Drawing list
area.
Drawing list - Displays all the drawings associated with the selected node on the
Plant Hierarchy tree. Choose a stockpile from this view to associate your partner
connector with.
Related Topics
• Change Default Storage Location for Partner Connector, page 192
• Move a Connector to Another Stockpile, page 192
• Move a Partner Connector to Another Stockpile, page 194
• Place an OPC or Utility Connector, page 190
• Store a Partner Connector, page 192
Coincident (1:1) - Imports a reference file, also known as an inserted object, at full
scale (1:1). This setting causes the reference file to appear temporarily in the lower
left of the drawing and determines a drawing scale that fits the reference file within
the drawing. The reference file is at the end of the pointer, ready to be placed in the
drawing, much like a catalog item during placement mode.
Select Scale - Sets the drawing scale to a standard ratio. The specified ratio defines
the size of the drawing in relation to the size of the real-world object. For a 2:1 ratio,
the 2 represents the size of the drawing and the 1 represents the size of the real-world
object.
Note
• The Fit to Sheet option in the Select Scale list determines a drawing sheet
scale that fits the reference file within the sheet but allows you to specify
where the file is inserted by clicking on the drawing sheet.
Custom Scale - Sets the scale for a drawing that you insert. For example, when you
type 3 and 2 in each of the respective boxes, the scale of the foreign drawing is one
and one half times its original size.
Browse - Opens the Browse dialog box, which allows you to select a local or
network folder to store your user-defined report templates (My Reports).
Related Topics
• Break a Link, page 276
• Change a Link, page 275
• Customize the Software With the Options Command, page 26
• Edit an Embedded Object, page 275
• Embed a New Object, page 270
• Link or Embed a Previously Existing Object, page 271
Look in - Displays the currently selected folder and the available folders in the active
drive.
Drives - Lists the drives that are currently active on your computer. Select a different
drive in order to see directories that reside on that drive in the Look in box.
Related Topics
• Customize the Software With the Options Command, page 26
• Options Command, page 22
Related Topics
• Customizing the Software: An Overview, page 90
Previous Command
View > Previous
Restores the previous view. For example, if you zoom in and then click View >
Previous, the view changes to the view displayed before you zoomed. This command
is available only when a Drawing view is active, and the software does not remember
more than one view.
Related Topics
• Restore a Drawing View, page 27
• Working With the Design Window, page 20
Notes
• To stop repainting items in the window, press Esc. This action is
convenient for large drawings.
• To refresh the window, press F5.
Related Topics
• Working With the Design Window, page 20
Enlarges the display of an area in the active window by allowing you to draw a fence
around that arbitrary area of the drawing. This command is available only when a
Drawing view is active.
Related Topics
• Working With the Design Window, page 20
Zoom In on an Area
1. On the main toolbar, click Zoom Area .
2. On the Drawing view, use the pointer to fence the area on which you want to
zoom. The selection fills the view.
Notes
• To go back to the previous view, click View > Previous.
• To stop repainting items in the window, press Esc. This action is
convenient for large drawings.
• To refresh the window, press F5.
• To cancel the command, right-click or press Esc.
Related Topics
• Working With the Design Window, page 20
Zoom In Command
View > Zoom In
Enlarges the display of items around a specified point in the active window. This
command is available only when a Drawing view is active.
Related Topics
• Working With the Design Window, page 20
Reduces the display of items around a specified point in the active window. This
command is available only when a Drawing view is active.
Related Topics
• Working With the Design Window, page 20
• Zoom Out from an Area, page 29
Fit Command
View > Fit
Fits all items in the active view if no items are currently selected. However, if any
items are selected in the drawing, the command fits only the selected items in the
active view. If only one item is selected in the drawing, the command zooms to the
selected item. This command is available only when a Drawing view is active.
Related Topics
• Fit All Items in the Active Drawing View, page 29
• Working With the Design Window, page 20
Pan Command
View > Pan
Allows you to move the display in any direction from a specific point in a drawing to
see other areas of the drawing by dragging the pointer across the view. This command
is available only when a Drawing view is active.
Related Topics
• Pan a Drawing View, page 30
• Working With the Design Window, page 20
• You can also click and drag the hand pointer to pan the view.
• To go back to the previous view, click View > Previous.
• To stop repainting items in the window, press Esc. This action is
convenient for large drawings.
• To refresh the window, press F5.
• To cancel the command, press Esc or right-click in the Drawing view.
Display Command
View > Display
Allows you to specify the windows you want to see in your design session:
• Catalog Explorer
• Properties Window
• Engineering Data Editor
Related Topics
• Display the Engineering Data Editor, page 44
• Turn the Display of Catalog Explorer On or Off, page 66
• Turn the Display of the Properties Window On or Off, page 85
Toolbars Command
View > Toolbars
Opens the Toolbars dialog box, which allows you to create new toolbars and display
or hide selected toolbars. You can change toolbar color schemes and button sizes, too.
Related Topics
• Add a Button to a Toolbar, page 32
• Customizing the Software: An Overview, page 90
• Remove a Button From a Toolbar, page 33
• Working With the Design Window, page 20
Toolbars - Lists the available toolbars. You can select the box next to the toolbar that
you want to display, hide, or change.
Toolbar Name - Displays the name of the toolbar that you have selected.
Customize - Adds buttons to or removes buttons from built-in toolbars with the
Customize dialog box.
Reset - Returns the toolbar to the state that it was in at the beginning of your current
design session.
Color Buttons - Adds color to the toolbar buttons. Clearing this option causes toolbar
buttons to appear in black and white.
Large Buttons - Enlarges toolbar buttons so that they are easier to see.
Related Topics
• Add a Button to a Toolbar, page 32
• Remove a Button From a Toolbar, page 33
• Remove a Command From a Menu, page 95
Toolbar Name - Type the name of the new toolbar in the box. You cannot choose a
name for your new toolbar that is already used for another toolbar.
Related Topics
• Add a Button to a Toolbar, page 32
• Remove a Button From a Toolbar, page 33
• Remove a Command From a Menu, page 95
Related Topics
• Customizing the Software: An Overview, page 90
Related Topics
• Customizing the Software: An Overview, page 90
Related Topics
• Customizing the Software: An Overview, page 90
Properties Command
View > Properties
Displays the View Properties dialog box which lets you define and control settings
for the active view.
Related Topics
• Restore a Drawing View, page 27
• Show Inconsistencies, page 312
• Working With the Design Window, page 20
Note
• You can access the View Properties dialog box by right-clicking in space
in your drawing and selecting Properties from the shortcut menu.
Related Topics
• Properties Command, page 33
Related Topics
• Properties Command, page 33
• View Properties Dialog Box, page 33
Do not show labels for filtered items - Prevents the display of labels in filtered
views of the design.
Show - Lists options for objects you want to appear in your Drawing view.
Labels - Toggles the display of all labels on or off, in any view. If the display of
labels is turned off here, then the Do not show labels options is not available since all
labels are no longer displayed regardless of the view tab that you are using.
Notes - Turns the display of notes on or off. Notes can contain links to a file, for
example, a Microsoft Word file. Also, Auxiliary Graphics are turned on and off with
Notes.
Claims - Turns on the display of the options selected on the Claims tab.
Select - Includes other options for the selection of items in your drawing.
Related Topics
• Change the Properties of a Drawing View, page 37
• Properties Command, page 33
• View Properties Dialog Box, page 33
View - Turns the grid display and grid snapping on or off. You do not have to display
the grid in order to snap items to it.
Snap grid - Turns the snap-to-grid feature on or off. When you select this option,
items always align with the grid lines or nearest intersection of the grid lines. Grid
lines are not printed.
Style - Specifies either Static or Dynamic grid style. A static grid displays solid grid
lines that do not move as you zoom in or out. When you zoom in or out, the grid lines
for a dynamic grid change with the level of magnification. A dynamic grid displays
index lines that intersect with the darker, solid grid lines. The choice of grid style
affects the option that is available in the Spacing or Density box and the availability
of the Index options, too.
Spacing - Allows you to specify the space between the grid lines when you choose
the Static grid style from the Style list.
Density - Allows you to specify fine, medium, or coarse levels when you choose the
Dynamic grid style from the Style list. For a dynamic grid display the number of
index lines varies depending on the zoom level, and so you cannot change the Index
list when using the Dynamic grid style.
Index - Specifies the grid index, which is the number of minor grid lines. This option
is available only with the Static grid style.
Related Topics
• Properties Command, page 33
• Show Grid Command, page 138
Show - Lists options for objects you want to appear in your Drawing view.
Errors above severity - Turns the display of errors on or off. You can specify the
severity level. For example, if you specify a severity level of five, all errors with
severity of five or above appear. Errors are marked with a .
Warnings above severity - Turns the display of warnings on or off. Again, you can
specify the severity level and control the warnings that you see. Warnings are marked
with a .
Related Topics
• Properties Command, page 33
• Show Inconsistencies, page 312
Status - Displays the possible claim states and combination of claim states for
drawing items.
Invalid claims - Specifies the display of invalidly claimed items in the Drawing
view. Invalidly claimed items are items which differ from the Plant items and which
you cannot modify and check into the Plant without first establishing a valid claim.
Invalid claiming can happen only for Plants that support shared claiming of database
items. If you specify a special display for invalidly claimed items in the Drawing
view, then these display options override all other options designated in the Claim
area of this dialog box.
Claim - Displays the possible claim states for all items except invalidly claimed
items.
Not claimed - Specifies the special display of drawing items that are not claimed at
all.
Claimed only by others - Specifies the special display of drawing items that are
claimed solely by other projects or the Plant.
Claimed only by this project - Specifies the special display of drawing items to
which this project has the sole claim.
Shared claims - Specifies the special display of drawing items when the active
project shares a claim on with another project or the Plant. If your Plant is configured
so that it honors only exclusive claiming, then these display options will have no
effect in the Drawing view.
Colors - Allows you to select a color for items with the corresponding claim state.
Widths - Allows you to select a line width for items with the corresponding claim
state.
Related Topics
• Claim a Drawing Item, page 288
• Display the Claim Status of a Drawing Item, page 299
• Release a Claim, page 297
Important
• If the active view is the Engineering Data Editor, then clicking View >
Properties opens the Table Properties dialog box.
Related Topics
• Claiming Items: An Overview, page 285
• Customizing the Software: An Overview, page 90
New Command
Window > New
Allows you to open a new Drawing or Engineering Data Editor window within the
Design window.
Related Topics
• New > Engineering Data Editor Command (Window Menu), page 39
• New Drawing Window Command, page 38
Creates a new Drawing view within the active drawing. This command copies the
contents of the active Drawing view into a new window and displays the contents as
graphical items. The new view has the same filters as the previous Drawing view.
You can change the view features for the new Drawing window using the commands
on the View menu.
Notes
• If only the Engineering Data Editor view of a drawing is open, the
graphical Drawing view is opened on top of the Engineering Data
Editor when you select Window > New > Drawing.
• Creating a new Drawing or Engineering Data Editor view of a drawing
does not create a new copy or version of the drawing. The same drawing
data simply displays in the different views.
Related Topics
• Open a New Drawing View, page 39
• Working With the Design Window, page 20
Opens the Engineering Data Editor in the Design window and allows you to view
and edit model data for a drawing in a tabular format.
Related Topics
• New Drawing Window Command, page 38
Cascade Command
Window > Cascade
Related Topics
• Switch to Another Open Drawing or View, page 110
• Working With the Design Window, page 20
Arranges windows to fit horizontally in the Design window. All the windows are
placed an even distance from each other on the screen.
Related Topics
• Switch to Another Open Drawing or View, page 110
• Working With the Design Window, page 20
Arranges windows to fit vertically in the Design window. All the windows are placed
an even distance from each other on the screen.
Related Topics
• Switch to Another Open Drawing or View, page 110
• Working With the Design Window, page 20
Related Topics
• Switch to Another Open Drawing or View, page 110
• Working With the Design Window, page 20
• Stockpile
• Edit
• View
Click the down-arrow next to the menu button to expose the available commands.
The list on the toolbar contains filters that query the database and display the
corresponding items in the EDE. If you want to list all items select Plant Item from
the list.
You can also filter the display by using the buttons that correspond to different
stockpiles and drawings:
• Active Drawing
• Active Drawing Stockpile
• Stockpile
• Other Drawings
By default, initially only the Active Drawing and Active Drawing Stockpile buttons
are selected. You can re-query and thereby refresh the EDE display by clicking the
Refresh button . Finally a summary box displays a comparison between the
number of items in the view and the total number of items, of the type chosen in the
list, that exist in the database.
The contents of cells can be copied to other cells, if the cell contents are compatible.
Notes
• The maximum number of items that can be displayed in the EDE is
65,537. If your database query results in more than this number, the
Query Results dialog box opens. You can then choose to refine your
query in order to generate fewer items or to enter report-only mode and
run a report on your query results.
• The EDE is where you view items in the Stockpile, the Active Drawing,
the Active Drawing Stockpile, or Other Drawings. For more
information, click Related Topics.
Related Topics
• Define a New Engineering Data Editor View, page 54
• Define a New Filter for an Engineering Data Editor View, page 54
• Define a New Layout for the Engineering Data Editor, page 55
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 56
• Moving and Placing Stockpile Items: An Overview, page 249
Related Topics
• Display the Engineering Data Editor, page 44
• Navigating in the Engineer Data Editor: An Overview, page 41
Add - Places a new entry at the end of the existing definition list and enables the
options in the Edit group so that you can edit the new entry.
Additional Filter Criteria - Displays all new criteria to add to the current filter. To
add to or modify the definition list, you must select a line in the list and then define or
edit the property in the Edit group.
Continue with this query so that I can generate a plant or personal report -
Causes the Engineering Data Editor to enable only these commands: Edit view,
Save view, Delete view, My Reports, and Plant Reports. This option is useful when
creating a report for large data sets such as an entire plant database.
Delete - Removes the selected criterion from the definition list. This button is
available only when you select a criterion in the definition list.
Edit - Allows you to define or edit a single line of filter definition criteria.
Match all - Specifies that items matching ALL of the filtering criteria pass through
the filter.
Match any - Specifies that items matching any one or more of the filtering criteria
pass through the filter. Match any is the default matching method.
Operator - Specifies the relationship between the property and its value.
Relationships include, for example, greater than, >; equal to, =; not equal to, <>; and
so forth.
Options - Allows you to choose between refining your query or entering report-only
mode.
Property - Displays a list of all properties for a certain item type. Examples of
properties include Equipment Type, Instrument Loop Item Tag, and Estimated
Length. You define or modify filtering criteria by selecting a property, an operator,
and a value.
Refine Query Definition - Allows you to use the Additional Filter Criteria list in
this dialog box to refine your query in order to display an allowed number of items in
the view.
Rows Returned - Displays the number of items that your query returned.
Value - Lists appropriate values for the property specified in the Property column. If
a list of attributes is not already associated with the Value box, you must type a value,
which can be free text, or choose null. You can type a percent sign, %, as a wildcard
character to find multiple characters, or type a question mark, ?, as a wildcard
character for a single character. Do not use an asterisk, *, in the Value box.
Related Topics
• Customizing the Display of the Engineering Data Editor: An Overview,
page 60
• Define a New Engineering Data Editor View, page 54
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 56
• Navigating in the Engineer Data Editor: An Overview, page 41
• Update the Engineering Data Editor, page 59
Tip
• To close the Engineering Data Editor, click View > Display >
Engineering Data Editor again.
Related Topics
• Navigating in the Engineer Data Editor: An Overview, page 41
• Working With the Design Window, page 20
Contains commands for moving and deleting items. Click the down-arrow next to the
Actions menu to display the available commands.
Related Topics
• Move a Stockpile Item to the Stockpile of Another Drawing, page 250
• Place Multiple Representations, page 142
• Remove an Item from a Drawing, page 237
• Remove an Item from the Model, page 238
Related Topics
• Navigating in the Engineer Data Editor: An Overview, page 41
• Place Multiple Representations, page 142
• Placing Equipment: An Overview, page 140
Removes the stockpile item from the plant model completely. That is the item and its
properties are deleted from the database and can no longer be placed in a drawing,
regardless of symbol settings in Options Manager or Catalog Manager.
Related Topics
• Cutting or Deleting Items: An Overview, page 232
• Remove an Item from the Model, page 238
Allows you to move a stockpile item from one stockpile to another. For instance, you
can move an item from the Stockpile into the stockpile for your active drawing if you
know the item belongs in that drawing but are not yet ready to place the item.
Similarly you can move an item in the Drawing Stockpile to the Stockpile so that it
can be used in other drawings. You can even move items from one drawing stockpile
to another. The Move to Different Stockpile dialog box opens.
Related Topics
• Move a Stockpile Item to the Stockpile of Another Drawing, page 250
• Navigating in the Engineer Data Editor: An Overview, page 41
Allows you to copy and paste values from one cell to another cell in the Engineering
Data Editor and to select all the items in the view in order to create a select set. You
can also invoke a claim at any time to expand the scope of your project, and any new
item created in a project is automatically claimed by that project. You can also release
a claim at any time and you can determine the validity of a claim.
Click the down-arrow next to the Edit menu button to display the available
commands.
Related Topics
• Claiming Items: An Overview, page 285
• Copy Command, page 46
• Paste Command, page 46
• Review and Edit Item Properties, page 86
• Select All Command, page 47
• Select an Item, page 135
Copy Command
Engineering Data Editor > Edit > Copy
Places the value in the currently selected cell onto the Clipboard so that you can paste
it somewhere else. This command does not remove the value from the selected table
cell. Values placed on the Clipboard remain there until newer values are copied over
them.
Related Topics
• Modifying Item Properties: An Overview, page 244
• Review and Edit Item Properties, page 86
Paste Command
Engineering Data Editor > Edit > Paste
Places the value from the Clipboard into the selected cell. If the cell is read-only, then
the Paste command is not available. You must have previously placed a value on the
Clipboard in order to paste it.
Related Topics
• Modifying Item Properties: An Overview, page 244
• Review and Edit Item Properties, page 86
Chooses all the items in the active Engineering Data Editor. You can create a select
set using this command.
Related Topics
• Modifying Item Properties: An Overview, page 244
• Review and Edit Item Properties, page 86
• Select an Item, page 135
• Selecting Drawing Items: An Overview, page 132
Claim Command
Engineering Data Editor > Edit > Claim
Gives control of the selected items to the current active project. The Claim dialog
box opens, allowing you to confirm the "claim-ability" of the items and enter claim
comments. Claim comments can be viewed later by anyone in the Plant when the
claim status is displayed.
Related Topics
• Claim a Drawing Item, page 288
• Claiming Items: An Overview, page 285
Displays the Release Claim dialog box and allows you to relinquish control (by your
project) of the selected items. This dialog box also displays when you attempt to
unclaim an item that has been modified in the project. Claims must be released before
projects can be completed or for other projects to be able to check in drawings with
changes.
Notes
• You can use the Compare and Refresh command to revert the item back
to the As-built state prior to unclaiming.
• If you are working in The Engineering Framework (TEF) environment and
there are any differences between an item in the Project and an item in the
AsBuilt, the claim cannot be released. If you are not working in a TEF
environment, the claim can be released. Also, items that display no
warnings or errors are released.
Related Topics
• Claiming Items: An Overview, page 285
• Release a Claim, page 297
Opens the Claim Status dialog box, which displays the details of the claimed state of
the selected items and enables you to claim items, release the claims to items, and so
forth. You must select the items in the Drawing view or the Engineering Data
Editor before using this command.
Related Topics
• Claiming Items: An Overview, page 285
• Display the Claim Status of a Drawing Item, page 299
Displays the commands that help you customize and manipulate the layout and
content of the Engineering Data Editor. Click the down-arrow next to the menu
button to display the commands.
Related Topics
• Customize the Display of the Engineering Data Editor, page 63
• Delete a Saved Engineering Data Editor View, page 58
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 56
• Save an Engineering Data Editor View, page 57
• Update the Engineering Data Editor, page 59
• Use AutoFilter in the Engineering Data Editor, page 61
Opens the Table Properties dialog box, where you can access options to specify the
tabular display. If you click Advanced on this dialog box, the Advanced Table
Properties dialog box opens, and you can further modify the layout and create
custom filters for your Engineering Data Editor.
Note
• The Engineering Data Editor is where stockpile items are displayed.
Related Topics
• Define a New Engineering Data Editor View, page 54
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 56
• Navigating in the Engineer Data Editor: An Overview, page 41
Item type - Lists all the item types that you can select (for example, equipment or
motors).
Filter - Lists all of the filters that have been saved for the selected item type.
Layout - Lists all of the layouts that have been saved for the selected item type. For a
list of default layouts, see Default Table Layouts, page 52.
Advanced - Displays the Advanced Table Properties dialog box, where you can
define and save filters or layouts for the Tabular or Engineering Data Editor. You
can specify the default filter and layout for a certain item type also. Specify brief and
bulk properties in this dialog box, too. Brief and bulk properties appear in the
Properties window when you select the Show Brief Properties, Copy Bulk
Properties, or Paste Bulk Properties commands from the Properties window
toolbar.
Related Topics
• Define a New Filter for an Engineering Data Editor View, page 54
• Define a New Layout for the Engineering Data Editor, page 55
• Edit View Command, page 48
Related Topics
• Define a New Filter for an Engineering Data Editor View, page 54
• Define a New Layout for the Engineering Data Editor, page 55
• Edit View Command, page 48
Default - Indicates if the named filter is the default filter for the item type selected on
the Table Properties dialog box. You can change a filter to the default by selecting
this box.
Browse - Opens the Select Filter dialog box, which allows you to select a base filter.
Match all - Specifies that items matching ALL of the filtering criteria pass through
the filter.
Match any - Specifies that items matching any one or more of the filtering criteria
pass through the filter. Match any is the default matching method.
Add - Places a new entry at the end of the existing definition list and enables the
options in the Edit group so that you can edit the new entry.
Delete - Removes the selected criterion from the definition list. This button is
available only when you select a criterion in the definition list.
Edit - Displays options that allow you to define or edit a single line of filter definition
criteria.
Property - Displays a list of all properties for a certain item type. Examples of
properties include revision number and name. You define or modify filtering criteria
by selecting a property, an operator, and a value.
Operator - Specifies the relationship between the property and its value.
Relationships include, for example, greater than, >; equal to, =; not equal to, <>; and
so forth.
Value - Lists appropriate values for the property specified in the Property column. If
a list of attributes is not already associated with the Value box, you must type a value,
which can be free text, or choose null. You can type a percent sign, %, as a wildcard
character to find multiple characters, or type a question mark, ?, as a wildcard
character for a single character. Do not use an asterisk, *, in the Value box.
Related Topics
• Define a New Engineering Data Editor View, page 54
• Define a New Filter for an Engineering Data Editor View, page 54
Name - Displays the name of a saved layout. You can enter a new layout name and
then click Save to save the layout for re-use. Or, you can select any of the layouts in
the list.
Default - Indicates whether the named layout is the default layout for the item type
on the Table Properties dialog box. You can designate a layout as the default by
checking this box and then clicking Save.
Usage - Lists the property display types associated with the Properties window.
Options include a blank value, Brief, Bulk, and Brief/Bulk. The selected item type
and display properties define what appears in the Properties window when you select
the Show Brief Properties, Copy Bulk Properties, or Paste Bulk Properties
commands from the Properties window toolbar. In order for your choice in the
Usage box to take effect, you must exit and reenter the design software.
Save - Saves the data in this dialog box as a named layout. Layout names must be
unique.
Note
• Saving a layout is not the same as saving a view in the Engineering Data
Editor. For more information about saving views, see
Save an Engineering Data Editor View
Definition - Displays all defined criteria associated with the selected layout. This
group contains two list views. In order to add to or modify either list, you must select
a line in the list and then define or edit the property in the Edit group. The buttons to
the right act upon the active list view.
Display Property - Lists the columns that appear in the Engineering Data Editor.
To edit an entry, select it and modify the property in the Edit group.
Caption (Definition) - Displays the caption for each column in the Engineering
Data Editor.
Sort Property - Lists the properties that apply to the item type specified in the Table
Properties dialog box.
Order - Lists the sort orders Ascending and Descending. You can select one.
Type - Lists the sort types Numeric and Alphanumeric. You select one.
Add - Adds a new entry at the end of the existing entries and enables the options in
the Edit group so that you can edit the new entry.
Insert - Places a new entry above the currently selected entry and enables the options
in the Edit group so that you can edit the new entry.
Up - Moves the currently selected entry up one line. Moving a row up either moves a
display column to the left or moves a sort order up, depending on the row you have
selected.
Down - Moves the currently selected entry down one line. Moving a row down either
moves a display column to the right or moves a sort order down, depending on the
row you have selected.
Edit - Allows you to edit a single entry selected in either the Display Property or
Sort Property list views. If you select an entry in the Display Property view, the
Edit group allows you to edit the property and the caption. If you select an entry in
the Sort Property view, the Edit group allows you to edit the property, order and
type.
Property - Displays a list of all the properties that apply to the item type defined in
the Table Properties dialog box. If you select an entry in the Display Property
view, you can specify the property and its caption. If you select an entry in the Sort
Property view, you can specify the property, its order, and its type.
Caption (Edit) - Displays the caption for each column in the Engineering Data
Editor.
Related Topics
• Advanced Table Properties Dialog Box, page 49
• Define a New Layout for the Engineering Data Editor, page 55
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 56
• New > Engineering Data Editor Command (Window Menu), page 39
SmartPlant Electrical
• Default Battery Bank List
• Default Bus List
• Default Cable List
• Default Circuit List
Note
• If you are using a workshare environment and you are at a satellite site,
Project Filters should not be created at a satellite site because when you
synchronize reference data, you lose that information. However, you can
always create My Filters in the Filter Manager environment.
Related Topics
• Customizing the Software: An Overview, page 90
• Navigating in the Engineer Data Editor: An Overview, page 41
Important
• The Add, Insert, Delete, Move Up, and Move Down buttons apply to the
active list view, which can be either Display Property or Sort Property.
• If you are using a workshare environment and you are at a satellite site,
you should not store custom layouts for the Engineering Data Editor
because when you synchronize reference data, you lose that information.
Related Topics
• Navigating in the Engineer Data Editor: An Overview, page 41
Related Topics
• Navigating in the Engineer Data Editor: An Overview, page 41
Opens the Save View dialog box, which allows you to name and save the current
Engineering Data Editor. These custom views appear at the bottom of the filter list
on the Engineering Data Editor toolbar.
Related Topics
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 56
• Navigating in the Engineer Data Editor: An Overview, page 41
• Save an Engineering Data Editor View, page 57
Name - Provides space for you to type in the name of your custom view.
Related Topics
• Save an Engineering Data Editor View, page 57
• Save View Command, page 57
Allows you to delete a view if you have stored a custom Engineering Data Editor
view. These custom views appear at the bottom of the filter list on the Engineer Data
Editor toolbar under Saved Views. The Delete View dialog box opens, and you can
choose the view that you want to delete from a list of saved views.
Related Topics
• Delete a Saved Engineering Data Editor View, page 58
• Navigating in the Engineer Data Editor: An Overview, page 41
Name - Lists the saved views. Choose one and click OK to delete that view.
Related Topics
• Delete a Saved Engineering Data Editor View, page 58
• Delete View Command, page 58
Note
• The Engineering Data Editor is where stockpile items can be displayed.
Related Topics
• Customizing the Display of the Engineering Data Editor: An Overview,
page 60
• Navigating in the Engineer Data Editor: An Overview, page 41
Refresh Command
Engineering Data Editor > View > Refresh
Updates the display in the Engineering Data Editor. This command queries the
database and builds a new view with new results.
Related Topics
• Navigating in the Engineer Data Editor: An Overview, page 41
• Update the Engineering Data Editor, page 59
Note
• The database can change all the time. The Engineering Data Editor is
not updated automatically: you must update it by using the Refresh
command manually.
Related Topics
• Navigating in the Engineer Data Editor: An Overview, page 41
By specifying the display settings, you can define the font that Stockpile items appear
in, for instance. By using the AutoFilter feature, you can quickly limit the number of
items that are displayed in the Engineering Data Editor. You can clarify the cells
that are read-only and the cells that allow you to enter new property information or
modify existing information. You can create your own filters to narrowly define the
contents of the view, and you can create unique layouts with exactly the properties
that you want to see, in exactly the order that you want to see them. You can control
the scrolling of the Engineering Data Editor with the Freeze Panes command, too.
Once you have defined and edited a view, you can save it and also delete it later, if
necessary.
Related Topics
• Customize the Display of the Engineering Data Editor, page 63
• Define a New Engineering Data Editor View, page 54
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 56
• Use AutoFilter in the Engineering Data Editor, page 61
AutoFilter Command
Engineering Data Editor > View > AutoFilter
Allows you to filter the items displayed in the Engineering Data Editor. When you
click AutoFilter, arrows appear at the top of each column. Click the arrow at the top
of the column that contains the data that you want to filter on and choose the value
from the list that appears. For instance, if the Engineering Data Editor displays
Equipment: Vessels, but you want to see only vertical drums, use the AutoFilter
command (click the arrow at the top of the Eq Subclass column and choose vertical
drums).
To create more elaborate filters and displays, you need to use the Edit View
command and enter options on the Table Properties dialog box and the Advanced
Table Properties dialog box.
Related Topics
• Navigating in the Engineer Data Editor: An Overview, page 41
Comparison operator - Lists the available comparisons: for example, equals, does
not equal, is greater than, begins with, and so forth.
And - Allows you to add another comparison using the Boolean operator sense of
and: this means all criteria must be met.
Or - Allows you to add another comparison in the Boolean sense of or: this means
any one of the criteria must be met. The Boolean or is less restrictive than the and.
Related Topics
• AutoFilter Command, page 60
• Customize the Display of the Engineering Data Editor, page 63
Related Topics
• Customize the Display of the Engineering Data Editor, page 63
• Customizing the Display of the Engineering Data Editor: An Overview,
page 60
• Navigating in the Engineer Data Editor: An Overview, page 41
Allows you to scroll through the Engineering Data Editor while keeping the display
of specified rows and columns constant. For instance, the first column can contain the
item tag, but you want to always see the item tag as you scroll to the right end of the
rows to view the supplier. You can accomplish this layout by using the Freeze Panes
command.
Related Topics
• Customize the Display of the Engineering Data Editor, page 63
• Customizing the Display of the Engineering Data Editor: An Overview,
page 60
• Navigating in the Engineer Data Editor: An Overview, page 41
Opens the Display Settings dialog box, which allows you to specify various display
options for the Engineering Data Editor. For example, you can choose the size of
icon that is displayed in the view, and you can specify the font that items in the
Stockpile are listed in. You can choose that read-only cells are filled with a special
background color.
Related Topics
• Customize the Display of the Engineering Data Editor, page 63
• Customizing the Display of the Engineering Data Editor: An Overview,
page 60
• Navigating in the Engineer Data Editor: An Overview, page 41
Icon size in table - Allows you to specify large or small icons for the display in the
far left column of the view.
Row - Contains settings that apply to rows in the view; that is, these settings apply to
individual items.
Item - Lists the different locations of items: Active Drawing, Active Drawing
Stockpile, Stockpile, or Other Drawings. When you select one of these options, the
remaining options in the Row area then pertain to that location. You can subsequently
select another option from the Item list and define fonts and colors for those items
and so on until you have specified the appearance for all locations in the Item list.
Font - Sets the font for the items selected from the Item list.
Color - Allows you to specify either the font or background color, depending on
whether you are specifying this property in the Row area or the Column area,
respectively.
Italic - Causes the font to be italicized for items selected from the Item list.
Bold - Causes the font to be bold for items selected from the Item list.
Column - Contains settings that apply to columns in the view; that is, these settings
apply to item properties.
Read-only properties - Allows you to choose a background color for read-only table
cells.
Read/write properties - Allows you to choose a background color for the table cells
that you can edit in the Engineering Data Editor.
Related Topics
• Customize the Display of the Engineering Data Editor, page 63
• Display Settings Command, page 62
Notes
• You can also customize the Engineering Data Editor by using the
AutoFilter feature. For more information, see
Use AutoFilter in the Engineering Data Editor, page 61
• You can use the Freeze Panes feature, too. To do so, follow these steps:
1. To freeze the top horizontal pane, select the row below where you want the
split to appear. To freeze the left vertical pane, select the column to the right
of where you want the split to appear. To freeze both the upper and left panes,
click the cell below and to the right of where you want the split to appear.
2. Click View > Freeze Panes on the Engineering Data Editor toolbar.
• And by clicking View > Edit View on the Engineering Data Editor
toolbar, you can totally redefine the content and layout of your
Engineering Data Editor. For more information, see
Modify the Table Properties of an Existing Engineering Data Editor View, page
56
Related Topics
• Customizing the Display of the Engineering Data Editor: An Overview,
page 60
• Navigating in the Engineer Data Editor: An Overview, page 41
Catalog Explorer consists of two main views: the Tree view and the List view. In
the Tree view, you can view the nodes of the catalog file system and open or close
the nodes to see the contents. In the List view, you see the contents of the opened
node. You also use the List view to select catalog items before placing them in a
drawing or in a stockpile. You can create a navigation bar in the region between the
tree and list views for shortcuts to places throughout the catalog.
Toolbar buttons carry out commands and allow you to customize the tree and list
views to suit your work session. These toolbar buttons are located at the top of the
tree view.
Related Topics
• Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80
• Create a Custom Catalog, page 72
• Place an Item from Catalog Explorer, page 66
• Rename a Catalog Node, page 75
• Turn the Display of Catalog Explorer On or Off, page 66
Related Topics
• Turn the Display of Catalog Explorer On or Off, page 66
• Using Catalog Explorer: An Overview, page 65
Related Topics
• Customizing the Software: An Overview, page 90
• Using Catalog Explorer: An Overview, page 65
Tips
• Or use the menu command Close when you right-click in the tree view of
Catalog Explorer.
• Or toggle the display of Catalog Explorer back off by clicking the icon
on the main toolbar:
Related Topics
• Using Catalog Explorer: An Overview, page 65
The Catalog menu in Catalog Explorer provides access to commands that allow you
to manipulate list view items and tree view nodes in the Catalog Explorer. Also, you
can search for catalog items.
Note
• The list of commands that are available on the Catalog menu depends on
whether the Tree view or the List view is active.
Related Topics
• Close the Catalog Explorer Window, page 68
• Rename a Catalog Item, page 75
• Rename a Catalog Node, page 75
• Search for an Item in Catalog Explorer, page 70
Find Command
Catalog Explorer > Catalog > Find
Displays the Find dialog box. The Find dialog box allows you to search the catalog
for a specific item or group of items.
Related Topics
• Assign a Command to a Catalog Explorer Toolbar Button, page 82
• Customizing Catalog Explorer: An Overview, page 82
• Search for an Item in Catalog Explorer, page 70
• Using Catalog Explorer: An Overview, page 65
Named - Specifies the name of the item for which you want to search. You can type
an asterisk, "*", as a wildcard character to find multiple characters, or type a question
mark, "?", as a wildcard character for a single character.
Class - Specifies the class of item for which you want to search. You can type a
percent sign, "%", as a wildcard character to find multiple characters, or type a
question mark, "?", as a wildcard character for a single character.
Look In - Specifies the drive or folder that contains the symbol library that you want
to search.
Browse - Opens the Explore Elsewhere dialog box, allowing you to search any
network drives or the local directory structure for a symbol library to display in the
Look In box.
Results List - Lists the items that met the defined search criteria. You can drag
catalog items from this area into a My Catalog set of items in the Catalog Explorer
tree view.
Find Now - Starts a search of the symbol library defined in the Look In: box.
New Search - Clears all search criteria in preparation for a new search.
Related Topics
• Explore Elsewhere Dialog Box, page 69
• Search for an Item in Catalog Explorer, page 70
Look in - Enter the location from which you want to view symbol information, or
select a drive from this list and use the tree that is displayed below to find the location
you want.
Related Topics
• Find Command, page 68
• Search for an Item in Catalog Explorer, page 70
New Command
Catalog Explorer > Catalog > New
Adds a node under the My Catalog > Toolbars node in the Catalog Explorer. This
command is available when you click the Toolbars node.
Note
Related Topics
• Activate Symbol Toolbars, page 76
• Define a User-Level Symbol Toolbar, page 71
Open Command
Catalog Explorer > Catalog > Open
Related Topics
• Close the Catalog Explorer Window, page 68
Clone Command
Catalog Explorer > Catalog > Clone
Related Topics
• Clone a Catalog Item, page 73
Delete Command
Catalog Explorer > Catalog > Delete
Removes the selected item from the Catalog Explorer list view or catalog node from
the tree view.
Note
• You must first delete all sub-nodes and catalog items that reside under a
node before you can delete the node itself.
Important
• Depending on your editing permissions, you are able to delete items from
certain catalogs. See your system administrator for information regarding
your current privileges, which are specified in SmartPlant Engineering
Manager.
Related Topics
• Delete a Catalog Item, page 74
• Delete a Catalog Node, page 74
Rename Command
Catalog Explorer > Catalog > Rename
Related Topics
• Using Catalog Explorer: An Overview, page 65
Related Topics
• Activate Symbol Toolbars, page 76
• Define a User-Level Symbol Toolbar, page 71
• Designing Symbol Toolbars, page 71
Related Topics
• Designing Symbol Toolbars, page 71
• Using Catalog Explorer: An Overview, page 65
Close Command
Catalog Explorer > Catalog > Close
Related Topics
• Close the Catalog Explorer Window, page 68
Sends the catalog item selected in the list view to the Stockpile. This command is
particularly useful for instrument loops and packages and other items that reside in a
stockpile but generally are not depicted graphically in a drawing.
Related Topics
• Add Instruments to a Loop, page 166
• Place a Package, page 200
Sends the catalog item selected in the list view to the Active Drawing Stockpile. This
command is particularly useful for instrument loops and packages and other items
that reside in a stockpile but generally are not depicted graphically in a drawing.
Related Topics
• Add Instruments to a Loop, page 166
• Place a Package, page 200
View Menu
Catalog Explorer > View
The Catalog Explorer View menu provides commands that allow you to control the
display format of catalog items within the Catalog Explorer list view.
Related Topics
• Customize the Catalog Explorer List View, page 78
Displays larger icons and names horizontally in the list view and does not list details.
Related Topics
• Customize the Catalog Explorer List View, page 78
Displays smaller icons with names horizontally in the list view and does not list file
locations.
Related Topics
• Customize the Catalog Explorer List View, page 78
List Command
Catalog Explorer > View > List
Displays smaller icons with names vertically using multiple columns in the list view
and does not list details.
Related Topics
• Customize the Catalog Explorer List View, page 78
Details Command
Catalog Explorer > View > Details
Displays smaller icons with names and source information vertically in a single
column in the list view.
Related Topics
• Customize the Catalog Explorer List View, page 78
• Using Catalog Explorer: An Overview, page 65
The Navigation menu in Catalog Explorer provides commands that allow you to
control the display and assignment of shortcut buttons within the Catalog Explorer.
Shortcut buttons provide shortcuts that bookmark a node in the active Tree view of
Catalog Explorer. These buttons reside on the navigation bar between the tree and
list view in the Catalog Explorer window.
For example, if your workflow requires you to route a lot of piping, you want to make
a shortcut button to the Process Lines node. Then when you open Catalog Explorer
and click this shortcut button, you open the node for the piping and all the piping
types appear in the list view. Consequently you save the time and effort of browsing
the catalog node structure in the tree view in order to find the node that you want to
open in the list view.
The software does not limit the number of shortcut buttons that you can create, but
you are limited by the size of the Catalog Explorer window. Also, shortcut buttons
are shortcuts to catalog nodes only. If you want to make a shortcut to a particular
symbol that you use a lot, you can use the symbol toolbar.
All of the commands for managing your shortcut buttons are found on the Catalog
Explorer Navigation menu.
Related Topics
• Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80
• Display Shortcut Buttons in Catalog Explorer, page 81
• Remove a Shortcut Button from the Catalog Explorer Navigation Bar,
page 81
Adds a shortcut button to Catalog Explorer for the active tree view node. For
example, if you frequently select nozzles, you can add a shortcut button to the nozzles
node of the Catalog Explorer tree view by selecting Nozzles in the tree view and
then choosing Add Button from the menu that appears when you click the down-
arrow of the Navigation menu. You must also select the Show Buttons option in the
menu in order for your shortcut button to appear between the tree view and list view
windows of Catalog Explorer.
Note
• Clicking the down-arrow of the Navigation menu button above accesses a
list of the associated commands. Clicking on the Navigation menu button
itself repeats the last command that you used from the menu.
Related Topics
• Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80
• Customizing the Software: An Overview, page 90
• Display Shortcut Buttons in Catalog Explorer, page 81
• Remove a Shortcut Button from the Catalog Explorer Navigation Bar,
page 81
• Using Catalog Explorer: An Overview, page 65
Removes the active shortcut button from the list of shortcut buttons in Catalog
Explorer.
Related Topics
• Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80
• Using Catalog Explorer: An Overview, page 65
Tip
• Or you can right-click any shortcut button and select Remove Button
from its shortcut menu.
Related Topics
• Navigation Menu (Catalog Explorer), page 79
• Using Catalog Explorer: An Overview, page 65
Causes shortcut buttons to appear on the navigation bar between the tree view and the
list view of Catalog Explorer.
Related Topics
• Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80
• Using Catalog Explorer: An Overview, page 65
Tip
• A check mark next to the menu item indicates that shortcut buttons appear
in Catalog Explorer. The buttons appear on the navigation bar between
the tree and list views.
Note
• You must first define a shortcut button in order to display it. For more
information, see Add a Shortcut Button to the Catalog Explorer
Navigation Bar, page 80.
Related Topics
• Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80
• Navigation Menu (Catalog Explorer), page 79
• Using Catalog Explorer: An Overview, page 65
Related Topics
• Assign a Command to a Catalog Explorer Toolbar Button, page 82
Related Topics
• Customizing Catalog Explorer: An Overview, page 82
• Using Catalog Explorer: An Overview, page 65
You can modify the values for properties in the Properties window. You can display
and edit relationships that involve components, component types, or assemblies.
At the top of the Properties window is the Selected Items list, which itemizes all of
the selected objects individually and as a select set. You can display item properties
by locating the appropriate item in the Selected Items list, as well as by selecting an
item in the Design window. If more than one item is selected in the Design window,
then the Selected Items list contains the choice Select Set as well as individual items
in the set.
You can use the Copy Bulk Properties and Paste Bulk Properties buttons to copy
properties from one item to another. This action can be particularly useful when
correcting inconsistencies, for instance, or when you must apply changes to more than
one item.
Notes
• The software includes a default set of bulk properties, but you can change
those properties specified as bulk in the Usage box on the Layout tab of
the Advanced Table Properties dialog box.
• When you pause your pointer over the buttons on the Properties window
toolbar, a ToolTip appears, giving the name of the button.
• An item and the properties that belong to it are associated when the item is
created in Catalog Manager.
• If you copy or paste values in the grid area, use Ctrl+C and Crtl+V. Do
not use the Edit > Copy, Edit > Paste, or Edit > Cut to modify property
values in this grid.
Related Topics
• Copy Bulk Properties, page 87
• Customize the Properties Window, page 85
• Display Null Values in the Properties Window, page 88
• Paste Bulk Properties, page 88
• Show Brief Properties, page 89
Opens the Properties window and displays characteristics for a selected item or a
select set. You can review and edit the properties. The applicable properties of an
item are defined when it is created in Catalog Manager.
Note
• You can display the Properties window by clicking View > Display >
Properties Window, too.
Related Topics
• Review and Edit Item Properties, page 86
• Selecting Drawing Items: An Overview, page 132
Show Brief Properties - Displays those properties that have been previously
specified as brief on the Advanced Table Properties dialog box.
Copy Bulk Properties - Copies the bulk properties of a selected item. The
properties are then available to paste onto other items. For more information, see
Copy Bulk Properties.
Paste Bulk Properties - Pastes copied bulk properties onto the newly selected
item or items. You must have previously selected an item or items and copied bulk
properties. For more information, see Paste Bulk Properties.
Display Null - Displays a null value in blank properties that currently contain no
value. This option helps avoid confusion between empty cells and cells containing a
zero.
Show Case Data - Displays a list of case conditions, for example, temperatures,
pressures, and so forth. Case data includes both process cases and control cases,
which are displayed for equipment, pipe runs or instruments, according to relevance.
To see the case data that appears for corresponding items, look in Data Dictionary
Manager.
Note
• The software includes a default set of bulk and brief properties, but you
can change those properties in the Usage box on the Layout tab of the
Advanced Table Properties dialog box.
Related Topics
• Copy Bulk Properties, page 87
• Customize the Properties Window, page 85
• Display Null Values in the Properties Window, page 88
• Paste Bulk Properties, page 88
• Show Brief Properties, page 89
• Whenever you have constructed a select set, you can choose single
items from that set by using the Selected Items list at the top of the
Properties window. A single item chosen in a select set this way is
highlighted in a different color in the Drawing view.
3. Display properties alphabetically or by categories by clicking the corresponding
display mode button on the Properties window toolbar. Click to display
properties alphabetically; click to display properties by categories.
4. Display only brief properties by clicking Show Brief Properties .
5. Display case data by clicking Show Case Data .
6. Display a null character in empty property cells by clicking Display Null .
Note
• When you point to a button on the Properties window toolbar and pause
over it, a ToolTip displays the name of the corresponding command.
Related Topics
• Properties Window Toolbar, page 84
• Working With the Properties Window: An Overview, page 83
Related Topics
• Modifying and Moving Placed Items: An Overview, page 206
• Modifying Item Properties: An Overview, page 244
Note
• The software includes a default set of bulk properties, but you can change
those properties specified as bulk in the Usage box on the Layout tab of
the Advanced Table Properties dialog box.
Related Topics
• Customizing the Software: An Overview, page 90
• Working With the Properties Window: An Overview, page 83
Note
• The software includes a default set of brief properties, but you can change
that set on the Layout tab of the Advanced Table Properties dialog box.
Related Topics
• Customize the Properties Window, page 85
• Properties Window Toolbar, page 84
• Working With the Properties Window: An Overview, page 83
If you want to create a new toolbar that does not exist in the software, you can start
by clicking View > Toolbars. You then click New and type the name of the new
toolbar on the New Toolbar dialog box. After you click OK, the Customize dialog
box automatically appears so that you can add buttons to the new toolbar.
You can create the macros in Visual Basic or other OLE-aware programming
applications. Some of the OLE-aware programming applications are Visual Basic for
Applications, Visual C++ Delphi, Visual Basic, and so forth.
The software includes a type library, which contains all the objects, properties, and
methods available with the product. Click Help > Programming with SmartPlant
P&ID to access the SmartPlant P&ID Programming User's Guide, which provides a
complete reference to the objects, methods, and properties. You can view the type
library with the type library browser of Visual Basic or the browser for an OLE-aware
programming application. Some macros also are delivered with the software; see a
list by using the Tools > Custom Commands command.
Related Topics
• Add a Button to a Toolbar, page 32
• Add a Command to a Menu, page 95
• Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80
• Create a New Menu, page 96
• Create a New Toolbar, page 32
• Run a Macro, page 101
Customize Command
Tools > Customize
Opens the Customize dialog box, which allows you to customize toolbars or menus
to fit your workflow. You can add commands to toolbars or menus, or you can create
new toolbars and menus.
Related Topics
• Create a New Menu, page 96
• Create a New Toolbar, page 32
• Customizing the Software: An Overview, page 90
Related Topics
• Add a Button to a Toolbar, page 32
• Create a New Menu, page 96
• Create a New Toolbar, page 32
• Remove a Button From a Toolbar, page 33
• Remove a Command From a Menu, page 95
Add Command - Places a command on a menu. This button is available only when
you select a command or macro in the Commands box or Macros box.
Add Menu - Places a menu at the level currently open on the menu tree. When you
add a menu with this option, you can add commands to the new menu later. If you
add a menu to an existing menu, you create a cascading menu. After you click this
button, you can type the name that you want in the tree view and then enter it by
clicking any other location on the dialog box.
Browse - Opens the Select Macro Directory dialog box. When you select a folder
and click OK, the Macros list displays the macros for the folder that you selected.
The Browse button appears only when you choose Macros in the Categories list.
Categories - Allows you to specify the category that you want to select a command
or macro from. Then you can add the command or macro to the menu or main menu
bar. When you select the title of a group of commands in this box, you can click the
title of a command in the Commands list. When you select Macros in the
Categories list, you can select a macro from the Macros list.
Commands - Allows you to specify the command that you want to add to the menu.
Description - Displays a description of the command that you selected before you
add it to a menu. Descriptions do not appear for macros.
Macros - Allows you to specify the macro that you want to add to the menu. If you
select a macro, you can click Browse to change the folder for macros.
Menu Tree - Lists the menus and their associated commands or macros. To see all
the commands on a menu, double-click a menu name or click the "+" next to the
menu name. When you click Add Command, Add Menu, or Remove, the changes
show up on the menu tree. Also, you edit menu and command names in this view.
Place Into Selected Menu - Overrides the default placement and places a command
or macro on the menu that is currently selected in the menu tree. If you do not set this
option, then the macros, commands, or menus are added at the level that is currently
open in the menu tree.
Reset All - Restores all menus and the main menu bar to the original settings.
Remove - Removes the command or menu that you selected in the menu tree.
Related Topics
• Add a Command to a Menu, page 95
• Create a New Menu, page 96
• Create a New Toolbar, page 32
• Remove a Command From a Menu, page 95
• Restore All Built-In Menus to their Original Settings, page 96
Categories - Lists the categories of the toolbars that you can customize. Choose one
and the corresponding buttons appear in the Buttons area.
Buttons - Lists the buttons available in the active category. You can drag a button
from this area onto a toolbar.
Related Topics
• Add a Button to a Toolbar, page 32
• Add a Command to a Menu, page 95
• Create a New Toolbar, page 32
• Remove a Button From a Toolbar, page 33
• Toolbars Dialog Box, page 31
Assign - Specifies the icon for your button and closes the dialog box.
Browse - Opens the Select Bitmap File dialog box, which allows you to look for an
icon on your local computer or on the network.
Related Topics
• Add a Button to a Toolbar, page 32
• Create a New Toolbar, page 32
• Remove a Button From a Toolbar, page 33
Related Topics
• Customizing the Software: An Overview, page 90
Tip
• The menu tree nodes expand to show the commands on the existing
menus.
5. Click the name of the command that you want the new command to appear after.
6. Select the Place Into Selected Menu option.
Tip
• If you want to add the new command to the main menu bar, clear the
Place Into Selected Menu option. The software places the new
command on the main menu bar after the existing menu that you select
in the menu tree.
7. Click Add Command.
Related Topics
• Customizing the Software: An Overview, page 90
• If you want to add a menu to an existing menu, select the Place Into
Selected Menu option before you click the Add Menu button, thereby
creating a cascading menu.
5. On the menu tree, type the name of the menu.
6. To enter the new menu, click anywhere away from the name.
Note
• After you create a new menu, you can add commands to it. For more
information, see Add a Command to a Menu, page 95.
Related Topics
• Customize Dialog Box, page 91
• Customizing the Software: An Overview, page 90
• Restore All Built-In Menus to their Original Settings, page 96
Opens the Custom Commands dialog box. You can choose a macro and run it. Some
macros are delivered with the software, generally in the C:\Program
Files\Smartplant\P&ID Workstation\Program directory. You can also record your
own macros and store them wherever you want to.
Related Topics
• Customizing the Software: An Overview, page 90
• Display Help for Programming With SmartPlant P&ID, page 15
• Run a Macro, page 101
Entire Database - Removes orphaned records from the plant database. Use this only
after running Database Report, examining the report, and manually cleaning up as
many items in the database as necessary.
Model Items - Finds and deletes any model item in the database that does not have a
corresponding entry in the T_Representation table. The utility works on an item type
basis and repairs the following model item types: Vessel, Mechanical, Exchanger,
Equipment: Other, Equipment Component, Instrument, Nozzle, Piping Component,
Pipe Run, Signal Run, and OPC. Once the orphan model items for an item type are
found, you can select any or all of the items and choose to delete them.
OPCs - Finds and repairs off-page connectors (OPCs) that have lost their associations
with the OPC with which they were originally paired. If one OPC has lost the identity
of its mated OPC, but the mated OPC still has the identity of the first OPC, then the
OPC is considered repairable. To repair the OPC, the utility updates the identity
information for the first OPC. However, if both the OPC and its mated OPC have lost
the identities of each other, then the OPCs are considered non-repairable, and you are
given the option to delete them.
Gaps - Repairs and updates gaps in the representation record with the proper item
type. On rare occasions you will need to perform this operation if you have gapping
problems in your drawings.
Related Topics
• Delete Orphan Model Items, page 100
OPC Types - Allows you to choose to list either the repairable or the non-repairable
OPC pairs that have lost links to their partner OPCs either one-way or both ways.
Fix - Fixes the reference to the mated OPC that you have selected in the OPC list.
Delete - Deletes the non-repairable OPC pair that you have chosen in the OPC list.
Item Type Names - Allows you to choose the type of orphaned model items that you
want to display in the Item list.
Delete - Removes the orphan items selected in the Item list from the plant database.
Delete All - Selects and deletes all the orphan model items of the type specified in the
Item Type Names list.
Related Topics
• Delete Orphan Model Items, page 100
Tip
• Follow the prompts on message boxes if you see any.
11. Click Close to return to the design software.
Notes
• The Delete Orphan Model Item Utility must be run from within the
drawing environment.
• Log messages generated when orphaned records are deleted from the plant
database are written to the DBCleanup.txt file in the directory assigned to
the Temp environment variable.
• Log messages are placed in SPDelOrpModItems.log file in the directory
assigned to the Temp environment variable. The log file contains
information about deleted items including the item type and sp_id.
Related Topics
• Re-creating Drawings: An Overview, page 126
Run a Macro
1. Click Tools > Custom Commands.
2. On the Custom Commands dialog box, select the macro that you want to run.
3. Click Run.
Note
• You can create macros with any programming tool that supports OLE
automation, such as Visual Basic.
Related Topics
• Customizing the Software: An Overview, page 90
Drawings are graphical representations of plant models using standard symbols and
conventions. A plant model consists of components. A component is any piece of
equipment, instrumentation, piping, or other item used to create a plant model.
Symbols represent components in Catalog Explorer and Engineering Data Editor.
You select symbols from Catalog Explorer and then select the appropriate
placement location in the drawing. In the Properties window, you enter appropriate
values into the database for each property of the component. You can use the
commands on toolbars and in menus to add information to your drawing, and you can
use edit commands to modify the information in your drawing.
Any changes that you make to the drawing data are automatically saved in the
database. You can save drawings in different formats, including .pid for SmartPlant,
.dwg and .dxf for AutoCAD®, .dgn for MicroStation®, and .cgm for CGM Metafile.
You cannot save a drawing as a template. The only way to use a template is to have a
plant administrator select a template at drawing creation in Drawing Manager.
The following table lists the characters that cannot be used in certain names or objects
throughout the SmartPlant Engineering Manager, SmartPlant P&ID, and SmartPlant
Electrical products.
Several standard templates are delivered with SmartPlant P&ID, and you can create
new templates in SmartPlant P&ID. If you want to create custom border files for your
drawing templates, use Intergraph SmartSketch. You can then embed your border file
in the new templates you create in SmartPlant P&ID. Once you embed a border file
into a drawing template and a drawing is created in Drawing Manager using that
template, any changes to the border file are not reflected in drawings created prior to
the change. If you link a border file, instead of embedding it, and then subsequently
change that border in SmartSketch, changes are reflected automatically in your
drawing.
The software keeps track of the drawings that you worked on last. These drawings
appear at the bottom of the File menu. To open one of these drawings, you can select
it from that list. The Options command on the Tools menu allows you to set the
number of entries displayed in that list.
With the Properties command on the File menu, you can view, edit, and save
properties for a drawing. Drawing properties can include the title, the author, and
keywords that identify important information. These properties include drawing
statistics, such as drawing size and the date that a drawing was created and last
modified; the software updates statistics automatically. You can change the size of a
drawing by using the Page Setup command on the File menu, and you can change
the name of a drawing in Drawing Manager.
Note
• Renaming a drawing file in Windows allows the drawing to be opened
with all graphics pointing to the database. However, renaming a drawing
file in Windows does not update the drawing table in the plant schema
where the drawing name is stored.
Working with Several Open Drawings
Several drawings can remain open in the same session but only if they all belong to
the same plant. Each drawing can have more than one view, too. You can use the
Cut, Copy, and Paste commands to move or copy information between the drawings
or within one open drawing. You can use commands on the Window menu to arrange
all the open drawings and views so that you can see them easily.
Open Command
File > Open
Opens the Open dialog box, which lists existing plants and their drawings. An
administrator creates the hierarchy of plants and projects in SmartPlant Engineering
Manager.
Related Topics
• Customize the Open Dialog Box, page 108
• Open an Existing Drawing, page 107
• Switch to Another Open Drawing or View, page 110
• Working with Drawings: An Overview, page 102
Pause over a toolbar button in order to display a ToolTip, which names the
corresponding command. For more information on the toolbar commands, see:
Open Database - Opens the Open Plant Structure dialog box, which allows you
to specify a different SmartPlant initialization file so that you can work in a different
database. You cannot open two drawings from different databases at the same time.
If you currently have a drawing open in SmartPlant P&ID, the Open Database
command is not available.
Filter - Opens the Filter dialog box, which allows you to specify the drawings
that are displayed in the list or detailed view.
Cancel Filter - Deactivates any ad hoc filter you have applied to the list of
drawings that appears in the list view of the Open dialog box.
Include Subnodes - Displays in the right-hand view of the Open dialog box all
the drawings and node names that reside in the currently selected node.
Details - Displays a detailed view in the right-hand window. The detailed view
displays all the properties specified in the Selected Properties list of the Customize
Current View dialog box. Using the detailed view allows you to view and sort
drawings by several attributes.
List - Displays the list view in the right-hand window. The list view only displays
one property for each drawing. You can specify that descriptor by clicking
Customize View; the first item in the Selected Properties list is the descriptor that
appears in the list view.
Customize View - Opens the Customize Current View dialog box, which allows
you to specify the information about each drawing that is displayed in the report or
list view of the Open dialog box.
Related Topics
• Customize the Open Dialog Box, page 108
• Open an Existing Drawing, page 107
• Open Command, page 72
• Switch to Another Open Drawing or View, page 110
Application Type - Allows you to specify the application that you want to associate
with this plant structure.
Available plant structure - Lists those plant structures found on the network. You
can select only one item from this list view at a time.
Open - Connects you to the selected database. The Open command also checks to
make sure you have the correct access privileges for the selected plant structure and
passes your access information back to the software.
Site Server - Opens the Open Site Server dialog box, allowing you to select a
SmartPlant initialization file from local and network directories. Plant structures that
correspond to the initialization file that you choose are subsequently displayed in the
list of available plant structures.
Related Topics
• Open a Drawing in a Different Database, page 108
• Open an Existing Drawing, page 107
• Open Command, page 72
Add - Places a new entry at the end of the existing definition list and enables the
options in the Edit group so that you can edit the new entry.
Definition - Displays all defined criteria associated with a filter. To add to or modify
the definition list, you must select a line in the list and then define or edit the property
in the Edit group.
Delete - Removes the selected criterion from the definition list. This button is
available only when you select a criterion in the definition list.
Edit - Allows you to define or edit a single line of filter definition criteria.
Match all - Specifies that items matching ALL of the filtering criteria pass through
the filter.
Match any - Specifies that items matching any one or more of the filtering criteria
pass through the filter. Match any is the default matching method.
Operator - Specifies the relationship between the property and its value.
Relationships include, for example, greater than, >; equal to, =; not equal to, <>; and
so forth.
Property - Displays a list of all properties for a certain item type. Examples of
properties include revision number and name. You define or modify filtering criteria
by selecting a property, an operator, and a value.
Value - Lists appropriate values for the property specified in the Property column. If
a list of attributes is not already associated with the Value box, you must type a value,
which can be free text, or choose null. You can type a percent sign, %, as a wildcard
character to find multiple characters, or type a question mark, ?, as a wildcard
character for a single character. Do not use an asterisk, *, in the Value box.
Related Topics
• Customize the Open Dialog Box, page 108
• Open an Existing Drawing, page 107
• Open Command, page 72
Add - Moves the selected items in the Drawing properties list into the Selected
properties list so that those properties are available in the detailed view of the Open
dialog box.
Drawing properties - Lists the properties that are available to be displayed in the
detailed view of the Open dialog box.
Move Up - Moves the selected property up in order in the list, which changes the
order of the display in the detailed view of the Open dialog box.
Move Down - Moves the selected property down in order in the list, which changes
the order of display in the detailed view of the Open dialog box.
Remove - Moves the chosen items in the Selected properties list back into the
Drawing properties list so that they are no longer available in the detailed view.
Selected properties - Displays the properties that are currently available for the
detailed view in the Open dialog box.
Related Topics
• Customize the Open Dialog Box, page 108
• Open a Drawing in a Different Database, page 108
• Open an Existing Drawing, page 107
• Open Command, page 72
Related Topics
• Creating P&IDs in SmartPlant P&ID: An Overview, page 130
• Working with Drawings: An Overview, page 102
Recent Drawings
File > Recent Drawings
Opens one of the drawings that you worked on most recently. The file names are
listed near the bottom of the File menu. You can change the number of files listed on
the menu by using the Tools > Options command.
Related Topics
• Access a Recently Open Drawing, page 110
• Working with Drawings: An Overview, page 102
Related Topics
• Working with Drawings: An Overview, page 102
Related Topics
• Working With the Design Window, page 20
Opens the File Properties dialog box, which displays general information about the
current drawing. You can review and edit the drawing summary and statistics.
Related Topics
• Set Document Properties, page 115
• View Document Properties, page 114
• Working with Drawings: An Overview, page 102
Note
• You must save the drawing before you can access the Statistics and
Summary tabs of the File Properties dialog box.
Related Topics
• File Properties Command, page 111
• Set Document Properties, page 115
• View Document Properties, page 114
Type - Displays the type of document. The type is based on the application used to
create the document.
Size - Displays the size of the document in bytes, kilobytes, and megabytes.
Created - Displays the date and time that the document was created or copied.
Modified - Displays the date and time that the document was last modified.
Accessed - Displays the date that the document was last opened or copied.
Attributes - Displays the properties of the current document. These settings are read-
only.
Read-Only - Indicates that the document is read-only. You cannot open a read-only
file for writing. You cannot create a file with the same name as a read-only file.
Hidden - Indicates that the document is a hidden document. You usually cannot see
this document in the Windows.
System - Shows that the document is a system document. You usually cannot see this
document unless you change the view options in Windows Explorer.
Note
• If some of the above information is not available, the dialog box displays
Unknown.
Related Topics
• File Properties Dialog Box, page 111
• Set Document Properties, page 115
• View Document Properties, page 114
Author - Displays the name of the person who created the document.
Keywords - Displays a list of words that identify the document when you browse or
search documents.
Related Topics
• File Properties Dialog Box, page 111
• Set Document Properties, page 115
• View Document Properties, page 114
Created - Displays the date and time the document was created or copied.
Creating Application - Displays the name of the application that created the
document.
Modified - Displays the date and time the document was last modified.
Accessed - Displays the date that the document was last opened or copied.
Last Saved By - Displays the name of the person who last saved the document.
Saving Application - Displays the name of the application that most recently saved
the document.
Currently Opened By - Displays the name of the person who has the document
open.
Related Topics
• File Properties Dialog Box, page 111
• Set Document Properties, page 115
• View Document Properties, page 114
The precision readout sets the number of significant figures to appear. It represents
the accuracy of the unit readout value. The precision setting does not alter the
numbers that you type into a property, only the display of the numbers. Values ending
in 5 are rounded up. For example, if the precision readout is .123 and you draw a line
that is 2.1056 inches long, then the line value length is rounded up to 2.106 inches.
Length Readout - Sets the unit of measure and precision readout for the length
values in a document.
Angle Readout - Sets the unit of measure and precision readout for the angle values
in a document.
Area Readout - Sets the unit of measure and precision readout for the area values in
a document.
Notes
• To avoid loss of precision in units when switching between small and
large types of a particular unit, increase the precision, that is, increase
decimal places, of the larger unit through Format Manager.
• All delivered labels use plant default units, which are defined in the
Options Manager, and so labels do not always display the units selected in
the Properties window. Change the Unit definition in the SmartText
Editor dialog box in Catalog Manager to see a different unit of measure in
a label.
• SmartPlant supports round-trip conversion of units without loss of
precision. That is, you can convert centimeters to meters and back and
retain the originally entered value of centimeters with no round-off loss.
Related Topics
• File Properties Dialog Box, page 111
• Set Document Properties, page 115
• View Document Properties, page 114
Related Topics
• Working with Drawings: An Overview, page 102
Close Command
File > Close
Closes the active drawing. The software saves your changes automatically.
Related Topics
• Close an Active Drawing, page 116
• Working with Drawings: An Overview, page 102
Note
• Any changes are automatically saved upon closing.
Related Topics
• Saving Drawings: An Overview, page 123
• Working with Drawings: An Overview, page 102
Exit Command
File > Exit
Closes the active drawing and the program. The software checks for unsaved changes
when you close the software. Any changes are automatically saved.
Related Topics
• Close the Program, page 117
• Working with Drawings: An Overview, page 102
Note
• The software saves any changes since the last time you saved your
changes.
Related Topics
• Saving Drawings: An Overview, page 123
The default storage location for templates is specified in Options Manager. If you
create a new template, save it in this default location in order for it to be available for
drawing creation.
The software also includes a set of title block labels that fit the delivered drawing
templates. If you create a new template, you can also create a new title block label
that fits the title block of your template correctly and that contains the appropriate
information. You create labels in Catalog Manager.
If you want to create custom border files for your drawing templates, use Intergraph
SmartSketch. You can then embed your border file in the new templates you create in
SmartPlant P&ID. Once you embed a border file into a drawing template and a
drawing is created in Drawing Manager using that template, any changes to the
border file are not reflected in drawings created prior to the change. If you link a
border file, instead of embedding it, and then subsequently change that border in
SmartSketch, changes are reflected automatically in your drawing.
Note
• SmartFrames are the only object type allowed in a template.
Standard Template Size Information
Template file Border file Page size
A0-Size.pid A0border.igr A0 Wide (1189mm x 841mm)
A1-Size.pid A1border.igr A1 Wide (841mm x 594mm)
A2-Size.pid A2border.igr A2 Wide (594mm x 420mm)
A3-Size.pid A3border.igr A3 Wide (420mm x 297mm)
A4-Size.pid A4border.igr A4 Wide (297mm x 210mm)
A5-Size.pid A5border.igr A5 Wide (210mm x 148mm)
Related Topics
• Create a Drawing Template, page 119
• Edit a Standard Drawing Template Border, page 121
• Embed a New Object, page 270
• Link or Embed a Previously Existing Object, page 271
• Set up a Page Layout, page 369
Creates a new blank template. You can specify properties for the new template and
embed border files.
Caution
• Templates created at the user level instead of the plant level are not
available to other users or to Drawing Manager for creating subsequent
drawings. The path to the plant-level drawing templates is defined in
Options Manager.
Related Topics
• Create a Drawing Template, page 119
• Creating Drawing Templates: An Overview, page 118
• Save a Drawing or a Drawing Template, page 124
• Set Document Properties, page 115
• Set up a Page Layout, page 369
• Working with Drawings: An Overview, page 102
3. In the Sheet size box on the Page Setup dialog box, choose a standard size or
define a custom size for this template.
4. Click OK.
5. Click File > Properties.
6. On the Units tab of the File Properties dialog box, specify the unit in the
Length, Angle, and Area readout boxes in order to define default units of
measurement.
7. You can also add general identifying information on the Summary tab.
8. Click OK.
9. Click Edit > Insert > Object.
10. On the Insert Object dialog box, make sure that the Link option is selected.
11. Type the path to the border file, a .igr file, in the Create from file box, or click
Browse, find the border file, and click Open.
Tip
• If you want to create custom border files for your drawing templates,
use Intergraph SmartSketch.
12. Click OK.
13. Click File > Save As and specify a name for your template on the Save As dialog
box.
Tip
• The default storage location for templates is specified in Options
Manager. Save it in this default location in order for it to be available
for drawing creation.
14. Quit the design software.
Notes
• To create a new drawing using a plant template, an administrator uses
Drawing Manager.
• You can also embed your border file in the drawing template if you want
to. Once you embed a border file into a template and a drawing is created
using that template, any changes to the border file are not reflected in
drawings created prior to the change. If you link a border file, instead of
embedding it, and then subsequently change that border in SmartSketch,
changes are reflected automatically in your drawing.
Related Topics
• Creating Drawing Templates: An Overview, page 118
• Embed a New Object, page 270
• Working with Drawings: An Overview, page 102
Notes
• You can also embed your border file in the drawing template if you want
to. Once you embed a border file into a template and a drawing is created
using that template, any changes to the border file are not reflected in
drawings created prior to the change. If you link a border file, instead of
embedding it, and then subsequently change that border in SmartSketch,
changes are reflected automatically in your drawing.
• For more information about editing other properties of a drawing template
or creating a new template, see
Create a Drawing Template, page 119
Related Topics
• Creating Drawing Templates: An Overview, page 118
• Embed a New Object, page 270
• Working with Drawings: An Overview, page 102
When you open an existing drawing, the software copies the drawing from the disk or
network and displays it on the screen. As you work, the changes that you make to the
drawing appear on your screen. These changes are saved in the database
automatically.
After you have saved a drawing, it remains displayed on the screen. You can use File
> Close to close the drawing and clear it from your screen, or you can use File > Exit
to close the drawing and quit the software.
Saving Assemblies
You can save a group of items in a drawing as an assembly. Assemblies are saved in a
specific folder specified in Options Manager. You can retrieve assemblies from
Catalog Explorer to place in a drawing.
CGM is an efficient format for publishing 2D vector drawings on the Web because it
uses little storage space, renders quickly, and has the ability to zoom and achieve
more detail. These types of drawings can contain embedded hyperlinks, allowing
quick access to information outside the drawing.
Related Topics
• Save a Drawing in a Different Format, page 125
• Save a Drawing or a Drawing Template, page 124
• Switch to Another Open Drawing or View, page 110
Save Command
File > Save
Stores the active drawing or template. If you have not already named a template, the
Save As dialog box opens. Plant location and paths are set in SmartPlant Engineering
Manager and Options Manager.
Related Topics
• Saving Drawings: An Overview, page 123
Save As Command
File > Save As
Opens the Save As dialog box. You can save the active document to a new format.
Note
When using AutoCAD, your parametric symbols should not be scaled. The graphics
will display incorrectly.
Related Topics
• Save a Drawing in a Different Format, page 125
• Saving Drawings: An Overview, page 123
Related Topics
• Save a Drawing or a Drawing Template, page 124
• Saving Drawings: An Overview, page 123
The software displays a message box that states One or more items in this drawing
are inconsistent with the database. Click OK to re-create the drawing from the
database.
During the re-create process, the status bar at the bottom of the main window keeps
you informed about the particular elements currently reconciling with the database.
Also, a log file, Recreate-DrawingName, is created in your Temp folder. You can
check this file for irregularities that occur during the re-create process.
Caution
• Do not interfere with the re-create process once started because the
drawing can become unusable.
After the re-create process is completed, the software reinitializes your drawing and
displays the message Re-create drawing is complete.
If a section of the drawing could not re-create successfully an error condition appears
on your drawing. Error conditions are always associated with a pipe or signal run, and
the symbology is a heavy orange line segment. This portion of the drawing must be
updated manually. Delete the heavy orange line segment and components connected
directly to it. Then re-route your runs and replace connections and components as
required.
Related Topics
• Resolve a Re-create Drawing Error Condition, page 128
Recreate a Drawing
1. Open the drawing that you want to recreate.
2. Place an item in the drawing.
3. Right-click an empty space on your Windows taskbar, and then click Task
Manager.
4. Click the Processes tab.
5. In the list, click draft.exe.
6. Click End Process.
7. In SmartPlant P&ID, open the drawing that you opened in step 1.
8. When the software prompts you that a recreate is necessary, click OK to recreate
the drawing from the database.
9. Delete the item that you placed in step 2.
10. Save the drawing.
Notes
• Normally SmartPlant P&ID recreates drawings automatically when it
detects a discrepancy between the drawing and the database.
• For more information about recreating drawings, see the Re-creating
Drawings section in the SmartPlant P&ID Installation and Upgrade
Guide.
Related Topics
• Re-creating Drawings: An Overview, page 126
You can use filters when you create report templates to display particular items on a
report. You can use filters in Rule Manager to define how items interact within a
view. You can associate filters with the source or target properties in rules. And you
can use filters to find and replace items.
You can create filters to control the display of hierarchy items in Drawing Manager.
These filters are not saved to any folder in Filter Manager, but the methods of
creating these filters are the same as those for creating filters saved in Filter Manager.
Note
• If you are using a workshare environment and you are at a satellite site, do
not create Project Filters at a satellite site. However, you can always create
My Filters in the Filter Manager or Select Filter dialog box environment.
Related Topics
• Define a New Filter for an Engineering Data Editor View, page 54
• Define the Contents of Your Report Template, page 356
In the Properties window, you can add values for various properties of each item
after you place it in your drawing. You can also annotate your drawing with labels as
you design the drawing.
As you work on your drawing, you can monitor any inconsistencies in your design by
reviewing the inconsistency indicators. These indicators appear in your drawing as
soon as an inconsistency occurs in the design. You can resolve inconsistencies using
solutions from the Consistency Check dialog box.
Additionally, you can generate reports to help you keep track of information in the
drawing. For example, after you finish the drawing, you can generate order lists for
the components in the drawing. You can print the drawing, if necessary.
Related Topics
• Create an Assembly, page 282
• Define a New Engineering Data Editor View, page 54
• Generate a Report, page 334
• Open a New Drawing View, page 39
• Print a Drawing, page 365
• Review an Inconsistency, page 320
• Foreign Key - Insures that the corresponding value, unless it is null, exists
in the table referenced by the foreign key. This type of constraint is used
to enforce logical relationships, such as the plant item to plant group
relationship.
• Foreign Key in conjunction with Not Null - Enforces group relationships,
such as the case to model item relationship. This constraint is similar to
the Foreign Key constraint described above, but does not allow null
values to persist.
• Foreign Key with Not Null and Unique - Enforce all subclass and one-to-
one relationships, such as the pairing of OPCs. This constraint is similar to
the Foreign Key constraint described above, but does not allow null
values to persist and requires that all values be unique.
The constraints so far described serve to enforce relationship integrity. Since the
relationship, the object and the foreign key it points to, already exists in the database
or is created during your transaction, the constraints are satisfied without changing
the scope of your transaction.
• The item changes to the selection color. You can change the selection
color with the Options command on the Tools menu.
• The handles of the item appear if the item has handles. Handles are solid
squares at significant positions on a selected item, such as end points and
center points. Handles allow you to directly modify the item, such as
dragging a handle to change the shape of the item. Although you can
select more than one item at a time, only one item can have handles at a
time.
• If the item is linked or embedded into the current drawing, selecting it
allows you to double-click it for editing.
When you select multiple items or grouped items, the items change to the selection
color.
You can also select drawing items by first selecting them in the Engineering Data
Editor. The corresponding items are selected in the Drawing view if they reside in
the active drawing.
You can use the Select Tool ribbon to choose if you want to select only items
completely enclosed by the fence or any item that is partly enclosed by the fence.
Many manipulation commands, like Delete, Move, Copy, and Rotate, can act upon
all items in the select set.
If you select multiple items in the Engineering Data Editor, these items are also
selected in the active drawing, if they reside there. You construct a select set using the
Engineering Data Editor in this way.
Whenever you have constructed a select set, you can choose single items from that set
by using the Selected Items list at the top of the Properties window. A single item
chosen in a select set this way is highlighted in a different color in the Drawing view.
Related Topics
• Move an Item With the Select Tool, page 209
• Select an Item, page 135
Related Topics
• Copy an Item With the Select Tool, page 240
• Modify an Item With the Select Tool, page 235
• Move an Item With the Select Tool, page 209
• Select an Item, page 135
• Selecting Drawing Items: An Overview, page 132
The Select Tool Ribbon appears when nothing is selected. After you select an item,
the Select Tool ribbon is replaced with a ribbon for editing the selected item.
Overlapping - Specifies that items both overlapped by the fence and inside the fence
are selected.
Top Down - Specifies that symbols are recognized in the locate zone as opposed to
individual elements in a symbol.
Note
• To find out the name of an option on the ribbon, pause the pointer over an
option and read the ToolTip.
Related Topics
• Copy an Item With the Select Tool, page 240
• Modify an Item With the Select Tool, page 235
• Move an Item With the Select Tool, page 209
• Select an Item, page 135
• Select Tool Command, page 133
Related Topics
• Place a Flow Arrow, page 181
• Place an Item from Catalog Explorer, page 66
• Place an Item With the Configuration (PickQuick) Tool, page 137
Select an Item
1. On the main toolbar, click the Select Tool .
2. Do one of the following:
• To select one item, click it.
• To select more than one item, hold Shift or Ctrl and click each item.
• To select more than one item at once, drag to fence the objects.
• To select one of several overlapping items, use PickQuick.
3. To clear the selection of an item or items, do one of the following:
• Click in an empty portion of the drawing.
• Right-click in an empty portion of the drawing.
• Select another item without holding Shift or Ctrl.
• To clear the selection of one item and leave other items selected, click
the item while holding Shift or Ctrl.
Notes
• When the Select Tool is active, selectable items are highlighted as you
pass the pointer over them. When the item you want to select is
highlighted, click to select it.
• Click Tools > Options to change the item highlight and selection colors
and locate and break-away tolerances.
• To select all items in a drawing, right-click a blank area in the drawing
and click Select All on the shortcut menu, or, to accomplish the same
thing, press Ctrl + A or click Edit > Select All.
• You can also select items in the Engineering Data Editor. If they reside
in the active drawing, they are selected in the Engineering Data Editor.
You can build up a select set using this method, too.
Related Topics
• Select an Item Using the Configuration (PickQuick) Tool, page 136
• Selecting Drawing Items: An Overview, page 132
3. On the PickQuick toolbar, that appears near the pointer, move the pointer over
the numbered PickQuick buttons, without clicking, to highlight the
corresponding items.
1. Move the pointer over each toolbar button to preview the available orientations.
2. When the appropriate orientation displays, click the corresponding button on the
Configuration toolbar to place the item in that orientation.
Note
• You can right-click in an empty portion of the drawing or press Esc to
close the Configuration toolbar, or you can close it by clicking X in the
upper right corner of the toolbar.
Related Topics
• Configuration (PickQuick) Tool, page 134
• Navigating in the Software: An Overview, page 16
The grid is an set of imaginary lines in the drawing; they do not appear when you
print the drawing. When you click View > Snap grid, items always align with the
grid lines or nearest intersection of the grid lines. You can view the grid by clicking
View > Show grid.
You can change the display of the grid from static to dynamic by setting options on
the Grid tab of the View Properties dialog box. To view grid lines at a finer level,
set the style to dynamic and adjust the density.
The grid lines for a dynamic grid move as you zoom in or out in a view. You can set
dynamic grid lines to appear at fine, medium, or coarse levels. The grid lines appear
at common major measurement increments. A dynamic grid displays index lines that
intersect with the darker, solid grid lines.
A static grid displays solid grid lines that do not move as you zoom in or out. You can
specify the increment settings on the Grid tab of the View Properties dialog box.
Note
• You do not have to display the grid in order to snap items to it.
Related Topics
• Change the Properties of a Drawing View, page 37
Displays a grid so you can place items with precision. The grid is not considered part
of the drawing and does not print.
Note
• You can change the grid display from static to dynamic by setting options
on the Grid tab of the View Properties dialog box, which opens when
you click View > Properties.
Related Topics
• Placing Items on a Grid: An Overview, page 138
• Set Document Properties, page 115
• View Document Properties, page 114
Aligns items with the grid. The grid is a set of lines in the drawing background that
helps you align items. When you set the Snap grid option, items always align with
the grid lines or nearest intersection of the grid lines. Grid lines do not print.
Note
• You can change the grid display by setting options on the Grid tab of the
View Properties dialog box, which opens when you click View >
Properties. To view grid lines at a finer level, set the style to Dynamic
and adjust the grid line width with the Density control.
Related Topics
• Placing Items on a Grid: An Overview, page 138
• Set Document Properties, page 115
• View Document Properties, page 114
Depending on the rules defined for the equipment or equipment component, you can
have limits to the possible placements for the equipment. For example, specific trays
can be flagged for placement inside the piece of equipment, and nozzles can be
flagged for placement outside the piece of equipment. Rule Manager defines rules
that determine the way that model items interact during manipulation.
Related Topics
• Assign Heat Tracing, page 151
• Place Equipment, page 140
• Place Multiple Representations, page 142
Place Equipment
1. In the Catalog Explorer list view, click the equipment that you want to place.
2. Drag the item to the appropriate place in the drawing.
3. Position the item and release to place it.
Tip
• In addition, you can click the item in the Catalog Explorer list view
and then click the appropriate point in the drawing to place the item.
Press Esc to quit placement mode. Or, you can escape placement mode
by right-clicking.
4. In the Properties window, enter values for the equipment properties in the
appropriate rows in the table.
Tip
• You can assign heat tracing to equipment. For more information, see
Assign Heat Tracing.
Notes
• After you place items, you can mirror, rotate, or move most items using
their component handles. For more information, see
Mirror an Item About an Existing Mirror Axis or Linear Element, page 229
Rotate an Item Using Its Rotate Handle, page 231
Move an Item Using the Move Button, page 210
Related Topics
• Grouping Equipment in SmartPlant P&ID, page 432
• Modifying and Moving Placed Items: An Overview, page 206
• Placing Equipment: An Overview, page 140
Tips
• You can find the parent item in the Engineering Data Editor by
clicking the Other Drawings button . You can choose a filter from
the list using the Engineering Data Editor. Select a filter that best
describes the type of item you want to represent (for example,
Equipment - Vessels).
• You can also open a tabular view of your target drawing in the Design
window by clicking Window > New > Engineering Data Editor.
5. In the Engineering Data Editor, right-click the icon at the far left of the parent
item.
7. Click the location in the drawing where you need to place the multiple
representation.
Notes
• You can use the Replace command or the Find and Replace dialog box
to replace a multiple representation symbol providing the definition
attributes for the source (parent) and target (child) are identical. The
definition attributes are Equipment Class, Equipment SubClass, and
Equipment Type.
• You are permitted only a single representation of an item in any one
drawing.
• If you are working in a project, be aware that multiple representations are
constrained because of claiming and moving drawings between projects
and the Plant.
Related Topics
• Placing Equipment: An Overview, page 140
• Selecting Drawing Items: An Overview, page 132
Lines consist of a series of line segments. The software places handles, represented
by black squares or dots, at each segment vertex along the line route. You can use
these vertex handles to move, reroute, or connect lines. You can add vertices to add
segments to the line using the commands on the Line Routing ribbon.
The software also provides a shortcut menu associated with lines. Right-click a line
and choose from several commands. You use this menu to break runs or join runs.
You can also use this menu to construct select sets of pipe runs.
Line Connectivity
When a new pipe run is placed such that it connects to existing pipe runs at either
end, those pipe runs are automatically joined together if they have the same
properties. The symbol placement command creates a new line when an inline
component is placed directly up against an existing nozzle or other inline component.
The pipe run created in this way has a zero length connector that attaches the two
symbols. Pipe runs that only have zero length connectors are aggressively joined up
with the pipe runs they attach to; the properties for pipe runs with zero length
connectors need not match. The zero length pipe run that gets created when one inline
component is placed directly up against another inline component is automatically
joined to the existing pipe run, too. When a new pipe run is placed that starts or ends
at a component that belongs to an existing pipe run, the new pipe run is automatically
joined with the existing pipe run. When a new pipe run is placed that starts or ends at
the endpoint of an existing connector, the two pipe runs are joined and the new
connector is actually merged with the existing connector. The automatic joining takes
place in the same way for both placement and modification of connectors. At the time
that the connection is made, the two pipe runs are tested for compatibility. If they
pass the property criteria, they are automatically joined together.
If two pipe runs have different properties, they are not automatically joined together.
If you want them joined together, the Join Runs command is still available for this
purpose. Of course when two pipe runs with differing properties are joined into one,
the properties of the surviving pipe run are retained and the others are lost. Similarly,
if you must define two different properties for two parts of a single pipe run, then the
pipe run must be broken. The Break Run command is still available for this purpose.
Pipe runs always consist of a linear sequence of members and never include any
branches. Placing a pipe run that branches off of an existing pipe run does not cause
them to be joined together. Reducers are always located at the end of a pipe run and
never in the middle. Placing a new pipe run that connects to a reducer does not cause
the pipe runs to be joined.
Auto Join
Pipe runs are automatically joined together whenever possible. When a new pipe run
is placed, and it connects to existing pipe runs at either end, those pipe runs are
automatically joined together if they have the same attribute values. Pipe runs that
only have zero length connectors are joined with the pipe runs they attach to. (The
attribute values for pipe runs with zero length connectors do not need to match.) This
means that both the bottom-up and the top-down approaches produce the same final
result.
When a new pipe run is placed that starts or ends at a component that belongs to an
existing pipe run, the new pipe run is automatically joined with the existing pipe run.
When a new pipe run is placed that starts or ends at the endpoint of an existing
connector, the two pipe runs are joined and the new connector is actually merged with
the existing connector.
The automatic joining takes place in the same way for both placement and
modification of connectors. At the time the connection is made the two pipe runs are
tested for compatibility. If they pass the attribute criteria, they are automatically
joined together. The zero length pipe run that is created when one inline component
is placed directly up against another inline component is automatically joined to the
existing pipe run.
Pipe runs always consist of a linear sequence of members and never include any
branches. Placing a pipe run that branches off of an existing pipe run does not cause
them to be joined together.
Reducers are always located at the end of a pipe run and never in the middle. Placing
a new pipe run that connects to a reducer does not cause the pipe runs to be joined.
If two pipe runs have different attribute values, they are not automatically joined
together. If you want them joined , the Join Runs command is to be used. When two
pipe runs with differing attribute values are joined into one, the attributes of the
surviving pipe run are retained and the others are discarded. Similarly, if you must
define two different attribute values for two parts of a single pipe run, then the pipe
run must be broken. The Break Run command is used.
Note
• All of the above information about pipe runs also applies to signal runs.
Related Topics
• Assign Heat Tracing, page 151
• Branch to an Existing Line, page 150
• Break a Pipe Run, page 153
• Insert Line Segments into an Existing Line, page 149
• Move a Line, page 211
• Start a Line in Free Space, page 147
Diagonal Mode (Alt) - Select the Diagonal Mode button or press the Alt key to
route lines in any direction, instead of the usual constraint of horizontal or vertical
line routing. This procedure is usually popular with signal and utility lines, but you
can use it for any line routing.
Insert Segment Mode (Shift) - Select the Insert Segment Mode button or press
the Shift key to insert line segments instead of routing new lines or instead of moving
existing lines.
Break Run - Allows you to break a pipe run. After you break the run, select the
pipe run and select Edit > Properties to enter or change any property values.
Join Runs - Allows you to join two pipe runs. The properties of the pipe run
after using Join Runs will be the values of the pipe run you selected first.
Related Topics
• Insert Line Segments into an Existing Line, page 149
• Move a Line, page 211
• Start a Line from a Connect Point, page 148
• Start a Line in Free Space, page 147
Route a Line
1. In the Catalog Explorer list view select the line that you want to place.
Tips
• This action displays the Line Routing ribbon and starts line placement
mode.
• Press Alt while routing a line or click Alter Segment on the Line
Routing ribbon to override the current line vector and allow routing in
any direction and at any angle.
2. Click a connect point on an item in the drawing.
Tip
• You can click an empty point in the drawing to start the line, too.
3. Click to place the vertex at the next point in the line.
4. Continue clicking to place the vertices of the line in the drawing.
5. When the line is complete, right-click to confirm the placement.
Tip
• You can escape line placement mode by right-clicking two more
times.
Related Topics
• Routing Lines: An Overview, page 144
Notes
• You can define values for the properties of a line by clicking the line and
then entering the values in the appropriate rows in the Properties window.
• If the Properties window does not appear, you can display it by clicking
the line and then selecting Edit > Properties.
Related Topics
• Routing Lines: An Overview, page 144
• You can change values for the properties of the line by clicking the line
and then entering the values in the appropriate rows in the Properties
window.
• If the Properties window is not displayed, you can display it by clicking
the line and then selecting Edit > Properties on the main menu bar.
Related Topics
• Routing Lines: An Overview, page 144
Related Topics
• Assign Heat Tracing, page 151
• Modifying Item Properties: An Overview, page 244
• Placing Equipment: An Overview, page 140
• Placing Instrumentation: An Overview, page 162
• Routing Lines: An Overview, page 144
Enables you to break a pipe run at an arbitrary location. After selecting this command
from the Line shortcut menu, click the line at the point you want the break it.
Related Topics
• Break a Pipe Run, page 153
• Routing Lines: An Overview, page 144
Enables you to join two lines together into one pipe run. After selecting this
command from the Line shortcut menu, click on the line that you want to join to the
selected line.
Related Topics
• Join Pipe Runs, page 154
• Routing Lines: An Overview, page 144
Generally, piping components automatically orient themselves when you drag them
near an existing pipe segment. For example, if you drag a horizontal valve to a
vertical pipe, the valve automatically orients itself vertically. If several possible
orientations exist for the piping component, you can use the Configuration tool, or
PickQuick, to review the possible placements for the component and select a final
orientation for the item. Rule Manager defines rules that determine the way that
model items interact during manipulation.
The software includes a standard group of piping component symbols. However, your
plant administrator can change and add to these symbols in Catalog Manager as
needed.
Related Topics
• Assign Heat Tracing, page 151
• Place a Piping Component, page 155
Notes
• As you drag piping components over a pipe run, or the pointer passes over
runs while you are in placement mode, the pipe run is highlighted. If you
place a piping component when a pipe segment is not highlighted, the
piping component is placed in free space if the placement rules allow the
action.
• If the item that you place has multiple possible orientations in relation to
other items, you can use the Configuration tool, or PickQuick to select the
appropriate placement for the item.
• If you want to be able to place two inline components an arbitrary distance
apart, regardless of minimum distance settings in Options Manager, do the
following.
1. Place the first component in the line.
2. Place the second component into the line and connected to the connect point
of the first component on the end that you want to attach to. You can see that
the connect points are actually joined by the black rectangle in the Drawing
view:
3. While holding down the Alt key, drag one component along the line away
from the other leaving the desired distance between the two.
If the components are already close to each other but not connected at coincident
connect points, you must drag one off of the segment to disconnect it and then
move it back to get the connect points attached.
• If you want to move a piping component but preserve its connection to the
pipe run, you can use the Alt key as you drag the component. Then even if
you drag the component away from the line, the line routes itself so as to
preserve its connection to the component.
Related Topics
• Routing Lines: An Overview, page 144
• Using Piping Components: An Overview, page 155
The minimum requirements to cause a lookup are that the piping component must be
in a pipe run, that the PMC of the pipe run must be populated and comply with
service limits, and that the nominal diameter of the piping component must be
specified. If the PMC is assigned but does not comply with the service limits, then the
Commodity Code property displays an error message.
The PipeSpec utility uses process case temperatures of the run during the commodity
code lookup only if the code for that component has a maximum temperature limit
value in the 3D database. For example, in PDS 3D, a value of -9999 for maximum
temperature in pdtable_202 indicates a null value, and the process case temperatures
on the pipe run are ignored for the lookup. If a maximum temperature exists for that
component, then the lookup insures this value is larger than all of the process case
temperatures assigned to the pipe run in which the piping component resides.
Note
• The units for the PDS 3D maximum temperature are those specified in
Options Manager.
If any temperature values for the pipe run are unspecified, then a value of zero Deg-K
is assumed for each of the unspecified temperatures. If multiple records are obtained
in the lookup, then the utility returns a commodity code only if all of the records have
the same code value. If not, an error is recorded in the error-log file with the
appropriate message.
Similarly, the Option Code property is a select list of text values in SmartPlant
P&ID, while it is a set of code numbers or indices in PDS 3D. Short Value for the
Option Code select list contains the PDS 3D indices corresponding to the appropriate
Option Code text in SmartPlant P&ID. The PipeSpec utility uses the entries in the
Short Value box of the Option Code list to obtain the Option Code used in the PDS
3D database tables.
Note
• Error messages are placed in the PipeSpecError.log file in the directory
assigned to the TEMP environment variable. Error messages help you
identify the cause of failure when the utility does not complete the tasks as
expected. For example, if minimum requirements are not met for the
lookup, the missing properties are listed in the log file.
• The ServiceLimits.log file contains any errors encountered during the
Service Limit Validation process, which runs as part of the PipeSpec
Utility.
Related Topics
• Assign a Commodity Code to a Piping Component Using PipeSpec, page
161
• Assign a Piping Materials Class to a Pipe Run Using PipeSpec, page 160
Piping materials class - Lists the PMCs in your piping specification. Choose one,
and depending on the settings in Options Manager, property validation for piping
segments and inline components is run. This can include checking service limits.
Related Topics
• Assign a Commodity Code to a Piping Component Using PipeSpec, page
161
• Assign a Piping Materials Class to a Pipe Run Using PipeSpec, page 160
Inline Instruments
Inline instruments are components that you can insert into a piping segment. Inline
instruments include instrument valves, such as pressure regulator valves, flow
controllers, flow indicators, and other instrument components, such as orifice plates.
As you drag inline instruments over a pipe segment, the pipe segment appears
selected. If you place an inline instrument when a pipe segment is not selected, the
instrument is placed in free space.
Offline Instruments
Offline instruments are components that you do not insert into a piping segment.
Typically, these instruments monitor and control inline instruments. Offline
instruments include flow controllers, level gauges, and system functions such as
digital control stations or computers.
Instrument Loops
You can create instrument loops containing any combination of inline and offline
instruments. Instruments loops are a group of one or more instruments or control
functions arranged so that signals can transfer from one function to the next to
measure and control a process variable.
The software includes a standard group of instrument and instrument loop symbols;
however, your plant administrator can change and add to these symbols as your plant
requires.
Related Topics
• Add Instruments to a Loop, page 166
• Assign Heat Tracing, page 151
• Place an Inline Instrument, page 163
• Place an Offline Instrument, page 165
• Remove an Instrument from a Loop, page 168
Search for - Allows you to type in descriptors to display the available loop tags,
limited by parameters that you enter here. The percent character, %, is a wildcard.
For example, if you want to list only loop tags that contain the letter F, you could
type %F% in the Search for box. If you want to display all available loop tags,
simply type %.
Search Now - Finds and displays the loop tags that match the criteria in the Search
for box. You can choose a tag from the main window and click OK in order to assign
the tag to the item whose properties currently appear in the Properties window.
Related Topics
• Add Instruments to a Loop, page 166
• Place an Inline Instrument, page 163
• Place an Offline Instrument, page 165
• Remove an Instrument from a Loop, page 168
• If you need to refresh the instrument Loop Tag Suffix display in the
Properties window, clear selection of the instrument and then select it
again.
• If the Properties window is not visible, you can display it by selecting the
instrument or loop and then selecting Edit > Properties on the main menu
bar.
Related Topics
• Generating Reports: An Overview, page 330
• Loop Tag Dialog Box (Properties Window), page 163
• Navigating in the Engineer Data Editor: An Overview, page 41
• Placing Instrumentation: An Overview, page 162
• Selecting Drawing Items: An Overview, page 132
• Working With the Properties Window: An Overview, page 83
Related Topics
• Generating Reports: An Overview, page 330
• Loop Tag Dialog Box (Properties Window), page 163
• Navigating in the Engineer Data Editor: An Overview, page 41
• Placing Instrumentation: An Overview, page 162
• Selecting Drawing Items: An Overview, page 132
• Working With the Properties Window: An Overview, page 83
Labeling: An Overview
Your main tool to add or edit text content that appears in a label is the Properties
window. By adding or editing text, you are entering data into the database. Whenever
you select a label. the corresponding labeled properties for its item appear in the
Properties window. The same properties appear in the long list of properties when
you select the item itself. Since only the label properties appear when the label is
selected, you have an easier method to find to the label properties.
Note
• If you enter text with a recognized unit of measure using a quotes or
double-quotes, the software parses the UOM and ignores the double-
quotes (or tick marks).
A label always reflects the current property values of the item that it labels. Labels
that populate a property at placement are called driving labels. In other words, the
predefined property value in the label overwrites the current property value on the
item that it labels. Labels that do not overwrite the property at placement are called
driven labels. Labels are defined as driven or driving in Catalog Manager.
Note
• If you place a label on a pipe run and a red X displays, this indicates an
inconsistency with the item being labeled. For example, if you place a
pipe run and then place Stress Analysis - Complete label, a red X
appears. This indicates that the label is inconsistent with the pipe run
value.
At label creation time, the plant administrator can define text content inside the label
with the SmartText editor in Catalog Manager. When placing a label later, you cannot
edit text such as OLL= on the OLL Elevation Equipment label. Nonetheless, you can
place free text in an item note.
Different labels have different label properties. The following table identifies some of
the label properties that are defined during label creation in Catalog Manager. After
the creation of a label, these properties dictate label placement behavior. You do not
see label properties while using the design software; these properties perform their
function in the background and are invisible to you.
Table notes:
• The four types of labels (title block, flow arrow, component, and break)
appear in columns. Label properties appear in rows.
• Yes indicates that the property applies to that type of label.
• Not applicable indicates that the property does not apply to that type of
label.
• Special notes, like 1- Point for one-point placement, indicate that the
property applies under certain conditions.
Related Topics
• Manipulate a Leader Line, page 177
• Place a Label from Catalog Explorer, page 172
• Place a One-Point Label, page 174
• Place a Two-Point Label, page 175
• Place an Annotation, page 199
Labels can have two-point placement or one-point placement. You use one-point
placement when a single point in the drawing identifies both the item to label and the
location of the label. You use two-point placement when you need one click to
identify the item to label and a second click to indicate a different location for the
label.
Some labels have no symbology associated with them; that is, they contain text only
(for example, the Short Description label for Equipment). If you place such a label,
but the properties that normally appear have not been entered yet, you have an empty
label. Since there is no symbology associated with this type of label, it would be
essentially invisible on the drawing. However, empty labels display a question mark
so that you can find them more easily and not unnecessarily repeat work.
You can add a leader line to a label by right-clicking on the label and choosing
Leader line display. If you place a leader line with the label, the first click also
identifies the end of the leader.
Labels can be moved by selecting the label and dragging the black square at the
center of the label. Drag the label to the location that you want it to occupy in the
drawing.
You set the placement type of a label at its creation in Catalog Manager. Afterwards,
you cannot change the placement type in the design software.
Notes
• Changing default label formats in Options Manager (for example,
changing temperature from K to °C) does not change labels that are
already placed in drawings. Once you have changed the label format
using Options Manger, you can use the Update Drawings command in
Drawing Manager or use the Replace command in SmartPlant P&ID to
update the existing labels in your drawings.
• All delivered labels use plant default units, which are defined in Options
Manager, and so labels do not always display the units selected in the
Properties window. Change units in the SmartText Editor dialog in
Catalog Manager to specify a different unit of measure in a label.
• A line label follows a line when you change its angle, for example,
changing from horizontal to vertical. A label and its assigned leader line
follow when you move a line. When you recalculate a line, the software
does not delete the label but repositions it in an associated location on the
line.
• When you place a property break label, the software stops the sharing of
data between segments of pipe. In other words, you break the pipe run.
• When you place an off-page connector (OPC), the software automatically
creates and stores a matching connector in either a plant or project
stockpile or the stockpile of another drawing. The matching connector
receives the value, for example, From Drawing 123, where the number
corresponds to the drawing. After you place the matching connector from
the stockpile into the related drawing, the software automatically updates
the matching connector in the original drawing (To Drawing 122, for
example).
Related Topics
• Place a Label from Catalog Explorer, page 172
• Place a One-Point Label, page 174
• Place a Two-Point Label, page 175
This valve received a label with one-point placement. Properties include an Offset
Distance value of .5 inch, no leader line, a Cursor Location value of above
midpoint, and an Offset Source value of local. These properties are set in Catalog
Manager during label creation.
The dots on the valve and label are not part of these drawing items. The dots
represent the center of the bounding box. These midpoints always align when you
place a label with one-point placement. Midpoints align at the y-axis of the local
coordinate system of the symbol with the label. This y-axis alignment line crosses the
center of the labeled item. Offset is always a positive value.
Pointer position determines if you place the label above or below the component. If
the pointer appears above the center (that is, the y coordinate is a positive value) you
are placing the label above the item. If the pointer appears below the center (that is,
the y coordinate is a negative value) you are placing the label below the item. The
center of the bounding box is (0,0), the local origin.
For a pipe run, the center is the point where the pointer touches the line. The tolerance
for the Select command determines the distance above and below the pipe run. The
alignment axis is perpendicular to the line at this point.
When you point to locations in the drawing and locate a valid target, the label
immediately moves to this position. The label remains in dynamics (you can move the
label to a different location before you place it) so you can confirm correct placement.
The property for offset source also affects label placement. If the value for offset
source is None, the software uses the default offset distance, designated in Options
Manager. In this example, the software aligns the center of the label at the center of
the item receiving the label. This action allows you to place labels on a line and at the
center of symbols. A value of Zero offset distance aligns the bounding boxes. Label
Offset options can be universally applied by inputting a value in the Distances option
in Options Manager; however, if a label offset is designated for the label during
creation in Catalog Manager, that value overrides the Options Manager setting.
Related Topics
• Customize the Software With the Options Command, page 26
• Manipulate a Leader Line, page 177
• Place a Label from Catalog Explorer, page 172
• Place a One-Point Label, page 174
• Place a Two-Point Label, page 175
This pump received a label by using two-point placement. (1) and (2) illustrate the
two pointer positions and clicks required to place this label. Properties include a
Rotation value of false and a Leader line value of true. These properties are set
through Catalog Manager during label creation.
With two-point placement, the software does not use properties for offset distance or
pointer location. You can place the first point anywhere on the item to receive the
label. The leader line points to this location.
Related Topics
• Manipulate a Leader Line, page 177
• Place a Label from Catalog Explorer, page 172
• Place a Two-Point Label, page 175
Tip
• Or, you can escape placement mode by right-clicking.
5. In the Properties window, specify the properties of the label in the appropriate
rows.
Tip
• If the Properties window is not displayed, you can display it by
selecting the label and then clicking Edit > Properties.
Notes
• After you place a label, you can move it and manipulate its leader line. For
more information, see
Modifying and Moving Placed Items: An Overview, page 206
Manipulate a Leader Line, page 177
• Property break labels and various types of component labels require two-
point placement.
Related Topics
• Labeling: An Overview, page 169
• Place a Break Label, page 182
• Placing Labels: An Overview, page 170
• Two-Point Label Placement, page 175
• Using the Types of Labels: An Overview, page 178
Copy Labels
1. In the Drawing view, select the label that you want to copy.
2. Right-click the label and select Place New from the shortcut menu or click Place
New on the Run Macro toolbar. The Place New icon does not appear on the
Run Macro toolbar until you select a label.
3. Associate the new label icon that appears at the end of the pointer with the new
item by highlighting the item and clicking.
Related Topics
• Copying Items: An Overview, page 239
• Labeling: An Overview, page 169
• Place a One-Point Label, page 174
• Placing Labels: An Overview, page 170
Align Labels
1. In the Drawing view, select the labels that you want to align.
Tip
• In order to align labels, you must be sure not to select any drawing
items other than labels. You can remove an item from a select set by
pressing Ctrl and clicking the item.
2. Click the appropriate alignment button on the main toolbar:
• Align Left - Align labels so that their left-most lines match
• Align Right - Align labels so that their right-most lines match
• Align Center About Vertical - Align labels so that their center
points agree on a horizontal line
• Align Center About Horizontal - Align labels so that their center
points agree on a vertical line
• Align Top - Align labels so that their top lines match
• Align Bottom - Align labels so that their bottom lines match
Related Topics
• Labeling: An Overview, page 169
• Modifying and Moving Placed Items: An Overview, page 206
• Placing Labels: An Overview, page 170
• Selecting Drawing Items: An Overview, page 132
Related Topics
• Labeling: An Overview, page 169
• Placing Labels: An Overview, page 170
The following four types of labels are Title Block, Flow Arrow, Component, and
Break.
Title Block
The title block label is unique among label types because you do not have to identify
the item to receive the label. The title block usually displays general information
about a drawing. After you select the label in the list view, you can drag it to the
location in the drawing where you want to assign the label.
Once the title block is placed in a drawing you can modify label properties using the
Property window (for example, Title and Description). Any properties that you
cannot modify while in SmartPlant P&ID would need to be modified using Drawing
Manager (for example, Drawing Number and Drawing Name). The different
template files, which create new drawing files, contain different title blocks.
Therefore, you can automatically place standard title blocks in standard drawings,
which are built on standard templates. Or, you can create custom title block labels to
fit your custom templates.
Flow Arrow
You place flow arrows in process piping lines. When you place the label, the arrow
orients itself with the flow in the pipe run if you have already defined flow direction.
If you have not specified a flow direction, then the direction you place the flow arrow
defines it for you (that is, a flow arrow is a driving label).
As you drag the label from the list view of Catalog Explorer, pipe runs in the
Drawing view are highlighted when you pause over them. Click a highlighted pipe
run to place the label. Flow arrows require only one click to place them.
After placing the label, you can change the flow direction of the pipe run in the
Properties window, and the flow arrow reorients itself accordingly. You cannot
change label properties that appear in the Properties window for a flow arrow.
Component
This type of label identifies physical commodities in the model. A typical example is
an Equipment ID label. Properties assigned to the label affect its behavior.
Component labels have a unique property: Label Behavior. The values are defined in
a select list in Data Dictionary Manager and are chosen in Catalog Manager when you
create a label. The default value is Follow. Values for this property can include the
following:
• Follow (no rotate) - The label does move but does not rotate,
corresponding to changes to the labeled item.
• Follow - The label does move and rotate, corresponding to changes to the
labeled item.
• Fixed - The label does not move if you move the labeled item.
This illustration shows component labels that you use to label vessels, nozzles, and
piping components. It also depicts both fixed and rotated orientations of labels.
Break
A break label, or property break label, graphically shows that a change occurs or can
occur in a property at some point in the process. This label indicates to the software
that an inconsistency for that property is acceptable. As a result, the software does not
issue a warning, or an existing inconsistency resolves itself when you place the break.
A break label can only be placed at a connection point where the specified properties
are being propagated. Break labels do not set properties but note that a value change
is acceptable for the property at the indicated point. Text included in the label reflects
the property at that point. You can associate multiple property breaks with one point
on the drawing.
You place property break labels, in the Segment Breaks node of Catalog Explorer,
with two-point placement.
Notes
• You can turn on or off the Is Leader Visible property in Catalog
Manager. After you place the label, you can right-click the label, and then
click Leader line display on the shortcut menu to control the display of
the leader line in the drawing software.
• Use care when you assign leader lines. You can place several break labels
at one point, and multiple leader lines can be confusing.
Related Topics
• Place a Label from Catalog Explorer, page 172
Related Topics
• Labeled Item Type, page 184
• One-Point Label Placement, page 172
• Placing Labels: An Overview, page 170
• Two-Point Label Placement, page 175
• Using the Types of Labels: An Overview, page 178
2. Place the break label using two-point placement. The first click (1) specifies the
junction in the process line, the second click (2) designates the location for the
break label itself.
3. Continue placing the same break label at other junctions in the drawing, or press
Esc to quit placement mode.
Notes
• A break label can only be placed at a connection point where the specified
properties are being propagated.
• Break labels can be removed using the Delete command. If the break
label is removed, the break is also removed. However, if there is another
break label at the same point, the break is not removed.
• You can turn on or off the Is Leader Visible property in Catalog
Manager. After you place the label, you can right-click the label, and then
click Leader line display on the shortcut menu to control the display of
the leader line in the drawing software.
• Use care when you assign leader lines. You can place several break labels
at one point, and multiple leader lines can be confusing.
Related Topics
• Consistency Checking: An Overview, page 310
• Placing Labels: An Overview, page 170
• Two-Point Label Placement, page 175
• Using the Types of Labels: An Overview, page 178
Examples of labeled item types include pipe run, instrument, piping component,
equipment, and so forth. If you specify that the labeled item type is a pipe run, then
you can place your label on a pipe run and not on any other type of item in your
drawing.
Related Topics
• Place a Label from Catalog Explorer, page 172
Offset Distance
This property defines the distance from the labeled item to the label. Offset distance
applies for labels that are defined with one-point placement. This property also
applies for two-point label placement if the property for offset source is set to Local.
The property must be defined correctly in Catalog Manager to allow you to place
your label. The actual plant-wide offset distance is specified in Options Manager.
The software measures the distance from the bounding box of the item to receive the
label and the bounding box of the label itself. Consider the offset as the clearance
distance between the bounding boxes.
Notes
• The bounding box in SmartPlant P&ID differs from the SmartSketch
definition of range. SmartSketch (A) uses the x-y coordinate range around
an item. SmartPlant P&ID (B) uses a rectangular area.
Offset Source
This property specifies the origin for the offset distance. The possible values for
offset sources are
None - The label does not have an offset. This value indicates placement at the center
of the labeled item.
Project Settings - Plant-level parameters determine the offset distance. You can use
Options Manager to define the plant settings distance.
Local - The label does have an offset, and the value for the Offset Distance property,
which is specified in Catalog Manager, defines the offset to use.
You set this property when you create a label in Catalog Manager. Afterwards, you
cannot change the offset source property in the drawing software. Likewise, you set
the local offset distance when you create a label, and you cannot change the property
in the drawing software.
Related Topics
• Place a Label from Catalog Explorer, page 172
Is Mirrorable
The value of this property is set to True to indicate that you can mirror the item. The
value of this property is set to False to indicate that you cannot create a reverse
image. You define this property when you create a label in Catalog Manager.
Related Topics
• Place a Label from Catalog Explorer, page 172
Related Topics
• Placing Labels: An Overview, page 170
• Working With the Properties Window: An Overview, page 83
Is Rotatable
The value of this property is set to True to indicate that you can rotate the item. The
value of this property is set to False to indicate that you cannot change the angular
orientation. You set this property when you create a label in Catalog Manager.
Related Topics
• Place a Label from Catalog Explorer, page 172
Is Fit To Text
The value of this property is set to True if the label graphics must fit around the text
when you place the label. The value of this property is set to False if the label
graphics do not need to fit around text. You can change the designation in Catalog
Manager.
You can set the value to True only for enclosures that are circles, ellipses, rectangles,
or parametrics. You set the Is Fit To Text property when you create a label in
Catalog Manager.
The following illustration is an example of a label with the Is Fit To Text property
set to False. The rectangle appears at the same size when you created it:
This illustration is an example of a label with the Is Fit To Text property set to True.
The rectangle resizes to fit around the text:
Related Topics
• Place a Label from Catalog Explorer, page 172
• Place a One-Point Label, page 174
• Place a Two-Point Label, page 175
• Place an Annotation, page 199
Is Leader Visible
The value of this property is set to True to indicate that the label includes a leader
line. The value of this property is set to False to indicate that the label does not
include a leader line. You set this property when you create a label in Catalog
Manager. You can turn on or off the display of the leader line after you place the
label.
Note
• To turn on or turn off the display of the leader line, right-click the label,
and click Leader line display.
Related Topics
• Manipulate a Leader Line, page 177
• Place a Label from Catalog Explorer, page 172
Related Topics
• Place a Label from Catalog Explorer, page 172
The drawing needs a connector when a line run continues on another drawing. The
minimum information in the label portion is the drawing name to which the connector
points and the connector number. Connectors do not have a property for flow
direction, although most connectors use an arrowhead to indicate direction. When you
place a connector, it does not set or respond to flow direction. The connector
represents continuation, not connectivity or flow.
During document creation, when you place the first connector of the pair, the
software places the partner in either the Stockpile or the stockpile of another drawing
of your choice. The default placement for the partner is into the Stockpile. When you
create a connector and place it in a drawing, the property for the drawing name is not
defined. The partner in the stockpile reflects the drawing name in which its match
was located. When you place the partner from the stockpile, the first connector is
updated to reflect the drawing name where you placed the partner connector. As a
result, you never need to type a drawing name, and the software guarantees a valid
match.
OPC pairs have a to and from orientation. The software does not use the graphical to
and from distinctions, but reading the drawing is easier for you with this
differentiation.
1. The OPC is a to connector if its connected point appears at the finish end of the
connector.
2. The OPC is a from connector if its connected point appears at the start end of the
connector.
In order to switch between to and from orientations, you must disconnect the OPC
from the line and then rotate or mirror it. Then you can reconnect the line to the other
end of the OPC. At the time of placement, you can pause when placing the OPC and
wait for the PickQuick toolbar in order to choose the correct orientation.
You can delete a connector from the drawing, and the software moves it to a stockpile
and updates the properties of its partner. To delete a connector from a stockpile, both
must reside there, and you delete both from a stockpile. After you delete a connector,
you cannot reuse the same number. You can change the connector number but not the
drawing name in these labels. However, you can change other properties. If you copy
a connector, the software must generate new connector numbers and add a partner to
a stockpile. The property for drawing name changes to Null or Undefined for the
copy.
Related Topics
• Change Default Storage Location for Partner Connector, page 192
• Place a Label from Catalog Explorer, page 172
• Place a One-Point Label, page 174
• Place an OPC or Utility Connector, page 190
• Store a Partner Connector, page 192
When the first OPC (of an OPC pair) is connected to a pipe run, there is no pipe run
connected to the mate OPC. Since there is no other pipe run, the system will not find
any applicable rules.
When the second OPC (of an OPC pair) is connected to a pipe run, however, the
system will find the rules that apply to this pair of pipe runs. The system copies the
specified properties from the pipe run in the other drawing to the pipe run in the
active drawing. This copy operation will not overwrite any existing values. (The
Copy is forced into the Copy If Null mode.) The properties that are copied across the
OPC are propagated into the active drawing. This can mean that property values on
items other than the connected pipe run are affected. However, this is only done if the
current value is Null. Existing values are not overwritten. After the copy process is
complete, the consistency criteria is evaluated and inconsistencies are generated for
all inconsistent properties.
Each time a drawing is opened, a routine is executed to update all of the OPCs in that
drawing. Also, the relationship between the OPC and the connected pipe run is
updated. During this update, the rule base is searched to find all of the applicable
rules. If the mate OPC has been connected to a new pipe run since the last time this
drawing was opened, it may find a different set of rules that apply. After finding the
applicable rules, the consistency criteria is evaluated and inconsistencies are
generated for all inconsistent properties. Property values are not automatically copied
across OPCs during this processing. If you want to copy changed property values
across OPCs, you can use the Solutions that are available in the Consistency Check
dialog box.
The text in the label on the OPC is also updated. If the mate OPC has been placed
into a different drawing since the late time this drawing was opened, this change will
be reflected in the updated label.
This workflow allows you to pull a changed property value across an OPC into the
continuation drawing. When a property value is changed on a pipe run that is
connected to an OPC, an inconsistency is generated at the OPC. This inconsistency
indicates that the two connected pipes have different values. To resolve this
inconsistency, you must close the active drawing and open the continuation drawing.
In that drawing, another inconsistency is shown at the mate OPC. You can double-
click on that inconsistency to display the Consistency Check dialog box. A solution
is displayed to Copy the new value from the first drawing onto the pipe run in the
active drawing. If you apply this solution, the value is copied into the active drawing
and propagated to the related items. This resolves the inconsistency in the second
drawing. The next time the first drawing is opened, the inconsistency will be resolved
there as well.
Related Topics
• Change Default Storage Location for Partner Connector, page 192
• Place a Label from Catalog Explorer, page 172
• Place a One-Point Label, page 174
• Place an OPC or Utility Connector, page 190
• Store a Partner Connector, page 192
2. Click the location in the drawing where you want to place the connector.
Tips
• You can place a connector in free space on the drawing and route a
line to it, or you can place it at the end of a line that already is drawn.
• If you are placing a connector in free space, rotate or mirror the OPC
after placement in order to get the correct orientation. Then route the
line to it.
•If you are placing a connector at the end of an existing line, you can
wait for the PickQuick toolbar so that you can choose the correct
orientation.
3. Modify the properties of the connector in the Properties window.
Tip
• If you placed a new connector from Catalog Explorer, you can
display and select the partner in the Engineering Data Editor and
modify its properties, too.
Notes
• Utility connectors support only one-to-one relationships. In other words,
they come in pairs only.
• When you place a utility connector and its partner goes to a stockpile, that
partner connector is of the same type as the first connector you placed. In
order to change the partner connector to the other type of utility connector,
you must place the partner in its drawing and then replace the symbol. For
more information on replacing symbols, see Replace an Item Using
Replace Mode, page 220.
Related Topics
• One-Point Label Placement, page 172
• Placing Labels: An Overview, page 170
• Using Off-Page and Utility Connectors: An Overview, page 187
Description - Allows you to enter to or from information for the connector. You can
enter drawing names or numbers or other pertinent information about the connected
drawing or the direction of flow.
Related Topics
• Review and Edit Item Properties, page 86
Related Topics
• Change Default Storage Location for Partner Connector, page 192
• Using Off-Page and Utility Connectors: An Overview, page 187
3. On the Move to Different Stockpile dialog box, select the plant hierarchy
element that contains the drawing whose stockpile you want to assign the
connector to.
Tip
• If you do not want to place the connector in a stockpile of a specific
drawing, you can select Stockpile at the bottom of the Plant hierarchy
tree.
4. In the Drawing list area, select the drawing whose stockpile you want to add the
partner to.
Related Topics
• Using Off-Page and Utility Connectors: An Overview, page 187
Opens the Move Partner OPC dialog box, from which you can move the selected
connector to the stockpile of any drawing in the active plant. This command is
available only when the partner connector is located in the Stockpile.
Related Topics
• Move a Partner Connector to Another Stockpile, page 194
• Using Off-Page and Utility Connectors: An Overview, page 187
Plant Hierarchy - Displays the hierarchical tree representation of the plant. When
you select a node, the drawings associated with that node appear in Drawing list.
Drawing list - Displays all the drawings associated with the selected node on the
Plant Hierarchy tree.
Related Topics
• Move a Partner Connector to Another Stockpile, page 194
• Move Partner OPC Command, page 193
Opens the connected drawing when the partner of the selected off-page or utility
connector is in a drawing or a drawing stockpile. This command is not available if the
partner OPC is in the stockpile (instead of a drawing or drawing stockpile).
Related Topics
• Open a Continuation Drawing, page 195
• Using Off-Page and Utility Connectors: An Overview, page 187
Related Topics
• Open Continuation Drawing Command, page 194
• Using Off-Page and Utility Connectors: An Overview, page 187
Deletes the selected item from the database; if you are deleting a connector, then its
partner is deleted from the stockpile as well.
Notes
• Unlike the standard Delete command, which moves the selected item to
the Stockpile, this command removes the selected items or connector and
its partner from the model completely.
• In the case of the connector, the command is not available unless the
partner connector is in the Stockpile.
Related Topics
• Delete a Connector From the Model, page 195
• Using Off-Page and Utility Connectors: An Overview, page 187
The ItemTag project deals specifically with the following item types: instrument
loops, instruments, pipe runs, equipment components, signal runs with a plant item
type pipe run (hydraulic, connect to process, and so forth), and equipment (other
equipment, exchangers, mechanical equipment, and vessels). This project disregards
all other item types.
Property validation is triggered when any property that comprises the Item Tag value
is added or modified. Calculation can be triggered by the Item Tag property for any
of the items shown in the tables below.
The following tables list item types that are validated or calculated by the ItemTag
project, and the database tables and column names where modifications trigger
calculation and validation.
Legend
Italics: Required for checking item tag uniqueness.
Bold Italics: Required for the item tag, but can be generated automatically.
Instrument
Item Tag Instrument Type Modifier Measured Variable Code Tag Sequence
Structure Number Loop Tag Suffix Tag Suffix
Format (Instrument Type Modifier)(Measured Variable Code)-(Tag
Sequence Number) Loop Tag Suffix(Tag Suffix)
Instrument Loop
Item Tag Instrument Loop Function Tag Sequence Number Tag Suffix
Structure
Format (Instrument Loop Function)-(Tag Sequence Number)(Tag
Suffix)
Pipe Run
Item Tag Unit Code Tag Sequence Number Tag Suffix Fluid Code
Structure
Format (Unit Code)(Tag Sequence Number)(Tag Suffix)-(Operating
Fluid Code)
Equipment
Item Tag Structure Tag Prefix Tag Sequence Number Tag Suffix
Format (Tag Prefix)-(Tag Sequence Number)(Tag Suffix)
Equipment Component
Item Tag Structure Tag Prefix Tag Sequence Number Tag Suffix
Format (Tag Prefix)-(Tag Sequence Number)(Tag Suffix)
Nozzle
Item Tag Structure Item Tag
Notes
• To refresh the instrument loop tag suffix in the Properties window, clear
the selection of the instrument and then select it again.
• Item Tag cells for these item types are read-only except for those of
signal runs, and Item Tag properties for instruments are not read-only so
that implied instruments can have item tags that are assigned manually.
• For information on customizing the software, including item tag formats,
see the SmartPlant P&ID Programmer's Guide or click Related Topics.
Related Topics
• Add Instruments to a Loop, page 166
• Display Help for Programming With SmartPlant P&ID, page 15
• Modify a Pump by Importing a SmartPlant P&ID Report into the
Stockpile, page 254
• Review and Edit Item Properties, page 86
Because annotations are frequently parametric, often you can resize them to fit your
needs.
Placing annotations works like placing any other component in a drawing. When you
place an annotation, which has an item type of item note, on a drawing, you can then
place a label on the item note. These labels allow you to enter the remarks, notes, and
other information that you need to effectively annotate your drawings.
Caution
• You cannot annotate drawings by opening them in SmartSketch and
adding dumb graphics to the drawing. Opening and saving a .pid file in
SmartSketch can corrupt the file, making the drawing unusable.
Note
• Annotations are a way to place free remarks in a drawing. There are
several design labels of different formats available in Catalog Explorer.
Most of these labels require placing an annotation point or other design
graphic on the drawing first and then attaching a label to the graphic. The
plain annotation point is located in the Graphics folder under the
Annotation node; however, there is one item in the Labels folder with an
annotation point built into it. It is called Item Note & Label, and it looks
like this:
1. Annotation point
2. Item note
Related Topics
• Place a Revision Cloud, page 205
• Place an Annotation, page 199
Place an Annotation
1. In the Catalog Explorer list view, select the annotation that you want to place
from the Graphics folder.
2. Click to place the annotation at the appropriate place in the drawing.
3. Press Esc to quit placement mode.
4. To add text to the annotation, place a design label on the annotation. For more
information, see Place a Two-Point Label, page 175 and Place a One-Point
Label, page 174.
5. Assign text to the annotation in the Note Text property box in the Properties
window.
Tip
• You can also assign text to the graphic in the Note Text property box
for the graphic, and when you add a label, it automatically displays
that text.
Note
• You can resize annotations by dragging their parametric handles. For
more information, see Scale a Parametric Item, page 226.
• There are several design labels of different formats available in Catalog
Explorer. Most of these labels require placing an annotation point or other
design graphic on the drawing first and then attaching a label to the
graphic, as in the procedure above. The plain annotation point is located in
the Graphics folder under the Annotation node; however, there is one
item in the Labels folder with an annotation point built into it. The symbol
is called Item Note & Label, and it looks like this:
1. Annotation point
2. Item note
Related Topics
• Placing Labels: An Overview, page 170
• Using Annotations: An Overview, page 198
Related Topics
• Selecting Drawing Items: An Overview, page 132
• Working With the Properties Window: An Overview, page 83
Place a Package
1. Right-click the Package symbol in Catalog Explorer in the Design node.
2. From the shortcut menu, select either Send to Stockpile or Send to Drawing
Stockpile, whichever is appropriate.
3. In the Properties window or the EDE, enter a value for the Item Tag property.
4. In the Drawing view, select items to be part of the package.
5. If you want to create a select set, in the Properties window, choose Select Set
from the Properties box.
6. In the Properties window, click in the Package Item Tag box and select the
appropriate value displayed list.
Tip
• Some catalog items do not possess the Package Item Tag property, for
example, OPCs and Item Notes. Do not include those items in your select
set because the package item tag does not appear in the Properties
window if any member of the select set does not possess that property.
Notes
• Packages normally reside in a stockpile with their members residing on
drawings. Moving the package itself to another stockpile has special
limitations. For more information about moving plant item groups from
one stockpile to another, see Move a Stockpile Item to the Stockpile of
Another Drawing, page 250.
• If the Properties window is not visible, you can display it by selecting an
item and then selecting Edit > Properties on the main menu bar.
Related Topics
• Place a Hydro Test Package, page 203
• Place a Safety Class, page 201
• Place a Test System, page 202
• Selecting Drawing Items: An Overview, page 132
• Working With the Properties Window: An Overview, page 83
Depending on the rules defined for particular items in the drawing, limits exist for
possible placements. For example, specific trays can be flagged for placement inside
a piece of equipment, and you can only move these inside the equipment. Rule
Manager defines rules that determine the way that model items interact during
manipulation. The software processes rules defined for items as you move them, as
well as when you place them.
You can resize or scale parametric items by using their parametric handles. Resizing
parametric items maintains certain characteristics of the item, such as angles between
elements of the symbol, while it allows modification of other characteristics of the
item, such as the length of its sides. Many items are now scalable, too, and can be
resized by using their scale handles.
You can modify the properties of each item by selecting the item and changing
individual properties in the Properties window. Also you can edit some item
properties in the Engineering Data Editor in the Design window by selecting a table
cell and filling in the appropriate information. You can select a entire row by clicking
on the corresponding row number to the left of the table and then viewing the
properties in the Properties window and editing them there.
If you want to remove an item from a drawing, you can delete the item. If the plant
model requires the deleted item, the item appears in the stockpile for later placement.
If the plant model does not require the item, it disappears from the drawing
completely. You can permanently remove required items from the plant model using
the Delete from Model command.
Notes
• When modifying or setting the fluid code properties of a line, you always
select the fluid code from a select list. If you do not set the fluid code first,
you will see all possible fluid codes. If you set the fluid system prior to
setting the fluid code, then only the fluid codes applicable to the type of
fluid system display. To redisplay a complete list of available fluid code
values, delete the property for the fluid system, and then the complete list
of fluid code values appears.
• If the Properties window is not open, you can display it by selecting an
item and then selecting Edit > Properties.
Related Topics
• Mirror an Item Using Its Mirror Handle, page 228
• Move a Select Set to Another Open Drawing, page 213
• Move an Item Using the Move Button, page 210
• Review and Edit Item Properties, page 86
• Scale a Drawing Item, page 226
• Scale a Parametric Item, page 226
Undo Command
Edit > Undo
Up to ten operations are saved in the undo list, and you can undo them by repeated
use of the Undo command. The undo list is cleared if you perform any of the
following actions:
• Change the properties of the Drawing view on the View Properties dialog
box
• Turn the display of inconsistency indicators off or on by clicking View >
Show Inconsistencies
• Click File > Save
• Open a different drawing or toggle to another open drawing
• Open a new Drawing view or new Engineering Data Editor (EDE)
• Using commands in the EDE or on the Connector shortcut menu, move a
connector to another drawing stockpile
• Changing or viewing the claim status of drawing objects
An undoable action is defined in several ways. Running a command is usually an
action. Modifying item properties is an action, and the action ends when another item
is selected. This definition of an action holds true for select sets, too, and for multiple
items selected in the EDE. That is, modifying the properties of a select set is one
action in and of itself, not one action for each member of the set.
The Undo command does not reverse view manipulations; however, the View >
Previous command is still available for that purpose.
Related Topics
• Claim a Drawing Item, page 288
• Claiming Items: An Overview, page 285
• Integrating SmartPlant P&ID with The Engineering Framework, page 371
• Modifying and Moving Placed Items: An Overview, page 206
• Move a Select Set to Another Open Drawing, page 213
• Save As Assembly Command, page 281
Tips
• Pressing Ctrl + Z also undoes your last action.
• The Undo command stores up to 10 actions making this command
available repeatedly.
• If the Undo button is not available, then the undo list has been cleared,
and you can no longer undo your last action.
Note
• The Undo command does not reverse view manipulations; however, the
View > Previous command is still available for that purpose.
Related Topics
• Modifying and Moving Placed Items: An Overview, page 206
• Selecting Drawing Items: An Overview, page 132
• Undo Command, page 207
Move Command
Edit > Move
Moves items from one location to another. You can specify the locations by clicking
the drawing sheet or by entering relative values in the Move ribbon. You can move
one or multiple items at a time, and you can move select sets. You can access this
command from the Edit menu or the main toolbar.
Notes
• If you want to move an item to another drawing, move it to the Stockpile,
open the second drawing and place the item from the stockpile.
• If you move an item that owns other items, the owned items move also.
For example, if you move a vessel that owns trays and nozzles, the trays
and nozzles move with the vessel.
• You can use other view manipulation commands, such as Zoom, Fit, and
Pan, while you are using the Move command. When you finish
manipulating the view, the software returns you to the Move command at
the point where you were when you started manipulating the view.
Related Topics
• Move an Item Using the Move Button, page 210
Move Ribbon
Specifies the from point and to point when you move items.
Copy - Copies the items in the select set when you move them.
Step Distance - Increases or decreases the value in the ribbon boxes. For example,
typing a step value of 0.25 and pointing away from the from point increases the
distance in discrete steps, from 0.25 to 0.5, 0.75, and so forth.
X - Allows you to enter an explicit value for the distance to move in the x-coordinate,
or you can simply observe the value as you drag the object.
Y - Allows you to enter an explicit value for the distance to move in the y-coordinate,
or you can simply observe the value as you drag the object.
Related Topics
• Move an Item Using the Move Button, page 210
• Move Command, page 208
• Selecting Drawing Items: An Overview, page 132
Related Topics
• Manipulating Items With Component Handles: An Overview, page 225
• Modifying and Moving Placed Items: An Overview, page 206
• Selecting Drawing Items: An Overview, page 132
Move a Line
1. In the Drawing view, select the line that you want to move.
2. Point near the center of the appropriate line.
3. When the pointer turns into a double arrow , drag the segment to the new
location and release.
Notes
• The software applies geometrical line routing rules as you move a line. If
you want to override those rules, press Shift as you move the line, or press
Alt while routing a line or click Alter Segment on the Line Routing
ribbon to override the current line vector and allow routing in any
direction and at any angle.
• When you move a line segment, the software changes the length of
attached line segments to accommodate the move.
• Press Esc at any time to stop changing the selected line.
• You can change values for the properties of the line by clicking the line
and then selecting or typing the new values in the appropriate rows in the
Properties window. If the Properties window is not open, you can
display it by clicking the line and then selecting Edit > Properties on the
main menu bar.
Related Topics
• Move a Line Using Vertex Handles, page 211
• Routing Lines: An Overview, page 144
Allows you to move a select set of drawing items into another open drawing. These
conditions must be met in order for this command to be available:
• The source and destination drawing must be open, and neither of these
drawings can be read-only.
• The drawing objects to be moved must be selected.
• The selected items must not have a connection to any items outside the
select set.
• You must have the appropriate permissions to modify the items in the
select set.
If more than one possible destination drawing is open, the Move To Drawing dialog
box appears, and you can select the appropriate destination drawing.
The Move To Drawing command manipulates the select set in order to make sure the
selected items are appropriate items to move. The command removes these objects
from the select set:
• Inserted OLE objects are automatically removed from the select set.
• Title blocks are automatically removed from the select set.
• If there is a label in the select set and the item that it labels is not in the
select set, that label is removed.
• If there is a dependent object (such as a nozzle, equipment component,
actuator, or item note) in the select set, and if the parent object that it is
dependent upon is not in the select set, it is removed.
The command expands the select set to include the following objects:
• If there are labels that are not in the select set but are attached to objects in
the select set, these labels are automatically added to the select set.
• If there are dependent objects (such as a nozzle, equipment component,
actuator, or item note) not in the select set but they are dependent on
objects in the select set, these objects are automatically added to the select
set.
OPCs cannot be moved from one drawing to another using this command.
Related Topics
• Modifying and Moving Placed Items: An Overview, page 206
• Move a Select Set to Another Open Drawing, page 213
Available drawings - Lists the open drawings that are available to be a destination
for the Move To Drawing command. Those drawings that are not included in the list
are the source drawing, open read-only drawings, open drawing templates, and open
assemblies.
Related Topics
• Move a Select Set to Another Open Drawing, page 213
• Move To Drawing Command, page 212
• You must have the appropriate permissions to modify the items in the
select set.
• Since you have to switch to a different drawing, the Undo command is not
available for moving a select set to another drawing.
• Logical relationships are preserved (for example, loop or package
relationships or plant group relationships). Also, if a logical group such as
an instrument loop, whose members are all moved to the new drawing,
resides in the source drawing stockpile, then that logical group moves to
the stockpile of the destination drawing.
• OPCs cannot be moved from one drawing to another using this command.
Related Topics
• Modifying and Moving Placed Items: An Overview, page 206
The software also searches your drawing for inconsistency indicators so that you can
review and correct inconsistencies systematically.
Replacing drawing items is straightforward, too. You have the capability to replace a
single drawing item with a comparable item, replace many items one-by-one, or even
replace all items of one type at the same time.
When you find or replace drawing items, the selected items are added to a select set,
and so you can view the common properties of the select set items in the Properties
window and edit them if appropriate.
The Find and Replace commands are not available in the Engineering Data Editor.
Related Topics
• Find a Drawing Item by Using a Catalog Item, page 216
• Find an Item by Using a Filter, page 216
• Find an Item by Using an Existing Drawing Item, page 217
• Find Drawing Inconsistencies, page 215
• Replace a Single Drawing Item, page 218
• Replace Multiple Drawing Items Using Catalog Items, page 219
Find Command
Edit > Find
Displays the Find and Replace dialog box, which allows you to search a drawing for
items by using catalog items or a filter or to find inconsistencies in your drawing. As
drawing items are found, they are added to a select set. You can replace items by
using the options on this dialog box, too.
Related Topics
• Find a Drawing Item by Using a Catalog Item, page 216
• Find an Item by Using a Filter, page 216
• Find an Item by Using an Existing Drawing Item, page 217
• Find Drawing Inconsistencies, page 215
• Finding and Replacing Drawing Items: An Overview, page 214
• Use the Direction options to change the order in which single drawing
items are found.
Related Topics
• Finding and Replacing Drawing Items: An Overview, page 214
Replace Command
Edit > Replace
Displays the Find and Replace dialog box, which allows you to replace some or all
of the drawing items that match the search criteria defined by the options on the Find
tab.
Related Topics
• Finding and Replacing Drawing Items: An Overview, page 214
• Replace a Single Drawing Item, page 218
• Replace an Item Using Replace Mode, page 220
• Replace Multiple Drawing Items Using Catalog Items, page 219
• Replace Multiple Drawing Items Using Filters, page 218
Tip
• Selecting Active window disables the Scroll mode option. Selecting
Active Document enables the Scroll mode option.
7. Click Find to search for and select the first match and to make the Replace All
button available.
8. Click Replace All to replace all instances of the selected drawing item with the
item defined in the Replace with box.
Note
• Use the Scroll mode options to control how the Drawing view changes
when a drawing item is found.
Related Topics
• Finding and Replacing Drawing Items: An Overview, page 214
• Replace a Single Drawing Item, page 218
• Replace Multiple Drawing Items Using Catalog Items, page 219
Controls whether catalog items are placed as substitutions for existing drawing items
or placed normally. When this mode is active, the software places catalog items only
when they replace an existing drawing item. When this mode is not active, the
software places catalog items as usual. The Replace Mode command copies
properties of the current item onto the new item.
The Replace Mode command works for like objects only. The item that you want to
replace in the drawing must be of the same class: equipment class, instrument class,
and so forth. For instance, you can replace a vessel with another vessel, but you
cannot replace a vessel with a pump. The software also takes into consideration the
connect points that are in use on the currently placed item. This stipulation means you
cannot replace an angled item for a straight item when the straight item is already
connected at both ends. For example, you cannot replace a Flanged Nozzle with an
Angle Parametric Nozzle if the nozzle is already connected to a pipe run, likewise for
angled valves. Replace Mode also works on parametrics. Resizing is maintained
during the replace if both symbols have an identical relative path.
The Replace Mode functions very much like Edit > Replace. However, the replace
mode works for only one item at a time and is not activated from inside a dialog box.
You cannot use the Replace Mode for pipe runs or signal lines. You also cannot use
this mode to replace items that are multiple representations. If you need to replace
pipe runs or signal lines, use the the Edit > Replace command.
Related Topics
• Cutting or Deleting Items: An Overview, page 232
• Finding and Replacing Drawing Items: An Overview, page 214
• Place Multiple Representations, page 142
• Replace an Item Using Replace Mode, page 220
• Replace Command, page 217
Tips
• The Replace Mode command works for like objects only. The item
that you want to replace in the drawing must be of the same class:
equipment class, instrument class, and so forth. For instance, you can
replace a vessel with another vessel, but you cannot replace a vessel
with a pump.
• The software also takes into consideration the connect points that are
in use on the currently placed item. This stipulation means you cannot
replace an angled item for a straight item when the straight item is
already connected at both ends. For example, you cannot replace a
Flanged Nozzle with an Angle Parametric Nozzle if the nozzle is
already connected to a pipe run, likewise for angled valves.
• If the drawing item can be replaced with the catalog item, the replace
icon is displayed, and the drawing item is selected.
4. When the replace icon appears, click to replace the drawing item with the
selected catalog item.
5. Continue to replace more items with your currently selected catalog item, or press
Esc to quit placement mode.
6. Click Tools > Replace Mode again to turn Replace Mode off.
Notes
• You cannot use the Replace Mode option for pipe runs or signal lines.
You also cannot use this mode to replace items that are multiple
representations.
• The Replace Mode command also copies properties of the current item
onto the new item.
Related Topics
• Cutting or Deleting Items: An Overview, page 232
• Finding and Replacing Drawing Items: An Overview, page 214
• Place Multiple Representations, page 142
• Selecting Drawing Items: An Overview, page 132
Note
• The Replace command does not allow a non-breaking component to be
replaced with a break component. Piping components and instruments can
be defined in the catalog as break components. Reducers are good
examples of break components. When a break component is placed into a
pipe run, the pipe run is automatically broken at that point. A break
component suppresses the consistency checking and limits the propagation
of the properties that are broken. The Property Breaks command in the
Catalog Manager is used to define a catalog item as a break component.
Related Topics
• Find a Drawing Item by Using a Catalog Item, page 216
• Find Command, page 68
• Find Drawing Inconsistencies, page 215
• Replace a Single Drawing Item, page 218
• Replace Command, page 217
Find what - Lists search criteria, and allows you to enter new search criteria or select
from a list of the five most recently used criteria. The items listed above the dashed
line in the list are used to set new search criteria by searching using the Catalog
Item, Filter, or Inconsistency options. Selecting the Catalog Item option opens the
Select Catalog Item dialog box. Selecting the Filter option opens the Select Filter
dialog box.
Search in - Defines the scope of the search. You can search the active drawing or just
the contents of the active window. If the Active Window option is selected, the
Scroll mode feature is not available. If the Active Drawing option is selected, the
Scroll mode feature is automatically set to Zoom, and you can select a preferred
scroll mode.
Scroll mode - Defines how the active view should be changed when a drawing item
is found. If you select Zoom, the active view is zoomed to a multiple of the range of
the found drawing item. If you select Pan, the active view is shifted without changing
the view scale so that the center of the drawing item is in the center of the view. If
Scroll Mode feature is turned off, then the active view is left unchanged.
Direction - Specifies the direction of the search. Because drawing objects are stored
linearly in the database, using either Next or Previous moves forward or backward
through the document.
Find - Initiates a search for a single item that is part of the specified search scope.
Each time you click Find, the software searches for and highlights the next drawing
item that matches the defined search criteria in the defined direction. Each time a item
is found that matches the Find what criteria, the active view is changed based on the
Scroll mode setting.
Find All - Initiates a search for all items matching the search criteria and adds them
to the select set. The active view is updated based on the Scroll mode setting.
Related Topics
• Find a Drawing Item by Using a Catalog Item, page 216
• Find an Item by Using a Filter, page 216
• Find an Item by Using an Existing Drawing Item, page 217
• Find Command, page 68
• Find Drawing Inconsistencies, page 215
• Replace Command, page 217
Find what - Lists search criteria, and allows you to enter new search criteria or select
from a list of the five most recently used criteria. The items listed above the dashed
line in the list are used to set new search criteria by searching using the Catalog
Item, Filter, or Inconsistency options. Selecting the Catalog Item option opens the
Select Catalog Item dialog box. Selecting the Filter option opens the Select Filter
dialog box. Since you cannot replace an inconsistency, if you select the
Inconsistency option from the Find what list, the Replace with option is not
available.
Replace with - Allows you to enter a new replacement item or select a replacement
item from a list of the five most recently used items, which are listed below the
dashed line. You can define a new replacement item by selecting Browse and picking
a catalog item from the Select Catalog Item dialog box.
Search in - Defines the scope of the search. You can search the active drawing or just
the contents of the active window. If the Active Window option is selected, the
Scroll mode feature is not available. If the Active Drawing option is selected, the
Scroll mode feature is automatically set to Zoom, and you can select a preferred
scroll mode.
Scroll mode - Defines how the active view should be changed when a drawing item
is found. If you select Zoom, the active view is zoomed to a multiple of the range of
the found drawing item. If you select Pan, the active view is shifted without changing
the view scale so that the center of the drawing item is in the center of the view. If
Scroll Mode feature is turned off, then the active view is left unchanged.
Direction - Specifies the direction of the search. Because drawing objects are stored
linearly in the database, using either Next or Previous moves forward or backward
through the document.
Find - Initiates a search for a single item that is part of the specified search scope.
Each time you click Find, the software searches for and highlights the next drawing
item that matches the defined search criteria in the defined direction. Each time a item
is found that matches the Find what criteria, the active view is changed based on the
Scroll mode setting.
Replace - Replaces the item selected when you clicked Find. The Replace button is
available only when the item found can be replaced by the item defined in the
Replace with box. Each time you click Replace, the located item is replaced, and the
Find command continues based on the Direction setting. As each drawing item is
found, the active view is updated based on the Scroll mode setting.
Replace All - Replaces all items that match the Find what criteria with the item
defined in the Replace with box without prompting you. After all of the replacements
are completed, the software reports the number of matches found and the number of
replacements that were made. The active view is also updated depending on the
Scroll mode setting.
Related Topics
• Find Command, page 68
• Replace a Single Drawing Item, page 218
• Replace Command, page 217
• Replace Multiple Drawing Items Using Catalog Items, page 219
• Replace Multiple Drawing Items Using Filters, page 218
Tree View - Displays a hierarchy of nodes that contain catalog items. You can
navigate through the tree view by clicking the different nodes. To open a node, click
the plus sign to the left of the node name. To close a node, click the minus sign to the
left of the node name. If the selected node contains any drawing symbols, the
software displays them in the list view.
List View - Displays the symbols that are associated with the active node in the tree
view. Only the contents of one node appear.
Navigation Bar - Allows you to see and use Catalog Explorer shortcut buttons to
navigate to catalog items more quickly.
Related Topics
• Find a Drawing Item by Using a Catalog Item, page 216
• Find an Item by Using a Filter, page 216
• Find an Item by Using an Existing Drawing Item, page 217
• Find Command, page 68
• Find Drawing Inconsistencies, page 215
• Replace Command, page 217
• The mirror handle allows you to mirror about the horizontal and
vertical axes, defined in relation to the origin of the item. You can mirror
items by dragging the mirror handle in the appropriate direction. The
software shows you the result of the operation dynamically so that you can
be sure to mirror the item correctly.
• The rotate handle provides a mechanism for rotating components
around their origin. You can rotate items by dragging the rotate handle in
the appropriate direction. The software shows you the result of the
operation dynamically so that you can be sure to rotate the item correctly.
• Parametric handles allow you to modify different parts of parametric
items. Standard parametric handles represent up to four driving
dimensions that have been applied to an item. Parametric handles can be
located in four standard positions: top center, bottom center, left center,
and right center of the range of an item. You can scale the item
parametrically by dragging any parametric handle. The software shows
you the result of the operation dynamically so that you can be sure to scale
the item correctly.
• Scale handles allow you to change the scale of a drawing item. A
scalable symbol displays four solid square scale handles. A handle is
displayed at each corner of the range of the symbol. You can drag any one
of the handles, and the symbol scales either larger or smaller depending on
the direction that you drag the handle.
Not all drawing items in can be mirrored, rotated, or scaled. Catalog Manager defines
these properties for items when the symbols for the items are created. Note also that
select sets cannot be mirrored or rotated with component handles. The Mirror and
Rotate commands on the toolbar can be used for select sets.
Related Topics
• Mirror an Item About an Existing Mirror Axis or Linear Element, page
229
• Mirror an Item Using Its Mirror Handle, page 228
• Rotate an Item About an Axis You Define, page 231
• Rotate an Item Using Its Rotate Handle, page 231
• Scale a Drawing Item, page 226
• Scale a Parametric Item, page 226
Related Topics
• Manipulating Items With Component Handles: An Overview, page 225
• Modifying and Moving Placed Items: An Overview, page 206
Mirror Command
Edit > Mirror
Reflects one or more selected items about a line or axis that you define. You can
mirror without copying, or mirror and copy.
To mirror an item using a defined mirror axis, click Mirror on the main toolbar.
The software reflects one or more selected items about that axis. You can mirror the
item itself, or you can make a copy of the item in the mirrored position.
You can also use mirror handles. The mirror handle appears at the upper right of
the item. For example, dragging a mirror handle across an x- or y-axis causes the item
to appear mirrored about its center.
Mirroring is displayed dynamically so that you can see the result of your action
before you release the item to place it.
Related Topics
• Mirror an Item About a Mirror Axis That You Define, page 228
• Mirror an Item About an Existing Mirror Axis or Linear Element, page
229
• Mirror an Item Using Its Mirror Handle, page 228
Mirror Ribbon
Appears on the main toolbar when the Mirror command is active, and allows you to
either specify mirroring options or to observe mirroring options.
Position Angle - Sets the angle of the mirror axis. The origin of the angle
measurement is the point that you clicked for the beginning of the mirror axis. Setting
the position angle to zero extends the axis horizontally to the right of the screen, 90
extends the axis vertically to the top, 180 extends the axis horizontally to the left, and
270 extends the axis vertically to the bottom.
Note
• To determine the option name on the ribbon, pause over an option and
read the ToolTip.
Related Topics
• Mirror an Item Using Its Mirror Handle, page 228
• Mirror Command, page 227
Related Topics
• Copying Items: An Overview, page 239
• Modifying and Moving Placed Items: An Overview, page 206
Rotate Command
Edit > Rotate
Rotates one or more items a precise distance or angle about a specified point.
To rotate and item, select the item and then click Rotate. To define the rotation axis,
you must specify two points by clicking in the drawing.
The software then dynamically displays a reference axis for the rotation. If you want
to define a precise location for the rotation, you can enter values in the Rotate ribbon.
You can enter increments in the Step Angle box if you want to control the increments
of the rotation. For example, if the box is set to 30.0, the rotation is displayed in 30
degree increments. The default setting is 0 degrees so that the rotation is fully
dynamic, that is, it can take on any value. The Rotation Angle box on the ribbon
displays the angle of change between the old and new position. Angles are always
displayed as a positive value.
Also, you can rotate an item about its center with the rotate component handle .
Keeping the rotate component handle close to the center of an item causes the item to
rotate at 90 degree increments. Dragging the rotate component handle further away
from the center of the item causes the item to rotate at smaller angles. The angle
increments become smaller the farther away your pointer is from the center of
rotation.
Related Topics
• Rotate an Item About an Axis You Define, page 231
• Rotate an Item Using Its Rotate Handle, page 231
Rotate Ribbon
Appears when the Rotate command is active, and allows you to either observe
rotation options as you rotate an item or specify rotation options.
Position Angle - Displays the angle between the horizontal axis through the center of
rotation (A) and the point that you rotate from (B). Then, if you rotate the item, the
position angle (C) changes to become the angle between the horizontal axis and the
point to which you rotate. The position angle is always a positive value measured
counter-clockwise from the axis.
Rotation Angle - Defines the rotation angle. The rotation angle is the angle between
the point from which you rotate and the point to which you rotate. In the following
picture, the center of rotation (A) shows the point (B) from which you rotate the item.
The rotation angle (C) is the angle of change between the old and new positions of the
rotated item. The value is always positive.
Step Angle - Specifies the rotation step angle. The step angle specifies the
increments, in degrees, that an item rotates on a rotation axis. You can enter
increments in the Step Angle box. For example, if the box is set to 30.0, the rotation
is displayed in 30 degree increments. The efault setting is 0 degrees so that the
rotation is fully dynamic.
Related Topics
• Rotate an Item About an Axis You Define, page 231
• Rotate an Item Using Its Rotate Handle, page 231
• Rotate Command, page 229
Notes
• To rotate by arbitrary increments, type a value in the Step Angle box on
the Rotate ribbon.
• In order to copy the rotated items into the new position, you can hold Ctrl
while you click to define the to point.
• You can use other view manipulation commands, such as Zoom and Pan,
while you are using the Rotate command. When you finish manipulating
the view, the software returns you to the Rotate command at the point that
you were when you started manipulating the view.
Related Topics
• Copying Items: An Overview, page 239
• Selecting Drawing Items: An Overview, page 132
The properties of an item affect what happens when you cut or delete it. If the item
has a TagReqdFlag property of True, which you set in Catalog Manager, and is
included in the StockpileItems group, which you set in Options Manager, cutting or
deleting the item from the drawing places the item in the Stockpile. The data
associated with the item remains in the database. If the TagReqdFlag property is
False, when you cut or delete the item, it is removed from the database as well as the
drawing.
Notes
• You can press Delete on the keyboard to remove an item or a select set
from the drawing. First, select the item or group of items in the drawing.
Then you must point to the Drawing view before you press Delete. The
software does not delete the item or group of items if the pointer is located
anywhere outside the Drawing view.
• You can delete an item by selecting and right-clicking it. On the shortcut
menu click Delete. If you select Delete from Model, the selected item is
not only deleted from the drawing but also from the database. In other
words, it is not placed in the Stockpile, regardless of its properties.
• Deleted stockpile items automatically go into the Stockpile. You can move
an item into the stockpile of a specific drawing. For more information, see
Move a Stockpile Item to the Stockpile of Another Drawing, page 250.
Related Topics
• Cut an Item from the Drawing, page 233
• Delete an Item from the Drawing, page 236
• Move a Stockpile Item to the Stockpile of Another Drawing, page 250
• Remove an Item from a Drawing, page 237
• Remove an Item from the Model, page 238
Cut Command
Edit > Cut
Cuts selected items from the drawing and pastes them to the Clipboard. The selected
items replace the previous contents of the Clipboard. When you cut items, they go to
the Stockpile, given appropriate stockpile settings.
Related Topics
• Cut an Item from the Drawing, page 233
• Cutting or Deleting Items: An Overview, page 232
• Selecting Drawing Items: An Overview, page 132
Related Topics
• Cutting or Deleting Items: An Overview, page 232
• Linking and Embedding Objects: An Overview, page 266
• Move a Stockpile Item to the Stockpile of Another Drawing, page 250
Paste Command
Edit > Paste
Inserts the Clipboard contents at the specified location. The command is not available
if the Clipboard is empty.
Related Topics
• Cutting or Deleting Items: An Overview, page 232
• Paste an Item With a Different Format, page 273
• Paste an Item, page 234
Paste an Item
1. Open the drawing in which you want to paste the contents of the Clipboard.
2. On the main toolbar, click Paste or right-click a blank area in the drawing and
then select Paste.
Notes
• The contents of the Clipboard remain unchanged until you use the Copy
or Cut command again.
• Equipment components cannot be pasted back into the drawing after they
have been removed using the Cut command.
• You cannot paste items if the Clipboard is empty (that is, if you have not
previously used the Copy or Cut commands).
• Pasted text and items remain selected after you use the Paste command.
Related Topics
• Cutting or Deleting Items: An Overview, page 232
Note
• You can also access this command by right-clicking a blank area in a
drawing or table. On the shortcut menu that displays, click Select All.
Related Topics
• Select an Item, page 135
• Selecting Drawing Items: An Overview, page 132
Related Topics
• Manipulating Items With Component Handles: An Overview, page 225
• Selecting Drawing Items: An Overview, page 132
Delete Command
Edit > Delete
Removes the selected item. You cannot paste items that you delete; however, if the
item moves to the Stockpile on deletion, then you can place that item again from the
stockpile.
Notes
• The properties of an item affect what happens when you cut or delete it. If
the item has a TagReqdFlag property of True, which you set in Catalog
Manager, and is included in the StockpileItems group, which you set in
Options Manager, cutting or deleting the item from the drawing places the
item in the Stockpile. However, the data associated with the item remains
in the database. If the TagReqdFlag property is False, when you cut or
delete the item it is removed from the database as well as the drawing.
Deletes the selected item from the database; if you are deleting a connector, then its
partner is deleted from the stockpile as well.
Notes
• Unlike the standard Delete command, which moves the selected item to
the Stockpile, this command removes the selected items or connector and
its partner from the model completely.
• In the case of the connector, the command is not available unless the
partner connector is in the Stockpile.
Related Topics
• Delete a Connector From the Model, page 195
• Using Off-Page and Utility Connectors: An Overview, page 187
• The properties of an item affect what happens when you cut or delete it. If
the item has a TagReqdFlag property of True, which you set in Catalog
Manager, and is included in the StockpileItems group, which you set in
Options Manager, cutting or deleting the item from the drawing places the
item in the Stockpile. However, the data associated with the item remains
in the database. If the TagReqdFlag property is False, when you cut or
delete the item it is removed from the database as well as the drawing.
• When you delete inline components, the software automatically mends the
pipe or signal run.
• Deleted stockpile items automatically go into the Pant Stockpile. You can
move an item into the stockpile of a specific drawing. For more
information, see Move a Stockpile Item to the Stockpile of Another
Drawing, page 250.
Related Topics
• Modifying and Moving Placed Items: An Overview, page 206
• Move a Stockpile Item to the Stockpile of Another Drawing, page 250
• Remove an Item from a Drawing, page 237
Remember that placement rules are in effect when you are copying an item to a new
location, just as they are when you originally place an item from a stockpile or from
Catalog Explorer. So a copied nozzle must be placed on a piece of equipment, for
instance.
Related Topics
• Copy an Item With the Select Tool, page 240
• Copy an Item, page 240
• Paste an Item With a Different Format, page 273
• Paste an Item, page 234
• Rotate an Item About an Axis You Define, page 231
Copy Command
Edit > Copy
Copies selected items to the Clipboard. This command replaces the previous contents
of the Clipboard with the new contents.
Related Topics
• Copy an Item With the Select Tool, page 240
• Copy an Item, page 240
• Cutting or Deleting Items: An Overview, page 232
Copy an Item
1. Select an item.
2. On the main toolbar, click Copy .
Notes
• After you copy an item, it is placed on the Clipboard. Then you can use
Paste to place it on the current drawing. When you paste the item, the
software frequently pastes it on top of the item that you copied. To see the
pasted item, drag it to its new location in the drawing.
• You can copy an item with the Move command,too. Select the item, click
Move on the toolbar, and press Ctrl as you place the item in the
drawing. You can do the same with a select set.
Related Topics
• Copying Items: An Overview, page 239
• Linking and Embedding Objects: An Overview, page 266
• Selecting Drawing Items: An Overview, page 132
Related Topics
• Copying Items: An Overview, page 239
• Selecting Drawing Items: An Overview, page 132
This functionality is useful for finding branches from runs and finding all the runs and
components on an entire drawing that have a common property value.
Once the items are selected in the drawing, it is then a simple matter to choose the
select set in the Properties window and continuing editing properties for not only
runs, but also lines and networks and all runs included in the drawing.
Note
• The properties that define a run are specified in Options Manager.
Related Topics
• Create a Select Set From a Line, page 243
• Customize the Properties Window, page 85
• Select an Item, page 135
Opens the Select Connected Items dialog box, which allows you to create a select
set that includes the active line and disconnected lines and inline components in any
network. This command is available only when either a single line segment or a
single component is selected on the drawing; however, once the dialog box is open,
you can change the selected item in the drawing and change the scope of the select set
freely.
Related Topics
• Create a Select Set From a Line, page 243
• Routing Lines: An Overview, page 144
• Select an Item Using the Configuration (PickQuick) Tool, page 136
• Selecting Connected Items: An Overview, page 241
• Selecting Drawing Items: An Overview, page 132
Scope - Provides options for defining the extent of your select set. The Scope List
allows you to choose extent, and the Include Runs and Include Components buttons
allow you to incorporate different items into the select set. At no time can neither the
Include Runs nor Include Components buttons be selected; that is, one or the other
or both is always active.
Scope List - Allows you to choose from Run, Line, Network, Drawing. The default
value for this list is Line.
Notes
• The Run option means that lines in a single run are selected. The Line
option selects runs that are connected at end points, including components.
The Network option adds branches, and the Drawing option selects all
the runs and inline components in the open drawing.
Include Runs - Incorporates lines into the select set.
Matching Properties - Displays options for defining the select set according to
common properties. The properties for the originally selected item are displayed by
default.
Preview - Highlights in the Drawing view the items that are selected according to
common properties in the Properties List of this dialog box.
Properties List - Allows you to choose common properties for your select set. You
can select more than one property in this list by using the Ctrl or Shift keys.
Related Topics
• Create a Select Set From a Line, page 243
• Select an Item, page 135
• Select Connected Items Command, page 241
Once you have populated the properties of an item you can, for instance, run reports
that display the items and their properties, or create filters and control Drawing views
so that only items with specified properties are displayed, or label items so that their
properties are displayed graphically.
Related Topics
• Copy Bulk Properties, page 87
• Import Aspen Zyqad Stream Data, page 329
• Modify an Item With the Select Tool, page 235
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 56
• Paste Bulk Properties, page 88
• Review and Edit Item Properties, page 86
• Working With the Properties Window: An Overview, page 83
Description - Allows you to type a description for the item. This box can contain a
link to a Web address, formatted like this: http://www.intergraph.com. You can also
link to a file on your file system by entering the UNC path like this:
file://servername/sharename/directory/document.extension.
Note
• Very long descriptions are not displayed in their entirety in labels, reports,
and so forth.
Related Topics
• Properties Window Command, page 84
• Review and Edit Item Properties, page 86
Description - Allows you to type a description for the item. This box can contain a
link to a Web address, formatted like this http://www.intergraph.com. You can also
link to a file on your file system by entering the path like this:
file://UNC_path/share/document.extension.
Note
• Labels do not display very long descriptions in their entirety.
Related Topics
• Properties Window Command, page 84
• Review and Edit Item Properties, page 86
Matching - Lists all insulation specifications that match any already chosen values,
such as Insulation Type or Insulation Purpose.
All - Lists all the insulation specifications in the plant insulation specification file.
Note
• The path to the plant insulation specification file is defined in Options
Manager. Any modifications to insulation specifications are carried out in
Insulation Specification Manager.
Related Topics
• Assign an Insulation Specification, page 247
Description - Allows you to type a description for the item. This box can contain a
link to a Web address, formatted like this: http://www.intergraph.com. You can also
link to a file on your file system by entering the path like this:
file://UNC_path/share/document.extension.
Note
• Very long descriptions are not displayed in their entirety in design labels.
Description - Allows you to type a description for the item. This box can contain a
link to a Web address, formatted like this: http://www.intergraph.com. You can also
link to a file on your file system by entering the path like this:
file://UNC_path/share/document.extension.
Note
• Labels do not display very long descriptions in their entirety.
Related Topics
• Place an Inline Instrument, page 163
• Review and Edit Item Properties, page 86
File Name - Specifies the file from which stream data is imported. You can click
Browse to find the file on your computer or the network. Stream data is generally
imported from an Aspen Zyqad stream data file.
Stream ID List - Lists the values found in the text file specified in the File Name
box.
Related Topics
• Import Aspen Zyqad Stream Data, page 329
• Populate the Stockpile from a Spreadsheet, page 252
You view the items in a stockpile in the Engineering Data Editor (EDE). In
particular click Stockpile to view items in the Stockpile, or click Active Drawing
Stockpile to view items in the stockpile of the active drawing. Be sure that the
other item buttons on the Engineering Data Editor toolbar (that is, the Active
Drawing or Other Drawings buttons) are not active when you want to view
stockpile items alone.
In the EDE, the Actions menu contains the commands for manipulating stockpile
items. These commands make it possible to place or move or delete stockpile items.
You can also access some of these commands from the Engineering Data Editor
shortcut menu, which opens when you right-click in the EDE.
You have the capability to place an item from a stockpile directly onto an open
drawing. You enter placement mode when you click the icon associated with a
stockpile item in the left-most column of the EDE.
You can import items into the Stockpile, too, by importing reports with the File >
Import > Data File command on the main toolbar.
Related Topics
• Move a Stockpile Item to the Stockpile of Another Drawing, page 250
• Place an Item from the Stockpile, page 250
• Place Multiple Representations, page 142
• Populate the Stockpile from a Spreadsheet, page 252
Tree view - Allows you to navigate in the plant hierarchy in order to display the
drawing into which stockpile you want to move the selected item.
List view - Displays a list of available drawings that can accept the selected stockpile
item.
Related Topics
• Move a Connector to Another Stockpile, page 192
Related Topics
• Navigating in the Engineer Data Editor: An Overview, page 41
Also, you can use a report to import information for items that already exist in the
database. You must first run the report, add or edit property values for the items
returned in the report, and then import the items back into the drawing. The property
values for the items are updated. Valid reports are Equipment List, Equipment Nozzle
List, and Pipe Run List.
Tag Description
<?xml version="1.0"?> Identifies the XML file and the version used
<Preamble> Ignored by SmartPlant P&ID
<Items> Indicates beginning of the list of all item types and
properties to be imported, and must have
corresponding </Items> tag
</Identification> Defines Classification and Symbol File: Classification
- Database Item Type, Symbol File - Path to symbol to
be created in stockpile
<ContextSpecificIdentifier Ignored by SmartPlant P&ID.
ContextId
<Item Attributes> Indicates the beginning of the list of properties to be
imported for the item type
Tag Description
<Item Attribute> Imported property for the item type: AttributeName -
Derived from the Data Dictionary Manager property
name, not the display name, and must be in double
quotes; Attribute Value - Must be in double quotes,
and specify the actual value, not the index number,
even for select-listed values; AttributeUnits - Specify
if the property has units of measure, and must be a
valid format; ITEMTAG - must be one of the
properties listed.
Notes
• The log file for import activities is called SPImport.log and is saved to
your local Temp directory.
• For examples of importing pumps into the database using the Equipment
List, click Related Topics.
Related Topics
• Add an Item to the Stockpile from Catalog Explorer, page 67
• Generate a Report, page 334
• Import Aspen Zyqad Stream Data, page 329
• Modify a Pump by Importing a SmartPlant P&ID Report into the
Stockpile, page 254
• Populate the Stockpile from a Spreadsheet, page 252
Notes
• Aspen Zyqad spreadsheets in either Microsoft Excel or XML format are
supported. These spreadsheets include the Vessel Equipment List, Pump
Equipment List, and Heat Exchanger Equipment.
• Stockpile items that come from importing Aspen Zyqad data can be easily
updated by re-importing a data file. Previously imported items, whether
they remain in the stockpile or have already been placed in the drawing,
are updated with data from the newly imported file.
• Importing Aspen Zyqad XML data files allows greater flexibility when
importing data into the software. All three reports, Equipment, Pumps, and
Exchangers, are included in a single XML report so that only one file has
to be imported.
• You can use the Equipment List, Pipe Run List, and Equipment Nozzle
List Reports from SmartPlant to define properties of items already placed
in the drawing, too. Items must have an assigned item tag prior to
definition or modification of properties. In addition, these reports can
create occurrences of items in the stockpile.
• See the SmartPlant P&ID Programmer's Guide Help file for more
information on import code and other importing parameters. Click Help >
Programming with SmartPlant P&ID.
Related Topics
• Using Reports to Import Items into the Stockpile, page 251
You can either turn auto-gapping on, and the software gaps your lines automatically
as you route them, or you can choose when the software performs gapping on your
drawing by using the Gap Now command. Using the Gap Now command, instead of
turning on auto-gapping, can increase the efficiency of your design session.
Symbology and priority for your line gaps is set in Options Manager.
Related Topics
• Add a Manual Gap to a Line, page 151
• Perform Line Gapping in Your Drawing Now, page 256
• Turn AutoGap On or Off, page 256
AutoGap Command
Tools > AutoGap
Turns automatic gapping on or off in the drawing. Gapping refers to the condition
that exists when two lines intersect graphically on the drawing but do not physically
intersect in the plant.
When AutoGap is on, the software automatically gaps drawings during the working
session each time that you modify an item, when you print, or when you save a file. A
progress indicator at the bottom of the window alerts you to avoid selecting another
command while the software completes the gapping. The Gap Now command does
not affect the setting for AutoGap.
When AutoGap is off, the software does not automatically gap drawings. By default,
automatic gapping is off.
Notes
• Using Gap Now, instead of leaving AutoGap on, improves the
performance of the software.
• The toolbar contains an AutoGap button for turning AutoGap on and
off.
Related Topics
• Gapping Lines: An Overview, page 255
• Turn AutoGap On or Off, page 256
Tip
• You can turn the automatic gapping on or off by clicking AutoGap on
the main toolbar, too.
Notes
• When you route lines and AutoGap is on, gaps appear automatically.
• The status bar at the bottom of the window alerts you to avoid selecting
another command while the software completes the gapping.
Related Topics
• Routing Lines: An Overview, page 144
Performs gapping on the current drawing, that is, on the entire drawing. Gapping
refers to the condition that exists when two lines intersect graphically on the drawing
but do not physically intersect in the plant. Using the Gap Now command does not
affect any setting for the AutoGap command.
Related Topics
• Gapping Lines: An Overview, page 255
• Turn AutoGap On or Off, page 256
Notes
• Using the Gap Now command does not affect any setting for the
AutoGap command.
• Using Gap Now instead of leaving AutoGap on improves the
performance of the software.
Related Topics
• Gapping Lines: An Overview, page 255
• Routing Lines: An Overview, page 144
Note
• System Editing is not supported from or to plant item groups such as loops
and packages.
When a new item is placed from the Catalog or the Stockpile or an existing item is
modified, creating a new relationship, property values flow across the new
relationship as specified in the rules. The flow of property values is as follows.
• Properties - The properties that can flow across this relationship are those
that are listed as consistency criteria in all of the applicable rules.
• Copy and Propagate - A property value can be copied in either direction
across the new relationship and is propagated outward.
• For new items, existing values are not overwritten by this process unless
one item contains a Null property value. For example, if different nominal
diameter values exit on both sides of a new connection, the existing
nominal diameter values are not automatically changed to match unless
one of the values is set to Null.
When a directional property, for example, Flow Direction and Slope Direction, is
propagated, it is not enough to set the same value on all items the propagation scope.
The direction of the underlying geometry must be compared to the direction of the
geometry of the start item. One of the possible property values must be selected
based on the direction of the geometry. In cases where the direction of the geometry
cannot be compared (such as a midpoint branch condition) no propagation is possible.
Rules - The consistency criteria specified in rules define which properties are
propagated and in which direction. The propagations scope can be expanded across a
relationship if there is an applicable rule for the property being modified.
Access Control - When working in a project, the propagation scope only includes
objects that have been claimed.
Break Components - Some components inherently limit the copying and suppress
the consistency checking of certain properties. For example, a reducer is a break
component for the Nominal Diameter property. When changing the Nominal
Diameter in a pipeline, the spread of that change is limited by any reducers that exist
in that pipeline. The consistency checking that would normally be done between the
connected pipes is also suppressed at the reducer.
Break Labels - The consistency criteria specified in the rules define the general
behavior of the properties. Break labels provide a way to define exceptions to the
general rules. A break label provides a visible and plottable symbol that signifies the
end of one property value condition and the beginning of a new condition along a
pipe. A changed property value is never propagated across a break label for that
property. A break label also suppresses consistency checking for the property it
breaks.
A break label can be created for any property or collection of properties of a pipe run.
A break label is created in the Catalog Manager just like any other label, except that
the Label Type property is set to Attribute Break. A SmartText field must be created
for each property that is to be broken. In many cases the graphical shape of the label
indicates which properties are broken. In these cases the Visible flag on the
SmartText is set to False so that the text is not visible. It is also normal to turn the
leader line on within the Catalog Manager so that it is automatically displayed at
placement time. All of the symbols under Piping\Segment Breaks in the delivered
catalog are break labels.
A break label can only be placed at the endpoint of a graphical pipe line where it
connects to a component or a branch point. Furthermore, a break label can only be
placed at a point where the specified properties are listed in the consistency criteria
for the applicable rules. The break label stays attached to the point it was placed on
and cannot be dragged away from it.
If you have a claimed object that is connected to some unclaimed objects, and if you
change a property on the claimed object, propagation will not change the property
value on the the unclaimed objects. The items in the propagation scope are initially
collected using the standard propagation rules. However, all unclaimed items are
removed from the propagation scope before any property values are changed.
Items that are claimed for relationship are treated as unclaimed for the the purpose of
propagation.
Related Topics
• Comparing System Editing to Propagation, page 436
• Enable System Editing, page 261
• System Editing Command, page 260
When System Editing is enabled for a plant, changed property values are
automatically spread or propagated to related items according to the currently defined
consistency criteria. In certain cases, you may want to set a property value on one
item only and not allow it to be propagated to any related items. The System Editing
command (on the Tools menu and the toolbar) allows you to turn off the propagation
functionality temporarily during a design session. After the change has been made,
you can use this same command to turn it back on again. System Editing is always
turned on when you start a new design session.
System Editing can be enabled or disabled for the entire plant by means of the Enable
System Editing setting that is exposed through Options Manager. For new plants, the
value of this setting is True by default. For upgraded plants, the value of this setting is
False. This allows you to enable System Editing for an upgraded plant at the time of
your choosing.
Related Topics
• Enable System Editing, page 261
• System Editing: An Overview, page 257
Note
• System editing can be turned on/off for an entire plant or for a single
design session.
Related Topics
• System Editing Command, page 260
• System Editing: An Overview, page 257
To remove the results displayed by selecting the Apply Display Set command, select
View > Clear Display Set.
Note
• Any display tabs created in previous versions of SmartPlant P&ID can be
converted to a display set using the macro UpgradeTabsCMD.dll. The
new display set will display in My Display Sets folder.
r- Adds an empty folder to the Tree. You can use Rename to define a name for
the folder. These folders can be used to organize display sets.
- Creates a new display set. You can use Rename to define a name for the new
display set.
- Displays the Select Filter dialog box. Select any displayed filter to add it to
the current display set.
- Allows you to move the selected filter name down in the list.
Filter Name - Displays a list of filter names. These filters are defined using the Add
Filter command.
Color - Displays the color of the selected item for your display set. You can click in
the Color field to display a color palette and then select any color to define a new
color for any selected item(s). The default color square is defined with the crosshatch
pattern.
Width - Displays the selected display width of items defined in the selected filter. A
wider display width would cause the item to be more visible.
Related Topics
• Page Setup Command, page 368
• Set up a Page Layout, page 369
The symbology and other settings defined in Options Manager usually take effect
only in those drawings created after those values are defined. You can force changes
in Options Manager to appear in the current drawing by updating Options Manager
settings, regardless of when the drawing was created.
Notes
• Any user can update drawings using these commands. However, check
your permissions, which are assigned in SmartPlant Engineering Manager,
to find out if you can make changes to the plant-wide symbology in
Options Manager.
• Once you load the current plant-wide definitions into your drawing, you
cannot revert to previous definitions. However, you can always override
plant-wide symbology choices in your drawing by using drawing filters
and choosing alternate symbology for items.
Related Topics
• Update Label Settings, page 178
• Update Line Settings, page 265
• Update Symbology, page 265
Updates the line width and color symbology for your active drawing. Redefining
symbology in Options Manager usually affects only drawings created after the
change. The Update Symbology command makes it possible to override this
constraint.
Related Topics
• Update Symbology, page 265
• Updating Options Manager Settings: An Overview, page 264
Update Symbology
1. Open a drawing.
2. Click Tools > Update Symbology.
Notes
• The line width and color symbology for your active drawing is changed to
the most recent symbology defined in Options Manager. You do not have
to update symbology for this drawing again, even if you end your design
session, unless Options Manager symbology changes again.
• Redefining symbology in Options Manager usually affects only drawings
created after the change. The Update Symbology command makes it
possible to override this constraint.
Related Topics
• Updating Options Manager Settings: An Overview, page 264
• Using Filters: An Overview, page 129
For example, you can use Microsoft Word to make a comment and then display the
comment in your drawing, or you can insert a Microsoft Excel worksheet into a
drawing. You can even create a drawing that contains another drawing, notes from
Microsoft Word, and an Excel worksheet.
You can insert information created in another application with one of many methods:
• You can cut and paste an item to delete it from one location and move it to
another location.
• You can copy and paste an item to duplicate it in another location.
• Linking stores data in one location and places a copy with a link in another
location. When you change the original data, the copy can be updated
either automatically or manually.
• Embedding copies information and stores the information in another
document that was created in a different application. If you change the
embedded object, the original information does not change and vice versa.
Linking or Embedding
An object is data from one application that you insert in a drawing. You can link or
embed information between drawings or documents that were created with this
software and OLE software.
Linking stores data in one location and places a copy and a link in another location.
The linked data is stored in the source document itself. When you paste the
information in the destination document with the Paste Link option, a reference point
or box is inserted into the destination document. This box displays the information
that you pasted. When you change the original data, the pasted data is updated either
automatically or manually. You can edit the linked information by opening the source
document. You can insert linked information with the Paste Special command on the
Edit menu. You can link an entire document to another document by inserting the
information with the Insert > Object command on the Edit menu.
Embedding copies data in one document and stores the information in another
document. If you change the copied data, the original information does not change,
and vice versa. You can embed information with the Paste Special command on the
Edit menu. You can embed an entire document inside another document by inserting
the information with the Insert > Object command on the Edit menu.
If you want to keep the document size small, then link the data to another document.
Linked information increases the document size only by the size of the displayed
image, not by the size of the data itself. Linking is also useful when you want to share
information in many different places and set that information to update automatically.
For example, if you want to display a drawing in several different reports that you
created in Microsoft Word, you could link the drawing inside the documents that
contained the reports. Then, later, you could update the drawing by editing it in this
software. Each report would automatically display the results of the drawing updates.
If document size is not an important factor, then use embedding. Embedded objects
make the file size larger.
Embedding is useful when the person viewing the document with the embedded
information does not have access to the software that created the object. The person
can still view the information if it is embedded in the document. For example, if you
wanted to send out several drawings for review, you could embed each drawing into a
Microsoft Word document and send the Microsoft Word document to each reviewer.
Embedded information is also a good choice if the information does not need
updating.
Notes
• If you want to copy the information, and not remove it from its original
location, press Ctrl while dragging.
• On the Paste Special dialog box be sure that you select Paste and not
Paste Link.
• Or if you want to link the object, select Paste Link on the dialog box.
Linking or Embedding an Object
If you want to insert an existing document, you can use Edit > Insert > Object, too.
On the dialog box, select the Create From File option and then enter the name, or
browse to the document. The entire document is embedded into the drawing.
Notes
• If you want to embed the existing object, make sure you have not selected
Link on the dialog box.
• If you want to link the existing object, select Link on the dialog box.
Notes
• You can click commands on a shortcut menu to activate the software that
created the object. To get the shortcut menu, right-click the embedded
object.
• You can type an URL with http syntax in the Description dialog box to
link World Wide Web documents to an item.
• Symbols in drawings usually point to the catalog associated with the
current plant. If items inadvertently point to the wrong catalog, you can
correct this problem by using the CheckFilePathsCmd macro. See
Related Topics for more information.
Important
• Linked or embedded files are not transferred by workshare. You must
transfer those files manually, and they should be located in the same
directory as the drawing files.
Related Topics
• Break a Link, page 276
• Change a Link, page 275
• Check Symbol Paths, page 276
• Edit an Embedded Object, page 275
• Embed a New Object, page 270
• Link or Embed a Previously Existing Object, page 271
Image Command
Edit > Insert > Image
Opens the Insert Image dialog box, where you can embed an image into a drawing.
You can edit the embedded image by double-clicking it.
Related Topics
• Break a Link, page 276
• Change a Link, page 275
• Embed a New Object, page 270
• Link or Embed a Previously Existing Object, page 271
• Linking and Embedding Objects: An Overview, page 266
Embed an Image
1. Click Edit > Insert > Image.
2. On the Insert Image dialog box, browse to the folder and image file that you
want to embed in your drawing.
3. Click OK.
Tip
• A box that is the size of the image appears at the end of the pointer so
that you know where the image fits in the drawing.
4. Move the pointer to the location in the drawing where you want to place your
image and click to place it.
Related Topics
• Linking and Embedding Objects: An Overview, page 266
Object Command
Edit > Insert > Object
Opens the Insert Object dialog box, where you can insert objects into a drawing with
linking or embedding. The difference between linking and embedding is the method
for storing and updating data.
Related Topics
• Break a Link, page 276
• Edit an Embedded Object, page 275
• Embed a New Object, page 270
• Link or Embed a Previously Existing Object, page 271
• Linking and Embedding Objects: An Overview, page 266
Notes
• You can move the object at any time later. For more information, see
Move an Item With the Select Tool, page 209 or Move an Item Using the
Move Button, page 210.
• You can place an object on the Clipboard and then embed it by using Edit
> Paste Special. For more information, see Paste an Item With a Different
Format, page 273.
• You can embed an OLE object, such as a Microsoft Word document or
Microsoft Excel workbook, by dragging the file from Windows into a
drawing, too. With this procedure, you can create a link only to an entire
document; you cannot link to a selection in a document.
• You can link an OLE by dragging a document from the Windows
environment onto the drawing also. You must press the Ctrl + Shift keys
while dragging to link the information. If you do not press these keys, the
information is embedded.
• If you insert a document into the drawing, the terminators, spaces, text,
and styles appear in paper units relative to the source document. This
behavior can cause the dimensions and text to appear very large or small
in the drawing.
• The software creates automatic links by default. An automatic update
occurs when the drawing is opened: if a change is made to the source
document and the drawing is already open, the change does not appear in
the drawing until it is closed and re-opened. The software updates manual
links only at the time you indicate. To change the way the software
updates links, click Edit > Links and specify automatic or manual update
mode for each link.
• In the Description box in the Properties window, you can type an URL
with http syntax to link documents to an Internet item. Click the ellipses
to open the Description dialog box.
Important
• Linked or embedded files are not transferred by Workshare. You must
transfer those files manually, and they should be located in the same
directory as the drawing files.
Related Topics
• Cutting or Deleting Items: An Overview, page 232
• Linking and Embedding Objects: An Overview, page 266
Inserts the Clipboard contents into a drawing with the format that you select in the
Paste Special dialog box.
Related Topics
• Copy an Item, page 240
• Linking and Embedding Objects: An Overview, page 266
• Paste an Item With a Different Format, page 273
Links Command
Edit > Links
Edits or updates links to objects in another document. The Links dialog box opens.
This command lets you manipulate Object Linking and Embedding (OLE) objects.
You can change links for Microsoft Word documents, Excel workbooks, and other
OLE objects.
Caution
• Do not use this command to change a symbol file. If you attempt to
update, change, break or open the source file, serious problems result in
the drawing. Use Catalog Manager to change or update symbols.
Note
• The software does not translate OLE objects that you have linked to your
document when you export a .pid file to a MicroStation® or AutoCAD®
file.
Related Topics
• Edit a Linked Object, page 274
• Linking and Embedding Objects: An Overview, page 266
Related Topics
• Linking and Embedding Objects: An Overview, page 266
• Working with Drawings: An Overview, page 102
Change a Link
1. Select Edit > Links.
2. In the Links dialog box, click the link that you want to change.
3. Click Change Source.
4. In the File Name box, specify the file that you want to change the link to.
Tip
• If you do not see the file that you want to link to, browse to a different
drive or folder.
Note
• If you have other links to the same source file, make sure you update all
links to the new source file.
Caution
• Do not use these procedures to change a symbol file. If you attempt to
update, change, break, or open the symbol source file, serious problems
result in the drawing. Use Catalog Manager to change or update symbols.
Related Topics
• Linking and Embedding Objects: An Overview, page 266
Break a Link
1. Click Edit > Links.
2. Select the link or links that you want to break.
3. Click Break Link.
4. When the software asks you to confirm that you want to break the link, click Yes.
5. Click Close.
Caution
• Do not use this command to edit a symbol file. If you attempt to update,
change, break, or open the symbol file, serious problems result in the
drawing. Use Catalog Manager to change or update symbols.
Related Topics
• Linking and Embedding Objects: An Overview, page 266
Type - Displays the category of the selected element. You cannot edit the type.
Sheet - Displays the name of the drawing sheet that contains the selected element.
You cannot edit the sheet.
Origin - Specifies the coordinates, or location, of an element along the X and Y-axes.
Behavior - Specifies how the SmartFrame reacts to to changes made within its
source. For example, if Fit Reference to Frame is selected and the size of the frame
contents is expanded, the SmartFrame will also resize and attempt to encompass all
the data. Conversely, if you resize the SmartFrame, the data inside is scaled so that it
continues to fit within the frame. If Frame Fixed is selected, the SmartFrame does
not react to changes made within its source, and resizing the frame will not affect the
scale factor of the frame contents; consequently, the frame remains "fixed" in its
original size and position.
Height - Displays the height of the selected SmartFrame. The value in this field is for
display purposes only.
Width - Displays the height of the selected SmartFrame. The value in this field is for
display purposes only.
Link - Determines the way that the object links with a SmartFrame. This option is
available only for linked objects.
As Part of the Model (Public)- Allows the linked object to publicly appear in any
document that links to the current document. Therefore, if you link an object to the
current drawing and then link to the current drawing from another document, the
current drawing and the linked object appear in the other document. For example, this
setting is useful if you link comments from a Word document to the current drawing
and you want other documents to appear in the current drawing with the comments.
As Reference Only (Private)- Restricts the linked object from being displayed in any
document that links to the current document. If the current drawing is linked to
another document, the linked object does not appear in the other document. For
example, this setting could be useful if you want to link comments from a Word
document to the current drawing and you want other documents to display the
drawing, but not the comments.
Show Border - Turns on/off the frame border around the object.
Line Type - Overrides a line type for a drawing sheet or embedded object and sets
another line style for an element or linked object.
View Shape - Specifies the geometric shape of the border. Two options are available:
Rectangular and Elliptical. Changing the border shape can result in cropping the
contents of the SmartFrame.
Related Topics
• Break a Link, page 276
• Change a Link, page 275
• Embed a New Object, page 270
• Info Tab (SmartFrame Properties Dialog Box), page 277
• Link or Embed a Previously Existing Object, page 271
• SmartFrame Properties Dialog Box, page 276
• User Tab (SmartFrame Properties Dialog Box), page 278
Save - Places the attribute set on the element that you selected.
Remove - Removes the attribute set from the element that you selected.
Attributes - Sets the name, type, and value of the attribute set. You can type a name
in the box and press Tab.
Type - Sets the type for the attribute, such as double, text, number, money, or date.
Value - Sets the value for the attribute. The value that you can enter is based on the
type that you selected in the Type box.
Add - Adds an attribute to the attribute set. After you click Add, the attribute appears
in the table.
Delete - Removes an attribute from the attribute set. You can select an attribute by
clicking a row in the table.
Related Topics
• Border Tab (SmartFrame Properties Dialog Box), page 278
• Break a Link, page 276
• Change a Link, page 275
• Embed a New Object, page 270
• Info Tab (SmartFrame Properties Dialog Box), page 277
• Link or Embed a Previously Existing Object, page 271
• SmartFrame Properties Dialog Box, page 276
You can create an assembly by selecting several items in a drawing and saving as an
assembly. The file extension for an assembly is .pid, which is the same file extension
as a drawing. If you want to retrieve the assembly from the Catalog Explorer tree
view, you must save the assembly where the other symbols are located. The Save As
Assembly command prompts you to save the assembly in the correct directory, which
is specified in Options Manager.
Placing assemblies is like placing any other item from Catalog Explorer into a
drawing. When you want to place an assembly into a drawing, you select the
assembly from Catalog Explorer and click a location in the drawing. Or, you can
drag the assembly into the drawing. The information in each label remains intact
when you place the assembly. After you have placed an assembly, the items in the
assembly are treated as separate items. You can delete just one item without concern
that the software deletes the entire assembly.
Assemblies cannot be placed inline. You must place the assembly first and then route
piping to it, if required.
Note
• Assemblies can be created in one plant and used in another. However, the
file structure and symbols must be identical. If you try to place an
assembly into a plant that uses a different file structure, you get an error
message that the software cannot find your reference files. The assembly
placement quits. Move the symbols that cannot be found to the location
indicated in the error message.
When creating or placing assemblies, a log file is created for each action. The log
files are placed in the Temp directory and are named <AssemblyName>_CreAsm.log
and <AssemblyName>_PlaAsm.log.
The following is an example of the log file created when creating assemblies.
Source Drawing Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\Drawings\38\38-PI-0001.pid
Assembly Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\RefDatA\P&ID Reference
Data\Symbols\Assemblies\Equipment\VesselAssembly.pid
Number of graphic items processed = 1
Number of database items processed = 1
Number of attributes processed = 15
Finished creating assembly.
The following is an example of the log file created when placing assemblies.
Assembly Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\RefDatA\P&ID Reference
Data\Symbols\Assemblies\Equipment\VesselAssembly.pid
Target Drawing Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\Drawings\38\38-PI-0001.pid
Number of graphic items processed = 1
Number of database items processed = 1
Number of properties processed = 15
Finished placing assembly.
Related Topics
• Create an Assembly, page 282
• Place an Assembly, page 283
Saves selected items as an assembly. This command is available only when items are
selected in the drawing. Assemblies are saved with the .pid file extension. A red
target appears at the end of your pointer. You use this target to specify the origin of
the assembly for placement. You can only use a standalone symbol as the origin of an
assembly. For example, you cannot use labels, pipe runs, signal runs, or child items;
however, you can use unattached ends of pipe runs. The Save Assembly dialog box
opens after you specify the origin, and you can name the assembly and place it in the
proper directory.
Note
• The Save As Assembly command does not constitute an undoable action;
therefore, it does not appear as a step available for the Undo command.
Related Topics
• Create an Assembly, page 282
• Place an Assembly, page 283
• Working With Assemblies: An Overview, page 280
Create an Assembly
1. Select several components in the drawing.
Tips
• You can select more than one item at once by dragging the pointer to
fence objects.
• To remove an item from the selection, click it while pressing Ctrl.
2. Click File > Save As Assembly.
3. Use the red target that appears at the end of your pointer to specify the origin of
the assembly for placement.
Tip
• You can only use a standalone symbol as the origin of an assembly.
For example, you cannot use labels, pipe runs, signal runs, or child
items; however, you can use unattached ends of pipe runs.
4. On the Save As Assembly dialog box, enter the file name.
5. Click Save.
Notes
• Any graphics that have been band-aided should be deleted and replaced
prior to using this command.
• The file extension for assemblies is .pid.
• You can save an assembly in any directory that you want, but the default
assembly path is specified in Options Manager. If you use the default
folder, then you can retrieve the assembly from Catalog Explorer. In
order to save assemblies, you must have write permissions to the folder
defined in Options Manager.
• Assemblies can be created in one plant and used in another. However, the
file structure and symbols must be identical. If you try to place an
assembly into a plant that uses a different file structure, you get an error
message that the software cannot find your reference files. The assembly
placement quits. Move the symbols that cannot be found to the location
indicated in the error message.
Related Topics
• Place an Assembly, page 283
• Selecting Drawing Items: An Overview, page 132
• Working With Assemblies: An Overview, page 280
Place an Assembly
1. In the Catalog Explorer list view, click the assembly that you want to place.
2. Use the red target that appears at the end of your pointer to position the assembly
appropriately.
Tips
• The red target is the origin of the assembly. Some assembly members
also appear during placement to aid you.
• Press Esc to quit placement mode, or you can escape placement mode
by right-clicking.
3. Connect the pipe runs and instruments on either side of the assembly.
Tip
•You cannot place an assembly into a line that is already routed.
4. Modify or delete individual components in the assembly as necessary.
Move an Item Using the Move Button, page 210
Mirror an Item About an Existing Mirror Axis or Linear Element, page 229
Rotate an Item About an Axis You Define, page 231
Delete an Item from the Drawing, page 236
Notes
• Assemblies are stored in a specific folder, Assemblies, in the Catalog
Explorer tree view.
• Assemblies can be created in one plant and used in another. However, the
file structure and symbols must be identical. If you try to place an
assembly into a plant that uses a different file structure, you get an error
message that the software cannot find your reference files. The assembly
placement quits. Move the symbols that cannot be found to the location
indicated in the error message.
• You can only use a standalone symbol as the origin of an assembly. For
example, you cannot use labels, pipe runs, signal runs, or child items;
however, you can use unattached ends of pipe runs.
• You can save an assembly in any directory that you want, but the default
assembly path is specified in Options Manager. If you use the default
folder, then you can retrieve the assembly from Catalog Explorer.
Related Topics
• Working With Assemblies: An Overview, page 280
Once projects are enabled in SmartPlant Engineering Manager, the Plant can no
longer create drawings; drawings are created inside projects. However, any drawings
that might have existed in the Plant before projects were enabled remain in the Plant.
All drawing versions in the Plant are read-only drawings when projects are enabled,
but the Plant can still delete these drawings, unless the drawing is either fetched or
checked out to a project.
Note
• When you are using projects inside SmartPlant P&ID, remember that the
reference data belongs to the Plant and is used by projects of the Plant.
You cannot change reference data, such as table layouts or formats or
rules, at the project level.
Projects and Claiming
• One of the main capabilities associated with using projects in SmartPlant
is the ability for a project to claim a drawing object. When a project claims
an object, the project controls modifications to that object. A project
cannot modify objects it has not claimed. All the modifications and
claiming of objects is carried out in the design software, but the claim
states of objects inside drawings do have ramifications for drawing
manipulation and for completing projects. You do not need to check out a
drawing to claim items on it; you can claim items on a fetched drawing.
Related Topics
• Claiming Items: An Overview, page 285
• Comparing and Refreshing Versions: An Overview, page 301
A new item is created in a project in the same ways it can be created in a green field
plant. The simplest way to create a new item is to drag a catalog item from the
Catalog Explorer and drop it onto a drawing. A new item in a drawing is
automatically claimed to the project.
However, when an existing drawing is fetched or checked out to a project, none of the
items on that drawing are initially claimed. Before you can modify or delete any of
those items, you must claim them.
After you have claimed an item, you can modify it using the same methods that you
would use in a plant that is not project enabled. Purely graphical modifications to
drawing items are allowed without claiming those items. For example, a symbol can
be repositioned or the vertices of a connector can be moved. Also, labels can be
added or removed without claiming anything.
Any modification that changes the meaning of the schematic design, however,
requires that the affected items be claimed. For example, if you break a pipe run,
some of the piping components and inline instruments in that pipe run will be
reassigned to the new pipe run. Therefore, the pipe run, the piping components and
the instruments in that pipe run must all be claimed before you break it. If they are not
claimed, a error message will be displayed.
Properties of items that are not claimed by the active project cannot be changed, nor
are the mirror and rotate handles available when you select an item not claimed by
your project. The Properties window and the Engineering Data Editor do not allow
editing of properties on items that are not claimed: the properties are read-only as if
the drawing is in a read-only state. No other explicit prompts let you know that you
cannot edit an item that you have not claimed. However, you can manipulate the
Drawing view properties so that the claim state of items is visually apparent.
You cannot delete items that have not been claimed. After you have claimed an item,
you can delete it using the same methods that you would use in a green field plant.
However, if the deletion of an item would result in related items being deleted or
modified, then those related items must also be claimed. For example, if you delete a
vessel, the nozzles attached to it will be deleted and the pipe runs connected to the
nozzles will be modified. Therefore, the vessel, the nozzles and the pipe runs must all
be claimed before you delete the vessel. If they are not claimed, a error message will
be displayed.
You do not need to check out a drawing to claim objects; you can fetch a drawing
with read/write permissions and claim its objects. Claim commands appear on
shortcut menus in the Drawing view, in the Engineering Data Editor, and on the
Edit menu.
Releasing Claims
From inside a project, you can invoke a claim at any time to expand the scope of your
project, and any new item created in a project is automatically claimed by that
project. You can also release a claim at any time, but you cannot release the claim
that is automatically created when your project creates a new item.
Claims are automatically released on all drawing items when that drawing is checked
into the Plant; however, a drawing cannot be checked in if any objects that are not
claimed differ from the Plant.
Claim Mode
The Claim Mode can be set to either Exclusive or Shared by using the Settings
option in SmartPlant P&ID Options Manager. The Claim Mode controls how items
are claimed by concurrent projects.
If the Claim Mode is set to Exclusive, only one project can claim an item at any
given time. Exclusive mode enforces the rule that concurrent projects do not overlap
at the object level. With this setting, conflict resolution at check in time is simplified.
If the Claim Mode is set to Shared, a single item can be claimed to more than one
project. Shared mode allows concurrent projects to overlap at the object level. This
setting may be required for plants that have overlapping projects. Conflict resolution
at check in time will be more complex.
Invalid Claims
When an item is claimed by a project, it must be consistent with the state of the item
in the Plant. Otherwise, an invalid claim exists. Invalid claiming can happen only for
Plants that support Shared claiming of database items. Invalidly claimed items differ
from the Plant items in that you cannot modify them and check a drawing into the
Plant without first establishing a valid claim.
When the Plant uses Shared claim mode and a project checks in a drawing, the
claims made by other projects to objects on that same drawing are now invalid if the
project that checked in the drawing also changed an item claimed by a different
project.
You can determine the validity of a claim by using the Claim Status command.
Invalidly claimed items can not be modified.
If an invalid claim is found but the item in question matches the item in the Plant, run
Verify for Check In to resolve the situation. This process automatically sets the
claim to valid and allows the check in to occur.
Notes
• A list of claimed items is automatically published to The Engineering
Framework.
• Claim commands are not available when you open a fetched drawing with
read-only permissions.
• Claiming of labels is ignored.
• Drawing Manager is the only tool for checking in, checking out, and
fetching drawings.
• You must have full control user access permissions for P&ID Objects
before you can claim objects. For more information about setting user
access permissions, see SmartPlant Engineering Manager Help.
• Remember that objects are claimed by the project, not by a single user.
Once a project claims an item, it can be modified by anyone with the
appropriate permissions in that project.
• Claiming items clears the Undo stack. Thus, claim is not an undoable
command.
Related Topics
• Claim a Drawing Item, page 288
• Display Claim Status in the Drawing Symbology, page 300
• Display the Claim Status of a Drawing Item, page 299
• Release a Claim, page 297
Claim Command
Engineering Data Editor > Edit > Claim
Gives control of the selected items to the current active project. The Claim dialog
box opens, allowing you to confirm the "claim-ability" of the items and enter claim
comments. Claim comments can be viewed later by anyone in the Plant when the
claim status is displayed.
Related Topics
• Claim a Drawing Item, page 288
• Claiming Items: An Overview, page 285
Items to be claimed - Lists the items that are selected in the Drawing view or
Engineering Data Editor and their details. These are the items that you claim to
your project when you click OK. You can select multiple elements of this list and
record comments for this claim operation. In this list, you can also see if a selected
item is already claimed or has any other claim errors or warnings associated with it.
Comments - Allows you to record comments for the claim operation that you are
currently undertaking.
Related Topics
• Claim a Drawing Item, page 288
• Claim Command, page 47
Enforcing Claims
Whether you are using shared or exclusive claiming mode, claiming objects to your
project involves many special relationships. The following topics discuss some of the
ways that claiming restricts your activities.
Note
• Claim Mode is defined in Options Manager for the Plant and all its
projects. When you claim an item, it is claimed to your active project. No
items are ever claimed by the Plant.
Controlling Access
Each command in the software checks your permissions for the items that it modifies.
When possible, commands simply do not allow the operation to proceed if you do not
have the necessary permissions. In some cases, such as when using the Delete
command, the software cannot prevent you from initiating a command, but an error
message is displayed.
You must have full control permissions on P&ID Objects before you can claim any
drawing items. For more information, see the User Access chapter in SmartPlant
Engineering Manager Help.
Modifying Properties
Claiming impacts properties modifications in the following manner.
Properties Window
When you select a claimed item, the Properties window allows the properties of that
item to be viewed and modified. When you select an item that has not been claimed,
the Properties window allows the properties to be viewed but not modified. The
properties of unclaimed items are read-only.
When you select a line segment, the Properties window displays the properties of the
associated pipe or signal run. If the run has been claimed, the properties can be
edited; otherwise, the properties are read-only.
When you select multiple items, if they are all claimed, the Properties window
allows them to be modified. If any of the selected items are not claimed, the
Properties window treats the whole group as read-only.
Implied Items
When a drawing item is claimed, it means that you can modify that model item and
all of its implied items. If a model item is not claimed, the user cannot modify any of
the implied items that the model item owns.
Related Topics
• Claiming Items: An Overview, page 285
• Navigating in the Engineer Data Editor: An Overview, page 41
• Working with Drawings in Projects: An Overview, page 284
Placement Rules
When a new relationship is created, such as when you place a nozzle on a vessel, the
applicable rules copy property values across the relationship. When a relationship to
an unclaimed item is created, properties can be copied from that item without any
problem; however, if the rule calls for properties to be copied to an unclaimed item,
the action is not allowed, and the properties are not copied. An inconsistency
indicator shows the inconsistency between the two related items.
If the target item needs to be claimed but is not claimed, then you cannot place your
item onto the target; the target will not highlight, and your item will not "snap" into
position. If no type of placement is allowed at that point, the "no place" indicator
is displayed. In most cases, freestanding placement is still allowed.
Geometric Modifications
Geometric operations include a geometric move, with the Alt key pressed where
necessary, a rotation, a mirroring, and a scale or parametric modification. The
selected symbol does not have to be claimed to perform these operations. None of the
connected items have to be claimed either.
Rule-Based Moves
All connected items must be claimed, as described above. If the required connected
items are not all claimed, the move operation can become a geometric move, as if you
pressed the Alt key.
Geometric Modification
If you move a line segment or a line vertex that is internal to a line, then the piping or
signal run that owns the selected segment does not have to be claimed.
The Join Runs command allows you to combine two connected piping or signal runs
into a single run. Both of the runs and all components in both runs must be claimed.
Related Topics
• Place Multiple Representations, page 142
Placing Gaps
Placing a gap symbol into a piping or signal line implies that the target line must be
claimed. If the target line run is not claimed, it is not highlighted as a valid target
when you move the pointer over it.
Replace Mode
The claim status check takes place as you move the pointer over the target. If the
target is not claimed, the target is not highlighted as a valid replacement target.
Deleting Items
Claiming impacts item deletion in the following manner.
Drawing Items
Drawing items are deleted from a design using three different commands: Delete,
Delete From Model, and Cut. All of these commands check if the selected items and
some dependent items are claimed. If all of the selected items and all of the related
items are claimed, then the delete operation proceeds normally. If any of the items or
the dependent items are not claimed, an error message appears.
All dependent items must be claimed. That is, all items that are deleted along with a
selected item must be claimed. All lines that are attached to selected items or are
dependent on those items must be claimed. The following table expands on this idea,
item type by item type.
Item in Select Set Additional items that must be claimed for Delete
Equipment
• All nozzles, equipment components, and item notes
• All item notes on those equipment components and
nozzles
• All runs with lines attached to those nozzles
Nozzle
• All item notes
• All runs with lines attached to the nozzle
Equipment
Component • All item notes
Line Segment
• The pipe or signal run that owns the segment
• All components in that run
Branch Point
• All runs with lines that attach to that branch point
• All item notes
Piping Component
• All item notes
• All runs with lines that attach to that piping component
Item in Select Set Additional items that must be claimed for Delete
Instrument
• All instrument components – actuators, functions, and
so forth
• All item notes
• All runs with lines that attach to the instrument
OPC
• All item notes
• All runs with lines that attach to the OPC
• The partner OPC must be claimed also
Stockpile Items
Most items in the stockpile do not have any relationships. For these items, if the item
is claimed, it can be deleted from the stockpile. If the item is not claimed, the Delete
command opens the standard claim violation message.
Plant item groups, for example loops, packages, and so forth, exist in the stockpile
and have relationships to member items on a drawing or in a stockpile. If the plant
item group is claimed and all of its members are claimed, then the plant item group
can be deleted. If the plant item group or any of its members is not claimed, the
Delete command opens the standard claim violation message.
When an OPC is in the stockpile, it maintains its relationship to the partner OPC.
OPCs can be deleted from the stockpile only if both OPCs in a pair are in the
stockpile and are deleted at the same time. In a project context, both OPCs in a pair
must be claimed before they can be deleted.
Validating Properties
The software uses validation functions before setting properties on items. The
software checks the claim status before setting any values. If the item is claimed, the
property can be changed. If the item is not claimed, the property can not be changed.
For more information about validating properties, select Start > Programs >
Intergraph SmartPlant P&ID > Programming Help and see the Extending the
Capabilities of SmartPlant P&ID and Logical Model Automation Reference topics.
Create Task - Running a create task creates a new item in the stockpile. The new
item is claimed automatically as soon as it is created.
Update Task - Running an update task sets or changes some properties of an existing
item. The item to be updated must be claimed before it can be updated. If it is not
claimed, the task status is set to Error and a note is added to the Notes area on the
General tab of the Task Properties dialog box.
Delete Task - Running a delete task causes the target item to be deleted. The item to
be deleted and possibly other related items must be claimed before the task can do its
work. If all of the necessary items are not claimed, the task status is set to Error and
a note is added to the Notes area on the General tab of the Task Properties dialog
box.
Correlate Items - The Framework > Correlate command correlates pipe runs to the
same design basis as an existing pipe run that is already correlated. Properties are
copied from the primary pipe run to the other pipe runs. You must claim the pipe runs
to be modified. If they are not claimed, they cannot be correlated.
Related Topics
• Deleting Items, page 294
Displays the Release Claim dialog box and allows you to relinquish control (by your
project) of the selected items. This dialog box also displays when you attempt to
unclaim an item that has been modified in the project. Claims must be released before
projects can be completed or for other projects to be able to check in drawings with
changes.
Notes
• You can use the Compare and Refresh command to revert the item back
to the As-built state prior to unclaiming.
• If you are working in The Engineering Framework (TEF) environment and
there are any differences between an item in the Project and an item in the
AsBuilt, the claim cannot be released. If you are not working in a TEF
environment, the claim can be released. Also, items that display no
warnings or errors are released.
Related Topics
• Claiming Items: An Overview, page 285
Release a Claim
1. In the Drawing view or Engineering Data Editor, select the items for which you
want to release claims.
2. Right-click the item or select set and click Release Claim. If there are any errors
or warnings during the release, the Release Claim dialog box displays. Review
any warnings and error messages about each item.
3. Click OK to complete the claim release operation.
Notes
• You cannot release the claim on an item that is claimed to your project if it
is a new item that was created in your project.
• You can also release claims on items when you display their claim status.
For more information, see Display the Claim Status of a Drawing Item,
page 299.
Opens the Claim Status dialog box, which displays the details of the claimed state of
the selected items and enables you to claim items, release the claims to items, and so
forth. You must select the items in the Drawing view or the Engineering Data
Editor before using this command.
Related Topics
• Claiming Items: An Overview, page 285
• Display the Claim Status of a Drawing Item, page 299
Claim - Opens the Claim dialog box, and you can claim the item and record claim
comments.
Release Claim - Releases the claim from your project. A confirmation message is
displayed; choose Yes to release the claim.
Details - Opens the Details dialog box, and you can discover what project has
claimed the selected item, the user that claimed it, and any claim comments that were
entered when it was claimed.
Related Topics
• Claim a Drawing Item, page 288
• Claim Status Command, page 48
• Display the Claim Status of a Drawing Item, page 299
• Release a Claim, page 297
The New Item entry is automatically added to the comments for an item that is new
to the drawing. New items are automatically claimed to the project that created them.
Related Topics
• Claim Status Command, page 48
• Display the Claim Status of a Drawing Item, page 299
Sets the appearance of drawing objects as it is specified in the Claims tab of the View
Properties dialog box. You can use this command to switch the claim symbology on
and off. Using the options on the Claims tab causes only the color and line weight to
change, not the line pattern.
Related Topics
• Display Claim Status in the Drawing Symbology, page 300
Differences between drawing versions are assigned to logical change groups, which
are listed on the Change groups area of the Compare and Refresh dialog box.
Differences display in the following two categories.
Change details displays information about selected groups in the Change groups
area. Values for the Change details include the following.
• Add - Indicates that the selected group will be added to the version
displaying on the right.
• Delete - Indicates the selected group will be removed from the version
displaying on the right.
• Modify - Indicates the selected group will be modified on the version
displaying on the right.
The two versions are displayed in two Drawing views, described as left and right
views. The relationship between the two views depends on whether you are
comparing two versions in your own database or comparing your version to a version
in another database.
• Two versions are in the active database - The left-hand view is the older
version, and the right-hand view is the newer version. That is, they are
displayed in time-order from left to right.
Allows you to refresh the active drawing with data from another version of the
drawing. The differences display in what is known as a change group. If you accept
the changes, the drawing refreshes to display the changes.
To refresh a project drawing, you use the drawing in the plant. Change groups are
marked if it affects items you have claimed. Be sure to refresh all of the changes that
do not involve claimed items because these are the changes that have been checked in
by other projects. You want to include these changes in your drawing so they will not
be lost when you perform a check in.
Available Databases - Lists all the different databases that currently have a version
of the drawing you chose on the Show History dialog box.
History - Lists all the versions of the chosen drawing in the database you named in
the Available Databases list.
Print - Prints the entire Compare and Refresh dialog box contents. You can also
specify to print either the right or left view by using the drop-down arrow to select
either Right View or Left View.
Generate Report - Displays a report in Microsoft Excel. The report contains the
details of the compared drawings.
Find in List - Highlights the line in the Change groups and Change details
areas. You must first select an item in a drawing.
Find in Drawing - Zooms to the selected item. You must first select an item in
either the Change groups or Change details area.
Zoom Area - Enlarges the selected area by allowing you to draw a fence around
the area.
Zoom Out - Reduces the display of the selected area where you click.
Pan - Allows you to move the display in any direction by dragging the pointer
across the view.
Source Representation Location - Displays the source item location if the item
exists in either the Drawing or the Plant Stockpile.
Target Representation Location - Displays if the target item location if the item
exists in either the Drawing or the Plant Stockpile.
Change groups - Area that lists the changed items in groups. A listed item contains
all the items this change effects.
Action - Defines which action is to be taken involving the selected change. Options
include:
Change details - Area that lists the details of the item in each change group.
Result - Defines the results of the compare. The column indicates any differences in
the two versions and which version contains the change.
Change - Describes what action is required to make the drawing in the right frame
match the drawing in the left frame. Actions include:
Show Modified - Toggles the display of only those properties that are different
between the properties that belong to a selected drawing item. This button only
applies to modified items that exist in both versions; for added and deleted items, all
properties are listed.
Left-only - Allows you to choose a color for the display of objects that exist in the
left-hand Drawing view only. Dark green is the default color for this option.
Right-only - Allows you to choose a color for the display of objects that exist in the
right-hand Drawing view only. Red is the default color for this option.
Different items - Allows you to choose a color for the display of items that exist in
both views but differ from each other for any number of reasons (for example,
modified properties). Blue is the default color for this option.
Identical items - Allows you to choose a color for the display of drawing items that
are identical in the two views. Black is the default color for this option.
Highlight items - Allows you to choose a color to denote that a drawing object is
highlighted, for instance, when an item is within your locate zone.
Selected items - Allows you to choose a color to denote items that are selected in one
or both of the Drawing views.
Data Example
In this example, a jacketed tower exists in the version to be selected for the compare.
The current version contains the same jacketed tower but a change has been made to
the Cleaning Requirements property. When the current version is compared to the
selected version, a data change is found during the compare.
The current version appears on the right and the version it is compared to appears on
the left. Change groups indicates there is only one group and a data change was
located. All items in the group are valid claims. Change details indicates the
compare located a different property value (Cleaning Requirement) in the current
version. If you Refresh the version, the property value will be modified as shown in
the Change column. Clicking in the Action column of the Change groups allows
you to take no action or refresh (accept the new property value).
Graphic Example
In this example, a jacketed tower exists in the version to be selected for the compare.
The current version contains the same jacketed tower but it has been moved to a new
location. When the current version is compared to the selected version, a graphic
change is found during the compare.
The current version appears on the right and the version it is compared to appears on
the left. Change groups indicates there is only one group and a graphic change was
located. All items in the group are valid claims. Change details indicates the
compare located a graphic modification to a vessel (Jacketed Vessel) in the current
version. If you Refresh the version, the graphic modification will be accepted as
shown in the Change column. Clicking in the Action column of the Change groups
allows you to take no action or refresh (accept the previous location of the vessel).
The setting are not applied to a version until you click OK.
The current drawing appears on the right and the drawing it is compared to appears
on the left. Change groups indicates there are three groups of differences. All items
in the groups are valid claims. Change details indicates the compare located an
existing nozzle was moved (Graphic) and a property value change (Data) in the
current drawing.
Clicking in the Action column of any of the three Change groups allows you to
select either No Action or Refresh. If you select Refresh for any of the three groups,
the action described in the Change column will be performed when you click OK.
Consistency checking continuously monitors your work when you change or add
items to a drawing. The software displays all the inconsistencies, describes specific
problems, and offers hints. Using these solutions, you can decide the best method to
resolve an inconsistency. One solution is to approve a warning and thereby remove
the inconsistency from the drawing. Another solution is to copy the same value from
one side to the other side and then propagate.
The Consistency Check dialog shows the consistency criteria that apply at the
selected relationship indicator. All of the properties that are copied and compared
across this connection are shown. When the user has placed a break label, the copy
and compare columns show icons that indicate that no copy and compare operations
are performed for the properties in the label.
Break labels can be created in the Catalog Manager environment. A break label is
created just like an ordinary label, except that the Label Type property must be set to
“Attribute Break”. A SmartText field must be created for each property
that the break label is intended to break. A break label can break one or more
properties. This functionality is all currently supported by the Catalog Manager. No
new functionality is required.
Break labels can be placed directly from the catalog explorer. A group of break labels
is currently delivered under Piping\SegmentBreaks. Break label placement is
enhanced so that a break label can only be placed at a connection point where the
specified properties are being propagated. When a break label is placed interactively,
the corresponding property break data is added to the Relationship object.
Break labels can be deleted in the standard way using the Delete command. When a
break label is deleted the break is removed from the Relationship object. However, if
there is another break label at this same point that also breaks this property, then the
break would not be removed.
Related Topics
• Resolve an Inconsistency, page 320
• Review an Inconsistency, page 320
• Show Inconsistencies, page 312
Turns on or off the display of indicators that identify inconsistent relationships in the
active view. The software does not mark consistent, error-free relationships.
Related Topics
• Consistency Checking: An Overview, page 310
• Show Inconsistencies, page 312
Show Inconsistencies
1. Click View > Show Inconsistencies. When this option is selected, inconsistent
relationship indicators appear in the drawing.
2. If you do not want the inconsistencies to appear, click View > Show
Inconsistencies again to clear the selection of the option.
Note
• Also, you can right-click in an empty portion of the drawing in order to
display a shortcut menu. Select Show > Inconsistencies to toggle the
display of inconsistencies off and on.
Related Topics
• Consistency Checking: An Overview, page 310
Related Topics
• Consistency Checking: An Overview, page 310
• Resolve an Inconsistency, page 320
• Review an Inconsistency, page 320
You open this dialog box by right-clicking an inconsistency indicator and choosing
Consistency Check from the shortcut menu. You can also select Edit > Consistency
Check. When this dialog box first appears, the software automatically selects the first
item in the list. Other sections of the dialog box provide details that are specifically
related to the selected inconsistency.
All inconsistencies that occur at a junction, regardless of severity, are listed on the
Consistency Check dialog box. When you select one of the inconsistencies in the
list, the software displays information specific to that inconsistency in the Solutions
box. A specific example of this type can involve data inconsistencies for nominal pipe
diameter, normal operating temperature, and alternate design pressure between a
piping component and pipe run. This represents three different problems but at the
same junction.
The Consistency Check dialog box contains the Inconsistencies Tab and the
Consistency Criteria Tab.
Related Topics
• Consistency Check Command, page 313
• Consistency Criteria Tab, page 317
• Inconsistencies Tab, page 315
• Resolve an Inconsistency, page 320
• Review an Inconsistency, page 320
Inconsistencies Tab
All of the properties that are compared by consistency checking and copied across
this connection by propagation are shown on these tabs. The information shown here
is very similar to the information shown on the Consistency tab of the Rule
Properties dialog in the Rule Manager. Open the Consistency Check dialog box
by selecting Edit > Consistency Check.
Item 1 - Displays the inconsistency, item type, and item tag for the first item that is
connected by the active relationship. When the Consistency Check dialog box first
appears, all items involved in the inconsistency are selected.
Relationship - Displays the number for the active relationship and allows you to
select the relationship to be reviewed. The drop-down list contains a number for each
relationship that exists at the selected point. The graphic relationship indicator that
corresponds to the number shown in this control is highlighted.
Item 2 - Displays the inconsistency, item type, and item tag for the second item that
is connected by the active relationship. When the Consistency Check dialog box
first appears, all items involved in the inconsistency are selected.
Highlight item 1 - Place a check mark in the check box to highlight the item in the
drawing. This helps you to quickly locate the selected object. By default, this option
is not selected.
Highlight item 2 - Place a check mark in the check box to highlight the item in the
drawing. This helps you to quickly locate the selected object. By default, this option
is not selected.
Description - Displays the actual error or warning. For a lengthy error or warning, a
ToolTip appears to reveal the entire description. You cannot change the inconsistency
description, which is provided for information only.
Solutions - Displays the list of available solutions for the selected inconsistency. The
same solution that was previously selected is automatically selected again. If none
was previously selected, the first solution in the list is automatically selected. Some of
the solutions copy a property value across the relationship and initiate propagation.
When one of these solutions is selected, the propagation scope is highlighted. This
shows the items that will be changed before they are modified. After selecting an
inconsistency from the Inconsistencies list, you can select the correct solution from
this list, and after clicking Apply, the selected solution is performed.
Apply - Performs the solution you choose from the Solutions box. The
inconsistencies are then re-evaluated and the dialog box is updated.
Note
• Canceling selection of Item 1or Item 2 excludes the item from the select
set in the drawing and thereby affects the display in the Properties
window.
Related Topics
• Consistency Check Dialog Box, page 313
• Consistency Criteria Tab, page 317
• Properties Command, page 33
• Show Inconsistencies, page 312
Consistency Criteria – This list view shows all of the properties to be compared
and copied at this relationship. These consistency criteria come from the rules that
apply to this relationship. The consistency criteria for each rule are originally
specified within the Rule Manager. The name of the source rule is shown in the first
column. The remaining columns are the same as shown in the Consistency tab of the
Rule Properties dialog box in Rule Manager. Single selection mode is supported.
Item 1 - Displays the inconsistency, item type, and item tag for the first item that is
connected by the active relationship. When the Consistency Check dialog box first
appears, all items involved in the inconsistency are selected.
Relationship - If there are multiple relationship indicators at the same location, all of
them are loaded into the Consistency Check dialog box. Each relationship indicator
is assigned a number. The numbers are loaded into the drop-down list on the
Relationship control. You can review each one individually by selecting from the
entries in the drop-down list.
Item 2 - Displays the inconsistency, item type, and item tag for the second item that
is connected by the active relationship. When the Consistency Check dialog box
first appears, all items involved in the inconsistency are selected.
Highlight item 1 - Place a check mark in the check box to highlight the item in the
drawing. This helps you to quickly locate the selected object. By default, this option
is not selected.
Highlight item 2 - Place a check mark in the check box to highlight the item in the
drawing. This helps you to quickly locate the selected object. By default, this option
is not selected.
Copy - The copy action to be performed is displayed in this column. This column
controls how the property value is propagated when a property value is changed. The
following table describes the possible values and their meanings.
Compare - Displays how the property values from Items 1 and 2 are compared. The
comparison occurs whenever any property on either item is changed. The following
table describes the possible values and their meanings
Related Topics
• Consistency Check Dialog Box, page 313
• Inconsistencies Tab, page 315
• Properties Command, page 33
• Show Inconsistencies, page 312
Review an Inconsistency
1. Open a drawing.
2. Double-click an inconsistency indicator.
Tip
• In addition, you can right-click an inconsistency indicator and select
Consistency Check.
3. On the Consistency Check dialog box, review the list of possible problem areas
at the junction.
Notes
• The options for solving the inconsistency in Solutions vary depending on
the type of inconsistency.
• Consistency Check identifies the type of problem with these symbols:
Errors.
Warnings.
Approved warnings.
Related Topics
• Consistency Checking: An Overview, page 310
Resolve an Inconsistency
1. Open a drawing.
2. Double-click an inconsistency indicator.
Tips
• Or you can right-click an inconsistency indicator to review its
properties.
3. On the Consistency Check dialog box, select the inconsistency that you want to
correct in the list.
4. Chose the appropriate solution from the Solutions list.
Tip
• An example of a solution is Copy property value Item 1 => Item 2,
which could involve inconsistent nominal diameters of a pipe and
nozzle, for example. If you determine that this solution is the best one,
you can select it and click Apply. Or you can use the Properties
window to change the nominal diameter of either the pipe or nozzle.
Changing the diameter confirms that the values are consistent with the
information that exists in Rule Manager.
• The options in the Solutions list vary, depending on the type of
inconsistency.
5. Click Apply.
Notes
• Consistency Check identifies the type of problem with these symbols:
Errors
Warnings
Approved warnings
Related Topics
• Consistency Checking: An Overview, page 310
• Review an Inconsistency, page 320
Related Topics
• Display Help for Programming With SmartPlant P&ID, page 15
• Import Aspen Zyqad Stream Data, page 329
• Populate the Stockpile from a Spreadsheet, page 252
Allows you to import data and items into the database from reports and other files.
Note
• Relationships between items cannot be imported, only items and their
properties.
Related Topics
• Import Aspen Zyqad Stream Data, page 329
• Populate the Stockpile from a Spreadsheet, page 252
• Using Reports to Import Items into the Stockpile, page 251
Import log - Lists the results of the file importing process. These results are also
available in SPImport.log, which is saved to your local TEMP folder.
Related Topics
• Import Data File Command, page 323
• Modify a Pump by Importing a SmartPlant P&ID Report into the
Stockpile, page 254
• Populate the Stockpile from a Spreadsheet, page 252
Allows you to import data from SmartSketch into SmartPlant P&ID and starts the
SmartPlant Migrator wizard. In order to import a SmartSketch drawing into
SmartPlant P&ID, you must have SmartSketch installed on your computer.
Related Topics
• Import a SmartSketch File, page 327
Placement Order
After the SmartSketch file is scanned and all its objects are mapped to SmartPlant
P&ID objects, the Migrator uses rules to determine the order in which to place the
resulting symbols. Certain symbols cannot be placed unless a rule has been met. For
example, a nozzle cannot be placed unless it is attached to a piece of equipment.
SmartSketch does not have rule sets. To account for the rules in SmartPlant P&ID,
the Migrator looks at the SmartSketch symbols to determine what the symbols are
attached to. Symbol placement is performed in this order:
1. Stand-alone symbols
2. Symbols attached to stand-alone symbols
3. Connectors and pipes
4. Symbols attached to connectors or pipes
5. Symbols attached to symbols that are attached to a connector or pipe
6. Labels
7. SmartSketch graphics that are not recognized as symbols
Rule Considerations
Because the SmartPlant Migration Wizard cannot account for all the rule possibilities
that are defined in the default SmartPlant P&ID rule set or a customized rule set, you
must create your SmartSketch drawing with the SmartPlant P&ID rule set in mind.
SmartPlant P&ID Rule Manager contains the rules used when creating a P&ID. This
includes default rules and any rules you have created. The P&ID user and the
SmartSketch user must collaborate on what the rules allow to be placed in a P&ID so
that the SmartSketch drawings account for the different possibilities. For example, if
you create a rule for special requirements for equipment or instrumentation placement
in your P&IDs, the SmartSketch user needs to be made aware of these rules.
Supported Templates - Intergraph Process Flow and P&ID symbols map to the
SmartPlant P&ID reference data included with the software.
Notes
• The AABBCC code is not displayed in Catalog Explorer or the
Properties window in SmartPlant P&ID. To view the code, you must
open the item in Catalog Manager.
• Because SmartSketch is file-driven and SmartPlant P&ID is database-
driven, both products have independent sets of symbols; therefore, symbol
definitions and attributes migrated from a SmartSketch file are stored as
properties in the SmartPlant P&ID database. SmartSketch symbol
attributes are conditionally migrated; this means that the attribute must
exist as a SmartPlant P&ID property for that symbol. SmartSketch has a
default set of attributes for vessels, pumps, compressors, and shell and
tube exchangers. These attributes are the same as the SmartPlant P&ID
properties for the same items. All of those attributes, if given a value in
SmartSketch, migrate to the SmartPlant P&ID property database. You can
add your own unique attributes to a P&ID symbol in SmartSketch, and if
that same symbol with same properties is available in SmartPlant P&ID,
custom SmartSketch attributes can migrate into those properties. You
define custom properties for SmartPlant P&ID symbols by using Catalog
Manager.
Nozzles - Nozzles are required for connection of piping in SmartPlant P&ID. Nozzles
are required in the SmartSketch document for connections to be established when
converted to SmartPlant P&ID.
Non-Nozzle Connections - Piping linear objects not connected to nozzles are placed
in SmartPlant P&ID, but are not connected. You have to make valid connections
manually in SmartPlant P&ID.
SmartLabels - Item tags and other single property labels are maintained intelligently.
Notes
• Labels in SmartSketch files are migrated very much like symbols. Any
label placed in SmartSketch must have an equivalent label in SmartPlant
P&ID before it can migrate. SmartSketch does include a subset of the
SmartPlant P&ID labels, and most of the common labels are smart labels,
which are labels that are associated with one or more object properties.
The properties of these smart labels are passed to the symbol to which
they are attached and migrate to SmartPlant P&ID.
• In order to assign an AABBCC code to a SmartPlant P&ID label so that it
matches a SmartSketch label, do the following.
1. Open the P&ID label in Catalog Manager.
2. Right-click the symbol page in order to open the File Properties dialog box,
and click the Symbol tab.
3. In the Name box, type AABBCC_code.
4. In the Type box, select Text.
5. In the Value box, enter the appropriate AABBCC code, for example, 1F6Y01.
Unrecognized Graphics and Annotations - All unrecognized graphics are inserted
in the SmartPlant P&ID drawing as embedded SmartSketch graphics. This rule
maintains visual fidelity even if there are items that could not be mapped intelligently.
Notes
• In order to import a SmartSketch drawing into SmartPlant P&ID, you
must have SmartSketch installed on your computer.
• You can determine if all the graphics in your file migrated correctly by
viewing the GetSmart.log file in the Temp folder. This file contains
information about the migration such as the file that was migrated, the
time that the migration started and stopped, the symbols that were
migrated, and any errors encountered during the migration.
Related Topics
• Import a SmartSketch File, page 327
Aspen Zyqad spreadsheets in either Microsoft Excel or XML format are supported.
Such spreadsheets include the Vessel Equipment List, Pump Equipment List, and
Heat Exchanger Equipment List.
Importing Aspen Zyqad XML data files allows greater flexibility when importing
data into the design software. All three reports, Vessels, Pumps, and Exchangers, are
included in a single XML report so that only one file has to be imported.
You can easily update stockpile items that originate from importing Aspen Zyqad
data by re-importing a data file. Previously imported items, whether they remain in
the stockpile or have already been placed in the drawing, are updated with data from
the newly imported file.
Important
• If a format change is made to an exported Aspen Zyqad report,
modifications must be made to the import code to accommodate the
changed report layout. For more information, see the SmartPlant P&ID
Programmer's Guide.
Related Topics
• Display Help for Programming With SmartPlant P&ID, page 15
• Import Aspen Zyqad Stream Data, page 329
• Populate the Stockpile from a Spreadsheet, page 252
Each report that you create is based on an item type. This item type serves as the
starting point for collecting data for your report. Examples of item types include
equipment, nozzle, instrument, and pipe run. Several default report templates already
exist; however, reports are fully customizable. You can create your own reports that
contain the information that you want to see in a format you choose.
The relationships that exist between the various item types constitute additional
available information for a report. For example, a nozzle is related to the equipment
with which it is grouped. When creating your report, only items that have a
relationship with your selected item type can be used as input. In order to discover
how items and their properties are related, and thereby how you can map the
properties that you want into your report templates, see the Properties Glossary,
which is included in the glossaries attached to online Help.
Your report definition contains one or more report items organized in a tree hierarchy.
Each report item is based on an item type. Each report contains at least one report
item to define the item type of the report. For example, a report based on the
equipment item type contains a report item named Equipment. This report item
makes the properties associated with each piece of equipment available for inclusion
in your report; however, you do not have to include every available property in your
report if it is not appropriate. You can define additional report items to access more
properties for more item types. For example, a nozzle report item can be added to
access data about nozzles because nozzles and equipment are related.
The location of a report item in the tree hierarchy affects the properties that are
collected for the associated item type. For example, if a nozzle is added as the top-
level item in the tree, all nozzles in the database are collected for your report. If the
nozzle is added as a child of Equipment: Mechanical, only the information about
nozzles that are associated with pumps is collected.
You begin your reporting process by selecting items in the drawing for inclusion in
your report. You can select individual items, or you can select the Entire Drawing
option. You can also select Include items in the Drawing Stockpile (available only
for the active drawing and when you select Reports > Plant Reports or My
Reports). Then, select report template from the Reports menu. Then the software
performs the following tasks:
1. Microsoft Excel starts. The report template is copied to the report output folder,
and then the Excel workbook opens.
2. Your report definition is retrieved from the Excel workbook.
3. Your data is retrieved based on the report item definitions of the report template.
4. Data prints to the Microsoft Excel workbook using the cell mapping data in your
report definition.
Notes
• To create a Plant wide report, use the Engineering Data Editor commands
View > Plant Reports or My Reports.
• You must have installed Microsoft Excel on your computer to display
reports.
• The software stores the reports that you generate in your Windows
directory under \Profiles\username.
Related Topics
• Create a New Blank Report Template, page 344
• Create a Report Template Based on an Existing Template, page 349
• Display the Properties of a Report Template, page 349
• Edit a Report Template, page 347
• Generate a Report, page 334
Opens the Plant Reports dialog box, which displays a list of all plant-level reports
associated with the current plant. This list is alphabetical. The location of these report
templates is defined in Options Manager. Selecting a plant report from this list and
specifying the items that you want to report on generates the associated report in
Microsoft Excel.
This command is available on the Reports menu on the main toolbar and also on the
View menu in the Engineering Data Editor. If you have a drawing in the Design
window and you want to report on items in that drawing, use this command from the
Reports menu. If you want to run a report based on items in your Engineering Data
Editor, use this command from the Engineering Data Editor View menu.
Note
• The Engineering Data Editor is the area where you can view stockpile
items.
Related Topics
• Generating Reports: An Overview, page 330
• Navigating in the Engineer Data Editor: An Overview, page 41
Current Selection - Produces a report containing the items currently selected in your
drawing or table. This option is not available if no drawing or table items are selected.
You cannot choose the Include items in drawing stockpile option when you choose
Current Selection.
Entire drawing - Produces a report containing the contents of the entire drawing.
This option is available only when you use the Reports menu command.
Include items in drawing stockpile - Allows you to specify whether or not you want
items that reside in the drawing stockpile in your report. This option is available only
when you use the Reports menu command.
Related Topics
• Generate a Report, page 334
• Plant Reports Command, page 332
• Select an Item, page 135
Generate a Report
1. In the Drawing view or Engineering Data Editor, select the items that you want
to include in the report.
Tip
• If you select no items, the software gives you the option to report on
all items.
2. Click Reports > Plant Reports.
Tip
• Or click Reports > My Reports to select a customized report that you
defined already.
3. Select the report that you want to generate.
4. In the Report using area on the Plant Reports dialog box or the My Reports
dialog box, choose the items that you want to report on.
Notes
• You must have installed Microsoft Excel on your computer to display
reports.
• Before running the Line List report, verify that every line in the selection
has an Item Tag.
• The software stores the reports that you generate in your Windows
directory under \Profiles\username.
Related Topics
• Generating Reports: An Overview, page 330
• Using Reports to Import Items into the Stockpile, page 251
My Reports Command
Reports > My Reports
Opens the My Reports dialog box which lists all user-level reports. They can be
stored on your local workstation. This list is alphabetical. If you want to run a report
based on drawing items, access this command from the Reports menu on the main
toolbar; if you want to run a report based on table items, access this command from
the View menu on the Engineering Data Editor toolbar.
Note
• You can define the location for storing user-level report templates by
clicking Tools > Options and then selecting the Files tab.
Related Topics
• Edit a Report Template, page 347
• Generate a Report, page 334
• Generating Reports: An Overview, page 330
Report using - Displays options for specifying the scope of your report. The options
that appear in this area depend on the view, Drawing view or Engineering Data
Editor, that is active when you access this dialog box.
Current Selection - Produces a report containing the items currently selected in your
drawing or table. This option is not available if no drawing or table items are selected.
You cannot choose the Include items in drawing stockpile option when you choose
Current Selection.
Entire drawing - Produces a report containing the contents of the entire drawing.
This option is available only when you use the Reports menu command.
Include items in drawing stockpile - Allows you to specify whether or not you want
items that reside in the drawing stockpile in your report. This option is available only
when you use the Reports menu command, not the Engineering Data Editor
command.
Related Topics
• Generate a Report, page 334
• My Reports Command, page 335
• Select an Item, page 135
• Tabular
• Fixed
• Composite Format Report
The delivered report templates are all tabular format reports. Fixed format templates
allow the greatest amount of freedom in formatting your report, and composite report
templates, as the name suggests, combine tabular and fixed formatting.
Not only can you completely control the format of your report, but you can control
the content of the template also. Each report is based on a unique item type, and the
properties that are associated with that item type are readily available to include in
your report. In addition, any item that is related in any way to the basic item type of
your report makes its properties available to include in the definition of your
template, too. For instance, the properties of inline components and instruments can
be used in a pipe run report because inline components are related to their pipe runs.
In order to discover how items and their properties are related, and thereby how you
can map the properties that you want into your report templates, see the Properties
Glossary, which is included in the glossaries attached to online Help.
Related Topics
• Create a New Blank Report Template, page 344
• Define the Contents of Your Report Template, page 356
• Define the Layout of a Composite Format Report Template, page 342
• Define the Layout of a Fixed Format Report Template, page 340
• Define the Layout of a Tabular Format Report Template, page 338
• Edit a Report Template, page 347
For example, the report template for an Equipment List can appear like this:
Related Topics
• Create a New Blank Report Template, page 344
• Define the Contents of Your Report Template, page 356
• Define the Layout of a Tabular Format Report Template, page 338
• Display the Properties of a Report Template, page 349
• Edit a Report Template, page 347
• Generate a Report, page 334
3. Choose the number of empty lines that you want between rows in your report.
Each row is filled with properties for one item.
Tip
• Some report templates, for example the Line List, designate two rows
of data for each report item and then an empty row.
4. Click OK to close the Options dialog box.
5. Complete general labels and graphics, if needed, in your header.
6. Complete column headings in the last row of your header.
7. Select a cell in your report template where you want to map a particular property.
Tip
• This cell can be either in the body of the report or in the header.
8. Choose the property that you want to map to your cell from the Map Properties
menu. The items on this menu are chosen when you define the contents of your
template. For more information, see Define the Contents of Your Report Template,
page 356.
Tips
• You only have to map properties for one item. Properties for all the
items follow the format you map for the first one.
• Only one property can be mapped to a given cell, although the same
property can be mapped to more than one cell.
9. Repeat the previous steps until you have mapped all the properties that you want
to map on this report template.
10. Save the template and quit Microsoft Excel.
Notes
• Because the delivered report templates are tabular format, if you create a
template based on an existing template, the format of your report template
is also tabular. Select Blank as your source template if you want to create
a fixed or composite format report template.
• The location of plant-level report templates is specified in Options
Manager. The location for user-level templates is defined on the Files tab
of the Options dialog box (Tools > Options).
• When you add any property value in the header, a new Microsoft Excel
worksheet is created, and the header is saved on the new sheet because the
entire header no longer fits in the space allotted on the first sheet. You can
customize the number of rows in the report header by using the Options
command on the SmartPlant Reports toolbar and choosing a larger value
in the Rows in report header option in the Options dialog box.
Related Topics
• Composite Format Report, page 341
• Creating and Editing Report Templates: An Overview, page 337
• Fixed Format Report, page 340
• Tabular Format Report, page 338
Related Topics
• Create a New Blank Report Template, page 344
• Create a Report Template Based on an Existing Template, page 349
• Define the Layout of a Fixed Format Report Template, page 340
• Display the Properties of a Report Template, page 349
• Edit a Report Template, page 347
Note
• You use the Options command on the SmartPlant Reports toolbar to
designate space for your header and to specify the number of blank lines
that you want between rows of data on your report. The Options
command is not available for fixed format report templates because you
are free to place headers and data anywhere on your worksheet.
Related Topics
• Composite Format Report, page 341
• Creating and Editing Report Templates: An Overview, page 337
• Fixed Format Report, page 340
• Tabular Format Report, page 338
Note
• Because the delivered report templates are tabular format, choose Blank
from the Source template list if you want to create a composite format
template.
Related Topics
• Create a New Blank Report Template, page 344
• Define the Layout of a Composite Format Report Template, page 342
• Display the Properties of a Report Template, page 349
• Edit a Report Template, page 347
• Generate a Report, page 334
New Command
Reports > New
Displays the New Report Template dialog box. This dialog box provides options for
defining plant-level and user-level templates. You can assign source templates,
names, formats, and descriptions for your report template and define the item type
upon which you base your report. You do not have to edit the report template when
you first create it.
Related Topics
• Composite Format Report, page 341
• Create a New Blank Report Template, page 344
• Create a Report Template Based on an Existing Template, page 349
• Creating and Editing Report Templates: An Overview, page 337
• Fixed Format Report, page 340
• Tabular Format Report, page 338
Source template - Lists the names of all existing report templates and Blank. You
select a user-level template, plant-level template, or Blank. The Blank option creates
a Microsoft Excel workbook with no predetermined formatting information. If you
chose Blank, you must specify an item type; whereas, if you do not chose Blank, the
item type automatically displays the item type that corresponds to your source
template. Templates in this list appear in alphabetical order.
Name - Allows you to enter a meaningful name to describe the report that you are
creating. This name matches your Microsoft Excel workbook. The software appends
.xls to the name when you save the Excel workbook.
Item type - Defines the item properties available in your report. If you do not select a
Blank source template type, then the Item type option automatically displays the
item type that corresponds to your source template.
Report Type - Specifies your report format. Available options include fixed, tabular,
and composite. All delivered report templates are tabular format.
Fixed format - Creates one Microsoft Excel worksheet for each item. You only edit
the first worksheet, but all fixed format worksheets, one for each item of the report
item type, follow the format of the first worksheet when you generate your report.
The Options button on the SmartPlant Reports toolbar is not available for editing a
fixed format report template because you are free to place headers and data anywhere
you want on your worksheet.
Tabular format - Formats your report in a table. That is, the properties of each item
included in your report begin on a unique row, or the template format is row-based.
All delivered reports are tabular format.
Description - Describes the report type that this template produces. You can assign
any description.
Related Topics
• Create a New Blank Report Template, page 344
• Display the Properties of a Report Template, page 349
• Edit a Report Template, page 347
• Edit Command, page 345
• New Command, page 38
Related Topics
• Composite Format Report, page 341
• Creating and Editing Report Templates: An Overview, page 337
• Edit a Report Template, page 347
• Fixed Format Report, page 340
Edit Command
Opens the Edit Report Template dialog box. This dialog box lists all the available
report templates. You can select a template and view its properties and edit it in
Microsoft Excel.
Note
• You must have valid privileges to edit a report template.
Related Topics
• Creating and Editing Report Templates: An Overview, page 337
• Edit a Report Template, page 347
• Generating Reports: An Overview, page 330
Available reports - Lists all report templates available to edit or customize. Select a
template from the list.
Properties - Displays the Report Properties dialog box where you can modify the
description and the report template format.
Important
• You must have the correct privileges, granted in SmartPlant Engineering
Manager, to edit plant-level report templates.
Related Topics
• Create a Report Template Based on an Existing Template, page 349
• Edit a Report Template, page 347
• Edit Command, page 345
• New Command, page 38
Source template - Displays the names of all existing report templates and Blank.
You select a user-level template, plant-level template, or Blank. The Blank option
creates a Microsoft Excel workbook with no predetermined formatting information. If
you choose the Blank option, you must specify an item type; whereas, if you do not
choose Blank, the software automatically specified the Item type option as the item
type that corresponds to your source template. Templates in this list appear in
alphabetically.
Name - Allows you to enter a meaningful name to describe the report that you are
creating. The name matches your Microsoft Excel workbook. The software appends
.xls to the name when you save the Excel workbook.
Item type - Defines the item properties available to populate your report. If you
select a source template other than Blank, the Item type option is automatically
specified with the item type that corresponds to your source template.
Report Type - Specifies your report format. Available options include fixed, tabular,
and composite.
Fixed format - Creates one Microsoft Excel worksheet for each item. You only edit
the first worksheet, but all fixed format worksheets, one for each item of the report
item type, follow the format of the first worksheet when you generate your report.
The Options button on the SmartPlant Reports toolbar is not available for editing a
fixed format report template because you are free to place headers and data anywhere
you want on your worksheet.
Tabular format - Formats your report in a table. That is, the properties of each item
included in your report begin on a unique row, or the report format is row-based. All
delivered report templates are tabular.
Composite format - Formats your report in a combination of fixed and tabular styles.
The first sheet in the workbook is fixed format; the second sheet is tabular format.
When you generate your report, the software creates subsequent fixed format
worksheets after sheet two for each item that matches your report item type.
Description - Describes the report type that this template produces. You can assign
any description.
Related Topics
• Create a New Blank Report Template, page 344
• Display the Properties of a Report Template, page 349
• Edit a Report Template, page 347
• Edit Command, page 345
• New Command, page 38
Notes
• You must have the correct permissions in SmartPlant Engineering
Manager to edit a report template.
• If the SmartPlant Reports toolbar is missing when editing report
templates in Microsoft Excel, then on the Excel menu bar, select Tools >
Macro > Visual Basic Editor and follow these steps.
1. Select View > Immediate Window.
2. Type Sheet1.Application.CommandBars("SmartPlant Reports").Delete in the
Immediate window.
3. Quit Excel, and the toolbar is displayed the next time a report is edited.
Related Topics
• Creating and Editing Report Templates: An Overview, page 337
• Generating Reports: An Overview, page 330
Notes
• Because the delivered report templates are all in tabular format, if you
create a template using an existing template, the format of your report
template is tabular.
• Because you are creating a report based on an existing template, some
options on the New Report Template dialog box are not available. In
order to make all options available, choose Blank from the Source
template list. For more information, see Create a New Blank Report
Template, page 344.
Related Topics
• Composite Format Report, page 341
• Creating and Editing Report Templates: An Overview, page 337
• Fixed Format Report, page 340
• Generating Reports: An Overview, page 330
Related Topics
• Creating and Editing Report Templates: An Overview, page 337
• Edit a Report Template, page 347
Delete Command
Reports > Delete
Displays the Delete Report Template dialog box, which allows you to select and
delete a report template.
Note
• You must have valid privileges, granted in SmartPlant Engineering
Manager, to delete a report template.
Related Topics
• Delete a Report Template, page 350
• Generating Reports: An Overview, page 330
Related Topics
• Delete a Report Template, page 350
• Edit Command, page 345
• New Command, page 38
Appears when you are editing or creating a report template in Microsoft Excel.
Note
• If the SmartPlant Reports toolbar is missing when editing report
templates in Microsoft Excel, then click Tools > Macro > Visual Basic
Editor in Excel and follow the steps below:
1. Select View > Immediate Window.
2. Type Sheet1.Application.CommandBars("SmartPlant Reports").Delete in
the Immediate window.
3. Quit Excel, and the toolbar is displayed the next time a report is edited.
Related Topics
• Define Command, page 351
• Define the Contents of Your Report Template, page 356
• Edit a Report Template, page 347
• Map Properties Command, page 359
• Options Command, page 22
Define Command
MS Excel > SmartPlant Reports Toolbar > Define
Opens the Define Report Contents dialog box, which allows you to define a report
template specifying the layout and contents of your report. This template is a
Microsoft Excel workbook that contains cells and worksheets. You map properties to
the individual Microsoft Excel cells to define the content and layout of your report.
Use the Options command on the SmartPlant Reports toolbar to designate space for
your header and to specify the number of blank lines that you want between rows of
data on your report. The Options command is not available for fixed format report
templates because you are free to place headers and data anywhere you want on the
worksheet.
In order to define the layout of the report item properties, you assign properties to
particular cells. Select the cell and then select the property from the Map Properties
menu on the SmartPlant Reports toolbar.
Note
• In order to generate From and To data for all Microsoft Excel worksheets,
click Tools > Macro > Macros > PrintFromToDataForAllSheets in
Excel. Choose the PrintFromToDataForActiveSheet macro to generate
this data for only the active worksheet.
Related Topics
• Create a New Blank Report Template, page 344
• Edit a Report Template, page 347
Define - Displays the Define Report Items dialog box. For the selected item in the
Report on tree, you define the properties that you want available for inclusion in
your report template.
Delete - Removes an item from the tree view and from your report structure. Its
properties are no longer available for your report template.
New - Displays the New Items dialog box. You use this dialog box to specify new
item types to include in the Report on tree. If you add a new item type, its properties
are available for inclusion in your report template.
Report on - Displays a tree view of item types the properties available for inclusion
in your report template. To include the properties, you must select an item from the
Report on list and click Define. Then you can map the properties that you select to
cells in your report template.
Note
• The level into which you add an item type affects the properties that you
can access for your template. That is, a new item type added into the
hierarchy under another item type does not give you access to the same
properties that you have if the item type is higher in the hierarchy. For
instance, if you add the equipment item type under nozzles, the equipment
item type only reports on equipment associated with a nozzle, and
equipment without nozzles is not reported.
Related Topics
• Create a New Blank Report Template, page 344
Apply - Adds the selected item type to the Report on tree on the Define Report
Contents dialog box. The software adds this item type as a child of the item type
selected on the Define Report Contents dialog box.
Note
• The level into which you add an item type affects the properties that you
can access for your template. That is, a new item type added into the
hierarchy under another item type does not give you access to the same
properties that you have if the item type is higher in the hierarchy. For
instance, if you add the equipment item type under nozzles, the equipment
item type only reports on equipment associated with a nozzle, and
equipment without nozzles is not reported.
Items related to - Displays a list of item types related to the item type that you
selected in the Report on tree on the Define Report Contents dialog box. Select
item types from this list to include in your report template. The properties of the new
item types are then available to use in your report.
Name - Displays the name of the selected item type. You can rename the item. If you
have duplicate item type names in your report item type hierarchy, the software
prompts you to rename the new item type uniquely.
Related Topics
• Create a New Blank Report Template, page 344
• Define Command, page 351
• Define the Contents of Your Report Template, page 356
• Edit a Report Template, page 347
• New Command, page 38
Related Topics
• Create a New Blank Report Template, page 344
• Define the Contents of Your Report Template, page 356
• Edit a Report Template, page 347
Group by the selected property - Automatically adds a special Report Item Group
Total property to the Map Properties menu on the SmartPlant Reports toolbar.
The Report Item Group Total property displays the number of items that have
identical reported properties. If you want to tally similar items in this way, be sure not
to map unique properties, such as item tags, onto your report. If you do, then items
are never grouped together because a unique tag is a property that items never share.
For example, you can use this feature to give you the total numbers of valves with 1"
nominal diameter, 1.5" nominal diameter, 2" nominal diameter, and so forth.
Repeat parent data - Displays the cells of parent item data in your report. For
example, if your report contains Unit then Drawing as a child of Unit, selecting this
option for Drawing causes repetition of Unit cells on any line containing Drawing
cells.
Available properties - Displays all properties for the report item you specified on the
Define Report Contents dialog box.
Selected properties - Lists the report item properties you have selected from the
Available properties list that are consequently available for inclusion in your report.
Left Arrow - Moves the selected item in the Selected properties list to the
Available properties list. You can select more than one item by using the Shift and
Ctrl keys and then clicking the left arrow. Also, double-clicking an item in the
Selected properties list moves it to the Available properties list.
Right Arrow - Moves the selected item out of the Available properties list and into
the Selected properties list. You can select more than one item by using the Shift
and Ctrl keys and then clicking the right arrow. Also, double-clicking an item in the
Available properties list moves it to the Selected properties list.
Use short text - Displays the short text value, which is defined in SmartPlant Data
Dictionary Manager. Only select-listed properties can be displayed in their short
value form. In a few cases, the short value is longer than the regular value.
Use select list index - Includes the numerical index of the select entry along with
either the short value or select list value for that property. For more information about
select lists and their values and indices, see SmartPlant Data Dictionary Manager
Help.
Related Topics
• Edit a Report Template, page 347
• New Command, page 38
Applied filter - Displays your selected filter. To select a new filter, type a valid filter
name or click Browse to locate a filter.
Browse - Displays the Select Filter dialog box, which allows you to choose or to
further define item types for your report template.
Related Topics
• Define Command, page 351
• Define the Contents of Your Report Template, page 356
• Edit a Report Template, page 347
• Map Properties Command, page 359
• Options Command, page 22
Left Arrow - Moves the selected item in the Sort properties list to the Available
properties list. You can select more than one item and then click this button. Also,
double-clicking an item moves it to the Available properties list.
Order - Specifies the sorting order (ascending or descending) for the report data.
Right Arrow - Moves the selected item in the Available properties list to the Sort
properties list. You can select more than one item and then click this button. Also,
double-clicking an item moves it to the Sort properties list.
Related Topics
• Define the Contents of Your Report Template, page 356
• Edit a Report Template, page 347
• New Report Template Dialog Box, page 343
Tips
• If you want to sort the order in which your items are listed when you
generate a report, choose the property or properties to sort on by using
the Sort tab.
• If you want to change the filter that finds your report items, use the
Filter tab. For instance, you can switch from a filter that displays all
pumps to a filter that displays only active pumps.
11. Click OK.
Tip
• The Define Report Contents dialog box remains open, and so you can
repeat the previous steps to continue adding more items and specifying
their properties.
12. When you have selected all the properties that you want in your report, click OK
on the Define Report Contents dialog box.
Notes
• All the properties that you have made available to map into your template
are now displayed when you click Map Properties on the SmartPlant
Reports toolbar. Now you can use the properties you have specified in the
layout of your template.
• In order to generate From and To data for all Microsoft Excel worksheets,
click Tools > Macro > Macros > PrintFromToDataForAllSheets in
Excel. Choose the PrintFromToDataForActiveSheet macro to generate
this data for only the active worksheet.
Related Topics
• Creating and Editing Report Templates: An Overview, page 337
• Edit a Report Template, page 347
• Generating Reports: An Overview, page 330
Options Command
MS Excel > SmartPlant Reports Toolbar > Options
Opens the Report Options dialog box, which provides options for defining header
and spacing details in your report template. The Options button on the SmartPlant
Reports toolbar is not available for editing a fixed format report template because
you are free to place headers and data anywhere you want to on your worksheet.
Related Topics
• Define the Contents of Your Report Template, page 356
• Edit a Report Template, page 347
• Generating Reports: An Overview, page 330
Skip lines between rows - Defines the number of blank lines between each row in
your report. You can enter a value in the box or use the scroll buttons to select a
value. The maximum value allowed is 1000.
Rows in report header - Specifies the number of rows in your report header.
Note
• The Options command is available for tabular and composite format
report templates only. It is not available for fixed format report templates
because you are free to place captions and properties in any configuration
that you want. In fixed format report templates, you are not constrained to
have a header or rows at all.
Related Topics
• Create a New Blank Report Template, page 344
• Create a Report Template Based on an Existing Template, page 349
• Define the Layout of a Composite Format Report Template, page 342
• Define the Layout of a Tabular Format Report Template, page 338
• Edit a Report Template, page 347
Displays a menu of all properties associated with your report. This menu is populated
with the items that you define with the SmartPlant Reports toolbar Define
command. The Map Properties menu contains a subset of all the properties in the
plant database.
You can select a cell in your report template and then assign a property from the Map
Properties list. The software places the corresponding property in the selected cell.
You do not have to map all the properties in the Map Properties menu, and you can
add properties to the menu by using the Define command again.
Note
• The SmartPlant Reports toolbar appears in Microsoft Excel when you
create or edit a report template.
Related Topics
• Create a New Blank Report Template, page 344
• Create a Report Template Based on an Existing Template, page 349
• Edit a Report Template, page 347
• Generating Reports: An Overview, page 330
Note
Zero length pipe runs will print. For example, when a reducer is connected to a
nozzle, the zero length pipe run between these symbols will print. Zero length pipe
runs will not print if you print your drawing using Drawing Manager.
Preparing to print
The printer you use affects the way the current drawing prints and displays text on the
screen. Before you print a drawing, you must install and select the printer you want to
use. For more information about installation, see the documentation for your printer.
Before you print, select a printer and the settings for it. To do this, click the Print
command on the File menu, and then click the printer you want to use. You can set
properties for the printer by clicking the Properties button. To set the print range and
scale, click the Settings button.
Printing a Drawing
As you work on a drawing, you can send a copy of it to a specified printer, plotter, or
file. You can click the Print command on the File menu to do the following:
Printing Time
Drawings can take some time to print. Expect longer print times when you have
drawings that contain a large number of the following items:
• Curved items
• Many fills that have complex colors, patterns, or textures
• Large bitmaps
• Links to various drawings
The type of printer you have also affects the printing time. PostScript® printers print
faster than LaserJet printers, because they can make the necessary calculations faster.
Some older versions of PostScript® printers are slower when compared to the newer
ones. The type of controller boards and the amount of RAM in the printer also affect
your printing times.
Related Topics
• Print a Drawing, page 365
• Print a Selected Area, page 365
• Print to a File, page 367
Print Command
File > Print
Sends a copy of the active drawing to a specified plotter, printer, or file. Options are
available for defining the printing area, range, number of copies, and other printing
characteristics. Selecting File > Print also opens the Print dialog box.
Before using this command, you must install and select a printer. For help on
installing a printer, see the printer documentation.
Related Topics
• Printing Drawings: An Overview, page 360
• Set Print Options, page 366
• Working with Drawings: An Overview, page 102
Name - Specifies the printer you want to use. You can select from a list of all the
available configured printers. The information below the Name box applies to the
selected printer. The printer you select in the Name box is the default printer for the
rest of the current design session until you specify a different printer.
Properties - Opens the Printer Document Properties dialog box, which allows you
to specify page setup and other printer settings.
Status - Describes the state of the selected printer, such as, busy or idle. This area is
read-only.
Type - Displays the type of printer currently selected. This area is read-only.
Where - Identifies the printer path, printer port, queue name, or physical location of
the currently selected printer. This area is read-only.
Comment - Displays any comments you entered during printer configuration. This
area is read-only.
Print to file - Stores your drawing in a file with extension .prn instead of sending it to
a printer. The Print to File dialog box appears when you select the Print to file
option on the Print dialog box and then click OK. You select a file name and
location for the print file in the Print to File dialog box. Then you can print from a
computer that does not have the application installed or print to a printer other than
the one you currently have configured.
View - Activates the All and Active check boxes so you can then define the view or
views to print.
Selection - Prints the user-defined area. When you select this option, the Settings
button at the bottom of the Print dialog box is unavailable.
Print black and white - Prints the drawing in black and white.
Number of copies - Displays the number of copies you want to print. Type the
number or use the scroll buttons to specify a number.
Settings - Opens the Settings dialog box, which allows you to view and edit the scale
and origin of your print area. This button is disabled when the Selection option in the
Print range group is selected.
Related Topics
• Print a Drawing, page 365
• Print Command, page 362
• Print to a File, page 367
• Set Print Options, page 366
Best fit - Scales the selected drawing sheets or print area to fit the printer paper for
the configured device.
Manual scale - Specifies the scale value to apply to the print range during printing.
For example, if the print range is a rectangle at 12 cm by 12 cm and you set a manual
scale of 1:12, then the printed range appears to be 1 cm by 1 cm on the printer paper.
If you want a 1:1 drawing of the current sheet scale, you can set the Paper length
option to 1 and the Design length option to 1.
Paper length - Specifies the paper length for the document you want to print with
respect to the Design length option.
Design length - Specifies a design length (size of the printed graphic) with respect to
the Paper length option.
Center - Positions the print area center to the center of the printer paper. If you do not
set this option, then the paper positions at bottom left to bottom left.
Preview - Displays dynamically how the graphic prints on the sheet as you change
other options on the dialog box.
Note
• For many of the options on this dialog box such as, Design length, Paper
length, X, Y, and so forth, when you change an option, the red, blue, and
black boxes in the Preview area change to reflect your new values.
Therefore, you have a dynamic representation of how your graphic fills
the printed sheet.
Related Topics
• Print a Drawing, page 365
• Print a Selected Area, page 365
• Print Command, page 362
• Print to a File, page 367
Print a Drawing
1. Click Print on the Main toolbar.
2. Select the printer that you want to use from the Name list.
3. In the Number of copies box, type the number of copies you want.
4. In the Print range box, specify the range of pages you want to print.
Caution
• It is a good idea to save your drawing before you print it so that a printer
error or other problem does not cause you to lose any work completed
since the last time you saved the drawing.
Notes
• You can set other options for the printer by clicking the Properties button
or the Settings button on the Print dialog box.
• Click File > Page Setup to specify the drawing size.
• You can display the drawing as it is to be printed. Click Tools > Options.
On the General tab, select the Display as printed option.
• Before you can print for the first time, you must connect the printer to the
computer or network, install a printer driver, and select the printer to print
the drawing. For more information about how to install a printer, see the
printer documentation.
Related Topics
• Print a Selected Area, page 365
• Print Command, page 362
• Print to a File, page 367
Related Topics
• Printing Drawings: An Overview, page 360
• Selecting Drawing Items: An Overview, page 132
Notes
• You can set other options for the printer by clicking Properties or
Settings on the Print dialog box. You can set the paper size, source, and
orientation.
• If you want to print more than one drawing, use SmartPlant P&ID
Drawing Manager, which has multiple drawing printing functionality.
Related Topics
• Printing Drawings: An Overview, page 360
Print to a File
1. On the Main toolbar, click Print .
2. On the Print dialog box, select Print to file.
3. Click OK.
4. On the Print to file dialog box, select the folder to which you want to print to,
and type the name of the file.
Note
• The file is saved with a .prn extension.
Related Topics
• Printing Drawings: An Overview, page 360
Opens the Page Setup dialog box, which allows you to specify information about the
layout and size for the drawing or template.
Related Topics
• Creating Drawing Templates: An Overview, page 118
• Save a Drawing or a Drawing Template, page 124
• Set Document Properties, page 115
• Set up a Page Layout, page 369
• Working with Drawings: An Overview, page 102
Custom - Defines the sheet size according to the recorded width (W) and height (H)
values. If you select Custom as the sheet size, you must type custom W and H
values. The Custom option is not available for existing drawings, only for new
templates.
Landscape - Displays the page so that the long edge is the top of the page.
Orientation - Click either the Portrait or Landscape option. The page orientation is
displayed according to each option.
Portrait - Displays the page so that the short edge is the top of the page.
Sheet Size - Sets the size of the sheet. If you select Custom as the sheet size, you
must type custom W and H values.
Note
• You can specify a new sheet size for an existing drawing; that is, you can
change, for example, a B-size drawing to a C-size. Choose the template
size from the list. The size choices are more limited for an existing
drawing than for a new template.
Show Watermark - Specifies when a watermark appears by selecting either the
While working option or the While printing option.
Standard - Defines the sheet size from a list of standard ANSI and ISO paper sizes.
Watermark - Allows you to choose a graphic that faintly appears in the background
of the drawing.
While printing - Displays the watermark only when you are printing the drawing.
While working - Displays the watermark in the background while you are working
within the drawing. The watermark also appears on any printed copies.
Related Topics
• Page Setup Command, page 368
• Set up a Page Layout, page 369
Related Topics
• Creating Drawing Templates: An Overview, page 118
• Printing Drawings: An Overview, page 360
• Working With the Design Window, page 20
Most of the commands that provide access to TEF functionality exist in TEF common
user interface. You have access to the common user interface through commands in
the authoring tools.
In the authoring tools, you can use the commands on the Framework menu to
interact with TEF, including publishing and retrieving data, registering your plant
with a SmartPlant Foundation database, and so on.
The following graphic displays what SmartPlant P&ID publishes and retrieves and
additional information about what data is exchanged.
Ports
• SmartPlant Instrumentation uses physical ports, while SmartPlant P&ID
uses logical ports. SmartPlant Instrumentation publishes the physical ports
with the Dimensional Data Sheets and not the Instrument Index.
SmartPlant P&ID retrieves the Instrument Index and does not retrieve the
Dimensional Data Sheets.
will respond to the claim on the pump and then claim the motor. When
Zyqad publishes, both the pump and motor are published. When P&ID
retrieves they get the update on the pump and get a create task for the
motor, even though they can clearly see the motor on the P&ID. Without it
being claimed to the P&ID project it is not acknowledged as belonging to
the project.
The same holds true for the equipment and nozzle issue. SmartPlant P&ID
permits an equipment object to be claimed to the project without requiring
the nozzles to be claimed, even if the nozzles are seen on the P&ID.
Zyqad's claim method does not support this. When Zyqad retrieves the
equipment claim it claims the nozzles along with the equipment. When
P&ID retrieves from Zyqad the nozzles are Create tasks since P&ID is not
looking to retrieve Claim status from other tools.
In these cases, either the P&ID user will have to delete the create tasks or
agree to add the objects to the project scope. If they agree to add them to
the project scope they should delete the create tasks first, then claim the
objects and then re-retrieve the Zyqad document. This would generate
update tasks. Optionally, since Zyqad requires all related nozzles to be
claimed when claiming equipment, when claiming equipment in
SmartPlant P&ID, all nozzles could be claimed. This causes the scopes of
the claims between Zyqad and SmartPlant P&ID to match.
Search Based on Type Value - Searches the catalog index for all rows with
matching ItemTypeName and Type values and IsDefaultForType = True. If one or
more rows are found, then use the CatalogItemName from the first one. If no match
is found, then perform the search based on Subclass.
Search Based on Subclass Value - Searches the catalog index for all rows with
matching ItemTypeName and SubClass values and IsDefaultForSubclass = true. If
one or more rows are found, then use the CatalogItemName from the first one. If no
match is found, then perform the search based on Class.
Search Based on Class Value - Searches the catalog index for all rows with
matching ItemTypeName and Class values and IsDefaultForClass = True. If one or
more rows are found, then use the CatalogItemName from the first one. If no match
is found, then return an empty string.
Related Topics
• Access the SmartPlant Foundation Web Client from SmartPlant P&ID,
page 399
• Find Documents to Publish from SmartPlant P&ID, page 414
Publish
When a P&ID drawing is published, the Adapter extracts data from the SmartPlant
P&ID database and converts it into a set of objects and relationships that are
compatible with the Framework schema. These objects and relationships are written
out to an XML file and are sent to the Framework Server for further processing. The
adapter depends on the data in the tool schema to support the publish operation.
For each published class in the tool schema, there is a code module in the adapter
known as a Class Publisher. The Class Publisher contains code for the following
tasks:
• Query the P&ID Database - The Class Publisher queries the database to
obtain the collection of items to be published.
• Create a Data Object - For each item to be published, the Class Publisher
creates a data object in the document container. The class of this object is
the Framework schema class related to the MapClass via the
MapClassToClass relationship.
• Set the Property Values - The property values on the data object are set
according to the values on the SmartPlant P&ID item. The list of
properties to be published is defined by the list of MapProperties related to
the current MapClass.
• Publish Relationships - The Class Publisher defines the types of
relationships that are to be published for each data object it publishes.
Retrieve
When a document from another authoring tool is retrieved, the adapter compares the
objects in that document to the data in the SmartPlant P&ID database and generates
tasks in the To Do List. A create task is generated when a new item needs to be
created. An update task is generated when an existing item needs to be modified. A
delete task is generated when an existing item needs to be deleted. The adapter
depends on the data in the tool schema to support the retrieve operation.
For each retrieved class in the tool schema, there is a code module in the adapter
known as a Class Retriever. Each Class Retriever contains code for retrieving a class
of objects.
• Generate Delete Task - The adapter searches for an existing item in the
SmartPlant P&ID database that is correlated to the item that was deleted in
the other application. If such an item is found, a delete task is generated in
the To Do List.
Related Topics
• Drawing, page 393
• Hierarchical Enumerated Lists, page 391
• The SmartPlant P&ID Framework Adapter and Tool Schema, page 376
• The Tool Schema Data Model, page 380
The rectangles on the left side of the graphic represent objects in the tool schema. The
rectangles on the right represent objects in the Framework schema. The relationships
that connect objects on the left with objects on the right are the mapping
relationships. The map file contains both the tool schema objects and the mapping
relationships.
Related Topics
• Hierarchical Enumerated Lists, page 391
• MapClass, page 381
• MapEnum, page 385
• MapEnumList, page 384
• MapProperty, page 383
• MapUoM, page 387
• MapUoMList, page 386
• The SmartPlant P&ID Framework Adapter and Tool Schema, page 376
MapClass
The MapClass object corresponds to the IMapClassDef interface in the diagram
above. In general, there is a MapClass object in the tool schema for each SmartPlant
P&ID class (ItemType) that needs to be published or retrieved. MapClass is referred
to as SPMapClassDef in the Schema Editor. The properties and relationships for a
MapClass can be viewed in the Edit Map Class Definition dialog box.
General
Property Value
UID Must be unique. No other special requirements.
Name The internal name of the SmartPlant P&ID class (ItemType). Required.
Process This property must be filled in for this MapClass to be used. The
Criteria format for this property is a comma delimited list of fields. The fields
are:
ProgID - The programmatic identifier of a class module within the
Adapter.
Expand Attributes Flag - A flag to indicate if the attributes should be
expanded.
Seq No - A number that indicates the sequence in which the classes are
processed. This field is used for Retrieve processing.
Note: The user should not change any of these values. The default
values that come with the delivered Tool Schema should remain
unchanged.
Relationship Comment
Map The map properties associated with the MapClass must be defined
Properties and related to it. (MapClassMapProperties in the diagram.)
Mapping Relationships
Relationship Comment
Related Topics
• MapEnum, page 385
• MapEnumList, page 384
• MapProperty, page 383
• MapUoM, page 387
• MapUoMList, page 386
• The Tool Schema Data Model, page 380
MapProperty
The MapProperty object corresponds to the IMapPropertyDef interface in the diagram
above. In general, there is a MapProperty object in the tool schema for each
SmartPlant P&ID property that needs to be published or retrieved. The properties and
relationships for a MapProperty can be viewed in the Edit Map Property Definition
dialog box in the Schema Editor.
General
Property Value
UID Must be unique. No other special requirements.
Name The internal name of the SmartPlant P&ID attribute. Required.
Selection This field is used to specify the handling of process data properties on
Criteria PipeRuns.
Process For properties that require special handling, the ProgID of the
Criteria appropriate PropertyConversion class must be entered here. In some
cases, additional parameters are also supplied in this field. For simple
properties with matching data types, no value is required here. See the
section on Property Conversions for more information.
Relationship Comment
Exposed by Every MapProperty must be related to a MapClass.
map classes (MapClassMapProperties in the diagram.)
Scoped by If the data type of the property is enumerated, the MapProperty must
enumeration be related to a MapEnumList. If the data type of the property is
UoM, the MapProperty must be related to a MapUoMList.
Otherwise, this relationship is not needed.
(MapPropertyMapEnumList in the diagram.)
Mapping Relationships
Relationship Comment
Map property This relationship defines the property in the Framework schema to
to property which this tool property is to be published. If this relationship is not
defined, the property will not be published.
(MapPropertyToProperty in the diagram.)
Property to This relationship defines the property in the Framework schema
map property from which this tool property is to be retrieved. If this relationship
is not defined, the property will not be retrieved.
(PropertyToMapProperty in the diagram.)
MapEnumList
The MapEnumList object corresponds to the IMapEnumListDef interface in the
diagram above. In general, there is a MapEnumList object in the tool schema for each
SmartPlant P&ID enumerated list associated with a property that needs to be
published or retrieved. The properties and relationships for a MapEnumList can be
viewed in the Edit Map Enumerated List Definition dialog box.
General
Property Value
UID The UID must be constructed using the following pattern:
UID = SP_<CodelistNumber>
<CodelistNumber> The numeric identifier for this enumerated list.
Name The name of the SmartPlant P&ID enumerated list.
Relationship Comment
Scoped map A MapEnumList must be related to the MapProperties that it scopes.
properties (MapPropertyMapEnumList in the diagram.)
Contains A MapEnumList can contain a variable number of MapEnum
objects. (MapEnumListMapEnum in the diagram.)
Constrains For hierarchical enumerated lists, the MapEnumList must be related
to the lower level list with the Constrains relationship.
(MapEnumListMapEnumList in the diagram.)
Constrained by For hierarchical enumerated lists, the MapEnumList must be related
to the higher level list with the Constrained by relationship.
(MapEnumListMapEnumList in the diagram.)
Mapping Relationships
Relationship Comment
Maps to To support the publish operation, a MapEnumList that should be
related to the corresponding enumerated list in the Framework schema
by means of the Maps to relationship. (MapEnumListToEnumList in
the diagram.)
Mapped To support the retrieve operation, a MapEnumList should be related
from to the corresponding enumerated list in the Framework schema by
means of the Mapped from relationship. (EnumListToMapEnumList
in the diagram.)
MapEnum
The MapEnum object corresponds to the IMapEnumDef interface in the diagram
above. In general, there is a MapEnum object in the tool schema for each SmartPlant
P&ID enumerated list entry that needs to be mapped. The properties and relationships
for a MapEnum can be viewed in the Edit Map Enumerated List Definition dialog
box.
General
Property Value
UID The UID must be constructed using the following pattern:
UID = SP_<CodelistNumber>_<CodelistIndex>
<CodelistNumber> The numeric identifier for this enumerated list.
<CodelistIndex> The numeric identifier for this entry.
Name The text of the SmartPlant P&ID enumerated list entry.
Relationship Comment
Contained In Every MapEnum must be related to a MapEnumList.
(MapEnumListMapEnum in the diagram.)
Mapping Relationships
Relationship Comment
Maps to This relationship defines the Framework schema enumerated value to
which this P&ID enumerated value is to be published. If this
relationship is not defined, the enumerated value will not be
published. (MapEnumToEnum in the diagram.)
Mapped This relationship defines the SmartPlant P&ID enumerated value to
from which this Framework schema enumerated value is to be retrieved. If
this relationship is not defined, the enumerated value will not be
retrieved. (EnumToMapEnum in the diagram.)
Related Topics
• MapClass, page 381
• MapEnumList, page 384
• MapProperty, page 383
• MapUoM, page 387
• MapUoMList, page 386
• The Tool Schema Data Model, page 380
MapUoMList
The following graphic displays a representation of the objects and relationships that
are relevant to the mapping of units of measure (UoM). A MapUoMList is a
specialized kind of MapEnumList. Similarly, a MapUoM is a specialized kind of
MapEnum. This is shown by the Implies relationships in the graphic. A MapProperty
with a UoM data type must be related to a MapUoMList.
General
Property Value
UID The UID must be constructed using the following pattern:
UID = SPMU_<FormatType >
<FormatType> This is a numeric value that uniquely identifies the
format type and therefore the UoM type within SmartPlant P&ID.
Name The name of the P&ID format type.
Relationship Comment
Scoped map A MapUoMList must be related to the MapProperties that it
properties scopes. (MapPropertyMapEnumList in the diagram.)
Contains A MapUoMList can contain a variable number of MapUoM
objects. (MapEnumListMapEnum in the diagram.)
Mapping Relationships
Relationship Comment
Maps to To support the publish operation, a MapUoMList should be related to
the corresponding UoMListType in the Framework schema by means
of the Maps to relationship. (MapEnumListToEnumList in the
diagram.)
Mapped To support retrieve, a MapEnumList should be related to the
from corresponding UoMListType in the Framework schema by means of
the Mapped from relationship. (EnumListToMapEnumList in the
graphic.)
Related Topics
• MapClass, page 381
• MapEnum, page 385
• MapEnumList, page 384
• MapProperty, page 383
• MapUoM, page 387
MapUoM
The MapUoM object corresponds to the IMapUoMDef interface in the diagram
above. In general, there is a MapUoM object in the tool schema for each SmartPlant
P&ID format that needs to be mapped. The properties and relationships for a
MapUoM can be viewed in the Edit Map Unit of Measure List Definition dialog
box in the Schema Editor.
General
Property Value
UID The UID must be constructed using the following pattern:
UID = SPMU_<FormatType >_<FormatName>
<FormatType> This is a numeric value that uniquely identifies the
format type and therefore the UoM type within SmartPlant P&ID.
<FormatName> This is a text value that identifies the name of the format
and therefore the UoM within SmartPlant P&ID.
Name The name of the SmartPlant P&ID format.
Relationship Comment
Contained In Every MapUoM must be related to a MapUoMList.
(MapEnumListMapEnum in the diagram.)
Mapping Relationships
Relationship Comment
Maps to This relationship defines the Framework schema UoM to which this
SmartPlant P&ID format (UoM) is to be published. If this relationship
is not defined, the UoM will not be published. (MapEnumToEnum in
the diagram.)
Mapped This relationship defines the SmartPlant P&ID format (UoM) to
from which this Framework schema UoM is to be retrieved. If this
relationship is not defined, the UoM will not be retrieved.
(EnumToMapEnum in the diagram.)
Related Topics
• MapClass, page 381
• MapEnum, page 385
• MapEnumList, page 384
• MapProperty, page 383
• MapUoMList, page 386
• The Tool Schema Data Model, page 380
Property Conversions
If the data type of the SmartPlant P&ID property does not match the data type of the
mapped TEF property, a data type mismatch exists. In some cases, a property with a
data type mismatch can still be published and retrieved using specialized code. The
code to perform these data type conversions and other special handling is
implemented in special Property Conversion objects. The SmartPlant adapter is told
about the need to use a Property Conversion object by putting the ProgID of the
Property Conversion class in the Process Criteria option of the MapProperty. The
list of available Property Conversion classes is shown in the table below.
Note
• The ProgID for each of these classes is formed by prefixing the class name
with the string EFAdapter.
Class Name Description
BoolToEnumConv This property conversion supports the conversion needed to
publish and retrieve the SmartPlant P&ID
SP_IsSpecialtyItem property to/from the
CommoditySpecialtyType property in TEF.
CompFlowDirConv This class only publishes the special property called
IsFlowDirectional. There is no property named
IsFlowDirectional in SmartPlant P&ID. This information is
derived from the Flow Direction property value. If the
Flow Direction on a component is set, then this will publish
IsFlowDirection as True; otherwise, it is published as
False.
EnumConversions This class implements the property conversion code for
Hierarchical Enumerated Lists.
EnumToBoolConv This class implements the property conversion code
between Enumerated to Boolean. This property conversion
module specifically targeted to handle
StressAnalysisRequirement property in SmartPlant P&ID.
EnumToStringConv This class implements the property conversion code
between Enumerated List to String.
NominalDiameterConv Converts Nominal Diameter from an Enumerated List to a
UoM during publish and from a UoM to Enumerated List
during retrieve.
PortFlowDirectionConv Special property conversion to handle the publishing of
FlowDirection property on Connect Point. The Select List
values for FlowDirection for SmartPlant P&ID Piping
Point and TEF PIDPipingPort do not match well.
SmartPlant P&ID uses only one Select List for
Related Topics
• Drawing, page 393
• Hierarchical Enumerated Lists, page 391
• The SmartPlant P&ID Framework Adapter and Tool Schema, page 376
• The Tool Schema Data Model, page 380
• Tool Schema Location, page 379
When mapping between SmartPlant P&ID and the Framework schema, four cases
must be considered.
1. Simple enumerated list to simple enumerated list.
2. Simple enumerated list to hierarchical enumerated list.
3. Hierarchical enumerated list to simple enumerated list.
4. Hierarchical enumerated list to hierarchical enumerated list. When mapping
between two hierarchical enumerated lists, the number of levels in each hierarchy
may not be the same.
EnumConversions - A special Property Conversion class is available to support
publishing and retrieving of enumerated properties. This class is called
EnumConversions, and it is used for all cases of mapping enumerated list properties.
Mapping Properties - Only the top level properties associated with a hierarchical
enumerated list are mapped. The lower level properties are left unmapped. The
EnumConversions object obtains all of the values from the set of related properties
even though they are not explicitly mapped.
Related Topics
• Access the SmartPlant Foundation Web Client from SmartPlant P&ID,
page 399
• Find Documents to Publish from SmartPlant P&ID, page 414
Catalog Index
During retrieval of a document, when a create task is generated, the adapter must
select a symbol to be used by the task. The adapter uses the Catalog Index to quickly
find a suitable symbol to be used. The Catalog Index lookup is based on the type
properties. For example, when generating a create task for Equipment, the Equipment
Class/Subclass/Type properties are used to perform the lookup. Before the Catalog
Index lookup can take place, the incoming TEF type values must be converted into
SmartPlant P&ID type values. This conversion of an Framework schema enum value
into a SmartPlant P&ID enumerated value is performed by the EnumConversions
object just like any other enumerated property value. It depends on the mapping of
enumerated values found in the tool schema.
Related Topics
• Drawing, page 393
• Hierarchical Enumerated Lists, page 391
• The SmartPlant P&ID Framework Adapter and Tool Schema, page 376
• The Tool Schema Data Model, page 380
• Tool Schema Location, page 379
Drawing
There is a MapClass in the tool schema for Drawing. The MapProperties for this
MapClass define the properties that will be published from the SmartPlant P&ID
Drawing item to the Framework schema PIDDrawing object. If new properties are
added to the Drawing item type in the Data Dictionary Manager, and corresponding
new properties are added in the Framework schema, then they can be mapped by
adding new MapProperties to this MapClass in the tool schema using the Schema
Editor.
Related Topics
• Drawing, page 393
• Hierarchical Enumerated Lists, page 391
• The SmartPlant P&ID Framework Adapter and Tool Schema, page 376
• The Tool Schema Data Model, page 380
• Tool Schema Location, page 379
Equipment
In SmartPlant P&ID there is an abstract class for Equipment with four subclasses for
Vessel, Exchanger, Mechanical and OtherEquipment. In the Framework schema,
there are four PID equipment classes.
1. PIDProcessVessel
2. PIDHeatTransferEquipment
3. PIDMechanicalEquipment
4. PIDProcessEquipment
The tool schema has a MapClass for each of the four equipment subclasses in
SmartPlant P&ID and another MapClass for the abstract Equipment class.
Retrieve - When a document is being retrieved, each incoming object is tested for
identifying interfaces to determine what type of object it is. The object is first tested
for the identifying interfaces for Vessel, Exchanger, Mechanical and
OtherEquipment. If the object has one of these identifying interfaces, it is retrieved as
that specific type of equipment (using the MapProperties associated with the specific
MapClass for that equipment class in the tool schema). If the object is not recognized
by its interfaces as any of these specific equipment types, but it is recognized as
Equipment, it is retrieved as generic equipment (using the MapProperties associated
with the generic Equipment MapClass in the tool schema).
Related Topics
• Drawing, page 393
• Hierarchical Enumerated Lists, page 391
• The SmartPlant P&ID Framework Adapter and Tool Schema, page 376
• The Tool Schema Data Model, page 380
• Tool Schema Location, page 379
Instrument
In SmartPlant P&ID there is one Instrument class.
• PIDInstrument
• PIDInlineInstrument
• PIDControlSystemFunction
The tool schema has three MapClasses.
• Instrument
• InstrumentInline
• InstrumentCtrlSysFunc
The SmartPlant P&ID adapter has three separate Class Publisher/Retriever objects for
these three classes.
Publish - All SmartPlant P&ID instruments with Instrument Class equal to System
Function are published as PIDControlSystemFunction using the
InstrumentCtrlSysFunc MapClass. All SmartPlant P&ID instruments with IsInline
equal to True are published as PIDInlineInstrument using the InstrumentInline
MapClass. All other SmartPlant P&ID instruments are published as PIDInstrument
using the Instrument MapClass.
Retrieve - All objects that have the IControlSystemFunction interface are retrieved as
Instruments using the InstrumentCtrlSysFunc MapClass. All objects that have the
IInstrumentOcc interface are retrieved as Instruments using the PIDInlineInstrument
MapClass.
Related Topics
• Drawing, page 393
• Hierarchical Enumerated Lists, page 391
• The SmartPlant P&ID Framework Adapter and Tool Schema, page 376
• The Tool Schema Data Model, page 380
• Tool Schema Location, page 379
PipeRun
In SmartPlant P&ID there is a single class for PipeRun. This class has properties
describing aspects of the physical pipe and other properties that describe the fluid
flowing through that pipe. In the Framework schema there are two relevant classes:
PIDPipingConnector for the pipe itself and PIDProcessPoint for the process data.
Furthermore, the Framework schema has several classes that are used to publish a
stream and its associated process data on a PFD. The SmartPlant P&ID tool schema
has one MapClass for PipeRun.
Select Criteria - In the Schema Editor, the Select Criteria option on the
MapProperty is used to indicate to the adapter how to handle each property for both
publish and retrieve. The format of the Select Criteria option is:
PipeLine
In SmartPlant P&ID, you draw graphical piperuns to indicate the schematic piping
design. You can assign naming properties to these piperuns. All of the piperuns with
matching values for the naming properties form a logical group. Such a group is
sometimes called a pipeline and the values of the naming properties represent the
name of the pipeline. All of this is done without requiring you to explicitly create a
pipeline object.
In the Framework schema there is an explicit PIDPipeLine class. Objects of this class
must be published with relationships to the associated PIDPipingConnectors. Some
downstream applications depend on the existence of the PIDPipeLine for their
processing.
The SmartPlant P&ID adapter creates and deletes pipelines dynamically during the
publish operation. The pipelines and the relationships to the piperuns are published as
if they really existed in the SmartPlant P&ID database. The tool schema contains a
MapClass for PipeLine. The MapProperties for the pipeline MapClass define the
properties that are published to the PIDPipeline object.
Related Topics
• Drawing, page 393
• Hierarchical Enumerated Lists, page 391
• The SmartPlant P&ID Framework Adapter and Tool Schema, page 376
• The Tool Schema Data Model, page 380
• Tool Schema Location, page 379
Related Topics
• Browser Command, page 399
Browser Command
If the active database is properly registered with The Engineering Framework (TEF),
the Framework > Browser command opens the SmartPlant Foundation Web Client.
Related Topics
• Accessing the SmartPlant Foundation Web Client: An Overview, page 398
The authoring tools publish data to TEF in XML format. The software then places the
.XML file in the appropriate SmartPlant Foundation vault and loads the data from the
.XML files to the SmartPlant Foundation database. After the document is published,
users can retrieve the data from the .XML file in the SmartPlant Foundation vault into
other authoring tools.
When you publish documents, the software does the following things:
• Places the published .XML file and any view files in the appropriate
SmartPlant Foundation vault. This .XML file can be retrieved when users
in the authoring tools retrieve as-published data.
• Sends notification to the publishing tool.
For more information about revisions and versions, see the SmartPlant Foundation
Web Client User's Guide or the SmartPlant Foundation Desktop Client User's Guide.
Reasons to Publish
You can publish documents and associated data into TEF for several reasons:
You can also publish a document by not assigning the document to a workflow, but
rather by using the default workflow from SmartPlant Foundation. When you do not
select a workflow for a document during publishing, the Framework Loader Manager
loads the document into SmartPlant Foundation as soon as it reaches the top of the
Loader queue.
Publishing Documents
Each authoring tool publishes different documents and data.
The PBS document contains information about the physical plant with a structure
consisting of plants, areas, and units. The default structure is plant/area/unit, but you
can define a custom hierarchy in the Schema Editor. When a PBS document is
published from SmartPlant Foundation, the authoring tools are notified about the
plant, areas, and units that need to be created in each authoring tool.
The project breakdown structure, project definition document, and project list contain
information about projects and their statuses. When these documents are published
from SmartPlant Foundation, the authoring tools are notified of projects and contracts
that need to be created in the authoring tools.
The project breakdown structure contains a single project and the hierarchy of
contracts under that project in a plant/project structure. The project definition
document contains information for a single project that needs to be created in the
authoring tool. The project list contains a list of all projects in a plant, and it is used
by those authoring tools that create all projects at one time.
Note
• The plant breakdown structure and project breakdown structure used in the
authoring tools must match the structure in SmartPlant Foundation for
publishing from the authoring tools and object correlation to work
correctly.
Note
• When you publish data from an authoring tool, you may not be able view
all the properties that you published in the SmartPlant Foundation client.
You can customize view definitions to allow you to see additional
properties. For more information about defining view definitions in the
Framework schema, see Working with View Definitions: An Overview
and Create a View Definition in the Schema Editor User's Guide. For
further assistance with visualizing data in SmartPlant Foundation, contact
Intergraph Support Services.
Related Topics
• Find Documents to Publish Command, page 412
• Publish Command, page 403
• Publish Dialog Box, page 404
• Publish Documents, page 409
Publish Command
The Framework > Publish command allows you to write the information in the
active document or documents from the authoring tool to The Engineering
Framework.
Related Topics
• Publish Dialog Box, page 404
• Publish Documents, page 409
• Publishing to The Engineering Framework: An Overview, page 400
Publish tab
Issue tab
The following fields and buttons are available regardless of which tab is displayed.
Selected documents - Displays a list of the documents selected for publishing. You
must populate this list by selecting documents before you use the Publish command
or by clicking the buttons in the Add section of this dialog box. For each document,
this list displays the name, the type of document, the workflow from which the
document was last published, the revision and version numbers, the revision scheme,
and the date when the document was last published.
Engineering Tool - Opens an authoring tool-specific dialog box that allows you to
select documents to add to the Selected documents list.
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 opens, allowing you to
specify information about the file, such as whether it is a new file or was previously
published; 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.
Related Topics
• Document Properties Dialog Box, page 408
• Publish Command, page 403
• Publish Documents, page 409
• Publishing to The Engineering Framework: An Overview, page 400
You can change some of the values assigned to one or more documents by changing
the value displayed in the table. The value you enter here will override any existing
values for all selected documents.
Last Published - Indicates the date on which the document or documents were last
published.
Source - Indicates the authoring tool in which the document was created.
Tips
• Even with this option set, documents may still be published. Any
documents that have never been published must be published, regardless
of this setting.
• You will receive an error message if you select multiple document and
activate this option when one or more of the selected documents cannot be
changed. For example, if a selected set of documents includes both a new
document (for which this field can be set only to No) and current or frozen
documents (for which this field can be set only to Yes). The error message
prompts you to select a smaller set of documents.
Revision - Displays the current revision number of the selected document or
documents.
Tip
• 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.
Tip
• You will receive an error message indicating that this field cannot be
edited if one or more of the documents 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.
Tip
• You will receive an error message indicating that this field cannot be
edited if one or more of the documents you have selected have conflicting
sets of possible workflows. The error message prompts you to select a
smaller set of documents.
Operation - Select the operation you want to perform on the selected documents.
Choose from the following options:
Related Topics
• Document Properties Dialog Box, page 408
• Publish Command, page 403
• Publish Documents, page 409
• Publishing to The Engineering Framework: An Overview, page 400
Issue to - Contains a list of all objects that can support issue requests. When you
select an item from this list, the names and reasons for issue of any documents
associated with that object appear in the table below.
Add - Creates a new item in the table for any documents highlighted in the Selected
documents tree view.
Document Name - Displays the names of all documents associated with the object in
the Issue to field.
Related Topics
• Document Properties Dialog Box, page 408
• Publish Command, page 403
• Publish Documents, page 409
• Publishing to The Engineering Framework: An Overview, page 400
Tips
• An asterisk (*) next to a field indicates that the field must be completed
before the OK button is available.
Selected file - Displays the name of the file you selected on the Select File dialog
box.
New document - Indicates that this document has not previously been published to
The Engineering Framework.
Published previously - Indicates that the file has already been published to TEF at
least once before.
Document type - Select the type of the document. The options that appear in this list
are determined by the selection you make in the Document category field.
Document subtype - If applicable, select the subtype for the document. The options
that appear in this list are determined by the selection you make in the Document
type field.
Descriptions - Enter a brief description of the file. This description appears later to
help you recognize the file.
Related Topics
• Publish Dialog Box, page 404
Publish Documents
1. From within the authoring tool, click Framework > Publish.
Tips
• This feature is also available through the SmartPlant Foundation Web
Client.
• This command is available only if the active authoring tool plant
database has been registered with The Engineering Framework (TEF).
• The documents that appear in the Selected documents list on the
Publish dialog box when it first appears are documents that were
selected within the authoring tool before you clicked the Publish
command.
2. Add any additional documents to the Selected documents list by using the
Engineering Tool, File System, or Find buttons.
Tip
• When multiple documents are selected, only property values shared by
all the selected documents appear in the grid. Changing a value in the
grid changes that value for all the selected documents.
4. Choose the method of publish you want to use from the Operation field.
• Select the Scheduled publish option to indicate that the publish
process should be run in batch mode, if the authoring tool supports
scheduled batch publishing.
• Choose the Background publish option when you want to publish the
selected documents as a background operation. When you use this
feature, an e-mail message alerts you when the process is complete.
• Otherwise, select Publish now to immediate start the publishing
process as soon as you click OK.
5. Click OK.
Related Topics
• Publish Command, page 403
• Publish Dialog Box, page 404
• Publishing to The Engineering Framework: An Overview, page 400
3. Select the contract to which you want to assign the document or documents from
the Issue to field.
4. In the tree view, select the documents you want to associate with the specified
contract, and click Add to add that document to the list under the contract.
• To add documents from SmartPlant P&ID, click Engineering Tools.
• To add documents from the file system, such as Microsoft Word
documents or Microsoft Excel spreadsheets, click File System.
• To search for documents to publish, click Find.
5. Click OK to publish the issue relation to SmartPlant Foundation.
Related Topics
• Publishing to The Engineering Framework: An Overview, page 400
• Working with The Engineering Framework: An Overview, page 370
Related Topics
• Find Documents to Publish Dialog Box, page 413
• Publishing to The Engineering Framework: An Overview, page 400
Last search performed - Displays the date when the files were last searched. The
information appearing in the lists on this dialog box was found on this specified date
and time.
Document types searched - Indicates what types of files were considered when the
last search was conducted.
Select documents to publish - Displays a list of files that were either updated since
they were last published to TEF or files that have not yet been published. For each
file, this list displays the file name and type, and the date on which the document was
last published. If the file has not been published to TEF, the Last Published field for
the document is New.
Select documents to terminate - Displays a list of all the files that were previously
published to TEF, but have since been removed from the project. For each file, this
list box displays the file name and type, and the date on which the document was last
published.
Select All - Selects all the files in the associated list of documents.
Related Topics
• Find Documents to Publish Command, page 412
• Publishing to The Engineering Framework: An Overview, page 400
Document types - Indicates the types of documents the system should consider when
deciding which documents should be published.
Related Topics
• Find Documents to Publish Command, page 412
• Publishing to The Engineering Framework: An Overview, page 400
3. From the Select documents to terminate list, indicate the documents that you
want to remove from TEF.
Tips
• Documents in this list are in TEF but are no longer present in the
authoring tool.
• This step is necessary only if a document was deleted from the
authoring tool, but is still available in TEF.
• The selected documents now appear in the Documents to Publish list
on the Publish dialog box, and you can publish them to TEF. For more
information about publishing documents, see
Publish a Document to The Engineering Framework.
Note
• The lists displayed on the Find Documents to Publish dialog box are
compiled at the time indicated in the Last search performed box. You
can update the lists by clicking Update, but this process can be time
consuming, depending on the mode you are running the applications in:
synchronous or asynchronous.
Related Topics
• Publishing to The Engineering Framework: An Overview, page 400
• Working with The Engineering Framework: An Overview, page 370
The authoring tools provide commands that let you select a document and retrieve it
into that tool. You can use either the Framework > Retrieve command to open a
dialog box that assists you in retrieving applicable documents.
Additionally, you can access the Web Client through the Framework > Browser
command. This allows you to select the document or documents that you want to
retrieve from your Web Client To Do List, the tree view, or by using the Web Client
search functionality. After you select the documents that you want to retrieve, you
can use the Retrieve command on the Web Client Framework menu to start the
retrieval process.
The Retrieve command provided in the authoring tools is slightly different from the
Retrieve command available in the SmartPlant Foundation Web Client. The Web
Client presents a list of documents from which you can select those you want to
retrieve. However, when you use the command from an authoring tool without first
selecting documents, the software searches the SmartPlant Foundation project for
documents to retrieve, and these are presented in a list on the Retrieve dialog box.
From the authoring tools, you can retrieve the plant breakdown structure (PBS) and
project documents. The PBS and project documents, created in SmartPlant
Foundation and published to TEF, are retrieved by authoring tools to provide
information about the plants, areas, units, projects, and contracts that need to be
created in the authoring tool so that the information is consistent across all authoring
tools.
The project breakdown structure, project list, and project definition document
contain information about the project or projects and their statuses in a plant/project
structure.
Design Basis
Objects that tools retrieve from other authoring tool documents can become the
design basis for objects in downstream documents. Objects that become the design
basis for other objects can be specific objects that get richer as they move through the
lifecycle or can be schematic or logical objects in one application that evolve into
more detailed objects downstream.
Design basis is implicit based on retrieval; you do not have to define it. For example,
a pump retrieved from a PFD becomes the design basis for a pump in the P&ID.
When you change common properties for the pump and retrieve the changes into
SmartPlant P&ID, tasks to update property values automatically appear in the To Do
List. The same process works for logical items that are a design basis for other items,
such as a stream in Zyqad that results in multiple pipe runs in SmartPlant P&ID.
Related Topics
• Retrieve Command, page 418
• Retrieve Dialog Box, page 419
Retrieve Command
The Framework > Retrieve command provides a list of the documents that need to
be retrieved into the authoring tool. This list is displayed in the Retrieve dialog box,
from which you can select the documents you want to retrieve, bringing the
information from The Engineering Framework (TEF) into the authoring tool.
Related Topics
• Retrieve Dialog Box, page 419
• Retrieving from The Engineering Framework: An Overview, page 416
Document type - Indicates the type of documents you can retrieve from TEF and
changes the list view to show only that document type.
Show - Indicates what documents you want to see in the list. Choose from the
following options:
Select All - Selects all the files in the associated list of documents.
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.
Related Topics
• Retrieve Command, page 418
• Retrieving from The Engineering Framework: An Overview, page 416
3. From the Documents to retrieve list, select the documents you want to retrieve
by clicking the corresponding check box.
Tip
• You can quickly select the entire list by clicking Select All, or you can
clear the entire list by clicking Clear All.
4. By using the Retrieve Option list for each document you are retrieving, select
whether you want to retrieve each document by using the As published option or
the With the latest data option.
Notes
• You can select the Batch retrieve option to indicate that the retrieval
process is run in batch mode — that is, in the background. When you use
this feature, an e-mail message alerts you when the process is complete.
Otherwise, the retrieval process begins interactively as soon as you click
OK.
Related Topics
• Retrieving from The Engineering Framework: An Overview, page 416
• Working with The Engineering Framework: An Overview, page 370
The Correlate Items command allows you to review and manage these relationships
within the drawing environment.
When you import a document into SmartPlant P&ID from The Engineering
Framework (TEF), each item that is created in a stockpile is automatically correlated
to the design basis item from which it came.
Related Topics
• Correlate Additional Items with a Design Basis Item, page 424
• Remove the Correlation Between Added and Design Basis Items, page 424
Correlate Command
Framework > Correlate
Opens the Correlate Items dialog box and allows you to review and edit the
correlation between plant items and design basis items.
Related Topics
• Correlate Additional Items with a Design Basis Item, page 424
• Correlating Items: An Overview, page 422
• Remove the Correlation Between Added and Design Basis Items, page 424
Items - Lists all the items associated with a single design basis item. Items in the
active drawing are displayed in bold font style. A single item can be selected from the
list, and when selected, the item is highlighted in the drawing.
Select - Allows you to review a different drawing item. Clicking this button clears the
Items list. As you move your pointer over an item in the drawing that is already
correlated, the item is highlighted. When you click on a correlated item, it is added to
the Items list as a primary item. Then the application searches the database for all
other items that are correlated to the same design basis item and adds them to the list
as well. Right-clicking quits this command.
Add - Allows you to correlate an additional item to the same design basis item that
the listed items are already correlated to. This command is available only when one or
more items already appear in the Items list. As you move your pointer over an item in
the drawing that has the same item type as the items in the list, the drawing item is
highlighted. When you click on a highlighted item, it is correlated with the same
design basis item, and it is added to the list. If you click on an item that is already
correlated to some other design basis item, a confirmation message appears. If you
correlate a new item with a previously correlated item, both are associated with the
same design basis item; however, the new item inherits the properties of the item that
it is correlated to rather than the design basis item.
Remove - Deletes the selected item from the Items list and cancels its correlation
with the design basis item.
Related Topics
• Correlate Additional Items with a Design Basis Item, page 424
• Correlate Command, page 422
• Remove the Correlation Between Added and Design Basis Items, page 424
A single To Do List is shared by all the users of a plant database. You can view the
entire To Do List and see the tasks that have been completed and those that are
pending. Some types of tasks have associated code and you can run them thereby
causing the database or drawings to be modified.
From the To Do List, you can perform tasks, defer them, or delete them altogether.
Additionally, you can view properties for each task in the To Do List. The
information that is available is specific to the type of task that is selected: Create
tasks and Update tasks, for instance, but certain information is provided for all types.
The available task types are
Notes
• When an Update task is created in the To Do List, the units of measure
used in properties are automatically converted to the defaults for the plant.
The units of measure used for properties in Create tasks are converted to
the plant defaults when the task is run.
• By clicking the heading of columns on the To Do List, you sort the list by
the values in that column. You can change the order in which these
columns appear in the Task List by right-clicking a column heading and
choosing either Shift Left or Shift Right from the shortcut menu to move
the column one place in either direction.
Related Topics
To Do List Command
Framework > To Do List
Opens the To Do List dialog box, which lists tasks to be performed in SmartPlant
P&ID. From this dialog box, you can run, defer, or delete tasks, and you can organize
your tasks.
Note
• This command is available regardless of whether a drawing is open or not.
Related Topics
• Using the To Do List: An Overview, page 425
Open Drawing - Opens the drawing associated with the selected task. If the
drawing is not active, this command activates it. Any drawings that are currently
open, remain open. This command is available when a drawing-specific task is
selected and the drawing is not currently open or active. If multiple tasks are selected,
this command is available only if they are assigned to the same drawing. You can
assign or reassign a Create task, but Update and Delete tasks that are already
assigned to a drawing cannot be reassigned.
Zoom In - Centers and zooms in on the drawing items associated with the
selected task or tasks in the Drawing view. You select the tasks from the Task list on
the To Do List dialog box. This command allows you to visually inspect the
referenced objects in the context of the surrounding drawing and is available when
the selected task is associated with graphics and the drawing that contains the object
is open and active. If multiple tasks are selected, this command is available only if
each of the tasks meets these criteria.
New Manual Task - Displays the Task Properties dialog box, and allows you
to manually create a new task.
Properties - Displays the Task Properties dialog box for the selected task. This
dialog box shows the detailed properties of the task. This command is available only
when a single task is selected.
Assign Drawing - Creates an association between the selected task or tasks and a
particular drawing. The Assign Drawing dialog box opens and lists the available
drawings. This command is available when you select manually added tasks or tasks
resulting from the Create command. If multiple tasks are selected, this command is
available only if each of the tasks meets these criteria.
Run Task - Runs the task that you select from the Task list on the To Do List
dialog box. This command is available when an executable task is selected, the
associated drawing is open and active, and the status of the selected task is Open or
Error. This command is not available for manually created tasks; in other words, the
command is only available for tasks generated automatically by integration with The
Engineering Framework (TEF) and importing of data from TEF. If multiple tasks are
selected, this command is available only if each of the tasks meets these criteria.
Note
• When a task runs, the status of the task and the Run Date and Run By
properties are updated. If the task runs successfully, the status is updated
to Completed . If there is a problem, the status is updated to Error ,
and a timestamp and error message are added to the Notes area.
Defer Task - Toggles the status of the selected tasks between Open and
Deferred . This command is available only when the selected task or tasks have
either Open, Error , or Deferred status.
Delete Task - Allows you to delete the selected task from the To Do List. This
command is available only when one or more tasks are selected. A confirmation
dialog box appears to verify deletion of the selected task or tasks.
View Deleted - Displays a list of tasks that have been deleted from the To Do
List in the Task list on a gray background. This command toggles this feature on and
off. If you wish to completely delete tasks from the list of deleted tasks, you can
select them and click Delete Task again on the To Do List toolbar.
Report - Opens Excel and runs a report on the contents of the To Do List. This
command is only available from the To Do List toolbar, but the report template,
called To Do List.xls, produces reports much the same way other SmartPlant reports
are produced.
Refresh - Updates the information that is displayed in the To Do List. Since only
one To Do List is generated per plant, multiple users can be working in the To Do
List at the same time, and so the information can change at any time. You can use the
Refresh command to stay up-to-date.
Group Related Tasks - When this button is depressed, clicking on the column
header not only sorts the tasks based on the selected sort key but also groups the
related tasks. If the Group Related Items button is not depressed, then clicking on
the column header only sorts the tasks based on the selected column sort key.
Task List - Populates automatically when you retrieve a document from TEF. This
list provides information about each task, including, for example, the status of the
task, the destination drawing, the name of the task, a description of the task, and so
forth. By clicking the heading of any of these columns, you sort the list by the values
in that column. You can change the order in which these columns appear in the Task
List by right-clicking a column heading and choosing either Shift Left or Shift Right
on the shortcut menu to move the column one place in either direction. Double-
clicking a task opens the Task Properties dialog box for that task.
Related Topics
• Open the To Do List, page 429
• To Do List Command, page 426
Related Topics
• Using the To Do List: An Overview, page 425
Code Lists and Select Lists - In PDS, an attribute that is restricted to pre-defined
values is said to be code-listed. These values for SmartPlant P&ID properties are
called select-listed values; they reside in a select list. For more information, see
Comparing Code Lists and Select Lists, page 431.
Grouping Equipment in SmartPlant P&ID - With PDS™ 2D, before you place an
equipment group, you must identify the equipment group before adding equipment
components to a piece of equipment. With SmartPlant P&ID whenever you place a
component on a piece of equipment, the software automatically creates a group
relationship among the equipment and its components. For more information, see
Grouping Equipment in SmartPlant P&ID, page 432.
Setting Construction Status - In PDS 2D, you set the construction status by clicking
the New, Future, or Existing buttons on the Construction Status control. When you
place an item, the default construction status is New. In SmartPlant P&ID, you can
set construction status before or after you place an item. For more information, see
Setting Construction Status, page 433.
Comparing Graphics and Text in PDS 2D and SmartPlant P&ID - In PDS 2D,
graphics are called cells. These graphics include pumps, tanks, piping, valves, and
other items. In SmartPlant P&ID, graphics are called catalog items. For more
information, see Comparing Graphics and Text in PDS 2D and SmartPlant P&ID,
page 437.
Using Filters Versus Levels - PDS 2D uses levels to separate data types in the
Drawing view. In SmartPlant P&ID, filters show certain parts of the drawing, such as
only the equipment or only the piping, and you can combine filters. For more
information, see Using Filters Versus Levels.
Related Topics
• Comparing Code Lists and Select Lists, page 431
• Comparing Consistency Check to Propagation, page 434
• Grouping Equipment in SmartPlant P&ID, page 432
• Setting Construction Status, page 433
Note
• When you add an entry to a codelist, the system automatically assigns a
number for the entry. The value assigned will be greater than 10,000.
In SmartPlant P&ID, some properties are likewise restricted to preset values. These
values for SmartPlant P&ID properties are called select-listed values; they reside in a
select list. Select entries are the individual members of a select list. Select lists and
their select entries are defined in SmartPlant Data Dictionary Manager. For more
information on defining select lists and entries, see SmartPlant Data Dictionary
Manager Help.
Some code lists and select lists contain special, restricted values, frequently in the
Short Value entry. These special values help SmartPlant P&ID communicate
information to other applications, such as PDS 3D and SmartPlant 3D. Consequently,
you should use caution when modifying any entries already included with the product
when it is delivered to you. You must have special permissions, granted in SmartPlant
Engineering Manager, to modify select lists in SmartPlant Data Dictionary Manager.
Related Topics
• Review and Edit Item Properties, page 86
Related Topics
• Place Equipment, page 140
In SmartPlant P&ID, you can set construction status before or after you place an item:
• If you know the construction status before placing an item, click Tools >
Options, and then set the status on the Placement tab. All items that are
subsequently placed in the drawing are assigned this status.
• If you have already placed an item, select the item in the drawing and
change the status in the Properties window.
Related Topics
• Customize the Software With the Options Command, page 26
To check for errors in your design, PDS 2D uses propagation, while SmartPlant
P&ID uses consistency checking. Errors occur when you violate the design practices
for a plant. For example, an inconsistency occurs if a designated material is connected
to a different type of material.
In PDS 2D, propagation checks for errors each time that the software populates the
database. You can list the types of errors you want to detect, such as pipe and valve
conflicts. The software detects and reports the errors so you can correct them in the
drawing. However, because you do not receive a list of possible solutions, resolution
can be time-consuming.
Related Topics
• Resolve an Inconsistency, page 320
• Review an Inconsistency, page 320
PDS2D is a drawing-centric application that can load the plant database from the data
in the drawings. Drawings can be created independently and loaded into the database
at a later time. The drawings contain the master data. The database can be regenerated
from the data in the drawings.
The term propagation as used in PDS2D describes the process by which the data in
the drawings are loaded into the database. This process includes three major parts: 1)
Validation of the graphics, 2) Validation of the data and the spreading of the data
through the network of connected items, 3) Loading of the database.
Validation of the graphics, validation of the data and loading of the database are not
included in SmartPlant P&ID System Editing (propagation). System Editing is not a
post-process of any kind. It is not driven by the existence of labels on the drawing. It
does not apply a precedence algorithm to determine the property value for each item.
It is a process that happens every time a property is changed (if the command is
turned on). It is a process by which a property value can be spread throughout a
connected network of items without requiring the user to visit each item. It is a
process by which consistency can be maintained with minimal effort as the design
changes.
Related Topics
• Resolve an Inconsistency, page 320
• Review an Inconsistency, page 320
In PDS 2D, you can record text on a label. Then, at certain times, you propagate or
write the information on the labels to the database.
In SmartPlant P&ID, graphics are called catalog items. SmartPlant P&ID supplies a
pre-loaded set of symbols. Plant administrators can create more symbols if needed.
For more information about creating symbols, see the SmartPlant Catalog Manager
Help.
In SmartPlant P&ID, labels play a different role than in PDS 2D. In SmartPlant
P&ID, you add or edit properties information for each item in the Properties
window, and the software continuously writes this information to the database. Most
labels show item properties, which are stored in the database. These labels are
referred to as "driven," because they are updated as the property values of the item are
updated. SmartPlant P&ID also provides "driving" labels, which you can use to
directly edit properties in the database by editing the properties of the label.
Related Topics
• Place a Label from Catalog Explorer, page 172
Glossary
A
active placement point
Coordinates that define the point where you place piping and instrumentation.
alias
An alternative name for a an object, such as a variable, file, device, or database
instance.
annotations
Dimensions, notes, symbols, or reports that you place in a drawing to provide
information or comments.
archive
To copy a file to a specified storage location and then delete the file from the current
location.
attribute
1. A property or characteristic of a component.
2. A characteristic that all members of a class possess. Each property has an
associated value that defines its current state. Most databases represent an
attribute by a column in a table.
B
backup
To copy a file to a specified storage location while retaining the file in the current
location.
batch processing
A method of processing data that collects a series of operations into a group and runs
the group in a continuous stream without user intervention.
Boolean operator
Syntax that defines logical relationships between expressions like AND (both), OR
(either), and NOT (other than).
branch point
A point on a pipe run that separates piping segments for assignments with different
segment parameters.
break label
A graphic label placed at a point in a piping line at which any property can change
value.
C
cache
Memory that stores recently-accessed data so that subsequent requests to access the
same data can be processed quickly.
catalog
A collection of catalog items, which are blueprints or templates for creating an item
within the model.
check in
Process of moving a file from a user location to a storage location and recording that
location in the database.
class
Blueprint for creating an item. The class defines the properties and behaviors that an
item can show.
client
A user, software application, or computer that requests the services, data, or
processing of another application or computer. The client is the user process. In a
network environment, the client is the local user process and the server may be local
or remote. All network operations among two or more nodes establish a client/server
relationship.
client/server database
A database system in which the database engine and database applications reside on
separate, intelligent computers that communicate with each other through a network.
In this system, the processing power is split between the two CPUs. The workstation
for the user is the client, and the database runs on the server.
code list
See select list.
collaboration
Working jointly. In Workshare, satellite sites work together with the host site to share
the creation and maintenance duties for P&ID drawings and related data.
column
An attribute of a database table. A group of columns defines a table in the database.
commodity code
A code that you define that provides an index to material descriptions.
commodity item
Standard component that you can find in a manufacturer catalog.
commodity option
A pre-defined exception to the default settings for a component definition in the
Piping Job Specification.
component
A catalog item that represents a part of the P&ID. A component has database
information associated with it.
concentric
Having a common center or origin point with varying radii.
configuration files
Files that are used to identify and characterize the components of a network.
Configuration is largely a process of naming network components and identifying
relationships among those components.
connect point
Active point item that is specially designated in a component. A connect point is a
location at which you can connect lines, labels, and other components to one another.
Also, a location for applying a relationship
connectivity
Linkage between items that relates because of their graphics, like a valve and a pipe
run. Proper connectivity must exist to confirm valid data integrity.
connector
Item with multiple vertices; behavior of a connector relies on the two items that it
connects.
D
data dictionary
The underlying data model of a plant, consisting of database entries and select lists.
SmartPlant Data Dictionary Manager maintains this information.
data model
Application items that populate a project. Typical items in a data model are
components, lines, and labels.
database
Collection of files of comprehensive information that have predefined structure and
organization; a specific program can communicate, interpret, or process these files.
database administrator
The technical support person who assigns user IDs and data access permissions,
creates new databases, removes databases no longer in use, and monitors disk storage
usage of the database and performance.
database link
A pointer that defines a one-way communication path from an Oracle database server
to another database server. This pointer is stored in the local database and identifies
the remote database, a communication path to that database, and optionally, a user
name and password. In connected Workshare, the database link is used to access the
remote database, providing the satellite a view into the plant schema at the host site.
database table
Part of the database consisting of rows and columns and containing information about
the project and design elements.
design file
File containing graphics and text data, also called a drawing file.
design-wide break
A region of the drawing within which a single property value is defined for all the
included components. Indicating the region, a closed shape exists, along with an
accompanying label that shows the property value.
display-only annotation
Feature that allows you to generate temporary annotation graphics for review without
placing the graphics in a design file.
drawing file
File in which you place items; also called a design file.
drawing, P&ID
Graphics file that contains data about one unit. Each drawing has a unique drawing
number within the unit to which the drawing belongs.
driving label
Graphics, text, or both with their own entities and properties that you place on the
P&ID to define values for properties of the components and groups to which they
apply.
E
easting
Term used in plane surveying that describes an east, or positive, difference in
longitude.
edge-edge model
Model that represents connectivity entire by edges.
enumerated list
See select list.
equipment components
Items associated with pieces of equipment, such as nozzles and trays. As you place
equipment components, the software automatically creates a group relationship
between the equipment and the component. As a group, the components move along
with the equipment.
equipment group
A single-name equipment body and any items within or attached to the body, such as
a tray or nozzle.
exit elevation
Lowest downstream elevation point on the internal diameter of a pipe.
F
filter
Function that creates a subset of items. This subset meets criteria that property values
define.
fixed point
A control point that usually is a locally known monument with known coordinates.
flow rate
Quantity of fluid that flows per unit of time.
flow time
Required time for the flow, from the start of the piped system, to reach a downstream
point.
G
gap
Condition that exists when two lines intersect graphically on the P&ID but not
physically in the plant.
glyphs
1. Icons attached to the pointer that provide feedback as you draw. For SmartPlant
P&ID, glyphs identify the relationships that you are creating.
2. Icons that show the perpendicular or parallel relationships with other items in the
drawing as you point over items in the drawing.
H
hierarchical
An ordered relationship from greatest to least; refers to the relationships among
groups, components, and labels.
hierarchy
A classified structure with superiors, or roots, and subordinates, or dependents, for
grouping files or commands.
horizontal angle
Angle measured in the horizontal plane. Horizontal angles are the basic
measurements needed to determine bearings and azimuths.
horizontal distance
Distance between two points computed using only the northing and easting
coordinates of the points.
host
A computer that acts as the controlling source of information. In Workshare, a site
that controls satellites.
I
implied piping component
Piping components that the software creates in the alphanumeric database; these
components are not represented graphically.
inline
Term used to refer to those piping or instrument components that you can insert in a
piping segment.
inline instruments
Components that you can insert into a piping segment. Inline instruments include
instrument valves, such as butterfly valves and temperature regulator valves, and
other instrument components, such as orifice plates and flow controllers.
instance
A single allocation of an item class.
instrument loops
A group of one or more instruments or control functions arranged so that signals can
pass from one function to the next for the purpose of measuring and controlling a
process variable. In SmartPlant P&ID, you can create instrument loops containing
any combination of inline and offline instruments.
instruments
Devices that directly or indirectly measure or control a variable in a plant process,
such as flow or temperature. Instruments can be devices such as final control
elements, computing devices, or electrical switches. Two types of instruments exist:
inline instruments and offline instruments.
interference checking
Process that identifies possible collisions or insufficient clearance between items in a
drawing.
isometric
Relating to or concerning a drafting system characterized by three equal axes at right
angles; a view in which the horizontal lines of an item are drawn at an angle to the
horizontal and all verticals are projected at an angle from the base.
item
Unit of storage within a larger unit, such as a file in a catalog; a single member in the
P&ID.
item type
Distinct objects that users can manipulate in SmartPlant P&ID, such as equipment,
events, and safety classes.
K
keypoint
Point on an item, including vertices, to which you can snap in the drawing - that is,
connect to the item.
L
label
A graphic representation that reflects the status or condition of an associated item.
label, PDS 2D
Intelligent graphics and text that identify a group or component. Each label is an
entity with properties and provides the primary means of defining property values in
the P&ID task.
line route
Collection of ordered line runs, gaps, and components that all share the same
attribution. A line route contains line runs, components, gaps, and properties;
however, a line route does not contain any branches.
line style
Collection of formats or properties that you name and store as a group to apply as a
style of a line.
loop
Software structure that allows a specified sequence of instructions to run repeatedly,
if the stated conditions remain constant.
M
MTO
Material take-off; also called a Bill of Materials.
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
OLE-aware programming applications are VBA, Visual C++ Delphi, Visual Basic,
and so forth.
mirror
To create the reverse image of a display set through a plane or around a defined axis.
mirror handle
Reflects an image about the horizontal and vertical axes. Point to the manipulation
handle on upper corner of an item to display the mirror handle.
model
A representation of graphics or a schema; collection of all items and their
relationships to create a coherent description of a process plant.
model file
A design file or database file that defines the 2-D or 3-D geometry and connectivity
of a structure.
N
network
Interconnection of host computers and workstations that allows them to share data
and control. The term has a dual meaning: network can refer to the devices that
connect the system, or network can refer to the connected system.
service name in a connect string for the service to which they wish to connect:
CONNECT username/password@net_service_name.
node name
Name, or alias, that you can assign to the node address of a device on a network.
northing
Term used to describe a north coordinate location in the plant coordinate system.
nozzle
A special equipment item that contains the connection point to piping.
O
offline
Term that refers to those instrument components that are not inserted in a pipe run.
offline instruments
Components that you do not insert into a piping segment. Typically, these
components are the instruments that monitor and control inline instruments. Offline
instruments include temperature regulators, level gauges, and system functions, such
as digital control stations (DCS) or computers.
Oracle Net
Communication software that enables a network session from a client application to
an Oracle database server. Once a network session is established, Oracle Net acts as a
data courier for the client application and the database server. It is responsible for
establishing and maintaining the connection between the client application and
database server, as well as exchanging messages between them. Oracle Net is able to
perform these jobs because it is located on each computer in the network.
ORACLE_HOME
An alternate name for the top directory in the Oracle directory hierarchy on some
directory-based operating systems.
orientation by system
A type of orientation in which the software places items in the same orientation that
you created them, if you place the items in free space or in a horizontal line. For
example, if you placed the item in a vertical line, the software automatically rotates
the item 90 degrees counterclockwise from the orientation in which you created it.
See also orientation by user.
orientation by user
A type of orientation in which you define the orientation of an item when you place
it. The default orientation of this item is identical to items that the software orients.
You can change the default orientation at placement time. See also orientation by
system and orientation fixed.
orientation fixed
A type of orientation in which the software places items in the same orientation in
which you created them, regardless of the method or location that you used for
placement. You cannot change the orientation at placement time. See also orientation
by system and orientation by user.
orthogonal view
A view that is a projection of the drawing onto a plane along lines that are orthogonal
to the plane.
P
PFD
Process Flow Diagram; a drawing that serves as a start for a P&ID.
P&ID
See Piping and Instrumentation Diagram.
parameter
A property with a value that determines the characteristics or behavior of an item.
parametric item
Item that contains geometry constrained together using relationships, with driving
dimensions that are defined as adjustable parameters.
path name
Sequence of directories leading to a file. See also absolute path name and relative
path name.
peak flow
Maximum flow rate of water through a specific size pipe.
pipe run
A line run that has piping properties. Also, a contiguous set of pipe run segments
separated only by inline components, branch points and gap components. A pipe run
has a beginning and an end. It does not branch or contain spaces between
components. A pipe run segment may have identical properties as a pipe run from
which it branches but is not considered part of the pipe run.
pipeline
Set of connected piping segments and their associated piping items. Also, the
collection of pipe runs from all drawings in a project whose project-defined line
property values are identical.
piping components
Graphic elements that represent processes or functions within a particular piping
segment. Piping components include valves, flanges, reducers, strainers, and safety
components. In drawings, piping components are connected with multiple line
segments.
piping network
Series of connected pipe runs and inline components. A network terminates at a
nozzle, off-page connector, utility connector, or one-point piping component - for
example, a pipe cap.
piping segment
A line string with two or more vertices that defines the centerline geometry of the
pipe run and contains the non-graphic data associated with the pipe run.
plant
A group of facilities and equipment that performs one or more material processing
functions within a given geographical area. One company can have several plants
located at different geographical locations.
plant structure
Represents the business structure or physical hierarchy of a plant.
PFD
Process Flow Diagram; a drawing that serves as a start for a P&ID.
process line
Ordered collection of connectors and inline components with an equal set of core
properties - typically, items with the same line number. Specifically, a representation
of the piping that transfers process fluid.
process point
A tool that defines the operating conditions at a particular place during a process.
Examples include defining temperature, density, and flow rate.
project
1. A directory file created in an application environment that contains design files
and subprojects. A project is not necessarily specific to an application; the project
may contain design files from multiple applications.
2. Term used for convenient grouping of either all or part of the items that constitute
a plant. Several projects can be under design at one time, probably in separate
geographical locations and having limited communication among them.
projection lines
Witness lines; lines extending from the boundaries of an item and between which
dimensioning data for the area marked by the projection lines is placed.
property
A unique characteristic of an object, item, symbol, or document.
The properties of an item can include display properties and properties stored with the
item. For example, the properties of a valve symbol can include display properties
such as color, line style, and width. Other properties stored with the valve symbol can
include the manufacturer, cost, or material. Properties stored with the valve symbol
are displayed in the Properties window when the valve symbol is selected.
publish
To release a P&ID drawing for subscription or distribution.
publishing method
To publish a P&ID drawing using either the database link or the file sharing means of
transferring data.
R
reference data
A collection of information containing facts relative to industry design codes, catalog
data of vendors, job specifications, commodity libraries, graphics symbology, label
descriptions, report formats, and other information of a similar theme.
reference file
A drawing file attached to another drawing file for reviewing reference; a graphic
representation attached to a drawing view.
relationship
A condition that exists between items. You can establish relationships as you place
new items or between items already on the drawing sheet. This connection indicates
that some form of communication of behavior or state occurs.
relative mode
A placement mode in which symbols respond to their orientation definition at
creation time, whether they are defined in the P&ID reference data as orientation
fixed, orientation by system or orientation by user, and to the orientation of any
graphic item to which they are attached at placement time. Relative placement mode
is more flexible then absolute, but much more difficult to predict.
report template
An online outline for a new report that you need to define. You can select a user-level
or a project-level template to create a new report template.
required item
Item that the plant model needs. An item is required if the Tag Required Flag
property is set to True for the item in the Properties window of Catalog Manager. If
you delete a required item from a drawing, it appears in the stockpile for later
placement.
revision cloud
A set or arcs used to enclose changes that have occurred since the last revision.
revision triangle
A numbered triangle placed in the P&ID to indicate the drawing revision when the
change occurred.
rule
Standard mechanism for creating relationships. A rule defines a valid context for two
items to communicate their behavior or state.
S
satellite
A server located remotely from the host server. In Workshare, a remote server
connected to a satellite slot at the host server.
satellite slot
The host's side of the Workshare connection. Satellites connect to the satellite slots
made available by the host at the host site.
schema
Description of the overall structure of the rulebase or database.
schema file
File that outlines the overall logical structure of a rulebase or database.
schematic file
Schematic drawing or diagram of a particular item in the plant.
search criteria
Set of values used to scan a database or object library.
segment
Contiguous piping and piping components between two points in the network at
which properties change value. Segments terminate by property break labels,
branches, nozzles, off-pace and utility connectors, and by the terminal ends of piping
lines.
select list
List of related values that SmartPlant P&ID Data Dictionary Manager uses to specify
various aspects of the SmartPlant P&ID data model. For example, select lists allow
you to select from a list of values for specific properties when creating P&IDs, filters,
and symbols. A select list for the fluid code property, for example, allows you to
select from a set of standard entries: such as P for process or MMA for methyl
alcohol.
server
In network operations, the node that maintains common data or performs a common
task that clients need. All network operations between two or more nodes establish a
client/server relationship.
signal lines
1. Intelligent line strings that connect offline instruments, inline instruments, and
piping.
2. An ordered collection of connectors, and inline components with an equal set of
core properties: typically, items that share the same line number. Specifically, a
representation of the wiring used for transferring electrical or software signals.
3. A collection of signal runs from all drawings in a project whose project-defined
line property values are identical.
signal run
A line run with signal properties. See also pipe run.
site
A group of plants. A site can contain one or more plants.
site server
A text file containing the database type, connection alias, data dictionary, and schema
information for the site. Appears as the root directory for each site in SmartPlant
Engineering Manager.
SP_IDs
Unique identification numbers assigned by the SmartPlant software to all items
created in the database.
stockpile
View of the data model, displaying items that you have not yet placed in the graphic
model.
style
1. The appearance of geometry and annotations on the drawing sheet. For example,
color and line weight of an element, the font used in a text box, and so forth.
2. A collection of formats or properties that you name and store as a group. When
you apply a style to a selected item, the software applies all the formats or
properties in the style to the element. The style types include: fill, dimension, line,
and text.
subnet
A division of a network into an interconnected, but independent, segment, or domain,
in order to improve performance and security.
subnet mask
The technique used by the IP protocol to filter messages into a particular network
segment. The subnet mask is a binary pattern that is stored in the client machine,
server, or router and is matched up with the incoming IP address to determine
whether to accept or reject the packet.
subscribe
To sign up for a service. In Workshare, connecting a satellite site with a satellite slot
at the host.
subscribe access
Read-only access to published P&ID drawings.
symbology
1. Display style of an item, including color, pattern, style, and width.
2. In Options Manager, symbology provides graphical clarity to a drawing by
differentiating among various items by their appearance. Symbology refers to the
color, line weight, and style associated with items in a particular filter.
T
table
Collection of data for quick reference, either stored in sequential locations in memory
or printed as an array of rows and columns of data items of the same type.
template
A document or file having a preset format, used as a starting point or blueprint for a
particular application so that the format does not have to be recreated each time it is
used. In SmartPlant P&ID, a file used to create a drawing with a set of default
parameters; a template serves as an outline or blueprint for you to create a new
drawing. In SmartPlant Engineering Manager, a file used to create roles, data
dictionaries or other database schemas.
time stamping
Process that prompts the software to generate a record when you change an property.
transaction
Nongraphic record of any additions, deletions, and changes that you request during
job posting activities.
U
UNC path
Universal Naming Convention. The full name of a resource on a network. It conforms
to the \\servername\sharename syntax, where servername is the name of the server
and sharename is the name of the shared resource. UNC names of directories or files
can also include the directory path under the share name, with the following syntax:
\\servername\sharename\directory\filename.
unit
Group of parts of the schematic and individual worlds of a plant that together perform
a given process function. The identifying number of the unit is unique within the
project and within the plant. Most companies, but not all, use the concept of unit.
user name
Name that provides access to an account on the system. Same as username.
V
validation
Process or program that verifies data integrity in the database.
Index
AABBCC codes segment, 150
assigning, 157 anchor point
access rotating, 225
control, 105 annotations
accessing labels, 198
Help, 14 placing, 199
recent drawings, 110 Apply Display Set
Actions menu options, 262
Stockpile, 44, 249 approved
activating warnings, 310, 313, 320
symbol toolbars, 76 approving
actuators warnings, 320
aligning, 229 area breaks
Adapter claiming, 293
Catalog Index, 392 multi-sided, 200
equipment, 394 rectangular, 200
Hierarchical Enum Lists, 391 arranging
instruments, 395 windows, 40
locating symbols, 392 Aspen Zyqad
MapClass, 393 importing, 248, 252, 322, 328, 329
pipelines, 396, 397 assemblies
piperuns, 396, 397 creating, 282
property conversions, 389 explained, 130
publish, 376 placing, 283
published drawing properties, 393 saving, 280, 281
published instruments, 395 assigning
retrieve, 376 insulation specifications, 246, 247
using, 376 piping specifications, 157, 159, 160, 161
adding associating
buttons, 32, 80 plant groups, 87
catalog items, 66, 70 attaching
commands, 94, 95 commands, 94, 95
instruments, 163, 166, 167 items, 234, 273
insulation specifications, 246, 247 objects, 270
item tags, 163 shortcut buttons, 79
items, 273 author
lines, 149 documents, 112
menus, 96 Auto Join
pipe runs, 149 pipe runs, 144
piping specifications, 157, 159, 160, 161 AutoCAD
reports, 343 exporting, 125
shortcut buttons, 79 OLE objects, 274
stockpile items, 67, 251, 252, 328, 329 Save As, 124
toolbars, 32 autofilter
affixing Engineering Data Editor, 60
labels, 170, 172 tabular views, 61
aligning AutoFilter
labels, 177 customizing, 63
alter options, 61
segment, 147 autogapping
Alter Segment activate, 255
routing lines, 147 lines, 255
altering using, 256
connecting correlations
items, 241, 242 removing, 424
lines, 144, 154 creating
pipe runs, 154 area breaks, 200
to databases, 105, 108 assemblies, 280, 282
to plant structures, 105, 108 buttons, 32
to TEF, 398, 399 catalog nodes, 68
connectors contract packages, 204
deleting, 195, 238 custom catalogs, 72
moving, 194 documents, 102
open partner drawing, 195 drawing templates, 102, 118, 119, 121
opening partner, 194 drawings, 102
placing, 190 filters, 54, 129
stockpile, 24 hydro test packages, 203
storing, 192, 193 item tags, 196
consistency menus, 91, 96
checking, 36, 310, 313, 434 P&IDs, 130
criteria, 317 packages, 200
consistency check report templates, 330, 337, 338, 340, 342, 343,
PDS 2D propagation, 430 344, 346, 349, 353, 354, 355, 356
constraints reports, 330, 334, 335, 341
databases, 131 safety class packages, 201
construction select sets, 241, 242, 243
status, 433 shortcut buttons, 79
construction status tables, 39, 49
placed items, 23 test system packages, 202
setting, 430 toolbars, 32, 71, 91
consulting custom
services, 10 catalogs, 72
contents of reports, 352 customer
continuation support, 10
drawings, 194 customization
continuation drawings Options dialog box, 22
how to, 195 setting, 22
contract packages toolbars, 84
creating, 204 customizing
copying appearance, 26
bulk properties, 87, 88 buttons, 90
files, 266 Catalog Explorer, 78, 80, 82, 90
inline component values, 163 colors, 23, 26
items, 232, 239, 240 compare options, 305, 306
labels, 176 display options, 22
mirrored items, 227 display properties, 26, 34
pipe run values, 163 environments, 26, 91, 95
properties, 46 filter tabs, 90
rotated items, 231 formats, 26
using the select tool, 240 instrument loops, 162
copyrights list views, 77, 78
software, 15 menus, 90, 91, 92, 95, 96
correcting Open dialog box, 107, 108
actions, 208 placement, 433
error conditions, 126, 127, 128 Properties window, 85, 88, 89, 90
graphical operations, 207 reports, 330
inconsistencies, 434 tabular views, 50, 57, 60, 63
correlating toolbars, 31, 32, 33, 90, 91, 94, 95
items, 422, 423, 424 with macros, 90
orientations PickQuick
drawings, 119 configuration tool, 134
Page Setup, 368 placement, 163
printing, 369 placing items, 137
orphan items selecting items, 135, 136
deleting, 98 pipe runs
overviews inline components and validation, 163
creating a drawing, 130 item tag, 254
database, 130 joining, 154
design window, 20 selecting, 241, 242
drawings, 102 pipelines
filters, 129 using the Adapter, 396, 397
labels, 169 piperuns
reports, 330 using the Adapter, 396, 397
SmartPlant P&ID, 11 PipeSpec
System Editing, 257 assigning, 160, 161
working with The Engineering Framework, 370 selecting, 159
P2C2 ServiceLimits.log, 157
Web forum, 15 using, 157
packages piping
creating, 200 branches, 150
stockpile, 76, 77, 250 breaking runs, 153
page setups components, 155
changing, 367 inserting vertices, 149
layouts, 368 joining, 154
Page Setup, 368 properties, 147, 153, 154
printing, 362, 365, 369 routing, 144, 148
templates, 121 runs, 147, 150, 155, 243
panes selecting runs, 243
freezing, 62 specifications, 157, 159, 160, 161
panning Placement tab
views, 30 Options dialog box, 22
parametric placements
handles, 225 construction status, 433
parametrics labels, 169
resizing, 206, 226 one-point, 170, 172, 174
parent tolerances, 23
representations, 45, 142 two-point, 170, 175
pasting placing
bulk properties, 87, 88 annotations, 199
files, 266 area breaks, 200
items, 233, 234, 240, 273 assemblies, 280, 283
objects, 270, 271, 273 catalog items, 66
properties, 46 component labels, 182
special, 273 connectors, 192
paths contract packages, 204
checking, 276 equipment, 140
linking files, 266 flow arrows, 181
PDS 2D heat tracing, 163
cells, 437 hydro test packages, 203
comparing to SmartPlant, 430 in stockpile, 76, 77
construction status, 433 inline instruments, 163
equipment groups, 432 instruments, 163, 165
errors, 310 instruments with heat tracing, 163
solving inconsistencies, 434 internal nozzles, 140
System Editing, 436 items, 66, 130, 132, 134, 137, 206, 220, 250
items, 46, 47, 132, 133, 134, 135, 136, 235, 241, sorting
242, 243 report items, 355
lines, 241, 242, 243 tables, 55
lists, 431 sources
macros, 97, 101 offset, 185, 187
networks, 241, 242, 243 report templates, 344
properties, 47 symbol file, 275
runs, 241, 242, 243 symbols, 270, 271, 274, 276, 283
sets, 46, 83, 84, 85, 212, 213, 235, 241, 242, 243 SP_ID, 299
tool, 133, 134, 209, 235, 240 spaces
selection removing, 196
criteria, 333, 336 specifications
selections insulation, 246, 247
colors, 23 splitting
servers drawings, 212, 213
open site server, 108 spreadsheets
Open Site Server, 105 adding items, 67
ServiceLimits.log Aspen Zyqad, 328
PipeSpec Utility, 157 importing, 252, 329
settings starting
labels, 178 lines, 147
lines, 264, 265 P&IDs, 130
printing, 366 pipe runs, 147
tabular views, 62 statistics
shortcuts current document, 113
buttons, 65, 79, 80, 81, 90 for a drawing, 111
Catalog Explorer, 65 properties, 111
keyboard, 17 setting options, 115
menus, 20, 21 status
showing construction, 433
brief properties, 85, 89 status bar
buttons, 81 prompts, 22
case data, 85, 89 stockpile
inconsistencies, 36, 312, 315 claiming items, 289, 295
leader lines, 177 setting partner locations, 24
sites stockpiles
open server, 108 adding items, 67
Open Site Server, 105 adding to, 76
sizing connectors, 187
drawings, 119, 121, 368, 369 Cut items, 233
SmartFrame deleted items, 235
using, 276, 277, 278 deleting items, 237
SmartPlant Migrator displayed items, 48
importing, 324 drawings, 77
SmartPlant P&ID Engineering Data Editor, 44
Drawing Manager, 12 filters, 129
Insulation Manager, 12 importing, 251, 328, 329
Options Manager, 12 moving items, 45, 166, 167, 206, 249, 250
overviews, 11 OPCs, 190
Rule Manager, 12 overview, 130
SmartSketch packages, 250
migration, 324, 327 placing items, 66, 250
snapping removing items, 232
grids, 139 reporting, 332
solving view, 16
inconsistencies, 320, 434 viewing, 44
storing views, 38, 39, 42, 43, 44, 46, 47, 48, 49, 50, 51, 57,
partner OPCs, 24, 192, 193 58, 59, 60, 61, 62
stream data Tabular Editor
importing, 248, 328, 329 filters, 50
summaries table views, 49
current document, 112 tabular views
for a drawing, 111 editing, 48
setting options, 115 modifying, 48
support reporting, 332
Help, 14 saving, 57
World Wide Web, 14 stockpiles, 249
switching tools, 48
drawings, 110 tags
views, 110 required, 232, 233, 235
windows, 40 validation, 196
symbol XML, 251
sources, 274 tasks
toolbars, 76 To Do List, 425, 426, 427, 429
symbology types, 425
claims, 36, 285, 288, 289, 297, 299, 300 technical
updating, 264, 265 support, 10
symbols TEF, 288, 297, 370
displaying, 69 correlating items, 423, 424
retrieving, 371 correlations, 424
sources, 69, 270, 271, 283 ing items, 422
toolbars, 71, 76 To Do List, 425, 426, 427
using the Adapter, 392 using, 371
System Editing Workshare, 371
compared to PDS 2D propagation, 436 temperature
consistency checking, 257 maximum, 157
enabling, 260, 261 templates
OPCs, 187, 189 creating, 119
overview, 257 creating for drawing, 102
projects, 257 drawings, 118, 119, 121
tables included sizes, 118
bold items, 41 reports, 129, 338, 340, 342, 343, 344, 345, 346,
editing items, 41 347, 349, 350
editing properties, 41, 56, 244 saving, 124
filters, 49, 56 sizes, 119, 121, 368, 369
italic items, 41 terminators
items, 39, 41 types of, 187
layouts, 49, 52, 55, 56 test system packages
new, 54 creating, 202
properties, 39, 49, 54, 89 testing
tabular databases, 131
customizing views, 60, 63 The Engineering Framework, 370
deleting, 58 tiling
displaying views, 62 windows, 40
filters, 61 title blocks
format reports, 338 label type, 178
freezing panes, 62 labels, 183
updating views, 59 placing, 181
view displays, 62 using, 178
view filters, 48 to and from data
view layouts, 48 reports, 356
view settings, 62 to do list
Trademarks
Intergraph, the Intergraph logo, SmartSketch, FrameWorks, SmartPlant, INtools, MARIAN, PDS, and IntelliShip
are registered trademarks of Intergraph Corporation. Microsoft and Windows are registered trademarks of Microsoft
Corporation. Other brands and product names are trademarks of their respective owners.
Table of Contents
Table of Contents
Customer Support and Documentation Comments........................................................5
Index................................................................................................................................226
To use Auxiliary Graphics, select Edit > Insert > Auxiliary Graphics. Selecting
the command opens a drawing sheet that also displays your SmartPlant P&ID
drawing. You can then create graphics using the displayed Draw toolbar. Existing
objects in your current SmartPlant P&ID drawing cannot be selected or edited but do
display for viewing purposes. To return to your SmartPlant P&ID drawing, select
File > Close Auxiliary Graphics. When you return to SmartPlant P&ID, you can
only move the graphics placed using Auxiliary Graphics. To edit the graphics
again, you can either double-click on the SmartFrame, right-click and select Edit, or
select Edit > Insert > Auxiliary Graphics.
The Auxiliary Graphics Draw toolbar contains commands for working with
continuous lines and arcs, tangent arcs, curves, free form drawing, circles, rectangles,
fillets, text and so forth. The Draw toolbar displays down the left side of the drawing
sheet (as shown in the example graphic). Note that any SmartPlant P&ID command
not available during the Auxiliary Graphics session is disabled.
You can customize the Auxiliary Graphics Draw toolbar using Tools > Customize.
The available commands display with (Auxiliary) following the command name.
Toolbar choices include:
• Draw (Auxiliary)
• Features (Auxiliary)
• Trim (Auxiliary)
• Extend (Auxiliary)
• Group (Auxiliary)
• Manipulation (Auxiliary)
• Priority (Auxiliary)
• Edit (Auxiliary)
• Relations (Auxiliary)
• Text (Auxiliary)
For information about how to customize a toolbar, refer to Customize Command
(Tools Menu).
Notes
• Any customizations made to the Draw toolbar are not saved when you
close the Auxiliary Graphics session.
• The Undo buffer is cleared each time you enter an Auxiliary Graphics
session. The SmartPlant P&ID Undo buffer is also cleared at this time.
Related Topics
• Adding Text to Documents: An Overview, page 66
• Editing Auxiliary Graphics, page 8
• Selecting, Moving, and Copying Elements: An Overview, page 43
Selecting the command opens a drawing sheet that also displays your SmartPlant
P&ID drawing. You can then create graphics using the displayed Draw toolbar.
Exiting objects in your current SmartPlant P&ID drawing cannot be selected or edited
but do display for viewing purposes. To return to your SmartPlant P&ID drawing,
select File > Close Auxiliary Graphics. When you return to SmartPlant P&ID, you
can only move the graphics placed using Auxiliary Graphics. To edit the graphics
again, you can either double-click on the SmartFrame, right-click and select Edit, or
select Edit > Insert > Auxiliary Graphics.
Related Topics
• Auxiliary Graphics: An Overview, page 6
Note
• Existing objects in your current SmartPlant P&ID drawing cannot be
selected or edited but do display for viewing purposes.
Related Topics
• Auxiliary Graphics Command, page 8
• Auxiliary Graphics: An Overview, page 6
Related Topics
• Auxiliary Graphics: An Overview, page 6
You can place most basic elements with just a few clicks. For example, if you want to
place a line, can click Line/Arc Continuous on the Draw toolbar. Then, click two
points to indicate where to start and finish the line. If you do not want to place
another line, you can right-click to end the operation.
Tip
• Right-clicking ends most operations in the software.
You can also place the line by clicking Line/Arc Continuous and then clicking and
dragging the pointer. When you release the mouse, the line appears on the drawing
sheet. With this method, you drag the pointer as if it were a pen. You can draw most
elements, such as rectangles, circles, and arcs, with this method, sometimes called
mouse-down drawing. The mouse-down method is typically used to place most
elements in conceptual sketching and modification.
If you want to place a precise line, click Line/Arc Continuous , type values into the
ribbon that appears, and then press Enter. You can then click on the drawing sheet to
place the line. This method, sometimes called mouse-up drawing, is typically used for
precision placement and when you want to draw elements that are related to each
other.
In some cases, you might want to click points on the drawing sheet and type values in
the ribbon to place an element. For example, you can click Line/Arc Continuous
and then type 3.0 in the Length box on the ribbon box and press Enter to lock the
length value.
When a line that is three inches long appears next to the pointer, you can click
anywhere on the drawing sheet to indicate where to place one end of the line. Then,
you move the line around and click again to set the line's orientation angle.
If you do not like the results of what you drew, you can click Undo on the Main
toolbar. If you want to repeat an action, click Redo on the Main toolbar.
Related Topics
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
• Drawing FreeForm Shapes: An Overview, page 35
• Drawing Lines: An Overview, page 10
• Drawing Squares, Rectangles, and Polygons: An Overview, page 32
You can also place the line by clicking Line/Arc Continuous and then clicking and
dragging the pointer. When you release the mouse, the line appears on the drawing
sheet.
If you want to place a precise line, you can click Line/Arc Continuous , type values
into the ribbon that appears, and then press Enter. You then click on the drawing
sheet to place the line.
You can also use a combination of clicks and ribbon input to place the line. For
example, you can type a line length in the ribbon box to lock the length value and
then set the line's orientation angle graphically. You can set the color and line type by
clicking a style in the Style list box.
Related Topics
• Draw a Line with FreeSketch, page 37
• Draw a Line, page 11
• Draw a Point, page 12
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
Draw a Line
1. On the Draw toolbar, click Line/Arc Continuous
2. Click the point where you want the line to begin.
3. Click the point where you want the line to end. This action defines the length and
rotation angle of the line.
4. Do one of the following:
• Right-click to end the line.
• To draw a series of connected lines, click at the point where you want
each line segment to end, and then right-click.
Tip
• If you close the shape, the command restarts so you begin drawing
again.
Notes
• Instead of clicking to draw the end points, you can type values on the
ribbon bar. You can also use a combination of graphic and ribbon input.
• Instead of clicking several different points to draw a line, you can drag the
pointer to draw a line.
• You can press Esc to end a line or a line segment.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit a line.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Drawing Lines: An Overview, page 10
• Line Ribbon, page 13
• Line/Arc Continuous Command, page 12
Draw a Point
1. On the Draw toolbar, click Point .
2. Click to place a point.
Notes
• Instead of clicking to place the point, you can type values in the coordinate
boxes on the ribbon. You can also use a combination of graphic and
ribbon bar input. The coordinate origin is located at the bottom left corner
of the window.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit a point.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Drawing Lines: An Overview, page 10
• Point Command, page 13
You can also draw a continuous series of lines and arcs that can be perpendicular or
tangent to each other. You can create an open or closed shape by drawing lines and
arcs in any combination. The last point of the line or arc is the first point of the next
line or arc.
Note
• The Line/Arc Continuous command starts in line mode by default. If you
want to start by drawing an arc, press Shift+A. While drawing, you can
toggle between the two modes by pressing Shift+A for arc mode or
pressing Shift+L for line mode.
Related Topics
• Draw a Line with FreeSketch, page 37
• Draw a Line, page 11
• Draw Connected Lines and Arcs with FreeSketch, page 22
• Draw Connected Lines and Arcs, page 20
• Drawing Lines: An Overview, page 10
Line Ribbon
Style - Sets the drawing style.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
Length - Sets the length of a line. This box accepts only positive values.
Angle - Sets the angle of a line. This box accepts positive or negative values. A
positive value is counterclockwise from the x axis, and a negative value is clockwise
from the x axis.
Related Topics
• Draw a Line with FreeSketch, page 37
• Draw a Line, page 11
• Draw Connected Lines and Arcs with FreeSketch, page 22
• Draw Connected Lines and Arcs, page 20
• Line/Arc Continuous Command, page 12
Point Command
Draws a point. The point is displayed as a filled rectangle.
Related Topics
• Draw a Point, page 12
• Drawing Basic Elements: An Overview, page 9
• Drawing FreeForm Shapes: An Overview, page 35
• Using Relationships as You Draw: An Overview, page 92
Point Ribbon
Style - Sets the drawing style.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
X - Sets a value for the x coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the y coordinate. You can use this option by itself or with the X
option.
Related Topics
• Draw a Point, page 12
• Drawing Basic Elements: An Overview, page 9
• Point Command, page 13
Besides clicking the pointer, you can also place circles by clicking Circle By Center
Point and then holding the mouse button down and drawing freehand. After you close
the loop, the circle appears.
You can also place a precise circle by clicking Circle By Center Point and then
typing values into the ribbon. After you press Enter, a circle appears around the
pointer. You can then place the defined circle by clicking the point you want on the
drawing sheet.
Related Topics
• Circle Ribbon, page 18
• Curve Ribbon, page 27
• Drawing Basic Elements: An Overview, page 9
• Ellipse Ribbon, page 31
Notes
• Instead of clicking several different points to draw a circle, you can draw a
diagonal line and the software automatically changes it to a circle.
• Instead of clicking to define the circumference of the circle, you can type
values on the ribbon. You can also use a combination of graphic and
ribbon bar input.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit a circle.
Related Topics
• Circle by 3 Points Command, page 17
• Circle Ribbon, page 18
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
• Intent Zones, page 94
Notes
• Instead of clicking to define the radius, you can type values on the ribbon
bar. You can also use a combination of graphic and ribbon input.
• Instead of clicking several different points to draw a circle, you can draw a
diagonal line and the software automatically changes it to a circle.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit a circle.
Related Topics
• Circle by Center Point Command, page 17
• Circle Ribbon, page 18
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
Notes
• Instead of clicking several different points to draw a circle, you can draw a
diagonal line, and the software automatically changes it to a circle.
• You can define the radius first to make a circle tangent to the first element,
but not fixed in one position on it.
• After you type a value in the Diameter or Radius box, move the pointer
along the element until the software recognizes a point on element
relationship, and then click. The circle is then displayed dynamically, and
you can move it along the element freely until you make it tangent to
another element or key point.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit a circle.
Related Topics
• Circle Ribbon, page 18
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
• Drawing with Relationships: An Overview, page 90
• Tangent Circle Command, page 17
Related Topics
• Circle by 3 Points Command, page 17
• Circle by Center Point Command, page 17
• Draw a Circle by Defining Three Points, page 15
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
Circle by Center Point Command
Related Topics
• Circle by 3 Points Command, page 17
• Circle by Center Point Command, page 17
• Draw a Circle by Center Point, page 16
Tangent Circle Command
Related Topics
• Circle by 3 Points Command, page 17
• Circle by Center Point Command, page 17
• Draw a Circle Tangent to One or Two Elements, page 16
Circle Ribbon
Sets options for placing circles.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
Related Topics
• Circle by 3 Points Command, page 17
• Circle by Center Point Command, page 17
Tip
• Use the intent zones at the first and second points to specify if the third
point is between the first two or beyond one of the first two.
Notes
• Instead of clicking to define the sweep and the midpoint, you can type
values on the ribbon. You can also use a combination of graphic and
ribbon input.
• Instead of clicking several different points to draw an arc, you can draw a
diagonal line and the software automatically changes it to an arc.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit an arc.
Related Topics
• Arc by 3 Points Command, page 26
• Arc Ribbon, page 27
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
Notes
• Instead of clicking to define the radius, you can type a value on the ribbon
bar. You can also use a combination of graphic and ribbon input.
• Instead of clicking several different points to draw an arc, you can draw a
diagonal line and the software automatically changes it to an arc.
• You can use the boxes on the ribbon and the commands on the shortcut
menu to edit an arc.
Related Topics
• Arc By Center Point Command, page 26
• Arc Ribbon, page 27
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
Notes
• Instead of clicking to define the radius and sweep of the arc, you can type
values on the ribbon. You can also use a combination of graphic and
ribbon bar input.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit an arc.
Related Topics
• Arc Ribbon, page 27
• Tangent Arc Command, page 26
5. If you are drawing an arc, click a point on the arc to define the radius.
Tip
• After you draw an arc, the command switches back to line mode
automatically. You can switch back to arc mode if you want to draw
another arc.
6. Continue drawing lines or arcs, pressing Shift+A to switch to arc mode and
Shift+L to switch to line mode.
7. Right-click to finish.
Tip
• If you close the shape, the command restarts so you begin drawing
again.
Notes
• Instead of pressing Shift+L or Shift+A to switch modes, you can use Line
or Arc on the ribbon.
• You can make the first line or arc tangent or perpendicular to an element.
First, move the pointer to the element to which you want to be tangent.
Click when the software recognizes a Point On the relationship. Then use
the intent zones to indicate if you want the line to be tangent or
perpendicular.
• Instead of clicking locations on the drawing sheet, you can type values on
the ribbon. You can also use a combination of graphic and ribbon input.
• Using the ribbon boxes to type values does not affect the settings of the
Line or Arc modes.
Related Topics
• Arc by 3 Points Command, page 26
• Arc By Center Point Command, page 26
• Drawing Basic Elements: An Overview, page 9
• Line/Arc Continuous Command, page 12
• Tangent Arc Command, page 26
Draw a Curve
1. On the Draw toolbar, click Curve
2. Do one of the following:
• To draw an open curve, set the Curve Type box on the ribbon to
Open.
• To draw a closed curve, set the Curve Type box on the ribbon to
Closed.
3. Click three or more points on the drawing sheet. These points represent nodes on
the curve.
Tip
• You must place at least three points to draw a curve.
4. Right-click to end the curve.
Notes
• You can drag the pointer to draw the shape of a curve. Instead of clicking
several different points to draw a curve, you can draw a diagonal line and
the software automatically changes it to a curve.
• The nodes at the start point and end point of a curve are always smooth.
• You can use Insert Node on the shortcut menu to add nodes to a curve.
• You can use Delete Node on the shortcut menu to delete nodes from a
curve.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit a curve.
Related Topics
• Change the Curve Type, page 25
• Curve Command, page 27
• Curve Ribbon, page 27
Notes
• You can use the arrows on the ribbon to select a node.
• You can use Insert Node on the shortcut menu to add nodes to a curve.
Related Topics
• Curve Command, page 27
• Curve Ribbon, page 27
• Draw a Curve, page 23
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
Notes
• You can use the arrows on the ribbon to select a node.
• You can use Insert Node on the shortcut menu to add nodes to a curve.
• You can use Delete Node on the shortcut menu to delete nodes from a
curve.
Related Topics
• Curve Command, page 27
• Curve Ribbon, page 27
• Draw a Curve, page 23
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
Related Topics
• Draw an Arc by Defining Three Points, page 18
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
• Drawing FreeForm Shapes: An Overview, page 35
Arc By Center Point Command
Draws an arc using three points. The first point defines the center of the arc and
the next two points define the sweep.
Related Topics
• Draw an Arc by Center Point, page 19
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
• Drawing FreeForm Shapes: An Overview, page 35
Tangent Arc Command
Draws an arc tangent or perpendicular to one or two elements. The first point
defines one end of the arc. If you place the first point on a key point of an element
you want the arc to be tangent or perpendicular to, then the second point defines the
sweep.
If you place the first point in free space, then this command works like Arc by 3
Points. In this case the first point defines an end point. You can then either define a
point on the arc and then the end point, or the end point and then a point on the arc.
Tip
• While in dynamics for the second point, you can set the orientation of the
arc by passing the pointer through one of the four quadrants of the first
point's intent zone.
Related Topics
• Draw an Arc Tangent to Two Elements, page 20
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
• Drawing FreeForm Shapes: An Overview, page 35
Arc Ribbon
Style - Sets the drawing style.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
Related Topics
• Arc by 3 Points Command, page 26
• Arc By Center Point Command, page 26
• Draw an Arc by Center Point, page 19
• Draw an Arc by Defining Three Points, page 18
• Draw an Arc Tangent to Two Elements, page 20
• Tangent Arc Command, page 26
Curve Command
Draws a smooth, open or closed curve. A series of curves can have smooth,
symmetric and cusp nodes. The node at the start point and the node at the end point of
a curve are always smooth.
Related Topics
• Change the Curve Type, page 25
• Change the Node Type, page 25
• Delete a Node from a Curve, page 24
• Draw a Curve, page 23
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
• Insert a Node into a Curve, page 24
Curve Ribbon
Style - Sets the drawing style.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
Important
• The following options appear on the Curve ribbon only when a curve or
curve element is selected.
Previous Node - Activates the previous node on the curve. This button is
available only when you have selected a curve to edit.
Next Node - Activates the next node on the curve. This button is available only
when you have selected a curve to edit.
Symmetric - Gives a curve the same curvature on each side of the selected node.
This button is available only when you have selected a curve to edit.
Smooth - Gives a curve a different curvature on each side of the selected node.
The start point and end point of a curve is always a smooth node. This button is
available only when you have selected a curve to edit.
Cusp - Makes a curve bend sharply at the selected node. This button is available
only when you have selected a curve to edit.
Related Topics
• Change the Curve Type, page 25
• Change the Node Type, page 25
• Curve Command, page 27
• Draw a Curve, page 23
3. Click the location to end the primary axis. This action defines the length of the
primary axis and the rotation angle.
4. Click a location on one side of the primary axis. This action defines the secondary
axis.
Tip
• The primary axis can be shorter than the secondary axis.
Notes
• Instead of clicking to define the primary and secondary axes of an ellipse,
you can type values on the ribbon. You can also use a combination of
graphic and ribbon input.
• Instead of clicking several different points to draw an ellipse, you can
draw a diagonal line, and the software automatically changes it to an
ellipse.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit an ellipse.
Related Topics
• Ellipse by 3 Points Command, page 31
Related Topics
• Draw an Ellipse by Center Point, page 30
• Drawing FreeForm Shapes: An Overview, page 35
• Drawing with Relationships: An Overview, page 90
• Ellipse by 3 Points Command, page 31
• Ellipse by Center Point Command, page 30
Draws an ellipse using three edge points. The first two points define the length of
the primary axis and the rotation angle. The last point defines the secondary axis.
Related Topics
• Draw an Ellipse by Defining Three Points, page 29
• Drawing FreeForm Shapes: An Overview, page 35
• Drawing with Relationships: An Overview, page 90
• Ellipse by 3 Points Command, page 31
• Ellipse by Center Point Command, page 30
Ellipse Ribbon
Style - Sets the drawing style.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
Primary - Sets the length of the primary axis. The ellipse orientation is based on the
primary axis.
Secondary - Sets the length of the secondary axis. The secondary axis is
perpendicular to the primary axis.
Angle - Sets the angle of the primary axis of the ellipse. Zero degrees is horizontal to
the x axis. The angle increases in the counterclockwise direction.
Related Topics
• Draw an Ellipse by Center Point, page 30
• Draw an Ellipse by Defining Three Points, page 29
• Ellipse by 3 Points Command, page 31
• Ellipse by Center Point Command, page 30
If you place dimensions on a rectangle or square, these are always driven dimensions.
This means that if you edit the value of the dimension, the object does not change.
You need to edit the width and height values on the ribbon to change the dimensions
of the rectangle or square. Also, you cannot ungroup a rectangle or square into
individual lines.
Tip
• If you want to place a rectangle or square that has driving dimensions, you
need to select Line/Arc Continuous on the Draw toolbar and place
four separate lines in the shape of a rectangle or square.
You can use the Polygon and Polygon by Center , also on the Draw
toolbar, to draw an n-side polygon. The default settings for both polygon commands
are for drawing an isosceles triangle. However, you can use the options on the
Polygon and Polygon by Center ribbons to specify the number of sides and
dimension values.
Each polygon that you draw is really an object of grouped lines. Consequently, once
the polygon is drawn there is no way to modify its dimensions. You can, however,
use Ungroup on the Relationships toolbar to separate the polygon into its
individual linear elements.
Related Topics
• Draw a Rectangle or Square with FreeSketch, page 34
• Draw a Rectangle or Square, page 33
• Drawing Basic Elements: An Overview, page 9
• Rectangle Command, page 34
• Using Relationships as You Draw: An Overview, page 92
Notes
• Instead of clicking to draw the rectangle or square, you can type values in
the Width, Height, and Angle boxes on the ribbon. You can also use a
combination of graphic and ribbon bar input.
• Instead of clicking several different points to draw a rectangle, you can
draw a diagonal line and the software automatically changes it to a
rectangle.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit a rectangle or square.
• If you place dimensions on a rectangle, they are always driven dimensions.
• You cannot ungroup a rectangle into individual lines.
Related Topics
• Rectangle Command, page 34
Notes
• Adjust allows the software to adjust the geometry that you draw.
• When Adjust is off, the software interprets the exact movements of your
pointer.
• When Adjust is on, the software interprets the diagonal as a rectangle or
square.
• You can use the buttons on the ribbon and shortcut menu to edit a
rectangle or square.
Rectangle Command
Draws a rectangle using three points. The first two points define the width and
rotation angle of the rectangle, and the third point defines the height. You can also
draw a square with this command.
Related Topics
• Draw a Rectangle or Square, page 33
• Drawing Basic Elements: An Overview, page 9
• Drawing FreeForm Shapes: An Overview, page 35
• Drawing Squares, Rectangles, and Polygons: An Overview, page 32
Rectangle Ribbon
Style - Sets the drawing style.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
Angle - Sets the orientation angle of the element. Zero degrees is horizontal to the x
axis. The angle increases in the counterclockwise direction.
Related Topics
• Draw a Rectangle or Square with FreeSketch, page 34
• Draw a Rectangle or Square, page 33
• Drawing Basic Elements: An Overview, page 9
• Rectangle Command, page 34
• Using Relationships as You Draw: An Overview, page 92
FreeSketch and FreeForm allow you to quickly place fluid lines and let the software
convert these into precision shapes. FreeSketch draws lines, arcs, circles, and
rectangles, and FreeForm draws curves (splines).
You can begin sketching anywhere on the drawing sheet. You can draw in free space
or use key points or end points of elements as reference points.
The next figure shows how the software interprets a rough sketch when Adjust Off is
set.
The next figure shows how the software interprets a rough sketch when Smoothing
Off is set.
Related Topics
• Draw a Circle with FreeSketch, page 38
• Draw a Curve with FreeForm, page 40
• Draw a Line with FreeSketch, page 37
• Draw a Rectangle or Square with FreeSketch, page 34
• Draw an Arc with FreeSketch, page 38
Notes
• Adjust allows the software to adjust the geometry that you draw.
• When Adjust is off, the software interprets the exact movements of your
pointer.
• When Adjust is on, the software interprets the lines as horizontal or
vertical when you finish drawing.
• The software recognizes relationships at the start point and end point of
the line.
• When you set the Line and Arc element types, you can draw connected
lines and arcs.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit a line.
Notes
• Adjust allows the software to adjust the geometry that you draw.
• When Adjust is off, the software interprets the exact movements of your
pointer.
• When Adjust is on, the software interprets your pointer movements as a
circle.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit a circle.
Related Topics
• Circle by 3 Points Command, page 17
• Circle by Center Point Command, page 17
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
• FreeSketch Command, page 40
• Tangent Circle Command, page 17
Notes
• Adjust allows the software to adjust the geometry that you draw.
• When Adjust is off, the software interprets the exact movements of your
pointer.
• When Adjust is on, the software interprets arcs as tangent to the
connected elements.
• The software recognizes relationships at the start point and end point of
the arc.
• When you set the Line and Arc element types, you can draw connected
lines and arcs.
• You can use the options on the ribbon and the commands on the shortcut
menu to edit an arc.
Related Topics
• Drawing Circles, Arcs, and Ellipses: An Overview, page 14
• Drawing FreeForm Shapes: An Overview, page 35
• Drawing with Relationships: An Overview, page 90
• FreeSketch Command, page 40
Notes
• Adjust allows the software to adjust the geometry that you draw.
• When Adjust is off, the software interprets the exact movements of your
pointer.
• When Adjust is on, the software interprets the diagonal as a rectangle or
square.
• You can use the buttons on the ribbon and shortcut menu to edit a
rectangle or square.
FreeSketch Command
Draws lines, arcs, rectangles, and circles by converting a sketch into a precision
drawing. You can specify which of these elements you want to draw using the ribbon.
Related Topics
• Draw a Circle with FreeSketch, page 38
• Draw a Line with FreeSketch, page 37
• Draw a Rectangle or Square with FreeSketch, page 34
• Draw an Arc with FreeSketch, page 38
FreeSketch Ribbon
Style - Sets the drawing style.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
Adjust Off - Does not adjust the orientation of lines and arcs in your rough
sketch.
Line - Draws lines in the precision drawing by recognizing them in the rough
sketch.
Arc - Draws arcs in the precision drawing by recognizing them in the rough
sketch.
Circle - Draws circles in the precision drawing by recognizing them in the rough
sketch.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Using Relationships as You Draw: An Overview, page 92
FreeForm Command
Draws freeform curves, or splines.
Related Topics
• Draw a Curve with FreeForm, page 40
• Drawing Basic Elements: An Overview, page 9
• Drawing FreeForm Shapes: An Overview, page 35
• Using Relationships as You Draw: An Overview, page 92
FreeForm Ribbon
Style - Sets the drawing style.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
Smoothing Off - Draws elements that closely resemble the movements of your
pointer, without smoothing them into cusp, smooth, and symmetric curves.
Related Topics
• Draw a Curve with FreeForm, page 40
• Drawing Basic Elements: An Overview, page 9
• FreeForm Command, page 41
• Using Relationships as You Draw: An Overview, page 92
Selecting Elements
You can select individual or multiple elements using the Select Tool on the Draw
toolbar. When you click the Select Tool, the pointer changes to an arrow with a
locate zone indicator at the end. As you move the pointer, any element that the locate
zone passes over is displayed in the highlight color. When an element is highlighted
you can click to select it.
You can select more than one element at a time by clicking the Select Tool and then
holding the Shift or Ctrl key as you click the elements you want to select. Or, you
can click the Select Tool and then drag the mouse to fence elements.
You can also use a tool called PickQuick to select elements that overlap. To use it,
you should move the Select Tool pointer over the elements, and pause the mouse.
When an ellipsis displays you can left-click or right-click to display the number of
selectable elements. You can move the pointer over the numbers; when the element
that you want highlights, you can click on the corresponding number to select it.
Moving Elements
The software provides several methods for moving elements. You can drag an
element with the Select Tool or specify precision points with Move on the Change
toolbar. You can also use PinPoint with the Select Tool to move an element a precise
distance in X and Y relative to a known position on your drawing.
Copying Elements
You can copy elements with one of many methods:
• You can select an object and click Copy on the Main toolbar. The
selected item is placed on the Clipboard. Then, when you click Paste on
the Main toolbar, the item is placed on the drawing sheet. The element
will not change from its original form.
• You can copy one or more elements by clicking the Select Tool on the
Draw toolbar. After the pointer changes to show that the element can be
copied, hold the Ctrl key and drag the copy to its new location.
• Formatting, such as line weight, line color, and line style, can be copied
from selected objects and applied to other objects as they are selected
using Format Painter on the Main toolbar.
• You can make several copies of elements that are the same by selecting
the element and clicking Rectangular Pattern or Circular Pattern on the
Change toolbar.
• You can also click Offset, Move, Scale, or Rotate on the Change toolbar
to create copies.
Cutting and Deleting Elements
You can cut an element by clicking Cut on the Main toolbar. The element is placed
on the Clipboard. You can then use Paste to place the element in the current
document or into other documents.
Important
• If you do not Paste the element after cutting, it will be permanently
removed from the document.
You can permanently remove an element by selecting the element and pressing
Delete on your keyboard. You can also permanently remove an element by clicking
Edit on the Main toolbar and then selecting Delete.
Related Topics
• Copying and Pasting Elements: An Overview, page 54
• Creating Patterns: An Overview, page 59
• Cutting or Deleting Elements: An Overview, page 63
• Moving Elements: An Overview, page 51
• Selecting Elements: An Overview, page 45
When you click Select Tool, the pointer changes to an arrow with a locate zone
indicator at the end. As you move the pointer, any element that the locate zone passes
over is displayed in the highlight color. When an element is highlighted, you can click
to select it.
• The element changes to the selection color. You can change the selection
color using Options on the Tools menu.
• The element's handles are displayed. Handles are solid squares at
significant positions on a selected element, such as end points and center
points. Handles allow you to directly modify the element — drag a handle
to change the element's shape. Although you can select more than one
element at a time, only one element can have handles at a time.
• The element's important properties are displayed on a ribbon.
• If the element is linked or embedded into the current document, selecting it
allows you to double-click it for editing.
When you select multiple elements or grouped elements, they change to the selection
color.
You can use the ribbon to select whether you want only elements completely
enclosed by the fence to be selected or any element that is partly enclosed by the
fence. Many manipulation commands, like delete, move, copy, and rotate, act upon
all elements in the selection set.
Deselecting Elements
To deselect an element or group of elements, you can click any point on the drawing
sheet.
Related Topics
• Copy an Element with the Select Tool, page 55
• Move an Element with the Select Tool, page 53
• Redo Actions, page 48
• Select an Element, page 46
• Undo Actions, page 48
Select an Element
1. On the Main toolbar, click Select Tool.
2. Do one of the following:
• To select one element, click it.
• To select more than one element hold the Shift or Ctrl key and click
each element.
• To select more than one element at once, drag to fence the objects.
• To select one of several overlapping elements, use PickQuick.
• To select all elements, click Ctrl + A or right-click in the Drawing
sheet and click Select All.
3. Move the pointer over PickQuick without clicking to highlight the corresponding
elements.
4. When the element you want to select is highlighted, click the corresponding
button on the PickQuick toolbar.
To clear a selection
Do one of the following:
• You can change the element highlight and selection colors with Options
on the Tools menu.
Related Topics
• Select All Command (Edit Menu), page 50
• Select Tool, page 49
• Selecting Elements: An Overview, page 45
Undo Actions
Do one of the following:
• To undo the most recent action, on the Main toolbar, click Undo .
• To undo more than one action, click the down arrow next to Undo on the
Main toolbar, and select the actions you want to undo.
Tip
• You can do this action only if you have placed Undo List on the Main
toolbar. You can place the button by clicking Customize on the Tools
menu.
Notes
• You cannot restore broken links with Undo.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Undo Command, page 50
• Using Relationships as You Draw: An Overview, page 92
Redo Actions
Do one of the following:
• To redo the most recent action, on the Main toolbar, click Redo .
• To redo more than one action, click the down arrow next to Redo on the
Main toolbar, and select the actions you want to undo or redo.
Tip
• You can do this action only if you have placed Redo List on the Main
toolbar. You can place the button by clicking Customize on the Tools
menu.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Using Relationships as You Draw: An Overview, page 92
Select Tool
Changes the pointer to the arrow-shaped selection pointer so that you can select,
modify, and manipulate elements. The circle at the end of the pointer arrow is the
locate zone.
Related Topics
• Copy an Element with the Select Tool, page 55
• Move an Element with the Select Tool, page 53
• Selecting Elements: An Overview, page 45
Tip
• To find out the name of an option on the ribbon, pause the pointer over an
option and read the ToolTip.
The options that appear depend on the types of elements that you selected. For
example, if you select eleven lines, then the Line ribbon appears. If you select several
types of items, then only the common properties for those types of elements appear
on the Select Tool ribbon. For example, if you select nine lines and a circle, then the
ribbon displays the Style, Line Type, Width, and Color options. For more
information about the options that appear, see the Help topic for the selected
element's ribbon.
If the items that you selected have no common properties, then no options will appear
if you click Expand. For example, if you select a dimension and ten lines and then
click Expand, a ribbon does not appear.
Related Topics
• Copy an Element with the Select Tool, page 55
• Move an Element with the Select Tool, page 53
• Select an Element, page 46
• Select Tool, page 49
Tip
• You can also access this command when you position the pointer in the
document and right-click.
Related Topics
• Selecting Elements: An Overview, page 45
Undo Command
Reverses an action. You can change the number of actions that can be undone
using Options. You then click the General tab on the Options dialog box.
Tip
• The Undo command is also available on the Edit menu.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Redo Actions, page 48
• Undo Actions, page 48
• Using Relationships as You Draw: An Overview, page 92
Redo Command
Repeats the most recent action taken or reverses the most recent Undo.
Tip
• The Redo command is also available on the Edit menu.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Redo Actions, page 48
• Undo Actions, page 48
Tip
• The element's handles do not need to be displayed for you to move it. If
they are displayed, and you want to move the element and not modify it,
position the pointer so it is not over a handle.
You can move an element with precision if you use the relationships indicators.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Move an Element with the Select Tool, page 53
• Move an Element, page 52
Move an Element
1. Select one or more elements.
Move Command
Moves elements from one location to another. You can specify the locations by
clicking on the drawing sheet or by entering values in the ribbon. You can move one
or more elements at a time, and you can move element groups.
Related Topics
• Move an Element, page 52
• Moving Elements: An Overview, page 51
Move Ribbon
Specifies the from point and to point when you move objects or elements.
X - Sets a value for the x coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the y coordinate. You can use this option by itself or with the X
option.
Step Value - Increments or decrements the value displayed in the ribbon boxes. For
example, typing a step value of 0.25 and moving the pointer away from the from
point would increment the distance from 0.25 to 0.5, 0.75, and so forth.
Related Topics
• Move an Element, page 52
• Move Command, page 53
You can also copy an element with the Select Tool. You click the Select Tool on the
Draw toolbar, select the element, and press Ctrl as you drag the element across the
drawing sheet. You can also copy several selected elements in the same manner.
When you copy elements that have relationships, the relationships are copied and
retained when possible. For example, if you make a copy of two related lines, the
relationship is also copied. However, if you copy one of two lines that are related to
each other, the relationship is not copied.
Related Topics
• Copy an Element with the Select Tool, page 55
• Copy an Element, page 55
• Paste an Element, page 56
Copy an Element
1. Select an element.
Related Topics
• Copy Command (Main Toolbar), page 56
• Copying and Pasting Elements: An Overview, page 54
• Select All Command (Edit Menu), page 50
• Select Tool, page 49
• Selecting Elements: An Overview, page 45
Paste an Element
You can place elements on the Clipboard with Copy or Cut, then paste the elements
into the current document or another document.
1. Open the document in which you want to paste the contents of the Clipboard.
When you copy more than one element at a time, all relationships shared among the
elements are also copied. However, when you copy an element that shares a
relationship with an element that you are not copying, the relationship is not copied.
Tip
• The Copy command is also available on the Edit menu.
Related Topics
• Copy an Element with the Select Tool, page 55
• Copy an Element, page 55
• Cutting or Deleting Elements: An Overview, page 63
Paste Command
Inserts the Clipboard contents at the same coordinates the elements had in the
source document. The command is not available if the Clipboard is empty.
Tip
• The Paste command is also available on the Edit menu.
Related Topics
• Cutting or Deleting Elements: An Overview, page 63
• Paste an Element, page 56
Related Topics
• Copying and Pasting Elements: An Overview, page 54
Tip
• To get Help for various items on the dialog box, click the Question Mark
in the upper right corner of the dialog box and click the control that you
want information about.
Related Topics
• Copying and Pasting Elements: An Overview, page 54
Offset Command
Draws an offset copy of an element or a set of contiguous elements. This
command copies elements while maintaining characteristics such as the angle of lines
and the center point of arcs and circles.
Offset copies the original element at a specified distance. Offsetting outside the
perimeter of the original element creates a larger element. Offsetting inside the
perimeter of the original element creates a smaller element.
Related Topics
• Copying and Pasting Elements: An Overview, page 54
Offset Ribbon
Step Distance - Sets the distance from the base element to the offset copy.
Cumulative Offset - Sets the total distance of the current offset graphic element from
the original graphic element.
The following graphic illustrates the difference between step distance (A) and
cumulative offset (B).
Related Topics
• Copy an Element with the Select Tool, page 55
• Copy an Element, page 55
• Offset Command, page 57
To modify individual members of the pattern, you can select an individual member of
the pattern and change it the way you would any other element.
Related Topics
• Circular Pattern Command, page 60
• Draw a Circular Pattern, page 59
• Draw a Rectangular Pattern, page 60
• Rectangular Pattern Command, page 62
Notes
• If you do not like the results of the pattern, you can use the Undo
command.
Related Topics
• Circular Pattern Command, page 60
• Circular Pattern Ribbon, page 61
• Creating Patterns: An Overview, page 59
Notes
• If you do not like the results of the pattern, you can use the Undo
command.
Related Topics
• Circular Pattern Ribbon, page 61
• Creating Patterns: An Overview, page 59
• Rectangular Pattern Command, page 62
• Rectangular Pattern Ribbon, page 62
• Selecting Elements: An Overview, page 45
Related Topics
• Circular Pattern Command, page 60
• Creating Patterns: An Overview, page 59
• Draw a Circular Pattern, page 59
• Rectangular Pattern Command, page 62
Rows - Sets the number of arc-shaped rows in the pattern. This option is available
only when Rows on the Circular Pattern Options dialog box is set to Multiple
Inward or Multiple Outward.
Angle - Sets the angle of the pattern. This box sets the sweep angle between pattern
members when Pattern Control on the Circular Pattern Options dialog box is set
to Incremental Array. This box also sets the total sweep angle when Pattern
Control is set to Fit To Arc.
Row Spacing - Sets the distance between adjacent arc-shaped rows in the pattern, as
measured from the bottom of one row to the bottom of the next. The bottom is the
side closest to the center point of the circular pattern.
Related Topics
• Circular Pattern Command, page 60
• Draw a Circular Pattern, page 59
Multiple Inward - Draws multiple rows, each one closer to the pattern center than
the last.
Multiple Outward - Draws multiple rows, each one farther away from the pattern
center than the last.
Preview - Displays the range of the graphic to print on the printer paper.
Related Topics
• Circular Pattern Command, page 60
• Circular Pattern Ribbon, page 61
• Draw a Circular Pattern, page 59
Related Topics
• Circular Pattern Command, page 60
• Creating Patterns: An Overview, page 59
• Draw a Rectangular Pattern, page 60
• Rectangular Pattern Command, page 62
X count - Sets the number of pattern members along the x axis of the pattern
rectangle.
Y count - Sets the number of pattern members along the y axis of the pattern
rectangle.
X offset - Sets the distance between adjacent rows in the pattern, measured along the
x axis of the pattern rectangle.
Y offset - Sets the distance between adjacent rows in the pattern, measured along the
y axis of the pattern rectangle.
Finish - Completes the pattern. When you click this button, the pattern is created on
the drawing sheet and you can select other elements.
Related Topics
• Rectangular Pattern Command, page 62
Stagger - Sets the row or column stagger distance to the specified distance.
Stagger = 1/2 Offset - Sets the row or column stagger distance to half the X Offset or
Y Offset value.
Include Last Column - Controls whether to include the last staggered column in the
pattern or to exclude the last column.
Preview - Displays the range of the graphic to print on the printer paper.
Related Topics
• Rectangular Pattern Command, page 62
Relationships that are no longer applicable after you delete an element are
automatically deleted. For example, if you delete one of a pair of parallel lines, the
parallel relationship is deleted from the remaining line.
Related Topics
• Cut an Element, page 63
• Cut Command (Main Toolbar), page 64
• Delete a Relationship, page 98
• Delete Command (Edit Menu), page 65
Cut an Element
1. Select an element.
Delete an Element
1. Select an element.
2. Click Edit > Delete or press Delete.
Tip
• When you delete an element and its relationships, the relationships are not
pasted to the Clipboard and cannot be reinserted. However, you can
restore an element and its relationships by immediately using Undo.
Related Topics
• Cut Command (Main Toolbar), page 64
• Cutting or Deleting Elements: An Overview, page 63
• Delete Command (Edit Menu), page 65
Tip
• The Cut command is also available on the Edit menu.
Related Topics
• Cut an Element, page 63
• Cutting or Deleting Elements: An Overview, page 63
• Selecting Elements: An Overview, page 45
Related Topics
• Cutting or Deleting Elements: An Overview, page 63
• Delete an Element, page 64
• Selecting Elements: An Overview, page 45
Related Topics
• Create a Text Label, page 87
• Engineering Fonts, page 89
• Place a SmartLabel, page 88
• Place a Text Box, page 69
To place annotations in a document, you can click one of the following buttons:
You can manipulate the annotation by selecting the leader and moving parts of it.
You can control the display of a leader break line and the graphic end and insert or
delete vertices on a leader.
Adding Leaders
You can add a leader to an annotation using Leader on the Dimension toolbar.
All leaders have two ends - the notation end and the graphic end. The notation end, or
the end that describes something, is often attached to a text box or the annotation
itself; the graphic end is the end near the object being described and frequently has a
terminator arrow or free-space dot on it. An annotation can have more than one
leader. The graphic end of the annotation can point to an element or be placed in free
space. The notation end of a new leader must connect to an annotation or the leader
on an annotation.
You can create a callout by placing a text box and adding a leader to it with Leader
.
If you attach the terminator of a leader to an element, the annotation moves with the
element.
If you point the graphic end of a leader to free space, the annotation is not associative
to any element in the drawing. To make an annotation associative, you can select the
graphic end of the leader and drag it to an element.
Formatting Annotations
You can format an annotation several ways. If you want several annotations to look
the same, you can apply a style by selecting it on the ribbon. You can apply
dimension styles to balloons, but not text boxes. You can apply text styles to text
boxes.
Tip
• If you want to format an existing balloon, you must click the balloon
leader to select the balloon. Then, you can change the formats of the
balloon.
If you want annotations to look unique, you can select an annotation and edit its
properties with the ribbon or with Properties on the Edit menu.
Related Topics
• Move an Annotation, page 70
• Place a Text Box, page 69
Move an Annotation
1. Select an annotation to display its handles. As you move the pointer over the parts
of the annotation, the pointer changes to show whether you are on a part of the
annotation or a handle.
2. Click a handle and drag the leader or annotation to its new location.
The previous procedure describes the general steps you can use to move an
annotation. The following descriptions explain how to move specific parts of an
annotation.
To move a terminator
• When a terminator is connected to an element, drag the terminator handle
to a new location along the element. If you drag the handle off the end of
an open element, such as a line, an extension line automatically appears.
The annotation and break line do not move.
• If a leader was placed with the Leader command, you can move the leader
away from the annotation and attach it to another annotation or element.
Click the leader line and then drag the handle to the annotation or leader
that you want to connect to.
To move a handle
Click a leader line and do one of the following:
• Drag the handle on a break line to move the leader line and annotation.
Related Topics
• Adding Text to Documents: An Overview, page 66
• Placing Annotations: An Overview, page 66
Related Topics
• Adding Text to Documents: An Overview, page 66
• Placing Annotations: An Overview, page 66
• Text Box Command, page 75
• Text Box Ribbon, page 75
Related Topics
• Adding Text to Documents: An Overview, page 66
• Placing Annotations: An Overview, page 66
• Text Box Command, page 75
• Text Box Ribbon, page 75
Related Topics
• Adding Text to Documents: An Overview, page 66
• Edit a Text Box, page 74
• Insert a Font Character into a Text Box, page 74
• Place a Text Box, page 69
• Placing Annotations: An Overview, page 66
Tip
• To find out the name of an option on the ribbon, pause the pointer over an
option and read the ToolTip.
Style - Lists and applies the available styles.
Paragraph Alignment - Positions the paragraph to the left, center, or right of the
text area edges in edit mode.
Tip
• You can also align the paragraph after you select text.
Border - Displays three options for setting borders. These options allow you to
either display no border, display a border, or display a border with a shadow.
Notes
• If you select text in the text box, Height and Width are not available
because the text is driving the dimension.
• If you select a text box and Height is not available, the text is driving
Height with Auto Save. The same is true for Width.
• If you place a text box with a single point, both Height and Width are not
available. If you drag a text box, Width is not available.
Angle - Sets the angle of the text box.
Left To Right - Specifies that the characters in a text box are displayed from left
to right, as you would see in an English paragraph.
Right To Left - Specifies that the characters in a text box are displayed from
right to left, as you would see in an Arabic or Japanese paragraph.
Related Topics
• Apply a Border to a Text Box, page 73
• Format a Text Box, page 184
• Place a Text Box, page 69
• Resize a Text Box, page 74
• Text Box Command, page 75
Related Topics
• Format a Text Box, page 184
Border type - Sets the shape of the border around a text box. You can choose from a
selection of common geometric shapes.
Line style - Sets the line style for the text box.
Line width - Specifies the width of the border in paper or world units of the text box.
A paragraph is defined by a carriage return within the text body. Using the carriage
return as the sole means to create a new line of text will result in a text object with
many lines as shown in the following illustration:
As an alternative for controlling auto returns within the text body, you can restrain the
width of the box during placement or through the Text Box Properties dialog box.
Shadow offset - Specifies a distance to offset the shadow in paper or world units of
the text box.
Fill color - Displays the color of a solid fill on an element boundary. This value
overrides the style of the fill. Transparent is the default. When you set the fill color to
transparent, no fill is visible on the boundary. You can also apply a fill color option
with a fill pattern. Filled elements always cover other elements when they overlap. A
fill color always appears behind the fill pattern when you apply both to the same
boundary.
Related Topics
• Apply a Border to a Text Box, page 73
• Edit a Text Box, page 74
• Format a Text Box, page 184
• Insert a Font Character into a Text Box, page 74
• Text Box Properties Dialog Box, page 76
Info Tab
Sheet - Shows the drawing sheet for an element.
Origin - Specifies the coordinates, or location, of a text box along the x and y axes.
Tip
• All metrics on the text box are either in paper units or world units except
origin. Origin is always in world units.
Width - Sets the width of the text box to either At Least (at least the value you
specify), Auto (the text drives the width), or Exactly (exactly at the value you
specify) in the At: field.
Height - Sets the height of the text box to either At Least (at least the value you
specify), Auto (the text drives the height), or Exactly (exactly at the value you
specify) in the At: field.
Tip
• The text box always rotates about the origin.
Text Orientation - Sets the orientation of the text either horizontally or vertically.
Units Space - Sets the text box units to either paper units or to world units.
Paper units represent units on an actual sheet of paper. Paper units are set in inches.
Other units are also available.
World units indicate real world distances, but can be scaled down to fit a sheet of
paper.
Note
• Within the drawing environment, "world units" is synonymous with the
term "model units" found in other CAD packages.
Text Flow - Determines the direction in which the characters are displayed in a text
box.
Left To Right - Specifies that the characters in a text box are displayed from left to
right, as you would see in an English paragraph.
Right To Left - Specifies that the characters in a text box are displayed from right to
left, as you would see in an Arabic or Japanese paragraph.
Justification - Specifies the placement relationship between the origin and the shape
(text box) according to the horizontal and vertical components.
The inside text area is an area that the margins of the text box define. That is, margins
are inside the outside edges of the text box.
The following graphic illustrates top (1), right (2), bottom (3) and left (4) margins
around the text box for horizontal justification (A) and vertical justification (B).
The maximum cap height of the first formatted text line of each line defines the text
area capline, even if the line has been clipped out of the text box.
The line baseline is a font metric that describes an imaginary line for location of
characters. The largest descender for any font on the line defines the baseline.
Therefore, the largest descender of the fonts used on the last line defines the text area
baseline, even if the line is clipped out of the text box.
The following graphic illustrates text cap area (a) and text baseline (b) for horizontal
justification (A) and vertical justification (B).
You must define horizontal and vertical components together. These components
apply to both single-line and multi-line text. For multi-line text, the cap height of the
first line is used for the capline of the text, and the descender of the last line is used
for the baseline of the text.
Horizontal - Specifies horizontal placement at six options based on shape (text box),
text area, and the text within the text box at left, center, and right positions.
Vertical - Specifies vertical placement at 10 options based on shape (text box), text
area, and the text within the text box.
Text Top - Specifies the top of the text area, which begins at the bottom of the top
margin.
Text Half Ascender - Specifies half the distance from the text area baseline to the
top of the text area.
Text Half Cap - Specifies the distance half way between the text area capline and
baseline.
Text Alignment - Specifies the placement of formatted text within the shape (text
box).
Horizontal - Specifies how each paragraph is aligned within the block of formatted
text. Values for horizontal alignment include Left, Center, and Right.
If Text Orientation is horizontal, you modify all the paragraph alignment properties
for all paragraphs within the text box. (These properties appear in the Text
Alignment area of the Info tab.)
If Text Orientation is vertical, you modify the shape alignment properties. (These
properties appear in the Text Alignment area of the Info tab.)
Vertical - Places the block of formatted text at Top, Center, Bottom, or Justify area
of the text box.
If Text Orientation is horizontal, you modify the shape alignment properties. (These
properties appear in the Text Alignment area of the Info tab.)
If Text Orientation is vertical, you modify all the paragraph alignment properties for
all paragraphs within the text box. (These properties appear in the Text Alignment
area of the Info tab.)
Center - Places the formatted text in the center of the text area.
Right - Places the formatted text in the right of the text area.
Center - Places the formatted text in the center of the text area.
Bottom - Places the formatted text in the bottom of the text area.
Top - Places the edge of the first line of text at the top of the text area.
Center - Places the formatted text in the center of the text area.
Bottom - Places the formatted text in the bottom of the text area.
Justified - Places the first line of the first paragraph at the top of the text area.
Places the last line of the last paragraph at the bottom of the text area.
Places remaining paragraphs at equal distance between the first and last paragraphs.
Margins
Sets the distance between the edge of the shape and the edge of the text area. Margins
are in the same units as the text box.
Top - Sets the distance between the top edge of the shape and the top edge of the text
area.
Bottom - Sets the distance between the bottom edge of the shape and the bottom edge
of the text area.
Left - Sets the distance between the left edge of the shape and the left edge of the text
area.
Right - Sets the distance between the right edge of the shape and the right edge of the
text area.
Paragraph Tab
Text Style - Displays the style for a text box.
Language - Lists and applies a language for text in a text box. If you use text
characters from more than one language in a text box, the option you specify in this
box determines the way the lines wrap in the paragraph.
Units Space - Sets the paragraph to paper units or to world units. You can change this
control only when you are creating new styles from the Format Styles or Format
Text Box dialog boxes. When you view this control from the Properties dialog box,
it is read-only. You can change the control from the Info tab because all paragraphs
contained within a text box must exist in the same units.
Note
• Within the drawing environment, "world units" is synonymous with the
term "model units" found in other CAD packages.
Text Color - Sets the color of the font.
Spacing - Determines the amount of space between lines and paragraphs in a text
box.
Text Alignment - Specifies alignment for each paragraph within the block of
formatted text. Values for horizontal alignment include Left, Center, and Right.
If Text Orientation is horizontal, you modify all the paragraph alignment properties
for all paragraphs within the text box. (These properties appear in the Text
Alignment area of the Info tab.)
If Text Orientation is vertical, you modify the shape alignment properties. (These
properties appear in the Text Alignment area of the Info tab.
Line spacing - Lists and applies the amount of vertical space between lines of text.
• Single sets the line spacing for each line to display the largest font in the
line.
• 1.5 sets the line space for the line to one-and-a-half that of single lines.
• Double sets the line spacing for the line to twice that of single lines.
Paragraph Spacing - Specifies the amount of space before and after paragraphs. No
spacing exists before the first paragraph and or after the last paragraph.
Before - Adds space before a paragraph. This value is set in the current working
units, not in points.
After - Adds space after a paragraph. This value is set in the current working units,
not in points. You can set the units using Units on the Format menu.
Related Topics
• Format a Text Box, page 184
• Format Text Box Dialog Box, page 193
• Modify Text Box Style Dialog Box, page 180
• New Text Box Style Dialog Box, page 170
• Text Box Properties Dialog Box, page 76
User Tab (Text Box Properties Dialog Box)
Attribute Set - Names a group of attributes. You can type a name in the box and
press Tab.
Save - Places the attribute set on the element that you selected.
Remove - Removes the attribute set from the element that you selected.
Attributes - Sets the name, type, and value of the attribute set. You can type a name
in the box and press Tab.
Type - Sets the type for the attribute, such as double, text, number, money, or date.
Value - Sets the value for the attribute. The value that you can enter is based on the
type that you selected in the Type box.
Add - Adds an attribute to the attribute set. After you click Add, the attribute appears
in the table.
Delete - Removes an attribute from the attribute set. You can select an attribute by
clicking a row in the table.
Related Topics
• Format a Dimension or Annotation, page 184
• Format a Fill, page 196
• Format a Geometric Element, page 183
• Format a Text Box, page 184
• Managing Styles, Formats, and Colors: An Overview, page 159
• Properties Command (Edit Menu), page 185
Tips
• If you are running Windows 95 or a higher version and this command is
not available, you must install the Character Map accessory. You can add
it by clicking the Control Panel icon and then the Add/Remove Programs
icon. While adding the software, you can find the Character Map software
in the Accessories category. For detailed instructions on how to add the
Character Map accessory, see the Windows 95 on-line Help for
Add/Remove Programs.
• To place the Character Map button on a toolbar, click Tools >
Customize to open the Customize dialog box. On the Toolbars tab, select
Tools from the Categories list. Click and drag Character Map to an
existing toolbar.
Related Topics
• Adding Text to Documents: An Overview, page 66
• Insert a Font Character into a Text Box, page 74
• Placing Annotations: An Overview, page 66
Help - Opens the online documentation for using Character Map effectively and
efficiently.
Copy - Copies the selected characters from the Characters To Copy box to the
Clipboard.
Advanced view - Lets you display groups of characters to help in refining a search of
a character's Unicode value. When you check the Advanced view check box, the
Character Map dialog box displays additional options.
Character set - Specifies the character set you you want to search. If a character set
is not available, choose a different font from the Fonts list.
Go to Unicode - Allows you to enter the four-digit Unicode value for the character
you are looking for. This option is only enabled if you have selected Unicode in the
Character set list.
Group by - Specifies the group you want to use for your search. If you select
Unicode Subrange, a list of category characters is displayed.
Search for - Allows you to type all or part of the name of the character for which you
are searching.
Search - Executes the search based on the criteria you have defined.
Related Topics
• Adding Text to Documents: An Overview, page 66
• Character Map Command, page 84
• Insert a Font Character into a Text Box, page 74
• Placing Annotations: An Overview, page 66
• Text Box Command, page 75
Labels: An Overview
Technical drawings often have many labels that display important information about
the objects or elements in the document. There are two types of labels: text labels and
SmartLabels.
Text labels are associated with an element or object. If you move the element or
object, the text label moves with it. You can create text labels in a document by
double-clicking an element or object. A text label appears near the element so that
you can type text. The label appears at the location where the element is double-
clicked, except for closed elements, such as a circle or rectangle. The label position
on closed elements is the center of the element. When you enter the text that you
want, the text label orients itself with the element.
A SmartLabel displays the attributes of the element or object as text in the document.
You can drag SmartLabels from the Symbol Explorer into the current document.
SmartLabels have an .sym extension. As you change an element's or object's
attributes in the Attribute Viewer or the Properties dialog box, the SmartLabel's text
displays those changes.
If an element or object has no attributes, and you drag a SmartLabel to it, the element
or object picks up the attributes of the SmartLabel. For example, you might want to
assign attributes to a heat exchanger, such as pressure and material type. If the
SmartLabel has the pressure and material type defined, and the heat exchanger does
not, the SmartLabel's pressure and material type are copied to the heat exchanger.
Tip
• Not all SmartLabels assume the text attributes of an element or object.
Some SmartLabels contain shapes that grow automatically if you add text
to the SmartLabel.
Related Topics
• Create a Text Label, page 87
• Edit a SmartLabel, page 88
• Edit a Text Box, page 74
• Move a Label, page 88
• Place a SmartLabel, page 88
• Placing Annotations: An Overview, page 66
Notes
• You can edit a text label like a text box.
Related Topics
• Adding Text to Documents: An Overview, page 66
• Labels: An Overview, page 85
• Move a Label, page 88
Move a Label
• If a text label is associated with an element or object, drag the element or
object. The label moves with the element or object.
• If a label is not associated with an element or object, drag the label.
Related Topics
• Adding Text to Documents: An Overview, page 66
• Labels: An Overview, page 85
Place a SmartLabel
1. On the Main toolbar, click Symbol Explorer.
2. Browse to the directory.
3. Drag the SmartLabel into the document. If you place the SmartLabel near an
element in the document, the SmartLabel is associated with that element.
Related Topics
• Adding Text to Documents: An Overview, page 66
• Labels: An Overview, page 85
Edit a SmartLabel
1. Double-click an element or object.
2. In the Attribute Viewer, type the values that you want for the label.
Notes
• You can edit the properties or parameters of a SmartLabel.
• You can also edit the properties of the elements or text in the SmartLabel.
Select the SmartLabel and then click Edit Graphic Properties or Edit
Text Properties on the shortcut menu.
• If you place a symbol with a SmartLabel in a document, you cannot select
or open the SmartLabel to edit it like most symbols. You must create a
new SmartLabel.
Related Topics
• Adding Text to Documents: An Overview, page 66
• Labels: An Overview, page 85
Engineering Fonts
The engineering fonts delivered with the software contain industry-specific fonts,
special characters, and symbols that you can use to annotate engineering drawings.
These fonts include degree symbols, diameter symbols, and other special characters
and symbols that are not usually included in a typical word processing package.
Your choice of font should be based on the industry for which you are creating
engineering drawings.
The software provides TrueType® fonts; with TrueType fonts, what you see on the
screen is what appears on the printed page. The screen display of the document
closely matches the printed document.
When you open a .dwg or .dgn document, the software provides a default mapping to
determine which TrueType font will be assigned to which AutoCAD or MicroStation
font. You can make changes to this mapping to define your own mapping. You can
change the mapping with Options on the Tools menu. On the Foreign Data tab, you
can click the appropriate Options.
Related Topics
• Adding Text to Documents: An Overview, page 66
• Apply a Border to a Text Box, page 73
• Character Map Command, page 84
• Edit a Text Box, page 74
• Format a Text Box, page 184
• Insert a Font Character into a Text Box, page 74
• Place a Text Box, page 69
• Placing Annotations: An Overview, page 66
• Resize a Text Box, page 74
• Text Box Command, page 75
The software gives you more information about the element that you are drawing by
displaying relationships between the temporary, dynamic element and the following
items:
For example, if the horizontal relationship indicator appears when you click to place
the second end point of a line, then the line is exactly horizontal.
Relationships
You can set the types of relationships you want the software to recognize using
SmartSketch Settings on the Tools menu. The software can recognize one or two
relationships at a time. When the software recognizes two relationships, it displays
both relationship indicators at the pointer.
Locate Zone
You do not have to move the pointer to an exact position for the software to recognize
a relationship. The software recognizes relationships for any element within the
locate zone of the pointer. The circle around the pointer crosshair or at the end of the
pointer arrow indicates the locate zone. You can change the size of the locate zone
with SmartSketch Settings on the Tools menu.
Infinite Elements
The software recognizes the Point On Element relationship for lines and arcs as if
these elements were infinite. In the following example, the software recognizes a
Point On Element relationship when you position the pointer directly over an element
and also when you move the pointer off the element.
Related Topics
• Draw a Line Connected to Another Line, page 103
• Draw with Relationships, page 96
• Drawing Basic Elements: An Overview, page 9
• Establish a Relationship with the SmartSketch Command, page 97
• Example: Draw a Horizontal Line, page 105
• Maintain Relationships, page 98
• SmartSketch Settings Command (Tools Menu), page 100
• Suspend Relationships, page 97
• Using Relationships as You Draw: An Overview, page 92
When you modify a part of a drawing that has a relationship to another part of the
drawing, the other part updates automatically. For example, if you apply a
perpendicular relationship between the two lines and move one line, the other line
moves with it. The software remembers the relationship between these two elements
and always maintains the perpendicular relationship between the lines. You can
manipulate either of the two lines and the software will move or modify the line
automatically to maintain the relationship.
Applying and maintaining relationships in the design simplifies changes to the design
later. In the following drawing, all the relationships were automatically established as
the design took shape on the drawing sheet. If you want to change the design, you
simply modify one segment of it and all the relationships are maintained.
Tip
• You can also set Maintain Relationships using the Tools menu.
Then, as you click commands on the Draw toolbar and place lines, arcs, and circles,
you should watch the relationship indicators that appear by the pointer. When a
relationship indicator appears by the pointer, you can click to apply that relationship
to the element that you are drawing.
For example, the following four lines appear with relationship handles (A) turned off
and with relationship handles (B) displayed.
Removing Relationships
You can quit using all the relationships that you have applied to the drawing if you
clear Maintain Relationships. You can also remove individual relationships by
selecting a relationship handle and deleting it. Clearing Relationship Handles on the
Tools menu hides the handles, but the relationships are still maintained and used in
the design.
For conceptual sketching and diagrams, you might want to use relationships by
setting Maintain Relationships. This method allows you to quickly get your ideas on
paper and revise them easily using direct modification and driving dimensions. The
kinds of projects in which you might want to use relationships include mechanical
concepts, architectural details, layouts, and schematic diagrams.
Tip
• If you switch between using relationships and not using them while you
draw, you can receive confusing results.
Related Topics
• Draw a Line Connected to Another Line, page 103
• Draw an Ellipse by Center Point, page 30
• Draw with Relationships, page 96
• Drawing with Relationships: An Overview, page 90
• Example: Draw a Horizontal Line, page 105
• Maintain Relationships, page 98
• SmartSketch Settings Command (Tools Menu), page 100
• Using Relationships as You Draw: An Overview, page 92
Intent Zones
As you draw and modify elements, small quadrants called intent zones appear next to
the pointer. The software uses intent zones to interpret your intentions as you draw.
Intent zones allow you to draw and modify elements many ways using few
commands. You do not need to select a different command for every type of element.
The last intent zone you move the pointer into is the active zone. To change the active
intent zone, move the mouse pointer into the zone you want to use, then move it to
the position where you want to click next.
If you want to draw a perpendicular arc instead, you can move the pointer back into
the intent zone region and out through the perpendicular zone before clicking to place
the second end point of the arc. The arc is then perpendicular to the line.
You can also use intent zones to define the arc direction.
Related Topics
• Draw an Arc by Defining Three Points, page 18
• Draw an Arc Tangent to Two Elements, page 20
• Drawing Basic Elements: An Overview, page 9
• Select an Element, page 46
• Selecting Elements: An Overview, page 45
• SmartSketch Settings Command (Tools Menu), page 100
• Using Relationships as You Draw: An Overview, page 92
Related Topics
• Draw a Line Connected to Another Line, page 103
• Drawing with Relationships: An Overview, page 90
• Establish More Than One Relationship, page 108
• Maintain Relationships Command, page 102
• SmartSketch Settings Command (Tools Menu), page 100
Suspend Relationships
1. Hold Alt. The software does not recognize any relationships while you hold this
key.
2. Release Alt to re-activate the software's ability to recognize relationships.
Related Topics
• Drawing with Relationships: An Overview, page 90
• SmartSketch Settings Command (Tools Menu), page 100
Delete a Relationship
Note
• If the relationship handles are hidden, click Relationship Handles on the
toolbar to display them.
1. Select a relationship handle.
2. Press Delete.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Relationship Handles Command, page 102
• Using Relationships as You Draw: An Overview, page 92
Maintain Relationships
Click Maintain Relationships on the Relationships toolbar.
Tips
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Maintain Relationships Command, page 102
• Using Relationships as You Draw: An Overview, page 92
Tip
• If a checkmark appears next to Relationship Handles, the display is on.
Note
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Lock Command, page 102
• Using Relationships as You Draw: An Overview, page 92
Relationships Command
Displays the Relationship toolbar. You can use the commands on this toolbar to
create relationships between two drawing elements.
Tip
• To maintain the relationship between elements when you modify either
one of the elements, you must set Maintain Relationships on the
Relationship toolbar.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
Related Topics
• Draw with Relationships, page 96
• Drawing with Relationships: An Overview, page 90
• Establish a Relationship with the SmartSketch Command, page 97
• Suspend Relationships, page 97
Related Topics
• Draw a Line Connected to Another Line, page 103
• Draw with Relationships, page 96
• Drawing with Relationships: An Overview, page 90
• Establish a Relationship with the SmartSketch Command, page 97
• Establish More Than One Relationship, page 108
• Example: Case Where a Relationship Is Not Maintained, page 106
• Example: Connect Points While Drawing a Line, page 107
• Example: Connect Points While Modifying a Line, page 108
• Example: Draw a Horizontal Line, page 105
• Example: Draw a Line, page 104
• Example: Draw an Arc, page 104
Related Topics
• Draw with Relationships, page 96
• Establish a Relationship with the SmartSketch Command, page 97
• SmartSketch Settings Command (Tools Menu), page 100
• Suspend Relationships, page 97
Relationships Tab
This tab allows you select the relationships that are recognized by the software as you
draw. Set the relationships you want to recognize, and clear the relationships you do
not want to recognize. Clear all relationships so that the software does not place
relationship handles.
Related Topics
• Draw with Relationships, page 96
• Establish a Relationship with the SmartSketch Command, page 97
• SmartSketch Dialog Box, page 101
• Suspend Relationships, page 97
Cursor Tab
Cursor Setup - Sets the sizes of the Locate Zone and Intent Zone around the
pointer.
Locate Zone - Sets the size of the locate zone radius. The locate zone is a region
around the pointer.
The software recognizes relationships based on elements within the locate zone so
that you do not have to move the pointer to an exact position. For example, if part of
an element is within the locate zone, the software recognizes a Point On relationship.
The size of the locate zone is indicated by a circle around the center of the pointer
crosshair. Values from 3 to 12 pixels are valid.
Intent Zone - Sets the size of the intent zone radius. Intent zones allow drawing
commands to interpret your intentions as you draw. Values from 3 to 12 pixels are
valid.
Preview - Shows the size of the locate zone and the symbol for the selected
relationship.
The Preview option does not apply to changes made to intent zone values.
You can also use Tools > Maintain Relationships to toggle this command on and
off.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Maintain Relationships, page 98
• Relationship Handles Command, page 102
• Using Relationships as You Draw: An Overview, page 92
Tip
• You can use Tools > Customize to place the Relationship Handles
button on a toolbar.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Delete a Relationship, page 98
• Display or Hide Relationship Handles, page 99
• Drawing Basic Elements: An Overview, page 9
• Using Relationships as You Draw: An Overview, page 92
Lock Command
Controls elements so they cannot be modified. When you use this button, you can
lock the length, angle, radius, or position of an element. You can also lock keypoints
on elements, such as endpoints of a line or the center of a circle, in their absolute
positions.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Lock an Element or Key Point, page 99
• Using Relationships as You Draw: An Overview, page 92
6. Click where you want to place the second end point of the new line.
7. The new line and the previous line have connected end points.
Notes
• If Maintain Relationships on the Tools menu is set, the software places a
connect relationship handle at the point where the two lines connect.
• If you do not want to place a connect relationship, you can follow the
same procedure with Maintain Relationships cleared. The end points of
the two lines will still be exactly coincident when you draw them.
3. Move the pointer around on the drawing sheet. Notice that the line follows the
movement of the pointer. At the same time, the pointer recognizes any
relationships it encounters, such as a horizontal relationship. When the pointer
finds a relationship, a relationship indicator appears at the pointer.
4. Click to place the end point of the line according to the displayed relationships.
5. Continue clicking to draw additional line segments, or right-click to end the
command.
3. Move the pointer horizontally, to a position where the software recognizes step
angle alignment with the center point.
5. Move the pointer to a position where the software identifies the step angle you
want to use for the sweep.
6. While the step angle relationship indicator is displayed at the pointer, click to
define the end of the sweep.
5. Move the pointer around in the window. Notice that the dynamic line display
always extends from the end point you just placed to the current pointer position.
You may also see relationship indicators displayed at the pointer.
Tip
• Relationship handles can be displayed or hidden with Relationship
Handles on the Tools menu.
6. Move the pointer to make the dynamic line approximately horizontal.
7. When the horizontal relationship indicator is displayed at the pointer, click to
place the second end point.
Notes
• If Maintain Relationships on the Tools menu is set, the software places a
horizontal relationship handle on the new line.
• If you do not want to place a horizontal relationship, you can follow the
same procedure with Maintain Relationships cleared. The line will still
be exactly horizontal when you draw it.
3. Move the pointer to a position where the software recognizes a point on element
relationship with a line on the drawing sheet.
Notes
• If the third input point for the arc had been between the first two points,
then it would have been interpreted as the arc midpoint, making the
second input point one end of the arc sweep. In this case, the point would
have been constrainable, and the software would have maintained the
point on element relationship.
3. Move the pointer to a position where the software recognizes the end point of a
line on the drawing sheet.
4. When the point on relationship indicator is displayed at the pointer, click to define
the end of the line.
2. Position the Select Tool over the handle at the end of the line you want to modify.
The pointer changes to a plus (+) shape to indicate that you have located the
handle.
3. Drag the handle to a position where the software recognizes the end point of
another line on the drawing sheet.
4. Release the mouse button to place the end point of the line you are modifying at
the end point of the stationary line.
3. Move the pointer to recognize point on element and tangent relationships with a
circle on the drawing sheet.
4. While the point on element and tangent relationship indicators are displayed at the
pointer, click to define the end point of the line.
Many types of drawings require a drawing scale that makes it possible to represent
very large or very small objects on a sheet of paper. You can set up your drawings
with the drawing scale and measurement units you need to create a wide range of
drawings.
When you are positioning elements and symbols on a drawing sheet, speed and
precision count. You can easily align symbols with other symbols or with locations
indicated by guides, rulers, and grids. You can also position symbols at exact x-and y-
coordinates in your drawing.
You can also display the dimensions of elements in your drawings. With the
software's measurement and dimensioning tools, you can calculate and display linear
and angular dimensions. When you resize an element that has attached dimensions,
the dimensions update automatically.
Related Topics
• Placing Elements with a Grid: An Overview, page 110
• Using Relationships as You Draw: An Overview, page 92
The grid is an invisible set of lines in the document. When you set Grid Snap on the
View menu, elements always align with the grid lines or nearest intersection of the
grid lines. You can view the grid by clicking Grid Display on the View menu. The
grid lines do not print.
You can change the display of the grid from static to dynamic by setting options on
the View tab of the Options dialog box. You can also adjust the brightness of the grid
display using View > Grid Brightness.
When you zoom in or out, the grid lines for a dynamic grid are generated
dynamically. You can set dynamic grid lines to appear at fine, medium, or coarse
levels. The grid lines appear at common major measurement increments. A dynamic
grid displays index lines that intersect with the darker, solid grid lines.
A static grid displays solid grid lines that do not move as you zoom in or out. You can
set up the increment settings on the View tab of the Options dialog box.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Grid Display Command (View Menu), page 112
• Grid Snap Command (View Menu), page 112
• Place Elements with a Grid, page 111
• Placing Elements with a Grid: An Overview, page 110
• Using Relationships as You Draw: An Overview, page 92
Tip
• You can also access Grid Display by right-clicking. You can change the
grid display from static to dynamic by setting options on the View tab of
the Tools Options dialog box.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Grid Display Command (View Menu), page 112
• Grid Snap Command (View Menu), page 112
• Place Elements with a Grid, page 111
• Placing Elements with a Grid: An Overview, page 110
• Using Relationships as You Draw: An Overview, page 92
Relationship and alignment indicators override the grid snap. You can suppress the
indicators by holding down Alt.
Notes
• You can also access Grid Snap by right clicking in the SmartSketch
document and displaying the shortcut menu.
• You can also use F3 to toggle on/off Grid Snap.
• You can change the grid display by setting options on the View tab of the
Tools Options dialog box.
• You cannot place elements using PinPoint on the Main toolbar if you are
using Grid Snap.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Grid Display Command (View Menu), page 112
• Grid Snap Command (View Menu), page 112
• Place Elements with a Grid, page 111
• Placing Elements with a Grid: An Overview, page 110
• Using Relationships as You Draw: An Overview, page 92
The Draw toolbar also provides options for extending or trimming elements. You can
click Extend to Next to extend an element, or you can click Trim or Trim Corner to
trim an element.
You can also add fillets or chamfers by clicking Fillet or Chamfer on the Draw
toolbar.
You can rotate an element a precise angle about a specified point by using Rotate on
the Change toolbar. You can use the Rotate Ribbon to change Step Angle, Rotation
Angle, and Position Angle values.
You can also use the Change toolbar to scale elements. Scalable elements include
framed elements, such as text boxes. After clicking Scale on the Change toolbar, you
can use the Scale Ribbon to increase the Scale Factor.
Important
• You cannot use Scale to scale or scale and copy elements in a drawing
view because a scale factor has already been applied to the drawing view.
The Relationship Toolbar
You can also use the Relationship toolbar to transform elements. For example,
selecting Equal and clicking two elements will make the elements equal in size.
The software will only allow you to select elements that are valid input for a specific
command. For example, if you use the Concentric button, only circles, arcs, or
ellipses can be selected.
Notes
• When you apply a relationship between elements, the elements are
modified to reflect the relationship. If Maintain Relationships is set when
you use the commands on the Relationship toolbar to add relationships to
your drawing, the added relationships will be maintained.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Changing the Shape of an Element: An Overview, page 114
• Extending or Trimming Elements: An Overview, page 126
• Mirroring Elements: An Overview, page 120
• Rotating Elements: An Overview, page 116
• Scaling Elements: An Overview, page 122
You can change the shape of a selected element by dragging one of its handles. The
first figure shows the effect of dragging an end point handle. The second figure shows
the effect of dragging the mid point handle.
Related Topics
• Change Command, page 146
• Extending or Trimming Elements: An Overview, page 126
• Mirror an Element, page 120
• Modify an Element with the Select Tool, page 115
• Rotate an Element, page 116
• Scaling Elements: An Overview, page 122
You can first select the element and then click Rotate, or you can click the button and
then the element.
As you click to define the reference points for the rotation, the software dynamically
displays a reference axis for the rotation. If you want to define a precise location for
the rotation, you can enter values in the ribbon. You can enter increments in the Step
Angle box if you want to dynamically view the results of the rotation. For example, if
the box is set to 30.0, the rotation is displayed in 30 degree increments. The default
setting is 0 degrees so that the rotation is fully dynamic.
The Rotation Angle box on the ribbon displays the angle of change between the old
and new positions with a positive value. The Position Angle box displays an absolute
angle of the new position of the rotation. You can type values in both of these boxes
and preview the results. You then click to complete the rotation of the element.
By default, a copy is made of the element when you rotate it. If you do not want a
copy, you should clear Copy on the ribbon.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Rotate an Element, page 116
• Rotate Command, page 117
• Using Relationships as You Draw: An Overview, page 92
Rotate an Element
1. Select one or more elements.
Notes
• To rotate by increments, type a value in the Step Angle box on the ribbon.
• You can click Rotate before you select elements to rotate.
• You can use relationship indicators to define the rotation from and to
points.
• Instead of using Copy on the ribbon to copy the rotated elements, you can
hold Ctrl while you click to define the to point.
• Relationships between elements within the selection set are maintained if
the relationships still apply after the elements have been rotated.
• You can use other view manipulation commands, such as Zoom and Pan,
while you are using Rotate.
When you finish manipulating the view, the software returns you to Rotate at the
point where you left off.
Related Topics
• Rotate Command, page 117
• Rotate Ribbon, page 118
• Rotating Elements: An Overview, page 116
Rotate Command
Rotates one or more elements a precise distance or angle about a specified point.
Related Topics
• Rotate an Element, page 116
• Rotating Elements: An Overview, page 116
Rotate Ribbon
Copy - Creates a copy of the element that you are rotating. If you do not want a
copy of the rotated element, then clear this option.
Step Angle - Specifies the rotation step angle. The step angle specifies the
increments, in degrees, that an element rotates from a temporary axis. The temporary
axis is the line between the element's center of rotation (A) and the point that you
rotate the element from (B).
You can enter increments in the Step Angle box if you want to dynamically view the
results of the rotation. For example, if the box is set to 30.0, the rotation is displayed
in 30 degree increments. The default setting is 0 degrees so that the rotation is fully
dynamic.
Rotation Angle - Defines the rotation angle. The rotation angle is the angle between
the point that you rotate from and the point that you rotate to. In the following picture,
the center of rotation (A) is shown with the point that you rotate the element from
(B).
The rotation angle (C) is the angle of change between the old and new positions of the
rotated element. The value is always positive.
Position Angle - Displays the angle between the horizontal axis through the center of
rotation (A) and the point that you rotate from (B). Then, if you rotate the element,
the position angle (C) changes to become the angle between the horizontal axis and
the point that you rotate to. The position angle is always a positive value that is
measured counter-clockwise from the axis.
Related Topics
• Rotate an Element, page 116
• Rotate Command, page 117
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Mirror an Element, page 120
• Mirror Command, page 122
• Using Relationships as You Draw: An Overview, page 92
Mirror an Element
You can mirror elements by defining a mirror axis or by using a linear element as a
mirror axis. You can also mirror and copy elements.
5. Position the pointer so that the mirrored elements are where you want them, then
click.
To mirror about a mirror axis that you define
1. Select one or more elements.
2. On the Change toolbar, click Mirror.
3. If you want to copy the mirrored elements, click Copy on the ribbon.
4. Define one end of the mirror axis by click in free space or by clicking a key point.
The software displays the mirror axis and mirrored elements dynamically.
5. Move the pointer until the mirror axis and the mirrored elements where you want
them to be, then click.
Notes
• If Maintain Relationships is set, the software places a symmetric
relationship when you mirror and copy elements. The mirror axis is used
as the symmetry axis.
• Relationships within the selection set are copied to the mirrored elements
if they are still applicable.
• You can click Mirror before you select elements to mirror.
• Instead of using Copy on the ribbon to mirror and copy, you can hold Ctrl
while you click to position the elements.
• Instead of positioning the mirror axis dynamically, you can use the
Position Angle box on the ribbon.
• You can use relationship indicators to define a mirror axis.
• You can use other view manipulation commands, such as Zoom and Pan,
while you are using Mirror.
When you finish manipulating the view, the software returns you to Mirror at the
point where you left off.
Related Topics
• Mirror an Element, page 120
• Mirror Command, page 122
• Mirror Ribbon, page 122
• Mirroring Elements: An Overview, page 120
Mirror Command
Mirrors one or more selected elements about a line or axis that you define. You
can mirror without copying, or mirror and copy.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Mirror an Element, page 120
• Mirroring Elements: An Overview, page 120
• Using Relationships as You Draw: An Overview, page 92
Mirror Ribbon
Position Angle - Sets the angle of the mirror axis. The origin of the angle
measurement is the point you clicked for the beginning of the mirror axis. Setting the
position angle to 0 extends the axis horizontally to the right of the screen, 90 extends
the axis vertically to the top, 180 extends the axis horizontally to the left, and 270
extends the axis vertically to the bottom.
Related Topics
• Mirror an Element, page 120
• Mirror Command, page 122
Relationships within the selection set are maintained if the relationships are still
applicable after the elements have been scaled. If not, the relationships are deleted.
To define the new scale, you can click points on the drawing sheet or you can type a
value in the Scale Factor box on the ribbon. You can also use the Step box on the
ribbon to make the Scale Factor increase or decrease incrementally as you move the
mouse.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Scale Command, page 125
• Using Relationships as You Draw: An Overview, page 92
Scale an Element
1. Select one or more elements.
5. Move the pointer until the elements are the size you want and then click.
Notes
• Relationships within the selection set are maintained if the relationships
are still applicable after the elements have been scaled.
• You can click Scale before you select elements to scale.
• Instead of clicking to define the new scale, you can use the Scale Factor
box on the ribbon.
• Instead of using Copy on the ribbon to scale and copy, you can hold Ctrl
while you click to define the new scale.
• You can use relationship indicators with this command.
• You can use the Step box on the ribbon to make the Scale Factor increase
or decrease incrementally as you move the mouse.
• You can use the Reference box on the ribbon to change how the
command dynamics correspond to the Scale Factor.
• To change the overall size of the graphics with respect to the paper size,
use Sheet Setup on the File menu.
Related Topics
• Scale an Element with Its Handles, page 124
• Scale an Element, page 123
• Scale an Inserted Object Back to Its Original Model Size, page 124
• Scale Command, page 125
• Scale Ribbon, page 125
• Scaling Elements: An Overview, page 122
Related Topics
• Scale an Element with Its Handles, page 124
• Scale an Element, page 123
• Scale an Inserted Object Back to Its Original Model Size, page 124
• Scale Command, page 125
• Scale Ribbon, page 125
• Scaling Elements: An Overview, page 122
Scale Command
Reduces or enlarges selected elements by a scale factor that you define. The scale
factor is the same along the X and Y axis. Scalable elements include framed elements,
such as text boxes. You can use Scale to scale, or to simultaneously scale and copy.
Related Topics
• Scaling Elements: An Overview, page 122
Scale Ribbon
Step - Specifies the step value for the Scale Factor. The step value causes the Scale
Factor to be decreased or increased in increments as you move the pointer toward or
away from the scale origin. For example, if you set the step value to 0.25, the scale
increases in increments of 0.25 as you move the pointer away from the scale origin.
Scale Factor - Specifies how much the software reduces or enlarges the element. A
scale factor between zero and one reduces; a scale factor greater than one enlarges.
Reference - Specifies how long the dynamic line from the scale origin to the pointer
has to be in order to achieve a Scale Factor of 1.
For example, if you set Reference to 1, for every inch you move the pointer away
from the scale origin, the scale factor increases by one. If you set Reference to 2, for
every two inches you move the pointer away from the scale origin, the scale factor
increases by one.
Related Topics
• Scale an Element with Its Handles, page 124
• Scale an Element, page 123
• Scale an Inserted Object Back to Its Original Model Size, page 124
You can also draw a chamfer on two different elements with Chamfer on the Draw
toolbar. The elements must be linear, but do not have to intersect. The elements
cannot be parallel to each other.
When two lines intersect, you can draw a chamfer simply by clicking the corner and
then moving the pointer in the distance that you want. A final click on the drawing
sheet places the chamfer (B).
To place a fillet, you can click Fillet on the Draw toolbar and then select the
elements you want to modify. As with any command, you can use a combination of
clicks and ribbon input.
Related Topics
• Chamfer Command, page 136
• Change Command, page 146
• Draw a Chamfer, page 129
• Draw a Fillet, page 132
• Drawing Basic Elements: An Overview, page 9
• Extend an Element, page 127
• Extend to Next Command, page 135
• Fillet Command, page 137
• Trim an Element, page 128
• Trim Command, page 135
• Using Relationships as You Draw: An Overview, page 92
Extend an Element
1. On the Draw toolbar, click Extend to Next .
2. Do one of the following:
• To extend one element at a time, click each element near the end you
want to extend.
• To extend more than one element at the same time, drag the pointer
over the elements near the end you want to extend. When you release
the mouse button, all the elements are extended.
Notes
• Before you select an element to extend, you can view the possible results.
When you move the pointer over elements, the software displays the
extension that will be drawn if you click.
• If an element does not extend in the direction you want it to, move your
pointer closer to the end of the element you want to extend.
Related Topics
• Extend to Next Command, page 135
Trim an Element
1. On the Draw toolbar, click Trim .
2. Do one of the following:
• To trim one element at a time, click each element you want to trim.
• To trim more than one element at the same time, drag the pointer over
the elements. When you release the mouse button, all the elements are
trimmed.
Notes
• Before you click an element to trim, you can use PickQuick to see which
portion of the element will be trimmed. When you move the pointer over
the elements, PickQuick highlights the portion of the element that will be
trimmed if you click.
• If you trim an element that does not intersect any other elements, the
command trims the entire element, effectively deleting the element.
Related Topics
• Extending or Trimming Elements: An Overview, page 126
• Trim Command, page 135
• Drag the pointer over one or more elements, then release the mouse
button. The parts of the element over which you dragged the mouse
remain — other parts are trimmed or extended as necessary.
Note
• You can draw only one corner at a time by dragging the pointer.
Related Topics
• Extending or Trimming Elements: An Overview, page 126
• Trim Corner Command, page 135
Draw a Chamfer
1. On the Draw toolbar, click Chamfer .
2. On the ribbon, type a distance value in the Setback A box. The first linear
element will be set back this distance from the corner.
3. Do one of the following:
• To define the setback distance for the second linear element, type a
value in the Setback B box on the ribbon.
• To define the chamfer angle, type a value in the Angle box on the
ribbon.
4. Click the linear element to which you want to apply the Setback A value.
5. Click the linear element to which you want to apply the Setback B value or the
chamfer angle value.
Tip
• The lines that you select do not need to intersect, but they cannot be
parallel.
• When two lines intersect, you can draw a chamfer simply by clicking the
corner and then moving the pointer in the distance that you want. A final
click on the drawing sheet places the chamfer.
• You can draw a chamfer with equal chamfer angles. Click the two linear
elements you want to use. When the chamfer is displayed dynamically,
move the pointer until the setback distance you want to use is displayed,
then click.
• You can switch the setback values for the linear elements. After you click
the linear elements you want to use, move the mouse pointer to one side or
the other of the temporary line display, then click.
• When the elements you want to use cross each other, you can draw the
chamfer in any of the quadrants. The software trims the remaining
elements at the end points of the chamfer.
• You can easily draw more than one 45 degree chamfer with the same
setback distance. On the ribbon, type a value in the Setback A or Setback
B box. The value in the setback box is active until you change it, so you
can click one corner after another to draw equivalent chamfers.
• You can draw a chamfer by dragging the pointer over the two elements
that you want to draw the chamfer between. When you use this method,
the setback distance and angle boxes on the ribbon are not active.
Related Topics
• Chamfer Command, page 136
• Chamfer Ribbon, page 136
Draw a Fillet
1. On the Draw toolbar, click Fillet .
2. On the ribbon, type a radius in the Radius box.
3. Click one of the elements that you want to draw the fillet between. You can draw
a fillet between arcs, lines, circles, ellipses, and curves.
4. Click the other element.
5. Click to draw the fillet.
Notes
• You can draw a fillet without typing a radius. Click the two elements you
want to use. Then move the pointer to a position that defines the radius,
and click.
• When the elements you want to use cross each other, you can draw a fillet
at any of the quadrants. The software trims the remaining elements at the
end points of the fillet.
• You can draw a fillet at a corner with one click. On the ribbon, type a
value in the Radius box. Position the pointer over a corner, then click.
The value in the Radius box is active until you change it, so you can click one
corner after another to draw fillets with the same radius.
• You can draw a fillet by dragging the pointer over the two elements that
you want to draw the fillet between. When you use this method, the
Radius box on the ribbon is not active.
Related Topics
• Extending or Trimming Elements: An Overview, page 126
• Fillet Command, page 137
• Fillet Ribbon, page 137
2. On the Split ribbon, click Segment the Element to enable Segment mode.
Tip
• The Segment the Element button is used to toggle between Split and
Segment modes. When the button is depressed, Segment mode is
enabled; when the button is "up", Split mode is enabled.
3. Then, enter the number of segments in the Segments field.
4. Select a graphic element in the SmartSketch drawing.
Tip
• As long as the Split command is active, you can continue splitting
SmartSketch elements by selecting them on the Drawing sheet.
Notes
• A graphic element is any primitive geometric shape, such as a line, circle,
or arc.
• Split mode divides the selected element into an equal number of sections;
Segment mode places equally spaced points along the selected element.
You can toggle between these two modes to alternatively split and
segment SmartSketch elements when the Split command is active.
• Press Esc or right-click an empty space on the active Drawing sheet to
exit the Split command.
Related Topics
• Split Command (Draw Toolbar), page 137
If there is no possible intersection between the element you want to extend and any
other element in the view, the command does not extend the element.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Extend an Element, page 127
• Extending or Trimming Elements: An Overview, page 126
• Using Relationships as You Draw: An Overview, page 92
Trim Command
Trims open and closed elements to the closest intersection in both directions.
Related Topics
• Extending or Trimming Elements: An Overview, page 126
Related Topics
• Draw a Corner by Trimming and Extending Elements, page 129
• Drawing Basic Elements: An Overview, page 9
• Extending or Trimming Elements: An Overview, page 126
• Using Relationships as You Draw: An Overview, page 92
Chamfer Command
Draws a chamfer, or bevel, between two linear elements. You can control the
chamfer angle and the setback distances for both elements.
Related Topics
• Draw a Chamfer, page 129
• Drawing Basic Elements: An Overview, page 9
• Drawing FreeForm Shapes: An Overview, page 35
• Drawing with Relationships: An Overview, page 90
• Extending or Trimming Elements: An Overview, page 126
• Using Relationships as You Draw: An Overview, page 92
Chamfer Ribbon
Style - Sets the drawing style.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
Angle - Measures the angle between the chamfer and the first linear element.
Setback A - Specifies the distance from the corner to the beginning of the chamfer on
the first linear element you select.
Setback B - Specifies the distance from the corner to the beginning of the chamfer on
the second linear element you select.
Related Topics
• Draw a Chamfer, page 129
Fillet Command
Draws a fillet between two elements. The elements can be arcs, lines, circles,
ellipses, or curves.
Related Topics
• Draw a Fillet, page 132
• Drawing Basic Elements: An Overview, page 9
• Extending or Trimming Elements: An Overview, page 126
• Using Relationships as You Draw: An Overview, page 92
Fillet Ribbon
Style - Sets the drawing style.
Line Color - Sets the drawing color. You can click More to define custom colors
with the Colors dialog box.
Radius - Specifies the radius between the two elements you want to use to create the
fillet.
Related Topics
• Draw a Fillet, page 132
• Extending or Trimming Elements: An Overview, page 126
• Fillet Command, page 137
Provides two modes for splitting graphic elements: Split mode, in which the
selected element is divided into an equal number of sections, and Segment mode, in
which equally spaced points are placed along the selected element.
In Split mode, points display (as x's) on the selected object indicating where it will be
divided. In the following illustration, the circle has been divided into four sections:
In Segment mode, points display on the selected object indicating where the
segments have been spaced. In the following illustration, notice that the circle is
segmented by four equally-spaced points.
Split/Segment Ribbon
Related Topics
• Split Graphic Elements, page 133
Split/Segment Ribbon
Sets options for dividing a graphic object.
Segment the Element - Toggles between Split mode, which allows you to
divide a graphic object into equal sections, and Segment mode, which allows you to
place equally spaced points along a graphic object.
Number of Segments - Specifies the number of segments into which the graphic
element is divided. The minimum number of segments that can be specified is two.
Related Topics
• Split Command (Draw Toolbar), page 137
For example, selecting Equal and clicking two circles makes the two circles equal in
size.
If a line and arc are not tangent, applying a tangent relationship modifies one or both
elements to make them tangent.
When you use commands on the Relationship toolbar, the software allows you to
select only elements that are valid input for that command. For example, when you
use Concentric, the command allows you to select only circles, arcs, and ellipses.
Perhaps you begin designing with a few key design parameters. You would usually
draw known elements in relation to one another and then draw additional elements to
fill in the blanks.
As you draw and add elements to the drawing, the relationships are maintained and
additional relationships are applied.
If you move a circle that does not have a tangent relationship with a line, the line does
not move.
Other elements that share relationships maintain them in the following ways:
• If a line and an arc share a tangent relationship, they remain tangent when
either is modified.
• If a line and arc share a connect relationship, they remain connected when
either is modified.
• If two lines are horizontal, they remain horizontal even if you change the
position and length of one of the lines.
Deleting Relationships
You can delete a relationship as you would delete any other element. You select a
relationship handle, and then click Delete. Relationships are automatically deleted
when their deletion is necessary to allow a modification to occur. For example, if you
rotate an element that has a horizontal relationship applied to it, the relationship is
automatically deleted.
Related Topics
• Connect Elements, page 143
• Make Elements Colinear, page 145
• Make Elements Concentric, page 142
• Make Elements Equal, page 144
• Make Elements or Key Points Horizontal or Vertical, page 145
• Make Elements Parallel, page 142
• Make Elements Perpendicular, page 143
• Make Elements Symmetric About an Axis, page 146
• Make Elements Tangent, page 144
3. Click another arc or circle. One element moves to make the two elements
concentric.
Notes
• The order in which you select the elements might determine which
element moves to a new location.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Concentric Command, page 147
• Drawing Basic Elements: An Overview, page 9
• Using Relationships as You Draw: An Overview, page 92
Connect Elements
1. On the toolbar, click Connect .
2. Click an element at a key point.
3. Click another element or key point. One element moves to connect the elements.
Notes
• The order in which you select the elements might determine which
element moves to a new location.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Connect Command, page 147
• Drawing Basic Elements: An Overview, page 9
• Using Relationships as You Draw: An Overview, page 92
Notes
• The order in which you select the elements might determine which
element moves to a new location.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Tangent Circle Command, page 17
• Tangent Command, page 148
• Using Relationships as You Draw: An Overview, page 92
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Equal Command, page 147
• Using Relationships as You Draw: An Overview, page 92
Change Command
Displays the Change toolbar. You can use the commands on this toolbar to
manipulate elements.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
Colinear Command
Makes two lines colinear.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Using Relationships as You Draw: An Overview, page 92
Concentric Command
Makes an arc or circle concentric with another arc or circle.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Make Elements Concentric, page 142
• Using Relationships as You Draw: An Overview, page 92
Connect Command
Connects two elements or key points at one point. This command also connects a
key point on an element to a position that you select on another element.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Connect Elements, page 143
• Drawing Basic Elements: An Overview, page 9
• Using Relationships as You Draw: An Overview, page 92
Equal Command
Makes elements or dimension values equal. You can make the length of lines, the
radius of arcs and circles, and the values of dimensions equal.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Make Elements Equal, page 144
• Using Relationships as You Draw: An Overview, page 92
Horizontal/Vertical Command
Makes a line horizontal or vertical, or horizontally or vertically aligns two key
points.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Make Elements or Key Points Horizontal or Vertical, page 145
Parallel Command
Makes two lines parallel.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Make Elements Parallel, page 142
• Using Relationships as You Draw: An Overview, page 92
Perpendicular Command
Makes two elements perpendicular. You can make two lines, a line and an arc, or
a line and a circle perpendicular.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Make Elements Perpendicular, page 143
• Using Relationships as You Draw: An Overview, page 92
Symmetric Command
Makes elements symmetric about an axis. The characteristics of the first element
selected, such as size and position, are maintained by the symmetric relationship.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Make Elements Symmetric About an Axis, page 146
• Using Relationships as You Draw: An Overview, page 92
Tangent Command
Makes two elements tangent. You can make two circles or arcs tangent. You can
also make a circle, or an arc, and a line tangent.
Related Topics
• Applying Relationships to Change Existing Elements: An Overview, page
138
• Drawing Basic Elements: An Overview, page 9
• Make Elements Tangent, page 144
The Group command on the Change toolbar allows you to group elements that
reside in the same document and drawing sheet together. The elements can then be
modified as a unit. You can ungroup elements by clicking Ungroup on the Change
toolbar.
You can also use Layers on the Main toolbar to arrange elements. Each time you
draw an element it is assigned to the active layer. You can use Layers to see which
layer is active or to change the active layer.
The Display Manager on the Tools menu allows you to control the way elements
appear on sheets or layers by changing settings such as, line type or color.
Elements that overlap are displayed in the order they are drawn. A newly created
element is placed in front of all other elements because it has the highest display
priority. An element's display priority can easily be changed. You can pull an element
up one position, push it down one position, send it to the back, or bring it to the front
by selecting the appropriate command on the Change toolbar.
Related Topics
• Element Display Priority: An Overview, page 155
• Grouping Elements: An Overview, page 149
You can use Group to nest two or more entire groups within a larger group, or you
can nest individual elements and groups within a larger group.
Once elements are grouped, you can use Ungroup to ungroup all of the elements at
the same time. You can also use Ungroup and PickQuick to remove one or more
elements from a group.
You can also use PickQuick to select one or more group members or an entire group.
When you copy an entire group, all of its members are copied, including nested
groups. The software creates a new group that contains all of the members of the
original group. When you copy one member of a group, only that member is copied.
If you use PickQuick to select a member of a group, you can perform tasks on the
member individually, without affecting other members.
Related Topics
• Drawing Basic Elements: An Overview, page 9
• Group Command, page 152
• Group or Ungroup Elements, page 151
• Moving Elements: An Overview, page 51
• UnGroup Command (Change Toolbar), page 154
• Using Relationships as You Draw: An Overview, page 92
To group elements
1. Select two or more elements.
Tip
• You cannot select an element that is already a member of a group.
2. On the Change toolbar, click Group .
To ungroup elements
1. Select a group.
Group Command
Binds elements so you can locate, select, and manipulate them as a unit. Grouped
elements are usually related, such as the holes and center lines of a bolt hole pattern.
When you select a group, the Group ribbon is displayed so you can edit the entire
group or any of its members. The command is only active when one of the following
conditions is met:
Group Ribbon
Style - Sets the style for all of the elements in a group.
Line Type - Sets the line types and styles for all of the elements in a group.
Width - Sets the line width for all of the elements in a group.
Related Topics
• Group Command, page 152
• Group or Ungroup Elements, page 151
• Grouping Elements: An Overview, page 149
Related Topics
• Group Command, page 152
• Group or Ungroup Elements, page 151
• Grouping Elements: An Overview, page 149
Sheet - Displays the name of the drawing sheet the element is on. You cannot edit the
name of the drawing sheet.
Name - Displays the name of the group. The software names the group when you
create it.
Number Of Items - Displays the number of elements in the group. This label updates
automatically when you add elements to or delete elements from the group.
Is Nested Within Another Group - Shows whether the group is nested within
another group. This label updates automatically when you nest a group using Group,
or ungroup a group using Ungroup.
Contains Nested Groups - Displays whether or not the selected group contains
nested groups.
Closed - The Preview Box shows whether the members of the group are primitive
elements, such as lines, arcs, and curves; whether the end points of these elements are
connected; and whether the members of the group form a closed region.
This box updates automatically when you add elements to or delete elements from the
group.
End-Point Connected - The Preview Box shows whether the members of the group
are primitive elements, such as lines, arcs, and curves, and whether the end points of
these elements are connected. This label updates automatically when you add
elements to or delete elements from the group.
Related Topics
• Group or Ungroup Elements, page 151
• Group Properties Dialog Box, page 152
• Grouping Elements: An Overview, page 149
• Properties Command (Edit Menu), page 185
User Tab
Attribute Set - Names a group of attributes. You can type a name in the box and
press Tab.
Save - Places the attribute set on the element that you selected.
Remove - Removes the attribute set from the element that you selected.
Attributes - Sets the name, type, and value of the attribute set. You can type a name
in the box and press Tab.
Type - Sets the type for the attribute, such as double, text, number, money, or date.
Value - Sets the value for the attribute. The value that you can enter is based on the
type that you selected in the Type box.
Add - Adds an attribute to the attribute set. After you click Add, the attribute appears
in the table.
Delete - Removes an attribute from the attribute set. You can select an attribute by
clicking a row in the table.
Related Topics
• Group or Ungroup Elements, page 151
• Group Properties Dialog Box, page 152
• Grouping Elements: An Overview, page 149
• Properties Command (Edit Menu), page 185
Related Topics
• Group Command, page 152
• Group or Ungroup Elements, page 151
• Grouping Elements: An Overview, page 149
For example, if you draw a circle, then an ellipse, and then a rectangle, the circle is
displayed in back. The ellipse is displayed between the circle and the rectangle, and
the rectangle is displayed in front.
You can change the display priority of a group the same way. The display priority of
elements within the group does not change.
Related Topics
• Bring an Element to the Front of the Display Order, page 156
• Pull an Element Up in the Display Order, page 157
• Pull Up Command, page 158
• Push an Element Down in the Display Order, page 157
• Push Down Command, page 158
• Selecting Elements: An Overview, page 45
• Send an Element to the Back of the Display Order, page 156
• Send To Back Command, page 158
Notes
• When you select a single element, the element moves to the front of the
display.
• When you bring more than one element or an element group to the front of
the display order, the elements retain their display order within the
selection set or group.
Related Topics
• Bring to Front Command, page 157
• Element Display Priority: An Overview, page 155
• Pull Up Command, page 158
• Push Down Command, page 158
• Send an Element to the Back of the Display Order, page 156
Related Topics
• Bring an Element to the Front of the Display Order, page 156
• Bring to Front Command, page 157
• Element Display Priority: An Overview, page 155
• Pull Up Command, page 158
• Push Down Command, page 158
Related Topics
• Bring to Front Command, page 157
• Element Display Priority: An Overview, page 155
• Pull Up Command, page 158
• Push Down Command, page 158
• Send an Element to the Back of the Display Order, page 156
• Send To Back Command, page 158
Pull Up Command
Moves one or more selected elements or element groups up one position in the
display order.
If more than one element overlaps the selected elements, the selected elements do not
move all the way to the front. To quickly move elements to the front, click Bring To
Front.
Related Topics
• Element Display Priority: An Overview, page 155
• Pull an Element Up in the Display Order, page 157
If the selected elements overlap more than one other element, the selected elements
do not move all the way to the back. To quickly move elements to the back, click
Send To Back.
Related Topics
• Element Display Priority: An Overview, page 155
• Push an Element Down in the Display Order, page 157
• Send an Element to the Back of the Display Order, page 156
Styles
To make elements that are the same type look alike, you can use styles to apply
several formats at once. Styles are a collection of formats that are saved under a
name. Styles allow you to save several formats so you can use them again and again.
Using styles guarantees consistency in a drawing.
To make an element look unique, you can select it and then format it directly.
Formatting a few elements at a time takes more time than applying styles, but gives
you greater flexibility.
The software provides fills that you can apply to closed boundaries. A fill floods a
closed boundary with a solid color or pattern.
Besides fills, the software provides line types such as continuous, dash, chain,
continuous chain, double chain, dot, and end gap. New line types can be created
through Visual Basic Automation.
For example, a valve symbol's style properties can include color, line style, and
width. Other user-defined properties stored with the symbol can include the
manufacturer, cost, or material.
Related Topics
• Applying Colors and Patterns to Closed Boundaries: An Overview, page
193
• Applying Formats with Styles: An Overview, page 160
• Applying Unique Formats: An Overview, page 182
• Format a Dimension or Annotation, page 184
• Format a Fill, page 196
• Format a Geometric Element, page 183
• Format a Text Box, page 184
• Geometric elements
• Dimensions
• Annotations
• Fills
Using styles ensures consistency. If you place or draw one or more elements, the
formats in the style are applied directly to the elements. You do not have to spend
time formatting as you draw. You can apply the formats in each style again and again.
The software provides styles that you can apply to elements so that they conform to
an engineering standard, such as ISO or ANSI.
Managing Styles
Using Style on the Format menu, you can create several styles so that elements in a
drawing appear the way you want. You can use or modify the styles delivered with
the software, or you can set up new ones that conform to your unique requirements.
One or more styles can be stored in a template so that you can use them in other
drawings.
The software divides styles into types, such as text, dimension, line, and fill. A style
type contains one or more styles. You can create styles for each style type. When you
create a new document based on a template, the template is copied. The copy includes
any styles that are in the template. Fonts are never copied into a document. If you
want someone to view the fonts, and that person's system does not have the same
fonts installed, you should give that person the fonts along with the document.
If you create a document based on a template, any style resource documents attached
to the template are attached to the new document as well. When you reference a style
resource document from the current document or template, the styles in the resource
document are added to the Style dropdown list on the active document's ribbon.
When you apply one of the line, dimension, or fill styles to an element on the drawing
sheet, the style is copied from the style resource document to the current document.
The fonts are added to the dropdown list on the ribbon as well, but are not copied into
the current document.
Applying Styles
The style type determines what type of item to which you can apply a style. A text
style can be applied to text within a text box. A fill style can be applied to a fill. A line
style can be applied to any geometric element such as a line, arc, circle, or ellipse. A
dimension style can be applied to a dimension or balloon.
When you place dimensions or annotations, or draw elements, the formats from their
default styles are applied automatically. For example, if you click SmartDimension
on the Dimension toolbar, the ANSI style appears on the ribbon. Each dimension
that you place receives the ANSI style. To apply a different style, you can change the
style name on the ribbon before or after you draw or place an element.
Important
• To preserve the data integrity of your custom styles files from one
software version to the next, Intergraph PPM recommends after installing
the latest version of the software that you open all your custom styles files
and save them to the new file format.
Related Topics
• Apply a Style to a Group of Elements, page 163
• Apply a Style, page 162
• Applying Unique Formats: An Overview, page 182
Apply a Style
1. Select the element you want to format.
2. Click Format > Style.
3. On the Style dialog box, in the Styles list, click the style you want to apply.
4. Click Apply.
Notes
• If you have formatted an element with Properties, or by setting options on
the active ribbon, these formats are removed when you apply a style.
Related Topics
• Apply a Style to a Group of Elements, page 163
• Applying Formats with Styles: An Overview, page 160
• Reapply Style Dialog Box, page 181
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
• Style Dialog Box, page 168
Notes
• Segmented Style does not recognize symbols as a bounding element.
• If you change the size of the element, you must re-apply the line type or
color by using Segmented Style.
Related Topics
• Segmented Style Command, page 180
Rename a Style
1. Click Format > Style.
2. On the Style dialog box, in the Style Types field, click the style type you want.
3. In the Style box, click the style you want to rename.
4. Click Modify.
5. In the Name box, type the new name for the style.
6. Click OK.
7. Close the dialog box.
Related Topics
• Applying Formats with Styles: An Overview, page 160
• Style Dialog Box, page 168
Delete a Style
1. Click Format > Style.
2. On the Style dialog box, in the Style Types field, click the style type you want.
3. In the Style box, click the style you want to delete.
4. Click Delete.
5. Confirm that you want to delete the style.
Related Topics
• Applying Formats with Styles: An Overview, page 160
• Style Dialog Box, page 168
Related Topics
• Applying Formats with Styles: An Overview, page 160
• New Dimension Style Dialog Box, page 172
• New Line Style Dialog Box, page 169
• New Text Box Style Dialog Box, page 170
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
Notes
• If an element has a style, you can override the style by editing the
element's properties with the Properties command on the Edit menu.
• You can remove style overrides by re-applying a style.
• You can modify one or more styles using Style on the Format menu.
Related Topics
• Applying Formats with Styles: An Overview, page 160
• Modify Dimension Style Dialog Box, page 180
• Modify Line Style Dialog Box, page 180
• Modify Text Box Style Dialog Box, page 180
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
Related Topics
• Applying Formats with Styles: An Overview, page 160
• Segmented Style Command, page 180
Tip
• The line styles are copied from the style resource document into the
current document. The font styles are not copied. So, if you want another
person to be able to view the same fonts in the document and that person's
system does not have the same fonts installed, you should give that person
a copy of the fonts along with the document.
Notes
• Sometimes you might attach several style resource documents that contain
styles with duplicate names. In these cases, the style in the style resource
document that is listed first in the Style Resources list takes precedence
and will be listed on the ribbon of the active document.
Related Topics
• Applying Formats with Styles: An Overview, page 160
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
Related Topics
• Apply a Style to a Group of Elements, page 163
• Apply a Style, page 162
• Applying Formats with Styles: An Overview, page 160
• Change the Formats of a Style, page 166
• Create a Style Using a Formatted Element, page 165
• Create a Style with the Style Command, page 165
• Delete a Style, page 164
• Format Part of an Element, page 163
• Rename a Style, page 164
• Save a Style to a Template, page 166
• Style Command (Format Menu), page 168
Tip
• You cannot create or modify a fill style with this dialog box. To create a
new fill style, you can type a name for a fill style in the Style box on the
Fill ribbon. The new style is saved with the current settings on the Fill
ribbon.
Dialog Box Options
Style Type - Specifies the style type. If you are placing a new element, you can
specify the style by clicking the appropriate style type in this box and then clicking
the style that you want in the Styles box. You can also change the style of an existing
element by selecting the element and then clicking Styles on the Format menu to set
these options.
Styles - Specifies the style. Before selecting an item on this list, you must first select
the appropriate style type in the Style Type box.
List - Specifies which styles appear in the Styles list. You can list only the styles in
use, styles that you defined, or all styles.
Tip
• The only styles that appear in the list are styles that are saved in the
current document. The styles saved in a styles resource document are not
listed. However, if you click New, you can select a style from a style
resource document to use as a base style for the new style that you are
creating.
Description - Displays a description of the settings in the style.
Apply - Applies the style selected in the Styles box to elements that you selected.
Applying a new style to elements that you selected removes the current formats for
the element.
• New - Accesses one of the Related Topics
• New Dimension Style Dialog Box, page 172
• New Line Style Dialog Box, page 169
• New Text Box Style Dialog Box, page 170
so that you can create a new style.
• Modify - Accesses one of the Related Topics
• Modify Dimension Style Dialog Box, page 180
• Modify Line Style Dialog Box, page 180
• Modify Text Box Style Dialog Box, page 180
so that you can modify the style that you selected in the Styles list.
Resources - Allows you to add style resource documents to the current template with
the Style Resources dialog box.
Related Topics
• Apply a Style to a Group of Elements, page 163
• Apply a Style, page 162
• Change the Formats of a Style, page 166
• Create a Style with the Style Command, page 165
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
New Line Style Dialog Box
Creates a line style by allowing you to specify new characteristics. You can also
define a new dash definition.
Related Topics
• Change the Formats of a Style, page 166
• Create a Style with the Style Command, page 165
Name Tab
Names a style when you create or modify a style. This tab appears only when you
click New or Modify on the Styles dialog box.
Name - Names the style. Style names can contain up to 253 characters (including
aliases and separators) and can include any combination of characters and spaces,
except the backslash character (\), semicolon (;), and braces ({ }). Style names are
case sensitive.
Based On - Displays the name of the style that the current or new style is based on.
Related Topics
• Change the Formats of a Style, page 166
• Create a Style with the Style Command, page 165
• Style Dialog Box, page 168
General Tab
Sets formats for a line.
Style - Displays the name of the style that is currently applied to the selected element
.
Related Topics
• Format a Geometric Element, page 183
• Modify Line Style Dialog Box, page 180
• New Line Style Dialog Box, page 169
New Text Box Style Dialog Box
Specifies the name of the style, the formats defined for the style, and other
characteristics.
Related Topics
• Change the Formats of a Style, page 166
• Character Map Command, page 84
• Create a Style with the Style Command, page 165
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
• Style Dialog Box, page 168
Name Tab
Names a style when you create or modify a style. This tab appears only when you
click New or Modify on the Styles dialog box.
Name - Names the style. Style names can contain up to 253 characters (including
aliases and separators) and can include any combination of characters and spaces,
except the backslash character (\), semicolon (;), and braces ({ }). Style names are
case sensitive.
Based On - Displays the name of the style that the current or new style is based on.
Related Topics
• Change the Formats of a Style, page 166
• Create a Style with the Style Command, page 165
• Style Dialog Box, page 168
Paragraph Tab
Text Style - Displays the style for a text box.
Language - Lists and applies a language for text in a text box. If you use text
characters from more than one language in a text box, the option you specify in this
box determines the way the lines wrap in the paragraph.
Units Space - Sets the paragraph to paper units or to world units. You can change this
control only when you are creating new styles from the Format Styles or Format
Text Box dialog boxes. When you view this control from the Properties dialog box,
it is read-only. You can change the control from the Info tab because all paragraphs
contained within a text box must exist in the same units.
Note
• Within the drawing environment, "world units" is synonymous with the
term "model units" found in other CAD packages.
Text Color - Sets the color of the font.
Spacing - Determines the amount of space between lines and paragraphs in a text
box.
Text Alignment - Specifies alignment for each paragraph within the block of
formatted text. Values for horizontal alignment include Left, Center, and Right.
If Text Orientation is horizontal, you modify all the paragraph alignment properties
for all paragraphs within the text box. (These properties appear in the Text
Alignment area of the Info tab.)
If Text Orientation is vertical, you modify the shape alignment properties. (These
properties appear in the Text Alignment area of the Info tab.
Line spacing - Lists and applies the amount of vertical space between lines of text.
• Single sets the line spacing for each line to display the largest font in the
line.
• 1.5 sets the line space for the line to one-and-a-half that of single lines.
• Double sets the line spacing for the line to twice that of single lines.
Paragraph Spacing - Specifies the amount of space before and after paragraphs. No
spacing exists before the first paragraph and or after the last paragraph.
Before - Adds space before a paragraph. This value is set in the current working
units, not in points.
After - Adds space after a paragraph. This value is set in the current working units,
not in points. You can set the units using Units on the Format menu.
Related Topics
• Format a Text Box, page 184
• Format Text Box Dialog Box, page 193
• Modify Text Box Style Dialog Box, page 180
• New Text Box Style Dialog Box, page 170
• Text Box Properties Dialog Box, page 76
New Dimension Style Dialog Box
Creates a new dimension style.
Related Topics
• Change the Formats of a Style, page 166
• Create a Style with the Style Command, page 165
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
General Tab
Sets general properties for dimensions.
Error Dimension - Sets the color for error dimensions. Error dimensions are driving
or driven dimensions that the software cannot recalculate correctly after parametric
attributes on driving dimensions are changed.
Automatic - Determines a correct dimensional value based on the scale set in the
drawing view.
Manual- Scales a dimensional value. The scale value determines the dimensional
value.
Important
• Manual mode only works with dimensions that are set to Driven.
Related Topics
• Format a Dimension or Annotation, page 184
• Format Dimension Dialog Box, page 193
• Modify Dimension Style Dialog Box, page 180
• New Dimension Style Dialog Box, page 172
Units Tab
Sets the primary units for dimensions.
Unit Label - Sets the unit label. You can type up to 20 characters for a unit label.
Subunit Label - Sets the subunit label. You can type up to 20 characters for a subunit
label.
Round-Off - Sets the round-off for the value. This control is sensitive to the unit
setting (decimal or fractional) and contains values appropriate for the unit. This
control is also sensitive to the dimension that you place and contains values
appropriate for the dimension.
Maximum Subunits - Sets the maximum subunits value. You can type a value up to
18. This value applies to feet and inches. For example, if you type 13, the dimension
appears as 13 inches and not 1 foot and 1 inch.
Units - Sets the primary units for angular dimensions. Options are Degrees, Deg-Min-
Sec, or Radians.
Round-Off - Sets the round-off for the value. This control is sensitive to the unit
setting (decimal or fractional) and contains values appropriate for the unit. This
control is also sensitive to the dimension that you place and contains values
appropriate for the dimension.
Leading - Places a zero to the left of the decimal point if no numbers appear to the
left.
Trailing - Places zeros to the right of the decimal point. The number of zeros placed
is based on the active setting for Round-Off. For example, if the dimensional value is
.5, and the round-off setting is .1234, the dimensional value appears as .5000.
Related Topics
• Format a Dimension or Annotation, page 184
• Format Dimension Dialog Box, page 193
• Modify Dimension Style Dialog Box, page 180
• New Dimension Style Dialog Box, page 172
Secondary Units Tab
Sets the secondary units for dimensions.
Units - Sets the secondary units in drawings with dual unit display. For example, the
primary unit can be inches, while the secondary unit can be millimeters. When you
place the dimension, it displays both units. The software derives the secondary unit
by converting the primary unit.
Unit Label - Sets the secondary units label in drawings with dual unit display. You
can type up to 20 characters.
Subunit Label - Sets the secondary subunit label in drawings with dual unit display.
You can type up to 20 characters.
Round-Off - Sets the round-off value for secondary units in drawings with dual unit
display.
Maximum Subunits - Sets the maximum subunits used for secondary subunits in
drawings with dual unit display.
Zeroes - Specifies if a zero appears on the left or right of the decimal in a dimension.
Leading - Places a zero to the left of the decimal point if no numbers appear to the
left.
Trailing - Places zeros to the right of the decimal point. The number of zeros placed
is based on the active setting for Round-Off. For example, if the dimensional value is
.5, and the round-off setting is .1234, the dimensional value appears as .5000.
Dual Unit Display - Selecting/Activating this checkbox displays secondary units for
dimensions in drawings. For example, the primary unit can be inches, while the
secondary unit is millimeters. Both units display when you place the dimension. The
software derives the secondary unit by converting the primary unit.
Related Topics
• Format a Dimension or Annotation, page 184
• Format Dimension Dialog Box, page 193
• Modify Dimension Style Dialog Box, page 180
• New Dimension Style Dialog Box, page 172
Text Tab
Sets the text options for dimensions.
Font Style - Specifies the font style to use for the text in a dimension.
Orientation - Sets the orientation for the text on a dimension. For example, the
dimension text looks like the following picture when you select Vertical.
Position - Sets the position where text appears in relation to the base line. The base
line is an imaginary horizontal line directly under a line of text. For example, when
you select Above, the dimension text looks like the following picture.
Tolerance Text - Sets options for text in certain types of dimensions that have related
tolerances. You can set the dimension type on the dimension ribbon bar.
Size - Sets the size of the text for tolerance text. The value is a ratio of the dimension
text size. For example, if you enter .5, the size of the tolerance text will be half the
size of the dimension text.
Related Topics
• Format a Dimension or Annotation, page 184
• Format Dimension Dialog Box, page 193
• Modify Dimension Style Dialog Box, page 180
• New Dimension Style Dialog Box, page 172
Lines and Coordinate Tab
Dimension Lines - Sets options for dimension lines.
Connect - Controls if the dimension line extends between both terminators when you
place the dimension text and terminators outside the projection lines.
Stack Pitch - Sets the distance between stacked dimensions. The value is a ratio of
the dimension text size.
Break Line - Sets the size of the break line for the dimension line. This value is a
ratio of the text size.
Auto-Jog - Turns the jog control on or off on the Dimension ribbon. You can use this
option only when you place a coordinate dimension. If you set Auto-Jog and the
distance between two dimensions is less than the value set for Stack Pitch, then you
can place the dimension with a jog in the projection line.
Common Origin - Sets the symbol type for the common origin on coordinate
dimensions. You can set the symbol type to dot, circle, or none.
Stack Pitch - Sets the distance between stacked dimensions. The value is a ratio of
the dimension text size.
Display - Controls the display of projection lines on linear dimensions. You can set
the display to none (off), origin, measurement, or origin and measurement. You can
use this option to hide projection lines when they overlap and you are using a pen
plotter.
Element Gap - Sets the distance that the projection line is set back from the element
you want to dimension. This value is a ratio of the dimension text size.
Extension - Sets the distance that the projection line extends beyond the dimension.
This value is a ratio of the dimension text size.
Angle - Sets the slant angle of the projection lines on dimensions. This option is
useful when you need to place a dimension on isometric drawings.
Center Mark - Places a center line automatically when you dimension a nonlinear
element.
Extend Center Mark - Displays projection lines on center marks. Extend Center
Mark only works when the the Center Mark option is selected as well.
Align Groups - Sets the length of all projection lines in a dimension group to equal
the shortest projection line in the group.
Related Topics
• Format a Dimension or Annotation, page 184
• Format Dimension Dialog Box, page 193
• Modify Dimension Style Dialog Box, page 180
• New Dimension Style Dialog Box, page 172
Spacing Tab
Sets dimension spacing options. All options are a ratio of the dimension text value.
Text Clearance Gap - Sets the space between the text and the dimension line.
Dual Display Vertical Gap - Sets the space between the primary and secondary units
when dual unit display is active. You can set Dual Unit Display on the Secondary
Units tab so that dimensions display two units.
Line Spacing - Sets the amount of space between the superfix or subfix and the
dimension text.
Dimension Above Line Gap - Sets the space between the dimension text and the
dimension line.
Horizontal Tolerance Gap - Sets the space between the dimensional value and the
tolerance on dimensions.
Vertical Tolerance Gap - Sets the space between the upper and lower tolerance
value on dimensions.
Vertical Limits Gap - Sets the space between the upper and lower dimensional
values on limit dimensions.
Symbol Gap - Sets the space between the symbol and the dimension line. You can
also set the space between the symbol and the dimension text.
Prefix/Suffix Gap - Sets the amount of space between the prefix or suffix and the
dimension text.
Horizontal Box Gap - Sets the space between the dimension text and the horizontal
edges of the box on dimensions.
Vertical Box Gap - Sets the space between the dimension text and the vertical edges
of the box on dimensions.
Related Topics
• Format a Dimension or Annotation, page 184
• Format Dimension Dialog Box, page 193
• Modify Dimension Style Dialog Box, page 180
• New Dimension Style Dialog Box, page 172
Terminator And Symbol Tab
Sets terminator and symbol options for dimensions.
Type - Sets the terminator type for all terminators. Click the various dimensions in
the following picture to see the different types.
Freespace Type - Sets the terminator type for a dimension with a terminator placed
in free space.
Size - Sets the size of the terminator. The value is a ratio of the dimension text size.
For example, if you set Font Size on the Text tab to be .2 cm and Size to be 2, the
terminator is twice the size of the dimension text.
Origin Type - Sets the terminator type used on the origin of a linear dimension.
Inside Limit - Sets the inside limit for the terminator. The value is a ratio of the
dimension text size. This setting controls when the terminators appear on the outside
of the projection lines according to the options that you set.
Datum Type - Sets the terminator type for datum frames. If you select Normal, the
datum frame uses the active terminator type for dimensions. If you select Anchor, the
datum frame uses an anchor terminator.
Display - Specifies which end of the terminator displays or if both ends display. You
can set the display to none (off), origin, measurement, or both origin and
measurement. The following picture shows the display when you select Origin and
Measurement.
Placement - Sets the placement position for the symbol on diameter and radial
dimensions and linear dimensions for an arc. You can place the symbol before or
after the dimension. You can also hide the symbol.
Related Topics
• Format a Dimension or Annotation, page 184
• Format Dimension Dialog Box, page 193
• Modify Dimension Style Dialog Box, page 180
• New Dimension Style Dialog Box, page 172
Related Topics
• Change the Formats of a Style, page 166
• Create a Style with the Style Command, page 165
• Style Dialog Box, page 168
Modify Text Box Style Dialog Box
Modifies a style by allowing you to specify new characteristics.
Related Topics
• Change the Formats of a Style, page 166
• Character Map Command, page 84
• Create a Style with the Style Command, page 165
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
• Style Dialog Box, page 168
• Text Box Command, page 75
Modify Dimension Style Dialog Box
Modifies a dimension style.
Related Topics
• Change the Formats of a Style, page 166
• Create a Style with the Style Command, page 165
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
Caution
• If you change the size of the element, you must re-apply the line type or
color using Segmented Style. Segmented Style does not recognize
symbols as a bounding element.
Tip
• To access this command, you must place it on a toolbar or menu with
Customize on the Tools menu. On the Toolbars tab of the Customize
dialog box, click Draw.
Related Topics
• Drawing Lines: An Overview, page 10
• Format Part of an Element, page 163
Style - Displays the name of the style that is currently applied to the selected element.
Related Topics
• Apply a Style to a Group of Elements, page 163
• Apply a Style, page 162
• Applying Formats with Styles: An Overview, page 160
Add - Allows you to add a style resource document to the Style Resource Files list
with the Add Style Resource dialog box. This dialog box allows you to select .RSC
or .igr documents and add them to the Style Resource Files list on the Style
Resources dialog box.
Remove - Removes a style resource document from the Style Resource Files list.
You must first select a document in that list.
Related Topics
• Add Styles to the Current Document, page 167
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
• Style Dialog Box, page 168
For example, if you click Text Box, a style appears in the Style box on the ribbon.
The style contains a format for bold fonts. If you turn Bold off on the ribbon, the text
box that you place will not display bold text.
You can also apply unique formats to an existing element, dimension, fill, or
annotation. You can select the element and then edit the formats with the ribbon or
Properties on the Edit menu.
For example, if you select a text box that has a style that displays borders, you can
remove the borders with Properties on the Edit menu. Since you are changing the
element's format, and not its style, the style of the text box still contains borders. If
you apply this style to any other text box, it will still display borders.
Related Topics
• Applying Formats with Styles: An Overview, page 160
• Dimension Command, page 193
• Format a Dimension or Annotation, page 184
• Format a Fill, page 196
• Format a Geometric Element, page 183
• Format a Text Box, page 184
• Line Command (Format Menu), page 192
• Properties Command (Edit Menu), page 185
• Text Box Command (Format Menu), page 192
• If you want to format an existing balloon, you must click to select the
leader line of the balloon. Then, you can change the formats of the
balloon.
Related Topics
• Format Dimension Dialog Box, page 193
• Properties Command (Edit Menu), page 185
Tip
• Before you can select this command from the shortcut menu, you must
locate an element and then right-click.
• You can use Tools > Customize to place the Properties button on a
toolbar.
Related Topics
• Applying Unique Formats: An Overview, page 182
• Format a Dimension or Annotation, page 184
• Format a Fill, page 196
• Format a Geometric Element, page 183
• Format a Text Box, page 184
• Managing Styles, Formats, and Colors: An Overview, page 159
Related Topics
• Format a Geometric Element, page 183
• Properties Command (Edit Menu), page 185
Info Tab
The contents of this tab varies depending on whether you selected or highlighted one
of the following types of elements:
Sheet - Displays the name of the drawing sheet that contains the element. You cannot
edit the name of the drawing sheet.
Start Point - Sets the X and Y values for the start point of the element.
X - Sets a value for the X-coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the Y-coordinate. You can use this option by itself or with the X
option.
End Point - Sets the X and Y values for the end point of an element.
X - Sets a value for the X-coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the Y-coordinate. You can use this option by itself or with the X
option.
Length - Displays the length of a curve. You cannot edit this value.
Sheet - Displays the name of the drawing sheet that contains the element. You cannot
edit the name of the drawing sheet.
Start Point - Sets the X and Y values for the start point of the element.
X - Sets a value for the X-coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the Y-coordinate. You can use this option by itself or with the X
option.
Center Point - Sets the X and Y values for the center point of the arc.
X - Sets a value for the X-coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the Y-coordinate. You can use this option by itself or with the X
option.
End Point - Sets the X and Y values for the end point of an element.
X - Sets a value for the X-coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the Y-coordinate. You can use this option by itself or with the X
option.
Start Angle - Displays the angle formed by the x axis and the first point of the sweep
angle. Zero degrees is horizontal to the x-axis.
Sheet - Displays the name of the drawing sheet that contains the element. You cannot
edit the name of the drawing sheet.
Center Point - Sets the X and Y values for the center point of the circle.
X - Sets a value for the X-coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the Y- coordinate. You can use this option by itself or with the X
option.
Area - Displays the area of a closed element. Although you cannot edit the area, the
box automatically updates when you edit the geometry.
Sheet - Displays the name of the drawing sheet that contains the element. You cannot
edit the name of the drawing sheet.
Curve Type - Displays the type of curve (open or closed). You cannot edit this field.
Order - Displays the order of the curve. Higher order curves are more accurate or
precise than lower order curves. All curves drawn with the curve command will be
4th order curves.
Nodes - Lists the nodes on a selected curve. When you select a node from the list, its
x and y values are displayed so you can edit them. The node type is also displayed.
X - Sets a value for the X-coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the Y-coordinate. You can use this option by itself or with the X
option.
Length - Displays the length of a curve. You cannot edit this value.
Area - Displays the area of a closed curve. Although you cannot edit the area, the box
automatically updates when you edit the geometry.
Sheet - Displays the name of the drawing sheet that contains the element. You cannot
edit the name of the drawing sheet.
Center Point - Sets the X and Y values for the center point of a closed element.
X - Sets a value for the X-coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the Y-coordinate. You can use this option by itself or with the X
option.
Primary Axis - Sets the length of the primary axis. The ellipse orientation is based on
the primary axis.
Secondary Axis - Sets the length of the secondary axis. The secondary axis is
perpendicular to the primary axis.
Rotation Angle - Sets the angle of the primary axis of the ellipse. Zero degrees is
horizontal to the X-axis. The angle increases in the counterclockwise direction.
Area - Displays the area of a closed element. Although you cannot edit the area, the
box automatically updates when you edit the geometry.
Sheet - Displays the name of the drawing sheet that contains the element. You cannot
edit the name of the drawing sheet.
X - Sets a value for the X-coordinate. You can use this option by itself or with the Y
option.
Y - Sets a value for the Y-coordinate. You can use this option by itself or with the X
option.
Sheet - Displays the name of the drawing sheet that contains the element. You cannot
edit the name of the drawing sheet.
Radius - Specifies the radius between the two elements you want to use to create the
fillet.
Sheet - Displays the name of the drawing sheet that contains the element. You cannot
edit the name of the drawing sheet.
Angle - Measures the angle between the chamfer and the first linear element.
Setback A - Specifies the distance from the corner to the beginning of the chamfer on
the first linear element you selected.
Setback B - Specifies the distance from the corner to the beginning of the chamfer on
the second linear element you selected.
Sheet - Displays the name of the drawing sheet that contains the element. You cannot
edit the name of the drawing sheet.
Centroid - Defines the exact center of the rectangle with X and Y coordinates.
Angle - Sets the orientation angle of the element. Zero degrees is horizontal to the X-
axis. The angle increases in the counterclockwise direction.
Area - Displays the area of a closed element. Although you cannot edit the area, the
box automatically updates when you edit the geometry.
Related Topics
• Element Properties Dialog Box, page 185
• Format a Geometric Element, page 183
Format Tab
Style - Sets the drawing style.
Related Topics
• Element Properties Dialog Box, page 185
• Format a Geometric Element, page 183
User Tab
Attribute Set - Names a group of attributes. You can type a name in the box and
press Tab.
Save - Places the attribute set on the element that you selected.
Remove - Removes the attribute set from the element that you selected.
Attributes - Sets the name, type, and value of the attribute set. You can type a name
in the box and press Tab.
Type - Sets the type for the attribute, such as double, text, number, money, or date.
Value - Sets the value for the attribute. The value that you can enter is based on the
type that you selected in the Type box.
Add - Adds an attribute to the attribute set. After you click Add, the attribute appears
in the table.
Delete - Removes an attribute from the attribute set. You can select an attribute by
clicking a row in the table.
Related Topics
• Format a Dimension or Annotation, page 184
• Format a Fill, page 196
• Format a Geometric Element, page 183
• Format a Text Box, page 184
• Managing Styles, Formats, and Colors: An Overview, page 159
• Properties Command (Edit Menu), page 185
Related Topics
• Applying Formats with Styles: An Overview, page 160
• Format a Geometric Element, page 183
• Line/Arc Continuous Command, page 12
Related Topics
• Format a Geometric Element, page 183
• Line Command (Format Menu), page 192
Related Topics
• Apply a Border to a Text Box, page 73
• Applying Formats with Styles: An Overview, page 160
• Character Map Command, page 84
• Edit a Text Box, page 74
• Format a Text Box, page 184
• Insert a Font Character into a Text Box, page 74
• Place a Text Box, page 69
• Resize a Text Box, page 74
Related Topics
• Character Map Command, page 84
• Format a Text Box, page 184
• Text Box Command, page 75
Dimension Command
Formats a new dimension as you place it.
Related Topics
• Format a Dimension or Annotation, page 184
Related Topics
• Dimension Command, page 193
• Format a Dimension or Annotation, page 184
The software provides styles for fills for various engineering standards, such as
ANSI, ISO, and AIA.
Modifying Fills
A fill is associative, which means it maintains its original orientation to an element
regardless of the way you manipulate the element. For example, if you move the
boundary, the fill moves with it. If you change the boundary, the fill changes to
conform to the new boundary area.
A fill can exist only inside a closed boundary. If you drag a fill to another region, the
fill assumes the shape of the region where you dragged it. If you open a closed
boundary, the fill changes color to indicate that it is disabled. If you close the
boundary again, the fill changes color to show that it is now active.
Formatting Fills
Formatting a fill is similar to applying formats to an element. You can apply unique
formats to fills using Properties on the Edit menu or by setting options on the
ribbon. To make several fills look the same, you can apply a fill style by selecting the
style on the ribbon.
Tip
• The blank color on the Fill ribbon takes on the background color of the
document. This is useful for creating symbols that can cover an element
on which the symbol is placed. Incorporating a fill with blank color into
the symbol allows the symbol, when placed, to mask out elements such as
lines or connectors that intersect the symbol.
You cannot modify an existing fill style, but you can create a new fill style by typing
a new name in the Style box on the Fill ribbon. The new style uses the settings on the
ribbon as the formats for the style.
Tip
• If you want to copy a fill style from one document to another, just create a
fill, apply a style, and then copy the fill to a new document. The fill style
appears in a dropdown list on the Fill ribbon in the new document.
Related Topics
• Fill Command, page 197
• Format a Fill, page 196
• Managing Styles, Formats, and Colors: An Overview, page 159
• Place a Fill, page 195
Place a Fill
You can place a fill only inside a closed boundary.
Notes
• When you change a filled boundary by drawing another element, the fill
does not automatically update to fit the new boundary. You can refill the
new boundary by selecting the fill handle, then clicking Redo Fill on the
ribbon to apply the fill to the new boundary. You can also refill an area by
dragging the handle to the new area.
• To fill a boundary quickly, you can zoom in on it first using Zoom Area
on the View menu.
• You cannot modify an existing fill style, but you can create a new fill style
by typing a new name in the Style box on the Fill ribbon. The new style
uses the settings on the ribbon as the formats for the style.
Related Topics
• Applying Colors and Patterns to Closed Boundaries: An Overview, page
193
• Fill Command, page 197
• Refill a Modified Boundary, page 197
Format a Fill
1. Select a fill.
2. On the Fill ribbon, click the settings that you want to update the fill.
Notes
• You can format a fill before you place it by setting options on the ribbon
or using Properties on the Edit menu.
• You can apply several formats at once by clicking a new fill style in the
Style list box on the ribbon.
• You cannot modify an existing fill style, but you can create a new fill style
by typing a new name in the Style list box on the Fill ribbon. The new
style uses the settings on the ribbon as the formats for the style.
• If you want to copy a fill style from document to another, just create a fill,
apply a style, and then copy the fill to a new document. The fill style
appears in a dropdown list on the Fill ribbon in the new document.
• The blank color on the Fill ribbon takes on the background color of the
document. This is useful for creating symbols that can cover an element
on which the symbol is placed. Incorporating a fill with blank color into
the symbol allows the symbol, when placed, to mask out elements such as
lines or connectors that intersect the symbol.
Related Topics
• Fill Command, page 197
• Managing Styles, Formats, and Colors: An Overview, page 159
• Properties Command (Edit Menu), page 185
• Segmented Style Command, page 180
• Style Command (Format Menu), page 168
4. On the Colors dialog box, click Define Custom Colors and set the options you
want to create a new color.
5. Click Add to Custom Colors.
6. On the Custom Color Name dialog box, type the name that you want for the
color you created. This name appears on the palettes for Solid Color or Pattern
Color on the Fill ribbon.
Related Topics
• Custom Color Name Dialog Box, page 199
• Fill Command, page 197
• Fill Ribbon, page 198
Fill Command
Places a fill inside a closed boundary. You can modify fill properties with the Fill
ribbon.
Related Topics
• Applying Colors and Patterns to Closed Boundaries: An Overview, page
193
• Fill Command, page 197
• Format a Fill, page 196
• Place a Fill, page 195
Related Topics
• Format a Fill, page 196
• Properties Command (Edit Menu), page 185
Fill Ribbon
Displays the active settings for a fill.
Style - Lists and applies the available styles. To define a new fill style, you can type a
name in the box. The new style uses the current settings on the ribbon.
Pattern Color - Applies a pattern line color for pattern fills. If you select none,
the background will be transparent. Filled elements cover other elements when they
overlap. You can click More to define custom colors with the Colors dialog box.
Solid Color - Applies a system color to set the background color for the fill. If
you select none, the background will be transparent. Filled elements cover other
elements when they overlap. You can click More to define custom colors with the
Colors dialog box.
Tip
• The blank fill color takes on the background color of the document. This is
useful for creating symbols that can cover an element on which the symbol
is placed. Incorporating a fill with blank color into the symbol allows the
symbol, when placed, to mask out elements such as lines or connectors
that intersect the symbol.
Redo Fill - Re-applies a fill to a filled area when the boundary changes. A fill
can become disabled, and change color, if you modify its boundary by drawing
another element or moving part of the existing boundary. If you click Redo Fill, the
area surrounding the fill handle is filled again.
Angle - Sets the angle of the fill in the active unit. Zero degrees is horizontal to the x
axis, and the angle (A) increases in a counterclockwise direction with zero on the
positive side (B) of the x axis. If you type a negative value, the software displays the
equivalent positive value.
Color Name - Specifies the name of the color that you created on the Colors dialog
box. After you save the custom color with a name, the name appears on the color
palette.
Related Topics
• Create a Fill Color, page 196
• Fill Ribbon, page 198
Your company standard may require that a hidden line look like a dotted line.
To change the Normal line style to conform to your company's standards, you can
follow these steps:
1. Click Format > Style.
2. On the Style dialog box, click the line style type in the Style Type box.
3. In the Styles list box, click the Normal line style.
4. Click Modify to access the Modify Line Style dialog box.
5. On the General tab, in the Type box, select the line type that looks like a dotted
line.
All the lines that you draw while the Normal style is selected on the ribbon will
conform to your company's standards: hidden lines will appear as dotted lines. You
can save the style to a template with Style on the Format menu. This allows you to
use the style again in other drawings.
Your company standard indicates that hidden lines should be a line type that is
dashed. You have been using a line style, called Dashed, to conform to the standards
used by your company.
To change the hidden lines in the drawing quickly and efficiently, you can follow
these steps:
1. Open the drawing that you received from the other company.
2. Select all the lines that you want to change.
3. On the ribbon, select Dashed in the Style box to change all the lines that you have
selected. All the lines now appear as dashed lines instead of continuous lines.
Linear patterns and styles are defined by a series of strokes, called a stroke sequence.
Each stroke appears either as a dash or a gap; however, point styles may be added to
the stroke when necessary. The strokes, when used together in a stroke sequence, are
placed in locations indicated by a stroke index, a number indicating the order in
which the individual strokes appear in the sequence.
The Line Style Editor appears as a frame in the SmartSketch window. The Line Style
Editor toolbar appears at the top of frame. A tree window displays line styles defined
for the active document or within any applicable resource files, and a preview
window at the bottom of the frame provides a graphic representation of selected
styles.
Using the Line Style Editor, you can create the following custom tools, which are
saved within the active symbol (.sym) file.
Linear Patterns - Adds point styles, if applicable, to a series of dashes and gaps
(strokes). When defining a linear pattern, you set the order in which dashes, gaps, and
point styles appear, as well as the position of the point styles relative to the stroke.
Linear Styles - Provides point styles and linear patterns in a format that can be used
in drawings. When you define a linear style, you provide width and color to linear
patterns so they can be applied to linear geometry.
Notes
• You can use the Tools menu to toggle on/off the Line Style Editor.
• If you are using a workshare environment, point styles, linear patterns, and
linear styles should not be created at a satellite site.
Related Topics
• Line Style Editor Toolbar, page 215
2. Click Select on the Draw toolbar, and then select the image on the Drawing
sheet.
3. On the tree in the Line Style Editor, select the point style you want to redefine
with the new image.
4. On the Line Style Editor toolbar, click Define Point Style Graphics .
5. Click on the image to place the origin of the point style.
Notes
• You can use the Tools menu to toggle on/off the Line Style Editor.
Related Topics
• Create New Point Style Dialog Box, page 216
• Point Style Properties Dialog Box, page 219
2. Click Select on the Draw toolbar, and then select the image on the Drawing
sheet.
3. On the tree in the Line Style Editor, select the point style you want to redefine
with the new image.
4. On the Line Style Editor toolbar, click Define Point Style Graphics .
5. Click on the image to place the origin of the point style.
Notes
• You can use the Tools menu to toggle on/off the Line Style Editor.
Related Topics
• Create New Point Style Dialog Box, page 216
• Point Style Properties Dialog Box, page 219
First, place dumb text (B) in the drawing sheet. This text will become part of the new
point style.
1. Click Text Box on the Draw toolbar and place a B on the drawing sheet.
2. Right click the text box, and click Properties to open the Text Box Properties
dialog box.
3. On the Info tab, change the Justification for the Horizontal and Vertical options
to Shape Center.
In your new line style, each occurrence of the letter " B" will be centered
horizontally and vertically in the line.
2. Type BuriedPipe in the Style name box to define a name for the new point style,
and then click OK.
3. In the Point Style Properties dialog box, type Buried Pipe Point Style in the
Notes box, and click OK. The entry for BuriedPipe appears in the Point Styles
list.
4. On the drawing sheet, select the letter "B", and then click Define Point Style
Graphics .
5. Move the cursor back to the drawing sheet and click on the "B" to place the origin
of the point style.
Add a Style to Linear Patterns
1. Click Linear Patterns in the Line Style Editor, and then click Create New Style
to open the Create New Linear Pattern dialog box.
Tip
• You can also right-click on Linear Patterns and select Add Style
from the popup menu to open the Create New Linear Pattern dialog
box.
2. Type BuriedPipe in the Style name box to define a name for the new linear
pattern, and then click OK.
3. On the Linear Pattern Properties dialog box, type Buried Pipe in the Notes
box.
4. In the Stroke sequence definitions section, select 1 in the Stroke index list.
Tip
• As you define properties for the new linear pattern, the Preview pane
displays an image of the new style.
11. Click OK. The entry for BuriedPipe appears in the Linear Patterns list.
3. In the Linear Style Properties dialog box, type Buried Pipe Linear Style
Property the Note box.
4. In the Color list, select Red.
6. Click OK.
7. The entry for BuriedPipe appears under Linear Styles.
Related Topics
• Line Style Editor Toolbar, page 215
Related Topics
• Using the Line Style Editor: An Overview, page 201
Tip
• You can use the Tools menu to toggle on/off the Line Style Editor.
Create New Style - Creates a new point style, linear pattern, or linear style.
Depending on what you have selected in the tree window of the Line Style Editor,
clicking this button will open either the Create New Linear Style, Create New
Point Style, or Create New Linear Pattern dialog box, from which you can define a
new style.
Copy Style - Creates a copy of the style selected in the tree window of the Line
Style Editor.
Import Style - Imports a selected style into the active document. This command is
available only when you have selected a style object in a resource file.
Delete Style - Removes the selected style from the active document only if the
style is not in use or referenced by another style as a base style or as a component of
another style.
Properties - Opens the Properties dialog box for the selected style.
Place Point Style Graphics - Places the selected point style graphic into the
active drawing so that it can be modified using the standard drawing tools. This
command is available only if you have selected a point style in the tree.
Define Point Style Graphics - Defines the graphic for a point style from ordinary
graphics in the active drawing. This command is available only when you have
selected a point style in the tree and one or more objects are selected in the drawing.
Show Styles in Resource Files - Displays or hides styles from attached styles
resource files in the tree window. Resource files are attached to a file using the host
application.
Notes
• Styles that appear bolded in the tree are styles currently saved in the active
document, while non-bolded styles are located in resource files.
Related Topics
• Copy Point Styles, Linear Patterns, and Linear Styles, page 204
• Delete Point Styles, Linear Patterns, and Linear Styles, page 206
• Import Point Styles, Linear Patterns, and Linear Styles, page 204
• Modify Point Styles, Linear Patterns, and Linear Styles, page 205
Related Topics
• Create New Linear Pattern Dialog Box, page 217
• Create New Linear Style Dialog Box, page 217
• Create New Point Style Dialog Box, page 216
Related Topics
• Create Custom Point Styles, page 202
• Point Style Properties Dialog Box, page 219
Based on - Select an existing linear pattern on which to base the new pattern.
Related Topics
• Create Custom Linear Patterns, page 203
• Linear Pattern Properties Dialog Box, page 219
Based on - Select an existing linear style on which to base the new style.
Related Topics
• Create Custom Linear Styles, page 203
• Linear Style Properties Dialog Box, page 222
Related Topics
• Copy Linear Pattern Dialog Box, page 218
• Copy Linear Style Dialog Box, page 218
• Copy Point Style Dialog Box, page 217
Related Topics
• Copy Point Styles, Linear Patterns, and Linear Styles, page 204
Related Topics
• Copy Point Styles, Linear Patterns, and Linear Styles, page 204
Related Topics
• Copy Point Styles, Linear Patterns, and Linear Styles, page 204
Related Topics
• Import Point Styles, Linear Patterns, and Linear Styles, page 204
Related Topics
• Delete Point Styles, Linear Patterns, and Linear Styles, page 206
Properties Command
Opens the Properties dialog box for the selected style.
Related Topics
• Linear Pattern Properties Dialog Box, page 219
• Linear Style Properties Dialog Box, page 222
• Point Style Properties Dialog Box, page 219
Notes - Enter a brief description or other useful information about the point style.
Units - Specifies the geometric definition for the point style. World units define the
width of the point style in geometric space; Paper units define the width of the point
style on paper. Changing the drawing scale has no effect on styles defined in Paper
units; however, it does change styles defined in World units.
Important
• When using the Line Style Editor to create new styles, if a linear style uses
a linear pattern and/point style it is recommended that they all have the
same units.
Preview - Displays the point style image.
Related Topics
• Modify Point Styles, Linear Patterns, and Linear Styles, page 205
Notes - Enter a brief description or other useful information about the linear pattern.
Based on - Displays the name of the pattern on which this linear pattern was based.
Units - Specifies the geometric definition for the linear pattern. World units define
the width of the line in geometric space; Paper units define the width of the line on
paper. Changing the drawing scale has no effect on styles defined in Paper units;
however, it does change styles defined in World units.
Important
• When using the Line Style Editor to create new styles, if a linear style uses
a linear pattern and/point style it is recommended that they all have the
same units.
Phasing - Select how dashes will be displayed.
Fraction of first dash(%) - Set the value, a numeric between 0 and 100, that
represents the fraction of the first dash to be used as the last dash of a line when the
phasing is set to Autophasing or Single Stroke sequence.
Break on change in direction - Indicates that a break in the linear pattern occurs
whenever the line changes direction.
Stroke index - Indicates the location within a stroke sequence where each stroke is
displayed. Each stroke within a sequence appears as a gap or a dash. Information
about the stroke located in a selected index location appears in the remaining fields in
this section of the dialog box.
Fixed length - Indicates that the length of the stroke is definite and cannot be
lengthened or shortened for phasing.
Stretchable - Indicates that the active stroke may be altered for phasing.
Tip
• Selecting the Dot option disables the Dash length field, as the length is set
by the selection.
Zero length - Indicates that the active stroke has no length. A stoke with no length is
often used as a place holder for a point style or as the last stroke if no gap is wanted
between cycles.
Tip
• Selecting the Zero Length option disables the Dash length field, as the
length is set by the selection.
Name - Select a point style from this list box to apply to the active stroke.
Angle - Set the angle which the point style should be rotated when it is displayed.
This value is measured from the selected Orientation. This field is available only
when you have selected an option from the Name list box.
Tips
• The angle appears in the default units set in the host application; however,
the field accepts any unit of measure applicable to an angle.
• A positive value in this field rotates the point style in a counter-clockwise
directions about its origin, while a negative value results in clockwise
rotation.
X offset - Distance along the stroke, at which the point style's origin is located. This
distance is measured from the point specified in the Position along stroke field. This
field is available only when you have selected an option from the Name list box.
Y offset - Distance perpendicular to the stroke at which the point style's origin is
located. This distance is measured from the point specified in the Position along
stroke field. This field is available only when you have selected an option from the
Name list box.
Add stroke - Creates a new stroke. A new number will be added to the Stroke index
list box, and the new stroke is made active in the dialog box.
Remove stroke - Removes the active stroke from the linear pattern. This button is
available only when more than two strokes exist.
Notes
• You can use the Tools menu to toggle on/off the Line Style Editor.
• To create a solid line with superimposed point style images, create dashes
and apply the point styles relative to those dashes. Then create gaps with
zero length.
• When you turn off the Display dashes command on this dialog, point
styles applied to the linear pattern are still displayed positioned relative to
the invisible dashes.
Related Topics
• Modify Point Styles, Linear Patterns, and Linear Styles, page 205
Notes - Enter a brief description or other useful information about the linear style.
Based on - Displays the style on which this linear style was based.
Units - Specifies the geometric definition for the linear pattern. World units define
the width of the line in geometric space; Paper units define the width of the line on
paper. Changing the drawing scale has no effect on styles defined in Paper units;
however, it does change styles defined in World units.
Important
• When using the Line Style Editor to create new styles, if a linear style uses
a linear pattern and/point style it is recommended that they all have the
same units.
Component index - This list contains a number for each of the components within
the linear style. Information about the component selected in this field is displayed in
the remaining fields in this section of the dialog box.
Override point style color - Indicates that the color specified for this component will
override the color defined for any point style used as the component.
Override point style width - Indicates that the width specified for this component
will override the width defined for any point style used as the component.
Tip
• If the component you are defining is a point style, and the color you select
is not the color with which the point style was defined, you should select
the Override point style color check box.
Transparency (%) - Indicate how transparent the drawn line will be. Zero (percent)
indicates that you will not be able to see through the line at all, while 100 (percent)
indicates the line will not be visible, as it will be completely transparent.
Tip
• If the component you are defining is a point style, and the width you select
is not the width with which the point style was defined, you should select
the Override point style width check box.
Linear pattern - Select a defined linear pattern to use as the active component in the
linear style.
Offset - Specify the distance the active component should be placed from the
centerline of the linear style. The offset distance appears in the default length units set
in the host application; however, the field accepts any distances in any unit of
measure applicable to a distance.
Start terminator - Select the point style with which you would like to start the line.
End terminator - Select the point style with which you would like to end the line.
End cap type - Indicate the type of cap you want to place at the end of the line. You
can choose from a rounded, flat, squared, or triangular end. For examples of each type
of end cap, see the following graphic.
Join type - Select the kind of join you want to use for line strings and complex
strings created through automation. You can choose from rounded, beveled, and
mitered joints. For examples of each type of joint, see the graphic below.
Tip
• The selected type of joint is not applied to regular lines joined at the end
point.
Add component - Creates a new component. A new number will be added to the
Component index list box, and the new component is made active in the dialog box.
Remove component - Removes the active component from the linear style. This
button is available only when more than one component exists.
Related Topics
• Modify Point Styles, Linear Patterns, and Linear Styles, page 205
Related Topics
• Place Point Styles in the Drawing Sheet, page 205
Related Topics
• Redefine Point Styles, page 202
Note
• Styles that appear bolded in the tree are styles currently saved in the active
document, while non-bolded styles are located in resource files.
Related Topics
• Using the Line Style Editor: An Overview, page 201
Index
actions show, 77
redoing, 48 type, 77
undoing, 48 Break mode, 133
adding bringing
linear patterns, 203, 217 elements to the front, 156, 157
linear styles, 217 buried pipe line style, 207
point styles, 202, 206, 216 callouts,placing, 69
align groups, 176 center mark, 176
alignments chamfers
showing, 100 angle, 136
annotations drawing, 129, 136
adding to drawings, 66 line color, 136
formatting, 159, 160, 182, 184 line type, 136
manipulating, 70 line width, 136
moving, 70 properties, 185
applying change toolbar,displaying, 146
borders, 73 changing
styles, 162, 168 associative elements, 51, 54, 114, 120, 122, 138
arcs display order, 156, 157, 158
drawing, 12, 19, 26, 27, 104 display priority, 155
drawing by three points, 18 drawings, 51, 54, 59, 114, 116, 120, 122, 138
drawing connected to lines, 20 elements, 52, 53, 54, 63, 116, 120, 122, 124, 125
drawing tangent to elements, 20 formats of a style, 166
drawing with FreeSketch, 22, 38 relationships, 138
arcs,drawing, 185 character maps, 74, 84
arrays,drawing, 59, 60, 61, 62 characters,inserting, 74, 84
associative elements circles
applying relationships, 138 drawing, 15, 16, 17, 18, 60, 61
changing shapes, 114 drawing overview, 14
extending, 126 drawing tangent to an element, 16
mirroring, 120 properties, 185
moving, 51 circular
rotating, 116 drawing in a pattern, 59
scaling, 122 Clipboard
trimming, 126 copying to, 55
autogapping pasting from, 56
activate, 8 closed boundaries,formatting, 193
auto-jog, 176 closing
auxiliary graphics Auxiliary Graphics, 8
customizing toolbars, 6 colinear
overview, 6 elements or key points, 145, 146
Auxiliary Graphics relationships, 145, 146
exiting, 8 colors
using, 8 borders, 77
back,moving elements to, 158 creating for fills, 196
balloons saving, 199
adding to drawings, 66 commands
bevels,drawing, 129, 136 Alignment Indicator, 100
borders, 77 Arc by 3 Points, 26
color, 77 Arc by Center Point, 26
fill color, 77 Bring to Front, 157
line style, 77 Chamfer, 136
shadow, 77 Change, 146