Академический Документы
Профессиональный Документы
Культура Документы
User's Guide
March 2015
DPID2-PE-200029C
Copyright
Copyright © 2012-2015 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
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 from Intergraph Corporation.
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN,
Sapphire, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph
Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of
Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are
trademarks of their respective owners.
Additional Documentation
SmartPlant P&ID Engineering Help Command (Help Menu)
Opens the Help viewer where you can read topics about commands, procedures, dialog boxes,
and so forth.
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. For more information, see Working with the Design Window.
Catalog Explorer
The Catalog Explorer displays all available catalog items. 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. For more information, see Using Catalog Explorer (on page 59).
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. For more
information, see Working with the Properties Window (on page 69).
See Also
Add an Item to the Stockpile from Catalog Explorer (on page 61)
Navigate the Catalog Explorer Tree View (on page 60)
Miscellaneous shortcuts
To Press
By using commands on the Window menu, you can cascade or tile views to more easily
navigate among them.
(A) Drawing view — A graphical representation of the plant model. This view displays the
common idea of a model: a diagram containing items such as equipment, piping, and
instrumentation.
(B) Engineering Data Editor — A tabular view that presents the plant data in a tabular
format. For more information, see Navigating in the Engineering Data Editor (on page 35).
(C) Properties window — A list of properties shown for a selected item or a select set of
multiple items.
SmartPlant P&ID provides multiple views of a central, unified data structure that represents the
plant model. A view is a visual presentation of the data that composes the plant model and can
be a schematic drawing or a table. The plant model is the computer representation of the
conceptual design in its entirety, including all plant components and their relationships. By
manipulating model views, you can organize the information within the plant model to better
understand and maintain the data.
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 and save). Occasionally, the software can end in an
abnormal way (for example, due to power outage). As a result, the database is updated 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, refer to the Properties Glossary.
See Also
Define a New Engineering Data Editor View (on page 55)
Define a New Filter for an Engineering Data Editor View (on page 55)
Define a New Layout for the Engineering Data Editor (on page 56)
Open a New Drawing View (on page 34)
Open an Existing Drawing (on page 89)
Show Command
Available on the Drawing View shortcut menu, the Show command allows you to choose to
display drawing elements such as notes, labels and grids.
General Tab
Used to set options for updating links in the drawing and displaying the drawing, the status bar,
and recently used files.
Update links automatically at open — Updates links automatically when a drawing is opened.
For more information about linking, see Related Topics.
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, the status bar displays prompts that explain what to do at each step of the
command, as well as messages about the operations the software is performing.
Colors Tab
Allows you to select options for the background, highlight, selection, and handle colors in the
drawing.
Background — Sets the default background color for all Drawing views in the active drawing.
Highlight — Sets the highlight color.
Selected items — Sets the color of selected items. The connect points in the drawing appear in
this color, too.
Handles — Sets the color of handles when an item is selected.
Use Defaults — Sets all the colors listed above to the default display value.
Placement Tab
Used to set the default construction status for the active drawing, and tolerances for locating
items in the drawing.
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.
For SmartPlant P&ID Engineering, the settings for this option only apply to new items
sent to the stockpile.
Locate — Specifies the range, called the locate zone, at which a candidate item is highlighted
when another item approaches. If you are selecting drawing items, the locate tolerance defines
how close 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 SmartPlant P&ID Engineering, placement is not allowed; therefore the settings for
this option do not affect the software behavior.
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.
For SmartPlant P&ID Engineering, placement is not allowed; therefore the settings for
this option do not affect the software behavior.
Files Tab
Used to set the location for storing report templates.
Scale reference files — Sets a scale option for importing a drawing.
For SmartPlant P&ID Engineering, placement is not allowed; therefore the settings for
this option do not affect the software behavior.
Coincident (1:1) — Imports a reference file, also known as an inserted object, at full scale (1:1).
For SmartPlant P&ID Engineering, placement is not allowed; therefore the settings for
this option do not affect the software behavior.
Select Scale — Sets the drawing scale to a standard ratio.
For SmartPlant P&ID Engineering, placement is not allowed; therefore the settings for
this option do not affect the software behavior.
Custom Scale — Sets the scale for a drawing that you insert.
For SmartPlant P&ID Engineering, placement is not allowed; therefore the settings for
this option do not affect the software behavior.
My Reports — Specifies the folder where your user-defined, or personal, report templates are
stored.
Browse — Opens the Browse dialog box, which allows you to select a local or network folder to
store your user-defined report templates (My Reports).
View Menu
Topics
Previous Command (View Menu) .................................................. 25
Zoom Area Command ................................................................... 25
Zoom In Command ........................................................................ 26
Zoom Out Command ..................................................................... 26
Fit Command (View Menu) ............................................................ 27
Pan Command (View Menu).......................................................... 27
Display Command (View Menu) .................................................... 28
Toolbars Command (View Menu) .................................................. 28
Properties Command (View Menu)................................................ 29
To stop repainting items in the window, press ESC. This action is convenient for large
drawings.
To refresh the window, press F5.
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.
Zoom In on an Area
1. On the main toolbar, click Zoom Area .
2. On the Drawing view, use the pointer to fence the area on which you want to zoom. The
selection fills the view.
Zoom In Command
Enlarges the display of items around a specified point in the active window. This command is
available only when a Drawing view is active.
Zoom In
Reduces the display of items around a specified point in the active window. This command is
available only when a Drawing view is active.
Zoom Out
1. On the main toolbar, click Zoom Out .
2. Click the Drawing view at the center of the area from which you want to zoom.
To go back to the previous view, click View > Previous or ALT + F5.
To stop repainting 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.
See Also
Zoom Area Command (on page 25)
Zoom Out Command (on page 26)
Zoom In Command (on page 26)
Fits all items in the active view if no items are currently selected. However, if any items are
selected in the drawing or if you select a row in the Engineering Data Editor representing an
item, 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.
If no selection is defined, you can right-click to access Fit from the shortcut menu.
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.
You can also click and drag the hand pointer to pan the view.
To go back to the previous view, click View > Previous.
To stop repainting items in the window, press ESC. This action is convenient for large
drawings.
To refresh the window, press F5.
To cancel the command, press ESC or right-click in the Drawing view.
General Tab
Displays miscellaneous information about a Drawing view, including the name, description, and
view type.
View name — Allows you to name the Drawing view.
Description — Allows you to enter a description of the Drawing view.
View type — Displays the type of view. This information is read-only.
Display Tab
Controls the display of items in a Drawing view. Items that you can display include labels,
drawing borders, grids, notes, and inconsistency indicators. When you select the check box, the
display toggles on for that item.
Do not show labels for filtered items — Select this option to prevent the display of labels
when a display set definition hides model items for which the labels apply. Clearing this check
box results in the label displaying also when the model item is hidden.
This option is available only when the Labels check box is selected.
This option only behaves as described above when, for the filter definition on the Filter
Properties dialog box, the Filter for value is equal to Label: Model Item. If the Filter for
value is equal to Label: Catalog Item, the behavior of each label follows the filter setting for
the model item, including displaying and hiding, regardless of the setting for this option.
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 for filtered items option is not available since all labels
are no longer displayed regardless of the view tab that you are using.
Drawing borders — Toggles the display of the drawing border on or off.
Grids — Turns the grid display on or off.
Notes — Turns the display of notes on or off. Notes can contain links to a file, for example, a
Microsoft Word file. Also, Auxiliary Graphics are turned on and off with notes.
Inconsistency indicators — Turns the display of inconsistency indicators on or off.
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.
Prevent selection of inserted objects — Makes inserted foreign data non-locatable in a
drawing. Inserted data appears gray in the drawing.
For SmartPlant P&ID Engineering, this option is selected by default and cannot be
changed.
Retain Auxiliary Graphics colors — This option is available only if Prevent selection of
inserted objects is selected. If the drawing includes Auxiliary Graphics, selecting this option
displays the Auxiliary Graphics in their original colors and when printing the drawing, prints them
in those colors. Choosing this option has no effect on other inserted objects. When this check
box is cleared, Auxiliary Graphics appear as gray in the drawing and when printed.
Grid Tab
Controls the behavior of the grid in the view.
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.
Show grid — Turns the grid display on or off.
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.
Claims Tab
Sets options for the display of items in the Drawing view according to their claim states. This tab
is part of the View Properties dialog box, which appears when you click View > Properties.
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.
See Also
Claim a Drawing Item (on page 194)
Window Menu
Topics
New Command (Window Menu) .................................................... 34
Cascade Command ....................................................................... 35
Tile Horizontally Command (Window Menu) ................................. 35
Tile Vertically Command (Window Menu) ..................................... 35
Active Window List ......................................................................... 35
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.
You can have as many Drawing views open for a drawing as needed.
Drawing views are named according to the name of the drawing file. For example, the first
drawing view created for the Pipeline.pid file is named Pipeline.pid:1. Each subsequent
drawing view is assigned the next consecutive number.
If the software gives indications that a drawing is in use when it is not, quit all SmartPlant
applications, and then open the Windows Task Manager. In Task Manager, search for an
extra draft.exe process. Select it and click End Task. For more information on the Windows
Task Manager, see Microsoft Windows Help.
Cascade Command
Overlaps windows diagonally across in the Design window.
Actions — Includes commands that allow you to delete stockpile items or move items
between stockpiles.
Edit — Includes commands that allow you to copy and paste data and to claim items or
release claimed items.
View — Includes commands that allow you to edit, save, or delete Engineering Data
Editor views, to filter or refresh the display, to generate reports, and to specify display
settings for the views.
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 Engineering Data Editor. 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 (by default, initially only the Active Drawing and Active Drawing Stockpile buttons
are selected):
Active Drawing — Displays properties of the items that belong to the drawing you are
currently viewing. This includes properties of implied items, which do not appear on the
drawing sheet.
Active Drawing Stockpile — Displays items existing in the data model that have not
been placed in the graphic drawing.
Stockpile — Displays items for the plant existing in the data model that have not been
placed in the graphic drawing.
Other Drawings — Displays properties of the items that appear in all drawings in the
plant other than the active drawing, including items in the stockpiles of other drawings.
The Asking Filter button displays the Filter tab of the Asking Filter dialog box, from which
you can quickly filter the Engineering Data Editor display by selecting a base filter and
properties appropriate for the selected item type. You can re-query and thereby refresh the
Engineering Data Editor 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.
In the Engineering Data Editor, it is possible to display a maximum of 350,000 cells. If
your database query results in more than this number, the Query Results dialog box opens.
You can then choose to refine your query in order to generate fewer items or to enter report-only
mode and run a report on your query results.
5. Specify a special background color for read/write properties, too, if you want.
You can also customize the Engineering Data Editor by using the AutoFilter feature. For
more information, see Use AutoFilter in the Engineering Data Editor (on page 38)
You can use the Freeze Panes feature, too. To do so, follow these steps:
a. To freeze the top horizontal pane, select the row below where you want the split to
appear. To freeze the left vertical pane, select the column to the right of where you want
the split to appear. To freeze both the upper and left panes, click the cell below and to
the right of where you want the split to appear.
b. Click View > Freeze Panes on the Engineering Data Editor toolbar.
c. Click View > Edit View on the Engineering Data Editor toolbar to totally redefine the
content and layout of the Engineering Data Editor. For more information, see Modify
the Properties of an Existing Engineering Data Editor View (on page 57).
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).
For columns with units of measure, the values are sorted in ascending numeric order
regardless of the units, for example: 2.000 in, 3.0 cm, 3.5 mm, 4.0 in. Where several identical
numeric values exist with the same units of measure, the values are sorted in ascending order
according to the number of decimal places, for example: 2.0 in, 2.000 in; if the values are
identical but have different units of measure, they are sorted in ascending alphabetical order of
the units (with symbols preceding letters of the alphabet), for example: 3.0", 3.0 cm, 3.0 in, 3.0
mil, 3.0 mm. All other data values are sorted alphabetically.
To create more elaborate filters and displays, you need to use the Edit View command and
enter options on the Edit View dialog box and the Advanced View Properties dialog box.
Select this command again to deactivate it.
measure, they are sorted in ascending alphabetical order of the units (with symbols preceding
letters of the alphabet), for example: 3.0", 3.0 cm, 3.0 in, 3.0 mil, 3.0 mm. All other data values
are sorted alphabetically.
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.
You can then generate a report based on the AutoFilter results. The AutoFilter is honored for the
report until another item type is selected in the list or the AutoFilter is turned off.
Color — Allows you to specify either the font color 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.
Plant Group Name property is not assigned for an item, the software removes the Plant
Group Type value as follows:
Active drawing:
Whether the change is made in the Properties window or in the Engineering Data
Editor, the Plant Group Type value is not removed while in the same drawing session.
Refreshing the Engineering Data Editor does not remove the Plant Group Type
value. Only closing the drawing removes the Plant Group Type value.
Non-active drawing:
Refreshing the Engineering Data Editor removes the Plant Group Type value.
When copying and pasting data between cells in the Engineering Data Editor where
one property is dependent upon another, the higher dependent (parent) property must be
located in a column to the left of the dependency (child) property in the layout. For
example, if copying both Fluid System and Fluid Code property values from one row to
one or more other rows in the Engineering Data Editor, Fluid System must be located to
the left of Fluid Code in the layout. Likewise, if copying Plant Group Type and Plant
Group Name properties, Plant Group Type must be located to the left of Plant Group
Name in the layout.
2. On the Edit View dialog box, define the items that you want to see in the Engineering Data
Editor. You can customize a filter and layout for the display on the Advanced View
Properties dialog box. For more details, see Modify the Properties of an Existing
Engineering Data Editor View (on page 57).
The software identifies read-only properties in the Engineering Data Editor visually by
using the display options that you set using the Display Settings command. For details of how
to configure the display settings, see Customize the Display of the Engineering Data Editor (on
page 36).
2. Ensure that Active Drawing is selected to display properties of the items that appear in
the drawing you are currently viewing.
You can also display or hide stockpile items by toggling the Active Drawing Stockpile
and Stockpile commands.
3. Edit the data in the field in accordance with the type of data by doing one of the following:
For text, select the field and just type the desired value.
For a list of values (or equivalent quantitative values with different units of measure),
double-click the field and select the desired value from the drop-down list that becomes
available.
For a field with a calculation command (ellipsis), double-click the field and then click the
ellipsis to open a dialog box.
You can copy the contents of cells to other cells if the cell contents are compatible.
If the cell is populated by a read-only property or a property that is only automatically
generated by validation, you cannot edit that cell. Read-only and editable properties are
indicated by the column background colors as specified on the Display Settings dialog box.
If an Engineering Data Editor view includes several item types (such as the Equipment,
Instrument, or Plant Item view) where certain properties do not apply to a particular item
type, those properties do not have values and are shown as read-only. In the example
below, the End 1 Flow Direction and End 1 Nominal Diameter properties only apply to the
control valve, while the Sig Point 1 Usage property only applies to the single solenoid and
DCS function instrument types.
For properties of active drawing items, you can edit in the Engineering Data Editor or in
the Properties window. In the Engineering Data Editor, if you click the icon in the
left-most column of the table, the entire row is selected and the item's properties are
displayed in the Properties window.
If you change a property value of an active drawing item in the Engineering Data Editor
and this causes other properties in the active drawing to be updated because System
Editing or validation is activated, the software automatically updates the Engineering Data
Editor display.
If a property value in the Engineering Data Editor is changed by the user or as a result of
an automatic update and this property is used for sorting, the software does not update the
sort order of the data automatically if the values are no longer in the correct order. To
update the sort order, the user must refresh the Engineering Data Editor display manually.
When editing the Plant Group Name property in the Engineering Data Editor or the
Properties window, if identical plant group names exist, holding the mouse pointer over a
selected value from the list displays a tool tip showing the plant group hierarchy path for that
value. Therefore if two units named U1 are available in the list, displaying the tool tip will
show the different paths for the names; for example \A1\U1 and \A2\U1.
Plant Editing
Plant Editing is the ability to use the Engineering Data Editor to manage data for all objects in
the plant. If System Editing is enabled, data that is edited will propagate according to the
System Editing rules defined for the plant.
3. If desired, ensure that Active Drawing is selected to display properties of the items that
appear in the drawing you are currently viewing.
4. Click Other Drawings to display properties of the items that appear in all the non-active
drawings in the plant.
Selecting this option also displays items in the drawing stockpiles of the other
drawings.
5. Edit the data in the field in accordance with the type of data by doing one of the following:
For text, select the field and just type the desired value.
For a list of values (or equivalent quantitative values with different units of measure),
double-click the field and select the desired value from the drop-down list that becomes
available.
For a field with a calculation command (ellipsis), double-click the field and then click the
ellipsis to open a dialog box.
The ability to perform Plant Editing for non-active drawings only applies to the default
Engineering Data Editor window. Editing item properties of non-active drawings is not
supported in a new Engineering Data Editor window that is opened using the Window >
New > Engineering Data Editor command.
You can copy the contents of cells to other cells if the cell contents are compatible.
If the cell is populated by a read-only property or a property that is only automatically
generated by validation, you cannot edit that cell. Read-only and editable properties are
indicated by the column background colors as specified on the Display Settings dialog box.
If an Engineering Data Editor view includes several item types (such as the Equipment,
Instrument, or Plant Item view) where certain properties do not apply to a particular item
type, those properties do not have values and are shown as read-only. In the example
below, the End 1 Flow Direction and End 1 Nominal Diameter properties only apply to the
control valve, while the Sig Point 1 Usage property only applies to the single solenoid and
DCS function instrument types.
While you are editing an item that belongs to another drawing, other users will only be able
to open that drawing in read-only mode. In this case, the other user will receive a message
that the drawing is open (in Drawing Manager, the Accessed By field for that drawing
shows the person who has the drawing open). To make the other drawing editable for other
users, you must move the cursor out of any Engineering Data Editor row representing an
item in the drawing. If the drawing is open as read-only, it will have to be re-opened in
order to be editable.
When editing the Plant Group Name property in the Engineering Data Editor or the
Properties window, if identical plant group names exist, holding the mouse pointer over a
selected value from the list displays a tool tip showing the plant group hierarchy path for that
value. Therefore if two units named U1 are available in the list, displaying the tool tip will
show the different paths for the names; for example \A1\U1 and \A2\U1.
In a project, you cannot perform Claim / Release Claim operations in the Engineering Data
Editor for items that belong to other drawings.
Editing items from other drawings clears the Undo buffer for the active drawing.
Editing items from other drawings creates out-of-date model items, which can be updated
using the Out-of-Date Drawings > Update command (for details of this command, see
Drawing Manager Online Help).
If you use Plant Editing to change a property value in a non-active drawing, propagation
occurs according to the System Editing rules defined for the plant and the Engineering Data
Editor display is automatically updated. This includes propagation of data between
non-active drawings across Off-Page Connectors (OPCs) when both drawings involved are
not opened by a user. Propagation does not occur across OPCs between the active
drawing and a non-active drawing.
In the OPC view in the Engineering Data Editor, it is not possible to edit OPC properties in
non-active drawings; however, OPC properties in the active drawing or in the plant or active
drawing stockpiles can be edited.
If a property value in the Engineering Data Editor is changed by the user or as a result of
an automatic update and this property is used for sorting, the software does not update the
sort order of the data automatically if the values are no longer in the correct order. To
update the sort order, the user must refresh the Engineering Data Editor display manually.
Certain restrictions exist for editing items in the Engineering Data Editor where those items
belong to other drawings. These restrictions are summarized in the following table.
Another user opens a drawing or Normal read/write appearance If you attempt to edit an item, the software
drawing file (.pid) was deleted during displays a message that the item's information
the current session has changed. After you click OK on the
message box, the software refreshes the
Engineering Data Editor and items belonging
to that drawing will be displayed as read-only.
Drawing was deleted from the Normal read/write appearance If you attempt to edit an item, that row is
database or fetched version of a deleted from the Engineering Data Editor
drawing does not include an item display. If you refresh the display, all affected
displayed in the Engineering Data rows are deleted.
Editor
The items belong to a drawing in a Read-only according to the System Editing will not apply to those items
project and have not been claimed user's Display Settings
or have been only partially claimed
to the project scope
None of the above conditions apply, Read-only according to the As an example, in the Plant Item view for a
but a particular item property is user's Display Settings non-customized plant, the Item Tag property is
read-only not editable for pipe runs but it is editable for
piping components. Likewise, Insulation
properties are not editable for a jacketed pipe
run (until that pipe run is defined as jacketed
according to the setting for the plant).
See Also
Edit Active Drawing Item Properties in the Engineering Data Editor (on page 42)
If you use Plant Editing to change a property value in a non-active drawing, propagation
occurs according to the System Editing rules defined for the plant and the Engineering Data
Editor display is automatically updated. This includes propagation of data between
non-active drawings across Off-Page Connectors (OPCs) when both drawings involved are
not opened by a user. Propagation does not occur across OPCs between the active
drawing and a non-active drawing.
If a property value in the Engineering Data Editor is changed by the user or as a result of
an automatic update and this property is used for sorting, the software does not update the
sort order of the data automatically if the values are no longer in the correct order. To
update the sort order, the user must refresh the Engineering Data Editor display manually.
The software copies the equivalent value in the new units of measure to all the selected
fields.
If you use Plant Editing to change a unit of measure value in a non-active drawing,
propagation occurs according to the System Editing rules defined for the plant and the
Engineering Data Editor display is automatically updated. This includes propagation of
data between non-active drawings across Off-Page Connectors (OPCs) when both drawings
involved are not opened by a user. Propagation does not occur across OPCs between the
active drawing and a non-active drawing.
Contains commands for placing multiple representations of an item, deleting stockpile items, or
moving items between stockpiles. Click the down-arrow next to the Actions menu to display
the available commands.
In the case of a connector, this command is not available unless the partner connector is in
one of the stockpiles.
For equipment components, the Engineering Data Editor view does not include a filter for
Item Status = 'Active' (unlike other item types). Therefore the row corresponding to the item
that was deleted from the stockpile is still shown in the view but becomes read-only after
refreshing the Engineering Data Editor display; the item is removed from the display only
when you close and reopen the drawing.
After deleting a stockpile item from the model, you can restore it to the stockpile (and then to
the drawing) using the Edit > Undo command on the main menu, unless you have
performed one of the actions that clears the Undo buffer. For details, see Undo Command
(Edit Menu) (on page 157).
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.
Copy Command
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.
Paste Command
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.
Claim Command
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.
This command can only be used for items that belong to the active drawing.
See Also
Claim a Drawing Item (on page 194)
If you are working in SmartPlant environment and there are any differences between an item
in the Project and an item in the As-Built, the claim cannot be released. If you are not
working in the SmartPlant environment, the claim can be released. Also, items that display
no warnings or errors are released.
This command can only be used for items that belong to the active drawing.
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.
Properties, Copy Bulk Properties, or Paste Bulk Properties commands from the Properties
window toolbar.
Filter Tab
Allows you to define, select, and save a filter for the Engineering Data Editor. If using an
on-the-fly filter to display data in the Engineering Data Editor (by opening the Edit View dialog
box and clicking Advanced), this filter overrides the existing filter selected using the settings on
the EDE toolbar.
Base filter
Displays details of a saved filter.
Name — Displays the name of the filter as defined in Filter Manager.
Default — Indicates if the named filter is the default filter for the item type selected on the Edit
View 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.
Definition
Allows you to add, remove, or edit filter criteria and to specify the relationship between multiple
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.
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
Provides 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 an underscore (_) as a wildcard character for a single character. Do not use an
asterisk (*) in the Value box.
Layout Tab
Allows you to define, select, and save a layout for the Tabular or Engineering Data Editor.
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 Edit
View dialog box. You can designate a layout as the default by selecting this box and then
clicking Save.
Usage — Lists the property display types associated with the Properties window. The
available options are:
Blank value — Specifies that neither Brief nor Bulk usage is implemented in the selected
layout.
Brief — Determines that the list of properties shown in the Display Property column are
displayed in the Properties window when you select the Show Brief Properties command
from the toolbar.
Bulk — Determines that the list of properties shown in the Display Property column are
copied in the Properties window when using the Copy Bulk Properties and Paste Bulk
Properties commands from the toolbar.
Brief/Bulk — Specifies that both Brief and Bulk usage are implemented in the selected
layout.
Where more than one layout exists, you can define the usage as Brief for any one layout and
Bulk for any other layout, or you can define the usage as Brief/Bulk for one layout only. If you
previously defined the usage for a particular layout and subsequently define the same usage for
another layout, the usage in the first layout is removed. In order for your choice for the Usage
property to take effect, you must exit and re-enter the design software.
Delete (Name) — Removes the named layout.
Save — Saves the data in this dialog box as a named layout. Layout names must be unique.
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 (on page 58).
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 on the Edit View
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 on the Edit
View 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.
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
3. Click Browse if you want to search for a filter or create a new filter (either simple or
compound) using the Select Filter dialog box.
4. To further define a filter, populate the Definition box with properties and values.
5. Select a property, operator, and value in the Edit group.
The Property list displays properties that apply to your item type; the Operator list
displays all the possible relationships, such as greater than and not equal to; the Value list
displays the specific properties that you can filter for.
6. You can click Add to add another line to the Definition box, if necessary. To add more
entries, repeat steps 4 and 5.
7. Click Delete if you want to delete the current row in the Definition box.
8. Click either Match all or Match any.
9. Click OK on the Advanced View Properties dialog box and again on the Edit View dialog
box so that the software can populate your table.
After you have defined a specific filter for your Engineering Data Editor, you can save
that definition (for details, see Save an Engineering Data Editor View (on page 58)).
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.
The filter settings override any existing filter selected using the settings on the EDE
toolbar. Furthermore, the filter settings are lost when you close the drawing or select a
different item type in the Engineering Data Editor.
7. In the Sort Property list, click Add to add an entry. Then select the property, order, and
type in the Edit group at the bottom of the dialog box.
8. To add and define more sort properties, repeat step 7.
To change the sort order of the properties in the Engineering Data Editor, select a
row in the Sort Property box and click Move Up or Move Down.
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.
After defining a layout, you can save it if you want to apply it to another view of the
Engineering Data Editor. To save the view layout, specify a name in the Name box and
click Save on the Layout tab of the Advanced View Properties dialog box.
You can also name and save the entire Engineering Data Editor, layout and all. For more
information, see Save an Engineering Data Editor View (on page 58).
An EDE view is a combination of item type, filter, and layout. You can change filters and
layouts by using the Advanced View Properties dialog box, and this action applies to any
EDE that refers to those properties of the table. That is, you can change a layout that applies
not only to a standard view but also to a saved view, and the new layout is reflected in both
views of the EDE.
You can delete a saved view, too. For more information, see Delete a Saved Engineering
Data Editor View (on page 58).
There are several ways to customize your EDE:
Modify the Properties of an Existing Engineering Data Editor View (on page 57)
Customize the Display of the Engineering Data Editor (on page 36)
The EDE is where you can display stockpile items.
Refresh Command
Updates the display in the Engineering Data Editor. This command queries the database and
builds a new view with new results.
The 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 "+" to the left of
the node name. To close a node, click the "-" to the left of the node name. If the selected node
contains any drawing symbols, the software displays them in the list view.
If the Symbols node is not displayed in the tree view, ensure that in Options Manager,
the Catalog Explorer Root Path value does not include a trailing '\' (backslash) character.
At the top of the tree view, there are several toolbar buttons for carrying out commands and
allowing you to customize the tree and list views to suit your work session.
The list view displays the symbols that are associated with the active node in the tree view. Only
the contents of one node appear. You can specify the view style for the symbols in the list view
by selecting options on the View menu . View styles available are large icons, small icons,
list, and details.
From the list view, you can select catalog items before placing them in a stockpile.
1. Click "+" to the left of a node name to open the hierarchy below the node.
When you click a node that contains catalog items, the items stored in it are displayed
in the Catalog Explorer list view.
2. Click "–" to the left of a node name to close the hierarchy below the node.
3. Use the horizontal and vertical scroll bars to view other portions of the hierarchy.
You can also right-click the empty area in the main toolbar and then select Catalog from
the shortcut menu.
Or, click View > Toolbars and select Catalog.
2. Use Catalog Explorer to view the symbol catalog and its contents and manipulate catalog
items.
You can import a spreadsheet in a recognized format into a stockpile to populate it, too.
For more information, see Populate the Stockpile from a Spreadsheet (on page 173).
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 (on page 171).
Catalog Menu
Catalog Explorer > Catalog
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.
The list of commands that are available on the Catalog menu depends on whether the
Tree (on page 60) view or the List (on page 60) view is active.
Find Command
Displays the Find dialog box, from which you can search the catalog for a specific item or group
of items.
New Command
Adds a node under the My Catalog > Toolbars node in the Catalog Explorer. This command
is available when you click the Toolbars node.
Clicking the down-arrow of the File menu button accesses a list of the associated
commands. Clicking the File menu button itself repeats the last command that you used from
the File menu.
You can dock the symbols toolbars on any side of the main window.
You can define up to two levels of toolbars. For example, you can create a Vessels node
under Toolbars, and under Vessels you can create Vertical and Horizontal. A divider
appears in the symbol toolbar between levels.
Plant-level symbol toolbars are created in Catalog Manager.
You must have the proper permissions, granted in SmartPlant Engineering Manager, to
create symbol toolbars.
Open Command
Opens the Catalog Explorer window.
Depending on your editing privileges, you are able to delete nodes in certain catalogs. See
your system administrator for information regarding your current editing privileges, which are
specified in SmartPlant Engineering Manager.
You must first delete all sub-nodes and catalog items that populate a node before you can
delete the node itself.
Rename Command
Allows you to type a new name for the item or node.
Depending on your editing privileges, you can rename nodes in certain catalogs.
See your system administrator for information regarding your current editing privileges, which
are specified in SmartPlant Engineering Manager.
Close Command
Closes the Catalog Explorer window.
View Menu
The Catalog Explorer View menu provides commands that allow you to control the display
format of catalog items within the Catalog Explorer list view.
List Command
Catalog Explorer > View > List
Displays smaller icons with names vertically using multiple columns in the list view and does not
list details.
Details Command
Catalog Explorer > View > Details
Displays smaller icons with names and source information vertically in a single column in the list
view.
Navigation Menu
Navigation Menu (Catalog Explorer)
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 Navigation menu of
the Catalog Explorer window.
On the Navigation menu , click Remove Button to delete the active shortcut button from the
navigation bar.
Or you can right-click any shortcut button and select Remove Button from its shortcut
menu.
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 View Properties
dialog box.
When you hold the pointer over the buttons on the Properties window toolbar, a ToolTip
appears with 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 menu commands to modify property values in this
grid.
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.
You can also display the Properties window by clicking View > Display > Properties.
Show Brief Properties — Displays those properties that have been previously specified as
brief on the Advanced View Properties dialog box.
Copy Bulk Properties — Copies the bulk properties of a selected item. The properties are
then available to paste onto other items. For more information, see Copy Bulk Properties (on
page 73).
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 (on page 73).
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. For
more information, see Display Null Values in the Properties Window (on page 73).
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.
Show Select Set — When using a fence to select a set of items, displays the common
properties of the selected items. This option improves display performance.
Show Single Item — When using a fence to select a set of items, displays the properties of
one item only. If you select multiple items by holding down the CTRL key, the software displays
the select set properties.
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 View Properties dialog
box.
The software will recognize valid URL addresses in a Description field. Double-clicking a
URL link in a Description field activates the link; for example, displaying an IP address in a
Web browser.
The properties that are subsequently displayed in the window belong to the chosen item
or the select set. For the select set, only properties that all items have in common
appear, and only common values are displayed for those properties. Consequently,
empty property values for a select set do not necessarily mean that no value has been
assigned for any of the items in the set, only that either no value has been assigned or
that the different items have different values for the property.
Whenever you have constructed a select set, you can choose single items from that set
by using the Selected Items list at the top of the Properties window. A single item
chosen in a select set this way is highlighted in a different color in the Drawing view.
3. Display properties alphabetically or by categories by clicking the corresponding display
mode button on the Properties window toolbar. Click to display properties
alphabetically; click to display properties by categories.
You can also display the Properties window by right-clicking the empty area of the main
toolbar and then selecting Properties from the shortcut menu.
Or you can click View > Display > Properties Window on the main menu bar.
Or you can right-click an item, and select Properties from the shortcut menu.
Or you can click View > Toolbars and select Properties.
3. Enter or edit information in the cell next to the appropriate property.
You can review and edit item properties in the Engineering Data Editor, too. You can edit
the contents of some cells directly in the table if the corresponding property is not read-only
or generated strictly by validation, or you can select an item by clicking the icon in the
left-most column and then edit its properties in the Properties window.
For formatted properties, such as estimated length or maximum operating temperature, you
can enter a value without a format. Use a single quote, ', at the beginning of your entry. In
this way, you can enter free text into a formatted property and no units of measurement are
assigned.
The default plant group is the node in the plant hierarchy immediately under which the
drawing resides.
Not all item types support the plant group property.
2. In the Properties window, select the plant group type in the Plant Group Type property
box.
It is possible that you do not want to modify the plant group type. For instance, your
item can already be associated with the plant group type of unit, but you want simply to
associate it with a different unit. Go to the last step if this is the case.
3. Modify the plant group name in the Plant Group Name property box.
If identical plant group names exist, holding the mouse pointer over a selected value
from the list displays a tool tip showing the plant group hierarchy path for that value.
Therefore if two units named U1 are available in the list, displaying the tool tip will show the
different paths for the names; for example \A1\U1 and \A2\U1.
Once you display case data in the Properties window, case data remains displayed for
the current design session.
After updating case data using Plant Editing, the next time the drawing is opened and
an appropriate item is selected, its case data is displayed.
If the Properties window is not displayed, you can select an item and click Edit >
Properties.
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.
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.
Menu Tab
Adds or removes commands from menus or the main menu bar. You can add a command to an
existing menu or build a custom menu with the commands that you want. Or you can add a
single command to the main menu bar.
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.
Toolbars Tab
Adds or removes commands from toolbars.
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.
Description — Describes the button selected in the Buttons area.
The new menu is added after the existing menu that you selected in step 3.
If you want to add a menu to an existing menu, select Place into selected menu 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.
After you create a new menu, you can add commands to it. For more information, see
Add a Command to a Menu (on page 79).
OPCs — Finds and repairs off-page connectors (OPCs) that have lost their associations with
the OPC with which they were originally paired. If one OPC has lost the identity of its mated
OPC, but the mated OPC still has the identity of the first OPC, then the OPC is considered
repairable. To repair the OPC, the utility updates the identity information for the first OPC.
However, if both the OPC and its mated OPC have lost the identities of each other, then the
OPCs are considered non-repairable, and you are given the option to delete them.
Gaps — Repairs and updates gaps in the representation record with the proper item type. On
rare occasions you will need to perform this operation if you have gapping problems in your
drawings.
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.
To repair the OPC, the utility updates the identity information for the first OPC. However, if
both the OPC and its mated OPC have lost the identities of each other, then the OPCs are
considered non-repairable, and you are given the option to delete them.
Update gaps in the representation record with the proper item type. This need occurs only in
rare instances. You need to perform this operation if you have gapping problems in your
drawings.
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.
Verify that the plant user has full permissions to the tables, T_Representation and
T_ModelItem. For information on setting table permissions, refer to your database
documentation.
It is very important that you perform the steps in the sequence that they are presented. The
buttons on the utility are arranged appropriately.
1. Open a drawing, and click Tools > Custom Commands to open the Custom Commands
dialog box.
2. Browse the drawing software program directory and open DelOrpModItems.dll.
You can find this macro in the ..\SmartPlant\P&ID Workstation\bin folder.
3. On the Clean Data dialog box, click Model Items.
4. On the Delete Orphan Model Items dialog box, choose the model item type from the Item
Type Names list.
5. In the list view, select the model orphan items to delete and click Delete.
You can also click Delete All to select and delete all the items in the list view.
6. Click Close.
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.
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.
You can create macros with any programming tool that supports OLE automation, such
as Visual Basic.
Oracle System Passwords All special characters are restricted except for
@ ('at' symbol), . (period), and _ (underscore)
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.
Open Database — Opens the Open Plant Structure dialog box, which allows you to
specify a different initialization file so that you can work in a different database. You cannot open
two drawings from different databases at the same time. If you currently have a drawing open
in SmartPlant P&ID, the Open Database command is not available.
Filter — Opens the Filter dialog box, which allows you to specify criteria for filtering the
drawings that are displayed in the List view.
Clear Filter — Deactivates any filter you have applied to the list of drawings that appears in
the List view.
Include Subnodes — Displays in the right-hand view of the Open dialog box all the
drawings and node names that reside in the currently selected node.
Details — Displays a detailed view in the right-hand window. The detailed view displays all
the properties specified in the Selected Properties list of the Customize Current View dialog
box. Using the detailed view allows you to view and sort drawings by several attributes.
List — Displays the list view in the right-hand window. The list view only displays one
property for each drawing. You can specify that descriptor by clicking Customize View; the first
item in the Selected Properties list is the descriptor that appears in the list view.
Customize View — Opens the Customize Current View dialog box, which allows you to
specify the information about each drawing that is displayed in the report or list view of the Open
dialog box.
You can open one of the last edited drawings by selecting it from the list of recently opened
files at the bottom of the File menu on the main menu bar.
You need to have the correct permissions to open or save certain drawings. Your plant
administrator has set the plant hierarchy and has identified user names and tasks for those
plants and related drawings. User roles are assigned in SmartPlant Engineering Manager.
If a filter was previously applied on the Open dialog box or in Drawing Manager, the filter
settings are retained for the plant the next time you open the List view. If you select another
plant, any filter that was previously applied to the current plant is cleared.
General Tab
Displays general information about the current document.
Type — Displays the type of document. The type is based on the application used to create the
document.
Location — Displays the directory containing the document.
Size — Displays the size of the document in bytes, kilobytes, and megabytes.
MS-DOS Name — Displays the name of the document as it would appear in a Windows file
naming system.
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.
Archive — Shows that the document is an archive document.
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.
If some of the above information is not available, the dialog box displays Unknown.
Summary Tab
Displays the title and author, if available, along with keywords and comments for the current
document. The software generates the author and template information when you create, save,
or print the document. You can edit these properties, with the exception of the template, unless
the document is write-protected.
Title — Specifies the title of the current document.
Subject — Gives a general description of the current document.
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.
Comments — Specifies comments about the current document.
Template — Specifies the current drawing template.
Statistics Tab
Displays detailed information about the current document. The software automatically generates
these properties when you create, save, or print the document.
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.
Units Tab
Sets up units of measure and precision readout for the length, area, or angle values in a
drawing.
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.
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.
When placed on a drawing, all delivered labels that include units of measure use the plant
default formats defined in Options Manager, and so labels do not always display the units of
measure selected in the Properties window. To ensure that a label displays the units of
measure specified in the Properties window, in Catalog Manager, select the desired label,
and from the Format list on the SmartText Editor dialog box, select the As Entered option.
The software 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.
Saving Drawings
Whenever you save a drawing using File > Save, the software uses the name and folder
location specified in Drawing Manager during drawing creation. If you want to save the drawing
in a format other than .pid, use the Save As or Save as PDF command.
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.
If another user modifies an item on an open drawing using automation and you also
modify the same item from SmartPlant P&ID, on saving the drawing, you will receive a message
that you must close and then reopen the drawing. All unsaved changes that you made to the
drawing will be lost.
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.
AutoCAD (*.dxf)
SmartPlant P&ID uses the ExportLayer.xlsx file to map drawing item types to the layers that
they will be assigned to. Filters are used to define the scope of the item type, for example
'New Equipment'. The file then specifies the layer to which the scoped item type will be
assigned. If a symbol’s item type does not match any of the filter definitions and if that
symbol is in the current drawing layer (Primary, Typical, or both), the symbol is saved in the
Default layer. If a display set is assigned to the drawing and the Color value of filtered or
background items is None, the software ignores the ExportLayer.xlsx file and those items go
to the hidden layer in AutoCAD or MicroStation. If the Color value of filtered or background
items is not None, filtered items go to the layer specified by the filter and background items
go to the default layer unless a filter exists in the ExportLayer.xlsx file for a particular item or
set of items, in which case the settings in the ExportLayer.xlsx file override the display set
settings for those background items.
You can save drawings as PDF files using the Save as PDF command.
You can also batch save drawings in other formats in Drawing Manager. For details, see
Save Drawings in Other Formats in the Drawing Manager User's Guide.
Stores the active drawing. Plant location and paths are set in SmartPlant Engineering Manager
and Options Manager.
You can choose more filters for the Filter column of this worksheet from filters in Filter
Manager.
If you save your drawing to the AutoCAD format, you can name layers with any
combination of alphanumeric characters.
3. Save ExportLayer.xlsx.
In addition to ExportLayer.xlsx definitions, you can also apply a display set to the
drawing to specify the assignment of drawing objects to different layers and their color
assignments. For details, see Notes and table below.
4. Click File > Save As.
5. On the Save As dialog box, select the drive and folder for the new drawing.
6. In the File path box, if desired, edit the name and path for the drawing file, or click Browse
to open the File Name and Path window to navigate to the desired path.
7. From the Save as type list, select the file format that you want to use.
The value of the Override Layers on Export attribute in the pidacad.ini file affects the
output when saving a file as AutoCAD. If symbols are exported as blocks (when the value of
the Dissolve Symbol to Groups attribute is set to 0), you must specify a value of 2 or 3 for
the Override Layers on Export attribute to ensure that the blocks are exported to the
correct AutoCAD layer. For full details of the Override Layers on Export attribute, see
Configuration File Settings for AutoCAD Translation (on page 97).
When saving to AutoCAD or MicroStation, the software checks the ExportLayer.xlsx file and
if it finds a reference to a filter that does not exist in the reference data, a Filters Not Found
dialog box is displayed showing a list of missing filters. When you click Exit to dismiss the
dialog box, the save as process stops.
When saving to AutoCAD or MicroStation using a display set, the software uses the
ExportLayer.xlsx file only for filtering items that do not meet any of the display set filter
criteria and for which the Color value of filtered or background items is not None.
The dependent behavior of drawing items on the color value of display sets is as follows:
Specific color Layer is created with name of Items are mapped according to
display set filter and filtered items go filters in the ExportLayer.xlsx file.
to that layer with the color specified Colors specified by the display set
by the display set filter. If Override filter are ignored for items mapped to
Layers on Export = 2 in the layers that appear in
pidacad.ini or pidmstn.ini file, the ExportLayer.xlsx, and the colors of
color from the seed file overrides the those items are assigned according
display set filter color for the to the Override Layers on Export
particular layer. setting. Items sent to the Default
layer are assigned the background
items color from the display set.
None Items are sent to the HiddenObjects Items are sent to the HiddenObjects
layer and the ExportLayer.xlsx file layer and the ExportLayer.xlsx file
settings are ignored. settings are ignored.
Options
Name of Setting Description Import Export Default Value Accepted Values
Seed File Name of a seed file used for No Yes pidacad.dwg Filename
export (not mandatory).
Enable Logging If set, a log file will be created Yes Yes 0 0 = Logging is turned
in the directory that the file OFF
was opened from and will
have the same name as the
file that was opened. 1 = Logging is turned
ON
Template File Sets the document that will be Yes No TransAcad.igr Filename
used as a template when
importing foreign data for (If this file is
setting up hatching and required, it can be
patterns. taken from the
SmartSketch folder)
Symbol Template Sets the symbol file that will Yes No Filename
File be used as a template when
importing foreign data.
Ignore Sheet Scale Determines whether to scale Yes No 1 0 = Do not fit the
the sheet to fit the graphics graphics to the sheet
during a translation import.
Processing Batch If set, progress bar dialog Yes Yes 1 0 = Progress Bar
Translation boxes do not display during display is turned ON
the translation.
1 = Progress Bar
display is turned
OFF
Attribute Sets Controls the import / export of Yes Yes TranslationSettings String consisting of
attribute information on attribute names
objects during translation. delimited by
semicolons, or the
ALL keyword
Read Block Sets how the blocks imported Yes No Shared Embeds Shared Embeds -
Options from AutoCAD are handled. Preserves blocks
Rigid Groups -
Translates blocks
into groups
Write Version Sets the version of the foreign No Yes 2012 2000; 2002; 2004;
file format that is created on 2005; 2006; 2007;
export. 2008; 2009; 2012
1 = All graphic
objects are exported
into the Paper space.
SmartFrames with
clipping boundaries
display properly.
Detail views are
ignored.
2 = All graphic
objects are exported
to Modelspace and
Paper space is
populated so that the
original SmartSketch
sheet is re-created.
Application Text Determines whether text Yes Yes 1 0= Text origin always
Type origin and justification are in upper left corner
preserved.
1= Origin preserved
1 = Horizontal text
alignment is set to
Left
1 = Attributes are
created as
SmartLabels
1 = ON
1 = ON
1 = Include
non-displayable
objects
1 = Attributes are
created
Metafile to Raster Sets the dpi resolution for No Yes 350 dpi resolution (1
DPI Resolution raster metadata during export. through 1200)
1 = Delete symbol
definitions
Merge References Controls whether files of type No Yes 2 0 = Save inserted igr,
.igr, .dwg, .dgn, and .dxf that .dwg, .dgn, and .dxf
were inserted into a files as separate
SmartPlant P&ID drawing are .dwg files
merged into the main .dwg file
when saving to AutoCAD.
Inserted Office documents are 1 = Merge inserted
translated to .tiff file format. files using BIND.
Regardless of the setting Creates a duplicate
value, objects with .tiff or .jpg set of styles for each
format are not merged and block reference.
need to be kept in the same
folder as the .dwg file in order
to display correctly.
2 = Merge inserted
files using INSERT.
Creates a single set
Note that for a main drawing of unique styles for
saved as a .dxf file with the main drawing
objects in .tiff format, when and all block
the files are copied to a new references.
location, AutoCAD cannot find
them due to the reference to
an exact location, even if they
are in the same location as
the .dxf file. To rectify this, the
path to the .tiff file needs to be
updated manually in the .dxf
file.
Write Linestyles
Many of the default linestyles in your document are pre-mapped to the most equivalent
AutoCAD linestyles. Other linestyles are mapped as continuous. If the _default_ = _stroke_
setting is used, all linestyles are stroked regardless of their mapping. The _default_ = _stroke_
setting is commented out by default to disable it.
The number values are used in the linestyle table to map linestyle definitions in the current
document to AutoCAD line types.
Number Definition
9 CONTINUOUS
10 HIDDEN2
11 DOT2
12 DASHDOT2
13 DIVIDE2
18 CENTER2
19 CENTER
20 PHANTOM2
21 BORDER2
23 CONTINUOUS
The following table shows the Signal Run linestyles as they appear in the software and in
AutoCAD.
Software AutoCAD
Capillary = CAPILLARY
Electric = ELECTRIC
Guided = ELECTROMAGNETIC
Electromagnetic
Hydraulic = HYDRAULIC
Pneumatic = PNEUMATIC
Undefined = UNDEFINED
Unguided = UNGUIDED_ELECTROMAGNETIC
Electromagnetic
_default_ = _stroke_
The following table shows the revision cloud linestyles as they appear in the software and in
AutoCAD.
Software AutoCAD
Options
Name of Setting Description Import Export Default Value Accepted Values
Enable Logging If set, a log file will be created Yes Yes 0 0 = Logging is turned
in the directory that the file OFF
was opened from and will
have the same name as the
file that was opened. 1 = Logging is turned
ON
Read Default Units If the MicroStation file being Yes No 64 59=m; 61=mm;
imported does not have a 62=cm; 63=km;
master unit setting that 64=in; 65=ft; 66=yd;
matches one of the default 67=miles
SmartSketch unit settings,
then this setting is used to
specify the units being
imported. If the MicroStation
file being imported does have
a valid master unit setting that
matches a default
SmartSketch unit setting, then
this setting is ignored.
Template File Sets the document that will be Yes No TransMstn.igr Filename
used as a template when
importing foreign data for (If this file is
setting up hatching and required, it can be
patterns. taken from the
SmartSketch folder)
Symbol Template Sets the symbol file that will Yes No Filename
File be used as a template when
importing foreign data.
Ignore Sheet Scale Determines whether to scale Yes No 1 0 = Do not fit the
the sheet to fit the graphics graphics to the sheet
during a translation import.
Processing Batch If set, progress bar dialog Yes Yes 1 0 = Progress Bar
Translation boxes do not display during display is turned ON
the translation.
1 = Progress Bar
display is turned
OFF
Attribute Sets Controls the import / export of Yes Yes TranslationSettings; String consisting of
attribute information on _SymInst attribute names
objects during translation. delimited by
semicolons, or the
ALL keyword
Write Version Sets the version of the foreign No Yes 8.0 7.0; 8.0
file format that is created on
export.
1 = Symbols are
exported as type 2
cells to control the
graphics level
To
implement this
behavior, you must
also assign to the
Attribute Sets
option the value
'TranslationSettings;
_SymInst'; otherwise,
when the value of
Dissolve Symbol to
Groups is set to 1,
symbols are
exported as
individual objects
Application Text Determines whether text Yes Yes 1 0= Text origin always
Type origin and justification are in upper left corner
preserved.
1= Origin preserved
1 = Horizontal text
alignment is set to
Left
1 = Attributes are
created as
SmartLabels
1 = ON
1 = ON
1 = Include
non-displayable
objects
1 = User-defined
linestyles are
preserved
1 = Attributes are
created
Metafile to Raster Sets the dpi resolution for No Yes 350 dpi resolution (1
DPI Resolution raster metadata during export. through 1200)
1 = Delete symbol
definitions
Read Cell Options Sets how the shared (type Yes No Shared Embeds Shared Embeds -
34/35) cells imported from Preserves shared
MicroStation are handled. cells
Rigid Groups -
Translates shared
cells into groups
Pos Units Per Sub Sets the values to determine Yes No 1000 Numeric
Units the size of units for a
MicroStation cell file
Always Shift GO to Controls whether to set the No Yes 0 0 = Do NOT shift the
Center Drawing Global Origin of .dgn files in Global Origin of the
case the drawing objects fall resulting .dgn file
outside the maximum design
plane as defined by
MicroStation. 1 = Shift the Global
Origin of the
resulting .dgn file
EDF as Smart Text Determines whether the Yes No 0 0 = Tags are created
values of tags are created as as text boxes
simple text boxes or as
SmartLabels during
translation import. 1 = Tags are created
as SmartLabels
Write Linestyles
The default linestyles in your document are pre-mapped to the most equivalent MicroStation
linestyles. Linestyles other than the default linestyles or any complex linestyles containing
shapes are mapped to continuous unless they are specifically mapped on the Linestyle tab.
Linestyles that are not mapped on export are stroked to give them a more correct appearance.
The default length of the stroking line is 0.1 millimeters (mm).
The number values are used in the linestyle table to map linestyle definitions in the current
document to MicroStation line types.
Number Definition
9 0
10 2
11 1
12 4
13 6
18 7
20 6
The following table shows the Signal Run linestyles as they appear in the software and in
MicroStation.
Software MicroStation
Capillary = Capillary
Electric = Electric
Hydraulic = Hydraulic
Pneumatic = Pneumatic
Software MicroStation
Undefined = Undefined
Unguided = Electromag/Sonic
Electromagnetic
_default_ = _stroke_
The following table shows the revision cloud linestyles as they appear in the software and in
MicroStation.
Software MicroStation
In addition to the above mapping, the PIDLineStylesV8.rsc file, delivered with SmartPlant P&ID,
must be copied to the MicroStation installation folder:
C:\ProgramData\Bentley\WorkSpace\System\Symb.
The following table shows the Tracing Media linestyles as they appear in the software and in
MicroStation.
Software MicroStation
NT = NT
E = E
FA = FA
FB = FB
FC = FC
I = I
MI = MI
SKE = SKE
SH = SH
SL = SL
SM SM
Software MicroStation
SN = SN
SS = SS
ST = ST
Save options
File path — Allows you to type or edit the file path and name.
You can also click Browse to open the File Name and Path window to navigate to the
desired path where you want to save the drawing.
Save as type — Allows you to select a file format for the drawing you want to save. The
following formats are available:
AutoCAD (*.dwg and *.dxf)
MicroStation (*.dgn)
3. Beside the File path box, click the ellipsis button to navigate to the folder where you
want to save the PDF file and type a name for the file.
Color options
Color — Creates a PDF using the colors available in the document. You can only create a color
PDF from a color drawing sheet.
Grayscale — Creates a PDF using a 256-color grayscale.
Pure black and white — Creates a PDF that has no color or grayscale. Anything that is not
pure white is drawn as black.
JPEG compression — Compresses images embedded in your document according to the
compression level you define. If your drawing contains a lot of images, compression settings are
very important for achieving good image quality at a manageable file size. Use the pull-down
menu to set the compression level. Compression levels in the High quality range do not
noticeably affect image quality, and produce larger file sizes than settings in the Low quality
range. However, using a mid-range compression level usually strikes the best balance in
creating a compact file while still maintaining enough information to product high-quality images.
Include inconsistency markers — When selected, includes inconsistency symbols that appear
on the drawing in the PDF output.
File path — Allows you to define the name and path for the PDF file.
Re-creating Drawings
SmartPlant P&ID continually updates the database as you edit a drawing; however, the drawing
file is not updated until you actually save the file (that is, when you click File > Save or when you
exit SmartPlant P&ID). Occasionally, the software may terminate abnormally due to power
outages and so forth. 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.
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.log, is created in your Temp folder. You can check this file for
irregularities that occur during the re-create process.
Do not interfere with the re-create process once started because the drawing can
become unusable.
For best system performance, close all other applications except for SmartPlant P&ID when
running the re-create process.
During the re-create process the status bar at the bottom of the P&ID window displays
updates about the particular elements currently being reconciled with the database. You can
check the log file, Recreate[Drawing#].log, located in the Temp directory, for any problems
that may have occurred during the re-create process.
If your reference data has changed, use the Update Drawings functionality to incorporate
those changes into your existing drawings. For more information, see the SmartPlant P&ID
Drawing Manager User's Guide.
After the re-create process finishes, SmartPlant P&ID reinitializes the drawing and displays the
message 'Re-create drawing is complete'. Review the re-created drawing and resolve any
errors that occurred.
Error Conditions
If a section of the drawing could not re-create successfully, an error condition appears on the
drawing as a heavy line segment that is highlighted orange by default. Error conditions are
almost always associated with a pipe or signal run and must be resolved manually.
Clicking OK will automatically delete orphaned symbols in the drawing. To band aid the
symbols, click Cancel. The next time you open the drawing, the message will appear again and
the symbols will be band-aided, Band-aided symbols are indicated by heavy orange lines.
Re-create a Drawing
1. Open the drawing that you want to re-create.
2. Set a heat trace medium for 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.
Using Filters
You can use filters in many ways throughout the software and its stand-alone applications and
utilities.
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. You can also use filters to find 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.
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.
You can also use the Polygon Fence Locate tool to create a polygon shaped fence to
select multiple items.
If you select multiple items in the Engineering Data Editor, these items are also selected in the
active drawing, if they reside there. You construct a select set using the Engineering Data
Editor in this way.
Whenever you have constructed a select set, you can choose single items from that set by using
the Selected Items list at the top of the Properties window. A single item chosen in a select set
this way is highlighted in a different color in the Drawing view.
The Select Tool Ribbon appears when nothing is selected. After you select an item, the Select
Tool ribbon is replaced with a ribbon for editing the selected item.
Inside — Specifies that items inside the fence are selected.
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.
Bottom Up — Specifies that individual elements, which make up symbols, are recognized in the
locate zone as opposed to the whole symbol.
To find out the name of an option on the ribbon, pause the pointer over an option and
read the ToolTip.
Rectangle — Creates a select area, or fence, by drawing a rectangle around points that you
define. When you drag the mouse to define a rectangular fence, a dashed rectangular outline
dynamically appears as you drag. When you reach the desired size, release the mouse button
to create the fence. The dashed fence outline disappears and the elements are selected.
Polygon — Creates a select area, or fence, by drawing a polygon around points that you
define. Click to place the first point, click the remaining points to define the polygon. Points are
placed when you release the mouse button. Right-click to end the polygon. The dotted outline
disappears and the elements are selected.
Overlapping — Specifies that elements overlapped by the fence are selected, as well as
elements inside the fence.
Top Down — Specifies that groups of elements are located as opposed to individual
elements in a group.
Bottom Up — Specifies that individual elements in a group are located as opposed to the
whole group.
Locate Filter — Opens the Define Locate Filter (see "Define Locate Filter Dialog Box" on
page 124) dialog box where you can specify a filter for the selection of specific drawing
elements. Filters allow you to select specific types of drawing elements, or all drawing elements.
See Also
Polygon Fence Locate Command (on page 121)
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 CTRL or SHIFT 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 QuickPick. For more information, see
Select an Item Using the Configuration (QuickPick) Tool (on page 123).
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 CTRL or SHIFT.
To clear the selection of one item and leave other items selected, click the item while
holding CTRL or SHIFT.
When the Select Tool is active, selectable items are highlighted as you pass the pointer
over them. When the item you want to select is highlighted, click to select it.
Click Tools > Options to change the item highlight and selection colors and locate and
break-away tolerances.
To select all items in a drawing, right-click a blank area in the drawing and click Select All
on the shortcut menu, or, to accomplish the same thing, press CTRL + A or click Edit >
Select All.
You can also select items in the Engineering Data Editor. If they reside in the active
drawing, they are selected in the Engineering Data Editor. You can build up a select set
using this method, too.
2. On the QuickPick tool, which appears near the pointer, move the pointer over the numbered
buttons, without clicking, to highlight the corresponding items.
For a single heat trace, ensure that the heat trace medium does not appear beside Heat
Tracing Media - Double Heat Trace or Heat Tracing Media - Jacketed Pipe.
For a double heat trace, assign the heat trace medium to Heat Tracing Media - Double
Heat Trace.
For a jacketed heat trace, assign the heat trace medium to Heat Tracing Media -
Jacketed Pipe.
The implementation and positioning of heat trace or jacketing graphics depends on the heat
tracing type and whether the heat tracing is applied to a pipe run or some other item type. The
following table summarizes the behavior.
Type of Heat Tracing Behavior when Applied to Pipe Run Behavior when Applied to Other
Item Types
Single As defined by the selected default Displays graphics from the Heat
placement on the Options Manager Trace layer of the symbol defined in
Tracing tab. Catalog Manager.
Double Heat tracing is placed on both sides of Displays graphics from the Heat
the pipe run. Trace layer of the symbol defined in
Catalog Manager (same appearance
as for single heat trace).
Jacketed Heat tracing is placed on both sides of Displays graphics from the Jacket
the pipe run. layer of the symbol defined in
Catalog Manager.
If, in Catalog Manager, no graphics are defined on the Heat Trace layer of a symbol, no
heat trace will be displayed for the symbol in the drawing if a single or double heat trace is
assigned and the item type of the symbol is anything other than Pipe Run.
If, in Catalog Manager, no graphics are defined on the Jacket layer of a symbol, no heat
trace will be displayed for the symbol in the drawing if a jacketed heat trace is assigned and
the item type of the symbol is anything other than Pipe Run.
If, in Catalog Manager, the item type of the symbol is Pipe Run, any graphics defined on the
Heat Trace or Jacket layers are ignored.
In the drawing, the heat tracing line style of the selected heat trace medium for all item types
is determined by the definition made on the Options Manager Tracing tab.
If a heat tracing medium that has been designated as jacketed is assigned to a pipe run in
SmartPlant P&ID, additional jacketed properties are displayed in the Properties window
under the Piping Jacket category for that pipe run. If the heat trace medium is removed
from the pipe run or is changed to something other than a jacketed heat trace, the Piping
Jacket category and the associated properties are no longer displayed, and any values
assigned to those properties are removed. In Data Dictionary Manager, you can add more
jacketed properties if you desire.
In Insulation Manager, you can define a heat trace medium to automatically be assigned
with a particular insulation spec for a pipe run or equipment. Only the defined heat trace
medium can be used in combination with that insulation spec. You can also choose one of
the following options:
Undefined — No heat trace can be used if that particular insulation spec is assigned.
Ignore — Any heat trace can be used with that specified insulation spec.
.
The new heat tracing medium will now be displayed in the Tracing Media list.
3. From the Tracing Media list, locate the new media and click the Style box.
4. Select a new heat tracing style from the list.
5. Click Save .
To designate a particular heat tracing medium as a double heat trace or jacketed heat trace,
in Options Manager, click Settings and add the heat tracing media to one of the
following:
Add heat tracing media designated as double to the Heat Tracing Media - Double Heat
Trace row, with each value separated by a comma.
Add heat tracing media designated as jacketed to the Heat Tracing Media - Jacketed
Pipe row, with each value separated by a comma.
Any changes made to a heat trace medium in Options Manager will not be reflected in any
drawing in which that heat trace medium was already assigned to an item. For changes to
be reflected in the drawings, you must run the Update Drawings command first. For
details, see the Update Drawings Command topic in the Drawing Manager User's Guide.
4. In the View window, click the Graphics layer, then while holding down the CTRL key, click
the Heat Trace layer.
This action makes both layers visible at once.
5. Using the drawing tools, draw the heat trace around the symbol.
To display the Heat Trace layer only, click any layer other than the Graphics or Heat
Trace layer, then click the Heat Trace layer.
6. Click Save.
The actual style of the heat tracing graphics displayed in the drawing depends on the line
style chosen for the specified heat trace medium in Options Manager. For details, see Create a
New Heat Tracing Medium (on page 126).
e. Click Open.
f. On the Style Resources dialog box, click OK.
g. On the Style dialog box, click Close.
5. In the Line Style Editor, expand the Linear Styles node.
6. Right-click on the heat trace line style that you want to modify (for example, Electric Heat
Trace) and on the shortcut menu, click Import Style.
The line style name becomes bold, indicating that it has been imported into the
symbol.
7. Right-click again on the style and on the shortcut menu, click Properties.
8. On the Linear Style Properties dialog box, in the Offset field, enter the desired offset
value.
The base offset value for heat trace lines is 0.05 in, therefore the actual offset value will
be 0.05 in + the value entered in the Offset field.
9. From the Crossover orientation list, select a value that matches one of the Options
Manager Tracing options, such as Top right.
Import the Line Style Changes back into the ProjectStyles.spp File Using Options Manager
1. Open Options Manager and click Tools > Linear Styles.
2. On the Linear Styles dialog box, click Import.
3. In the Import Linear Styles From window, browse to and select the symbol with the
updated linear styles.
4. Click Open.
Update Drawings
1. Open Drawing Manager and select existing drawings that you want to update with the new
heat trace style.
2. Click File > Out-of-Date Drawings > Update.
Unlike the default offset distance, a user-defined additional heat trace offset distance will not
change dynamically as the zoom level changes in the SmartPlant P&ID drawing view. It is
recommended to turn on the Display as printed option (Tools > Options > General) in
SmartPlant P&ID to get a consistent look for the offset. This limitation will not affect the
print-out results of the SmartPlant P&ID drawings.
This procedure has no impact on the heat trace line offset in translation output files (.dwg /
.dxf / .dgn) created by the SmartPlant P&ID Save As feature.
If you have already specified insulation properties for the item, you cannot subsequently
assign heat tracing properties unless the default heat trace medium was set to Ignore for
the specified insulation spec.
If you assign heat tracing to an item before you assign insulation properties, your choices of
insulation properties and specifications are restricted.
The HT Medium and HT Requirement properties are available from select lists. When you
type the temperature value for the HT Medium Temp property, the software associates the
default unit of measure with the value unless you specify a different unit of measure. Select
list values are defined in Data Dictionary Manager; Format Manager contains definitions for
temperature units.
The location of the heat tracing graphics for piping components, equipment, equipment
components, nozzles, or instruments is determined using the Heat Trace layer in Catalog
Manager.
In Options Manager, you can define the heat trace symbology and if desired, you can
specify whether a particular heat trace medium is defined as a single or a double heat trace.
This affects the way the symbology is applied, as shown in the following examples.
Pipe run, valve and nozzle with single heat trace medium:
Pipe run, valve and nozzle with double heat trace medium:
Note that the double heat trace definition affects the symbology of the pipe run only.
See Also
Define Heat Tracing Graphics for an Item (on page 127)
Modify the Offset Distance of Heat Trace Lines (on page 128)
Assign a Jacketed Heat Trace to an Item (on page 136)
1. Click Settings .
2. Add the desired heat tracing media to the Heat Tracing Media - Jacketed Pipe row, with
each value separated by a comma.
3. Click Tracing .
4. From the Tracing Media list, locate one of the media defined as a jacketed pipe and click
the Style box.
5. Select a new heat tracing style from the list if one has not already been defined or if a
different style is desired.
6. Define styles as desired for the other jacketed pipe media.
7. Click Save .
8. To define standard pipe jacket nominal diameters, do the following:
a. Click Tools > Pipe Jacket Nominal Diameter.
b. On the Pipe Jacket Nominal Diameter dialog box, click Add Row.
c. In the Core NPD column, select a nominal pipe diameter value for the core pipe.
d. In the Jacket NPD Min column and as many of the succeeding columns (Jacket NPD
2, Jacket NPD 3, and so forth), select nominal diameter values for the pipe jacket.
The values in these columns must always be greater than the corresponding
core pipe value.
e. Continue to enter core pipe and jacket diameters until you have all the values that you
need.
f. Click Save and then click Close.
4. In the View window, click the Graphics layer, then while holding down the CTRL key, click
the Jacket layer.
This action makes both layers visible at once.
5. Using the drawing tools, draw the jacket around the symbol.
To display the Jacket layer only, click any layer other than the Graphics or Jacket
layer, then click the Jacket layer.
6. Click Save.
The actual style of the jacketing graphics displayed in the drawing depends on the line
style chosen for the specified heat trace medium in Options Manager. For details of how to
define the jacket style and to designate a heat trace medium as a pipe jacket, see Create a New
Heat Tracing Medium (on page 126).
For a pipe run, if you have already specified insulation properties, you cannot subsequently
assign jacketed pipe properties unless the default heat trace medium was set to Ignore for
the specified insulation spec.
If you define a pipe run as jacketed, you can no longer assign values for regular insulation
properties and specifications. If you desire to specify insulation property values for the
jacketed pipe, you must assign those values using the properties that have the J_ prefix,
which apply only to a jacketed pipe run.
The HT Medium and HT Requirement properties are available from select lists. When you
type the temperature value for the HT Medium Temp property, the software associates the
default unit of measure with the value unless you specify a different unit of measure. Select
list values are defined in Data Dictionary Manager; Format Manager contains definitions for
temperature units.
The location of the jacketed graphics for piping components, equipment, equipment
components, nozzles, or instruments is determined using the Jacket layer in Catalog
Manager.
Options Manager contains the symbology definitions and settings for defining the heat trace
medium as a pipe jacket. This affects the way the symbology is applied to items. In the
following example, graphics were added to the Jacket layer in Catalog Manager for the
inline valve only, therefore jacketed symbology is displayed only for the valve and the pipe
run, but not for the nozzle and the vessel.
When you select a nominal diameter value for a pipe run, the software assigns the minimum
value for the jacket nominal diameter (as defined on the Pipe Jacket Nominal Diameter
dialog box table in Options Manager) to the J_Nominal Diameter property of the pipe
jacket. Also, the software only allows combinations of core pipe nominal diameter and pipe
jacket diameter that are consistent with the values in the table.
To use the Piping Specification Utility with SmartPlant 3D, you must install the SmartPlant
3D Piping Specification Remote Access Client, which is available on the SmartPlant P&ID
product CD under Prerequisite Software.
All of the displayed text strings are maintained as Visual Basic resources in the
PipeSpec.dll file. These strings can be translated or modified as required using a resource
file editor.
When performing piping materials class validations, commodity code lookup, or validation of
nominal diameter for SmartPlant 3D or SmartPlant Reference Data, the Piping Specification
Utility assigns the highest revision number from the SmartPlant 3D or SmartPlant Reference
Data piping materials class to the Pipe Spec Revision property.
Error messages are placed in the PipeSpecError.log file in the folder 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 look-up, the missing properties are listed in the log file.
The ServiceLimits.log file contains any errors encountered during the Service Limit
Validation process, which runs as part of the Piping Specification Utility.
assigned in SmartPlant P&ID to the pipe run in which the piping component resides exceed this
limit.
The units for the PDS 3D maximum temperature are those specified in Options Manager.
If continuous validation is turned on for the PipeSpec utility, then a pipe run with
temperature-pressure limits that do not agree with its PMC generates Error in PMC in the
commodity code for an inline component.
If any temperature values for the pipe run are unspecified, then for SmartPlant Reference
Data or PDS 3D, a value of zero Deg-K is assumed for each of the unspecified
temperatures. For SmartPlant 3D, an unspecified temperature is interpreted as 'undefined'.
SmartPlant 3D can validate commodity codes using the four case temperatures listed earlier
against Maximum Temperature ranges or Minimum Temperatures specified on piping
components in the SmartPlant 3D database.
SmartPlant Reference Data can validate commodity codes using the pipe run’s Design Max
Temp against Maximum Temperatures specified on piping components in the SmartPlant
Reference Data database. Other case maximum temperatures or minimum temperatures will
not be used in the validation.
If the temperature falls within the allowable limits, the software will return a commodity code;
otherwise, Not in Spec is returned.
SmartPlant Reference Data supports a single maximum temperature only for each option
code.
SmartPlant Reference Data does not return a commodity code for reducers.
The Fabrication Category property of inline piping components is a select-listed property in
SmartPlant P&ID. A relationship between the fabrication category and the commodity name
can be defined in the PDS 3D database. The Commodity Name is a unique name for
every symbol. In PDS 3D, this unique name is the AABBCC Code property. In SmartPlant
P&ID, the commodity name corresponds to the Short Value entry of the Piping Component
Type select list for the symbol defined in Data Dictionary Manager and it is this value of the
commodity name that is used for the look-up. For a delivered SmartPlant symbol, the Short
Value entry is equivalent to the symbol's AABBCC Code, defined in Catalog Manager.
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 SmartPlant 3D. Short Value for the Option Code
select list contains the SmartPlant 3D indices corresponding to the appropriate Option Code
text in SmartPlant P&ID. The Piping Specification Utility uses the entries in the Short Value
box of the Option Code list to obtain the Option Code used in the SmartPlant 3D database
tables.
If continuous validation is turned on for the PipeSpec utility, then a pipe run with
temperature-pressure limits that do not agree with its PMC generates Error in PMC in the
commodity code for an inline component.
With continuous validation, not only is the commodity code defined automatically, but for
PDS 3D, so is the Fabrication Category property for the inline components, if the
relationship is defined in your PDS 3D database.
Adding or changing the option code can change the commodity code, if the relationship is
defined in your PDS 3D database.
If continuous validation is not activated but other appropriate settings and program IDs are
assigned, you can still click the Calc button for the Commodity Code property and
choose a code. However this does not verify that the component agrees with a piping
specification.
For additional information about the behavior of specific 3D databases when returning
commodity codes, see Using the Piping Specification Utility (on page 137).
If you need to change or modify a loop, and the loop has instrument(s) already assigned to
it, you can use the Updating Associated Instruments with Loop Properties (Properties
Window) command to select those instruments whose properties you want to update to
match the changes in the loop.
If an instrument-loop association is attempted and the resulting instrument item tag is a
duplicate, the association will be canceled and the instrument tag will retain its original value.
This can occur for single or multiple instrument-loop associations.
If an association is made between a loop and a select set consisting of several instruments
and the generated item tag for some of the instruments will be duplicates, no associations
will be made for the duplicate instruments. A message will be displayed for each duplicate
instrument indicating that the instrument tag will retain its original value.
You can assign the Loop Tag qualifier to instruments that are already placed in your
drawing or that reside in the stockpile.
Since loops are logical collections of instruments rather than physical groupings, you do not
need to place the loop symbol in the drawing itself to create an occurrence. Instead, placing
the loop in the stockpile adds the loop to the model.
You can assign a group of instruments and other elements to a loop by creating a select set
of them and assigning the correct loop tag for the set.
Instrument loops normally reside in a stockpile with their members residing on drawings.
Moving the instrument loop 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 (on page 171).
After you create instrument loops, you can create a customized loop report to generate lists
of items in specific loops in your drawing or plant, or you can open the Engineering Data
Editor to display elements of the loop.
If you need to refresh the instrument Loop Tag Suffix display in the Properties window,
clear selection of the instrument and then select it again.
If the Properties window is not visible, you can display it by selecting the instrument or loop
and then selecting Edit > Properties on the main menu bar.
Legend
Italics: Required for checking item tag uniqueness.
Bold Italics: Required for the item tag, but can be generated automatically.
Instrument
Item Tag Structure Instrument Type Modifier Measured Variable Code Tag Sequence Number
Loop Tag Suffix Tag Suffix
Instrument Loop
Item Tag Structure Instrument Loop Function Tag Sequence Number Tag Suffix
Pipe Run
Item Tag Structure Unit Code Tag Sequence Number Tag Suffix Fluid Code
Duct Run
Item Tag Structure Unit Code Tag Sequence Number Tag Suffix
Equipment
Item Tag Structure Tag Prefix Tag Sequence Number Tag Suffix
Room
Item Tag Structure Tag Prefix Tag Sequence Number Tag Suffix
Nozzle
Item Tag Structure Tag Prefix Tag Sequence Number Tag Suffix
Item Tag Structure Unit Code Operating Fluid Code Tag Sequence Number Tag Suffix
To refresh the instrument loop tag suffix in the Properties window, clear the selection of the
instrument and then select it again.
All calculated item tags listed in the table are read-only.
For information on customizing the software, including item tag formats, see the SmartPlant
P&ID Programmer's Guide.
To use these files, you must rename the ItemTag.dll file installed on your computer (for
example, rename the file to DeliveredItemTag.dll), then copy from one of the product CD
sub-folders (ActiveProjectAgainstAs-Built or ActiveProjectAgainstAs-BuiltAndProjects)
the ItemTag.dll flavor that you want to use. Place this copy in the same location as the installed
ItemTag.dll that you just renamed. When you are finished, remove the ItemTag.dll copy, then
rename the delivered copy back to its original name.
Labeling
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.
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.
If you enter text with a recognized unit of measure using a quotes or double-quotes, the
software parses the unit of measure and ignores the double-quotes (or tick marks).
At label creation time, the plant administrator can define text content inside the label with the
SmartText editor in Catalog Manager. In SmartPlant P&ID Engineering, 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 for labels that were placed in
SmartPlant P&ID. 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, such as '1- Point' for single-point placement, indicate that the property applies
under certain conditions.
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.
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.
The text in the label on the OPC is also updated. If the mate OPC has been placed into a
different drawing since the last time this drawing was opened, this change will be reflected in the
updated label.
4. In the Drawing list area, select the drawing whose stockpile you want to add the partner to.
Place a Package
1. Right-click the Package symbol in Catalog Explorer in the Design node.
2. From the shortcut menu, select Send to Stockpile or Send to Drawing Stockpile,
whichever is appropriate.
3. In the Properties window or the Engineering Data Editor, enter a value for the Item Tag
property.
4. In the Drawing view, select items to be part of the package.
5. If you want to create a select set, in the Properties window, choose Select Set from the
Properties box.
6. In the Properties window, click in the Package Item Tag box and select the appropriate
value displayed list.
Some catalog items do not possess the Package Item Tag property, for example,
OPCs and Item Notes. Do not include those items in your select set because the package
item tag does not appear in the Properties window if any member of the select set does not
possess that property.
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 (on page 171).
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.
package item tag does not appear in the Properties window if any member of the select set
does not possess that property.
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 (on page 171).
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.
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 (on page 171).
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.
When modifying or setting the fluid code properties of a line, you always select the fluid
code from a select list. If you do not set the fluid code first, you will see all possible fluid
codes. If you set the fluid system prior to setting the fluid code, then only the fluid codes
applicable to the type of fluid system display. To redisplay a complete list of available fluid
code values, delete the property for the fluid system, and then the complete list of fluid code
values appears.
If the Properties window is not open, you can display it by selecting an item and then
selecting Edit > Properties.
If the Undo button is not available, then the undo list has been cleared, and you can
no longer undo your last action.
The Undo command does not reverse view manipulations; however, the View >
Previous command is still available for that purpose.
Find Command
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.
For detailed information about all your drawing inconsistencies one-by-one, right-click the
selected inconsistency and click Properties. Leave the Consistency Check dialog box
open, and click Find on the Find and Replace dialog box to display information on the next
drawing inconsistency.
Use the Direction options to change the order in which drawing items are found.
Use the Scroll mode options to control how the Drawing view changes when an
inconsistency is selected.
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.
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 single drawing items are found.
On the dialog box, the Find what option is automatically defined according to the
drawing item you selected in the first step.
Selecting Active window disables the Scroll mode option. Selecting Active
Document enables the Scroll mode option.
4. Click Find to search for and select the next matching item in the drawing or click Find All to
select all matches in the drawing.
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.
Controls whether catalog items are placed as substitutions for existing drawing items or placed
normally. When this mode is active, the software places catalog items only when they replace
an existing drawing item. When this mode is not active, the software places catalog items as
usual. The Replace Mode command copies properties of the current item onto the new item.
For SmartPlant P&ID Engineering, this command is disabled.
Reflects one or more selected items about a line or axis that you define.
For SmartPlant P&ID Engineering, this command is disabled.
Rotates one or more items a precise distance or angle about a specified point.
For SmartPlant P&ID Engineering, this command is disabled.
Cuts selected items from the drawing and pastes them to the Clipboard. The selected items
replace the previous contents of the Clipboard. Cut items go to the Stockpile, given appropriate
stockpile settings.
For SmartPlant P&ID Engineering, this command is disabled.
Inserts the Clipboard contents at the specified location. The command is not available if the
Clipboard is empty.
For SmartPlant P&ID Engineering, this command is disabled.
Copying Items
In SmartPlant P&ID Engineering, it is possible to copy a drawing item to the Clipboard for use in
other applications. Items that you copy cannot be placed in SmartPlant P&ID drawings.
Copies selected items to the Clipboard. This command replaces the previous contents of the
Clipboard with the new contents.
Copy an Item
1. Select an item.
6. If you want to construct a select set based on common properties, select those properties
from the Properties list in the Matching properties area of the dialog box.
You can use the CTRL or SHIFT keys to select more than one property value.
You can choose an empty property value for matching criterion, too.
If no properties are displayed in the dialog box, select a line segment or component in
the drawing that already has a property value you know you are interested in.
7. Click the Preview button to see the items that qualify according to the matching criteria
chosen in the previous step. The matching items are highlighted in the Drawing view.
8. Once you have selected the items you want for your select set, click OK. The selected items
are centered in the Drawing view.
9. Use the Selected Items list in the Properties window to display the common properties for
the select set. For more information, see Customize the Properties Window (on page 71).
If you click Cancel, the Select Connected Items dialog box closes, and the original item
is selected in the drawing.
The Equivalent Diameter and Cross Section Area properties are read-only.
2. Run the Equipment List report. For more information on generating reports, see Generate
a Report for an Active Drawing (on page 224).
3. In the resulting report, change the property values as desired by updating the cells in the
appropriate columns.
If a desired property does not appear in the report, you can add it to the report
template. For more information, see Define the Contents of Your Report Template (on page
243).
4. Click File > Save.
5. Click File > Close.
6. In SmartPlant P&ID, click File > Import > Data file.
7. Browse to the Equipment List report that you just created and modified.
8. Click Open.
Description — Allows you to type a description for the item. This box can contain a link to a
Web address, formatted like this: http://www.intergraph.com. You can also link to a file on your
file system by entering the UNC path like this:
file://servername/sharename/directory/document.extension.
Very long descriptions are not displayed in their entirety in labels, reports, and so forth.
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 (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.
Labels do not display very long descriptions in their entirety.
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.
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.
specifications that agree with the properties already chosen; nonetheless, you can choose a
specification from the All list.
If you assign a heat tracing to an item before you assign insulation properties, your
choices of insulation properties and specifications are restricted.
In the Engineering Data Editor, the Actions menu contains the following commands for
manipulating stockpile items:
Delete Stockpile Item Command (on page 49)
Move to Different Stockpile Command (on page 50)
You can also access these commands from the shortcut menu, which opens when you
right-click in the Engineering Data Editor. For more information, see Engineering Data Editor
Shortcut Menu (on page 59).
You can import items into the Stockpile, too, by importing reports with the File > Import > Data
File command on the main toolbar.
Plant item groups, such as instrument loops, packages, safety classes, and so forth,
frequently reside in a stockpile with their members residing on drawings. Moving the plant
item group itself to another stockpile has special limitations:
From a drawing stockpile to the Stockpile — No constraints apply. This action can
occur at any time.
From the Stockpile to a drawing stockpile — If the plant item group contains only
items in the destination drawing or does not contain items in any drawing, this action is
allowed.
From a drawing stockpile to another drawing stockpile — Same constraint as above
applies.
<?xml version="1.0"?> Identifies the XML file and the version used
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.
The status bar at the bottom of the SmartPlant P&ID window displays the progress of
the import activity.
You can populate the stockpile with items from Aspen Basic Engineering exported
spreadsheets and some SmartPlant reports.
3. On the Import Log dialog box, you can click Report in order to open the log file and view
notes on the import process, or you can click Close.
If a format change is made to an exported Aspen Basic Engineering report, you
must make modifications to the import code to accommodate the changed report layout.
Aspen Basic Engineering spreadsheets in either Microsoft Excel or XML format are
supported. These spreadsheets include the Vessel Equipment List, Pump Equipment List,
and Heat Exchanger Equipment.
Stockpile items that come from importing Aspen Basic Engineering data can be easily
updated by re-importing a data file. Previously imported items, whether they remain in the
stockpile or have already been placed in the drawing, are updated with data from the newly
imported file.
Importing Aspen Basic Engineering XML data files allows greater flexibility when importing
data into the software. All three reports: Equipment, Pumps, and Exchangers, are included
in a single XML report so that only one file has to be imported.
You can use the Equipment List, Pipe Run List, and Equipment Nozzle List Reports to
define properties of items already placed in the drawing, too. Items must have an assigned
item tag prior to definition or modification of properties. In addition, these reports can create
occurrences of items in the stockpile.
For more information on import code and other importing parameters, see the Import
Implementation Customization topic in the SmartPlant P&ID Programmer's Guide. To view
this file, on the Start menu, click Intergraph SmartPlant P&ID > Programming Help.
Importing new pipe runs using the Pipe Run List report is a little different because it also
includes SP_ID and Fluid Code columns. The method above is valid, but you must be
careful with row copy and paste because the layout is a little different. Additionally, you must
clear the SP_ID value.
The delivered Item Tag format for pipe runs is unit code - tag sequence number - tag suffix -
fluid code.
Typicals
A typical is a user defined, graphical representation, of a group of objects and their
relationships. On a drawing, a typical marks the position of where similar groups of objects
should appear but have been hidden from view. For example, on a drawing a typical that
contains a series of pipes, a pump, and valves, informs the viewer that at this position on the
drawing there is more than one group of objects that consist of a series of pipes, a pump, and
valves, but have been hidden from view to make the reading of the drawing clearer. To know
exactly what the hidden objects are the viewer needs to switch views, from the primary view to
the typical view. In the typical view the viewer sees all the typicals and their attributes. Though
only the primary typical appears on the primary view, all the typicals and their relationships with
the primary view are maintained. A typical can be repeated any number of times and can
contain any objects/symbols depicted in the P&ID symbol catalog used to convey the logical
plant model, including off-page connectors.
Auxiliary Graphics cannot be viewed on the Typical layer.
Select a View
When creating a typical after selecting the Create Typical command, the software automatically
switches to the typical view. This procedure shows you how to switch between the primary and
typical views, to view already created typicals, and how to view the primary and typical views at
the same time.
For more information, see Select a View (on page 175).
For more information on comparing drawings with SmartPlant P&ID, see Comparing and
Refreshing Versions (on page 199).
Select a View
1. To select the primary view, do one of the following:
Select View > Show Primary.
Right-click, and from the shortcut menu select Show Primary.
Depending on the selected view, Primary, Typical, or Both is displayed in the status
bar, also the respective menu commands and icons on the Typicals toolbar are grayed
out.
When viewing in the Both view you can identify which items are typicals and which are
not, by selecting an item and looking at the Is Typical property in the Properties
window. If the value is True, the selected item is a typical.
This command is only active when the primary or typical view is active.
The AutoGap and the Gap Now commands are disabled in this view.
2. Click (Print).
3. Select the required settings on the Print dialog box. For more details, see the Print dialog
box.
4. Click OK.
2. Click (Print).
3. On the Print dialog box, select the Typicals only check box.
4. Select the required settings on the Print dialog box. For more details, see Printing
Multiple Drawings in SmartPlant P&ID Drawing Manager Online Help.
5. Click OK.
Gapping Lines
A gap in a drawing is a condition that exists when two lines intersect graphically in the drawing
but not physically in the plant.
System Editing
System Editing allows propagation of property values between related items. If you select
Tools > System Editing and a check mark displays by the command, the function is
active. You can also turn on System Editing by clicking . When the command is active and
you make changes to properties in a drawing, those changes are propagated according to
relationships and rules. If the Enable System Editing setting is set to Yes in Options Manager,
then every P&ID drawing in the plant will have System Editing enabled. You can turn System
Editing off but when you turn it back on, it does not attempt to propagate any prior drawing
changes.
If you use Plant Editing to change a property value in a non-active drawing, propagation
occurs according to the System Editing rules defined for the plant and the Engineering Data
Editor display is automatically updated.
System Editing is not supported from or to plant item groups such as loops and packages.
The flow of property values is as follows.
Properties — The properties that can flow across this relationship are those that are listed
as consistency criteria in all of the applicable rules.
Copy and Propagate — A property value can be copied in either direction across the new
relationship and is propagated outward.
For new items, existing values are not overwritten by this process unless one item contains
a Null property value. For example, if different nominal diameter values exit on both sides of
a new connection, the existing nominal diameter values are not automatically changed to
match unless one of the values is set to Null.
When a directional property, for example, Flow Direction and Slope Direction, is propagated, it is
not enough to set the same value on all items the propagation scope. The direction of the
underlying geometry must be compared to the direction of the geometry of the start item. One
of the possible property values must be selected based on the direction of the geometry. In
cases where the direction of the geometry cannot be compared (such as a midpoint branch
condition) no propagation is possible.
When System Editing is enabled for a plant, changed property values are automatically spread
or propagated to related items according to the currently defined consistency criteria. In certain
cases, you may want to set a property value on one item only and not allow it to be propagated
to any related items. The System Editing command (on the Tools menu and the toolbar) allows
you to turn off the propagation functionality temporarily during a design session. After the
change has been made, you can use this same command to turn it back on again. System
Editing is always turned on when you start a new design session.
System Editing can be enabled or disabled for the entire plant by means of the Enable System
Editing setting that is exposed through Options Manager. For new plants, the value of this
setting is True by default. For upgraded plants, the value of this setting is False. This allows you
to enable System Editing for an upgraded plant at the time of your choosing.
Add Folder — Adds an empty folder to the Tree. You can use Rename to define a name
for the folder. These folders can be used to organize display sets.
Add Display Set — Creates a new display set. You can use Rename to define a name for
the new display set.
Add Filter — Displays the Select Filter dialog box. Select any displayed filter to add it to
the current display set.
Save — Saves the selected display set.
Rename — Allows you to click on an item in the Tree and rename it.
Move Up — Allows you to move the selected filter name up in the list.
Move Down — Allows you to move the selected filter name down in the list.
'Filter for' value 'Do not show Resultant Behavior when Applying Display Set
labels...' setting
Label: Model Item Selected Label colors are independent of model item colors;
labels are hidden when model items are hidden.
Label: Model Item Cleared Label colors are independent of model item colors;
labels display when model items are hidden.
Label: Catalog Item Selected or cleared Label colors are the same as the model item
(optional) colors; labels are hidden when model items are
hidden.
Filtering behavior for label colors depends on the value of the Filter for property in the label
filter and the Do not show labels for filtered items check box setting on the View
Properties dialog box Display tab (the Labels check box must always be selected to
enable the Do not show labels for filtered items check box). The following table
summarizes the behavior.
'Filter for' value 'Do not show Resultant Behavior when Applying Display Set
labels...' setting
Label: Model Item Selected Label colors are independent of model item colors;
labels are hidden when model items are hidden.
Label: Model Item Cleared Label colors are independent of model item colors;
labels display when model items are hidden.
Label: Catalog Item Selected or cleared Label colors are the same as the model item
(optional) colors; labels are hidden when model items are
hidden.
When specifying line widths for display sets, you can set label graphics and leader lines to
appear in the default width of the labels regardless of the line width value specified for model
items. This option is specified by using a key 'IgnoreDisplaySetWidthOnLabels' under the
'Options' section of the SmartPlantPID.ini file (located in the users\<username> folder) as
shown:
[options]
WaterMarkWhileWorking=True
WaterMarkWhilePrinting=True
undosteps=0
autogapping=False
ConsistencyChecks=True
.
.
.
IgnoreDisplaySetWidthOnLabels=1
The following table shows how the values assigned in the SmartPlantPID.ini file affect the
output.
For a display set that contains one or more asking filters, on clicking Apply, the Asking
Filters dialog box opens with the default values for each asking filter, allowing you to change
the operators and values of each asking filter's attributes, if desired. The attribute values you
selected are used when saving or printing the drawing and those values are retained until
the display set is cleared for that drawing. This applies on a per drawing basis; therefore if
the same display set is applied to more than one drawing, you can enter different attribute
values for each asking filter and those values are retained independently for each drawing.
Filter details
Displays the details of the selected asking filter. Name, Item type, Match all / Match any, and
Attributes fields are read-only. You can change the Operator and Value for each attribute as
desired.
Updates the line width and color symbology for your active drawing.
For SmartPlant P&ID Engineering, this command is disabled.
Assemblies can be created in one plant and used in another. However, the file structure
and symbols must be identical. If you try to place an assembly into a plant that uses a different
file structure, you get an error message that the software cannot find your reference files. The
assembly placement quits. Move the symbols that cannot be found to the location indicated in
the error message.
When creating or placing assemblies, a log file is created for each action. The log files are
placed in the Temp directory and are named <AssemblyName>_CreAsm.log and
<AssemblyName>_PlaAsm.log.
The following is an example of the log file created when creating assemblies.
Source Drawing Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\Drawings\38\38-PI- 0001.pid
Assembly Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\RefDatA\P&ID Reference
Data\Symbols\Assemblies\Equipment\VesselAssembly.pid
Number of graphic items processed = 1
Number of database items processed = 1
Number of attributes processed = 15
Finished creating assembly.
The following is an example of the log file created when placing assemblies.
Assembly Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\RefDatA\P&ID Reference
Data\Symbols\Assemblies\Equipment\VesselAssembly.pid
Target Drawing Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\Drawings\38\38-PI- 0001.pid
Number of graphic items processed = 1
Number of database items processed = 1
Number of properties processed = 15
Finished placing assembly.
Create an Assembly
1. Select several components in the drawing.
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.
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.
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.
Projects claim objects in either Exclusive (default) or Shared mode. If you plan to use the
project in an integrated environment, Shared mode is mandatory. Use the Settings view in
Options Manager to set the Claim Mode before creating a project.
When publishing from a project, an instruction container, which contains all the claimed
objects, is created within the tombstone file. Therefore, if you create a new item in a project
and you want that item to be included in the instruction container, you must first merge that
item to the As-Built and then claim it back to the project.
You can change the Claim Mode to Shared at any time. However, you can change the mode
to Exclusive only when there are no claims in any project in the Plant.
Claiming Items
A project in the Plant frequently deals with a subset of items within a drawing. The Claim
functionality provided by SmartPlant P&ID allows you to grant control of an item to a project.
Since claiming makes it possible for a project to work on an item-by-item basis, claiming fosters
an ability to define the scope of work as narrowly as necessary.
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 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.
Properties of items that are not claimed by the active project cannot be changed. 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 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 cannot 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.
Partial Claim
When an item has a relationship with another item that has been claimed, but is not itself
explicitly claimed, it is said to have Partial Claim status, denoted by . Partial claim only
applies to objects connected to pipe runs (inline components such as instrumentation and piping
components).
Partial claim works automatically when a claimed pipe run is ‘broken’. There is a routine that
determines which side of the broken pipe run gets the new GUID and which side maintains the
original GUID. Inline components on the side that gets the new GUID receive Partial Claims
status, which is only for the purpose of changing their database relationship to the pipe run with
new GUID. Data cannot be edited on items that are ‘claimed for relationship purposes’.
See Also
Claim a Drawing Item (on page 194)
Claim Command
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.
This command can only be used for items that belong to the active drawing.
See Also
Claim a Drawing Item (on page 194)
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.
In Exclusive claim mode, the software allows the user to claim all the selected items that
were not already claimed by other projects. The claim log shows which items could not be
claimed because they were already claimed by other projects.
Claiming items clears the Undo stack. Thus claiming is not an undoable command.
You can only claim an item in the Engineering Data Editor if that item belongs to the active
drawing.
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.
The claim mode (Exclusive or Shared) 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.
See Also
Controlling Access (on page 195)
Modifying Properties (on page 195)
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.
You must have full control permissions on P&ID Objects before you can claim any drawing
items. For more information, see User Access in SmartPlant Engineering Manager Help.
Modifying Properties
Claiming impacts properties modifications in the following manner.
Properties Window
When you select a claimed item, the Properties window allows the properties of that item to be
viewed and modified. When you select an item that has not been claimed, the Properties
window allows the properties to be viewed but not modified. The properties of unclaimed items
are read-only.
When you select a line segment, the Properties window displays the properties of the
associated pipe or signal run. If the run has been claimed, the properties can be edited;
otherwise, the properties are read-only.
When you select multiple items, if they are all claimed, the Properties window allows them to be
modified. If any of the selected items are not claimed, the Properties window treats the whole
group as read-only.
Implied Items
When a drawing item is claimed, it means that you can modify that model item and all of its
implied items. If a model item is not claimed, the user cannot modify any of the implied items
that the model item owns.
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 cannot be changed. For more information about validating
properties, select Start > Programs > Intergraph SmartPlant P&ID > Programming Help and
see the Extending the Capabilities of SmartPlant P&ID and Logical Model Automation
Reference topics.
From version 2009, you can use the validation and calculation functions on drawing item
type. The software uses the same automation interface managing all other item types.
If you are working in SmartPlant environment and there are any differences between an item
in the Project and an item in the As-Built, the claim cannot be released. If you are not
working in the SmartPlant environment, the claim can be released. Also, items that display
no warnings or errors are released.
This command can only be used for items that belong to the active drawing.
Release a Claim
1. In the Drawing view or Engineering Data Editor, select the items for which you want to
release claims.
2. Right-click the item or select set and click Release Claim. If there are any errors or
warnings during the release, the Release Claim dialog box displays. Review any warnings
and error messages about each item.
3. Click OK to complete the claim release operation.
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 (on page 199).
You can only release the claim on an item in the Engineering Data Editor if that item
belongs to the active drawing.
Opens when you select one or more items and click Edit > Claim Status on the main menu bar.
You can review the details of the claimed state of the selected items, claim items, release the
claims to items, and discover other details of the claim status. To perform an action on an item
(claim, release claim, or show details), you must first select the row of the item. Hold down
CTRL or SHIFT to select multiple items.
Item Tag — The tag that identifies the item. If a selected item that appears in this dialog box
does not have an item tag, the value is blank.
Item Type — The item type to which the item belongs, for example: Mechanical, Nozzle,
PipingComp, SignalRun.
Claimed — Indicates the claim status of items claimed in the current project. An item claimed
by your active project is denoted by ; an item with an invalid claim on it is denoted by ; an
item which has a relationship with another item that has been claimed, but which itself was not
explicitly claimed is denoted by (partial claim); otherwise, this field is blank.
Claimed by Others — Indicates the claim status of items claimed by other projects. The
symbols are the same as for the Claimed column. If you are working in 'Exclusive mode', you
cannot claim an item that is already claimed by another project.
Claim — Opens the Claim dialog box, where 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, where 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.
See Also
Claim a Drawing Item (on page 194)
You define the line color and weight used to designate claim status on the Claims tab of the
View Properties dialog box.
If you turn on the display of claim status in the drawing, then when you print the drawing, the
claim status will be plotted.
Data refers to a mismatch in the properties assigned to an item that exists in both drawings;
that is, a change, addition, or deletion of a property in the Properties window or
Engineering Data Editor in SmartPlant P&ID or through automation.
Every change grouping and every changed item is assigned a category, and if more than one
category applies (for instance, if you move an item and change one of its properties), then the
highest priority category is displayed.
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.
Two versions exist in different databases — The right-hand view is reserved for the version
in your active Plant or project database, and the left-hand view belongs to the version in
another database because you cannot be assured that time-order is the logical order to
display the versions.
You can also compare the differences between the typicals of either drawing. Using the select
list situated in the drawing name bar of each view, you can display the primary, typical, or both
views of the selected version.
Toolbar Commands
The toolbar commands apply to the Drawing views.
For icons that display a drop down-arrow, you can apply the command to either the right
or left view.
Compare Options — Opens the Compare Options dialog box, which allows you to
customize the colors that the various comparison states are displayed in. That color coding is
then displayed in the status bar as a static reminder.
Generate Report — Opens Microsoft Excel and creates a report of the information
contained in this comparison session. This report lists the same information that is displayed in
the Change groups and Change details lists (change groups, item types, claim statuses, and
so forth).
Find in List — Zooms to the Change details list entry that corresponds to an item you
select in either Drawing view. In general, if you select a drawing item that exists in the list,
then the list display automatically zooms to that entry.
Find in Drawings — Manipulates the Drawing views so that the selected element is listed
in the Change details and the Change groups list is centered in the appropriate Drawing view.
You must first select an item in either the Change groups or Change details area.
Zoom Area — Enlarges the selected area in one or both Drawing views by allowing you to
draw a fence around the area.
Zoom Out — Reduces the display of the selected area where you click.
Fit — Fits all the drawing elements into the visible viewing area of the active
drawing. Selecting part of the drawing and clicking Fit fits the selected area into the visible
viewing area of the active drawing.
Pan — Allows you to move the display in any direction from a specific point in one or both
Drawing views in order to see other areas of the view by dragging the pointer across the
display.
Drawing Views
The left and right drawing views display the two versions of your drawing being compared. The
display above the drawing view shows the drawing name and the version. The select list in the
display allows you to choose the drawing layers to be compared and can be selected
individually for each version. Possible select list values are Primary, Typical, or Both.
If you compare two versions from different projects, the version that belongs to the other project
appears in the left Drawing view and the version that belongs to your active Drawing Manager
project appears in the right Drawing view. If you compare two versions from your active
project, then the latest version appears in the right Drawing view.
At the top of each Drawing view, the Plant or project, the name of the drawing, and the version
is displayed explicitly. You can move the bars between the different views according to your
needs. If you double-click on the divider between the left and right Drawing views, then the
software automatically adjusts the two views to be the same-size.
Properties Window
Displays two columns of properties for an item selected in a Drawing view or in the Change
details list. The left-hand and right-hand columns correspond to the left and right Drawing
views. If a deleted item is selected (the item exists in left view, but not the right view), the
properties for that item are listed in the left-hand column and the right-hand column is empty. If a
modified item is selected, values from both versions show in their respective columns in the
Properties window. If a new item is selected, that is, the item exists in right view, but not the left
view, the properties for that item are listed in the right-hand column and the left-hand column is
empty.
Properties Commands
Allows you to customize the properties that are displayed in the Properties window.
Alphabetical — Lists properties in alphabetical order. This button acts as a toggle and is
available when properties are displayed categorically.
Show Modified — Toggles the display of only those properties of the selected drawing item
that are different in the versions. This button applies only to modified items that exist in both
versions; for added and deleted items, all properties are listed.
Change groups
Lists the changed items in groups. A listed item contains all the items this change effects. You
can sort the list be clicking the column headings.
For SmartPlant P&ID Engineering, the refresh action is not allowed.
Check box column — Displays colors in the drawings as defined using Compare Options. If
not selected, the Default items color displays.
Number — Displays an arbitrary number that is assigned to a logical change group when this
dialog box is opened. The number has no intrinsic meaning and may apply to a different group
the next time you open this dialog box.
Action — Defines which action is to be taken involving the selected change. Options include:
No Action — No drawing changes are applied.
Refresh — Applies any drawing changes to the open drawing version.
Identifier — Lists item tags for the principal member of the change group, if an item tag is
assigned to that object. For instance, if a change group centers around data differences for a
vessel and its nozzles, then the item tag for the vessel is displayed in this column.
Category — Displays the category of the change, listed in order of highest to lowest priority.
Options include:
Data — Indicates that a property value has changed (for example, a property value for a
vessel).
Graphic — Indicates that a change has been made to an item in the drawing (for example,
a vessel has been moved).
Claimed — Displays an overview of the claim status of the individual items in the group.
Possible values are All, Some, or None.
Valid Claim — Indicates that the claimed item is a valid claim.
Change details
Lists all the individual items that belong to the group that you select from the Change groups
list. You can sort this list by clicking on any of the column headings.
Result — Displays one of three possible values: Left-Only, Right-Only, and Different.
Left-Only denotes an item that exists in the left-hand version only, implying that the item is
deleted from the right-hand version. Right-Only denotes an item that exists in the right-hand
version only, implying that the item was added to the right-hand version. Different denotes a
difference between the properties or graphical elements of an item that exists in both versions.
Change — Describes what action is required to make the drawing in the right frame match the
drawing in the left frame. Actions include:
Add — Adds the listed item to the version on the right.
Delete — Removes the listed item from the version on the right.
Modify — Changes the listed item in the version on the right.
When a plant item group is sent to the Plant Stockpile and after creating a new version of
the drawing, that plant item group is assigned to a piece of equipment or an instrument, the
Change column displays the value Delete. Plant Item Group types that are affected by this
behavior are: Contract Package, Hydro Test Package, Package, Instrument Safety Class, Test
System, and Hydraulic Circuit. If the plant item group is sent to the drawing stockpile, the
behavior is identical; however, the Change column displays the value Modify.
Item Type — Describes the item type, such as Instrument, PipeRun, or Nozzle.
Specific Item Type — Displays the specific type of item, such as 3-Way Ball Valve, Piping, or
Flange Orifice.
Item Tag — Displays the item tag of the individual item in question if a tag has been assigned to
the item.
Category — Displays the highest priority category of change that applies. Possible categories
are:
Data — Indicates that a property value has changed (for example, a property value for a
vessel).
Graphic — indicates that a change has been made to an item in the drawing (for example,
a vessel has been moved).
Claimed — Displays the claim status of the object:
— Valid claim
— Invalid claim
Not claimed.
Added to Primary
Added to Typical
Moved to Typical
Moved to Primary
No Change in Typical
No Change in Primary
Status bar — Displays the currently defined colors for illustrating comparison status. You can
change the color scheme by clicking the Compare Options button on the toolbar and
defining options on the Compare Options dialog box.
See Also
Claim a Drawing Item (on page 194)
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.
See Also
Claim a Drawing Item (on page 194)
4. Click OK.
5. On the Compare and Refresh dialog box, review the information in the Change groups
and Change details areas. Your current drawing displays on the right side of the
screen. The version you are comparing it to displays on the left.
8. Click OK to refresh the drawing and accept any changes or Cancel to dismiss the dialog
box.
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 that there is only one group and a data change was located. All
items in the group are valid claims. Change details indicates that the comparison located a
different property value (Cleaning Requirement) in the current version.
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 that there is only one group and a graphic change was
located. All items in the group are valid claims. Change details indicates that the comparison
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 data allows you to take no action
or refresh (accept the previous location of the vessel). The settings are not applied to a version
until you click OK.
Consistency Checking
Consistency checking verifies the suitability of work that a designer performs while creating the
drawing. The software verifies, in real-time, if the composition of a drawing and the underlying
data model satisfy rules that your company has defined. The software includes pre-defined
standard industry design propagation: for example, pipe runs inherit properties from nozzles.
Additional consistency checking and design propagation are defined in Rule Manager.
Consistency checking continuously monitors your work when you change items on a drawing.
The software displays all the inconsistencies, describes specific problems, and offers hints.
Using these solutions, you can decide the best method to resolve an inconsistency. One
solution is to approve a warning and thereby remove the inconsistency from the drawing.
Another solution is to copy the same value from one side to the other side and then propagate.
This illustration shows the inconsistency indicators that highlight incorrect relationships at a
junction of items in a drawing. An error appears where the pipe run connects to the pump nozzle
(A). A warning appears at the point where the valve and pipe run intersect (B). An approved
warning accompanies the off-page connector (C).
attribute breaks, and pipe segment breaks where those properties for which a discontinuity is
expected are the same on either side of the break.
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.
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.
The Consistency Check dialog box contains the Inconsistencies Tab and the Consistency
Criteria Tab.
Item 1 — Displays the inconsistency, item type, and item tag for the first item that is connected
by the active relationship. When the Consistency Check dialog box first appears, all items
involved in the inconsistency are selected.
Relationship — Displays the number for the active relationship and allows you to select the
relationship to be reviewed. The drop-down list contains a number for each relationship that
exists at the selected point. The graphic relationship indicator that corresponds to the number
shown in this control is highlighted.
Item 2 — Displays the inconsistency, item type, and item tag for the second item that is
connected by the active relationship. When the Consistency Check dialog box first appears,
all items involved in the inconsistency are selected.
Highlight item 1 — Place a check mark in the check box to highlight the item in the
drawing. This helps you to quickly locate the selected object. By default, this option is not
selected.
Highlight item 2 — Place a check mark in the check box to highlight the item in the
drawing. This helps you to quickly locate the selected object. By default, this option is not
selected.
Inconsistencies — Displays the inconsistencies at the selected relationship. For each
inconsistency, the status, severity and description are displayed. The icons used for the status
column are the same as the icons used for inconsistencies in the Drawing View. The first
inconsistency in the list is automatically selected. You can select any of the inconsistencies with
a mouse click or the arrow keys.
Description — Displays the actual error or warning. For a lengthy error or warning, a ToolTip
appears to reveal the entire description. You cannot change the inconsistency description, which
is provided for information only.
Solutions — Displays the list of available solutions for the selected inconsistency. The same
solution that was previously selected is automatically selected again. If none was previously
selected, the first solution in the list is automatically selected. Some of the solutions copy a
property value across the relationship and initiate propagation. When one of these solutions is
selected, the propagation scope is highlighted. This shows the items that will be changed before
they are modified. After selecting an inconsistency from the Inconsistencies list, you can
select the correct solution from this list, and after clicking Apply, the selected solution is
performed.
Apply — Performs the solution you choose from the Solutions box. The inconsistencies are
then re-evaluated and the dialog box is updated.
Consistency Criteria — This list view shows all of the properties to be compared and copied at
this relationship. These consistency criteria come from the rules that apply to this relationship.
The consistency criteria for each rule are originally specified within the Rule Manager. The name
of the source rule is shown in the first column. The remaining columns are the same as shown in
the Consistency tab of the Rule Properties dialog box in Rule Manager. Single selection
mode is supported.
Item 1 — Displays the inconsistency, item type, and item tag for the first item that is connected
by the active relationship. When the Consistency Check dialog box first appears, all items
involved in the inconsistency are selected.
Relationship — If there are multiple relationship indicators at the same location, all of them are
loaded into the Consistency Check dialog box. Each relationship indicator is assigned a
number. The numbers are loaded into the drop- down list on the Relationship control. You can
review each one individually by selecting from the entries in the drop-down list.
Item 2 — Displays the inconsistency, item type, and item tag for the second item that is
connected by the active relationship. When the Consistency Check dialog box first appears,
all items involved in the inconsistency are selected.
Highlight item 1 — Place a check mark in the check box to highlight the item in the
drawing. This helps you to quickly locate the selected object. By default, this option is not
selected.
Highlight item 2 — Place a check mark in the check box to highlight the item in the
drawing. This helps you to quickly locate the selected object. By default, this option is not
selected.
Compare — Displays how the property values from Items 1 and 2 are compared. The
comparison occurs whenever any property on either item is changed. The following table
describes the possible values and their meanings
None No comparison
= Equal
Item 2 Property — Displays the name of an Item 2 property to be copied and/or compared.
Typically, this property name is the same as the Item 1 Property. However, there are some
cases where the property names are different. This property must have the same data type as
the property listed for Item 1.
Review an Inconsistency
1. Open a drawing.
2. Double-click an inconsistency indicator.
In addition, you can right-click an inconsistency indicator and select Consistency
Check.
3. On the Consistency Check dialog box, review the list of possible problem areas at the
junction.
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.
To alert you to possible problems, the Drawing view offers different inconsistency indicators:
Resolve an Inconsistency
1. Open a drawing.
2. Double-click an inconsistency indicator.
Or you can right-click an inconsistency indicator to review its properties.
3. On the Consistency Check dialog box, select the inconsistency that you want to correct in
the list.
4. Chose the appropriate solution from the Solutions list.
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.
Errors
Warnings
Approved warnings
A Drawing view also offers graphical symbols to alert you to possible problems:
Generating Reports
Reporting is the process of retrieving information from the database and displaying the
information as formatted output. At any time during the design creation process, you can create
a report. Each report consists of a Microsoft Excel workbook and a report definition, which
describes the data to collect and how to organize the data in the workbook.
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 SmartPlant P&ID 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.
When you generate a report, 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.
To create a Plant wide report, use the Engineering Data Editor commands View > Plant
Reports or My Reports.
You must have Microsoft Excel installed on your computer to display reports.
When generating a report, the software displays all report templates with unique names. If
templates with the same name exist having .xlsm and .xls formats, the software displays
only one of these templates in the format that depends on the installed version of Excel:
.xlsm for Excel 2007 or later and .xls for earlier versions of Excel.
The software stores the reports that you generate in your Windows directory under
\Profiles\username\My Reports\Output.
You must have Microsoft Excel installed on your computer to display reports.
When generating a report, the software displays all report templates with unique names. If
templates with the same name exist having .xlsm and .xls formats, the software displays
only one of these templates in the format that depends on the installed version of Excel:
.xlsm for Excel 2007 or later and .xls for earlier versions of Excel.
The software stores the reports that you generate in your Windows directory under
\Profiles\username\My Reports\Output.
Before running any Line List report, verify that every line in the selection has an Item Tag.
When applying an AutoFilter, if the number of data records in the Engineering Data Editor
exceeds the maximum, the Query Results dialog box opens indicating the total number of
rows found before the AutoFilter was applied. If you choose to continue with the query in
order to generate a report, the Engineering Data Editor view does not show any headers or
records; instead, it displays the text 'Report only mode' and indicates the number of items
returned by the AutoFilter out of the total number of items available before the AutoFilter was
applied.
You can then generate a report based on the AutoFilter results. The AutoFilter is honored
for the report until another item type is selected in the list or the AutoFilter is turned off.
2. Click the down-arrow next to the View menu button and do one of the following:
Click Plant Reports to select a report that was released to the Plant.
Click My Reports to select a customized report that you defined already.
3. On the Plant Reports dialog box or the My Reports dialog box, select the report that you
want to generate.
4. In the Report using area, choose the items that you want to report on.
You must have Microsoft Excel installed on your computer to display reports.
When generating a report, the software displays all report templates with unique names. If
templates with the same name exist having .xlsm and .xls formats, the software displays
only one of these templates in the format that depends on the installed version of Excel:
.xlsm for Excel 2007 or later and .xls for earlier versions of Excel.
The software stores the reports that you generate in your Windows directory under
\Profiles\username\My Reports\Output.
Before running any Line List report, verify that every line in the selection has an Item Tag.
When applying an AutoFilter, if the number of data records in the Engineering Data Editor
exceeds the maximum, the Query Results dialog box opens indicating the total number of
rows found before the AutoFilter was applied. If you choose to continue with the query in
order to generate a report, the Engineering Data Editor view does not show any headers or
records; instead, it displays the text 'Report only mode' and indicates the number of items
returned by the AutoFilter out of the total number of items available before the AutoFilter was
applied.
You can then generate a report based on the AutoFilter results. The AutoFilter is honored
for the report until another item type is selected in the list or the AutoFilter is turned off.
2. Click the down-arrow next to the View menu button and click Edit View.
3. Click Advanced.
4. Under Edit, from the Property list, select Rep Drawing Name.
5. From the Operator list, select =.
6. In the Value box, type <Drawing name 1>.
7. For additional drawings, enter Rep Drawing Name = <Drawing name 2>, and so forth.
For multiple entries for drawing names, be sure to select Match any.
You must have Microsoft Excel installed on your computer to display reports.
When generating a report, the software displays all report templates with unique names. If
templates with the same name exist having .xlsm and .xls formats, the software displays
only one of these templates in the format that depends on the installed version of Excel:
.xlsm for Excel 2007 or later and .xls for earlier versions of Excel.
The software stores the reports that you generate in your Windows directory under
\Profiles\username\My Reports\Output.
Before running any Line List report, verify that every line in the selection has an Item Tag.
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.
4. Add the following code to the Excel report workbook code sheet:
Public Sub RunWorkbook()
objRunWorkBook.RunWorkbook Me
Exit Sub
mErr:
MsgBox Err.Description
Application.Quit
End Sub
The header is part of the tabular format report template where data is not mapped
based on rows. That is, you are free to type a label and map report item properties
anywhere in the lines that you designate for your header.
The header is a good place to put information that applies to all the items in your report,
such as Unit or Plant Name.
Also, you can add graphics in your report header.
Be sure to include space in your header for the labels of your columns.
3. Choose the number of empty lines that you want between rows in your report. Each row is
filled with properties for one item.
Some report templates, for example some Line List reports, designate two rows of
data for each report item and then an empty row.
4. If you want to sort the map properties, under 'Map Properties' sort order, click Ascending
or Descending.
When sorted in ascending or descending order, the properties that have sub-properties
appear first sorted alphabetically, followed by the properties that do not have
sub-properties, sorted alphabetically.
For a summary report, the list entry Report Item Group Total that appears at the lowest
level is always at the bottom of the list, regardless of the sort order selected.
5. Click OK to close the Options dialog box.
6. Complete general labels and graphics, if needed, in your header.
7. Complete column headings in the last row of your header.
8. Select a cell in your report template where you want to map a particular property.
This cell can be either in the body of the report or in the header.
9. 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 (on page 243).
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.
10. Repeat the previous steps until you have mapped all the properties that you want to map on
this report template.
11. Save the template and quit Microsoft Excel.
Because the delivered report templates have a 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.
Each item in the report has its own page. The properties of the first item are displayed
on the first worksheet, but the properties for subsequent items in the report are
displayed starting with the third sheet because the second worksheet is tabular format.
On the SmartPlant Reports toolbar, you use the Options command 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 to
on your worksheet; however, the Options command is available for you to use in the
tabular portion of the composite report template.
2. Define the layout of the second Microsoft Excel worksheet. In a composite format report
template, the second worksheet is automatically tabular format. For more information about
defining tabular format report templates, see Define the Layout of a Tabular Format Report
Template (on page 231).
3. After you have defined the layout for the first and second worksheets in your report
template, save the template and quit Excel.
You can map only one property into a given cell, although you can map the same property
to more than one cell.
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.
New Command
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.
You can create a new report template based on an existing template by specifying a
source template also. For more information, see Create a Report Template Based on an
Existing Template (on page 236).
Since delivered reports are all in tabular format, you must choose Blank if you want a
fixed or composite format report template. You can select Blank for a tabular format
report template, nonetheless.
3. In the Name box, type a meaningful name to describe the report template you are creating.
This entry is the name of your Microsoft Excel workbook. When you save the template,
the software appends the .xls extension to the name.
4. In the Item type box, select an item type.
5. In the Report type box, choose template format.
These options are only available when you choose Blank from the Source template
list.
6. In the Description box, type a description for the template.
7. If you want this template to be available at the plant-level, select the Add to plant reports
option.
You must have the appropriate permissions, granted in SmartPlant Engineering
Manager, to create plant-level report templates.
8. Click OK to create the template.
9. When the software gives you the option to edit your new template in Microsoft Excel, click
OK and define the layout and contents of the template. For more information about these
procedures, see the following topics:
Define the Layout of a Tabular Format Report Template (on page 231)
Define the Layout of a Fixed Format Report Template (on page 233)
Define the Layout of a Composite Format Report Template (on page 234)
Define the Contents of Your Report Template
When creating a new report template, the software saves the file in the format that
depends on the installed version of Excel: .xlsm for Excel 2007 or later and .xls for earlier
versions of Excel.
Define the Layout of a Tabular Format Report Template (on page 231)
Define the Layout of a Fixed Format Report Template (on page 233)
Define the Layout of a Composite Format Report Template (on page 234)
Define the Contents of Your Report Template
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.
You must have valid privileges to edit a report template.
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.
Delete Command
Displays the Delete Report Template dialog box, which allows you to select and delete a report
template.
You must have valid privileges, granted in SmartPlant Engineering Manager, to delete a
report template.
Appears when you are editing or creating a report template in Microsoft Excel.
Define Command (on page 240)
Options Command (on page 245)
Map Properties Command (on page 248)
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.
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.
To create a report definition (a list of report item properties available to include in your template),
use the Define Report Items dialog box, which opens when you click Define on the Define
Report Contents dialog box. A report definition describes how to collect the properties data and
how to format it in a report. Each report item is based on an item type (equipment, nozzle, pipe
run, instrument, and so forth) and controls how the properties of that item type, or item types
related to it, are retrieved from the database.
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.
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.
Properties Tab
Displays properties for a report item so you can select properties to use in your report template.
This tab is part of the Define Report Items dialog box, which opens when you click Define on
the Define Report Contents dialog box.
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 that contains 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 CTRL and SHIFT 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 CTRL and SHIFT
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.
Filter Tab
Defines the filter that you want to use for your report item. This tab is part of the Define Report
Items dialog box, which opens when you click Define on the Define Report Contents dialog
box, which, in turn, opens when you click Define on the SmartPlant Reports toolbar.
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.
Sort Tab
Defines the cells that you use to sort the report items and how. This tab is part of the Define
Report Items dialog box, which opens when you click Define on the Define Report Contents
dialog box, which, in turn, opens when you click Define on the SmartPlant Reports toolbar.
Available properties — Lists all the properties of your report item.
Down Arrow — Moves the selected item down in sorting priority.
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.
Sort properties — Displays the properties selected for sorting.
Up Arrow — Moves the selected item up in sorting priority.
When you click New on the Define Report Contents dialog box, you can choose from
only those items that are related to the item you selected in the Report on hierarchy.
The highest node in the Report on hierarchy under which you can add a new item is the
node that belongs to the report item type that you base your template definition on. You
can add items under any nodes subordinate to the main report item type as long as they
have items related to them.
Using the New command skillfully allows you to navigate in all directions in the plant
hierarchy and gather properties from throughout the plant database.
4. On the New Items dialog box, select the new item that you want to add to the hierarchy.
5. Change the name of the item that appears in the hierarchy by typing text in the Name box.
If the item that you choose has the same name as an item elsewhere in the hierarchy,
you must type a different name for it in the Name box.
6. Click Apply.
7. When you have added all the items that you want from this list, click Close.
If you want to add more new items under another node in the hierarchy, choose that
node and repeat the previous steps.
8. On the Define Report Contents dialog box, select an item with properties that you want for
your report template.
9. Click Define.
10. On the Properties tab of the Define Report Items dialog box, choose the properties that
you want to map to your report template.
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.
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.
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.
If a certain property is not available in the import code, the import code also needs to be
updated. For more information on import code and other importing parameters, see the
Import Implementation Customization topic in the SmartPlant P&ID Programmer's Guide. To
view this file, on the Start menu, click Intergraph SmartPlant P&ID > Programming Help.
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.
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.
When sorted in ascending or descending order, the properties that have sub-properties
appear first sorted alphabetically, followed by the properties that do not have sub-properties,
sorted alphabetically.
For a summary report, the list entry Report Item Group Total that appears at the lowest
level is always at the bottom of the list, regardless of the sort order selected.
Prompt for alternative format — Select this check box to display a prompt for an alternative
format when reporting on a property that has units of measure. When cleared, the property will
display using the format specified in the Properties window.
Formats with primary, secondary, and tertiary units are truncated to the primary value with
no rounding when the units are not displayed. Therefore if you clear the Display units of
measure check box, you may not get accurate results when using such a format. If you do
not want to display units of measure, consider using a format that has primary units only.
Use caution when importing a report that contains numerical values without units of
measure. In such cases, these numerical values will be imported using the plant default
formats, potentially altering the items' properties. For example, if a report was created with a
temperature in Celsius without displaying the units (using an alternative format), a numerical
value of 100 in the report (intended as 100 ºC) will be imported as 100 ºF (37.78 ºC) into a
plant with ºF as the plant default.
5. On the Report Options dialog box, ensure that the Prompt for alternative format check
box is selected.
6. Click OK to close the Report Options dialog box.
7. Choose a cell where you want the property to appear.
8. Click the Add-Ins tab, and in the Custom Toolbars area, click Map Properties.
9. From the menu, select a property with units of measure that you want to map to the chosen
cell.
The properties on the Map Properties menu are specified when you define the
contents of your report. For more information, see Define the Contents of Your Report
Template (on page 243).
10. On the Select Alternative Format for Display dialog box, do the following:
a. From the Format list, select the desired alternative format.
Formats with primary, secondary, and tertiary units are truncated to the primary
value with no rounding when the units are not displayed. Therefore if you clear the
Display units of measure check box, you may not get accurate results when using
such a format. If you do not want to display units of measure, consider using a
format that has primary units only.
Use caution when importing a report that contains numerical values without units of
measure. In such cases, these numerical values will be imported using the plant
default formats, potentially altering the items' properties. For example, if a report
was created with a temperature in Celsius without displaying the units (using an
alternative format), a numerical value of 100 in the report (intended as 100 ºC) will
be imported as 100 ºF (37.78 ºC) into a plant with ºF as the plant default.
c. Click OK to place the property syntax in the cell.
If the format name mentioned in the report template does not exist in the active
plant, the cell will be left blank when the report is generated.
Example
Let us assume that the property you want to display is 'Design Max Pressure' and that the
default format is Pressure-psig.
If the default format is chosen, the value of that property will be displayed in the report with
the units of measure defined for that format. The string that appears in the cell is:
#Pipe Run::Design MaxPress::ProcessDesign.Max.Pressure#
If an alternative format named ‘Pressure-BarG’ was chosen to display the property, the
string that appears in the cell is:
#Pipe Run::Design
MaxPress::ProcessDesign.Max.Pressure[Pressure-BarG]#
If the Display units of measure check box was cleared, the property will be displayed using
the numerical value of the format without showing the units of measure in the report, and the
string that appears in the cell is:
#Pipe Run::Design
MaxPress::ProcessDesign.Max.Pressure[Pressure-BarG::-1]#
Printing Drawings
You can print your drawings on many different devices ranging from dot matrix printers to laser
printers and plotters. Except for the color settings and a few special effects, your drawing prints
exactly as it appears in the Drawing view. This stipulation applies to special settings like the
display of claimed items, inconsistency indicators, or filtered items.
Printing Time
Drawings can take some time to print. Expect longer print times when you have drawings that
contain a large number of the following items:
Curved items
Many fills that have complex colors, patterns, or textures
Large bitmaps
Links to various drawings
The type of printer you have also affects the printing time. PostScript® printers print faster than
LaserJet printers, because they can make the necessary calculations faster. Some older
versions of PostScript® printers are slower when compared to the newer ones. The type of
controller boards and the amount of RAM in the printer also affect your printing times.
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. This
command 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.
Number of copies — Displays the number of copies you want to print. Type the number or use
the scroll buttons to specify a number.
Collate — Prints the copies in proper binding order.
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.
Scale
Controls the scale applied to the print area in a document.
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.
Origin
Adjusts the origin of the graphic area, thereby changing the location of the effective print area on
the paper.
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.
X origin — Sets a shift in the x-direction from the origin.
Y origin — Sets a shift in the y-direction from the origin.
Preview
Displays dynamically how the graphic prints on the sheet as you change other options on the
dialog box.
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.
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.
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.
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 (not available for SmartPlant P&ID
Engineering).
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.
To print Do this
The entire drawing Under the Print range option, select Drawing. The entire
drawing is printed.
All defined views Arrange the views you want to print, and then on the Print dialog
box, select View and All.
You can create more than one Drawing view by selecting
Window > New > Drawing and zooming or panning to the area
of the Drawing view that you want to print.
A selected area Select the item or portion of the drawing that you want to print.
Click Selection. The Settings button becomes unavailable. Click
OK on the Print dialog box.
To a file Select Print to file on the Print dialog box. Click OK. The Print
to File dialog box appears, and you can enter the file name and
select its location.
Multiple copies In the Number of Copies box, enter a number of copies. To sort
the sheets by sheet number, select Collate.
Black and white Under Options, select Print black and white.
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.
When specifying line widths for display sets, you can set label graphics and leader lines to
appear in the default width of the labels regardless of the line width value specified for model
items. This option is specified by using a key 'IgnoreDisplaySetWidthOnLabels' under the
'Options' section of the SmartPlantPID.ini file (located in the users\<username> folder) as
shown:
[options]
WaterMarkWhileWorking=True
WaterMarkWhilePrinting=True
undosteps=0
autogapping=False
ConsistencyChecks=True
.
.
.
IgnoreDisplaySetWidthOnLabels=1
The following table shows how the values assigned in the SmartPlantPID.ini file affect the
output.
If you want to print more than one drawing, use SmartPlant P&ID Drawing Manager, which
has multiple drawing printing functionality.
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.
The file is saved with a .prn extension.
SmartPlant P&ID interacts with SmartPlant Foundation by correlating items between the plant
database and the SmartPlant Foundation database, retrieving documents from SmartPlant
Foundation. Also, SmartPlant P&ID creates a set of tasks in the To Do List that you can run to
update the plant database. In SmartPlant P&ID, you can also use the commands on the
SmartPlant menu to publish documents and retrieve data, access the SmartPlant Foundation
Web Portal in order to browse in SmartPlant Foundation, and subscribe to change notifications
and compare documents.
You can only use the SmartPlant menu commands after your plant is registered. For
more information, see SmartPlant Engineering Manager Online Help.
Registering Tools
Before you can publish and retrieve documents from any of the other authoring tools, such as
SmartPlant Electrical or SmartPlant Instrumentation, you must register each plant in SmartPlant
P&ID with a SmartPlant Foundation database. The connection allows SmartPlant P&ID to use
the commands on the SmartPlant menu. A SmartPlant Engineering Manager administrator
typically registers a plant.
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 once; this action takes
place in SmartPlant Engineering Manager. After the plant is registered, you can publish and
retrieve documents.
By default, SmartPlant P&ID item tag validation does not allow duplicate item tags for
loops or instruments.
Instrument Expansion
A SmartPlant P&ID instrument or loop tag does not always have a 1:1 relationship with
instruments in SmartPlant Instrumentation. In some cases, a single item tag in a P&ID
corresponding to an instrument or loop needs to be expanded to create several instruments
when publishing the data for SmartPlant Instrumentation. For this purpose, the Expansion
Type property in SmartPlant P&ID specifies the expansion behavior when publishing an
instrument or loop. Each value of the property corresponds to a SmartPlant Instrumentation
rule that determines which instrument types and numbers are to be created in SmartPlant
Instrumentation when the SmartPlant P&ID tag is expanded and retrieved.
When retrieving data back to SmartPlant P&ID, the behavior of a particular
instrument created by expansion is determined by SmartPlant Instrumentation parameters.
For an expanded instrument, the state of the IRetrievableExpansion interface determines
whether that instrument will be retrieved by SmartPlant P&ID: if the IRetrievableExpansion
interface is realized, the instrument is retrieved, whereas if the IRetrievableExpansion
interface is not realized, the instrument is not retrieved. The 'parent' item tag is always
retrieved, regardless of the realization state of the IRetrievableExpansion interface.
Ports
SmartPlant Instrumentation uses physical ports, while SmartPlant P&ID uses logical ports.
SmartPlant Instrumentation publishes the physical ports with the Dimensional Data Sheets
and not the Instrument Index. SmartPlant P&ID retrieves the Instrument Index and does
not retrieve the Dimensional Data Sheets.
When the workflow goes from SmartPlant P&ID to SmartPlant Instrumentation, followed by
SmartPlant Instrumentation publishing the Dimensional Datasheet, a Same As relationship
is created between the ports in the SmartPlant Foundation database. That Same As
relationship is required by Smart 3D to correctly match the design basis ports to the 3D
representation of the ports.
When the workflow goes from SmartPlant Instrumentation to SmartPlant P&ID, however, a
Same As relationship is not created in the SmartPlant Foundation database. Without the
Same As relationship created in the SmartPlant Foundation database, the result may be
additional ports in Smart 3D. To obtain the Same As relationship on the ports requires that
SmartPlant P&ID publish the P&ID with the instrument, this P&ID be retrieved by SmartPlant
Instrumentation and then having SmartPlant Instrumentation publish the Dimensional Data
Sheet.
Drawing Items
For Smart 3D to properly determine flow direction in a process run, that process run must be
connected to at least 2 items.
Some items that can be represented as single objects in SmartPlant P&ID, such as Vent
Detail, are modeled in Smart 3D as a set of separate objects. For full correlation to be
established between the two tools, ensure that these objects are modeled in SmartPlant
P&ID with the same configuration used to represent them in Smart 3D.
Properties
Smart 3D handles temperature and pressure properties in pairs and does not support
having a temperature (for example, Normal Operating Temperature) without defining the
matching pressure (in this case, Normal Operating Pressure). While this is a valid condition
for SmartPlant P&ID, it should be a consideration when publishing for retrieval into Smart
3D. Without the Pressure / Temperature pair of values defined, the Smart 3D user will be
required to enter a value that was not defined in SmartPlant P&ID.
used for additional searches. In this way, a generic symbol will be returned if no specific symbol
is available in the catalog.
Search Based on Type Value — Searches the catalog index for all rows with matching
ItemTypeName and Type values and IsDefaultForType = True. If one or more rows are found,
the software uses the CatalogItemName from the first one. If no match is found, the software
performs the search based on Subclass.
Search Based on Subclass Value — Searches the catalog index for all rows with matching
ItemTypeName and SubClass values and IsDefaultForSubclass = true. If one or more rows are
found, the software uses the CatalogItemName from the first one. If no match is found, the
software performs the search based on Class.
Search Based on Class Value — Searches the catalog index for all rows with matching
ItemTypeName and Class values and IsDefaultForClass = True. If one or more rows are found,
the software uses the CatalogItemName from the first one. If no match is found, the software
returns an empty string.
Publish
When a P&ID drawing is published, the Adapter extracts data from the SmartPlant P&ID
database and converts it into a set of objects and relationships that are compatible with the
SmartPlant schema. These objects and relationships are written out to an XML file and are sent
to the SmartPlant Server for further processing. The adapter depends on the data in the tool
schema to support the publish operation.
For each published class in the tool schema, there is a code module in the adapter known as a
Class Publisher. The Class Publisher contains code for the following tasks:
Query the P&ID Database — The Class Publisher queries the database to obtain the
collection of items to be published.
Create a Data Object — For each item to be published, the Class Publisher creates a data
object in the document container. The class of this object is the SmartPlant schema class
related to the MapClass via the MapClassToClass relationship.
Set the Property Values — The property values on the data object are set according to the
values on the SmartPlant P&ID item. The list of properties to be published is defined by the
list of MapProperties related to the current MapClass.
Publish Relationships — The Class Publisher defines the types of relationships that are to
be published for each data object it publishes.
Retrieve
When a document from another authoring tool is retrieved, the adapter compares the objects in
that document to the data in the SmartPlant P&ID database and generates tasks in the To Do
List. A Create task is generated when a new item needs to be created. An Update task is
generated when an existing item needs to be modified. A Delete task is generated when an
existing item needs to be deleted. The adapter depends on the data in the tool schema to
support the retrieve operation.
Generation of Create, Update, and Delete tasks can, if desired, be suppressed for
specified document types, for example, for objects that are not correlated between the
publishing and retrieving tools. For details of how to do this, see Suppress Generation of Tasks
on Retrieve (on page 286).
For each retrieved class in the tool schema, there is a code module in the adapter known as a
Class Retriever. Each Class Retriever contains code for retrieving a class of objects.
When a document is retrieved, the adapter receives two containers of data.
1. The document container includes all of the published objects and relationships for that
document.
2. The tombstone container includes information about deleted objects and relationships.
The adapter iterates over all of the objects in the document container and performs these
actions:
Use Identifying Interface to Determine Class — The incoming object is tested for an
identifying interface to determine which Class Retriever should handle the retrieval of that
object.
Generate Update Task — The Class Retriever searches for an existing SmartPlant P&ID
item to update. If an item is found, it generates an Update task in the To Do List. The
properties of the incoming object are compared against the properties of the existing item.
When differences are found, property updates are added to the task. The list of properties to
be compared is defined by the properties in the tool schema.
Generate Create Task — If no item is found to update, a Create task is generated in the To
Do List. Property updates are added to the task for each of the incoming property values.
The list of properties to be added is defined by the properties in the tool schema.
For SmartPlant P&ID Engineering, it is not possible to run Create tasks.
Retrieve Relationships — The Class Retriever defines the types of relationships that are to
be retrieved for each data object.
The adapter iterates over all of the objects in the tombstone container and performs these
actions:
Generate Delete Task — The adapter searches for an existing item in the SmartPlant P&ID
database that is correlated to the item that was deleted in the other application. If such an
item is found, a Delete task is generated in the To Do List.
The rectangles on the left side of the graphic represent objects in the tool schema. The
rectangles on the right represent objects in the SmartPlant schema. The relationships that
connect objects on the left with objects on the right are the mapping relationships. The map file
contains both the tool schema objects and the mapping relationships.
MapClass
The MapClass object corresponds to the IMapClassDef interface in the Mapping Relationships
diagram. In general, there is a MapClass object in the tool schema for each SmartPlant P&ID
class (ItemType) that needs to be published or retrieved. MapClass is referred to as
SPMapClassDef in the Schema Editor. The properties and relationships for a MapClass can be
viewed in the Edit Map Class Definition dialog box.
General
Property Value
Process Criteria This property must be filled in for this MapClass to be used. The
format for this property is a comma delimited list of fields. The fields
are:
ProgID — The programmatic identifier of a class module within the
Adapter.
Expand Attributes Flag — A flag to indicate if the attributes should
be expanded.
Seq No — A number that indicates the sequence in which the classes
are processed. This field is used for Retrieve processing.
The user should not change any of these values. The default
values that come with the delivered Tool Schema should remain
unchanged. One exception to this is if you want to ignore the retrieval
of items in the desired class, as described in the example below.
To ignore an item for retrieval, delete all the parameters from the Process Criteria
property for the desired map class. For example, to prevent retrieval of PipeRuns, delete the
parameters for the EFAdapter.PipeRunDataExchanger map class.
Map Properties The map properties associated with the MapClass must be defined
and related to it. (MapClassMapProperties in the diagram.)
Mapping Relationships
Relationship Comment
Publish to SmartPlant This relationship must be set to a class in the SmartPlant schema if
class this class is to be published. When this relationship is set, an instance
of the target class is published for each instance of the source class in
the drawing being published. (MapClassToClass in the diagram.)
Retrieve from The list of interfaces from which properties are to be retrieved must be
SmartPlant interface set if this class is to be used for retrieval. (ClassToMapClass in the
diagram.)
MapProperty
The MapProperty object corresponds to the IMapPropertyDef interface in the Mapping
Relationships diagram. In general, there is a MapProperty object in the tool schema for each
SmartPlant P&ID property that needs to be published or retrieved. The properties and
relationships for a MapProperty can be viewed in the Edit Map Property Definition dialog box
in the Schema Editor.
General
Property Value
Selection This field is used to specify the handling of process data properties on
Criteria PipeRuns.
Process Criteria For properties that require special handling, the ProgID of the appropriate
PropertyConversion class must be entered here. In some cases, additional
parameters are also supplied in this field. For simple properties with
matching data types, no value is required here. See the section on Property
Conversions for more information.
Scoped by If the data type of the property is enumerated, the MapProperty must be
enumeration related to a MapEnumList. If the data type of the property is UoM, the
MapProperty must be related to a MapUoMList. Otherwise, this
relationship is not needed. (MapPropertyMapEnumList in the diagram.)
Mapping Relationships
Relationship Comment
Map property to This relationship defines the property in the SmartPlant schema to
property which this tool property is to be published. If this relationship is not
defined, the property will not be published. (MapPropertyToProperty in
the diagram.)
Property to map This relationship defines the property in the SmartPlant schema from
property which this tool property is to be retrieved. If this relationship is not
defined, the property will not be retrieved. (PropertyToMapProperty in
the diagram.)
MapEnumList
The MapEnumList object corresponds to the IMapEnumListDef interface in the Mapping
Relationships diagram. In general, there is a MapEnumList object in the tool schema for each
SmartPlant P&ID enumerated list associated with a property that needs to be published or
retrieved. The properties and relationships for a MapEnumList can be viewed in the Edit Map
Enumerated List Definition dialog box.
General
Property Value
Constrains For hierarchical enumerated lists, the MapEnumList must be related to the
lower level list with the Constrains relationship.
(MapEnumListMapEnumList in the diagram.)
Relationship Comment
Constrained by For hierarchical enumerated lists, the MapEnumList must be related to the
higher level list with the Constrained by relationship.
(MapEnumListMapEnumList in the diagram.)
Mapping Relationships
Relationship Comment
Mapped from To support the retrieve operation, a MapEnumList should be related to the
corresponding enumerated list in the SmartPlant schema by means of the
Mapped from relationship. (EnumListToMapEnumList in the diagram.)
MapEnum
The MapEnum object corresponds to the IMapEnumDef interface in the Mapping Relationships
diagram. In general, there is a MapEnum object in the tool schema for each SmartPlant P&ID
enumerated list entry that needs to be mapped. The properties and relationships for a MapEnum
can be viewed in the Edit Map Enumerated List Definition dialog box.
General
Property Value
Mapping Relationships
Relationship Comment
Maps to This relationship defines the SmartPlant schema enumerated value to which
this P&ID enumerated value is to be published. If this relationship is not
defined, the enumerated value will not be published. (MapEnumToEnum in the
diagram.)
Mapped from This relationship defines the SmartPlant P&ID enumerated value to which this
SmartPlant schema enumerated value is to be retrieved. If this relationship is
not defined, the enumerated value will not be retrieved. (EnumToMapEnum in
the diagram.)
MapUoMList
The following graphic displays a representation of the objects and relationships that are relevant
to the mapping of units of measure (UoM). A MapUoMList is a specialized kind of MapEnumList.
Similarly, a MapUoM is a specialized kind of MapEnum. This is shown by the Implies
relationships in the graphic. A MapProperty with a UoM data type must be related to a
MapUoMList.
The MapUoMList object corresponds to the IMapUoMListDef interface in the graphic. In general,
there is a MapUoMList object in the tool schema for each SmartPlant P&ID format type
associated with a property that needs to be published or retrieved. The properties and
relationships for a MapUoMList can be viewed in the Edit Map Unit of Measure List Definition
dialog box in the Schema Editor.
General
Property Value
Mapping Relationships
Relationship Comment
MapUoM
The MapUoM object corresponds to the IMapUoMDef interface in the Mapping Relationships
diagram. In general, there is a MapUoM object in the tool schema for each SmartPlant P&ID
format that needs to be mapped. The properties and relationships for a MapUoM can be viewed
in the Edit Map Unit of Measure List Definition dialog box in the Schema Editor.
General
Property Value
Mapping Relationships
Relationship Comment
Maps to This relationship defines the SmartPlant schema UoM to which this
SmartPlant P&ID format (UoM) is to be published. If this relationship is not
defined, the UoM will not be published. (MapEnumToEnum in the diagram.)
Mapped from This relationship defines the SmartPlant P&ID format (UoM) to which this
SmartPlant schema UoM is to be retrieved. If this relationship is not defined,
the UoM will not be retrieved. (EnumToMapEnum in the diagram.)
Property Conversions
If the data type of the SmartPlant P&ID property does not match the data type of the mapped
property in the SmartPlant schema, a data type mismatch exists. In some cases, a property with
a data type mismatch can still be published and retrieved using specialized code. The code to
perform these data type conversions and other special handling is implemented in special
Property Conversion objects. The SmartPlant adapter is told about the need to use a Property
Conversion object by putting the ProgID of the Property Conversion class in the Process
Criteria option of the MapProperty. The list of available Property Conversion classes is shown in
the table below.
The ProgID for each of these classes is formed by prefixing the class name with the
string 'EFadapter'.
PpConnNameConv This class implements the property conversion code for Piping
Connector Name property.
TagPrefixConv This class implements the property conversion code for the
TagPrefix property. It populates the UnitName value for
instrumentation.
Mapping Enum Values — An enumerated value within an enumerated list hierarchy can be
mapped to any value (at any level) in the target enumerated list hierarchy. There is no explicit
relationship between the levels of two hierarchies.
Catalog Index
During retrieval of a document, when a create task is generated, the adapter must select a
symbol to be used by the task. The adapter uses the Catalog Index to quickly find a suitable
symbol to be used. The Catalog Index lookup is based on the type properties. For example,
when generating a create task for Equipment, the Equipment Class/Subclass/Type properties
are used to perform the lookup. Before the Catalog Index lookup can take place, the incoming
SmartPlant type values must be converted into SmartPlant P&ID type values. This conversion of
a SmartPlant schema enum value into a SmartPlant P&ID enumerated value is performed by
the EnumConversions object just like any other enumerated property value. It depends on the
mapping of enumerated values found in the tool schema.
Drawing
There is a MapClass in the tool schema for Drawing. The MapProperties for this MapClass
define the properties that will be published from the SmartPlant P&ID Drawing item to the
SmartPlant schema PIDDrawing object. If new properties are added to the Drawing item type in
the Data Dictionary Manager, and corresponding new properties are added in the SmartPlant
schema, then they can be mapped by adding new MapProperties to this MapClass in the tool
schema using the Schema Editor.
Equipment
In SmartPlant P&ID there is an abstract class for Equipment with four subclasses for Vessel,
Exchanger, Mechanical and OtherEquipment. In the SmartPlant schema, there are four PID
equipment classes.
1. PIDProcessVessel
2. PIDHeatTransferEquipment
3. PIDMechanicalEquipment
4. PIDProcessEquipment
The tool schema has a MapClass for each of the four equipment subclasses in SmartPlant P&ID
and another MapClass for the abstract Equipment class.
Publish — The four MapClasses map the corresponding equipment classes in SmartPlant P&ID
and the SmartPlant schema. A SmartPlant P&ID vessel is published as a PIDProcessVessel in
SmartPlant; an Exchanger is published as a PIDHeatTransferEquipment, and so forth. The
MapClass for Equipment does not play any role in the publish operation.
Retrieve — When a document is being retrieved, each incoming object is tested for identifying
interfaces to determine what type of object it is. The object is first tested for the identifying
interfaces for Vessel, Exchanger, Mechanical and OtherEquipment. If the object has one of
these identifying interfaces, it is retrieved as that specific type of equipment (using the
MapProperties associated with the specific MapClass for that equipment class in the tool
schema). If the object is not recognized by its interfaces as any of these specific equipment
types, but it is recognized as Equipment, it is retrieved as generic equipment (using the
MapProperties associated with the generic Equipment MapClass in the tool schema).
Instrument
In SmartPlant P&ID there is one Instrument class.
In the SmartPlant schema, there are three PID instrument classes.
PIDInstrument
PIDInlineInstrument
PIDControlSystemFunction
The tool schema has three MapClasses.
Instrument
InstrumentInline
InstrumentCtrlSysFunc
The SmartPlant P&ID adapter has three separate Class Publisher/Retriever objects for these
three classes.
Publish — All SmartPlant P&ID instruments with Instrument Class equal to System Function
are published as PIDControlSystemFunction using the InstrumentCtrlSysFunc MapClass. All
SmartPlant P&ID instruments with IsInline equal to True are published as PIDInlineInstrument
using the InstrumentInline MapClass. All other SmartPlant P&ID instruments are published as
PIDInstrument using the Instrument MapClass.
Retrieve — All objects that have the IControlSystemFunction interface are retrieved as
Instruments using the InstrumentCtrlSysFunc MapClass. All objects that have the
IInstrumentOcc interface are retrieved as Instruments using the PIDInlineInstrument MapClass.
The InstrLoop map class in the tool schema is used for the instrument loop, which is
usually retrieved when retrieving the associated instruments. To retrieve instruments from
SmartPlant Instrumentation without their associated loops, for the InstrLoop map class
Process Criteria property, change the string 'EFAdapter.InstrLoopDataExchanger,False,7' to
'EFAdapter.InstrLoopDataExchanger,False,7,False' (add an extra 'False' parameter with a
comma separator at the end). For more details, see MapClass (on page 266).
PipeRun
In SmartPlant P&ID there is a single class for PipeRun. This class has properties describing
aspects of the physical pipe and other properties that describe the fluid flowing through that
pipe. In the SmartPlant schema there are two relevant classes: PIDPipingConnector for the pipe
itself and PIDProcessPoint for the process data. Furthermore, the SmartPlant schema has
several classes that are used to publish a stream and its associated process data on a PFD.
The SmartPlant P&ID tool schema has one MapClass for PipeRun.
Publish — Each SmartPlant P&ID PipeRun is published as a PIDPipingConnector and a
PIDProcessPoint with a relationship between the two. Some of the properties from the PipeRun
are mapped to the PIDPipingConnector and others are mapped to the PIDProcessPoint.
Retrieve — When an object is retrieved with the IPipingSystemConnector interface, it is
recognized as a Stream and is retrieved using the PipeRun MapClass to create or update a
PipeRun. The ProcessDataCaseComposition relationship is traversed to obtain objects that
realize the IProcessDataCase interface. From those objects, the ProcessDataBulkComposition
relationship is traversed to obtain objects that realize the IProcessDataBulkPhase interface.
Properties from all of these SmartPlant schema objects can be retrieved onto the SmartPlant
P&ID PipeRun object.
Select Criteria — In the Schema Editor, the Select Criteria option on the MapProperty is used
to indicate to the adapter how to handle each property for both publish and retrieve. The format
of the Select Criteria option is:
Select Criteria = <Retrieve Path>%<Publish Path>
<Retrieve Path> — Indicates where the property comes from during retrieve. If this value is
empty, it means that the property comes from the primary object being retrieved
(IPipingSystemConnector). If a value exists, it means that this property comes from one of
the secondary objects that is related to the primary object by means of a relationship.
<Publish Path> — This is a string that indicates where the property goes during publish. If
this value is empty, it means that the property is published to the primary object
(PIDPipingConnector). If this property is has a value (it should be equal to ProcessPoint), it
means that this property is published to the related PIDProcessPoint object.
PipeLine
In SmartPlant P&ID, graphical pipe runs indicate the schematic piping design. You can assign
naming properties to these pipe runs. All of the pipe runs with matching values for the naming
properties form a logical group. Such a group is sometimes called a pipeline and the values of
the naming properties represent the name of the pipeline. All of this is done without requiring
you to explicitly create a pipeline object.
In the SmartPlant schema there is an explicit PIDPipeLine class. Objects of this class must be
published with relationships to the associated PIDPipingConnectors. Some downstream
applications depend on the existence of the PIDPipeLine for their processing.
The SmartPlant P&ID adapter creates and deletes pipelines dynamically during the publish
operation. The pipelines and the relationships to the pipe runs are published as if they really
existed in the SmartPlant P&ID database. The tool schema contains a MapClass for PipeLine.
The MapProperties for the pipeline MapClass define the properties that are published to the
PIDPipeline object.
1. In Data Dictionary Manager, add new entries in the Expansion Type select list, for example
as shown below.
3. In SmartPlant P&ID, select the instrument, control system, or loop that you want to expand,
and in the Properties window, select the desired value from the Expansion Type list.
To enable data exchange with SmartPlant Foundation and other tools, the schema
version in use must include the following Interfaces:
If you set a value to True, the application adapter ignores the mapping relationship
and uses hard-coded logic which should already be defined.
4. On the Edit Map Relationship Definition dialog box, beside Maps to, click the ellipsis
button and from the list of EFSchema RelDef items, select OwnsComponentOcc.
5. Click OK to return to the Edit Map Relationship Definition dialog box with the mapping
assigned.
The next time you publish a document from SmartPlant P&ID, it will include this relationship.
4. Scroll down to the PipeRun map class and right-click the node.
6. On the Edit Map Class Definition dialog box, click the Advanced tab.
7. In the Select criteria field, enter the code for suppressing the generation of tasks for the
document types you specify.
Code Syntax
Use the following code syntax for suppressing task generation:
NoDeleteTasksForDocTypes=[DocType1;DocType2;...;DocTypeN]/NoCreateTa
sksForDocTypes=
[DocType1;DocType2;...;DocTypeN]/NoUpdateTasksForDocTypes=[DocType1;
DocType2;...;DocTypeN]
where the code elements are as follows:
NoDeleteTasksForDocTypes — Suppresses generation of Delete tasks for the
specified document types.
For SmartPlant P&ID Engineering, it is not possible to run Create or Delete tasks.
A forward slash (/) separates the commands for each task type (Delete, Create, Update).
For each task type, the document type names or IDs are separated by a semicolon (;) as
shown:
In this example, EE82 is the ID for PFD documents, and EE84 is the ID for Instrument Index
documents.
To find the name or ID of a document type, go to the retrieved document and use the
‘DocType’ property value of the IDocument interface.
Code Example
The following code is used to suppress generation of Create and Delete tasks for PFD and
Instrument Index documents (using document type names and IDs) including Delete tasks for
deleted and unclaimed objects:
NoCreateTasksForDocTypes=PFD;EE82;Instrument
Index;EE84/NoDeleteTasksForDocTypes=PFD;EE82;Instrument
Index;EE84;Deleted and Unclaimed Objects
6. Click File > Save to save your changes in Data Dictionary Manager.
Launch Schema Editor and Load the SmartPlant P&ID Tool Map Schema
The ICustomInterface must be realized by the class definitions that represent objects in this
authoring tool that will be publishing or retrieving the custom property. If you have not configured
ICustomInterface, see the Schema Editor User's Guide for more information.
1. In the Desktop Client, set your scope for the applicable plant, and then find the CMF file.
2. Right-click the CMF file, and then click Edit > Check Out.
3. Click OK in the Check Out dialog box.
4. In the New Items window, right-click the new version of the CMF file, and select Launch
Schema Editor.
5. On the Set Active Configurations dialog box, select the schema version that you want to
view.
For more options, click Advanced on the Set Active Configuration dialog box.
By default, changes to the SmartPlant Schema are written to all versions managed by
the CMF file. You can choose to write changes to only selected versions; however, that
is not recommended.
If you choose to view one version of the schema (Specify configurations to display
window), but write changes to all versions (Set Configurations for new objects
window), an information window appears when you click OK, indicating that you will be
prompted with every change to the schema to confirm that you want to write the
changes to all versions. Click OK to continue.
The CMF file must be checked in to SmartPlant Foundation before users can publish
from an authoring tool.
7. In the Schema Editor, click File > SmartPlant > Edit Engineering Tool Options, and
select SMARTPLANTPID in the list of authoring tools to load the SmartPlant P&ID tool map
schema.
8. Under Startup options, select the Load map schema and Connect to application schema
check boxes, and click OK.
9. In each row in the Synchronize dialog box, the values in the tool database and tool map
schema columns indicate actions to correct inconsistencies between the tool metadata and
tool map schema. Select the appropriate action in each row, and then click OK.
Each row represents a discrepancy between the tool database and the tool map
schema.
Default actions are blue when the Synchronize dialog box appears. However, if you
select a different option, it will become blue instead.
In many cases, only one operation is supported to synchronize the database and map
schema. For example, if a new property was found in the database, the metadata
adapter can add the property to the tool map schema, but it cannot remove the property
from the tool database.
Because the SmartPlant P&ID tool map schema does not have a map class definition
called Plant Item, the new property that you added appears on several map class definitions
that inherit from Plant Item, such as equipment component and instrument loop.
In the Exposed by interface definitions dialog box, click Browse, and select
ICustomInterface as the interface definition that exposes this property.
In the Scoped by property type box, select string.
3. Click OK.
4. Under Unmapped application properties, select SystemCode.
5. Under Unmapped SmartPlant properties, select SystemCode.
7. Click OK.
If the SystemCode property does not appear in the Unmapped SmartPlant properties
list after you created and exposed it on the ICustomInterface interface definition, check the
ICustomInterface definition to make sure that it is realized by the PIDInstrumentLoop class
definition and implied by the IInstrumentLoop interface.
The view definition that creates the list of unmapped properties is generated by the
software the first time you access the Edit form for a map class for each Schema Editor session.
So, if you view the list, leave it, and make changes, such as adding additional interfaces to the
class definition to which the map class is mapped, the changes you made will not appear when
you return to this form because the view definition is not updated or regenerated. You will see
the changes during your next Schema Editor session.
When you close the Schema Editor, the software prompts you to save your connection
information, user interface options, and loaded tool map schemas to a session file. Click Yes
in the message box to save the session file so that you can use it to return to this working
environment. However, you should not open a session file after launching the CMF file from
the Desktop Client.
If you save changes to the CMF file or a tool map schema but did not validate the changes
before exiting, the software displays an information message to remind you that the file
contains changes that have not been validated. Click OK to dismiss the message.
If you make changes to the SmartPlant schema, you must load the changes into the
SmartPlant Foundation database. For more information, see the SmartPlant Schema Editor
User's Guide.
Additionally, if you made changes to the SmartPlant schema, you should regenerate the
component schemas for the site before testing any publish or retrieve mapping relationships.
For more information, see the SmartPlant Schema Editor User's Guide.
8. In the first empty row, create a new entry with a value of AA and a short value of Steam
Gen & Fired Htr, Water/Steam Side.
9. Click Add Row, and enter the following values, creating a new row for each:
CA Ammonia/Urea
10. Click Database Tables on the left of the dialog box, and select Plant Item from the list in
the middle.
Property Value
Name EngSystem
Category Process
5. On the Set Active Configurations dialog box, select the schema version that you want to
view.
For more options, click Advanced on the Set Active Configuration dialog box.
By default, changes to the SmartPlant Schema are written to all versions managed by
the CMF file. You can choose to write changes to only selected versions; however, that
is not recommended.
If you choose to view one version of the schema (Specify configurations to display
window), but write changes to all versions (Set Configurations for new objects
window), an information window appears when you click OK, indicating that you will be
prompted with every change to the schema to confirm that you want to write the
changes to all versions. Click OK to continue.
The CMF file must be checked in to SmartPlant Foundation before users can publish
from an authoring tool.
In the Schema Editor, click File > SmartPlant > Edit Engineering Tool Options, and
select SMARTPLANTPID in the list of authoring tools to load the SmartPlant P&ID tool map
schema.
7. Under Startup options, select the Load map schema and Connect to application schema
check boxes, and click OK.
8. In each row in the Synchronize dialog box, the values in the tool database and tool map
schema columns indicate actions to correct inconsistencies between the tool metadata and
tool map schema. Select the appropriate action in each row, and then click OK.
Each row represents a discrepancy between the tool database and the tool map
schema.
Default actions are blue when the Synchronize dialog box appears. However, if you
select a different option, it will become blue instead.
In many cases, only one operation is supported to synchronize the database and map
schema. For example, if a new property was found in the database, the metadata
adapter can add the property to the tool map schema, but it cannot remove the property
from the tool database.
Add the New Enumerated List to the SmartPlant Schema and Map
1. In the Map Environment, expand SmartPlant P&ID > Loaded Map Schemas >
SmartPlant P&ID Tool Schema.
2. Expand Map Enumerated Lists, and right-click EngSys.
3. On the shortcut menu, select Edit EngSys.
4. In the Edit Map Enumerated List Definition dialog box, select the Advanced tab.
5. At the bottom of the dialog box, click New SmartPlant Enumerated List with Correlated
Entries.
This process creates an enumerated list in the SmartPlant schema with the same
name and values as the list in the tool map schema. Additionally, the software will
automatically map all the enumerations for publish. A dialog box will suggest that you can
map the enumeration for retrieve as well. Click Yes to create both publish and retrieve
mapping relationships, or No to create only publish mapping relationships.
6. Click OK in the Create Enumerated List and Entries dialog box.
Depending on your selections on the Set Active Configurations dialog box when you
launched the Schema Editor, you may be prompted to confirm that you want to create the
new list and enumerations in multiple versions of the schema.
7. In the Edit Map Enumerated List Definition dialog box, click OK.
8. In the Map Enumerated Lists node, right-click EngSys.
9. On the shortcut menu, select Edit EngSys.
10. In the Edit Map Enumerated List Definition dialog box, select the Publish tab.
11. Under SmartPlant in the upper right window, right-click EngSys.
12. On the shortcut menu, select Edit <UID>.
13. Click each entry, and under Overview, edit the number to match the values in the following
table:
AA 10111
BA 10112
CA 10113
DC 10114
EA 10115
5. In the New Property Definition dialog box, define the new SmartPlant schema
EngineeringSys property.
When you close the Schema Editor, the software prompts you to save your connection
information, user interface options, and loaded tool map schemas to a session file. Click Yes
in the message box to save the session file so that you can use it to return to this working
environment. However, you should not open a session file after launching the CMF file from
the Desktop Client.
If you save changes to the CMF file or a tool map schema but did not validate the changes
before exiting, the software displays an information message to remind you that the file
contains changes that have not been validated. Click OK to dismiss the message.
If you make changes to the SmartPlant schema, you must load the changes into the
SmartPlant Foundation database. For more information, see the SmartPlant Schema Editor
User's Guide.
Additionally, if you made changes to the SmartPlant schema, you should regenerate the
component schemas for the site before testing any publish or retrieve mapping relationships.
For more information, see the SmartPlant Schema Editor User's Guide.
Launch the Schema Editor and Load the SmartPlant P&ID Tool Map Schema
1. In the Desktop Client, set your scope for the applicable plant, and then find the CMF file.
2. Right-click the CMF file, and select Launch Schema Editor.
3. On the Set Active Configuration dialog box, select the version of the schema that you
want to view.
4. Click OK to set the configuration, and open the Schema Editor.
5. In the Schema Editor, click File > SmartPlant > Edit Engineering Tool Options, and
select SMARTPLANTPID in the list of authoring tools to load the SmartPlant P&ID tool map
schema.
6. In each row in the Synchronize dialog box, the values in the tool database and tool map
schema columns indicate actions to correct inconsistencies between the tool metadata and
tool map schema. Select the appropriate action in each row, and then click OK.
Each row represents a discrepancy between the tool database and the tool map
schema.
Default actions are blue when the Synchronize dialog box appears. However, if you
select a different option, it will become blue instead.
In many cases, only one operation is supported to synchronize the database and map
schema. For example, if a new property was found in the database, the metadata
adapter can add the property to the tool map schema, but it cannot remove the property
from the tool database.
4. Define the property, for example, ProcessOperatingMaxPressure, in the Edit Map Property
Definition dialog box.
5. Type %ProcessPoint in the Select criteria field, and then click OK.
The Process criteria box is automatically filled with the value set to False. By setting
the Process criteria value to True, the SmartPlant P&ID adapter finds the extended
properties that contain the process properties for equipment.
8. Click the Publish tab.
The mapping you defined appears in the mapped objects table at the bottom of the
dialog box.
The ProcessOperatingMinTemperature map property can be mapped to
PhaseTemperatureMin using the same process.
12. Click OK.
5. On the Set Active Configurations dialog box, select the schema version that you want to
view.
For more options, click Advanced on the Set Active Configuration dialog box.
By default, changes to the SmartPlant Schema are written to all versions managed by
the CMF file. You can choose to write changes to only selected versions; however, that
is not recommended.
If you choose to view one version of the schema (Specify configurations to display
window), but write changes to all versions (Set Configurations for new objects
window), an information window appears when you click OK, indicating that you will be
prompted with every change to the schema to confirm that you want to write the
changes to all versions. Click OK to continue.
The CMF file must be checked in to SmartPlant Foundation before users can publish
from an authoring tool.
7. In the Schema Editor, click File > SmartPlant > Edit Engineering Tool Options, and
select SMARTPLANTPID in the list of authoring tools to load the SmartPlant P&ID tool map
schema.
8. In each row in the Synchronize dialog box, the values in the tool database and tool map
schema columns indicate actions to correct inconsistencies between the tool metadata and
tool map schema. Select the appropriate action in each row, and then click OK.
Each row represents a discrepancy between the tool database and the tool map
schema.
Default actions are blue when the Synchronize dialog box appears. However, if you
select a different option, it will become blue instead.
9. In many cases, only one operation is supported to synchronize the database and map
schema. For example, if a new property was found in the database, the metadata adapter
can add the property to the tool map schema, but it cannot remove the property from the
tool database.
10. In the Map Environment, expand SmartPlant P&ID > Loaded Map Schemas > SmartPlant
P&ID Tool Schema.
11. Expand the Map Enumerated Lists node, and double-click EquipmentType.
12. Click the Publish tab.
13. In the tool map schema view on the left side of the Publish tab, right-click any node, then
select Create New SPMapEnumDef.
14. Type Variable Frequency Drive in the Name box and provide a description.
15. Click OK.
16. The new list appears in the Unmapped application enumerations table.
17. In the Unmapped application enumerations table, select Variable Frequency Drive.
18. In the Unmapped SmartPlant enumerations table, select Variable-frequency Drive.
When you close the Schema Editor, the software prompts you to save your connection
information, user interface options, and loaded tool map schemas to a session file. Click Yes
in the message box to save the session file so that you can use it to return to this working
environment. However, you should not open a session file after launching the CMF file from
the Desktop Client.
If you save changes to the CMF file or a tool map schema but did not validate the changes
before exiting, the software displays an information message to remind you that the file
contains changes that have not been validated. Click OK to dismiss the message.
If you make changes to the SmartPlant schema, you must load the changes into the
SmartPlant Foundation database. For more information, see the SmartPlant Schema Editor
User's Guide.
Additionally, if you made changes to the SmartPlant schema, you should regenerate the
component schemas for the site before testing any publish or retrieve mapping relationships.
For more information, see the SmartPlant Schema Editor User's Guide.
Launch Schema Editor and Load the SmartPlant P&ID Tool Map Schema
1. In the Desktop Client, set your scope for the applicable plant, and then find the CMF file.
2. Right-click the CMF file, and then click Edit > Check Out.
3. Click OK in the Check Out dialog box.
4. In the New Items window, right-click the new version of the CMF file, and select Launch
Schema Editor.
5. On the Set Active Configurations dialog box, select the schema version that you want to
view.
For more options, click Advanced on the Set Active Configuration dialog box.
By default, changes to the SmartPlant Schema are written to all versions managed by
the CMF file. You can choose to write changes to only selected versions; however, that
is not recommended.
If you choose to view one version of the schema (Specify configurations to display
window), but write changes to all versions (Set Configurations for new objects
window), an information window appears when you click OK, indicating that you will be
prompted with every change to the schema to confirm that you want to write the
changes to all versions. Click OK to continue.
The CMF file must be checked in to SmartPlant Foundation before users can publish
from an authoring tool.
7. In the Schema Editor, click File > SmartPlant > Edit Engineering Tool Options, and
select SMARTPLANTPID in the list of authoring tools to load the SmartPlant P&ID tool map
schema.
8. Under Startup options, select the Load map schema and Connect to application schema
check boxes, and click OK.
9. In each row in the Synchronize dialog box, the values in the tool database and tool map
schema columns indicate actions to correct inconsistencies between the tool metadata and
tool map schema. Select the appropriate action in each row, and then click OK.
Each row represents a discrepancy between the tool database and the tool map
schema.
Default actions are blue when the Synchronize dialog box appears. However, if you
select a different option, it will become blue instead.
In many cases, only one operation is supported to synchronize the database and map
schema. For example, if a new property was found in the database, the metadata
adapter can add the property to the tool map schema, but it cannot remove the property
from the tool database.
Verify that the Corrosive Enumerated List Does Not Already Exist in the Schema
1. In the Map Environment window, select the Schema tab.
2. Find the Fluid system enumerated list in the tree view.
3. Right-click the Fluid system node, and then click View FluidSystems.
4. In the Edit Enumerated List dialog box, review the existing list entries.
Note that Corrosive does not exist in the Fluid system list.
5. Next, check to be sure that there are not any fluid code entries with the same meaning as
the one you want to add.
5. In the SmartPlant schema tree view on the right side of the Publish tab, right-click any entry
under the Fluid system node, and then click Create New EnumListType on the shortcut
menu.
6. In the New Enumerated List dialog box, type Corrosive as the short description of the new
list, Corrosive Fluid System as the long description, and 10100 as the number.
7. Click New Child Entry, and create a fluid code of KA with a description of (KA) Ammonia,
Anhydrous.
8. Repeat step 7 for each fluid code in the following list, and click OK.
KC (KC) Caustic
Add the New Corrosive List to the SmartPlant P&ID Tool Map Schema and Map
1. In the authoring tool map schema tree view on the left side of the Publish tab, right-click
any entry under the Fluid system node, and then click Create New SPMapEnumDef.
2. In the New SPMapEnumDef dialog box, type Corrosive in the Name field.
3. Type Corrosive Fluid System in the Description box, and then click OK.
4. The new list appears in the Unmapped application enumerations table.
7. Click Map .
8. Click OK.
4. In the New SPMapEnumDef dialog box, create a fluid code of KA with a description of (KA)
Ammonia, Anhydrous.
5. Repeat steps 3 and 4 for each fluid code in the following list:
KC (KC) Caustic
8. In the Constrained by box, click Browse, and select Corrosive as the dependent fluid
code enum entry. This value is saved in the tool map schema and ensures that the
Corrosive fluid system enum entry is defined as the Dependent value of the selected fluid
code in the Data Dictionary.
9. Repeat step 8 for each of the fluid code enum entries KC, KP, and KW.
10. Click the Publish tab.
11. In the Unmapped application enumerations table, select a fluid code that you defined.
12. In the Unmapped SmartPlant enumerations table, select the corresponding fluid code
from the SmartPlant schema.
14. Repeat steps 5-7 for each enumerated entry in the Fluid Code list.
When you close the Schema Editor, the software prompts you to save your connection
information, user interface options, and loaded tool map schemas to a session file. Click Yes
in the message box to save the session file so that you can use it to return to this working
environment. However, you should not open a session file after launching the CMF file from
the Desktop Client.
If you save changes to the CMF file or a tool map schema but did not validate the changes
before exiting, the software displays an information message to remind you that the file
contains changes that have not been validated. Click OK to dismiss the message.
If you make changes to the SmartPlant schema, you must load the changes into the
SmartPlant Foundation database. For more information, see the SmartPlant Schema Editor
User's Guide.
Additionally, if you made changes to the SmartPlant schema, you should regenerate the
component schemas for the site before testing any publish or retrieve mapping relationships.
For more information, see the SmartPlant Schema Editor User's Guide.
5. In the Selected list box, click Fluid Code, and in the Dependent Value column for each of
the new fluid codes, select Corrosive as the fluid system value.
EFCustomProcess Reference
IEFCustomPublish Interface
The methods and properties on this interface must be implemented to do any additional
processing of data before transmitting the data to SmartPlant Foundation during the publish
process. With this interface, you can process extra data that is not compatible with the tool
adapters.
MessageIContainer
Description
This is a container property to store any error or warning messages during the processing.
These message are logged during the publish process. This property is part of
IEFCustomPublish and is controlled by SmartPlant Client. The software implementation for the
IEFCusomtPublish interface adds messages to this container when required while processing
data to be published. These messages are logged to the same logging system as the rest of the
publishing process.
Data Type
IContainer
ToolParameters
Description
This is a collection of tool parameters and is the same object that the design tool passes through
the Connect call with CommonUI. IEFToolParameters is a collection of IEFToolParameter.
IEFParameter is a data class with sName (string) and vValue (variant) properties.
Data Type
IEFToolParameters
SetEventHandlerObj
Description
This method must be implemented to use the IEFCustomPublishEventHandler member object in
IEFCustomPublish. StepProgressBegin() and StepProgressEnd() must be called on this object
to update the publish progress bar with steps. SmartPlant Client implements the
IEFCustomPublishEventHandler interface, and SmartPlant Client acts as the oEventHandler
parameter for this method in SmartPlant Client.
Arguments
ListOfProgressSteps
Description
This method is called by SmartPlant Client to retrieve all additional steps to be displayed in the
publish progress bar while processing the data. In the implementation of this method, add the
required additional steps that need to be displayed in the progress bar while processing the
data. These steps are displayed during the publish process along with the rest of the publish
process steps with status icons. The StepNames array must be filled with individual steps to be
displayed during the publish process.
Arguments
ProcessPublishData
Description
This method is called by SmartPlant Client and needs to be implemented to modify, add, or
remove information from the data to be published before transmitting to SmartPlant Foundation.
This implementation can also validate the published data and raise messages during the publish
process. It can also update the publish progress bar with the status of each step.
By implementing this method, you can achieve the following:
Modify or add information to the published data that cannot be handled by the tool adapters.
Filter and limit information from the data being published.
Calculate additional information based on the publishing application data, such as finding
the beginning P&ID number for a pipeline.
Manipulate data to represent special business rules.
Validate data and raise an "invalid" state to EFClient to stop the publish process.
To log messages, make sure MessageIContainer is set, and add the messages to
MessageIContainer. The messages are saved to a log file.
To display progress steps in the publish progress bar, implement ListOfProgressSteps(). For
each step, call StepProgressBegin(stepName) before and StepProgressEnd(stepName)
after. Use the member variable of type IEFCustomPublishEventHandler with
SetEventHandlerObj().
For a sample implementation, see Sample Implementation (IEFCustomPublish) (on page 330).
Arguments
IEFCustomPublishEventHandler Interface
SmartPlant Client implements this interface to handle progress bar updates that are received
from the implementation of IEFCustomPublish. The software that implements IEFCustomPublish
declares an object of IEFCustomPublishEventHandler. This object is set in SmartPlant Client by
passing itself as the parameter to SetEventHandlerObj() and update the publish progress bar
with the required steps. The software implementation of IEFCustomPublish must call
StepProgressBegin() and StepProgressEnd() when required to update the publish progress bar.
StepProgressBegin
Description
This method is implemented in SmartPlant Client and raises the progress status of current
progressing steps to the publish progress bar. The software that implements the
IEFCustomPublish interface must call this method before each step.
Arguments
StepProgressEnd
Description
This method raises the progress information of the current progressing step to the publish
progress bar. The software that implements IEFCustomPublish must call this method after each
completed step. The steps must be filled with the string array StepNames by implementing the
ListStepNames method of the IEFCustomPublish interface.
Arguments
Implementation (IEFCustomPublish)
Sample Implementation (IEFCustomPublish)
Option Explicit
Implements EFCustomProcess.IEFCustomPublish
Dim ObjEFSrvMgrLocal As IEFCustomPublishEventHandler
Private m_oMessageIContainer As IContainer
Private m_oToolParms As IEFToolParameters
End Sub
llblErrorHandler:
Call
ECU_HandleErrorProcessPublishDta("IEFCustomPublish_ProcessPublishData",
m_oMessageIContainer, Err.Source, Err.Description, Err.Number)
llblExitProcedure:
End Sub
Registering Tools
Before you can publish and retrieve documents from any of the other authoring tools, such as
Aspen Basic Engineering or SmartPlant Instrumentation, you must register each plant in
SmartPlant P&ID with a SmartPlant Foundation database. The connection allows SmartPlant
P&ID to display the SmartPlant integration commands. A SmartPlant Engineering Manager
administrator typically registers plants.
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 once; this action takes
place in SmartPlant Engineering Manager. After the plant is registered, you can publish and
retrieve documents.
This command is available only if you have registered the active plant using the SmartPlant
Registration Wizard. For more information, see SmartPlant Engineering Manager Online
Help.
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.
Publishing Documents
In an integrated SmartPlant environment, you must publish documents containing the drawing
data and relationships before the authoring tools can share this information. The publishing
process involves selecting a document to publish, assigning it to a workflow (if necessary), and
specifying a revision and version of the document if specified in SmartPlant Foundation. For
most documents, the associated data is included in the publishing process.
The authoring tools publish data in XML format. The software then places the .XML file in the
appropriate SmartPlant Foundation vault and loads the data from the .XML files to the
SmartPlant Foundation database. After the document is published, users can retrieve the data
from the .XML file in the SmartPlant Foundation vault into other authoring tools.
When you publish documents, the software does the following things:
Creates a new master document and the first revision in SmartPlant Foundation the first
time you publish a particular document. From that point on, the software creates new
versions and revisions when the document is subsequently published. The software relates
revisions to the master document. You can publish subsequent revisions into a workflow,
which can be a different workflow than assigned in the original publish. Changes in the
document status of a related revision change the status of the subsequently published
versions and revisions of the document.
Publishes a visual representation of the document that you can view without the authoring
tool. For many applications, this is an Intergraph proprietary file, called a RAD file. The
viewable file can also be an Excel spreadsheet or another viewable file type, such as .pdf or
.doc. You can review and mark up the visual representation of the document, which is
attached to the document revision, using SmartPlant Markup.
Publishes associated data, depending on workflow approval. If the data is approved and
loaded, it is used for reporting and subsequent retrieval by downstream applications when
the tools retrieve latest data. The software publishes only meaningful engineering data. The
published data is not enough to re-create the document in the originating tool.
The software publishes some document types without the associated data, such as reports
from authoring tools (for example, line lists in SmartPlant P&ID). Users can submit
documents published without data to workflows just like documents with data. The document
types and data that you can publish depend on the authoring tool you are using.
Places the published .XML file and any view files in the appropriate SmartPlant Foundation
vault. This .XML file can be retrieved when users in the authoring tools retrieve as-published
data.
Sends notification to the publishing tool.
For more information about revisions and versions, see the SmartPlant Foundation Web Client
User's Guide or the SmartPlant Foundation Desktop Client User's Guide.
Reasons to Publish
You can publish documents and associated data for several reasons:
To exchange and enhance data among tools, to avoid creating data multiple times in
multiple authoring tools
To report on common data originating 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 in 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 rather by
using the default workflow from SmartPlant Foundation. When you do not select a workflow for a
document during publishing, the SmartPlant Loader Manager loads the document into
SmartPlant Foundation as soon as it reaches the top of the Loader queue.
Publishing Documents
Each authoring tool publishes different documents and data.
The PBS document contains information about the physical plant with a structure consisting of
plants, areas, and units. The default structure is plant/area/unit, but you can define a custom
hierarchy in the Schema Editor. When a PBS document is published from SmartPlant
Foundation, the authoring tools are notified about the plant, areas, and units that need to be
created in each authoring tool.
The project breakdown structure, project definition document, and project list contain information
about projects and their statuses. When these documents are published from SmartPlant
Foundation, the authoring tools are notified of projects and contracts that need to be created in
the authoring tools.
The project breakdown structure contains a single project and the hierarchy of contracts under
that project in a plant/project structure. The project definition document contains information for
a single project that needs to be created in the authoring tool. The project list contains a list of all
projects in a plant, and it is used by those authoring tools that create all projects at one time.
The plant breakdown structure and project breakdown structure used in the authoring tools
must match the structure in SmartPlant Foundation for publishing from the authoring tools
and object correlation to work correctly.
When you publish data from an authoring tool, you may not be able view all the properties
that you published in the SmartPlant Foundation client. You can customize view definitions
to allow you to see additional properties. For more information about defining view
definitions in the SmartPlant schema, see Working with View Definitions and Create a View
Definition in the Schema Editor User's Guide. For further assistance with visualizing data in
SmartPlant Foundation, contact Intergraph Support Services.
When publishing from a project, an instruction container, which contains all the claimed
objects, is created within the tombstone file.
* This step applies to a plant that is configured to use SmartPlant Foundation revisions. If your
plant is configured to use SmartPlant P&ID revisions, a new revision is added in the SmartPlant
P&ID Revise dialog box.
For details of the revision procedure, see SmartPlant P&ID Drawing Manager Help.
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard.
If you logged on to the authoring tool with a user name that is not defined in the
integrated environment, you are prompted to log on when you use this command.
A plug-in can be created that will allow user intervention to modify, add, or remove
information from data to be published before it gets transmitted to SmartPlant
Foundation. For details, see Pre-Publishing Automation from SmartPlant P&ID (on
page 325).
2. Add any additional documents to the Selected documents list by clicking one of the
following toolbar buttons:
Engineering Tool — Opens the Publish from Engineering Tool dialog box for
selecting documents.
File System — Opens a standard Microsoft dialog box that allows you to select
files. When you select a file with this Select File dialog box, the Document Properties
dialog box appears, allowing you to specify information about the file, such as whether it
is a new file; the category, type, and subtype of the document; and the name,
description, and title of the document.
Find — Opens the Find Documents to Publish dialog box, which allows you to
search for documents. These are documents that have at least one revision and that
were not published after creation of the last revision. For more information, see Find
Documents to Publish Dialog Box (on page 345).
The documents that appear in the Selected documents list in the Publish dialog
box when it first appears are publishable documents that were selected within the authoring
tool before you clicked the Publish command.
3. Edit properties as required for the selected documents.
When multiple documents are selected, only property values shared by all the selected
documents appear in the grid. Changing a value in the grid changes that value for all the
selected documents.
To remove an entry (or node) from the Selected documents list, select the node in the
tree, and then click the Delete toolbar button.
4. From the Operations list, choose a publish method.
Select Publish to immediately start the publishing process as soon as you click OK.
During publishing, an information dialog box appears with a progress bar. Click Show
Details to view details of the operation showing steps completed successfully, the current
step that is running, and steps yet to run. You can click Hide Details to hide this section of
the dialog box. If the View Log button on the dialog box is enabled, messages are available
concerning the operation. These messages may include errors or warnings or even
informational messages. Click View Log to see these messages.
The SmartPlant Schema file must be checked in to SmartPlant Foundation when you
publish. If the publish operation fails, contact your SmartPlant Foundation system
administrator to make sure the SmartPlant Schema is checked in to SmartPlant Foundation.
Publish a Report
1. Click SmartPlant > Publish.
Publish Workflows
When a SmartPlant application publishes, the user can publish documents using a workflow.
The following list describes the delivered publish workflows and use cases for the workflows.
Publish Takes the document through an Use Publish when you want
approval step. Upon approval, it the published document
creates the document load and approved before it is loaded
consolidate tasks. into SmartPlant Foundation.
The approval step is added to
the To Do list.
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard.
If you logged on to the authoring tool with a user name that is not defined in the
integrated environment, you are prompted to log on when you use this command.
2. In the Publish dialog box, click the Issue Request tab.
3. In the Issue to box, select the contract to which you want to assign the document or
documents.
4. Under Selected documents, select the documents you want to associate with the specified
contract.
5. Add any additional documents to the Selected documents list by clicking one of the
following toolbar buttons:
Engineering Tool — Opens the Publish from Engineering Tool dialog box for
selecting documents.
File System — Opens a standard Microsoft dialog box that allows you to select
files. When you select a file with this Select File dialog box, the Document Properties
dialog box appears, allowing you to specify information about the file, such as whether it
is a new file; the category, type, and subtype of the document; and the name,
description, and title of the document.
Find — Opens the Find Documents to Publish dialog box, which allows you to
search for documents. These are documents that have at least one revision and that
were not published after creation of the last revision. For more information, see Find
Documents to Publish Dialog Box (on page 345).
The documents that appear in the Selected documents list in the Publish dialog
box when it first appears are publishable documents that were selected within the authoring
tool before you clicked the Publish command. To remove documents from the list, select
them and then click the Delete toolbar button.
6. Click OK to issue the contract request for the selected documents to the integrated
environment.
7. Start SmartPlant Foundation Desktop Client on your computer and search for the published
document to verify the publishing process.
8. Right-click the document in the Desktop Client tree view and on the shortcut menu, click
Refresh.
9. Update the document. For more information, see the SmartPlant Foundation Desktop Client
User's Guide.
10. Review the issue properties by right-clicking the document and on the shortcut menu,
clicking Properties, and then clicking the Issue Request tab to see the issue information.
You can also open the document to see the issue information in the title block.
11. Publish the document with the updated issue information.
Engineering Tool — Displays a tool-specific dialog box that allows you to add documents
from authoring tools, such as P&IDs or PFDs, to the Selected documents list.
File System — Opens the standard Select File dialog box that allows you to select
documents, such as Microsoft Word documents or Microsoft Excel workbooks, to add to the
Selected documents list. When you select a file using this dialog box, the Document
Properties dialog box opens, allowing you to specify information about the file, such as whether
it is a new file or was previously published; the category, type, and subtype of the document;
and the name, description, and title of the document.
Find — Opens the Find Documents to Publish dialog box, which allows you to search for
documents to add to the Selected documents list.
Even with the Issue Only option set, documents may still be published. Any documents that
have never been published must be published, regardless of this setting.
You will receive an error message if you select multiple documents and activate this option
when one or more of the selected documents cannot be changed. For example, if a selected
set of documents includes new documents (for which this field can be set only to No) and
current or locked documents (for which this field can be set only to Yes), the error message
prompts you to select a smaller set of documents.
Owning Group - Select an owning group from the drop down list to which the document
belongs.
By default, the owning group selected for the previous version, if any, is shown.
All the owning groups configured in SmartPlant Foundation are listed.
Revision - Displays the current revision number of the selected document or documents.
You will receive an error message if you attempt to change the value in this box when you
have selected one or more documents that have conflicting revision schemes or different
possible revisions. The error message prompts you to select a smaller set of documents.
Revision Scheme - Displays the revision scheme applied to the selected document or
documents.
Only revision schemes that are applicable to the configuration (plant) or classification
(document type) are available in the shortcut menu. The revision schemes related to a
configuration or classification are not available for any other configurations or classifications. If
none of the revision schemes are related to the configuration or classification, then all revision
schemes are available unless they are related to any other configuration or classification. For
more information on revision scheme configuration, see Configuring Different Revision Scheme
Strategies in the How to Configure Document Management guide.
You will receive an error message indicating that this field cannot be edited if one or more
of the documents you have selected are not new or will have a revision scheme supplied by the
authoring tool. The error message prompts you to select a smaller set of documents.
Version — Indicates the current version of the document or documents.
Workflow — Indicates to which workflow the selected document or documents were assigned.
You will receive an error message indicating that this field cannot be edited if one or more
of the documents you have selected have conflicting sets of possible workflows. The error
message prompts you to select a smaller set of documents.
Check and publish released claims for previously deleted items - Select this check box to
resolve issues where deleted items were restored from an earlier version and the claim on them
was released. This check will take additional time and should only be used when deleted items
have been restored.
Operation — Select the operation you want to perform on the selected documents. Choose
from the following options:
Publish now — Selected documents are published immediately.
Background publish — Selected documents are published immediately as a separate
process, allowing you to perform other tasks at the same time.
Scheduled publish — Selected documents are published in batch mode by the authoring
tool. This option is available only for tools that support it and if processed by the authoring
tool, not the SmartPlant Client. The documents are not published immediately. Instead, the
selected documents are scheduled for publish at a later time and maybe be scheduled as a
recurring operation.
Custom — If applicable, opens the Custom dialog box. This functionality is available only if
defined by your project implementation team.
Issue to — Contains a list of all objects (contracts) that can support issue requests. When you
select an item from this list, the names of any documents associated with that object appear in
the table below.
Add — Creates a new item in the table for any documents highlighted in the Selected
documents tree view.
Remove — Deletes a selected document from the table.
Document Name — Displays the names of all documents associated with the object in the
Issue to box.
This feature is also available by clicking Find on the Publish dialog box.
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard.
The Find Documents to Publish command determines which documents need to be
published or re-published and displays the results on the Find Documents to Publish
dialog box.
2. From the Select documents to publish list on the Find Documents to Publish dialog box,
select the check boxes beside the documents that you want to publish.
You can quickly select the entire list by clicking Select All, or you can clear the entire
list by clicking Clear All.
3. Click OK to accept the selections. The documents you selected to publish now appear in the
Documents to Publish list on the Publish dialog box, and are ready to be published.
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 whether you are running the applications
in synchronous or asynchronous mode.
Check for deleted objects no longer on documents option will be checked and disabled
if Automatic process of moved objects option is set to TRUE on the Manage Integration
Options dialog box in the SmartPlant Foundation Desktop Client. For more information, see
Configure Automatic process of moved objects in the Integration Administrator's Guide.
The status bar contains three separate areas of information.
Revising Documents
The document revision process is separate from the publishing process, making it possible to
revise a document locally and in SmartPlant Foundation and save the revision values to the tool
database without re-publishing the document. You specify the revision using the Revisions >
New Revision command in Drawing Manager.
Revising a document creates a revision for the document with major and minor revision values
set, depending on the revision schema selected. When revising a document, you can modify the
major and minor revision data on the document.
You can change the revision scheme after a document has been published, skip revision
numbers, and manually add a revision number, then have it validated against the revision
scheme. It is not required to assign a minor revision number. Also, revision data from tools is
supported even if the document has previously been revised in SmartPlant Foundation.
You can revise a document by using any previous revisions that are available from
the last published revision.
Example:
If you revise a new document using the revision scheme RevAlpha (A, B, C, D…) and revision
C, then SmartPlant Foundation reserves revision number C for the document. Revising the
same document with RevAlpha, you can now revise with any previous revision numbers, such
as A or B. However, if the document is published to SmartPlant Foundation with revision number
C, you are not allowed to go back to the previous revision numbers.
The following table contains the available revision numbers based on the document revision
state in SmartPlant Foundation:
For more details about performing revisions for SmartPlant P&ID, see Revising Drawings in the
SmartPlant P&ID Drawing Manager User's Guide.
Retrieving Documents
When you retrieve documents into an authoring tool, you are retrieving the document data that
was published by another authoring tool. For example, in SmartPlant Instrumentation, you can
retrieve engineering information from a published P&ID into the SmartPlant Instrumentation
database.
The authoring tools provide commands that let you select a document and retrieve it into that
tool. You can use either the SmartPlant > 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.
When you publish a 3D model, you must now enable the Scheduler and Loader in
SmartPlant Foundation to make the 3D model data document retrievable. The load, consolidate,
and merge tasks must complete successfully before the 3D model document can be retrieved.
The software trims all leading and trailing spaces from all strings and from all values
without units of measure. These spaces do not appear in the retrieved data file.
Additionally, you can access the Web Client through the SmartPlant > Browser command. This
allows you to select the document or documents that you want to retrieve from your Web Client
To Do List, the tree view, or by using the Web Client search functionality. After you select the
documents that you want to retrieve, you can use the Retrieve command on the Web Client
SmartPlant menu to start the retrieval process.
The Retrieve command provided in the authoring tools is slightly different from the Retrieve
command available in the SmartPlant Foundation Web Client. The Web Client presents a list of
documents from which you can select those you want to retrieve. However, when you use the
command from an authoring tool without first selecting documents, the software searches the
SmartPlant Foundation project for documents to retrieve, and these are presented in a list on
the Retrieve dialog box.
You can retrieve a document in two ways:
As published — Retrieves only the data the authoring tool originally published with the
selected revision and version of the document. Retrieving as-published data retrieves the
.XML file the authoring tool published from the appropriate SmartPlant Foundation vault.
With the latest data — Retrieves the latest data associated with the selected document in
the SmartPlant Foundation database. If another, more-recently published document contains
updates to objects in the selected document, the software retrieves the most current data in
the SmartPlant Foundation database for those shared objects. When you retrieve the latest
data, SmartPlant Foundation generates an .XML file containing the published data.
breakdown structure, project list, and project definition document contain information about the
project or projects and their statuses in a plant/project structure.
Retrieving the project breakdown documents and the PBS into SmartPlant Engineering
Manager creates the appropriate structures automatically.
When using SmartPlant Instrumentation, you must create the plant hierarchy according to
the PBS information in SmartPlant Foundation before you retrieve either the PBS or the
project definition document. You must create a plant hierarchy with at least three levels with
a minimum of one unit before you can retrieve the PBS and project definition document.
When working in a project, retrieval is not available.
For certain document types, the tool schema definition may specify that To Do List tasks
(Create, Update, or Delete) will not be generated for those document types. For details, see
Suppress Generation of Tasks on Retrieve (on page 286).
Design Basis
Objects that tools retrieve from other authoring tool documents can become the design basis for
objects in downstream documents. Objects that become the design basis for other objects can
be specific objects that get richer as they move through the life-cycle or can be schematic or
logical objects in one application that evolve into more detailed objects downstream.
Design basis is implicit based on retrieval; you do not have to define it. For example, a pump
retrieved from a PFD becomes the design basis for a pump in the P&ID. When you change
common properties for the pump and retrieve the changes into SmartPlant P&ID, tasks to
update property values automatically appear in the To Do List. The same process works for
logical items that are a design basis for other items, such as a stream in Aspen Basic
Engineering that results in multiple pipe runs in SmartPlant P&ID, or a P&ID tag in SmartPlant
P&ID can evolve into a control loop with associated tag numbers in SmartPlant Instrumentation.
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard.
If you logged on to the authoring tool with a user name that is not defined in the
integrated environment, you are prompted to log on when you use this command.
The Retrieve command searches the SmartPlant Foundation plant for documents that
are ready to be retrieved into the authoring tool. These documents appear in the
Documents to retrieve list in the Retrieve dialog box.
2. In the Document type list box, specify the type of document to be retrieved. The default
option is All.
3. Select further filtering options in the Show area of the dialog box.
Select New documents to only display documents that have not been retrieved
previously.
Select New versions of retrieved documents to only display documents that are a
new version of a previously retrieved document.
Select Unchanged documents to display documents that have not been modified since
the last retrieval process.
4. Select Documents of all owning groups to display all documents.
5. In the Documents to retrieve list, select the check box beside each document you want to
retrieve. To help identify the documents, review the details in the Type, Revision, Version,
and Last Retrieved columns.
To quickly select the entire list, click Select All. To quickly cancel the selections, click
Clear All.
6. For each document you selected, use the Retrieve Option column to specify whether you
want to retrieve the document with the latest data or retrieve it as published.
7. Click OK to retrieve the specified documents.
Select the Batch retrieve option if you want the retrieve process to run in batch mode. If
you select this option, an e-mail message will alert you when the process is complete.
Otherwise, the retrieval process begins when you click OK.
The Deleted and Unclaimed Objects document is retrieved automatically every time you
retrieve, if there is a newer version of this document since the last retrieval. The
document is not included in the list, but it is retrieved automatically, when necessary, to
ensure that the applicable information is updated.
During retrieval, an information dialog box appears with a progress bar. If the View Log
button on the dialog box is enabled, messages are available concerning the operation.
These messages may include errors or warnings or even informational messages. Click
View Log to see these messages.
Clear All — Cancels the selection of documents in the Documents to retrieve list.
Batch retrieve — Indicates that the system will retrieve the selected documents in batch mode,
in other words, in the background. When you use this feature, an e-mail message alerts you
when the process is complete. Otherwise, the retrieval process begins as soon as you click OK.
Work Breakdown Structure (WBS) documents, such as the Project List, Project
Definition, and Project Breakdown, and Plant Breakdown Structure (PBS) documents are
considered Administrative documents by the software and must be retrieved by all tools that
subscribed to these types of documents. So, even when these documents are new to the tools
(have not been retrieved by the tool before), they are still listed in the Documents to be
retrieved only list because they must be retrieved.
Correlation
Correlation may be defined as establishing a design basis for an item that has a separate
representation in two tools. For example, an instrument can share a design basis between
SmartPlant P&ID and SmartPlant Instrumentation; if data for that instrument is updated and
published from one of the tools and then retrieved in the other tool, an Update task is generated
for the correlated item.
In many cases, a one-to-one relationship exists between an item in an external application and
an item or items in the drawing software. For example, a piece of equipment defined in Aspen
Basic Engineering usually maps to a single equipment item in SmartPlant P&ID. In these cases,
once correlation has taken place, it is not possible to correlate the item in SmartPlant P&ID with
any other item in the external application unless the item is first uncorrelated. In addition, if an
item that has a design basis is deleted and then published in the external application and
afterwards retrieved in SmartPlant P&ID, a Delete task will appear in the To Do List for the
correlated item.
Correlation of the same item with different applications occurs independently.
For some types of piping, a single item in the external application is associated with multiple
items within the drawing software. For example, a single stream item in Aspen Basic
Engineering normally maps to multiple pipe runs in SmartPlant P&ID. The Correlate command
allows you to review and manage these relationships within the drawing environment.
Automatic Correlation
Automatic correlation takes place when you run a task in the To Do List for an item that does not
have an existing design basis. This can occur in the following situations:
A newly-created item in the external application that does not have a matching item tag in
SmartPlant P&ID is retrieved in SmartPlant P&ID. This results in the generation of a Create
task. When this Create task is run, the item is created in the SmartPlant P&ID drawing and is
automatically correlated with the item in the external application.
Automatic correlation does not take place for items that are initially created in the
plant stockpile, such as loops. Such items must first be moved to the active drawing
stockpile and then correlated manually.
An item in the external application that has a matching item tag in SmartPlant P&ID and
non-identical mapped properties is retrieved in SmartPlant P&ID. This results in the
generation of an Update task. When this Update task is run, the properties of the item are
updated in SmartPlant P&ID and the item is automatically correlated with the item in the
external application.
Manual Correlation
Manual correlation is available on the To Do List for Create tasks only, and is allowed under the
following conditions:
The selected item cannot have an existing design basis for the same tool from which the
item was published.
The selected item must be of the same item type as the item for which the Create task
applies.
If a catalog item exists for the selected item, its catalog item type must be the same as the
catalog item type defined for the Create task.
For more information, see Perform Manual Correlation (on page 362).
Uncorrelating Items
When a design basis exists for an item, the item can be uncorrelated in one of the following
ways:
On the To Do List, you can uncorrelate items from their Update or Delete tasks. For details,
see Uncorrelate Items from the To Do List (on page 362).
Using the SmartPlant > Uncorrelate command, you can uncorrelate items even if they
were not deleted or their properties were not changed in the external application. For details,
see Uncorrelate Items (on page 354).
Uncorrelate Items
The purpose of this procedure is to uncorrelate drawing items with their design basis items.
1. Select one or more items on the drawing.
2. Click SmartPlant > Uncorrelate.
In the Design basis details pane, beside the ID, Item Tag and Item Type Name
columns, the software displays additional columns for each of the tools for which a design
basis exists for the selected drawing items.
3. On the Uncorrelate dialog box, select the check boxes for the items that you want to
uncorrelate for each tool.
To uncorrelate all of the items in a particular tool that have a design basis, select the
check box in the header for that tool.
If an item does not have a design basis for a particular tool, the cell is read-only and it is not
possible to select the check box.
After uncorrelating an item, any relevant tasks for that item on the To Do List dialog box are
removed.
For SmartPlant P&ID Engineering, it is not possible to run Create or Delete tasks.
Each task in the To Do List has a status. Initially, the status is Open. If you successfully run the
task, the status changes to Complete . If you attempt to run a task, but the process is not
completed successfully, the status is changed to Error . Error status occurs, for example, if
you attempt to run an Update task assigned to a drawing that is not currently open. For a
Create task where the task runs successfully, but the software has made changes to the item
tag, the status is updated to Completed with Warning . For more details, see Example of
Completed with Warning Status (on page 358). You can also postpone running a task and
change its status to Deferred .
SmartPlant P&ID retrieves equipment components and nozzles and generates corresponding
Create tasks in the To Do List for them. The system allows you to automatically place the items
in a drawing when the To Do List task is executed. The items are placed attached to their
parent equipment item, based on a spacing algorithm. You can adjust the location,
post-placement, as necessary.
When the software creates an Update task 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.
The software opens a Drawing view with the drawing items that are associated with the task
highlighted.
The Zoom command is available only for Update and Delete tasks, not for Create tasks,
and only when the drawing that the item belongs to is already open.
3. Click Run .
For SmartPlant P&ID Engineering, it is not possible to run Create or Delete tasks.
If a task is assigned to a drawing, the drawing must be open before you can run the task.
You can open a drawing from the To Do List.
Manually created tasks are not executable tasks and cannot be run from the To Do List.
6. Double-click the Create task to open the Properties dialog box for the task and click the
General tab.
An indication of the warning appears in the Notes field, together with details of the loop
renaming.
8. On the Add Filter dialog box, define a filter using the Task Assignment property as shown
in the example below.
In the Value field, you can use a percent sign (%) as a wildcard character to find
multiple characters or an underscore (_) as a wildcard character for a single character.
9. Click OK to apply the filter on the To Do List.
You cannot perform Correlate or Uncorrelate to items in the To Do List that were
upgraded from versions prior to SmartPlant Instrumentation 2013. Republish the To Do List to
allow the correlation functionality to work with items that were upgraded from versions prior to
SmartPlant Instrumentation 2013.
Open Drawing — Opens the drawing associated with the selected task. If the drawing is not
active, this command activates it. Any currently-open drawings 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 tasks
in the Drawing view. You select the tasks from the list. 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 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.
Create in Drawing — If this button is depressed, the item created by running the selected
task is placed on the active drawing. If the button is not depressed, the item is created in the
Plant stockpile.
Run — Runs the task that you select from the list. 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 and
importing data. 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 . For a Create task where the task runs successfully,
but the software has made changes to the item tag, the status is updated to Completed with
Warning . For more details, see Example of Completed with Warning Status (on page 358).
When the status is Error or Completed with Warning, a timestamp and error message are
added to the Notes area on the General tab of the Task Properties dialog box.
Defer — Toggles the status of the selected tasks between Open and Deferred . This
command is available only when the selected tasks have Open, Error , or Deferred status.
Delete — 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.
Ignore — Allows you to specify the selected task from the To Do List as an ignored
task. This command is available only when one or more tasks are selected. When you invoke
this command, the software moves all the selected tasks to the ignored tasks list. An ignored
task is skipped for all subsequent retrieve operations. To make a task available for running
again the next time you retrieve data, you must delete that task from the ignored tasks list.
Correlate — Allows you to correlate tasks manually when a retrieved item tag does not
match the defined correlation criteria. This command is available only when a Create task is
selected. To correlate an item, you select a suitable item on the drawing sheet or in the
Engineering Data Editor. After correlation, the Create task changes to an Update task and
the software removes any properties on the task that have the same values as those of the item
selected on the drawing sheet.
Correlation is allowed under the following conditions:
The selected item cannot have an existing design basis for the same tool from which the
item was published.
The selected item must be of the same item type as the item for which the Create task
applies.
If a catalog item exists for the selected item, its catalog item type must be the same as the
catalog item type defined for the Create task.
Uncorrelate — Allows you to uncorrelate tasks related to items on the drawing sheet or in
the Engineering Data Editor. This command is available only when Update or Delete tasks
are selected. After uncorrelating tasks, the items will no longer be correlated with the tool from
which those tasks were retrieved. The tasks are permanently removed from the To Do List and
do not appear on the deleted tasks list. The next time the document is retrieved, the To Do List
is updated.
View Deleted Tasks — Toggles the view between the To Do List and the deleted tasks
list. To completely delete tasks, you select them from the deleted tasks list and click Delete
.
View Ignored Tasks — Toggles the view between the To Do List and the ignored tasks
list. To make tasks available for running again the next time you retrieve data, you select them
from the ignored tasks list and click Delete .
Report — Opens Microsoft 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 reports are produced.
Filter / Sort Tasks — Opens a dialog box that allows you to filter or sort the list of tasks by
the headings in the To Do List. This is useful if, for example, you want to filter or sort the tasks
in order to run tasks of one type only, such as Create tasks.
Refresh — Updates the information that is displayed in the To Do List. Since only one To
Do List is generated per plant, multiple users can be working in the To Do List at the same
time, and so the information can change at any time. You can use the Refresh command to
stay up-to-date.
Group Related Tasks — When this button is depressed, clicking on the column header not
only sorts the tasks based on the selected sort key but also groups the related tasks. If the
Group Related Items button is not depressed, then clicking on the column header only sorts
the tasks based on the selected column sort key.
Task List
Populates automatically when you retrieve a document. 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.
The Task Assignment column value is assigned on the General tab of the Properties
dialog box for the task and is intended for filtering To Do List tasks.
Filter Tab
This dialog box allows you to filter the data displayed on the To Do List dialog box according to
the category headings for the To Do List tasks.
Filter name — Displays the name of the selected filter, defined in the Filter Manager. To select
a filter, click the ellipsis button .
Clear — Clears the selected filter in the Filter name field so that you can clear the filter on the
To Do List.
Sort Tab
This dialog box allows you to sort the data displayed on the To Do List dialog box according to
the category headings for the To Do List tasks.
Sort by
Allows you to select the first category to sort the list by.
Ascending —Sorts by the beginning of the alphabet, the lowest number, or the earliest date
first for the selected category.
Descending —Sorts by the end of the alphabet, the highest number, or the latest date first for
the selected category.
Then by
Allows you to select the second category to sort the list by.
Ascending —Sorts by the beginning of the alphabet, the lowest number, or the earliest date
first for the selected category.
Descending —Sorts by the end of the alphabet, the highest number, or the latest date first for
the selected category.
Then by
Allows you to select the third category to sort the list by.
Ascending —Sorts by the beginning of the alphabet, the lowest number, or the earliest date
first for the selected category.
Descending —Sorts by the end of the alphabet, the highest number, or the latest date first for
the selected category.
Clear —Clears the selected sort selections so that you can clear the sorting on the To Do List.
General Tab
Displays properties that are common to all types of tasks. The Task Properties dialog box
opens when you click Properties on the To Do List dialog box toolbar.
Name — Provides a descriptive string that helps you identify the purpose of the task. This value
is not a unique identifier for the task.
Description — Displays a longer description of the purpose of the task.
Task assignment — Free text field whose value is used for filtering tasks to be displayed on the
To Do List dialog box.
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 list of To Do List tasks.
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.
If you run a Create task for an item that already exists, the new item automatically
receives a new sequence number, and the To Do List item status becomes Completed with
Warning, indicated by the icon . In the Notes field, the message 'Task completed with a
warning' is displayed, together with details of the sequence number change.
Details Tab
Provides information that is common to all types of tasks and that concerns the source and
destination of the information being imported as part of the task. The Task Properties dialog
box opens when you click Properties on the To Do List dialog box toolbar.
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,
an Aspen Basic Engineering equipment data sheet or a SmartPlant Instrumentation 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.
History Tab
Provides information this is common to all types of tasks and that concerns the history of the
task. This information includes the user names and dates for the creation of an item,
modification of an item, and so forth. The information on this tab is read-only. The Task
Properties dialog box opens when you click Properties on the To Do List dialog box toolbar.
Created By — Displays the user name of the task creator.
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 By — Displays the user name that removed the task.
Deleted Date — Displays the date and time that the task was removed.
Create Tab
Displays information specific to tasks that create new items in the drawing. This information
includes the type of item created and the names and values of the properties of the new
item. The Task Properties dialog box opens when you click Properties on the To Do List
dialog box toolbar.
Item type — Displays the type of item to be created.
Catalog item — Indicates the catalog item used to create the drawing item if the task is run.
Correlation action — If running the task involves correlating data with another item, the text
Correlate appears in this box; otherwise, the value in the box is empty.
Item properties
Displays the task data properties and enables you to select which properties to include when
you run the task.
Activate — Creates the value in the database when you run the task. This option applies only
to tasks for which the status is New, Open, or Deferred.
Ignore — Ignores the new value of the property when you run the task, unless the new value
changes after subsequent retrieval. This option applies only to tasks for which the status is
New, Open, or Deferred. To ignore a property for the current retrieve session only, clear both
the Activate and Ignore check boxes.
Property — The name of the item property as it appears in SmartPlant P&ID.
New Value — The new value of the item property in the SmartPlant P&ID database as indicated
in the retrieved document.
Update Tab
Displays information specific to tasks that update existing items in the drawing. This information
includes the type of item created and the names and values of the item properties. The Task
Properties dialog box opens when you click Properties on the To Do List dialog box toolbar.
Item type — Displays the type of item to be updated.
Catalog item — Indicates the catalog item used to create the drawing item if the task is run.
Correlation action — If running the task involves correlating data with another item, the text
Correlate appears in this box; otherwise, the value in the box is empty.
Item properties
Displays the task data properties and enables you to select which properties to include when
you run the task.
Activate — Updates the value in the database when you run the task. This option applies only
to tasks for which the status is New, Open, or Deferred.
Ignore — Ignores the new value of the property when you run the task, unless the new value
changes after subsequent retrieval. This option applies only to tasks for which the status is
New, Open, or Deferred. To ignore a property for the current retrieve session only, clear both
the Activate and Ignore check boxes.
Property — The name of the item property as it appears in SmartPlant P&ID.
New Value — The new value of the item property in the SmartPlant P&ID database as indicated
in the retrieved document.
Old Value — The current value of the item property in the SmartPlant P&ID database.
verify the design, and it automatically reports in the graphical view on junctions that do not follow
these rules.
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 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.
In SmartPlant P&ID Engineering, consistency checking occurs continuously as you modify
equipment according to settings in SmartPlant P&ID Rule Manager. Double-click an
inconsistency in a Drawing view, and the Consistency Check dialog box lists solutions to fix the
errors.
PDS 2D uses levels to separate data types in the Drawing view. The software automatically
defines levels for the various parts of process systems. You can customize these levels, and
you can combine them to view collective data sets.
In SmartPlant P&ID, display sets show certain parts of the drawing, such as only the equipment
or only the piping. A display set consists of one or more filters. For example, you can define a
display set that combines 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.
SmartPlant P&ID filters fall into the following categories:
Plant filters
Personal filters
Plant filters are stored in Plant Folders, and personal filters are stored in My Folders. The plant
administrator defines Plant 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. For more information about display sets, see Apply Display Set Dialog Box (on page
181).
Troubleshooting
Problem: The application fails to launch or stops working when the user launches it.
Reasons: The application may fail to launch due to damage in any of the following areas:
Cached data
Database connection or database client
Database server, site, or plant
SmartPlant P&ID client software
SmartPlant P&ID client USER information
Solution: We recommend that you perform each of the following steps in the order shown and
after each step try to launch the application. If the application still fails to launch, proceed to the
next step:
1. Open Task Manager and terminate the draft.exe process.
2. Reboot the computer.
3. Clean up temporary cached data (.tmp and .temp files) in the client's user profile. These
files are usually located in the path C:\Documents and Settings\username\Local
Settings\Temp\.
4. Check the database connection using the appropriate database tools.
5. Delete the SmartPlantManager.ini and SmartPlantPID.ini files. These files are usually
located in the path C:\Documents and Settings\username\
6. Uninstall the software client and do the following:
a. Clean up the current USER registry information:
HKEY_CURRENT_USER\Software\Intergraph\Applications\SmartPlantPID.Application
b. Ensure that the following registry settings have been removed:
HKEY_LOCAL_MACHINE\SOFTWARE\Intergraph\Applications\SmartPlantPID.App
lication
HKEY_LOCAL_MACHINE\SOFTWARE\Intergraph\SmartPlant P&ID
c. Clean up any left-over files and the following folders:
SmartPlant P&ID installation folder ..\SmartPlant\P&ID Workstation\.
Any subfolders in the Windows\Downloaded Installations\ folder that contain
SmartPlantPID.msi files.
Deletion of the SmartPlantManager.ini file and the current user's registry
environment will clear the user's recent activities and customized menu look-up.
d. Reinstall the software client.
If, after performing all of the above troubleshooting steps, the application still fails to launch,
contact Intergraph Customer Support.
check in
The process of moving a file from a user location to a storage location and recording that
location in the database.
class
A blueprint for creating an item. The class defines the properties and behaviors that an item can
show.
client
A user, software application, or computer that requests the services, data, or processing of
another application or computer. The client is the user process. In a network environment, the
client is the local user process and the server may be local or remote. All network operations
among two or more nodes establish a client/server relationship.
client/server database
A database system in which the database engine and database applications reside on separate,
intelligent computers that communicate with each other through a network. In this system, the
processing power is split between the two CPUs. The workstation for the user is the client, and
the database runs on the server.
code list
See select list.
collaboration
Working jointly. In Workshare, satellite sites work together with the host site to share the
creation and maintenance duties for P&ID drawings and related data.
column
An attribute of a database table. A group of columns defines a table in the database.
commodity code
A code you define that provides an index to material descriptions.
commodity item
A standard component that you can find in a manufacturer catalog.
commodity option
A pre-defined exception to the default settings for a component definition in the Piping Job
Specification.
component
A catalog item that represents a part of the P&ID. A component has database information
associated with it.
concentric
Having a common center or origin point with varying radii.
configuration files
Files that are used to identify and characterize the components of a network. Configuration is
largely a process of naming network components and identifying relationships among those
components.
connect point
An active point item that is specially designated in a component. A connect point is a location at
which lines, labels, and other components connect to one another. Also, a location for applying
a relationship.
connectivity
Linkage between items that relate 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.
data dictionary
The underlying data model of a plant, consisting of database entries and select lists. SmartPlant
Data Dictionary Manager maintains this information.
data model
Application items that populate a project. Typical items in a data model are components, lines,
and labels.
database
Collection of files of comprehensive information that have predefined structure and organization;
a specific program can communicate, interpret, or process these files.
database administrator
The technical support person who assigns user IDs and data access permissions, creates new
databases, removes databases no longer in use, and monitors disk storage usage of the
database and performance.
database link
A pointer that defines a one-way communication path from an Oracle database server to
another database server. This pointer is stored in the local database and identifies the remote
database, a communication path to that database, and optionally, a user name and password. In
connected Workshare, the database link is used to access the remote database, providing the
satellite a view into the plant schema at the host site.
database table
Part of the database consisting of rows and columns and containing information about the
project and design elements.
design file
File containing graphics and text data, also called a drawing file.
design-wide break
A region of the drawing within which a single property value is defined for all the included
components. Indicating the region, a closed shape exists, along with an accompanying label that
shows the property value.
display-only annotation
Feature that allows you to generate temporary annotation graphics for review without placing the
graphics in a design file.
drawing file
File that contains graphical items; also called a design file.
drawing, P&ID
Graphics file that contains data about one unit. Each drawing has a unique drawing number
within the unit to which the drawing belongs.
driving label
Graphics, text, or both with their own properties that are placed on the P&ID to define property
values of the components and groups to which they apply.
easting
Term used in plane surveying that describes an east, or positive, difference in longitude.
edge-edge model
A model that represents connectivity entirely by edges.
enumerated list
See select list.
equipment components
Items associated with pieces of equipment, such as nozzles and trays.
equipment group
A single-name equipment body and any items within or attached to the body, such as a tray or
nozzle.
exclusive database relationship
Relationship that exists between any given item and the parent item to which it belongs, for
example, an instrument can belong only to one loop at a time.
exit elevation
Lowest downstream elevation point on the internal diameter of a pipe.
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.
full path name
Name of the entire path or directory hierarchy to a file, including the filename. See also relative
path name and UNC path.
gap
Condition that exists when two lines intersect graphically on the P&ID but not physically in the
plant.
hierarchical
An ordered relationship from greatest to least; refers to the relationships among groups,
components, and labels.
hierarchy
A classified structure with superiors, or roots, and subordinates, or dependents, for grouping
files or commands.
horizontal angle
Angle measured in the horizontal plane. Horizontal angles are the basic measurements needed
to determine bearings and azimuths.
horizontal distance
Distance between two points computed using only the northing and easting coordinates of the
points.
host
A computer that acts as the controlling source of information. In SmartPlant P&ID Workshare, a
site that controls satellites.
implied piping component
Piping components that the software creates in the alphanumeric database; these components
are not represented graphically.
inline
Term used to refer to those piping or instrument components that have been inserted in a piping
segment.
inline instruments
Components that have been inserted in a piping segment. Inline instruments include instrument
valves, such as butterfly valves and temperature regulator valves, and other instrument
components, such as orifice plates and flow controllers.
instance
A single allocation of an item class.
instrument loops
A group of one or more instruments or control functions arranged so that signals can pass from
one function to the next for the purpose of measuring and controlling a process variable. In
SmartPlant P&ID, you can create instrument loops containing any combination of inline and
offline instruments.
instruments
Devices that directly or indirectly measure or control a variable in a plant process, such as flow
or temperature. Instruments can be devices such as final control elements, computing devices,
or electrical switches. Two types of instruments exist: inline instruments and offline instruments.
interference checking
Process that identifies possible collisions or insufficient clearance between items in a drawing.
isometric
Relating to or concerning a drafting system characterized by three equal axes at right angles; a
view in which the horizontal lines of an item are drawn at an angle to the horizontal and all
verticals are projected at an angle from the base.
item
Unit of storage within a larger unit, such as a file in a catalog; a single member in a drawing.
item type
Distinct objects that users can manipulate in SmartPlant P&ID, such as equipment, events, and
safety classes.
keypoint
A point on an item, including vertices, which is used to connect to the item.
label
A graphic representation that reflects the status or condition of an associated item.
line route
Collection of ordered line runs, gaps, and components that all share the same attribution. A line
route contains line runs, components, gaps, and properties; however, a line route does not
contain any branches.
line style
Collection of formats or properties that you name and store as a group to apply as a style of a
line.
loop
Software structure that allows a specified sequence of instructions to run repeatedly, if the
stated conditions remain constant.
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.
model
A representation of graphics or a schema; collection of all items and their relationships to create
a coherent description of a process plant.
model file
A design file or database file that defines the 2-D or 3-D geometry and connectivity of a
structure.
MTO
Material take-off; also called a Bill of Materials.
net service alias
(Oracle) An alternative name for a directory naming object in a directory server. A directory
server stores net service aliases for any defined net service name or database service.
net service name
(Oracle) A simple name for a service that resolves to a connect descriptor. Users initiate a
connect request by passing a username and password along with a net service name in a
connect string for the service to which they wish to connect: CONNECT
username/password@net_service_name.
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.
node name
A name or alias that you can assign to the node address of a device on a network.
northing
Term used to describe a north coordinate location in the plant coordinate system.
nozzle
A special equipment item that contains the connection point to piping.
offline
Term that refers to those instrument components that are not inserted in a pipe run.
offline instruments
Components that are not inserted in a piping segment. Typically, these components are the
instruments that monitor and control inline instruments. Offline instruments include temperature
regulators, level gauges, and system functions, such as digital control stations (DCS) or
computers.
Oracle Net
Communication software that enables a network session from a client application to an Oracle
database server. Once a network session is established, Oracle Net acts as a data courier for
the client application and the database server. It is responsible for establishing and maintaining
the connection between the client application and database server, as well as exchanging
messages between them. Oracle Net is able to perform these jobs because it is located on each
computer in the network.
Oracle Net Manager
A graphical user interface tool that provides an integrated environment for configuring and
managing Oracle Net Services.
ORACLE_HOME
An alternate name for the top directory in the Oracle directory hierarchy on some
directory-based operating systems.
orthogonal view
A view that is a projection of the drawing onto a plane along lines that are orthogonal to the
plane.
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 relative path name.
peak flow
Maximum flow rate of water through a specific size pipe.
PFD
Process Flow Diagram; a drawing that serves as a start for a P&ID.
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 and Instrumentation Diagram (P&ID)
A primary drawing for maintaining a plant. The P&ID includes three primary groups of items:
equipment, piping, and instrumentation. The drawing relates critical process-related information,
such as process conditions for temperatures and pressures, and identifies physical components
in the plant. The P&ID is the basis for both the construction of the physical plant and further
specification of instrumentation components.
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 Materials Class (PMC)
Classification of components by service or specification - for example, a 150-pound carbon steel
specification.
piping network
Series of connected pipe runs and inline components. A network terminates at a nozzle,
off-page connector, utility connector, or one-point piping component - for example, a pipe cap.
piping segment
A line string with two or more vertices that defines the centerline geometry of the pipe run and
contains the non-graphic data associated with the pipe run.
plant
A group of facilities and equipment that performs one or more material processing functions
within a given geographical area. One company can have several plants located at different
geographical locations.
plant group items
The building blocks, such as site, plant, unit, area, and level, used to create plant breakdown
structures or plant structure hierarchies.
plant structure
Represents the business structure or physical hierarchy of a plant.
process line
Ordered collection of connectors and inline components with an equal set of core properties -
typically, items with the same line number. Specifically, a representation of the piping that
transfers process fluid.
process point
A tool that defines the operating conditions at a particular place during a process. Examples
include defining temperature, density, and flow rate.
project
1. A directory file created in an application environment that contains design files and
subprojects. A project is not necessarily specific to an application; the project may contain
design files from multiple applications.
2. Term used for convenient grouping of either all or part of the items that constitute a plant.
Several projects can be under design at one time, probably in separate geographical
locations and having limited communication among them.
projection lines
Witness lines; lines extending from the boundaries of an item and between which dimensioning
data for the area marked by the projection lines is placed.
property
A unique characteristic of an object, item, symbol, or document.
The properties of an item can include display properties and properties stored with the item. For
example, the properties of a valve symbol can include display properties such as color, line
style, and width. Other properties stored with the valve symbol can include the manufacturer,
cost, or material. Properties stored with the valve symbol are displayed in the Properties window
when the valve symbol is selected.
publish
To release a P&ID drawing for subscription or distribution.
publishing method
To publish a P&ID drawing using either the database link or the file sharing means of
transferring data.
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.
Relational Database Management System (RDBMS)
A database management system that uses Structured Query Language (SQL) to implement and
query data in relational tables.
relationship
A condition that exists between items indicating some form of communication of behavior or
state.
revision cloud
A set or arcs used to enclose changes that have occurred since the last revision.
revision triangle
A numbered triangle placed in the P&ID to indicate the drawing revision when the change
occurred.
rule
Standard mechanism for creating relationships. A rule defines a valid context for two items to
communicate their behavior or state.
satellite
A server located remotely from the host server. In SmartPlant P&ID Workshare, a remote server
connected to a satellite slot at the host server.
satellite slot
The host's side of a Workshare connection. Satellites connect to the satellite slots made
available by the host at the host site.
schema
Description of the overall structure of the rulebase or database.
schema file
File that outlines the overall logical structure of a rulebase or database.
schematic file
Schematic drawing or diagram of a particular item in the plant.
search criteria
Set of values used to scan a database or object library.
segment
Contiguous piping and piping components between two points in the network at which properties
change value. Segments terminate by property break labels, branches, nozzles, off-pace and
utility connectors, and by the terminal ends of piping lines.
select list
List of related values that Data Dictionary Manager uses to specify various aspects of the data
model. For example, select lists allow you to select from a list of values for specific properties
when creating drawings, filters, and symbols. A select list for the fluid code property, for
example, allows you to select from a set of standard entries: such as P for process or MMA for
methyl alcohol.
server
In network operations, the node that maintains common data or performs a common task that
clients need. All network operations between two or more nodes establish a client/server
relationship.
signal lines
1. Intelligent line strings that connect offline instruments, inline instruments, and piping.
2. An ordered collection of connectors, and inline components with an equal set of core
properties: typically, items that share the same line number. Specifically, a representation of
the wiring used for transferring electrical or software signals.
3. A collection of signal runs from all drawings in a project whose project-defined line property
values are identical.
signal run
A line run with signal properties. See also pipe run.
site
A group of plants. A site can contain one or more plants.
site server
A text file containing the database type, connection alias, data dictionary, and schema
information for the site. Appears as the root directory for each site in SmartPlant Engineering
Manager.
SP_IDs
Unique identification numbers assigned by the SmartPlant software to all items created in the
database.
Standard Query Language (SQL)
Language developed by IBM for creating, modifying, and querying relational databases.
static Oracle port
A network configuration that forces an Oracle database link to always connect via a fixed path to
a fixed port number.
stockpile
View of the data model, displaying items that have not yet been placed in the graphic model.
style
1. The appearance of geometry and annotations on the drawing sheet. For example, color and
line weight of an element, the font used in a text box, and so forth.
2. A collection of formats or properties that you name and store as a group. When you apply a
style to a selected item, the software applies all the formats or properties in the style to the
element. The style types include: fill, dimension, line, and text.
subnet
A division of a network into an interconnected, but independent, segment, or domain, in order to
improve performance and security.
subnet mask
The technique used by the IP protocol to filter messages into a particular network segment. The
subnet mask is a binary pattern that is stored in the client machine, server, or router and is
matched up with the incoming IP address to determine whether to accept or reject the packet.
subscribe
To sign up for a service. In SmartPlant P&ID Workshare, to connect a satellite site with a
satellite slot at the host.
subscribe access
Read-only access to published P&ID drawings.
symbology
1. Display style of an item, including color, pattern, style, and width.
2. In Options Manager, symbology provides graphical clarity to a drawing by differentiating
among various items by their appearance. Symbology refers to the color, line weight, and
style associated with items in a particular filter.
table
Collection of data for quick reference, either stored in sequential locations in memory or printed
as an array of rows and columns of data items of the same type.
template
A document or file having a preset format, used as a starting point or blueprint for a particular
application so that the format does not have to be re-created 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
A process that prompts the software to generate a record when you change a property.
transaction
A non-graphic record of any additions, deletions, and changes that you request during job
posting activities.
UNC path
Universal Naming Convention. The full name of a resource on a network. It conforms to the
\\servername\sharename syntax, where servername is the name of the server and sharename is
the name of the shared resource. UNC names of directories or files can also include the
directory path under the share name, with the following syntax:
\\servername\sharename\directory\filename.
unit
Group of parts of the schematic and individual worlds of a plant that together perform a given
process function. The identifying number of the unit is unique within the project and within the
plant. Most companies, but not all, use the concept of unit.
user name
Name that provides access to an account on the system. Same as username.
validation
A process or program that verifies data integrity in the database.
Data File Command (File > Import Menu) • Delete to Stockpile > Drawing Command
221 (Edit Menu) • 164
data model • 379 Delete to Stockpile > Plant Command (Edit
database • 379 Menu) • 164
database administrator • 379 Delete to Stockpile Commands (Edit Menu)
database link • 379 • 164
database table • 379 Delete View Command • 58
Default Table Layouts • 54 Delete View Dialog Box • 58
Defer Tasks from the To Do List • 361 Description Dialog Box • 168
Define a Display Set • 183 design file • 379
Define a New Engineering Data Editor View Designing Symbol Toolbars • 63
• 55 design-wide break • 380
Define a New Filter for an Engineering Data Details Command • 66
Editor View • 55 Details Dialog Box • 198
Define a New Layout for the Engineering Details Tab • 369
Data Editor • 56 Display > Engineering Data Editor
Define a User-Level Symbol Toolbar • 63 Command (View Menu) • 47
Define Command • 240 Display Claim Status in the Drawing
Define Filtering by Task Assignment for the Symbology • 199
To Do List • 359 Display Command (View Menu) • 28
Define Heat Trace Media as Pipe Jacketing Display Deleted To Do List Tasks • 361
• 133 Display Help for Programming with
Define Heat Tracing Graphics for an Item • SmartPlant P&ID Engineering • 16
127 Display Ignored To Do List Tasks • 363
Define Jacketing Graphics for an Item • 134 Display Null Values in the Properties
Define Locate Filter Dialog Box • 124 Window • 73
Define Mapping Relationships as 'For Display Properties with Units Using an
Documentation Only' • 282 Alternative Format • 246
Define Report Contents Dialog Box • 241 Display Settings Dialog Box • 39
Define Report Items Dialog Box • 242 Display Shortcut Buttons in Catalog
Define the Contents of Your Report Explorer • 68
Template • 243 Display Tab • 30
Define the Layout of a Composite Format Display the Claim Status of a Drawing Item
Report Template • 234 • 199
Define the Layout of a Fixed Format Report Display the Engineering Data Editor • 49
Template • 233 Display the Properties of a Report Template
Define the Layout of a Tabular Format • 239
Report Template • 231 display-only annotation • 380
Defining Test System Relationships • 155 Drawing • 275
Delete a Catalog Item • 64 drawing file • 380
Delete a Catalog Node • 64 drawing, P&ID • 380
Delete a Report Template • 239 driving label • 380
Delete a Saved Engineering Data Editor
View • 58 E
Delete Command • 239
Delete Command (Catalog Explorer > easting • 380
Catalog Menu) • 64 edge-edge model • 380
Delete from Model Command (Edit Menu) • Edit a Report Template • 238
164 Edit Active Drawing Item Properties in the
Delete Orphan Model Items • 82 Engineering Data Editor • 42
Delete Orphan Model Items Dialog Box • 81 Edit Command • 237
Delete Report Template Dialog Box • 239 Edit Menu (Engineering Data Editor) • 50
Delete Stockpile Item Command • 49 Edit Report Template Dialog Box • 237
Edit the Engineering Data Editor View • 41 Fit All Items in the Active Drawing View • 27
Edit View Command • 51 Fit Command (View Menu) • 27
Edit View Dialog Box • 51 Fixed Format Report • 233
Editing Item Properties in the Engineering fixed point • 381
Data Editor • 40 flow rate • 381
EFCustomProcess Reference • 326 flow time • 381
Enable System Editing • 180 Freeze Panes Command • 39
Enforcing Claims • 195 full path name • 381
Engineering Data Editor Shortcut Menu • 59
enumerated list • 380 G
Equipment • 275
equipment components • 380 gap • 381
equipment group • 380 Gap Now Command (Tools Menu) • 177
Equivalent Diameter and Cross Section Gapping Lines • 177
Area Properties • 167 General Tab • 22, 30, 91, 368
Example of Completed with Warning Status Generate a Report for an Active Drawing •
• 358 224
exclusive database relationship • 380 Generate a Report for the Plant • 225
Exit Command (File Menu) • 94 Generate Reports for Selected Drawings •
exit elevation • 380 226
Explore Elsewhere Dialog Box • 62 Generating Reports • 223
Grid Tab • 31
F
H
File Properties Dialog Box • 91
Files Tab • 24 hierarchical • 381
filter • 380 Hierarchical Enumerated Lists • 274
Filter / Sort Dialog Box • 367 hierarchy • 381
Filter Dialog Box • 88 History Tab • 369
Filter Tab • 52, 243, 367 Hold Status Text Dialog Box • 168
Filter To Do List Tasks • 360 horizontal angle • 381
Find a Drawing Item by Using a Catalog horizontal distance • 381
Item • 159 host • 381
Find an Item by Using a Filter • 159
Find an Item by Using an Existing Drawing I
Item • 160 IEFCustomPublish Interface • 326
Find and Replace Dialog Box • 161 IEFCustomPublishEventHandler Interface •
Find Command • 61, 158 329
Find Documents to Publish Command Ignore Task Properties • 363
(SmartPlant Menu) • 345 Ignore To Do List Tasks • 361
Find Documents to Publish Dialog Box • Implementation (IEFCustomPublish) • 330
345 implied piping component • 381
Find Documents to Publish dialog box - Import > SmartSketch Command (File
Document Types • 346 Menu) • 221
Find Documents to Publish from SmartPlant Import Aspen Basic Engineering Stream
P&ID • 344 Data • 222
Find Drawing Inconsistencies • 158 Import Log Dialog Box • 221
Find Redundant Breaks • 219 Importing Aspen Basic Engineering Stream
Find Redundant Breaks Command (View Data • 221
Menu) • 219 Importing Drawing Data • 221
Find Tab (Find and Replace Dialog Box) • Improve the Performance of Custom
161 Reports • 229
Finding Drawing Items • 158
System Editing and Consistency Checking • Undo Your Last Action • 157
179 unit • 390
System Editing and Projects • 180 Units Tab • 92
System Editing Command (Tools Menu) • Update Associated Instruments with Loop
180 Properties Dialog Box • 143
Update Symbology Command (Tools Menu)
T • 186
Update Tab • 370
table • 389 Update the Engineering Data Editor • 59
Tabular Format Report • 231 Update the To Do List Display • 363
Task Properties Dialog Box • 368 Upgrade Schema Command (SmartPlant
template • 389 Menu) • 262
The SmartPlant Adapter and Tool Schema • Use AutoFilter in the Engineering Data
262 Editor • 38
The Tool Schema Data Model • 265 user name • 390
Tile Horizontally Command (Window Menu) Using Catalog Explorer • 59
• 35 Using Filters • 118
Tile Vertically Command (Window Menu) • Using Filters to Create and Apply Display
35 Sets • 180
time stamping • 389 Using Implied Items • 144
To / From Dialog Box (Properties Window) • Using Off-Page and Utility Connectors • 148
150 Using Piping Components • 137
To Do List and Correlating Items • 196 Using Reports to Import Items into the
To Do List Command • 364 Stockpile • 172
To Do List Dialog Box • 364 Using Shortcut Keys • 18
To Do List Task Commands and Controls • Using the Piping Specification Utility • 137
364 Using the To Do List • 355
Tool Requirements for Integrating
SmartPlant P&ID • 258
Tool Schema Location • 265 V
Toolbars Command (View Menu) • 28 Validating Properties • 196
Toolbars Dialog Box • 28 validation • 390
Toolbars Tab • 78 View > Display Settings Command (EDE) •
transaction • 390 39
Troubleshooting • 375 View Document Properties • 93
Turn the Display of Catalog Explorer On or View Menu • 25, 65
Off • 60 View Menu (Engineering Data Editor) • 51
Turn the Display of the Properties Window View Properties Dialog Box • 30
On or Off • 71
Typicals • 174 W
Typicals Common Tasks • 174
Window Menu • 33
Working with Assemblies • 187
U Working with Drawings • 85
UNC path • 390 Working with Drawings in Projects • 191
Uncorrelate Command (SmartPlant Menu) • Working with Instruments and Loops • 141
355 Working with Off-Site Projects • 192
Uncorrelate Dialog Box • 355 Working with P&IDs in SmartPlant P&ID
Uncorrelate Items • 354 Engineering • 119
Uncorrelate Items from the To Do List • 362 Working with SmartPlant Integration • 257
Understanding Database Constraints • 119 Working with the Design Window • 20
Understanding System Editing and OPCs • Working with the Properties Window • 69
149
Undo Command (Edit Menu) • 157
Z
Zoom Area Command • 25
Zoom In • 26
Zoom In Command • 26
Zoom In on an Area • 25
Zoom Out • 26
Zoom Out Command • 26