Smartplant P&Id Drawing Manager: User'S Guide
Smartplant P&Id Drawing Manager: User'S Guide
Smartplant P&Id Drawing Manager: User'S Guide
Manager
User's Guide
March 2015
DPID2-PE-200005Q
Copyright
Copyright © 1999-2015 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN,
Sapphire, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph
Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of
Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are
trademarks of their respective owners.
Additional Documentation
Click Help > SmartPlant P&ID Drawing Manager Help on the main menu bar.
You can also open online help by clicking Help on the main toolbar or by clicking the
Help button on any dialog box or by clicking F1.
Displays contents for the Help topics that include step-by-step instructions for using Drawing
Manager.
The Contents tab displays the Table of Contents for Drawing Manager Help.
The Index tab contains keywords that describe and link to specific topics.
The Search tab lists words that appear only within the Help topics. By using the Search tab,
you can locate every topic that contains a particular word.
To print the user's guide, use the printing capability of the application that opens the
guide.
The printable user's guides contain the same information that is in the Online Help.
Intergraph gives you permission to print as many copies of the delivered .pdf files that
you need for non-commercial use at your company. You cannot print the .pdf files for resale or
redistribution outside your company.
The About SmartPlant P&ID Drawing Manager dialog box is the place to access
information about version numbers, copyrights, licensing, technical support, and other topics.
You can drag-and-drop drawings from one plant group to another plant group, providing
the P&IDs are in the same plant structure and the Allow P&ID Drawings option has been
enabled in SmartPlant Engineering Manager.
On the Check Out dialog box in the Plant, fewer drawing states are needed.
The software indicates out-of-date drawings by displaying the icon in the Out-of-Date
Drawing Status column. To display this column, do the following:
1. Click View > Customize Current View.
2. On the Customize Current View dialog box, from the Drawing properties list, select
Out-of-Date Drawing Status.
3. Click Add to copy this property to the Selected properties list.
Opens the Open Plant Structure dialog box, allowing you to connect to the site server
containing the drawings that you want to work with. Choosing the appropriate SmartPlant .INI
file connects you to that site. You can also view the plants to which you have recently been
connected.
In order to use this command, your computer must be able to connect to the network where the
server is located.
Available plant structures — Lists those plant structures found on the network. You can select
only one item from this list at a time.
Open — Connects you to the selected plant or project database. The Open command also
checks to make sure you have the correct access privileges for the selected database and
passes your access information back to Drawing Manager.
Site Server — Opens the Open Site Server dialog box, allowing you to select the SmartPlant
.INI file for the site you want to access. Plant structures contained in the site you selected
display in the Available plant structures list.
Application Type — Allows you to select an application for filtering the available plant
structures that are associated with that application. If all the plants in the site are associated
with one application only, the value is read-only.
Connect to a Database
1. Click File > Open Database.
2. On the Open Plant Structure dialog box, click Site Server.
3. On the Open Site Server dialog box, select the correct SmartPlant initialization (.ini) file and
click OK.
4. Click Open.
If the site server .ini file that you need appears on the File menu in the list of recently
opened items, you can click it and open that database immediately.
If you are working in a Project, you can also click the Custom View button on the
Fetch dialog box.
Drawing properties — Lists the drawing properties that are available for display in the List
view. Select a property from this list and click Add in order to move it to the Selected
properties list.
Selected properties — List the properties that will display in the List view.
Add — Moves the property into the Selected properties list so that the selected information is
displayed in the List view.
Remove — Moves the selected property back into the Drawing properties list. That information
will no longer display in the List view.
Move Up — Moves the property you select in the Selected properties list up one position. Use
this button to further customize the way the columns in the List view are displayed.
Move Down — Moves the property you select in the Selected Properties list down one
position. Use this button to further customize the way the columns in the List view are
displayed.
Use filtering (see "Filter the List View" on page 17) to control which drawings are displayed
in the List view.
To display all drawings in the selected plant hierarchy node, use the View > Include
Subnodes command. For more information, see Display Subnodes in the List View (on
page 16).
You can drag-and-drop drawings from one plant structure to another, provided P&IDs are
allowed in the target plant structure.
Displays in the List view all of the drawings that reside under the selected plant in the Tree
view, not only those drawings that reside directly under the selected node.
If you select a plant in the Tree view and then click View > Include Subnodes, the
entire plant hierarchy is displayed in the List view. This command provides an easy way of
viewing the plant hierarchy without having to open every unit.
Any previously-applied filter settings are retained the next time you open Drawing
Manager in the current plant.
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.
Match all — Specifies that items matching ALL of the filtering criteria pass through the filter.
Match any — (Default) Specifies that items matching any one or more of the filtering criteria
pass through the 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.
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.
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. These relationships
include greater than, >; equal to, =; not equal to, <>; and so forth.
Value — Lists appropriate values for the property specified in the Property list. If a list of
attributes is not already associated with the Value box, you must choose null or type a value,
which can be free text. You can type a percent sign (%) as a wildcard character to find multiple
characters or an underscore (_) as a wildcard character for a single character. Do not use an
asterisk (*) in the Value box.
You can rename and renumber a drawing, but keep in mind possible naming conflicts
that can arise when you retrieve a drawing under an older name. In particular, a drawing that
has been renamed appears in the list of deleted drawings when you use the Revisions > Fetch
Deleted Drawing command even though it has not actually been deleted.
If you select a plant group in the Tree view, you can open the Plant Group Properties dialog
box to view the description for the selected plant group.
You cannot modify many of the drawing properties after the drawing is created. For
example, the Template property value cannot be changed.
4. Click OK.
You can rename and renumber a drawing but keep in mind possible naming
conflicts can arise.
You can rename and renumber a drawing, but keep in mind possible naming
conflicts that can arise when you retrieve a drawing under an older name. In particular a drawing
which has been renamed appears in the list of deleted drawings when you use the Revisions >
Fetch Deleted Drawing command even though it has not actually been deleted.
Of course, you must have the appropriate permissions, which are assigned in SmartPlant
Engineering Manager, in order to carry out these operations.
This operation can only be carried out by an administrator with Full Control Permissions to
Options Manager.
Opening the copied plant structure in SmartPlant P&ID or Drawing Manager before
completing this process is not possible.
When loading a plant for which the Keep unique identifiers from source check box on
the Associate Applications page of the Load Plant Structure Wizard was selected, and where
the name of the loaded plant is the same as the source plant name, this command is not
required and is therefore disabled.
If you are using a utility that communicates data from a SmartPlant authoring tool to
PDS, remember that there can be no spaces in the path to a drawing, therefore you
should name your drawings accordingly.
For the Document Type property, you must select P&IDs or D&IDs according to the
desired designation of the drawing.
4. Click Create to generate the new drawing and add it to the plant node; the New Drawing
dialog box remains open so that you can create more drawings under this node.
5. Click OK to create the new drawing, close the dialog box, and return to the main Drawing
Manager interface.
You can modify the drawing properties that appear in the New Drawing dialog box by
modifying them in Database Tables in Data Dictionary Manager.
You can specify whether certain drawing properties are required or optional in Options
Manager. The Document Type, Drawing Number, Name, Path, and Template properties
are always required for being able to view the drawing.
The Drawing Number and Name properties must be unique within each unit.
For the Name property, the following characters are not allowed: / \ : * ' ? " < > |. For the
Drawing Number property, the single quote (') character is not allowed.
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.
Opens the New Drawing dialog box where you specify properties for a new drawing. The
drawing is created under the currently selected plant group node in the Tree view.
You must have the appropriate permissions, specified in SmartPlant Engineering
Manager, in order to be able to create drawings.
The Drawing Number and Name properties must be unique within each unit.
For the Document Type property, you must select P&IDs or D&IDs according to the
desired designation of the drawing.
The Drawing Number, Name, and Template properties on a drawing are always
considered as Read/Write by Drawing Manager even when set to Read Only within the
Data Dictionary Manager. This is because these properties must be set when creating a
drawing.
Open a Drawing
1. In the Tree view, select the node in which the drawing resides.
2. In the List view, select the drawing that you want to open.
You must have the appropriate permissions, specified in SmartPlant Engineering Manager,
in order to view or modify drawings.
If you only want to quickly view a read-only version of the drawing, you can do so inside
Drawing Manager, without opening SmartPlant P&ID. For more information, see View a
Drawing in Drawing Manager (on page 25).
You can open a read-only display of a drawing using commands in Drawing Manager without
having to open the full-blown design software. Although you cannot edit the drawing from
Drawing Manager, you can view the graphics and properties assigned to drawing items. In some
cases, this capability can save you time and effort.
You can use this viewing functionality on the current drawing in the database or on any of the
saved versions for a drawing, too. However, a version, either current or saved, must exist in
order to use this viewing capability. Versions are automatically created once the drawing is
opened and changed for the first time; otherwise, the New Version command can be used to
save a version.
Most of the commands to manipulate the view are also available. That is, you can zoom in on an
area in the drawing, fit the drawing to the display space, pan across a drawing, and so forth. You
can also use buttons on the Properties window toolbar to manipulate the display of properties
for a selected drawing item or items.
locate and resolve missing symbols using the Update command. You can also create reports
and schedule updates.
Be sure to back up your work or create a version prior to using this command.
These updates do not apply to assemblies.
Out-of-Date Symbols — File Last Modified Time Stamp on at least one representation in the
drawing is not equivalent to the File Last Modified Time Stamp on the corresponding symbol
definition file.
Missing Symbols — Filename specified for at least one representation in the drawing does not
have the corresponding symbol definition file available in the current catalog.
Rule Changes — Rules GUID on the drawing item is not equivalent to the GUID from the Rules
file.
Heat Trace Changes — Heat Trace GUID on the drawing is not equivalent to the Heat Trace
GUID in Option Manager Setting.
Gapping Changes — Gapping GUID on the drawing item is not equivalent to the Gapping
GUID in Option Manager Setting.
Symbology Changes — Symbology GUID on the drawing item is not equivalent to the
Symbology GUID in Option Manager Setting.
Out-of-Date Model Items — SP_ModelItemTimeStamp for at least one representation in the
drawing is not equivalent to the TimeStamp on the History Item of its Model Item. This criteria
covers model items updated via Llama (Outside the drawing).
Moved OPCs — MatingOPCPath (will have Drawing ID of its mate) on the OPC is not
equivalent to the SP_DrawingId of its mate OPC. The OPC label is in a to-be-updated state as
its mate has been moved.
Recreate State — The drawing is in a re-create state.
Drawing Property Changes — Property Changes GUID on the drawing item is not equivalent
to Drawing Property Changes GUID on the drawing item. Drawing Property Changes GUID is
set when drawing properties are modified from Drawing Manager.
Update Command
Displays the Update Drawings dialog box. When you select this command, the selected
drawings are analyzed based on the out-of-date criteria and the results display on the Update
Drawings dialog box.
Update does not update any symbol whose definition has been changed into a break
component. This situation occurs when you have a catalog item that has been placed in a
drawing and then you change its definition to be a break component. The SmartPlant P&ID
Replace command does not allow a non-breaking component to be replaced with a break
component. The Update command relies on the SmartPlant P&ID Replace command to
replace symbols that are out-of-date.
If an item type property has Write P&ID or Write Both permissions in Data Dictionary
Manager and a symbol belonging to the item type is changed in Catalog Manager, running
the Update command on a drawing in Drawing Manager will NOT overwrite values assigned
to this property with any defaults that may have been pre-defined in Catalog Manager. If the
property permissions are Write Catalog in Data Dictionary Manager, Update will restore any
default property values defined in Catalog Manager.
Intergraph recommends that you backup your work or create a version of your work
prior to using this command.
Resolve Command
Displays the Resolve Missing Symbols dialog box which provides a way for you to define any
symbols that have been deleted, moved, or renamed.
In order to resolve any missing symbols, you must have an existing symbol in the catalog to
define as the replacement for the missing symbol.
You cannot resolve missing symbols for offline instruments of a different class using this
command.
Old Path - Displays the relative path of the missing symbol.
New Path - Displays possible options for defining correct locations for the missing symbol(s).
Drawings - Displays the list of drawings that contain the missing symbol(s).
Report Command
Displays detailed information about out-of-date drawings. Criteria that can be checked includes
select list values, formats, out-of-date symbols, missing symbols, rules, heat tracing, gapping,
symbology, OPCs, and so forth.
You must select one or more drawings prior to selecting this command. The information
displays in Microsoft Excel and is based on options selected using the Out-of-Date Drawing
Criteria command. If all drawings are up-to-date, a message box displays stating that all
selected drawings are up-to-date.
When upgrading a plant, drawings may be out of date for any of the out-of-date criteria.
In order to use this command, you must be assigned the user right Update P&ID on the
Role Properties dialog box in SmartPlant Engineering Manager. Also, you are required to
have Full Control assigned on P&ID Objects.
In order to use this command, you must be assigned the user right Update P&ID on the
Role Properties dialog box in SmartPlant Engineering Manager. Also, you are required to
have Full Control assigned on P&ID Objects.
Any changes made to the out-of-date drawing settings after the task is scheduled will not
affect the scheduled task.
If update drawings processing is scheduled for a hierarchy item, select in the Tree view, at
the scheduled time all the drawings under it are analyzed and only the out-of-date drawings
are updated.
If update drawings processing is scheduled for drawings, selected in the List view, at the
scheduled time only the selected drawings are analyzed and the out-of-date drawings are
updated.
Drawings with missing symbols are logged but not updated. Drawings that do not require
an update are logged with a message that the drawing is up-to-date.
Importing Drawings
The Import Drawings command allows you to copy drawings from another plant in the same
site or a different site. An import map file is used to match attributes. The software uses a
delivered map file to map any customized attributes, select list entries, and symbols between the
target and source plants. Using the wizard, you can create and save your own map files. In
order to be able to edit the import map file, you must have permission as assigned in SmartPlant
Engineering Manager. Using the Roles Properties dialog box and the Rights tab, you must
select the Drawing Management option Edit Import Map in order to be able to edit a map file.
There are several import drawing options also available in Options Manager. The Import Map
Path setting defines where your map files will reside on the system. The Import
Transformation Program controls the depth of the data transformation. A transformation
program is delivered with the software but you can copy and edit the program to fit your
requirements. For example, you could edit the program to clean individual property values,
categories of values, or you can flag values that are set during the copy process.
Any graphics that have been band-aided should be deleted and replaced prior to using this
command.
If your target plant uses a shorter data string value than the source plant, the string will be
truncated. For example, if the source plant has a maximum character value of 80 set for a
field, and the target plant has a maximum character value of 40 set for the same field, only
the first 40 characters of the field will be mapped.
If your source drawings and target database use different languages, you are required to
use a database created using the UTF-8 character set for unrestricted multilingual
support. For example, if the source drawing name contains German characters, they will be
converted to English during the import. When you try to open the drawing, the physical file
will not be found and the product will try to re-create the drawing.
When importing a symbol's representation properties, the representation properties are a
pure copy of the source symbol.
If the import of drawings fails, the reason will be recorded in the import log file and those
drawings will not be included in the re-create process.
Available plant structures — Lists those plant structures found on the network. You can select
only one item from this list at a time.
Open — Connects you to the selected plant or project database. The Open command also
checks to make sure you have the correct access privileges for the selected database and
passes your access information back to Drawing Manager.
Site Server — Opens the Open Site Server dialog box, allowing you to select the SmartPlant
.INI file for the site you want to access. Plant structures contained in the site you selected
display in the Available plant structures list.
Application Type — Allows you to select an application for filtering the available plant
structures that are associated with that application. If all the plants in the site are associated
with one application only, the value is read-only.
Filter — Opens the Filter dialog box, which allows you to specify criteria for filtering the
drawings that are displayed in the List view.
Clear Filter — Deactivates any filter you have applied to the list of drawings that appears in
the List view.
Include Subnodes — Displays all the drawings and node names that reside in the currently
selected node.
Details — Displays a detailed view of the drawing properties specified using the Customize
View option. You can sort by the listed properties. By default, this view shows the Name
property only, so it will appear the same as the List view unless you specify additional
properties to display.
List — Displays a list of the drawings. One property per drawing is displayed.
Properties — Displays the properties for the selected item. These values display in the
Properties dialog box.
Customize View — Opens the Customize Current View dialog box, which allows you to
specify the information about each drawing that is displayed.
Import Drawings Wizard. For more information, refer to Import Drawings Wizard - Complete
Import Map (on page 33).
Source catalog path — Displays the catalog root path where your symbols are installed.
Symbols — Displays an alphabetical list of any missing symbols.
All of the import map files for a plant are saved in the import map folder defined using Options
Manager. This folder is normally setup on a server that is accessible to all client computers. One
import map file is created for each source plant from which drawings are imported. The wizard
automatically opens the import map file for the selected source plant. If you have imported
drawings from a different source plant, you can copy that import map file using the Open
command. The Save command always saves the current import map file to the standard name
in the standard location.
The import map is displayed in a familiar Explorer view with a Tree view on the left and a list
view on the right. You can select the nodes of the Tree view and see the related data in the list
view. The Map Status column in the list view can have a value of Complete or Incomplete. A
value of Complete indicates this item and all of the items below it have been mapped. A value
of Incomplete indicates this value is not mapped or some value below it has not been mapped.
You must expand the Tree view to find the item that needs to be mapped. When you select the
top-most node in the Tree view and the Map Status field displays Complete for all three of its
children, then you know that the import map is complete.
You must have the same size symbols available when importing. Imported parametric symbols
will use existing parametric parameters.
New — Creates a new import map file. If there are any unsaved changes in the current
map file, you are prompted to save those changes if needed. The new map file is automatically
updated with existing values that are in use by the selected drawing.
Open — Opens a new import map file. If there are any unsaved changes in the current
map file, you are prompted to save those changes if needed. The import map file is validated
against both the source and target plants. Map entries for items that do not exist in the current
source and target plants are deleted. The map is automatically updated with the existing values
in use by the selected drawings.
Save — Writes the current import map file to the disk using the standard naming
convention.
Show in Use — If selected, this command filters the display to show only the items being
used by the selected drawing. By default, this option is selected. If not selected, the display is
based on all items in the map.
Show Incomplete — If selected, this command filters the display to show only the items
displaying an incomplete map status. By default, this option is selected. If not selected, all
items display.
Update from Source — Reads data from the source plant and then populates the import
map file. The import map is updated using the source plant data dictionary and catalog
definitions. If you have the top node in the Tree selected, a complete update is performed. If
any lower level node in the Tree is selected, a partial update is performed. This option fills in
the source value for each created map object and automatically completes the mapping process
by filling in the target value for certain objects. Properties in the source plant that match with
identically named properties in the target plant are automatically mapped. Select list values and
symbols are not automatically mapped. If you are doing a partial update (a lower level node in
the Tree view is selected when using this command), select lists should be updated before item
types or symbols. This will help to create the proper relationships between the items.
Auto Complete — Automatically maps source objects to the corresponding target objects
where possible. If the target value is already defined, the target value is not changed. If you
have the top node in the Tree selected, a full operation is performed. If any lower level node in
Clean Up Map File — Cleans up the map file by removing items in the map file that have no
relationship with the current import. All items on drawings to be imported must be mapped. If
you have the top node in the tree view selected, a full operation is performed. If any lower level
node in the tree view is selected, a partial operation is performed.
Update Catalog Index — Updates the catalog index to include the latest information about
all symbols in the target catalog. The mapping of symbols depends on the catalog index. The
catalog index should be updated after any changes are made to the symbols in the
catalog. The catalog index is saved in the file named CatalogIndex.xml in the top level folder of
the catalog.
Match index — Matches index, or number, associated with each select list item. For example,
you would use this option if your source plant contains English text values and the target plant
contains German values. The values would be assigned according to the select list index (its
numeric value).
Match text — Matches the text, or string, associated with each select list item. For example,
use this option if you have added entries to your select list. This option matches the text values
and ignores the numeric values.
Match text and index — Matches the index and text associated with each select list item.
3. On the Target Symbols dialog box, select the symbol you would like to use.
For details of how the software determines which symbols are available as target symbols,
see Criteria for Available Target Symbols (on page 38).
4. Click OK.
Available symbols — Displays a list of symbols that meet the criteria determined by the
software for mapping to the source symbol. For details of how the software determines which
symbols are available as target symbols, see Criteria for Available Target Symbols (on page
38).
temperatures and pressures. If a drawing is being imported from a source plant that shares the
same locale as the target plant, typically this option should be turned off to prevent any loss of
formatting during the import operation. For example, if pressure values are expressed in
several different units of measure for different properties, these would all be imported exactly as
they are in the source database. If a drawing is being imported from a source plant in one
locale into a target plant in a different locale, typically this option should be turned on. This
ensures that locale-dependent formatting is applied to all values. For example, if importing from
a plant where the decimal symbol is a comma (,) to a plant where the decimal symbol is a period
(.), property values should be reformatted using the default formats.
Import revisions — Select to include with the import all drawing revisions that were made in the
source plant.
Use source drawing name and number — Select to keep the original name and number of the
drawings without the addition of any prefix. Clear to specify new drawing names and
numbers. When cleared, the software adds a prefix to the drawing name indicating the name of
the source plant.
Do not recreate drawings — Select to skip re-creation of the graphical drawings when
importing the drawing data. This improves performance when you are importing a large number
of drawings. If you select this option, you are prompted to re-create a drawing when you open
it.
Transformation program — This option displays the name of the transformation program
defined by the Options Manager setting Import Transformation Program. You can copy the
delivered code and then create your own customized transformation program. Then, you can
use this field to enter the name of your transformation program. The delivered import
transformation program is CopyTransformation.Import. You are not required to use a
transformation program. For more information about creating a transformation program, see
Customizing the Sample Projects in the SmartPlant P&ID Programmer's Guide.
Custom Options — If a transformation program is defined, this command displays the
Transformation Programs dialog box. It is used to define options for modifying property
values during the import process. The options that appear on the Transformation Programs
dialog box depend on the transformation program defined by the Options Manager setting
Import Transformation Program. You can copy the delivered code and then create your own
customized transformation program. The delivered transformation program used for importing
drawings is CopyTransformation.Import.
Sequence numbers
Generate new — Selecting the option causes existing tag sequence numbers to be set to null
for any item that has the property TagSequenceNo. The null sequence number triggers the
creation of new sequence numbers during normal item tag validation.
Add value to the beginning of all sequence numbers — When you select this option, you
can use the box to type the values you want to display at the beginning of all your sequence
numbers.
Keep existing if unique — If the sequence number for an imported item is unique within the
target plant, it will be left as it was in the source plant, but if a duplicate is detected in the target
plant, the tag sequence number of the imported item will be changed.
Duplicate item tags are not allowed for loops and instruments.
When importing a drawing that has a loop associated with one or more instruments, the
sequence number that the newly-created loop receives is in accordance with the selected
option; however, the instrument / loop associations will correspond to those in the source
drawing and the instruments will retain the original values for their Tag Seq No and Item
Tag properties. This may result in a mismatch between the loop and instrument sequence
numbers. To resolve this situation, you must update the related instrument tags on the
Update Associated Instruments with Loop Properties dialog box in SmartPlant P&ID.
Clear piping material classification — Select to remove any defined piping materials class.
Clear process data — Select to remove any values in the Process category.
Associate drawings Associate plant items Resulting behavior for the imported
drawing
By current plant By drawing plant group The drawing and all of its plant items are
group associations re-associated with the current plant
group. For details, see Import Options -
Example 1 (on page 43).
By current plant Depending on original The drawing and those plant items that
group associations were associated with the same plant
group as the drawing are re-associated
with the current plant group. Other plant
items follow the plant item mapping. For
details, see Import Options - Example 3
(on page 45).
By mapping (multiple By mapping The drawing and the plant items follow
plant groups) the mapping. For details, see Import
Options - Example 5 (on page 48).
By mapping (multiple Depending on original The drawing and those plant items that
plant groups) associations were associated with the same plant
group as the drawing follow the mapping
for the drawing. Other plant items follow
the plant item mapping. Note that the
end result is the same as for the previous
combination of settings. For details, see
Import Options - Example 6 (on page 49).
'In use' plant group data only — Filters the plant groups available for mapping so that only
those plant groups that have associated plant items and drawings will be available on the
Mapping dialog box.
Mapping — Opens the Mapping dialog box to allow you to define the associations between the
target and source plant groups for the drawings and / or the plant items depending on the
settings you choose. This button is only enabled when you make appropriate selections under
Import options.
Selected Options
Associate drawings: By current plant group
Associate plant items: By drawing plant group associations
Import Results
The drawing and all of its plant items are re-associated with the current plant group.
Selected Options
Associate drawings: By current plant group
Associate plant items: By mapping
Mapping
Source Plant Group Target Plant Group
P1\U1 P2\U4
P1\U2 P2\U2
P1\U3 P2\Unit3
Import Results
The drawing is re-associated with the current plant group and the plant items are re-associated
according to the mapping.
Selected Options
Associate drawings: By current plant group
Associate plant items: Depending on original associations
Mapping
Source Plant Group Target Plant Group
P1\U1 P2\U4
P1\U2 P2\U2
P1\U3 P2\Unit3
Import Results
The drawing and those plant items that were associated with the same plant group as the
drawing are re-associated with the current plant group. Other plant items follow the plant item
mapping.
Selected Options
Associate drawings: By mapping (multiple plant groups)
Associate plant items: By drawing plant group associations
Mapping
Source Plant Group Target Plant Group
P1\U1 P2\U4
P1\U2 P2\U2
P1\U3 P2\Unit3
Import Results
The drawing is re-associated according to the mapping. All plant items in a particular drawing
are re-associated with the target plant group specified for that drawing in the mapping.
Selected Options
Associate drawings: By mapping (multiple plant groups)
Associate plant items: By mapping
Mapping
Source Plant Group Target Plant Group
P1\U1 P2\U4
P1\U2 P2\U2
P1\U3 P2\Unit3
Import Results
The drawing and the plant items follow the mapping.
Selected Options
Associate drawings: By mapping (multiple plant groups)
Associate plant items: Depending on original associations
Mapping
Source Plant Group Target Plant Group
P1\U1 P2\U4
P1\U2 P2\U2
P1\U3 P2\Unit3
Import Results
The drawing and those plant items that were associated with the same plant group as the
drawing follow the mapping for the drawing. Other plant items follow the plant item mapping.
You can assign plant groups at any level of the hierarchy as the target; for example, an
Area.
If you use the mapping to associate both the drawing and the plant items to the target plant
group, and you do not have appropriate permissions for the drawing association, a message
appears and only the plant items are re-associated according to the mapping. In this case,
the software associates the drawing with the current plant group.
You must map ALL of the rows that appear in the source path to a target path.
You can clear the mapping for a particular row by selecting that row and clicking Remove
Mapping.
Item types
Allows you to select the following item types for validation in the selected drawings:
Equipment
Pipe run
Instrument
Instrument loop
Piping component
Room
Duct run
Ducting component
Validation programs
Item tag validation — Validates changes in item tag configuration. These changes may be the
result of renaming the plant hierarchy item name where this name is a part of the item tag.
For item tag validation to take effect, this check box must be selected.
Options
Allows you to include items in either or both of the stockpiles for validation in the selected
drawings:
Include drawing stockpile
Include plant stockpile
Run — Runs the validation for the selected drawings.
Copy a Drawing
1. In the Tree view, select the node in which the drawing resides.
2. In the List view, select the drawing that you want to copy.
Use the SHIFT or CTRL key to select more than one drawing.
You must have the appropriate permissions, specified in SmartPlant Engineering Manager,
in order to copy drawings.
You can hold CTRL, select a drawing, and drag it to a new location to make a copy. You
can also drag it to the current list view to make a copy. When copying a drawing, the
software displays the Transformation Programs dialog box. If you drag and drop the
drawing to another unit, you will need to select the contents of the drawing using SmartPlant
P&ID and set the Plant Group Name value in the Properties window.
A multi-rep model item is created at the target only once if the drawings that contain all the
representations for it are selected for copy in one session. If the drawings are copied in
separate sessions, the model item is re-created at the target for that session.
Paired OPCs in a drawing that are not copied (for example, not in a Select Set) are placed
in the plant stockpile. Paired OPCs in a copied drawing have their relationships maintained
by the copy. Paired OPCs are not moved from the plant stockpile to a drawing by a
subsequent copy session.
A plant item group is created at the target only once if the drawings that contain all of its
members are selected for copy in one session. If the member drawings are copied in
separate sessions, the plant item group is re-created at the target for each session.
Move a Drawing
1. In the Tree view, select the node in which the drawing resides.
2. In the List view, select the drawing that you want to move.
3. Drag and drop the selected drawing to the new location.
You must have the appropriate permissions, specified in SmartPlant Engineering Manager,
in order to copy drawings.
If you move the drawing to another plant group, the associated plant groups for the items in
the drawing are not automatically updated to reflect the new plant group. You will have to
update the plant groups manually from within SmartPlant P&ID.
See Also
Open a Drawing (on page 24)
View a Drawing in Drawing Manager (on page 25)
Pastes the selected drawing(s) in Drawing Manager. When implementing this command, the
software displays the Transformation Programs dialog box.
To avoid database lockup during pasting of a group of drawings, ensure that the
workstation performing the operation has at least 4 GB of memory. Also ensure that the size of
the redo log files of the database instance is at least 500 MB.
The options that appear on the Transformation Programs dialog box depend on the
transformation program defined by the Options Manager setting Copy Transformation
Program. You can copy the delivered code and then create your own customized
transformation program. The delivered transformation program used for copying drawings
is CopyTransformation.Transform.
You can change the name of a pasted drawing by selecting the drawing and then select
Edit > Properties. On the Properties dialog box, in the Name field, enter the new name.
Sequence numbers
Generate new — Selecting the option causes existing tag sequence numbers to be set to null
for any item that has the property TagSequenceNo. The null sequence number triggers the
creation of new sequence numbers during normal item tag validation.
Add value to the beginning of all sequence numbers — When you select this option, you
can use the box to type the values you want to display at the beginning of all your sequence
numbers.
Keep existing if unique — If the sequence number for a copied item is unique, it will be left as
it was, but if a duplicate is detected, the tag sequence number will be changed.
Duplicate item tags are not allowed for loops and instruments.
When copying a drawing that has a loop associated with one or more instruments, the
sequence number that the newly-created loop receives is in accordance with the selected
option; however, the instrument / loop associations will correspond to those in the source
drawing and the instruments will retain the original values for their Tag Seq No and Item
Tag properties. This may result in a mismatch between the loop and instrument sequence
numbers. To resolve this situation, you must update the related instrument tags on the
Update Associated Instruments with Loop Properties dialog box in SmartPlant P&ID.
Clear piping material classification — Select to remove any defined piping materials class.
Clear process data — Select to remove any values in the Process category.
Plant item associations
Allows you to specify the behavior of the plant item associations when copying the drawing.
Re-associate all plant items with the target — All plant items, regardless of their plant
group associations in the source, are associated with the target plant group of the copied
drawing.
Retain existing plant item associations — All plant items retain the same plant group
associations that they had in the source. No changes are made to the associations.
Re-associate items depending on original associations — Those plant items that belong
to the plant group of the drawing itself in the source are reassigned to the target plant
group. Those plant items that were assigned to a different plant group from that of the
drawing source plant group retain their existing override associations.
Paste a Drawing
1. In the Tree view, select the node where the copy of the drawing will reside.
2. In the List view, select the location where you want to paste the copy of the drawing.
3. Click Paste on the main toolbar. The software displays the Transformation Programs
dialog box.
The options that appear on the Transformation Programs dialog box depend on the
transformation program defined by the Options Manager setting Copy Transformation
Program. You can copy the delivered code and then create your own customized
transformation program. The delivered transformation program used for copying drawings
is CopyTransformation.Transform.
4. Click the Generate new sequence numbers option if you would like new sequence
numbers to be created. Selecting the option causes existing tag sequence numbers to be
set to null for any item that has the property TagSequenceNo. The null sequence number
triggers the creation of new sequence numbers during normal item tag validation. An
exception to this is that the tag sequence number for an instrument item is not set to
null. Item tag validation does not generate a new sequence number for an instrument.
Instrument tags will be duplicated at the target.
5. Click to select the Add value to the beginning of all sequence numbers to use this
option. Click in the provided field and enter the values you want to display at the beginning
of all your sequence numbers.
6. Click to select Keep exiting if unique to use this option.
7. Select the Clear piping material classification check box to remove any defined piping
materials class.
8. Select the Clear process data check box to remove any values in the Process category.
9. Click OK. The software displays the Paste Drawings dialog box.
10. When the processes are complete, click View Log to view the report or click Close to
dismiss the Paste Drawings dialog box.
You must have the appropriate permissions, specified in SmartPlant Engineering Manager,
in order to paste drawings.
For more information about creating a transformation program, see Customizing the Sample
Projects in the SmartPlant P&ID Programmer's Guide.
Allows you to delete drawings from the List view and from the plant structure. Because a new
version of the drawing is automatically created when you delete a drawing, you can recover the
drawing after you have deleted it, but there are many drawing recovery ramifications (see
"Recovering Drawings" on page 105).
Of course, you must have the appropriate permissions, specified in SmartPlant Engineering
Manager, in order to be able to delete a drawing.
Drawings — Lists the drawings that are being deleted, and shows the status of that operation.
View Log — Opens the log file, DeleteDrawing.log, which is created when you delete a drawing.
Delete a Drawing
1. In the List view, select the drawing that you want to delete.
2. Click Delete .
3. To confirm the drawing deletion, click Yes on the message box.
If you have not saved a version of the drawing, you will not be able to retrieve the
drawing after deleting it.
4. Click View Log on the Deleting Drawings dialog box to review notes from the drawing
deletion process.
If you have a saved version of a deleted drawing, you can retrieve the drawing as it was
when you saved it. For more information, see Recover a Version of a Deleted Drawing (on
page 109).
If a plant group has no drawings or plant items belonging to it, you can delete that hierarchy
item in SmartPlant Engineering Manager. Keep in mind, though, that if you have associated
a plant item with a hierarchy item by using the Properties window in SmartPlant P&ID, then
even though it can look as if no drawings are associated with that plant group, you cannot
delete that hierarchy item in SmartPlant Engineering Manager.
You can also delete saved versions of a drawing, without deleting the drawing itself. For
more information, see Show the Version History of a Drawing (on page 104).
Database Configuration
To allow work on projects to proceed without affecting the Plant, separate schemas are created
for each project. In other words, all projects must be located in the same database instance as
the Plant, with each project contained within a separate schema (separate database user
names).
The Plant shares reference data with its projects. Changes to the reference data can be made
only in the Plant. In other words, you can use Catalog Manager, Data Dictionary Manager, Filter
Manager, and Format Manager in a project, but you have read-only permissions and are not
allowed to modify any of the data from within these managers.
Projects claim objects in either Exclusive (default) or Shared mode. If you plan to use the
project in an integrated environment, Shared mode is mandatory. Use the Settings view in
Options Manager to set the Claim Mode before creating a project.
When publishing from a project, an instruction container, which contains all the claimed
objects, is created within the tombstone file.
You can change the Claim Mode to Shared at any time. However, you can change the mode
to Exclusive only when there are no claims in any project in the Plant.
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 As-Built. You cannot change reference data,
such as table layouts or formats or rules, at the project level.
Claiming
Claiming objects on a drawing is one of the main features of using projects in an integrated
environment. When a project claims an object on a drawing, the project controls modifications to
that object. A project cannot modify objects that it has not claimed.
Projects claim objects in either Exclusive (default) or Shared claim mode. If you plan to use the
project in an integrated environment, Shared mode is mandatory. Use the Settings view in
Options Manager to set the Claim Mode value before creating a project.
You can change the claim mode to Shared at any time. However, you can change the claim
mode to Exclusive only when there are no claims in any project in the Plant.
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.
For more information about claiming items, see the SmartPlant P&ID User's Guide.
A project can only be returned to an Active state from the Completed state. If a project
has been set to Merged or Canceled, it cannot be changed back to Active. Merged and
Canceled are permanent states.
SmartPlant project status — Displays information about the status of the active project with
respect to SmartPlant Foundation. This area is not active if the plant is not registered with
SmartPlant Foundation.
Refresh Status — Searches for and displays the status of this project in SmartPlant Foundation
and updates this information in SmartPlant Foundation if appropriate. This button is not
available if the plant is not registered with SmartPlant Foundation.
P&ID project status — Active, Completed, Merged, Canceled. If your project status is
merged, then no further actions are available on this dialog box.
Return to Active — Returns the P&ID project status to active. This button is available only
when the P&ID project status is Completed and the SmartPlant project status, if applicable,
is Active.
Complete Project — Sets the P&ID project status to Completed. This button is available only
when the P&ID project status and the SmartPlant project status are both Active. When you
click Complete Project, a confirmation message appears.
Merge Project — Sets the P&ID project status to Merged. This button is available only when
the P&ID project status and the SmartPlant project status are both Completed. When you
click Merge Project, a confirmation message appears.
Cancel Project — Clears all claims on all objects and sets the P&ID project status to
Canceled. This button is available only when the SmartPlant project status is Canceled. If
the Plant is not registered, then the project is simply canceled out of Drawing Manager.
If the plant is registered, click Refresh Status on the Project Status dialog box to update
the SmartPlant project status display.
In SmartPlant Foundation, the Complete Project, Return to Active, and Merge Project
options are not available unless the SmartPlant project status is also Active. The Cancel
Project option is not available unless the SmartPlant project status is also Canceled.
Displays the Fetch dialog box, which provides options for fetching a drawing version from the
Plant or another project. You can fetch a drawing with read/write permissions or with read-only
permissions.
The Fetch command is not available if you are currently working in the Plant. You cannot fetch a
deleted drawing, but a deleted drawing can be retrieved if a version of it is saved, and then you
can fetch it.
Open Database — Opens the Projects dialog box, which allows you to specify a different
project or the Plant.
Filter — Opens the Filter dialog box, which allows you to specify the drawings that are
displayed in the List view.
Cancel Filter — Deactivates any ad hoc filter you have applied to the List view.
Include Subnodes — Displays all the drawings and node names that reside in the currently
selected node.
List — Displays the List view. The List view displays only one property for each drawing.
To specify which property displays, click Customize View . The first item in the Selected
Properties list is the property that appears in the List view.
Details — Displays the Detail view, which contains all the properties specified in the
Selected Properties list on the Customize Current View dialog box. Using the Detail view
allows you to view and sort drawings by several attributes.
Customize View — Opens the Customize Current View dialog box, which allows you to
specify the information about each drawing that is displayed in the List view.
Options — Displays options specific to this fetch operation.
Create New Version — Saves a new version of the drawing before overwriting the existing
version. This option is not enabled if the current drawing is not already fetched or checked out
to the project.
Read-only — Fetches a read-only version of the drawing so that your project can examine the
drawing but not alter it.
Comments — Allows you to enter comments pertinent to this fetch operation.
History — Opens an abbreviated version of the Version History dialog box, which allows you
to choose a saved version of the drawing you select in the Fetch dialog box List view.
If you are connected to SmartPlant Foundation and you have already fetched the
drawing with read/write permissions, when you select the same drawing to fetch, the OK button
on this dialog box is not available.
Drawings — Lists the drawings that are being fetched, and shows the status of that operation.
View Log — Opens the log file, Fetch.log, which is created when you fetch a drawing version.
Fetch a Drawing
1. Click Fetch .
2. On the Fetch dialog box, select the pertinent node in the Tree view if it is not already
selected.
3. In the List view, select the drawing that you want to fetch.
4. Click History if you need to fetch a version of this drawing other than the current version.
5. On the Version History dialog box, select the version that you want to fetch, and then click
OK.
6. Select the Read-only option if you want to fetch a version of the drawing for review only.
7. (Optional) Enter appropriate comments in the Comments box.
8. Click OK. You can follow the progress of the fetch operation on the Fetching Drawings
dialog box. Click View Log if you want to examine notes from the fetch operation.
If you want to fetch a drawing version from another project and not from the Plant, click
Open Database on the Fetch dialog box toolbar. On the Projects dialog box, select the
Plant or a project from the Available databases list, and then click OK.
You can open a read-only version of the drawing for review by clicking View. For more
information about viewing drawing versions without fetching or checking them out, see Show
the Version History of a Drawing (on page 104).
If you are connected to SmartPlant Foundation and you have already fetched the
drawing with read/write permissions when you check the drawing out, the fetched version
remains intact and only its status changes to checked-out. That is, you cannot replace the
fetched version with the version in the Plant.
After you check out a drawing to a project, the drawing will be read only in the As-Built and
the following actions are not allowed:
Modifying drawing properties
Modifying the drawing or any drawing items or properties
Deleting the drawing
Updating the drawing using Drawing Manager
Updating the drawing using automation
You cannot check out a drawing to a project if it is open in the As-Built.
The software cannot validate a drawing in the As-Built using the Global Validation
functionality if you have checked out that drawing to a project.
Displays the Check Out dialog box, enabling you to check drawings out from the Plant and into
your current project.
You can check out drawings that you have already fetched to your project, too. The Check Out
command is available only inside a project of the Plant; that is, you cannot check a drawing out
from a project and into the Plant. After a drawing is checked out to a project, the drawing icon
changes to reflect the new status.
You do not have to check out a drawing in order to claim items on that drawing.
This command checks user permissions, assigned in SmartPlant Engineering Manager,
before it allows you to check out a drawing.
If you are connected to SmartPlant Foundation and you have already fetched the
drawing with read/write permissions, when you check the drawing out, the fetched version
remains intact and only its status changes to checked-out. That is, you cannot replace the
fetched version with the version in the Plant.
3. If you already have a fetched version of the drawing in your project and you want to replace
it with the version that you check out, select the Replace existing P&ID option.
If you do not replace the existing P&ID, your previously fetched version remains, but its
status changes to Checked-out.
4. (Optional) Enter comments in the Comments area.
5. Click OK. If you want to review notes about this operation after it is completed, click View
Log on the Checking Out Drawings dialog box.
If you discover that you did not want or need to check out this drawing, you can undo the
checkout. For more information, see Undo a Drawing Checkout (on page 74).
Open Database — Opens the Projects dialog box, which allows you to specify a different
project or the Plant.
Filter — Opens the Filter dialog box, which allows you to specify the drawings that are
displayed in the List view.
Cancel Filter — Deactivates any ad hoc filter you have applied to the List view.
Include Subnodes — Displays all the drawings and node names that reside in the currently
selected node.
List — Displays the List view. The List view displays only one property for each drawing.
To specify which property displays, click Customize View . The first item in the Selected
Properties list is the property that appears in the List view.
Details — Displays the Detail view, which contains all the properties specified in the
Selected Properties list on the Customize Current View dialog box. Using the Detail view
allows you to view and sort drawings by several attributes.
Customize View — Opens the Customize Current View dialog box, which allows you to
specify the information about each drawing that is displayed in the List view.
Drawings — Lists the drawings that are being checked out, and shows the status of that
operation.
View Log — Opens the log file, CheckOut.log, which is created when you check out a drawing
version.
If you do not choose to remove the drawing from the project when you undo the checkout,
the drawing remains in the project as a fetched drawing with read/write permissions.
If the project has claimed items on the checked-out drawing, then clicking Undo Checkout
and using the Remove from project option, the software reminds you to release all claims
prior to undoing the check out.
Remove from project — Returns the drawing to the Plant and deletes it from the project. If the
project has claimed items on the checked-out drawing, you must release all claimed items
before you can undo checkout.
Leave in project — Returns the drawing to the Plant while leaving a fetched drawing with
read/write permissions in the project.
changes, if needed. Each change group is marked if it affects items you have claimed. You
should accept, or refresh, all of the changes that do not involve items claimed by you because
these items represent changes checked in by other projects.
Items must be claimed before you can delete them. If deleting an item results in changes to
related items, then those related items must be claimed also.
Check In a Drawing
1. In the List view, select the drawings that you want to check into the Plant.
3. On the Check In dialog box, select either Keep checked out and maintain claims,
Remove from project or Leave in project. If you leave the drawing in the project, it
becomes a fetched drawing with read/write permissions.
You cannot check in a fetched drawing. In order to check a drawing in, it must be checked
out. For more information about checking out drawings, see Check Out a Drawing (on page
70).
If your current active database is the Plant database, you cannot check in drawings. For
more information about changing databases, see Connect to a Database (on page 14).
When you check a drawing into the Plant, any claims on objects on that drawing are
automatically released. For more information about claiming items, see SmartPlant P&ID
Help.
When you check a drawing into the Plant, your version of the drawing becomes the current
version in the Plant. However, the version that was in the Plant already is automatically
saved as the previous version.
You can select a checked out drawing and use the Verify for Checkin command to make
sure claims and conflicts are resolved before you try to check in a drawing. For more
information, see Verify a Drawing for Checkin (on page 79).
If an invalid claim is found but the item in question matches the item in the Plant, run Verify
for Checkin to resolve this situation. This process automatically sets the claim to valid and
allows the check in to occur.
All objects that exist in the project but don't exist in the Plant must be claimed.
All objects that exist in the Plant but don't exist in the project (that is, they were deleted)
must have been claimed.
All objects that exist in both the Plant and the project must be identical if not claimed.
The claim state must be valid for the project.
If any claim on an object on this drawing is invalid then check in cannot occur.
The timestamp on all objects that exist in the project must be earlier than or equal to the
timestamp on the drawing.
Last Publish Date > Drawing date.
Check In not allowed if Drawing is in a Re-create state.
The Verify for Checkin for new drawings should ensure that all items on the drawing have
been claimed.
Enables you to check drawings into the Plant. This command is available only when drawings
are selected in the List view and when those drawings are checked out to the current project.
Drawings created in a project automatically belong to that project and can be selected and
checked in. This command is not available from within the Plant.
You must have the correct permissions, assigned in SmartPlant Engineering Manager,
before you can check drawings in or out.
You cannot check a drawing in if any of the objects that belong to that drawing were
modified after the latest version of a drawing was created. For more information about
creating versions, see Save a Version of a Drawing (on page 101).
If an invalid claim is found but the item in question matches the item in the Plant, run Verify
for Checkin to resolve this situation. This process automatically sets the claim to valid and
allows the check in to occur.
To be able to use this command, you must have Write permissions in the
..\SmartPlant\P&ID Workstation\bin folder.
Remove from project — Deletes the selected drawings from the active project's List view and
moves them into the Plant hierarchy.
Leave in project — Leaves a copy of the selected drawings in the active project's List view and
moves them into the Plant hierarchy. The version left at the active project is a fetched drawing
in read/write mode.
Keep checked out and maintain claims — Checks in the selected drawings to the plant, but
keeps the drawings checked out and maintains all claims to allow you to continue working on
the drawings in the project. This option is enabled only when the Enable "Keep Checked Out"
on check-in option is set to Yes in Options Manager.
Comments — Allows you to enter notes that apply to this check-in operation.
Major revision — Displays the new major revision for the selected drawings, if added.
Minor revision — Displays the new minor revision for the selected drawings, if added.
New Revision — Opens the New Revision dialog box and allows you to add a revision for the
drawings prior to check-in. The values that you enter appear in the Major revision and Minor
revision boxes.
Compare — Performs a comparison between the latest versions of the drawings in the active
project and As-Built. The Compare button is not available when you have selected more than
one drawing for check-in or if no drawing version exists in As-Built for the selected drawings.
Drawings — Lists the drawings that you selected to check into the Plant and displays the
progress of the process through the list.
View Log — Allows you to review the log file for the check-in operation when the task is
finished.
When you have verified the drawing for checkin, go ahead and check the drawing
into the Plant as soon as possible. Because the verification process does not freeze the drawing
state, there is no guarantee that changes are not made to the drawing during any interim time
between verification and actual check in. For more information, see Check In a Drawing (on
page 75).
You cannot check in a fetched drawing, it must be checked out first. You can, however,
check in a new drawing created in the project. For more information about checking out
drawings, see Check Out a Drawing (on page 70).
Verifying a drawing for checkin checks exactly the same drawing conditions as the Check In
command, but without actually checking the drawing into the Plant.
If an invalid claim is found but the item in question matches the item in the Plant, run Verify
for Checkin to resolve this situation. This process automatically sets the claim to valid and
allows the check in to occur.
Drawings — Lists the drawings that are being verified for checkin, and shows the status of that
operation.
View Log — Opens the log file that is created by the verification process.
Displays the projects that have fetched or checked out the selected drawing. This command is
available in the Plant and in any of its projects. You can select more than one drawing and
display their statuses at the same time.
The Drawing Status dialog box displays information about the project and the user who
changed the status, the time of the change, and any comments that were added during the
status change. These comments can be entered during any status-changing operations, such as
fetching, checking out, checking in, and undoing a checkout.
b. Create the following Assembly A-1 and assign the item tags as shown.
Choose vessel type Equipment > Vessels > Vertical Drums > Short 1D 1C 1to1.
Place both OPC partners in the Plant Stockpile.
c. Open Drawings B, C, D, and G and place Assembly A-1 in each of the drawings.
The software assigns unique item tags to the vessel, pipe runs, and OPCs in
each drawing.
d. Open Drawing E and place the instrument OPC partner from Drawing D.
4. In SmartPlant P&ID Drawing Manager, create a version of Drawing G and make a note of
the version number (1).
5. In SmartPlant Engineering Manager, do the following:
a. Enable projects for the plant.
b. Create three projects: Project 1, Project 2, and Project 3 and for each, set the Project
Scope at the level of the unit in which you created the drawings.
c. Define Roles for each of the projects if not defined already.
6. In SmartPlant P&ID Options Manager, set the Claim Mode option to Shared.
Undo a Checkout
Before performing this scenario, ensure that you have completed all the prerequisite
activities described in Sample Project Workflows (on page 82).
1. In Project 1, check out Drawing A from the Plant.
2. Open Drawing A and do the following:
a. Claim Vessel V-100.
b. Find and replace Vessel V-100 with a 1 to 1 Parametric V Drum.
c. Exit Drawing A.
Drawing A becomes Drawing A'.
3. In Project 2, fetch Drawing A' from Project 1.
4. In Project 1, execute the Undo Checkout command on Drawing A', leaving Drawing A' in
Project 1.
5. In Project 2, open Drawing A' and do the following:
a. Claim Nozzle N1.
b. Change the Tag Sequence Number of the nozzle to 4.
c. Exit Drawing A'.
Drawing A' becomes Drawing A''.
6. Check out Drawing A from the Plant to Project 2 without replacing the existing P&ID.
Drawing A becomes Drawing A''.
7. In Project 2, perform the following steps:
a. Attempt to check in Drawing A''.
b. View the check in log file.
Unclaimed changes prevent check in.
Key
Fetch drawing
Check in drawing
Check-in unsuccessful
The claim status for the items indicates that they have already been claimed by
another project.
b. Change the Tag Sequence Number for the vessel to 110.
c. Change the Construction Status of the vessel from New to Existing.
d. Exit Drawing B.
Drawing B becomes Drawing B'.
5. In Project 1, open Drawing B and do the following:
a. Place an Area Break around the vessel and Nozzle N1.
b. Place an Alt Dgn Press-Temp Equipment Label on the Area Break.
c. Select the Area Break, right-click, and on the shortcut menu, click Select Contents.
d. In the Properties window, if you cannot see the pressure and temperature properties,
select Show Case Data for the Select Set to display those properties.
e. Assign Alt Dgn Max Press of 100 psi.
f. Assign Alt Dgn Max Temp of 101 F.
g. Exit Drawing B.
Drawing B becomes Drawing B''.
6. In Project 1, check in Drawing B'' with removal of the drawing from the project and then do
the following:
a. Click Project > Project Status.
b. Click Complete Project.
c. Click Merge Project to merge Project 1 into the Plant.
If you complete and merge Project 1, you will not be able to use it for the other
workflows unless you delete and re-create Project 1. If you want to continue without
deleting and re-creating the project, you should skip both the Complete and Merge
operations until you have completed all of the workflows.
7. In Project 2, check out Drawing B'' without replacing the existing P&ID.
Drawing B'' becomes Drawing B' in Project 2.
8. In Project 2, attempt to check in Drawing B'.
Invalid Claim prevents check-in.
9. In Project 2, compare Drawing B' with the drawing in the Plant and do the following:
a. Refresh Drawing B' for the Area Break and label and all other differences that result in
invalid claims.
Key
Fetch drawing
Check in drawing
Check-in unsuccessful
Key
Fetch drawing
Check in drawing
Check-in unsuccessful
Delete drawing
Key
Fetch drawing
Check in drawing
Check-in unsuccessful
13. In Project 2, check in Drawing H', leaving the drawing in the project.
14. Open Drawing H' and do the following:
a. Claim OPC1, OPC2, and OPC3.
b. Exit Drawing H'.
Drawing H' becomes Drawing H''.
15. In Project 3, check in Drawing I''.
Key
Fetch drawing
Check in drawing
Check-in unsuccessful
Saves a new version of the selected drawing. The New Version dialog box opens, allowing you
to add comments to the version as you create it.
Previously saved drawing versions are available to be viewed, compared, and fetched, if
necessary. If drawing versions are saved on a regular basis, the sequence of drawing versions
in a project becomes a sort of archive that shows the development of the drawing over the life of
the project.
Each time a drawing is checked into the Plant database, a new version of the drawing is
automatically created in the Plant and all versions of that drawing are deleted from the project.
The drawing versions in the Plant show the changes to the drawing over the life of the Plant.
Drawings — Lists the versions that are being created, and shows the status of version creation
process.
View Log — Opens the log file that is created when you save a new version.
Click View Log on the Creating Version of Drawings dialog box to open the log file and
review notes on the version creation operation.
New Version skips open drawings, notes them in the log, and then continues.
If no changes have been made to the drawing since the last version was created, no new
version is created.
Use the Schedule button to create a task for creating drawing versions at a later time or on
a regular interval. Follow the instructions on the Schedule Task Wizard (for details, see
Scheduling Tasks (on page 235)).
When a drawing is checked in to the Plant, all versions are deleted from the project.
When a drawing version is created, it is stored in a database segment named
LOBSEGMENT. This space is not reclaimed when drawing versions are deleted. However,
if you delete the older version of a drawing before creating a new version, then the database
size will not increase rapidly. Deleting older version will create free space in LOBSEGMENT
(without decreasing the total LOBSEGMENT size) which will be available for storing future
drawing versions.
When saving versions of all drawings in a Plant that has projects, new versions of the
drawings belonging to those projects are created also.
This procedure saves new versions of only those drawings whose time stamp shows that
they have changed since the last version was saved.
Instead of creating versions of a set of drawings, you can create a version of a single
drawing. For more information, see Save a Version of a Drawing (on page 101).
Opens the Version History dialog box, which displays a record of the versions of the selected
drawing and allows you to view the drawing or compare the drawing with other versions of the
drawing.
History — Lists all the versions of the drawing in the current plant or project.
Compare — Opens the Compare dialog box, allowing you to compare two versions in the
History list. This button is not available unless two versions are selected in the list or if you open
this dialog box by clicking History on the Fetch dialog box. Use the Compare With button to
compare one version in the active project to a version in another project or the Plant.
Compare With — Opens the Compare With dialog box, allowing you to find a drawing version
in a different project or in the Plant to compare to the drawing version you select in the History
list. The Compare With button is not available if you open this dialog box by clicking History
on the Fetch dialog box.
View — Opens the View dialog box, which displays a read-only view of the selected drawing
version without opening SmartPlant P&ID. You can manipulate the view or select drawing items
and review their properties.
Fetch — Opens the Fetch Comments dialog box. This button is available only if you have
selected one, and only one, version in the History list and that drawing is not the current
version. The Fetch button is not available if you open this dialog box by clicking History on the
Fetch dialog box.
Delete — Removes the selected drawing version. You must have the appropriate permissions,
assigned in SmartPlant Engineering Manager, to delete versions. You cannot delete the current
version of a drawing by using this button. However, you can delete the current version of a
drawing by using the Delete command on the Edit menu on the main menu bar. If the selected
version is one that was created especially for the last revision using the Associate Version
command, then you cannot delete the version unless you first delete the revision.
Print — Opens the Print dialog box where you can specify options for printing your
drawings.
Zoom In — Enlarges the display of items around a specified point in the active window.
Zoom Out — Reduces the display of items around a specified point in the active window.
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.
Select Tool — Changes the pointer to the arrow-shaped selection pointer so that you can
select items. The circle at the end of the pointer arrow is the locate zone.
Help — Displays contents for the Help topics that include step-by-step instructions for using
Drawing Manager.
Drawing View — Displays the graphical view of the selected drawing version.
Properties Window — Displays the properties associated with a drawing item that you select in
the Drawing view.
Selected Items List — Itemizes all of the selected objects individually and as a select set.
Categorized Button — Displays item properties categorically. Categories are defined and
assigned in Data Dictionary Manager. This button acts as a toggle and is available when
properties are displayed alphabetically.
Use the View command to open a read-only display of a selected drawing version. For more
information, see View a Drawing in Drawing Manager (on page 25).
Use the Compare command to compare two drawing versions selected in the History list.
For more information, see Compare Drawing Versions (on page 111).
If the drawing exists in other projects, use the Compare With command to compare this
version to a version in another project or in the Plant. For more information, see Compare
Drawing Versions for As-Built and Projects (on page 117).
Use the Delete command to delete a selected drawing version. You cannot delete the
current drawing version.
Recovering Drawings
The following areas require special consideration with regard to saving new drawing versions
and how retrieving a drawing effects the actions that can occur in the Plant between saving a
version and retrieving it. These actions have serious implications when recovering (using the
Fetch Deleted Drawing command) a drawing. In all drawing recovery activities, a log file is
created in which you can review notes on any recovery activity that you are undertaking.
Multiple Representations
After a drawing is recovered, there are situations where multiple representations of piping and
equipment items can spontaneously occur. For example, you place a piece of equipment on
drawing A and then you save a version of drawing A. After creating a version of drawing A, you
move the equipment from drawing A to the Plant Stockpile and then to drawing B. When
drawing A is retrieved, the following message is added to the log file:
Item (item tag ItemTag, internal ID SP_ID) is being restored as a multiple
representation because another representation of the same item was found
in drawing Drawing Name.
Encountering this situation does not cause the retrieval to fail; the retrieval process continues as
normal.
If an equipment item already exists as a multiple representation in another drawing, the following
message is added to the log file:
Restoring multi representation item (item tag ItemTag, internal ID
SP_ID).
Encountering this situation does not cause the retrieval to fail; the retrieval process continues as
normal.
If other valid stockpile items are moved from drawing A to drawing B, the following message is
added to the log file:
Error ! Item (item tag ItemTag, internal ID SP_ID) has been moved to
drawing Drawing Name.
To resolve this conflict, you must either delete the indicated item or restore the indicated
drawing first. If you delete the item, then the item can either be deleted to the Plant Stockpile or
deleted from the model. This error message is created for each moved item, and the retrieval
process quits without restoring the archive.
Miscellaneous
If a drawing is deleted after a version is saved and a new drawing is created using the same
name and drawing number as the deleted drawing, retrieval of the deleted drawing fails.
Changing drawing properties, such as name, number, and so forth, after saving a version of a
drawing results in the original values being restored when the drawing is recovered. If this
situation occurs, the following message is added to the log file:
Warning! Drawing drawing name1 has been renamed to new drawing name2.
Drawing Manager changes the drawing back to its original name, drawing name1, in the
database. The original .pid file pathname\drawing name1 is also replaced. You must delete the
.pid file for pathname\drawing name2.
You must have either site administrator or modify privileges to save versions or recover
drawings.
You cannot restore hierarchy items by using drawing recovery. For example, if a unit is
deleted, an archived drawing belonging to that unit can never be retrieved.
2. Click Revisions > Version History or click the Version History button .
3. On the Version History dialog box, select the version of the drawing you want to recall.
4. Click Fetch and enter comments on the Fetch Comments dialog box.
5. On the message box, click Yes to confirm that you want to overwrite the current version with
the saved version you have selected.
6. Click View Log on the Fetching Drawings dialog box if you want to see notes about this
operation.
You can also recover a version of a drawing by clicking Fetch . Using the Fetch
command is particularly useful if you want to recover a version of your drawing that resides at
the Plant or another project. For more information, see Fetch a Drawing (on page 68).
Drawings — Lists the drawings that are being retrieved, and shows the status of that operation.
View Log — Opens the log file that is created when you perform a drawing recovery operation.
This action is irreversible; drawings cannot be recovered after being deleted permanently.
It is not possible to permanently delete drawings that have been checked out or fetched by
other projects.
4. On the Fetching Deleted Drawings dialog box, click View Log to review notes about this
retrieval process.
All the saved versions of the selected drawing are retrieved. You can view the various
versions by selecting the drawing in the List view and clicking Revisions > Version
History.
If you retrieve a drawing that was new to your Plant or project, then the drawing icon for a
new drawing will be applied; otherwise, the drawing icon for a fetched drawing is used in the
List view.
You can also compare the differences between the typicals of either drawing. Using the select
list situated in the drawing name bar of each view, you can display the primary, typical, or both
views of the selected version.
The Compare dialog box in Drawing Manager is useful reviewing differences between versions
only. If you want to reconcile anything about the two versions you review, then you must do so
inside SmartPlant P&ID. The Compare and Refresh command in SmartPlant P&ID exists for
this purpose. If you started with the left-hand drawing version and applied every change listed
on the Compare dialog box, then you would end with a drawing that is identical to the right
drawing version. For more information about reconciling two versions, see SmartPlant P&ID
Help.
You can manipulate the views and navigate through the listed changes by using the
commands on the Compare dialog box toolbar. Each Drawing view also has its own
shortcut menu, which includes manipulation commands that apply only to that view.
You can select an item in either Drawing view. The item is then located in the appropriate
group in the Change details list. If you select an item in the Change details list, then you
can use the Find in Drawings button on the toolbar to locate the item in one or both
Drawing views.
You can select an item in the Drawing view or in the Change details list. Properties for that
item appear in the Properties window. Selecting multiple items is not possible on the
Compare dialog box.
The following differences are ignored: claim status, select list strings, linked or embedded
objects, symbology, and inconsistency indicators.
You can only compare a drawing against a version of itself; that is, you cannot compare one
drawing to another drawing.
You can also compare versions when you are checking in a drawing. For more information,
see Check In a Drawing (on page 75).
If at any point you attempt to compare two versions that are actually identical to each other,
the Compare dialog box does not open and a confirmation message alerts you as to why.
Toolbar Commands
The toolbar commands apply to the Drawing views.
For icons that display a drop down-arrow, you can apply the command to either the right
or left view.
Compare Options — Opens the Compare Options dialog box, which allows you to
customize the colors that the various comparison states are displayed in. That color coding is
then displayed in the status bar as a static reminder.
Generate Report — Opens Microsoft Excel and creates a report of the information
contained in this comparison session. This report lists the same information that is displayed in
the Change groups and Change details lists (change groups, item types, claim statuses, and
so forth).
Find in List — Zooms to the Change details list entry that corresponds to an item you
select in either Drawing view. In general, if you select a drawing item that exists in the list,
then the list display automatically zooms to that entry.
Find in Drawings — Manipulates the Drawing views so that the selected element is listed
in the Change details and the Change groups list is centered in the appropriate Drawing view.
You must first select an item in either the Change groups or Change details area.
Zoom Area — Enlarges the selected area in one or both Drawing views by allowing you to
draw a fence around the area.
Zoom Out — Reduces the display of the selected area where you click.
Fit — Fits all the drawing elements into the visible viewing area of the active
drawing. Selecting part of the drawing and clicking Fit fits the selected area into the visible
viewing area of the active drawing.
Pan — Allows you to move the display in any direction from a specific point in one or both
Drawing views in order to see other areas of the view by dragging the pointer across the
display.
Drawing Views
The left and right drawing views display the two versions of your drawing being compared. The
display above the drawing view shows the drawing name and the version. The select list in the
display allows you to choose the drawing layers to be compared and can be selected
individually for each version. Possible select list values are Primary, Typical, or Both.
If you compare two versions from different projects, the version that belongs to the other project
appears in the left Drawing view and the version that belongs to your active Drawing Manager
project appears in the right Drawing view. If you compare two versions from your active
project, then the latest version appears in the right Drawing view.
At the top of each Drawing view, the Plant or project, the name of the drawing, and the version
is displayed explicitly. You can move the bars between the different views according to your
needs. If you double-click on the divider between the left and right Drawing views, then the
software automatically adjusts the two views to be the same-size.
Properties Window
Displays two columns of properties for an item selected in a Drawing view or in the Change
details list. The left-hand and right-hand columns correspond to the left and right Drawing
views. If a deleted item is selected (the item exists in left view, but not the right view), the
properties for that item are listed in the left-hand column and the right-hand column is empty. If a
modified item is selected, values from both versions show in their respective columns in the
Properties window. If a new item is selected, that is, the item exists in right view, but not the left
view, the properties for that item are listed in the right-hand column and the left-hand column is
empty.
Properties Commands
Allows you to customize the properties that are displayed in the Properties window.
Alphabetical — Lists properties in alphabetical order. This button acts as a toggle and is
available when properties are displayed categorically.
Show Modified — Toggles the display of only those properties of the selected drawing item
that are different in the versions. This button applies only to modified items that exist in both
versions; for added and deleted items, all properties are listed.
Change groups
Lists the changed items in groups. A listed item contains all the items this change effects. You
can sort the list be clicking the column headings.
For SmartPlant P&ID Engineering, the refresh action is not allowed.
Check box column — Displays colors in the drawings as defined using Compare Options. If
not selected, the Default items color displays.
Number — Displays an arbitrary number that is assigned to a logical change group when this
dialog box is opened. The number has no intrinsic meaning and may apply to a different group
the next time you open this dialog box.
Identifier — Lists item tags for the principal member of the change group, if an item tag is
assigned to that object. For instance, if a change group centers around data differences for a
vessel and its nozzles, then the item tag for the vessel is displayed in this column.
Category — Displays the category of the change, listed in order of highest to lowest priority.
Options include:
Data — Indicates that a property value has changed (for example, a property value for a
vessel).
Graphic — Indicates that a change has been made to an item in the drawing (for example,
a vessel has been moved).
Claimed — Displays an overview of the claim status of the individual items in the group.
Possible values are All, Some, or None.
Valid Claim — Indicates that the claimed item is a valid claim.
Change details
Lists all the individual items that belong to the group that you select from the Change groups
list. You can sort this list by clicking on any of the column headings.
Result — Displays one of three possible values: Left-Only, Right-Only, and Different.
Left-Only denotes an item that exists in the left-hand version only, implying that the item is
deleted from the right-hand version. Right-Only denotes an item that exists in the right-hand
version only, implying that the item was added to the right-hand version. Different denotes a
difference between the properties or graphical elements of an item that exists in both versions.
Item Type — Describes the item type, such as Instrument, PipeRun, or Nozzle.
Specific Item Type — Displays the specific type of item, such as 3-Way Ball Valve, Piping, or
Flange Orifice.
Item Tag — Displays the item tag of the individual item in question if a tag has been assigned to
the item.
Category — Displays the highest priority category of change that applies. Possible categories
are:
Data — Indicates that a property value has changed (for example, a property value for a
vessel).
Graphic — indicates that a change has been made to an item in the drawing (for example,
a vessel has been moved).
Claimed — Displays the claim status of the object:
— Valid claim
— Invalid claim
Not claimed.
Added to Primary
Added to Typical
Moved to Typical
Moved to Primary
No Change in Typical
No Change in Primary
Status bar — Displays the currently defined colors for illustrating comparison status. You can
change the color scheme by clicking the Compare Options button on the toolbar and
defining options on the Compare Options dialog box.
Left-only items — Allows you to choose a color for displaying objects that exist only in the
left-hand Drawing view. Dark green is the default color for this option.
Right-only items — Allows you to choose a color for displaying objects that exist only in the
right-hand Drawing view. Red is the default color for this option.
Different items — Allows you to choose a color for displaying items that exist in both views but
differ from each other for any number of reasons (for example, modified properties, changed
connectivity, and so forth). Blue is the default color for this option.
Default items — Allows you to choose a color for displaying 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.
You can manipulate the views and navigate through the listed changes by using the
commands on the Compare dialog box toolbar. Each Drawing view also has its own
shortcut menu, which includes manipulation commands that apply only to that view.
You can select an item in either Drawing view. The item is then located in the appropriate
group in the Change details list. If you select an item in the Change details list, then you
can use the Find in Drawings button on the toolbar to locate the item in one or both
Drawing views.
You can select an item in the Drawing view or in the Change details list. Properties for that
item appear in the Properties window. Selecting multiple items is not possible on the
Compare dialog box.
The following differences are ignored: claim status, select list strings, linked or embedded
objects, symbology, and inconsistency indicators.
You can only compare a drawing against a version of itself; that is, you cannot compare one
drawing to another drawing.
You can also compare versions when you are checking in a drawing. For more information,
see Check In a Drawing (on page 75).
If at any point you attempt to compare two versions that are actually identical to each other,
the Compare dialog box does not open and a confirmation message alerts you as to why.
Available Databases — Lists all the different databases that currently have a version of the
drawing you chose on the Version History dialog box.
History — Lists all the versions of the chosen drawing in the database you selected in the
Available Databases list.
Name — Specifies the printer that 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 that 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 specific to the selected printer.
Status — Describes the state of the selected printer, for example, 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.
Print range — Allows you to select the following options:
Drawing — Prints the entire drawing based on the defined page size.
View — Prints the portion of the drawing that is actually visible in the Print Preview window.
Number of copies — Allows you to specify the number of copies of the drawing to be printed.
Collate — When the number of copies is more than 1, selecting this check box collates the
output by printing all the pages consecutively for each copy. Clearing the check box causes the
same page of each copy to be printed together for the number of copies specified.
Settings — Opens the Settings dialog box, which allows you to view and edit the scale and
origin of your print area.
Revising Drawings
The software implements drawing revisions in different ways depending on your work
environment. If you are working in an integrated environment, when you select the New
Revision command, the software opens either the SmartPlant Foundation Revise dialog box or
the New Revision dialog box, depending on the option selected in Options Manager for the
Revision Management Software for Publishing Documents setting. If you want to associate
a version with a new revision in an integrated environment, you must select the drawing and run
the Revisions > Associate Version command after creating the revision.
Revising a document creates a revision for the document with major and minor revision values
set, depending on the revision schema selected. When revising a document, you can modify the
major and minor revision data on the document.
You can change the revision scheme after a document has been published, skip revision
numbers, and manually add a revision number, then have it validated against the revision
scheme. It is not required to assign a minor revision number. Also, revision data from tools is
supported even if the document has previously been revised in SmartPlant Foundation.
You can revise a document by using any previous revisions that are available from
the last published revision.
Example:
If you revise a new document using the revision scheme RevAlpha (A, B, C, D…) and revision
C, then SmartPlant Foundation reserves revision number C for the document. Revising the
same document with RevAlpha, you can now revise with any previous revision numbers, such
as A or B. However, if the document is published to SmartPlant Foundation with revision number
C, you are not allowed to go back to the previous revision numbers.
The following table contains the available revision numbers based on the document revision
state in SmartPlant Foundation:
The current revisions scheme used in the As-built is displayed as the default revision scheme
The combination of the major and minor revision values must be unique in the plant, or
when working with As-Built, in the project.
When you check out or fetch a drawing from the As-Built into a project, only the last revision
record is displayed on the Revision History dialog box, regardless of whether that revision
is associated with a version or not.
On the Revision History dialog box, the Delete command is disabled if the plant is
registered with SmartPlant Foundation, regardless of any permission settings.
3. In the Status section, select a major revision number and if desired, a minor revision
number.
After creation of the revisions, the drawings remain selected.
See Also
Revising Drawings (on page 120)
New Revision Command (Revisions Menu) (on page 125)
New Revision Dialog Box (on page 125)
Revise Dialog Box (on page 126)
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard and if the authoring tool has implemented the
SmartPlant Foundation revision functionality.
If you logged onto the authoring tool with a user name that is not defined in the
integrated environment, you are prompted to log on when you use this command.
The documents that appear in the documents tree view on the Revise dialog box when
it first appears are documents that were selected within the authoring tool before you
clicked the Revise command. Click Engineering Tool to add documents from
authoring tools. Click Delete to remove a document from the list.
You can revise documents in an integrated environment from the Publish dialog box.
For more information, see Revisable and Locked Documents.
3. For a new document or a document that does not yet have a defined revision scheme,
select the revision scheme you want to use from the Revision Scheme Name list.
Only revision schemes that are applicable to the configuration (plant) or classification
(document type) are available in the shortcut menu. The revision schemes related to a
configuration or classification are not available for any other configurations or
classifications. If none of the revision schemes are related to the configuration or
classification, then all revision schemes are available unless they are related to any
other configuration or classification. For more information on revision scheme
The current revisions of the tool will not be available in the Major and Minor list. You
can select the current revisions of the tool only if they are not active.
If the Allow skipping revisions option is set to False on the Manage Integration
Options dialog box in SmartPlant Foundation Desktop Client, you are limited to which
revisions you can select.
5. Click OK. The document currently available for retrieval by other authoring tools is not
updated until you publish this revised document.
After creation of the revisions, the drawings remain selected.
See Also
Revising Drawings (on page 120)
New Revision Command (Revisions Menu) (on page 125)
New Revision Dialog Box (on page 125)
Revise Dialog Box (on page 126)
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard and if the authoring tool has implemented the
SmartPlant Foundation revision functionality.
If you logged onto the authoring tool with a user name that is not defined in the
integrated environment, you are prompted to log on when you use this command.
The documents that appear in the documents tree view on the Revise dialog box when
it first appears are documents that were selected within the authoring tool before you
clicked the Revise command. Click Engineering Tool to add documents from
authoring tools. Click Delete to remove a document from the list.
You can revise documents in an integrated environment from the Publish dialog box.
For more information, see Revisable and Locked Documents.
2. In the Revision Scheme list, select RevA01.
3. In the Revise in Tool > Major list, select B as the major revision for the document.
4. Click OK. The revised document is saved to the authoring tool database. The document
currently available for retrieval by other authoring tools is not updated until you publish this
revised document.
5. Revise the document again. In the Revise in Tool > Major list, change the major revision to
C.
6. Click OK.
7. Publish the document.
The document is revised in a tool to make additional changes. The tool manages its
own revision schemes and sets the revision of the document to 5. Rather than selecting a
revision scheme to match the tool revision scheme, you choose a new revision scheme.
8. Click Revisions > New Revision. The Revise dialog box displays.
9. In the Revision Scheme list, select RevA01.
In the Revise in Tool > Major list, the first major revision is A. A is the first available
revision because the document has not been previously published in SmartPlant
Foundation.
Opens the New Revision dialog box, allowing you to create a new revision for the selected
drawings and to enter values for the revision properties. You can also associate a version with
a new revision.
If you are working in an integrated environment, when you select the New Revision
command, the software opens either the SmartPlant Foundation Revise dialog box or the New
Revision dialog box, depending on the option selected in Options Manager for the Revision
Management Software for Publishing Documents setting.
(Properties and Values List) — Displays a list of shipped properties used for the revision. You
can specify additional properties for display on this dialog box by defining them in the Data
Dictionary Manager. Note that Major Revision is a mandatory property and that the
combination of the Major Revision and Minor Revision values must be unique in the plant or
project.
Associate version — Check to associate drawings. When you click OK, the New Version
dialog box opens, which allows you to create a new version and associate it with the revision.
OK — Generates the new revision, and if specified, an associated version. This command only
becomes available when you enter a value for Major Revision.
Engineering Tool - Displays an authoring tool-specific dialog box that allows you to select
documents to add to the tree view list.
Delete - Allows you to remove a document from the tree view list.
Documents list - Displays a list of the documents selected to be revised. You populate this list
by selecting documents before activating the Revise command. You can click the Delete button
to remove documents from this list.
Revision Scheme > Name - Choose the revision scheme to be applied from the list of available
options. Only revision schemes that are applicable to the configuration (plant) or classification
(document type) are available in the drop-down menu. If none of the revision schemes are
related to the configuration or classification, then all revision schemes are available. For more
information on revision schema configuration, see Configuring Different Revision Scheme
Strategies in the How to Configure Document Management guide.
Revision Scheme > Major Type - For the selected revision scheme, this box displays the type
of the major revision value sequence in read-only format.
Revision Scheme > Minor Type - For the selected revision scheme, this box displays the type
of the minor revision value sequence in read-only format if the revision scheme contains a minor
revision scheme.
Current Revision in Tool > Major - For existing documents, this box displays the current major
revision of the document, as defined in the authoring tool, in a read-only format. For new
documents, this box is empty.
Current Revision in Tool > Minor - For existing documents, this box displays the current minor
revision of the document, as defined in the authoring tool, in a read-only format. If the revision
scheme does not use minor revision, or if the selected document has not yet been revised, this
box is empty.
Revise in Tool > Major - From this list box, choose the major revision value for the document to
revise it locally and to reserve the revision in SmartPlant Foundation.
Revise in Tool > Minor - From this list box, if you want a minor revision value, choose a minor
revision value for the document to revise it locally and to reserve the revision in SmartPlant
Foundation.
An Administrator can disable the skipping of revision numbers using the Manage
Integration Options in the SmartPlant Foundation Desktop Client. For more information, see
Configure Skip Revisions in the Integration Administrator's guide.
(Properties and Values List) — Displays a list of shipped properties used for the revision. You
can specify additional properties for display on this dialog box by defining them in the Data
Dictionary Manager. Note that Major Revision is a mandatory property and that the
combination of the Major Revision and Minor Revision values must be unique in the plant or
project.
Associate version — This option is not available on this dialog box.
Opens the New Version dialog box, which allows you to associate a version with the last
revision of the selected drawings. Once you associate this version, it can only be deleted at the
same time as you delete the revision.
Opens the Revision History dialog box, which displays the revisions of the selected drawing.
History
Lists all the revisions of the drawing in the current plant or project. Note that when you check
out or fetch a drawing from As-Built into a project, only the last revision record is displayed on
this dialog box, regardless of whether that revision is associated with a version or not.
Major Revision — Indicates the number or other designation of the major revision. This is a
required property, so a value will always appear in this column.
Minor Revision — Indicates the number or other designation of the minor revision. This is not
a required property, so a value may or may not appear in this column.
Revision Date — Shows the date on which the revision was created.
Approved By — Shows the name of the person who approved the revision.
Created By — Shows the name of the user who created the revision.
Checked By — Shows the name of the person who checked the revision.
Revision Properties — Opens the Revision Properties dialog box, allowing you to view or edit
all of the revision properties.
Associate Version — Opens the New Version dialog box, allowing you to create and associate
a new version with this revision. This option is only available for the last revision.
Delete — Removes the selected drawing revision. To be able to delete revisions, you must
have appropriate permissions assigned in SmartPlant Engineering Manager. If the revision has
an associated version, the software deletes the version together with the revision.
The Delete command is disabled if the plant is registered with SmartPlant Foundation,
regardless of any permission settings.
Saving Drawings
You can save SmartPlant P&ID drawings in the following formats:
AutoCAD (*.dwg and *.dxf)
MicroStation (*.dgn)
PDF (*.pdf)
ISO 15926 (*.xml)
SmartPlant P&ID uses the ExportLayer.xlsx file to map drawing item types to the layers that
they will be assigned to. Filters are used to define the scope of the item type, for example
'New Equipment'. The file then specifies the layer to which the scoped item type will be
assigned. If a symbol’s item type does not match any of the filter definitions and if that
symbol is in the Primary drawing layer (the only active layer when saving from Drawing
Manager), the symbol is saved in the Default layer. If a display set is assigned to the
drawing and the Color value of filtered or background items is None, the software ignores
the ExportLayer.xlsx file and those items go to the hidden layer in AutoCAD or MicroStation.
If the Color value of filtered or background items is not None, filtered items go to the layer
specified by the filter and background items go to the default layer unless a filter exists in the
ExportLayer.xlsx file for a particular item or set of items, in which case the settings in the
ExportLayer.xlsx file override the display set settings for those background items.
For details of the supported versions of AutoCAD and MicroStation for these formats, refer
to the SmartPlant P&ID Installation and Upgrade Guide, Hardware and Software
Recommendations under the section SmartPlant P&ID Workstation > Optional Software.
The PDF printer that the current version of the software supports is SmartPlant PDF
Converter (Amyuni 4.5).
The ISO 15926 (*.xml) format is available only if you have a valid license ID and you have
run a procedure that activates this option. For details, see Enable Save As XML (on page
135).
For multiple drawings, in the Folder path field, type the path to an existing folder where
you want to save the files, or click Browse to open the Browse for Folder dialog box to
navigate to the desired folder.
4. From the Save as type list, select one of the following formats:
AutoCAD (*.dwg and *.dxf)
MicroStation (*.dgn)
PDF (*.pdf)
ISO 15926 (*.xml)
The value of the Override Layers on Export attribute in the pidacad.ini file affects the
output when saving a file as AutoCAD. If symbols are exported as blocks (when the
value of the Dissolve Symbol to Groups attribute is set to 0), you must specify a value
of 2 or 3 for the Override Layers on Export attribute to ensure that the blocks are
exported to the correct AutoCAD layer. For full details of the Override Layers on
Export attribute, see Configuration File Settings for AutoCAD Translation (on page
136).
The ISO 15926 (*.xml) format is available only if you have a valid license ID and you
have run a procedure that activates this option. For details, see Enable Save As XML
(on page 135).
5. When saving to AutoCAD or MicroStation, to use a display set to filter the layers to which
the drawing items are sent, do the following:
a. Under Save filter, click Apply display set.
b. Beside the Active display set field, click Browse to open the Apply Display Set dialog
box.
c. Select a display set.
When saving to AutoCAD or MicroStation, the software checks the ExportLayer.xlsx file
and if it finds a reference to a filter that does not exist in the reference data, a Filters
Not Found dialog box is displayed showing a list of missing filters. When you click Exit
to dismiss the dialog box, the save as process stops.
When saving to AutoCAD or MicroStation using a display set, the software uses the
ExportLayer.xlsx file only for filtering items that do not meet any of the display set filter
criteria and for which the Color value of filtered or background items is not None.
The dependent behavior of drawing items on the color value of display sets is as
follows:
Specific color Layer is created with name of Items are mapped according to
display set filter and filtered items go filters in the ExportLayer.xlsx file.
to that layer with the color specified Colors specified by the display set
by the display set filter. If Override filter are ignored for items mapped to
Layers on Export = 2 in the layers that appear in
pidacad.ini or pidmstn.ini file, the ExportLayer.xlsx, and the colors of
color from the seed file overrides the those items are assigned according
display set filter color for the to the Override Layers on Export
particular layer. setting. Items sent to the Default
layer are assigned the background
items color from the display set.
None Items are sent to the HiddenObjects Items are sent to the HiddenObjects
layer and the ExportLayer.xlsx file layer and the ExportLayer.xlsx file
settings are ignored. settings are ignored.
For a display set that contains one or more asking filters, on clicking OK in the Save As
dialog box, the Asking Filters dialog box opens with the default values for each asking
filter, allowing you to change the operators and values of each asking filter's attributes
for the selected drawings, if desired.
6. When saving as PDF, click PDF Settings to open the PDF Settings dialog box, where you
can specify the resolution, color mode, JPEG compression, and whether or not to include
inconsistency markers in the output.
Options
Name of Setting Description Import Export Default Value Accepted Values
Seed File Name of a seed file used for No Yes pidacad.dwg Filename
export (not mandatory).
Enable Logging If set, a log file will be created Yes Yes 0 0 = Logging is turned
in the directory that the file OFF
was opened from and will
have the same name as the
file that was opened. 1 = Logging is turned
ON
Template File Sets the document that will be Yes No TransAcad.igr Filename
used as a template when
importing foreign data for (If this file is
setting up hatching and required, it can be
patterns. taken from the
SmartSketch folder)
Symbol Template Sets the symbol file that will Yes No Filename
File be used as a template when
importing foreign data.
Ignore Sheet Scale Determines whether to scale Yes No 1 0 = Do not fit the
the sheet to fit the graphics graphics to the sheet
during a translation import.
Processing Batch If set, progress bar dialog Yes Yes 1 0 = Progress Bar
Translation boxes do not display during display is turned ON
the translation.
1 = Progress Bar
display is turned
OFF
Attribute Sets Controls the import / export of Yes Yes TranslationSettings String consisting of
attribute information on attribute names
objects during translation. delimited by
semicolons, or the
ALL keyword
Read Block Sets how the blocks imported Yes No Shared Embeds Shared Embeds -
Options from AutoCAD are handled. Preserves blocks
Rigid Groups -
Translates blocks
into groups
Write Version Sets the version of the foreign No Yes 2012 2000; 2002; 2004;
file format that is created on 2005; 2006; 2007;
export. 2008; 2009; 2012
1 = All graphic
objects are exported
into the Paper space.
SmartFrames with
clipping boundaries
display properly.
Detail views are
ignored.
2 = All graphic
objects are exported
to Modelspace and
Paper space is
populated so that the
original SmartSketch
sheet is re-created.
Application Text Determines whether text Yes Yes 1 0= Text origin always
Type origin and justification are in upper left corner
preserved.
1= Origin preserved
1 = Horizontal text
alignment is set to
Left
1 = Attributes are
created as
SmartLabels
1 = ON
1 = ON
1 = Include
non-displayable
objects
1 = Attributes are
created
Metafile to Raster Sets the dpi resolution for No Yes 350 dpi resolution (1
DPI Resolution raster metadata during export. through 1200)
1 = Delete symbol
definitions
Merge References Controls whether files of type No Yes 2 0 = Save inserted igr,
.igr, .dwg, .dgn, and .dxf that .dwg, .dgn, and .dxf
were inserted into a files as separate
SmartPlant P&ID drawing are .dwg files
merged into the main .dwg file
when saving to AutoCAD.
Inserted Office documents are 1 = Merge inserted
translated to .tiff file format. files using BIND.
Regardless of the setting Creates a duplicate
value, objects with .tiff or .jpg set of styles for each
format are not merged and block reference.
need to be kept in the same
folder as the .dwg file in order
to display correctly.
2 = Merge inserted
files using INSERT.
Creates a single set
Note that for a main drawing of unique styles for
saved as a .dxf file with the main drawing
objects in .tiff format, when and all block
the files are copied to a new references.
location, AutoCAD cannot find
them due to the reference to
an exact location, even if they
are in the same location as
the .dxf file. To rectify this, the
path to the .tiff file needs to be
updated manually in the .dxf
file.
Write Linestyles
Many of the default linestyles in your document are pre-mapped to the most equivalent
AutoCAD linestyles. Other linestyles are mapped as continuous. If the _default_ = _stroke_
setting is used, all linestyles are stroked regardless of their mapping. The _default_ = _stroke_
setting is commented out by default to disable it.
The number values are used in the linestyle table to map linestyle definitions in the current
document to AutoCAD line types.
Number Definition
9 CONTINUOUS
10 HIDDEN2
11 DOT2
12 DASHDOT2
13 DIVIDE2
18 CENTER2
19 CENTER
20 PHANTOM2
21 BORDER2
23 CONTINUOUS
The following table shows the Signal Run linestyles as they appear in the software and in
AutoCAD.
Software AutoCAD
Capillary = CAPILLARY
Electric = ELECTRIC
Guided = ELECTROMAGNETIC
Electromagnetic
Hydraulic = HYDRAULIC
Pneumatic = PNEUMATIC
Undefined = UNDEFINED
Unguided = UNGUIDED_ELECTROMAGNETIC
Electromagnetic
_default_ = _stroke_
The following table shows the revision cloud linestyles as they appear in the software and in
AutoCAD.
Software AutoCAD
Options
Name of Setting Description Import Export Default Value Accepted Values
Enable Logging If set, a log file will be created Yes Yes 0 0 = Logging is turned
in the directory that the file OFF
was opened from and will
have the same name as the
file that was opened. 1 = Logging is turned
ON
Read Default Units If the MicroStation file being Yes No 64 59=m; 61=mm;
imported does not have a 62=cm; 63=km;
master unit setting that 64=in; 65=ft; 66=yd;
matches one of the default 67=miles
SmartSketch unit settings,
then this setting is used to
specify the units being
imported. If the MicroStation
file being imported does have
a valid master unit setting that
matches a default
SmartSketch unit setting, then
this setting is ignored.
Template File Sets the document that will be Yes No TransMstn.igr Filename
used as a template when
importing foreign data for (If this file is
setting up hatching and required, it can be
patterns. taken from the
SmartSketch folder)
Symbol Template Sets the symbol file that will Yes No Filename
File be used as a template when
importing foreign data.
Ignore Sheet Scale Determines whether to scale Yes No 1 0 = Do not fit the
the sheet to fit the graphics graphics to the sheet
during a translation import.
Processing Batch If set, progress bar dialog Yes Yes 1 0 = Progress Bar
Translation boxes do not display during display is turned ON
the translation.
1 = Progress Bar
display is turned
OFF
Attribute Sets Controls the import / export of Yes Yes TranslationSettings; String consisting of
attribute information on _SymInst attribute names
objects during translation. delimited by
semicolons, or the
ALL keyword
Write Version Sets the version of the foreign No Yes 8.0 7.0; 8.0
file format that is created on
export.
1 = Symbols are
exported as type 2
cells to control the
graphics level
To
implement this
behavior, you must
also assign to the
Attribute Sets
option the value
'TranslationSettings;
_SymInst'; otherwise,
when the value of
Dissolve Symbol to
Groups is set to 1,
symbols are
exported as
individual objects
Application Text Determines whether text Yes Yes 1 0= Text origin always
Type origin and justification are in upper left corner
preserved.
1= Origin preserved
1 = Horizontal text
alignment is set to
Left
1 = Attributes are
created as
SmartLabels
1 = ON
1 = ON
1 = Include
non-displayable
objects
1 = User-defined
linestyles are
preserved
1 = Attributes are
created
Metafile to Raster Sets the dpi resolution for No Yes 350 dpi resolution (1
DPI Resolution raster metadata during export. through 1200)
1 = Delete symbol
definitions
Read Cell Options Sets how the shared (type Yes No Shared Embeds Shared Embeds -
34/35) cells imported from Preserves shared
MicroStation are handled. cells
Rigid Groups -
Translates shared
cells into groups
Pos Units Per Sub Sets the values to determine Yes No 1000 Numeric
Units the size of units for a
MicroStation cell file
Always Shift GO to Controls whether to set the No Yes 0 0 = Do NOT shift the
Center Drawing Global Origin of .dgn files in Global Origin of the
case the drawing objects fall resulting .dgn file
outside the maximum design
plane as defined by
MicroStation. 1 = Shift the Global
Origin of the
resulting .dgn file
EDF as Smart Text Determines whether the Yes No 0 0 = Tags are created
values of tags are created as as text boxes
simple text boxes or as
SmartLabels during
translation import. 1 = Tags are created
as SmartLabels
Write Linestyles
The default linestyles in your document are pre-mapped to the most equivalent MicroStation
linestyles. Linestyles other than the default linestyles or any complex linestyles containing
shapes are mapped to continuous unless they are specifically mapped on the Linestyle tab.
Linestyles that are not mapped on export are stroked to give them a more correct appearance.
The default length of the stroking line is 0.1 millimeters (mm).
The number values are used in the linestyle table to map linestyle definitions in the current
document to MicroStation line types.
Number Definition
9 0
10 2
11 1
12 4
13 6
18 7
20 6
The following table shows the Signal Run linestyles as they appear in the software and in
MicroStation.
Software MicroStation
Capillary = Capillary
Electric = Electric
Hydraulic = Hydraulic
Pneumatic = Pneumatic
Software MicroStation
Undefined = Undefined
Unguided = Electromag/Sonic
Electromagnetic
_default_ = _stroke_
The following table shows the revision cloud linestyles as they appear in the software and in
MicroStation.
Software MicroStation
In addition to the above mapping, the PIDLineStylesV8.rsc file, delivered with SmartPlant P&ID,
must be copied to the MicroStation installation folder:
C:\ProgramData\Bentley\WorkSpace\System\Symb.
The following table shows the Tracing Media linestyles as they appear in the software and in
MicroStation.
Software MicroStation
NT = NT
E = E
FA = FA
FB = FB
FC = FC
I = I
MI = MI
SKE = SKE
SH = SH
Software MicroStation
SL = SL
SM SM
SN = SN
SS = SS
ST = ST
Save options
File path — Allows you to type or edit the file path and name.
You can also click Browse to open the File Name and Path window to navigate to the
desired path where you want to save the drawing.
Save as type — Allows you to select a file format for the drawing you want to save. The
following formats are available:
AutoCAD (*.dwg and *.dxf)
MicroStation (*.dgn)
PDF (*.pdf)
ISO 15926 (*.xml)
For details of the supported versions of AutoCAD and MicroStation for these formats, refer
to the SmartPlant P&ID Installation and Upgrade Guide, Hardware and Software
Recommendations under the section SmartPlant P&ID Workstation > Optional Software.
The PDF printer that the current version of the software supports is SmartPlant PDF
Converter (Amyuni 4.5).
The ISO 15926 (*.xml) format is available only if you have a valid license ID and you have
run a procedure that activates this option. For details, see Enable Save As XML (on page
135).
PDF Settings — (Available only when PDF is selected in the Save as type list.) Opens the
PDF Settings dialog box to specify settings for the PDF output.
Save filter
Apply display set — Select this check box to enable selection of a display set to specify the
layers to which drawing items go when saving to AutoCAD or MicroStation formats. Clear the
check box to ignore display set settings.
Active display set — This field becomes active when you select Apply display set. Click
Browse to open the Apply Display Set dialog box from which you choose the desired display
set.
If an active display set is already selected for the drawing, this dialog box opens with the
Apply display set check box selected and the relevant display set appears in the Active
display set field.
About ISO 15926 — (Available only when ISO 15926 (*.xml) is selected in the Save as type
list.) Opens an About dialog box that displays version and licensing information for the
SmartPlant P&ID ISO 15926 Export Utility.
See Also
Save Drawings in Other Formats (on page 131)
Save options
Folder path — Allows you to type the path to an existing folder where you want to save the
drawings.
You can also click Browse to navigate to the desired folder.
Save as type — Allows you to select a file format for the drawings you want to save. The
following formats are available:
AutoCAD (*.dwg and *.dxf)
MicroStation (*.dgn)
PDF (*.pdf)
ISO 15926 (*.xml)
For details of the supported versions of AutoCAD and MicroStation for these formats, refer
to the SmartPlant P&ID Installation and Upgrade Guide, Hardware and Software
Recommendations under the section SmartPlant P&ID Workstation > Optional Software.
The PDF printer that the current version of the software supports is SmartPlant PDF
Converter (Amyuni 4.5).
The ISO 15926 (*.xml) format is available only if you have a valid license ID and you have
run a procedure that activates this option. For details, see Enable Save As XML (on page
135).
PDF Settings — (Available only when PDF is selected in the Save as type list.) Opens the
PDF Settings dialog box to specify settings for the PDF output.
Save filter
Apply display set — Select this check box to enable selection of a display set to specify the
layers to which drawing items go when saving to AutoCAD or MicroStation formats. Clear the
check box to ignore display set settings.
Active display set — This field becomes active when you select Apply display set. Click
Browse to open the Apply Display Set dialog box from which you choose the desired display
set.
The display set chosen from the Active display set field is the one used to specify the
layers for all selected drawings and this overrides any active display sets that were selected for
individual drawings.
About ISO 15926 — (Available only when ISO 15926 (*.xml) is selected in the Save as type
list.) Opens an About dialog box that displays version and licensing information for the
SmartPlant P&ID ISO 15926 Export Utility.
See Also
Save Drawings in Other Formats (on page 131)
Color options
Color — Creates a PDF using the colors available in the document. You can only create a color
PDF from a color drawing sheet.
Grayscale — Creates a PDF using a 256-color grayscale.
Pure black and white — Creates a PDF that has no color or grayscale. Anything that is not
pure white is drawn as black.
JPEG compression — Compresses images embedded in your document according to the
compression level you define. If your drawing contains a lot of images, compression settings are
very important for achieving good image quality at a manageable file size. Use the pull-down
menu to set the compression level. Compression levels in the High quality range do not
noticeably affect image quality, and produce larger file sizes than settings in the Low quality
range. However, using a mid-range compression level usually strikes the best balance in
creating a compact file while still maintaining enough information to product high-quality images.
Include inconsistency markers — When selected, includes inconsistency symbols that appear
on the drawing in the PDF output.
When filtering by typicals or display sets to determine which drawings are to be printed, you
can specify whether to include or exclude in the printout drawings that do not contain filtered
items.
In SmartPlant P&ID, you can control the display and print output of the drawing using
various settings on the Display tab of the View Properties dialog box. Two options affect
the way that inserted objects are printed from SmartPlant P&ID and also from Drawing
Manager: Prevent selection of inserted objects and Retain Auxiliary Graphics colors.
Inserted objects, including Auxiliary Graphics, are printed in gray if only Prevent selection
of inserted objects is selected. If Retain Auxiliary Graphics colors is also selected, any
Auxiliary Graphics included in the drawing are printed in their original colors.
Opens the Print dialog box where you can specify options for printing your drawings.
Printer
Name — Specifies the printer that 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 that 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 specific to the selected printer.
Status — Describes the state of the selected printer, for example, busy or idle. This area is
read-only.
Types — 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.
Print filter
Filters the selected drawings that are to be printed according to the specified criteria. If none of
the check boxes in this section are selected, all selected drawings are printed.
Typicals only — Prints only the typical items as they appear in the typical view.
Apply display set — Associates symbols to a display set filter that defines which symbols to
print. If not selected, then no filtering is applied to the drawing and the entire drawing prints.
When specifying line widths for display sets, you can set label graphics and leader lines
to appear in the default width of the labels regardless of the line width value specified for model
items. This option is specified by using a key 'IgnoreDisplaySetWidthOnLabels' under the
'Options' section of the SmartPlantPID.ini file (located in the users\<username> folder) as
shown:
[options]
WaterMarkWhileWorking=True
WaterMarkWhilePrinting=True
undosteps=0
autogapping=False
ConsistencyChecks=True
.
.
.
IgnoreDisplaySetWidthOnLabels=1
The following table shows how the values assigned in the SmartPlantPID.ini file affect the
output.
Active display set — Displays the selected display set. You can click Browse to select a
defined display set.
Print all selected drawings — This option is only available when either or both check boxes
Typicals only and Apply display set are selected. When the Print all selected drawings
check box is cleared, those drawings that do not contain filtered items as a result of applying
these filters are excluded from the print output. Selecting the check box results in the printing of
all selected drawings, including drawings that do not contain such filtered items.
Options
Fit to page — Prints your entire drawing on one page. This option is selected by default.
Print black and white — Prints the drawing in black and white. This option is selected by
default.
Print claim status — Allows for the printed copy to include the status of claims. This check
box is only enabled if you are in a Project.
Print watermark — Prints a faint graphic in the drawing background.
Print inconsistency markers — Causes inconsistency markers in the graphic to appear on the
printed copy.
Settings — Opens the Settings dialog box, which allows you to view and edit the scale and
origin of your print area.
Preview — Allows you to see how the image will look when printed. The image displays on
your monitor.
Schedule — Opens the Schedule Task Wizard, which allows you to specify options for printing
the selected drawings at a later time or on a regular interval. For details, see Scheduling Tasks
(on page 235).
Add Folder — Adds an empty folder to the Tree. You can use Rename to define a name
for the folder. These folders can be used to organize display sets.
Add Display Set — Creates a new display set. You can use Rename to define a name for
the new display set.
Add Filter — Displays the Select Filter dialog box. Select any displayed filter to add it to
the current display set.
Save — Saves the selected display set.
Rename — Allows you to click on an item in the Tree and rename it.
Move Up — Allows you to move the selected filter name up in the list.
Move Down — Allows you to move the selected filter name down in the list.
Scale
Controls the scale applied to the print area in a document.
Best fit — Scales the selected drawing sheets or print area to fit the printer paper for the
configured device.
Manual scale — Specifies the scale value to apply to the print range during printing. For
example, if the print range is a rectangle at 12 cm by 12 cm and you set a manual scale of 1:12,
then the printed range appears to be 1 cm by 1 cm on the printer paper. If you want a 1:1
drawing of the current sheet scale, you can set the Paper length option to 1 and the Design
length option to 1.
Paper length — Specifies the paper length for the document you want to print with respect to
the Design length option.
Design length — Specifies a design length (size of the printed graphic) with respect to the
Paper length option.
Origin
Adjusts the origin of the graphic area, thereby changing the location of the effective print area on
the paper.
Center — Positions the print area center to the center of the printer paper. If you do not set this
option, then the paper positions at bottom left to bottom left.
X origin — Sets a shift in the x-direction from the origin.
Y origin — Sets a shift in the y-direction from the origin.
Preview
Displays dynamically how the graphic prints on the sheet as you change other options on the
dialog box.
For many of the options on this dialog box such as, Design length, Paper length, X, Y,
and so forth, when you change an option, the red, blue, and black boxes in the Preview area
change to reflect your new values. Therefore, you have a dynamic representation of how your
graphic fills the printed sheet.
Drawings — Lists the drawings to be queued to the printer. When each drawing is queued, a
check mark is displayed next to that drawing name.
View Log — Opens the log file with details of the print jobs.
Close — Closes the dialog box.
When filtering by typicals or display sets to determine which drawings are to be printed, you
can specify whether to include or exclude in the printout drawings that do not contain filtered
items.
For a display set that contains one or more asking filters, on clicking OK in the Print dialog
box, the Asking Filters dialog box opens with the default values for each asking filter,
allowing you to change the operators and values of each asking filter's attributes for the
selected drawings, if desired.
Using Workshare
Workshare functions allow you to share SmartPlant P&ID data within one plant structure with
remote sites. Designed for companies running plants from multiple sites, EPCs or
Owner/Operators, or for multiple companies that are working on a single plant, Workshare
provides tools to manage changes as if they were created at the same site.
Workshare Modes
Workshare can be configured in two modes:
Connected — Uses a database link established between the database servers at the host
and satellite sites. In other words, satellites are distributed databases linked to a host
database. In connected Workshare, both the host and satellite must be using Oracle. If
you plan to use Workshare in an integrated environment, we recommend using connected
Workshare to ensure smooth claiming.
Standalone — Shares files and data without having a database link. Files are manually
transmitted between host and satellites.
Any given site can host both connected and standalone satellites. In other words, the host can
use Oracle and the satellite can use SQL Server, or any combination thereof. However, a site
must use Oracle to host a connected Workshare collaboration.
Configurations
The configuration possibilities for implementing Workshare are numerous. For example, you
can use Workshare to simulate the PDS 2D Task/Master configuration by using the Workshare
host as the Task environment and the satellite as the Master. You could then publish drawings
for sharing from the host to the satellite. By limiting user access at the satellite site to Read
Only for SmartPlant P&ID objects, the satellite becomes an issued drawing database.
You can also use standalone Workshare in a mixed database environment where the host can
be using Oracle and the satellite can be using SQL Server, or vice-versa. This configuration is
useful when multiple companies using different database standards are working on the same
plant.
Standalone Workshare provides a means of implementing off-site projects.
Workshare can be used in an integrated environment. For more information, see Using
Workshare in an Integrated Environment (on page 168).
Another possible configuration involves using Workshare at the project level within an As-Built
plant scenario. For more information about using Workshare with projects, see Using
Workshare with Projects (on page 171).
Automation
Several of the Workshare commands are available in the SmartPlant P&ID automation layer.
For more information about using these Workshare automation commands, see SmartPlant
P&ID Programmer's Guide.
To Do List — All commands and tasks are available for drawings opened with read-write
privileges. For drawings opened in read-only mode, commands that modify a drawing, such
as the Run To Do List task, are not available.
See Also
Projects vs. Workshare (on page 172)
Publishing a Drawing
To share a drawing with another site, you must first publish that drawing. Publishing the
drawing does not grant access to the drawing: it only freezes a copy of the drawing in
anticipation of ownership being transferred. Between the publication of a drawing and the
transfer of ownership, the publishing site still owns the drawing and is free to modify it. Granting
subscription access to the drawing gives another site read-only access to the published copy of
the drawing. Assigning ownership to the drawing allows the new owner to claim ownership of the
drawing and obtain the published copy of the drawing.
up to date with the files at the host. These files include the rules file, insulation specification file,
report and drawing templates, symbology settings, CAD definition file, and so forth.
You can synchronize this data either with the host site or with a copy of the reference data on
your local computer or network using the Synchronize Reference Data commands.
Reference data at the satellite site must be synchronized with the host reference data before
drawings and shared items can be synchronized or transferred.
We recommend scheduling synchronization for a time when no users are working in the
data.
Topology Each plant can have many Each Workshare host can have
projects. Each project belongs to many satellites. Each satellite
exactly one plant. belongs to exactly one host.
Reference Data One set of reference data is used The reference data must be the
for a plant and all its projects. same for a host and its satellites.
Changes can be made only Changes can be made only through
through the Plant. Since all projects the host. Changes are propagated
use the same reference data as the to the satellites by means of the
Plant, all projects immediately see synchronize reference data
changes to the reference data. commands in Drawing Manager.
Physical Separation A plant and all of its projects must Connected Workshare allows data
exist on the same server and within to be distributed to multiple
the same database instance. database instances on separate
servers that may be remote from the
host server.
Standalone Workshare allows data
to be distributed between separate
database types.
When to Use? When the work to be done must be When the work to be done must be
divided into subsets, but it is all divided into subsets and assigned to
done by the same organization and different organizations.
can use the same server.
When the subsets of work must be
When an As-Built facility model is done on servers that are physically
to be built and the changes to that separated.
model need to be managed.
When a master database is to be
used for the approved design and a
task database is to be used for the
ongoing design work.
Sample Workflows
The following scenarios provide example workflows for using connected Workshare with
projects:
Scenario 1: Compare
Scenario 2: Loops
Scenario 3: OPCs
Scenario 1: Compare
The following workflow demonstrates how to compare drawings in a connected Workshare
collaboration using projects.
See Also
Projects vs. Workshare (on page 172)
Scenario 2: Loops
The following workflow demonstrates using shared items in a connected Workshare
collaboration using projects.
8 Satellite 1.1 opens Drawing B', verifies via the EDE that only
the P102 loop tag is available for assignment (confirming
that synchronizing shared items brought the loop over to the
satellite), then closes Drawing B'.
10 Satellite 2.1 opens Drawing C', verifies via the EDE that
only the P102 loop tag is available for assignment
(confirming that synchronizing shared items brought the
loop over to the satellite), then closes Drawing C'.
See Also
Projects vs. Workshare (on page 172)
Scenario 3: OPCs
The following workflow demonstrates handling OPCs in a connected Workshare collaboration
using projects.
12 Satellite 2.1 opens drawing A'' and verifies that the OPC
label is updated with information from Drawing B, then
closes Drawing A''.
See Also
Projects vs. Workshare (on page 172)
Publishes the selected drawing or drawings. The Publish dialog box displays the status of the
operation.
The act of publishing a drawing actually bundles the drawing and its related data and places it
as a "blob" object in the host database.
In a connected Workshare collaboration, when the satellite uses the Get Latest Version from
Remote command, the published "blob" is copied from the host database to the satellite site
database. At the satellite site, the "blob" is then unpacked and the drawing is placed in the local
file system while its related data is placed in the local SmartPlant P&ID database.
In a standalone Workshare collaboration, the published "blob" is automatically extracted into a
published zip file. The Publish command derives which sites have been given subscribe access
to the drawings being published and places the published zip files in the target WSPublish folder
in individual folders corresponding to each subscribing site, allowing you to more easily
determine which published zip files to transmit to a given site. The receiving site then uses the
Get Latest Version from Local command to unpack the zip file, placing the drawing in the local
file system and the related data into the local SmartPlant P&ID database.
For mixed Workshare collaborations, the publishing process detects the types of satellites
involved and performs the appropriate actions. For example, when a drawing is published for
both a standalone and a connected satellite, the Publish command creates the published zip
file in the WSPublish folder and places the corresponding "blob" in the database.
Before the connected satellite site can access the published drawing, you must grant
subscription access to or assign ownership of the drawing to the satellite site.
For standalone Workshare collaborations, if you do not grant subscription access to or
assign ownership of a drawing before you publish it, the published drawing zip file will not be
created in the WSPublish folder.
Satellite-to-satellite data transfer is not supported in standalone Workshare.
Published zip files in the WSPublish folder are overwritten without warning as needed by
subsequent publishes.
When using Workshare in an integrated SmartPlant environment, satellites must transfer
drawing ownership back to the host in order for the host to publish the drawings and in order
for retrieved documents to have tasks updated within the satellite drawings.
Drawings — Lists the drawings that are being published, and shows the status of that
operation.
View Log — Opens the log file that is created when you perform a Workshare operation.
Publish a Drawing
1. In the List view, select the drawings that you want to publish.
2. Grant access to the drawings by using either the Subscribe Access or Assign Ownership
commands.
3. Click Workshare > Publish. If you used the Assign Ownership command in the previous
step, the Publish process is launched automatically.
4. On the Publish dialog box, you can click View Log to see the history of the Workshare
operation just completed.
5. If you are using connected Workshare, drawings need to be extracted if the files need to be
transmitted manually in a case where the default publishing method is through the database.
For details, see Extract Published Drawings (on page 186).
6. If you are using standalone Workshare and changes have been made to the reference data,
be sure to use the Publish Standalone Package command in SmartPlant Engineering
Manager to bundle the database reference data for synchronization with the satellite.
Linked or embedded files are not transferred by Workshare. Those files must be transferred
manually. We do not recommend using linked files in a Workshare collaboration.
You can schedule the selected drawings for publishing at a later time or on a regular interval
by using the Schedule Publish command in Drawing Manager and following the prompts on
the Schedule Task Wizard (on page 205).
When using Workshare in an integrated SmartPlant environment, satellites must transfer
drawing ownership back to the host in order for the host to publish the drawings and in order
for retrieved documents to have tasks updated within the satellite drawings.
Look in - Lists the available directories. You can choose a folder and click OK. A new folder to
hold your published drawings is created inside the folder you select.
Drives - Displays the currently active drive. To change to another drive, click Network.
Network - Opens the Microsoft standard Map Network Drive dialog box with which you can
specify a new active drive.
OK - Extracts all published data plant-wide and places it in a new folder inside the folder
selected in the Look in list.
A new folder is created in this directory and named using the day, date, and time of the
publishing operation. This folder contains the results of the extraction operation. The folder
could be on a local or network drive.
Extracting published drawings is later used with the Get Latest Version from Local
command.
This command is available only in connected Workshare collaborations.
Available sites - Lists the satellite sites that are available to subscribe to the selected drawing.
Selected sites - Lists the sites that currently have subscribe access to the drawings that you
publish.
Add - Moves a selected site from the Available sites list to the Selected sites list.
Remove - Moves a selected site from the Selected sites list to the Available sites list.
Add selected - Gives subscription access to all the sites selected in Available sites.
Delete selected - Removes subscription access from all the sites selected in Selected sites.
You must have published a drawing before you can assign read access to another site.
To grant read/write permission for a drawing, see Assign Ownership to a Drawing (on page
189).
When the other site gets a copy of a drawing to which they have read access, they do not
see updates to that drawing after the point when they receive that version. That is, the two
instances of the drawing are not linked dynamically. For more information about getting the
latest version of a drawing, see Getting Latest Versions of Drawings (on page 190).
Opens the Assign Ownership dialog box, where you can specify which Workshare sites have
read/write permission for published drawings. Drawing ownership is used to control, for a given
drawing, which satellite's published data the host receives during a Get Latest Version
operation.
In a mixed-mode Workshare collaboration, the following limitations apply.
For drawings owned by the host, ownership can be given by the host to any standalone or
connected satellite.
For drawings owned by a standalone satellite, ownership can be given by the host to any
other standalone or connected satellite or the host itself. For the host to transfer ownership
to a drawing from one satellite to another, the host must first transfer ownership back to itself
before granting ownership to the other satellite.
For drawings owned by a connected satellite, ownership cannot be set by the host.
When using Workshare in an integrated SmartPlant environment, satellites must transfer
drawing ownership back to the host in order for the host to publish the drawings and in order
for retrieved documents to have tasks updated within the satellite drawings.
When the host, in standalone mode, is functioning as a project, all items on the selected
drawings are automatically claimed when the drawing ownership is assigned to a satellite site. If
exclusive claiming is being used and one or more items have already been claimed by another
project, assigning ownership is not allowed.
Available Workshare sites — Lists the sites that are currently linked to your site and available
to take ownership of the selected drawing.
OK — Assigns ownership of the drawing to the specified site and publishes the selected
drawing.
The sites available on the Assign Ownership dialog box are specified automatically
according to the sites currently participating in the Workshare collaboration. These
Workshare sites are set up in SmartPlant Engineering Manager.
Assigning ownership of a drawing also publishes the drawing.
If you want to grant read access only, see Set Subscription Access for a Drawing (on page
187).
For drawings owned by the host, ownership can be given by the host to any standalone or
connected satellite.
For drawings owned by a standalone satellite, ownership can be given by the host to any
other standalone or connected satellite or the host itself. For the host to transfer ownership
to a drawing from one satellite to another, the host must first transfer ownership back to itself
before granting ownership to the other satellite.
For drawings owned by a connected satellite, ownership cannot be set by the host.
When transferring ownership of a drawing, the corresponding drawing versions are not
transferred. Only the current version of the drawing is transferred.
When using Workshare in an integrated SmartPlant environment, satellites must transfer
drawing ownership back to the host in order for the host to publish the drawings and in order
for retrieved documents to have tasks updated within the satellite drawings.
Typically used only in a connected Workshare collaboration, this command opens the Get
Latest Version from Remote dialog box, which allows you to specify the site from which you
want to receive the latest versions of published drawings.
When you get the latest version of a drawing, you do not see updates to that drawing after the
point in time when you got that version. That is, the two versions of the drawing are not linked
dynamically.
Before you can get the latest version of a drawing, that drawing must first be published and
assigned to you with the appropriate permissions, and you must have a network or database
connection to the Workshare site where the published drawing currently resides.
The latest version of a drawing replaces any versions of that drawing currently at
your site; therefore, use caution when subscribing to the latest versions.
Available Workshare Sites — Lists the sites in your Workshare collaboration that have
published drawings available to you. If the site you are looking for is not in the list, check to see
if that site has published any drawings and, if so, has it assigned access to you.
Drawings — Lists the drawings that are being updated and shows the status of that operation.
View Log — Opens the log file that is created during this procedure.
The locations available in the list in the Get Latest Version from Remote Site dialog box
are specified automatically according to the satellites connected to the host.
When you get a version of a drawing, you do not see updates to that drawing after the point
in time when you subscribed to it. That is, the two versions of the drawing are not linked
dynamically.
Linked files are not transferred by Workshare. Those files must be transferred manually. We
do not recommend using linked files in a Workshare collaboration.
You can click Workshare > Schedule Get Latest Version from Remote to open the
Schedule Task Wizard (on page 205) and defer the subscription to a later time or on a
regular interval. You must still complete the next step in this procedure.
Typically used in a standalone Workshare collaboration, this command opens the Get Latest
Version from Local dialog box, which allows you to browse to the published zip file you
received from another site and to select the drawings you want to receive. The Get Latest
Version from Local command detects if the incoming published files originated from the
expected host site. If they did not, the files are skipped and an entry is written in the log file.
When you get the latest version of a drawing, you do not see updates to that drawing after the
point in time when you got that version. That is, the two versions of the drawing are not linked
dynamically. In a connected Workshare collaboration, the latest version of a drawing replaces
the version of a drawing that you currently have on your computer. In a standalone
collaboration, a version is created for each replaced drawing.
When a new drawing created at a satellite is obtained by the host, the drawing ownership at the
host is set to the originating site. For projects, when new objects created by a satellite site are
obtained by the host, new claim records are created at the host.
Before you can get the latest version of a drawing, that drawing must first be
published and assigned to you with the appropriate permissions, and you must have placed the
zip file containing the extracted published files on your local computer or a network share to
which you have access.
Published files — Displays the drawings included in the published zip file. In the following
situations, certain published drawings are excluded from this list:
At a connected satellite, excludes published files for drawings owned by that site and
drawings from a site not collaborating with the same host.
At the host, excludes published drawings not owned by the originating site and drawings
from a site not collaborating with the same host.
At a standalone satellite, excludes published files for drawings from a site not collaborating
with the same host.
Drawings that already have assigned ownership at the current site are displayed in gray.
Browse — Opens the Select Publish Folder dialog box, which allows you to browse to the
location where you saved the zip file containing the extracted published files (see "Extract
Published Drawings" on page 186).
View — Opens the View dialog box, which displays a read-only view of the selected drawing
version without opening SmartPlant P&ID. You can manipulate the view or select drawing items
and review their properties.
Compare With — Opens the Compare With dialog box, allowing you to compare the current
drawing version at your site with the incoming data. You cannot compare incoming data to a
previous version of the drawing.
Select All — Marks all drawings in the Published files list to be extracted from the zip file and
written to your local plant database.
Drawings — Lists the drawings that are being updated and shows the status of that operation.
View Log — Opens the log file.
You can schedule this process for a later time by using the Schedule Task Wizard (on page
205).
If you are using a connected Workshare collaboration and have an active network
connection to the remote site, you can get the latest version from there, too. For more
information, see Get the Latest Version of a Drawing from a Remote Site (on page 191).
Customizations should be done at the host. For example, Plant Filters should not be created
at a satellite site because when you synchronize reference data with the host, you lose that
information. However, you can always create My Filters in the Filter Manager environment.
Automation programs (for example, DLL and OCX files) are not synchronized. For more
information about automation, see SmartPlant P&ID Programmer's Guide.
Reference data at the satellite site must be synchronized with the host reference data before
any drawings and shared items can be synchronized or transferred.
Border files are synchronized only if they are in the same location as the drawing templates.
We recommend scheduling synchronization for a time when no users are working in the
data.
Tasks — Lists the individual parts of the reference data and displays their status in the
synchronization process.
View Log — Opens the log file that is created when you perform a Workshare operation.
In order to synchronize the databases, the DBLink or other network connection between
host and satellite must be active.
You can view the progress of the synchronization process on the Synchronize dialog box.
If a satellite does not synchronize reference data, the satellite can neither publish nor get the
latest version of a drawing.
For information about synchronizing reference data without a remote connection to the host,
see Synchronize Reference Data from a Copy (on page 202).
Rules library — Allows you to specify the path to the rules file (Rules.rul) in the copied
reference data. By default, this file is located in the SmartPlant\P&ID Reference Data folder on
your computer.
The path you specify for the rules library is also used to determine the path for the
PlantConfig.xml file.
Insulation specifications file — Allows you to specify the insulation specification file
(InsulationSpec.isl) in the copied reference data. By default, this file is located in the
SmartPlant\P&ID Reference Data folder on your computer.
Default report template path — Allows you to specify the path to the default report templates
folder in the copied reference data. This path typically points to the Report Files folder in the
SmartPlant\P&ID Reference Data folder on your computer.
Plant style file — Allows you to specify the plant styles file (ProjectStyles.spp) in the copied
reference data.
CAD definition file — Allows you to specify the CAD definition file (Exportlayer.xlsx) in the
copied reference data. By default, this file is located in the SmartPlant\P&ID Reference Data
folder on your computer.
P&ID template path — Allows you to specify the path to the P&ID templates in the copied
reference data. This path typically points to the Template Files folder in the SmartPlant\P&ID
Reference Data folder on your computer.
Catalog Explorer root path — Displays the path to the Catalog Explorer root path in the
copied reference data. This path typically points to the Symbols folder in the SmartPlant\P&ID
Reference Data folder on your computer.
Pipe jacket nominal diameter configuration file — Allows you to specify the path to the pipe
jacket nominal diameter configuration file (JacketNDCoreND.XML) if it exists in the copied
reference data. By default, this file is located in the SmartPlant\P&ID Reference Data folder on
your computer.
Since this file may not exist at the host, the software does not require that the field be
filled in order to synchronize the Reference Data. It is the user's responsibility to select the file
to synchronize it with the satellite.
Standalone package file — Allows you to specify the zipped file (plantname_sync.zip)
containing the database reference data information bundled by the host using the Publish
Standalone Package command. This field is available only for standalone Workshare
collaborations.
Browse — Allows you to browse to the appropriate file or folder for the pertinent reference data.
Schedule — Opens the Schedule Task Wizard (on page 205), which allows you to defer
synchronizing data to a later time or to schedule it on a regular interval.
Look in — Lists the available directories. Choose a folder and click OK.
Drives — Displays the currently active drive. To change to another drive click Network.
Network — Opens the Microsoft standard Map Network Drive dialog box where you can
specify a new active drive.
Look in - Lists the available directories. Choose a folder and click OK.
Drives - Displays the currently active drive. To change to another drive click Network.
Network - Opens the Microsoft standard Map Network Drive dialog box where you can specify
a new active drive.
Look in - Lists the available directories. Choose a folder and click OK.
Drives - Displays the currently active drive. To change to another drive, click Network.
Network - Opens the Microsoft standard Map Network Drive dialog box where you can specify
a new active drive.
6. Exit, then re-open Drawing Manager. You can now publish or get latest version of
drawings.
If a satellite does not synchronize reference data, the satellite cannot publish or get the
latest version of a drawing.
If you are using a Workshare environment in SmartPlant P&ID and you are at a satellite site,
you should not store custom layouts for the Engineering Data Editor or Plant Filters
because when you synchronize reference data, you lose that information.
You can click Schedule to defer this task to a later time or schedule it on a regular interval.
When the Schedule Task Wizard (on page 205) opens, follow directions in the wizard to
complete the scheduling of this synchronizing operation.
View Log — Opens the log file that is created when you perform a synchronizing operation.
14. Host performs a Get Latest Version from Local on Dwg2. (The Host receives a moved items
error condition and must move the OPC currently in Dwg3 to the plant stockpile before the
Get Latest Version from Local command can succeed.)
15. Host publishes Dwg2 and sends to Site1.
16. Site1 performs a Get Latest Version from Local on Dwg 2. (Site1 receives a moved items
error condition and must move the OPC currently in the Dwg3 stockpile to the plant stockpile
before the Get Latest Version from Local command can succeed.)
17. Site1 opens Dwg 1 to cause the OPC label to refresh.
After setting up the schedule, the wizard relinquishes control over the schedule to
your Windows operating system. The only way to modify or delete a task schedule is to use the
Control Panel > Scheduled Tasks utility.
Available Workshare Sites - Lists the sites in your Workshare collaboration that have
published drawings available to you. If the site you are looking for is not in the list, check to see
if that site has published any drawings and, if so, has it assigned access to you.
SmartPlant P&ID interacts with SmartPlant Foundation by correlating items between the plant
database and the SmartPlant Foundation database, retrieving documents from SmartPlant
Foundation. Also, SmartPlant P&ID creates a set of tasks in the To Do List that you can run to
update the plant database. In SmartPlant P&ID, you can also use the commands on the
SmartPlant menu to publish documents and retrieve data, access the SmartPlant Foundation
Web Portal in order to browse in SmartPlant Foundation, and subscribe to change notifications
and compare documents.
You can only use the SmartPlant menu commands after your plant is registered. For
more information, see SmartPlant Engineering Manager Online Help.
Registering Tools
Before you can publish and retrieve documents from any of the other authoring tools, such as
SmartPlant Electrical or SmartPlant Instrumentation, you must register each plant in SmartPlant
P&ID with a SmartPlant Foundation database. The connection allows SmartPlant P&ID to use
the commands on the SmartPlant menu. A SmartPlant Engineering Manager administrator
typically registers a plant.
The software maps a plant and all its projects to a single SmartPlant Foundation URL, which
points to one, and only one, SmartPlant Foundation plant database and its projects. When you
use the Register command in any of the authoring tools, you are registering an authoring tool
plant with a SmartPlant Foundation URL and plant that you specify.
The system administrator must register each plant in the authoring tool once; this action takes
place in SmartPlant Engineering Manager. After the plant is registered, you can publish and
retrieve documents.
When creating formats for use with SmartPlant P&ID publishing, the formats must be added
and mapped in SPPIDDataMap.xml using Schema Editor. The UID string of the custom
SPMapUOMDef map file must be of the form SPMU_<NN>_FormatName>, where 'NN'
represents the SPMapUOMListDef ID for the format type (for example Temperature = 5;
Pressure = 27). Since spaces or restricted characters are not allowed in the UID string,
custom format names must not include spaces or restricted characters.
If you intend to publish select lists (enum lists) to SmartPlant Foundation, make sure that
you review the SmartPlant Adapter for SmartPlant P&ID Guide to understand the
requirements (see under Data Transformation Logic > Publish/Retrieve).
If the SmartPlant P&ID item tag validation allows for duplicate tags, this may have an impact
on downstream tools such as SmartPlant Instrumentation, which does not allow duplicates.
In such cases, allowing duplicates in SmartPlant P&ID can cause problems in the retrieving
tool.
By default, SmartPlant P&ID item tag validation does not allow duplicate item tags for
loops or instruments.
Instrument Expansion
A SmartPlant P&ID instrument or loop tag does not always have a 1:1 relationship with
instruments in SmartPlant Instrumentation. In some cases, a single item tag in a P&ID
corresponding to an instrument or loop needs to be expanded to create several instruments
when publishing the data for SmartPlant Instrumentation. For this purpose, the Expansion
Type property in SmartPlant P&ID specifies the expansion behavior when publishing an
instrument or loop. Each value of the property corresponds to a SmartPlant Instrumentation
rule that determines which instrument types and numbers are to be created in SmartPlant
Instrumentation when the SmartPlant P&ID tag is expanded and retrieved.
When retrieving data back to SmartPlant P&ID, the behavior of a particular
instrument created by expansion is determined by SmartPlant Instrumentation parameters.
For an expanded instrument, the state of the IRetrievableExpansion interface determines
whether that instrument will be retrieved by SmartPlant P&ID: if the IRetrievableExpansion
interface is realized, the instrument is retrieved, whereas if the IRetrievableExpansion
interface is not realized, the instrument is not retrieved. The 'parent' item tag is always
retrieved, regardless of the realization state of the IRetrievableExpansion interface.
Ports
SmartPlant Instrumentation uses physical ports, while SmartPlant P&ID uses logical ports.
SmartPlant Instrumentation publishes the physical ports with the Dimensional Data Sheets
and not the Instrument Index. SmartPlant P&ID retrieves the Instrument Index and does
not retrieve the Dimensional Data Sheets.
When the workflow goes from SmartPlant P&ID to SmartPlant Instrumentation, followed by
SmartPlant Instrumentation publishing the Dimensional Datasheet, a Same As relationship
is created between the ports in the SmartPlant Foundation database. That Same As
relationship is required by Smart 3D to correctly match the design basis ports to the 3D
representation of the ports.
When the workflow goes from SmartPlant Instrumentation to SmartPlant P&ID, however, a
Same As relationship is not created in the SmartPlant Foundation database. Without the
Same As relationship created in the SmartPlant Foundation database, the result may be
additional ports in Smart 3D. To obtain the Same As relationship on the ports requires that
SmartPlant P&ID publish the P&ID with the instrument, this P&ID be retrieved by SmartPlant
Instrumentation and then having SmartPlant Instrumentation publish the Dimensional Data
Sheet.
Drawing Items
For Smart 3D to properly determine flow direction in a process run, that process run must be
connected to at least 2 items.
Some items that can be represented as single objects in SmartPlant P&ID, such as Vent
Detail, are modeled in Smart 3D as a set of separate objects. For full correlation to be
established between the two tools, ensure that these objects are modeled in SmartPlant
P&ID with the same configuration used to represent them in Smart 3D.
Properties
Smart 3D handles temperature and pressure properties in pairs and does not support
having a temperature (for example, Normal Operating Temperature) without defining the
matching pressure (in this case, Normal Operating Pressure). While this is a valid condition
for SmartPlant P&ID, it should be a consideration when publishing for retrieval into Smart
3D. Without the Pressure / Temperature pair of values defined, the Smart 3D user will be
required to enter a value that was not defined in SmartPlant P&ID.
Registering Tools
Before you can publish and retrieve documents from any of the other authoring tools, such as
Aspen Basic Engineering or SmartPlant Instrumentation, you must register each plant in
SmartPlant P&ID with a SmartPlant Foundation database. The connection allows SmartPlant
P&ID to display the SmartPlant integration commands. A SmartPlant Engineering Manager
administrator typically registers plants.
The software maps a plant and all its projects to a single SmartPlant Foundation URL, which
points to one, and only one, SmartPlant Foundation plant database and its projects. When you
use the Register command in any of the authoring tools, you are registering an authoring tool
plant with a SmartPlant Foundation URL and plant that you specify.
The system administrator must register each plant in the authoring tool once; this action takes
place in SmartPlant Engineering Manager. After the plant is registered, you can publish and
retrieve documents.
This command is available only if the active plant has been registered. For more
information, see SmartPlant Engineering Manager Help.
From the SmartPlant Foundation Web Client, you can perform a number of tasks, such as
publishing or retrieving documents, comparing documents, subscribing to document
changes, and so forth. Many of these tasks can be performed from the authoring tools,
such as SmartPlant P&ID or SmartPlant Electrical, but the Web Client provides unique
access to other features such as the Web Client To Do List and search capabilities.
Publishing Documents
In an integrated SmartPlant environment, you must publish documents containing the drawing
data and relationships before the authoring tools can share this information. The publishing
process involves selecting a document to publish, assigning it to a workflow (if necessary), and
specifying a revision and version of the document if specified in SmartPlant Foundation. For
most documents, the associated data is included in the publishing process.
The authoring tools publish data in XML format. The software then places the .XML file in the
appropriate SmartPlant Foundation vault and loads the data from the .XML files to the
SmartPlant Foundation database. After the document is published, users can retrieve the data
from the .XML file in the SmartPlant Foundation vault into other authoring tools.
When you publish documents, the software does the following things:
Creates a new master document and the first revision in SmartPlant Foundation the first
time you publish a particular document. From that point on, the software creates new
versions and revisions when the document is subsequently published. The software relates
revisions to the master document. You can publish subsequent revisions into a workflow,
which can be a different workflow than assigned in the original publish. Changes in the
document status of a related revision change the status of the subsequently published
versions and revisions of the document.
Publishes a visual representation of the document that you can view without the authoring
tool. For many applications, this is an Intergraph proprietary file, called a RAD file. The
viewable file can also be an Excel spreadsheet or another viewable file type, such as .pdf or
.doc. You can review and mark up the visual representation of the document, which is
attached to the document revision, using SmartPlant Markup.
Publishes associated data, depending on workflow approval. If the data is approved and
loaded, it is used for reporting and subsequent retrieval by downstream applications when
the tools retrieve latest data. The software publishes only meaningful engineering data. The
published data is not enough to re-create the document in the originating tool.
The software publishes some document types without the associated data, such as reports
from authoring tools (for example, line lists in SmartPlant P&ID). Users can submit
documents published without data to workflows just like documents with data. The document
types and data that you can publish depend on the authoring tool you are using.
Places the published .XML file and any view files in the appropriate SmartPlant Foundation
vault. This .XML file can be retrieved when users in the authoring tools retrieve as-published
data.
Sends notification to the publishing tool.
For more information about revisions and versions, see the SmartPlant Foundation Web Client
User's Guide or the SmartPlant Foundation Desktop Client User's Guide.
Reasons to Publish
You can publish documents and associated data for several reasons:
To exchange and enhance data among tools, to avoid creating data multiple times in
multiple authoring tools
To report on common data originating in multiple tools
To provide enterprise-wide accessibility to published documents
To manage change, including workflow history and document revision management
You can also publish documents to share information with users in other tools without going
through a formal workflow. To share data, you can publish a document to a "for sharing"
workflow that has only a load step, so that the data in loaded into SmartPlant Foundation as
soon as you publish the document.
You can also publish a document by not assigning the document to a workflow, but rather by
using the default workflow from SmartPlant Foundation. When you do not select a workflow for a
document during publishing, the SmartPlant Loader Manager loads the document into
SmartPlant Foundation as soon as it reaches the top of the Loader queue.
Publishing Documents
Each authoring tool publishes different documents and data. The following list contains each
authoring tool that is part of integration, the document types that each tool publishes, and
information about whether data is also published with each document type.
Aspen Basic Engineering
Process Flow Diagrams (PFD)
Equipment Datasheets — documents and data
Equipment Lists (published as Equipment Datasheets) — documents and data
Stream Datasheets (published as Equipment Datasheets) — documents and data
SmartPlant P&ID
Piping and Instrumentation Diagram (P&ID) — documents and data
Line List — documents
P&ID generated report — documents
SmartPlant Electrical
SPEL Electrical I/O Lists — documents and data
SPEL Electrical Power Elements — documents and data
Cable Schedules — documents and data
SmartPlant Instrumentation
Instrument Index — documents and data (limited)
Instrument Specification Sheets — documents
Foundation, the authoring tools are notified of projects and contracts that need to be created in
the authoring tools.
The project breakdown structure contains a single project and the hierarchy of contracts under
that project in a plant/project structure. The project definition document contains information for
a single project that needs to be created in the authoring tool. The project list contains a list of all
projects in a plant, and it is used by those authoring tools that create all projects at one time.
The plant breakdown structure and project breakdown structure used in the authoring tools
must match the structure in SmartPlant Foundation for publishing from the authoring tools
and object correlation to work correctly.
When you publish data from an authoring tool, you may not be able view all the properties
that you published in the SmartPlant Foundation client. You can customize view definitions
to allow you to see additional properties. For more information about defining view
definitions in the SmartPlant schema, see Working with View Definitions and Create a View
Definition in the Schema Editor User's Guide. For further assistance with visualizing data in
SmartPlant Foundation, contact Intergraph Support Services.
When publishing from a project, an instruction container, which contains all the claimed
objects, is created within the tombstone file.
* This step applies to a plant that is configured to use SmartPlant Foundation revisions. If your
plant is configured to use SmartPlant P&ID revisions, a new revision is added in the SmartPlant
P&ID Revise dialog box.
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard.
If you logged on to the authoring tool with a user name that is not defined in the
integrated environment, you are prompted to log on when you use this command.
A plug-in can be created that will allow user intervention to modify, add, or remove
information from data to be published before it gets transmitted to SmartPlant
Foundation. For details, see Pre-Publishing Automation from SmartPlant P&ID.
3. Add any additional documents to the Selected documents list by clicking one of the
following toolbar buttons:
Engineering Tool — Opens the Publish from Engineering Tool dialog box for
selecting documents.
File System — Opens a standard Microsoft dialog box that allows you to select
files. When you select a file with this Select File dialog box, the Document Properties
dialog box appears, allowing you to specify information about the file, such as whether it
is a new file; the category, type, and subtype of the document; and the name,
description, and title of the document.
Find — Opens the Find Documents to Publish dialog box, which allows you to
search for documents. These are documents that have at least one revision and that
were not published after creation of the last revision. For more information, see Find
Documents to Publish Dialog Box (on page 227).
The documents that appear in the Selected documents list in the Publish dialog
box when it first appears are publishable documents that were selected within the authoring
tool before you clicked the Publish command.
4. Edit properties as required for the selected documents.
When multiple documents are selected, only property values shared by all the selected
documents appear in the grid. Changing a value in the grid changes that value for all the
selected documents.
To remove an entry (or node) from the Selected documents list, select the node in the
tree, and then click the Delete toolbar button.
5. From the Operations list, choose a publish method.
Select Publish to immediately start the publishing process as soon as you click OK.
Select Background publish to publish the selected documents immediately as a
separate process, allowing you to perform other tasks at the same time. When you use
this feature, an e-mail message alerts you when the process is complete.
If the authoring tool supports scheduled batch publishing, select the Scheduled
publish option to indicate that the publish process should be run in batch mode.
6. Click OK to complete the publishing procedure.
During publishing, an information dialog box appears with a progress bar. Click Show
Details to view details of the operation showing steps completed successfully, the current
step that is running, and steps yet to run. You can click Hide Details to hide this section of
the dialog box. If the View Log button on the dialog box is enabled, messages are available
concerning the operation. These messages may include errors or warnings or even
informational messages. Click View Log to see these messages.
The SmartPlant Schema file must be checked in to SmartPlant Foundation when you
publish. If the publish operation fails, contact your SmartPlant Foundation system
administrator to make sure the SmartPlant Schema is checked in to SmartPlant Foundation.
Find Documents to Publish from SmartPlant P&ID Drawing Manager (on page 226)
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard.
If you logged on to the authoring tool with a user name that is not defined in the
integrated environment, you are prompted to log on when you use this command.
3. In the Publish dialog box, click the Issue Request tab.
4. In the Issue to box, select the contract to which you want to assign the document or
documents.
5. Under Selected documents, select the documents you want to associate with the specified
contract.
6. Add any additional documents to the Selected documents list by clicking one of the
following toolbar buttons:
Engineering Tool — Opens the Publish from Engineering Tool dialog box for
selecting documents.
File System — Opens a standard Microsoft dialog box that allows you to select
files. When you select a file with this Select File dialog box, the Document Properties
dialog box appears, allowing you to specify information about the file, such as whether it
is a new file; the category, type, and subtype of the document; and the name,
description, and title of the document.
Find — Opens the Find Documents to Publish dialog box, which allows you to
search for documents. These are documents that have at least one revision and that
were not published after creation of the last revision. For more information, see Find
Documents to Publish Dialog Box (on page 227).
The documents that appear in the Selected documents list in the Publish dialog
box when it first appears are publishable documents that were selected within the authoring
tool before you clicked the Publish command. To remove documents from the list, select
them and then click the Delete toolbar button.
7. Click OK to issue the contract request for the selected documents to the integrated
environment.
8. Start SmartPlant Foundation Desktop Client on your computer and search for the published
document to verify the publishing process.
9. Right-click the document in the Desktop Client tree view and on the shortcut menu, click
Refresh.
10. Update the document. For more information, see the SmartPlant Foundation Desktop Client
User's Guide.
11. Review the issue properties by right-clicking the document and on the shortcut menu,
clicking Properties, and then clicking the Issue Request tab to see the issue information.
You can also open the document to see the issue information in the title block.
12. Publish the document with the updated issue information.
Engineering Tool — Displays a tool-specific dialog box that allows you to add documents
from authoring tools, such as P&IDs or PFDs, to the Selected documents list.
File System — Opens the standard Select File dialog box that allows you to select
documents, such as Microsoft Word documents or Microsoft Excel workbooks, to add to the
Selected documents list. When you select a file using this dialog box, the Document
Properties dialog box opens, allowing you to specify information about the file, such as whether
it is a new file or was previously published; the category, type, and subtype of the document;
and the name, description, and title of the document.
Find — Opens the Find Documents to Publish dialog box, which allows you to search for
documents to add to the Selected documents list.
Even with the Issue Only option set, documents may still be published. Any documents that
have never been published must be published, regardless of this setting.
You will receive an error message if you select multiple documents and activate this option
when one or more of the selected documents cannot be changed. For example, if a selected
set of documents includes new documents (for which this field can be set only to No) and
current or locked documents (for which this field can be set only to Yes), the error message
prompts you to select a smaller set of documents.
Owning Group - Select an owning group from the drop down list to which the document
belongs.
By default, the owning group selected for the previous version, if any, is shown.
All the owning groups configured in SmartPlant Foundation are listed.
Revision - Displays the current revision number of the selected document or documents.
You will receive an error message if you attempt to change the value in this box when you
have selected one or more documents that have conflicting revision schemes or different
possible revisions. The error message prompts you to select a smaller set of documents.
Revision Scheme - Displays the revision scheme applied to the selected document or
documents.
Only revision schemes that are applicable to the configuration (plant) or classification
(document type) are available in the shortcut menu. The revision schemes related to a
configuration or classification are not available for any other configurations or classifications. If
none of the revision schemes are related to the configuration or classification, then all revision
schemes are available unless they are related to any other configuration or classification. For
more information on revision scheme configuration, see Configuring Different Revision Scheme
Strategies in the How to Configure Document Management guide.
You will receive an error message indicating that this field cannot be edited if one or more
of the documents you have selected are not new or will have a revision scheme supplied by the
authoring tool. The error message prompts you to select a smaller set of documents.
Version — Indicates the current version of the document or documents.
Workflow — Indicates to which workflow the selected document or documents were assigned.
You will receive an error message indicating that this field cannot be edited if one or more
of the documents you have selected have conflicting sets of possible workflows. The error
message prompts you to select a smaller set of documents.
Check and publish released claims for previously deleted items - Select this check box to
resolve issues where deleted items were restored from an earlier version and the claim on them
was released. This check will take additional time and should only be used when deleted items
have been restored.
Operation — Select the operation you want to perform on the selected documents. Choose
from the following options:
Publish now — Selected documents are published immediately.
Background publish — Selected documents are published immediately as a separate
process, allowing you to perform other tasks at the same time.
Scheduled publish — Selected documents are published in batch mode by the authoring
tool. This option is available only for tools that support it and if processed by the authoring
tool, not the SmartPlant Client. The documents are not published immediately. Instead, the
selected documents are scheduled for publish at a later time and maybe be scheduled as a
recurring operation.
Custom — If applicable, opens the Custom dialog box. This functionality is available only if
defined by your project implementation team.
Issue to — Contains a list of all objects (contracts) that can support issue requests. When you
select an item from this list, the names of any documents associated with that object appear in
the table below.
Add — Creates a new item in the table for any documents highlighted in the Selected
documents tree view.
Remove — Deletes a selected document from the table.
Document Name — Displays the names of all documents associated with the object in the
Issue to box.
This feature is also available by clicking Find on the Publish dialog box.
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard.
The Find Documents to Publish command determines which documents need to be
published or re-published and displays the results on the Find Documents to Publish
dialog box.
2. From the Select documents to publish list on the Find Documents to Publish dialog box,
select the check boxes beside the documents that you want to publish.
You can quickly select the entire list by clicking Select All, or you can clear the entire
list by clicking Clear All.
3. Click OK to accept the selections. The documents you selected to publish now appear in the
Documents to Publish list on the Publish dialog box, and are ready to be published.
The lists displayed on the Find Documents to Publish dialog box are compiled at the
time indicated in the Last search performed box. You can update the lists by clicking Update,
but this process can be time consuming, depending on whether you are running the applications
in synchronous or asynchronous mode.
Check for deleted objects no longer on documents option will be checked and disabled
if Automatic process of moved objects option is set to TRUE on the Manage Integration
Options dialog box in the SmartPlant Foundation Desktop Client. For more information, see
Configure Automatic process of moved objects in the Integration Administrator's Guide.
The status bar contains three separate areas of information.
Revising Documents
The document revision process is separate from the publishing process, making it possible to
revise a document locally and in SmartPlant Foundation and save the revision values to the tool
database without re-publishing the document. You specify the revision using the Revisions >
New Revision command.
Revising a document creates a revision for the document with major and minor revision values
set, depending on the revision schema selected. When revising a document, you can modify the
major and minor revision data on the document.
You can change the revision scheme after a document has been published, skip revision
numbers, and manually add a revision number, then have it validated against the revision
scheme. It is not required to assign a minor revision number. Also, revision data from tools is
supported even if the document has previously been revised in SmartPlant Foundation.
You can revise a document by using any previous revisions that are available from
the last published revision.
Example:
If you revise a new document using the revision scheme RevAlpha (A, B, C, D…) and revision
C, then SmartPlant Foundation reserves revision number C for the document. Revising the
same document with RevAlpha, you can now revise with any previous revision numbers, such
as A or B. However, if the document is published to SmartPlant Foundation with revision number
C, you are not allowed to go back to the previous revision numbers.
The following table contains the available revision numbers based on the document revision
state in SmartPlant Foundation:
For more details about performing revisions for SmartPlant P&ID, see Revising Drawings (on
page 120).
Retrieving Documents
When you retrieve documents into an authoring tool, you are retrieving the document data that
was published by another authoring tool. For example, in SmartPlant Instrumentation, you can
retrieve engineering information from a published P&ID into the SmartPlant Instrumentation
database.
The authoring tools provide commands that let you select a document and retrieve it into that
tool. You can use either the SmartPlant > Retrieve command to open a wizard that assists you
in retrieving applicable documents, or with some authoring tools, you can configure an automatic
retrieval feature.
When you publish a 3D model, you must now enable the Scheduler and Loader in
SmartPlant Foundation to make the 3D model data document retrievable. The load, consolidate,
and merge tasks must complete successfully before the 3D model document can be retrieved.
The software trims all leading and trailing spaces from all strings and from all values
without units of measure. These spaces do not appear in the retrieved data file.
Additionally, you can access the Web Client through the SmartPlant > Browser command. This
allows you to select the document or documents that you want to retrieve from your Web Client
To Do List, the tree view, or by using the Web Client search functionality. After you select the
documents that you want to retrieve, you can use the Retrieve command on the Web Client
SmartPlant menu to start the retrieval process.
The Retrieve command provided in the authoring tools is slightly different from the Retrieve
command available in the SmartPlant Foundation Web Client. The Web Client presents a list of
documents from which you can select those you want to retrieve. However, when you use the
command from an authoring tool without first selecting documents, the software searches the
SmartPlant Foundation project for documents to retrieve, and these are presented in a list on
the Retrieve dialog box.
You can retrieve a document in two ways:
As published — Retrieves only the data the authoring tool originally published with the
selected revision and version of the document. Retrieving as-published data retrieves the
.XML file the authoring tool published from the appropriate SmartPlant Foundation vault.
With the latest data — Retrieves the latest data associated with the selected document in
the SmartPlant Foundation database. If another, more-recently published document contains
updates to objects in the selected document, the software retrieves the most current data in
the SmartPlant Foundation database for those shared objects. When you retrieve the latest
data, SmartPlant Foundation generates an .XML file containing the published data.
PDS
Does not retrieve
All Authoring Tools
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,
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 PBS document published by SmartPlant Foundation 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. 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.
Retrieving the project breakdown documents and the PBS into SmartPlant Engineering
Manager creates the appropriate structures automatically.
When using SmartPlant Instrumentation, you must create the plant hierarchy according to
the PBS information in SmartPlant Foundation before you retrieve either the PBS or the
project definition document. You must create a plant hierarchy with at least three levels with
a minimum of one unit before you can retrieve the PBS and project definition document.
When working in a project, retrieval is not available.
For certain document types, the tool schema definition may specify that To Do List tasks
(Create, Update, or Delete) will not be generated for those document types. For details, see
Suppress Generation of Tasks on Retrieve.
Design Basis
Objects that tools retrieve from other authoring tool documents can become the design basis for
objects in downstream documents. Objects that become the design basis for other objects can
be specific objects that get richer as they move through the life-cycle or can be schematic or
logical objects in one application that evolve into more detailed objects downstream.
Design basis is implicit based on retrieval; you do not have to define it. For example, a pump
retrieved from a PFD becomes the design basis for a pump in the P&ID. When you change
common properties for the pump and retrieve the changes into SmartPlant P&ID, tasks to
update property values automatically appear in the To Do List. The same process works for
logical items that are a design basis for other items, such as a stream in Aspen Basic
Engineering that results in multiple pipe runs in SmartPlant P&ID, or a P&ID tag in SmartPlant
P&ID can evolve into a control loop with associated tag numbers in SmartPlant Instrumentation.
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard.
If you logged on to the authoring tool with a user name that is not defined in the
integrated environment, you are prompted to log on when you use this command.
The Retrieve command searches the SmartPlant Foundation plant for documents that
are ready to be retrieved into the authoring tool. These documents appear in the
Documents to retrieve list in the Retrieve dialog box.
2. In the Document type list box, specify the type of document to be retrieved. The default
option is All.
3. Select further filtering options in the Show area of the dialog box.
Select New documents to only display documents that have not been retrieved
previously.
Select New versions of retrieved documents to only display documents that are a
new version of a previously retrieved document.
Select Unchanged documents to display documents that have not been modified since
the last retrieval process.
4. Select Documents of all owning groups to display all documents.
5. In the Documents to retrieve list, select the check box beside each document you want to
retrieve. To help identify the documents, review the details in the Type, Revision, Version,
and Last Retrieved columns.
To quickly select the entire list, click Select All. To quickly cancel the selections, click
Clear All.
6. For each document you selected, use the Retrieve Option column to specify whether you
want to retrieve the document with the latest data or retrieve it as published.
7. Click OK to retrieve the specified documents.
Select the Batch retrieve option if you want the retrieve process to run in batch mode. If
you select this option, an e-mail message will alert you when the process is complete.
Otherwise, the retrieval process begins when you click OK.
The Deleted and Unclaimed Objects document is retrieved automatically every time you
retrieve, if there is a newer version of this document since the last retrieval. The
document is not included in the list, but it is retrieved automatically, when necessary, to
ensure that the applicable information is updated.
During retrieval, an information dialog box appears with a progress bar. If the View Log
button on the dialog box is enabled, messages are available concerning the operation.
These messages may include errors or warnings or even informational messages. Click
View Log to see these messages.
retrieve and then use the Retrieve Option column to specify whether you want to retrieve the
document with the Latest Data or retrieve it As published.
Select All — Selects all the files in the Documents to retrieve list.
Clear All — Cancels the selection of documents in the Documents to retrieve list.
Batch retrieve — Indicates that the system will retrieve the selected documents in batch mode,
in other words, in the background. When you use this feature, an e-mail message alerts you
when the process is complete. Otherwise, the retrieval process begins as soon as you click OK.
Work Breakdown Structure (WBS) documents, such as the Project List, Project
Definition, and Project Breakdown, and Plant Breakdown Structure (PBS) documents are
considered Administrative documents by the software and must be retrieved by all tools that
subscribed to these types of documents. So, even when these documents are new to the tools
(have not been retrieved by the tool before), they are still listed in the Documents to be
retrieved only list because they must be retrieved.
Scheduling Wizard
Scheduling Tasks
Drawing Manager has the capability to let you schedule tasks to complete at a later time or on a
regular interval. For example, you can schedule drawings to print at a time when the print queue
is not in high demand, or you can schedule a drawing to publish at a specific time every day.
Tasks that can be scheduled are either associated with a schedule command on the main
menus or with a Schedule button on a dialog box. Clicking either one of those opens the
Schedule Task Wizard, and you can progress through screens that are appropriate to your task
and specify options for that task.
After setting up the schedule, the wizard relinquishes control over the schedule to
your Windows operating system. The only way to modify or delete a task schedule is to use the
Control Panel > Scheduled Tasks utility.
Schedule a Task
1. If you choose to schedule a task, such as printing, archiving, or publishing, by selecting a
schedule command or clicking Schedule on a dialog box, the Schedule Task Wizard
opens.
2. Follow the directions, fill out options, and click Next on the wizard to complete the schedule.
3. Click Finish on the last wizard screen in order to exit the wizard.
Troubleshooting
Problem: The application fails to launch or stops working when the user launches it.
Reasons: The application may fail to launch due to damage in any of the following areas:
Cached data
Database connection or database client
Database server, site, or plant
SmartPlant P&ID client software
SmartPlant P&ID client USER information
Solution: We recommend that you perform each of the following steps in the order shown and
after each step try to launch the application. If the application still fails to launch, proceed to the
next step:
1. Open Task Manager and terminate the draft.exe process.
2. Reboot the computer.
3. Clean up temporary cached data (.tmp and .temp files) in the client's user profile. These
files are usually located in the path C:\Documents and Settings\username\Local
Settings\Temp\.
4. Check the database connection using the appropriate database tools.
5. Delete the SmartPlantManager.ini and SmartPlantPID.ini files. These files are usually
located in the path C:\Documents and Settings\username\
6. Uninstall the software client and do the following:
a. Clean up the current USER registry information:
HKEY_CURRENT_USER\Software\Intergraph\Applications\SmartPlantPID.Application
b. Ensure that the following registry settings have been removed:
HKEY_LOCAL_MACHINE\SOFTWARE\Intergraph\Applications\SmartPlantPID.App
lication
HKEY_LOCAL_MACHINE\SOFTWARE\Intergraph\SmartPlant P&ID
c. Clean up any left-over files and the following folders:
SmartPlant P&ID installation folder ..\SmartPlant\P&ID Workstation\.
Any subfolders in the Windows\Downloaded Installations\ folder that contain
SmartPlantPID.msi files.
Deletion of the SmartPlantManager.ini file and the current user's registry
environment will clear the user's recent activities and customized menu look-up.
d. Reinstall the software client.
If, after performing all of the above troubleshooting steps, the application still fails to launch,
contact Intergraph Customer Support.
catalog
A collection of catalog items, which are blueprints or templates for creating an item within the
model.
check in
The process of moving a file from a user location to a storage location and recording that
location in the database.
class
A blueprint for creating an item. The class defines the properties and behaviors that an item can
show.
client
A user, software application, or computer that requests the services, data, or processing of
another application or computer. The client is the user process. In a network environment, the
client is the local user process and the server may be local or remote. All network operations
among two or more nodes establish a client/server relationship.
client/server database
A database system in which the database engine and database applications reside on separate,
intelligent computers that communicate with each other through a network. In this system, the
processing power is split between the two CPUs. The workstation for the user is the client, and
the database runs on the server.
code list
See select list.
collaboration
Working jointly. In Workshare, satellite sites work together with the host site to share the
creation and maintenance duties for P&ID drawings and related data.
column
An attribute of a database table. A group of columns defines a table in the database.
commodity code
A code you define that provides an index to material descriptions.
commodity item
A standard component that you can find in a manufacturer catalog.
commodity option
A pre-defined exception to the default settings for a component definition in the Piping Job
Specification.
component
A catalog item that represents a part of the P&ID. A component has database information
associated with it.
concentric
Having a common center or origin point with varying radii.
configuration files
Files that are used to identify and characterize the components of a network. Configuration is
largely a process of naming network components and identifying relationships among those
components.
connect point
An active point item that is specially designated in a component. A connect point is a location at
which lines, labels, and other components connect to one another. Also, a location for applying
a relationship.
connectivity
Linkage between items that relate because of their graphics, like a valve and a pipe run. Proper
connectivity must exist to confirm valid data integrity.
connector
Item with multiple vertices; behavior of a connector relies on the two items that it connects.
data dictionary
The underlying data model of a plant, consisting of database entries and select lists. SmartPlant
Data Dictionary Manager maintains this information.
data model
Application items that populate a project. Typical items in a data model are components, lines,
and labels.
database
Collection of files of comprehensive information that have predefined structure and organization;
a specific program can communicate, interpret, or process these files.
database administrator
The technical support person who assigns user IDs and data access permissions, creates new
databases, removes databases no longer in use, and monitors disk storage usage of the
database and performance.
database link
A pointer that defines a one-way communication path from an Oracle database server to
another database server. This pointer is stored in the local database and identifies the remote
database, a communication path to that database, and optionally, a user name and password. In
connected Workshare, the database link is used to access the remote database, providing the
satellite a view into the plant schema at the host site.
database table
Part of the database consisting of rows and columns and containing information about the
project and design elements.
design file
File containing graphics and text data, also called a drawing file.
design-wide break
A region of the drawing within which a single property value is defined for all the included
components. Indicating the region, a closed shape exists, along with an accompanying label that
shows the property value.
display-only annotation
Feature that allows you to generate temporary annotation graphics for review without placing the
graphics in a design file.
drawing file
File that contains graphical items; also called a design file.
drawing, P&ID
Graphics file that contains data about one unit. Each drawing has a unique drawing number
within the unit to which the drawing belongs.
driving label
Graphics, text, or both with their own properties that are placed on the P&ID to define property
values of the components and groups to which they apply.
easting
Term used in plane surveying that describes an east, or positive, difference in longitude.
edge-edge model
A model that represents connectivity entirely by edges.
enumerated list
See select list.
equipment components
Items associated with pieces of equipment, such as nozzles and trays. 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 item and the parent item to which it belongs, for
example, an instrument can belong only to one loop at a time.
exit elevation
Lowest downstream elevation point on the internal diameter of a pipe.
filter
Function that creates a subset of items. This subset meets criteria that property values define.
fixed point
A control point that usually is a locally known monument with known coordinates.
flow rate
Quantity of fluid that flows per unit of time.
flow time
Required time for the flow, from the start of the piped system, to reach a downstream point.
full path name
Name of the entire path or directory hierarchy to a file, including the filename. See also relative
path name and UNC path.
gap
Condition that exists when two lines intersect graphically on the P&ID but not physically in the
plant.
glyphs
1. Icons attached to the pointer that provide feedback as you draw. For SmartPlant P&ID,
glyphs identify the relationships that you are creating.
2. Icons that show the perpendicular or parallel relationships with other items in the drawing as
you point over items in the drawing.
hierarchical
An ordered relationship from greatest to least; refers to the relationships among groups,
components, and labels.
hierarchy
A classified structure with superiors, or roots, and subordinates, or dependents, for grouping
files or commands.
horizontal angle
Angle measured in the horizontal plane. Horizontal angles are the basic measurements needed
to determine bearings and azimuths.
horizontal distance
Distance between two points computed using only the northing and easting coordinates of the
points.
host
A computer that acts as the controlling source of information. In SmartPlant P&ID Workshare, a
site that controls satellites.
implied piping component
Piping components that the software creates in the alphanumeric database; these components
are not represented graphically.
inline
Term used to refer to those piping or instrument components that have been inserted in a piping
segment.
inline instruments
Components that have been inserted in a piping segment. Inline instruments include instrument
valves, such as butterfly valves and temperature regulator valves, and other instrument
components, such as orifice plates and flow controllers.
instance
A single allocation of an item class.
instrument loops
A group of one or more instruments or control functions arranged so that signals can pass from
one function to the next for the purpose of measuring and controlling a process variable. In
SmartPlant P&ID, you can create instrument loops containing any combination of inline and
offline instruments.
instruments
Devices that directly or indirectly measure or control a variable in a plant process, such as flow
or temperature. Instruments can be devices such as final control elements, computing devices,
or electrical switches. Two types of instruments exist: inline instruments and offline instruments.
interference checking
Process that identifies possible collisions or insufficient clearance between items in a drawing.
isometric
Relating to or concerning a drafting system characterized by three equal axes at right angles; a
view in which the horizontal lines of an item are drawn at an angle to the horizontal and all
verticals are projected at an angle from the base.
item
Unit of storage within a larger unit, such as a file in a catalog; a single member in a drawing.
item type
Distinct objects that users can manipulate in SmartPlant P&ID, such as equipment, events, and
safety classes.
keypoint
A point on an item, including vertices, which is used to connect to the item.
label
A graphic representation that reflects the status or condition of an associated item.
line route
Collection of ordered line runs, gaps, and components that all share the same attribution. A line
route contains line runs, components, gaps, and properties; however, a line route does not
contain any branches.
line style
Collection of formats or properties that you name and store as a group to apply as a style of a
line.
loop
Software structure that allows a specified sequence of instructions to run repeatedly, if the
stated conditions remain constant.
macro
A sequence of actions or commands that can be named and stored. When you run the macro,
the software performs the actions or runs the commands. You can create the macros in Visual
Basic or other OLE-aware programming applications. Some of the OLE-aware programming
applications are VBA, Visual C++ Delphi, Visual Basic, and so forth.
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.
MTO
Material take-off; also called a Bill of Materials.
net service alias
(Oracle) An alternative name for a directory naming object in a directory server. A directory
server stores net service aliases for any defined net service name or database service.
net service name
(Oracle) A simple name for a service that resolves to a connect descriptor. Users initiate a
connect request by passing a username and password along with a net service name in a
connect string for the service to which they wish to connect: CONNECT
username/password@net_service_name.
network
Interconnection of host computers and workstations that allows them to share data and control.
The term has a dual meaning: network can refer to the devices that connect the system, or
network can refer to the connected system.
node name
A name or alias that you can assign to the node address of a device on a network.
northing
Term used to describe a north coordinate location in the plant coordinate system.
nozzle
A special equipment item that contains the connection point to piping.
offline
Term that refers to those instrument components that are not inserted in a pipe run.
offline instruments
Components that are not inserted in a piping segment. Typically, these components are the
instruments that monitor and control inline instruments. Offline instruments include temperature
regulators, level gauges, and system functions, such as digital control stations (DCS) or
computers.
Oracle Net
Communication software that enables a network session from a client application to an Oracle
database server. Once a network session is established, Oracle Net acts as a data courier for
the client application and the database server. It is responsible for establishing and maintaining
the connection between the client application and database server, as well as exchanging
messages between them. Oracle Net is able to perform these jobs because it is located on each
computer in the network.
Oracle Net Manager
A graphical user interface tool that provides an integrated environment for configuring and
managing Oracle Net Services.
ORACLE_HOME
An alternate name for the top directory in the Oracle directory hierarchy on some
directory-based operating systems.
orientation by system
A type of orientation in which the software places items in the same orientation that you created
them, if you place the items in free space or in a horizontal line. For example, if you placed the
item in a vertical line, the software automatically rotates the item 90 degrees counterclockwise
from the orientation in which you created it. See also orientation by user.
orientation by user
A type of orientation in which you define the orientation of an item when you place it. The default
orientation of this item is identical to items that the software orients. You can change the default
orientation at placement time. See also orientation by system and orientation fixed.
orientation fixed
A type of orientation in which the software places items in the same orientation in which you
created them, regardless of the method or location that you used for placement. You cannot
change the orientation at placement time. See also orientation by system and orientation by
user.
orthogonal view
A view that is a projection of the drawing onto a plane along lines that are orthogonal to the
plane.
P&ID
See Piping and Instrumentation Diagram.
parameter
A property with a value that determines the characteristics or behavior of an item.
parametric item
Item that contains geometry constrained together using relationships, with driving dimensions
that are defined as adjustable parameters.
path name
Sequence of directories leading to a file. See also relative path name.
peak flow
Maximum flow rate of water through a specific size pipe.
PFD
Process Flow Diagram; a drawing that serves as a start for a P&ID.
pipe run
A line run that has piping properties. Also, a contiguous set of pipe run segments separated only
by inline components, branch points and gap components. A pipe run has a beginning and an
end. It does not branch or contain spaces between components. A pipe run segment may have
identical properties as a pipe run from which it branches but is not considered part of the pipe
run.
pipeline
Set of connected piping segments and their associated piping items. Also, the collection of pipe
runs from all drawings in a project whose project-defined line property values are identical.
Piping and Instrumentation Diagram (P&ID)
A primary drawing for maintaining a plant. The P&ID includes three primary groups of items:
equipment, piping, and instrumentation. The drawing relates critical process-related information,
such as process conditions for temperatures and pressures, and identifies physical components
in the plant. The P&ID is the basis for both the construction of the physical plant and further
specification of instrumentation components.
piping components
Graphic elements that represent processes or functions within a particular piping segment.
Piping components include valves, flanges, reducers, strainers, and safety components. In
drawings, piping components are connected with multiple line segments.
Piping Materials Class (PMC)
Classification of components by service or specification - for example, a 150-pound carbon steel
specification.
piping network
Series of connected pipe runs and inline components. A network terminates at a nozzle,
off-page connector, utility connector, or one-point piping component - for example, a pipe cap.
piping segment
A line string with two or more vertices that defines the centerline geometry of the pipe run and
contains the non-graphic data associated with the pipe run.
plant
A group of facilities and equipment that performs one or more material processing functions
within a given geographical area. One company can have several plants located at different
geographical locations.
plant group items
The building blocks, such as site, plant, unit, area, and level, used to create plant breakdown
structures or plant structure hierarchies.
plant structure
Represents the business structure or physical hierarchy of a plant.
process line
Ordered collection of connectors and inline components with an equal set of core properties -
typically, items with the same line number. Specifically, a representation of the piping that
transfers process fluid.
process point
A tool that defines the operating conditions at a particular place during a process. Examples
include defining temperature, density, and flow rate.
project
1. A directory file created in an application environment that contains design files and
subprojects. A project is not necessarily specific to an application; the project may contain
design files from multiple applications.
2. Term used for convenient grouping of either all or part of the items that constitute a plant.
Several projects can be under design at one time, probably in separate geographical
locations and having limited communication among them.
projection lines
Witness lines; lines extending from the boundaries of an item and between which dimensioning
data for the area marked by the projection lines is placed.
property
A unique characteristic of an object, item, symbol, or document.
The properties of an item can include display properties and properties stored with the item. For
example, the properties of a valve symbol can include display properties such as color, line
style, and width. Other properties stored with the valve symbol can include the manufacturer,
cost, or material. Properties stored with the valve symbol are displayed in the Properties window
when the valve symbol is selected.
publish
To release a P&ID drawing for subscription or distribution.
publishing method
To publish a P&ID drawing using either the database link or the file sharing means of
transferring data.
reference data
A collection of information containing facts relative to industry design codes, catalog data of
vendors, job specifications, commodity libraries, graphics symbology, label descriptions, report
formats, and other information of a similar theme.
reference file
A drawing file attached to another drawing file for reviewing reference; a graphic representation
attached to a drawing view.
Relational Database Management System (RDBMS)
A database management system that uses Structured Query Language (SQL) to implement and
query data in relational tables.
relationship
A condition that exists between items indicating some form of communication of behavior or
state. You can establish relationships as you place new items or between items already on the
drawing sheet.
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.
revision cloud
A set or arcs used to enclose changes that have occurred since the last revision.
revision triangle
A numbered triangle placed in the P&ID to indicate the drawing revision when the change
occurred.
rule
Standard mechanism for creating relationships. A rule defines a valid context for two items to
communicate their behavior or state.
satellite
A server located remotely from the host server. In SmartPlant P&ID Workshare, a remote server
connected to a satellite slot at the host server.
satellite slot
The host's side of a Workshare connection. Satellites connect to the satellite slots made
available by the host at the host site.
schema
Description of the overall structure of the rulebase or database.
schema file
File that outlines the overall logical structure of a rulebase or database.
schematic file
Schematic drawing or diagram of a particular item in the plant.
search criteria
Set of values used to scan a database or object library.
segment
Contiguous piping and piping components between two points in the network at which properties
change value. Segments terminate by property break labels, branches, nozzles, off-pace and
utility connectors, and by the terminal ends of piping lines.
select list
List of related values that Data Dictionary Manager uses to specify various aspects of the data
model. For example, select lists allow you to select from a list of values for specific properties
when creating drawings, filters, and symbols. A select list for the fluid code property, for
example, allows you to select from a set of standard entries: such as P for process or MMA for
methyl alcohol.
server
In network operations, the node that maintains common data or performs a common task that
clients need. All network operations between two or more nodes establish a client/server
relationship.
signal lines
1. Intelligent line strings that connect offline instruments, inline instruments, and piping.
2. An ordered collection of connectors, and inline components with an equal set of core
properties: typically, items that share the same line number. Specifically, a representation of
the wiring used for transferring electrical or software signals.
3. A collection of signal runs from all drawings in a project whose project-defined line property
values are identical.
signal run
A line run with signal properties. See also pipe run.
site
A group of plants. A site can contain one or more plants.
site server
A text file containing the database type, connection alias, data dictionary, and schema
information for the site. Appears as the root directory for each site in SmartPlant Engineering
Manager.
SP_IDs
Unique identification numbers assigned by the SmartPlant software to all items created in the
database.
Standard Query Language (SQL)
Language developed by IBM for creating, modifying, and querying relational databases.
static Oracle port
A network configuration that forces an Oracle database link to always connect via a fixed path to
a fixed port number.
stockpile
View of the data model, displaying items that have not yet been placed in the graphic model.
style
1. The appearance of geometry and annotations on the drawing sheet. For example, color and
line weight of an element, the font used in a text box, and so forth.
2. A collection of formats or properties that you name and store as a group. When you apply a
style to a selected item, the software applies all the formats or properties in the style to the
element. The style types include: fill, dimension, line, and text.
subnet
A division of a network into an interconnected, but independent, segment, or domain, in order to
improve performance and security.
subnet mask
The technique used by the IP protocol to filter messages into a particular network segment. The
subnet mask is a binary pattern that is stored in the client machine, server, or router and is
matched up with the incoming IP address to determine whether to accept or reject the packet.
subscribe
To sign up for a service. In SmartPlant P&ID Workshare, to connect a satellite site with a
satellite slot at the host.
subscribe access
Read-only access to published P&ID drawings.
symbology
1. Display style of an item, including color, pattern, style, and width.
2. In Options Manager, symbology provides graphical clarity to a drawing by differentiating
among various items by their appearance. Symbology refers to the color, line weight, and
style associated with items in a particular filter.
table
Collection of data for quick reference, either stored in sequential locations in memory or printed
as an array of rows and columns of data items of the same type.
template
A document or file having a preset format, used as a starting point or blueprint for a particular
application so that the format does not have to be re-created each time it is used. In SmartPlant
P&ID, a file used to create a drawing with a set of default parameters; a template serves as an
outline or blueprint for you to create a new drawing. In SmartPlant Engineering Manager, a file
used to create roles, data dictionaries or other database schemas.
time stamping
A process that prompts the software to generate a record when you change a property.
transaction
A non-graphic record of any additions, deletions, and changes that you request during job
posting activities.
UNC path
Universal Naming Convention. The full name of a resource on a network. It conforms to the
\\servername\sharename syntax, where servername is the name of the server and sharename is
the name of the shared resource. UNC names of directories or files can also include the
directory path under the share name, with the following syntax:
\\servername\sharename\directory\filename.
unit
Group of parts of the schematic and individual worlds of a plant that together perform a given
process function. The identifying number of the unit is unique within the project and within the
plant. Most companies, but not all, use the concept of unit.
user name
Name that provides access to an account on the system. Same as username.
validation
A process or program that verifies data integrity in the database.
host • 244 M
macro • 245
I Map Source and Target Symbols • 36
implied piping component • 244 Mapping Dialog Box • 51
Import Drawings Command (File Menu) • 31 mirror • 245
Import Drawings Wizard - Complete Import mirror handle • 245
Map • 33 model • 245
Import Drawings Wizard - Missing Symbols model file • 245
Dialog Box • 32 Modify Drawing Properties • 18
Import Drawings Wizard - Options • 38 Modify Project Status • 65
Import Drawings Wizard - Select Drawings • Move a Drawing • 55
32 MTO • 245
Import Drawings Wizard - Select List
Options Dialog Box • 35 N
Import Drawings Wizard - Select Source
Navigating in Drawing Manager • 11
Plant • 31
net service alias • 245
Import Drawings Wizard - Summary • 53
net service name • 245
Import Drawings Wizard - Welcome • 31
network • 246
Import Options - Example 1 • 43
New Drawing Command (File Menu) • 23
Import Options - Example 2 • 44
New Drawing Dialog Box • 23
Import Options - Example 3 • 45
New Revision Command (Revisions Menu)
Import Options - Example 4 • 46
• 125
Import Options - Example 5 • 48
New Revision Dialog Box • 125
Import Options - Example 6 • 49
New Version Command (Revisions Menu) •
Importing Drawings • 30
100
Include Subnodes Command (View Menu) •
New Version Dialog Box • 100
15
node name • 246
Incremental New Versions Command
northing • 246
(Revisions Menu) • 101
nozzle • 246
inline • 244
inline instruments • 244
instance • 244 O
instrument loops • 244 offline • 246
instruments • 244 offline instruments • 246
interference checking • 244 Open a Drawing • 24
isometric • 244 Open Database Command (File Menu) • 13
Issue Request Documents from SmartPlant Open Drawing Command (File Menu) • 25
P&ID Drawing Manager • 220 Open Plant Structure Dialog Box • 13, 31
Issue Request Tab (Publish Dialog Box) • Oracle Net • 246
225 Oracle Net Manager • 246
item • 244 ORACLE_HOME • 246
item type • 244 orientation by system • 246
orientation by user • 247
K orientation fixed • 247
orthogonal view • 247
keypoint • 244
Out-of-Date Drawing Criteria Command
(Tools Menu) • 26
L Out-of-Date Drawing Criteria Dialog Box •
label • 245 26
line route • 245 Out-of-Date Drawings Command (File
line style • 245 Menu) • 25
loop • 245
U
UNC path • 253
Understanding the Drawing Icons • 12
Undo a Checkout • 84
Undo a Drawing Checkout • 74
Undo Checkout Command (Project Menu) •
73
Undo Checkout Dialog Box • 74
unit • 253
Unlock Plant After Group Rename
Command (Tools Menu) • 60
Update Command • 27
Upgrade Schema Command (SmartPlant
Menu) • 212
Use Minor Revisions in SmartPlant P&ID •
123
user name • 253
Using Drawing Versions • 99
Using Workshare • 167
Using Workshare in an Integrated
Environment • 168
Using Workshare with Projects • 171
V
validation • 253
Verify a Drawing for Checkin • 79
Verify for Checkin Command (Project
Menu) • 80
Verifying Drawings for Checkin Dialog Box •
80
Version History Command (Revisions
Menu) • 102
Version History Dialog Box • 102
View a Drawing in Drawing Manager • 25
View Dialog Box • 103
W
Working with Drawing Versions and
Revisions • 99
Working with Drawings • 21
Working with Drawings within a Project • 62
Working with Off-Site Projects • 62
Working with Projects • 61
Working with SmartPlant Integration • 207
Workshare Common Tasks • 169