Restricted Rights Legend
Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c) of the Contractor Rights in Technical Data clause at DFARS 252.227-7013, subparagraph (b) of the Rights in Computer Software or Computer Software Documentation clause at DFARS 252.227-7014, subparagraphs (b)(1) and (2) of the License clause at DFARS 252.227-7015, or subparagraphs (c) (1) and (2) of Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished---rights reserved under the copyright laws of the United States. Intergraph Corporation Huntsville, Alabama 35894-0001

Warranties and Liabilities
All warranties given by Intergraph Corporation about equipment or software are set forth in your purchase contract, and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such warranties. 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 discussed in this document is furnished under a license and may be used or copied only in accordance with the terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Trademarks
Intergraph, the Intergraph logo, SmartSketch, FrameWorks, SmartPlant, INtools, MARIAN, PDS, and IntelliShip are registered trademarks of Intergraph Corporation. Microsoft and Windows are registered trademarks of Microsoft Corporation. Other brands and product names are trademarks of their respective owners.

Recent Drawings.......................................................................................................110
Access a Recently Open Drawing................................................................................... 110 Switch to Another Open Drawing or View..................................................................... 110

Close Command........................................................................................................116
Close an Active Drawing ................................................................................................ 116

Routing Lines: An Overview....................................................................................144
Line Routing Ribbon....................................................................................................... 146 Route a Line.................................................................................................................... 147 Start a Line in Free Space ............................................................................................... 147 Start a Line from a Connect Point................................................................................... 148 Insert Line Segments into an Existing Line .................................................................... 149 Insert a Vertex into an Existing Line .............................................................................. 149 Branch from an Existing Line......................................................................................... 150 Branch to an Existing Line ............................................................................................. 150 Add a Manual Gap to a Line........................................................................................... 151 Assign Heat Tracing ....................................................................................................... 151

Break Run Command ...............................................................................................153
Break a Pipe Run ............................................................................................................ 153

Using Piping Components: An Overview ................................................................155
Place a Piping Component .............................................................................................. 155 Using the PipeSpec Utility: An Overview ...................................................................... 157

Using Annotations: An Overview ............................................................................198
Place an Annotation ........................................................................................................ 199 Place an Area Break........................................................................................................ 200 Place a Package............................................................................................................... 200 Place a Safety Class ........................................................................................................ 201 Place a Test System ........................................................................................................ 202 Place a Hydro Test Package............................................................................................ 203 Place a Contract Package ................................................................................................ 204 Place a Revision Cloud ................................................................................................... 205

Moving and Placing Stockpile Items: An Overview ................................................249
Move to Different Stockpile Dialog Box........................................................................ 249 Place an Item from the Stockpile .................................................................................... 250 Move a Stockpile Item to the Stockpile of Another Drawing......................................... 250 Using Reports to Import Items into the Stockpile........................................................... 251 Populate the Stockpile from a Spreadsheet..................................................................... 252 Modify a Pump by Importing a SmartPlant P&ID Report into the Stockpile................. 254

Working With Assemblies: An Overview................................................................280
Save As Assembly Command......................................................................................... 281

Working with The Engineering Framework: An Overview ......................................370 Integrating SmartPlant P&ID with The Engineering Framework ............................371
Working with SmartPlant Instrumentation ..................................................................... 371 Working with SmartPlant 3D.......................................................................................... 372 Working with Zyqad ....................................................................................................... 372 General TEF Requirements for SmartPlant P&ID.......................................................... 373 Using Workshare with The Engineering Framework ..................................................... 374

SmartPlant P&ID User’s Guide 7

Table of Contents
Using the Catalog Index in SmartPlant P&ID and TEF Integration............................... 374

Using the To Do List: An Overview.........................................................................425
To Do List Command ..................................................................................................... 426

8 SmartPlant P&ID User’s Guide

Table of Contents
To Do List Dialog Box ................................................................................................... 427 Open the To Do List ....................................................................................................... 429

Customer Support and Documentation Comments
For the latest support information for this product, use a World Wide Web browser to connect to http://www.intergraph.com/ppm/services/support.asp. Send documentation comments or suggestions to PPMdoc@intergraph.com.

10 SmartPlant P&ID User’s Guide

Introducing SmartPlant P&ID

Introducing SmartPlant P&ID
SmartPlant P&ID creates intelligent P&IDs by populating the database with relevant plant data. This method provides valuable information throughout the plant life cycle. As a data-centric, rule-based solution for the P&ID life cycle, SmartPlant P&ID helps users improve design quality, data consistency, and standards compliance. With quick access to supporting engineering data, SmartPlant P&ID significantly cuts design and modification time and increases accuracy with its exclusive data-centric approach and use of design rules, automatic checks, and drag-and-drop capabilities. SmartPlant P&ID is vastly different from graphic-driven P&ID solutions of today. All data from the P&ID is stored in the plant database and adheres to plant standards. The graphical representation of the P&ID is a view or a report of the data. The strong data import and export facilities of SmartPlant P&ID allow users to populate the system with relevant plant data, such as process data from process simulation databases based on Aspen Zyqad from Aspen Technologies, Inc. or equipment and line lists. You can then use this information in the SmartPlant P&ID Stockpile to design the P&ID. The rule-based and automation capabilities of SmartPlant P&ID also differentiate it from other P&ID systems. SmartPlant P&ID features a comprehensive, userdefinable rule-based system that assists the engineer during the design phase of the plant and subsequent life cycle phases. Data is entered directly into the database; rules are executed; and feedback is immediate. The design rule-base confirms data consistency and compliance with plant and engineering standards, allowing faster, more efficient design with less iteration. SmartPlant P&ID incorporates the latest Microsoft technologies, such as OLE automation, to provide integration with existing data and other systems. Running on Microsoft Windows XP and Windows 2000, SmartPlant P&ID does not require a traditional, expensive CAD engine for P&ID creation. The open architecture of SmartPlant P&ID permits integration with other systems, such as Intergraph PDS, SmartPlant Instrumentation, and Aspen Zyqad, all of which allow users to share data with third-party software.

SmartPlant P&ID User’s Guide 11

Introducing SmartPlant P&ID

SmartPlant P&ID Program Group
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 in the plant model and can be a schematic drawing or a table. The plant model is the computer representation of the conceptual design, 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. SmartPlant P&ID has several programs and utilities for running and managing your plant data. SmartPlant P&ID provides the design environment for SmartPlant. SmartPlant P&ID Drawing Manager allows you to create and delete drawings, manage drawing versions, and print multiple drawings. SmartPlant P&amp;ID Drawing Manager allows you to perform Workshare and projectspecific commands. SmartPlant P&ID Insulation Specification Manager allows you to create and modify lookup tables for insulation specifications and thicknesses. SmartPlant P&ID Options Manager defines plant-wide graphic standards for symbology, gapping, heat tracing, and formats. SmartPlant P&amp;ID Options Manager also defines paths to SmartPlant files and directories. SmartPlant P&ID Rule Manager defines rules for placement and property copying on placement. SmartPlant Engineering Manager performs higher-level data management tasks, such as specifying user permissions, designing plant hierarchies, and so forth. For more information about SmartPlant Engineering Manager, see the SmartPlant Engineering Manager User's Guide and the SmartPlant P&ID Installation and Upgrade Guide.

12 SmartPlant P&ID User’s Guide

Introducing SmartPlant P&ID

What's New in SmartPlant P&ID?
This version of SmartPlant P&ID contains the following new functionality and changes.
•

Auxiliary Graphics allows you to add simple graphics to your SmartPlant P&ID drawings. When you have completed adding graphics using Auxiliary Graphics, these graphics display in your SmartPlant P&ID drawing inside a SmartFrame. The SmartFrame and its contents are stored in the database. For more information, see Auxiliary Graphics: An Overview. You can also find the Auxiliary Graphics topics in the SmartPlant P&ID User's Guide PDF file. The Release Claims dialog box displays when you attempt to unclaim an item that has been modified in the project. Claims must be released before projects can be completed or for other projects to be able to check in drawings with changes. For more information, see the Release Claim Command. To prevent a specified value from overwriting another specified value during publish, nothing will be published for properties with blank values. If there was previously a value for the property and it is missing, a Null value will be inserted. If the property value is defined as Null, the Null value is published. In addition, no value will be retrieved for properties with blank values. If there was previously a value for the property and it is missing, the missing value is ignored. The existing item value is not overwritten. If the property value is defined as Null, the Null value is always retrieved. For more information, see Publishing to TEF: An Overview and Retrieving from TEF: An Overview. Placing piping and/or signal points on equipment and equipment components is not supported by SmartPlant P&ID. Some features of SmartPlant P&ID may not work properly (for example, the item will not publish to The Engineering Framework). Intergraph recommends removing these points from these equipment items.

SmartPlant P&ID Help Command
Help > SmartPlant P&ID Help Opens the Help viewer where you can read topics about commands, procedures, dialog boxes, and so forth.

Printable Guides Command
Help > Printable Guides Opens a page in your default browser that includes links to the user's guides in portable document format. Click a link, and the guide opens in the appropriate application. You can print it if necessary. The user's guides contain the same information as the online Help.

SmartPlant P&ID on the Web Command
Help > SmartPlant P&ID on the Web Activates your web browser and opens the SmartPlant P&ID World Wide Web page. On this page, you can access registration and support information, learning tools, and other items to help you use SmartPlant P&ID more efficiently.

14 SmartPlant P&ID User’s Guide

Introducing SmartPlant P&ID

SmartPlant P&ID Web Forum Command
Help > SmartPlant P&ID Web Forum Opens your web browser to the Intergraph Process & Power Client Community web page. On this page you can learn about international and regional conferences, online forums, informal networking, structured product feedback, and more. Follow the instructions and links on this web page to find your information.

About SmartPlant P&ID Command
Help > About SmartPlant P&ID Displays information about your copy of the software, including the version number and the copyright, legal, and licensing notices.

Programming with SmartPlant P&ID is the method by which you can use the Automation layer to customize the software to meet your own particular requirements. This documentation consists of a programmer's guide and reference guides for placement automation and the logical model.

SmartPlant P&ID User’s Guide 15

Navigating in the Software: An Overview

Navigating in the Software: An Overview
The drawing interface is divided into four distinct parts: the Design window, the Catalog Explorer, the Engineering Data Editor, and the Properties window. Each part provides specific features that you need to create drawings in the software. 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. Engineering Data Editor The Engineering Data Editor is a modification of the stockpile display. This view is exactly the same tabular view that you can display in the Design window, with the same capabilities for modifying the display, editing properties, and organizing data. Catalog Explorer The Catalog Explorer displays all available catalog items for you to use in drawings and plant models. The Catalog Explorer contains a hierarchical representation of the selected catalog. You can navigate through the nodes in a catalog by clicking the + or – icons by the selected node. In addition, you can double-click nodes in the tree view to open them. Properties Window When you select an item in a plant model, you can enter, view and modify the properties associated with that item in the Properties window. Your system administrator defines customized properties and their defaults for each item in Data Dictionary Manager. Related Topics Add an Item to the Stockpile from Catalog Explorer, page 67 • Place an Item from Catalog Explorer, page 66 • Place an Item from the Stockpile, page 250
•

Navigating in the Software: An Overview File menu (tree view) in Catalog Explorer To Start the Find command Start the Deletecommand Start the Rename command Start the Close command View menu in Catalog Explorer To Turn Small Icons command on or off Turn List command on or off Turn Detailscommand on or off Shortcuts with the View menu To Open the Toolbars dialog box and lets you display or hide selected toolbars Opens the Properties command Start Show grid command to turn on or off the display of drawing grid Start the Grip snap command to turn on or off the snap-to-grid behavior for component placement Turn on or off the display of the Catalog Explorer window Turn on or off the display of the Properties window Turn on or off the Show Inconsistencies command and the display of inconsistency indicators in the active view Turn on or off the display of the Stockpile window Press Alt + V + T Alt + V + P Alt + V + D Alt + V + S Alt + V + C Alt + V + G Alt + V + W Alt + V + S Press M L D Turn Large Icons command on or off G Press F N M C Start the Explore Elsewhere command E

Miscellaneous shortcuts To Cancel a command Press Esc

18 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview Cancel items in a fence Clear a select set Close a dialog box Copy item with the Move, Rotate, or Mirror command Insert segment when you modify a pipe run Insert a vertex when you modify a pipe run Open context-sensitive Help for the active command Override grip snap while identifying items aligned along grid lines Select items with Select Tool in a fence Move a symbol but maintain the existing connections. This action results in a simple geometric move for the symbol Suspend a relationship temporarily and place a line near another item, avoiding automatically snapping to a particular point Stop repainting an item while using a View command Turn off relationship Update the window Note
•

Shift or Ctrl Esc Esc Ctrl before you place the item Shift and point to a segment Alt and point to segment F1 Alt Shift or Ctrl Alt and drag the symbol Alt Esc Alt F5

To get shortcut mnemonics on a Windows® 2000 system, you must choose a specific setting. Right-click the desktop, choose Properties, select the Effects tab, and clear the selection of Hide keyboard navigation indicators until I use the Alt key.

SmartPlant P&ID User’s Guide 19

Navigating in the Software: An Overview

Working With the Design Window
The Design window, or Modeler, consists of several parts and displays the model information for a design in a Drawing or Engineering Data Editor view. You can open as many windows as needed to support a design. Each window has its own independent set of properties defining view range, display properties, and so forth. You can define one or more Engineering Data Editors for a drawing. The Engineering Data Editor displays drawing information in a table, much like a Properties window. In the Engineering Data Editor, you can specify filters and layouts to define the table information and even edit some item properties. By using commands on the Window menu, you can cascade or tile views to more easily navigate among them.

•

(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.

SmartPlant P&ID provides multiple views of a central, unified data structure that represents the plant model. A view is a visual presentation of the data that composes the plant model and can be a schematic drawing or a table. The plant model is the computer representation of the conceptual design in its entirety, including all plant components and their relationships. By manipulating model views, you can organize the information within the plant model to better understand and maintain the data. Caution
•

The software continually updates the database as you edit a drawing; however, the software does not update the drawing file until you actually save the file (when you click File > Save or when you quit the program). Occasionally, the software can end in an abnormal way, for example, due to power outage. As a result, the database is up-to-date with changes that you posted to the drawing, but the drawing file reflects the status when you last saved the drawing. When you re-open the drawing, the software recognizes that the drawing file is different from the database and displays a message: One or more items in this drawing are inconsistent with the database. Click OK to re-create the drawing from the database.

For more information about the data model, see Using the Properties Glossary: An Overviewin the SmartPlant P&ID Help Related Topics Define a New Engineering Data Editor View, page 54 • Define a New Filter for an Engineering Data Editor View, page 54 • Define a New Layout for the Engineering Data Editor, page 55 • Open a New Drawing View, page 39 • Open an Existing Drawing, page 107
•

Show Command
Available on the Drawing View Shortcut menu, the Show command allows you to choose to display drawing elements, such as notes, labels, grids, and so forth. Related Topics • Change the Properties of a Drawing View, page 37

Options Dialog Box
Sets options for the current drawing. For example, you can set the number of recently used files that appear on the File menu. Open this dialog box by clicking Tools > Options on the main menu bar. Related Topics • Customize the Software With the Options Command, page 26

General Tab (Options Dialog Box)
Sets options for updating links in the drawing and displaying the drawing, the status bar, and recently used files. The Options dialog box opens when you click Tools > Options. 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, prompts that explain what to do at each step of the command appear in the status bar, and messages about the operations the software is performing appear in the status bar. Related Topics • Break a Link, page 276 • Change a Link, page 275 • Customize the Software With the Options Command, page 26 • Embed a New Object, page 270 • Link or Embed a Previously Existing Object, page 271

22 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Colors Tab (Options Dialog Box)
Allows you to select options for the background, highlight, selection, and handle colors in the drawing. The Options dialog box opens when you click Tools > Options. 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. Note
•

To set the symbology, (for example, the line weight and color) for item types throughout a plant structure, use Options Manager.

Placement Tab (Options Dialog Box)
Sets the default construction status for the active drawing, and tolerances for locating items and moving around in the drawing. The Options dialog box opens when you click Tools > Options. Default construction status - Assigns the selected construction status to all placed items. This list contains the following options: New, Existing, and Future. The plant administrator sets the plant-wide default at setup, but this option allows you to change the default on a drawing-by-drawing basis. The construction status for an item appears in the Properties window when the item is selected. Also, the construction status can be set for individual drawing items by changing its value in the Properties window. Locate - Specifies the range, called the locate zone, at which a candidate item is highlighted when another item approaches. A candidate item is any item in the drawing that meets the placement rules of the approaching item. For example, a pipe run can be a candidate item, and a valve can be an approaching item to that pipe run. The pipe is highlighted when the valve is within the locate tolerance. If you are not placing an item but only selecting drawing items, the locate tolerance defines how close that the pointer must approach in order to select the item.

SmartPlant P&ID User’s Guide 23

Navigating in the Software: An Overview Break-away - Sets the number of pixels at which an item disconnects from its parent item. For example, to move a valve, you drag the valve. If you keep the pointer within the break-away tolerance from the line, the valve does not disconnect from the line. Place partner OPC in Stockpile - Indicates that when a new off-page connector, OPC, is placed, the partner OPC is automatically stored in the Stockpile. If you clear this option, the Set Stockpile Location of Partner OPC dialog box appears after you place a new OPC. Using this dialog box, you can indicate the drawing in which the partner OPC is stored until you place it in that drawing. Related Topics • Change Default Storage Location for Partner Connector, page 192 • Customize the Software With the Options Command, page 26 • Options Command, page 22

Set Stockpile Location of Partner OPC Dialog Box
Opens after you place a connector on a drawing, unless you have selected the Place partner OPC in Stockpile option on the Placement tab of the Options dialog box. The Set Stockpile Location of Partner OPC dialog box allows you to select the drawing stockpile and also the stockpile into which the partner of the new connector is placed. Plant Hierarchy - Displays the hierarchical tree representation of the plant. When you select a node, the drawings associated with that node appear in the Drawing list area. Drawing list - Displays all the drawings associated with the selected node on the Plant Hierarchy tree. Choose a stockpile from this view to associate your partner connector with. Related Topics • Change Default Storage Location for Partner Connector, page 192 • Move a Connector to Another Stockpile, page 192 • Move a Partner Connector to Another Stockpile, page 194 • Place an OPC or Utility Connector, page 190 • Store a Partner Connector, page 192

24 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Files Tab (Options Dialog Box)
Sets options for inserting objects in the drawing. This tab is part of the Options dialog box, which opens when you click Tools > Options on the main menu bar. These settings take effect in your next drawing session. Scale reference files - Sets a scale option for importing a drawing. Coincident (1:1) - Imports a reference file, also known as an inserted object, at full scale (1:1). This setting causes the reference file to appear temporarily in the lower left of the drawing and determines a drawing scale that fits the reference file within the drawing. The reference file is at the end of the pointer, ready to be placed in the drawing, much like a catalog item during placement mode. Select Scale - Sets the drawing scale to a standard ratio. The specified ratio defines the size of the drawing in relation to the size of the real-world object. For a 2:1 ratio, the 2 represents the size of the drawing and the 1 represents the size of the real-world object. Note
•

The Fit to Sheet option in the Select Scale list determines a drawing sheet scale that fits the reference file within the sheet but allows you to specify where the file is inserted by clicking on the drawing sheet.

Custom Scale - Sets the scale for a drawing that you insert. For example, when you type 3 and 2 in each of the respective boxes, the scale of the foreign drawing is one and one half times its original size. 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). Related Topics • Break a Link, page 276 • Change a Link, page 275 • Customize the Software With the Options Command, page 26 • Edit an Embedded Object, page 275 • Embed a New Object, page 270 • Link or Embed a Previously Existing Object, page 271

SmartPlant P&ID User’s Guide 25

Navigating in the Software: An Overview

Browse Dialog Box
Allows you to select a directory that contains your reports. Open this dialog box by clicking Tools > Options > Files Tab > Browse. Look in - Displays the currently selected folder and the available folders in the active drive. Drives - Lists the drives that are currently active on your computer. Select a different drive in order to see directories that reside on that drive in the Look in box. Related Topics Customize the Software With the Options Command, page 26 • Options Command, page 22
•

Customize the Software With the Options Command
1. Click Tools > Options. 2. On the Options dialog box, click the tab containing the information that you want to customize.
• • • •

Previous Command
View > Previous Restores the previous view. For example, if you zoom in and then click View > Previous, the view changes to the view displayed before you zoomed. This command is available only when a Drawing view is active, and the software does not remember more than one view. Related Topics • Restore a Drawing View, page 27 • Working With the Design Window, page 20

26 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Restore a Drawing View
Click View > Previous. Notes
•

To stop repainting items in the window, press Esc. This action is convenient for large drawings. To refresh the window, press F5.

•

Related Topics • Working With the Design Window, page 20

Zoom Area Command
View > Zoom Area Enlarges the display of an area in the active window by allowing you to draw a fence around that arbitrary area of the drawing. This command is available only when a Drawing view is active. Related Topics • Working With the Design Window, page 20

Zoom In on an Area
1. On the main toolbar, click Zoom Area . 2. On the Drawing view, use the pointer to fence the area on which you want to zoom. The selection fills the view. Notes
• •

To go back to the previous view, click View > Previous. To stop repainting items in the window, press Esc. This action is convenient for large drawings. To refresh the window, press F5. To cancel the command, right-click or press Esc.

• •

Related Topics • Working With the Design Window, page 20

SmartPlant P&ID User’s Guide 27

Navigating in the Software: An Overview

Zoom In Command
View > Zoom In Enlarges the display of items around a specified point in the active window. This command is available only when a Drawing view is active. Related Topics Working With the Design Window, page 20

•

Zoom In on the Drawing
1. On the Main toolbar, click Zoom In . 2. Click the view at the center of the area on which you want to zoom. 3. To cancel the command, press Esc or right-click in the drawing. Notes
• •

To go back to the previous view, click View > Previous. To stop repainting items in the window, press Esc. This action is convenient for large drawings. To refresh the window, press F5.

•

Related Topics • Working With the Design Window, page 20

Zoom Out Command
View > Zoom Out Reduces the display of items around a specified point in the active window. This command is available only when a Drawing view is active. Related Topics Working With the Design Window, page 20 • Zoom Out from an Area, page 29
•

28 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Zoom Out from an Area
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. Notes
• •

To go back to the previous view, click View > Previous. To stop repainting items in the window, press Esc. This action is convenient for large drawings. To refresh the window, press F5. To quit the command, right-click or press Esc.

• •

Related Topics • Working With the Design Window, page 20

Fit Command
View > Fit Fits all items in the active view if no items are currently selected. However, if any items are selected in the drawing, the command fits only the selected items in the active view. If only one item is selected in the drawing, the command zooms to the selected item. This command is available only when a Drawing view is active. Related Topics • Fit All Items in the Active Drawing View, page 29 • Working With the Design Window, page 20

Fit All Items in the Active Drawing View
•

On the main toolbar, click Fit

.

Related Topics • Working With the Design Window, page 20

SmartPlant P&ID User’s Guide 29

Navigating in the Software: An Overview

Pan Command
View > Pan Allows you to move the display in any direction from a specific point in a drawing to see other areas of the drawing by dragging the pointer across the view. This command is available only when a Drawing view is active. Related Topics Pan a Drawing View, page 30 • Working With the Design Window, page 20
•

Pan a Drawing View
1. On the main toolbar, click Pan 2. Click in the view you want to pan. 3. Click in the view again to define how far you want to pan. Notes
• • •

.

You can also click and drag the hand pointer

to pan the view.

To go back to the previous view, click View > Previous. To stop repainting items in the window, press Esc. This action is convenient for large drawings. To refresh the window, press F5. To cancel the command, press Esc or right-click in the Drawing view.

• •

Display Command
View > Display Allows you to specify the windows you want to see in your design session:
• • •

Toolbars Command
View > Toolbars Opens the Toolbars dialog box, which allows you to create new toolbars and display or hide selected toolbars. You can change toolbar color schemes and button sizes, too. Related Topics Add a Button to a Toolbar, page 32 • Customizing the Software: An Overview, page 90 • Remove a Button From a Toolbar, page 33 • Working With the Design Window, page 20
•

Toolbars Dialog Box
Sets options for displaying, hiding, or changing toolbars. Open this dialog box by clicking View > Toolbars on the main menu bar. Toolbars - Lists the available toolbars. You can select the box next to the toolbar that you want to display, hide, or change. Toolbar Name - Displays the name of the toolbar that you have selected. New - Accesses the New Toolbar dialog box. Customize - Adds buttons to or removes buttons from built-in toolbars with the Customize dialog box. Reset - Returns the toolbar to the state that it was in at the beginning of your current design session. Color Buttons - Adds color to the toolbar buttons. Clearing this option causes toolbar buttons to appear in black and white. Large Buttons - Enlarges toolbar buttons so that they are easier to see. Show ToolTips - Displays on-screen descriptions of a toolbar button when the pointer pauses over one of them. Related Topics Add a Button to a Toolbar, page 32 • Remove a Button From a Toolbar, page 33 • Remove a Command From a Menu, page 95
•

SmartPlant P&ID User’s Guide 31

Navigating in the Software: An Overview

New Toolbar Dialog Box
Creates a new toolbar. Open this dialog box from the main menu bar by clicking View > Toolbars > New. Toolbar Name - Type the name of the new toolbar in the box. You cannot choose a name for your new toolbar that is already used for another toolbar. Related Topics • Add a Button to a Toolbar, page 32 • Remove a Button From a Toolbar, page 33 • Remove a Command From a Menu, page 95

Create a New Toolbar
1. Click View > Toolbars. 2. On the Toolbars dialog box, click New. 3. On the New Toolbar dialog box, type the name of the new toolbar. 4. Click OK. 5. Click Tools > Customize. 6. On the Toolbars tab of the Customize dialog box, click the category that contains the command that you want to add. 7. Drag the command button from the Buttons display area to the new toolbar. Related Topics • Customizing the Software: An Overview, page 90

Add a Button to a Toolbar
1. Click Tools > Customize on the main menu bar. 2. On the Toolbars tab, click the category that contains the command that you want to add. 3. Drag the command button from the Buttons area to the toolbar.
•

Related Topics Customizing the Software: An Overview, page 90

32 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Remove a Button From a Toolbar
1. On the main menu bar, click Tools > Customize. 2. On the Toolbars tab, drag the button that you want to remove from the toolbar into the Buttons area. Related Topics • Customizing the Software: An Overview, page 90

Display Tab (View Properties Dialog Box)
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 - Prevents the display of labels in filtered views of the design. Show - Lists options for objects you want to appear in your Drawing view. Labels - Toggles the display of all labels on or off, in any view. If the display of labels is turned off here, then the Do not show labels options is not available since all labels are no longer displayed regardless of the view tab that you are using. 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. For example, if you insert a file using Edit > Insert Object and do not want to accidentally select that file in the drawing, select this box. The inserted file appears gray in the drawing.

Grid Tab (View Properties Dialog Box)
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. Related Topics • Properties Command, page 33 • Show Grid Command, page 138

SmartPlant P&ID User’s Guide 35

Navigating in the Software: An Overview

Inconsistency Indicators Tab (View Properties Dialog Box)
Controls the display of inconsistency indicators, which signify the suitability of design work that you perform while creating the drawing. The software verifies in real-time if the composition of a drawing and the underlying data model satisfy rules defined in Rule Manager. Choose the indicators and severities that you want to view in your drawing. Open the View Properties dialog box by clicking View > Properties. Show - Lists options for objects you want to appear in your Drawing view. Errors above severity - Turns the display of errors on or off. You can specify the severity level. For example, if you specify a severity level of five, all errors with . severity of five or above appear. Errors are marked with a Warnings above severity - Turns the display of warnings on or off. Again, you can specify the severity level and control the warnings that you see. Warnings are marked with a . Approved warnings - Turns the display of approved warnings on or off. Approved warnings are marked with . Related Topics • Properties Command, page 33 • Show Inconsistencies, page 312

Claims Tab (View Properties Dialog Box)
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.

36 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview Claimed only by others - Specifies the special display of drawing items that are claimed solely by other projects or the Plant. Claimed only by this project - Specifies the special display of drawing items to which this project has the sole claim. Shared claims - Specifies the special display of drawing items when the active project shares a claim on with another project or the Plant. If your Plant is configured so that it honors only exclusive claiming, then these display options will have no effect in the Drawing view. Colors - Allows you to select a color for items with the corresponding claim state. Widths - Allows you to select a line width for items with the corresponding claim state. Related Topics • Claim a Drawing Item, page 288 • Display the Claim Status of a Drawing Item, page 299 • Release a Claim, page 297

Change the Properties of a Drawing View
1. Click View > Properties. 2. On the View Properties dialog box, select the General tab, and enter a view name and description. The View type box is read-only. 3. On the Display tab, select the items you want to display in the view. You can select any of the Labels, Filter labels, Drawing borders, Grids, Notes, and Inconsistency indicators options. 4. Select the Prevent selection of inserted objects option if you want to prohibit the selection of linked or embedded objects in the drawing. 5. On the Grid tab, choose the Show grid or Snap grid option, and the properties of the grid, if needed, in the Style, Density, and Index options. 6. On the Inconsistency Indicator tab, you can select from any of the Errors, Warnings, and Approved warnings options. For errors and warnings, you can specify the severity level of the displayed inconsistencies. For example, when you specify 5, errors with severity level of 5 or greater are displayed. 7. On the Claims tab, choose special display colors for drawing items according to their claim status. Tip
•

New Drawing Window Command
Window > New > Drawing Creates a new Drawing view within the active drawing. This command copies the contents of the active Drawing view into a new window and displays the contents as graphical items. The new view has the same filters as the previous Drawing view. You can change the view features for the new Drawing window using the commands on the View menu. Notes
•

If only the Engineering Data Editor view of a drawing is open, the graphical Drawing view is opened on top of the Engineering Data Editor when you select Window > New > Drawing. Creating a new Drawing or Engineering Data Editor view of a drawing does not create a new copy or version of the drawing. The same drawing data simply displays in the different views.

•

Related Topics • Open a New Drawing View, page 39 • Working With the Design Window, page 20

Open a New Drawing View
1. Click Window > New > Drawing. Tip A new Drawing view is not the same as a new drawing. You create new drawings in SmartPlant P&ID Drawing Manager. For more information, see SmartPlant P&ID Drawing Manager Help, which you can access from the Help > Printable Guides command. 2. Edit the drawing as needed.
•

Notes
• •

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.

•

Related Topics • Working with Drawings: An Overview, page 102

Cascade Command
Window > Cascade Overlaps windows diagonally across in the Design window. Related Topics • Switch to Another Open Drawing or View, page 110 • Working With the Design Window, page 20

SmartPlant P&ID User’s Guide 39

Navigating in the Software: An Overview
• • •

Zoom In on an Area, page 27 Zoom In on the Drawing, page 28 Zoom Out from an Area, page 29

Tile Horizontally Command
Window > Tile Horizontally Arranges windows to fit horizontally in the Design window. All the windows are placed an even distance from each other on the screen. Related Topics • Switch to Another Open Drawing or View, page 110 • Working With the Design Window, page 20

Tile Vertically Command
Window > Tile Vertically Arranges windows to fit vertically in the Design window. All the windows are placed an even distance from each other on the screen. Related Topics • Switch to Another Open Drawing or View, page 110 • Working With the Design Window, page 20

Active Window List
Displays an alphabetical list of open document windows below the commands on the Window menu. You can access another open document by clicking one of the window names on the list. Related Topics • Switch to Another Open Drawing or View, page 110 • Working With the Design Window, page 20

40 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Navigating in the Engineer Data Editor: An Overview
The Engineering Data Editor (EDE) uses a grid or tabular format to display the query results for the database. The EDE is automatically displayed in the lower left of the main window, and you can also open the EDE to appear in the Design window. The EDE Toolbar At the top of the EDE is the EDE toolbar. The menu buttons are found here:
• • •

Stockpile Edit View

Click the down-arrow next to the menu button to expose the available commands. The list on the toolbar contains filters that query the database and display the corresponding items in the EDE. If you want to list all items select Plant Item from the list. You can also filter the display by using the buttons that correspond to different stockpiles and drawings:
• • • •

Active Drawing Active Drawing Stockpile Stockpile Other Drawings

By default, initially only the Active Drawing and Active Drawing Stockpile buttons are selected. You can re-query and thereby refresh the EDE display by clicking the Refresh button . Finally a summary box displays a comparison between the number of items in the view and the total number of items, of the type chosen in the list, that exist in the database. Customizing the EDE Commands on the Edit menu allow you to customize the display of the EDE further. You can use the Display Settings command, for instance, to color code items according to the stockpile that they are currently in. Use Edit View to display the Table Properties dialog box, which allows you to define the items that you want to see in the EDE. You customize a filter and layout for the display on the Advanced Table Properties dialog box.

SmartPlant P&ID User’s Guide 41

Navigating in the Software: An Overview Editing Properties in the EDE You can edit some of the properties viewed in the table by selecting a table cell and filling in the appropriate information. If the property has a select list associated with it, then you choose the value from the select list. If the cell is populated by a readonly property or a property that is only automatically generated by validation, you cannot edit that cell. You can select a entire row by clicking the corresponding icon in the left-most column of the table. Then you can view the properties in the Properties window and edit item properties there, too. The contents of cells can be copied to other cells, if the cell contents are compatible. Notes
•

The maximum number of items that can be displayed in the EDE is 65,537. If your database query results in more than this number, the Query Results dialog box opens. You can then choose to refine your query in order to generate fewer items or to enter report-only mode and run a report on your query results. The EDE is where you view items in the Stockpile, the Active Drawing, the Active Drawing Stockpile, or Other Drawings. For more information, click Related Topics.

Query Results Dialog Box
Displays options for continuing your work in the Engineering Data Editor when you have requested more information than can appear in the interface. You can either refine your query or run a report with your query results. Add - Places a new entry at the end of the existing definition list and enables the options in the Edit group so that you can edit the new entry. Additional Filter Criteria - Displays all new criteria to add to the current filter. To add to or modify the definition list, you must select a line in the list and then define or edit the property in the Edit group. Continue with this query so that I can generate a plant or personal report Causes the Engineering Data Editor to enable only these commands: Edit view, Save view, Delete view, My Reports, and Plant Reports. This option is useful when creating a report for large data sets such as an entire plant database. Delete - Removes the selected criterion from the definition list. This button is available only when you select a criterion in the definition list. Edit - Allows you to define or edit a single line of filter definition criteria. Match all - Specifies that items matching ALL of the filtering criteria pass through the filter. Match any - Specifies that items matching any one or more of the filtering criteria pass through the filter. Match any is the default matching method. Maximum Allowed - Displays the currently allowed number of items in the Engineering Data Editor. Operator - Specifies the relationship between the property and its value. Relationships include, for example, greater than, >; equal to, =; not equal to, <>; and so forth. Options - Allows you to choose between refining your query or entering report-only mode. Property - Displays a list of all properties for a certain item type. Examples of properties include Equipment Type, Instrument Loop Item Tag, and Estimated Length. You define or modify filtering criteria by selecting a property, an operator, and a value. Refine Query Definition - Allows you to use the Additional Filter Criteria list in this dialog box to refine your query in order to display an allowed number of items in the view. Rows Returned - Displays the number of items that your query returned.

SmartPlant P&ID User’s Guide 43

Navigating in the Software: An Overview Value - Lists appropriate values for the property specified in the Property column. If a list of attributes is not already associated with the Value box, you must type a value, which can be free text, or choose null. You can type a percent sign, %, as a wildcard character to find multiple characters, or type a question mark, ?, as a wildcard character for a single character. Do not use an asterisk, *, in the Value box. Related Topics Customizing the Display of the Engineering Data Editor: An Overview, page 60 • Define a New Engineering Data Editor View, page 54 • Modify the Table Properties of an Existing Engineering Data Editor View, page 56 • Navigating in the Engineer Data Editor: An Overview, page 41 • Update the Engineering Data Editor, page 59
•

Actions Menu: An Overview
Engineering Data Editor > Stockpile Contains commands for moving and deleting items. Click the down-arrow next to the Actions menu to display the available commands. Related Topics • Move a Stockpile Item to the Stockpile of Another Drawing, page 250 • Place Multiple Representations, page 142 • Remove an Item from a Drawing, page 237 • Remove an Item from the Model, page 238

44 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Place Multiple Representation Command
Engineering Data Editor > Stockpile > Place Multiple Representation Allows you to place a second instance of an equipment item in a second drawing. This multiple representation allows the depiction of an item from another drawing in a detailed or alternate view. Multiple representations are available only for some types of equipment. Related Topics • Navigating in the Engineer Data Editor: An Overview, page 41 • Place Multiple Representations, page 142 • Placing Equipment: An Overview, page 140

Delete Stockpile Item Command
Engineering Data Editor > Stockpile > Delete Stockpile Item Removes the stockpile item from the plant model completely. That is the item and its properties are deleted from the database and can no longer be placed in a drawing, regardless of symbol settings in Options Manager or Catalog Manager. Related Topics • Cutting or Deleting Items: An Overview, page 232 • Remove an Item from the Model, page 238

Move to Different Stockpile Command
Engineering Data Editor > Stockpile > Actions > Move to Different Stockpile Allows you to move a stockpile item from one stockpile to another. For instance, you can move an item from the Stockpile into the stockpile for your active drawing if you know the item belongs in that drawing but are not yet ready to place the item. Similarly you can move an item in the Drawing Stockpile to the Stockpile so that it can be used in other drawings. You can even move items from one drawing stockpile to another. The Move to Different Stockpile dialog box opens. Related Topics • Move a Stockpile Item to the Stockpile of Another Drawing, page 250 • Navigating in the Engineer Data Editor: An Overview, page 41

SmartPlant P&ID User’s Guide 45

Navigating in the Software: An Overview

Edit Menu: An Overview
Engineering Data Editor > Edit Allows you to copy and paste values from one cell to another cell in the Engineering Data Editor and to select all the items in the view in order to create a select set. You can also invoke a claim at any time to expand the scope of your project, and any new item created in a project is automatically claimed by that project. You can also release a claim at any time and you can determine the validity of a claim. Click the down-arrow next to the Edit menu button to display the available commands. Related Topics • Claiming Items: An Overview, page 285 • Copy Command, page 46 • Paste Command, page 46 • Review and Edit Item Properties, page 86 • Select All Command, page 47 • Select an Item, page 135

Copy Command
Engineering Data Editor > Edit > Copy Places the value in the currently selected cell onto the Clipboard so that you can paste it somewhere else. This command does not remove the value from the selected table cell. Values placed on the Clipboard remain there until newer values are copied over them. Related Topics • Modifying Item Properties: An Overview, page 244 • Review and Edit Item Properties, page 86

Paste Command
Engineering Data Editor > Edit > Paste Places the value from the Clipboard into the selected cell. If the cell is read-only, then the Paste command is not available. You must have previously placed a value on the Clipboard in order to paste it. Related Topics Modifying Item Properties: An Overview, page 244 • Review and Edit Item Properties, page 86
•

Claim Command
Engineering Data Editor > Edit > Claim Gives control of the selected items to the current active project. The Claim dialog box opens, allowing you to confirm the "claim-ability" of the items and enter claim comments. Claim comments can be viewed later by anyone in the Plant when the claim status is displayed. Related Topics • Claim a Drawing Item, page 288 • Claiming Items: An Overview, page 285

Release Claim Command
Engineering Data Editor > Edit > Release Claim Displays the Release Claim dialog box and allows you to relinquish control (by your project) of the selected items. This dialog box also displays when you attempt to unclaim an item that has been modified in the project. Claims must be released before projects can be completed or for other projects to be able to check in drawings with changes. Notes
•

You can use the Compare and Refresh command to revert the item back to the As-built state prior to unclaiming. If you are working in The Engineering Framework (TEF) environment and there are any differences between an item in the Project and an item in the AsBuilt, the claim cannot be released. If you are not working in a TEF environment, the claim can be released. Also, items that display no warnings or errors are released.

Claim Status Command
Engineering Data Editor > Edit > Claim Status Opens the Claim Status dialog box, which displays the details of the claimed state of the selected items and enables you to claim items, release the claims to items, and so forth. You must select the items in the Drawing view or the Engineering Data Editor before using this command. Related Topics • Claiming Items: An Overview, page 285 • Display the Claim Status of a Drawing Item, page 299

Table Properties Dialog Box
Enables you to select the item types, filters, and layouts for the Tabular or Engineering Data Editor. This dialog box appears when you right-click an existing table and select Edit View. Item type - Lists all the item types that you can select (for example, equipment or motors). Filter - Lists all of the filters that have been saved for the selected item type. Layout - Lists all of the layouts that have been saved for the selected item type. For a list of default layouts, see Default Table Layouts, page 52. Advanced - Displays the Advanced Table Properties dialog box, where you can define and save filters or layouts for the Tabular or Engineering Data Editor. You can specify the default filter and layout for a certain item type also. Specify brief and bulk properties in this dialog box, too. Brief and bulk properties appear in the Properties window when you select the Show Brief Properties, Copy Bulk Properties, or Paste Bulk Properties commands from the Properties window toolbar. Related Topics Define a New Filter for an Engineering Data Editor View, page 54 • Define a New Layout for the Engineering Data Editor, page 55 • Edit View Command, page 48
•

Filter Tab (Advanced Table Properties Dialog Box)
Allows you to define, select, and save a filter for the Tabular or Engineering Data Editor. Base filter - Displays the name of a saved filter. Name - Displays the name of the filter, as it is defined in Filter Manager. Default - Indicates if the named filter is the default filter for the item type selected on the Table Properties dialog box. You can change a filter to the default by selecting this box. Browse - Opens the Select Filter dialog box, which allows you to select a base filter. Definition - Includes areas to add, remove, or edit filter 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 - Displays options that allow you to define or edit a single line of filter definition criteria. Property - Displays a list of all properties for a certain item type. Examples of properties include revision number and name. You define or modify filtering criteria by selecting a property, an operator, and a value. Operator - Specifies the relationship between the property and its value. Relationships include, for example, greater than, >; equal to, =; not equal to, <>; and so forth. Value - Lists appropriate values for the property specified in the Property column. If a list of attributes is not already associated with the Value box, you must type a value, which can be free text, or choose null. You can type a percent sign, %, as a wildcard character to find multiple characters, or type a question mark, ?, as a wildcard character for a single character. Do not use an asterisk, *, in the Value box. Related Topics Define a New Engineering Data Editor View, page 54 • Define a New Filter for an Engineering Data Editor View, page 54
•

50 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Layout Tab (Advanced Table Properties Dialog Box)
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 Table Properties dialog box. You can designate a layout as the default by checking this box and then clicking Save. Usage - Lists the property display types associated with the Properties window. Options include a blank value, Brief, Bulk, and Brief/Bulk. The selected item type and display properties define what appears in the Properties window when you select the Show Brief Properties, Copy Bulk Properties, or Paste Bulk Properties commands from the Properties window toolbar. In order for your choice in the Usage box to take effect, you must exit and reenter the design software. Delete (Name) - Removes the named layout. Save - Saves the data in this dialog box as a named layout. Layout names must be unique. Note
•

Saving a layout is not the same as saving a view in the Engineering Data Editor. For more information about saving views, see Save an Engineering Data Editor View

Definition - Displays all defined criteria associated with the selected layout. This group contains two list views. In order to add to or modify either list, you must select a line in the list and then define or edit the property in the Edit group. The buttons to the right act upon the active list view. Display Property - Lists the columns that appear in the Engineering Data Editor. To edit an entry, select it and modify the property in the Edit group. Caption (Definition) - Displays the caption for each column in the Engineering Data Editor. Sort Property - Lists the properties that apply to the item type specified in the Table Properties dialog box. Order - Lists the sort orders Ascending and Descending. You can select one. Type - Lists the sort types Numeric and Alphanumeric. You select one. Add - Adds a new entry at the end of the existing entries and enables the options in the Edit group so that you can edit the new entry. SmartPlant P&ID User’s Guide 51

Navigating in the Software: An Overview Insert - Places a new entry above the currently selected entry and enables the options in the Edit group so that you can edit the new entry. Delete (Definition) - Removes the currently selected entry. Up - Moves the currently selected entry up one line. Moving a row up either moves a display column to the left or moves a sort order up, depending on the row you have selected. Down - Moves the currently selected entry down one line. Moving a row down either moves a display column to the right or moves a sort order down, depending on the row you have selected. Edit - Allows you to edit a single entry selected in either the Display Property or Sort Property list views. If you select an entry in the Display Property view, the Edit group allows you to edit the property and the caption. If you select an entry in the Sort Property view, the Edit group allows you to edit the property, order and type. Property - Displays a list of all the properties that apply to the item type defined in the Table Properties dialog box. If you select an entry in the Display Property view, you can specify the property and its caption. If you select an entry in the Sort Property view, you can specify the property, its order, and its type. Caption (Edit) - Displays the caption for each column in the Engineering Data Editor. Related Topics • Advanced Table Properties Dialog Box, page 49 • Define a New Layout for the Engineering Data Editor, page 55 • Modify the Table Properties of an Existing Engineering Data Editor View, page 56 • New > Engineering Data Editor Command (Window Menu), page 39

Default Table Layouts
The software includes several default layouts. You can use them to base your own layouts on by changing the layout name, adding or deleting properties, and saving under a new name. Different layouts are included with SmartPlant Electrical and SmartPlant P&ID. SmartPlant Electrical
• • • •

Define a New Filter for an Engineering Data Editor View
1. Click Advanced on the Table Properties dialog box. Tip You can open the Table Properties dialog box by right-clicking the Engineering Data Editor and choosing Edit View from the shortcut menu. 2. On the Filter tab of the Advanced Table Properties dialog box, specify a name for the filter in the Base filter box.
•

Tip Check Default if you want this filter to be the default for the item type that you selected on the Table Properties dialog box. 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. Tip 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 Table Properties dialog box and again on the Table Properties dialog box so that the software can populate your table. Tip
•

After you have defined a specific filter for your Engineering Data Editor, you can save that definition: Save an Engineering Data Editor View, page 57

54 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview Note
•

If you are using a workshare environment and you are at a satellite site, Project Filters should not be created at a satellite site because when you synchronize reference data, you lose that information. However, you can always create My Filters in the Filter Manager environment.

Define a New Layout for the Engineering Data Editor
1. Click Advanced on the Table Properties dialog box. Tip You can right-click an existing Engineering Data Editor and select Edit View to open the Table Properties dialog box. 2. On the Layout tab of the Advanced Table Properties dialog box, specify a name for the layout.
•

Tip Select Default if you want this layout to be the default table layout for the item type, which you specify on the Table Properties dialog box. 3. Click Save if you want to save the layout in order to apply it to another Engineering Data Editor; click Delete if you want to delete the layout.
•

4. To further define a layout, populate the Definition box with display and sort properties. 5. Click Add to add a blank line to the Display Property list, and then specify the property and caption in the Edit group at the bottom of the dialog box. 6. To add and define more display properties, repeat step 5. Tip To change the display order of the columns in the Engineering Data Editor, select a row in the Display Property box and click Move Up or Move Down. 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. Tip
•

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.

SmartPlant P&ID User’s Guide 55

Navigating in the Software: An Overview Important
•

The Add, Insert, Delete, Move Up, and Move Down buttons apply to the active list view, which can be either Display Property or Sort Property. If you are using a workshare environment and you are at a satellite site, you should not store custom layouts for the Engineering Data Editor because when you synchronize reference data, you lose that information.

Modify the Table Properties of an Existing Engineering Data Editor View
1. In the Engineering Data Editor, click the View menu and select Edit View. 2. Review and edit the item type, filter, and layout on the Table Properties dialog box. 3. If you want to customize a filter or layout click Advanced on the Table Properties dialog box. For more information, see Define a New Filter for an Engineering Data Editor View, page 54 Define a New Layout for the Engineering Data Editor, page 55 4. Click OK to display the modified view. Notes
•

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 Table 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, page 57

Save View Dialog Box
Allows you to specify a name for your custom Engineering Data Editor. This name, which applies to the currently active EDE, is displayed at the bottom of the filter list on the Engineering Data Editor toolbar with other saved views. Open this dialog box by clicking View > Save View in the EDE. Name - Provides space for you to type in the name of your custom view. Related Topics • Save an Engineering Data Editor View, page 57 • Save View Command, page 57

Save an Engineering Data Editor View
1. After you customize the Engineering Data Editor (EDE), click View > Save View on the EDE toolbar. 2. Enter a name for your view in the Name box. Tip
•

You can reactivate your saved view any time from the bottom of the filter list on the EDE toolbar.

Notes
•

An EDE view is a combination of item type, filter, and layout. You can change filters and layouts by using the Advanced Table Properties dialog box, and this action applies to any EDE that refers to those table properties. 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, page 58.

•

SmartPlant P&ID User’s Guide 57

Navigating in the Software: An Overview
•

There are several ways to customize your EDE: Modify the Table Properties of an Existing Engineering Data Editor View, page 56 Customize the Display of the Engineering Data Editor, page 63

Delete View Command
Engineering Data Editor > View > Delete View Allows you to delete a view if you have stored a custom Engineering Data Editor view. These custom views appear at the bottom of the filter list on the Engineer Data Editor toolbar under Saved Views. The Delete View dialog box opens, and you can choose the view that you want to delete from a list of saved views. Related Topics • Delete a Saved Engineering Data Editor View, page 58 • Navigating in the Engineer Data Editor: An Overview, page 41

Delete a Saved Engineering Data Editor View
1. Click View > Delete View on the Engineering Data Editor toolbar. Tip Saved views are displayed at the bottom of the filter list on the Engineering Data Editor toolbar. 2. Select the view that you want to delete from the Name list in the Delete View dialog box.
•

58 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview Note
•

The Engineering Data Editor is where stockpile items can be displayed.

Customizing the Display of the Engineering Data Editor: An Overview
You can change the content and layout of the Engineering Data Editor rather extensively. Several methods to customize the look of the Engineering Data Editor exist. By specifying the display settings, you can define the font that Stockpile items appear in, for instance. By using the AutoFilter feature, you can quickly limit the number of items that are displayed in the Engineering Data Editor. You can clarify the cells that are read-only and the cells that allow you to enter new property information or modify existing information. You can create your own filters to narrowly define the contents of the view, and you can create unique layouts with exactly the properties that you want to see, in exactly the order that you want to see them. You can control the scrolling of the Engineering Data Editor with the Freeze Panes command, too. Once you have defined and edited a view, you can save it and also delete it later, if necessary. Related Topics Customize the Display of the Engineering Data Editor, page 63 • Define a New Engineering Data Editor View, page 54 • Modify the Table Properties of an Existing Engineering Data Editor View, page 56 • Use AutoFilter in the Engineering Data Editor, page 61
•

AutoFilter Command
Engineering Data Editor > View > AutoFilter Allows you to filter the items displayed in the Engineering Data Editor. When you click AutoFilter, arrows appear at the top of each column. Click the arrow at the top of the column that contains the data that you want to filter on and choose the value from the list that appears. For instance, if the Engineering Data Editor displays Equipment: Vessels, but you want to see only vertical drums, use the AutoFilter command (click the arrow at the top of the Eq Subclass column and choose vertical drums). To create more elaborate filters and displays, you need to use the Edit View command and enter options on the Table Properties dialog box and the Advanced Table Properties dialog box. Select this command again to deactivate it. Related Topics • Navigating in the Engineer Data Editor: An Overview, page 41

60 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Custom AutoFilter Dialog Box
Sets options for the behavior of the AutoFilter as it controls the display of items in the Engineering Data Editor. Open this dialog box by clicking View > AutoFilter > Custom in the EDE. Comparison operator - Lists the available comparisons: for example, equals, does not equal, is greater than, begins with, and so forth. Value - Lists the available values currently stored in the column. And - Allows you to add another comparison using the Boolean operator sense of and: this means all criteria must be met. Or - Allows you to add another comparison in the Boolean sense of or: this means any one of the criteria must be met. The Boolean or is less restrictive than the and. Related Topics AutoFilter Command, page 60 • Customize the Display of the Engineering Data Editor, page 63
•

Use AutoFilter in the Engineering Data Editor
1. Turn AutoFilter on by clicking View > AutoFilter on the Engineering Data Editor toolbar. Tip Click View > AutoFilter again to turn the AutoFilter feature off. 2. Click the down-arrow at the top of the column you want to filter values for. Do one of the following:
• •

To match one criterion, choose that criterion from the list that is displayed. You can choose Blanks or NonBlanks from the list in order to display items that either have no value in the column or do have a value in the column, respectively. To display rows that meet two conditions, choose Custom from the list. The Custom AutoFilter dialog box opens. Enter the comparison operator and value that you want, and then click the And button. In the second comparison operator and value boxes, enter the operator and value that you want. To display rows that meet either one condition or another condition, enter the comparison operator and value that you want, and then click the Or button on the Custom AutoFilter dialog box. In the second comparison operator and value boxes, enter the operator and value that you want.

•

•

•

SmartPlant P&ID User’s Guide 61

Navigating in the Software: An Overview Related Topics • Customize the Display of the Engineering Data Editor, page 63 • Customizing the Display of the Engineering Data Editor: An Overview, page 60 • Navigating in the Engineer Data Editor: An Overview, page 41

Freeze Panes Command
Engineering Data Editor > View > Freeze Panes Allows you to scroll through the Engineering Data Editor while keeping the display of specified rows and columns constant. For instance, the first column can contain the item tag, but you want to always see the item tag as you scroll to the right end of the rows to view the supplier. You can accomplish this layout by using the Freeze Panes command. Related Topics • Customize the Display of the Engineering Data Editor, page 63 • Customizing the Display of the Engineering Data Editor: An Overview, page 60 • Navigating in the Engineer Data Editor: An Overview, page 41

Display Settings Command
Engineering Data Editor > View > Display Settings Opens the Display Settings dialog box, which allows you to specify various display options for the Engineering Data Editor. For example, you can choose the size of icon that is displayed in the view, and you can specify the font that items in the Stockpile are listed in. You can choose that read-only cells are filled with a special background color. Related Topics • Customize the Display of the Engineering Data Editor, page 63 • Customizing the Display of the Engineering Data Editor: An Overview, page 60 • Navigating in the Engineer Data Editor: An Overview, page 41

Display Settings Dialog Box
Sets options for the display of icons and rows and columns in the Engineering Data Editor. Open this dialog box by clicking View > Display Settings in the EDE. Icon size in table - Allows you to specify large or small icons for the display in the far left column of the view. Small - Causes small icons to appear in the view. 62 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview Large - Causes large icons to appear in the view. Row - Contains settings that apply to rows in the view; that is, these settings apply to individual items. Item - Lists the different locations of items: Active Drawing, Active Drawing Stockpile, Stockpile, or Other Drawings. When you select one of these options, the remaining options in the Row area then pertain to that location. You can subsequently select another option from the Item list and define fonts and colors for those items and so on until you have specified the appearance for all locations in the Item list. Font - Sets the font for the items selected from the Item list. Color - Allows you to specify either the font or background color, depending on whether you are specifying this property in the Row area or the Column area, respectively. Italic Bold - Causes the font to be italicized for items selected from the Item list. - Causes the font to be bold for items selected from the Item list.

Column - Contains settings that apply to columns in the view; that is, these settings apply to item properties. Read-only properties - Allows you to choose a background color for read-only table cells. Read/write properties - Allows you to choose a background color for the table cells that you can edit in the Engineering Data Editor. Related Topics Customize the Display of the Engineering Data Editor, page 63 • Display Settings Command, page 62
•

Customize the Display of the Engineering Data Editor
1. Click View > Display Settings on the Engineering Data Editor toolbar. 2. On the Display Settings dialog box, choose large or small icons. 3. Choose an item type in the Item list, and the specify font, style, and color that you want these items to be displayed in. Tip You can specify this display information for each of the four types of items in the Item list. 4. Specify a special background color for read-only properties.
•

5. Specify a special background color for read/write properties, too, if you want.

SmartPlant P&ID User’s Guide 63

Navigating in the Software: An Overview Notes
•

You can also customize the Engineering Data Editor by using the AutoFilter feature. For more information, see Use AutoFilter in the Engineering Data Editor, page 61 You can use the Freeze Panes feature, too. To do so, follow these steps: 1. To freeze the top horizontal pane, select the row below where you want the split to appear. To freeze the left vertical pane, select the column to the right of where you want the split to appear. To freeze both the upper and left panes, click the cell below and to the right of where you want the split to appear. 2. Click View > Freeze Panes on the Engineering Data Editor toolbar. And by clicking View > Edit View on the Engineering Data Editor toolbar, you can totally redefine the content and layout of your Engineering Data Editor. For more information, see Modify the Table Properties of an Existing Engineering Data Editor View, page 56

Using Catalog Explorer: An Overview
Catalog Explorer is an interface to view and manipulate an electronic catalog containing drawing symbols and their associated properties. Conceptually, the Catalog Explorer resembles a manufacturer catalog with pictures of parts to build a plant. The paper catalog contains many items arranged in sections; you can search for items or browse through the catalog and bookmark certain pages and sections. Catalog Explorer replaces the paper catalog with an electronic equivalent. You can browse the catalog tree view for drawing items that you need and create bookmarks for important categories. Catalog Explorer consists of two main views: the Tree view and the List view. In the Tree view, you can view the nodes of the catalog file system and open or close the nodes to see the contents. In the List view, you see the contents of the opened node. You also use the List view to select catalog items before placing them in a drawing or in a stockpile. You can create a navigation bar in the region between the tree and list views for shortcuts to places throughout the catalog. Toolbar buttons carry out commands and allow you to customize the tree and list views to suit your work session. These toolbar buttons are located at the top of the tree view. Related Topics Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80 • Create a Custom Catalog, page 72 • Place an Item from Catalog Explorer, page 66 • Rename a Catalog Node, page 75 • Turn the Display of Catalog Explorer On or Off, page 66
•

Place an Item from Catalog Explorer
1. Find the catalog node in the Tree view. For more information, see Navigate the Catalog Explorer Tree View. 2. In the Catalog Explorer list view, click the symbol that you want to place. 3. Select and place the item in the appropriate place in the drawing. Tip Or, you can drag the required item from Catalog Explorer into the Drawing view. 4. Click Esc to quit placement mode.
•

Notes
•

The procedure for placing items from the Catalog Explorer list view is similar to that of placing items from a stockpile. However, when you place items from the stockpile, they disappear from the stockpile; whereas, items placed from the Catalog Explorer list view remain in that view. If the item that you place has multiple possible orientations in relation to other items, you can use the Configuration tool, or PickQuick, to select the appropriate placement for the item. You can enter values for properties of the placed item by clicking the item, and then selecting Edit > Properties to display the Properties window. Labels are a special class of item in Catalog Explorer. You can place labels with one-point placement or two-point placement, depending on the label.

Add an Item to the Stockpile from Catalog Explorer
1. In the Catalog Explorer tree view, click "+" by the node containing the appropriate symbol library. Tip Or you can double-click a node name in the Catalog Explorer tree view to expand the node. 2. Select the appropriate node in the symbol library in order to display catalog symbols in the Catalog Explorer list view.
•

3. In the Catalog Explorer list view, right-click the Loop or Plant Item Group symbol (excluding Area Breaks and Revision Clouds) that you want to add to the stockpile (which do not display on the drawing). 4. From the shortcut menu, choose either Send to Stockpile or Send to Drawing Stockpile, depending on the stockpile that you want to place the item in. Notes
•

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, page 252. Items remain in the stockpile until you place them in a drawing or delete them from the stockpile. Deleted stockpile items automatically go into the Stockpile. You can move an item into the stockpile of a specific drawing. For more information, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250.

•

•

Related Topics • Navigating in the Software: An Overview, page 16 • Using Reports to Import Items into the Stockpile, page 251

SmartPlant P&ID User’s Guide 67

Navigating in the Software: An Overview

Close the Catalog Explorer Window
Right-click the main toolbar area, and cancel the selection of the Catalog Explorer option. Tips
•

Or use the menu command Close when you right-click in the tree view of Catalog Explorer. Or toggle the display of Catalog Explorer back off by clicking the icon on the main toolbar:

•

Related Topics • Using Catalog Explorer: An Overview, page 65

Catalog Menu: An Overview
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. Note
•

The list of commands that are available on the Catalog menu depends on whether the Tree view or the List view is active.

Catalog Explorer Find Dialog Box
Allows you to search the active catalog for a specific item based on user-defined search criteria. Open this dialog box by clicking File > Find in the Catalog Explorer. Named - Specifies the name of the item for which you want to search. You can type an asterisk, "*", as a wildcard character to find multiple characters, or type a question mark, "?", as a wildcard character for a single character. Class - Specifies the class of item for which you want to search. You can type a percent sign, "%", as a wildcard character to find multiple characters, or type a question mark, "?", as a wildcard character for a single character. Look In - Specifies the drive or folder that contains the symbol library that you want to search. Browse - Opens the Explore Elsewhere dialog box, allowing you to search any network drives or the local directory structure for a symbol library to display in the Look In box. Results List - Lists the items that met the defined search criteria. You can drag catalog items from this area into a My Catalog set of items in the Catalog Explorer tree view. Find Now - Starts a search of the symbol library defined in the Look In: box. Stop - Ends the current search. New Search - Clears all search criteria in preparation for a new search. Related Topics • Explore Elsewhere Dialog Box, page 69 • Search for an Item in Catalog Explorer, page 70

Explore Elsewhere Dialog Box
Opens when you click Browse on the Catalog Explorer Find dialog box, allowing you to search any network drives or the local directory structure for a symbol library. Look in - Enter the location from which you want to view symbol information, or select a drive from this list and use the tree that is displayed below to find the location you want. Related Topics • Find Command, page 68 • Search for an Item in Catalog Explorer, page 70

SmartPlant P&ID User’s Guide 69

Navigating in the Software: An Overview

Search for an Item in Catalog Explorer
1. On the Catalog Explorer Catalog menu Tip The Tree view must be the active view in Catalog Explorer for the Find command to be available on the File menu. 2. On the Find dialog box, fill in the Name & Class options.
•

, click Find.

Tip You can use the asterisk, *, as a wildcard in either the Named or Class options to broaden the scope of your search. 3. Click Find Now to start the search with the defined criteria.
•

Note
•

Items found by the search appear at the bottom of the Find dialog box. You can select one or more items by using the Ctrl or Shift keys, but you cannot place an item directly onto a design from this results window. However, you can save the set of current search results to use later by dragging them into a My Catalog folder or subfolder in the Catalog Explorer Tree view.

Designing Symbol Toolbars
Symbols toolbars allow you to create toolbars that contain the symbols you use most frequently, keeping them conveniently located for easy access. Symbol toolbars can be plant-level or user-level. You create plant-level toolbars in Catalog Manager; whereas, you create user-level toolbars in either Catalog Manager or SmartPlant P&ID. With the most often used equipment, instrumentation, or piping symbols, for example, your symbol toolbars can streamline your work considerably. The symbol toolbars can be docked on any side of the main window. Related Topics Activate Symbol Toolbars, page 76 • Define a User-Level Symbol Toolbar, page 71
•

Define a User-Level Symbol Toolbar
1. In the Catalog Explorer tree view, open the My Catalog node. 2. Right-click the Toolbars node under My Catalog. 3. Click New on the shortcut menu. 4. Name the new toolbar. 5. In the Catalog Explorer list view, find symbols you want to place on your new symbol toolbar. 6. Drag symbols from the list view and drop them into the new toolbar in the tree view. 7. When you add all the new symbols you want to the new toolbar, right-click the tree view and click Refresh Symbol Toolbar. Tip
•

The new toolbar appears on the left side of the window.

Notes
• •

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 Explorer. You must have the proper permissions, granted in SmartPlant Engineering Manager, to create symbol toolbars.

Create a Custom Catalog
1. Click the My Catalog node in the Catalog Explorer tree view. 2. Right-click the tree view. 3. On the shortcut menu, click New. Tip The software adds a subcategory called New Category to the My Catalog node. New Category is selected so that you can rename it. 4. Type a name for the category.
•

5. Navigate through the tree view to display in the list view a group of items that you want to add to the custom catalog. 6. Select the items that you want to add to the custom catalog from the list view. 7. Drag the selected items from the list view to the appropriate category or subcategory of the My Catalog portion of the tree view. Caution
•

Do not move symbols to the My Catalog folder on your computer using Windows Explorer. If the symbols reside on your computer, other users cannot view the symbols when they open that drawing on another workstation. Use the My Catalog folder only for shortcuts to symbols in the plant catalog. Notes

•

To rename a node, select it in the tree view and right-click. From the shortcut menu, click Rename. Type a new name for the node. You can drag selected items to a custom catalog from the Find dialog box, which opens when you click Find on the Catalog Explorer File menu.

Clone a Catalog Item
1. Click the item you want to copy in the Catalog Explorer List view. 2. On Catalog Explorer File menu, click Clone. The software places a copy of the selected item in the List view. Important
•

Depending on your editing privileges, you may or may not be able to clone items from certain catalogs. See your system administrator for information regarding your current editing privileges. Note

•

Cloning symbols differs from creating new symbols. When you clone an existing symbol, the software copies all of the graphics and associated properties for the original symbol to the new, cloned symbol. You can then modify the properties of the cloned symbol. When you create a new symbol, you must define all of the graphics and properties for the new symbol.

You must first delete all sub-nodes and catalog items that reside under a node before you can delete the node itself.

SmartPlant P&ID User’s Guide 73

Navigating in the Software: An Overview Important
•

Depending on your editing permissions, you are able to delete items from certain catalogs. See your system administrator for information regarding your current privileges, which are specified in SmartPlant Engineering Manager.

Delete a Catalog Node
1. Click the custom catalog node that you want to delete in the Catalog Explorer Tree view. 2. On the File menu , click Delete.

3. Click OK on the confirmation box to delete the selected node. Important
•

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.

•

Related Topics • Using Catalog Explorer: An Overview, page 65

Delete a Catalog Item
1. In the Catalog Explorer List view, click the custom catalog item that you want to delete. 2. On the File menu , click Delete.

3. Click OK on the confirmation box to delete the selected item. Important
•

Depending on your editing permissions, you can delete items from certain catalog. See your system administrator for information regarding your current privileges, which are specified in SmartPlant Engineering Manager.

Related Topics • Using Catalog Explorer: An Overview, page 65

74 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Rename Command
Catalog Explorer > Catalog > Rename Allows you to type a new name for the item or node. Related Topics • Using Catalog Explorer: An Overview, page 65

Rename a Catalog Node
1. Click the custom catalog node that you want to rename in the Catalog Explorer tree view. 2. On the File menu , click Rename.

3. Type the new name for the custom catalog node. Important
•

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.

Rename a Catalog Item
1. In the Catalog Explorer list view, click the custom catalog item that you want to rename. 2. On the File menu , click Rename.

3. Enter the new name for the catalog item. Important
•

Depending on your editing privileges, you can rename items in Catalog Explorer. See your system administrator for information regarding your current editing privileges, which are specified in SmartPlant Engineering Manager.

Send to Stockpile Command
Catalog Explorer > Catalog > Send to Stockpile Sends the catalog item selected in the list view to the Stockpile. This command is particularly useful for instrument loops and packages and other items that reside in a stockpile but generally are not depicted graphically in a drawing. Related Topics Add Instruments to a Loop, page 166 • Place a Package, page 200
•

76 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Send to Drawing Stockpile Command
Catalog Explorer > Catalog > Send to Drawing Stockpile Sends the catalog item selected in the list view to the Active Drawing Stockpile. This command is particularly useful for instrument loops and packages and other items that reside in a stockpile but generally are not depicted graphically in a drawing. Related Topics • Add Instruments to a Loop, page 166 • Place a Package, page 200

Customize the Catalog Explorer List View
1. In Catalog Explorer click the down-arrow on the View menu 2. Choose the display of items in your list view. Options include
•

.

Large Icons - Displays the icon for an item in the list view in a larger format. Small Icons - Displays the icon for an item in the list view in a smaller format. List - Displays the icon and name for an item in the list view in a simple list. Details - Displays the icon, name, and file location for an item.

Navigation Menu (Catalog Explorer)
Catalog Explorer > Navigation The Navigation menu in Catalog Explorer provides commands that allow you to control the display and assignment of shortcut buttons within the Catalog Explorer. Shortcut buttons provide shortcuts that bookmark a node in the active Tree view of Catalog Explorer. These buttons reside on the navigation bar between the tree and list view in the Catalog Explorer window. For example, if your workflow requires you to route a lot of piping, you want to make a shortcut button to the Process Lines node. Then when you open Catalog Explorer and click this shortcut button, you open the node for the piping and all the piping types appear in the list view. Consequently you save the time and effort of browsing the catalog node structure in the tree view in order to find the node that you want to open in the list view. The software does not limit the number of shortcut buttons that you can create, but you are limited by the size of the Catalog Explorer window. Also, shortcut buttons are shortcuts to catalog nodes only. If you want to make a shortcut to a particular symbol that you use a lot, you can use the symbol toolbar. All of the commands for managing your shortcut buttons are found on the Catalog Explorer Navigation menu. Related Topics • Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80 • Display Shortcut Buttons in Catalog Explorer, page 81 • Remove a Shortcut Button from the Catalog Explorer Navigation Bar, page 81

Add Button Command
Catalog Explorer > Navigation > Add Button Adds a shortcut button to Catalog Explorer for the active tree view node. For example, if you frequently select nozzles, you can add a shortcut button to the nozzles node of the Catalog Explorer tree view by selecting Nozzles in the tree view and then choosing Add Button from the menu that appears when you click the downarrow of the Navigation menu. You must also select the Show Buttons option in the menu in order for your shortcut button to appear between the tree view and list view windows of Catalog Explorer.

SmartPlant P&ID User’s Guide 79

Navigating in the Software: An Overview Note
•

Clicking the down-arrow of the Navigation menu button above accesses a list of the associated commands. Clicking on the Navigation menu button itself repeats the last command that you used from the menu.

Add a Shortcut Button to the Catalog Explorer Navigation Bar
1. Verify that shortcut buttons are set to appear on the navigation bar between the tree and list views of Catalog Explorer by clicking the down-arrow on the Navigation menu and making sure that Show Buttons is selected. 2. In the tree view, select the node that you want a shortcut to. 3. On the Navigation menu, click Add Button to create a shortcut button for the currently selected node. Note
•

You can right-click any shortcut button to display options to add, remove, and show buttons.

Customizing Catalog Explorer: An Overview
The Catalog Explorer toolbar buttons access the Catalog Explorer File, View, and Navigation menus. The commands on these menus allow you to customize the Catalog Explorer. After customization you can control the content and display of components in the Catalog Explorer window. For example, you can control the display of icons in the list view and define shortcut buttons that allow you easy access to user-defined groups of catalog items. Related Topics • Assign a Command to a Catalog Explorer Toolbar Button, page 82

Assign a Command to a Catalog Explorer Toolbar Button
1. Click the down-arrow portion of a Catalog Explorer toolbar button to open the associated menu. 2. On the menu, click an available command, for example, the Find command on the File menu. The software assigns the selected command to the Catalog Explorer toolbar button, the icon located next to the menu button. 3. Click the toolbar button itself, and that most recent command from the menu is carried out. For example, click on the File menu button (not the down-arrow) and the Find command is carried out again. Related Topics • Customizing Catalog Explorer: An Overview, page 82 • Using Catalog Explorer: An Overview, page 65

82 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Working With the Properties Window: An Overview
The Properties window display is a two-column table that provides the common properties of the current selection in the active Design window. The active items always determine the content of the Properties window. You can only have one Properties window open. If only one component is selected, or all components are of the same type, all the properties of that type of component appear. If your select set contains components of different types, then only the common properties appear. If the selected items have different values for their common properties, the value box is blank. You can modify the values for properties in the Properties window. You can display and edit relationships that involve components, component types, or assemblies. At the top of the Properties window is the Selected Items list, which itemizes all of the selected objects individually and as a select set. You can display item properties by locating the appropriate item in the Selected Items list, as well as by selecting an item in the Design window. If more than one item is selected in the Design window, then the Selected Items list contains the choice Select Set as well as individual items in the set. You can use the Copy Bulk Properties and Paste Bulk Properties buttons to copy properties from one item to another. This action can be particularly useful when correcting inconsistencies, for instance, or when you must apply changes to more than one item. Notes
•

The software includes a default set of bulk properties, but you can change those properties specified as bulk in the Usage box on the Layout tab of the Advanced Table Properties dialog box. When you pause your pointer over the buttons on the Properties window toolbar, a ToolTip appears, giving the name of the button. An item and the properties that belong to it are associated when the item is created in Catalog Manager. If you copy or paste values in the grid area, use Ctrl+C and Crtl+V. Do not use the Edit > Copy, Edit > Paste, or Edit > Cut to modify property values in this grid.

Properties Window Command
View > Display > Properties Opens the Properties window and displays characteristics for a selected item or a select set. You can review and edit the properties. The applicable properties of an item are defined when it is created in Catalog Manager. Note
•

Properties Window Toolbar
You can customize the display of the Properties window by using the following Properties window toolbar buttons: Alphabetic - Lists properties in alphabetical order. Categorized - Displays properties grouped by specific categories. Categories are defined and properties are assigned to those categories in Data Dictionary Manager. Show Brief Properties - Displays those properties that have been previously specified as brief on the Advanced Table Properties dialog box. Copy Bulk Properties - Copies the bulk properties of a selected item. The properties are then available to paste onto other items. For more information, see Copy Bulk Properties. Paste Bulk Properties - Pastes copied bulk properties onto the newly selected item or items. You must have previously selected an item or items and copied bulk properties. For more information, see Paste Bulk Properties. Display Null - Displays a null value in blank properties that currently contain no value. This option helps avoid confusion between empty cells and cells containing a zero. Show Case Data - Displays a list of case conditions, for example, temperatures, pressures, and so forth. Case data includes both process cases and control cases, which are displayed for equipment, pipe runs or instruments, according to relevance. To see the case data that appears for corresponding items, look in Data Dictionary Manager. 84 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview Note
•

The software includes a default set of bulk and brief properties, but you can change those properties in the Usage box on the Layout tab of the Advanced Table Properties dialog box.

Customize the Properties Window
1. Open the Properties window. Tip For more information on opening the Properties window, see Turn the Display of the Properties Window On or Off, page 85. 2. If more than one item is selected in the Drawing view or in the Engineering Data Editor, use the Selected Items list at the top of the Properties window choose a single item or the select set of all listed items.
•

Tips
•

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.

SmartPlant P&ID User’s Guide 85

Navigating in the Software: An Overview 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.
•

Tips
•

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.

86 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview
•

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.

Associate an Item with a Plant Group
1. Select the item that you want to associate with a different plant group. Tips
•

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.
•

Tip 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. Then modify the plant group name in the Plant Group Name property box.
•

On the Properties window toolbar, click the Show Case Data button Tip
•

.

Once you display case data in the Properties window, case data remains displayed for the current design session.

Notes
•

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.

Customizing the Software: An Overview
Customization allows you to modify and enhance the software to meet your specific needs. You can use standard Windows programming tools and languages that are OLE-aware, such as Microsoft® Visual Basic®. Several ways to customize the software are available: Customizing with Built-In Commands You can add commands to a menu or a menu command to a toolbar. To add a button to a toolbar or a command to a menu, you click Tools > Customize. From there, you can click the Menu or Toolbars tab and click the options that you want. For example, if you frequently use the View > Previous command, you could add the Previous View button to the main toolbar. The Previous View button is listed on the Toolbars tab of the Customize dialog box. If you want to create a new toolbar that does not exist in the software, you can start by clicking View > Toolbars. You then click New and type the name of the new toolbar on the New Toolbar dialog box. After you click OK, the Customize dialog box automatically appears so that you can add buttons to the new toolbar. Customizing with Macros Not only can you add built-in commands or buttons to the software, but you can also create your own macros and add them to menus and toolbars in the same manner. The Tools > Customize command allows you to add macros to the standard menus and toolbars in the software. Or, you can run the macros directly by clicking Tools > Custom Commands and selecting the macro. You can create the macros in Visual Basic or other OLE-aware programming applications. Some of the OLE-aware programming applications are Visual Basic for Applications, Visual C++ Delphi, Visual Basic, and so forth. The software includes a type library, which contains all the objects, properties, and methods available with the product. Click Help > Programming with SmartPlant P&ID to access the SmartPlant P&ID Programming User's Guide, which provides a complete reference to the objects, methods, and properties. You can view the type library with the type library browser of Visual Basic or the browser for an OLE-aware programming application. Some macros also are delivered with the software; see a list by using the Tools > Custom Commands command.

90 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview Customizing Interface Elements You can customize many of the various ways of interfacing with the software. Some customization options include displaying small or large icons, creating shortcut buttons to access your most commonly used items, creating filter tabs, and so forth. For more information about some of these options, see these examples Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80 Customize the Catalog Explorer List View, page 78 Customize the Properties Window, page 85 Define a User-Level Symbol Toolbar, page 71 Related Topics • Add a Button to a Toolbar, page 32 • Add a Command to a Menu, page 95 • Add a Shortcut Button to the Catalog Explorer Navigation Bar, page 80 • Create a New Menu, page 96 • Create a New Toolbar, page 32 • Run a Macro, page 101

Customize Command
Tools > Customize Opens the Customize dialog box, which allows you to customize toolbars or menus to fit your workflow. You can add commands to toolbars or menus, or you can create new toolbars and menus. Related Topics • Create a New Menu, page 96 • Create a New Toolbar, page 32 • Customizing the Software: An Overview, page 90

Customize Dialog Box
Changes the display of toolbar buttons and menus according to your needs. This dialog box opens when you click Tools > Customize on the main menu bar. Related Topics • Add a Button to a Toolbar, page 32 • Create a New Menu, page 96 • Create a New Toolbar, page 32 • Remove a Button From a Toolbar, page 33 • Remove a Command From a Menu, page 95

SmartPlant P&ID User’s Guide 91

Navigating in the Software: An Overview

Menu Tab (Customize Dialog Box)
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. 92 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview Categories - Allows you to specify the category that you want to select a command or macro from. Then you can add the command or macro to the menu or main menu bar. When you select the title of a group of commands in this box, you can click the title of a command in the Commands list. When you select Macros in the Categories list, you can select a macro from the Macros list. Commands - Allows you to specify the command that you want to add to the menu. Description - Displays a description of the command that you selected before you add it to a menu. Descriptions do not appear for macros. Macros - Allows you to specify the macro that you want to add to the menu. If you select a macro, you can click Browse to change the folder for macros. Menu Tree - Lists the menus and their associated commands or macros. To see all the commands on a menu, double-click a menu name or click the "+" next to the menu name. When you click Add Command, Add Menu, or Remove, the changes show up on the menu tree. Also, you edit menu and command names in this view. Place Into Selected Menu - Overrides the default placement and places a command or macro on the menu that is currently selected in the menu tree. If you do not set this option, then the macros, commands, or menus are added at the level that is currently open in the menu tree. Reset All - Restores all menus and the main menu bar to the original settings. Remove - Removes the command or menu that you selected in the menu tree. Related Topics Add a Command to a Menu, page 95 • Create a New Menu, page 96 • Create a New Toolbar, page 32 • Remove a Command From a Menu, page 95 • Restore All Built-In Menus to their Original Settings, page 96
•

Categories - Lists the categories of the toolbars that you can customize. Choose one and the corresponding buttons appear in the Buttons area. Buttons - Lists the buttons available in the active category. You can drag a button from this area onto a toolbar. Description - Describes the button selected in the Buttons area. Related Topics • Add a Button to a Toolbar, page 32 • Add a Command to a Menu, page 95 • Create a New Toolbar, page 32 • Remove a Button From a Toolbar, page 33 • Toolbars Dialog Box, page 31 94 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Custom Button Dialog Box
Allows you to assign an toolbar button icon to a macro. This dialog box opens when you drag a macro from the Toolbars tab of the Customize dialog box to the toolbar. Buttons - Displays the available icons. Assign - Specifies the icon for your button and closes the dialog box. Browse - Opens the Select Bitmap File dialog box, which allows you to look for an icon on your local computer or on the network. Related Topics Add a Button to a Toolbar, page 32 • Create a New Toolbar, page 32 • Remove a Button From a Toolbar, page 33
•

Remove a Command From a Menu
1. Click Tools > Customize. 2. On the Menu tab, double-click a menu in the menu tree. Tip The menu tree expands to show the commands on the existing menu. 3. Click the name of an existing menu or command that you want to remove from the main menu bar or the existing menu.
•

Add a Command to a Menu
1. Click Tools > Customize. 2. In the Categories list on the Menu tab, select the command category that you want. 3. In the Commands or Macros box, click the name of the command that you want to add. Tip If you choose Macros from the Categories list, then the Macros box is displayed; otherwise, the view contains the Commands box. 4. In the menu tree, double-click the name of the existing menu that you want to add a command to.
•

SmartPlant P&ID User’s Guide 95

Navigating in the Software: An Overview Tip The menu tree nodes expand to show the commands on the existing menus. 5. Click the name of the command that you want the new command to appear after.
•

6. Select the Place Into Selected Menu option. Tip If you want to add the new command to the main menu bar, clear the Place Into Selected Menu option. The software places the new command on the main menu bar after the existing menu that you select in the menu tree. 7. Click Add Command.
•

Related Topics • Customizing the Software: An Overview, page 90

Restore All Built-In Menus to their Original Settings
1. Click Tools > Customize. 2. On the Menu tab, click the Reset All button. Notes
•

If you remove Customize from the Tools menu, you can restore the command. Right-click the empty area of the main toolbar and click Customize on the shortcut menu in order to open the Customize dialog box.

•

Related Topics Customizing the Software: An Overview, page 90

Create a New Menu
1. Click Tools > Customize. 2. In the Categories box on the Menu tab, click the command category that you want. 3. On the menu tree, click the name of an existing menu. 4. Click the Add Menu button. Tips
•

The new menu is added after the existing menu that you selected in step 3.

96 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview If you want to add a menu to an existing menu, select the Place Into Selected Menu option before you click the Add Menu button, thereby creating a cascading menu. 5. On the menu tree, type the name of the menu.
•

6. To enter the new menu, click anywhere away from the name. Note
•

After you create a new menu, you can add commands to it. For more information, see Add a Command to a Menu, page 95.

Custom Commands Command
Tools > Custom Commands Opens the Custom Commands dialog box. You can choose a macro and run it. Some macros are delivered with the software, generally in the C:\Program Files\Smartplant\P&ID Workstation\Program directory. You can also record your own macros and store them wherever you want to. Related Topics • Customizing the Software: An Overview, page 90 • Display Help for Programming With SmartPlant P&ID, page 15 • Run a Macro, page 101

Clean Data Dialog Box
The Delete Orphan Model Items utility opens when you click Tools > Custom Commands and run the DelOrpModItems.dll. You use this utility to delete obsolete model items from the database. For more information, refer to the SmartPlant P&ID Installation and Upgrade Guide. Database Report - Generates a report, written to the DBCleanup.txt file in your Temp folder, that helps you decide if a manual cleanup alternative exists before using the Entire Database command to delete the problems from the database. Entire Database - Removes orphaned records from the plant database. Use this only after running Database Report, examining the report, and manually cleaning up as many items in the database as necessary.

SmartPlant P&ID User’s Guide 97

Navigating in the Software: An Overview Model Items - Finds and deletes any model item in the database that does not have a corresponding entry in the T_Representation table. The utility works on an item type basis and repairs the following model item types: Vessel, Mechanical, Exchanger, Equipment: Other, Equipment Component, Instrument, Nozzle, Piping Component, Pipe Run, Signal Run, and OPC. Once the orphan model items for an item type are found, you can select any or all of the items and choose to delete them. OPCs - Finds and repairs off-page connectors (OPCs) that have lost their associations with the OPC with which they were originally paired. If one OPC has lost the identity of its mated OPC, but the mated OPC still has the identity of the first OPC, then the OPC is considered repairable. To repair the OPC, the utility updates the identity information for the first OPC. However, if both the OPC and its mated OPC have lost the identities of each other, then the OPCs are considered non-repairable, and you are given the option to delete them. Gaps - Repairs and updates gaps in the representation record with the proper item type. On rare occasions you will need to perform this operation if you have gapping problems in your drawings. Related Topics • Delete Orphan Model Items, page 100

Repair OPCs Dialog Box
Opens when you click Tool > Custom Commands to run DelOrpModItems.dll and click OPCs. You can choose OPCs to repair or delete from the plant database. This dialog box is part of the Delete Orphan Model Items Utility. For more information, see Related Topics.

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.

98 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview

Delete Orphan Model Items Dialog Box
Opens when you click Tool > Custom Commands and run DelOrpModItems.dll and then click Model Items. You can choose the orphan model items that you want to delete from the plant database. Part of the Delete Orphan Model Items Utility, this dialog box can be used to accomplish the following tasks.
• •

Clean orphaned records from the plant database. Find and delete any model item in the database that does not have a corresponding entry in the T_Representation table. The utility works on an item type basis and repairs the following model item types: Vessel, Mechanical, Exchanger, Equipment: Other, Equipment Component, Instrument, Nozzle, Piping Component, Pipe Run, Signal Run, Area Break, and OPC. Once the orphan model items for an item type are found, you can select any or all of the items and choose to delete them. Find and repair off-page connectors (OPCs) that have lost their associations with the OPC that they were originally paired with. 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. 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.

SmartPlant P&ID User’s Guide 99

Navigating in the Software: An Overview Delete All - Selects and deletes all the orphan model items of the type specified in the Item Type Names list. Related Topics • Delete Orphan Model Items, page 100

Delete Orphan Model Items
Important
•

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. Tip

You can find this macro in \Program Files\Smartplant\P&ID Workstation\Program. 3. On the Clean Data dialog box, click Clean DB.
•

4. Click Model Items. 5. On the Delete Orphan Model Items dialog box, choose the model item type from the Item Type Names list. 6. In the list view, select the model orphan items to delete and click Delete. Tip You can also click Delete All to select and delete all the items in the list view. 7. Click OPCs.
•

8. On the Repair OPCs dialog box, choose either repairable or non-repairable from the OPC Type list. Tip Repairable OPC pairs retain one link out of two between the mates. Non-repairable OPC pairs retain neither link. 9. Choose the OPC pair that you are interested in from the OPC list, and click Fix if it is a repairable pair or Delete if it is non-repairable.
•

10. Click Gaps to find and repair gaps that do not have the correct representation in the database.

100 SmartPlant P&ID User’s Guide

Navigating in the Software: An Overview Tip Follow the prompts on message boxes if you see any. 11. Click Close to return to the design software.
•

Notes
•

The Delete Orphan Model Item Utility must be run from within the drawing environment. Log messages generated when orphaned records are deleted from the plant database are written to the DBCleanup.txt file in the directory assigned to the Temp environment variable. Log messages are placed in SPDelOrpModItems.log file in the directory assigned to the Temp environment variable. The log file contains information about deleted items including the item type and sp_id.

You can create macros with any programming tool that supports OLE automation, such as Visual Basic.

Related Topics • Customizing the Software: An Overview, page 90

SmartPlant P&ID User’s Guide 101

Working with Drawings: An Overview

Working with Drawings: An Overview
An administrator uses Drawing Manager to create a new drawing on a pre-formatted template. When you create and open a drawing, the drawing is displayed in a Drawing view in the Design window. Drawings are graphical representations of plant models using standard symbols and conventions. A plant model consists of components. A component is any piece of equipment, instrumentation, piping, or other item used to create a plant model. Symbols represent components in Catalog Explorer and Engineering Data Editor. You select symbols from Catalog Explorer and then select the appropriate placement location in the drawing. In the Properties window, you enter appropriate values into the database for each property of the component. You can use the commands on toolbars and in menus to add information to your drawing, and you can use edit commands to modify the information in your drawing. Any changes that you make to the drawing data are automatically saved in the database. You can save drawings in different formats, including .pid for SmartPlant, .dwg and .dxf for AutoCAD®, .dgn for MicroStation®, and .cgm for CGM Metafile. You cannot save a drawing as a template. The only way to use a template is to have a plant administrator select a template at drawing creation in Drawing Manager. The following table lists the characters that cannot be used in certain names or objects throughout the SmartPlant Engineering Manager, SmartPlant P&ID, and SmartPlant Electrical products. Object File and Directory Names (Windows restriction) SmartPlant Engineering Manager Names (site, plant, project, satellite, and so forth) Database User Names and Passwords Paths (directories, and so forth) Restricted Characters \/:*?“<>| <,>?\/';{}[]~`!%*( )|“: .<,>?\/';{}[]~`!%* ()&$@#" <,>?/';{}[]~`!%*() :|"

Using Templates as a Starting Point You use a template as a starting point for creating the drawing. A template is a file that provides tools such as text, formats, geometry, dimensions, units of measurement, and styles used to produce a new drawing. Your plant administrator can edit the property set of the template to include default values for some of the properties, as well as the additional custom properties that you need to manage your drawings. The template that your plant administrator selects depends on the type of information that is wanted in the drawing.

102 SmartPlant P&ID User’s Guide

Working with Drawings: An Overview Several standard templates are delivered with SmartPlant P&ID, and you can create new templates in SmartPlant P&ID. If you want to create custom border files for your drawing templates, use Intergraph SmartSketch. You can then embed your border file in the new templates you create in SmartPlant P&ID. Once you embed a border file into a drawing template and a drawing is created in Drawing Manager using that template, any changes to the border file are not reflected in drawings created prior to the change. If you link a border file, instead of embedding it, and then subsequently change that border in SmartSketch, changes are reflected automatically in your drawing. Opening Existing Drawings The Open command on the File menu opens existing drawings. You can also change databases by using this command so that you can open drawings in other plants. The software keeps track of the drawings that you worked on last. These drawings appear at the bottom of the File menu. To open one of these drawings, you can select it from that list. The Options command on the Tools menu allows you to set the number of entries displayed in that list. Setting Up Properties for a Drawing An administrator sets up drawing properties such as units of measure in Options Manager and Format Manager. The drawing information is stored in a database associated with the drawings in a plant. With the Properties command on the File menu, you can view, edit, and save properties for a drawing. Drawing properties can include the title, the author, and keywords that identify important information. These properties include drawing statistics, such as drawing size and the date that a drawing was created and last modified; the software updates statistics automatically. You can change the size of a drawing by using the Page Setup command on the File menu, and you can change the name of a drawing in Drawing Manager. Note
•

Renaming a drawing file in Windows allows the drawing to be opened with all graphics pointing to the database. However, renaming a drawing file in Windows does not update the drawing table in the plant schema where the drawing name is stored.

Working with Several Open Drawings Several drawings can remain open in the same session but only if they all belong to the same plant. Each drawing can have more than one view, too. You can use the Cut, Copy, and Paste commands to move or copy information between the drawings or within one open drawing. You can use commands on the Window menu to arrange all the open drawings and views so that you can see them easily.

SmartPlant P&ID User’s Guide 103

Working with Drawings: An Overview

Open Command
File > Open Opens the Open dialog box, which lists existing plants and their drawings. An administrator creates the hierarchy of plants and projects in SmartPlant Engineering Manager. Related Topics Customize the Open Dialog Box, page 108 • Open an Existing Drawing, page 107 • Switch to Another Open Drawing or View, page 110 • Working with Drawings: An Overview, page 102
•

Open Dialog Box
Displays the active plant hierarchy and lists its drawings, and allows you to open a drawing and to choose the database that you access. This dialog box appears when you click File > Open on the main menu bar. Pause over a toolbar button in order to display a ToolTip, which names the corresponding command. For more information on the toolbar commands, see: Open Database - Opens the Open Plant Structure dialog box, which allows you to specify a different SmartPlant initialization file so that you can work in a different database. You cannot open two drawings from different databases at the same time. If you currently have a drawing open in SmartPlant P&ID, the Open Database command is not available. Filter - Opens the Filter dialog box, which allows you to specify the drawings that are displayed in the list or detailed view. Cancel Filter - Deactivates any ad hoc filter you have applied to the list of drawings that appears in the list view of the Open dialog box. Include Subnodes - Displays in the right-hand view of the Open dialog box all the drawings and node names that reside in the currently selected node. Details - Displays a detailed view in the right-hand window. The detailed view displays all the properties specified in the Selected Properties list of the Customize Current View dialog box. Using the detailed view allows you to view and sort drawings by several attributes. List - Displays the list view in the right-hand window. The list view only displays one property for each drawing. You can specify that descriptor by clicking

104 SmartPlant P&ID User’s Guide

Working with Drawings: An Overview Customize View; the first item in the Selected Properties list is the descriptor that appears in the list view. Customize View - Opens the Customize Current View dialog box, which allows you to specify the information about each drawing that is displayed in the report or list view of the Open dialog box. Related Topics • Customize the Open Dialog Box, page 108 • Open an Existing Drawing, page 107 • Open Command, page 72 • Switch to Another Open Drawing or View, page 110

Open Plant Structure Dialog Box
Sets options for connecting to a site and plant structure and passes user access information to the application. This dialog box opens when you click Open Database on the Open dialog box. Application Type - Allows you to specify the application that you want to associate with this plant structure. Available plant structure - Lists those plant structures found on the network. You can select only one item from this list view at a time. Open - Connects you to the selected database. The Open command also checks to make sure you have the correct access privileges for the selected plant structure and passes your access information back to the software. Site Server - Opens the Open Site Server dialog box, allowing you to select a SmartPlant initialization file from local and network directories. Plant structures that correspond to the initialization file that you choose are subsequently displayed in the list of available plant structures. Related Topics Open a Drawing in a Different Database, page 108 • Open an Existing Drawing, page 107 • Open Command, page 72
•

SmartPlant P&ID User’s Guide 105

Working with Drawings: An Overview

Filter Dialog Box
Sets options for the display of drawings in the list or report view of the Open dialog on the Open dialog box. box. This dialog box opens when you click Filter Add - Places a new entry at the end of the existing definition list and enables the options in the Edit group so that you can edit the new entry. Definition - Displays all defined criteria associated with a filter. To add to or modify the definition list, you must select a line in the list and then define or edit the property in the Edit group. Delete - Removes the selected criterion from the definition list. This button is available only when you select a criterion in the definition list. Edit - Allows you to define or edit a single line of filter definition criteria. Match all - Specifies that items matching ALL of the filtering criteria pass through the filter. Match any - Specifies that items matching any one or more of the filtering criteria pass through the filter. Match any is the default matching method. Operator - Specifies the relationship between the property and its value. Relationships include, for example, greater than, >; equal to, =; not equal to, <>; and so forth. Property - Displays a list of all properties for a certain item type. Examples of properties include revision number and name. You define or modify filtering criteria by selecting a property, an operator, and a value. Value - Lists appropriate values for the property specified in the Property column. If a list of attributes is not already associated with the Value box, you must type a value, which can be free text, or choose null. You can type a percent sign, %, as a wildcard character to find multiple characters, or type a question mark, ?, as a wildcard character for a single character. Do not use an asterisk, *, in the Value box. Related Topics Customize the Open Dialog Box, page 108 • Open an Existing Drawing, page 107 • Open Command, page 72
•

106 SmartPlant P&ID User’s Guide

Working with Drawings: An Overview

Customize Current View Dialog Box
Allows you to specify what drawing property or properties are displayed in the list view of the Open dialog box. This dialog box opens when you click Customize View on the Open dialog box. Add - Moves the selected items in the Drawing properties list into the Selected properties list so that those properties are available in the detailed view of the Open dialog box. Drawing properties - Lists the properties that are available to be displayed in the detailed view of the Open dialog box. Move Up - Moves the selected property up in order in the list, which changes the order of the display in the detailed view of the Open dialog box. Move Down - Moves the selected property down in order in the list, which changes the order of display in the detailed view of the Open dialog box. Remove - Moves the chosen items in the Selected properties list back into the Drawing properties list so that they are no longer available in the detailed view. Selected properties - Displays the properties that are currently available for the detailed view in the Open dialog box. Related Topics Customize the Open Dialog Box, page 108 • Open a Drawing in a Different Database, page 108 • Open an Existing Drawing, page 107 • Open Command, page 72
•

Open an Existing Drawing
1. On the main toolbar, click Open . 2. Double-click the drawing that you want to open. Tip
•

If you do not see the drawing that you want to open, confirm that the plant hierarchy is correct. You can change the database you are working in. For more information, see Open a Drawing in a Different Database, page 108.

Notes
•

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.

SmartPlant P&ID User’s Guide 107

Working with Drawings: An Overview
•

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.

Related Topics • Working with Drawings: An Overview, page 102

Open a Drawing in a Different Database
1. On the main menu bar, click File > Open. 2. On the Open dialog box, click Open Database Tip The Open Database command is not available if you already have a drawing open because you cannot open drawings from different databases during the same P&ID session. 3. On the Open Plant Structure dialog box, click Site Server.
•

.

4. On the Open Site Server dialog box, select the correct SmartPlant .ini initialization file and click OK. 5. Select the correct plant on the Open Plant Structure dialog box and click Open. Tip The Open command checks to make sure that you have the correct access privileges for the selected plant structure and passes your access information back to the software. 6. Navigate to the correct drawing in the Open dialog box and double-click it.
•

Customize the Open Dialog Box
1. To apply a filter to the drawings displayed in the right-hand view of the Open dialog box, click Filter . 2. On the Filter dialog box, define your ad hoc filter criteria. 3. To cancel a filter that you have already applied to the Open dialog box, click Clear Filter . 4. To display all the drawings and node names that reside in the currently selected node, click Include Subnodes . 5. To cancel the display of subnodes, click Include Subnodes again.

108 SmartPlant P&ID User’s Guide

Working with Drawings: An Overview 6. To display a detailed view in the right-hand window, click Details Tip
•

.

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. .

7. To display a list view in the right-hand window, click List Tip

The list view displays only 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. 8. To further manipulate the properties that are available to view in the right-hand window, click Customize View .
•

Tip
•

On the Customize Current View dialog box, you can add and remove drawing properties from the display, and you can change the order that drawing properties appear in.

Note
•

Because the Open dialog box is similar in nature to the Drawing Manager interface, you can see Drawing Manager Help for more information.

•

Related Topics Working with Drawings: An Overview, page 102

SmartPlant P&ID User’s Guide 109

Working with Drawings: An Overview

Recent Drawings
File > Recent Drawings Opens one of the drawings that you worked on most recently. The file names are listed near the bottom of the File menu. You can change the number of files listed on the menu by using the Tools > Options command. Related Topics • Access a Recently Open Drawing, page 110 • Working with Drawings: An Overview, page 102

Access a Recently Open Drawing
1. Click File on the main menu bar. 2. Select the drawing from the list of recently opened drawings. Related Topics • Working with Drawings: An Overview, page 102

Switch to Another Open Drawing or View
If you can see a portion of the drawing or view that you want to switch to, click its window. Or, if you cannot see any portion of the drawing or view, on the Window menu, select the view that you want to work in from the list. The view then appears on top of other open views. Related Topics Working With the Design Window, page 20

General Tab (File Properties Dialog Box)
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.

SmartPlant P&ID User’s Guide 111

Working with Drawings: An Overview Attributes - Displays the properties of the current document. These settings are readonly. 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 doocument. Hidden - Indicates that the document is a hidden document. You usually cannot see this document in the Windows. System - Shows that the document is a system document. You usually cannot see this document unless you change the view options in Windows Explorer. Note
•

If some of the above information is not available, the dialog box displays Unknown.

Summary Tab (File Properties Dialog Box)
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. Related Topics • File Properties Dialog Box, page 111 • Set Document Properties, page 115 • View Document Properties, page 114

112 SmartPlant P&ID User’s Guide

Working with Drawings: An Overview

Statistics Tab (File Properties Dialog Box)
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. Related Topics • File Properties Dialog Box, page 111 • Set Document Properties, page 115 • View Document Properties, page 114

Units Tab (File Properties Dialog Box)
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.

SmartPlant P&ID User’s Guide 113

Working with Drawings: An Overview Notes
•

To avoid loss of precision in units when switching between small and large types of a particular unit, increase the precision, that is, increase decimal places, of the larger unit through Format Manager. All delivered labels use plant default units, which are defined in the Options Manager, and so labels do not always display the units selected in the Properties window. Change the Unit definition in the SmartText Editor dialog box in Catalog Manager to see a different unit of measure in a label. SmartPlant supports round-trip conversion of units without loss of precision. That is, you can convert centimeters to meters and back and retain the originally entered value of centimeters with no round-off loss.

You must save the document before you can view the document statistics or summary information on the Statistics and Summary tabs of the File Properties dialog box.

Note
•

The File Properties dialog box displays information about the current condition of the active document. If the document has unsaved changes, you must save the document to update the property information.

Set Document Properties
1. Click File > Properties. 2. On the File Properties dialog box, set the options that you want, such as summary information or keywords. Notes
•

Before you can set or view the document statistics or summary information on the Statistics and Summary tabs of the File Properties dialog box, you must save the document . You can also change the size for an existing drawing. For more information, see Set up a Page Layout, page 369

Exit Command
File > Exit Closes the active drawing and the program. The software checks for unsaved changes when you close the software. Any changes are automatically saved. Related Topics • Close the Program, page 117 • Working with Drawings: An Overview, page 102

Close the Program
Click File > Exit. Note
•

The software saves any changes since the last time you saved your changes.

Related Topics • Saving Drawings: An Overview, page 123

SmartPlant P&ID User’s Guide 117

Working with Drawings: An Overview

Creating Drawing Templates: An Overview
The software includes several standard drawing templates. You usually create a new drawing based on one of these existing templates; however, it is possible to customize a drawing template to meet your particular needs. This task is accomplished inside the design software by using commands on the File menu. The pre-defined size choices for a new template are extensive. The default storage location for templates is specified in Options Manager. If you create a new template, save it in this default location in order for it to be available for drawing creation. The software also includes a set of title block labels that fit the delivered drawing templates. If you create a new template, you can also create a new title block label that fits the title block of your template correctly and that contains the appropriate information. You create labels in Catalog Manager. If you want to create custom border files for your drawing templates, use Intergraph SmartSketch. You can then embed your border file in the new templates you create in SmartPlant P&ID. Once you embed a border file into a drawing template and a drawing is created in Drawing Manager using that template, any changes to the border file are not reflected in drawings created prior to the change. If you link a border file, instead of embedding it, and then subsequently change that border in SmartSketch, changes are reflected automatically in your drawing. Note
•

New Template Command
File > New Template Creates a new blank template. You can specify properties for the new template and embed border files. To create new drawings, an administrator uses Drawing Manager. For more information about creating new drawings, see Drawing Manager Help. Caution
•

Templates created at the user level instead of the plant level are not available to other users or to Drawing Manager for creating subsequent drawings. The path to the plant-level drawing templates is defined in Options Manager.

Before you can edit one of the standard templates included with SmartPlant software, you must verify that you are connected to the correct database and that you do not have any drawings open. For more information about connecting to a database, see Open a Drawing in a Different Database, page 108. .

Working with Drawings: An Overview 3. In the Sheet size box on the Page Setup dialog box, choose a standard size or define a custom size for this template. 4. Click OK. 5. Click File > Properties. 6. On the Units tab of the File Properties dialog box, specify the unit in the Length, Angle, and Area readout boxes in order to define default units of measurement. 7. You can also add general identifying information on the Summary tab. 8. Click OK. 9. Click Edit > Insert > Object. 10. On the Insert Object dialog box, make sure that the Link option is selected. 11. Type the path to the border file, a .igr file, in the Create from file box, or click Browse, find the border file, and click Open. Tip If you want to create custom border files for your drawing templates, use Intergraph SmartSketch. 12. Click OK.
•

13. Click File > Save As and specify a name for your template on the Save As dialog box. Tip The default storage location for templates is specified in Options Manager. Save it in this default location in order for it to be available for drawing creation. 14. Quit the design software.
•

Notes
•

To create a new drawing using a plant template, an administrator uses Drawing Manager. You can also embed your border file in the drawing template if you want to. Once you embed a border file into a template and a drawing is created using that template, any changes to the border file are not reflected in drawings created prior to the change. If you link a border file, instead of embedding it, and then subsequently change that border in SmartSketch, changes are reflected automatically in your drawing.

Edit a Standard Drawing Template Border
Important Before you can edit one of the standard templates included with SmartPlant software, you must verify that you are connected to the correct database and that you do not have any drawings open. For more information about connecting to a database, see Open a Drawing in a Different Database, page 108. 1. Open the design application, but do not open a drawing.
•

Tip You can do this by opening the product from the Start menu or by closing all open documents in the design software if it is already running. 2. In Windows Explorer, find the template you want to edit and drag it into the Design window.
•

Tip Be sure to select a template that matches not only the page size requirements for drawings but also the units of measurement, metric or English, for the plant. 3. Select the existing border file and click Delete while the pointer is in the Drawing view.
•

4. Click Edit > Insert > Object. 5. On the Insert Object dialog box, make sure that the Link option is selected. 6. Type the path to the border file, a .igr file, in the Create from file box, or click Browse, find the border file, and click Open. Tip If you want to create custom border files for your drawing templates, use Intergraph SmartSketch. 7. Click OK.
•

8. Click File > Save. Tip The default storage location for templates is specified in Options Manager. Save it in this default location in order for it to be available for drawing creation. 9. Quit the design software.
•

SmartPlant P&ID User’s Guide 121

Working with Drawings: An Overview Notes
•

You can also embed your border file in the drawing template if you want to. Once you embed a border file into a template and a drawing is created using that template, any changes to the border file are not reflected in drawings created prior to the change. If you link a border file, instead of embedding it, and then subsequently change that border in SmartSketch, changes are reflected automatically in your drawing. For more information about editing other properties of a drawing template or creating a new template, see Create a Drawing Template, page 119

Saving Drawings: An Overview
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 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. 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. Saving Drawings to .cgm Format The Computer Graphics Metafile (.cgm) format provides an efficient way to make information available on the Internet. You can use the Save As command to save drawings in .cgm format. Then, you can place the graphics on a Web page and view them with a browser. CGM is an efficient format for publishing 2D vector drawings on the Web because it uses little storage space, renders quickly, and has the ability to zoom and achieve more detail. These types of drawings can contain embedded hyperlinks, allowing quick access to information outside the drawing. Related Topics • Save a Drawing in a Different Format, page 125 • Save a Drawing or a Drawing Template, page 124 • Switch to Another Open Drawing or View, page 110

SmartPlant P&ID User’s Guide 123

Working with Drawings: An Overview

Save Command
File > Save Stores the active drawing or template. If you have not already named a template, the Save As dialog box opens. Plant location and paths are set in SmartPlant Engineering Manager and Options Manager. Related Topics • Saving Drawings: An Overview, page 123

Save a Drawing or a Drawing Template
•

Click Save Notes

on the main toolbar.

•

If you have not named a template before clicking Save, the Save As dialog box appears. You can type a name and choose a format and location for your template. You cannot open an existing drawing and then decide to save it as a template. An administrator must click File > New Template to create a new template.

Save As Command
File > Save As Opens the Save As dialog box. You can save the active document to a new format. Note When using AutoCAD, your parametric symbols should not be scaled. The graphics will display incorrectly. Related Topics • Save a Drawing in a Different Format, page 125 • Saving Drawings: An Overview, page 123

124 SmartPlant P&ID User’s Guide

Working with Drawings: An Overview

Save a Drawing in a Different Format
1. In Microsoft Excel, open ExportLayer.xls. The location of this Microsoft Excel workbook is specified in Options Manager. 2. Assign level or layer numbers between 10 and 63 to ensure that graphics appear in the designated levels or layers. Tips
•

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.xls.
•

4. In the design software click Tools > Custom Commands. 5. When the Custom Commands dialog box opens, run the ExportLayer.dll macro. This macro is delivered in \Program Files\SmartPlant\P&ID Workstation\Program. Tip When the macro finishes running, a message appears that tells you if all items were assigned layers successfully or if any items lacked the appropriate layer specification. You can edit the Microsoft Excel workbook again if you need to add filters and layers. 6. Click File > Save As.
•

7. On the Save As dialog box, select the drive and folder for the new drawing. 8. In the File Name box, type a new name for the drawing. 9. In the Save As Type box, select the document format that you want to use. Related Topics • Save a Drawing or a Drawing Template, page 124 • Saving Drawings: An Overview, page 123

SmartPlant P&ID User’s Guide 125

Working with Drawings: An Overview

Re-creating Drawings: An Overview
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 (for example, when you click File > Save or when you quit the program). Occasionally, the software can end in an abnormal way (for example, due to power outage). As a result, the database is up-to-date with changes that you posted to the drawing, but the drawing file reflects the status when you last saved the drawing. When you re-open the drawing, the software recognizes that the drawing file is different from the database. The software displays a message box that states One or more items in this drawing are inconsistent with the database. Click OK to re-create the drawing from the database. During the re-create process, the status bar at the bottom of the main window keeps you informed about the particular elements currently reconciling with the database. Also, a log file, Recreate-DrawingName, is created in your Temp folder. You can check this file for irregularities that occur during the re-create process. Caution
•

Do not interfere with the re-create process once started because the drawing can become unusable.

After the re-create process is completed, the software reinitializes your drawing and displays the message Re-create drawing is complete. If a section of the drawing could not re-create successfully an error condition appears on your drawing. Error conditions are always associated with a pipe or signal run, and the symbology is a heavy orange line segment. This portion of the drawing must be updated manually. Delete the heavy orange line segment and components connected directly to it. Then re-route your runs and replace connections and components as required.

Recreate a Drawing
1. Open the drawing that you want to recreate. 2. Place an item in the drawing. 3. Right-click an empty space on your Windows taskbar, and then click Task Manager. 4. Click the Processes tab. 5. In the list, click draft.exe. 6. Click End Process. 7. In SmartPlant P&ID, open the drawing that you opened in step 1. 8. When the software prompts you that a recreate is necessary, click OK to recreate the drawing from the database. 9. Delete the item that you placed in step 2. 10. Save the drawing. Notes
•

Normally SmartPlant P&ID recreates drawings automatically when it detects a discrepancy between the drawing and the database. For more information about recreating drawings, see the Re-creating Drawings section in the SmartPlant P&ID Installation and Upgrade Guide.

Resolve a Re-create Drawing Error Condition
1. Delete all connectors and components that are directly connected to the error condition. 2. Delete the heavy orange lines that make up the error itself. 3. Re-route your pipe or signal run. Tip Keep property breaks in mind as you re-route your lines. 4. Replace connectors and components that you deleted in step 1.
•

Note
•

Error conditions are not required items and therefore do not move to the stockpile when you delete them.

Related Topics • Re-creating Drawings: An Overview, page 126

128 SmartPlant P&ID User’s Guide

Working with Drawings: An Overview

Using Filters: An Overview
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. And you can use filters to find and replace items. You can create filters to control the display of hierarchy items in Drawing Manager. These filters are not saved to any folder in Filter Manager, but the methods of creating these filters are the same as those for creating filters saved in Filter Manager. Note
•

If you are using a workshare environment and you are at a satellite site, do not create Project Filters at a satellite site. However, you can always create My Filters in the Filter Manager or Select Filter dialog box environment.

Creating P&IDs in SmartPlant P&ID: An Overview
With SmartPlant® P&ID, you can easily perform the tasks required to create a detailed plant model. You can place components such as equipment, piping, and instrumentation from Catalog Explorer or the stockpile into graphical representations of your plant model in the drawing. SmartPlant P&ID provides multiple views of a central, unified data structure that represents the plant model. 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. A view is a visual presentation of the data that composes the plant model. A view can be a schematic drawing, a table, or a report. One key feature of SmartPlant P&ID is using catalogs to create instances of components within the plant model. The standard modeling environment lets you place items from the catalog into the appropriate model views. If you repeatedly place particular groups of items, you can save the group of items as an assembly. Assemblies appear as symbols in the Catalog Explorer List view so you can place them exactly as you place other symbols in your List. In the Properties window, you can add values for various properties of each item after you place it in your drawing. You can also annotate your drawing with labels as you design the drawing. As you work on your drawing, you can monitor any inconsistencies in your design by reviewing the inconsistency indicators. These indicators appear in your drawing as soon as an inconsistency occurs in the design. You can resolve inconsistencies using solutions from the Consistency Check dialog box. Additionally, you can generate reports to help you keep track of information in the drawing. For example, after you finish the drawing, you can generate order lists for the components in the drawing. You can print the drawing, if necessary. Related Topics Create an Assembly, page 282 • Define a New Engineering Data Editor View, page 54 • Generate a Report, page 334 • Open a New Drawing View, page 39 • Print a Drawing, page 365 • Review an Inconsistency, page 320
•

130 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Understanding Database Constraints
The following database constraints improve the integrity of the data associated with your design.
•

Foreign Key - Insures that the corresponding value, unless it is null, exists in the table referenced by the foreign key. This type of constraint is used to enforce logical relationships, such as the plant item to plant group relationship. Foreign Key in conjunction with Not Null - Enforces group relationships, such as the case to model item relationship. This constraint is similar to the Foreign Key constraint described above, but does not allow null values to persist. Foreign Key with Not Null and Unique - Enforce all subclass and one-toone relationships, such as the pairing of OPCs. This constraint is similar to the Foreign Key constraint described above, but does not allow null values to persist and requires that all values be unique.

•

•

The constraints so far described serve to enforce relationship integrity. Since the relationship, the object and the foreign key it points to, already exists in the database or is created during your transaction, the constraints are satisfied without changing the scope of your transaction.
•

Check - Used for more complex data integrity controls, such as monitoring conditions on multiple items. For example, History records can pertain to either a drawing or the model. Either of these objects can be null, but not both of them. A Check constraint enforces this condition by using comparisons and exclusions. Another candidate for a Check constraint is the enforcement of certain values for one or more items. For example, invalid null or zeroes assigned to properties are tested against Check constraints.

SmartPlant P&ID User’s Guide 131

Creating P&IDs in SmartPlant P&ID: An Overview

Selecting Drawing Items: An Overview
To select an item, you can use the Select Tool on the main toolbar. You can select pipe routes, equipment, valves, labels, and so forth, and you can select item groups, assemblies, or embedded or linked objects. Selecting Single Items To select an item, click the Select Tool on the main toolbar. When you click the Select Tool, the pointer changes to an arrow with a locate zone indicator at the end: . As you pause on items in a drawing, the items appear in the highlight color. When an item is highlighted, click to select it. When you select an individual item, the following things happen:
•

The item changes to the selection color. You can change the selection color with the Options command on the Tools menu. The handles of the item appear if the item has handles. Handles are solid squares at significant positions on a selected item, such as end points and center points. Handles allow you to directly modify the item, such as dragging a handle to change the shape of the item. Although you can select more than one item at a time, only one item can have handles at a time. If the item is linked or embedded into the current drawing, selecting it allows you to double-click it for editing.

•

•

When you select multiple items or grouped items, the items change to the selection color. You can also select drawing items by first selecting them in the Engineering Data Editor. The corresponding items are selected in the Drawing view if they reside in the active drawing. Selecting Multiple Items and then You can select more than one item at a time by clicking Select Tool holding Shift or Ctrl as you click the items that you want to select. Additionally, you can click the Select Tool and then drag to fence items. You can use the Select Tool ribbon to choose if you want to select only items completely enclosed by the fence or any item that is partly enclosed by the fence. Many manipulation commands, like Delete, Move, Copy, and Rotate, can act upon all items in the select set.

132 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview 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. Canceling the Selection of Items To cancel the selection of an item or group of items, click any empty point on the drawing. Selecting Items for Placement To place an item in a drawing, you select it in Catalog Explorer or the stockpile. Then you click to select the position in the drawing to place the item. You cannot select more than one item for placement in a drawing at a time. After placement, you can select another item or press Esc to quit placement mode. Or, you can escape placement mode by right-clicking. Related Topics • Move an Item With the Select Tool, page 209 • Select an Item, page 135

Select Tool Command
Changes the pointer to the arrow-shaped selection pointer so you can select, modify, and manipulate items. The circle at the end of the pointer arrow is the locate zone. While the Select Tool is active, the Select Tool ribbon is displayed. Related Topics Copy an Item With the Select Tool, page 240 • Modify an Item With the Select Tool, page 235 • Move an Item With the Select Tool, page 209 • Select an Item, page 135 • Selecting Drawing Items: An Overview, page 132
•

SmartPlant P&ID User’s Guide 133

Creating P&IDs in SmartPlant P&ID: An Overview

Select Tool Ribbon
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. Note
•

To find out the name of an option on the ribbon, pause the pointer over an option and read the ToolTip.

Configuration (PickQuick) Tool
In addition to using the manipulation handles to orient an item after you place it, you can use PickQuick to select the orientation of some items, such as check valves or flow arrows or other inline items, when you are placing them. Pausing after you drag the item to the appropriate place in the drawing activates the Configuration tool, if it is available for the selected item, and allows you to select the proper orientation for the item.

Related Topics • Place a Flow Arrow, page 181 • Place an Item from Catalog Explorer, page 66 • Place an Item With the Configuration (PickQuick) Tool, page 137

134 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Select an Item
1. On the main toolbar, click the Select Tool 2. Do one of the following:
• • • •

.

To select one item, click it. To select more than one item, hold Shift or Ctrl and click each item. To select more than one item at once, drag to fence the objects.

To select one of several overlapping items, use PickQuick. 3. To clear the selection of an item or items, do one of the following:
• • • •

Click in an empty portion of the drawing. Right-click in an empty portion of the drawing. Select another item without holding Shift or Ctrl. To clear the selection of one item and leave other items selected, click the item while holding Shift or Ctrl.

Notes
•

When the Select Tool is active, selectable items are highlighted as you pass the pointer over them. When the item you want to select is highlighted, click to select it. Click Tools > Options to change the item highlight and selection colors and locate and break-away tolerances. To select all items in a drawing, right-click a blank area in the drawing and click Select All on the shortcut menu, or, to accomplish the same thing, press Ctrl + A or click Edit > Select All. You can also select items in the Engineering Data Editor. If they reside in the active drawing, they are selected in the Engineering Data Editor. You can build up a select set using this method, too.

Select an Item Using the Configuration (PickQuick) Tool
1. Pause the pointer over the item you want to select. 2. When the pointer appears with ellipses, as illustrated below, click.

3. On the PickQuick toolbar, that appears near the pointer, move the pointer over the numbered PickQuick buttons, without clicking, to highlight the corresponding items.

The first item is highlighted.

The second item is highlighted. 4. When the item you want to select is highlighted, click the corresponding button on the PickQuick toolbar. Note
•

PickQuick helps you to select items that overlap each other. PickQuick also helps you place items when multiple possible placement configurations exist. For more information, see Place an Item With the Configuration (PickQuick) Tool, page 137

Related Topics • Selecting Drawing Items: An Overview, page 132

136 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Place an Item With the Configuration (PickQuick) Tool
1. Drag the item to the appropriate position on the line or equipment. 2. Pause until ellipses appear beside the pointer: .

3. Click to display the Configuration toolbar near the pointer.

1. Move the pointer over each toolbar button to preview the available orientations. 2. When the appropriate orientation displays, click the corresponding button on the Configuration toolbar to place the item in that orientation. Note
•

You can right-click in an empty portion of the drawing or press Esc to close the Configuration toolbar, or you can close it by clicking X in the upper right corner of the toolbar.

Placing Items on a Grid: An Overview
The grid and its lines allow you to place items in the drawing by aligning them with the grid lines or nearest intersection of the grid lines. You can use the grid if you want the items to line up at regular intervals in the drawing. The grid is an set of imaginary lines in the drawing; they do not appear when you print the drawing. When you click View > Snap grid, items always align with the grid lines or nearest intersection of the grid lines. You can view the grid by clicking View > Show grid. You can change the display of the grid from static to dynamic by setting options on the Grid tab of the View Properties dialog box. To view grid lines at a finer level, set the style to dynamic and adjust the density. The grid lines for a dynamic grid move as you zoom in or out in a view. You can set dynamic grid lines to appear at fine, medium, or coarse levels. The grid lines appear at common major measurement increments. A dynamic grid displays index lines that intersect with the darker, solid grid lines. A static grid displays solid grid lines that do not move as you zoom in or out. You can specify the increment settings on the Grid tab of the View Properties dialog box. Note
•

You do not have to display the grid in order to snap items to it.

Related Topics • Change the Properties of a Drawing View, page 37

Show Grid Command
View > Show Grid Displays a grid so you can place items with precision. The grid is not considered part of the drawing and does not print. Note
•

You can change the grid display from static to dynamic by setting options on the Grid tab of the View Properties dialog box, which opens when you click View > Properties.

Snap Grid Command
View > Snap Grid Aligns items with the grid. The grid is a set of lines in the drawing background that helps you align items. When you set the Snap grid option, items always align with the grid lines or nearest intersection of the grid lines. Grid lines do not print. Note
•

You can change the grid display by setting options on the Grid tab of the View Properties dialog box, which opens when you click View > Properties. To view grid lines at a finer level, set the style to Dynamic and adjust the grid line width with the Density control.

Placing Equipment: An Overview
You can place various types of equipment in your drawing, such as towers, boilers, heat exchangers, and reactors. You also place equipment components in drawings. Equipment components are items associated with pieces of equipment, such as nozzles and trays. As you place equipment components, the software automatically creates a group relationship between the equipment and the component. As a group, the components move when you move the equipment. However, you can only associate an equipment component with a single piece of equipment. When you place an equipment component, the component is associated with the last selected or highlighted piece of equipment, creating an equipment group. Depending on the rules defined for the equipment or equipment component, you can have limits to the possible placements for the equipment. For example, specific trays can be flagged for placement inside the piece of equipment, and nozzles can be flagged for placement outside the piece of equipment. Rule Manager defines rules that determine the way that model items interact during manipulation. The software includes a standard group of equipment and equipment component symbols. However, you or your plant administrator can change and add to these symbols as needed for your plant. Related Topics • Assign Heat Tracing, page 151 • Place Equipment, page 140 • Place Multiple Representations, page 142

Place Equipment
1. In the Catalog Explorer list view, click the equipment that you want to place. 2. Drag the item to the appropriate place in the drawing. 3. Position the item and release to place it. Tip In addition, you can click the item in the Catalog Explorer list view and then click the appropriate point in the drawing to place the item. Press Esc to quit placement mode. Or, you can escape placement mode by right-clicking. 4. In the Properties window, enter values for the equipment properties in the appropriate rows in the table.
•

140 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Tip
•

You can assign heat tracing to equipment. For more information, see Assign Heat Tracing.

Notes
•

After you place items, you can mirror, rotate, or move most items using their component handles. For more information, see Mirror an Item About an Existing Mirror Axis or Linear Element, page 229 Rotate an Item Using Its Rotate Handle, page 231 Move an Item Using the Move Button, page 210

•

If the Properties window is not displayed, you can display it by selecting the item and then selecting Edit > Properties on the main menu bar. Flanged Nozzle-Internal, Nozzle-Internal, and Pump Nozzle-Internal can all be placed internally (for example, in a tank). You can use the same steps for placing equipment. For internal placement of equipment, you drag the nozzle to the interior of a tank and place it. If you want the nozzle opening facing to the right, approach the tank from the right when placing the nozzle. In other words, the opening of the nozzle will be placed in the direction that you approach the tank during placement. If you need to place a nozzle so that it is associated with equipment but not attached to it, you can do the following. 1. Attach the nozzle to the equipment that you want it related to. 2. Select the nozzle. 3. While holding down the Alt key, drag the nozzle an arbitrary distance away from the equipment.

Place Multiple Representations
1. Open a drawing and place an item of equipment. 2. Save your work and exit the drawing. 3. Open the drawing that is a target for your multiple representation (parent-child representations) of an item. Be sure the drawing used in step 1 is closed. Tip A multiple representation allows the depiction of an item from another drawing in a detailed or alternate view. You can think of a multiple representation as a child item associated with the parent item that already exists in another drawing. 4. Display the parent item in the Engineering Data Editor.
•

Tips
•

You can find the parent item in the Engineering Data Editor by clicking the Other Drawings button . You can choose a filter from the list using the Engineering Data Editor. Select a filter that best describes the type of item you want to represent (for example, Equipment - Vessels).

You can also open a tabular view of your target drawing in the Design window by clicking Window > New > Engineering Data Editor. 5. In the Engineering Data Editor, right-click the icon at the far left of the parent item.
•

142 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview 6. Select Place Multiple Representation from the shortcut menu.

7. Click the location in the drawing where you need to place the multiple representation. Notes
•

You can use the Replace command or the Find and Replace dialog box to replace a multiple representation symbol providing the definition attributes for the source (parent) and target (child) are identical. The definition attributes are Equipment Class, Equipment SubClass, and Equipment Type. You are permitted only a single representation of an item in any one drawing. If you are working in a project, be aware that multiple representations are constrained because of claiming and moving drawings between projects and the Plant.

Routing Lines: An Overview
Whether you are routing pipe or signal lines, you can manipulate all lines by using the same basic procedures. After you select a type of line route from the Catalog Explorer list view, use the commands on the Line Routing ribbon to help construct or modify the line. Lines consist of a series of line segments. The software places handles, represented by black squares or dots, at each segment vertex along the line route. You can use these vertex handles to move, reroute, or connect lines. You can add vertices to add segments to the line using the commands on the Line Routing ribbon. The software also provides a shortcut menu associated with lines. Right-click a line and choose from several commands. You use this menu to break runs or join runs. You can also use this menu to construct select sets of pipe runs. Line Connectivity When a new pipe run is placed such that it connects to existing pipe runs at either end, those pipe runs are automatically joined together if they have the same properties. The symbol placement command creates a new line when an inline component is placed directly up against an existing nozzle or other inline component. The pipe run created in this way has a zero length connector that attaches the two symbols. Pipe runs that only have zero length connectors are aggressively joined up with the pipe runs they attach to; the properties for pipe runs with zero length connectors need not match. The zero length pipe run that gets created when one inline component is placed directly up against another inline component is automatically joined to the existing pipe run, too. When a new pipe run is placed that starts or ends at a component that belongs to an existing pipe run, the new pipe run is automatically joined with the existing pipe run. When a new pipe run is placed that starts or ends at the endpoint of an existing connector, the two pipe runs are joined and the new connector is actually merged with the existing connector. The automatic joining takes place in the same way for both placement and modification of connectors. At the time that the connection is made, the two pipe runs are tested for compatibility. If they pass the property criteria, they are automatically joined together. If two pipe runs have different properties, they are not automatically joined together. If you want them joined together, the Join Runs command is still available for this purpose. Of course when two pipe runs with differing properties are joined into one, the properties of the surviving pipe run are retained and the others are lost. Similarly, if you must define two different properties for two parts of a single pipe run, then the pipe run must be broken. The Break Run command is still available for this purpose.

144 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Pipe runs always consist of a linear sequence of members and never include any branches. Placing a pipe run that branches off of an existing pipe run does not cause them to be joined together. Reducers are always located at the end of a pipe run and never in the middle. Placing a new pipe run that connects to a reducer does not cause the pipe runs to be joined. Auto Join Pipe runs are automatically joined together whenever possible. When a new pipe run is placed, and it connects to existing pipe runs at either end, those pipe runs are automatically joined together if they have the same attribute values. Pipe runs that only have zero length connectors are joined with the pipe runs they attach to. (The attribute values for pipe runs with zero length connectors do not need to match.) This means that both the bottom-up and the top-down approaches produce the same final result. When a new pipe run is placed that starts or ends at a component that belongs to an existing pipe run, the new pipe run is automatically joined with the existing pipe run. When a new pipe run is placed that starts or ends at the endpoint of an existing connector, the two pipe runs are joined and the new connector is actually merged with the existing connector. The automatic joining takes place in the same way for both placement and modification of connectors. At the time the connection is made the two pipe runs are tested for compatibility. If they pass the attribute criteria, they are automatically joined together. The zero length pipe run that is created when one inline component is placed directly up against another inline component is automatically joined to the existing pipe run. Pipe runs always consist of a linear sequence of members and never include any branches. Placing a pipe run that branches off of an existing pipe run does not cause them to be joined together. Reducers are always located at the end of a pipe run and never in the middle. Placing a new pipe run that connects to a reducer does not cause the pipe runs to be joined.

SmartPlant P&ID User’s Guide 145

Creating P&IDs in SmartPlant P&ID: An Overview If two pipe runs have different attribute values, they are not automatically joined together. If you want them joined , the Join Runs command is to be used. When two pipe runs with differing attribute values are joined into one, the attributes of the surviving pipe run are retained and the others are discarded. Similarly, if you must define two different attribute values for two parts of a single pipe run, then the pipe run must be broken. The Break Run command is used. Note
•

All of the above information about pipe runs also applies to signal runs.

Line Routing Ribbon
Appears when you select a line element from the Catalog Explorer list view or the Engineering Data Editor or when you select an existing line in a drawing. You can dock the Line Routing ribbon in the main toolbar; it remains there for the current design session unless you move it again. Diagonal Mode (Alt) - Select the Diagonal Mode button or press the Alt key to route lines in any direction, instead of the usual constraint of horizontal or vertical line routing. This procedure is usually popular with signal and utility lines, but you can use it for any line routing. Insert Segment Mode (Shift) - Select the Insert Segment Mode button or press the Shift key to insert line segments instead of routing new lines or instead of moving existing lines. Break Run - Allows you to break a pipe run. After you break the run, select the pipe run and select Edit > Properties to enter or change any property values. Join Runs - Allows you to join two pipe runs. The properties of the pipe run after using Join Runs will be the values of the pipe run you selected first. Related Topics • Insert Line Segments into an Existing Line, page 149 • Move a Line, page 211 • Start a Line from a Connect Point, page 148 • Start a Line in Free Space, page 147

146 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Route a Line
1. In the Catalog Explorer list view select the line that you want to place. Tips
•

This action displays the Line Routing ribbon and starts line placement mode.

Press Alt while routing a line or click Alter Segment on the Line Routing ribbon to override the current line vector and allow routing in any direction and at any angle. 2. Click a connect point on an item in the drawing.
•

Tip You can click an empty point in the drawing to start the line, too. 3. Click to place the vertex at the next point in the line.
•

4. Continue clicking to place the vertices of the line in the drawing. 5. When the line is complete, right-click to confirm the placement. Tip
•

You can escape line placement mode by right-clicking two more times.

Related Topics • Routing Lines: An Overview, page 144

Start a Line in Free Space
1. In the Catalog Explorer list view or the Engineering Data Editor, click the line that you want to place. Tip Press Alt while routing a line or click Alter Segment on the Line Routing ribbon to override the current line vector and allow routing in any direction. 2. In the drawing, click the starting point for the line route.
•

3. Click the location for each vertex of the line, including the termination point. 4. When you complete the line route, right-click to place the line. Tip
•

If you want to route the line to a connect point of an existing item, click the connect point of the appropriate item to place the line.

SmartPlant P&ID User’s Guide 147

Creating P&IDs in SmartPlant P&ID: An Overview Notes
•

You can define values for the properties of a line by clicking the line and then entering the values in the appropriate rows in the Properties window. If the Properties window does not appear, you can display it by clicking the line and then selecting Edit > Properties.

•

Related Topics • Routing Lines: An Overview, page 144

Start a Line from a Connect Point
1. In the Catalog Explorer list view, click the type of line that you want to place. 2. In the drawing, click the connect point from which you want to start routing your line. 3. Click the location for each vertex of the line route. 4. When you complete the line route, right-click to place the line. Notes
•

To stop placing lines in the drawing, press Esc to quit line placement mode. Or, you can escape line placement mode by right-clicking two more times after the final right-click in the last step above. Press Alt while routing a line or click Alter Segment on the Line Routing ribbon to override the current line vector and allow routing in any direction and at any angle. You can define values for the properties of a line by clicking the line and then entering the values in the appropriate rows in the Properties window. If the Properties window is not displayed, you can display it by clicking the line and then selecting Edit > Properties on the main menu bar.

•

•

•

Related Topics • Routing Lines: An Overview, page 144

148 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Insert Line Segments into an Existing Line
1. In the drawing, select the existing line that you want to insert a segment into. 2. On the Line Routing ribbon, click Insert Segment Tip Instead of clicking Insert Segment, you can hold Shift while moving a line to insert segments. 3. Drag the selected line to the new position.
•

.

Notes
•

The line remains selected until you click another item or command. Press Esc to stop adding segments. You can join two pipe runs that have different property values. The resulting pipe run has the properties of the pipe run that you selected first. You can change values for properties of the line by clicking the line and then entering the values in the appropriate rows in the Properties window. If the Properties window is not displayed, you can display it by clicking the line and then selecting Edit > Properties on the main menu bar.

•

•

•

Related Topics • Routing Lines: An Overview, page 144

Insert a Vertex into an Existing Line
1. Select the line that you want to add a vertex to. 2. Point near the center of the line where you want the new vertex. 3. When the pointer turns into a double arrow to the appropriate location. Notes
•

, press Alt and drag the new vertex

You can also insert line segments into an existing line. For more information, see Insert Line Segments into an Existing Line, page 149. You can also break a line at a point. For more information, see Break a Pipe Run, page 153.

•

Related Topics • Routing Lines: An Overview, page 144

SmartPlant P&ID User’s Guide 149

Creating P&IDs in SmartPlant P&ID: An Overview

Branch from an Existing Line
1. In the Catalog Explorer list view, click the type of line that you want to place. 2. In the drawing, click a point on an existing line route to begin placing the branch. 3. Click to place each vertex of the line branch. 4. When you complete the line, right-click to place it. Notes
•

Press Alt while routing a line or click Alter Segment on the Line Routing ribbon to override the current line vector and allow routing in any direction and at any angle. To stop placing lines in the drawing, press Esc to quit line placement mode. Or, you can escape placement mode by right-clicking two more times after the final right-click in the last step above. You can extend a line to an existing line to create another branch point. You can change values for the properties of the line by clicking the line and then entering the values in the appropriate rows in the Properties window. If the Properties window is not displayed, you can display it by selecting the line and then clicking Edit > Properties on the main menu bar.

•

• •

•

Related Topics • Routing Lines: An Overview, page 144

Branch to an Existing Line
1. In the Catalog Explorer list view, click the type of line that you want to place. 2. In the drawing, click the starting point for the branch. 3. Click to place each vertex of the line branch. 4. To complete the line route, click a point on the existing line where you want to end the branch. Notes
•

The starting point for a branch can be a point in free space, a point on an existing line, or a connect point on an item in the drawing. Press Alt while routing a line or click Alter Segment on the Line Routing ribbon to override the current line vector and allow routing in any direction and at any angle. To stop placing lines in the drawing, press Esc to quit line placement mode. Or, you can escape line placement mode by right-clicking two more times after the last step above.

•

•

150 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview
•

You can change values for the properties of the line by clicking the line and then entering the values in the appropriate rows in the Properties window. If the Properties window is not displayed, you can display it by clicking the line and then selecting Edit > Properties on the main menu bar.

•

Related Topics • Routing Lines: An Overview, page 144

Add a Manual Gap to a Line
1. Select the appropriate gap from the Catalog Explorer. 2. On the line, click the position for one side of the gap. 3. Then on the same line, click the position for the other side of the gap. Note
•

Gaps are parametric symbols. You can resize the gap by dragging the parametric handles. For more information on resizing parametric symbols, see Scale a Parametric Item, page 226.

If you have already specified insulation properties for the item, then you cannot subsequently assign heat tracing properties. If you assign heat tracing to an item before you assign insulation properties, your choices of insulation properties and specifications are restricted. You choose the HT Medium and HT Requirement properties from select lists. You choose the units for the HT Medium Temp property when you assign the temperature value. Select list values are defined in Data Dictionary Manager; Format Manager contains definitions for temperature units.

Break Run Command
Line Shortcut Menu > Break Run Enables you to break a pipe run at an arbitrary location. After selecting this command from the Line shortcut menu, click the line at the point you want the break it. Related Topics • Break a Pipe Run, page 153 • Routing Lines: An Overview, page 144

Break a Pipe Run
1. In the drawing, right-click the pipe run that you want to break. 2. On the shortcut menu, click Break Runs. 3. In the drawing, click the point where you want to break the run. Tip
•

The software breaks the selected pipe run into two separate runs at the selected point.

Notes
•

You can change values for the properties of the new run by clicking it and then entering the values in the appropriate rows in the Properties window. If the Properties window is not displayed, then you can display it by clicking the line and then selecting Edit > Properties.

Join Runs Command
Line Shortcut Menu > Join Runs Enables you to join two lines together into one pipe run. After selecting this command from the Line shortcut menu, click on the line that you want to join to the selected line. Related Topics • Join Pipe Runs, page 154 • Routing Lines: An Overview, page 144

Join Pipe Runs
1. In the drawing, right-click the first pipe run that you want to join. 2. On the shortcut menu, click Join Runs. 3. In the drawing, click the second pipe run to join the two runs. Notes
•

If you join two pipe runs with different properties, the resulting pipe run has the properties of the pipe run that you selected first. For information about breaking runs, see Break a Pipe Run, page 153. You can change values for the properties of the new run by clicking the pipe run and then entering the values in the appropriate rows in the Properties window. If the Properties window does not appear, you can display it by clicking the line and then selecting Edit > Properties on the main menu bar.

• •

Related Topics • Routing Lines: An Overview, page 144

154 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Using Piping Components: An Overview
Piping components are graphic elements that represent processes or functions within a particular piping segment. Piping components include valves, flanges, reducers, and strainers. In drawings, piping components are connected with lines. Generally, piping components automatically orient themselves when you drag them near an existing pipe segment. For example, if you drag a horizontal valve to a vertical pipe, the valve automatically orients itself vertically. If several possible orientations exist for the piping component, you can use the Configuration tool, or PickQuick, to review the possible placements for the component and select a final orientation for the item. Rule Manager defines rules that determine the way that model items interact during manipulation. As you place piping components, the software automatically creates a relationship between the pipe route and the component to create a pipe run. When you move the pipe run, the pipe route and the associated piping components both move. Your plant administrator can modify the relationships between piping components and piping in Rule Manager. The software includes a standard group of piping component symbols. However, your plant administrator can change and add to these symbols in Catalog Manager as needed. Related Topics Assign Heat Tracing, page 151 • Place a Piping Component, page 155
•

Place a Piping Component
1. In the Catalog Explorer list view, click the piping component that you want to place. 2. Drag the item to the appropriate pipe run in the drawing. 3. Position the item and release. 4. In the Properties window, enter values for the properties of the piping component in the appropriate rows in the table. Tip
•

If the Properties window does not appear, you can display it by selecting the component and then selecting Edit > Properties.

SmartPlant P&ID User’s Guide 155

Creating P&IDs in SmartPlant P&ID: An Overview Notes
•

As you drag piping components over a pipe run, or the pointer passes over runs while you are in placement mode, the pipe run is highlighted. If you place a piping component when a pipe segment is not highlighted, the piping component is placed in free space if the placement rules allow the action. If the item that you place has multiple possible orientations in relation to other items, you can use the Configuration tool, or PickQuick to select the appropriate placement for the item. If you want to be able to place two inline components an arbitrary distance apart, regardless of minimum distance settings in Options Manager, do the following. 1. Place the first component in the line. 2. Place the second component into the line and connected to the connect point of the first component on the end that you want to attach to. You can see that the connect points are actually joined by the black rectangle in the Drawing view:

•

•

3. While holding down the Alt key, drag one component along the line away from the other leaving the desired distance between the two. If the components are already close to each other but not connected at coincident connect points, you must drag one off of the segment to disconnect it and then move it back to get the connect points attached.
•

If you want to move a piping component but preserve its connection to the pipe run, you can use the Alt key as you drag the component. Then even if you drag the component away from the line, the line routes itself so as to preserve its connection to the component.

Using the PipeSpec Utility: An Overview
The Piping Specification utility works with PDS 3D or SmartPlant 3D to validate the piping materials class with the temperatures, pressures, and diameters assigned to the pipe run and to search commodity codes and fabrication categories for piping components. The database tables and library files in the 3D product provide source information for the validation and search. The service limits validation and automatic commodity code lookup can be disabled simultaneously using a switch in Options Manager. For more information about modifying the PipeSpec settings, see Options Manager Help. For more information about using the Piping Specification utility with SmartPlant 3D, refer to the SmartPlant P&ID Installation and Upgrade Guide for details about installing SmartPlant 3D Piping Specification Remote Access Client. In Data Dictionary Manager, the ValidateNomDiam.ForeignCalc program ID, which is assigned to the Nominal Diameter property, starts the Piping Specification utility and triggers the commodity code and fabrication category lookups when a nominal diameter is changed. For more information about assigning program IDs, see Data Dictionary Manager Help. PDS 3D Files Used For PipeSpec
• • • •

Performing Service Limits Validation The Piping Specification utility verifies that the temperatures and pressures assigned to a pipe run comply with the service limits associated with the selected Piping Materials Class. In continuous validation mode, which is activated by assigned settings in Options Manager, this verification occurs each time that you modify either the Piping Materials Class or a temperature – pressure pair in the process case data of the pipe run. The Service Limits validation requires at least one complete temperature-pressure pair from among design, alternate design, operating, and alternate operating cases. If any temperature-pressure pair violates the service limits of the selected Piping Materials Class, a warning displays the appropriate pairs. This warning appears in the design software by appending an error string to the name of the PMC.

SmartPlant P&ID User’s Guide 157

Creating P&IDs in SmartPlant P&ID: An Overview Performing Commodity Code and Fabrication Category Look Up The Piping Specification utility looks up the Commodity Code and Fabrication Category properties of inline piping components. In the continuous validation mode, this lookup occurs each time the Piping Materials Class or any of the four case Max temperatures (Design, Alternate Design, Operating, and Alternate Operating) are modified on the pipe run. Validation also occurs each time the Option Code or Nominal Diameter of the component is modified. If the modification occurs on a property of a piping component, then the lookup is restricted to that particular component, but if the modification occurs on a property of a pipe run, then the lookup encompasses every piping component on that run. The minimum requirements to cause a lookup are that the piping component must be in a pipe run, that the PMC of the pipe run must be populated and comply with service limits, and that the nominal diameter of the piping component must be specified. If the PMC is assigned but does not comply with the service limits, then the Commodity Code property displays an error message. The PipeSpec utility uses process case temperatures of the run during the commodity code lookup only if the code for that component has a maximum temperature limit value in the 3D database. For example, in PDS 3D, a value of -9999 for maximum temperature in pdtable_202 indicates a null value, and the process case temperatures on the pipe run are ignored for the lookup. If a maximum temperature exists for that component, then the lookup insures this value is larger than all of the process case temperatures assigned to the pipe run in which the piping component resides. Note
•

The units for the PDS 3D maximum temperature are those specified in Options Manager.

If any temperature values for the pipe run are unspecified, then a value of zero Deg-K is assumed for each of the unspecified temperatures. If multiple records are obtained in the lookup, then the utility returns a commodity code only if all of the records have the same code value. If not, an error is recorded in the error-log file with the appropriate message. 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 3D databases. The Commodity Name is a unique name for every symbol. In PDS 3D, this unique name is the AABBCC Code property. SmartPlant symbols are assigned the same AABBCC Code properties in Catalog Manager.

158 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Similarly, the Option Code property is a select list of text values in SmartPlant P&ID, while it is a set of code numbers or indices in PDS 3D. Short Value for the Option Code select list contains the PDS 3D indices corresponding to the appropriate Option Code text in SmartPlant P&ID. The PipeSpec utility uses the entries in the Short Value box of the Option Code list to obtain the Option Code used in the PDS 3D database tables. Note
•

Error messages are placed in the PipeSpecError.log file in the directory assigned to the TEMP environment variable. Error messages help you identify the cause of failure when the utility does not complete the tasks as expected. For example, if minimum requirements are not met for the lookup, the missing properties are listed in the log file. The ServiceLimits.log file contains any errors encountered during the Service Limit Validation process, which runs as part of the PipeSpec Utility.

•

Related Topics • Assign a Commodity Code to a Piping Component Using PipeSpec, page 161 • Assign a Piping Materials Class to a Pipe Run Using PipeSpec, page 160

Piping Specifications Dialog Box
Opens when you click the Calc button for the Piping Materials Class property (PMC) for a pipe run in the Properties window, and allows you to choose a PMC from a piping specification. This functionality is not available unless the proper settings are defined in Options Manager and the applicable Program IDs are assigned in Data Dictionary Manager. For more information about Piping Specification configuration, you can refer to the SmartPlant P&ID Installation Guide by clicking Help > Printable Guides. Piping materials class - Lists the PMCs in your piping specification. Choose one, and depending on the settings in Options Manager, property validation for piping segments and inline components is run. This can include checking service limits. Related Topics • Assign a Commodity Code to a Piping Component Using PipeSpec, page 161 • Assign a Piping Materials Class to a Pipe Run Using PipeSpec, page 160

SmartPlant P&ID User’s Guide 159

Creating P&IDs in SmartPlant P&ID: An Overview

Assign a Piping Materials Class to a Pipe Run Using PipeSpec
Important The PipeSpec utility is not available unless the appropriate settings and program IDs are assigned in Options Manager and Data Dictionary Manager, respectively. For more information, see those Help files. 1. Select the pipe run.
•

2. Select the Piping Materials Class property for the pipe run in the Properties window. 3. Click the Calc button . 4. On the Piping Specifications dialog box, choose the appropriate PMC from the list and click OK. Tip
•

Based on the chosen PMC and other assigned properties, such as Nominal Diameter, Maximum Design Pressure, Maximum Design Temperature, and so forth, the PipeSpec utility copies properties and checks limits in the entire run, including inline components.

Notes
•

If you subsequently assign nominal diameters to inline valves or other components, SmartPlant P&ID assigns commodity codes and fabrication categories to them that correspond to the PMC of the pipe run and the specifications in your 3D databases. If you choose a diameter, for instance, that does not exist for the assigned PMC, then the commodity code property becomes Not In Spec. If you choose temperature-pressure limits for process cases that do not agree with the assigned PMC, then the error Service Limits Error is added to the PMC for the run. Given the appropriate settings in Options Manager and Data Dictionary Manager, you can manually assign commodity codes to inline components, and the PipeSpec utility looks up accepted diameters and validates the assignment. For more information, see Assign a Commodity Code to a Piping Component Using PipeSpec, page 161.

•

•

Related Topics • Using the PipeSpec Utility: An Overview, page 157

160 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Assign a Commodity Code to a Piping Component Using PipeSpec
Important The PipeSpec utility is not available unless the appropriate settings and program IDs are assigned in Options Manager and Data Dictionary Manager, respectively. For more information, see those Help files. 1. Select an inline component that belongs to a pipe run whose piping material class has been defined. For more information on assigning a PMC, see Assign a Piping Materials Class to a Pipe Run Using PipeSpec, page 160.
•

2. In the Properties window, define the Nominal Piping Diameter property for the component. Tip
•

You can verify that a commodity code and fabrication category have been assigned in the Properties window, or you can open the error log, PipeSpecError.log, if properties have not been assigned as expected. For more information about the error log, click Related Topics.

Notes
•

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 produces the error Error in PMC in the commodity code for an inline component. For information about the settings required for continuous service limits validation, see Options Manager Help. With continuous validation, not only is the commodity code defined automatically, but so it the Fabrication Category property for the inline components, given that the relationship exists in the 3D databases. Adding or changing the option code can change the commodity code, if the relationship is defined in your 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.

•

•

•

Related Topics • Using the PipeSpec Utility: An Overview, page 157

SmartPlant P&ID User’s Guide 161

Creating P&IDs in SmartPlant P&ID: An Overview

Placing Instrumentation: An Overview
You can place various types of instrumentation in your drawing, such as orifice plates, flow controllers, and pressure regulators. Instruments are devices used directly or indirectly to measure or control a variable, such as flow or temperature, in a plant process. Instruments can be items such as flow control elements, computing devices, or electrical switches. Two types of instruments exist: inline instruments and offline instruments. Signal lines are intelligent line strings that connect offline instruments, inline instruments, and piping. Inline Instruments Inline instruments are components that you can insert into a piping segment. Inline instruments include instrument valves, such as pressure regulator valves, flow controllers, flow indicators, and other instrument components, such as orifice plates. As you drag inline instruments over a pipe segment, the pipe segment appears selected. If you place an inline instrument when a pipe segment is not selected, the instrument is placed in free space. Offline Instruments Offline instruments are components that you do not insert into a piping segment. Typically, these instruments monitor and control inline instruments. Offline instruments include flow controllers, level gauges, and system functions such as digital control stations or computers. Instrument Loops You can create instrument loops containing any combination of inline and offline instruments. Instruments loops are a group of one or more instruments or control functions arranged so that signals can transfer from one function to the next to measure and control a process variable. The software includes a standard group of instrument and instrument loop symbols; however, your plant administrator can change and add to these symbols as your plant requires. Related Topics Add Instruments to a Loop, page 166 • Assign Heat Tracing, page 151 • Place an Inline Instrument, page 163 • Place an Offline Instrument, page 165 • Remove an Instrument from a Loop, page 168
•

162 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Loop Tag Dialog Box (Properties Window)
Allows you to search for and specify the loop tag for the item whose properties currently appear in the Properties window. This dialog box opens when you click the ellipses (...) button next to the loop tag cell. Search for - Allows you to type in descriptors to display the available loop tags, limited by parameters that you enter here. The percent character, %, is a wildcard. For example, if you want to list only loop tags that contain the letter F, you could type %F% in the Search for box. If you want to display all available loop tags, simply type %. Search Now - Finds and displays the loop tags that match the criteria in the Search for box. You can choose a tag from the main window and click OK in order to assign the tag to the item whose properties currently appear in the Properties window. Related Topics • Add Instruments to a Loop, page 166 • Place an Inline Instrument, page 163 • Place an Offline Instrument, page 165 • Remove an Instrument from a Loop, page 168

Place an Inline Instrument
1. In the Catalog Explorer list view or the stockpile, click the inline instrument that you want to place. 2. Drag the item to the appropriate line in the drawing. 3. Position the item and release it. 4. In the Properties window, specify properties of the inline instrument in the appropriate rows in the table. Tip
•

If the Properties window is not visible, you can display it by selecting the instrument and then selecting Edit > Properties on the main menu bar.

Notes
•

As you drag inline instruments over a pipe run, the pipe run appears selected. If you place an inline instrument when a pipe segment is not selected, the instrument is placed in free space if rules defined in Rule Manager allow such a placement. If the item you place has multiple possible orientations in relation to other items, you can use the Configuration tool, or PickQuick, to select the appropriate placement for the item.

•

SmartPlant P&ID User’s Guide 163

Creating P&IDs in SmartPlant P&ID: An Overview
•

While placing an inline instrument on a pipe run with associated heat tracing, if the pointer is below the pipe run, then the heat tracing appears above the instrument and vice versa – regardless of the heat tracing orientation on the piping. By keeping the pointer either above or below the piping, you can decide the orientation for the heat tracing on the inline instrument at placement time. Validation takes place between the pipe run and the inline components on that pipe run with the result that you may see some properties values being copied from the pipe run to the inline component. This copying behavior is based upon the pipe run properties that should have their values copied to the in-line components. You may determine which properties should be copied. This is configurable by adding the ProgID called UpdInlineCompProp.ForeignCalc in the Validation ID field for the PipeRun Property. You can use Data Dictionary Manager to sort the properties by Validation ID using the Piperun table. Notice the only attributes that are delivered with this validation ID. They are CleaningReqmts, CoatingReqmts, MaterialOfConstClass, and ScheduleOrThickness. Nominal diameter is also included although it does not have that particular Validation ID specified. It has the one involved in the pipe spec access. The way this works with the attributes that have that ID is that the software is watching the pipe run and the inline components. When a value for one of the affected attributes changes on the pipe run, and it was previously equivalent to the value on the inline component, then an update to the pipe run will update the inline component. If the values were different, updating the pipe run will not affect the inline component. Also, the routine UpdInlineCompProp.ForeignCalc is not delivered as part of our sample validation. You must specify that particular validation id in order to use the functionality.

Place an Offline Instrument
1. In the Catalog Explorer list view, click the offline instrument that you want to place. 2. Drag the item to the appropriate place in the drawing. 3. Position the item and release to place it. Tip You can click an item from Catalog Explorer and then place it by clicking the appropriate location in your drawing. Press Esc to quit placement mode. Or, you can escape placement mode by rightclicking. 4. In the Properties window, enter values for the properties of the instrument in the appropriate rows in the table.
•

Tips
•

If the Properties window is not visible, then you can display it by selecting the instrument and then selecting Edit > Properties on the main menu bar. You can assign heat tracing to offline instruments, too. For more information, see Assign Heat Tracing, page 151.

•

Notes
•

If you place an offline instrument over an existing signal line, the software inserts the offline instrument in the signal line, just as piping components are inserted into pipe runs. After you place offline instruments, you can connect them to piping segments or inline instruments using signal lines. After you place items, you can mirror, rotate, or move them.

Add Instruments to a Loop
1. From the Catalog Explorer tree view Loops node, right-click the instrument loop that you want to place. 2. Select Send to Drawing Stockpile or Send to Stockpile from the shortcut menu. 3. Define properties for the loop by entering values in the Properties window. The software automatically generates an item tag when you enter a tag suffix. 4. Select the item that you want to associate with the instrument loop. 5. Select the item tag of the loop from the Loop Tag select list in the Properties window, or you can click the Calculation button next to the Loop Tag box in the Properties window. 6. On the Loop Tag dialog box, enter characters in the Search for box in order to display the available loop tags. 7. Click Search Now. 8. Choose the appropriate loop from the resulting list. Notes
•

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. Selecting the item tag of the loop for an instrument triggers the Item Tag Validation program. The software automatically generates a unique item tag for the instrument. You can assign the Loop Tag qualifier to instruments that you have already placed in your drawing or that reside in the stockpile, and you can either place instruments then create the loop or create the loop and assign instruments to it as you place them. 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, page 250. 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.

•

•

•

•

•

•

166 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview
•

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.

Updating Associated Instruments with Loop Properties (Properties Window)
The Updating Associated Instruments with Loop Properties dialog box allows you to update the Item tag property of an instrument so that it will correspond with the current Loop tag property for that instrument. This dialog box may be accessed by clicking the ellipses (...) button next to the Tag Seq No cell for a loop in the EDE. The dialog box displays the list of instruments associated with that loop. The checkboxes beside the tags can be selected to determine which instruments will have their Instrument tag property updated. After clicking OK, the selected updates will be made. 1. Click in a checkbox to select and update the instrument associated to the displayed loop. 2. Click OK. Related Topics • Generating Reports: An Overview, page 330 • Loop Tag Dialog Box (Properties Window), page 163 • Navigating in the Engineer Data Editor: An Overview, page 41 • Placing Instrumentation: An Overview, page 162 • Selecting Drawing Items: An Overview, page 132 • Working With the Properties Window: An Overview, page 83

SmartPlant P&ID User’s Guide 167

Creating P&IDs in SmartPlant P&ID: An Overview

Remove an Instrument from a Loop
1. In the drawing, select the item or items that you want to remove from the loop. 2. In the Properties window, remove the value for the Loop Tag property for the selection. Notes
•

When an instrument is assigned to a loop, validation automatically creates an instrument item tag. If you remove the loop tag property, the instrument item tag remains the same until the instrument is assigned to a new loop. You can remove an instrument from a loop by deleting the item from the model, too. You can press Delete on the keyboard to remove an item or a group of items from the drawing. First, select the item or items in the drawing. Then you must point to the Drawing view before you press Delete. The Delete command is not carried out if the pointer is located anywhere outside the Drawing view. If the Properties window is not visible, you can display it by selecting the item and then clicking Edit > Properties.

•

•

•

•

Related Topics Placing Instrumentation: An Overview, page 162

168 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Labeling: An Overview
Your main tool to add or edit text content that appears in a label is the Properties window. By adding or editing text, you are entering data into the database. Whenever you select a label. the corresponding labeled properties for its item appear in the Properties window. The same properties appear in the long list of properties when you select the item itself. Since only the label properties appear when the label is selected, you have an easier method to find to the label properties. Note
•

If you enter text with a recognized unit of measure using a quotes or double-quotes, the software parses the UOM and ignores the doublequotes (or tick marks).

A label always reflects the current property values of the item that it labels. Labels that populate a property at placement are called driving labels. In other words, the predefined property value in the label overwrites the current property value on the item that it labels. Labels that do not overwrite the property at placement are called driven labels. Labels are defined as driven or driving in Catalog Manager. Note
•

If you place a label on a pipe run and a red X displays, this indicates an inconsistency with the item being labeled. For example, if you place a pipe run and then place Stress Analysis - Complete label, a red X appears. This indicates that the label is inconsistent with the pipe run value.

At label creation time, the plant administrator can define text content inside the label with the SmartText editor in Catalog Manager. When placing a label later, you cannot edit text such as OLL= on the OLL Elevation Equipment label. Nonetheless, you can place free text in an item note. Different labels have different label properties. The following table identifies some of the label properties that are defined during label creation in Catalog Manager. After the creation of a label, these properties dictate label placement behavior. You do not see label properties while using the design software; these properties perform their function in the background and are invisible to you. Break Labeled Item Type Placement Type Leader Line Terminator Type Offset Distance Title Block Yes 1-Point Flow Arrow Yes 1-Point Component Yes 1- or 2-Point

Not applicable Not applicable Yes Not applicable Not applicable Yes Not applicable Not applicable Yes

SmartPlant P&ID User’s Guide 169

Creating P&IDs in SmartPlant P&ID: An Overview Offset Source Behavior Area Break Not applicable Not applicable Yes Not applicable Not applicable Yes Not applicable Not applicable Yes Not applicable Yes

Fit Graphics to Text Yes Table notes:
•

The four types of labels (title block, flow arrow, component, and break) appear in columns. Label properties appear in rows. Yes indicates that the property applies to that type of label. Not applicable indicates that the property does not apply to that type of label. Special notes, like 1- Point for one-point placement, indicate that the property applies under certain conditions.

Placing Labels: An Overview
You can place a label in a few basic steps. First, you select the label that you want from Catalog Explorer and then identify the item in the drawing that you want to label. Labels can have two-point placement or one-point placement. You use one-point placement when a single point in the drawing identifies both the item to label and the location of the label. You use two-point placement when you need one click to identify the item to label and a second click to indicate a different location for the label. Some labels have no symbology associated with them; that is, they contain text only (for example, the Short Description label for Equipment). If you place such a label, but the properties that normally appear have not been entered yet, you have an empty label. Since there is no symbology associated with this type of label, it would be essentially invisible on the drawing. However, empty labels display a question mark so that you can find them more easily and not unnecessarily repeat work. You can add a leader line to a label by right-clicking on the label and choosing Leader line display. If you place a leader line with the label, the first click also identifies the end of the leader.

170 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Labels can be moved by selecting the label and dragging the black square at the center of the label. Drag the label to the location that you want it to occupy in the drawing. You set the placement type of a label at its creation in Catalog Manager. Afterwards, you cannot change the placement type in the design software. Notes
•

Changing default label formats in Options Manager (for example, changing temperature from K to °C) does not change labels that are already placed in drawings. Once you have changed the label format using Options Manger, you can use the Update Drawings command in Drawing Manager or use the Replace command in SmartPlant P&ID to update the existing labels in your drawings. All delivered labels use plant default units, which are defined in Options Manager, and so labels do not always display the units selected in the Properties window. Change units in the SmartText Editor dialog in Catalog Manager to specify a different unit of measure in a label. A line label follows a line when you change its angle, for example, changing from horizontal to vertical. A label and its assigned leader line follow when you move a line. When you recalculate a line, the software does not delete the label but repositions it in an associated location on the line. When you place a property break label, the software stops the sharing of data between segments of pipe. In other words, you break the pipe run. When you place an off-page connector (OPC), the software automatically creates and stores a matching connector in either a plant or project stockpile or the stockpile of another drawing. The matching connector receives the value, for example, From Drawing 123, where the number corresponds to the drawing. After you place the matching connector from the stockpile into the related drawing, the software automatically updates the matching connector in the original drawing (To Drawing 122, for example).

Place a Label from Catalog Explorer
1. Select the label that you want from the Catalog Explorer list view. 2. Click the item in the drawing that you want to label. 3. If the properties of the label require two-point placement, click again to place the label where you want it in relation to other items in the drawing. Notes
•

Labels are a special class of item in Catalog Explorer. Depending on the definition of the label, you place labels with one-point or two-point placement. If the label is designed for two-point placement, you must use item placement mode instead of the drag method. An example of onepoint placement is placing an ID label on a valve. An example of twopoint placement is placing an equipment label on a pump. You can edit the database properties for the labeled item after you have placed the label.

One-Point Label Placement
To illustrate placing a label with this placement method, consider placement of a Tag ID label on a valve. You point to the valve, and it is highlighted indicating that you can place a label. When you click the valve, the software places the component label. This valve received a label with one-point placement. Properties include an Offset Distance value of .5 inch, no leader line, a Cursor Location value of above midpoint, and an Offset Source value of local. These properties are set in Catalog Manager during label creation.

172 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview The dots on the valve and label are not part of these drawing items. The dots represent the center of the bounding box. These midpoints always align when you place a label with one-point placement. Midpoints align at the y-axis of the local coordinate system of the symbol with the label. This y-axis alignment line crosses the center of the labeled item. Offset is always a positive value. Pointer position determines if you place the label above or below the component. If the pointer appears above the center (that is, the y coordinate is a positive value) you are placing the label above the item. If the pointer appears below the center (that is, the y coordinate is a negative value) you are placing the label below the item. The center of the bounding box is (0,0), the local origin. For a pipe run, the center is the point where the pointer touches the line. The tolerance for the Select command determines the distance above and below the pipe run. The alignment axis is perpendicular to the line at this point. When you point to locations in the drawing and locate a valid target, the label immediately moves to this position. The label remains in dynamics (you can move the label to a different location before you place it) so you can confirm correct placement. The property for offset source also affects label placement. If the value for offset source is None, the software uses the default offset distance, designated in Options Manager. In this example, the software aligns the center of the label at the center of the item receiving the label. This action allows you to place labels on a line and at the center of symbols. A value of Zero offset distance aligns the bounding boxes. Label Offset options can be universally applied by inputting a value in the Distances option in Options Manager; however, if a label offset is designated for the label during creation in Catalog Manager, that value overrides the Options Manager setting. Related Topics Customize the Software With the Options Command, page 26 • Manipulate a Leader Line, page 177 • Place a Label from Catalog Explorer, page 172 • Place a One-Point Label, page 174 • Place a Two-Point Label, page 175
•

SmartPlant P&ID User’s Guide 173

Creating P&IDs in SmartPlant P&ID: An Overview

Place a One-Point Label
1. In the Catalog Explorer list view, click the label that you want to place. 2. Drag the label to the appropriate place in the drawing. 3. Release the label when the target is highlighted. Tips
•

When you drag a label over an appropriate target, the target is highlighted.

The pointer position, in relation to the item when you place the label, determines if you place the label above or below the item in the drawing. 4. In the Properties window, select or type values for the properties of the label in the appropriate rows in the table, if needed.
•

Notes
•

Title blocks, flow arrows, off-page connectors, and some component labels use one-point placement. A label display always reflects the values of the item with which it is associated. Labels that populate the item values at placement time are called driving labels. In other words, the predefined properties in the label overwrite current item properties when the label is placed. Labels that do not overwrite the item properties are called driven labels. Labels are defined as driven or driving in Catalog Manager. If you place flow arrow labels on a pipe run, the direction of the arrow changes depending on the flow direction of the pipe run. If the pipe run has no direction defined for it, the direction of the flow arrow label defines the flow direction of the pipe run. You can use the Configuration Tool, or PickQuick, to select the direction of a flow arrow as you place it. If you place an off-page connector on a pipe in the drawing, the software fills in the connector number and automatically adds a second off-page connector to either the Stockpile or the stockpile of another drawing. When you place the second connector in a drawing, the software automatically updates the number and name of the drawings in both offpage connectors. To display a leader line for the label, right-click the label, and then select Leader line display on the shortcut menu. If the Properties window is not visible, you can display it by selecting a label and then clicking Edit > Properties on the main menu bar.

Two-Point Label Placement
To illustrate placing a label with this placement method consider placement of an Equipment ID label on a pump. When you point to the pump, it is highlighted, indicating that you can place the label. When you click the pump, the software recognizes the pump as a target for the label. That action is the first point of two-point placement. At the location on the drawing that you want actually to place the label, click again. That action is the second point of two-point placement. After the first click, the pointer changes from a northwest arrow, , to a four-headed arrow, , until you place the label with your second click. During the time between the first and second clicks, the label is attached to the pointer.

This pump received a label by using two-point placement. (1) and (2) illustrate the two pointer positions and clicks required to place this label. Properties include a Rotation value of false and a Leader line value of true. These properties are set through Catalog Manager during label creation. With two-point placement, the software does not use properties for offset distance or pointer location. You can place the first point anywhere on the item to receive the label. The leader line points to this location. Related Topics • Manipulate a Leader Line, page 177 • Place a Label from Catalog Explorer, page 172 • Place a Two-Point Label, page 175

Place a Two-Point Label
1. In the Catalog Explorer list view, click the label that you want to place. 2. In the drawing click the item that you want to label. Tip As the pointer passes over an appropriate target item for the label, the software highlights the item. To label the item, click the item when the software highlights it. 3. Click the location in the drawing for the label.
•

4. Quit label placement mode by pressing Esc.

SmartPlant P&ID User’s Guide 175

Creating P&IDs in SmartPlant P&ID: An Overview Tip Or, you can escape placement mode by right-clicking. 5. In the Properties window, specify the properties of the label in the appropriate rows.
•

Tip
•

If the Properties window is not displayed, you can display it by selecting the label and then clicking Edit > Properties.

Notes
•

After you place a label, you can move it and manipulate its leader line. For more information, see Modifying and Moving Placed Items: An Overview, page 206 Manipulate a Leader Line, page 177

Copy Labels
1. In the Drawing view, select the label that you want to copy. 2. Right-click the label and select Place New from the shortcut menu or click Place on the Run Macro toolbar. The Place New icon does not appear on the New Run Macro toolbar until you select a label. 3. Associate the new label icon that appears at the end of the pointer with the new item by highlighting the item and clicking. Related Topics • Copying Items: An Overview, page 239 • Labeling: An Overview, page 169 • Place a One-Point Label, page 174 • Placing Labels: An Overview, page 170

176 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Align Labels
1. In the Drawing view, select the labels that you want to align. Tip In order to align labels, you must be sure not to select any drawing items other than labels. You can remove an item from a select set by pressing Ctrl and clicking the item. 2. Click the appropriate alignment button on the main toolbar:
• • • •

Align Left - Align labels so that their left-most lines match Align Right - Align labels so that their right-most lines match Align Center About Vertical - Align labels so that their center points agree on a horizontal line Align Center About Horizontal - Align labels so that their center points agree on a vertical line Align Top - Align labels so that their top lines match Align Bottom - Align labels so that their bottom lines match

Manipulate a Leader Line
1. Display the handles of the leader line by clicking the label that it belongs to. Tip In order to manipulate a leader line, you must display it. Right-click the label and then click Leader line display on the shortcut menu. 2. Click a handle and drag the line to a new location.
•

You can find this macro in \Program Files\Smartplant\P&ID Workstation\Program.

Note
•

The UpdateLabelsCmd.dll refreshes the value of the currently placed label properties as displayed on the drawing. The command does not update the label based on modifications made to the label using Catalog Manager. To update the label if changes have been made using Catalog Manager, the label must be replaced in the drawing using Edit > Replace.

•

Related Topics Labeling: An Overview, page 169

Using the Types of Labels: An Overview
The type of label that you place determines the workflow that you follow. You define the label type when you create a label in Catalog Manager. As defined in Rule Manager, rules apply when you are placing a label. The following four types of labels are Title Block, Flow Arrow, Component, and Break. Title Block The title block label is unique among label types because you do not have to identify the item to receive the label. The title block usually displays general information about a drawing. After you select the label in the list view, you can drag it to the location in the drawing where you want to assign the label. Once the title block is placed in a drawing you can modify label properties using the Property window (for example, Title and Description). Any properties that you cannot modify while in SmartPlant P&ID would need to be modified using Drawing Manager (for example, Drawing Number and Drawing Name). The different template files, which create new drawing files, contain different title blocks. Therefore, you can automatically place standard title blocks in standard drawings, which are built on standard templates. Or, you can create custom title block labels to fit your custom templates.

178 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Flow Arrow You place flow arrows in process piping lines. When you place the label, the arrow orients itself with the flow in the pipe run if you have already defined flow direction. If you have not specified a flow direction, then the direction you place the flow arrow defines it for you (that is, a flow arrow is a driving label). As you drag the label from the list view of Catalog Explorer, pipe runs in the Drawing view are highlighted when you pause over them. Click a highlighted pipe run to place the label. Flow arrows require only one click to place them. After placing the label, you can change the flow direction of the pipe run in the Properties window, and the flow arrow reorients itself accordingly. You cannot change label properties that appear in the Properties window for a flow arrow.

Component This type of label identifies physical commodities in the model. A typical example is an Equipment ID label. Properties assigned to the label affect its behavior. Component labels have a unique property: Label Behavior. The values are defined in a select list in Data Dictionary Manager and are chosen in Catalog Manager when you create a label. The default value is Follow. Values for this property can include the following:
•

Follow (no rotate) - The label does move but does not rotate, corresponding to changes to the labeled item. Follow - The label does move and rotate, corresponding to changes to the labeled item. Fixed - The label does not move if you move the labeled item.

•

•

SmartPlant P&ID User’s Guide 179

Creating P&IDs in SmartPlant P&ID: An Overview This illustration shows component labels that you use to label vessels, nozzles, and piping components. It also depicts both fixed and rotated orientations of labels.

Break A break label, or property break label, graphically shows that a change occurs or can occur in a property at some point in the process. This label indicates to the software that an inconsistency for that property is acceptable. As a result, the software does not issue a warning, or an existing inconsistency resolves itself when you place the break. A break label can only be placed at a connection point where the specified properties are being propagated. Break labels do not set properties but note that a value change is acceptable for the property at the indicated point. Text included in the label reflects the property at that point. You can associate multiple property breaks with one point on the drawing.

You place property break labels, in the Segment Breaks node of Catalog Explorer, with two-point placement. Notes
•

You can turn on or off the Is Leader Visible property in Catalog Manager. After you place the label, you can right-click the label, and then click Leader line display on the shortcut menu to control the display of the leader line in the drawing software.

180 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview
•

Use care when you assign leader lines. You can place several break labels at one point, and multiple leader lines can be confusing.

Related Topics • Place a Label from Catalog Explorer, page 172

Place a Title Block
1. Find the title block that corresponds to your drawing template in the Catalog Explorer List view. 2. Click the label and position it over the pre-defined title area on the drawing so that the elements of the label fall within the cells of the title area. 3. Click to place the title block. 4. Press Esc to quit placement mode. Tips
•

You can review the properties of the title block label in the Properties window. You can modify some of these properties using the Properties window, for example, Description, Title, and Title Block Revision. If you want to modify the Name and Drawing Number properties, you must exit the drawing and make the edits using Drawing Manager. For more information, see Drawing Manager Help. You can move the title block if you need to position it more carefully within the title area of the drawing. For more information, see Move an Item With the Select Tool, page 209.

Place a Flow Arrow
1. Find the flow arrow in the list view of Catalog Explorer and select it. 2. Position your pointer over the process line that you want to label. 3. If a flow direction has not been specified, then choose an orientation for the arrow so that it reflects the correct direction. Tips
•

If a flow direction has already been specified for the line, then the flow arrow orients itself so that it reflects that property.

If you pause over a line whose flow direction has not been defined, you can use PickQuick to position the flow arrow. 4. Click to place the flow arrow on the process line.
•

You must change the flow direction of a line by changing the property in the Properties window. Do not rotate a flow arrow by using the Rotate command or the rotate handle in order to change the flow direction; flow direction is a property.

Place a Component Label
1. From the list view in Catalog Explorer, choose the label that you want to place. 2. Place the pointer over the component that you want to label. 3. Place the label using either one-point or two-point placement methods, depending on the label. For more information, see Place a One-Point Label, page 174 and Place a Two-Point Label, page 175. 4. Continue placing the same label or click Esc to quit placement mode. Related Topics • Labeled Item Type, page 184 • One-Point Label Placement, page 172 • Placing Labels: An Overview, page 170 • Two-Point Label Placement, page 175 • Using the Types of Labels: An Overview, page 178

Place a Break Label
1. From the List view in Catalog Explorer, select the break label that you want to place. Tip
•

The Catalog Explorer Tree view node where break labels are located is called Segment Breaks.

182 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview 2. Place the break label using two-point placement. The first click (1) specifies the junction in the process line, the second click (2) designates the location for the break label itself.

3. Continue placing the same break label at other junctions in the drawing, or press Esc to quit placement mode. Notes
•

A break label can only be placed at a connection point where the specified properties are being propagated. Break labels can be removed using the Delete command. If the break label is removed, the break is also removed. However, if there is another break label at the same point, the break is not removed. You can turn on or off the Is Leader Visible property in Catalog Manager. After you place the label, you can right-click the label, and then click Leader line display on the shortcut menu to control the display of the leader line in the drawing software. Use care when you assign leader lines. You can place several break labels at one point, and multiple leader lines can be confusing.

Label Properties: An Overview
The following label properties are available for specifying your labels.

SmartPlant P&ID User’s Guide 183

Creating P&IDs in SmartPlant P&ID: An Overview

Labeled Item Type
This property defines the type of item that your label is used with. When you create a label in Catalog Manager, you must specify this property; you cannot change it in the design software. The property must be defined correctly to allow you to place labels. When you create a label in Catalog Manager, you choose the labeled item type from the Item list in the SmartText Editor. That list is defined in Data Dictionary Manager, where all the valid item types are defined and stored. Examples of labeled item types include pipe run, instrument, piping component, equipment, and so forth. If you specify that the labeled item type is a pipe run, then you can place your label on a pipe run and not on any other type of item in your drawing. Related Topics • Place a Label from Catalog Explorer, page 172

Offset Distance
This property defines the distance from the labeled item to the label. Offset distance applies for labels that are defined with one-point placement. This property also applies for two-point label placement if the property for offset source is set to Local. The property must be defined correctly in Catalog Manager to allow you to place your label. The actual plant-wide offset distance is specified in Options Manager. The software measures the distance from the bounding box of the item to receive the label and the bounding box of the label itself. Consider the offset as the clearance distance between the bounding boxes. Notes
•

The bounding box in SmartPlant P&ID differs from the SmartSketch definition of range. SmartSketch (A) uses the x-y coordinate range around an item. SmartPlant P&ID (B) uses a rectangular area.

•

For a line segment, the bounding box is the line itself.

Related Topics • Place a Label from Catalog Explorer, page 172

184 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Offset Source
This property specifies the origin for the offset distance. The possible values for offset sources are None - The label does not have an offset. This value indicates placement at the center of the labeled item. Project Settings - Plant-level parameters determine the offset distance. You can use Options Manager to define the plant settings distance. Local - The label does have an offset, and the value for the Offset Distance property, which is specified in Catalog Manager, defines the offset to use. You set this property when you create a label in Catalog Manager. Afterwards, you cannot change the offset source property in the drawing software. Likewise, you set the local offset distance when you create a label, and you cannot change the property in the drawing software. Related Topics • Place a Label from Catalog Explorer, page 172

Is Mirrorable
The value of this property is set to True to indicate that you can mirror the item. The value of this property is set to False to indicate that you cannot create a reverse image. You define this property when you create a label in Catalog Manager. Related Topics • Place a Label from Catalog Explorer, page 172

Disable Flip Text
This value allows you to rotate or orient text for readability. By default, the software displays text in a readable manner and will not allow it to display upside down. For example, if you move a label in a direction that would effect the readability of the text, the software automatically flips the text so that it can still be read. Using Catalog Manager, you can disable this option and allow the text to display upside down if needed. Related Topics • Placing Labels: An Overview, page 170 • Working With the Properties Window: An Overview, page 83

SmartPlant P&ID User’s Guide 185

Creating P&IDs in SmartPlant P&ID: An Overview

Is Rotatable
The value of this property is set to True to indicate that you can rotate the item. The value of this property is set to False to indicate that you cannot change the angular orientation. You set this property when you create a label in Catalog Manager. Related Topics Place a Label from Catalog Explorer, page 172

•

Is Fit To Text
The value of this property is set to True if the label graphics must fit around the text when you place the label. The value of this property is set to False if the label graphics do not need to fit around text. You can change the designation in Catalog Manager. You can set the value to True only for enclosures that are circles, ellipses, rectangles, or parametrics. You set the Is Fit To Text property when you create a label in Catalog Manager. The following illustration is an example of a label with the Is Fit To Text property set to False. The rectangle appears at the same size when you created it:

This illustration is an example of a label with the Is Fit To Text property set to True. The rectangle resizes to fit around the text:

Is Leader Visible
The value of this property is set to True to indicate that the label includes a leader line. The value of this property is set to False to indicate that the label does not include a leader line. You set this property when you create a label in Catalog Manager. You can turn on or off the display of the leader line after you place the label. Note
•

To turn on or turn off the display of the leader line, right-click the label, and click Leader line display.

Label Terminator Styles
The Terminator Style property specifies the terminator, if any, to place at the end of a leader line. Choices include None, Arrow, Solid Dot, and so forth. This property applies only to labels whose value of the Leader Line property is set to True. You specify these properties when you create a label in Catalog Manager. Afterwards, you cannot change the terminator type property in the design software. Related Topics Place a Label from Catalog Explorer, page 172

•

Using Off-Page and Utility Connectors: An Overview
A connector is not actually a label but more like a component that includes a label. Placement behavior for a connector is very similar to a standard piping component label. OPCs, utility connectors, and piping components are inserted into a line. The drawing needs a connector when a line run continues on another drawing. The minimum information in the label portion is the drawing name to which the connector points and the connector number. Connectors do not have a property for flow direction, although most connectors use an arrowhead to indicate direction. When you place a connector, it does not set or respond to flow direction. The connector represents continuation, not connectivity or flow.

SmartPlant P&ID User’s Guide 187

Creating P&IDs in SmartPlant P&ID: An Overview During document creation, when you place the first connector of the pair, the software places the partner in either the Stockpile or the stockpile of another drawing of your choice. The default placement for the partner is into the Stockpile. When you create a connector and place it in a drawing, the property for the drawing name is not defined. The partner in the stockpile reflects the drawing name in which its match was located. When you place the partner from the stockpile, the first connector is updated to reflect the drawing name where you placed the partner connector. As a result, you never need to type a drawing name, and the software guarantees a valid match. OPC pairs have a to and from orientation. The software does not use the graphical to and from distinctions, but reading the drawing is easier for you with this differentiation.

1. The OPC is a to connector if its connected point appears at the finish end of the connector. 2. The OPC is a from connector if its connected point appears at the start end of the connector. In order to switch between to and from orientations, you must disconnect the OPC from the line and then rotate or mirror it. Then you can reconnect the line to the other end of the OPC. At the time of placement, you can pause when placing the OPC and wait for the PickQuick toolbar in order to choose the correct orientation. You can delete a connector from the drawing, and the software moves it to a stockpile and updates the properties of its partner. To delete a connector from a stockpile, both must reside there, and you delete both from a stockpile. After you delete a connector, you cannot reuse the same number. You can change the connector number but not the drawing name in these labels. However, you can change other properties. If you copy a connector, the software must generate new connector numbers and add a partner to a stockpile. The property for drawing name changes to Null or Undefined for the copy. These properties exist for connectors:
• • •

Offset source is set to None. Rotation is set to True. Leader line is set to False.

188 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview In Catalog Explorer, Off-Drawing or Off-Unit OPCs are available for instruments. Two types of connectors are available for process lines: Off-Drawing or Off-Unit OPCs or Utility Connectors. The correct symbology differentiates OPCs. You define symbology with Options Manager. Related Topics Change Default Storage Location for Partner Connector, page 192 • Place a Label from Catalog Explorer, page 172 • Place a One-Point Label, page 174 • Place an OPC or Utility Connector, page 190 • Store a Partner Connector, page 192
•

Understanding System Editing and OPCs
An OPC can be placed as a freestanding item in a drawing or it can be placed onto an existing pipe run. If an OPC has been placed as a freestanding item, a pipe run can be attached to it. When the relationship between the OPC and the pipe run is created (either by placing the OPC or by placing the pipe run), the system finds the applicable rules, copies the specified properties and evaluates the consistency criteria. When the first OPC (of an OPC pair) is connected to a pipe run, there is no pipe run connected to the mate OPC. Since there is no other pipe run, the system will not find any applicable rules. When the second OPC (of an OPC pair) is connected to a pipe run, however, the system will find the rules that apply to this pair of pipe runs. The system copies the specified properties from the pipe run in the other drawing to the pipe run in the active drawing. This copy operation will not overwrite any existing values. (The Copy is forced into the Copy If Null mode.) The properties that are copied across the OPC are propagated into the active drawing. This can mean that property values on items other than the connected pipe run are affected. However, this is only done if the current value is Null. Existing values are not overwritten. After the copy process is complete, the consistency criteria is evaluated and inconsistencies are generated for all inconsistent properties. Each time a drawing is opened, a routine is executed to update all of the OPCs in that drawing. Also, the relationship between the OPC and the connected pipe run is updated. During this update, the rule base is searched to find all of the applicable rules. If the mate OPC has been connected to a new pipe run since the last time this drawing was opened, it may find a different set of rules that apply. After finding the applicable rules, the consistency criteria is evaluated and inconsistencies are generated for all inconsistent properties. Property values are not automatically copied across OPCs during this processing. If you want to copy changed property values across OPCs, you can use the Solutions that are available in the Consistency Check dialog box.

SmartPlant P&ID User’s Guide 189

Creating P&IDs in SmartPlant P&ID: An Overview The text in the label on the OPC is also updated. If the mate OPC has been placed into a different drawing since the late time this drawing was opened, this change will be reflected in the updated label.

System Editing and Changing Property Values Across OPCs
When a property value is changed on a pipe run that is connected to an OPC, it is expected that the connected pipe run in the continuation drawing should be changed in a corresponding manner. You can achieve this result with a workflow that pulls the change into the other drawing. This workflow allows you to pull a changed property value across an OPC into the continuation drawing. When a property value is changed on a pipe run that is connected to an OPC, an inconsistency is generated at the OPC. This inconsistency indicates that the two connected pipes have different values. To resolve this inconsistency, you must close the active drawing and open the continuation drawing. In that drawing, another inconsistency is shown at the mate OPC. You can doubleclick on that inconsistency to display the Consistency Check dialog box. A solution is displayed to Copy the new value from the first drawing onto the pipe run in the active drawing. If you apply this solution, the value is copied into the active drawing and propagated to the related items. This resolves the inconsistency in the second drawing. The next time the first drawing is opened, the inconsistency will be resolved there as well. Related Topics • Change Default Storage Location for Partner Connector, page 192 • Place a Label from Catalog Explorer, page 172 • Place a One-Point Label, page 174 • Place an OPC or Utility Connector, page 190 • Store a Partner Connector, page 192

Place an OPC or Utility Connector
1. From the list view in Catalog Explorer or from a stockpile, select the connector that you want to place. Tip
•

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 (for example, line weight and color) differentiates OPCs. You define symbology with Options Manager.

190 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview 2. Click the location in the drawing where you want to place the connector. Tips
•

You can place a connector in free space on the drawing and route a line to it, or you can place it at the end of a line that already is drawn. If you are placing a connector in free space, rotate or mirror the OPC after placement in order to get the correct orientation. Then route the line to it.

•

If you are placing a connector at the end of an existing line, you can wait for the PickQuick toolbar so that you can choose the correct orientation. 3. Modify the properties of the connector in the Properties window.
•

Tip
•

If you placed a new connector from Catalog Explorer, you can display and select the partner in the Engineering Data Editor and modify its properties, too.

Notes
•

Utility connectors support only one-to-one relationships. In other words, they come in pairs only. When you place a utility connector and its partner goes to a stockpile, that partner connector is of the same type as the first connector you placed. In order to change the partner connector to the other type of utility connector, you must place the partner in its drawing and then replace the symbol. For more information on replacing symbols, see Replace an Item Using Replace Mode, page 220.

ToFromText Dialog Box (Properties Window)
Opens when you click To / From in the Properties window when an OPC or other connector is selected, and allows you to enter a text value to be displayed in the connector. Click the ellipses to open the ToFromText dialog box. Description - Allows you to enter to or from information for the connector. You can enter drawing names or numbers or other pertinent information about the connected drawing or the direction of flow. Related Topics • Review and Edit Item Properties, page 86

If the Place partner OPC in Stockpile option is not selected, the Set Stockpile Location for Partner OPC dialog box appears whenever you place a connector. This dialog box allows you to place each partner OPC in the stockpile of a specific drawing.

Store a Partner Connector
1. Place a connector in a drawing. 2. On the Set Stockpile Location of Partner OPC dialog box, choose the stockpile in which you want the partner stored. Tip
•

If you have not deactivated the default storage for connectors, this dialog box does not appear because the partner connector is placed directly into the Stockpile. However, you can change the default storage location. For more information, see Change Default Storage Location for Partner Connector, page 192

Move a Connector to Another Stockpile
1. In the Engineering Data Editor, select the connector that you want to move. 2. On the Engineering Data Editor toolbar, click Actions > Move to Different Stockpile. Tip
•

If you select a connector that you do not have write privileges for, then the Move to Different Stockpile command is not available. That is, you cannot move a connector that belongs to a different drawing, for instance.

192 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview 3. On the Move to Different Stockpile dialog box, select the plant hierarchy element that contains the drawing whose stockpile you want to assign the connector to. Tip If you do not want to place the connector in a stockpile of a specific drawing, you can select Stockpile at the bottom of the Plant hierarchy tree. 4. In the Drawing list area, select the drawing whose stockpile you want to add the partner to.
•

Move Partner OPC Command
Connector Shortcut Menu > Move Partner OPC Opens the Move Partner OPC dialog box, from which you can move the selected connector to the stockpile of any drawing in the active plant. This command is available only when the partner connector is located in the Stockpile. Related Topics • Move a Partner Connector to Another Stockpile, page 194 • Using Off-Page and Utility Connectors: An Overview, page 187

Move Partner OPC Dialog Box
Opens when you click Move Partner OPC on the Connector shortcut menu. This dialog box allows you to move a partner connector from the Stockpile into the stockpile of a specific drawing, or vice versa. Plant Hierarchy - Displays the hierarchical tree representation of the plant. When you select a node, the drawings associated with that node appear in Drawing list. Drawing list - Displays all the drawings associated with the selected node on the Plant Hierarchy tree. Related Topics Move a Partner Connector to Another Stockpile, page 194 • Move Partner OPC Command, page 193
•

SmartPlant P&ID User’s Guide 193

Creating P&IDs in SmartPlant P&ID: An Overview

Move a Partner Connector to Another Stockpile
1. In the Drawing view, right-click the connector whose partner you want to move. 2. From the shortcut menu, click Move Partner OPC. Tip If you select a connector that you do not have write privileges for, then the Move Partner OPC command is not available. That is, if the partner connector belongs to another drawing, you cannot move it, for instance. However, you can use the Open Partner Drawing command on the shortcut menu to open the other drawing and move the connector from its stockpile. For more information about opening the partner drawing, see Open a Continuation Drawing, page 195. 3. On the Move Partner OPC dialog box, select the plant hierarchy element that contains the drawing whose stockpile you want to assign the connector to.
•

Tip If you do not want to place the connector in a stockpile of a specific drawing, you can select Stockpile at the bottom of the Plant hierarchy tree. 4. In the Drawing list area, select the drawing whose stockpile you want to add the partner to.
•

Note
•

If the partner connector is in a stockpile and is displayed in the Engineering Data Editor, you can move it from there. For more information, see Move a Connector to Another Stockpile, page 192.

Open Continuation Drawing Command
Connector Shortcut Menu > Open Continuation Drawing Opens the connected drawing when the partner of the selected off-page or utility connector is in a drawing or a drawing stockpile. This command is not available if the partner OPC is in the stockpile (instead of a drawing or drawing stockpile). Related Topics • Open a Continuation Drawing, page 195 • Using Off-Page and Utility Connectors: An Overview, page 187

Delete From Model Command
Connector Shortcut Menu > Delete From Model Deletes the selected item from the database; if you are deleting a connector, then its partner is deleted from the stockpile as well. Notes
•

Unlike the standard Delete command, which moves the selected item to the Stockpile, this command removes the selected items or connector and its partner from the model completely. In the case of the connector, the command is not available unless the partner connector is in the Stockpile.

Delete a Connector From the Model
1. Right-click the connector that you want to remove from the model. 2. From the shortcut menu, click Delete From Model. Tips
•

This command is available only when the partner of the selected connector is stored in the Stockpile. If you want to move the connector to the Stockpile instead of deleting it completely from the database, click Delete on the shortcut menu.

•

Note
•

The selected connector and its partner in the Stockpile are removed from the model.

Calling Item Tag Validation
The ItemTag project performs calculations and validations for unique tag checking, automatic tag generation, and tag reformatting. This project generates unique Item Tag values, maintains consistency between the Item Tag value and the properties used in its calculation. Also, any leading or trailing spaces are removed during the validation (only for properties included in the item tag). The ItemTag project deals specifically with the following item types: instrument loops, instruments, pipe runs, equipment components, signal runs with a plant item type pipe run (hydraulic, connect to process, and so forth), and equipment (other equipment, exchangers, mechanical equipment, and vessels). This project disregards all other item types. Property validation is triggered when any property that comprises the Item Tag value is added or modified. Calculation can be triggered by the Item Tag property for any of the items shown in the tables below. The following tables list item types that are validated or calculated by the ItemTag project, and the database tables and column names where modifications trigger calculation and validation. Legend Italics: Required for checking item tag uniqueness. Bold Italics: Required for the item tag, but can be generated automatically. Instrument Item Tag Structure Format Instrument Type Modifier Measured Variable Code Tag Sequence Number Loop Tag Suffix Tag Suffix (Instrument Type Modifier)(Measured Variable Code)-(Tag Sequence Number) Loop Tag Suffix(Tag Suffix)

To refresh the instrument loop tag suffix in the Properties window, clear the selection of the instrument and then select it again. Item Tag cells for these item types are read-only except for those of signal runs, and Item Tag properties for instruments are not read-only so that implied instruments can have item tags that are assigned manually. For information on customizing the software, including item tag formats, see the SmartPlant P&ID Programmer's Guide or click Related Topics.

Using Annotations: An Overview
Annotations are model items used to add notes, remarks, and other information to your drawing. You can use annotations to include any type of information previously inserted into a drawing using primitive commands. Annotations include everything from geometric shapes to extension and dimension lines. Because annotations are frequently parametric, often you can resize them to fit your needs. Placing annotations works like placing any other component in a drawing. When you place an annotation, which has an item type of item note, on a drawing, you can then place a label on the item note. These labels allow you to enter the remarks, notes, and other information that you need to effectively annotate your drawings. Caution
•

You cannot annotate drawings by opening them in SmartSketch and adding dumb graphics to the drawing. Opening and saving a .pid file in SmartSketch can corrupt the file, making the drawing unusable. Note

•

Annotations are a way to place free remarks in a drawing. There are several design labels of different formats available in Catalog Explorer. Most of these labels require placing an annotation point or other design graphic on the drawing first and then attaching a label to the graphic. The plain annotation point is located in the Graphics folder under the Annotation node; however, there is one item in the Labels folder with an annotation point built into it. It is called Item Note & Label, and it looks like this:

Place an Annotation
1. In the Catalog Explorer list view, select the annotation that you want to place from the Graphics folder. 2. Click to place the annotation at the appropriate place in the drawing. 3. Press Esc to quit placement mode. 4. To add text to the annotation, place a design label on the annotation. For more information, see Place a Two-Point Label, page 175 and Place a One-Point Label, page 174. 5. Assign text to the annotation in the Note Text property box in the Properties window. Tip
•

You can also assign text to the graphic in the Note Text property box for the graphic, and when you add a label, it automatically displays that text.

Note
•

You can resize annotations by dragging their parametric handles. For more information, see Scale a Parametric Item, page 226. There are several design labels of different formats available in Catalog Explorer. Most of these labels require placing an annotation point or other design graphic on the drawing first and then attaching a label to the graphic, as in the procedure above. The plain annotation point is located in the Graphics folder under the Annotation node; however, there is one item in the Labels folder with an annotation point built into it. The symbol is called Item Note & Label, and it looks like this:

Place an Area Break
1. Select the area break in Catalog Explorer in the Design node. 2. Place the area break shape around items in the Drawing view for which this area break applies. Tips
•

You can place a rectangular area break by dragging the pointer in the Drawing view, like fencing items with the Select Tool.

Or you can place a multi-sided area break by clicking at a starting point and then clicking for each vertex of the shape. 3. Press Esc to quit placement mode.
•

4. Create a select set of the items that you want to include in the area break. You can include the area break shape itself but only common properties with every item in the select set with be used. 5. In the Properties window, specify the properties for the select set. Related Topics • Selecting Drawing Items: An Overview, page 132 • Working With the Properties Window: An Overview, page 83

Place a Package
1. Right-click the Package symbol in Catalog Explorer in the Design node. 2. From the shortcut menu, select either Send to Stockpile or Send to Drawing Stockpile, whichever is appropriate. 3. In the Properties window or the EDE, enter a value for the Item Tag property. 4. In the Drawing view, select items to be part of the package. 5. If you want to create a select set, in the Properties window, choose Select Set from the Properties box. 6. In the Properties window, click in the Package Item Tag box and select the appropriate value displayed list. Tip
•

Some catalog items do not possess the Package Item Tag property, for example, OPCs and Item Notes. Do not include those items in your select set because the package item tag does not appear in the Properties window if any member of the select set does not possess that property.

200 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Notes
•

Packages normally reside in a stockpile with their members residing on drawings. Moving the package itself to another stockpile has special limitations. For more information about moving plant item groups from one stockpile to another, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250. If the Properties window is not visible, you can display it by selecting an item and then selecting Edit > Properties on the main menu bar.

Place a Safety Class
1. Right-click the Safety Class symbol in Catalog Explorer in the Design node. 2. From the shortcut menu, select either Send to Stockpile or Send to Drawing Stockpile, whichever is appropriate. 3. In the Properties window or the EDE, enter a value for the Item Tag property. 4. In the Drawing view, select items to be part of the package. 5. If you want to create a select set, choose Select Set from the Properties box in the Properties window. 6. In the Properties window, click in the Instr Safety Class Item Tag box and select the appropriate value from the displayed list. Tip
•

Some catalog items do not possess the Instr Safety Class Item Tag property, for example, OPCs, piping, equipment, and Item Notes. Do not include those items in your select set because the package item tag does not appear in the Properties window if any member of the select set does not possess that property. Notes

• •

Safety Class only applies to instruments. Packages normally reside in a stockpile with their members residing on drawings. Moving the package itself to another stockpile has special limitations. For more information about moving plant item groups from one stockpile to another, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250.

SmartPlant P&ID User’s Guide 201

Creating P&IDs in SmartPlant P&ID: An Overview
•

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.

Place a Test System
1. Right-click the Test System symbol in Catalog Explorer in the Design node. 2. From the shortcut menu, select either Send to Stockpile or Send to Drawing Stockpile, whichever is appropriate. 3. In the Properties window or the EDE, enter a value for the Item Tag property. 4. In the Drawing view, select items to be part of the package. 5. If you want to create a select set, choose Select Set from the Properties box in the Properties window. 6. In the Properties window, click in the Test Sys Item Tag box and select the appropriate value from the displayed list. Tip
•

Some catalog items do not possess the Test Sys Item Tag property, for example, Trays, Items Notes, and OPCs. Do not include those items in your select set because the package item tag does not appear in the Properties window if any member of the select set does not possess that property. Notes

•

Packages normally reside in a stockpile with their members residing on drawings. Moving the package itself to another stockpile has special limitations. For more information about moving plant item groups from one stockpile to another, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250. If the Properties window is not visible, you can display it by selecting an item and then selecting Edit > Properties on the main menu bar.

Place a Hydro Test Package
1. Right-click the Hydro Test Package symbol in Catalog Explorer in the Design node. 2. From the shortcut menu, select either Send to Stockpile or Send to Drawing Stockpile, whichever is appropriate. 3. In the Properties window or the EDE, enter a value for the Item Tag property. 4. In the Drawing view, select items to be part of the package. 5. If you want to create a select set, choose Select Set from the Properties box in the Properties window. 6. In the Properties window, click in the HydroTest Package No box and select the appropriate value from the displayed list. Tip
•

Some catalog items do not possess the HydroTest Package No property. Do not include those items in your select set because the package item tag does not appear in the Properties window if any member of the select set does not possess that property. Notes

• •

The Hydro Test Package is for piping only. Packages normally reside in a stockpile with their members residing on drawings. Moving the package itself to another stockpile has special limitations. For more information about moving plant item groups from one stockpile to another, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250. If the Properties window is not visible, you can display it by selecting an item and then selecting Edit > Properties on the main menu bar.

Place a Contract Package
1. Right-click the Contract Package symbol in Catalog Explorer in the Design node. 2. From the shortcut menu, select either Send to Stockpile or Send to Drawing Stockpile, whichever is appropriate. 3. In the Properties window or the EDE, enter a value for the Item Tag property. 4. In the Drawing view, select items to be part of the package. 5. If you want to create a select set, choose Select Set from the Properties box in the Properties window. 6. In the Properties window, click in the Contract Package No box and select the appropriate value from the displayed list. Tip
•

Some catalog items do not possess the Contract Package No property. Do not include those items in your select set because the package item tag does not appear in the Properties window if any member of the select set does not possess that property. Notes

•

Packages normally reside in a stockpile with their members residing on drawings. Moving the package itself to another stockpile has special limitations. For more information about moving plant item groups from one stockpile to another, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250. If the Properties window is not visible, you can display it by selecting an item and then selecting Edit > Properties on the main menu bar.

Place a Revision Cloud
1. Using the Catalog Explorer tree, select the Symbols > Design > Revision Cloud nodes. 2. Click the starting point in the drawing for the revision cloud area. 3. In a clockwise direction, continue clicking to place vertices on the revision cloud. 4. Right-click to complete the revision cloud. 5. Set the Area Break Style property to either a Cloud - Large or Cloud - Small. Notes
•

You can change the symbology, the line width and line style using the Symbology option in Options Manager.

Related Topics • Using Annotations: An Overview, page 198

SmartPlant P&ID User’s Guide 205

Creating P&IDs in SmartPlant P&ID: An Overview

Modifying and Moving Placed Items: An Overview
After you place items in a drawing, you can modify the items in several ways. Obviously, you can move items or groups of items from one location to another in the drawing. If you want to change the orientation of items, you can mirror and rotate most items. You can also move groups of items to another open drawing in the same plant hierarchy. Depending on the rules defined for particular items in the drawing, limits exist for possible placements. For example, specific trays can be flagged for placement inside a piece of equipment, and you can only move these inside the equipment. Rule Manager defines rules that determine the way that model items interact during manipulation. The software processes rules defined for items as you move them, as well as when you place them. You can resize or scale parametric items by using their parametric handles. Resizing parametric items maintains certain characteristics of the item, such as angles between elements of the symbol, while it allows modification of other characteristics of the item, such as the length of its sides. Many items are now scalable, too, and can be resized by using their scale handles. You can modify the properties of each item by selecting the item and changing individual properties in the Properties window. Also you can edit some item properties in the Engineering Data Editor in the Design window by selecting a table cell and filling in the appropriate information. You can select a entire row by clicking on the corresponding row number to the left of the table and then viewing the properties in the Properties window and editing them there. If you want to remove an item from a drawing, you can delete the item. If the plant model requires the deleted item, the item appears in the stockpile for later placement. If the plant model does not require the item, it disappears from the drawing completely. You can permanently remove required items from the plant model using the Delete from Model command. Notes
•

When modifying or setting the fluid code properties of a line, you always select the fluid code from a select list. If you do not set the fluid code first, you will see all possible fluid codes. If you set the fluid system prior to setting the fluid code, then only the fluid codes applicable to the type of fluid system display. To redisplay a complete list of available fluid code values, delete the property for the fluid system, and then the complete list of fluid code values appears. If the Properties window is not open, you can display it by selecting an item and then selecting Edit > Properties.

Undo Command
Edit > Undo Allows you to reject the last action that you completed. Up to ten operations are saved in the undo list, and you can undo them by repeated use of the Undo command. The undo list is cleared if you perform any of the following actions:
•

Change the properties of the Drawing view on the View Properties dialog box Turn the display of inconsistency indicators off or on by clicking View > Show Inconsistencies Click File > Save Open a different drawing or toggle to another open drawing Open a new Drawing view or new Engineering Data Editor (EDE) Using commands in the EDE or on the Connector shortcut menu, move a connector to another drawing stockpile Changing or viewing the claim status of drawing objects

•

• • • •

•

An undoable action is defined in several ways. Running a command is usually an action. Modifying item properties is an action, and the action ends when another item is selected. This definition of an action holds true for select sets, too, and for multiple items selected in the EDE. That is, modifying the properties of a select set is one action in and of itself, not one action for each member of the set. The Undo command does not reverse view manipulations; however, the View > Previous command is still available for that purpose. Related Topics • Claim a Drawing Item, page 288 • Claiming Items: An Overview, page 285 • Integrating SmartPlant P&ID with The Engineering Framework, page 371 • Modifying and Moving Placed Items: An Overview, page 206 • Move a Select Set to Another Open Drawing, page 213 • Save As Assembly Command, page 281 SmartPlant P&ID User’s Guide 207

Creating P&IDs in SmartPlant P&ID: An Overview

Undo Your Last Action
Click Undo Tips
• •

.

Pressing Ctrl + Z also undoes your last action. The Undo command stores up to 10 actions making this command available repeatedly. If the Undo button is not available, then the undo list has been cleared, and you can no longer undo your last action. Note

•

•

The Undo command does not reverse view manipulations; however, the View > Previous command is still available for that purpose.

Move Command
Edit > Move Moves items from one location to another. You can specify the locations by clicking the drawing sheet or by entering relative values in the Move ribbon. You can move one or multiple items at a time, and you can move select sets. You can access this command from the Edit menu or the main toolbar. Notes
•

If you want to move an item to another drawing, move it to the Stockpile, open the second drawing and place the item from the stockpile. If you move an item that owns other items, the owned items move also. For example, if you move a vessel that owns trays and nozzles, the trays and nozzles move with the vessel. You can use other view manipulation commands, such as Zoom, Fit, and Pan, while you are using the Move command. When you finish manipulating the view, the software returns you to the Move command at the point where you were when you started manipulating the view.

•

•

Related Topics • Move an Item Using the Move Button, page 210

208 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Move Ribbon
Specifies the from point and to point when you move items. Copy - Copies the items in the select set when you move them. Step Distance - Increases or decreases the value in the ribbon boxes. For example, typing a step value of 0.25 and pointing away from the from point increases the distance in discrete steps, from 0.25 to 0.5, 0.75, and so forth. X - Allows you to enter an explicit value for the distance to move in the x-coordinate, or you can simply observe the value as you drag the object. Y - Allows you to enter an explicit value for the distance to move in the y-coordinate, or you can simply observe the value as you drag the object. Related Topics Move an Item Using the Move Button, page 210 • Move Command, page 208 • Selecting Drawing Items: An Overview, page 132
•

Move an Item With the Select Tool
1. On the main toolbar, click the Select Tool . 2. Position the pointer over the item but not over any of the handles of the item. Tip Dragging a handle modifies the item instead of moving it. 3. Drag the item to its new position.
•

Move an item with precision 1. On the main toolbar, click Select Tool. 2. Position the pointer over the item that you want to move, at a location where the software recognizes a keypoint . Tip The pointer snaps to the keypoint thereby making it easier for you to control the exact locus of the move. 3. Drag the item to its new position.
•

Move an Item Using the Move Button
1. Select one or more items. 2. Select Edit > Move or on the main toolbar, click Move . 3. Click to define the from point or you can use the Move ribbon fields to key in the Step Distance, X and Y direction. 4. Click to define the to point or you can use the Move ribbon fields to key in the Step Distance, X and Y direction. Tip
•

If you want to copy the items, press Ctrl when you place the item.

Notes
•

If you move an item that owns other items, the owned items move also. For example, if you move a vessel that owns trays and nozzles, the trays and nozzles move with the vessel. You can drag an item without using Move. Select the item and then drag it to its new location. If you want to copy the item, press Ctrl while you drag or select Copy on the Move ribbon. You can use the Move ribbon to specify the to point. The values are relative distances along the x- and y-axis, and you must click in the appropriate portion of the drawing to specify to which quadrant you want to move or copy the item or items. You can use other view manipulation commands, such as Zoom, Fit, and Pan, while you are using the Move command. When you finish manipulating the view, the software returns you to the Move command at the point where you were when you started manipulating the view. If you want to move an item to another drawing, move it to the Stockpile, open the second drawing, and place the item from the stockpile. You can also use the Edit > Move to Drawing command.

Move a Line
1. In the Drawing view, select the line that you want to move. 2. Point near the center of the appropriate line. 3. When the pointer turns into a double arrow location and release. Notes
•

, drag the segment to the new

The software applies geometrical line routing rules as you move a line. If you want to override those rules, press Shift as you move the line, or press Alt while routing a line or click Alter Segment on the Line Routing ribbon to override the current line vector and allow routing in any direction and at any angle. When you move a line segment, the software changes the length of attached line segments to accommodate the move. Press Esc at any time to stop changing the selected line. You can change values for the properties of the line by clicking the line and then selecting or typing the new values in the appropriate rows in the Properties window. If the Properties window is not open, you can display it by clicking the line and then selecting Edit > Properties on the main menu bar.

Move a Line Using Vertex Handles
1. Click an existing line in the drawing. 2. Click the vertex handle of the line route that you want to move. 3. Drag the vertex to a new position in the drawing and release. Notes
•

While moving the vertex handle to modify the line segment, click Alter Segment on the Line Routing ribbon or press Alt to allow the line segments to move freely at any angle. Press Esc at any time to stop changing the selected line. You can change values for the properties of the line by clicking the line and then specifying the new values in the appropriate rows in the Properties window. If the Properties window is not open, you can display it by clicking the line and then selecting Edit > Properties on the main menu bar.

• •

SmartPlant P&ID User’s Guide 211

Creating P&IDs in SmartPlant P&ID: An Overview

Move To Drawing Command
Edit > Move To Drawing Allows you to move a select set of drawing items into another open drawing. These conditions must be met in order for this command to be available:
•

The source and destination drawing must be open, and neither of these drawings can be read-only. The drawing objects to be moved must be selected. The selected items must not have a connection to any items outside the select set. You must have the appropriate permissions to modify the items in the select set.

• •

•

If more than one possible destination drawing is open, the Move To Drawing dialog box appears, and you can select the appropriate destination drawing. The Move To Drawing command manipulates the select set in order to make sure the selected items are appropriate items to move. The command removes these objects from the select set:
• • •

Inserted OLE objects are automatically removed from the select set. Title blocks are automatically removed from the select set. If there is a label in the select set and the item that it labels is not in the select set, that label is removed. If there is a dependent object (such as a nozzle, equipment component, actuator, or item note) in the select set, and if the parent object that it is dependent upon is not in the select set, it is removed.

•

The command expands the select set to include the following objects:
•

If there are labels that are not in the select set but are attached to objects in the select set, these labels are automatically added to the select set. If there are dependent objects (such as a nozzle, equipment component, actuator, or item note) not in the select set but they are dependent on objects in the select set, these objects are automatically added to the select set.

•

OPCs cannot be moved from one drawing to another using this command. Related Topics • Modifying and Moving Placed Items: An Overview, page 206 • Move a Select Set to Another Open Drawing, page 213

212 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Move To Drawing Dialog Box
Allows you to choose the destination drawing that you want to place a item(s) into. This dialog box displays only when you have more than one possible destination drawing open. You must also have the item(s) selected that you want to move. Then, click Edit > Move To Drawing and click in the drawing to define the Select from point. The Move to Drawing dialog box displays. It contains a list of possible drawings that your item(s) can be moved to. Select the drawing and click OK. Available drawings - Lists the open drawings that are available to be a destination for the Move To Drawing command. Those drawings that are not included in the list are the source drawing, open read-only drawings, open drawing templates, and open assemblies. Related Topics Move a Select Set to Another Open Drawing, page 213 • Move To Drawing Command, page 212
•

Move a Select Set to Another Open Drawing
1. Open the destination drawing if it is not already open. 2. Select the items that you want to move into the destination drawing. 3. Click Edit > Move To Drawing. 4. In the Drawing view, click the from point. Tips
•

For the purposes of placement in the destination drawing, the from point becomes the origin of the select set.

While you are using a from point (or to in the destination drawing), the pointer is a crosshair. 5. If more than one possible destination drawing is open, then select the desired destination drawing from the Available Drawings list on the Move To Drawing dialog box.
•

6. In the Drawing view of the destination drawing, click the to point. Notes
•

In order for the Move To Drawing command to be available, the following conditions must be met: The source and destination drawing must be open, and neither of these drawings can be read-only. The drawing objects to be moved must be selected. The selected items must not have a connection to any items outside the select set.

•

• •

SmartPlant P&ID User’s Guide 213

Creating P&IDs in SmartPlant P&ID: An Overview
•

You must have the appropriate permissions to modify the items in the select set.

•

Since you have to switch to a different drawing, the Undo command is not available for moving a select set to another drawing. Logical relationships are preserved (for example, loop or package relationships or plant group relationships). Also, if a logical group such as an instrument loop, whose members are all moved to the new drawing, resides in the source drawing stockpile, then that logical group moves to the stockpile of the destination drawing. OPCs cannot be moved from one drawing to another using this command.

Finding and Replacing Drawing Items: An Overview
The software has the ability to find items and inconsistency indicators in your drawing. You can define search criteria based on a catalog item or an item type already in place in your drawing. Or, you can define criteria based on a delivered filter or on a user-defined filter. Having found all drawing items of a certain type, you can modify their properties or reposition them or even replace them with an item of a compatible type. The software also searches your drawing for inconsistency indicators so that you can review and correct inconsistencies systematically. Replacing drawing items is straightforward, too. You have the capability to replace a single drawing item with a comparable item, replace many items one-by-one, or even replace all items of one type at the same time. When you find or replace drawing items, the selected items are added to a select set, and so you can view the common properties of the select set items in the Properties window and edit them if appropriate. The Find and Replace commands are not available in the Engineering Data Editor. Related Topics • Find a Drawing Item by Using a Catalog Item, page 216 • Find an Item by Using a Filter, page 216 • Find an Item by Using an Existing Drawing Item, page 217 • Find Drawing Inconsistencies, page 215 • Replace a Single Drawing Item, page 218 • Replace Multiple Drawing Items Using Catalog Items, page 219

214 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Find Command
Edit > Find Displays the Find and Replace dialog box, which allows you to search a drawing for items by using catalog items or a filter or to find inconsistencies in your drawing. As drawing items are found, they are added to a select set. You can replace items by using the options on this dialog box, too. Related Topics • Find a Drawing Item by Using a Catalog Item, page 216 • Find an Item by Using a Filter, page 216 • Find an Item by Using an Existing Drawing Item, page 217 • Find Drawing Inconsistencies, page 215 • Finding and Replacing Drawing Items: An Overview, page 214

For detailed information about all your drawing inconsistencies one-byone, 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.

Find an Item by Using a Filter
1. Click Edit > Find. 2. On the Find and Replace dialog box, select <Filter...> from the Find what list. 3. On the Select Filter dialog box, select a filter to locate your drawing items, and click OK. 4. Select an option from the Search in list. Tip Selecting Active window disables the Scroll mode option. Selecting Active Document enables the Scroll mode option. 5. Click Find to search for and select the next item match in your drawing or click Find All to select all matches in the drawing items that meet the selected filter.
•

Notes
•

Use the Scroll mode options to control how the Drawing view changes when a drawing item is found. Use the Direction options to change the order in which drawing items are found.

Find a Drawing Item by Using a Catalog Item
1. Click Edit > Find 2. On the Find and Replace dialog box, select <Catalog Item> from the Find what list. 3. On the Select Catalog Item dialog box, select the catalog item type to search for, and click OK. 4. Select an option from Search in. Tip Selecting Active window disables the Scroll mode option. Selecting Active Document enables the Scroll mode option. 5. Click Find to select the first match in the drawing or click Find All to select all matches in the drawing. All the items are in the select set, and you can view the common properties of the set in the Properties window.
•

Notes
•

Use the Scroll mode options to control how the Drawing view changes when a drawing item is found.

216 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview
•

Use the Direction options to change the order in which single drawing items are found.

Find an Item by Using an Existing Drawing Item
1. Select an item in your drawing. 2. Click Edit > Find. 3. On the Find and Replace dialog box, select an option from the Search in list. Tips
•

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.
•

Notes
•

Use the Scroll mode options to control how the Drawing view changes when a drawing item is found. Use the Direction options to change the order in which drawing items are found.

Replace Multiple Drawing Items Using Filters
1. Click Edit > Replace. 2. On the Find and Replace dialog box, select <Filter> from the Find what list. 3. On the Select Filter dialog box, choose the filter that you want to use to find drawing items, and click OK. 4. Select <Browse> from the Replace with list. 5. On the Select Catalog Item dialog box, choose the catalog item that you want to replace the drawing items you find with your filter, and click OK. 6. Select an option from the Search in list.

218 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Tip Selecting Active window disables the Scroll mode option. Selecting Active Document enables the Scroll mode option. 7. Click Find to search for and select the first match and to make the Replace All button available.
•

8. Click Replace All to replace all instances of the selected drawing item with the item defined in the Replace with box. Note
•

Use the Scroll mode options to control how the Drawing view changes when a drawing item is found.

Replace Multiple Drawing Items Using Catalog Items
1. Click Edit > Replace. 2. On the Find and Replace dialog box, select <Catalog Item> from the Find what list. 3. On the Select Catalog Item dialog box, select the item type from the catalog that you want to find in your drawing, and click OK. 4. On the Replace with list select <Browse>. 5. On the Select Catalog Item dialog box, select the item type that you want to replace the found item type with, and click OK. 6. Select an option from the Search in list. Tip Selecting Active window disables the Scroll mode option. Selecting Active Document enables the Scroll mode option. 7. Click Find to search for and select the first match and to enable the Replace All command.
•

8. Click Replace All to find and replace all matching items. Note
•

Use the Scroll mode options to control how the Drawing view changes when a drawing item is found.

Replace Mode Command
Tools > Replace Mode Controls whether catalog items are placed as substitutions for existing drawing items or placed normally. When this mode is active, the software places catalog items only when they replace an existing drawing item. When this mode is not active, the software places catalog items as usual. The Replace Mode command copies properties of the current item onto the new item. The Replace Mode command works for like objects only. The item that you want to replace in the drawing must be of the same class: equipment class, instrument class, and so forth. For instance, you can replace a vessel with another vessel, but you cannot replace a vessel with a pump. The software also takes into consideration the connect points that are in use on the currently placed item. This stipulation means you cannot replace an angled item for a straight item when the straight item is already connected at both ends. For example, you cannot replace a Flanged Nozzle with an Angle Parametric Nozzle if the nozzle is already connected to a pipe run, likewise for angled valves. Replace Mode also works on parametrics. Resizing is maintained during the replace if both symbols have an identical relative path. The Replace Mode functions very much like Edit > Replace. However, the replace mode works for only one item at a time and is not activated from inside a dialog box. You cannot use the Replace Mode for pipe runs or signal lines. You also cannot use this mode to replace items that are multiple representations. If you need to replace pipe runs or signal lines, use the the Edit > Replace command. Related Topics • Cutting or Deleting Items: An Overview, page 232 • Finding and Replacing Drawing Items: An Overview, page 214 • Place Multiple Representations, page 142 • Replace an Item Using Replace Mode, page 220 • Replace Command, page 217

Replace an Item Using Replace Mode
1. Click Tools > Replace Mode or click Replace Mode on the main toolbar. 2. In Catalog Explorer, select the item that you want to place in the drawing. Tip You cannot use this mode to replace drawing items with items from the Engineering Data Editor. 3. Move the selected catalog item over the drawing item that it is to replace.
•

220 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Tips
•

The Replace Mode command works for like objects only. The item that you want to replace in the drawing must be of the same class: equipment class, instrument class, and so forth. For instance, you can replace a vessel with another vessel, but you cannot replace a vessel with a pump. The software also takes into consideration the connect points that are in use on the currently placed item. This stipulation means you cannot replace an angled item for a straight item when the straight item is already connected at both ends. For example, you cannot replace a Flanged Nozzle with an Angle Parametric Nozzle if the nozzle is already connected to a pipe run, likewise for angled valves. If the drawing item can be replaced with the catalog item, the replace is displayed, and the drawing item is selected. icon appears, click to replace the drawing item with the

You cannot use the Replace Mode option for pipe runs or signal lines. You also cannot use this mode to replace items that are multiple representations. The Replace Mode command also copies properties of the current item onto the new item.

Find and Replace Dialog Box
Sets options for searching for and replacing drawing items. This dialog box opens when you click either Edit > Find or Edit > Replace. Depending on your command choice, you access one of the following tabs. Note
•

The Replace command does not allow a non-breaking component to be replaced with a break component. Piping components and instruments can be defined in the catalog as break components. Reducers are good examples of break components. When a break component is placed into a pipe run, the pipe run is automatically broken at that point. A break component suppresses the consistency checking and limits the propagation of the properties that are broken. The Property Breaks command in the Catalog Manager is used to define a catalog item as a break component.

Find Tab (Find and Replace Dialog Box)
Allows you to search the drawing for specified items. Find what - Lists search criteria, and allows you to enter new search criteria or select from a list of the five most recently used criteria. The items listed above the dashed line in the list are used to set new search criteria by searching using the Catalog Item, Filter, or Inconsistency options. Selecting the Catalog Item option opens the Select Catalog Item dialog box. Selecting the Filter option opens the Select Filter dialog box. Search in - Defines the scope of the search. You can search the active drawing or just the contents of the active window. If the Active Window option is selected, the Scroll mode feature is not available. If the Active Drawing option is selected, the Scroll mode feature is automatically set to Zoom, and you can select a preferred scroll mode. Scroll mode - Defines how the active view should be changed when a drawing item is found. If you select Zoom, the active view is zoomed to a multiple of the range of the found drawing item. If you select Pan, the active view is shifted without changing the view scale so that the center of the drawing item is in the center of the view. If Scroll Mode feature is turned off, then the active view is left unchanged.

222 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Direction - Specifies the direction of the search. Because drawing objects are stored linearly in the database, using either Next or Previous moves forward or backward through the document. Find - Initiates a search for a single item that is part of the specified search scope. Each time you click Find, the software searches for and highlights the next drawing item that matches the defined search criteria in the defined direction. Each time a item is found that matches the Find what criteria, the active view is changed based on the Scroll mode setting. Find All - Initiates a search for all items matching the search criteria and adds them to the select set. The active view is updated based on the Scroll mode setting. Related Topics Find a Drawing Item by Using a Catalog Item, page 216 • Find an Item by Using a Filter, page 216 • Find an Item by Using an Existing Drawing Item, page 217 • Find Command, page 68 • Find Drawing Inconsistencies, page 215 • Replace Command, page 217
•

Replace Tab (Find and Replace Dialog Box)
Sets options for searching for and replacing drawing items. This tab is on the Find and Replace dialog box. Find what - Lists search criteria, and allows you to enter new search criteria or select from a list of the five most recently used criteria. The items listed above the dashed line in the list are used to set new search criteria by searching using the Catalog Item, Filter, or Inconsistency options. Selecting the Catalog Item option opens the Select Catalog Item dialog box. Selecting the Filter option opens the Select Filter dialog box. Since you cannot replace an inconsistency, if you select the Inconsistency option from the Find what list, the Replace with option is not available. Replace with - Allows you to enter a new replacement item or select a replacement item from a list of the five most recently used items, which are listed below the dashed line. You can define a new replacement item by selecting Browse and picking a catalog item from the Select Catalog Item dialog box. Search in - Defines the scope of the search. You can search the active drawing or just the contents of the active window. If the Active Window option is selected, the Scroll mode feature is not available. If the Active Drawing option is selected, the Scroll mode feature is automatically set to Zoom, and you can select a preferred scroll mode.

SmartPlant P&ID User’s Guide 223

Creating P&IDs in SmartPlant P&ID: An Overview Scroll mode - Defines how the active view should be changed when a drawing item is found. If you select Zoom, the active view is zoomed to a multiple of the range of the found drawing item. If you select Pan, the active view is shifted without changing the view scale so that the center of the drawing item is in the center of the view. If Scroll Mode feature is turned off, then the active view is left unchanged. Direction - Specifies the direction of the search. Because drawing objects are stored linearly in the database, using either Next or Previous moves forward or backward through the document. Find - Initiates a search for a single item that is part of the specified search scope. Each time you click Find, the software searches for and highlights the next drawing item that matches the defined search criteria in the defined direction. Each time a item is found that matches the Find what criteria, the active view is changed based on the Scroll mode setting. Replace - Replaces the item selected when you clicked Find. The Replace button is available only when the item found can be replaced by the item defined in the Replace with box. Each time you click Replace, the located item is replaced, and the Find command continues based on the Direction setting. As each drawing item is found, the active view is updated based on the Scroll mode setting. Replace All - Replaces all items that match the Find what criteria with the item defined in the Replace with box without prompting you. After all of the replacements are completed, the software reports the number of matches found and the number of replacements that were made. The active view is also updated depending on the Scroll mode setting. Related Topics • Find Command, page 68 • Replace a Single Drawing Item, page 218 • Replace Command, page 217 • Replace Multiple Drawing Items Using Catalog Items, page 219 • Replace Multiple Drawing Items Using Filters, page 218

Select Catalog Item Dialog Box
Allows you to select a catalog item type for the search criteria when you use the Find or Replace commands. This dialog box is constructed much the same as the Catalog Explorer window. Tree View - Displays a hierarchy of nodes that contain catalog items. You can navigate through the tree view by clicking the different nodes. To open a node, click the plus sign to the left of the node name. To close a node, click the minus sign to the left of the node name. If the selected node contains any drawing symbols, the software displays them in the list view.

224 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview List View - Displays the symbols that are associated with the active node in the tree view. Only the contents of one node appear. Navigation Bar - Allows you to see and use Catalog Explorer shortcut buttons to navigate to catalog items more quickly. Related Topics • Find a Drawing Item by Using a Catalog Item, page 216 • Find an Item by Using a Filter, page 216 • Find an Item by Using an Existing Drawing Item, page 217 • Find Command, page 68 • Find Drawing Inconsistencies, page 215 • Replace Command, page 217

Manipulating Items With Component Handles: An Overview
Many components allow you to change their shape or orientation using component handles. Component handles allow you to rotate or mirror a component around axes, and you can use component handles to scale or resize parametric items in a drawing. Items can have several different types of component handles.
•

The mirror handle allows you to mirror about the horizontal and vertical axes, defined in relation to the origin of the item. You can mirror items by dragging the mirror handle in the appropriate direction. The software shows you the result of the operation dynamically so that you can be sure to mirror the item correctly. The rotate handle provides a mechanism for rotating components around their origin. You can rotate items by dragging the rotate handle in the appropriate direction. The software shows you the result of the operation dynamically so that you can be sure to rotate the item correctly. Parametric handles allow you to modify different parts of parametric items. Standard parametric handles represent up to four driving dimensions that have been applied to an item. Parametric handles can be located in four standard positions: top center, bottom center, left center, and right center of the range of an item. You can scale the item parametrically by dragging any parametric handle. The software shows you the result of the operation dynamically so that you can be sure to scale the item correctly. Scale handles allow you to change the scale of a drawing item. A scalable symbol displays four solid square scale handles. A handle is displayed at each corner of the range of the symbol. You can drag any one of the handles, and the symbol scales either larger or smaller depending on the direction that you drag the handle.

•

•

•

SmartPlant P&ID User’s Guide 225

Creating P&IDs in SmartPlant P&ID: An Overview Not all drawing items in can be mirrored, rotated, or scaled. Catalog Manager defines these properties for items when the symbols for the items are created. Note also that select sets cannot be mirrored or rotated with component handles. The Mirror and Rotate commands on the toolbar can be used for select sets. Related Topics • Mirror an Item About an Existing Mirror Axis or Linear Element, page 229 • Mirror an Item Using Its Mirror Handle, page 228 • Rotate an Item About an Axis You Define, page 231 • Rotate an Item Using Its Rotate Handle, page 231 • Scale a Drawing Item, page 226 • Scale a Parametric Item, page 226

Scale a Parametric Item
1. Select the parametric drawing item that you want to resize. 2. Drag one of the parametric handles change the size of the item. in the middle of each side of the item to

3. Continue dragging the parametric handles until the item is the size that you want. Note
•

Certain properties of the parametric item, such as angle values, remain the same when you resize it.

A scalable symbol includes four solid square scale handles . A handle is displayed at each corner of the range of the symbol.

Scalable symbols are created by setting the IsScalable property of the symbol to True in Catalog Manager. 2. Drag any one of the handles to make the symbol either larger or smaller, depending on the direction that you drag the handle.
•

Mirror Command
Edit > Mirror Reflects one or more selected items about a line or axis that you define. You can mirror without copying, or mirror and copy. To mirror an item using a defined mirror axis, click Mirror on the main toolbar. The software reflects one or more selected items about that axis. You can mirror the item itself, or you can make a copy of the item in the mirrored position. You can also use mirror handles. The mirror handle appears at the upper right of the item. For example, dragging a mirror handle across an x- or y-axis causes the item to appear mirrored about its center. Mirroring is displayed dynamically so that you can see the result of your action before you release the item to place it. Related Topics • Mirror an Item About a Mirror Axis That You Define, page 228 • Mirror an Item About an Existing Mirror Axis or Linear Element, page 229 • Mirror an Item Using Its Mirror Handle, page 228

Mirror Ribbon
Appears on the main toolbar when the Mirror command is active, and allows you to either specify mirroring options or to observe mirroring options. Copy - Copies the item or items when you mirror them. Position Angle - Sets the angle of the mirror axis. The origin of the angle measurement is the point that you clicked for the beginning of the mirror axis. Setting the position angle to zero extends the axis horizontally to the right of the screen, 90 extends the axis vertically to the top, 180 extends the axis horizontally to the left, and 270 extends the axis vertically to the bottom. Note
•

To determine the option name on the ribbon, pause over an option and read the ToolTip.

Mirror an Item Using Its Mirror Handle
1. Select an item in the drawing. 2. Click the mirror handle or click Mirror on the main toolbar. 3. Drag the mirror handle in the direction that you want to mirror the item. Related Topics • Copying Items: An Overview, page 239 • Modifying and Moving Placed Items: An Overview, page 206

Mirror an Item About a Mirror Axis That You Define
1. Select one or more items. 2. On the main toolbar, click Mirror . 3. Define one end of the mirror axis by clicking in an appropriate empty portion of the drawing or by clicking a keypoint . The software displays the mirror axis and the mirrored items dynamically (that is, as you move your pointer). 4. Position the pointer so that the mirrored items appear where you want them, and then click. Tip
•

If you want to copy the mirrored items, hold Ctrl when you click to place your items.

Notes
•

Instead of positioning the mirror axis dynamically, you can use the Position Angle box on the Mirror ribbon. You can use other view manipulation commands, such as Zoom and Pan, while you are using the Mirror command. When you finish manipulating the view, the software returns you to the Mirror command at the point where you were when you started manipulating the view. If an actuator is upside down when placed on an instrument valve, then use Rotate or Mirror to align the actuator in the appropriate position.

•

•

228 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Mirror an Item About an Existing Mirror Axis or Linear Element
1. Select one or more items. 2. On the main toolbar, click Mirror . 3. By dragging the pointer over the item, locate a mirror axis. The mirrored items are displayed dynamically on the other side of the mirror axis. 4. Position the pointer so that the mirrored items appear where you want them, and then click. Tip
•

If you want to copy the mirrored items, hold down Ctrl when you click to place your items.

Notes
•

You can use other view manipulation commands, such as Zoom and Pan, while you are using Mirror. When you finish manipulating the view, the software returns you to Mirror at the point where you were when you started manipulating the view. If an actuator is upside down when placed on an instrument valve, you can use Mirror to align the actuator in the appropriate position.

Rotate Command
Edit > Rotate Rotates one or more items a precise distance or angle about a specified point. To rotate and item, select the item and then click Rotate. To define the rotation axis, you must specify two points by clicking in the drawing. First Click - Defines the rotation point. Second Click - Defines the rotation handle. The software then dynamically displays a reference axis for the rotation. If you want to define a precise location for the rotation, you can enter values in the Rotate ribbon. You can enter increments in the Step Angle box if you want to control the increments of the rotation. For example, if the box is set to 30.0, the rotation is displayed in 30 degree increments. The default setting is 0 degrees so that the rotation is fully dynamic, that is, it can take on any value. The Rotation Angle box on the ribbon displays the angle of change between the old and new position. Angles are always displayed as a positive value.

SmartPlant P&ID User’s Guide 229

Creating P&IDs in SmartPlant P&ID: An Overview Third Click - Completes the rotation of the item. Also, you can rotate an item about its center with the rotate component handle . Keeping the rotate component handle close to the center of an item causes the item to rotate at 90 degree increments. Dragging the rotate component handle further away from the center of the item causes the item to rotate at smaller angles. The angle increments become smaller the farther away your pointer is from the center of rotation. Related Topics • Rotate an Item About an Axis You Define, page 231 • Rotate an Item Using Its Rotate Handle, page 231

Rotate Ribbon
Appears when the Rotate command is active, and allows you to either observe rotation options as you rotate an item or specify rotation options. Copy - Creates a copy of the item that you are rotating. Position Angle - Displays the angle between the horizontal axis through the center of rotation (A) and the point that you rotate from (B). Then, if you rotate the item, the position angle (C) changes to become the angle between the horizontal axis and the point to which you rotate. The position angle is always a positive value measured counter-clockwise from the axis.

Rotation Angle - Defines the rotation angle. The rotation angle is the angle between the point from which you rotate and the point to which you rotate. In the following picture, the center of rotation (A) shows the point (B) from which you rotate the item.

230 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview The rotation angle (C) is the angle of change between the old and new positions of the rotated item. The value is always positive. Step Angle - Specifies the rotation step angle. The step angle specifies the increments, in degrees, that an item rotates on a rotation axis. You can enter increments in the Step Angle box. For example, if the box is set to 30.0, the rotation is displayed in 30 degree increments. The efault setting is 0 degrees so that the rotation is fully dynamic. Related Topics • Rotate an Item About an Axis You Define, page 231 • Rotate an Item Using Its Rotate Handle, page 231 • Rotate Command, page 229

Rotate an Item Using Its Rotate Handle
1. Select an item in the drawing. 2. Click the rotate handle . 3. Drag the rotate handle in the direction that you want to rotate the item. Notes
•

You can click the rotate handle closer to or further from the center of the item to change the step angle for the rotation. You can rotate items using the Rotate button on the main toolbar, too.

Rotate an Item About an Axis You Define
1. Select one or more items. 2. On the main toolbar, click Rotate 3. Click at the center of rotation. 4. Then, click to define the other end of the rotation axis. Tip The software dynamically displays the rotation axis and items being rotated. The location and position of the rotation axis defines the rotation from point. 5. Rotate the items into position by dragging the rotation axis.
•

.

6. Click to define the rotation to point.

SmartPlant P&ID User’s Guide 231

Creating P&IDs in SmartPlant P&ID: An Overview Notes
•

To rotate by arbitrary increments, type a value in the Step Angle box on the Rotate ribbon. In order to copy the rotated items into the new position, you can hold Ctrl while you click to define the to point. You can use other view manipulation commands, such as Zoom and Pan, while you are using the Rotate command. When you finish manipulating the view, the software returns you to the Rotate command at the point that you were when you started manipulating the view.

Cutting or Deleting Items: An Overview
You can delete items from a drawing by selecting them and clicking Cut on the main toolbar or by pressing Delete on the keyboard. Clicking Cut places the selected item on the Clipboard. This action allows you to paste the item in the same location in the drawing and then move it to another location as appropriate. The properties of an item affect what happens when you cut or delete it. If the item has a TagReqdFlag property of True, which you set in Catalog Manager, and is included in the StockpileItems group, which you set in Options Manager, cutting or deleting the item from the drawing places the item in the Stockpile. The data associated with the item remains in the database. If the TagReqdFlag property is False, when you cut or delete the item, it is removed from the database as well as the drawing. Notes
•

You can press Delete on the keyboard to remove an item or a select set from the drawing. First, select the item or group of items in the drawing. Then you must point to the Drawing view before you press Delete. The software does not delete the item or group of items if the pointer is located anywhere outside the Drawing view. You can delete an item by selecting and right-clicking it. On the shortcut menu click Delete. If you select Delete from Model, the selected item is not only deleted from the drawing but also from the database. In other words, it is not placed in the Stockpile, regardless of its properties. Deleted stockpile items automatically go into the Stockpile. You can move an item into the stockpile of a specific drawing. For more information, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250.

•

•

232 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Related Topics • Cut an Item from the Drawing, page 233 • Delete an Item from the Drawing, page 236 • Move a Stockpile Item to the Stockpile of Another Drawing, page 250 • Remove an Item from a Drawing, page 237 • Remove an Item from the Model, page 238

Cut Command
Edit > Cut Cuts selected items from the drawing and pastes them to the Clipboard. The selected items replace the previous contents of the Clipboard. When you cut items, they go to the Stockpile, given appropriate stockpile settings. Related Topics Cut an Item from the Drawing, page 233 • Cutting or Deleting Items: An Overview, page 232 • Selecting Drawing Items: An Overview, page 132
•

Cut an Item from the Drawing
1. Select the item. 2. Click Cut Notes
•

.

After you cut an item and its associated properties, they are placed on the Clipboard. You can then use Paste or Paste Special to paste the item and its properties into the current drawing or into other drawings or documents. The properties of an item affect what happens when you cut or delete it. If the item has a TagReqdFlag property of True, which you set in Catalog Manager, and is included in the StockpileItems group, which you set in Options Manager, cutting or deleting the item from the drawing places the item in the Stockpile. However, the data associated with the item remains in the database. If the TagReqdFlag property is False, when you cut or delete the item it is removed from the database as well as the drawing. However, off-page and utility connectors are always placed in the Stockpile when deleted regardless of the TagReqdFlag property and settings in Options Manager. Deleted stockpile items automatically go into the Stockpile. You can move an item into the stockpile of a specific drawing. For more information, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250.

Paste Command
Edit > Paste Inserts the Clipboard contents at the specified location. The command is not available if the Clipboard is empty. Related Topics • Cutting or Deleting Items: An Overview, page 232 • Paste an Item With a Different Format, page 273 • Paste an Item, page 234

Paste an Item
1. Open the drawing in which you want to paste the contents of the Clipboard. 2. On the main toolbar, click Paste then select Paste. Notes
•

or right-click a blank area in the drawing and

The contents of the Clipboard remain unchanged until you use the Copy or Cut command again. Equipment components cannot be pasted back into the drawing after they have been removed using the Cut command. You cannot paste items if the Clipboard is empty (that is, if you have not previously used the Copy or Cut commands). Pasted text and items remain selected after you use the Paste command.

•

•

•

Related Topics • Cutting or Deleting Items: An Overview, page 232

234 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Select All Command
Edit > Select All Selects all visible items in a view. Note
•

You can also access this command by right-clicking a blank area in a drawing or table. On the shortcut menu that displays, click Select All.

Modify an Item With the Select Tool
1. Click the Select Tool 2. Select an item. 3. Position the pointer over one of the item handles. 4. Drag the item handle to modify the item. For example, you can rotate an item with its rotate handle, mirror an item with its mirror handle, scale an item with its scale handle, or resize an item with its parametric handle. Related Topics • Manipulating Items With Component Handles: An Overview, page 225 • Selecting Drawing Items: An Overview, page 132 .

Delete Command
Edit > Delete Removes the selected item. You cannot paste items that you delete; however, if the item moves to the Stockpile on deletion, then you can place that item again from the stockpile. Notes
•

The properties of an item affect what happens when you cut or delete it. If the item has a TagReqdFlag property of True, which you set in Catalog Manager, and is included in the StockpileItems group, which you set in Options Manager, cutting or deleting the item from the drawing places the item in the Stockpile. However, the data associated with the item remains in the database. If the TagReqdFlag property is False, when you cut or delete the item it is removed from the database as well as the drawing.

SmartPlant P&ID User’s Guide 235

Creating P&IDs in SmartPlant P&ID: An Overview
•

However, off-page and utility connectors are always placed in the Stockpile when deleted regardless of the TagReqdFlag property and settings in Options Manager. Also, you can press Delete on the keyboard to remove an item or a group of items in a fence from the drawing. First, select the item or group of items in the drawing. Then you must point to the Drawing view before you press Delete. The software does not delete the item or group of items if the pointer is located anywhere outside the Drawing view. Deleted stockpile items automatically go into the Stockpile. You can move an item into the stockpile of a specific drawing. For more information, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250.

Delete an Item from the Drawing
1. Select an item. 2. Click Edit > Delete or press Delete on the keyboard. Tip
•

When you use the Delete key on the keyboard to remove an item or items from the drawing, you must point to the Drawing view before you press Delete. The software does not delete the item if the pointer is located anywhere outside the Drawing view.

Notes
•

If you want to delete the item, its location in the drawing, and its properties in the database, right-click the item and select Delete From Model from the shortcut menu. The item is not placed in the stockpile regardless of its settings or properties. Deleted stockpile items automatically go into the Stockpile. You can move an item into the stockpile of a specific drawing. For more information, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250.

Remove an Item from a Drawing
1. Right-click the item that you want to remove. 2. On the shortcut menu, click Delete. Tips
•

You can press Delete on the keyboard to remove an item or a group of items from the drawing, too. First, select the item or items in the drawing. Then you must place the pointer in the Drawing view and press Delete. The software does not delete the item if the pointer is located anywhere outside the Drawing view. Or you can select Edit > Delete on the main menu bar after you select the items. You can also delete an item from the model when it is already in a stockpile. Select the item in the Engineering Data Editor, and click the Delete Stockpile Item command on the Stockpile menu of the Engineering Data Editor.

•

•

Notes
•

The properties of an item affect what happens when you cut or delete it. If the item has a TagReqdFlag property of True, which you set in Catalog Manager, and is included in the StockpileItems group, which you set in Options Manager, cutting or deleting the item from the drawing places the item in the Stockpile. However, the data associated with the item remains in the database. If the TagReqdFlag property is False, when you cut or delete the item it is removed from the database as well as the drawing. For more information on deleting items from the model, see Remove an Item from the Model, page 238. When you delete inline components, the software automatically mends the pipe or signal run. A stockpile item that is deleted automatically goes to the Stockpile. You can move it to a drawing stockpile from the Stockpile.

Delete From Model Command
Connector Shortcut Menu > Delete From Model Deletes the selected item from the database; if you are deleting a connector, then its partner is deleted from the stockpile as well. Notes
•

Unlike the standard Delete command, which moves the selected item to the Stockpile, this command removes the selected items or connector and its partner from the model completely. In the case of the connector, the command is not available unless the partner connector is in the Stockpile.

Remove an Item from the Model
1. In the Drawing view, right-click the item that you want to delete in order to display the shortcut menu. Tips
•

You can delete a select set from the model by choosing the items and then right-clicking on any member of the set to display the shortcut menu.

You can also delete an item from the model when it is already in a stockpile. Select the item in the Engineering Data Editor, and click the Delete Stockpile Item command on the Stockpile menu of the Engineering Data Editor. 2. On the shortcut menu, click Delete from Model to delete the item from the drawing and from the plant model. That is, the item is not placed in the stockpile, and when you save the drawing, no data associated with the item remains in the database.
•

Notes
•

You can only remove items from the plant model that do not share a relationship with another drawing. You can permanently remove items that are not flagged as required for the model by selecting Delete from the shortcut menu.

•

238 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview
•

The properties of an item affect what happens when you cut or delete it. If the item has a TagReqdFlag property of True, which you set in Catalog Manager, and is included in the StockpileItems group, which you set in Options Manager, cutting or deleting the item from the drawing places the item in the Stockpile. However, the data associated with the item remains in the database. If the TagReqdFlag property is False, when you cut or delete the item it is removed from the database as well as the drawing. When you delete inline components, the software automatically mends the pipe or signal run. Deleted stockpile items automatically go into the Pant Stockpile. You can move an item into the stockpile of a specific drawing. For more information, see Move a Stockpile Item to the Stockpile of Another Drawing, page 250.

Copying Items: An Overview
Copying an item makes it possible to use a drawing item that is already in place as a starting point for placing a new item, without removing the current item from the drawing. Several methods exist for doing this, such as using the Copy button on the main toolbar or using Ctrl while you move, mirror, or rotate a drawing item. Remember that placement rules are in effect when you are copying an item to a new location, just as they are when you originally place an item from a stockpile or from Catalog Explorer. So a copied nozzle must be placed on a piece of equipment, for instance. Related Topics • Copy an Item With the Select Tool, page 240 • Copy an Item, page 240 • Paste an Item With a Different Format, page 273 • Paste an Item, page 234 • Rotate an Item About an Axis You Define, page 231

Copy an Item
1. Select an item. 2. On the main toolbar, click Copy Notes
•

.

After you copy an item, it is placed on the Clipboard. Then you can use Paste to place it on the current drawing. When you paste the item, the software frequently pastes it on top of the item that you copied. To see the pasted item, drag it to its new location in the drawing. You can copy an item with the Move command,too. Select the item, click on the toolbar, and press Ctrl as you place the item in the Move drawing. You can do the same with a select set.

Copy an Item With the Select Tool
1. Click Select Tool 2. Select an item. 3. Position the pointer over the item, but not over any of the handles of the item. 4. Hold Ctrl and drag the copy to its new location. Placement rules are in effect, and so you must place the copy in an allowed position as if it were a new catalog item. Related Topics Copying Items: An Overview, page 239 • Selecting Drawing Items: An Overview, page 132
•

on the main toolbar.

240 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Selecting Connected Items: An Overview
You can use the Select Connected Items command to navigate the line connectivity from a selected line segment to add components and other runs to a select set based on matching properties. In cases where you want the software to continue constructing a select set beyond a break in a line, for example, a nozzle, this command makes it possible to accomplish that goal. This functionality is useful for finding branches from runs and finding all the runs and components on an entire drawing that have a common property value. Once the items are selected in the drawing, it is then a simple matter to choose the select set in the Properties window and continuing editing properties for not only runs, but also lines and networks and all runs included in the drawing. Note
•

Select Connected Items Command
Edit > Select Connected Items Opens the Select Connected Items dialog box, which allows you to create a select set that includes the active line and disconnected lines and inline components in any network. This command is available only when either a single line segment or a single component is selected on the drawing; however, once the dialog box is open, you can change the selected item in the drawing and change the scope of the select set freely. Related Topics • Create a Select Set From a Line, page 243 • Routing Lines: An Overview, page 144 • Select an Item Using the Configuration (PickQuick) Tool, page 136 • Selecting Connected Items: An Overview, page 241 • Selecting Drawing Items: An Overview, page 132

SmartPlant P&ID User’s Guide 241

Creating P&IDs in SmartPlant P&ID: An Overview

Select Connected Items Dialog Box
Allows you to construct a select set from lines and inline components, even if there are breaks in a network. This dialog box remains open until you dismiss it, and you can highlight items in the drawing and manipulate members of the select set while the dialog is active. The Select Connected Items command, which appears both on the Edit menu and on the Line Shortcut menu, is available only when either a single line segment or a single component is selected. Scope - Provides options for defining the extent of your select set. The Scope List allows you to choose extent, and the Include Runs and Include Components buttons allow you to incorporate different items into the select set. At no time can neither the Include Runs nor Include Components buttons be selected; that is, one or the other or both is always active. Scope List - Allows you to choose from Run, Line, Network, Drawing. The default value for this list is Line. Notes
•

The Run option means that lines in a single run are selected. The Line option selects runs that are connected at end points, including components. The Network option adds branches, and the Drawing option selects all the runs and inline components in the open drawing. Include Runs - Incorporates lines into the select set. Include Components - Adds inline components into the select set.

Matching Properties - Displays options for defining the select set according to common properties. The properties for the originally selected item are displayed by default. Alphabetic - Lists properties in alphabetical order. Categorized - Displays properties grouped by specific categories. By default the properties are displayed categorically. Categories are defined and properties are assigned to those categories in Data Dictionary Manager. Preview - Highlights in the Drawing view the items that are selected according to common properties in the Properties List of this dialog box. Properties List - Allows you to choose common properties for your select set. You can select more than one property in this list by using the Ctrl or Shift keys. Related Topics Create a Select Set From a Line, page 243 • Select an Item, page 135 • Select Connected Items Command, page 241
•

242 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Create a Select Set From a Line
1. Select a single line segment or inline component in the drawing. 2. Click Edit > Select Connected Items. 3. On the Select Connected Items dialog box, you can change the scope of the select set by changing the display in the Scope list. 4. You can change the scope to include inline components or exclude lines, too, by using the Include Runs and Include Components buttons. 5. At any time, you can select a different line segment or component in the drawing in order to change the properties displayed in the dialog box. Tip The properties for the new selection are displayed in the Select Connected Items dialog box, but the display of the Properties window itself is not updated until you click OK. 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.
•

Tips
•

You can use the Ctrl or Shift buttons 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, page 85. Notes
•

If you click Cancel, the Select Connected Items dialog box closes, and the original item is selected in the drawing.

Modifying Item Properties: An Overview
When you use the design software to produce drawings, it is important to be able to specify and change the properties of the items that you place in your diagram. You can review and edit the properties of an item in the Properties window. Or you can open the Engineering Data Editor of the drawing data and edit properties in the cells of the table. In the Engineering Data Editor, items that belong to another drawing cannot be edited. 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; you can copy, cut, and paste properties, too, with the same restriction. In the Properties window you are also constrained to edit only those properties that are not read-only. Once you have populated the properties of an item you can, for instance, run reports that display the items and their properties, or create filters and control Drawing views so that only items with specified properties are displayed, or label items so that their properties are displayed graphically. Related Topics • Copy Bulk Properties, page 87 • Import Aspen Zyqad Stream Data, page 329 • Modify an Item With the Select Tool, page 235 • Modify the Table Properties of an Existing Engineering Data Editor View, page 56 • Paste Bulk Properties, page 88 • Review and Edit Item Properties, page 86 • Working With the Properties Window: An Overview, page 83

244 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Description Dialog Box
Opens when you click the ellipses next to the Description property in the Properties window, allowing you to enter long text descriptions for items.

Description - Allows you to type a description for the item. This box can contain a link to a Web address, formatted like this: http://www.intergraph.com. You can also link to a file on your file system by entering the UNC path like this: file://servername/sharename/directory/document.extension. Note
•

Very long descriptions are not displayed in their entirety in labels, reports, and so forth.

Hold Status Text Dialog Box
Opens when you click the Hold Text calculation button text value. and allows you to enter a

Description - Allows you to type a description for the item. This box can contain a link to a Web address, formatted like this http://www.intergraph.com. You can also link to a file on your file system by entering the path like this: file://UNC_path/share/document.extension. Note
•

Insulation Spec Dialog Box
Opens when you click the ellipses for the Insulation Spec property in the Properties window, allowing you to specify an insulation specification for the selected item or items. You can choose a specification from either of the following lists.

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.

246 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Note
•

The path to the plant insulation specification file is defined in Options Manager. Any modifications to insulation specifications are carried out in Insulation Specification Manager.

Related Topics • Assign an Insulation Specification, page 247

Assign an Insulation Specification
1. Select the item that you want to add an insulation specification to. 2. Click the Insulation Spec property box in the Properties window. 3. Click the Calculation button . 4. On the InsulationSpec dialog box, choose a specification from either the Matching or the All lists. Tip
•

If you have already specified other insulation properties, such as the insulation temperature, type, or purpose, then the Matching list contains only those insulation specifications that agree with the properties already chosen; nonetheless, you can choose a specification from the All list.

Note
•

If you assign a heat tracing to an item before you assign insulation properties, your choices of insulation properties and specifications are restricted.

Note Text Dialog Box
Opens when you click the Note Text calculation button and allows you to enter a text value in an item note. in the Properties window,

Description - Allows you to type a description for the item. This box can contain a link to a Web address, formatted like this: http://www.intergraph.com. You can also link to a file on your file system by entering the path like this: file://UNC_path/share/document.extension. Note
•

Very long descriptions are not displayed in their entirety in design labels.

SmartPlant P&ID User’s Guide 247

Creating P&IDs in SmartPlant P&ID: An Overview

Revision Text Dialog Box
Opens when you click the Revision Text calculation button enter a text value. and allows you to

Description - Allows you to type a description for the item. This box can contain a link to a Web address, formatted like this: http://www.intergraph.com. You can also link to a file on your file system by entering the path like this: file://UNC_path/share/document.extension. Note
•

Stream Number Dialog Box
Opens when you click the ellipses next to the Stream Number property in the Properties window, allowing you to specify the stream number for your pipe run. Browse - Allows you to search for a file on your computer or network. File Name - Specifies the file from which stream data is imported. You can click Browse to find the file on your computer or the network. Stream data is generally imported from an Aspen Zyqad stream data file. Stream ID List - Lists the values found in the text file specified in the File Name box. Related Topics • Import Aspen Zyqad Stream Data, page 329 • Populate the Stockpile from a Spreadsheet, page 252

248 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Moving and Placing Stockpile Items: An Overview
You can move the items that reside in stockpiles (the Stockpile, which belongs to the Plant or the active project, or drawing stockpiles) from one stockpile to another, or you can place them in a drawing or delete them from the model altogether. You view the items in a stockpile in the Engineering Data Editor (EDE). In particular click Stockpile to view items in the Stockpile, or click Active Drawing Stockpile to view items in the stockpile of the active drawing. Be sure that the other item buttons on the Engineering Data Editor toolbar (that is, the Active Drawing or Other Drawings buttons) are not active when you want to view stockpile items alone. In the EDE, the Actions menu contains the commands for manipulating stockpile items. These commands make it possible to place or move or delete stockpile items. You can also access some of these commands from the Engineering Data Editor shortcut menu, which opens when you right-click in the EDE. You have the capability to place an item from a stockpile directly onto an open drawing. You enter placement mode when you click the icon associated with a stockpile item in the left-most column of the EDE. You can import items into the Stockpile, too, by importing reports with the File > Import > Data File command on the main toolbar. Related Topics Move a Stockpile Item to the Stockpile of Another Drawing, page 250 • Place an Item from the Stockpile, page 250 • Place Multiple Representations, page 142 • Populate the Stockpile from a Spreadsheet, page 252
•

Move to Different Stockpile Dialog Box
Opens when you right-click a stockpile item icon in the Engineering Data Editor and select Move to Different Stockpile. You can move your selected stockpile item into the drawing stockpile of another drawing. Tree view - Allows you to navigate in the plant hierarchy in order to display the drawing into which stockpile you want to move the selected item. List view - Displays a list of available drawings that can accept the selected stockpile item. Related Topics • Move a Connector to Another Stockpile, page 192

SmartPlant P&ID User’s Guide 249

Creating P&IDs in SmartPlant P&ID: An Overview

Place an Item from the Stockpile
1. In the Engineering Data Editor, click the icon in the left most column for the stockpile item that you want to place. Tip Be sure you have chosen a stockpile item in your Engineering Data Editor, not a drawing item. 2. Click the appropriate position in the drawing for the item.
•

Notes
•

If the item you place has multiple orientations in relation to other items, you can use the Configuration tool to select the appropriate placement for the item. For more information, see Place an Item With the Configuration (PickQuick) Tool, page 137. You can enter values for properties of the placed item by selecting the item, and then clicking Edit > Properties to display the Properties window. You cannot use Replace Mode mode to replace drawing items with items from the Engineering Data Editor.

Move a Stockpile Item to the Stockpile of Another Drawing
1. In the left-most column of the Engineering Data Editor, right-click the icon of the stockpile item that you want to move. Tip Be sure you have chosen a stockpile item in your Engineering Data Editor, not a drawing item. 2. From the shortcut menu, select Move to Different Stockpile.
•

3. On the Move to Different Stockpile dialog box, choose a drawing from the list and click OK. Note
•

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:

250 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview
•

From a drawing stockpile to the Stockpile - No constraints apply. This action can occur at anytime. 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.

Using Reports to Import Items into the Stockpile
You can use the Equipment List and the Pipe Run List to import new items into the stockpile. This capability allows you to define values for an item that does not yet exist in the database. Both of these reports have hidden columns that store some key information that is necessary for importing this information. Also, you can use a report to import information for items that already exist in the database. You must first run the report, add or edit property values for the items returned in the report, and then import the items back into the drawing. The property values for the items are updated. Valid reports are Equipment List, Equipment Nozzle List, and Pipe Run List. XML Tags and Descriptions Tag <?xml version="1.0"?> <Preamble> <Items> Description Identifies the XML file and the version used Ignored by SmartPlant P&ID Indicates beginning of the list of all item types and properties to be imported, and must have corresponding </Items> tag Defines Classification and Symbol File: Classification - Database Item Type, Symbol File - Path to symbol to be created in stockpile Ignored by SmartPlant P&ID. Indicates the beginning of the list of properties to be imported for the item type

</Identification>

<ContextSpecificIdentifier ContextId <Item Attributes>

SmartPlant P&ID User’s Guide 251

Creating P&IDs in SmartPlant P&ID: An Overview Tag <Item Attribute> Description Imported property for the item type: AttributeName Derived from the Data Dictionary Manager property name, not the display name, and must be in double quotes; Attribute Value - Must be in double quotes, and specify the actual value, not the index number, even for select-listed values; AttributeUnits - Specify if the property has units of measure, and must be a valid format; ITEMTAG - must be one of the properties listed.

Notes
•

The log file for import activities is called SPImport.log and is saved to your local Temp directory. For examples of importing pumps into the database using the Equipment List, click Related Topics.

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 Zyqad 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.
•

Important
•

If a format change is made to an exported Aspen Zyqad report, you must make modifications the import code to accommodate the changed report layout.

252 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Notes
•

Aspen Zyqad spreadsheets in either Microsoft Excel or XML format are supported. These spreadsheets include the Vessel Equipment List, Pump Equipment List, and Heat Exchanger Equipment. Stockpile items that come from importing Aspen Zyqad data can be easily updated by re-importing a data file. Previously imported items, whether they remain in the stockpile or have already been placed in the drawing, are updated with data from the newly imported file. Importing Aspen Zyqad XML data files allows greater flexibility when importing data into the software. All three reports, Equipment, Pumps, and Exchangers, are included in a single XML report so that only one file has to be imported. You can use the Equipment List, Pipe Run List, and Equipment Nozzle List Reports from SmartPlant to define properties of items already placed in the drawing, too. Items must have an assigned item tag prior to definition or modification of properties. In addition, these reports can create occurrences of items in the stockpile. See the SmartPlant P&ID Programmer's Guide Help file for more information on import code and other importing parameters. Click Help > Programming with SmartPlant P&ID.

•

•

•

•

Related Topics • Using Reports to Import Items into the Stockpile, page 251

SmartPlant P&ID User’s Guide 253

Creating P&IDs in SmartPlant P&ID: An Overview

Modify a Pump by Importing a SmartPlant P&ID Report into the Stockpile
1. Place a pump in a drawing and assign an item tag, for example, P-100A. 2. Run the Equipment List report. For more information on generating reports, see Generate a Report, page 334. 3. In the resulting report, change the value in the Item Tag cell (for example, change P-100A to P-101D) by highlighting the last column in the report and the column right next to it, then clicking Format > Column > Unhide. The path name of the associated symbol is available in column T. Columns Y, Z, and AA display the Tag Prefix, Tag Sequence Number, and Tag Suffix properties, respectively. In this example, these should be updated to P, 101, and D, respectively. 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. Notes
•

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.

Gapping Lines: An Overview
A gap in a drawing is a condition that exists when two lines intersect graphically in the drawing but not physically in the plant. In order to portray this condition, you can specify that lines show a gap at these non-physical intersections. This procedure can improve the clarity of your drawing considerably. You can either turn auto-gapping on, and the software gaps your lines automatically as you route them, or you can choose when the software performs gapping on your drawing by using the Gap Now command. Using the Gap Now command, instead of turning on auto-gapping, can increase the efficiency of your design session. Symbology and priority for your line gaps is set in Options Manager. Related Topics • Add a Manual Gap to a Line, page 151 • Perform Line Gapping in Your Drawing Now, page 256 • Turn AutoGap On or Off, page 256

AutoGap Command
Tools > AutoGap Turns automatic gapping on or off in the drawing. Gapping refers to the condition that exists when two lines intersect graphically on the drawing but do not physically intersect in the plant. When AutoGap is on, the software automatically gaps drawings during the working session each time that you modify an item, when you print, or when you save a file. A progress indicator at the bottom of the window alerts you to avoid selecting another command while the software completes the gapping. The Gap Now command does not affect the setting for AutoGap. When AutoGap is off, the software does not automatically gap drawings. By default, automatic gapping is off. Notes
•

Using Gap Now, instead of leaving AutoGap on, improves the performance of the software. The toolbar contains an AutoGap button off. for turning AutoGap on and

You can turn the automatic gapping on or off by clicking AutoGap the main toolbar, too. Notes

on

• •

When you route lines and AutoGap is on, gaps appear automatically. The status bar at the bottom of the window alerts you to avoid selecting another command while the software completes the gapping.

Related Topics • Routing Lines: An Overview, page 144

Gap Now Command
Tools > Gap Now Performs gapping on the current drawing, that is, on the entire drawing. Gapping refers to the condition that exists when two lines intersect graphically on the drawing but do not physically intersect in the plant. Using the Gap Now command does not affect any setting for the AutoGap command. Related Topics • Gapping Lines: An Overview, page 255 • Turn AutoGap On or Off, page 256

System Editing: An Overview
System Editing works within the context of the active drawing. 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 additions or changes to a drawing, the changes are propagated according to relationships and rules. If System Editing is enabled for the Plant, then every P&ID drawing 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. Note
•

System Editing is not supported from or to plant item groups such as loops and packages.

When a new item is placed from the Catalog or the Stockpile or an existing item is modified, creating a new relationship, property values flow across the new relationship as specified in the rules. The flow of property values is as follows.
•

Properties - The properties that can flow across this relationship are those that are listed as consistency criteria in all of the applicable rules. Copy and Propagate - A property value can be copied in either direction across the new relationship and is propagated outward. For new items, existing values are not overwritten by this process unless one item contains a Null property value. For example, if different nominal diameter values exit on both sides of a new connection, the existing nominal diameter values are not automatically changed to match unless one of the values is set to Null.

•

•

When a directional property, for example, Flow Direction and Slope Direction, is propagated, it is not enough to set the same value on all items the propagation scope. The direction of the underlying geometry must be compared to the direction of the geometry of the start item. One of the possible property values must be selected based on the direction of the geometry. In cases where the direction of the geometry cannot be compared (such as a midpoint branch condition) no propagation is possible.

SmartPlant P&ID User’s Guide 257

Creating P&IDs in SmartPlant P&ID: An Overview

The Scope of System Editing
Connectivity - All objects that are connected to the selected object are candidates for inclusion in the propagation (System Editing) process. Rules - The consistency criteria specified in rules define which properties are propagated and in which direction. The propagations scope can be expanded across a relationship if there is an applicable rule for the property being modified. Inconsistencies - The propagation scope is not expanded past an existing inconsistency for the property being modified. Using System Editing does not resolve inconsistencies. You must resolve the inconsistency. Breaks - Propagation breaks can be defined for specified properties at specified relationships in a design. The propagation scope is not expanded past a break for the property being modified. Access Control - When working in a project, the propagation scope only includes objects that have been claimed.

System Editing and Consistency Checking
You can effectively propagate a changed property value across drawing boundaries. If a changed property value is propagated and it reaches an OPC, it simply stops at that point. An inconsistency indicator at the OPC shows that the value in the active drawing is inconsistent with the value on the connected pipe in the continuation drawing. To resolve this type of inconsistency, the user must open the continuation drawing. With the continuation drawing open, the user can double click on the inconsistency indicator to display the Consistency Check dialog. One of the solutions available for resolving inconsistencies is to copy the property value from the first drawing into the active drawing. When this solution is used, the property value from the pipe run in the first drawing is copied to the pipe run in the active drawing and spreads outward from there according to the standard propagation rules. Thus, property values can be propagated across document boundaries. Inconsistencies - System Editing never expands across an inconsistency for the property being propagated. For a given set of connected items with a consistent property value, System Editing allows you to easily change that value to a new value. However, if the items are not consistent to begin with (inconsistencies exist), then System Editing will not automatically make them consistent. Other tools are available (such as Solutions on the Consistency Check dialog box) for resolving inconsistencies.

258 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview Break Components - Some components inherently limit the copying and suppress the consistency checking of certain properties. For example, a reducer is a break component for the Nominal Diameter property. When changing the Nominal Diameter in a pipeline, the spread of that change is limited by any reducers that exist in that pipeline. The consistency checking that would normally be done between the connected pipes is also suppressed at the reducer. A break component can be created for any property or collection of properties of a pipe run. To create a break component, you must first create a special filter. This filter must apply to pipe runs and must include the properties to be broken as criteria in the filter. The value for each property in the filter is not important. The final step in creating a break component is to open the symbol in Catalog Manager and select the Property Breaks command to select the filter. After creating a break component, when it is placed into a drawing, it breaks the specified properties. Break Labels - The consistency criteria specified in the rules define the general behavior of the properties. Break labels provide a way to define exceptions to the general rules. A break label provides a visible and plottable symbol that signifies the end of one property value condition and the beginning of a new condition along a pipe. A changed property value is never propagated across a break label for that property. A break label also suppresses consistency checking for the property it breaks. A break label can be created for any property or collection of properties of a pipe run. A break label is created in the Catalog Manager just like any other label, except that the Label Type property is set to Attribute Break. A SmartText field must be created for each property that is to be broken. In many cases the graphical shape of the label indicates which properties are broken. In these cases the Visible flag on the SmartText is set to False so that the text is not visible. It is also normal to turn the leader line on within the Catalog Manager so that it is automatically displayed at placement time. All of the symbols under Piping\Segment Breaks in the delivered catalog are break labels. A break label can only be placed at the endpoint of a graphical pipe line where it connects to a component or a branch point. Furthermore, a break label can only be placed at a point where the specified properties are listed in the consistency criteria for the applicable rules. The break label stays attached to the point it was placed on and cannot be dragged away from it.

SmartPlant P&ID User’s Guide 259

Creating P&IDs in SmartPlant P&ID: An Overview

System Editing and Projects
When working in a project, the system enforces the rule that unclaimed objects cannot be modified. If you select an unclaimed object, the property grid does not allow you to enter new values for its properties. Similarly, System Editing does not allow property values to flow to unclaimed objects. If you have a claimed object that is connected to some unclaimed objects, and if you change a property on the claimed object, propagation will not change the property value on the the unclaimed objects. The items in the propagation scope are initially collected using the standard propagation rules. However, all unclaimed items are removed from the propagation scope before any property values are changed. Items that are claimed for relationship are treated as unclaimed for the the purpose of propagation. Related Topics • Comparing System Editing to Propagation, page 436 • Enable System Editing, page 261 • System Editing Command, page 260

System Editing Command
Tools > System Editing When System Editing is enabled for a plant, changed property values are automatically spread or propagated to related items according to the currently defined consistency criteria. In certain cases, you may want to set a property value on one item only and not allow it to be propagated to any related items. The System Editing command (on the Tools menu and the toolbar) allows you to turn off the propagation functionality temporarily during a design session. After the change has been made, you can use this same command to turn it back on again. System Editing is always turned on when you start a new design session. System Editing can be enabled or disabled for the entire plant by means of the Enable System Editing setting that is exposed through Options Manager. For new plants, the value of this setting is True by default. For upgraded plants, the value of this setting is False. This allows you to enable System Editing for an upgraded plant at the time of your choosing. Related Topics Enable System Editing, page 261 • System Editing: An Overview, page 257
•

260 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Enable System Editing
Select Tools > System Editing or click Note
•

.

System editing can be turned on/off for an entire plant or for a single design session.

Apply Display Set Dialog Box
Specifies which symbols display in the Drawing View. You can create filters that define which symbols you want to display. Click View > Apply Display Set to open this dialog box. You can save these filters and share them with other users working in the same Plant. You can also define colors and widths for display items. If a display set is currently active, its name displays in the lower right-hand corner of the product. To remove the results displayed by selecting the Apply Display Set command, select View > Clear Display Set. Note
•

Any display tabs created in previous versions of SmartPlant P&ID can be converted to a display set using the macro UpgradeTabsCMD.dll. The new display set will display in My Display Sets folder.

r- Adds an empty folder to the Tree. You can use Rename to define a name for the folder. These folders can be used to organize display sets. - Creates a new display set. You can use Rename to define a name for the new display set. - Displays the Select Filter dialog box. Select any displayed filter to add it to the current display set.

262 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview - Saves the selected display set. - Removes the selected display set and places it in memory. - Copies the selected display set into memory. - Pastes any values that are currently stored in memory. - Deletes the selected item. - Allows you to click on an item in the Tree and rename it. - Allows you to move the selected filter name up in the list. - Allows you to move the selected filter name down in the list. - Displays the properties of the filter. Filter Name - Displays a list of filter names. These filters are defined using the Add Filter command. Color - Displays the color of the selected item for your display set. You can click in the Color field to display a color palette and then select any color to define a new color for any selected item(s). The default color square is defined with the crosshatch pattern. Width - Displays the selected display width of items defined in the selected filter. A wider display width would cause the item to be more visible. Related Topics Page Setup Command, page 368 • Set up a Page Layout, page 369
•

SmartPlant P&ID User’s Guide 263

Creating P&IDs in SmartPlant P&ID: An Overview

Updating Options Manager Settings: An Overview
You can force the software to regenerate the drawing by using the Update Symbology command. This command refreshes the graphic symbology of symbols in your drawing based on the current settings in Options Manager. The ApplySettingsCmd macro also updates the line settings, Minimum Connector Segment and Routing Self-Avoidance, so that the current values in Options Manager are reflected in the drawing. The symbology and other settings defined in Options Manager usually take effect only in those drawings created after those values are defined. You can force changes in Options Manager to appear in the current drawing by updating Options Manager settings, regardless of when the drawing was created. Notes
•

Any user can update drawings using these commands. However, check your permissions, which are assigned in SmartPlant Engineering Manager, to find out if you can make changes to the plant-wide symbology in Options Manager. Once you load the current plant-wide definitions into your drawing, you cannot revert to previous definitions. However, you can always override plant-wide symbology choices in your drawing by using drawing filters and choosing alternate symbology for items.

The line width and color symbology for your active drawing is changed to the most recent symbology defined in Options Manager. You do not have to update symbology for this drawing again, even if you end your design session, unless Options Manager symbology changes again. Redefining symbology in Options Manager usually affects only drawings created after the change. The Update Symbology command makes it possible to override this constraint.

You can find this macro in \Program Files\Smartplant\P&ID Workstation\Program.

Note
•

Two settings, Minimum Connector Segment and Routing Self-Avoidance, in Options Manager control the behavior of pipe and signal runs when placed in a drawing or when an inline component is placed on a run. You can change these settings in Options Manager, but the new values only affect lines placed after the change. The ApplySettingsCmd.dll macro applies the latest settings to all runs on the current drawing. You must run this macro for every drawing individually.

Linking and Embedding Objects: An Overview
This software is compatible with Object Linking and Embedding (OLE) software. You can transfer text, numbers, or images between drawings or documents that were created with this software and other OLE applications. You can move whole documents around or just parts of a document that you select. The information that you move is an object. For example, you can use Microsoft Word to make a comment and then display the comment in your drawing, or you can insert a Microsoft Excel worksheet into a drawing. You can even create a drawing that contains another drawing, notes from Microsoft Word, and an Excel worksheet. You can insert information created in another application with one of many methods:
•

You can cut and paste an item to delete it from one location and move it to another location. You can copy and paste an item to duplicate it in another location. Linking stores data in one location and places a copy with a link in another location. When you change the original data, the copy can be updated either automatically or manually. Embedding copies information and stores the information in another document that was created in a different application. If you change the embedded object, the original information does not change and vice versa.

• •

•

Linking or Embedding An object is data from one application that you insert in a drawing. You can link or embed information between drawings or documents that were created with this software and OLE software. Linking stores data in one location and places a copy and a link in another location. The linked data is stored in the source document itself. When you paste the information in the destination document with the Paste Link option, a reference point or box is inserted into the destination document. This box displays the information that you pasted. When you change the original data, the pasted data is updated either automatically or manually. You can edit the linked information by opening the source document. You can insert linked information with the Paste Special command on the Edit menu. You can link an entire document to another document by inserting the information with the Insert > Object command on the Edit menu. Embedding copies data in one document and stores the information in another document. If you change the copied data, the original information does not change, and vice versa. You can embed information with the Paste Special command on the Edit menu. You can embed an entire document inside another document by inserting the information with the Insert > Object command on the Edit menu.

266 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview If you want to keep the document size small, then link the data to another document. Linked information increases the document size only by the size of the displayed image, not by the size of the data itself. Linking is also useful when you want to share information in many different places and set that information to update automatically. For example, if you want to display a drawing in several different reports that you created in Microsoft Word, you could link the drawing inside the documents that contained the reports. Then, later, you could update the drawing by editing it in this software. Each report would automatically display the results of the drawing updates. If document size is not an important factor, then use embedding. Embedded objects make the file size larger. Embedding is useful when the person viewing the document with the embedded information does not have access to the software that created the object. The person can still view the information if it is embedded in the document. For example, if you wanted to send out several drawings for review, you could embed each drawing into a Microsoft Word document and send the Microsoft Word document to each reviewer. Embedded information is also a good choice if the information does not need updating. Embedding by Cutting or Copying, and Pasting The easiest way to embed an object is to use the Cut, Copy, and Paste commands on the Edit menu in any OLE software. If you copy or paste information into an application in which you cannot edit the information, the software automatically embeds the information in the document. You can then edit the embedded information with the software that created it. If you cannot edit the information, the information appears as a static picture. Notes
•

If you want to copy the information, and not remove it from its original location, press Ctrl while dragging. On the Paste Special dialog box be sure that you select Paste and not Paste Link. Or if you want to link the object, select Paste Link on the dialog box.

•

•

Linking or Embedding an Object If you want to insert an existing document, you can use Edit > Insert > Object, too. On the dialog box, select the Create From File option and then enter the name, or browse to the document. The entire document is embedded into the drawing. Notes
•

If you want to embed the existing object, make sure you have not selected Link on the dialog box. If you want to link the existing object, select Link on the dialog box.

•

SmartPlant P&ID User’s Guide 267

Creating P&IDs in SmartPlant P&ID: An Overview Editing a Linked or Embedded Object To edit an object, you can double-click the object to open the software that created the object. If you do not have the source software installed, you cannot edit the object. The menus and toolbars of the current software are temporarily replaced by the menus and toolbars of the software that just opened. Notes
•

You can click commands on a shortcut menu to activate the software that created the object. To get the shortcut menu, right-click the embedded object. You can type an URL with http syntax in the Description dialog box to link World Wide Web documents to an item. Symbols in drawings usually point to the catalog associated with the current plant. If items inadvertently point to the wrong catalog, you can correct this problem by using the CheckFilePathsCmd macro. See Related Topics for more information. Important

•

•

•

Linked or embedded files are not transferred by workshare. You must transfer those files manually, and they should be located in the same directory as the drawing files.

Embed an Image
1. Click Edit > Insert > Image. 2. On the Insert Image dialog box, browse to the folder and image file that you want to embed in your drawing. 3. Click OK. Tip A box that is the size of the image appears at the end of the pointer so that you know where the image fits in the drawing. 4. Move the pointer to the location in the drawing where you want to place your image and click to place it.
•

Related Topics • Linking and Embedding Objects: An Overview, page 266

Object Command
Edit > Insert > Object Opens the Insert Object dialog box, where you can insert objects into a drawing with linking or embedding. The difference between linking and embedding is the method for storing and updating data.
•

When you link an object to a drawing, the drawing stores information about the location of the object, but the object itself is not stored in the drawing. When you embed an object in a drawing, the software stores a copy of the object in the drawing. When you change a linked object, all drawings that have links to that object are updated. When you change an embedded object, the software updates only the copy of the object stored in the drawing.

•

The Insert Object command inserts any OLE-enabled object, such as a Microsoft Word file, .avi document, or CAD drawing, such as a .dwg drawing. You can edit an embedded object by double-clicking it. You can edit a linked object by clicking Edit > Links and selecting Open Source. Related Topics Break a Link, page 276 • Edit an Embedded Object, page 275 • Embed a New Object, page 270 • Link or Embed a Previously Existing Object, page 271 • Linking and Embedding Objects: An Overview, page 266
•

SmartPlant P&ID User’s Guide 269

Creating P&IDs in SmartPlant P&ID: An Overview

Embed a New Object
1. Click Edit > Insert > Object. 2. On the Insert Object dialog box, click the Create New option. Tip You can insert an object that already exists also. For more information, see Link or Embed a Previously Existing Object, page 271. 3. In Object Type, choose the software in which you want to create the object and then click OK.
•

Tip The contents of the list depend on the applications that are installed on your computer and that support linking and embedding. 4. After you create the object in its separate window, click File > Exit or File > Update in the source application. If a message appears asking if you want to update the document, click the Yes button.
•

5. Click the pointer, which now includes a box the size of the object at its end, at the location in the drawing where you want to insert the object. 6. If the software temporarily replaces some of the menus and toolbars, click anywhere outside the embedded object. Caution
•

Do not use these procedures to create a symbol file. If you attempt to create a symbol source file, serious problems result in the drawing. Use Catalog Manager to create, change, or update symbols. Notes

•

You can move the embedded object again at any later time. For more information, see Move an Item With the Select Tool, page 209 or Move an Item Using the Move Button, page 210. You can place an object on the Clipboard and then embed it by using Edit > Paste Special. For more information, see Paste an Item With a Different Format, page 273. With this procedure, you embed an entire document; you cannot embed a selection in a document. If you insert a document into the drawing, the terminators, spaces, text, and styles appear in paper units relative to the source document. This behavior can cause the dimensions and text to appear very large or small in the drawing.

•

•

•

270 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview
•

The software creates automatic links by default. An automatic update occurs when the drawing is opened: if a change is made to the source document and the drawing is already open, the change does not appear in the drawing until it is closed and re-opened. The software updates manual links only at the time that you indicate. To change the way the software updates links, click Edit > Links and specify automatic or manual update mode for each link. In the Description box in the Properties window, you can type an URL with http syntax to link documents to an Internet item. Click the ellipses to open the Description dialog box. Important

•

•

Linked or embedded files are not transferred by Workshare. You must transfer those files manually, and they should be located in the same directory as the drawing files. Once you embed a border file into a drawing template and a drawing is created in Drawing Manager using that template, any changes to the border file are not reflected in drawings created prior to the change. For more information about creating drawing templates, see Create a Drawing Template, page 119.

Link or Embed a Previously Existing Object
1. Click Edit > Insert > Object. 2. On the Insert Object dialog box, click Create From File. 3. In the File box, type the name and directory path of the document that you want to include in your drawing, or click Browse to find and choose the file. 4. If you want to link this object to your drawing, select the Link box. If you want to embed the object, do not select this option. 5. Click OK. 6. Click the pointer, which now includes a box the size of the object at its end, at the location in the drawing where you want to insert the object. Caution
•

Do not use these procedures to change a symbol file. If you attempt to update, change, break, or open the symbol source file, serious problems result in the drawing. Use Catalog Manager to change or update symbols.

SmartPlant P&ID User’s Guide 271

Creating P&IDs in SmartPlant P&ID: An Overview Notes
•

You can move the object at any time later. For more information, see Move an Item With the Select Tool, page 209 or Move an Item Using the Move Button, page 210. You can place an object on the Clipboard and then embed it by using Edit > Paste Special. For more information, see Paste an Item With a Different Format, page 273. You can embed an OLE object, such as a Microsoft Word document or Microsoft Excel workbook, by dragging the file from Windows into a drawing, too. With this procedure, you can create a link only to an entire document; you cannot link to a selection in a document. You can link an OLE by dragging a document from the Windows environment onto the drawing also. You must press the Ctrl + Shift keys while dragging to link the information. If you do not press these keys, the information is embedded. If you insert a document into the drawing, the terminators, spaces, text, and styles appear in paper units relative to the source document. This behavior can cause the dimensions and text to appear very large or small in the drawing. The software creates automatic links by default. An automatic update occurs when the drawing is opened: if a change is made to the source document and the drawing is already open, the change does not appear in the drawing until it is closed and re-opened. The software updates manual links only at the time you indicate. To change the way the software updates links, click Edit > Links and specify automatic or manual update mode for each link. In the Description box in the Properties window, you can type an URL with http syntax to link documents to an Internet item. Click the ellipses to open the Description dialog box. Important

•

•

•

•

•

•

•

Linked or embedded files are not transferred by Workshare. You must transfer those files manually, and they should be located in the same directory as the drawing files.

Paste Special Command
Edit > Paste Special Inserts the Clipboard contents into a drawing with the format that you select in the Paste Special dialog box. Related Topics • Copy an Item, page 240 • Linking and Embedding Objects: An Overview, page 266 • Paste an Item With a Different Format, page 273

Paste an Item With a Different Format
1. Click Edit > Paste Special. Tip You cannot paste an item unless you have previously placed it on the Clipboard with the Copy or Cut commands. 2. Choose the Paste command to embed the information or the Paste Link command to link the information. Depending on the type of information, both options can be available.
•

3. In the As list, select the format that you want to use to paste the information from the list of available options. Tip
•

The Results box gives an explanation of the outcome of your selection.

Notes
•

The contents of the Clipboard remain unchanged until you use the Cut or Copy command again. If you select an item for the insertion point and that item cannot be replaced, the Clipboard contents are not pasted over the selected item. Pasted text and items remain selected after you use the Paste Special command until you select another item or click Esc.

Do not use this command to change a symbol file. If you attempt to update, change, break or open the source file, serious problems result in the drawing. Use Catalog Manager to change or update symbols. Note

•

The software does not translate OLE objects that you have linked to your document when you export a .pid file to a MicroStation® or AutoCAD® file.

Edit a Linked Object
1. Click Edit > Links on the main menu bar. 2. On the Links dialog box, select the link that you want to edit. 3. Click the Open Source button. Tip You must have the appropriate software installed on your computer in order to be able to edit the object in its source software. 4. Make the changes that you want in the source file.
•

Edit an Embedded Object
1. Double-click the embedded object. 2. Edit the object. Tip You must have the appropriate software installed on your computer in order to be able to edit the object in its source software. 3. Do one of the following:
• •

If you are editing the object in a separate application window, click either Exit or Update on the File menu to return to the design software. If you are editing the object in software that temporarily replaces menus and toolbars, click anywhere outside the embedded object to return to the design software.

•

Related Topics • Linking and Embedding Objects: An Overview, page 266

Change a Link
1. Select Edit > Links. 2. In the Links dialog box, click the link that you want to change. 3. Click Change Source. 4. In the File Name box, specify the file that you want to change the link to. Tip
•

If you do not see the file that you want to link to, browse to a different drive or folder.

Note
•

If you have other links to the same source file, make sure you update all links to the new source file. Caution

•

Do not use these procedures to change a symbol file. If you attempt to update, change, break, or open the symbol source file, serious problems result in the drawing. Use Catalog Manager to change or update symbols.

Related Topics • Linking and Embedding Objects: An Overview, page 266

SmartPlant P&ID User’s Guide 275

Creating P&IDs in SmartPlant P&ID: An Overview

Break a Link
1. Click Edit > Links. 2. Select the link or links that you want to break. 3. Click Break Link. 4. When the software asks you to confirm that you want to break the link, click Yes. 5. Click Close. Caution
•

Do not use this command to edit a symbol file. If you attempt to update, change, break, or open the symbol file, serious problems result in the drawing. Use Catalog Manager to change or update symbols.

You can find this macro in \Program Files\Smartplant\P&ID Workstation\Program.

Notes
•

The CheckFilePathCmd macro checks the directory paths in the file names of all symbols used in the plant, and it creates a log file that reports all symbols missing from the current catalog. The log resides in your Temp directory< and is named CheckFilePathsFor_yourplant.log.

•

Related Topics Linking and Embedding Objects: An Overview, page 266

SmartFrame Properties Dialog Box
Sets properties for a frame, called a SmartFrame, that provides a border for an object when you insert or paste the object into the current document. You can scale the object by dragging one of the handles on the frame. Or, you can crop the object by pressing the Shift and dragging one of the handles.

276 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview

Info Tab (SmartFrame Properties Dialog Box)
Provides information about frames around objects, such as raster images or drawings from other applications. Type - Displays the category of the selected element. You cannot edit the type. Sheet - Displays the name of the drawing sheet that contains the selected element. You cannot edit the sheet. Layers - Sets the layer that contains the selected element. Origin - Specifies the coordinates, or location, of an element along the X and Y-axes. Behavior - Specifies how the SmartFrame reacts to to changes made within its source. For example, if Fit Reference to Frame is selected and the size of the frame contents is expanded, the SmartFrame will also resize and attempt to encompass all the data. Conversely, if you resize the SmartFrame, the data inside is scaled so that it continues to fit within the frame. If Frame Fixed is selected, the SmartFrame does not react to changes made within its source, and resizing the frame will not affect the scale factor of the frame contents; consequently, the frame remains "fixed" in its original size and position. Height - Displays the height of the selected SmartFrame. The value in this field is for display purposes only. Width - Displays the height of the selected SmartFrame. The value in this field is for display purposes only. Link - Determines the way that the object links with a SmartFrame. This option is available only for linked objects. As Part of the Model (Public)- Allows the linked object to publicly appear in any document that links to the current document. Therefore, if you link an object to the current drawing and then link to the current drawing from another document, the current drawing and the linked object appear in the other document. For example, this setting is useful if you link comments from a Word document to the current drawing and you want other documents to appear in the current drawing with the comments. As Reference Only (Private)- Restricts the linked object from being displayed in any document that links to the current document. If the current drawing is linked to another document, the linked object does not appear in the other document. For example, this setting could be useful if you want to link comments from a Word document to the current drawing and you want other documents to display the drawing, but not the comments.

SmartPlant P&ID User’s Guide 277

Creating P&IDs in SmartPlant P&ID: An Overview

Border Tab (SmartFrame Properties Dialog Box)
Allows you to format frames around objects, such as raster images or drawings from other applications. Show Border - Turns on/off the frame border around the object. Color - Sets the color of the border. Line Width - Sets the line width. Line Type - Overrides a line type for a drawing sheet or embedded object and sets another line style for an element or linked object. View Shape - Specifies the geometric shape of the border. Two options are available: Rectangular and Elliptical. Changing the border shape can result in cropping the contents of the SmartFrame. Related Topics • Break a Link, page 276 • Change a Link, page 275 • Embed a New Object, page 270 • Info Tab (SmartFrame Properties Dialog Box), page 277 • Link or Embed a Previously Existing Object, page 271 • SmartFrame Properties Dialog Box, page 276 • User Tab (SmartFrame Properties Dialog Box), page 278

User Tab (SmartFrame Properties Dialog Box)
Attribute Set - Names a group of attributes. You can type a name in the box and press Tab. Save - Places the attribute set on the element that you selected. Remove - Removes the attribute set from the element that you selected. Attributes - Sets the name, type, and value of the attribute set. You can type a name in the box and press Tab. Name - Sets the name of a unique attribute in the attribute set. Type - Sets the type for the attribute, such as double, text, number, money, or date. Value - Sets the value for the attribute. The value that you can enter is based on the type that you selected in the Type box. Add - Adds an attribute to the attribute set. After you click Add, the attribute appears in the table.

Working With Assemblies: An Overview
An assembly is a group of items that you can place in a drawing at one time. Assemblies can save time because you do not have to keep creating commonlyoccurring groups of items. Instead of copying and pasting each individual item into a drawing at several locations, you can place the group of items: the assembly. An example of an assembly is a control valve with vents on both sides, an instrument loop that controls the valve, and a piping bypass around the valve. You can create an assembly by selecting several items in a drawing and saving as an assembly. The file extension for an assembly is .pid, which is the same file extension as a drawing. If you want to retrieve the assembly from the Catalog Explorer tree view, you must save the assembly where the other symbols are located. The Save As Assembly command prompts you to save the assembly in the correct directory, which is specified in Options Manager. Placing assemblies is like placing any other item from Catalog Explorer into a drawing. When you want to place an assembly into a drawing, you select the assembly from Catalog Explorer and click a location in the drawing. Or, you can drag the assembly into the drawing. The information in each label remains intact when you place the assembly. After you have placed an assembly, the items in the assembly are treated as separate items. You can delete just one item without concern that the software deletes the entire assembly. Assemblies cannot be placed inline. You must place the assembly first and then route piping to it, if required. Note
•

Assemblies can be created in one plant and used in another. However, the file structure and symbols must be identical. If you try to place an assembly into a plant that uses a different file structure, you get an error message that the software cannot find your reference files. The assembly placement quits. Move the symbols that cannot be found to the location indicated in the error message.

When creating or placing assemblies, a log file is created for each action. The log files are placed in the Temp directory and are named <AssemblyName>_CreAsm.log and <AssemblyName>_PlaAsm.log.

280 SmartPlant P&ID User’s Guide

Creating P&IDs in SmartPlant P&ID: An Overview The following is an example of the log file created when creating assemblies.
Source Drawing Name: \\sppidtraining\Site_4_3_25_1\Plant_4_2_36_1A\Drawings\38\38-PI-0001.pid Assembly Name: \\sppidtraining\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: \\sppidtraining\Site_4_3_25_1\Plant_4_2_36_1A\RefDatA\P&ID Reference Data\Symbols\Assemblies\Equipment\VesselAssembly.pid Target Drawing Name: \\sppidtraining\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.

Save As Assembly Command
File > Save As Assembly Saves selected items as an assembly. This command is available only when items are selected in the drawing. Assemblies are saved with the .pid file extension. A red target appears at the end of your pointer. You use this target to specify the origin of the assembly for placement. You can only use a standalone symbol as the origin of an assembly. For example, you cannot use labels, pipe runs, signal runs, or child items; however, you can use unattached ends of pipe runs. The Save Assembly dialog box opens after you specify the origin, and you can name the assembly and place it in the proper directory. Note
•

The Save As Assembly command does not constitute an undoable action; therefore, it does not appear as a step available for the Undo command.

Create an Assembly
1. Select several components in the drawing. Tips
•

You can select more than one item at once by dragging the pointer to fence objects.

To remove an item from the selection, click it while pressing Ctrl. 2. Click File > Save As Assembly.
•

3. Use the red target that appears at the end of your pointer to specify the origin of the assembly for placement. Tip You can only use a standalone symbol as the origin of an assembly. For example, you cannot use labels, pipe runs, signal runs, or child items; however, you can use unattached ends of pipe runs. 4. On the Save As Assembly dialog box, enter the file name.
•

5. Click Save. Notes
•

Any graphics that have been band-aided should be deleted and replaced prior to using this command. The file extension for assemblies is .pid. You can save an assembly in any directory that you want, but the default assembly path is specified in Options Manager. If you use the default folder, then you can retrieve the assembly from Catalog Explorer. In order to save assemblies, you must have write permissions to the folder defined in Options Manager. Assemblies can be created in one plant and used in another. However, the file structure and symbols must be identical. If you try to place an assembly into a plant that uses a different file structure, you get an error message that the software cannot find your reference files. The assembly placement quits. Move the symbols that cannot be found to the location indicated in the error message.

Place an Assembly
1. In the Catalog Explorer list view, click the assembly that you want to place. 2. Use the red target that appears at the end of your pointer to position the assembly appropriately. Tips
•

The red target is the origin of the assembly. Some assembly members also appear during placement to aid you.

Press Esc to quit placement mode, or you can escape placement mode by right-clicking. 3. Connect the pipe runs and instruments on either side of the assembly.
•

Tip You cannot place an assembly into a line that is already routed. 4. Modify or delete individual components in the assembly as necessary.
•

Move an Item Using the Move Button, page 210 Mirror an Item About an Existing Mirror Axis or Linear Element, page 229 Rotate an Item About an Axis You Define, page 231 Delete an Item from the Drawing, page 236 Notes
•

Assemblies are stored in a specific folder, Assemblies, in the Catalog Explorer tree view. Assemblies can be created in one plant and used in another. However, the file structure and symbols must be identical. If you try to place an assembly into a plant that uses a different file structure, you get an error message that the software cannot find your reference files. The assembly placement quits. Move the symbols that cannot be found to the location indicated in the error message. You can only use a standalone symbol as the origin of an assembly. For example, you cannot use labels, pipe runs, signal runs, or child items; however, you can use unattached ends of pipe runs. You can save an assembly in any directory that you want, but the default assembly path is specified in Options Manager. If you use the default folder, then you can retrieve the assembly from Catalog Explorer.

•

•

•

Related Topics • Working With Assemblies: An Overview, page 280

SmartPlant P&ID User’s Guide 283

Working with Drawings in Projects: An Overview

Working with Drawings in Projects: An Overview
After enabling and creating projects in SmartPlant Engineering Manager and using Drawing Manager to manipulate the drawings, actual design work is still accomplished in SmartPlant P&ID. However, managing and meting out that work is largely controlled from the Drawing Manager interface. Only the project can use the commands on the Project menu in Drawing Manager to fetch, check in, and check out drawings. Once projects are enabled in SmartPlant Engineering Manager, the Plant can no longer create drawings; drawings are created inside projects. However, any drawings that might have existed in the Plant before projects were enabled remain in the Plant. All drawing versions in the Plant are read-only drawings when projects are enabled, but the Plant can still delete these drawings, unless the drawing is either fetched or checked out to a project. Note
•

When you are using projects inside SmartPlant P&ID, remember that the reference data belongs to the Plant and is used by projects of the Plant. You cannot change reference data, such as table layouts or formats or rules, at the project level. One of the main capabilities associated with using projects in SmartPlant is the ability for a project to claim a drawing object. When a project claims an object, the project controls modifications to that object. A project cannot modify objects it has not claimed. All the modifications and claiming of objects is carried out in the design software, but the claim states of objects inside drawings do have ramifications for drawing manipulation and for completing projects. You do not need to check out a drawing to claim items on it; you can claim items on a fetched drawing.

Claiming Items: An Overview
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 itemby-item basis, claiming fosters an ability to define the scope of work as narrowly as necessary. A new item is created in a project in the same ways it can be created in a green field plant. The simplest way to create a new item is to drag a catalog item from the Catalog Explorer and drop it onto a drawing. A new item in a drawing is automatically claimed to the project. However, when an existing drawing is fetched or checked out to a project, none of the items on that drawing are initially claimed. Before you can modify or delete any of those items, you must claim them. After you have claimed an item, you can modify it using the same methods that you would use in a plant that is not project enabled. Purely graphical modifications to drawing items are allowed without claiming those items. For example, a symbol can be repositioned or the vertices of a connector can be moved. Also, labels can be added or removed without claiming anything. Any modification that changes the meaning of the schematic design, however, requires that the affected items be claimed. For example, if you break a pipe run, some of the piping components and inline instruments in that pipe run will be reassigned to the new pipe run. Therefore, the pipe run, the piping components and the instruments in that pipe run must all be claimed before you break it. If they are not claimed, a error message will be displayed. Properties of items that are not claimed by the active project cannot be changed, nor are the mirror and rotate handles available when you select an item not claimed by your project. The Properties window and the Engineering Data Editor do not allow editing of properties on items that are not claimed: the properties are read-only as if the drawing is in a read-only state. No other explicit prompts let you know that you cannot edit an item that you have not claimed. However, you can manipulate the Drawing view properties so that the claim state of items is visually apparent. You cannot delete items that have not been claimed. After you have claimed an item, you can delete it using the same methods that you would use in a green field plant. However, if the deletion of an item would result in related items being deleted or modified, then those related items must also be claimed. For example, if you delete a vessel, the nozzles attached to it will be deleted and the pipe runs connected to the nozzles will be modified. Therefore, the vessel, the nozzles and the pipe runs must all be claimed before you delete the vessel. If they are not claimed, a error message will be displayed.

SmartPlant P&ID User’s Guide 285

Working with Drawings in Projects: An Overview You do not need to check out a drawing to claim objects; you can fetch a drawing with read/write permissions and claim its objects. Claim commands appear on shortcut menus in the Drawing view, in the Engineering Data Editor, and on the Edit menu. Releasing Claims From inside a project, you can invoke a claim at any time to expand the scope of your project, and any new item created in a project is automatically claimed by that project. You can also release a claim at any time, but you cannot release the claim that is automatically created when your project creates a new item. Claims are automatically released on all drawing items when that drawing is checked into the Plant; however, a drawing cannot be checked in if any objects that are not claimed differ from the Plant. Claim Mode The Claim Mode can be set to either Exclusive or Shared by using the Settings option in SmartPlant P&ID Options Manager. The Claim Mode controls how items are claimed by concurrent projects. If the Claim Mode is set to Exclusive, only one project can claim an item at any given time. Exclusive mode enforces the rule that concurrent projects do not overlap at the object level. With this setting, conflict resolution at check in time is simplified. If the Claim Mode is set to Shared, a single item can be claimed to more than one project. Shared mode allows concurrent projects to overlap at the object level. This setting may be required for plants that have overlapping projects. Conflict resolution at check in time will be more complex. Invalid Claims When an item is claimed by a project, it must be consistent with the state of the item in the Plant. Otherwise, an invalid claim exists. Invalid claiming can happen only for Plants that support Shared claiming of database items. Invalidly claimed items differ from the Plant items in that you cannot modify them and check a drawing into the Plant without first establishing a valid claim. When the Plant uses Shared claim mode and a project checks in a drawing, the claims made by other projects to objects on that same drawing are now invalid if the project that checked in the drawing also changed an item claimed by a different project. You can determine the validity of a claim by using the Claim Status command. Invalidly claimed items can not be modified. If an invalid claim is found but the item in question matches the item in the Plant, run Verify for Check In to resolve the situation. This process automatically sets the claim to valid and allows the check in to occur.

286 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview Notes
•

A list of claimed items is automatically published to The Engineering Framework. Claim commands are not available when you open a fetched drawing with read-only permissions. Claiming of labels is ignored. Drawing Manager is the only tool for checking in, checking out, and fetching drawings. You must have full control user access permissions for P&ID Objects before you can claim objects. For more information about setting user access permissions, see SmartPlant Engineering Manager Help. Remember that objects are claimed by the project, not by a single user. Once a project claims an item, it can be modified by anyone with the appropriate permissions in that project. Claiming items clears the Undo stack. Thus, claim is not an undoable command.

Claim Command
Engineering Data Editor > Edit > Claim Gives control of the selected items to the current active project. The Claim dialog box opens, allowing you to confirm the "claim-ability" of the items and enter claim comments. Claim comments can be viewed later by anyone in the Plant when the claim status is displayed. Related Topics • Claim a Drawing Item, page 288 • Claiming Items: An Overview, page 285

SmartPlant P&ID User’s Guide 287

Working with Drawings in Projects: An Overview

Claim Dialog Box
Opens when you select an item and click Edit > Claim on the main menu bar and displays details of the items that you select for claiming. You can discover if the selected items are already claimed by your project or another project. The Claim command checks first if your project already has a valid claim on a selected item. Next it checks if the items are claimed by another project, and if the Plant uses exclusive sharing, this step can produce an error display on the Claim dialog box. Finally the command compares the selected items against the same items in the Plant and displays a warning if an object either differs from that item in the Plant or if the object does not exist in the Plant. Items to be claimed - Lists the items that are selected in the Drawing view or Engineering Data Editor and their details. These are the items that you claim to your project when you click OK. You can select multiple elements of this list and record comments for this claim operation. In this list, you can also see if a selected item is already claimed or has any other claim errors or warnings associated with it. Comments - Allows you to record comments for the claim operation that you are currently undertaking. Related Topics • Claim a Drawing Item, page 288 • Claim Command, page 47

Claim a Drawing Item
1. In the Drawing view or Engineering Data Editor, select the items that you want to claim. 2. Click Edit > Claim. 3. On the Claim dialog box, record comments about this claim operation. In the Items to be claimed list, select the item or items that you want to add comments to, and fill in the Comments box. Notes
• •

A newly placed item is automatically claimed by the project that placed it. Remember that objects are claimed by the project, not by a single user. Once a project claims an item, it can be modified by anyone with the appropriate permissions in that project. Claiming items clears the Undo stack. Thus, claim is not an undoable command.

•

Related Topics • Claiming Items: An Overview, page 285

288 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview

Enforcing Claims
Whether you are using shared or exclusive claiming mode, claiming objects to your project involves many special relationships. The following topics discuss some of the ways that claiming restricts your activities. Note
•

Claim Mode is defined in Options Manager for the Plant and all its projects. When you claim an item, it is claimed to your active project. No items are ever claimed by the Plant.

Controlling Access
Each command in the software checks your permissions for the items that it modifies. When possible, commands simply do not allow the operation to proceed if you do not have the necessary permissions. In some cases, such as when using the Delete command, the software cannot prevent you from initiating a command, but an error message is displayed. You must have full control permissions on P&ID Objects before you can claim any drawing items. For more information, see the User Access chapter in SmartPlant Engineering Manager Help.

Modifying Properties
Claiming impacts properties modifications in the following manner. Properties Window When you select a claimed item, the Properties window allows the properties of that item to be viewed and modified. When you select an item that has not been claimed, the Properties window allows the properties to be viewed but not modified. The properties of unclaimed items are read-only. When you select a line segment, the Properties window displays the properties of the associated pipe or signal run. If the run has been claimed, the properties can be edited; otherwise, the properties are read-only. When you select multiple items, if they are all claimed, the Properties window allows them to be modified. If any of the selected items are not claimed, the Properties window treats the whole group as read-only. Engineering Data Editor (EDE) If the item has been claimed, you can edit its properties through the EDE; otherwise, the EDE treats the item properties as read-only. The EDE behaves similarly to the Properties window.

SmartPlant P&ID User’s Guide 289

Working with Drawings in Projects: An Overview Consistency Check Dialog Box The Solutions section of the Consistency Check dialog box allows you to copy property values from one item to another. For the selected solution, if the destination item is not claimed, the Apply button is not available. Implied Items When a drawing item is claimed, it means that you can modify that model item and all of its implied items. If a model item is not claimed, the user cannot modify any of the implied items that the model item owns. Related Topics • Claiming Items: An Overview, page 285 • Navigating in the Engineer Data Editor: An Overview, page 41 • Working with Drawings in Projects: An Overview, page 284

Placement Rules
When a new relationship is created, such as when you place a nozzle on a vessel, the applicable rules copy property values across the relationship. When a relationship to an unclaimed item is created, properties can be copied from that item without any problem; however, if the rule calls for properties to be copied to an unclaimed item, the action is not allowed, and the properties are not copied. An inconsistency indicator shows the inconsistency between the two related items.

Placing and Moving Drawing Items
Sometimes the target item must be claimed, but other times it does not have to be claimed. The following list explains how the relationship between an object and its target effects claiming.
•

Placing Nozzles, Equipment Components, or Instrument Components - The target item does not need to be claimed. Placing Piping Components or Instruments in Pipe or Signal Runs The target run must be claimed. In certain cases, placing a piping component or inline instrument causes a zero-length line segment to be created and automatic line connectivity causes it to be joined to an existing run. The target of that zero-length line must be claimed. Placing Reducers - A reducer is a "line-breaking component." The target pipe run and all of its components must be claimed. Placing Flow-Oriented Components - A flow-oriented component sets the flow direction of the target pipe run, if it is not already set. The target pipe run must be claimed. You can place a flow arrow label, however, if the flow direction is already defined. Placing OPCs on Runs - The target connector must be claimed.

•

•

•

•

290 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview If the target item needs to be claimed but is not claimed, then you cannot place your item onto the target; the target will not highlight, and your item will not "snap" into position. If no type of placement is allowed at that point, the "no place" indicator is displayed. In most cases, freestanding placement is still allowed. Geometric Modifications Geometric operations include a geometric move, with the Alt key pressed where necessary, a rotation, a mirroring, and a scale or parametric modification. The selected symbol does not have to be claimed to perform these operations. None of the connected items have to be claimed either. Rotation and Mirroring of Inline Components Rotations of 180 degrees and mirroring about the local y-axis for inline components are special geometric modifications cases because the lines are disconnected before and reconnected after the operations. Therefore, the lines, but not the selected symbol, must be claimed before these operations are allowed. If the lines are not claimed, the standard claim violation message displays. Rule-Based Moves All connected items must be claimed, as described above. If the required connected items are not all claimed, the move operation can become a geometric move, as if you pressed the Alt key.

Placing and Modifying Lines
Sometimes the target item must be claimed, sometimes not. Here is a list of the cases where claiming plays a role:
• •

Routing Lines up to Nozzles - The nozzles do not have to be claimed. Routing Lines up to Freestanding Piping Components or Instruments - The piping component or instrument must be claimed since it will be adopted by the new run. Routing Lines up to Owned Piping Components or Instruments - The piping component or instrument does not have to be claimed. In certain cases, when routing a line segment up to an existing inline component, automatic line connectivity will cause an existing zero length run to be joined to the new run. The target run must be claimed. Routing Lines up to OPCs - The OPC does not have to be claimed. Routing Lines up to Another Pipe or Signal Run - The target run must be claimed.

•

• •

If the target item needs to be claimed but is not claimed, you are not allowed to connect to the target. The black connection handle does not appear at the required point.

SmartPlant P&ID User’s Guide 291

Working with Drawings in Projects: An Overview Geometric Modification If you move a line segment or a line vertex that is internal to a line, then the piping or signal run that owns the selected segment does not have to be claimed. Extreme End of a Run If you modify the start point of the first line segment in a run or the end point of the last line segment in a run, then the following stipulations apply: 1. The selected run must be claimed. 2. The target item may need to be claimed. 3. If the existing connected item is a branch point for the run, then the run it belongs to must be claimed since the branch point is deleted and the adjacent line segments in the existing connected run are merged. 4. If a component is connected to the endpoint, it does not need to be claimed. Internal Vertex of a Run Modification of an internal vertex can result in the run being split; consequently, the following stipulations apply: 1. The entire run and all components must be claimed. 2. The target item may need to be claimed. Breaking and Joining Runs The Break Run command allows you to split one piping or signal run into two pieces. The run to be broken and all components within that run must be claimed. The Join Runs command allows you to combine two connected piping or signal runs into a single run. Both of the runs and all components in both runs must be claimed.

Placing and Modifying Labels
The target item for a label usually does not need to be claimed. However, claiming plays a role in the following cases:
•

Placing Driving Labels - A driving label sets one or more properties on the labeled item. The target item must be claimed. This includes flow arrow labels, unless the flow direction is already defined for the line. Placing Labels on Area Breaks - Placing a label on an area break causes a dynamic property to be added to the area break. For this to happen, the area break must be claimed.

•

If you modify a label, you do not need to claim it. However, modifying a driving label modifies the labeled item. Therefore, you must claim the item.

292 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview

Placing Multiple Representations
This Stockpile command enables you to place an additional representation of an existing equipment item into the design in a different drawing, thus creating a multiple representation in the database. You must claim the selected equipment item before this command is made available on the Stockpile menu in the EDE. Related Topics • Place Multiple Representations, page 142

Placing and Modifying Area Breaks
The placement of an area break does not create any new relationships and therefore does not require any claiming. Modifying an area break allows the shape to be changed. This is a purely geometric modification, and so no claiming is required.

Placing Gaps
Placing a gap symbol into a piping or signal line implies that the target line must be claimed. If the target line run is not claimed, it is not highlighted as a valid target when you move the pointer over it.

Replacing Drawing Items
The Replace and Replace Mode commands replace one item representation in the design with a different representation and change the value of the "type" attribute for the design item. To replace an item using these commands, you must claim that item. Replace Mode The claim status check takes place as you move the pointer over the target. If the target is not claimed, the target is not highlighted as a valid replacement target. Find and Replace Items that are not claimed can be found, but they cannot be replaced. The Replace button is not available if an unclaimed item is selected.

SmartPlant P&ID User’s Guide 293

Working with Drawings in Projects: An Overview

Deleting Items
Claiming impacts item deletion in the following manner. Drawing Items Drawing items are deleted from a design using three different commands: Delete, Delete From Model, and Cut. All of these commands check if the selected items and some dependent items are claimed. If all of the selected items and all of the related items are claimed, then the delete operation proceeds normally. If any of the items or the dependent items are not claimed, an error message appears. All dependent items must be claimed. That is, all items that are deleted along with a selected item must be claimed. All lines that are attached to selected items or are dependent on those items must be claimed. The following table expands on this idea, item type by item type. Item in Select Set Equipment
• •

Additional items that must be claimed for Delete All nozzles, equipment components, and item notes All item notes on those equipment components and nozzles All runs with lines attached to those nozzles All item notes All runs with lines attached to the nozzle All item notes The pipe or signal run that owns the segment All components in that run All runs with lines that attach to that branch point All item notes All item notes All runs with lines that attach to that piping component

•

Nozzle
• •

Equipment Component Line Segment

•

• •

Branch Point
• •

Piping Component
• •

294 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview Item in Select Set Instrument
•

Additional items that must be claimed for Delete All instrument components – actuators, functions, and so forth All item notes All runs with lines that attach to the instrument All item notes All runs with lines that attach to the OPC The partner OPC must be claimed also

• •

OPC
• • •

Stockpile Items Most items in the stockpile do not have any relationships. For these items, if the item is claimed, it can be deleted from the stockpile. If the item is not claimed, the Delete command opens the standard claim violation message. Plant item groups, for example loops, packages, and so forth, exist in the stockpile and have relationships to member items on a drawing or in a stockpile. If the plant item group is claimed and all of its members are claimed, then the plant item group can be deleted. If the plant item group or any of its members is not claimed, the Delete command opens the standard claim violation message. When an OPC is in the stockpile, it maintains its relationship to the partner OPC. OPCs can be deleted from the stockpile only if both OPCs in a pair are in the stockpile and are deleted at the same time. In a project context, both OPCs in a pair must be claimed before they can be deleted.

Moving Between Stockpiles
The Move to Different Stockpile command in the Engineering Data Editor allows you to move an item from one stockpile to a different stockpile. The selected model item must be claimed before you can use this command (if you are using a Project).

Validating Properties
The software uses validation functions before setting properties on items. The software checks the claim status before setting any values. If the item is claimed, the property can be changed. If the item is not claimed, the property can not be changed. For more information about validating properties, select Start > Programs > Intergraph SmartPlant P&ID > Programming Help and see the Extending the Capabilities of SmartPlant P&ID and Logical Model Automation Reference topics.

SmartPlant P&ID User’s Guide 295

Working with Drawings in Projects: An Overview

To Do List and Correlating Items
Claiming impacts the To Do List and other TEF commands in the following manner. Create Task - Running a create task creates a new item in the stockpile. The new item is claimed automatically as soon as it is created. Update Task - Running an update task sets or changes some properties of an existing item. The item to be updated must be claimed before it can be updated. If it is not claimed, the task status is set to Error and a note is added to the Notes area on the General tab of the Task Properties dialog box. Delete Task - Running a delete task causes the target item to be deleted. The item to be deleted and possibly other related items must be claimed before the task can do its work. If all of the necessary items are not claimed, the task status is set to Error and a note is added to the Notes area on the General tab of the Task Properties dialog box. Correlate Items - The Framework > Correlate command correlates pipe runs to the same design basis as an existing pipe run that is already correlated. Properties are copied from the primary pipe run to the other pipe runs. You must claim the pipe runs to be modified. If they are not claimed, they cannot be correlated. Related Topics Deleting Items, page 294

•

Release Claim Command
Engineering Data Editor > Edit > Release Claim Displays the Release Claim dialog box and allows you to relinquish control (by your project) of the selected items. This dialog box also displays when you attempt to unclaim an item that has been modified in the project. Claims must be released before projects can be completed or for other projects to be able to check in drawings with changes. Notes
•

You can use the Compare and Refresh command to revert the item back to the As-built state prior to unclaiming. If you are working in The Engineering Framework (TEF) environment and there are any differences between an item in the Project and an item in the AsBuilt, the claim cannot be released. If you are not working in a TEF environment, the claim can be released. Also, items that display no warnings or errors are released.

Release a Claim
1. In the Drawing view or Engineering Data Editor, select the items for which you want to release claims. 2. Right-click the item or select set and click Release Claim. If there are any errors or warnings during the release, the Release Claim dialog box displays. Review any warnings and error messages about each item. 3. Click OK to complete the claim release operation. Notes
•

You cannot release the claim on an item that is claimed to your project if it is a new item that was created in your project. You can also release claims on items when you display their claim status. For more information, see Display the Claim Status of a Drawing Item, page 299.

•

Claim Status Command
Engineering Data Editor > Edit > Claim Status Opens the Claim Status dialog box, which displays the details of the claimed state of the selected items and enables you to claim items, release the claims to items, and so forth. You must select the items in the Drawing view or the Engineering Data Editor before using this command. Related Topics • Claiming Items: An Overview, page 285 • Display the Claim Status of a Drawing Item, page 299

Claim Status Dialog Box
Opens when you select and item or 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. A selected item in the list is highlighted in the design window. If a selected item that appears in this dialog box does not have an item tag, then the SmartPlant ID, SP_ID, is displayed in the Item Tag column. The actual status is displayed in the Claims an item column of the list. An item claimed by your active project is denoted by with an invalid claim on it is denoted by any other state remains blank. Claim - Opens the Claim dialog box, and you can claim the item and record claim comments. Release Claim - Releases the claim from your project. A confirmation message is displayed; choose Yes to release the claim. SmartPlant P&ID User’s Guide 297

Working with Drawings in Projects: An Overview Details - Opens the Details dialog box, and you can discover what project has claimed the selected item, the user that claimed it, and any claim comments that were entered when it was claimed. Related Topics • Claim a Drawing Item, page 288 • Claim Status Command, page 48 • Display the Claim Status of a Drawing Item, page 299 • Release a Claim, page 297

Details Dialog Box
Displays details about the claim status of the item that you selected in the Claim Status dialog box. You can discover the project that has the claim, the user that claimed the item, and claim comments that were entered when the claim was made. Since newly placed items are automatically claimed by the project that places them, their claim comments are always "New Item". This dialog box opens when you click Details on the Claim Status dialog box. You can select all the items in the list by using Ctrl + A, and clicking Ctrl + C makes the selected items available to paste into another document. The New Item entry is automatically added to the comments for an item that is new to the drawing. New items are automatically claimed to the project that created them. Related Topics • Claim Status Command, page 48 • Display the Claim Status of a Drawing Item, page 299

298 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview

Display the Claim Status of a Drawing Item
1. In the Drawing view or Engineering Data Editor, select the items for which you want to display the claim status. 2. Click Edit > Claim Status. 3. On the Claim Status dialog box, review the information in the list of items. 4. To claim the items to your project, select elements in the list and click Claim. 5. To relinquish claims on those items by your project , select elements in the list and click Release Claim. 6. To see more detailed information about the claim status of that item, the project that has claimed the item, the user who claimed it, and any related comments, select an element in the list and click Details. Note
•

When you see the item tag listed for claimed items and an item tag is not defined for the selected items, the software displays the GUID for that item. GUIDs are automatically generated for every design item. When an item tag is defined for an item, the software displays the item tag in the Claim Status dialog box.

Related Topics • Claiming Items: An Overview, page 285

Show Claims Command
View > Show Claims Sets the appearance of drawing objects as it is specified in the Claims tab of the View Properties dialog box. You can use this command to switch the claim symbology on and off. Using the options on the Claims tab causes only the color and line weight to change, not the line pattern. Related Topics • Display Claim Status in the Drawing Symbology, page 300

SmartPlant P&ID User’s Guide 299

Working with Drawings in Projects: An Overview

Display Claim Status in the Drawing Symbology
1. Click View > Show Claims. 2. Click View > Show Claims again to turn off the display of claim status in the symbology of drawing items. Notes
•

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.

•

Related Topics • Claiming Items: An Overview, page 285

300 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview

Comparing and Refreshing Versions: An Overview
When more than one version of a drawing exists, you can view two versions side-byside and examine their differences by using the Tools > Compare and Refresh command. You can compare two versions from inside your own Plant or project database, or you can compare a version in your database to a version in the Plant or another project database. Keep in mind that you can compare a drawing only against a version of itself; that is, you cannot compare one drawing to another drawing. Differences between drawing versions are assigned to logical change groups, which are listed on the Change groups area of the Compare and Refresh dialog box. Differences display in the following two categories.
•

Graphic refers to an item that has changed only in its graphical representation in the design; that is, the item is moved or otherwise graphically manipulated in the drawing. 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.

SmartPlant P&ID User’s Guide 301

Working with Drawings in Projects: An Overview
•

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.

To refresh any differences between these two versions, you must set the Action column to Refresh. Change groups are marked if the changes affect items you have claimed. Be sure to refresh all of the changes that do not involve claimed items because these are the changes that have been checked in by other projects. You want to include these changes in your drawing so they will not be lost when you perform a check in.

Compare and Refresh Command
Tools > Compare and Refresh Allows you to refresh the active drawing with data from another version of the drawing. The differences display in what is known as a change group. If you accept the changes, the drawing refreshes to display the changes. To refresh a project drawing, you use the drawing in the plant. Change groups are marked if it affects items you have claimed. Be sure to refresh all of the changes that do not involve claimed items because these are the changes that have been checked in by other projects. You want to include these changes in your drawing so they will not be lost when you perform a check in.

Compare With Dialog Box
Opens when you click Tools > Compare and Refresh allowing you to select a drawing version to compare against the version that you currently have open and active. Available Databases - Lists all the different databases that currently have a version of the drawing you chose on the Show History dialog box. History - Lists all the versions of the chosen drawing in the database you named in the Available Databases list.

302 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview

Compare and Refresh Dialog Box
Compare Options - Displays the Compare Options dialog box. Allows you to customize the display colors for items that differ between the two drawing being compared. Print - Prints the entire Compare and Refresh dialog box contents. You can also specify to print either the right or left view by using the drop-down arrow to select either Right View or Left View. Generate Report - Displays a report in Microsoft Excel. The report contains the details of the compared drawings. Find in List - Highlights the line in the Change groups and Change details areas. You must first select an item in a drawing. Find in Drawing - Zooms to the selected item. You must first select an item in either the Change groups or Change details area. Zoom Area - Enlarges the selected area by allowing you to draw a fence around the area. Zoom In - Enlarges the selected area where you click. Zoom Out - Reduces the display of the selected area where you click. Pan - Allows you to move the display in any direction by dragging the pointer across the view. Select - Changes the pointer to an arrow allowing you to select an item. Alphabetic Categorized - Displays the properties in either an alphabetic list or by specific category. Show Modified - Displays modified properties. Source Representation Location - Displays the source item location if the item exists in either the Drawing or the Plant Stockpile. Target Representation Location - Displays if the target item location if the item exists in either the Drawing or the Plant Stockpile. Change groups - Area that lists the changed items in groups. A listed item contains all the items this change effects. Checkbox column - Displays colors in the drawings as defined using Compare Options. If not selected, the Default items color displays.

SmartPlant P&ID User’s Guide 303

Working with Drawings in Projects: An Overview Number - Displays the number assigned to each change group. 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; and No Action - performs no action on the selected drawing group.

Category - Displays the category of the change. 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 - Indicates that the items in the group have been claimed. Valid Claim - Indicates that the claimed item is a valid claim. Change details - Area that lists the details of the item in each change group. Result - Defines the results of the compare. The column indicates any differences in the two versions and which version contains the change. Change - Describes what action is required to make the drawing in the right frame match the drawing in the left frame. Actions include:
• • •

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.

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 - Indicates if an item is a valid or invalid claim.

304 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview

Compare and Refresh Dialog Box Properties Window Toolbar
Allows you to customize the properties that are displayed in the Properties window of the Compare dialog box. Alphabetical - Lists properties in alphabetical order. Categorized - Displays properties grouped by specific categories. Categories are defined and properties are assigned to those categories in Data Dictionary Manager. 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.

Compare Options Dialog Box
Opens when you click Compare Options on the Compare dialog box toolbar and allows you to customize the colors that the various comparison states are displayed in. The active color scheme is displayed in the Compare dialog box status bar. Left-only - Allows you to choose a color for the display of objects that exist in the left-hand Drawing view only. Dark green is the default color for this option. Right-only - Allows you to choose a color for the display of objects that exist in the right-hand Drawing view only. Red is the default color for this option. Different items - Allows you to choose a color for the display of items that exist in both views but differ from each other for any number of reasons (for example, modified properties). Blue is the default color for this option. Identical items - Allows you to choose a color for the display of drawing items that are identical in the two views. Black is the default color for this option. Highlight items - Allows you to choose a color to denote that a drawing object is highlighted, for instance, when an item is within your locate zone. Selected items - Allows you to choose a color to denote items that are selected in one or both of the Drawing views.

SmartPlant P&ID User’s Guide 305

Working with Drawings in Projects: An Overview

Compare and Refresh Drawing Versions
1. Click Tools > Compare. 2. On the Compare With dialog box, select a database using the Available databases drop-down list box. 3. In the History list box, select the drawing you want to compare your current drawing with. 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. 6. In the Change groups area, click in the Action column. 7. Using the drop-down list, select No Action, Refresh, or Validate. Validate will display as an option only if you have an Invalid Claim. 8. Click OK to refresh the drawing and accept any changes or Cancel to dismiss the dialog box.

306 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview

Compare and Refresh Examples
The following examples provide details for reconciling data and graphic differences between your current drawing and a previously created version of that drawing. Data Example In this example, a jacketed tower exists in the version to be selected for the compare. The current version contains the same jacketed tower but a change has been made to the Cleaning Requirements property. When the current version is compared to the selected version, a data change is found during the compare. The current version appears on the right and the version it is compared to appears on the left. Change groups indicates there is only one group and a data change was located. All items in the group are valid claims. Change details indicates the compare located a different property value (Cleaning Requirement) in the current version. If you Refresh the version, the property value will be modified as shown in the Change column. Clicking in the Action column of the Change groups allows you to take no action or refresh (accept the new property value).

SmartPlant P&ID User’s Guide 307

Working with Drawings in Projects: An Overview Graphic Example In this example, a jacketed tower exists in the version to be selected for the compare. The current version contains the same jacketed tower but it has been moved to a new location. When the current version is compared to the selected version, a graphic change is found during the compare. The current version appears on the right and the version it is compared to appears on the left. Change groups indicates there is only one group and a graphic change was located. All items in the group are valid claims. Change details indicates the compare located a graphic modification to a vessel (Jacketed Vessel) in the current version. If you Refresh the version, the graphic modification will be accepted as shown in the Change column. Clicking in the Action column of the Change groups allows you to take no action or refresh (accept the previous location of the vessel). The setting are not applied to a version until you click OK.

308 SmartPlant P&ID User’s Guide

Working with Drawings in Projects: An Overview Data and Graphic Example In this example, a jacketed tower with a nozzle exists in the version to be selected for the compare. The current drawing contains the same jacketed tower and nozzle. The original nozzle has been moved, a new nozzle has been added, and a property for the jacketed tower has been changed. When the current drawing is compared to the selected version, a data and graphic change is found during the compare. The current drawing appears on the right and the drawing it is compared to appears on the left. Change groups indicates there are three groups of differences. All items in the groups are valid claims. Change details indicates the compare located an existing nozzle was moved (Graphic) and a property value change (Data) in the current drawing. Clicking in the Action column of any of the three Change groups allows you to select either No Action or Refresh. If you select Refresh for any of the three groups, the action described in the Change column will be performed when you click OK.

SmartPlant P&ID User’s Guide 309

Consistency Checking: An Overview

Consistency Checking: An Overview
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 or add items to a drawing. The software displays all the inconsistencies, describes specific problems, and offers hints. Using these solutions, you can decide the best method to resolve an inconsistency. One solution is to approve a warning and thereby remove the inconsistency from the drawing. Another solution is to copy the same value from one side to the other side and then propagate. 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).

310 SmartPlant P&ID User’s Guide

Consistency Checking: An Overview

Consistency Checking and Break Labels
A property break is a point in a connected network of objects where a property value changes. A user can define a property break by the placement of a break label. A property break is an exception to the consistency criteria defined in a rule. A property break defines a limitation to the spread of the propagation scope. Whereas rules provide the general definition of the scope, property breaks provide specific limitations of the scope. The Consistency Check dialog shows the consistency criteria that apply at the selected relationship indicator. All of the properties that are copied and compared across this connection are shown. When the user has placed a break label, the copy and compare columns show icons that indicate that no copy and compare operations are performed for the properties in the label. Break labels can be created in the Catalog Manager environment. A break label is created just like an ordinary label, except that the Label Type property must be set to &ldquo;Attribute Break&rdquo;. A SmartText field must be created for each property that the break label is intended to break. A break label can break one or more properties. This functionality is all currently supported by the Catalog Manager. No new functionality is required. Break labels can be placed directly from the catalog explorer. A group of break labels is currently delivered under Piping\SegmentBreaks. Break label placement is enhanced so that a break label can only be placed at a connection point where the specified properties are being propagated. When a break label is placed interactively, the corresponding property break data is added to the Relationship object. Break labels can be deleted in the standard way using the Delete command. When a break label is deleted the break is removed from the Relationship object. However, if there is another break label at this same point that also breaks this property, then the break would not be removed. Related Topics Resolve an Inconsistency, page 320 • Review an Inconsistency, page 320 • Show Inconsistencies, page 312
•

SmartPlant P&ID User’s Guide 311

Consistency Checking: An Overview

Show Inconsistencies Command
View > Show Inconsistencies Turns on or off the display of indicators that identify inconsistent relationships in the active view. The software does not mark consistent, error-free relationships. Related Topics • Consistency Checking: An Overview, page 310 • Show Inconsistencies, page 312

Show Inconsistencies
1. Click View > Show Inconsistencies. When this option is selected, inconsistent relationship indicators appear in the drawing. 2. If you do not want the inconsistencies to appear, click View > Show Inconsistencies again to clear the selection of the option. Note
•

Also, you can right-click in an empty portion of the drawing in order to display a shortcut menu. Select Show > Inconsistencies to toggle the display of inconsistencies off and on.

Related Topics • Consistency Checking: An Overview, page 310

312 SmartPlant P&ID User’s Guide

Consistency Checking: An Overview

Consistency Check Command
Right-click an inconsistency indicator and choose Consistency Check to display the Consistency Check dialog box. As you create a drawing, consistency checking monitors your drawing for design discrepancies. If a location in the drawing has only one or multiple inconsistencies, you can correct the problems by reviewing them on the Consistency Check dialog box. Related Topics • Consistency Checking: An Overview, page 310 • Resolve an Inconsistency, page 320 • Review an Inconsistency, page 320

Consistency Check Dialog Box
Opens when you display the properties of an inconsistency indicator, and lists the inconsistencies, their specific problem area, and solutions for resolving the inconsistency. The dialog box also displays the consistency criteria and propagation breaks that apply at the selected relationship indicator. You open this dialog box by right-clicking an inconsistency indicator and choosing Consistency Check from the shortcut menu. You can also select Edit > Consistency Check. When this dialog box first appears, the software automatically selects the first item in the list. Other sections of the dialog box provide details that are specifically related to the selected inconsistency. All inconsistencies that occur at a junction, regardless of severity, are listed on the Consistency Check dialog box. When you select one of the inconsistencies in the list, the software displays information specific to that inconsistency in the Solutions box. A specific example of this type can involve data inconsistencies for nominal pipe diameter, normal operating temperature, and alternate design pressure between a piping component and pipe run. This represents three different problems but at the same junction.

Inconsistencies Tab
All of the properties that are compared by consistency checking and copied across this connection by propagation are shown on these tabs. The information shown here is very similar to the information shown on the Consistency tab of the Rule Properties dialog in the Rule Manager. Open the Consistency Check dialog box by selecting Edit > Consistency Check.

Item 1 - Displays the inconsistency, item type, and item tag for the first item that is connected by the active relationship. When the Consistency Check dialog box first appears, all items involved in the inconsistency are selected. Relationship - Displays the number for the active relationship and allows you to select the relationship to be reviewed. The drop-down list contains a number for each relationship that exists at the selected point. The graphic relationship indicator that corresponds to the number shown in this control is highlighted. Item 2 - Displays the inconsistency, item type, and item tag for the second item that is connected by the active relationship. When the Consistency Check dialog box first appears, all items involved in the inconsistency are selected. Highlight item 1 - Place a check mark in the check box to highlight the item in the drawing. This helps you to quickly locate the selected object. By default, this option is not selected.

SmartPlant P&ID User’s Guide 315

Consistency Checking: An Overview 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. Note
•

Canceling selection of Item 1or Item 2 excludes the item from the select set in the drawing and thereby affects the display in the Properties window.

Consistency Criteria Tab
All of the properties that are compared by consistency checking and copied across this connection by propagation are shown on these tabs. The information shown here is very similar to the information shown on the Consistency tab of the Rule Properties dialog in the Rule Manager. Open the Consistency Check dialog box by selecting Edit > Consistency Check.

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.

SmartPlant P&ID User’s Guide 317

Consistency Checking: An Overview 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. Rule Name - Displays the name of the rule. Item 1 Property - Displays the name of an Item 1 property to be copied and/or compared is displayed in this column. Only those properties that are listed are copied across the relationship (propagated) and compared to the value in the related item (consistency checked). Copy - The copy action to be performed is displayed in this column. This column controls how the property value is propagated when a property value is changed. The following table describes the possible values and their meanings. Copy Action Symbol None -> Copy Action Name None Copy 1 to 2 if Null Copy 2 to 1 if Null Copy Bidirectional if Null Copy 1 to 2 Always Copy 2 to 1 Always Copy Bidirectional Always At Property Modification

The property is not propagated across this relationship. The value from Item 1 is copied to Item 2 during propagation but only if the current value on Item 2 is Null. The value from Item 2 is copied to Item 1 during propagation but only if the current value on Item 1 is Null. The value can be copied in either direction during propagation but only if the current value on the target item is Null. The value from Item 1 is copied to Item 2 during propagation. The value from Item 2 is copied to Item 1 during propagation. The value can be copied in either direction during propagation.

<-

<-->

-> <<-->

318 SmartPlant P&ID User’s Guide

Consistency Checking: An Overview 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 Comparison Operator Meaning None = < <= > >= <> No comparison Equal Less than Less than or equal to Greater than Greater than or equal to Not 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. Related Topics Consistency Check Dialog Box, page 313 • Inconsistencies Tab, page 315 • Properties Command, page 33 • Show Inconsistencies, page 312
•

SmartPlant P&ID User’s Guide 319

Consistency Checking: An Overview

Review an Inconsistency
1. Open a drawing. 2. Double-click an inconsistency indicator. Tip In addition, you can right-click an inconsistency indicator and select Consistency Check. 3. On the Consistency Check dialog box, review the list of possible problem areas at the junction.
•

Notes
•

The options for solving the inconsistency in Solutions vary depending on the type of inconsistency. Consistency Check identifies the type of problem with these symbols: Errors. Warnings. Approved warnings.

•

•

To alert you to possible problems, the Drawing view offers different inconsistency indicators: Warning for suspicious construction in the Drawing view. Error in the Drawing view that warrants your inspection and correction.

Related Topics • Consistency Checking: An Overview, page 310

Resolve an Inconsistency
1. Open a drawing. 2. Double-click an inconsistency indicator. Tips Or you can right-click an inconsistency indicator to review its properties. 3. On the Consistency Check dialog box, select the inconsistency that you want to correct in the list.
•

4. Chose the appropriate solution from the Solutions list.

320 SmartPlant P&ID User’s Guide

Consistency Checking: An Overview Tip
•

An example of a solution is Copy property value Item 1 => Item 2, which could involve inconsistent nominal diameters of a pipe and nozzle, for example. If you determine that this solution is the best one, you can select it and click Apply. Or you can use the Properties window to change the nominal diameter of either the pipe or nozzle. Changing the diameter confirms that the values are consistent with the information that exists in Rule Manager.

The options in the Solutions list vary, depending on the type of inconsistency. 5. Click Apply.
•

A Drawing view also offers graphical symbols to alert you to possible problems: Warning for suspicious construction in the Drawing view Error in the Drawing view that warrants your inspection and correction

Importing Drawing Data: An Overview
There are several ways you can import data into SmartPlant P&ID. You can import data and items into the database using reports and other files. SmartSketch files can be imported into SmartPlant P&ID using the SmartPlant Migrator wizard. Also, you can also populate or redefine pipe run properties by importing an Aspen Zyqad stream data file. During the import process, you can assign the stream and its associated engineering data to the pipe run. Related Topics • Display Help for Programming With SmartPlant P&ID, page 15 • Import Aspen Zyqad Stream Data, page 329 • Populate the Stockpile from a Spreadsheet, page 252

Import Log Dialog Box
Shows the progress of the data importation process and allows you to review the log file. This dialog box opens when you use the Import > Data File command on the File menu. Import log - Lists the results of the file importing process. These results are also available in SPImport.log, which is saved to your local TEMP folder. Related Topics Import Data File Command, page 323 • Modify a Pump by Importing a SmartPlant P&ID Report into the Stockpile, page 254 • Populate the Stockpile from a Spreadsheet, page 252
•

SmartPlant P&ID User’s Guide 323

Importing Drawing Data: An Overview

Import SmartSketch Command
File > Import > SmartSketch Allows you to import data from SmartSketch into SmartPlant P&ID and starts the SmartPlant Migrator wizard. In order to import a SmartSketch drawing into SmartPlant P&ID, you must have SmartSketch installed on your computer. Related Topics • Import a SmartSketch File, page 327

Using the SmartPlant Migrator
The SmartPlant Migration Wizard is a data migration tool provided by SmartPlant P&ID for converting and importing process flow diagrams (PFDs) and preliminary process and instrumentation diagrams (P&IDs) from SmartSketch into SmartPlant P&ID. When migrating your SmartSketch file to SmartPlant P&ID, the Migrator maintains graphic visual fidelity. During processing, the Migrator scans the SmartSketch file and maps all the objects to SmartPlant P&ID equivalent objects. Any graphics that cannot be mapped are placed in a SmartSketch file that is then placed as an inserted object in the SmartPlant P&ID file. The database does not contain any information for these unmapped objects. Placement Order After the SmartSketch file is scanned and all its objects are mapped to SmartPlant P&ID objects, the Migrator uses rules to determine the order in which to place the resulting symbols. Certain symbols cannot be placed unless a rule has been met. For example, a nozzle cannot be placed unless it is attached to a piece of equipment. SmartSketch does not have rule sets. To account for the rules in SmartPlant P&ID, the Migrator looks at the SmartSketch symbols to determine what the symbols are attached to. Symbol placement is performed in this order: 1. Stand-alone symbols 2. Symbols attached to stand-alone symbols 3. Connectors and pipes 4. Symbols attached to connectors or pipes 5. Symbols attached to symbols that are attached to a connector or pipe 6. Labels 7. SmartSketch graphics that are not recognized as symbols

324 SmartPlant P&ID User’s Guide

Importing Drawing Data: An Overview Rule Considerations Because the SmartPlant Migration Wizard cannot account for all the rule possibilities that are defined in the default SmartPlant P&ID rule set or a customized rule set, you must create your SmartSketch drawing with the SmartPlant P&ID rule set in mind. SmartPlant P&ID Rule Manager contains the rules used when creating a P&ID. This includes default rules and any rules you have created. The P&ID user and the SmartSketch user must collaborate on what the rules allow to be placed in a P&ID so that the SmartSketch drawings account for the different possibilities. For example, if you create a rule for special requirements for equipment or instrumentation placement in your P&IDs, the SmartSketch user needs to be made aware of these rules. Supported Templates - Intergraph Process Flow and P&ID symbols map to the SmartPlant P&ID reference data included with the software. Symbols - Delivered symbols with a matching AABBCC code are mapped intelligently to the equivalent SmartPlant P&ID symbol, or you can edit a symbol map file to equate the symbol names between SmartSketch and SmartPlant P&ID. You can check the symbol map file, SymbolMap.csv, for duplicate codes. This file is created during the migration process and you can open this file by using Microsoft Excel. Notes
•

The AABBCC code is not displayed in Catalog Explorer or the Properties window in SmartPlant P&ID. To view the code, you must open the item in Catalog Manager. Because SmartSketch is file-driven and SmartPlant P&ID is databasedriven, both products have independent sets of symbols; therefore, symbol definitions and attributes migrated from a SmartSketch file are stored as properties in the SmartPlant P&ID database. SmartSketch symbol attributes are conditionally migrated; this means that the attribute must exist as a SmartPlant P&ID property for that symbol. SmartSketch has a default set of attributes for vessels, pumps, compressors, and shell and tube exchangers. These attributes are the same as the SmartPlant P&ID properties for the same items. All of those attributes, if given a value in SmartSketch, migrate to the SmartPlant P&ID property database. You can add your own unique attributes to a P&ID symbol in SmartSketch, and if that same symbol with same properties is available in SmartPlant P&ID, custom SmartSketch attributes can migrate into those properties. You define custom properties for SmartPlant P&ID symbols by using Catalog Manager.

•

Nozzles - Nozzles are required for connection of piping in SmartPlant P&ID. Nozzles are required in the SmartSketch document for connections to be established when converted to SmartPlant P&ID.

SmartPlant P&ID User’s Guide 325

Importing Drawing Data: An Overview Non-Nozzle Connections - Piping linear objects not connected to nozzles are placed in SmartPlant P&ID, but are not connected. You have to make valid connections manually in SmartPlant P&ID. Flow - Appropriate flow direction is established based on the terminator of the connector. Properties - User-defined and default SmartSketch properties are mapped to an equivalent SmartPlant P&ID property. SmartLabels - Item tags and other single property labels are maintained intelligently. Notes
•

Labels in SmartSketch files are migrated very much like symbols. Any label placed in SmartSketch must have an equivalent label in SmartPlant P&ID before it can migrate. SmartSketch does include a subset of the SmartPlant P&ID labels, and most of the common labels are smart labels, which are labels that are associated with one or more object properties. The properties of these smart labels are passed to the symbol to which they are attached and migrate to SmartPlant P&ID. In order to assign an AABBCC code to a SmartPlant P&ID label so that it matches a SmartSketch label, do the following. 1. Open the P&ID label in Catalog Manager. 2. Right-click the symbol page in order to open the File Properties dialog box, and click the Symbol tab. 3. In the Name box, type AABBCC_code. 4. In the Type box, select Text. 5. In the Value box, enter the appropriate AABBCC code, for example, 1F6Y01.

•

Unrecognized Graphics and Annotations - All unrecognized graphics are inserted in the SmartPlant P&ID drawing as embedded SmartSketch graphics. This rule maintains visual fidelity even if there are items that could not be mapped intelligently. Limitations - The following list shows planned limitations of the Migrator:
• • •

Multiple iterations are not supported Flow direction that is indicated by using symbols is not understood The primary goal is not to take fully developed P&IDs into a data-centric environment The SmartSketch Migrator converts entire files only. If you want to migrate only a portion of a file, select the geometry that you want to migrate and copy and paste it into another file. Then the file you just created can migrate

•

326 SmartPlant P&ID User’s Guide

Importing Drawing Data: An Overview Notes
•

In order to import a SmartSketch drawing into SmartPlant P&ID, you must have SmartSketch installed on your computer. You can determine if all the graphics in your file migrated correctly by viewing the GetSmart.log file in the Temp folder. This file contains information about the migration such as the file that was migrated, the time that the migration started and stopped, the symbols that were migrated, and any errors encountered during the migration.

•

Related Topics • Import a SmartSketch File, page 327

Import a SmartSketch File
Important In order to import a SmartSketch drawing into SmartPlant P&ID, you must have SmartSketch installed on your computer. 1. Open the drawing that you want to import the SmartSketch objects into.
•

The Migrator allows you to browse in the file system for the SmartSketch drawing that you want to import.

Notes
•

The SmartSketch Migrator converts entire files only. If you want to migrate only a portion of a file, select the geometry that you want to migrate and copy and paste it into another file in SmartSketch. Then the file you just created can migrate. You can determine if all the graphics in your file migrated correctly by viewing the GetSmart.log file in the Temp folder. This file contains information about the migration such as the file that was migrated, the time the migration started and stopped, the symbols that were migrated, and any errors encountered during the migration.

•

Related Topics • Using the SmartPlant Migrator, page 324

SmartPlant P&ID User’s Guide 327

Importing Drawing Data: An Overview

Importing Aspen Zyqad Stream Data
You can populate or redefine pipe run properties by importing an Aspen Zyqad stream data file. During the import process, you can assign the stream and its associated engineering data to the pipe run. Aspen Zyqad spreadsheets in either Microsoft Excel or XML format are supported. Such spreadsheets include the Vessel Equipment List, Pump Equipment List, and Heat Exchanger Equipment List. Importing Aspen Zyqad XML data files allows greater flexibility when importing data into the design software. All three reports, Vessels, Pumps, and Exchangers, are included in a single XML report so that only one file has to be imported. You can easily update stockpile items that originate from importing Aspen Zyqad data by re-importing a data file. Previously imported items, whether they remain in the stockpile or have already been placed in the drawing, are updated with data from the newly imported file. Important
•

If a format change is made to an exported Aspen Zyqad report, modifications must be made to the import code to accommodate the changed report layout. For more information, see the SmartPlant P&ID Programmer's Guide.

Import Aspen Zyqad Stream Data
1. Select a pipe run from the drawing to display the Properties window for the pipe run. Tip If the Properties window is not open, you can click Edit > Properties after you select the pipe run. 2. Click the Calculate button next to the Stream No. cell to display the Stream Number dialog box.
•

Related Topics • Using Reports to Import Items into the Stockpile, page 251

SmartPlant P&ID User’s Guide 329

Generating Reports: An Overview

Generating Reports: An Overview
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 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 toplevel 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.

330 SmartPlant P&ID User’s Guide

Generating Reports: An Overview You begin your reporting process by selecting items in the drawing for inclusion in your report. You can select individual items, or you can select the Entire Drawing option. You can also select Include items in the Drawing Stockpile (available only for the active drawing and when you select Reports > Plant Reports or My Reports). Then, select report template from the Reports menu. Then the software performs the following tasks: 1. Microsoft Excel starts. The report template is copied to the report output folder, and then the Excel workbook opens. 2. Your report definition is retrieved from the Excel workbook. 3. Your data is retrieved based on the report item definitions of the report template. 4. Data prints to the Microsoft Excel workbook using the cell mapping data in your report definition. Notes
•

To create a Plant wide report, use the Engineering Data Editor commands View > Plant Reports or My Reports. You must have installed Microsoft Excel on your computer to display reports. The software stores the reports that you generate in your Windows directory under \Profiles\username.

Plant Reports Command
Reports > Plant Reports Opens the Plant Reports dialog box, which displays a list of all plant-level reports associated with the current plant. This list is alphabetical. The location of these report templates is defined in Options Manager. Selecting a plant report from this list and specifying the items that you want to report on generates the associated report in Microsoft Excel. This command is available on the Reports menu on the main toolbar and also on the View menu in the Engineering Data Editor. If you have a drawing in the Design window and you want to report on items in that drawing, use this command from the Reports menu. If you want to run a report based on items in your Engineering Data Editor, use this command from the Engineering Data Editor View menu. Note
•

The Engineering Data Editor is the area where you can view stockpile items.

Plant Reports Dialog Box
Allows you to choose a report and specify what items to report on. This dialog box opens either when you click Reports > Plant Reports on the main toolbar or when you click View > Plant Reports on the Engineering Data Editor toolbar. If you want to run a report on drawing items, use the Reports menu; if you want to run a report on table items, use the Engineering Data Editor View menu.

Current Selection - Produces a report containing the items currently selected in your drawing or table. This option is not available if no drawing or table items are selected. You cannot choose the Include items in drawing stockpile option when you choose Current Selection. Entire drawing - Produces a report containing the contents of the entire drawing. This option is available only when you use the Reports menu command. Include items in drawing stockpile - Allows you to specify whether or not you want items that reside in the drawing stockpile in your report. This option is available only when you use the Reports menu command. Related Topics • Generate a Report, page 334 • Plant Reports Command, page 332 • Select an Item, page 135

SmartPlant P&ID User’s Guide 333

Generating Reports: An Overview

Generate a Report
1. In the Drawing view or Engineering Data Editor, select the items that you want to include in the report. Tip If you select no items, the software gives you the option to report on all items. 2. Click Reports > Plant Reports.
•

Tip Or click Reports > My Reports to select a customized report that you defined already. 3. Select the report that you want to generate.
•

4. In the Report using area on the Plant Reports dialog box or the My Reports dialog box, choose the items that you want to report on. Notes
•

You must have installed Microsoft Excel on your computer to display reports. Before running the Line List report, verify that every line in the selection has an Item Tag. The software stores the reports that you generate in your Windows directory under \Profiles\username.

My Reports Command
Reports > My Reports Opens the My Reports dialog box which lists all user-level reports. They can be stored on your local workstation. This list is alphabetical. If you want to run a report based on drawing items, access this command from the Reports menu on the main toolbar; if you want to run a report based on table items, access this command from the View menu on the Engineering Data Editor toolbar. Note
•

You can define the location for storing user-level report templates by clicking Tools > Options and then selecting the Files tab.

My Reports Dialog Box
Allows you to choose one of your custom reports and to specify what items to report on. This dialog box opens either when you click Reports > My Reports on the main toolbar or when you click View > My Reports on the Engineering Data Editor toolbar. If you want to run a report on drawing items, use the Reports menu; if you want to run a report on table items, use the Engineering Data Editor menu. Report using - Displays options for specifying the scope of your report. The options that appear in this area depend on the view, Drawing view or Engineering Data Editor, that is active when you access this dialog box. Current Selection - Produces a report containing the items currently selected in your drawing or table. This option is not available if no drawing or table items are selected. You cannot choose the Include items in drawing stockpile option when you choose Current Selection. Entire drawing - Produces a report containing the contents of the entire drawing. This option is available only when you use the Reports menu command. Include items in drawing stockpile - Allows you to specify whether or not you want items that reside in the drawing stockpile in your report. This option is available only when you use the Reports menu command, not the Engineering Data Editor command. Related Topics Generate a Report, page 334 • My Reports Command, page 335 • Select an Item, page 135
•

336 SmartPlant P&ID User’s Guide

Generating Reports: An Overview

Creating and Editing Report Templates: An Overview
Although the software includes several default report templates, such as Equipment List and Pipe Run List, you create your own custom report templates or modify the delivered templates in order to gather and display the specific information that you want. So the software allows you to define report templates in several different formats and with all manner of information from the design database. You can create report templates in three different formats:
• • •

Tabular Fixed Composite Format Report

The delivered report templates are all tabular format reports. Fixed format templates allow the greatest amount of freedom in formatting your report, and composite report templates, as the name suggests, combine tabular and fixed formatting. Not only can you completely control the format of your report, but you can control the content of the template also. Each report is based on a unique item type, and the properties that are associated with that item type are readily available to include in your report. In addition, any item that is related in any way to the basic item type of your report makes its properties available to include in the definition of your template, too. For instance, the properties of inline components and instruments can be used in a pipe run report because inline components are related to their pipe runs. In order to discover how items and their properties are related, and thereby how you can map the properties that you want into your report templates, see the Properties Glossary, which is included in the glossaries attached to online Help. Portable report templates In previous versions of the software, when a property is mapped to a report template, the template file stores an internal identifier for that property; thus, that report template is tightly linked to the plant that creates the property. Now the property name is mapped into the report template; therefore, as long as all plants use the same property name, the same report template is valid. Related Topics Create a New Blank Report Template, page 344 • Define the Contents of Your Report Template, page 356 • Define the Layout of a Composite Format Report Template, page 342 • Define the Layout of a Fixed Format Report Template, page 340 • Define the Layout of a Tabular Format Report Template, page 338 • Edit a Report Template, page 347
•

SmartPlant P&ID User’s Guide 337

Generating Reports: An Overview

Tabular Format Report
All the delivered report templates are tabular format reports. When the report is generated, all properties populate the report by using the same format defined for the first row. In other words, tabular format reports are row-based. The Options command on the SmartPlant Reports toolbar is important for setting aside space for the header and empty rows between lines in the report because the placement of report item properties is restricted in the tabular format report template. For example, the report template for an Equipment List can appear like this: Equipment Name Equipment Description Equipment Type

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.

•

• •

338 SmartPlant P&ID User’s Guide

Generating Reports: An Overview 3. Choose the number of empty lines that you want between rows in your report. Each row is filled with properties for one item. Tip Some report templates, for example the Line List, designate two rows of data for each report item and then an empty row. 4. Click OK to close the Options dialog box.
•

5. Complete general labels and graphics, if needed, in your header. 6. Complete column headings in the last row of your header. 7. Select a cell in your report template where you want to map a particular property. Tip This cell can be either in the body of the report or in the header. 8. Choose the property that you want to map to your cell from the Map Properties menu. The items on this menu are chosen when you define the contents of your template. For more information, see Define the Contents of Your Report Template, page 356.
•

Tips
•

You only have to map properties for one item. Properties for all the items follow the format you map for the first one.

Only one property can be mapped to a given cell, although the same property can be mapped to more than one cell. 9. Repeat the previous steps until you have mapped all the properties that you want to map on this report template.
•

10. Save the template and quit Microsoft Excel. Notes
•

Because the delivered report templates are tabular format, if you create a template based on an existing template, the format of your report template is also tabular. Select Blank as your source template if you want to create a fixed or composite format report template. The location of plant-level report templates is specified in Options Manager. The location for user-level templates is defined on the Files tab of the Options dialog box (Tools > Options). When you add any property value in the header, a new Microsoft Excel worksheet is created, and the header is saved on the new sheet because the entire header no longer fits in the space allotted on the first sheet. You can customize the number of rows in the report header by using the Options command on the SmartPlant Reports toolbar and choosing a larger value in the Rows in report header option in the Options dialog box.

Fixed Format Report
The fixed format report creates one Microsoft Excel worksheet for each item. When defining the report template, you only edit the first worksheet. When you generate your report, all fixed format worksheets, one for each item of the report item type, follow the format of the first Microsoft Excel worksheet. The Options button on the SmartPlant Reports toolbar is not available for editing a fixed format report template because you are free to place headers and data anywhere you want on your worksheet. Related Topics • Create a New Blank Report Template, page 344 • Create a Report Template Based on an Existing Template, page 349 • Define the Layout of a Fixed Format Report Template, page 340 • Display the Properties of a Report Template, page 349 • Edit a Report Template, page 347

Define the Layout of a Fixed Format Report Template
1. Choose a cell on your Microsoft Excel worksheet and type labeling information into it. Tip A label is not a required feature of a fixed format report template. You can simply map properties to cells without any labeling if you want. 2. Choose a cell where you want the property associated with the labeling to appear.
•

3. Click Map Properties on the SmartPlant Reports toolbar, and from the menu select the property that you want to map to the cell you chose in the previous step. Tip 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, page 356. 4. Repeat the previous steps until you have labeled and mapped all the needed report item properties to the corresponding locations in your template. When you generate a fixed format report, the data for each report item appears in its own worksheet, and the layout for each worksheet matches the layout defined for the first worksheet.
•

340 SmartPlant P&ID User’s Guide

Generating Reports: An Overview Note
•

You use the Options command on the SmartPlant Reports toolbar to designate space for your header and to specify the number of blank lines that you want between rows of data on your report. The Options command is not available for fixed format report templates because you are free to place headers and data anywhere on your worksheet.

Define the Layout of a Composite Format Report Template
1. Define the layout of the first Microsoft Excel worksheet. In a composite format report template, the first worksheet is automatically fixed format. For more information about defining fixed format report templates, see Define the Layout of a Fixed Format Report Template, page 340. Tips
•

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.

You use the Options command on the SmartPlant Reports toolbar to designate space for your header and to specify the number of blank lines that you want between rows of data on your report. The Options command is not available for fixed format report templates because you are free to place headers and data anywhere 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, page 338.
•

3. After you have defined the layout for the first and second worksheets in your report template, save the template and quit Excel. Notes
•

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 Report Template Dialog Box
Displays options for creating plant-level and user-level report templates. This dialog box opens when you click Reports > New on the main menu bar. Source template - Lists the names of all existing report templates and Blank. You select a user-level template, plant-level template, or Blank. The Blank option creates a Microsoft Excel workbook with no predetermined formatting information. If you chose Blank, you must specify an item type; whereas, if you do not chose Blank, the item type automatically displays the item type that corresponds to your source template. Templates in this list appear in alphabetical order. Name - Allows you to enter a meaningful name to describe the report that you are creating. This name matches your Microsoft Excel workbook. The software appends .xls to the name when you save the Excel workbook. Item type - Defines the item properties available in your report. If you do not select a Blank source template type, then the Item type option automatically displays the item type that corresponds to your source template. Report Type - Specifies your report format. Available options include fixed, tabular, and composite. All delivered report templates are tabular format. Fixed format - Creates one Microsoft Excel worksheet for each item. You only edit the first worksheet, but all fixed format worksheets, one for each item of the report item type, follow the format of the first worksheet when you generate your report. The Options button on the SmartPlant Reports toolbar is not available for editing a fixed format report template because you are free to place headers and data anywhere you want on your worksheet.

SmartPlant P&ID User’s Guide 343

Generating Reports: An Overview Tabular format - Formats your report in a table. That is, the properties of each item included in your report begin on a unique row, or the template format is row-based. All delivered reports are tabular format. Composite format - Formats your report in a combination of fixed and tabular formats. The first sheet in the workbook is Fixed format; the second sheet is Tabular format. Subsequent fixed format worksheets are created after sheet two for each item of your report item type when you generate your report. Description - Describes the report type that this template produces. You can assign any description. Related Topics • Create a New Blank Report Template, page 344 • Display the Properties of a Report Template, page 349 • Edit a Report Template, page 347 • Edit Command, page 345 • New Command, page 38

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, page 349.

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.
•

Tip This entry is the name of your Microsoft Excel workbook. When you save the template, the software appends .xls to the name. 4. In the Item type box, select an item type.
•

5. In the Report type box, choose template format. Tip
•

These options are only available when you choose Blank from the Source template list.

344 SmartPlant P&ID User’s Guide

Generating Reports: An Overview 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. Tip You must have the appropriate permissions, granted in SmartPlant Engineering Manager, to create plant-level report templates. 8. Click OK to create the 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. Note
•

Edit Report Template Dialog Box
Displays a list of available report templates and opens the selected report template in Microsoft Excel so that you can make changes to it. Click Properties to view and update properties for a report template. This dialog box opens when you click Reports > Edit on the main menu bar. Available reports - Lists all report templates available to edit or customize. Select a template from the list. Properties - Displays the Report Properties dialog box where you can modify the description and the report template format. Open - Displays the selected template in Microsoft Excel. Important
•

You must have the correct privileges, granted in SmartPlant Engineering Manager, to edit plant-level report templates.

Report Properties Dialog Box
Displays properties for plant-level and user-level report templates. This dialog box opens when you click Properties on the Edit Report Template dialog box. Source template - Displays the names of all existing report templates and Blank. You select a user-level template, plant-level template, or Blank. The Blank option creates a Microsoft Excel workbook with no predetermined formatting information. If you choose the Blank option, you must specify an item type; whereas, if you do not choose Blank, the software automatically specified the Item type option as the item type that corresponds to your source template. Templates in this list appear in alphabetically. Name - Allows you to enter a meaningful name to describe the report that you are creating. The name matches your Microsoft Excel workbook. The software appends .xls to the name when you save the Excel workbook. Item type - Defines the item properties available to populate your report. If you select a source template other than Blank, the Item type option is automatically specified with the item type that corresponds to your source template. Report Type - Specifies your report format. Available options include fixed, tabular, and composite. 346 SmartPlant P&ID User’s Guide

Generating Reports: An Overview Fixed format - Creates one Microsoft Excel worksheet for each item. You only edit the first worksheet, but all fixed format worksheets, one for each item of the report item type, follow the format of the first worksheet when you generate your report. The Options button on the SmartPlant Reports toolbar is not available for editing a fixed format report template because you are free to place headers and data anywhere you want on your worksheet. Tabular format - Formats your report in a table. That is, the properties of each item included in your report begin on a unique row, or the report format is row-based. All delivered report templates are tabular. Composite format - Formats your report in a combination of fixed and tabular styles. The first sheet in the workbook is fixed format; the second sheet is tabular format. When you generate your report, the software creates subsequent fixed format worksheets after sheet two for each item that matches your report item type. Description - Describes the report type that this template produces. You can assign any description. Related Topics Create a New Blank Report Template, page 344 • Display the Properties of a Report Template, page 349 • Edit a Report Template, page 347 • Edit Command, page 345 • New Command, page 38
•

Because you are modifying a template that already is defined, changing the Report type option and the description are the only available actions on the Report Properties dialog box. Click Open on the Edit Report Template dialog box to display the report in Microsoft Excel so that you can edit the layout and contents of your report template.

SmartPlant P&ID User’s Guide 347

Generating Reports: An Overview Notes
•

You must have the correct permissions in SmartPlant Engineering Manager to edit a report template.

2. Type Sheet1.Application.CommandBars("SmartPlant Reports").Delete in the Immediate window. 3. Quit Excel, and the toolbar is displayed the next time a report is edited. Related Topics Creating and Editing Report Templates: An Overview, page 337 • Generating Reports: An Overview, page 330
•

348 SmartPlant P&ID User’s Guide

Generating Reports: An Overview

Create a Report Template Based on an Existing Template
1. Click Reports > New. 2. On the New Report Template dialog box, select an existing template from the Source template list. 3. In the Name box, type a name for the new report template. 4. In the Description box, type a description for the new report template. 5. Click OK. 6. When the software gives you the option to edit your template, click OK to open Microsoft Excel and define the contents and layout of your report. For more information about those procedures, see Define the Contents of Your Report Template, page 356 Define the Layout of a Tabular Format Report Template, page 338 Define the Layout of a Fixed Format Report Template, page 340 Define the Layout of a Composite Format Report Template, page 342 Notes
•

Because the delivered report templates are all in tabular format, if you create a template using an existing template, the format of your report template is tabular. Because you are creating a report based on an existing template, some options on the New Report Template dialog box are not available. In order to make all options available, choose Blank from the Source template list. For more information, see Create a New Blank Report Template, page 344.

Appears when you are editing or creating a report template in Microsoft Excel. Note
•

If the SmartPlant Reports toolbar is missing when editing report templates in Microsoft Excel, then click Tools > Macro > Visual Basic Editor in Excel and follow the steps below: 1. Select View > Immediate Window. 2. Type Sheet1.Application.CommandBars("SmartPlant Reports").Delete in the Immediate window. 3. Quit Excel, and the toolbar is displayed the next time a report is edited.

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 Reports 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.

SmartPlant P&ID User’s Guide 351

Generating Reports: An Overview In order to define the layout of the report item properties, you assign properties to particular cells. Select the cell and then select the property from the Map Properties menu on the SmartPlant Reports toolbar. Note
•

In order to generate From and To data for all Microsoft Excel worksheets, click Tools > Macro > Macros > PrintFromToDataForAllSheets in Excel. Choose the PrintFromToDataForActiveSheet macro to generate this data for only the active worksheet.

Define Report Contents Dialog Box
Defines new items to include in your report and selects the cells to include for the new items. This dialog box opens when you click Define on the SmartPlant Reports toolbar. Define - Displays the Define Report Items dialog box. For the selected item in the Report on tree, you define the properties that you want available for inclusion in your report template. Delete - Removes an item from the tree view and from your report structure. Its properties are no longer available for your report template. New - Displays the New Items dialog box. You use this dialog box to specify new item types to include in the Report on tree. If you add a new item type, its properties are available for inclusion in your report template. Report on - Displays a tree view of item types the properties available for inclusion in your report template. To include the properties, you must select an item from the Report on list and click Define. Then you can map the properties that you select to cells in your report template. Note
•

The level into which you add an item type affects the properties that you can access for your template. That is, a new item type added into the hierarchy under another item type does not give you access to the same properties that you have if the item type is higher in the hierarchy. For instance, if you add the equipment item type under nozzles, the equipment item type only reports on equipment associated with a nozzle, and equipment without nozzles is not reported.

Related Topics • Create a New Blank Report Template, page 344

352 SmartPlant P&ID User’s Guide

Generating Reports: An Overview

New Items Dialog Box
Opens when you click New on the Define Report Contents dialog box and displays a list of items that are related to the item that you selected there. Select an item type to make its properties available to include in your report. Apply - Adds the selected item type to the Report on tree on the Define Report Contents dialog box. The software adds this item type as a child of the item type selected on the Define Report Contents dialog box. Note
•

The level into which you add an item type affects the properties that you can access for your template. That is, a new item type added into the hierarchy under another item type does not give you access to the same properties that you have if the item type is higher in the hierarchy. For instance, if you add the equipment item type under nozzles, the equipment item type only reports on equipment associated with a nozzle, and equipment without nozzles is not reported.

Items related to - Displays a list of item types related to the item type that you selected in the Report on tree on the Define Report Contents dialog box. Select item types from this list to include in your report template. The properties of the new item types are then available to use in your report. Name - Displays the name of the selected item type. You can rename the item. If you have duplicate item type names in your report item type hierarchy, the software prompts you to rename the new item type uniquely. Related Topics • Create a New Blank Report Template, page 344 • Define Command, page 351 • Define the Contents of Your Report Template, page 356 • Edit a Report Template, page 347 • New Command, page 38

Define Report Items Dialog Box
Specifies the report item properties available for your report. Select the properties to include for each report item type and define sorting and filtering for those properties. This dialog box is accessed by clicking Define on the Define Report Contents dialog box, which, in turn, is accessed by clicking Define on the SmartPlant Reports toolbar. Related Topics • Create a New Blank Report Template, page 344 • Define the Contents of Your Report Template, page 356 • Edit a Report Template, page 347

SmartPlant P&ID User’s Guide 353

Generating Reports: An Overview

Properties Tab (Define Report Items Dialog Box)
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 containing Drawing cells. Available properties - Displays all properties for the report item you specified on the Define Report Contents dialog box. Selected properties - Lists the report item properties you have selected from the Available properties list that are consequently available for inclusion in your report. Left Arrow - Moves the selected item in the Selected properties list to the Available properties list. You can select more than one item by using the Shift and Ctrl keys and then clicking the left arrow. Also, double-clicking an item in the Selected properties list moves it to the Available properties list. Right Arrow - Moves the selected item out of the Available properties list and into the Selected properties list. You can select more than one item by using the Shift and Ctrl keys and then clicking the right arrow. Also, double-clicking an item in the Available properties list moves it to the Selected properties list. Use short text - Displays the short text value, which is defined in SmartPlant Data Dictionary Manager. Only select-listed properties can be displayed in their short value form. In a few cases, the short value is longer than the regular value. Use select list index - Includes the numerical index of the select entry along with either the short value or select list value for that property. For more information about select lists and their values and indices, see SmartPlant Data Dictionary Manager Help. Related Topics Edit a Report Template, page 347 • New Command, page 38
•

Sort Tab (Define Report Items Dialog Box)
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. Related Topics • Define the Contents of Your Report Template, page 356 • Edit a Report Template, page 347 • New Report Template Dialog Box, page 343 SmartPlant P&ID User’s Guide 355

Generating Reports: An Overview

Define the Contents of Your Report Template
1. On the SmartPlant Reports toolbar in Microsoft Excel, click Define. 2. Select the node in the Report on hierarchy under which you want the new item type to appear to add a new report item type so that its properties are available to map onto your report template. 3. Click New. Tips
•

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. Tip 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. Tip 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.

356 SmartPlant P&ID User’s Guide

Generating Reports: An Overview Tips
•

If you want to sort the order in which your items are listed when you generate a report, choose the property or properties to sort on by using the Sort tab.

If you want to change the filter that finds your report items, use the Filter tab. For instance, you can switch from a filter that displays all pumps to a filter that displays only active pumps. 11. Click OK.
•

Tip The Define Report Contents dialog box remains open, and so you can repeat the previous steps to continue adding more items and specifying their properties. 12. When you have selected all the properties that you want in your report, click OK on the Define Report Contents dialog box.
•

Notes
•

All the properties that you have made available to map into your template are now displayed when you click Map Properties on the SmartPlant Reports toolbar. Now you can use the properties you have specified in the layout of your template. In order to generate From and To data for all Microsoft Excel worksheets, click Tools > Macro > Macros > PrintFromToDataForAllSheets in Excel. Choose the PrintFromToDataForActiveSheet macro to generate this data for only the active worksheet.

Report Options Dialog Box
Specifies the number of empty rows between items in your report and the number of rows in your report header. This dialog box opens when you click Options on the SmartPlant Reports toolbar in Microsoft Excel. Skip lines between rows - Defines the number of blank lines between each row in your report. You can enter a value in the box or use the scroll buttons to select a value. The maximum value allowed is 1000. Rows in report header - Specifies the number of rows in your report header. Note
•

The Options command is available for tabular and composite format report templates only. It is not available for fixed format report templates because you are free to place captions and properties in any configuration that you want. In fixed format report templates, you are not constrained to have a header or rows at all.

Map Properties Command
MS Excel > SmartPlant Reports Toolbar > Map Properties Displays a menu of all properties associated with your report. This menu is populated with the items that you define with the SmartPlant Reports toolbar Define command. The Map Properties menu contains a subset of all the properties in the plant database. You can select a cell in your report template and then assign a property from the Map Properties list. The software places the corresponding property in the selected cell. You do not have to map all the properties in the Map Properties menu, and you can add properties to the menu by using the Define command again. Note
•

The SmartPlant Reports toolbar appears in Microsoft Excel when you create or edit a report template.

Printing Drawings: An Overview
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. Note Zero length pipe runs will print. For example, when a reducer is connected to a nozzle, the zero length pipe run between these symbols will print. Zero length pipe runs will not print if you print your drawing using Drawing Manager. Preparing to print The printer you use affects the way the current drawing prints and displays text on the screen. Before you print a drawing, you must install and select the printer you want to use. For more information about installation, see the documentation for your printer. Before you print, select a printer and the settings for it. To do this, click the Print command on the File menu, and then click the printer you want to use. You can set properties for the printer by clicking the Properties button. To set the print range and scale, click the Settings button. Printing a Drawing As you work on a drawing, you can send a copy of it to a specified printer, plotter, or file. You can click the Print command on the File menu to do the following:
• •

Print an entire drawing or specific views from a drawing. Set printing options, such as the range of sheets or number of copies to print.

The software supports plotting using standard Windows plotting capabilities. It also supports pen plotters, subject to the limitations of the device driver. Items look the same on the screen and in the printed drawing. However, the fonts you select can affect the match between what you see on the screen and what appears on the printed page. Three kinds of fonts affect your work: scalable fonts, printer fonts, and screen fonts. Use scalable fonts, such as TrueType® fonts, to make sure that what you see on the screen is what appears on the printed page. If you use printer fonts, you must have a corresponding screen font and font size to display each font on the screen. If each screen font you use has a matching printer font, the screen display of the drawing closely matches the printed drawing.

360 SmartPlant P&ID User’s Guide

Printing Drawings: An Overview Printing Part of a Drawing You can print selected sheets in a drawing or a selected area. This feature is handy if you are working on a complex drawing and you want to print only certain parts to proof them. You can print all views or certain views. You can print not only drawing items that are selected, but other items that are in the view with the select set print. Printing Time Drawings can take some time to print. Expect longer print times when you have drawings that contain a large number of the following items:
• • • •

Curved items Many fills that have complex colors, patterns, or textures Large bitmaps Links to various drawings

The type of printer you have also affects the printing time. PostScript® printers print faster than LaserJet printers, because they can make the necessary calculations faster. Some older versions of PostScript® printers are slower when compared to the newer ones. The type of controller boards and the amount of RAM in the printer also affect your printing times. Related Topics • Print a Drawing, page 365 • Print a Selected Area, page 365 • Print to a File, page 367

SmartPlant P&ID User’s Guide 361

Printing Drawings: An Overview

Print Command
File > Print Sends a copy of the active drawing to a specified plotter, printer, or file. Options are available for defining the printing area, range, number of copies, and other printing characteristics. Selecting File > Print also opens the Print dialog box. Before using this command, you must install and select a printer. For help on installing a printer, see the printer documentation. Related Topics • Printing Drawings: An Overview, page 360 • Set Print Options, page 366 • Working with Drawings: An Overview, page 102

Print Dialog Box
Controls how a drawing is printed. This dialog box opens when you click File > Print on the menu bar. Name - Specifies the printer you want to use. You can select from a list of all the available configured printers. The information below the Name box applies to the selected printer. The printer you select in the Name box is the default printer for the rest of the current design session until you specify a different printer. Properties - Opens the Printer Document Properties dialog box, which allows you to specify page setup and other printer settings. Status - Describes the state of the selected printer, such as, busy or idle. This area is read-only. Type - Displays the type of printer currently selected. This area is read-only. Where - Identifies the printer path, printer port, queue name, or physical location of the currently selected printer. This area is read-only. Comment - Displays any comments you entered during printer configuration. This area is read-only. Print to file - Stores your drawing in a file with extension .prn instead of sending it to a printer. The Print to File dialog box appears when you select the Print to file option on the Print dialog box and then click OK. You select a file name and location for the print file in the Print to File dialog box. Then you can print from a computer that does not have the application installed or print to a printer other than the one you currently have configured.

362 SmartPlant P&ID User’s Guide

Printing Drawings: An Overview Drawing - Prints your entire drawing. View - Activates the All and Active check boxes so you can then define the view or views to print. Selection - Prints the user-defined area. When you select this option, the Settings button at the bottom of the Print dialog box is unavailable. All - Prints each defined view associated with the drawing. Active - Prints only the active view. Fit to page - Prints your entire drawing on one page. Print watermark - Prints a faint graphic in the drawing background. Print black and white - Prints the drawing in black and white. Number of copies - Displays the number of copies you want to print. Type the number or use the scroll buttons to specify a number. 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. Related Topics • Print a Drawing, page 365 • Print Command, page 362 • Print to a File, page 367 • Set Print Options, page 366

SmartPlant P&ID User’s Guide 363

Printing Drawings: An Overview

Settings Dialog Box
Specifies the area you want to print. This dialog box opens when you click Settings on the Print dialog box. Best fit - Scales the selected drawing sheets or print area to fit the printer paper for the configured device. Manual scale - Specifies the scale value to apply to the print range during printing. For example, if the print range is a rectangle at 12 cm by 12 cm and you set a manual scale of 1:12, then the printed range appears to be 1 cm by 1 cm on the printer paper. If you want a 1:1 drawing of the current sheet scale, you can set the Paper length option to 1 and the Design length option to 1. Paper length - Specifies the paper length for the document you want to print with respect to the Design length option. Design length - Specifies a design length (size of the printed graphic) with respect to the Paper length option. Center - Positions the print area center to the center of the printer paper. If you do not set this option, then the paper positions at bottom left to bottom left. 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. Note
•

For many of the options on this dialog box such as, Design length, Paper length, X, Y, and so forth, when you change an option, the red, blue, and black boxes in the Preview area change to reflect your new values. Therefore, you have a dynamic representation of how your graphic fills the printed sheet.

Print a Drawing
1. Click Print on the Main toolbar. 2. Select the printer that you want to use from the Name list. 3. In the Number of copies box, type the number of copies you want. 4. In the Print range box, specify the range of pages you want to print. Caution
•

It is a good idea to save your drawing before you print it so that a printer error or other problem does not cause you to lose any work completed since the last time you saved the drawing. Notes

•

You can set other options for the printer by clicking the Properties button or the Settings button on the Print dialog box. Click File > Page Setup to specify the drawing size. You can display the drawing as it is to be printed. Click Tools > Options. On the General tab, select the Display as printed option. Before you can print for the first time, you must connect the printer to the computer or network, install a printer driver, and select the printer to print the drawing. For more information about how to install a printer, see the printer documentation.

Set Print Options
1. Click File > Print or the Print 2. Do one of the following. To print The entire drawing All defined views Do this Under the Print range option, select Drawing. The entire drawing is printed. Arrange the views you want to print, and then on the Print dialog box, select View and All. Tip
•

button on the Main toolbar.

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.

The active view A selected area To a file

Select View and then Active. 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. 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. In the Number of Copies box, enter a number of copies. To sort the sheets by sheet number, select Collate. Under Options, select Fit to page. Under Options, select Print watermark. 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. If you want to print more than one drawing, use SmartPlant P&ID Drawing Manager, which has multiple drawing printing functionality.

Page Setup Dialog Box
Specifies information about the layout for the entire drawing. You can set the sheet size, orientation, and watermark. Click File > Page Setup to open this dialog box. Browse - Click this button to search for a watermark graphic.

Custom - Defines the sheet size according to the recorded width (W) and height (H) values. If you select Custom as the sheet size, you must type custom W and H values. The Custom option is not available for existing drawings, only for new templates. H (Height) - Displays the height of the custom sheet size. Landscape - Displays the page so that the long edge is the top of the page. Orientation - Click either the Portrait or Landscape option. The page orientation is displayed according to each option. Portrait - Displays the page so that the short edge is the top of the page. Sheet Size - Sets the size of the sheet. If you select Custom as the sheet size, you must type custom W and H values. Note
•

You can specify a new sheet size for an existing drawing; that is, you can change, for example, a B-size drawing to a C-size. Choose the template size from the list. The size choices are more limited for an existing drawing than for a new template.

Show Watermark - Specifies when a watermark appears by selecting either the While working option or the While printing option.

368 SmartPlant P&ID User’s Guide

Printing Drawings: An Overview Standard - Defines the sheet size from a list of standard ANSI and ISO paper sizes. W (Width) - Displays the width of the custom sheet size. Watermark - Allows you to choose a graphic that faintly appears in the background of the drawing. While printing - Displays the watermark only when you are printing the drawing. While working - Displays the watermark in the background while you are working within the drawing. The watermark also appears on any printed copies. Related Topics • Page Setup Command, page 368 • Set up a Page Layout, page 369

Set up a Page Layout
1. Click File > Page Setup. 2. On the Page Setup dialog box, select either Standard or Custom sheet size. If you select Standard, specify a standard sheet size. If you select Custom, specify the width, W, and height, H, of the sheet. Tip You can specify a new sheet size for an existing drawing; that is, you can change, for example, a B-size drawing to a C-size. Choose the template size from the list. The size choices are more limited for an existing drawing than for a new template, and the Custom option is not available for an existing drawing. 3. Select either Portrait or Landscape.
•

4. Specify a watermark if you want a watermark to be displayed. Specify when you want the watermark to be displayed by selecting either the While working option or the While printing option. Related Topics • Creating Drawing Templates: An Overview, page 118 • Printing Drawings: An Overview, page 360 • Working With the Design Window, page 20

SmartPlant P&ID User’s Guide 369

Working with The Engineering Framework: An Overview

Working with The Engineering Framework: An Overview
The Engineering Framework (TEF) standardizes and improves communication among the various authoring tools that you use in the course of designing, constructing, and operating a plant. The Engineering Framework acts as a repository for data and a medium through which information is shared among other tools, such as Zyqad, SmartPlant Instrumentation, and SmartPlant P&ID. Most of the commands that provide access to TEF functionality exist in TEF common user interface. You have access to the common user interface through commands in the authoring tools. In the authoring tools, you can use the commands on the Framework menu to interact with TEF, including publishing and retrieving data, registering your plant with a SmartPlant Foundation database, and so on. The following graphic displays what SmartPlant P&ID publishes and retrieves and additional information about what data is exchanged.

370 SmartPlant P&ID User’s Guide

Working with The Engineering Framework: An Overview

Integrating SmartPlant P&ID with The Engineering Framework
The following lists include rules that must be followed when using SmartPlant P&ID when working in The Engineering Framework (TEF) environment. Following these rules allows SmartPlant P&ID data to be shared correctly with SmartPlant 3D, SmartPlant Instrumentation, and the other tools that are part of The Engineering Framework. Other tools that are not listed here have no known SmartPlant P&ID/TEF integration issues.

Working with SmartPlant Instrumentation
Connect to Process Lines
•

Connect to Process lines are required for connecting instruments to equipment nozzles and pipe runs in SmartPlant P&ID. All non-piped offline equipment instruments must be connected to vessels through non-electric signal lines and nozzles in SmartPlant P&ID. This enables SmartPlant Instrumentation to recognize that instruments are connected to vessels. If SmartPlant P&ID assigns an object to an intermediate level in the hierarchy and publishes, SmartPlant Instrumentation will assign the object to the level in the hierarchy in SmartPlant Instrumentation determined by their logic. Because instruments belong to units in SmartPlant Instrumentation, an instrument assigned to the intermediate level in SmartPlant P&ID will be assigned to the unit in SmartPlant Instrumentation. Panels will be assigned to the plant. SmartPlant P&ID may get an update on retrieve to move the object to another level in their hierarchy than where it was published based on the move done automatically by SmartPlant Instrumentation. Instruments will move to the top level; panels will move to the bottom. When you are working in a Projects environment, and items are correlated using the tools in TEF, you should minimize deleting and re-adding any items. SmartPlant P&ID will reuse tag numbers in the numbering scheme when you delete and re-add items. SmartPlant Instrumentation tracks tag numbers claimed in a project, and this tracking will not work if tag numbers are reused after correlation. If you must delete an item in this situation, you can delete the item to the SmartPlant P&ID Stockpile.

•

•

Deleting and Adding Items
•

SmartPlant P&ID User’s Guide 371

Working with The Engineering Framework: An Overview 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 Engineering Framework. That Same As relationship is required by SmartPlant 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 Engineering Framework. Without the Same As relationship created in The Engineering Framework, the result may be additional ports in SmartPlant 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 Datasheet.

Working with SmartPlant 3D
Piping
•

Deleting pipe runs should be avoided in SmartPlant P&ID. You should either use the SmartPlant P&ID Undo command or try to reconnect the pipe run correctly. Deleting pipe runs in SmartPlant P&ID causes delete instructions to be passed to SmartPlant 3D which requires a SmartPlant 3D user to remodel the pipe runs.

Working with Zyqad
Retrieving Documents
•

Zyqad datasheets can contain multiple objects and may be formatted in a traditional datasheet view or list view (for example, as an equipment list). Datasheets retrieved from Zyqad may include stream data, specialty piping data, or relief valve data as required by business practices. When using Projects in the TEF environment and SmartPlant P&ID claims a pump but not the motor and then publishes, when Zyqad retrieves, they

Using Nozzles, Projects and Claiming in the TEF Environment
•

372 SmartPlant P&ID User’s Guide

Working with The Engineering Framework: An Overview will respond to the claim on the pump and then claim the motor. When Zyqad publishes, both the pump and motor are published. When P&ID retrieves they get the update on the pump and get a create task for the motor, even though they can clearly see the motor on the P&ID. Without it being claimed to the P&ID project it is not acknowledged as belonging to the project. The same holds true for the equipment and nozzle issue. SmartPlant P&ID permits an equipment object to be claimed to the project without requiring the nozzles to be claimed, even if the nozzles are seen on the P&ID. Zyqad's claim method does not support this. When Zyqad retrieves the equipment claim it claims the nozzles along with the equipment. When P&ID retrieves from Zyqad the nozzles are Create tasks since P&ID is not looking to retrieve Claim status from other tools. In these cases, either the P&ID user will have to delete the create tasks or agree to add the objects to the project scope. If they agree to add them to the project scope they should delete the create tasks first, then claim the objects and then re-retrieve the Zyqad document. This would generate update tasks. Optionally, since Zyqad requires all related nozzles to be claimed when claiming equipment, when claiming equipment in SmartPlant P&ID, all nozzles could be claimed. This causes the scopes of the claims between Zyqad and SmartPlant P&ID to match.

General TEF Requirements for SmartPlant P&ID
The following is a list of best practice scenarios for using SmartPlant P&ID so data will migrate correctly to the other TEF tools.
•

When working with Projects and As-built, all instruments in the Instrument Index must be placed on a P&ID drawing. This is because the Stockpile is not communicated back and forth between Projects and AsBuilt. 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.

•

SmartPlant P&ID User’s Guide 373

Working with The Engineering Framework: An Overview

Using Workshare with The Engineering Framework
The following rules apply to using the Workshare functionality within The Engineering Framework (TEF).
•

You can enable and disable Workshare before or after registering a Greenfield plant with TEF. You can create satellites and connect to them after registering with TEF. You cannot register a satellite with TEF. You cannot retrieve a WBS document when Workshare is enabled.

• • •

Using the SmartPlant P&ID TEF Commands Within a Workshare Collaboration
The Workshare host can perform the following actions from within SmartPlant P&ID when registered with TEF. For more information about these commands, see the SmartPlant P&ID User's Guide.
• • •

Publish - Any drawing can be published to TEF. Retrieve - Any TEF document can be retrieved. Correlate - Reviewing correlation is available if the drawing is in a readonly state. It is not possible to assign correlation in a read-only drawing. To Do List - Only available at the Workshare Host. To Do List tasks may be reviewed on drawings for which the host does not have ownership, but these tasks may not be exectued unless ownership is assigned to the Host. The To Do List is not available at the Satellite.

•

Using the Catalog Index in SmartPlant P&ID and TEF Integration
When you select the Retrieve command, the software accesses the CatalogIndex.mdb and the system performs the following options: 1. Using the retrieved document, the object type and classification of the retrieved item is determined. 2. Using the SmartPlant P&ID Map file, the ItemTypeName (Equipment, PipeRun, PipingComp, and so forth), and codelist indices for Class, Sub-Class, and Type is determined.

374 SmartPlant P&ID User’s Guide

Working with The Engineering Framework: An Overview

Catalog Index Lookup
The Catalog Index file is used to find a symbol in the catalog with type properties that match the given values. The lookup is performed using the most specific information first. If a match is found, that symbol is used. However, if there is no match, the more generic type information is 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, then use the CatalogItemName from the first one. If no match is found, then perform the search based on Subclass. Search Based on Subclass Value - Searches the catalog index for all rows with matching ItemTypeName and SubClass values and IsDefaultForSubclass = true. If one or more rows are found, then use the CatalogItemName from the first one. If no match is found, then perform the search based on Class. Search Based on Class Value - Searches the catalog index for all rows with matching ItemTypeName and Class values and IsDefaultForClass = True. If one or more rows are found, then use the CatalogItemName from the first one. If no match is found, then return an empty string. Related Topics Access the SmartPlant Foundation Web Client from SmartPlant P&ID, page 399 • Find Documents to Publish from SmartPlant P&ID, page 414
•

SmartPlant P&ID User’s Guide 375

Working with The Engineering Framework: An Overview

The SmartPlant P&ID Framework Adapter and Tool Schema
The tool schema implements a mapping between the objects in the SmartPlant P&ID data model and the objects in The Engineering Framework (TEF) schema. If you customize either the SmartPlant P&ID data model or the Framework schema, you may also need to customize the mapping contained in the tool schema. The following describes the structure of the tool schema and how it is used by the SmartPlant P&ID adapter in order to support the publish and retrieve functions.

Publish
When a P&ID drawing is published, the Adapter extracts data from the SmartPlant P&ID database and converts it into a set of objects and relationships that are compatible with the Framework schema. These objects and relationships are written out to an XML file and are sent to the Framework Server for further processing. The adapter depends on the data in the tool schema to support the publish operation. For each published class in the tool schema, there is a code module in the adapter known as a Class Publisher. The Class Publisher contains code for the following tasks:
•

Query the P&ID Database - The Class Publisher queries the database to obtain the collection of items to be published. Create a Data Object - For each item to be published, the Class Publisher creates a data object in the document container. The class of this object is the Framework schema class related to the MapClass via the MapClassToClass relationship. Set the Property Values - The property values on the data object are set according to the values on the SmartPlant P&ID item. The list of properties to be published is defined by the list of MapProperties related to the current MapClass. Publish Relationships - The Class Publisher defines the types of relationships that are to be published for each data object it publishes.

•

•

•

376 SmartPlant P&ID User’s Guide

Working with The Engineering Framework: An Overview

Retrieve
When a document from another authoring tool is retrieved, the adapter compares the objects in that document to the data in the SmartPlant P&ID database and generates tasks in the To Do List. A create task is generated when a new item needs to be created. An update task is generated when an existing item needs to be modified. A delete task is generated when an existing item needs to be deleted. The adapter depends on the data in the tool schema to support the retrieve operation. For each retrieved class in the tool schema, there is a code module in the adapter known as a Class Retriever. Each Class Retriever contains code for retrieving a class of objects. 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. 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.

SmartPlant P&ID User’s Guide 377

Working with The Engineering Framework: An Overview

SmartPlant P&ID Mapping Rules and Limitations
•

For properties that use enumerated lists to publish, you must add EFAdapter.EnumConversions to the process criteria when you define the map property definition in the tool schema. When you create a new enumerated list definition in the tool map file, you must replace the system-generated UID for the list with SP_<Codelist_Index>, for example, SP_12001. The codelist index is located in the Enumerations database table for the SmartPlant P&ID Data Dictionary user in the SmartPlant P&ID database. When you create enumerated list entries in the tool map file, you must replace the system-generated UID for each list entry with SP_<Codelist_Index>_<Codelist_Number>, for example, SP_12001_1. The codelist index for the enumerated list and the codelist number for the entry are located in the Enumerations and Codelists database table for the SmartPlant P&ID Data Dictionary user in the SmartPlant P&ID database. If you want SmartPlant P&ID to create line numbers at publish time so they match the displayed labels on the P&ID, you can modify the process criteria for the ItemTag map property definition in the publish map for the PipeRun tool class. To change the format for line numbers, modify the process criteria for the ItemTag, and add the properties that you want to include in the item tag inside angle brackets (<>) after EFAdapter.PpConnNameConv. For example, EFAdapter.PpConnNameConv, <OperFluidCode>-<TagSequenceNo><NominalDiameter>-<PipingMaterialsClass>-<InsulPurpose>. The property names inside the angle brackets must match property names in the map file.

Tool Schema Location
The SmartPlant P&ID tool schema is named SPPIDDataMap.xml. This file must exist in the folder specified by the Framework ResourcePath setting in Options Manager. When a new plant is created, you must define the value of this setting and ensure that the file exists in that folder. During publish and retrieve operations, the adapter looks for that file in that location. Related Topics • Drawing, page 393 • Hierarchical Enumerated Lists, page 391 • The SmartPlant P&ID Framework Adapter and Tool Schema, page 376 • The Tool Schema Data Model, page 380

SmartPlant P&ID User’s Guide 379

Working with The Engineering Framework: An Overview

The Tool Schema Data Model
The following graphic displays a representation of the objects and relationships that are relevant to the SmartPlant P&ID tool schema.

The rectangles on the left side of the graphic represent objects in the tool schema. The rectangles on the right represent objects in the Framework schema. The relationships that connect objects on the left with objects on the right are the mapping relationships. The map file contains both the tool schema objects and the mapping relationships.

MapClass
The MapClass object corresponds to the IMapClassDef interface in the diagram above. In general, there is a MapClass object in the tool schema for each SmartPlant P&ID class (ItemType) that needs to be published or retrieved. MapClass is referred to as SPMapClassDef in the Schema Editor. The properties and relationships for a MapClass can be viewed in the Edit Map Class Definition dialog box. General Property UID Name Process Criteria Value Must be unique. No other special requirements. The internal name of the SmartPlant P&ID class (ItemType). Required. 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. Note: The user should not change any of these values. The default values that come with the delivered Tool Schema should remain unchanged.

SmartPlant P&ID User’s Guide 381

Working with The Engineering Framework: An Overview Tool Schema Relationships Relationship Comment

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 EF class

This relationship must be set to a class in the Framework schema if 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.) The list of interfaces from which properties are to be retrieved must be 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 diagram above. In general, there is a MapProperty object in the tool schema for each SmartPlant P&ID property that needs to be published or retrieved. The properties and relationships for a MapProperty can be viewed in the Edit Map Property Definition dialog box in the Schema Editor. General Property UID Name Selection Criteria Process Criteria Value Must be unique. No other special requirements. The internal name of the SmartPlant P&ID attribute. Required. This field is used to specify the handling of process data properties on PipeRuns. 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.

Tool Schema Relationships Relationship Exposed by map classes Scoped by enumeration Comment Every MapProperty must be related to a MapClass. (MapClassMapProperties in the diagram.) If the data type of the property is enumerated, the MapProperty must be related to a MapEnumList. If the data type of the property is UoM, the MapProperty must be related to a MapUoMList. Otherwise, this relationship is not needed. (MapPropertyMapEnumList in the diagram.)

Mapping Relationships Relationship Map property to property Comment This relationship defines the property in the Framework schema to which this tool property is to be published. If this relationship is not defined, the property will not be published. (MapPropertyToProperty in the diagram.) This relationship defines the property in the Framework schema from which this tool property is to be retrieved. If this relationship is not defined, the property will not be retrieved. (PropertyToMapProperty in the diagram.)

Property to map property

SmartPlant P&ID User’s Guide 383

Working with The Engineering Framework: An Overview

MapEnumList
The MapEnumList object corresponds to the IMapEnumListDef interface in the diagram above. In general, there is a MapEnumList object in the tool schema for each SmartPlant P&ID enumerated list associated with a property that needs to be published or retrieved. The properties and relationships for a MapEnumList can be viewed in the Edit Map Enumerated List Definition dialog box. General Property Value UID The UID must be constructed using the following pattern: UID = SP_<CodelistNumber> <CodelistNumber> The numeric identifier for this enumerated list. The name of the SmartPlant P&ID enumerated list.

Name

Tool Schema Relationships Relationship Scoped map properties Contains Constrains Comment A MapEnumList must be related to the MapProperties that it scopes. (MapPropertyMapEnumList in the diagram.) A MapEnumList can contain a variable number of MapEnum objects. (MapEnumListMapEnum in the diagram.) For hierarchical enumerated lists, the MapEnumList must be related to the lower level list with the Constrains relationship. (MapEnumListMapEnumList in the diagram.) For hierarchical enumerated lists, the MapEnumList must be related to the higher level list with the Constrained by relationship. (MapEnumListMapEnumList in the diagram.)

Constrained by

Mapping Relationships Relationship Comment Maps to To support the publish operation, a MapEnumList that should be related to the corresponding enumerated list in the Framework schema by means of the Maps to relationship. (MapEnumListToEnumList in the diagram.) To support the retrieve operation, a MapEnumList should be related to the corresponding enumerated list in the Framework schema by means of the Mapped from relationship. (EnumListToMapEnumList in the diagram.)

Mapped from

384 SmartPlant P&ID User’s Guide

Working with The Engineering Framework: An Overview

MapEnum
The MapEnum object corresponds to the IMapEnumDef interface in the diagram above. In general, there is a MapEnum object in the tool schema for each SmartPlant P&ID enumerated list entry that needs to be mapped. The properties and relationships for a MapEnum can be viewed in the Edit Map Enumerated List Definition dialog box. General Property Value UID The UID must be constructed using the following pattern: UID = SP_<CodelistNumber>_<CodelistIndex> <CodelistNumber> The numeric identifier for this enumerated list. <CodelistIndex> The numeric identifier for this entry. The text of the SmartPlant P&ID enumerated list entry.

Name

Tool Schema Relationships Relationship Comment Contained In Every MapEnum must be related to a MapEnumList. (MapEnumListMapEnum in the diagram.)

Mapping Relationships Relationship Comment Maps to This relationship defines the Framework schema enumerated value to which this P&ID enumerated value is to be published. If this relationship is not defined, the enumerated value will not be published. (MapEnumToEnum in the diagram.) This relationship defines the SmartPlant P&ID enumerated value to which this Framework schema enumerated value is to be retrieved. If this relationship is not defined, the enumerated value will not be retrieved. (EnumToMapEnum in the diagram.)

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 UID The UID must be constructed using the following pattern: UID = SPMU_<FormatType > <FormatType> This is a numeric value that uniquely identifies the format type and therefore the UoM type within SmartPlant P&ID. The name of the P&ID format type.

Name

Tool Schema Relationships Relationship Scoped map properties Contains Comment A MapUoMList must be related to the MapProperties that it scopes. (MapPropertyMapEnumList in the diagram.) A MapUoMList can contain a variable number of MapUoM objects. (MapEnumListMapEnum in the diagram.)

386 SmartPlant P&ID User’s Guide

Working with The Engineering Framework: An Overview Mapping Relationships Relationship Comment Maps to To support the publish operation, a MapUoMList should be related to the corresponding UoMListType in the Framework schema by means of the Maps to relationship. (MapEnumListToEnumList in the diagram.) To support retrieve, a MapEnumList should be related to the corresponding UoMListType in the Framework schema by means of the Mapped from relationship. (EnumListToMapEnumList in the graphic.)

MapUoM
The MapUoM object corresponds to the IMapUoMDef interface in the diagram above. In general, there is a MapUoM object in the tool schema for each SmartPlant P&ID format that needs to be mapped. The properties and relationships for a MapUoM can be viewed in the Edit Map Unit of Measure List Definition dialog box in the Schema Editor. General Property Value UID The UID must be constructed using the following pattern: UID = SPMU_<FormatType >_<FormatName> <FormatType> This is a numeric value that uniquely identifies the format type and therefore the UoM type within SmartPlant P&ID. <FormatName> This is a text value that identifies the name of the format and therefore the UoM within SmartPlant P&ID. The name of the SmartPlant P&ID format.

Name

Tool Schema Relationships Relationship Comment Contained In Every MapUoM must be related to a MapUoMList. (MapEnumListMapEnum in the diagram.)

SmartPlant P&ID User’s Guide 387

Working with The Engineering Framework: An Overview Mapping Relationships Relationship Comment Maps to This relationship defines the Framework schema UoM to which this SmartPlant P&ID format (UoM) is to be published. If this relationship is not defined, the UoM will not be published. (MapEnumToEnum in the diagram.) This relationship defines the SmartPlant P&ID format (UoM) to which this Framework schema UoM is to be retrieved. If this relationship is not defined, the UoM will not be retrieved. (EnumToMapEnum in the diagram.)

Property Conversions
If the data type of the SmartPlant P&ID property does not match the data type of the mapped TEF property, a data type mismatch exists. In some cases, a property with a data type mismatch can still be published and retrieved using specialized code. The code to perform these data type conversions and other special handling is implemented in special Property Conversion objects. The SmartPlant adapter is told about the need to use a Property Conversion object by putting the ProgID of the Property Conversion class in the Process Criteria option of the MapProperty. The list of available Property Conversion classes is shown in the table below. Note
•

The ProgID for each of these classes is formed by prefixing the class name with the string EFAdapter. Description This property conversion supports the conversion needed to publish and retrieve the SmartPlant P&ID SP_IsSpecialtyItem property to/from the CommoditySpecialtyType property in TEF. This class only publishes the special property called IsFlowDirectional. There is no property named IsFlowDirectional in SmartPlant P&ID. This information is derived from the Flow Direction property value. If the Flow Direction on a component is set, then this will publish IsFlowDirection as True; otherwise, it is published as False. This class implements the property conversion code for Hierarchical Enumerated Lists. This class implements the property conversion code between Enumerated to Boolean. This property conversion module specifically targeted to handle StressAnalysisRequirement property in SmartPlant P&ID. This class implements the property conversion code between Enumerated List to String. Converts Nominal Diameter from an Enumerated List to a UoM during publish and from a UoM to Enumerated List during retrieve.

Class Name BoolToEnumConv

CompFlowDirConv

EnumConversions EnumToBoolConv

EnumToStringConv NominalDiameterConv

PortFlowDirectionConv Special property conversion to handle the publishing of FlowDirection property on Connect Point. The Select List values for FlowDirection for SmartPlant P&ID Piping Point and TEF PIDPipingPort do not match well. SmartPlant P&ID uses only one Select List for SmartPlant P&ID User’s Guide 389

Working with The Engineering Framework: An Overview Class Name Description FlowDirection for both InlineComponent and PipingPoint whereas TEF uses two separate Select Lists. This class implements the property conversion code for Piping Connector Name property. This class implements the property conversion code for TagPrefix rpoperty. It populates the Unit number value. This class implements the property conversion code between UoM and Double. This property conversion module is specifically targeted to handle conversion of unitless attributes (such as Molecular Weight, CpCvRatio, Compressibility, SpecificGravity). In SmartPlant P&ID these attributes are treated like UoM attributes. However, in the Framework schema they are simply Double. This class implements the property conversion code between UoM to Enumerated List.

Hierarchical Enumerated Lists
A hierarchical enumerated list is a complex data type in which there is a collection of related enumerated lists and a value in a higher level list constrains the valid values in a lower level list. When a hierarchical enumerated list is used, a separate property is created for each level in the hierarchy. Examples of hierarchical enumerated lists in SmartPlant P&ID are Equipment Class, Equipment Subclass, Equipment Type, and Fluid System, Fluid Code. Examples in the Framework schema include: EqType0, ... , EqType6, and ConstructionStatus, ConstructionStatus2. When mapping between SmartPlant P&ID and the Framework schema, four cases must be considered. 1. Simple enumerated list to simple enumerated list. 2. Simple enumerated list to hierarchical enumerated list. 3. Hierarchical enumerated list to simple enumerated list. 4. Hierarchical enumerated list to hierarchical enumerated list. When mapping between two hierarchical enumerated lists, the number of levels in each hierarchy may not be the same. EnumConversions - A special Property Conversion class is available to support publishing and retrieving of enumerated properties. This class is called EnumConversions, and it is used for all cases of mapping enumerated list properties. Mapping Properties - Only the top level properties associated with a hierarchical enumerated list are mapped. The lower level properties are left unmapped. The EnumConversions object obtains all of the values from the set of related properties even though they are not explicitly mapped. Tool Schema Relationships - The MapEnumList objects that form an enumerated hierarchy must be related to each other with the Constrains and Constrained By relationships. The EnumConversions object relies on these relationships to get the job done. 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. Related Topics • Access the SmartPlant Foundation Web Client from SmartPlant P&ID, page 399 • Find Documents to Publish from SmartPlant P&ID, page 414

SmartPlant P&ID User’s Guide 391

Working with The Engineering Framework: An Overview

Catalog Index
During retrieval of a document, when a create task is generated, the adapter must select a symbol to be used by the task. The adapter uses the Catalog Index to quickly find a suitable symbol to be used. The Catalog Index lookup is based on the type properties. For example, when generating a create task for Equipment, the Equipment Class/Subclass/Type properties are used to perform the lookup. Before the Catalog Index lookup can take place, the incoming TEF type values must be converted into SmartPlant P&ID type values. This conversion of an Framework schema enum value into a SmartPlant P&ID enumerated value is performed by the EnumConversions object just like any other enumerated property value. It depends on the mapping of enumerated values found in the tool schema. Related Topics • Drawing, page 393 • Hierarchical Enumerated Lists, page 391 • The SmartPlant P&ID Framework Adapter and Tool Schema, page 376 • The Tool Schema Data Model, page 380 • Tool Schema Location, page 379

392 SmartPlant P&ID User’s Guide

Working with The Engineering Framework: An Overview

Drawing
There is a MapClass in the tool schema for Drawing. The MapProperties for this MapClass define the properties that will be published from the SmartPlant P&ID Drawing item to the Framework schema PIDDrawing object. If new properties are added to the Drawing item type in the Data Dictionary Manager, and corresponding new properties are added in the Framework schema, then they can be mapped by adding new MapProperties to this MapClass in the tool schema using the Schema Editor. Related Topics • Drawing, page 393 • Hierarchical Enumerated Lists, page 391 • The SmartPlant P&ID Framework Adapter and Tool Schema, page 376 • The Tool Schema Data Model, page 380 • Tool Schema Location, page 379

SmartPlant P&ID User’s Guide 393

Working with The Engineering Framework: An Overview

Equipment
In SmartPlant P&ID there is an abstract class for Equipment with four subclasses for Vessel, Exchanger, Mechanical and OtherEquipment. In the Framework schema, there are four PID equipment classes. 1. PIDProcessVessel 2. PIDHeatTransferEquipment 3. PIDMechanicalEquipment 4. PIDProcessEquipment The tool schema has a MapClass for each of the four equipment subclasses in SmartPlant P&ID and another MapClass for the abstract Equipment class. Publish - The four MapClasses map the corresponding equipment classes in SmartPlant P&ID and the Framework schema. A SmartPlant P&ID vessel is published as a PIDProcessVessel in TEF; 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). Related Topics • Drawing, page 393 • Hierarchical Enumerated Lists, page 391 • The SmartPlant P&ID Framework Adapter and Tool Schema, page 376 • The Tool Schema Data Model, page 380 • Tool Schema Location, page 379

394 SmartPlant P&ID User’s Guide

Working with The Engineering Framework: An Overview

Instrument
In SmartPlant P&ID there is one Instrument class. In the Framework 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. Related Topics • Drawing, page 393 • Hierarchical Enumerated Lists, page 391 • The SmartPlant P&ID Framework Adapter and Tool Schema, page 376 • The Tool Schema Data Model, page 380 • Tool Schema Location, page 379

SmartPlant P&ID User’s Guide 395

Working with The Engineering Framework: An Overview

PipeRun
In SmartPlant P&ID there is a single class for PipeRun. This class has properties describing aspects of the physical pipe and other properties that describe the fluid flowing through that pipe. In the Framework schema there are two relevant classes: PIDPipingConnector for the pipe itself and PIDProcessPoint for the process data. Furthermore, the Framework schema has several classes that are used to publish a stream and its associated process data on a PFD. The SmartPlant P&ID tool schema has one MapClass for PipeRun. 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 EF 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 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, you draw graphical piperuns to indicate the schematic piping design. You can assign naming properties to these piperuns. All of the piperuns with matching values for the naming properties form a logical group. Such a group is sometimes called a pipeline and the values of the naming properties represent the name of the pipeline. All of this is done without requiring you to explicitly create a pipeline object. In the Framework schema there is an explicit PIDPipeLine class. Objects of this class must be published with relationships to the associated PIDPipingConnectors. Some downstream applications depend on the existence of the PIDPipeLine for their processing. The SmartPlant P&ID adapter creates and deletes pipelines dynamically during the publish operation. The pipelines and the relationships to the piperuns are published as if they really existed in the SmartPlant P&ID database. The tool schema contains a MapClass for PipeLine. The MapProperties for the pipeline MapClass define the properties that are published to the PIDPipeline object. Related Topics Drawing, page 393 • Hierarchical Enumerated Lists, page 391 • The SmartPlant P&ID Framework Adapter and Tool Schema, page 376 • The Tool Schema Data Model, page 380 • Tool Schema Location, page 379
•

SmartPlant P&ID User’s Guide 397

Accessing the SmartPlant Foundation Web Client: An Overview

Accessing the SmartPlant Foundation Web Client: An Overview
The SmartPlant Foundation Web Client provides a web-based user interface that allows you to interact with SmartPlant Foundation. From this interface you can perform a number of tasks, such as browse data and documents that have been published to TEF, use the SmartPlant Foundation To Do List to complete workflow tasks, compare document revisions and TEF documents with tool data, and subscribe to documents to receive notification of document changes. Related Topics • Browser Command, page 399

This command is available only if the active plant has been registered with The Engineering Framework (TEF). For more information, see the SmartPlant Engineering Manager Help.

Note
•

From the SmartPlant Foundation Web Client, you can perform a number of tasks, such as publishing or retrieving documents, comparing documents, subscribing to document changes, and so forth. Many of these tasks can be performed from the authoring tools, such as SmartPlant P&ID or SmartPlant Electrical, but the Web Client provides unique access to other features such as the Web Client To Do List and search capabilities.

Related Topics • Working with The Engineering Framework: An Overview, page 370

SmartPlant P&ID User’s Guide 399

Publishing to The Engineering Framework: An Overview

Publishing to The Engineering Framework: An Overview
In The Engineering Framework (TEF), 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 to TEF in XML format. The software then places the .XML file in the appropriate SmartPlant Foundation vault and loads the data from the .XML files to the SmartPlant Foundation database. After the document is published, users can retrieve the data from the .XML file in the SmartPlant Foundation vault into other authoring tools. When you publish documents, the software does the following things:
•

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 into TEF, 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 to TEF. 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.

•

•

400 SmartPlant P&ID User’s Guide

Publishing to The Engineering Framework: An Overview
•

Places the published .XML file and any view files in the appropriate SmartPlant Foundation vault. This .XML file can be retrieved when users in the authoring tools retrieve as-published data. Sends notification to the publishing tool.

•

For more information about revisions and versions, see the SmartPlant Foundation Web Client User's Guide or the SmartPlant Foundation Desktop Client User's Guide. Reasons to Publish You can publish documents and associated data into TEF for several reasons:
•

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 Framework Loader Manager loads the document into SmartPlant Foundation as soon as it reaches the top of the Loader queue. Publishing Documents Each authoring tool publishes different documents and data. The PBS document contains information about the physical plant with a structure consisting of plants, areas, and units. The default structure is plant/area/unit, but you can define a custom hierarchy in the Schema Editor. When a PBS document is published from SmartPlant Foundation, the authoring tools are notified about the plant, areas, and units that need to be created in each authoring tool. The project breakdown structure, project definition document, and project list contain information about projects and their statuses. When these documents are published from SmartPlant Foundation, the authoring tools are notified of projects and contracts that need to be created in the authoring tools. The project breakdown structure contains a single project and the hierarchy of contracts under that project in a plant/project structure. The project definition document contains information for a single project that needs to be created in the

SmartPlant P&ID User’s Guide 401

Publishing to The Engineering Framework: An Overview authoring tool. The project list contains a list of all projects in a plant, and it is used by those authoring tools that create all projects at one time. Note
•

The plant breakdown structure and project breakdown structure used in the authoring tools must match the structure in SmartPlant Foundation for publishing from the authoring tools and object correlation to work correctly. Note

•

When you publish data from an authoring tool, you may not be able view all the properties that you published in the SmartPlant Foundation client. You can customize view definitions to allow you to see additional properties. For more information about defining view definitions in the Framework schema, see Working with View Definitions: An Overview and Create a View Definition in the Schema Editor User's Guide. For further assistance with visualizing data in SmartPlant Foundation, contact Intergraph Support Services.

Publish Dialog Box
Provides a list of documents selected to publish to The Engineering Framework (TEF). Information on this dialog box is divided onto the following two tabs: Publish tab Issue tab The following fields and buttons are available regardless of which tab is displayed. Selected documents - Displays a list of the documents selected for publishing. You must populate this list by selecting documents before you use the Publish command or by clicking the buttons in the Add section of this dialog box. For each document, this list displays the name, the type of document, the workflow from which the document was last published, the revision and version numbers, the revision scheme, and the date when the document was last published. Engineering Tool - Opens an authoring tool-specific dialog box that allows you to select documents to add to the Selected documents list. File System - Opens a standard Microsoft dialog box that allows you to select documents to add to the Selected documents list. When you select a file with this Select File dialog box, the Document Properties dialog box opens, allowing you to specify information about the file, such as whether it is a new file or was previously published; the category, type, and subtype of the document; and the name, description, and title of the document. Find - Opens the Find Documents to Publish dialog box, which allows you to search for documents to add to the Selected documents list. Related Topics Document Properties Dialog Box, page 408 • Publish Command, page 403 • Publish Documents, page 409 • Publishing to The Engineering Framework: An Overview, page 400
•

404 SmartPlant P&ID User’s Guide

Publishing to The Engineering Framework: An Overview

Publish Tab (Publish Dialog Box)
This tab displays properties of the selected document or documents. If only one document is selected in the tree view, the properties displayed on this tab are the properties of that one document. If multiple documents are selected, only the properties with the same value for all documents appears. Any properties with varying values across the documents appear as blank values in these fields. You can change some of the values assigned to one or more documents by changing the value displayed in the table. The value you enter here will override any existing values for all selected documents. Last Published - Indicates the date on which the document or documents were last published. Name - Displays the name of the document. Source - Indicates the authoring tool in which the document was created. Type - Displays the type of document or documents selected. Issue Only - Allows you to issue request documents without, necessarily, republishing them. Use this option when no changes were made to a drawing, but you want to add it to a transmittal. Tips
•

Even with this option set, documents may still be published. Any documents that have never been published must be published, regardless of this setting. You will receive an error message if you select multiple document and activate this option when one or more of the selected documents cannot be changed. For example, if a selected set of documents includes both a new document (for which this field can be set only to No) and current or frozen documents (for which this field can be set only to Yes). The error message prompts you to select a smaller set of documents.

•

Revision - Displays the current revision number of the selected document or documents. Tip
•

You will receive an error message if you attempt to change the value in this field when you have selected one or more documents that have conflicting revision schemes or different possible revisions. The error message prompts you to select a smaller set of documents.

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 - Indicate what to which workflow the selected document or documents were assigned. Tip
•

You will receive an error message indicating that this field cannot be edited if one or more of the documents you have selected have conflicting sets of possible workflows. The error message prompts you to select a smaller set of documents.

Operation - Select the operation you want to perform on the selected documents. Choose from the following options:
• •

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 the batch mode by the authoring tool. This option is available only for tools that support it and it processed by the authoring tool, not TEF 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.

Issue Tab (Publish Dialog Box)
This tab allows you to view the documents associated with a specific issue request and add to remove documents to a request. Issue to - Contains a list of all objects that can support issue requests. When you select an item from this list, the names and reasons for issue of any documents associated with that object appear in the table below. Add - Creates a new item in the table for any documents highlighted in the Selected documents tree view. Remove - Deletes a selected document from the table. Document Name - Displays the names of all documents associated with the object in the Issue to field. Related Topics • Document Properties Dialog Box, page 408 • Publish Command, page 403 • Publish Documents, page 409 • Publishing to The Engineering Framework: An Overview, page 400

SmartPlant P&ID User’s Guide 407

Publishing to The Engineering Framework: An Overview

Document Properties Dialog Box
Provides details about a new or existing document selected for publishing using the file system command on the Publish dialog box. Tips
•

An asterisk (*) next to a field indicates that the field must be completed before the OK button is available.

Selected file - Displays the name of the file you selected on the Select File dialog box. New document - Indicates that this document has not previously been published to The Engineering Framework. Published previously - Indicates that the file has already been published to TEF at least once before. Document category - Select a category to which to assign the document. Document type - Select the type of the document. The options that appear in this list are determined by the selection you make in the Document category field. Document subtype - If applicable, select the subtype for the document. The options that appear in this list are determined by the selection you make in the Document type field. Name - Enter the name of the file as it will be known in TEF. Descriptions - Enter a brief description of the file. This description appears later to help you recognize the file. Title - Enter the official title of the document. Related Topics • Publish Dialog Box, page 404

This feature is also available through the SmartPlant Foundation Web Client. This command is available only if the active authoring tool plant database has been registered with The Engineering Framework (TEF).

•

The documents that appear in the Selected documents list on the Publish dialog box when it first appears are documents that were selected within the authoring tool before you clicked the Publish command. 2. Add any additional documents to the Selected documents list by using the Engineering Tool, File System, or Find buttons.
•

•

To add documents from the engineering tools, such as P&IDs or PFDs, click Engineering Tools. To add documents from the file system, such as Microsoft Word documents or Microsoft Excel spreadsheets, click File System.

•

•

To search for documents to publish, click Find. For more information about these commands, see the Publish dialog box.

3. If necessary, edit any of the information for the selected documents as displayed in the properties grid.

SmartPlant P&ID User’s Guide 409

Publishing to The Engineering Framework: An Overview Tip When multiple documents are selected, only property values shared by all the selected documents appear in the grid. Changing a value in the grid changes that value for all the selected documents. 4. Choose the method of publish you want to use from the Operation field.
• •

Select the Scheduled publish option to indicate that the publish process should be run in batch mode, if the authoring tool supports scheduled batch publishing. Choose the Background publish option when you want to publish the selected documents as a background operation. When you use this feature, an e-mail message alerts you when the process is complete.

•

Otherwise, select Publish now to immediate start the publishing process as soon as you click OK. 5. Click OK.
•

This feature is also available through the SmartPlant Foundation Web Client. This command is available only if the active plant has been registered with The Engineering Framework (TEF). For more information, see the SmartPlant Engineering Manager Help. The documents listed on the Publish dialog box when it first opens are documents that you selected in the authoring tool before you clicked the Publish command.

•

•

410 SmartPlant P&ID User’s Guide

Publishing to The Engineering Framework: An Overview 2. Click on the Issue tab.

3. Select the contract to which you want to assign the document or documents from the Issue to field. 4. In the tree view, select the documents you want to associate with the specified contract, and click Add to add that document to the list under the contract.
• •

To search for documents to publish, click Find. 5. Click OK to publish the issue relation to SmartPlant Foundation.
•

Related Topics • Publishing to The Engineering Framework: An Overview, page 400 • Working with The Engineering Framework: An Overview, page 370

SmartPlant P&ID User’s Guide 411

Publishing to The Engineering Framework: An Overview

Find Documents to Publish Command
The Framework > Find Documents to Publish command provides a list of documents that either have not been published to The Engineering Framework (TEF) or have been modified and need to be published to TEF again or have been deleted since the last publish. This list is specific to the authoring tool from which you used the command. Related Topics • Find Documents to Publish Dialog Box, page 413 • Publishing to The Engineering Framework: An Overview, page 400

412 SmartPlant P&ID User’s Guide

Publishing to The Engineering Framework: An Overview

Find Documents to Publish Dialog Box
Allows you to search for documents that have been updated since they were last published to The Engineering Framework (TEF). Additionally, you can use this dialog box to terminate documents that were previously published but no longer exist in the authoring tool. Last search performed - Displays the date when the files were last searched. The information appearing in the lists on this dialog box was found on this specified date and time. Update - Performs a new search to find documents to publish. Document types searched - Indicates what types of files were considered when the last search was conducted. Select documents to publish - Displays a list of files that were either updated since they were last published to TEF or files that have not yet been published. For each file, this list displays the file name and type, and the date on which the document was last published. If the file has not been published to TEF, the Last Published field for the document is New. Select documents to terminate - Displays a list of all the files that were previously published to TEF, but have since been removed from the project. For each file, this list box displays the file name and type, and the date on which the document was last published. Select All - Selects all the files in the associated list of documents. Clear All - Clears any selected documents in the associated list. Related Topics • Find Documents to Publish Command, page 412 • Publishing to The Engineering Framework: An Overview, page 400

SmartPlant P&ID User’s Guide 413

Publishing to The Engineering Framework: An Overview

Find Documents to Publish Dialog Box - Document Types
Allows you specify the types of documents to find for publication. Document types - Indicates the types of documents the system should consider when deciding which documents should be published. Related Topics • Find Documents to Publish Command, page 412 • Publishing to The Engineering Framework: An Overview, page 400

This feature is also available by clicking the Find button on the Publish dialog box. This command is available only if the active plant has been registered with The Engineering Framework (TEF). For more information, see the SmartPlant Engineering Manager Help.

•

TEF communicates with the authoring tool to determine the documents that need to be published or re-published to TEF. When the results of this search are available, the documents appear in lists in the Find Documents to Publish dialog box. 2. From the Select documents to publish list on the Find Documents to Publish dialog box, indicate the documents that you want to publish to TEF by clicking the corresponding check box.
•

Tip
•

You can quickly select the entire list by clicking Select All, or you can clear the entire list by clicking Clear All.

414 SmartPlant P&ID User’s Guide

Publishing to The Engineering Framework: An Overview 3. From the Select documents to terminate list, indicate the documents that you want to remove from TEF. Tips
•

Documents in this list are in TEF but are no longer present in the authoring tool. This step is necessary only if a document was deleted from the authoring tool, but is still available in TEF.

•

The selected documents now appear in the Documents to Publish list on the Publish dialog box, and you can publish them to TEF. For more information about publishing documents, see Publish a Document to The Engineering Framework.
•

Note
•

The lists displayed on the Find Documents to Publish dialog box are compiled at the time indicated in the Last search performed box. You can update the lists by clicking Update, but this process can be time consuming, depending on the mode you are running the applications in: synchronous or asynchronous.

Related Topics Publishing to The Engineering Framework: An Overview, page 400 • Working with The Engineering Framework: An Overview, page 370
•

SmartPlant P&ID User’s Guide 415

Retrieving from The Engineering Framework: An Overview

Retrieving from The Engineering Framework: An Overview
When you retrieve documents from The Engineering Framework (TEF) into an authoring tool, you are retrieving the document data that was published to TEF 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 Framework > Retrieve command to open a dialog box that assists you in retrieving applicable documents. Additionally, you can access the Web Client through the Framework > Browser command. This allows you to select the document or documents that you want to retrieve from your Web Client To Do List, the tree view, or by using the Web Client search functionality. After you select the documents that you want to retrieve, you can use the Retrieve command on the Web Client Framework menu to start the retrieval process. The Retrieve command provided in the authoring tools is slightly different from the Retrieve command available in the SmartPlant Foundation Web Client. The Web Client presents a list of documents from which you can select those you want to retrieve. However, when you use the command from an authoring tool without first selecting documents, the software searches the SmartPlant Foundation project for documents to retrieve, and these are presented in a list on the Retrieve dialog box. 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.

•

416 SmartPlant P&ID User’s Guide

Retrieving from The Engineering Framework: An Overview Document Types for Retrieval The types of documents that you can retrieve depend on the authoring tool you are using. From the authoring tools, you can retrieve the plant breakdown structure (PBS) and project documents. The PBS and project documents, created in SmartPlant Foundation and published to TEF, are retrieved by authoring tools to provide information about the plants, areas, units, projects, and contracts that need to be created in the authoring tool so that the information is consistent across all authoring tools. The project breakdown structure, project list, and project definition document contain information about the project or projects and their statuses in a plant/project structure. Data Handling After Retrieval The authoring tool that you use also determines how the system deals with changes in downstream data when you retrieve a document. SmartPlant P&ID, SmartPlant Instrumentation, SmartPlant Electrical, and Zyqad analyze the impact of the newly retrieved data on the existing database, then place tasks on the authoring tool's To Do list that allow you to create, delete, or modify items at the appropriate time in the design process. The To Do list gives you the opportunity to view and understand potential changes before accepting, deleting, or modifying those changes. In SmartPlant 3D you can view the P&ID using the View > P&ID command to pull in the data and correlate items. Design Basis Objects that tools retrieve from other authoring tool documents can become the design basis for objects in downstream documents. Objects that become the design basis for other objects can be specific objects that get richer as they move through the lifecycle or can be schematic or logical objects in one application that evolve into more detailed objects downstream. Design basis is implicit based on retrieval; you do not have to define it. For example, a pump retrieved from a PFD becomes the design basis for a pump in the P&ID. When you change common properties for the pump and retrieve the changes into SmartPlant P&ID, tasks to update property values automatically appear in the To Do List. The same process works for logical items that are a design basis for other items, such as a stream in Zyqad that results in multiple pipe runs in SmartPlant P&ID. Related Topics Retrieve Command, page 418 • Retrieve Dialog Box, page 419
•

SmartPlant P&ID User’s Guide 417

Retrieving from The Engineering Framework: An Overview

Retrieve Command
The Framework > Retrieve command provides a list of the documents that need to be retrieved into the authoring tool. This list is displayed in the Retrieve dialog box, from which you can select the documents you want to retrieve, bringing the information from The Engineering Framework (TEF) into the authoring tool. Related Topics • Retrieve Dialog Box, page 419 • Retrieving from The Engineering Framework: An Overview, page 416

418 SmartPlant P&ID User’s Guide

Retrieving from The Engineering Framework: An Overview

Retrieve Dialog Box
Allows you to retrieve information from The Engineering Framework (TEF). Document type - Indicates the type of documents you can retrieve from TEF and changes the list view to show only that document type. Show - Indicates what documents you want to see in the list. Choose from the following options:
•

Documents to be retrieved only - Selecting this option provides a list of only those documents that need to be retrieved. In other words, the list will display the documents that have newer versions published since they were last retrieved. New documents only - Choosing this option provides a list of only the new documents that have not yet been retrieved. All documents - Selecting this option provides a list of all the documents available for retrieval, including both new and previously retrieved documents.

•

•

Documents to retrieve - Displays a list of the documents that will be retrieved from TEF. For each document, this list provides the name, type, revision and version numbers, status, date of the last retrieval, and revision option. Using the retrieve option, indicate whether you want to retrieve the document as it was published or with the latest data. Select All - Selects all the files in the associated list of documents. Clear All - Clears any selected documents in the associated 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. Related Topics Retrieve Command, page 418 • Retrieving from The Engineering Framework: An Overview, page 416
•

This command is available only if the active plant has been registered with The Engineering Framework (TEF). For more information, see the SmartPlant Engineering Manager Help.

TEF searches the SmartPlant Foundation project for documents that are ready to be retrieved into your tool. These documents can appear in the Documents to retrieve list. 2. On the Retrieve dialog box, select the types of files that are displayed in the Documents to retrieve list by choosing either Documents to be retrieved only or All documents in the SmartPlant Foundation project or by using the Document type list.
•

3. From the Documents to retrieve list, select the documents you want to retrieve by clicking the corresponding check box. Tip
•

You can quickly select the entire list by clicking Select All, or you can clear the entire list by clicking Clear All.

420 SmartPlant P&ID User’s Guide

Retrieving from The Engineering Framework: An Overview 4. By using the Retrieve Option list for each document you are retrieving, select whether you want to retrieve each document by using the As published option or the With the latest data option. Notes
•

You can select the Batch retrieve option to indicate that the retrieval process is run in batch mode — that is, in the background. When you use this feature, an e-mail message alerts you when the process is complete. Otherwise, the retrieval process begins interactively as soon as you click OK.

Related Topics • Retrieving from The Engineering Framework: An Overview, page 416 • Working with The Engineering Framework: An Overview, page 370

SmartPlant P&ID User’s Guide 421

Retrieving from The Engineering Framework: An Overview

Correlating Items: An Overview
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 Zyqad usually maps to a single equipment item in SmartPlant P&ID. 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 Zyqad normally maps to multiple pipe runs in SmartPlant P&ID. The Correlate Items command allows you to review and manage these relationships within the drawing environment. When you import a document into SmartPlant P&ID from The Engineering Framework (TEF), each item that is created in a stockpile is automatically correlated to the design basis item from which it came. Related Topics • Correlate Additional Items with a Design Basis Item, page 424 • Remove the Correlation Between Added and Design Basis Items, page 424

Correlate Items Dialog Box
Allows you to review and edit the relationship between plant items and design basis items imported from external applications. This dialog box opens when you click Framework > Correlate on the main menu bar. Items - Lists all the items associated with a single design basis item. Items in the active drawing are displayed in bold font style. A single item can be selected from the list, and when selected, the item is highlighted in the drawing. Select - Allows you to review a different drawing item. Clicking this button clears the Items list. As you move your pointer over an item in the drawing that is already correlated, the item is highlighted. When you click on a correlated item, it is added to the Items list as a primary item. Then the application searches the database for all other items that are correlated to the same design basis item and adds them to the list as well. Right-clicking quits this command. Add - Allows you to correlate an additional item to the same design basis item that the listed items are already correlated to. This command is available only when one or more items already appear in the Items list. As you move your pointer over an item in the drawing that has the same item type as the items in the list, the drawing item is highlighted. When you click on a highlighted item, it is correlated with the same design basis item, and it is added to the list. If you click on an item that is already correlated to some other design basis item, a confirmation message appears. If you correlate a new item with a previously correlated item, both are associated with the same design basis item; however, the new item inherits the properties of the item that it is correlated to rather than the design basis item. Remove - Deletes the selected item from the Items list and cancels its correlation with the design basis item. Related Topics • Correlate Additional Items with a Design Basis Item, page 424 • Correlate Command, page 422 • Remove the Correlation Between Added and Design Basis Items, page 424

SmartPlant P&ID User’s Guide 423

Retrieving from The Engineering Framework: An Overview

Correlate Additional Items with a Design Basis Item
1. Click Tools > Correlate Items. 2. In the drawing, select either an item that was retrieved using The Engineering Framework (TEF) and placed in the drawing or a previously correlated item. Tip As you move your pointer over an item in the drawing that is already correlated, the item is highlighted. When you click on a correlated item, it is added to the Items list on the Correlate Items dialog box as a primary item. Then the application searches the database for all other items that are correlated to the same design basis item and adds them to the list as well. 3. On the Correlate Items dialog box, click Add.
•

4. Select a item in the drawing that you want to correlate to the retrieved item. Tip
•

When the Correlate Items dialog box opens, you can highlight and select only items that were retrieved from TEF or native P&ID items that are already correlated. Since items from TEF already have a correlation, a message appears to make sure that you want to change the existing correlation.

Note
•

When you import a document into SmartPlant P&ID from TEF, each item that is created in a stockpile is automatically correlated to the design basis item that it came from. The above procedure is to correlate additional drawing items to the design basis item.

Using the To Do List: An Overview
The To Do List allows you to keep track of tasks required to keep P&IDs updated with information in The Engineering Framework (TEF). Specifically, this feature aids in retrieving data from TEF by providing a list of all the things that must be added, deleted, or modified to bring the drawing into agreement with the newest information retrieved from TEF. A single To Do List is shared by all the users of a plant database. You can view the entire To Do List and see the tasks that have been completed and those that are pending. Some types of tasks have associated code and you can run them thereby causing the database or drawings to be modified. From the To Do List, you can perform tasks, defer them, or delete them altogether. Additionally, you can view properties for each task in the To Do List. The information that is available is specific to the type of task that is selected: Create tasks and Update tasks, for instance, but certain information is provided for all types. The available task types are
• • • •

Create - Creates a new item in the stockpile Update - Updates the selected properties of the specified item Delete - Deletes the specified item from the plant Manual - Creates and displays a reminder. You can decide when a manual task is complete and set the status accordingly.

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. 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.

SmartPlant P&ID User’s Guide 425

Retrieving from The Engineering Framework: An Overview Notes
•

When an Update task is created in the To Do List, the units of measure used in properties are automatically converted to the defaults for the plant. The units of measure used for properties in Create tasks are converted to the plant defaults when the task is run. By clicking the heading of columns on the To Do List, you sort the list by the values in that column. You can change the order in which these columns appear in the Task List by right-clicking a column heading and choosing either Shift Left or Shift Right from the shortcut menu to move the column one place in either direction.

•

Related Topics

To Do List Command
Framework > To Do List Opens the To Do List dialog box, which lists tasks to be performed in SmartPlant P&ID. From this dialog box, you can run, defer, or delete tasks, and you can organize your tasks. Note
•

This command is available regardless of whether a drawing is open or not.

Related Topics • Using the To Do List: An Overview, page 425

426 SmartPlant P&ID User’s Guide

Retrieving from The Engineering Framework: An Overview

To Do List Dialog Box
Provides the ability to manage tasks that need to be run within a SmartPlant P&ID database to keep the plant current with information in The Engineering Framework (TEF). This dialog box opens when you click Framework > To Do List on the main menu bar. The commands associated with the To Do List are all on the To Do List toolbar.

Open Drawing - Opens the drawing associated with the selected task. If the drawing is not active, this command activates it. Any drawings that are currently open, remain open. This command is available when a drawing-specific task is selected and the drawing is not currently open or active. If multiple tasks are selected, this command is available only if they are assigned to the same drawing. You can assign or reassign a Create task, but Update and Delete tasks that are already assigned to a drawing cannot be reassigned. Zoom In - Centers and zooms in on the drawing items associated with the selected task or tasks in the Drawing view. You select the tasks from the Task list on the To Do List dialog box. This command allows you to visually inspect the referenced objects in the context of the surrounding drawing and is available when the selected task is associated with graphics and the drawing that contains the object is open and active. If multiple tasks are selected, this command is available only if each of the tasks meets these criteria. New Manual Task - Displays the Task Properties dialog box, and allows you to manually create a new task. SmartPlant P&ID User’s Guide 427

Retrieving from The Engineering Framework: An Overview Properties - Displays the Task Properties dialog box for the selected task. This dialog box shows the detailed properties of the task. This command is available only when a single task is selected. Assign Drawing - Creates an association between the selected task or tasks and a particular drawing. The Assign Drawing dialog box opens and lists the available drawings. This command is available when you select manually added tasks or tasks resulting from the Create command. If multiple tasks are selected, this command is available only if each of the tasks meets these criteria. Create in Drawing - If this button is depressed, the selected task is automatically performed on the drawing. If the button is not depressed, then the task is not run automatically. Run Task - Runs the task that you select from the Task list on the To Do List dialog box. This command is available when an executable task is selected, the associated drawing is open and active, and the status of the selected task is Open or Error. This command is not available for manually created tasks; in other words, the command is only available for tasks generated automatically by integration with The Engineering Framework (TEF) and importing of data from TEF. If multiple tasks are selected, this command is available only if each of the tasks meets these criteria. Note
•

When a task runs, the status of the task and the Run Date and Run By properties are updated. If the task runs successfully, the status is updated to Completed . If there is a problem, the status is updated to Error , and a timestamp and error message are added to the Notes area.

Defer Task - Toggles the status of the selected tasks between Open and Deferred . This command is available only when the selected task or tasks have either Open, Error , or Deferred status. Delete Task - Allows you to delete the selected task from the To Do List. This command is available only when one or more tasks are selected. A confirmation dialog box appears to verify deletion of the selected task or tasks. View Deleted - Displays a list of tasks that have been deleted from the To Do List in the Task list on a gray background. This command toggles this feature on and off. If you wish to completely delete tasks from the list of deleted tasks, you can select them and click Delete Task again on the To Do List toolbar. Report - Opens Excel and runs a report on the contents of the To Do List. This command is only available from the To Do List toolbar, but the report template, called To Do List.xls, produces reports much the same way other SmartPlant reports are produced.

428 SmartPlant P&ID User’s Guide

Retrieving from The Engineering Framework: An Overview Refresh - Updates the information that is displayed in the To Do List. Since only one To Do List is generated per plant, multiple users can be working in the To Do List at the same time, and so the information can change at any time. You can use the Refresh command to stay up-to-date. Group Related Tasks - When this button is depressed, clicking on the column header not only sorts the tasks based on the selected sort key but also groups the related tasks. If the Group Related Items button is not depressed, then clicking on the column header only sorts the tasks based on the selected column sort key. Task List - Populates automatically when you retrieve a document from TEF. This list provides information about each task, including, for example, the status of the task, the destination drawing, the name of the task, a description of the task, and so forth. By clicking the heading of any of these columns, you sort the list by the values in that column. You can change the order in which these columns appear in the Task List by right-clicking a column heading and choosing either Shift Left or Shift Right on the shortcut menu to move the column one place in either direction. Doubleclicking a task opens the Task Properties dialog box for that task. Related Topics Open the To Do List, page 429 • To Do List Command, page 426
•

Open the To Do List
Click Framework > To Do List on the main menu bar. Related Topics • Using the To Do List: An Overview, page 425

SmartPlant P&ID User’s Guide 429

Comparing SmartPlant P&ID with PDS: An Overview

Comparing SmartPlant P&ID with PDS: An Overview
The are many functions that can be compared between SmartPlant P&ID and the PDS product. They include attributes and properties, code lists and select lists, relationships between placed items, construction status values, consistency checking and propagation, design file differences, and using filters. Code Lists and Select Lists - In PDS, an attribute that is restricted to pre-defined values is said to be code-listed. These values for SmartPlant P&ID properties are called select-listed values; they reside in a select list. For more information, see Comparing Code Lists and Select Lists, page 431. Grouping Equipment in SmartPlant P&ID - With PDS™ 2D, before you place an equipment group, you must identify the equipment group before adding equipment components to a piece of equipment. With SmartPlant P&ID whenever you place a component on a piece of equipment, the software automatically creates a group relationship among the equipment and its components. For more information, see Grouping Equipment in SmartPlant P&ID, page 432. Setting Construction Status - In PDS 2D, you set the construction status by clicking the New, Future, or Existing buttons on the Construction Status control. When you place an item, the default construction status is New. In SmartPlant P&ID, you can set construction status before or after you place an item. For more information, see Setting Construction Status, page 433. Comparing Consistency Check to Propagation - Consistency Check in SmartPlant P&ID serves the same purpose as propagation in PDS 2D. For more information, see Comparing Consistency Check to Propagation, page 434. Comparing Graphics and Text in PDS 2D and SmartPlant P&ID - In PDS 2D, graphics are called cells. These graphics include pumps, tanks, piping, valves, and other items. In SmartPlant P&ID, graphics are called catalog items. For more information, see Comparing Graphics and Text in PDS 2D and SmartPlant P&ID, page 437. Using Filters Versus Levels - PDS 2D uses levels to separate data types in the Drawing view. In SmartPlant P&ID, filters show certain parts of the drawing, such as only the equipment or only the piping, and you can combine filters. For more information, see Using Filters Versus Levels. Related Topics • Comparing Code Lists and Select Lists, page 431 • Comparing Consistency Check to Propagation, page 434 • Grouping Equipment in SmartPlant P&ID, page 432 • Setting Construction Status, page 433 430 SmartPlant P&ID User’s Guide

Comparing SmartPlant P&ID with PDS: An Overview

Comparing Code Lists and Select Lists
In PDS, an attribute that is restricted to pre-defined values is said to be code-listed. That is, the accepted values for the attribute are defined in a codelist. Note
•

When you add an entry to a codelist, the system automatically assigns a number for the entry. The value assigned will be greater than 10,000.

In SmartPlant P&ID, some properties are likewise restricted to preset values. These values for SmartPlant P&ID properties are called select-listed values; they reside in a select list. Select entries are the individual members of a select list. Select lists and their select entries are defined in SmartPlant Data Dictionary Manager. For more information on defining select lists and entries, see SmartPlant Data Dictionary Manager Help. Some code lists and select lists contain special, restricted values, frequently in the Short Value entry. These special values help SmartPlant P&ID communicate information to other applications, such as PDS 3D and SmartPlant 3D. Consequently, you should use caution when modifying any entries already included with the product when it is delivered to you. You must have special permissions, granted in SmartPlant Engineering Manager, to modify select lists in SmartPlant Data Dictionary Manager. Related Topics • Review and Edit Item Properties, page 86

SmartPlant P&ID User’s Guide 431

Comparing SmartPlant P&ID with PDS: An Overview

Grouping Equipment in SmartPlant P&ID
With PDS™ 2D, before you place an equipment group, you must identify the equipment group before adding equipment components to a piece of equipment. Moving components from one equipment group to another also requires that you manually regroup components so that they belong to the destination equipment. With SmartPlant P&ID whenever you place a component on a piece of equipment, the software automatically creates a group relationship among the equipment and its components. This guideline also exists for placing equipment labels and equipment component labels. Related Topics • Place Equipment, page 140

432 SmartPlant P&ID User’s Guide

Comparing SmartPlant P&ID with PDS: An Overview

Setting Construction Status
In PDS 2D, you set the construction status by clicking the New, Future, or Existing buttons on the Construction Status control. When you place an item, the default construction status is New. In SmartPlant P&ID, you can set construction status before or after you place an item:
•

If you know the construction status before placing an item, click Tools > Options, and then set the status on the Placement tab. All items that are subsequently placed in the drawing are assigned this status. If you have already placed an item, select the item in the drawing and change the status in the Properties window.

Comparing Consistency Check to Propagation
Consistency Check in SmartPlant P&ID serves the same purpose as propagation in PDS 2D. However, instead of waiting to check for errors until after the drawing is complete, SmartPlant P&ID continuously checks for design errors as you create the drawing. Consistency checking is an important function in producing a useful design. The designer places the elements that compose the overall configuration of the design in a graphical mode. The designer places equipment, routes lines between equipment, places components on lines, and adds labels for accuracy. After the designer completes this work, consistency checking confirms that the created drawing agrees, or is consistent, with the design practices of the associated plant. PDS 2D uses a process called propagation to verify the suitability of a design. Propagation determines that a drawing is not ambiguous. Also, the process populates the associated database if serious propagation errors do not exist. Propagation produces a report with propagation exceptions. You must resolve them for an acceptable drawing. Available tools can help in the review of the report along with the drawing. However, pinpointing the source of the inconsistency could require time. Also, when you discover an error, tools or suggested error recoveries are not available. In the SmartPlant P&ID environment, Consistency Check continuously blends into the software product, more so than the workflow associated with propagation. Consistency Check starts when you place or modify an item. SmartPlant P&ID uses predefined rules to establish relationships that 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 that the software populates the database. You can list the types of errors you want to detect, such as pipe and valve conflicts. The software detects and reports the errors so you can correct them in the drawing. However, because you do not receive a list of possible solutions, resolution can be time-consuming.

Comparing System Editing to Propagation
SmartPlant P&ID is a data-centric application that makes use of a live connection to the plant database within the graphical environment. The drawing provides a familiar user interface for creating and modifying the data in the database. The database is the master data-store. The drawings can be re-generated from the data in the database. PDS2D is a drawing-centric application that can load the plant database from the data in the drawings. Drawings can be created independently and loaded into the database at a later time. The drawings contain the master data. The database can be regenerated from the data in the drawings. The term propagation as used in PDS2D describes the process by which the data in the drawings are loaded into the database. This process includes three major parts: 1) Validation of the graphics, 2) Validation of the data and the spreading of the data through the network of connected items, 3) Loading of the database. Validation of the graphics, validation of the data and loading of the database are not included in SmartPlant P&ID System Editing (propagation). System Editing is not a post-process of any kind. It is not driven by the existence of labels on the drawing. It does not apply a precedence algorithm to determine the property value for each item. It is a process that happens every time a property is changed (if the command is turned on). It is a process by which a property value can be spread throughout a connected network of items without requiring the user to visit each item. It is a process by which consistency can be maintained with minimal effort as the design changes. For more information, refer to System Editing: An Overview. Related Topics • Resolve an Inconsistency, page 320 • Review an Inconsistency, page 320

436 SmartPlant P&ID User’s Guide

Comparing SmartPlant P&ID with PDS: An Overview

Comparing Graphics and Text in PDS 2D and SmartPlant P&ID
In PDS 2D, graphics are called cells. These graphics include pumps, tanks, piping, valves, and other items. PDS 2D cells are grouped together in libraries. You can add and delete cells or place cells from a library into the design file. In PDS 2D, you can record text on a label. Then, at certain times, you propagate or write the information on the labels to the database. In SmartPlant P&ID, graphics are called catalog items. SmartPlant P&ID supplies a pre-loaded set of symbols. Plant administrators can create more symbols if needed. For more information about creating symbols, see the SmartPlant Catalog Manager Help. In SmartPlant P&ID, labels play a different role than in PDS 2D. In SmartPlant P&ID, you add or edit properties information for each item in the Properties window, and the software continuously writes this information to the database. Most labels show item properties, which are stored in the database. These labels are referred to as "driven," because they are updated as the property values of the item are updated. SmartPlant P&ID also provides "driving" labels, which you can use to directly edit properties in the database by editing the properties of the label. Related Topics Place a Label from Catalog Explorer, page 172

•

SmartPlant P&ID User’s Guide 437

Glossary

Glossary
A active placement point Coordinates that define the point where you place piping and instrumentation. alias An alternative name for a an object, such as a variable, file, device, or database instance. annotations Dimensions, notes, symbols, or reports that you place in a drawing to provide information or comments. archive To copy a file to a specified storage location and then delete the file from the current location. attribute 1. A property or characteristic of a component. 2. A characteristic that all members of a class possess. Each property has an associated value that defines its current state. Most databases represent an attribute by a column in a table. B backup To copy a file to a specified storage location while retaining the file in the current location. batch processing A method of processing data that collects a series of operations into a group and runs the group in a continuous stream without user intervention. Boolean operator Syntax that defines logical relationships between expressions like AND (both), OR (either), and NOT (other than). branch point A point on a pipe run that separates piping segments for assignments with different segment parameters. break label A graphic label placed at a point in a piping line at which any property can change value.

438 SmartPlant P&ID User’s Guide

Glossary C cache Memory that stores recently-accessed data so that subsequent requests to access the same data can be processed quickly. catalog A collection of catalog items, which are blueprints or templates for creating an item within the model. check in Process of moving a file from a user location to a storage location and recording that location in the database. class Blueprint for creating an item. The class defines the properties and behaviors that an item can show. client A user, software application, or computer that requests the services, data, or processing of another application or computer. The client is the user process. In a network environment, the client is the local user process and the server may be local or remote. All network operations among two or more nodes establish a client/server relationship. client/server database A database system in which the database engine and database applications reside on separate, intelligent computers that communicate with each other through a network. In this system, the processing power is split between the two CPUs. The workstation for the user is the client, and the database runs on the server. code list See select list. collaboration Working jointly. In Workshare, satellite sites work together with the host site to share the creation and maintenance duties for P&ID drawings and related data. column An attribute of a database table. A group of columns defines a table in the database. commodity code A code that you define that provides an index to material descriptions. commodity item Standard component that you can find in a manufacturer catalog.

SmartPlant P&ID User’s Guide 439

Glossary commodity option A pre-defined exception to the default settings for a component definition in the Piping Job Specification. component A catalog item that represents a part of the P&ID. A component has database information associated with it. concentric Having a common center or origin point with varying radii. configuration files Files that are used to identify and characterize the components of a network. Configuration is largely a process of naming network components and identifying relationships among those components. connect point Active point item that is specially designated in a component. A connect point is a location at which you can connect lines, labels, and other components to one another. Also, a location for applying a relationship connectivity Linkage between items that relates because of their graphics, like a valve and a pipe run. Proper connectivity must exist to confirm valid data integrity. connector Item with multiple vertices; behavior of a connector relies on the two items that it connects. D data dictionary The underlying data model of a plant, consisting of database entries and select lists. SmartPlant Data Dictionary Manager maintains this information. data model Application items that populate a project. Typical items in a data model are components, lines, and labels. database Collection of files of comprehensive information that have predefined structure and organization; a specific program can communicate, interpret, or process these files. database administrator The technical support person who assigns user IDs and data access permissions, creates new databases, removes databases no longer in use, and monitors disk storage usage of the database and performance. 440 SmartPlant P&ID User’s Guide

Glossary database link A pointer that defines a one-way communication path from an Oracle database server to another database server. This pointer is stored in the local database and identifies the remote database, a communication path to that database, and optionally, a user name and password. In connected Workshare, the database link is used to access the remote database, providing the satellite a view into the plant schema at the host site. database table Part of the database consisting of rows and columns and containing information about the project and design elements. design file File containing graphics and text data, also called a drawing file. design-wide break A region of the drawing within which a single property value is defined for all the included components. Indicating the region, a closed shape exists, along with an accompanying label that shows the property value. display-only annotation Feature that allows you to generate temporary annotation graphics for review without placing the graphics in a design file. drawing file File in which you place items; also called a design file. drawing, P&ID Graphics file that contains data about one unit. Each drawing has a unique drawing number within the unit to which the drawing belongs. driving label Graphics, text, or both with their own entities and properties that you place on the P&ID to define values for properties of the components and groups to which they apply. E easting Term used in plane surveying that describes an east, or positive, difference in longitude. edge-edge model Model that represents connectivity entire by edges. enumerated list See select list.

SmartPlant P&ID User’s Guide 441

Glossary equipment components Items associated with pieces of equipment, such as nozzles and trays. As you place equipment components, the software automatically creates a group relationship between the equipment and the component. As a group, the components move along with the equipment. equipment group A single-name equipment body and any items within or attached to the body, such as a tray or nozzle. exclusive database relationship Relationship that exists between any given instrument and the loop to which it belongs - that is, an instrument can belong only to one loop at a time. exit elevation Lowest downstream elevation point on the internal diameter of a pipe. F filter Function that creates a subset of items. This subset meets criteria that property values define. fixed point A control point that usually is a locally known monument with known coordinates. flow rate Quantity of fluid that flows per unit of time. flow time Required time for the flow, from the start of the piped system, to reach a downstream point. 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. G gap Condition that exists when two lines intersect graphically on the P&ID but not physically in the plant. glyphs 1. Icons attached to the pointer that provide feedback as you draw. For SmartPlant P&ID, glyphs identify the relationships that you are creating.

442 SmartPlant P&ID User’s Guide

Glossary 2. Icons that show the perpendicular or parallel relationships with other items in the drawing as you point over items in the drawing. H hierarchical An ordered relationship from greatest to least; refers to the relationships among groups, components, and labels. hierarchy A classified structure with superiors, or roots, and subordinates, or dependents, for grouping files or commands. horizontal angle Angle measured in the horizontal plane. Horizontal angles are the basic measurements needed to determine bearings and azimuths. horizontal distance Distance between two points computed using only the northing and easting coordinates of the points. host A computer that acts as the controlling source of information. In Workshare, a site that controls satellites. I implied piping component Piping components that the software creates in the alphanumeric database; these components are not represented graphically. inline Term used to refer to those piping or instrument components that you can insert in a piping segment. inline instruments Components that you can insert into a piping segment. Inline instruments include instrument valves, such as butterfly valves and temperature regulator valves, and other instrument components, such as orifice plates and flow controllers. instance A single allocation of an item class. instrument loops A group of one or more instruments or control functions arranged so that signals can pass from one function to the next for the purpose of measuring and controlling a process variable. In SmartPlant P&ID, you can create instrument loops containing any combination of inline and offline instruments. SmartPlant P&ID User’s Guide 443

Glossary instruments Devices that directly or indirectly measure or control a variable in a plant process, such as flow or temperature. Instruments can be devices such as final control elements, computing devices, or electrical switches. Two types of instruments exist: inline instruments and offline instruments. interference checking Process that identifies possible collisions or insufficient clearance between items in a drawing. isometric Relating to or concerning a drafting system characterized by three equal axes at right angles; a view in which the horizontal lines of an item are drawn at an angle to the horizontal and all verticals are projected at an angle from the base. item Unit of storage within a larger unit, such as a file in a catalog; a single member in the P&ID. item type Distinct objects that users can manipulate in SmartPlant P&ID, such as equipment, events, and safety classes. K keypoint Point on an item, including vertices, to which you can snap in the drawing - that is, connect to the item. L label A graphic representation that reflects the status or condition of an associated item. label, PDS 2D Intelligent graphics and text that identify a group or component. Each label is an entity with properties and provides the primary means of defining property values in the P&ID task. line route Collection of ordered line runs, gaps, and components that all share the same attribution. A line route contains line runs, components, gaps, and properties; however, a line route does not contain any branches. line style Collection of formats or properties that you name and store as a group to apply as a style of a line.

444 SmartPlant P&ID User’s Guide

Glossary loop Software structure that allows a specified sequence of instructions to run repeatedly, if the stated conditions remain constant. M MTO Material take-off; also called a Bill of Materials. macro A sequence of actions or commands that can be named and stored. When you run the macro, the software performs the actions or runs the commands. You can create the macros in Visual Basic or other OLE-aware programming applications. Some of the OLE-aware programming applications are VBA, Visual C++ Delphi, Visual Basic, and so forth. mirror To create the reverse image of a display set through a plane or around a defined axis. mirror handle Reflects an image about the horizontal and vertical axes. Point to the manipulation handle on upper corner of an item to display the mirror handle. model A representation of graphics or a schema; collection of all items and their relationships to create a coherent description of a process plant. model file A design file or database file that defines the 2-D or 3-D geometry and connectivity of a structure. N network Interconnection of host computers and workstations that allows them to share data and control. The term has a dual meaning: network can refer to the devices that connect the system, or network can refer to the connected system. 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

SmartPlant P&ID User’s Guide 445

Glossary service name in a connect string for the service to which they wish to connect: CONNECT username/password@net_service_name. node name Name, or alias, that you can assign to the node address of a device on a network. northing Term used to describe a north coordinate location in the plant coordinate system. nozzle A special equipment item that contains the connection point to piping. O offline Term that refers to those instrument components that are not inserted in a pipe run. offline instruments Components that you do not insert into a piping segment. Typically, these components are the instruments that monitor and control inline instruments. Offline instruments include temperature regulators, level gauges, and system functions, such as digital control stations (DCS) or computers. Oracle Net Communication software that enables a network session from a client application to an Oracle database server. Once a network session is established, Oracle Net acts as a data courier for the client application and the database server. It is responsible for establishing and maintaining the connection between the client application and database server, as well as exchanging messages between them. Oracle Net is able to perform these jobs because it is located on each computer in the network. Oracle 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. orientation by system A type of orientation in which the software places items in the same orientation that you created them, if you place the items in free space or in a horizontal line. For example, if you placed the item in a vertical line, the software automatically rotates the item 90 degrees counterclockwise from the orientation in which you created it. See also orientation by user.

446 SmartPlant P&ID User’s Guide

Glossary orientation by user A type of orientation in which you define the orientation of an item when you place it. The default orientation of this item is identical to items that the software orients. You can change the default orientation at placement time. See also orientation by system and orientation fixed. orientation fixed A type of orientation in which the software places items in the same orientation in which you created them, regardless of the method or location that you used for placement. You cannot change the orientation at placement time. See also orientation by system and orientation by user. orthogonal view A view that is a projection of the drawing onto a plane along lines that are orthogonal to the plane. P PFD Process Flow Diagram; a drawing that serves as a start for a P&ID. P&ID See Piping and Instrumentation Diagram. parameter A property with a value that determines the characteristics or behavior of an item. parametric item Item that contains geometry constrained together using relationships, with driving dimensions that are defined as adjustable parameters. path name Sequence of directories leading to a file. See also absolute path name and relative path name. peak flow Maximum flow rate of water through a specific size pipe. pipe run A line run that has piping properties. Also, a contiguous set of pipe run segments separated only by inline components, branch points and gap components. A pipe run has a beginning and an end. It does not branch or contain spaces between components. A pipe run segment may have identical properties as a pipe run from which it branches but is not considered part of the pipe run.

SmartPlant P&ID User’s Guide 447

Glossary 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) Primary drawing for maintaining a plant. The P&ID includes three primary groups of items: equipment, piping, and instrumentation. The drawing relates critical processrelated 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. PFD Process Flow Diagram; a drawing that serves as a start for a P&ID.

448 SmartPlant P&ID User’s Guide

Glossary process line Ordered collection of connectors and inline components with an equal set of core properties - typically, items with the same line number. Specifically, a representation of the piping that transfers process fluid. process point A tool that defines the operating conditions at a particular place during a process. Examples include defining temperature, density, and flow rate. project 1. A directory file created in an application environment that contains design files and subprojects. A project is not necessarily specific to an application; the project may contain design files from multiple applications. 2. Term used for convenient grouping of either all or part of the items that constitute a plant. Several projects can be under design at one time, probably in separate geographical locations and having limited communication among them. projection lines Witness lines; lines extending from the boundaries of an item and between which dimensioning data for the area marked by the projection lines is placed. property A unique characteristic of an object, item, symbol, or document. The properties of an item can include display properties and properties stored with the item. For example, the properties of a valve symbol can include display properties such as color, line style, and width. Other properties stored with the valve symbol can include the manufacturer, cost, or material. Properties stored with the valve symbol are displayed in the Properties window when the valve symbol is selected. publish To release a P&ID drawing for subscription or distribution. publishing method To publish a P&ID drawing using either the database link or the file sharing means of transferring data. R reference data A collection of information containing facts relative to industry design codes, catalog data of vendors, job specifications, commodity libraries, graphics symbology, label descriptions, report formats, and other information of a similar theme. reference file A drawing file attached to another drawing file for reviewing reference; a graphic representation attached to a drawing view.

SmartPlant P&ID User’s Guide 449

Glossary 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. You can establish relationships as you place new items or between items already on the drawing sheet. This connection indicates that some form of communication of behavior or state occurs. relative mode A placement mode in which symbols respond to their orientation definition at creation time, whether they are defined in the P&ID reference data as orientation fixed, orientation by system or orientation by user, and to the orientation of any graphic item to which they are attached at placement time. Relative placement mode is more flexible then absolute, but much more difficult to predict. relative path name Sequence of directories leading from the current directory to a particular file. See also absolute path name and path name. report template An online outline for a new report that you need to define. You can select a user-level or a project-level template to create a new report template. required item Item that the plant model needs. An item is required if the Tag Required Flag property is set to True for the item in the Properties window of Catalog Manager. If you delete a required item from a drawing, it appears in the stockpile for later placement. revision cloud A set or arcs used to enclose changes that have occurred since the last revision. revision triangle A numbered triangle placed in the P&ID to indicate the drawing revision when the change occurred. rule Standard mechanism for creating relationships. A rule defines a valid context for two items to communicate their behavior or state. S satellite A server located remotely from the host server. In Workshare, a remote server connected to a satellite slot at the host server.

450 SmartPlant P&ID User’s Guide

Glossary satellite slot The host's side of the Workshare connection. Satellites connect to the satellite slots made available by the host at the host site. schema Description of the overall structure of the rulebase or database. schema file File that outlines the overall logical structure of a rulebase or database. schematic file Schematic drawing or diagram of a particular item in the plant. search criteria Set of values used to scan a database or object library. segment Contiguous piping and piping components between two points in the network at which properties change value. Segments terminate by property break labels, branches, nozzles, off-pace and utility connectors, and by the terminal ends of piping lines. select list List of related values that SmartPlant P&ID Data Dictionary Manager uses to specify various aspects of the SmartPlant P&ID data model. For example, select lists allow you to select from a list of values for specific properties when creating P&IDs, filters, and symbols. A select list for the fluid code property, for example, allows you to select from a set of standard entries: such as P for process or MMA for methyl alcohol. server In network operations, the node that maintains common data or performs a common task that clients need. All network operations between two or more nodes establish a client/server relationship. signal lines 1. Intelligent line strings that connect offline instruments, inline instruments, and piping. 2. An ordered collection of connectors, and inline components with an equal set of core properties: typically, items that share the same line number. Specifically, a representation of the wiring used for transferring electrical or software signals. 3. A collection of signal runs from all drawings in a project whose project-defined line property values are identical. signal run A line run with signal properties. See also pipe run. SmartPlant P&ID User’s Guide 451

Glossary 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 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 you have not yet placed in the graphic model. style 1. The appearance of geometry and annotations on the drawing sheet. For example, color and line weight of an element, the font used in a text box, and so forth. 2. A collection of formats or properties that you name and store as a group. When you apply a style to a selected item, the software applies all the formats or properties in the style to the element. The style types include: fill, dimension, line, and text. subnet A division of a network into an interconnected, but independent, segment, or domain, in order to improve performance and security. subnet mask The technique used by the IP protocol to filter messages into a particular network segment. The subnet mask is a binary pattern that is stored in the client machine, server, or router and is matched up with the incoming IP address to determine whether to accept or reject the packet. subscribe To sign up for a service. In Workshare, connecting a satellite site with a satellite slot at the host.

452 SmartPlant P&ID User’s Guide

Glossary subscribe access Read-only access to published P&ID drawings. symbology 1. Display style of an item, including color, pattern, style, and width. 2. In Options Manager, symbology provides graphical clarity to a drawing by differentiating among various items by their appearance. Symbology refers to the color, line weight, and style associated with items in a particular filter. T table Collection of data for quick reference, either stored in sequential locations in memory or printed as an array of rows and columns of data items of the same type. template A document or file having a preset format, used as a starting point or blueprint for a particular application so that the format does not have to be recreated each time it is used. In SmartPlant P&ID, a file used to create a drawing with a set of default parameters; a template serves as an outline or blueprint for you to create a new drawing. In SmartPlant Engineering Manager, a file used to create roles, data dictionaries or other database schemas. time stamping Process that prompts the software to generate a record when you change an property. transaction Nongraphic record of any additions, deletions, and changes that you request during job posting activities. U UNC path Universal Naming Convention. The full name of a resource on a network. It conforms to the \\servername\sharename syntax, where servername is the name of the server and sharename is the name of the shared resource. UNC names of directories or files can also include the directory path under the share name, with the following syntax: \\servername\sharename\directory\filename. unit Group of parts of the schematic and individual worlds of a plant that together perform a given process function. The identifying number of the unit is unique within the project and within the plant. Most companies, but not all, use the concept of unit. user name Name that provides access to an account on the system. Same as username.

SmartPlant P&ID User’s Guide 453

Glossary V validation Process or program that verifies data integrity in the database.

Restricted Rights Legend
Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c) of the Contractor Rights in Technical Data clause at DFARS 252.227-7013, subparagraph (b) of the Rights in Computer Software or Computer Software Documentation clause at DFARS 252.227-7014, subparagraphs (b)(1) and (2) of the License clause at DFARS 252.227-7015, or subparagraphs (c) (1) and (2) of Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished---rights reserved under the copyright laws of the United States. Intergraph Corporation Huntsville, Alabama 35894-0001

Warranties and Liabilities
All warranties given by Intergraph Corporation about equipment or software are set forth in your purchase contract, and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such warranties. 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 discussed in this document is furnished under a license and may be used or copied only in accordance with the terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Trademarks
Intergraph, the Intergraph logo, SmartSketch, FrameWorks, SmartPlant, INtools, MARIAN, PDS, and IntelliShip are registered trademarks of Intergraph Corporation. Microsoft and Windows are registered trademarks of Microsoft Corporation. Other brands and product names are trademarks of their respective owners.

Drawing with Relationships: An Overview................................................................90
Using Relationships as You Draw: An Overview ............................................................ 92 Draw a Line Connected to Another Line ........................................................................ 103

Drawing Precisely: An Overview.............................................................................110
Placing Elements with a Grid: An Overview.................................................................. 110

Customer Support and Documentation Comments
For the latest support information for this product, use a World Wide Web browser to connect to http://www.intergraph.com/ppm/services/support.asp. Send documentation comments or suggestions to PPMdoc@intergraph.com.

SmartPlant P&ID Auxiliary Graphics User’s Guide 5

Auxiliary Graphics: An Overview

Auxiliary Graphics: An Overview
You can use Auxiliary Graphics to add simple graphics to your SmartPlant P&ID drawings. When you have completed adding graphics using Auxiliary Graphics, these graphics display in your SmartPlant P&ID drawing inside a SmartFrame. The SmartFrame and its contents are stored in the database.

To use Auxiliary Graphics, select Edit > Insert > Auxiliary Graphics. Selecting the command opens a drawing sheet that also displays your SmartPlant P&ID drawing. You can then create graphics using the displayed Draw toolbar. Existing objects in your current SmartPlant P&ID drawing cannot be selected or edited but do display for viewing purposes. To return to your SmartPlant P&ID drawing, select File > Close Auxiliary Graphics. When you return to SmartPlant P&ID, you can only move the graphics placed using Auxiliary Graphics. To edit the graphics again, you can either double-click on the SmartFrame, right-click and select Edit, or select Edit > Insert > Auxiliary Graphics.

6 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview The Auxiliary Graphics Draw toolbar contains commands for working with continuous lines and arcs, tangent arcs, curves, free form drawing, circles, rectangles, fillets, text and so forth. The Draw toolbar displays down the left side of the drawing sheet (as shown in the example graphic). Note that any SmartPlant P&ID command not available during the Auxiliary Graphics session is disabled. You can customize the Auxiliary Graphics Draw toolbar using Tools > Customize. The available commands display with (Auxiliary) following the command name. Toolbar choices include:
• • • • • • • • • •

For information about how to customize a toolbar, refer to Customize Command (Tools Menu). Notes
•

Any customizations made to the Draw toolbar are not saved when you close the Auxiliary Graphics session. The Undo buffer is cleared each time you enter an Auxiliary Graphics session. The SmartPlant P&ID Undo buffer is also cleared at this time.

Auxiliary Graphics Command
Edit > Insert > Auxiliary Graphics Selecting the command opens a drawing sheet that also displays your SmartPlant P&ID drawing. You can then create graphics using the displayed Draw toolbar. Exiting objects in your current SmartPlant P&ID drawing cannot be selected or edited but do display for viewing purposes. To return to your SmartPlant P&ID drawing, select File > Close Auxiliary Graphics. When you return to SmartPlant P&ID, you can only move the graphics placed using Auxiliary Graphics. To edit the graphics again, you can either double-click on the SmartFrame, right-click and select Edit, or select Edit > Insert > Auxiliary Graphics. Related Topics • Auxiliary Graphics: An Overview, page 6

Drawing Basic Elements: An Overview
An element is any line, circle, or other part of the drawing. The Draw toolbar on the left side of the drawing sheet contains most of the buttons that you can use to draw any type of basic geometric element — freeform shapes, lines, arcs, circles, and so forth.

You can place most basic elements with just a few clicks. For example, if you want to place a line, can click Line/Arc Continuous on the Draw toolbar. Then, click two points to indicate where to start and finish the line. If you do not want to place another line, you can right-click to end the operation. Tip
•

Right-clicking ends most operations in the software.

You can also place the line by clicking Line/Arc Continuous and then clicking and dragging the pointer. When you release the mouse, the line appears on the drawing sheet. With this method, you drag the pointer as if it were a pen. You can draw most elements, such as rectangles, circles, and arcs, with this method, sometimes called mouse-down drawing. The mouse-down method is typically used to place most elements in conceptual sketching and modification. If you want to place a precise line, click Line/Arc Continuous , type values into the ribbon that appears, and then press Enter. You can then click on the drawing sheet to place the line. This method, sometimes called mouse-up drawing, is typically used for precision placement and when you want to draw elements that are related to each other. In some cases, you might want to click points on the drawing sheet and type values in the ribbon to place an element. For example, you can click Line/Arc Continuous and then type 3.0 in the Length box on the ribbon box and press Enter to lock the length value.

SmartPlant P&ID Auxiliary Graphics User’s Guide 9

Auxiliary Graphics: An Overview When a line that is three inches long appears next to the pointer, you can click anywhere on the drawing sheet to indicate where to place one end of the line. Then, you move the line around and click again to set the line's orientation angle.

If you do not like the results of what you drew, you can click Undo on the Main toolbar. If you want to repeat an action, click Redo on the Main toolbar. Related Topics • Drawing Circles, Arcs, and Ellipses: An Overview, page 14 • Drawing FreeForm Shapes: An Overview, page 35 • Drawing Lines: An Overview, page 10 • Drawing Squares, Rectangles, and Polygons: An Overview, page 32

Drawing Lines: An Overview
If you want to place a line, you click Line/Arc Continuous on the Draw toolbar. Then, you click a point on the drawing sheet to indicate where to start the line. You click a second point to indicate where to end the line. If you do not want to place another line, right-click to end the operation. You can also place the line by clicking Line/Arc Continuous and then clicking and dragging the pointer. When you release the mouse, the line appears on the drawing sheet. If you want to place a precise line, you can click Line/Arc Continuous , type values into the ribbon that appears, and then press Enter. You then click on the drawing sheet to place the line. You can also use a combination of clicks and ribbon input to place the line. For example, you can type a line length in the ribbon box to lock the length value and then set the line's orientation angle graphically. You can set the color and line type by clicking a style in the Style list box.

Draw a Line
1. On the Draw toolbar, click Line/Arc Continuous 2. Click the point where you want the line to begin. 3. Click the point where you want the line to end. This action defines the length and rotation angle of the line. 4. Do one of the following:
• •

Right-click to end the line. To draw a series of connected lines, click at the point where you want each line segment to end, and then right-click. Tip

•

If you close the shape, the command restarts so you begin drawing again.

Notes
•

Instead of clicking to draw the end points, you can type values on the ribbon bar. You can also use a combination of graphic and ribbon input. Instead of clicking several different points to draw a line, you can drag the pointer to draw a line. You can press Esc to end a line or a line segment. You can use the options on the ribbon and the commands on the shortcut menu to edit a line.

Draw a Point
1. On the Draw toolbar, click Point 2. Click to place a point. Notes
•

.

Instead of clicking to place the point, you can type values in the coordinate boxes on the ribbon. You can also use a combination of graphic and ribbon bar input. The coordinate origin is located at the bottom left corner of the window. You can use the options on the ribbon and the commands on the shortcut menu to edit a point.

Line/Arc Continuous Command
Draws one line or a series of connected lines. When you draw a series of lines, the second point of one line is the first point of the next line. You can also draw a continuous series of lines and arcs that can be perpendicular or tangent to each other. You can create an open or closed shape by drawing lines and arcs in any combination. The last point of the line or arc is the first point of the next line or arc. Note
•

The Line/Arc Continuous command starts in line mode by default. If you want to start by drawing an arc, press Shift+A. While drawing, you can toggle between the two modes by pressing Shift+A for arc mode or pressing Shift+L for line mode.

Line Ribbon
Style - Sets the drawing style. Line Color - Sets the drawing color. You can click More to define custom colors with the Colors dialog box. Line Type - Sets the drawing line type and style. Line Width - Sets the line width. Line - Switches the drawing mode from arc to line. Arc - Switches the drawing mode from line to arc. Length - Sets the length of a line. This box accepts only positive values. Angle - Sets the angle of a line. This box accepts positive or negative values. A positive value is counterclockwise from the x axis, and a negative value is clockwise from the x axis. Related Topics Draw a Line with FreeSketch, page 37 • Draw a Line, page 11 • Draw Connected Lines and Arcs with FreeSketch, page 22 • Draw Connected Lines and Arcs, page 20 • Line/Arc Continuous Command, page 12
•

Point Command
Draws a point. The point is displayed as a filled rectangle.

Point Ribbon
Style - Sets the drawing style. Line Color - Sets the drawing color. You can click More to define custom colors with the Colors dialog box. Line Type - Sets the drawing line type and style. Line Width - Sets the line width. X - Sets a value for the x coordinate. You can use this option by itself or with the Y option. Y - Sets a value for the y coordinate. You can use this option by itself or with the X option. Related Topics Draw a Point, page 12 • Drawing Basic Elements: An Overview, page 9 • Point Command, page 13
•

Drawing Circles, Arcs, and Ellipses: An Overview
If you want to draw a circle, you can click Circle By Center Point on the Draw toolbar. Then, you click a point to define the center of the circle. To place the circle, you click a second point to define the distance of the circle radius from the first point. You can use other commands on the Draw toolbar to place arcs, ellipses, and other types of circles.

14 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Besides clicking the pointer, you can also place circles by clicking Circle By Center Point and then holding the mouse button down and drawing freehand. After you close the loop, the circle appears. You can also place a precise circle by clicking Circle By Center Point and then typing values into the ribbon. After you press Enter, a circle appears around the pointer. You can then place the defined circle by clicking the point you want on the drawing sheet. Related Topics Circle Ribbon, page 18 • Curve Ribbon, page 27 • Drawing Basic Elements: An Overview, page 9 • Ellipse Ribbon, page 31
•

Draw a Circle by Defining Three Points
1. On the Draw toolbar, click Circle By 3 Points . 2. Click three points on the circumference of the circle.

Notes
•

Instead of clicking several different points to draw a circle, you can draw a diagonal line and the software automatically changes it to a circle. Instead of clicking to define the circumference of the circle, you can type values on the ribbon. You can also use a combination of graphic and ribbon bar input. You can use the options on the ribbon and the commands on the shortcut menu to edit a circle.

Draw a Circle by Center Point
1. On the Draw toolbar, click Circle By Center 3. Click to define the radius. . 2. Click the location where you want the center point.

Notes
•

Instead of clicking to define the radius, you can type values on the ribbon bar. You can also use a combination of graphic and ribbon input. Instead of clicking several different points to draw a circle, you can draw a diagonal line and the software automatically changes it to a circle. You can use the options on the ribbon and the commands on the shortcut menu to edit a circle.

Draw a Circle Tangent to One or Two Elements
1. On the Draw toolbar, click Tangent Circle . 2. Move the pointer along an element until the software recognizes a point on element relationship or a key point. 3. Click to make the circle tangent. 4. Do one of the following to define the radius:
•

Move the pointer until the circle is in the position that you want, and then click. Move the pointer until the software recognizes a tangent or key point relationship with another element, and then click.

•

16 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Notes
•

Instead of clicking several different points to draw a circle, you can draw a diagonal line, and the software automatically changes it to a circle. You can define the radius first to make a circle tangent to the first element, but not fixed in one position on it. After you type a value in the Diameter or Radius box, move the pointer along the element until the software recognizes a point on element relationship, and then click. The circle is then displayed dynamically, and you can move it along the element freely until you make it tangent to another element or key point. You can use the options on the ribbon and the commands on the shortcut menu to edit a circle.

Draw an Arc by Defining Three Points
1. On the Draw toolbar, click Arc by 3 Points 2. Click the location to begin the sweep of the arc. 3. Do one of the following:
•

.

Click the location that you want as midpoint of the arc, and then click the location that you want to end the sweep of the arc. Click the location that you want to end the sweep of the arc, and then click the location that you want as midpoint of the arc.

•

Tip
•

Use the intent zones at the first and second points to specify if the third point is between the first two or beyond one of the first two.

18 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Notes
•

Instead of clicking to define the sweep and the midpoint, you can type values on the ribbon. You can also use a combination of graphic and ribbon input. Instead of clicking several different points to draw an arc, you can draw a diagonal line and the software automatically changes it to an arc. You can use the options on the ribbon and the commands on the shortcut menu to edit an arc.

Draw an Arc by Center Point
1. On the Draw toolbar, click Arc by Center Point 2. Click the point where you want the center point. 3. Click where you want to begin and end the sweep of the arc. Tip
•

You can change the arc direction by moving the pointer.

Notes
•

Instead of clicking to define the radius, you can type a value on the ribbon bar. You can also use a combination of graphic and ribbon input. Instead of clicking several different points to draw an arc, you can draw a diagonal line and the software automatically changes it to an arc. You can use the boxes on the ribbon and the commands on the shortcut menu to edit an arc.

Draw an Arc Tangent to Two Elements
1. On the Draw toolbar, click Tangent Arc .

2. Click an element to which you want the new arc to be tangent. You can click the end point of a line or curved element, or any point on the element. 3. Move the pointer through one of the intent zones displayed at the position you just clicked. If the command dynamics show an arc perpendicular to the existing element, move the pointer back to the intent zones and exit through a different quadrant. 4. When the command dynamics show an arc that is tangent to the first element, move the pointer to a position where the software recognizes the tangent relationship with another element and then click.

Notes
•

Instead of clicking to define the radius and sweep of the arc, you can type values on the ribbon. You can also use a combination of graphic and ribbon bar input. You can use the options on the ribbon and the commands on the shortcut menu to edit an arc.

•

Related Topics • Arc Ribbon, page 27 • Tangent Arc Command, page 26

Draw Connected Lines and Arcs
1. On the Draw toolbar, click Line/Arc Continuous 2. This command starts in line mode by default. If you want to start by drawing an arc, press Shift+A. 3. Click the location to begin the line or arc. 4. Click the location to end the line or arc. You can use intent zones to specify if you want to draw a tangent or perpendicular arc.

20 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview 5. If you are drawing an arc, click a point on the arc to define the radius. Tip After you draw an arc, the command switches back to line mode automatically. You can switch back to arc mode if you want to draw another arc. 6. Continue drawing lines or arcs, pressing Shift+A to switch to arc mode and Shift+L to switch to line mode.
•

7. Right-click to finish. Tip
•

If you close the shape, the command restarts so you begin drawing again.

Notes
•

Instead of pressing Shift+L or Shift+A to switch modes, you can use Line or Arc on the ribbon. You can make the first line or arc tangent or perpendicular to an element. First, move the pointer to the element to which you want to be tangent. Click when the software recognizes a Point On the relationship. Then use the intent zones to indicate if you want the line to be tangent or perpendicular. Instead of clicking locations on the drawing sheet, you can type values on the ribbon. You can also use a combination of graphic and ribbon input. Using the ribbon boxes to type values does not affect the settings of the Line or Arc modes.

Draw Connected Lines and Arcs with FreeSketch
1. On the Draw toolbar, click FreeSketch . 2. On the ribbon, set the line and arc element types with Element Type, and clear the other element types. 3. Drag to draw a line or arc. When you stop moving the pointer, do not release the mouse button. 4. Drag to draw a series of line segments and arcs, continuing to hold the mouse button as you draw each line and arc. Tip 5. When you have finished, release the mouse button. Notes
• •

Use Adjust to adjust the geometry you draw. When Adjust is off, the software interprets the exact movements of your pointer. When Adjust is on, the software interprets the lines as horizontal or vertical and the arcs as tangent to the connected elements. The software recognizes relationships at the start point and end point of the line. You can use the boxes on the ribbon and the commands on the shortcut menu to edit a line or an arc.

Draw a Curve
1. On the Draw toolbar, click Curve 2. Do one of the following:
•

To draw an open curve, set the Curve Type box on the ribbon to Open.

•

To draw a closed curve, set the Curve Type box on the ribbon to Closed.

3. Click three or more points on the drawing sheet. These points represent nodes on the curve. Tip You must place at least three points to draw a curve. 4. Right-click to end the curve.
•

Notes
•

You can drag the pointer to draw the shape of a curve. Instead of clicking several different points to draw a curve, you can draw a diagonal line and the software automatically changes it to a curve. The nodes at the start point and end point of a curve are always smooth. You can use Insert Node on the shortcut menu to add nodes to a curve. You can use Delete Node on the shortcut menu to delete nodes from a curve. You can use the options on the ribbon and the commands on the shortcut menu to edit a curve.

Change the Curve Type
1. Select the curve. 2. Do one of the following:
•

To change an open curve to a closed curve, set the Curve Type box on the ribbon to Closed.

To change a closed curve to an open curve, select the node you want to open, and then set the Curve Type box on the ribbon to Open. If you do not select a node, the software opens the curve at the node that was automatically activated when you selected the curve.
•

Notes
• • •

You can use the arrows on the ribbon to select a node. You can use Insert Node on the shortcut menu to add nodes to a curve. You can use Delete Node on the shortcut menu to delete nodes from a curve.

Change the Node Type
1. Select the curve. 2. Select the node you want to change. 3. On the ribbon, click the button for the node type you want to change the node to: Smooth, Symmetric, or Cusp. Notes
• • •

You can use the arrows on the ribbon to select a node. You can use Insert Node on the shortcut menu to add nodes to a curve. You can use Delete Node on the shortcut menu to delete nodes from a curve.

Arc by 3 Points Command
Draws an arc using three points. The first point defines an end point. You can then either define a point on the arc and then the end point, or the end point and then a point on the arc. The end points are not tangent or perpendicular to other elements. Related Topics • Draw an Arc by Defining Three Points, page 18 • Drawing Circles, Arcs, and Ellipses: An Overview, page 14 • Drawing FreeForm Shapes: An Overview, page 35 Arc By Center Point Command Draws an arc using three points. The first point defines the center of the arc and the next two points define the sweep. Related Topics • Draw an Arc by Center Point, page 19 • Drawing Circles, Arcs, and Ellipses: An Overview, page 14 • Drawing FreeForm Shapes: An Overview, page 35 Tangent Arc Command Draws an arc tangent or perpendicular to one or two elements. The first point defines one end of the arc. If you place the first point on a key point of an element you want the arc to be tangent or perpendicular to, then the second point defines the sweep. If you place the first point in free space, then this command works like Arc by 3 Points. In this case the first point defines an end point. You can then either define a point on the arc and then the end point, or the end point and then a point on the arc. Tip
•

While in dynamics for the second point, you can set the orientation of the arc by passing the pointer through one of the four quadrants of the first point's intent zone.

Auxiliary Graphics: An Overview Arc Ribbon Style - Sets the drawing style. Line Color - Sets the drawing color. You can click More to define custom colors with the Colors dialog box. Line Type - Sets the drawing line type and style. Line Width - Sets the line width. Radius - Sets the radius. Sweep - Sets the sweep angle. Related Topics • Arc by 3 Points Command, page 26 • Arc By Center Point Command, page 26 • Draw an Arc by Center Point, page 19 • Draw an Arc by Defining Three Points, page 18 • Draw an Arc Tangent to Two Elements, page 20 • Tangent Arc Command, page 26 Curve Command Draws a smooth, open or closed curve. A series of curves can have smooth, symmetric and cusp nodes. The node at the start point and the node at the end point of a curve are always smooth. Related Topics Change the Curve Type, page 25 • Change the Node Type, page 25 • Delete a Node from a Curve, page 24 • Draw a Curve, page 23 • Drawing Circles, Arcs, and Ellipses: An Overview, page 14 • Insert a Node into a Curve, page 24
•

Curve Ribbon Style - Sets the drawing style. Line Color - Sets the drawing color. You can click More to define custom colors with the Colors dialog box. Line Type - Sets the drawing line type and style. Line Width - Sets the line width.

SmartPlant P&ID Auxiliary Graphics User’s Guide 27

Auxiliary Graphics: An Overview

Open - Sets the curve type to open. Closed - Sets the curve type to closed. Important
•

The following options appear on the Curve ribbon only when a curve or curve element is selected.

Previous Node - Activates the previous node on the curve. This button is available only when you have selected a curve to edit. Next Node - Activates the next node on the curve. This button is available only when you have selected a curve to edit. Symmetric - Gives a curve the same curvature on each side of the selected node. This button is available only when you have selected a curve to edit.

Smooth - Gives a curve a different curvature on each side of the selected node. The start point and end point of a curve is always a smooth node. This button is available only when you have selected a curve to edit.

28 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview

Cusp - Makes a curve bend sharply at the selected node. This button is available only when you have selected a curve to edit.

Draw an Ellipse by Defining Three Points
1. On the Draw toolbar, click Ellipse By 3 Points 2. Click the location to begin the primary axis. .

3. Click the location to end the primary axis. This action defines the length of the primary axis and the rotation angle.

4. Click a location on one side of the primary axis. This action defines the secondary axis.

Tip
•

The primary axis can be shorter than the secondary axis.

Notes
•

Instead of clicking to define the primary and secondary axes of an ellipse, you can type values on the ribbon. You can also use a combination of graphic and ribbon input. Instead of clicking several different points to draw an ellipse, you can draw a diagonal line, and the software automatically changes it to an ellipse. SmartPlant P&ID Auxiliary Graphics User’s Guide 29

•

Auxiliary Graphics: An Overview
•

You can use the options on the ribbon and the commands on the shortcut menu to edit an ellipse.

Related Topics • Ellipse by 3 Points Command, page 31

Draw an Ellipse by Center Point
1. On the Draw toolbar, click Ellipse by Center . 2. Click the location for the center of the primary axis. 3. Click the location to end the primary axis. This action defines the length of the primary axis and the rotation angle. 4. Click a location on one side of the primary axis. This action defines the secondary axis. Tip
•

The primary axis can be shorter than the secondary axis.

Notes
•

Instead of clicking to define the axes and rotation angle of the ellipse, you can type values on the ribbon. You can also use a combination of graphic and ribbon input. Instead of clicking several different points to draw an ellipse, you can draw a diagonal line and the software automatically changes it to an ellipse. You can use the options on the ribbon and the commands on the shortcut menu to edit an ellipse.

Ellipse by Center Point Command
Draws an ellipse using the center point and two edge points. The center point and the next point define half the length of the primary axis and the rotation angle. The last point defines the secondary axis. Related Topics • Draw an Ellipse by Center Point, page 30 • Drawing FreeForm Shapes: An Overview, page 35 • Drawing with Relationships: An Overview, page 90 • Ellipse by 3 Points Command, page 31 • Ellipse by Center Point Command, page 30

30 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Ellipse by 3 Points Command Draws an ellipse using three edge points. The first two points define the length of the primary axis and the rotation angle. The last point defines the secondary axis. Related Topics • Draw an Ellipse by Defining Three Points, page 29 • Drawing FreeForm Shapes: An Overview, page 35 • Drawing with Relationships: An Overview, page 90 • Ellipse by 3 Points Command, page 31 • Ellipse by Center Point Command, page 30 Ellipse Ribbon Style - Sets the drawing style. Line Color - Sets the drawing color. You can click More to define custom colors with the Colors dialog box. Line Type - Sets the drawing line type and style. Line Width - Sets the line width. Primary - Sets the length of the primary axis. The ellipse orientation is based on the primary axis.

Secondary - Sets the length of the secondary axis. The secondary axis is perpendicular to the primary axis. Angle - Sets the angle of the primary axis of the ellipse. Zero degrees is horizontal to the x axis. The angle increases in the counterclockwise direction. Related Topics • Draw an Ellipse by Center Point, page 30 • Draw an Ellipse by Defining Three Points, page 29 • Ellipse by 3 Points Command, page 31 • Ellipse by Center Point Command, page 30

SmartPlant P&ID Auxiliary Graphics User’s Guide 31

Auxiliary Graphics: An Overview

Drawing Squares, Rectangles, and Polygons: An Overview
To draw a rectangle or square, you click Rectangle on the Draw toolbar. Then, you click two different points to define the shape. If you want to precisely define dimensions, you can type values into the ribbon and press Enter.

If you place dimensions on a rectangle or square, these are always driven dimensions. This means that if you edit the value of the dimension, the object does not change. You need to edit the width and height values on the ribbon to change the dimensions of the rectangle or square. Also, you cannot ungroup a rectangle or square into individual lines. Tip
•

If you want to place a rectangle or square that has driving dimensions, you need to select Line/Arc Continuous on the Draw toolbar and place four separate lines in the shape of a rectangle or square.

You can use the Polygon and Polygon by Center , also on the Draw toolbar, to draw an n-side polygon. The default settings for both polygon commands are for drawing an isosceles triangle. However, you can use the options on the Polygon and Polygon by Center ribbons to specify the number of sides and dimension values. Each polygon that you draw is really an object of grouped lines. Consequently, once the polygon is drawn there is no way to modify its dimensions. You can, however, on the Relationships toolbar to separate the polygon into its use Ungroup individual linear elements. Related Topics • Draw a Rectangle or Square with FreeSketch, page 34 • Draw a Rectangle or Square, page 33 • Drawing Basic Elements: An Overview, page 9 • Rectangle Command, page 34 • Using Relationships as You Draw: An Overview, page 92

32 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview

Draw a Rectangle or Square
1. On the Draw toolbar, click Rectangle . 2. Click the location for one corner of the rectangle or square. 3. Click to define the rotation angle and the width of the rectangle or square. 4. Do one of the following:
• •

To draw a rectangle, click to define the height. To draw a square, hold the Shift key, and then click. The command automatically makes the height equal to the width.

Notes
•

Instead of clicking to draw the rectangle or square, you can type values in the Width, Height, and Angle boxes on the ribbon. You can also use a combination of graphic and ribbon bar input. Instead of clicking several different points to draw a rectangle, you can draw a diagonal line and the software automatically changes it to a rectangle.

•

•

You can use the options on the ribbon and the commands on the shortcut menu to edit a rectangle or square. If you place dimensions on a rectangle, they are always driven dimensions. You cannot ungroup a rectangle into individual lines.

• •

Related Topics • Rectangle Command, page 34

SmartPlant P&ID Auxiliary Graphics User’s Guide 33

Auxiliary Graphics: An Overview

Draw a Rectangle or Square with FreeSketch
1. On the Draw toolbar, click FreeSketch Tip
•

.

If FreeSketch is not displayed, click the Curve fly-out menu

and select it from the list. 2. On the ribbon, set the rectangle Element Type and clear the other Element Type buttons. 3. Drag the pointer to sketch the diagonal of the rectangle.

Notes
• •

Adjust allows the software to adjust the geometry that you draw. When Adjust is off, the software interprets the exact movements of your pointer. When Adjust is on, the software interprets the diagonal as a rectangle or square. You can use the buttons on the ribbon and shortcut menu to edit a rectangle or square.

•

•

Rectangle Command
Draws a rectangle using three points. The first two points define the width and rotation angle of the rectangle, and the third point defines the height. You can also draw a square with this command. Related Topics • Draw a Rectangle or Square, page 33 • Drawing Basic Elements: An Overview, page 9 • Drawing FreeForm Shapes: An Overview, page 35 • Drawing Squares, Rectangles, and Polygons: An Overview, page 32

34 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview

Rectangle Ribbon
Style - Sets the drawing style. Line Color - Sets the drawing color. You can click More to define custom colors with the Colors dialog box. Line Type - Sets the drawing line type and style. Line Width - Sets the line width. Width - Sets the width of the rectangle or square. Height - Sets the height of the rectangle or square. Angle - Sets the orientation angle of the element. Zero degrees is horizontal to the x axis. The angle increases in the counterclockwise direction. Related Topics • Draw a Rectangle or Square with FreeSketch, page 34 • Draw a Rectangle or Square, page 33 • Drawing Basic Elements: An Overview, page 9 • Rectangle Command, page 34 • Using Relationships as You Draw: An Overview, page 92

Drawing FreeForm Shapes: An Overview
As you draw, you can place precisely defined lines, arcs, and circles by clicking and typing values in the ribbon. You can also use tools to quickly sketch a design and let the software convert it into a precision drawing. FreeSketch and FreeForm allow you to quickly place fluid lines and let the software convert these into precision shapes. FreeSketch draws lines, arcs, circles, and rectangles, and FreeForm draws curves (splines).

SmartPlant P&ID Auxiliary Graphics User’s Guide 35

Auxiliary Graphics: An Overview You can begin sketching anywhere on the drawing sheet. You can draw in free space or use key points or end points of elements as reference points.

How FreeSketch and FreeForm Work As you drag the pointer, a rough sketch of your design appears. When you release the pointer, the software recognizes the shapes in your sketch and turns the sketch into a precise drawing. You can control the accuracy of the shape recognition using the ribbon options. FreeSketch and FreeForm Options FreeSketch Adjust controls how closely FreeSketch interprets mouse movements. When Adjust On is set, the software interprets all lines as either horizontal or vertical, and all arcs as tangent. The first figure shows how the software interprets a rough sketch when Adjust On is set.

The next figure shows how the software interprets a rough sketch when Adjust Off is set.

36 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview FreeForm Smoothing controls how closely the software interprets mouse movements when drawing curves. The first figure shows how FreeForm interprets a rough sketch when Smoothing On is set.

The next figure shows how the software interprets a rough sketch when Smoothing Off is set.

Draw a Line with FreeSketch
1. On the Draw toolbar, click FreeSketch . 2. On the ribbon, set the Line element type and clear the other element type buttons. 3. Drag to draw a line or a series of connected lines.

Notes
• •

Adjust allows the software to adjust the geometry that you draw. When Adjust is off, the software interprets the exact movements of your pointer. When Adjust is on, the software interprets the lines as horizontal or vertical when you finish drawing. The software recognizes relationships at the start point and end point of the line. When you set the Line and Arc element types, you can draw connected lines and arcs. You can use the options on the ribbon and the commands on the shortcut menu to edit a line.

•

•

•

•

SmartPlant P&ID Auxiliary Graphics User’s Guide 37

Auxiliary Graphics: An Overview

Draw a Circle with FreeSketch
1. On the Draw toolbar, click FreeSketch 2. On the ribbon, set the Circle element type and clear the other element type buttons. 3. Drag to sketch the shape of the circle or the diameter of the circle.

Notes
• •

Adjust allows the software to adjust the geometry that you draw. When Adjust is off, the software interprets the exact movements of your pointer. When Adjust is on, the software interprets your pointer movements as a circle. You can use the options on the ribbon and the commands on the shortcut menu to edit a circle.

Draw an Arc with FreeSketch
1. On the Draw toolbar, click FreeSketch 3. Drag to draw an arc. .

2. On the ribbon, set the Arc element type and clear the other element type buttons.

Notes
•

Adjust allows the software to adjust the geometry that you draw.

38 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview
•

When Adjust is off, the software interprets the exact movements of your pointer. When Adjust is on, the software interprets arcs as tangent to the connected elements. The software recognizes relationships at the start point and end point of the arc. When you set the Line and Arc element types, you can draw connected lines and arcs. You can use the options on the ribbon and the commands on the shortcut menu to edit an arc.

Draw a Rectangle or Square with FreeSketch
1. On the Draw toolbar, click FreeSketch Tip
•

.

If FreeSketch is not displayed, click the Curve fly-out menu

and select it from the list. 2. On the ribbon, set the rectangle Element Type and clear the other Element Type buttons. 3. Drag the pointer to sketch the diagonal of the rectangle.

Notes
• •

Adjust allows the software to adjust the geometry that you draw. When Adjust is off, the software interprets the exact movements of your pointer. When Adjust is on, the software interprets the diagonal as a rectangle or square. SmartPlant P&ID Auxiliary Graphics User’s Guide 39

•

Auxiliary Graphics: An Overview
•

You can use the buttons on the ribbon and shortcut menu to edit a rectangle or square.

Smooth allows the software to adjust the geometry that you draw. When Smooth is off, the software interprets the exact movements of your pointer. When Smooth is on, the software creates smooth, symmetric, or cusp curves. You can begin or end your drawing using the end point or key point of an element. You can use Insert Node on the shortcut menu to add nodes to a curve. You can use Delete Node on the shortcut menu to delete nodes from a curve. You can use the options on the ribbon and the commands on the shortcut menu to edit a curve.

FreeSketch Command
Draws lines, arcs, rectangles, and circles by converting a sketch into a precision drawing. You can specify which of these elements you want to draw using the ribbon. Related Topics • Draw a Circle with FreeSketch, page 38 • Draw a Line with FreeSketch, page 37 • Draw a Rectangle or Square with FreeSketch, page 34 • Draw an Arc with FreeSketch, page 38

40 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview

FreeSketch Ribbon
Style - Sets the drawing style. Line Color - Sets the drawing color. You can click More to define custom colors with the Colors dialog box. Line Type - Sets the drawing line type and style. Line Width - Sets the line width. Adjust On - Draws all lines recognized in the rough sketch as horizontal or vertical in the precision drawing, and draws all arcs recognized in the rough sketch as tangent in the precision drawing. Adjust Off - Does not adjust the orientation of lines and arcs in your rough sketch. Line - Draws lines in the precision drawing by recognizing them in the rough sketch. Arc - Draws arcs in the precision drawing by recognizing them in the rough sketch. Circle - Draws circles in the precision drawing by recognizing them in the rough sketch. Rectangle - Draw rectangles in the precision drawing by recognizing them in the rough sketch. Related Topics • Drawing Basic Elements: An Overview, page 9 • Using Relationships as You Draw: An Overview, page 92

FreeForm Ribbon
Style - Sets the drawing style. Line Color - Sets the drawing color. You can click More to define custom colors with the Colors dialog box. Line Type - Sets the drawing line type and style. Line Width - Sets the line width. Smoothing On - Draws cusp, smooth, and symmetric curves in the precision drawing by recognizing these shapes in the rough sketch. Smoothing Off - Draws elements that closely resemble the movements of your pointer, without smoothing them into cusp, smooth, and symmetric curves. Related Topics • Draw a Curve with FreeForm, page 40 • Drawing Basic Elements: An Overview, page 9 • FreeForm Command, page 41 • Using Relationships as You Draw: An Overview, page 92

42 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview

Selecting, Moving, and Copying Elements: An Overview
The software provides several simple methods for utilizing existing elements. You can quickly move or copy an existing element or group of elements onto a drawing sheet. Moving or copying elements saves you time by eliminating the need to recreate information, as well as help you maintain accurate graphic data throughout a project. Selecting Elements You can select individual or multiple elements using the Select Tool on the Draw toolbar. When you click the Select Tool, the pointer changes to an arrow with a locate zone indicator at the end. As you move the pointer, any element that the locate zone passes over is displayed in the highlight color. When an element is highlighted you can click to select it. You can select more than one element at a time by clicking the Select Tool and then holding the Shift or Ctrl key as you click the elements you want to select. Or, you can click the Select Tool and then drag the mouse to fence elements. You can also use a tool called PickQuick to select elements that overlap. To use it, you should move the Select Tool pointer over the elements, and pause the mouse. When an ellipsis displays you can left-click or right-click to display the number of selectable elements. You can move the pointer over the numbers; when the element that you want highlights, you can click on the corresponding number to select it. Moving Elements The software provides several methods for moving elements. You can drag an element with the Select Tool or specify precision points with Move on the Change toolbar. You can also use PinPoint with the Select Tool to move an element a precise distance in X and Y relative to a known position on your drawing. Copying Elements You can copy elements with one of many methods:
•

You can select an object and click Copy on the Main toolbar. The selected item is placed on the Clipboard. Then, when you click Paste on the Main toolbar, the item is placed on the drawing sheet. The element will not change from its original form. You can copy one or more elements by clicking the Select Tool on the Draw toolbar. After the pointer changes to show that the element can be copied, hold the Ctrl key and drag the copy to its new location.

•

SmartPlant P&ID Auxiliary Graphics User’s Guide 43

Auxiliary Graphics: An Overview
•

Formatting, such as line weight, line color, and line style, can be copied from selected objects and applied to other objects as they are selected using Format Painter on the Main toolbar. You can make several copies of elements that are the same by selecting the element and clicking Rectangular Pattern or Circular Pattern on the Change toolbar. You can also click Offset, Move, Scale, or Rotate on the Change toolbar to create copies.

•

•

Cutting and Deleting Elements You can cut an element by clicking Cut on the Main toolbar. The element is placed on the Clipboard. You can then use Paste to place the element in the current document or into other documents. Important
•

If you do not Paste the element after cutting, it will be permanently removed from the document.

You can permanently remove an element by selecting the element and pressing Delete on your keyboard. You can also permanently remove an element by clicking Edit on the Main toolbar and then selecting Delete. Related Topics Copying and Pasting Elements: An Overview, page 54 • Creating Patterns: An Overview, page 59 • Cutting or Deleting Elements: An Overview, page 63 • Moving Elements: An Overview, page 51 • Selecting Elements: An Overview, page 45
•

44 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview

Selecting Elements: An Overview
To select an element, you must use Select Tool at the top of the Draw toolbar. You can select lines, arcs, or annotations, such as dimensions or fills. You can also select element groups, embedded or linked objects, symbols, or handles on elements that indicate relationships. Selecting Single Elements To select an element, you can click the Select Tool on the Draw toolbar.

When you click Select Tool, the pointer changes to an arrow with a locate zone indicator at the end. As you move the pointer, any element that the locate zone passes over is displayed in the highlight color. When an element is highlighted, you can click to select it.

When you select an individual element, the following things happen:
•

The element changes to the selection color. You can change the selection color using Options on the Tools menu. The element's handles are displayed. Handles are solid squares at significant positions on a selected element, such as end points and center points. Handles allow you to directly modify the element — drag a handle to change the element's shape. Although you can select more than one element at a time, only one element can have handles at a time. The element's important properties are displayed on a ribbon. If the element is linked or embedded into the current document, selecting it allows you to double-click it for editing.

•

• •

When you select multiple elements or grouped elements, they change to the selection color. Selecting Multiple Elements You can select more than one element at a time by clicking the Select Tool and then holding the Shift or Ctrl key as you click the elements you want to select. Or, you can click the Select Tool and then drag the mouse to fence elements. You can use the ribbon to select whether you want only elements completely enclosed by the fence to be selected or any element that is partly enclosed by the fence. Many manipulation commands, like delete, move, copy, and rotate, act upon all elements in the selection set.

SmartPlant P&ID Auxiliary Graphics User’s Guide 45

Auxiliary Graphics: An Overview Selecting an Element That Overlaps Other Elements If you want to select an element that overlaps other elements, and you cannot highlight the element you want by moving the pointer over it, you can use a tool called PickQuick. To use it, you should move the pointer over the elements and pause the mouse. When the software displays an ellipsis, or three small circles, by the pointer, you can left-click or right-click to display a small toolbar that shows the number of selectable elements. You can move the pointer over the numbers; and, when the element that you want highlights, you can click on the corresponding number to select it.

Deselecting Elements To deselect an element or group of elements, you can click any point on the drawing sheet. Related Topics Copy an Element with the Select Tool, page 55 • Move an Element with the Select Tool, page 53 • Redo Actions, page 48 • Select an Element, page 46 • Undo Actions, page 48
•

Select an Element
1. On the Main toolbar, click Select Tool. 2. Do one of the following:
• •

To select one element, click it. To select more than one element hold the Shift or Ctrl key and click each element. To select more than one element at once, drag to fence the objects. To select one of several overlapping elements, use PickQuick. To select all elements, click Ctrl + A or right-click in the Drawing sheet and click Select All.

• • •

46 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview To select an element with PickQuick PickQuick helps you to select elements that overlap each other. 1. Position the pointer over the element you want to select and pause the pointer there. 2. When the pointer changes to an ellipsis (three dots), click. The software displays the PickQuick toolbar near the pointer, with a button for each selectable element.

3. Move the pointer over PickQuick without clicking to highlight the corresponding elements.

4. When the element you want to select is highlighted, click the corresponding button on the PickQuick toolbar. To clear a selection Do one of the following:
• • • •

Click in free space. Right-click in free space. Select another element without holding the Shift or Ctrl key. To clear the selection of one element and leave other elements selected, click the element while holding the Shift key. Notes

•

When the Select Tool is active, selectable elements highlight as you pass the pointer over them. When the element you want to select is highlighted, click to select it. You can use the ribbon commands to set element selection options.

•

SmartPlant P&ID Auxiliary Graphics User’s Guide 47

Auxiliary Graphics: An Overview
•

You can change the element highlight and selection colors with Options on the Tools menu.

Select Tool
Changes the pointer to the arrow-shaped selection pointer so that you can select, modify, and manipulate elements. The circle at the end of the pointer arrow is the locate zone. Related Topics • Copy an Element with the Select Tool, page 55 • Move an Element with the Select Tool, page 53 • Selecting Elements: An Overview, page 45

Select Tool Ribbon
The default selection ribbon is displayed only when nothing is selected. Once you select an object, the selection ribbon is replaced with a ribbon bar for editing the selected object. Tip
•

To find out the name of an option on the ribbon, pause the pointer over an option and read the ToolTip. Inside - Specifies that elements inside the fence 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. Expand - Displays another ribbon depending on the items that you selected on the drawing sheet. This button appears when you select ten or more items on the drawing sheet. When you click it, another ribbon appears. The options that appear depend on the types of elements that you selected. For example, if you select eleven lines, then the Line ribbon appears. If you select several types of items, then only the common properties for those types of elements appear on the Select Tool ribbon. For example, if you select nine lines and a circle, then the ribbon displays the Style, Line Type, Width, and Color options. For more information about the options that appear, see the Help topic for the selected element's ribbon.

SmartPlant P&ID Auxiliary Graphics User’s Guide 49

Auxiliary Graphics: An Overview If the items that you selected have no common properties, then no options will appear if you click Expand. For example, if you select a dimension and ten lines and then click Expand, a ribbon does not appear. Related Topics • Copy an Element with the Select Tool, page 55 • Move an Element with the Select Tool, page 53 • Select an Element, page 46 • Select Tool, page 49

Moving Elements: An Overview
You can move elements on the drawing sheet with one of several methods:
• •

Dragging elements with the Select Tool. Specifying precision points with Move on the Change toolbar. Tip

•

You can also click Scale and Rotate on the Change toolbar to move elements.

Using the Select Tool To move an element, you must first select it with Select Tool on the Draw toolbar. You can drag the selected element to move it without changing its shape.

Tip
•

The element's handles do not need to be displayed for you to move it. If they are displayed, and you want to move the element and not modify it, position the pointer so it is not over a handle.

You can move an element with precision if you use the relationships indicators.

When you modify a drawing, elements with maintained relationships automatically update to honor the relationship. For example, if you move an element that shares a maintained parallel relationship with another element, the other element moves as needed to remain parallel. If a line and an arc share a maintained tangent relationship, they remain tangent when either is modified.

SmartPlant P&ID Auxiliary Graphics User’s Guide 51

Auxiliary Graphics: An Overview Moving Elements by Specifying Precision Points You can move a line that shares a tangent relationship with an arc if you select the line and click Move on the Change toolbar. As you move the line, the line moves without maintaining the relationship with the arc. You can then specify a from point and a to point by clicking on the drawing sheet or by entering values in the ribbon. You can move any element by specifying precision points with Move. Related Topics • Drawing Basic Elements: An Overview, page 9 • Move an Element with the Select Tool, page 53 • Move an Element, page 52

Move an Element
1. Select one or more elements. 2. On the Change toolbar, click Move 4. Click to define the from point. 5. Click to define the to point. After the elements move, the relationships with other elements are not maintained. Notes
• •

.

3. If you want to copy the elements, click Copy on the ribbon.

You can click Move before you select elements to move. Using the Move command on the Change toolbar will break any relationships the element may have. You must move an element with the Select Tool to maintain its relationships. Instead of using Copy on the ribbon to copy elements, you can hold Ctrl while you click to position the elements. You can use the ribbon boxes to specify the to point. The values are relative distances along the x and y axes. You must click to specify to which quadrant you want to move or copy the selection set. When you move or copy elements, the to point becomes the next from point. The software maintains relationships within the select set if they are still applicable after you have moved or copied the elements. You can use other view manipulation commands, such as Zoom, Fit, and Pan, while you are using Move. When you finish manipulating the view, the software returns you to Move at the point where you left off.

•

•

•

•

•

•

52 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview

Move an Element with the Select Tool
1. On the Main toolbar, click Select Tool. 2. Position the pointer over the element, but not over any of the element's handles. 3. Drag the element to its new position. To move an element with precision 1. On the Main toolbar, click Select Tool. 2. Position the pointer over the element you want to move, at a location where the software recognizes a key point. 3. Begin to drag the element. 4. Release the element when the software recognizes the key point of another element, or a relationship between the element you are moving and another element. Notes
•

If you want to move a selected element, make sure to position the pointer away from any of the element's handles. Dragging a handle modifies the element instead of moving it.

Move Command
Moves elements from one location to another. You can specify the locations by clicking on the drawing sheet or by entering values in the ribbon. You can move one or more elements at a time, and you can move element groups. Related Topics Move an Element, page 52 • Moving Elements: An Overview, page 51
•

SmartPlant P&ID Auxiliary Graphics User’s Guide 53

Auxiliary Graphics: An Overview

Move Ribbon
Specifies the from point and to point when you move objects or elements. X - Sets a value for the x coordinate. You can use this option by itself or with the Y option. Y - Sets a value for the y coordinate. You can use this option by itself or with the X option. Copy - Copies the elements in the selection set. Step Value - Increments or decrements the value displayed in the ribbon boxes. For example, typing a step value of 0.25 and moving the pointer away from the from point would increment the distance from 0.25 to 0.5, 0.75, and so forth. Related Topics • Move an Element, page 52 • Move Command, page 53

Copying and Pasting Elements: An Overview
You can copy any element, dimension, or object by selecting it and clicking Copy on the Main toolbar. Copying places the selected item on the Clipboard. When you click Paste on the Main toolbar, the item is placed on the drawing sheet. You can also copy an element with the Select Tool. You click the Select Tool on the Draw toolbar, select the element, and press Ctrl as you drag the element across the drawing sheet. You can also copy several selected elements in the same manner. When you copy elements that have relationships, the relationships are copied and retained when possible. For example, if you make a copy of two related lines, the relationship is also copied. However, if you copy one of two lines that are related to each other, the relationship is not copied. Related Topics • Copy an Element with the Select Tool, page 55 • Copy an Element, page 55 • Paste an Element, page 56

54 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview

Copy an Element
1. Select an element. 2. On the Main toolbar, click Copy Tip
•

.

You can also click Ctrl + C to copy the selected element.

Notes
•

After you copy an element and its relationships, they are placed on the Clipboard. You can then use Paste to paste them into the current document, or into other documents. When you paste the element, it is pasted on top of the element you copied. To see the pasted element, you must drag it.

Copy an Element with the Select Tool
1. On the Draw toolbar, click Select Tool 2. Select one or more elements. 3. Position the pointer over the element, but not over any of the element's handles. The pointer changes to show that the element can now be copied. 4. Hold the Ctrl key and drag the copy to its new location. Related Topics • Copy Command (Main Toolbar), page 56 • Copying and Pasting Elements: An Overview, page 54 • Select All Command (Edit Menu), page 50 • Select Tool, page 49 • Selecting Elements: An Overview, page 45 .

SmartPlant P&ID Auxiliary Graphics User’s Guide 55

Auxiliary Graphics: An Overview

Paste an Element
You can place elements on the Clipboard with Copy or Cut, then paste the elements into the current document or another document. 1. Open the document in which you want to paste the contents of the Clipboard. 2. On the Main toolbar, click Paste Tip
•

.

You can also press Ctrl + V to paste elements on the Clipboard into your document.

Notes
•

The contents of the Clipboard remain unchanged until you use Copy or Cut again. You cannot run Paste if the Clipboard is empty. You can use Undo to reverse the results of Paste. If you are unable to see the symbol, element, fill, or document that you pasted into your SmartSketch drawing, click Fit on the Main toolbar Pasted text and elements remain selected after you use Paste.

Copy Command (Main Toolbar)
Copies selected elements and their associated relationships to the Clipboard. When you use this command, it replaces the previous contents of the Clipboard with the new contents. When you copy more than one element at a time, all relationships shared among the elements are also copied. However, when you copy an element that shares a relationship with an element that you are not copying, the relationship is not copied. Tip
•

Paste Special Dialog Box
Inserts the Clipboard contents into a document using a selected format. Tip
•

To get Help for various items on the dialog box, click the Question Mark in the upper right corner of the dialog box and click the control that you want information about.

Related Topics • Copying and Pasting Elements: An Overview, page 54

Offset Command
Draws an offset copy of an element or a set of contiguous elements. This command copies elements while maintaining characteristics such as the angle of lines and the center point of arcs and circles. Offset copies the original element at a specified distance. Offsetting outside the perimeter of the original element creates a larger element. Offsetting inside the perimeter of the original element creates a smaller element.

SmartPlant P&ID Auxiliary Graphics User’s Guide 57

Auxiliary Graphics: An Overview Elements are transitioned as necessary during the offset operation.

Related Topics • Copying and Pasting Elements: An Overview, page 54

Offset Ribbon
Select Chain - Selects a chain of continuous elements. If this option is not selected, Offset selects only an individual element. Step Distance - Sets the distance from the base element to the offset copy. Cumulative Offset - Sets the total distance of the current offset graphic element from the original graphic element. The following graphic illustrates the difference between step distance (A) and cumulative offset (B).

Creating Patterns: An Overview
Patterns are useful if you want to create several elements quickly that are the same without using several commands. You can create patterns by selecting one or more elements and making several copies of it with Rectangular Pattern or Circular Pattern on the toolbar.

To modify individual members of the pattern, you can select an individual member of the pattern and change it the way you would any other element. Related Topics • Circular Pattern Command, page 60 • Draw a Circular Pattern, page 59 • Draw a Rectangular Pattern, page 60 • Rectangular Pattern Command, page 62

Draw a Circular Pattern
1. Select one or more elements to pattern.

2. On the Change toolbar, click Circular Pattern

.

3. Click where you want the center of the circular pattern to be. 4. Use the ribbon boxes and the Circular Pattern Options dialog box to define other characteristics of the pattern, such as the number of pattern members and rows. 5. To finish creating the pattern, click Finish on the ribbon.

Notes
•

If you do not like the results of the pattern, you can use the Undo command.

3. To define a rectangular area for the pattern, click Pattern Options on the ribbon. 4. On the Rectangular Pattern Options dialog box, select Fit to Rectangle. Tip Use the ribbon boxes and the Rectangular Pattern Options dialog box to define other characteristics of the pattern, such as the number of pattern members and rows. 5. On the drawing sheet, click to identify one corner of the pattern and click to identify the opposite corner of the pattern.
•

6. To finish creating the pattern, click Finish on the ribbon.

Notes
•

If you do not like the results of the pattern, you can use the Undo command.

Circular Pattern Ribbon
Options - Displays the Circular Pattern Options dialog box. Count - Sets the number of copies in the pattern. Rows - Sets the number of arc-shaped rows in the pattern. This option is available only when Rows on the Circular Pattern Options dialog box is set to Multiple Inward or Multiple Outward. Angle - Sets the angle of the pattern. This box sets the sweep angle between pattern members when Pattern Control on the Circular Pattern Options dialog box is set to Incremental Array. This box also sets the total sweep angle when Pattern Control is set to Fit To Arc. Row Spacing - Sets the distance between adjacent arc-shaped rows in the pattern, as measured from the bottom of one row to the bottom of the next. The bottom is the side closest to the center point of the circular pattern. Related Topics Circular Pattern Command, page 60 • Draw a Circular Pattern, page 59
•

Rectangular Pattern Ribbon
Options - Displays the Rectangular Pattern Options dialog box. X count - Sets the number of pattern members along the x axis of the pattern rectangle. Y count - Sets the number of pattern members along the y axis of the pattern rectangle. X offset - Sets the distance between adjacent rows in the pattern, measured along the x axis of the pattern rectangle. Y offset - Sets the distance between adjacent rows in the pattern, measured along the y axis of the pattern rectangle. Angle - Sets the rotation angle of the pattern rectangle. Finish - Completes the pattern. When you click this button, the pattern is created on the drawing sheet and you can select other elements. Related Topics • Rectangular Pattern Command, page 62

Incremental Array - Draws a pattern with a set offset between members. Fit To Rectangle - Draws a pattern by evenly spacing members along the x and y axes of the pattern rectangle.

Stagger - Controls whether pattern members are arranged in a straight matrix, or whether every other row or column is offset from its default position. Options are None, for a straight matrix, Rows, to offset alternate pattern rows, and Columns, to offset alternate pattern columns. Stagger - Sets the row or column stagger distance to the specified distance. 62 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Stagger = 1/2 Offset - Sets the row or column stagger distance to half the X Offset or Y Offset value. Include Last Column - Controls whether to include the last staggered column in the pattern or to exclude the last column. Preview - Displays the range of the graphic to print on the printer paper. Related Topics Rectangular Pattern Command, page 62

•

Cutting or Deleting Elements: An Overview
You can delete elements by selecting them and clicking Cut on the Main toolbar or by pressing Delete. Clicking Cut allows you to paste the element in another location. Pressing Delete removes the element permanently. Relationships that are no longer applicable after you delete an element are automatically deleted. For example, if you delete one of a pair of parallel lines, the parallel relationship is deleted from the remaining line.

Cut an Element
1. Select an element. 2. On the Main toolbar, click Cut Tip
•

.

You can also press Ctrl + X to cut the selected element.

Notes
•

After you cut an element and its relationships from a document, they are placed on the Clipboard. You can then use Paste to paste them into the current document, or into other documents.

SmartPlant P&ID Auxiliary Graphics User’s Guide 63

Auxiliary Graphics: An Overview
•

When relationships exist between elements, cutting the elements from a document deletes the relationships. If there is a relationship between a selected element and an unselected element, you can do one of the following: Cut and paste only the selected element. Cut and paste both elements and their relationship. Cut and paste only the selected element and the relationship, then reconnect the relationship to another element.

When you delete an element and its relationships, the relationships are not pasted to the Clipboard and cannot be reinserted. However, you can restore an element and its relationships by immediately using Undo.

Delete Command (Edit Menu)
Deletes the selected element and any relationships and dimensions that have been placed on it. You cannot reinsert or paste elements deleted with this command. However, you can retrieve the data by immediately clicking Undo. Related Topics • Cutting or Deleting Elements: An Overview, page 63 • Delete an Element, page 64 • Selecting Elements: An Overview, page 45

SmartPlant P&ID Auxiliary Graphics User’s Guide 65

Auxiliary Graphics: An Overview

Adding Text to Documents: An Overview
You can add text to documents using different types of tools:
•

Annotations, such as text boxes and balloons.

You also can add text using a drag-and-drop operation. For example, you can drag an Excel spreadsheet to a document to create a bill of materials. Related Topics • Create a Text Label, page 87 • Engineering Fonts, page 89 • Place a SmartLabel, page 88 • Place a Text Box, page 69

Placing Annotations: An Overview
An essential part of the drawing process is adding text, notes, and annotations. Annotations are text and graphics that give information about a drawing. You can add this information quickly and easily with the text and annotation commands in the software. To place annotations in a document, you can click one of the following buttons:
•

Text Box on the toolbar

•

Balloon on the toolbar

66 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Annotations with Leaders When you create a balloon, you can place it with a leader by setting options on the ribbon. The leader can point to another element or be placed in free space. Annotations with leaders have the following components:

(A) Leader line (B) Break line (C) Graphic end (D) Annotation You can manipulate the annotation by selecting the leader and moving parts of it. You can control the display of a leader break line and the graphic end and insert or delete vertices on a leader. Adding Leaders You can add a leader to an annotation using Leader on the Dimension toolbar. All leaders have two ends - the notation end and the graphic end. The notation end, or the end that describes something, is often attached to a text box or the annotation itself; the graphic end is the end near the object being described and frequently has a terminator arrow or free-space dot on it. An annotation can have more than one leader. The graphic end of the annotation can point to an element or be placed in free space. The notation end of a new leader must connect to an annotation or the leader on an annotation.

SmartPlant P&ID Auxiliary Graphics User’s Guide 67

Auxiliary Graphics: An Overview You can create a callout by placing a text box and adding a leader to it with Leader .

Annotations and Associations Annotations can be associative or non-associative. An associative annotation moves when its associated element moves. Text boxes differ from the other annotations in that they are always non-associative. If you attach the terminator of a leader to an element, the annotation moves with the element.

If you point the graphic end of a leader to free space, the annotation is not associative to any element in the drawing. To make an annotation associative, you can select the graphic end of the leader and drag it to an element. Formatting Annotations You can format an annotation several ways. If you want several annotations to look the same, you can apply a style by selecting it on the ribbon. You can apply dimension styles to balloons, but not text boxes. You can apply text styles to text boxes. Tip
•

If you want to format an existing balloon, you must click the balloon leader to select the balloon. Then, you can change the formats of the balloon.

If you want annotations to look unique, you can select an annotation and edit its properties with the ribbon or with Properties on the Edit menu. Related Topics Move an Annotation, page 70 • Place a Text Box, page 69
•

68 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview

Place a Text Box
1. On the Draw toolbar, click Text Box . 2. To place a text box, drag to define the location and size of the text box. To see the text box, begin typing text. Important
•

When you place text by this method, the width measures exactly between the two points. Text is wrapped, if necessary. The height measures at least the height between the two points. If necessary, the height of the text box increases to fit all of the text.

•

Notes
•

To place a text box, you can also click a point, and begin typing text. When you place text by this method, the height and width are set to Auto mode. The size of the text box increases automatically to contain all of the text. The text does not wrap. You can also place a text box by double-clicking any element. A blinking pointer appears below or in the center of the element. You can press Enter to create a new line in a text box. When you are in edit mode, a border appears around the text box. To place a callout, you can add a leader to the text box using Leader on the Dimension toolbar.

Move an Annotation
1. Select an annotation to display its handles. As you move the pointer over the parts of the annotation, the pointer changes to show whether you are on a part of the annotation or a handle.

2. Click a handle and drag the leader or annotation to its new location. The previous procedure describes the general steps you can use to move an annotation. The following descriptions explain how to move specific parts of an annotation. To move a terminator
•

When a terminator is connected to an element, drag the terminator handle to a new location along the element. If you drag the handle off the end of an open element, such as a line, an extension line automatically appears. The annotation and break line do not move.

70 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview
•

When a terminator is connected to an element, disconnect the terminator by holding the Alt key while you drag the terminator handle. The terminator type automatically changes to the active setting for a terminator in free space.

•

To reconnect a terminator to an element, drag the terminator handle to an element. The terminator type automatically changes to the active setting for a terminator connected to an element. Click a leader line and then drag the break line of a leader. The break line and annotation move and the leader line changes in length, but not orientation.

To move a leader line
•

•

If a leader was placed with the Leader command, you can move the leader away from the annotation and attach it to another annotation or element. Click the leader line and then drag the handle to the annotation or leader that you want to connect to.

SmartPlant P&ID Auxiliary Graphics User’s Guide 71

Auxiliary Graphics: An Overview To move a handle Click a leader line and do one of the following:
•

Drag the handle closest to the annotation to move the annotation.

•

Drag the handle on a break line to move the leader line and annotation.

Apply a Border to a Text Box
1. Select the text box to which you want to apply a border. 2. On the shortcut menu, click Properties. 3. On the Border and Fill tab of the Text Box Properties dialog box, set the options for the type of border that you want. Notes
•

You can also apply a border by selecting a text box and clicking Border on the ribbon. To see a text box border that is greater than 2 mm, set Display As Printed on the View tab of the Options dialog box.

Insert a Font Character into a Text Box
1. On the Draw toolbar, click the Text Box button and place a text box. . 2. On the Dimension toolbar, click Character Map 4. Click Select. 5. Continue to click the characters you want, clicking Select after you click each character. 6. On the Unicode Character Map dialog box, click Copy to copy the characters to the Clipboard. 7. Click inside the text box where you want to paste the characters. 8. Press Ctrl-V to paste.

3. On the font character chart, click the character you want to insert.

Border - Displays three options for setting borders. These options allow you to either display no border, display a border, or display a border with a shadow. More - Displays more options on the ribbon. Height - Sets the height of the text box. Width - Sets the width of the text box. Notes
•

If you select text in the text box, Height and Width are not available because the text is driving the dimension. If you select a text box and Height is not available, the text is driving Height with Auto Save. The same is true for Width. If you place a text box with a single point, both Height and Width are not available. If you drag a text box, Width is not available.

•

•

Angle - Sets the angle of the text box. Horizontal Text Orientation - Specifies that the text is oriented horizontally on or in the document. Vertical Text Orientation - Specifies that the text is oriented vertically on or in the document. Left To Right - Specifies that the characters in a text box are displayed from left to right, as you would see in an English paragraph. Right To Left - Specifies that the characters in a text box are displayed from right to left, as you would see in an Arabic or Japanese paragraph. Related Topics Apply a Border to a Text Box, page 73 • Format a Text Box, page 184 • Place a Text Box, page 69 • Resize a Text Box, page 74 • Text Box Command, page 75
•

Auxiliary Graphics: An Overview Border and Fill Tab Border - Specifies the appearance of a border around a text box. Border type - Sets the shape of the border around a text box. You can choose from a selection of common geometric shapes. Show border - Displays the outline of the text box. Line style - Sets the line style for the text box. Border color - Sets the color of the border. Line width - Specifies the width of the border in paper or world units of the text box. Paragraph separators - Places a horizontal line between each paragraph in a text box. This option is only available if Show Border is selected. A paragraph is defined by a carriage return within the text body. Using the carriage return as the sole means to create a new line of text will result in a text object with many lines as shown in the following illustration:

As an alternative for controlling auto returns within the text body, you can restrain the width of the box during placement or through the Text Box Properties dialog box. Shadow - Places a shadow around the borders of text in a text box. Shadow offset - Specifies a distance to offset the shadow in paper or world units of the text box. Fill color - Displays the color of a solid fill on an element boundary. This value overrides the style of the fill. Transparent is the default. When you set the fill color to transparent, no fill is visible on the boundary. You can also apply a fill color option with a fill pattern. Filled elements always cover other elements when they overlap. A fill color always appears behind the fill pattern when you apply both to the same boundary. Related Topics • Apply a Border to a Text Box, page 73 • Edit a Text Box, page 74 • Format a Text Box, page 184 • Insert a Font Character into a Text Box, page 74 • Text Box Properties Dialog Box, page 76

SmartPlant P&ID Auxiliary Graphics User’s Guide 77

Auxiliary Graphics: An Overview Info Tab Sheet - Shows the drawing sheet for an element. Layer - Shows the layer on which an element appears in a drawing sheet. Origin - Specifies the coordinates, or location, of a text box along the x and y axes. Tip
•

All metrics on the text box are either in paper units or world units except origin. Origin is always in world units.

Width - Sets the width of the text box to either At Least (at least the value you specify), Auto (the text drives the width), or Exactly (exactly at the value you specify) in the At: field. Height - Sets the height of the text box to either At Least (at least the value you specify), Auto (the text drives the height), or Exactly (exactly at the value you specify) in the At: field. Angle - Sets the angle of the text box. Tip
•

The text box always rotates about the origin.

Text Orientation - Sets the orientation of the text either horizontally or vertically. Units Space - Sets the text box units to either paper units or to world units. Paper units represent units on an actual sheet of paper. Paper units are set in inches. Other units are also available. World units indicate real world distances, but can be scaled down to fit a sheet of paper. Note
•

Within the drawing environment, "world units" is synonymous with the term "model units" found in other CAD packages.

Text Flow - Determines the direction in which the characters are displayed in a text box. Left To Right - Specifies that the characters in a text box are displayed from left to right, as you would see in an English paragraph. Right To Left - Specifies that the characters in a text box are displayed from right to left, as you would see in an Arabic or Japanese paragraph.

78 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Justification - Specifies the placement relationship between the origin and the shape (text box) according to the horizontal and vertical components. The inside text area is an area that the margins of the text box define. That is, margins are inside the outside edges of the text box. The following graphic illustrates top (1), right (2), bottom (3) and left (4) margins around the text box for horizontal justification (A) and vertical justification (B).

The maximum cap height of the first formatted text line of each line defines the text area capline, even if the line has been clipped out of the text box. The line baseline is a font metric that describes an imaginary line for location of characters. The largest descender for any font on the line defines the baseline. Therefore, the largest descender of the fonts used on the last line defines the text area baseline, even if the line is clipped out of the text box. The following graphic illustrates text cap area (a) and text baseline (b) for horizontal justification (A) and vertical justification (B).

You must define horizontal and vertical components together. These components apply to both single-line and multi-line text. For multi-line text, the cap height of the first line is used for the capline of the text, and the descender of the last line is used for the baseline of the text.

SmartPlant P&ID Auxiliary Graphics User’s Guide 79

Auxiliary Graphics: An Overview Horizontal - Specifies horizontal placement at six options based on shape (text box), text area, and the text within the text box at left, center, and right positions. Vertical - Specifies vertical placement at 10 options based on shape (text box), text area, and the text within the text box. Text Baseline - Specifies the text area baseline. Text Top - Specifies the top of the text area, which begins at the bottom of the top margin. Text Capline - Specifies the text area capline. Text Half Ascender - Specifies half the distance from the text area baseline to the top of the text area. Text Half Cap - Specifies the distance half way between the text area capline and baseline. Text Center - Specifies the center of the text area. Text Bottom - Specifies the bottom of the text area. Shape Top - Specifies the top edge of the shape. Shape Center - Specifies center of the shape. Shape Bottom - Specifies the bottom of the shape. Text Alignment - Specifies the placement of formatted text within the shape (text box). You must define horizontal and vertical components together. Horizontal - Specifies how each paragraph is aligned within the block of formatted text. Values for horizontal alignment include Left, Center, and Right. If Text Orientation is horizontal, you modify all the paragraph alignment properties for all paragraphs within the text box. (These properties appear in the Text Alignment area of the Info tab.) If Text Orientation is vertical, you modify the shape alignment properties. (These properties appear in the Text Alignment area of the Info tab.) Vertical - Places the block of formatted text at Top, Center, Bottom, or Justify area of the text box. If Text Orientation is horizontal, you modify the shape alignment properties. (These properties appear in the Text Alignment area of the Info tab.)

80 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview If Text Orientation is vertical, you modify all the paragraph alignment properties for all paragraphs within the text box. (These properties appear in the Text Alignment area of the Info tab.) Horizontal Paragraph Alignment Properties Left - Places the edge of the first line of text at the left of the text area. Center - Places the formatted text in the center of the text area. Right - Places the formatted text in the right of the text area. Vertical Paragraph Alignment Properties Top - Places the edge of the first line of text at the top of the text area. Center - Places the formatted text in the center of the text area. Bottom - Places the formatted text in the bottom of the text area. Shape Alignment Properties Positions the text within the text area. Top - Places the edge of the first line of text at the top of the text area. Center - Places the formatted text in the center of the text area. Bottom - Places the formatted text in the bottom of the text area. Justified - Places the first line of the first paragraph at the top of the text area. Places the last line of the last paragraph at the bottom of the text area. Places remaining paragraphs at equal distance between the first and last paragraphs. Margins Sets the distance between the edge of the shape and the edge of the text area. Margins are in the same units as the text box. Top - Sets the distance between the top edge of the shape and the top edge of the text area. Bottom - Sets the distance between the bottom edge of the shape and the bottom edge of the text area. Left - Sets the distance between the left edge of the shape and the left edge of the text area. Right - Sets the distance between the right edge of the shape and the right edge of the text area.

SmartPlant P&ID Auxiliary Graphics User’s Guide 81

Auxiliary Graphics: An Overview Paragraph Tab Text Style - Displays the style for a text box. Font - Lists and applies the available fonts. Font Size - Applies a text size. Font Style - Lists the available font styles. Underline - Underlines text. Language - Lists and applies a language for text in a text box. If you use text characters from more than one language in a text box, the option you specify in this box determines the way the lines wrap in the paragraph. Units Space - Sets the paragraph to paper units or to world units. You can change this control only when you are creating new styles from the Format Styles or Format Text Box dialog boxes. When you view this control from the Properties dialog box, it is read-only. You can change the control from the Info tab because all paragraphs contained within a text box must exist in the same units. Note
•

Within the drawing environment, "world units" is synonymous with the term "model units" found in other CAD packages.

Text Color - Sets the color of the font. Spacing - Determines the amount of space between lines and paragraphs in a text box. Text Alignment - Specifies alignment for each paragraph within the block of formatted text. Values for horizontal alignment include Left, Center, and Right. If Text Orientation is horizontal, you modify all the paragraph alignment properties for all paragraphs within the text box. (These properties appear in the Text Alignment area of the Info tab.) If Text Orientation is vertical, you modify the shape alignment properties. (These properties appear in the Text Alignment area of the Info tab. Line spacing - Lists and applies the amount of vertical space between lines of text.
•

Single sets the line spacing for each line to display the largest font in the line. 1.5 sets the line space for the line to one-and-a-half that of single lines. Double sets the line spacing for the line to twice that of single lines.

• •

82 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Paragraph Spacing - Specifies the amount of space before and after paragraphs. No spacing exists before the first paragraph and or after the last paragraph. Before - Adds space before a paragraph. This value is set in the current working units, not in points. After - Adds space after a paragraph. This value is set in the current working units, not in points. You can set the units using Units on the Format menu. Related Topics Format a Text Box, page 184 • Format Text Box Dialog Box, page 193 • Modify Text Box Style Dialog Box, page 180 • New Text Box Style Dialog Box, page 170 • Text Box Properties Dialog Box, page 76
•

User Tab (Text Box Properties Dialog Box) Attribute Set - Names a group of attributes. You can type a name in the box and press Tab. Save - Places the attribute set on the element that you selected. Remove - Removes the attribute set from the element that you selected. Attributes - Sets the name, type, and value of the attribute set. You can type a name in the box and press Tab. Name - Sets the name of a unique attribute in the attribute set. Type - Sets the type for the attribute, such as double, text, number, money, or date. Value - Sets the value for the attribute. The value that you can enter is based on the type that you selected in the Type box. Add - Adds an attribute to the attribute set. After you click Add, the attribute appears in the table. Delete - Removes an attribute from the attribute set. You can select an attribute by clicking a row in the table. Related Topics Format a Dimension or Annotation, page 184 • Format a Fill, page 196 • Format a Geometric Element, page 183 • Format a Text Box, page 184 • Managing Styles, Formats, and Colors: An Overview, page 159 • Properties Command (Edit Menu), page 185
•

SmartPlant P&ID Auxiliary Graphics User’s Guide 83

Auxiliary Graphics: An Overview

Character Map Command
Inserts a character into a text box using a different font. You can also insert special characters that do not have corresponding keys on the keyboard. You can use this command when you type or edit text in a text box. Tips
•

If you are running Windows 95 or a higher version and this command is not available, you must install the Character Map accessory. You can add it by clicking the Control Panel icon and then the Add/Remove Programs icon. While adding the software, you can find the Character Map software in the Accessories category. For detailed instructions on how to add the Character Map accessory, see the Windows 95 on-line Help for Add/Remove Programs. To place the Character Map button on a toolbar, click Tools > Customize to open the Customize dialog box. On the Toolbars tab, select Tools from the Categories list. Click and drag Character Map existing toolbar. to an

Character Map Dialog Box
Selects special characters for inserting into a text box. For additional information about using Character Map, click the Help button in the Character Map dialog box. Font - Lists the available fonts. Help - Opens the online documentation for using Character Map effectively and efficiently. Characters To Copy - Displays selected characters to copy to the Clipboard. Select - Copies selected characters to the Characters To Copy box. Copy - Copies the selected characters from the Characters To Copy box to the Clipboard. Advanced view - Lets you display groups of characters to help in refining a search of a character's Unicode value. When you check the Advanced view check box, the Character Map dialog box displays additional options. Character set - Specifies the character set you you want to search. If a character set is not available, choose a different font from the Fonts list.

84 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Go to Unicode - Allows you to enter the four-digit Unicode value for the character you are looking for. This option is only enabled if you have selected Unicode in the Character set list. Group by - Specifies the group you want to use for your search. If you select Unicode Subrange, a list of category characters is displayed. Search for - Allows you to type all or part of the name of the character for which you are searching. Search - Executes the search based on the criteria you have defined. Related Topics • Adding Text to Documents: An Overview, page 66 • Character Map Command, page 84 • Insert a Font Character into a Text Box, page 74 • Placing Annotations: An Overview, page 66 • Text Box Command, page 75

Labels: An Overview
Technical drawings often have many labels that display important information about the objects or elements in the document. There are two types of labels: text labels and SmartLabels. Text labels are associated with an element or object. If you move the element or object, the text label moves with it. You can create text labels in a document by double-clicking an element or object. A text label appears near the element so that you can type text. The label appears at the location where the element is doubleclicked, except for closed elements, such as a circle or rectangle. The label position on closed elements is the center of the element. When you enter the text that you want, the text label orients itself with the element.

Another kind of label, a SmartLabel, can be associated to an object or element's text attributes. A SmartLabel is often distinguished by a question mark in the display.

SmartPlant P&ID Auxiliary Graphics User’s Guide 85

Auxiliary Graphics: An Overview A SmartLabel displays the attributes of the element or object as text in the document. You can drag SmartLabels from the Symbol Explorer into the current document. SmartLabels have an .sym extension. As you change an element's or object's attributes in the Attribute Viewer or the Properties dialog box, the SmartLabel's text displays those changes.

If an element or object has no attributes, and you drag a SmartLabel to it, the element or object picks up the attributes of the SmartLabel. For example, you might want to assign attributes to a heat exchanger, such as pressure and material type. If the SmartLabel has the pressure and material type defined, and the heat exchanger does not, the SmartLabel's pressure and material type are copied to the heat exchanger.

If an element already has existing attributes, a SmartLabel placed on the element displays the values for the existing attributes. For example, if the heat exchanger already has values for pressure and material type attributes, the values of those attributes are filled in for a SmartLabel placed on the heat exchanger.

86 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Tip
•

Not all SmartLabels assume the text attributes of an element or object. Some SmartLabels contain shapes that grow automatically if you add text to the SmartLabel.

Create a Text Label
1. Double-click an element or object. A small, blinking pointer appears below the element or object. For a closed element, the pointer appears in the center of that element 2. Type the text in the label. 3. Click outside the label to complete it. The text label rotates to align with the element or object to which it is associated.

Edit a Text Label
1. Double-click the label. 2. Type the text in the label. 3. Click a point outside the label to complete the operation. The text label rotates to align with the element or object to which it is associated. Notes
•

You can format a text label like a text box. Select the label and right-click. On the shortcut menu, click Edit Text Properties.

SmartPlant P&ID Auxiliary Graphics User’s Guide 87

Auxiliary Graphics: An Overview

Move a Label
•

If a text label is associated with an element or object, drag the element or object. The label moves with the element or object. If a label is not associated with an element or object, drag the label.

Place a SmartLabel
1. On the Main toolbar, click Symbol Explorer. 2. Browse to the directory. 3. Drag the SmartLabel into the document. If you place the SmartLabel near an element in the document, the SmartLabel is associated with that element. Related Topics • Adding Text to Documents: An Overview, page 66 • Labels: An Overview, page 85

Edit a SmartLabel
1. Double-click an element or object. 2. In the Attribute Viewer, type the values that you want for the label. Notes
• •

You can edit the properties or parameters of a SmartLabel. You can also edit the properties of the elements or text in the SmartLabel. Select the SmartLabel and then click Edit Graphic Properties or Edit Text Properties on the shortcut menu. If you place a symbol with a SmartLabel in a document, you cannot select or open the SmartLabel to edit it like most symbols. You must create a new SmartLabel.

Engineering Fonts
The engineering fonts delivered with the software contain industry-specific fonts, special characters, and symbols that you can use to annotate engineering drawings. These fonts include degree symbols, diameter symbols, and other special characters and symbols that are not usually included in a typical word processing package. Your choice of font should be based on the industry for which you are creating engineering drawings. The software provides TrueType® fonts; with TrueType fonts, what you see on the screen is what appears on the printed page. The screen display of the document closely matches the printed document. When you open a .dwg or .dgn document, the software provides a default mapping to determine which TrueType font will be assigned to which AutoCAD or MicroStation font. You can make changes to this mapping to define your own mapping. You can change the mapping with Options on the Tools menu. On the Foreign Data tab, you can click the appropriate Options. Related Topics • Adding Text to Documents: An Overview, page 66 • Apply a Border to a Text Box, page 73 • Character Map Command, page 84 • Edit a Text Box, page 74 • Format a Text Box, page 184 • Insert a Font Character into a Text Box, page 74 • Place a Text Box, page 69 • Placing Annotations: An Overview, page 66 • Resize a Text Box, page 74 • Text Box Command, page 75

SmartPlant P&ID Auxiliary Graphics User’s Guide 89

Auxiliary Graphics: An Overview

Drawing with Relationships: An Overview
As you move the pointer, the software automatically updates values in the ribbon, giving you constant feedback on the size and position of the element you are drawing. As you draw, the software shows a temporary, dynamic display of the element you are drawing by the pointer – – this feedback is called a relationship indicator. This temporary display shows the look of the elements if you place the element at the current location.

The software gives you more information about the element that you are drawing by displaying relationships between the temporary, dynamic element and the following items:
• • •

Other elements in the drawing Horizontal and vertical orientations Origin of the element that you are drawing

When the software recognizes a relationship, it displays a relationship indicator at the pointer. As you move the pointer, the software updates the indicator to show new relationships. If a relationship indicator appears by the pointer when you click to draw the element, the software applies that relationship to the element. Relationship End point Midpoint Intersection Horizontal Vertical Point On Element Perpendicular Relationship Indicator

90 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Relationship Parallel Tangent Center For example, if the horizontal relationship indicator appears when you click to place the second end point of a line, then the line is exactly horizontal. Relationship Indicator

Relationships You can set the types of relationships you want the software to recognize using SmartSketch Settings on the Tools menu. The software can recognize one or two relationships at a time. When the software recognizes two relationships, it displays both relationship indicators at the pointer.

Locate Zone You do not have to move the pointer to an exact position for the software to recognize a relationship. The software recognizes relationships for any element within the locate zone of the pointer. The circle around the pointer crosshair or at the end of the pointer arrow indicates the locate zone. You can change the size of the locate zone with SmartSketch Settings on the Tools menu.

Infinite Elements The software recognizes the Point On Element relationship for lines and arcs as if these elements were infinite. In the following example, the software recognizes a Point On Element relationship when you position the pointer directly over an element and also when you move the pointer off the element.

Using Relationships as You Draw: An Overview
You can use relationships to capture and remember your design intent as your sketch. You can make your drawings associative by applying those relationships — or you can sketch designs that do not use relationships. How Relationships Affect a Drawing You can move and change an element that does not use relationships in various ways without affecting other parts of the design. For example, when no relationships exist between two lines, you can move and change each line without affecting the other. When you modify a part of a drawing that has a relationship to another part of the drawing, the other part updates automatically. For example, if you apply a perpendicular relationship between the two lines and move one line, the other line moves with it. The software remembers the relationship between these two elements and always maintains the perpendicular relationship between the lines. You can manipulate either of the two lines and the software will move or modify the line automatically to maintain the relationship. Applying and maintaining relationships in the design simplifies changes to the design later. In the following drawing, all the relationships were automatically established as the design took shape on the drawing sheet. If you want to change the design, you simply modify one segment of it and all the relationships are maintained. Applying and Maintaining Relationships You can place elements that are related to each other as you draw. First, you must set Maintain Relationships on the Relationship toolbar. Tip
•

You can also set Maintain Relationships using the Tools menu.

Then, as you click commands on the Draw toolbar and place lines, arcs, and circles, you should watch the relationship indicators that appear by the pointer. When a relationship indicator appears by the pointer, you can click to apply that relationship to the element that you are drawing.

92 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview Visualizing Maintained Relationships When you apply relationships, relationship handles appear on the related elements. The handles are symbols that show how elements are related. You can display or hide the relationship handles in your drawings by setting or clearing Relationship Handles on the Tools menu. Relationship Colinear Connect Concentric Equal Horizontal/Vertical Tangent Symmetric Parallel Perpendicular Lock For example, the following four lines appear with relationship handles (A) turned off and with relationship handles (B) displayed. Relationship Handle

Applying Relationships to Existing Geometry You can apply relationships to geometry after you place it with the buttons on the Relationship toolbar. These buttons include parallel, tangent, connect, and so on. You can use relationships created with these buttons if you set Maintain Relationships on the Relationship toolbar. Removing Relationships You can quit using all the relationships that you have applied to the drawing if you clear Maintain Relationships. You can also remove individual relationships by selecting a relationship handle and deleting it. Clearing Relationship Handles on the Tools menu hides the handles, but the relationships are still maintained and used in the design.

SmartPlant P&ID Auxiliary Graphics User’s Guide 93

Auxiliary Graphics: An Overview When to Maintain Relationships Maintaining relationships makes designing more productive and revisions much easier. However, relationships can slow drawing and changes on large data sets. You should decide whether to use relationships depending on the speed of your computer and the importance of easy revision. For conceptual sketching and diagrams, you might want to use relationships by setting Maintain Relationships. This method allows you to quickly get your ideas on paper and revise them easily using direct modification and driving dimensions. The kinds of projects in which you might want to use relationships include mechanical concepts, architectural details, layouts, and schematic diagrams. When to Design Without Relationships For more complex projects where you initially need to draw with precision, you should not use relationships in the document. You can then draw with precision by using the PinPoint tool and entering values on ribbons. You can still use relationships within symbols. The kinds of projects in which you might want to draw without relationships include multiple-view drawings, floor plans, maps, and detailed designs. Tip
•

If you switch between using relationships and not using them while you draw, you can receive confusing results.

Intent Zones
As you draw and modify elements, small quadrants called intent zones appear next to the pointer. The software uses intent zones to interpret your intentions as you draw. Intent zones allow you to draw and modify elements many ways using few commands. You do not need to select a different command for every type of element. How Intent Zones Work When you click to begin drawing certain elements, the software divides the region around the clicked position into intent zones. By moving the pointer into one of these intent zones on the way to your next click location, you can tell the software what you want to do next.

94 SmartPlant P&ID Auxiliary Graphics User’s Guide

Auxiliary Graphics: An Overview The last intent zone you move the pointer into is the active zone. To change the active intent zone, move the mouse pointer into the zone you want to use, then move it to the position where you want to click next. Drawing Tangent or Perpendicular Arcs You can use intent zones to change the result of Tangent Arc. To draw an arc tangent to a line, first click a point on the line to place the first end point of the arc. Then move the pointer through the tangent intent zone and click to place the second end point of the arc.

If you want to draw a perpendicular arc instead, you can move the pointer back into the intent zone region and out through the perpendicular zone before clicking to place the second end point of the arc. The arc is then perpendicular to the line.

You can also use intent zones to define the arc direction. Drawing Arcs by Three Points When you use Arc by 3 Points, intent zones allow you to input the three points in any order. You can also use intent zones to change the arc direction.

SmartPlant P&ID Auxiliary Graphics User’s Guide 95

Auxiliary Graphics: An Overview Drawing Lines Tangent or Connected to Curved Elements Using intent zones with Line/Arc Continuous , you can draw a line tangent to a circle or arc. Or you can draw a line that is connected to the circle or arc, but not tangent to it.

Draw with Relationships
1. Set the SmartSketch options so that the software recognizes the relationships you want to use. You can set the options with SmartSketch Settings on the Tools menu. 2. On the Draw toolbar, click a drawing command. 3. Move the pointer around on the drawing sheet to find relationships. 4. Click when the software recognizes a relationship you want to use for the element you are drawing. When you click with a relationship indicator displayed at the pointer, the relationship is established in the drawing. Notes
•

If Maintain Relationships is set, the software places relationship handles as you draw. These relationships are maintained when you modify the drawing.

If the Relationship toolbar is not displayed, click Relationships on the Main toolbar.

You can also click Tools > Maintain Relationships to toggle on and off the Maintain Relationships command. 2. Draw as usual. The software automatically establishes recognized relationships. For each relationship, a relationship handle is placed on the related elements.
•