Documente Academic
Documente Profesional
Documente Cultură
User’s Guide
June 2004 Version 4.1
DPID2-PE-200004E
Copyright
Copyright © 1999-2004 Intergraph Corporation. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license
agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by
copyright law, trade secret law, and international treaty, and may not be provided or otherwise made available
without proper authorization.
Trademarks
Intergraph, the Intergraph logo, SmartSketch, FrameWorks, SmartPlant, INtools, PDS, and MARIAN are registered
trademarks 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........................................................9
Glossary ..........................................................................................................................414
Index................................................................................................................................436
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 has several programs and utilities for running and managing your plant
data.
Drawing Manager allows you to create and delete P&IDs and drawing
versions and print multiple drawings. Drawing Manager allows you to
perform Workshare- and project-specific commands.
Insulation Specification Manager allows you to create and modify lookup
tables for insulation specifications and thicknesses.
Options Manager defines plant-wide graphic standards for symbology,
gapping, heat tracing, and formats. Options Manager also defines paths to
SmartPlant files and directories.
Rule Manager defines rules for placement and property copying on
placement.
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 264
You create your drawing In the Drawing view, using vertical and horizontal scroll
bars as well as Zoom and Pan commands to change the center point for the Drawing
view. The title bar identifies the drawing name. Filter tabs provide a quick and easy
way to choose what appears in the Drawing view. You can add new tabs for
additional filters as needed. A tab scroll provides a way to view tabs hidden from
display by the horizontal scroll bar.
You can define one or more Engineering Data Editors for a drawing, too. 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, too.
By using commands on the Window menu, you can cascade or tile views to more
easily navigate among them.
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
Overview
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
• Define a New Engineering Data Editor View, page 51
• Define a New Filter for an Engineering Data Editor View, page 52
• Define a New Layout for the Engineering Data Editor, page 53
• Open a New Drawing View, page 35
• Open an Existing Drawing, page 108
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 33
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 21
• Customizing the Software: An Overview, page 91
• Linking and Embedding Objects: An Overview, page 273
Related Topics
• Customize the Software With the Options Command, page 21
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 283
• Change a Link, page 282
• Customize the Software With the Options Command, page 21
• Embed a New Object, page 277
• Link or Embed a Previously Existing Object, page 278
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 21
• Options Command, page 17
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 204
• Customize the Software With the Options Command, page 21
• Options Command, page 17
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 204
• Move a Connector to Another Stockpile, page 204
• Move a Partner Connector to Another Stockpile, page 206
• Place an OPC or Utility Connector, page 202
• Store a Partner Connector, page 204
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.
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 21
• Options Command, page 17
Related Topics
• Customizing the Software: An Overview, page 91
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 present before you zoomed in. 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 22
• Working With the Design Window: An Overview, page 15
Notes
• To stop the repainting of 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: An Overview, page 15
Related Topics
• Save the Settings for the Active View, page 37
• Working With the Design Window: An Overview, page 15
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: An Overview, page 15
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 that you want to zoom in
on. The selection then fills the view.
Notes
• To go back to the previous view, click View > Previous.
• To stop the repainting of items in the window, press Esc. This action is
convenient for large drawings.
• To refresh the window, press F5.
• To quit the command, right-click or press Esc.
Related Topics
• Working With the Design Window: An Overview, page 15
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: An Overview, page 15
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: An Overview, page 15
• Zoom Out from an Area, page 24
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 25
• Working With the Design Window: An Overview, page 15
Related Topics
• Working With the Design Window: An Overview, page 15
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 25
• Working With the Design Window: An Overview, page 15
• You can click and drag the hand pointer to pan the view, too.
• To go back to the previous view, click View > Previous.
• To stop the repainting of items in the window, press Esc. This action is
convenient for large drawings.
• To refresh the window, press F5.
• To quit the command, press Esc or right-click in the Drawing view.
Related Topics
• Working With the Design Window: An Overview, page 15
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 41
• 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 28
• Customizing the Software: An Overview, page 91
• Remove a Button From a Toolbar, page 28
• Working With the Design Window: An Overview, page 15
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.
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 28
• Remove a Button From a Toolbar, page 28
• 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 28
• Remove a Button From a Toolbar, page 28
• Remove a Command From a Menu, page 95
Related Topics
• Customizing the Software: An Overview, page 91
Related Topics
• Customizing the Software: An Overview, page 91
Related Topics
• Customizing the Software: An Overview, page 91
Properties Command
View > Properties
Displays the View Properties dialog box, which lets you define and control settings
for the active view. The set of property tabs that are available in the View Properties
dialog box depends on the active view. These tabs logically organize the properties
into sets that you can use for manipulating special view qualities.
Related Topics
• Restore a Drawing View, page 22
• Save the Settings for the Active View, page 37
• Show Inconsistencies, page 314
• Working With the Design Window: An Overview, page 15
Filter - Contains information about the filter that you want to use for your Drawing
view.
Filter Name - Displays the name of the filter that you want to use for your Drawing
view. This information is read-only. You specify the name of the filter when you
choose or create it.
Browse - Opens the Select Filter dialog box, which allows you to choose or create a
filter for your Drawing view.
Properties - Opens the Filter Properties dialog box. You can modify the properties
of the filter that you choose from the Select Filter dialog box. You can name the new
filter appropriately.
Alternate symbology - Contains information about how the software displays the
filtered items in your Drawing view. In order for the alternate symbology to take
effect in your drawing, you must right-click the drawing filter tab and select Use
Alternate Symbology.
Color - Allows you to specify the color of the filtered items. Scroll down the list to
choose a color.
Width - Allows you to specify the line width for your filtered items. Scroll down the
list to choose a line width.
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
Note
• If the active view is the Engineering Data Editor, then View >
Properties opens the Table Properties dialog box.
Related Topics
• Properties Command, page 28
Related Topics
• Properties Command, page 28
• View Properties Dialog Box, page 29
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.
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.
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
• Change the Properties of a Drawing View, page 33
• Properties Command, page 28
• View Properties Dialog Box, page 29
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 28
• Show Grid Command, page 150
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 28
• Show Inconsistencies, page 314
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 292
• Display the Claim Status of a Drawing Item, page 302
• Release a Claim, page 301
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 289
• Customizing the Software: An Overview, page 91
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 35
• New Drawing Window Command, page 34
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 35
• Working With the Design Window: An Overview, page 15
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 34
Cascade Command
Window > Cascade
Related Topics
• Switch to Another Open Drawing or View, page 111
• Working With the Design Window: An Overview, page 15
• Zoom In on an Area, page 23
• Zoom In on the Drawing, page 23
• Zoom Out from an Area, page 24
Arranges windows to fit horizontally in the Design window. All the windows appear
at an even distance from each other on the screen.
Related Topics
• Switch to Another Open Drawing or View, page 111
• Working With the Design Window: An Overview, page 15
Arranges windows to fit vertically in the Design window. All the windows appear at
an even distance from each other on the screen.
Related Topics
• Switch to Another Open Drawing or View, page 111
• Working With the Design Window: An Overview, page 15
Related Topics
• Switch to Another Open Drawing or View, page 111
• Working With the Design Window: An Overview, page 15
Notes
• This command saves all display filters for the active Drawing view.
• Your settings are automatically saved upon quitting the software.
Related Topics
• Working With the Design Window: An Overview, page 15
• 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.
Related Topics
• Display the Engineering Data Editor, page 41
• Navigating in the Engineer Data Editor: An Overview, page 38
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 59
• Define a New Engineering Data Editor View, page 51
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 54
• Navigating in the Engineer Data Editor: An Overview, page 38
• Update the Engineering Data Editor, page 58
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 38
• Working With the Design Window: An Overview, page 15
Contains commands for moving and deleting items. Click the down-arrow next to the
Stockpile menu to display the available commands.
Related Topics
• Move a Stockpile Item to the Stockpile of Another Drawing, page 265
• Place Multiple Representations, page 154
• Remove an Item from a Drawing, page 250
• Remove an Item from the Model, page 251
Related Topics
• Navigating in the Engineer Data Editor: An Overview, page 38
• Place Multiple Representations, page 154
• Placing Equipment: An Overview, page 152
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 245
• Remove an Item from the Model, page 251
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 265
• Navigating in the Engineer Data Editor: An Overview, page 38
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 289
• Copy Command, page 43
• Paste Command, page 43
• Review and Edit Item Properties, page 87
• Select All Command, page 44
• Select an Item, page 147
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 258
• Review and Edit Item Properties, page 87
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 258
• Review and Edit Item Properties, page 87
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 258
• Review and Edit Item Properties, page 87
• Select an Item, page 147
• Selecting Drawing Items: An Overview, page 144
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 292
• Claiming Items: An Overview, page 289
Allows you to relinquish control by your project of the selected items. A confirmation
message is displayed so that you can confirm the release-claim action. Claims must
be released before projects can be completed or for other projects to be able to check
in drawings with changes.
Related Topics
• Claiming Items: An Overview, page 289
• Release a Claim, page 301
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 289
• Display the Claim Status of a Drawing Item, page 302
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 64
• Delete a Saved Engineering Data Editor View, page 57
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 54
• Save an Engineering Data Editor View, page 56
• Update the Engineering Data Editor, page 58
• 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 51
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 54
• Navigating in the Engineer Data Editor: An Overview, page 38
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 50.
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 52
• Define a New Layout for the Engineering Data Editor, page 53
• Edit View Command, page 46
Related Topics
• Define a New Filter for an Engineering Data Editor View, page 52
• Define a New Layout for the Engineering Data Editor, page 53
• Edit View Command, page 46
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 51
• Define a New Filter for an Engineering Data Editor View, page 52
• Modify the Table Properties of an Existing 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.
Delete (Definition) - Removes the currently selected 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 47
• Define a New Layout for the Engineering Data Editor, page 53
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 54
• New > Engineering Data Editor Command (Window Menu), page 35
SmartPlant Electrical
• Default Battery Bank List
• Default Bus List
• Default Cable List
• Default Circuit List
• Default Circuit Breaker List
• Default Control Stations List
• Default Document List
• Default Generator List
• Default Load List
• Motor List
• Default PDB List
• Default Reference Cable List
SmartPlant P&ID
• Area Break
• Drawing
• Equipment
• Equipment Component
• Exchanger
• Mechanical
• Equipment Other
• Vessel
• Instrument
• Instrument Loop
• Item Note
• Nozzle
• OPC
• Package
• Pipe Run
• Piping Component
• Plant Item
• Plant Item Group Other
• Representation
• Safety Class
• Signal Run
• System
Related Topics
• Define a New Layout for the Engineering Data Editor, page 53
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 91
• Navigating in the Engineer Data Editor: An Overview, page 38
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 38
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 54
• Navigating in the Engineer Data Editor: An Overview, page 38
• Save an Engineering Data Editor View, page 56
Name - Provides space for you to type in the name of your custom view.
Related Topics
• Save an Engineering Data Editor View, page 56
• Save View Command, page 55
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 57
• Navigating in the Engineer Data Editor: An Overview, page 38
Name - Lists the saved views. Choose one and click OK to delete that view.
Related Topics
• Delete a Saved Engineering Data Editor View, page 57
• Delete View Command, page 57
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 38
• Update the Engineering Data Editor, page 58
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 38
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 64
• Define a New Engineering Data Editor View, page 51
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 54
• 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 38
• Use AutoFilter in the Engineering Data Editor, page 61
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 64
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 64
• Customizing the Display of the Engineering Data Editor: An Overview,
page 59
• Navigating in the Engineer Data Editor: An Overview, page 38
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 64
• Customizing the Display of the Engineering Data Editor: An Overview,
page 59
• Navigating in the Engineer Data Editor: An Overview, page 38
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 64
• Display Settings Command, page 62
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 91
• Using Catalog Explorer: An Overview, page 65
Related Topics
• Configuration (PickQuick) Tool, page 146
• Manipulating Items With Component Handles: An Overview, page 238
• One-Point Label Placement, page 184
• Placing Items on a Grid: An Overview, page 150
• Two-Point Label Placement, page 187
• 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 76
• 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
Creates a new item or adds a node under the selected node in the Catalog Explorer.
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 75
• 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 178
• Place a Package, page 213
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 178
• Place a Package, page 213
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
Customize the Catalog Explorer List View
1. In Catalog Explorer click the down-arrow on the View menu .
2. Choose the display of items in your list view. Options include
• Large Icons - Displays the icon for an item in the list view in a larger
format.
• Small Icons - Displays the icon for an item in the list view in a smaller
format.
• List - Displays the icon and name for an item in the list view in a
simple list.
• Details - Displays the icon, name, and file location for an item.
Related Topics
• Using Catalog Explorer: An Overview, page 65
• View Menu, page 77
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 82
• 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 91
• Display Shortcut Buttons in Catalog Explorer, page 82
• 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 88
• Customize the Properties Window, page 86
• Display Null Values in the Properties Window, page 89
• Paste Bulk Properties, page 89
• Show Brief Properties, page 90
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 87
• Selecting Drawing Items: An Overview, page 144
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.
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.
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.
Show Brief Properties - Displays those properties that have been previously
specified as brief on the Advanced Table Properties dialog box.
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 88
• Customize the Properties Window, page 86
• Display Null Values in the Properties Window, page 89
• Paste Bulk Properties, page 89
• Show Brief Properties, page 90
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 215
• Modifying Item Properties: An Overview, page 258
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 86
• 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 28
• 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 27
• 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 27
• Customizing the Software: An Overview, page 91
Related Topics
• Add a Button to a Toolbar, page 28
• Add a Command to a Menu, page 95
• Create a New Menu, page 96
• Create a New Toolbar, page 27
• Remove a Button From a Toolbar, page 28
• 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 27
• 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 28
• Add a Command to a Menu, page 95
• Create a New Toolbar, page 27
• Remove a Button From a Toolbar, page 28
• Toolbars Dialog Box, page 26
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 28
• Create a New Toolbar, page 27
• Remove a Button From a Toolbar, page 28
Related Topics
• Customizing the Software: An Overview, page 91
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 91
• 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 93
• Customizing the Software: An Overview, page 91
• 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 91
• Display Help for Programming With SmartPlant P&ID, page 13
• Run a Macro, page 101
Model Items - Opens the Delete Orphan Model Items dialog box, which allows you
to delete obsolete model items.
OPCs - Opens the Repair OPCs dialog box, which allows you to fix or delete OPC
pairs with incomplete reference information.
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.
Related Topics
• Delete Orphan Model Items, page 100
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 127
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 91
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.
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.
Related Topics
• Embed a New Object, page 277
• Open an Existing Drawing, page 108
• Review and Edit Item Properties, page 87
• Save a Drawing or a Drawing Template, page 125
• Set Document Properties, page 116
• Switch to Another Open Drawing or View, page 111
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 110
• Open an Existing Drawing, page 108
• Switch to Another Open Drawing or View, page 111
• 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
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.
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.
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 110
• Open an Existing Drawing, page 108
• Open Command, page 72
• Switch to Another Open Drawing or View, page 111
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 109
• Open an Existing Drawing, page 108
• 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 110
• Open an Existing Drawing, page 108
• 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 110
• Open a Drawing in a Different Database, page 109
• Open an Existing Drawing, page 108
• Open Command, page 72
Related Topics
• Creating P&IDs in SmartPlant P&ID: An Overview, page 141
• 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 111
• Working with Drawings: An Overview, page 102
Related Topics
• Working with Drawings: An Overview, page 102
Related Topics
• Working With the Design Window: An Overview, page 15
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 116
• View Document Properties, page 115
• 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 112
• Set Document Properties, page 116
• View Document Properties, page 115
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 112
• Set Document Properties, page 116
• View Document Properties, page 115
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 112
• Set Document Properties, page 116
• View Document Properties, page 115
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 112
• Set Document Properties, page 116
• View Document Properties, page 115
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 112
• Set Document Properties, page 116
• View Document Properties, page 115
Close Command
File > Close
Closes the active drawing. The software saves your changes automatically.
Related Topics
• Close an Active Drawing, page 117
• Working with Drawings: An Overview, page 102
Note
• Any changes are automatically saved upon closing.
Related Topics
• Saving Drawings: An Overview, page 124
• 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 118
• 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 124
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.
Related Topics
• Create a Drawing Template, page 121
• Edit a Standard Drawing Template Border, page 122
• Embed a New Object, page 277
• Link or Embed a Previously Existing Object, page 278
• Set up a Page Layout, page 370
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 121
• Creating Drawing Templates: An Overview, page 119
• Save a Drawing or a Drawing Template, page 125
• Set Document Properties, page 116
• Set up a Page Layout, page 370
• Working with Drawings: An Overview, page 102
• 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 119
• Embed a New Object, page 277
• Working with Drawings: An Overview, page 102
7. Click OK.
8. Click File > Save.
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.
9. Quit the design software.
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 121
Related Topics
• Creating Drawing Templates: An Overview, page 119
• Embed a New Object, page 277
• 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.
Closing Drawings
You can close a drawing without saving your work, because changes to the drawing
post to the database as you make them. However, you probably feel more comfortable
saving it at least once yourself. You can save your drawing by clicking Save on the
toolbar.
Related Topics
• Save a Drawing in a Different Format, page 126
• Save a Drawing or a Drawing Template, page 125
• Switch to Another Open Drawing or View, page 111
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 124
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 126
• Saving Drawings: An Overview, page 124
Related Topics
• Save a Drawing or a Drawing Template, page 125
• Saving Drawings: An Overview, page 124
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.
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 127
You can apply filters to either Drawing views or the Engineering Data Editor. For
example, you could filter all pumps in a Drawing view. After applying the filter, you
see all pumps in the drawing as graphical symbols. You can then select all the pumps
and edit their properties one-by-one or as a select set in the Properties window. That
same filter applied to the Engineering Data Editor displays a list of pumps and their
characteristics in a tabular format, where you can edit the properties of the pumps
also.
Filters can help you show different views of the same drawing and can make your
workflow more efficient. For example, you can use a filter to display an operational
design, or an under construction design. You can show all items added after a certain
date or after a certain revision number. You can use filters if, for example, you want
to delete items of a certain type.
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
• Create a Simple Filter, page 136
• Customize a Filter Tab for the Drawing View, page 138
• Define a New Filter for an Engineering Data Editor View, page 52
• Define the Contents of Your Report Template, page 357
Adds a filter tab to the drawings in the Design window. This command displays the
Select Filter dialog box, which contains a subset of the commands in Filter Manager.
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
• Working With the Design Window: An Overview, page 15
• Click Browse on the Add Filter Tab dialog box when you want to add a
filter to the Drawing view.
• Click Browse on the Filter tab of the Define Report Items dialog box
when you are choosing your report item type.
• Choose Filter in the Find what list on the Find tab of the Find and
Replace dialog box.
New - Displays the New Filter dialog box, which allows you to specify a new simple
or new compound filter.
Properties - Allows you to edit the properties of the selected filter. This button
displays the Filter Properties dialog box or the Compound Filter Properties dialog
box, depending on your selection in the filter list. If you create a compound filter,
select the individual simple filters that compose a compound filter and click
Properties to view the Filter Properties dialog box for those simple filters.
Related Topics
• Create a Simple Filter, page 136
• Customize a Filter Tab for the Drawing View, page 138
• Define the Contents of Your Report Template, page 357
• Find an Item by Using a Filter, page 226
• Replace Multiple Drawing Items Using Filters, page 230
Filter - Contains information about the filter that you want to use for your Drawing
view.
Filter Name - Displays the name of the filter that you want to use for your Drawing
view. This information is read-only. You specify the name of the filter when you
choose or create it.
Browse - Opens the Select Filter dialog box, which allows you to choose or create a
filter for your Drawing view.
Properties - Opens the Filter Properties dialog box. You can modify the properties
of the filter that you choose from the Select Filter dialog box. You can name the new
filter appropriately.
Alternate symbology - Contains information about how the software displays the
filtered items in your Drawing view. In order for the alternate symbology to take
effect in your drawing, you must right-click the drawing filter tab and select Use
Alternate Symbology.
Color - Allows you to specify the color of the filtered items. Scroll down the list to
choose a color.
Width - Allows you to specify the line width for your filtered items. Scroll down the
list to choose a line width.
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
Simple filter - Returns a collection of items based on the filter definition and criteria
of a single filter.
Related Topics
• Add Filter Command, page 131
• Customize a Filter Tab for the Drawing View, page 138
• Define a New Filter for an Engineering Data Editor View, page 52
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. If you are defining the Engineering Data Editor, the criteria that
you enter on the Filter tab on the Advanced Table Properties dialog box are
combined with the base filter that you select.
Delete - Removes the selected criterion from the definition list. This button is active
only when you select a criterion in the definition list.
Description - A phrase or sentence about the filter. The description can be any
combination of characters and has no length limit. The description appears as a
ToolTip when you point to the filter name on the Filter Manager interface.
Edit - Allows you to define or edit a single line of filter definition criteria.
Filter for - Contains the top-level items from the data dictionary. Specifies available
properties in the Definition grid.
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.
Name - Specifies the filter name. The name can be any combination of characters and
has no length limit. Filter names within a project must be unique. This name appears
as the filter name on the Filter Manager interface.
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 a Filter Tab for the Drawing View, page 138
Related Topics
• Create a Simple Filter, page 136
Description - Specifies a phrase or sentence about the filter. The description can be
any combination of characters and has no length limit. The description appears as a
ToolTip when you point to the filter name on the Filter Manager interface.
Filter Method - Allows you to choose either Match all or Match any.
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.
Name - Specifies the filter name. The name can be any combination of characters and
has no length limit. Filter names within a plant must be unique. This name appears as
the filter name on the Filter Manager interface.
Related Topics
• Add Filter Command, page 131
• Customize a Filter Tab for the Drawing View, page 138
Note
• You must select a filter tab in order for this command to be available. The
Filter Tab shortcut menu opens when you right-click the filter tab area at
the bottom of a Drawing view.
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
Note
• You must select a filter tab in order for this command to be available. The
Filter Tab shortcut menu opens when you right-click the filter tab area at
the bottom of a Drawing view.
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
Note
• The Filter Tab shortcut menu opens when you right-click the filter tab
area at the bottom of a Drawing view.
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
Note
• The Filter Tab shortcut menu opens when you right-click the filter tab
area at the bottom of a Drawing view.
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
Note
• The Filter Tab shortcut menu opens when you right-click the filter tab
area at the bottom of a Drawing view.
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
Note
• The Filter Tab shortcut menu opens when you right-click the filter tab
area at the bottom of a Drawing view.
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
In the Properties window, you can add values for various properties of each item
after you place it in your drawing. Also, you can 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.
Also, you can generate reports to help you keep track of information in the drawing.
After you finish the drawing, you can generate order lists for the components in the
drawing, for example. You can print the drawing, too.
Note
• When SmartPlant P&ID or any associated stand-alone application, for
example Filter Manager, Format Manager, Options Manager or Rules
Manager, cannot establish a connection with the database on the server,
and the error message in SPError.log is Error
Problem:Common::GetDatabasePathAndServerLocS:\SmartPid\bin\
SmartPlant.ini, solve the error by making sure your internet options are
set to allow internet access using a proxy server and also to bypass the
proxy server for intranet addresses.
Related Topics
• Create an Assembly, page 286
• Define a New Engineering Data Editor View, page 51
• Generate a Report, page 334
• Open a New Drawing View, page 35
• Print a Drawing, page 365
• Review an Inconsistency, page 317
• 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.
When you click the Select Tool, the pointer changes to an arrow with a locate zone
indicator at the end: . As you pause on items in a drawing, the items appear in the
highlight color. When an item is highlighted, you can click to select it.
• 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.
Selecting Multiple Items
You can select more than one item at a time by clicking Select Tool and then
holding Shift or Ctrl as you click the items that you want to select. Or, you can click
the Select Tool and then drag to fence items.
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 can 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.
Canceling the Selection of Items
To cancel selection of an item or group of items, you can click any empty point on the
drawing.
Selecting Items for Placement
To place an item in a drawing, you select it in Catalog Explorer or the stockpile.
Then you click to select the position in the drawing to place the item. You cannot
select more than one item for placement in a drawing at a time. After placement, you
can select another item or press Esc to quit placement mode. Or, you can escape
placement mode by right-clicking.
Related Topics
• Move an Item With the Select Tool, page 218
• Select an Item, page 147
Related Topics
• Copy an Item With the Select Tool, page 254
• Modify an Item With the Select Tool, page 248
• Move an Item With the Select Tool, page 218
• Select an Item, page 147
• Selecting Drawing Items: An Overview, page 144
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 254
• Modify an Item With the Select Tool, page 248
• Move an Item With the Select Tool, page 218
• Select an Item, page 147
• Select Tool Command, page 145
Related Topics
• Place a Flow Arrow, page 194
• Place an Item from Catalog Explorer, page 66
• Place an Item from the Stockpile, page 264
• Place an Item With the Configuration (PickQuick) Tool, page 149
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 that 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.
• Also, you can 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 148
• Selecting Drawing Items: An Overview, page 144
3. On the PickQuick toolbar, which appears near the pointer, move the pointer over
the numbered PickQuick buttons, without clicking, to highlight the
corresponding items.
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 33
Displays a grid so that 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 150
• Set Document Properties, page 116
• View Document Properties, page 115
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 150
• Set Document Properties, page 116
• View Document Properties, page 115
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 164
• Place Equipment, page 153
• Place Multiple Representations, page 154
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
242
Rotate an Item Using Its Rotate Handle, page 244
Move an Item Using the Move Button, page 219
• If the Properties window is not displayed, you can display it by selecting
the item and then selecting Edit > Properties on the main menu bar.
• Flanged Nozzle-Internal, Nozzle-Internal, and Pump Nozzle-Internal
can all be placed internally (for example, in a tank). You can use the same
steps for placing equipment. For internal placement of equipment, you
drag the nozzle to the interior of a tank and place it. If you want the
nozzle opening facing to the right, approach the tank from the right when
placing the nozzle. In other words, the opening of the nozzle will be
placed in the direction that you approach the tank during placement.
Related Topics
• Grouping Equipment in SmartPlant P&ID, page 408
• Modifying and Moving Placed Items: An Overview, page 215
• Placing Equipment: An Overview, page 152
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.
6. Select Place Multiple Representation from the shortcut menu.
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 152
• Selecting Drawing Items: An Overview, page 144
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.
Note
• All of the above information about pipe runs also applies to signal runs.
Related Topics
• Assign Heat Tracing, page 164
• Branch to an Existing Line, page 162
• Break a Pipe Run, page 165
• Insert Line Segments into an Existing Line, page 161
• Move a Line, page 220
• Start a Line in Free Space, page 159
Alter Segment - Allows you 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 - Causes the software to insert line segments instead of routing
new lines or instead of moving existing lines.
Related Topics
• Branch from an Existing Line, page 162
• Insert Line Segments into an Existing Line, page 161
• Move a Line, page 220
• Start a Line from a Connect Point, page 160
• Start a Line in Free Space, page 159
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 156
• 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 156
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 165
• Routing Lines: An Overview, page 156
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 166
• Routing Lines: An Overview, page 156
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 164
• Place a Piping Component, page 167
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 156
• Using Piping Components: An Overview, page 167
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.
Related Topics
• Assign a Commodity Code to a Piping Component Using PipeSpec, page
173
• Assign a Piping Materials Class to a Pipe Run Using PipeSpec, page 172
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
173
• Assign a Piping Materials Class to a Pipe Run Using PipeSpec, page 172
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 178
• Assign Heat Tracing, page 164
• Place an Inline Instrument, page 175
• Place an Offline Instrument, page 177
• Remove an Instrument from a Loop, page 180
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 178
• Place an Inline Instrument, page 175
• Place an Offline Instrument, page 177
• Remove an Instrument from a Loop, page 180
• 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 331
• Loop Tag Dialog Box (Properties Window), page 175
• Navigating in the Engineer Data Editor: An Overview, page 38
• Placing Instrumentation: An Overview, page 174
• Selecting Drawing Items: An Overview, page 144
• Working With the Properties Window: An Overview, page 83
Related Topics
• Generating Reports: An Overview, page 331
• Loop Tag Dialog Box (Properties Window), page 175
• Navigating in the Engineer Data Editor: An Overview, page 38
• Placing Instrumentation: An Overview, page 174
• Selecting Drawing Items: An Overview, page 144
• 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.
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 190
• Place a Label from Catalog Explorer, page 184
• Place a One-Point Label, page 186
• Place a Two-Point Label, page 188
• Place an Annotation, page 211
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. You must replace those labels individually to
see the change whether those labels use the plant default setting or have
the value set uniquely.
• 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 184
• Place a One-Point Label, page 186
• Place a Two-Point Label, page 188
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 21
• Manipulate a Leader Line, page 190
• Place a Label from Catalog Explorer, page 184
• Place a One-Point Label, page 186
• Place a Two-Point Label, page 188
Related Topics
• Configuration (PickQuick) Tool, page 146
• Placing Labels: An Overview, page 182
• Using Off-Page and Utility Connectors: An Overview, page 201
• Using the Types of Labels: An Overview, page 191
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 190
• Place a Label from Catalog Explorer, page 184
• Place a Two-Point Label, page 188
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.
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 253
• Labeling: An Overview, page 181
• Place a One-Point Label, page 186
• Placing Labels: An Overview, page 182
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 labels so that their bottom lines match
• Align labels so that their center points agree on a vertical line
• Align labels so that their center points agree on a horizontal line
• Align labels so that their left-most lines match
• Align labels so that their right-most lines match
• Align labels so that their top lines match
Related Topics
• Labeling: An Overview, page 181
• Modifying and Moving Placed Items: An Overview, page 215
• Placing Labels: An Overview, page 182
• Selecting Drawing Items: An Overview, page 144
Related Topics
• Labeling: An Overview, page 181
• Placing Labels: An Overview, page 182
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.
You cannot modify label properties for a title block. 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.
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 184
Related Topics
• Labeled Item Type, page 197
• One-Point Label Placement, page 184
• Placing Labels: An Overview, page 182
• Using the Types of Labels: An Overview, page 191
Related Topics
• Labeled Item Type, page 197
• One-Point Label Placement, page 184
• Placing Labels: An Overview, page 182
• Two-Point Label Placement, page 187
• Using the Types of Labels: An Overview, page 191
3. Continue placing the same break label at other junctions in the drawing, or press
Esc to quit placement mode.
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
• Consistency Checking: An Overview, page 313
• Placing Labels: An Overview, page 182
• Two-Point Label Placement, page 187
• Using the Types of Labels: An Overview, page 191
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 184
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.
Related Topics
• Place a Label from Catalog Explorer, page 184
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 184
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 184
Related Topics
• Placing Labels: An Overview, page 182
• 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 184
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 184
• Place a One-Point Label, page 186
• Place a Two-Point Label, page 188
• Place an Annotation, page 211
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 190
• Place a Label from Catalog Explorer, page 184
Related Topics
• Place a Label from Catalog Explorer, page 184
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 cannot change the connector number or
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.
These properties exist for connectors:
• Offset source is set to None.
• Rotation is set to True.
• Leader line is set to False.
In Catalog Explorer, Off-Drawing or Off-Unit OPCs are available for instruments.
Two types of connectors are available for process lines: Off-Drawing or Off-Unit
OPCs or Utility Connectors. The correct symbology differentiates OPCs. You define
symbology with Options Manager.
Related Topics
• Change Default Storage Location for Partner Connector, page 204
• Place a Label from Catalog Explorer, page 184
• Place a One-Point Label, page 186
• Place an OPC or Utility Connector, page 202
• Store a Partner Connector, page 204
•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 233.
Related Topics
• One-Point Label Placement, page 184
• Placing Labels: An Overview, page 182
• Using Off-Page and Utility Connectors: An Overview, page 201
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
• Properties Window Command, page 84
• Review and Edit Item Properties, page 87
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 201
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 206
• Using Off-Page and Utility Connectors: An Overview, page 201
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 206
• Move Partner OPC Command, page 205
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 connector is not located in the drawing stockpile.
Related Topics
• Open a Continuation Drawing, page 207
• Using Off-Page and Utility Connectors: An Overview, page 201
Related Topics
• Open Continuation Drawing Command, page 206
• Using Off-Page and Utility Connectors: An Overview, page 201
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 207
• Using Off-Page and Utility Connectors: An Overview, page 201
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 178
• Display Help for Programming With SmartPlant P&ID, page 13
• Modify a Pump by Importing a SmartPlant P&ID Report into the
Stockpile, page 268
• Review and Edit Item Properties, page 87
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 214
• Place an Annotation, page 211
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 188 and Place a One-Point
Label, page 186.
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 239.
• 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 182
• Using Annotations: An Overview, page 210
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. Select the package in the stockpile.
4. In the Properties window, enter a value for the Item Tag property.
5. Press Esc to quit placement mode.
6. In the Drawing view, select items to be part of the package.
7. In the Properties window, choose Select Set from the Properties box.
8. In the Properties window, click in the Pkg Item Tag box and select the
appropriate value displayed list.
Tip
• Some catalog items do not possess the Pkg Item Tag property. 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 265.
• 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
• Selecting Drawing Items: An Overview, page 144
• 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 as 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 the fluid code properties of a line, you select a fluid code
from the select list. The fluid code list displays only codes beginning with
the first letter of any previously selected fluid code for that line. 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 241
• Move a Select Set to Another Open Drawing, page 223
• Move an Item Using the Move Button, page 219
• Review and Edit Item Properties, page 87
• Scale a Drawing Item, page 239
• Scale a Parametric Item, page 239
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
• Add a filter tab to the Drawing view
• 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
• Modifying and Moving Placed Items: An Overview, page 215
• Undo Your Last Action, page 217
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 215
• Selecting Drawing Items: An Overview, page 144
• Undo Command, page 216
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 219
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 219
• Move Command, page 217
• Selecting Drawing Items: An Overview, page 144
Related Topics
• Manipulating Items With Component Handles: An Overview, page 238
• Modifying and Moving Placed Items: An Overview, page 215
• Selecting Drawing Items: An Overview, page 144
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 221
• Routing Lines: An Overview, page 156
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 215
• Move a Select Set to Another Open Drawing, page 223
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 223
• Move To Drawing Command, page 222
• 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 215
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 227
• Find an Item by Using a Filter, page 226
• Find an Item by Using an Existing Drawing Item, page 228
• Find Drawing Inconsistencies, page 226
• Replace a Single Drawing Item, page 229
• Replace Multiple Drawing Items Using Catalog Items, page 231
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 227
• Find an Item by Using a Filter, page 226
• Find an Item by Using an Existing Drawing Item, page 228
• Find Drawing Inconsistencies, page 226
• Finding and Replacing Drawing Items: An Overview, page 225
Notes
• Use the Scroll mode options to control how the Drawing view changes
when a drawing item is found.
• Use the Direction options to change the order in which drawing items are
found.
Related Topics
• Finding and Replacing Drawing Items: An Overview, page 225
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 225
• Replace a Single Drawing Item, page 229
• Replace an Item Using Replace Mode, page 233
• Replace Multiple Drawing Items Using Catalog Items, page 231
• Replace Multiple Drawing Items Using Filters, page 230
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 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.
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.
The Replace Mode command copies properties of the current item onto the new item.
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.
Related Topics
• Cutting or Deleting Items: An Overview, page 245
• Finding and Replacing Drawing Items: An Overview, page 225
• Place Multiple Representations, page 154
• Replace an Item Using Replace Mode, page 233
Related Topics
• Find a Drawing Item by Using a Catalog Item, page 227
• Find Command, page 68
• Find Drawing Inconsistencies, page 226
• Replace a Single Drawing Item, page 229
• Replace Command, page 228
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 227
• Find an Item by Using a Filter, page 226
• Find an Item by Using an Existing Drawing Item, page 228
• Find Command, page 68
• Find Drawing Inconsistencies, page 226
• Replace Command, page 228
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 229
• Replace Command, page 228
• Replace Multiple Drawing Items Using Catalog Items, page 231
• Replace Multiple Drawing Items Using Filters, page 230
• Click Browse on the Add Filter Tab dialog box when you want to add a
filter to the Drawing view.
• Click Browse on the Filter tab of the Define Report Items dialog box
when you are choosing your report item type.
• Choose Filter in the Find what list on the Find tab of the Find and
Replace dialog box.
New - Displays the New Filter dialog box, which allows you to specify a new simple
or new compound filter.
Properties - Allows you to edit the properties of the selected filter. This button
displays the Filter Properties dialog box or the Compound Filter Properties dialog
box, depending on your selection in the filter list. If you create a compound filter,
select the individual simple filters that compose a compound filter and click
Properties to view the Filter Properties dialog box for those simple filters.
Related Topics
• Create a Simple Filter, page 136
• Customize a Filter Tab for the Drawing View, page 138
• Define the Contents of Your Report Template, page 357
• Find an Item by Using a Filter, page 226
• Replace Multiple Drawing Items Using Filters, page 230
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 227
• Find an Item by Using a Filter, page 226
• Find an Item by Using an Existing Drawing Item, page 228
• Find Command, page 68
• Find Drawing Inconsistencies, page 226
• Replace Command, page 228
• 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
242
• Mirror an Item Using Its Mirror Handle, page 241
• Rotate an Item About an Axis You Define, page 244
• Rotate an Item Using Its Rotate Handle, page 244
• Scale a Drawing Item, page 239
• Scale a Parametric Item, page 239
Related Topics
• Manipulating Items With Component Handles: An Overview, page 238
• Modifying and Moving Placed Items: An Overview, page 215
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 241
• Mirror an Item About an Existing Mirror Axis or Linear Element, page
242
• Mirror an Item Using Its Mirror Handle, page 241
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 241
• Mirror Command, page 240
Related Topics
• Copying Items: An Overview, page 253
• Modifying and Moving Placed Items: An Overview, page 215
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 244
• Rotate an Item Using Its Rotate Handle, page 244
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 default setting is 0 degrees so that the
rotation is fully dynamic.
Related Topics
• Rotate an Item About an Axis You Define, page 244
• Rotate an Item Using Its Rotate Handle, page 244
• Rotate Command, page 242
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 253
• Selecting Drawing Items: An Overview, page 144
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 265.
Related Topics
• Cut an Item from the Drawing, page 246
• Delete an Item from the Drawing, page 249
• Move a Stockpile Item to the Stockpile of Another Drawing, page 265
• Remove an Item from a Drawing, page 250
• Remove an Item from the Model, page 251
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 246
• Cutting or Deleting Items: An Overview, page 245
• Selecting Drawing Items: An Overview, page 144
Related Topics
• Cutting or Deleting Items: An Overview, page 245
• Linking and Embedding Objects: An Overview, page 273
• Move a Stockpile Item to the Stockpile of Another Drawing, page 265
Paste Command
Edit > Paste
Inserts the Clipboard contents at the same location that the items occupied in the
source document or drawing. The command is not available if the Clipboard is empty.
Related Topics
• Cutting or Deleting Items: An Overview, page 245
• Paste an Item With a Different Format, page 280
• Paste an Item, page 247
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 245
Note
• You can access this command when you right-click a blank area in a
drawing or table, too. On the shortcut menu click Select All.
Related Topics
• Select an Item, page 147
• Selecting Drawing Items: An Overview, page 144
Related Topics
• Manipulating Items With Component Handles: An Overview, page 238
• Selecting Drawing Items: An Overview, page 144
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.
Related Topics
• Cutting or Deleting Items: An Overview, page 245
• Selecting Drawing Items: An Overview, page 144
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 207
• Using Off-Page and Utility Connectors: An Overview, page 201
• 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 265.
Related Topics
• Modifying and Moving Placed Items: An Overview, page 215
• Move a Stockpile Item to the Stockpile of Another Drawing, page 265
• Remove an Item from a Drawing, page 250
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 254
• Copy an Item, page 253
• Paste an Item With a Different Format, page 280
• Paste an Item, page 247
• Rotate an Item About an Axis You Define, page 244
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 254
• Copy an Item, page 253
• Cutting or Deleting Items: An Overview, page 245
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 253
• Linking and Embedding Objects: An Overview, page 273
• Selecting Drawing Items: An Overview, page 144
Related Topics
• Copying Items: An Overview, page 253
• Selecting Drawing Items: An Overview, page 144
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 256
• Customize the Properties Window, page 86
• Select an Item, page 147
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 256
• Routing Lines: An Overview, page 156
• Select an Item Using the Configuration (PickQuick) Tool, page 148
• Selecting Connected Items: An Overview, page 254
• Selecting Drawing Items: An Overview, page 144
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.
Alphabetic - Lists properties in alphabetical order.
Categorized - Displays properties grouped by specific categories. By default the
properties are displayed categorically. Categories are defined and properties are
assigned to those categories in Data Dictionary Manager.
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 256
• Select an Item, page 147
• Select Connected Items Command, page 255
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 88
• Import Aspen Zyqad Stream Data, page 329
• Modify an Item With the Select Tool, page 248
• Modify the Table Properties of an Existing Engineering Data Editor View,
page 54
• Paste Bulk Properties, page 89
• Review and Edit Item Properties, page 87
• 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 path like this:
file://UNC_path/share/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 87
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 87
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 261
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.
Related Topics
• Properties Window Command, page 84
• Review and Edit Item Properties, page 87
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 175
• Review and Edit Item Properties, page 87
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 267
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 Stockpile 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 265
• Place an Item from the Stockpile, page 264
• Place Multiple Representations, page 154
• Populate the Stockpile from a Spreadsheet, page 267
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 204
• Move a Stockpile Item to the Stockpile of Another Drawing, page 265
Related Topics
• Navigating in the Engineer Data Editor: An Overview, page 38
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
<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 268
• Populate the Stockpile from a Spreadsheet, page 267
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
• Perform Line Gapping in Your Drawing Now, page 270
• Turn AutoGap On or Off, page 270
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 269
• Turn AutoGap On or Off, page 270
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 156
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 269
• Turn AutoGap On or Off, page 270
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 269
• Routing Lines: An Overview, page 156
The symbology and other settings defined in Options Manager usually only take
effect in those drawings that are 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
• Customize a Filter Tab for the Drawing View, page 138
• Update Label Settings, page 190
• Update Line Settings, page 272
• Update Symbology, page 272
Updates the line width and color symbology for your active drawing. Redefining
symbology in Options Manager usually only affects drawings created after the
change. The Update Symbology command makes it possible to override this
constraint.
Related Topics
• Update Symbology, page 272
• Updating Options Manager Settings: An Overview, page 271
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 only affects drawings
created after the change. The Update Symbology command makes it
possible to override this constraint.
• Once you load the current plant-wide symbology 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. For more
information, see Customize a Filter Tab for the Drawing View, page 138.
Related Topics
• Updating Options Manager Settings: An Overview, page 271
• Using Filters: An Overview, page 130
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.
Embedding by Cutting or Copying, and Pasting
The easiest way to embed an object is to use the Cut, Copy, and Paste commands on
the Edit menu in any OLE software. If you copy or paste information into an
application in which you cannot edit the information, the software automatically
embeds the information in the document. You can then edit the embedded
information with the software that created it. If you cannot edit the information, the
information appears as a static picture.
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.
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 283
• Change a Link, page 282
• Embed a New Object, page 277
• Link or Embed a Previously Existing Object, page 278
• Linking and Embedding Objects: An Overview, page 273
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 273
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 283
• Edit an Embedded Object, page 282
• Embed a New Object, page 277
• Link or Embed a Previously Existing Object, page 278
• Linking and Embedding Objects: An Overview, page 273
Notes
• You can move the object at any time later. For more information, see
Move an Item With the Select Tool, page 218 or Move an Item Using the
Move Button, page 219.
• 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 280.
• 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 245
• Linking and Embedding Objects: An Overview, page 273
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 253
• Linking and Embedding Objects: An Overview, page 273
• Paste an Item With a Different Format, page 280
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 281
• Linking and Embedding Objects: An Overview, page 273
Related Topics
• Linking and Embedding Objects: An Overview, page 273
• 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 273
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 273
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.
Related Topics
• Create an Assembly, page 286
• Place an Assembly, page 287
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 286
• Place an Assembly, page 287
• Working With Assemblies: An Overview, page 284
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 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 287
• Selecting Drawing Items: An Overview, page 144
• Working With Assemblies: An Overview, page 284
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 219
Mirror an Item About an Existing Mirror Axis or Linear Element, page 242
Rotate an Item About an Axis You Define, page 244
Delete an Item from the Drawing, page 249
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 284
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 289
• Comparing and Refreshing Versions: An Overview, page 304
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 292
• Display Claim Status in the Drawing Symbology, page 303
• Display the Claim Status of a Drawing Item, page 302
• Release a Claim, page 301
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 292
• Claiming Items: An Overview, page 289
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 292
• Claim Command, page 44
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.
The Reapply Rules button executes the placement rules that copy property values
across a relationship. In some cases this results in resolving an inconsistency. For a
description of how Reapply Rules can interact with claiming, see Placement Rules,
page 294.
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.
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.
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.
Rotation and Mirroring of Inline Components
Rotations of 180 degrees and mirroring about the local y-axis for inline components
are special geometric modifications cases because the lines are disconnected before
and reconnected after the operations. Therefore, the lines, but not the selected symbol,
must be claimed before these operations are allowed. If the lines are not claimed, the
standard claim violation message displays.
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.
Extreme End of a Run
If you modify the start point of the first line segment in a run or the end point of the
last line segment in a run, then the following stipulations apply:
1. The selected run must be claimed.
2. The target item may need to be claimed.
3. If the existing connected item is a branch point for the run, then the run it belongs
to must be claimed since the branch point is deleted and the adjacent line
segments in the existing connected run are merged.
4. If a component is connected to the endpoint, it does not need to be claimed.
Internal Vertex of a Run
Modification of an internal vertex can result in the run being split; consequently, the
following stipulations apply:
1. The entire run and all components must be claimed.
2. The target item may need to be claimed.
Breaking and Joining Runs
The Break Run command allows you to split one piping or signal run into two
pieces. The run to be broken and all components within that run must 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 154
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
Instrument
• All instrument components – actuators, functions, and
so forth
Item in Select Set Additional items that must be claimed for Delete
• 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. Refer to 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 298
Allows you to relinquish control by your project of the selected items. A confirmation
message is displayed so that you can confirm the release-claim action. Claims must
be released before projects can be completed or for other projects to be able to check
in drawings with changes.
Related Topics
• Claiming Items: An Overview, page 289
• Release a Claim, page 301
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. In order to complete
the claim release operation, select Yes on the confirmation dialog box that opens.
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 302.
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 289
• Display the Claim Status of a Drawing Item, page 302
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 292
• Claim Status Command, page 45
• Display the Claim Status of a Drawing Item, page 302
• Release a Claim, page 301
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 45
• Display the Claim Status of a Drawing Item, page 302
Note
• When you see the item tag listed for claimed items and an item tag is not
defined for the selected items, the software displays the GUID for that
item. GUIDs are automatically generated for every design item. When an
item tag is defined for an item, the software displays the item tag in the
Claim Status dialog box.
Related Topics
• Claiming Items: An Overview, page 289
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 303
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.
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:
• Validate - Validates Invalid Claims for the selected group (no drawing
changes are applied).
• Refresh - Applies any drawing changes to the open drawing version; and
No Action - performs no action on the selected drawing group.
Category - Displays the category of the change. Options 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 reapply placement rules
that normally copy properties from one side of a junction to another at the time of
item placement.
Related Topics
• Reapply Placement Rules to Resolve an Inconsistency, page 322
• Resolve an Inconsistency, page 319
• Review an Inconsistency, page 317
• Show Inconsistencies, page 314
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 313
• Show Inconsistencies, page 314
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 313
Properties Command
Right-click an inconsistency indicator and choose Properties to display the
Consistency Check dialog box. As you create a drawing, consistency checking
monitors your drawing for design discrepancies. If a location in the drawing has only
one or multiple inconsistencies, you can correct the problems by reviewing them on
the Consistency Check dialog box.
Related Topics
• Consistency Checking: An Overview, page 313
• Reapply Placement Rules to Resolve an Inconsistency, page 322
• Resolve an Inconsistency, page 319
• Review an Inconsistency, page 317
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 — three different problems but at the same junction.
Item 1 - Allows the display of inconsistencies that pertain to the first item. When the
Consistency Check dialog box first appears, all items involved in the inconsistency
are selected.
Item 2 - Allows the display of inconsistencies that pertain to the second item. When
the Consistency Check dialog box first appears, all items involved in the
inconsistency are 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 - Lists solutions for resolving the drawing inconsistency. 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.
Reapply Rules - Copies properties from one side of the selected inconsistency to the
other according to placement rules. Invoking the placement rules is not necessarily
sufficient to resolve all inconsistencies at a junction.
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
• Properties Command, page 28
• Resolve an Inconsistency, page 319
• Review an Inconsistency, page 317
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
Properties.
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.
• You can choose the appropriate solution in the Solutions list and click
Apply in order to correct an inconsistency, or you can click Reapply
Rules to copy properties from one side of the indicator to the other
according to placement rules.
Related Topics
• Consistency Checking: An Overview, page 313
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.
• When you right-click the indicator, you can choose the Reapply Rules
command. This action can correct the inconsistency.
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.
Tip
• In addition, you can click the Reapply Rules button on the
Consistency Check dialog box.
Notes
• Consistency Check identifies the type of problem with these symbols:
Errors
Warnings
Approved warnings
Related Topics
• Consistency Checking: An Overview, page 313
• Reapply Placement Rules to Resolve an Inconsistency, page 322
• Review an Inconsistency, page 317
For example, if your vessel has a cleaning requirement assigned to it and you place a
nozzle on the vessel, then the cleaning requirement is copied to the nozzle at
placement. But if you place a nozzle on the vessel and then you assign a cleaning
requirement to the vessel, the nozzle does not inherit that property. An inconsistency
indicator at the junction between the vessel and the nozzle is displayed for the
mismatched cleaning requirements. If you use Reapply Rules at this indicator, then
the rule that copies the cleaning requirement to the nozzle at placement is re-invoked
and the inconsistency is resolved.
Notes
• The Reapply Rules button is available on the Consistency Check dialog
box, too.
• You can add the Reapply Rules command to the main toolbar. Go to
Tools > Customize, and on the Toolbars tab in the Tools category,
choose the button for Reapply Rules and drag it to the main toolbar.
Then you can reapply rules with one click. This button is particularly
useful when you want to reapply rules to a select set, rather than a single
inconsistency.
Related Topics
• Consistency Checking: An Overview, page 313
• Reapply Placement Rules to Resolve an Inconsistency, page 322
Related Topics
• Display Help for Programming With SmartPlant P&ID, page 13
• Import Aspen Zyqad Stream Data, page 329
• Populate the Stockpile from a Spreadsheet, page 267
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 267
• Using Reports to Import Items into the Stockpile, page 265
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 324
• Modify a Pump by Importing a SmartPlant P&ID Report into the
Stockpile, page 268
• Populate the Stockpile from a Spreadsheet, page 267
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 328
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.
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.
Flow - Appropriate flow direction is established based on the terminator of the
connector.
Properties - User-defined and default SmartSketch properties are mapped to an
equivalent SmartPlant P&ID property.
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.
Related Topics
• Import a SmartSketch File, page 328
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 13
• Import Aspen Zyqad Stream Data, page 329
• Populate the Stockpile from a Spreadsheet, page 267
Note
• Existing values in the Properties window are redefined by importing
Aspen Zyqad stream data.
Related Topics
• Using Reports to Import Items into the Stockpile, page 265
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 a report template from the Reports
menu and then selecting items in the drawing for inclusion in your report. 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
• 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 350
• Edit a Report Template, page 348
• 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 331
• Navigating in the Engineer Data Editor: An Overview, page 38
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.
Note
• A report can contain up to the default value of 255 items. You can include
more items in your report by selecting Entire drawing. Using either of
these options allows the software to ignore the 255 item limit.
Related Topics
• Generate a Report, page 334
• Plant Reports Command, page 333
• Select an Item, page 147
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 331
• Using Reports to Import Items into the Stockpile, page 265
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 348
• Generate a Report, page 334
• Generating Reports: An Overview, page 331
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.
Note
• A report can contain up to the default value of 255 items. You can include
more items in your report by selecting the Entire drawing option. Using
either of these options allows the software to ignore the 255 item limit.
Related Topics
• Generate a Report, page 334
• My Reports Command, page 335
• Select an Item, page 147
• 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.
Portable report templates
In previous versions of the software, when a property is mapped to a report template,
the template file stores an internal identifier for that property; thus, that report
template is tightly linked to the plant that creates the property. Now the property
name is mapped into the report template; therefore, as long as all plants use the same
property name, the same report template is valid.
Related Topics
• Create a New Blank Report Template, page 344
• Define the Contents of Your Report Template, page 357
• Define the Layout of a Composite Format Report Template, page 341
• 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 348
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 357
• Define the Layout of a Tabular Format Report Template, page 338
• Display the Properties of a Report Template, page 350
• Edit a Report Template, page 348
• 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 357.
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 350
• Edit a Report Template, page 348
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 341
• Display the Properties of a Report Template, page 350
• Edit a Report Template, page 348
• 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 350
• Edit a Report Template, page 348
• Edit Command, page 345
• New Command, page 34
Related Topics
• Composite Format Report, page 341
• Creating and Editing Report Templates: An Overview, page 337
• Edit a Report Template, page 348
• 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 348
• Generating Reports: An Overview, page 331
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 348
• Edit Command, page 345
• New Command, page 34
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 350
• Edit a Report Template, page 348
• Edit Command, page 345
• New Command, page 34
Related Topics
• Creating and Editing Report Templates: An Overview, page 337
• Edit a Report Template, page 348
• Generating Reports: An Overview, page 331
• Report Properties Dialog Box, page 346
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 351
• Generating Reports: An Overview, page 331
Related Topics
• Delete a Report Template, page 351
• Edit Command, page 345
• New Command, page 34
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 352
• Define the Contents of Your Report Template, page 357
• Edit a Report Template, page 348
• Map Properties Command, page 360
• Options Command, page 17
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 348
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
• Create a Report Template Based on an Existing Template, page 349
• Define the Contents of Your Report Template, page 357
• Edit a Report Template, page 348
• New Command, page 34
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 352
• Define the Contents of Your Report Template, page 357
• Edit a Report Template, page 348
• New Command, page 34
Related Topics
• Create a New Blank Report Template, page 344
• Define the Contents of Your Report Template, page 357
• Edit a Report Template, page 348
• Edit Command, page 345
• New Command, page 34
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 348
• New Command, page 34
• New Report Template Dialog Box, page 343
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 352
• Define the Contents of Your Report Template, page 357
• Edit a Report Template, page 348
• Map Properties Command, page 360
• Options Command, page 17
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 357
• Edit a Report Template, page 348
• 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 348
• Generating Reports: An Overview, page 331
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 357
• Edit a Report Template, page 348
• Generating Reports: An Overview, page 331
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 341
• Define the Layout of a Tabular Format Report Template, page 338
• Edit a Report Template, page 348
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 348
• Generating Reports: An Overview, page 331
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:
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 361
• Set Print Options, page 367
• 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 .pri 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 363
• Print to a File, page 368
• Set Print Options, page 367
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 366
• Print Command, page 363
• Print to a File, page 368
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.
• Because the fonts available on the selected printer affect both displaying
and printing, select the printer before you begin working on a 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 366
• Print Command, page 363
• Print to a File, page 368
Related Topics
• Printing Drawings: An Overview, page 361
• Selecting Drawing Items: An Overview, page 144
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 361
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 361
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 119
• Save a Drawing or a Drawing Template, page 125
• Set Document Properties, page 116
• Set up a Page Layout, page 370
• 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.
W (Width) - Displays the width of the custom sheet size.
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 369
• Set up a Page Layout, page 370
Related Topics
• Creating Drawing Templates: An Overview, page 119
• Printing Drawings: An Overview, page 361
• Working With the Design Window: An Overview, page 15
Most of the commands that provide access to TEF functionality exist in the common
user interface available on the Framework menu in SmartPlant Engineering Manager,
SmartPlant P&ID, and Drawing Manager.
SmartPlant P&D interacts with TEF by correlating items between the plant database
and the SmartPlant Foundation database, retrieving PFDs, Equipment Data sheets,
and the like from TEF, and creating a set of tasks in the To Do List that you can run
to update the plant database. In SmartPlant P&ID and Drawing Manager you can also
use the Framework menu to publish drawings and retrieve data, access the
SmartPlant Foundation Web Client in order to browse in TEF and subscribe to
change notifications and compare documents.
For more information about TEF commands in SmartPlant P&ID Drawing Manager,
see the SmartPlant P&ID Drawing Manager Help.
The Framework menu commands are not available unless your plant is registered
with the Framework. For more information, see SmartPlant Engineering Manager
Help and Related Topics.
The software maps a plant and all its projects to a single SmartPlant Foundation URL,
which points to one, and only one, SmartPlant Foundation plant database and its
projects. When you use the Register command in any of the authoring tools, you are
registering an authoring tool plant with a SmartPlant Foundation URL and plant that
you specify.
The system administrator must register each plant in the authoring tool with TEF
once; this action takes place in SmartPlant Engineering Manager. After the plant is
registered, you can publish and retrieve documents.
Related Topics
• Access the SmartPlant Foundation Web Client, page 381
• Find a Document to Publish, page 380
• Publish a Document to TEF, page 378
• Retrieve a Document from TEF, page 386
The authoring tools (SmartPlant P&ID or INtools, for instance) publish data to TEF
in .xml format. The software the loads the data from the .xml files to the SmartPlant
Foundation database. After the data is loaded into SmartPlant Foundation, you can
retrieve the data from TEF into other authoring tools.
When you publish documents, the software does the following things:
Reasons to Publish
You can publish documents and associated data into TEF for several reasons:
• To exchange and enhance data among tools, allowing users to avoid
creating data multiple times in multiple authoring tools
• To report on common data that originates in multiple tools
• To provide enterprise-wide accessibility to published documents
• To manage change, including workflow history and document revision
management
You can also publish documents to share information with users in other tools
without going through a formal workflow. To share data, you can publish a document
to a For sharing workflow that has only a load step so that the data is loaded into
SmartPlant Foundation as soon as you publish the document.
You can also publish a document by not assigning the document to a workflow but by
using the default workflow from SmartPlant Foundation. When you do not select a
workflow for a document during publishing, the Framework Loader loads the
document into SmartPlant Foundation as soon as it reaches the top of the Loader
queue.
Document Types for Publishing
Each authoring tool publishes different documents and data. The following list
contains each authoring tool that is part of the Framework, the document types that
each tool publishes, and information about whether data is also published with each
document type.
INtools
• Instrument Index documents and data, limited
• Instrument Specification Sheet documents
• Instrument Process Data Sheet documents
• Instrument Loop Drawings
• I/O Assignment document
SmartPlant P&ID
• Piping and Instrumentation Diagram (P&ID) documents and data
• Line List documents
• P&ID generated report documents
Zyqad
• PFD documents and data
• Equipment Data Sheet documents and data
• Summary Sheet documents and data
SmartPlant 3D
• Orthographic Drawings
SmartPlant Foundation
• Work Breakdown Structures (WBS)
• Plant Breakdown Structures (PBS)
All Authoring Tools
The PBS document contains information about the physical project with the
following structure: plant/area/unit. 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 PBS in the authoring tools
must match the one in SmartPlant Foundation for publishing from the authoring tools
and object correlation to work properly.
The WBS document contains information about the project and its status in a
plant/project/contract structure. When a WBS document is published from SmartPlant
Foundation, the authoring tools are notified of projects and contracts that need to be
created in the authoring tools. The WBS in the authoring tools must match the one in
SmartPlant Foundation for publishing from the authoring tools and object correlation
to work correctly.
Publishing Files without Data
You can also browse to other file types on the file system, such as Microsoft Word or
Excel files, or SmartSketch® files, in order to publish them. These documents are
always published without data. The primary reasons to publish documents without
data are that the SmartPlant Foundation Change Management functionality can
manage document changes and reviews using workflows and that you can view the
documents electronically.
Related Topics
• Access the SmartPlant Foundation Web Client, page 381
• Find a Document to Publish, page 380
Publish Command
Framework > Publish
Opens the Publish dialog box, and allows you to send the information of the
documents that you have selected to The Engineering Framework (TEF).
Related Topics
• Publishing to TEF: An Overview, page 373
• Working with The Engineering Framework: An Overview, page 371
Selected documents - Displays a list of the documents selected for publishing. You
can populate this list by clicking the buttons in the Add area of this dialog box. For
each document, this list provides the name, the type of the document, the application
which last published the document, the revision and version numbers, the revision
schedule, and the date that the document was last published.
Engineering Tool - Opens a tool-specific dialog box that allows you to select
documents to add to the Selected documents list.
File System - Opens the standard Microsoft Select File dialog box that allows you to
select documents to add to the Selected documents list. When you select a file in this
dialog box, you open the Document Properties dialog box, and you can 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.
Advanced - Opens the Advanced Publish Options dialog box, which allows you to
search for files that are of a specific type and that have been updated since they were
last published to TEF.
Remove - Removes the selected file or files from the Selected documents list.
Contract - If applicable, opens the Contract dialog box. This command is available
only if it is defined by your project implementation team.
Batch publish - Indicates that the system publishes the selected documents in batch
mode (that is, in the background). You are notified by e-mail when the operation is
complete. If this options is not selected, the documents begin to be published as soon
as you click OK.
Note
• You may select rows that are in white on this dialog box. Rows that are
gray are provided for viewing purposes only and cannot be selected.
Related Topics
• Find a Document to Publish, page 380
• Publish a Document to TEF, page 378
• Publish Command, page 375
Document type - Indicates the types of documents the software considers when
selecting the documents to publish.
Related Topics
• Find a Document to Publish, page 380
• Find Documents to Publish Command, page 379
• Publish a Document to TEF, page 378
• Publish Command, page 375
Selected file - Displays the name of the file that you selected on the Select File dialog
box.
New document - Indicates that this document has not been published to The
Engineering Framework (TEF) before.
Published previously - Indicates that the file has already been published to TEF at
lease once before.
Document type - Allows you to select the type of the document. The options that
appear in this list are determined by the selection you make in the Document
category box.
Document subtype - Lists the subtype of the document. If applicable, select one. The
options that appear in this list are determined by the selection you make in the
Document type box.
Name - Allows you to enter the name of the file as it is known in TEF.
Descriptions - Allows you to enter a brief description of the file. This description
appears later to help you recognize the file.
Note
• An asterisk * next to a box indicates that the information is mandatory.
Related Topics
• Find a Document to Publish, page 380
• Find Documents to Publish Command, page 379
• Publish a Document to TEF, page 378
• Publish Command, page 375
Opens the Find Documents to Publish dialog box, which helps you select the
documents that you want to write to The Engineering Framework (TEF) and specifies
those documents that have been published before, have never been published, and
need to be re-published. This list is specific to the authoring tool from which you used
the command.
Related Topics
• Find a Document to Publish, page 380
• Publish a Document to TEF, page 378
• Publishing to TEF: An Overview, page 373
• Working with The Engineering Framework: An Overview, page 371
Last search performed - Displays the date when the files were last searched. The
information that appears in the lists on this dialog box were found on this 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 name and type of the file and the date that it was last
published. If the file has not been published to TEF, the Last Published box for the
document displays the value New.
Select documents to terminate - Displays a list of all the files that were previously
published to TEF but were subsequently removed from the project. For each file, this
list displays the name and type of the file and the date that the document was last
published.
Select All - Selects all the files in the Select documents to publish list.
Clear All - Cancels the selection of all the files in the Select documents to publish
list.
Related Topics
• Find a Document to Publish, page 380
• Find Documents to Publish Command, page 379
• Publish a Document to TEF, page 378
• Publish Command, page 375
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 TEF: An Overview, page 373
• Working with The Engineering Framework: An Overview, page 371
Browser Command
Framework > Browser
Opens a web-based user interface that allows you to interact with SmartPlant
Foundation if the active plant is registered with The Engineering Framework (TEF).
From this interface, you can perform a number of tasks, such as browsing for
documents that have been published to TEF, using the SmartPlant Foundation To Do
List to complete tasks, comparing TEF documents with the data in your authoring
tool, and subscribing to documents in order to receive notification of changes to the
documents.
Related Topics
• Access the SmartPlant Foundation Web Client, page 381
• Working with The Engineering Framework: An Overview, page 371
Tip
• This command is available only if the active plant has been registered with
The Engineering Framework (TEF). For more information, see SmartPlant
Engineering Manager Help and Related Topics.
Note
• From the SmartPlant Foundation Web Client, you can perform a number
of tasks, such as publishing or retrieving documents, comparing
documents, subscribing to document changes, and so forth. Many of these
tasks can be performed from the authoring tools, such as SmartPlant P&ID
or SmartPlant Electrical, but the Web Client provides unique access to
other features such as the Web Client To Do List and search capabilities.
Related Topics
• Working with The Engineering Framework: An Overview, page 371
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
wizard that assists you in retrieving applicable documents, or with some authoring
tools, you can configure an automatic retrieval feature.
Additionally, you can access the Web Client through the Framework > Browser
command, and then you can select the document or documents that you want to
retrieve from your Web Client To Do List or the tree view, or you can find the
document that you want to retrieve using the Web Client search capability. After you
select the documents that you want to retrieve, you can use the Framework >
Retrieve command in the Web Client to start the retrieval process.
The Framework > Retrieve command in an authoring tool is slightly different from
the Retrieve command available in the SmartPlant Foundation Web Client. The Web
Client presents a list of documents that you can choose to retrieve. However, when
you use the command from an authoring tool, such as SmartPlant P&ID or
SmartPlant Electrical, without first selecting documents, the software searches the
SmartPlant Foundation project for documents to retrieve, and these are presented in a
list in the Retrieve dialog box.
Retrieval States
• As published - Retrieves only the data the authoring tool originally
published with the selected revision and version of the document.
• With the latest data - Retrieves the latest data associated with the
selected document in the SmartPlant Foundation database. That is, if
another more recently published document contains updates to objects in
the document that you selected, the software retrieves the most current
data in the SmartPlant Foundation database for those common objects.
SmartPlant P&ID
• PFDs
• Equipment Data Sheets
• Instrument Index documents
• Instrument I/O Assignment documents
• P&IDs
Zyqad
• PFDs
• Equipment Data Sheets
• Summary Sheet documents and data
• P&IDs
INtools
• P&IDs
• Instrument Index documents
SmartPlant 3D
• P&IDs
All Authoring Tools
From most authoring tools, you can retrieve Plant Breakdown Structure (PBS) and
Work Breakdown Structure (WBS) documents. The PBS and WBS, created in
SmartPlant Foundation and published to TEF, are retrieved by authoring tools in
order 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
associated applications.
The PBS contains information about the physical project with the following plant
hierarchy: plant-area-unit. The WBS contains information about the concepts of the
project in a plant-project-contract hierarchy. When an authoring tool retrieves it, the
WBS communicates project status.
Notes
• Retrieving the WBS and PBS into SmartPlant Engineering Manager
(SPEM) creates items in the SPEM To Do List. Create the appropriate
structures by running these tasks.
• When using SmartPlant 3D, you must create the PBS and WBS structures
manually. These documents cannot be retrieved into that application.
• When using INtools, you must create the plant-area-unit according to PBS
information in SmartPlant Foundation before you retrieve either the PBS
or the WBS. You must create at least one unit before you can retrieve any
documents from TEF.
Data Handling After Retrieval
The authoring tool that you use also determines how the software deals with changes
in downstream data when you retrieve a document.
In SmartPlant P&ID and INtools, the authoring tool analyzes the impact of the newly
retrieved data on the existing database, and then it places tasks that instruct you to
create, delete, or modify items at the appropriate time in the design process on the To
Do List. The To Do List gives you the opportunity to view and understand potential
changes before accepting, deleting, or modifying those changes.
Zyqad, on the other hand automatically overwrites the existing database information
when you retrieve data. You are not required to accept or reject changes in Zyqad.
In SmartPlant 3D, you can view the Piping and Instrumentation Diagram (P&ID) by
using the View > P&ID command, which pulls the data and correlates items.
Design Basis
Objects that tools retrieve from other authoring tools can become the design basis for
objects downstream in the design process. An object that becomes a design basis for
another object can be a specific object that gets richer as it moves through the
schematic or logical lifecycle of one application and evolves into a more detailed
object downstream. The design basis is implied and 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 the pump 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
• Open the To Do List, page 391
• Retrieve a Document from TEF, page 386
Retrieve Command
Framework > Retrieve
Opens the Retrieve dialog box, and provides a list of the files that can be retrieved by
the authoring tool (SmartPlant Electrical or SmartPlant P&ID, for instance). You can
select the documents that you want to retrieve and thereby bring in the information
from the The Engineering Framework (TEF).
Related Topics
• Retrieve a Document from TEF, page 386
• Retrieving from TEF: An Overview, page 382
• Working with The Engineering Framework: An Overview, page 371
Document type - Indicates the type of documents you can retrieve from TEF and
changes the list view so that it displays only that document type.
Show - Allows you to indicate whether you want to view a list of all of the latest
documents available or of only those documents that need to be retrieved from TEF.
Select All - Selects all the files in the Documents to retrieve list.
Clear All - Cancels the selection of documents in the Documents to retrieve list.
Batch retrieve - Indicates that the system retrieves the selected documents in batch
mode. You are notified by e-mail when the operation is complete. If this option is not
selected, the documents are retrieved as soon as you click OK.
Related Topics
• Retrieve a Document from TEF, page 386
• Retrieve Command, page 385
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 389
• Remove the Correlation Between Added and Design Basis Items, page 389
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 389
• Correlating Items: An Overview, page 387
• Remove the Correlation Between Added and Design Basis Items, page 389
• Working with The Engineering Framework: An Overview, page 371
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 389
• Correlate Command, page 387
• Remove the Correlation Between Added and Design Basis Items, page 389
• Working with The Engineering Framework: An Overview, page 371
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
• Add a New Manual Task to the To Do List, page 396
• Defer a Task on the To Do List, page 402
• Open a Drawing from the To Do List, page 394
• Remove a Task from the To Do List, page 402
• Run a Task from the To Do List, page 401
• Update the To Do List Display, page 405
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 390
• Working with The Engineering Framework: An Overview, page 371
Related Topics
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
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.
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 391
• To Do List Command, page 391
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.
Related Topics
• Open a Drawing from the To Do List, page 394
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
Zoom In Command
Framework > To Do List > 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.
Related Topics
• Open a Drawing from the To Do List, page 394
• Using the To Do List: An Overview, page 390
• View a Drawing Item from the To Do List, page 395
• Working with The Engineering Framework: An Overview, page 371
Displays the Task Properties dialog box, and allows you to manually create a new
task.
Related Topics
• Add a New Manual Task to the To Do List, page 396
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
Properties Command
Framework > To Do List > 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.
Related Topics
• Modify To Do List Task Properties, page 399
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
Related Topics
• Modify To Do List Task Properties, page 399
• Properties Command, page 28
Name - Provides a descriptive string that helps you identify the purpose of the task.
This value is not a unique identifier for the task.
Status - Indicates the level of completion of the task. The following choices are
available: Open, Completed , Deferred , and Error . When a task is created,
the status is set to Open, which does not have an identifying icon in the Task list on
the To Do List.
Notes - Allows you to enter freeform text about the task. You can also enter
hyperlinks to other documents for more extensive information. Information about the
execution of the task, such as the success of the procedure, is added to the end of any
existing notes for a task.
Related Topics
• Modify To Do List Task Properties, page 399
• Properties Command, page 28
Engineering Tool - Displays the name of the application that published the document
from which this task originated.
Document - Displays the name of the document from which this task originated (for
example, a Zyqad equipment data sheet or an INtools instrument index).
Item Tag - Displays the item tag of the drawing object from which this task
originated. For Update and Delete tasks, this box displays the item tag of an existing
item. For Create tasks, this box displays the item tag of the item to be created. This
information is read-only.
Drawing - For drawing-specific tasks, this box displays the name of the drawing to
which the task is assigned. This information cannot be directly edited on this tab, but
you can use the Assign Drawing command on the To Do List dialog box to change
this value.
Related Topics
• Modify To Do List Task Properties, page 399
• Properties Command, page 28
Created Date - Displays the date and time that the task was created.
Modified By - Displays the user name that last ran, modified, or deleted the task.
Modified Date - Displays the date and time that the task was last run, modified, or
deleted.
Run By - Displays the user name that last ran the task.
Run Date - Displays the date and time that the task was last run.
Deleted Date - Displays the date and time that the task was removed.
Related Topics
• Modify To Do List Task Properties, page 399
• Properties Command, page 28
Catalog item - Indicates the catalog item used to create the drawing item if the task is
run.
Item Properties - Shows the name of each item property and its new value. To
prevent a value from being used if the Create task is run, turn off the property by
selecting it in the list.
Related Topics
• Modify To Do List Task Properties, page 399
• Properties Command, page 28
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.
Related Topics
• Assign a Task to a Drawing, page 400
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
Clear - Removes the association between the selected task and a drawing.
Drawings - Lists all the drawings associated with the active plant. Select the drawing
that you want to associate with the task or tasks you selected on the To Do List
dialog box. When you select a drawing and click OK, the selected tasks are assigned
to that drawing.
Related Topics
• Assign a Task to a Drawing, page 400
• Assign Drawing Command, page 399
Related Topics
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
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.
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.
Related Topics
• Run a Task from the To Do List, page 401
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
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.
Related Topics
• Defer a Task on the To Do List, page 402
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
Related Topics
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
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.
Related Topics
• Remove a Task from the To Do List, page 402
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
Report Command
Framework > To Do List > 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.
Related Topics
• Run a To Do List Report, page 404
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
Refresh Command
Framework > To Do List > 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.
Related Topics
• Update the To Do List Display, page 405
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
Related Topics
• Using the To Do List: An Overview, page 390
• Working with The Engineering Framework: An Overview, page 371
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 407.
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 408.
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 409.
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 412.
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, page 413.
Related Topics
• Comparing Code Lists and Select Lists, page 407
• Comparing Consistency Check to Propagation, page 410
• Grouping Equipment in SmartPlant P&ID, page 408
• Setting Construction Status, page 409
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 87
Related Topics
• Place Equipment, page 153
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 21
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
• Reapply Placement Rules to Resolve an Inconsistency, page 322
• Resolve an Inconsistency, page 319
• Review an Inconsistency, page 317
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 184
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 example, you can
combine a filter that displays 6-inch pipe with a filter that displays tanks more than 5
feet in diameter. Then, both 6-inch pipe and tanks over 5 feet in diameter are
displayed.
• Project filters
• Personal filters
Project filters are stored in Project Folders, and personal filters are stored in My
Folders. The plant administrator defines project filters, while each individual user
defines personal filters. You can use filters along with rules to check for errors in
certain filtered views. SmartPlant P&ID offers extensive flexibility in creating and
editing filters. You can even edit the individual properties of the filters.
For more information about creating and editing filters, see SmartPlant Filter
Manager Help.
Related Topics
• Customize a Filter Tab for the Drawing View, page 138
Glossary
A
absolute path name
Sequence of directories, beginning with the node name, that locates a file, for
example, \\MyPC\C:\temp\MyFile.txt.
access
Performing actions that are required to use the SmartPlant P&ID software.
alphanumeric
Information in the form of letter, numbers, and some special character and
punctuation marks.
angle
Circular measurement of the intersection of two lines in degrees. You measure angles
in a clockwise or counterclockwise direction.
angle bisector
A line that divides an angle into two equal parts.
angle key-in
A number that you type to specify an active angle.
annotations
Dimensions, notes, symbols, or reports that you place in a drawing to provide
information or comments.
append
To add to the end of a file, a file name, text string, and so forth.
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.
axis
An imaginary line that defines the orientation of a system or item. Most orientations
use an x-, y-, and z-axis.
B
batch
A group of jobs to process on a computer at one time with the same program without
user intervention.
bearing
The acute horizontal angle of a line with respect to a reference line.
Bill of Materials
A detailed list of the items that you assemble.
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
A secure place of storage.
catalog
A collection of catalog items, which are blueprints or templates for creating an item
within the model.
category
A grouping of items by description. A classification of items that share common
values for specified properties. A set of filters can define the potential membership in
a category.
centerline
Graphic representation of the central axis of an item.
character
Data type that stores alphanumeric character data.
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
In network operations, a node that accesses data or performs a function on the remote
resource, usually a server. 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.
collection
An indexed group, or select list, that contains similar items.
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.
concatenate
To connect in a series; to link or append.
concentric
Having a common center or origin point with varying radii.
configuration
Relative arrangement of parts or items.
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.
context-sensitive help
Display of help topics that are associated with a dialog box or command. For
example, you can press F1 to learn about a dialog box.
coordinate
Location of a point along the x-, y-, or z-axis.
coordinate system
Geometric relation that denotes the location of points in the design cube. The most
common coordinate system is the rectangular coordinate system; points are located by
traversing the x-, y-, and z-axes. Normally, the origin of coordinate systems is 0,0,0.
Other coordinate systems more easily express the coordinates of specific geometric
entries. For example, you can use a spherical coordinate system to define points on a
sphere, or use a cylindrical coordinate system to define points on a cylinder.
coordinates
Ordered set of absolute or relative data values that specify a location in a coordinate
system.
cursor
See pointer.
D
data
Facts or raw material that you add, change, or delete.
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 table
Part of the database consisting of rows and columns and containing information about
the project and design elements.
default
Predetermined value of a parameter that the system or a program automatically
supplies whenever the user does not specify a value.
delimiter
A separating mark or space; a character or sequence of contiguous characters that
mark the end of a string of characters.
design database
Database that contains the non-graphical data for the equipment and piping models.
design file
File containing graphics and text data, also called a drawing file.
design session
Elapsed time from when you open a design file until you close the design 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.
device
Non-addressable component of a network; examples of devices are a tape drive, disk
drive, or floppy disk.
diameter
A straight line passing through the origin of an arc or circle, ending at the points of
intersection with that arc or circle.
digits of accuracy
Number of digits used after a decimal point to display the discharge dimensions.
directional
Referring to items that depend on their orientations to directional flow for correct
placement in a drawing; directional items use the direction of the line in which you
located them.
directory
File or folder that stores the names of other files.
display-only annotation
Feature that allows you to generate temporary annotation graphics for review without
placing the graphics in a design file.
dithering
Technique for achieving greater color resolution at the expense of spatial resolution.
More colors are produced with loss of some detail.
diversity
Amount of deviation in airflow that a system encounters from the design conditions.
drag
To use the software functionality that attaches the pointer to an item so you can see
the item move in dynamics.
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.
drawing view
Specific, scaled view produced from the model graphics. You can consider a drawing
view like a window into a specified volume in the model.
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.
endpoint
Data point that defines the end of a linear element.
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.
event
A status milestone that tracks the history of an item. Examples of events are creation,
name change, and assignment to unit.
exit elevation
Lowest downstream elevation point on the internal diameter of a pipe.
F
fences
Temporary method of locating and grouping items that you need to change.
field
Interface component of a dialog box that displays information to you or allows you to
type data to record.
file
Collection of logical records stored as a unit.
file name
Name that a user defines for an interactively created file. For easier identification, the
name should relate to the contents of the file.
file specification
Path name that instructs the software for the location of a file.
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.
font
Complete set and style of the characters and symbols of a typeface used for
displaying text that you place in a drawing file.
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.
grid
Network of uniformly spaced horizontal and perpendicular lines that help to identify
either 2-D or 3-D relationships.
group
Set of components with physical boundaries and a single name - that is, a group
number.
H
handles
Graphical indications that appear when you perform a valid change to an item.
header
First items of information in a file that precede any actual data. The header contains
information on the structure and contents of the file.
height property
Distance between the base offset and the top of the item. This property provides a
method to represent a 3-D model when working in a 2-D drawing.
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
Parallel to, in the plane of, or operating in a plane parallel to the horizon or to a base
line.
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.
horizontal scale
A scaling factor that exaggerates the horizontal scale as you draw graphics.
I
icon
A pictorial representation or image; a symbol that graphically identifies a command
or task.
import
Process that transports or transfers data from one environment to another.
import script
File that the software uses to import or transfer data.
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.
input
The data submitted to a computer for processing.
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.
integer
A whole number with no fractional part.
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.
J
justification
Point of orientation for text placement.
K
key
Property or column in a table that is the access vehicle to individual rows of the table.
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.
layer
A logical grouping of items on a drawing sheet. You can have several layers in a
drawing sheet.
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 string
A series of connected line segments.
line style
Collection of formats or properties that you name and store as a group to apply as a
style of a line.
line width
Thickness of a displayed item.
linear
Having a single dimension; a line.
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.
makeup air
Air brought into a space from the outside to replace exhausted air.
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.
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.
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
occurrence
A row within a relational database table.
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.
operator
The part of the Structured Query Language (SQL) syntax that defines relationships
between data. Examples are equal to and greater than.
Oracle
A relational database management system.
orientation
Position of items in the design plane relative to the origin. See also orientation by
system, orientation by user, and orientation fixed.
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.
origin
In coordinate geometry, the point where the x-, y-, and z-axes intersect.
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.
pointer
On-screen tool that allows you to indicate an item or area.
position angle
Defines the angle between the horizontal axis, as drawn through the anchor point, and
the rotate handle.
primitive commands
The most basic graphic command such as placing a line or placing a circle.
primitive items
An item, such as a line or circle, that you place by a primitive command.
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.
R
RAD 2D Draft Platform
2D graphic platform developed from the product core functionality of SmartSketch.
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.
rotate handle
Turns a selected item around its anchor point. Point to the manipulation handle on
either side of an item to display the rotate handle.
rotation angle
Defines the angle of change between the old and new positions of a rotated element.
row
A unit of related information in a table; one collection of column values for a table.
rubberbanding
Animation dynamic that allows you to specify the position of a data point while the
item changes as you move the pointer.
rule
Standard mechanism for creating relationships. A rule defines a valid context for two
items to communicate their behavior or state.
S
scale
To enlarge or reduce the size of a defined item, modifying only the dimensions but
not the ratio among the pieces.
Scale Handle
Changes the size of a selected drawing item. Point to the manipulation handle on any
corner of the item to display the scale handle.
schema
Description of the overall structure of the 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 set
A group of more than one drawing item.
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.
slider
Interface component of a dialog box that displays values along a range.
source file
Uncompiled version of a parametric definition or other data table. Usually, text
libraries contain source files. See also neutral file.
specific energy
Depth of flow plus velocity head.
step angle
Specifies the increment of rotation for a selected item, relative to the anchor point of
the item. A value of 0 degrees allows free rotation. The default Step Angle is 0
degrees.
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.
surface of revolution
Surface formed by the revolution of a curve about an axis in its plane.
symbol, graphic
Permanent association of items that you can store and place as a group but cannot
manipulate as individual items.
symbol name
Descriptive phrase that names a symbol that resides in a folder.
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.
tabular data
Non-graphic, alphanumeric information.
task
Grouping of related design activities.
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
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.
utility
Program that provides a commonly used service.
V
validation program
User program that verifies data integrity in the database.
values
Data stored in a property; either you can enter this data or the software determines the
value.
variable
Quantity that can assume any one of a set of values.
vector
A quantity that has both magnitude and direction, generally represented as a line. You
can manipulate vectors geometrically. A coordinate triple (x, y, z) represents a vector.
vertical
Located at a right angle to the plane of a supporting surface.
vertical angle
Angle above or below a horizontal plane through the line of sight. The format that
you type for vertical angles is the occupied point, the foresight point, and the
measured angle.
vertical scale
Scaling factor that exaggerates the vertical scale of graphics when you draw; also
called Z scale or Z factor.
view
Defined area of vision on a screen or window. The visual contents of a window
displaying an aspect of the application model.
W
width
Line thickness of a displayed item.
window
A control in the software that is the physical outline that contains a view.
witness lines
Dimensioning items that extend from the dimension points to the dimension line.
work area
Individual parts of a single process function that, when considered as a whole,
constitute a unit.
work session
All operations performed in the period between opening and closing a database
partition of the task. A work session is not limited to worth in the drawing file.
workflow
Method of selecting processes and performing tasks.
working units
Real-world units that you can group into the design plane. For example, working
units can be defined in terms of feet and inches.
Index
AABBCC codes warnings, 317
assigning, 169 area breaks
access claiming, 297
control, 105 multi-sided, 212
accessing rectangular, 212
Help, 12 arranging
recent drawings, 111 windows, 36
Web Client, 381 Aspen Zyqad
activating importing, 262, 267, 323, 329
symbol toolbars, 76 assemblies
actuators creating, 286
aligning, 242 explained, 141
adding placing, 287
buttons, 28, 80 saving, 284, 285
catalog items, 66, 70 assigning
commands, 94, 95 insulation specifications, 260, 261
filter tabs, 131 piping specifications, 169, 171, 172, 173
filters, 131, 132, 133, 237 tasks to drawings, 399, 400
instruments, 175, 178, 179 associating
insulation specifications, 260, 261 plant groups, 88
item tags, 175 attaching
items, 280 commands, 94, 95
lines, 161 items, 247, 280
menus, 96 objects, 277
pipe runs, 161 shortcut buttons, 80
piping specifications, 169, 171, 172, 173 author
reports, 343 documents, 113
shortcut buttons, 80 AutoCAD
stockpile items, 67, 265, 267, 329 exporting, 126
tasks, 395, 396 OLE objects, 281
toolbars, 27 Save As, 125
affixing autofilter
labels, 182, 184 Engineering Data Editor, 60
aligning tabular views, 61
labels, 189 AutoFilter
alter customizing, 64
segment, 158 options, 60
Alter Segment autogapping
routing lines, 159 activate, 269
altering lines, 269
segment, 162 using, 270
alternate automation
symbology, 138, 140 item tag formats, 208
anchor point axes
rotating, 238 mirror, 241, 242
annotations backgrounds
labels, 210 customizing, 18
placing, 211 borders
applying displaying, 30
rules, 321, 322 embedding, 121, 122
approved linking, 102, 122
warnings, 313, 316, 319 sizes, 119
approving bounding box
elsewhere, 69 catalogs, 69
exporting documents to publish, 373, 375, 376, 377, 378,
drawings, 126 379, 380
objects, 281 drawing items, 225, 226, 227, 228, 229, 234, 237
stockpile items, 267, 329 inconsistencies, 226, 234
fabrication replacing, 225, 228, 229, 230, 231, 234, 235
categories, 173 fitting
fabrication categories views, 24, 25
assigning, 172 fixed
relationships, 169 format, 340
fields flow
reports, 352 arrows, 186, 191, 194, 197
files, 377 connectors, 201
checking paths, 283 fluids
manipulating, 273 code values, 215
opening, 104 fonts
publishing to TEF, 373, 375, 376, 377, 378, 379, printing, 361
380 formats
retrieving, 382, 385, 386 fixed, 340, 341
Files tab report templates, 340, 343, 346
Options dialog box, 17 reports, 338, 341
report templates, 335 Foundation
reports, 21 SmartPlant, 381
Filter Framework
tab, 47 accessing Web, 381
Filter Manager adding tasks, 395
Add Filter command, 131 assigning tasks, 400
Filter tab Browser, 381
customize, 138 correlating items, 387, 389
Paste, 139 correlations, 389
Properties, 29 creating properties, 398
filtering, 131 creating tasks, 396
Design window, 131 deferring tasks, 402
displays, 131 deleting tasks, 403
tabular views, 60 modifying properties, 396, 397
filters opening drawings, 394
autofilter, 60, 61 properties, 396, 397, 398
compound, 135, 137 publishing, 373, 375, 376, 377, 378, 379, 380
creating, 131, 132, 136, 137, 237 refresh, 404
customizing, 64, 91 refreshing, 405
defining, 15 reporting, 403, 404
definition, 413 Retrieve command, 385
display, 130 retrieving documents, 382, 386
drawings, 29, 110, 138, 139, 140 retrieving files, 385
finding items, 226, 230 running a task, 400
new, 136 To Do List, 390, 391, 392, 394, 395, 399, 401, 402
properties, 133, 136, 138, 258 using, 371
reports, 352, 354, 356 zooming, 394
rules, 130 freezing
setting, 22 panes, 64
stockpile, 130 from and to data
tab, 131, 132 reports, 357
tables, 46, 47, 51, 52, 54 gapping
tabular views, 64 AutoGap, 269
finding Gap Now, 270
catalog items, 68, 69, 70 lines, 269
colors, 18 pasting
construction status, 409 bulk properties, 88, 89
setting, 17 files, 273
Options items, 246, 247, 253, 280
dialog box, 17 objects, 277, 278, 280
Options Manager properties, 43
connectors, 202 special, 280
Cut command, 246 paths
default units, 114 checking, 283
deleting items, 250 linking files, 273
line settings, 272 PDS 2D
overview, 11 cells, 412
removing items, 245 comparing to SmartPlant, 406
report templates, 333 construction status, 409
symbology, 271 equipment groups, 408
symbology changes, 272 errors, 313
update symbology, 271 solving inconsistencies, 410
organizing using filters, 413
tasks, 391 PickQuick
orientations configuration tool, 146
drawings, 121 placement, 175
Page Setup, 369 placing items, 149
printing, 370 selecting items, 147, 148
orphan items pipe runs
deleting, 98 inline components and validation, 175
overview item tag, 268
SmartPlant P&ID, 10 joining, 166
overviews selecting, 254, 255
creating a drawing, 141 PipeSpec
database, 141 assigning, 172, 173
design window, 15 selecting, 171
drawings, 102 using, 169
filters, 130 piping
labels, 181 branches, 162
reports, 331 breaking runs, 165
P2C2 components, 167
Web forum, 13 inserting vertices, 161
packages joining, 166
creating, 213 properties, 159, 165, 166
stockpile, 77, 265 routing, 156, 160
page setups runs, 158, 159, 162, 167, 256
changing, 368 selecting runs, 256
layouts, 369 specifications, 169, 171, 172, 173
Page Setup, 369 Placement tab
printing, 363, 365, 370 Options dialog box, 17
templates, 122 placements
panes construction status, 409
freezing, 62 labels, 181
panning one-point, 182, 184, 186
views, 25 tolerances, 19
parametric two-point, 182, 188
handles, 238 placing
parametrics annotations, 211
resizing, 215, 239 area breaks, 212
parent assemblies, 284, 287
representations, 42, 154 catalog items, 66
grids, 31 removing
inconsistencies, 315, 319 assembly items, 284
instruments, 175, 259, 262 buttons, 80
labels, 198, 199 catalog items, 74, 75
lines, 159, 165, 166, 221 catalog nodes, 74
notes, 261 commands, 28, 94, 95
nulls, 89 correlations, 389
OPCs, 201, 203 inline components, 251
pasting, 43 instruments, 180
pipe runs, 159, 165, 166, 220, 221 items, 215, 245, 246, 248, 249, 250, 251
piping components, 167 OPCs, 248
printers, 368 report templates, 350
relationship, 83 shortcut buttons, 81
report templates, 346, 350 stockpile items, 42
table, 35, 46, 51, 88, 90 tasks, 402, 403
tasks, 396, 397, 398, 399 views, 57
validating, 299 renaming
views, 28, 29, 151 catalog items, 68, 75, 76
Properties catalog nodes, 68, 75
window, 14, 89 drawings, 102
proxy Replace Mode
server, 141 catalog items, 232
publishing replacing
documents, 373, 375, 376, 377, 378, 379, 380 and claiming, 293
files, 373, 375, 376, 377, 378, 379, 380 items, 225, 228, 229, 230, 231, 232, 233, 234, 235,
to TEF, 373, 375, 376, 377, 378, 379, 380 237
queries mode, 233
Engineering Data Editor, 40 report templates
quitting contents, 354
Catalog Explorer, 68, 76 deleting, 350
SmartPlant P&ID, 118 editing, 346
reapplying formats, 340
rules, 321 headers, 358
recreating including select lists, 354
drawings, 98, 99, 100, 127, 129 options, 358
reflecting spacings, 358
items, 240 reporting
refresh contents, 333
Compare and Refresh dialog, 306 creating, 333
example, 310 importing items, 268
To Do List, 404 lengths, 333
version, 310 to do list, 403, 404
views, 58 reports
refreshing, 305 changing templates, 345
drawings, 305 composite, 341
tabular views, 58 contents, 335, 352
To Do List, 405 creating, 331, 334, 335, 341
versions, 305 creating templates, 343, 344, 354, 356
registering defining contents, 337
projects, 371 defining items, 354, 357
with SmartPlant Foundation, 371 defining layouts, 337, 340, 341
relationships defining template layouts, 338, 341
using, 83 deleting templates, 350, 351
releasing displaying, 331
claims, 43 editing, 345
releasing claims, 44, 45, 292, 300, 301, 302, 303 editing items, 354
temperature displaying, 26
maximum, 169 project specific, 71
templates Properties window, 83, 84
creating, 120 reports, 351, 352, 353, 354, 359, 360
creating for drawing, 102 symbol, 71, 76
drawings, 119, 121, 122 To Do List, 392
included sizes, 119 user specific, 71
reports, 130, 338, 340, 341, 343, 344, 345, 346, tools
348, 349, 350 Customize, 96
saving, 125 customizing, 17, 21
sizes, 121, 122, 369, 370 gapping, 270
terminators General tab, 17
types of, 200 PickQuick, 146
testing reports, 21
databases, 143 Select Tool, 254
tiling tree
windows, 36 views, 65
title two-point
blocks, 191 placement, 182
title blocks two-point placement
labels, 197 labels, 184, 187, 188, 195
placing, 194 undoing
to and from data actions, 216
reports, 357 assemblies, 285
to do list changes, 217
tasks, 390 units
To Do List for a drawing, 112
adding tasks, 395 precision, 114
assign drawing, 399 To Do List, 390
assigning tasks, 400 updating
creating properties, 398 drawings, 214
creating tasks, 396 items, 267, 329
deferring items, 401 label settings, 190
deferring tasks, 402 line settings, 271, 272
deleted tasks, 403 links, 281
dialog box, 391, 392 properties, 329
how to, 394 symbol toolbars, 76
modifying properties, 396, 397 symbology, 271, 272
opening, 391 tabular views, 58
opening drawings, 394 to do list, 404, 405
properties, 397, 398, 399 user
refresh, 404 access, 105
remove a task, 402 user's guides
removing tasks, 402 printable, 12
reporting, 403, 404 utility
running a task, 400 connectors, 20, 202, 204
updating, 405 validation
zooming, 394, 395 item tags, 208
tolerances piperun and inline components, 175
placement, 19 values
pointer, 19 dates, 134
toolbars short, 169
adding buttons, 28 version
creating, 27, 92 numbers, 13
customizing, 26, 27, 28, 91, 92, 93, 94, 95 versions
default, 28 compare, 310