Projects
Projects
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 Software License Agreement ("SLA") 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 SLA 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 use. 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 SLA 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.
Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.
Export Controls
Intergraph Corporation’s commercial-off-the-shelf software products, customized software and/or third-party software, including any
technical data related thereto (“Technical Data”), obtained from Intergraph Corporation, its subsidiaries or distributors, is subject to
the export control laws and regulations of the United States of America. Diversion contrary to U.S. law is prohibited. To the extent
prohibited by United States or other applicable laws, Intergraph Corporation software products, customized software, Technical Data,
and/or third-party software, or any derivatives thereof, obtained from Intergraph Corporation, its subsidiaries or distributors must not
be exported or re-exported, directly or indirectly (including via remote access) under the following circumstances:
a. To Cuba, Iran, North Korea, the Crimean region of Ukraine, or Syria, or any national of these countries or territories.
b. To any person or entity listed on any United States government denial list, including, but not limited to, the United States
Department of Commerce Denied Persons, Entities, and Unverified Lists, the United States Department of Treasury Specially
Designated Nationals List, and the United States Department of State Debarred List
(https://build.export.gov/main/ecr/eg_main_023148).
c. To any entity when Customer knows, or has reason to know, the end use of the software product, customized software,
Technical Data and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors 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 Customer knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export/re-export of relevant Intergraph Corporation software product, customized software, Technical Data
and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors, should be addressed to PPM’s
Export Compliance Department, 305 Intergraph Way, Madison, Alabama 35758 USA or at [email protected].
Customer shall hold harmless and indemnify PPM and Hexagon Group Company for any causes of action, claims, costs, expenses
and/or damages resulting to PPM or Hexagon Group Company from a breach by Customer.
Trademarks
Intergraph®, the Intergraph logo®, Intergraph Smart®, SmartPlant®, SmartMarine, SmartSketch®, SmartPlant Cloud®, PDS®,
FrameWorks®, I-Route, I-Export, ISOGEN®, SPOOLGEN, SupportManager®, SupportModeler®, SAPPHIRE®, TANK, PV Elite®,
CADWorx®, CADWorx DraftPro®, GTSTRUDL®, and CAESAR II® are trademarks or registered trademarks of Intergraph Corporation
or its affiliates, parents, subsidiaries. Hexagon and the Hexagon logo are registered trademarks of Hexagon AB or its subsidiaries.
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.
Introduction to Projects
Plants, once designed and built, are often modified throughout their lifecycles. During these
modifications, information assets of the "As-Built" state must be maintained. Using projects in
your plant allows you to maintain this information while allowing multiple projects, possibly
overlapping and running concurrently, to be designed, approved, constructed, and/or canceled.
What is a Site?
A site is a logical unit of data that is normally used to model a collection of physical plants. Every
plant within a site has a unique identity. You access a site by opening the smartplantv4.ini file,
which contains the database type, connection alias, and the schema information for the site and
the site data dictionary. The site schema basically keeps track of the plants in the site.
The Site Server node is the root directory for each site when opened in Intergraph Smart®
Engineering Manager.
What is a Plant?
A plant is a logical unit of data that is normally used to model a single physical plant. A plant has
a single plant hierarchy that defines the breakdown of the whole plant into its functional parts.
Every object within a plant has a unique identity.
A plant makes use of a single data dictionary and a single set of reference data. Named objects
are normally unique within a plant, but this is not a requirement.
A plant defines the largest scope of a report, and a plant can contain many P&ID drawings.
Plant items such as equipment, instruments and pipes are shown in schematic form on the
drawings.
What is a Project?
A project is a logical unit of data that is related to a plant. A project is used for making controlled,
incremental changes to the data in a plant. There can be multiple projects for a plant at any
given time.
The identity of objects within a project is the same as their identity within the plant. All projects of
a plant share the same data dictionary and the same reference data that is used by the plant. All
projects of a plant share the same plant hierarchy, with a few exceptions as noted later.
The scope of a project may be limited so that it deals only with a subset of the drawings and
plant items that exist within the plant. Changes made to items in a project do not immediately
affect the corresponding items in the plant. A project may be completed and merged back into
the plant, or canceled and discarded without affecting the plant.
What is Claiming?
The Claim operation identifies the scope of a project within a drawing. A project may affect some
items on a drawing and leave others unchanged. All items that are affected by the project must
be claimed before they can be modified or deleted. When a new item is placed on a drawing (in
a project) it is automatically claimed.
In Options Manager, a plant setting called Claim Mode controls how items are claimed by
concurrent projects. If the claim mode is Exclusive, only one project can claim an item at any
given time. Exclusive claim mode enforces the rule that concurrent projects do not overlap at the
object level. With this setting, conflict resolution at check-in time is simplified. If the claim mode
is Shared, a single item can be claimed to more than one project. Shared claim mode allows
concurrent projects to overlap at the object level. This setting may be required for plants that
have truly overlapping projects; however conflict resolution at check in time will be more
complex.
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.
version of it, the Replace Existing P&ID option on the Check Out dialog box is never
available. Likewise the OK button on the Fetch dialog box is not available if you select a
drawing to fetch that you have already fetched with read/write permissions. Of course, if you
really want to overwrite a drawing you already have fetched, you can delete the fetched version
first.
In This Section
Working Directly in a Plant ............................................................. 9
Using a Project for New Design Work ........................................... 9
Using Projects with an As-Built Facility Model............................... 10
Using Projects for Multiple, Overlapping Projects ......................... 10
Using Projects to Explore Alternative Designs .............................. 11
To... Use...
Manage drawings (fetch, check in, check Smart P&ID Drawing Manager
out, create and compare versions)
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.
in the plant before projects were enabled remain in the As-Built. All drawing versions in the
As-Built are read-only drawings when projects are enabled, but these drawings can still be
deleted in the As-Built, unless the drawing is either fetched or checked out to a project. If the
plant is registered in SmartPlant Foundation, drawings can be created and edited in the As-Built,
except for drawings that are checked out to a project.
▪ 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.
Enabling Projects
Before you can create projects in a plant, you must activate the plant structure for projects.
When you enable a plant for projects, the plant structure becomes the Plant (often referred to as
the Master or As-Built plant) and the Projects node is added under the Plant node. From this
point on, all changes to the Plant and its drawings must be performed in the context of a project.
▪ The Enable Projects command is not available unless you associate Smart P&ID or
Intergraph Smart® Electrical with your plant. Applications associated with the plant are
automatically associated with the project, except for Smart Process Engineering, for which
projects are not supported. For more information about associating applications, see
Associate Applications Wizard in the Smart Engineering Manager User's Guide.
▪ A plant cannot be enabled for projects if any drawings in the plant are in a re-create state.
▪ If the plant you are enabling for projects is using Workshare, the Satellites folder under the
plant structure is removed when projects are enabled. Therefore, before enabling projects in
a plant structure containing active satellites, you must transfer all drawings from the
satellites back to the host and delete all satellites from the plant.
Enable Projects
1. In the Plant Structures node, select the plant that you want to enable for projects.
2. Click Projects > Enable Projects.
▪ The Enable Projects command is not available unless you associate Smart P&ID or Smart
Electrical with your plant. All applications associated with the Plant are automatically
associated with every project created in the Plant.
▪ When you enable a plant for projects, the plant structure becomes the Plant (often referred
to as the Master or As-Built plant) and all drawings in the Plant are locked down. All
changes to the Plant and its drawings must be performed in the context of a project. To edit
a drawing in project mode, you must use Smart P&ID Drawing Manager to fetch the drawing
from the Plant into a project. To maintain one reference data source for all projects in the
Plant, only the Plant can modify the reference data. For more information about accessing
drawings from within a project, see Smart P&ID Drawing Manager Help.
▪ If the plant you are enabling for projects is using Workshare, the Satellites folder under the
plant structure node is removed when projects are enabled. Therefore, before enabling
projects in a plant structure containing active satellites, you must transfer all drawings from
the satellites back to the host and delete all satellites from the plant.
See Also
Enabling Projects (on page 13)
Using Workshare with Projects (on page 94)
Projects Node
The Projects node displays only after projects are enabled for the plant. When projects are
enabled, the plant structure becomes the Plant, which is often referred to as the Master or
As-Built plant. This node shows the active projects in the Plant and displays their attributes in
the List view.
Project names must be unique within a plant and cannot contain any of the following
characters: ~ ` ! % ^ & * ( ) - + = { } [ ] \ / ; : ‘ " < > , . ? |
See Also
Enable Projects (on page 14)
Creating a Project
After enabling a plant for projects, create a project in the Plant using the Projects > New
Project command. When creating a new project, the software automatically creates a new
database containing a project schema based on the Plant schema and project application
schemas based on the applications associated with the Plant. Because the reference data is
shared between the Plant and its projects, the software does not need to create project data
dictionaries.
New projects display in the List view when you select the Projects node inside the Plant
structure. The new project is also given its own node inside the Plant node.
After creating a project, set the project scope and create roles to assign user access to the
project. For more information, see Set Project Scope and Create a New Role in the Smart
Engineering Manager User's Guide.
▪ The claim mode is either Exclusive (default) or Shared, and applies to the Plant and all its
projects. If you plan to use the project in an integrated environment, Shared mode is
mandatory. For more information, see the Smart P&ID User's Guide and the Smart P&ID
Options Manager User's Guide.
▪ 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.
See Also
Enabling Projects (on page 13)
Setting the Project Scope (on page 23)
▪ Project names must be unique within the plant and cannot contain any of the following
characters: ~ ` ! % ^ & * ( ) - + = { } [ ] \ / ; : ‘ " < > , . ? |
▪ You do not have to be a site administrator to create a project, however if you create a
project without site administrator privileges, you will have no privileges in the project. Users
without site administrator privileges can create a project and add a role as long as they do
not exit Smart Engineering Manager. If they exit the program without adding themselves to a
role with necessary privileges, they will not be able to add roles or create plant groups in the
project.
▪ Before creating the project, be sure to set the claim mode using the Settings view in Smart
P&ID Options Manager. The claim mode is either Exclusive (default) or Shared, and applies
to the Plant and all its projects. If you plan to use the project in an integrated environment,
Shared mode is mandatory. For more information, see the Smart P&ID User's Guide and
the Smart P&ID Options Manager User's Guide.
▪ 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.
See Also
Enable Projects Command (Projects Menu) (on page 15)
Enable Projects (on page 14)
Creating a Project (on page 15)
Name — Type a name for the new project. Project names must be unique within a plant, cannot
begin with a numerical digit, and cannot contain any of the following characters: ~ ` ! % ^ & * ( ) -
+={}[]\/;:‘"<>,.?|
Description — Type a description for the project.
See Also
Creating a Project (on page 15)
Name — Displays the name of the project. You cannot change the project name after the
project has been created.
Description — Displays the current description of the project. You can type a new description.
Address — Displays the address for the project root item. This option appears only if the project
uses Hierarchy 2: Site/Plant/Unit or uses a hierarchy with the Site plant group type as the root
item. You can edit this value.
Date created — Displays the date on which the project was created. You cannot change this
value.
Number of plant items — Displays the number of plant items in the project.
Number of roles — Displays the number of roles defined for this project.
Plant structure type — Displays the current function of the plant.
Applications — Displays the engineering applications associated with the project.
Last backup — Displays the time of the last backup of the project.
If the plant has not been backed up the Last backup field displays a default date:
"3/8/2002 1:32:27 AM". This date indicates that the plant has never been backed up.
Hierarchy definition — Displays the plant breakdown structure and hierarchy items of the plant
on which the project is based.
Plant structure path — Displays the path to the share where the actual, physical plant structure
files reside. You cannot change this path after the project is created.
Backup location — Displays the path to the share where the project files are backed up. You
can change this path to point to a new backup location. This field is limited to 255 characters.
Publishing method — Displays the publishing method used to share project data in a
Workshare collaboration.
Publish location — Displays the UNC path to the shared location on the host site where the
shared data is stored. This field is limited to 255 characters and is available only when using the
file share publishing method.
Mail server — Displays the SMTP server address to which the administrative e-mail address
(below) has access.
E-mail address — Displays the e-mail address for the satellite site administrator. This address
must be a valid account known to the satellite Mail server defined above. The satellite site
uses this address to send a message to both the satellite and host administrators, notifying them
when the database link has been down for an extended period of time.
3. On the Set Project Scope dialog box, click the check box beside the plant groups in the
Plant that you want to share with the project.
4. Click OK. The selected plant groups should now appear in the Plant Groups node in the
project.
5. Assign user access rights to the project.
See Also
Setting the Project Scope (on page 23)
Set Project Scope Command (Projects Menu) (on page 24)
Project name — Displays the name of the project with which the selected plant groups will be
shared.
Plant groups — Displays all the plant groups currently available in the Plant.
Select All — Marks all the plant groups as shared.
Clear All — Removes the check marks beside the selected items in the Plant groups list.
Expand All — Opens all branches in the Plant groups list.
Collapse All — Closes all branches in the Plant groups list.
See Also
Setting the Project Scope (on page 23)
▪ Active — Indicates that the project is ready for design work to proceed. When a project is
created, it automatically becomes active and remains in this state until it is either completed
or canceled. While a project is active, all the various project design activities, such as
checking out and revising drawings, checking in drawings, and so forth, can be performed.
▪ Completed — Indicates that work on the project has come to an end. All drawings checked
out to the project are verified for check-in by Drawing Manager when the project is promoted
to Completed. Work in a completed project is not allowed. You can reactivate a completed
project and do more work, but to finish the project, you must change the status back to
Completed.
▪ Merged — Indicates that a project is complete and that all project data has been merged
back into the Plant. When the project is promoted to Merged, Drawing manager checks in
all drawings and merges all project data back into the Plant.
▪ Canceled — Indicates that the project can no longer be worked on. In this state, drawings
cannot be checked into or out of the Plant. Canceling a project releases all claimed items
and reverses the checkout of all drawings. A canceled project can be deleted in Smart
Engineering Manager.
See Also
Projects Node (on page 15)
2. On the Project Management toolbar, click to open the Project Status dialog box.
3. In the SmartPlant project status area, ascertain the current status of your project with
respect to the Plant.
A check mark denotes the current status. Possible statuses include Active,
Completed, Merged, and Canceled.
4. To change an active project to completed, click Complete Project. This button is available
only when the SmartPlant project status is Active.
When you change the project status to Completed, the software automatically sets
the status of all the items in the project to Completed, except for registered reports and all
documents (SLDs, schematics, miscellaneous drawings and electrical analysis SLDs). To
include these items when merging the project, you must mark them manually as completed
in a separate session.
5. To change a completed project back to active, click Return to Active. This button is
available only when the Smart Electrical project status is Completed.
6. To merge a completed project into the Plant, click Merge Project. This button is available
only when the Smart Electrical project status is Completed.
7. To cancel the active project, click Cancel Project.
▪ If you are registered with SmartPlant Foundation, click Refresh Status on the Project
Status dialog box to update the SmartPlant project status display.
▪ 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.
editing drawings are disabled. There is one notable exception to the general rule that all editing
takes place within projects: The Delete Drawing command is available from within the Plant.
The reference data for the Plant is shared with all its projects. All editing of the reference data
must be done through the Plant; therefore all reference data commands are enabled. The
project commands (such as Check Out, Check In, and so forth) are disabled.
Project
Within a project, all the commands for editing reference data are disabled. Reference data can
only be edited through the associated plant. The availability of the project commands and the
commands for editing drawings depends on the project status.
Active This is the initial state when a project is created and the state in
which most design activity takes place. All commands for editing
drawings are enabled. The project commands for pulling drawings
into a project (Fetch and Check Out) and merging drawings back
into the plant (Check In) are enabled.
Completed All drawings have been verified and are ready to be merged into
the plant. All commands for editing drawings are disabled. The
Check In command is enabled, but the other project commands
are disabled.
Merged All project drawings have been merged back into the plant and
the project is ready to be deleted. All commands for editing
drawings are disabled. All project commands are disabled.
See Also
Projects Node (on page 15)
▪ 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.
FrameWork 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 with SmartPlant if appropriate. This button is not available if the
plant is not registered with SmartPlant Foundation.
Smart Electrical project status — Options are: Active, Completed, Merged, or Canceled. If
your project status is Merged, then no further actions are available on this dialog box.
Return to Active — Returns the Smart Electrical project status to Active. This button is
available only when the Smart Electrical project status is Completed and the SmartPlant
project status, if applicable, is Active.
Complete Project — Sets the Smart Electrical project status to Completed. This button is
available only when the Smart Electrical project status is Active and the SmartPlant project
status is also Active. When you click Complete Project, a confirmation message appears.
Merge Project — Sets the Smart Electrical project status to Merged. This button is available
only when the Smart Electrical project status is Completed and the SmartPlant project
status is also Completed. When you click Merge Project, a confirmation message appears.
Cancel Project — Clears all claims on all objects and sets the Smart Electrical project status
to Canceled. This button is available only when the SmartPlant project status is Canceled. If
the Plant is not registered with SmartPlant Foundation, then the project is simply canceled out of
Smart Electrical.
Finishing a Project
Finishing a project is a two-step procedure: First, you must complete the project, and then you
must merge the project back into the Plant.
Completing a Project
To complete a project, start Drawing Manager, open the Project Status dialog box and click the
Complete Project button. This command performs several tests, including verifying all the
drawings for check in. If the project passes all the tests, the project state is set to Completed. If
the project fails to pass one of the tests, the project remains in the Active state and you have
more work to do before completing the project.
▪ Before a project can be completed, all the drawings that exist in the project must be checked
out (not just fetched). Checking out a drawing to a project means that this project is the only
one that can check it back into the plant.
▪ All drawings must be up-to-date with the version in the Plant. If another project has checked
in changes to one of the project drawings since it was fetched from the Plant, then the
project will fail to complete. In this case, you must refresh the affected drawings before the
project can be completed. This ensures that overlapping projects with shared drawings do
not destroy each other's changes. If projects do not share any drawings, this is not an issue.
The Verify for Check In command in Drawing Manager allows you to perform the same tests
on individual drawings that are done by the Complete Project process on all drawings. This
allows you to check if individual drawings are ready for check in as work on them is completed.
Merging a Project
The second step of finishing a project is to merge the project back into the Plant.
To merge the project, start Drawing Manager, open the Project Status dialog box and click the
Merge Project button. This command performs the check in operation on each of the
checked-out drawings and sets the state of the project to Merged.
Merging the project causes all the changes that were made in the project to be merged back into
the Plant. Prior to merging, the Plant is not affected by any of the changes that are done in the
project. After merging, all the project changes are incorporated into the Plant database.
In some workflows, it is desirable to merge some of the drawings back into the Plant before the
project is completed. Individual drawings can be merged into the Plant with the Check In
command in Drawing Manager.
Merged projects cannot be returned to an active status.
Canceling a Project
If you decide that a project should not be merged into the Plant, the other alternative is to cancel
the project. Canceling a project causes all the project changes to be discarded.
To cancel a project, start Drawing Manager, open the Project Status dialog box and click the
Cancel Project button.
Canceled projects cannot be returned to an active status.
Deleting Projects
Deleting a project removes the database tables and the associated user names for the various
project and application schemas generated when the project was created.
▪ Before you can access the Delete command from within a project, the project status must
be marked as merged or canceled, and you must have full control permissions in Smart
Engineering Manager.
▪ Prior to deleting the project, all users must be logged out of all software components that
use the project schemas. Smart Engineering Manager for open sessions of all database
users before deleting the project.
▪ The Delete command is not available for projects containing in-use satellite slots. All
satellite slot connections must be disconnected before the project can be deleted.
▪ The Delete command is not available if the project contains drawings at any plant group
level. All drawings in the plant group level of the project must be deleted before the project
can be deleted.
▪ Deleting a project cannot be undone.
▪ When deleting plant group levels, all drawings in the plant group level must be deleted
before that level can be deleted. Furthermore, the Delete command is not available for a
plant group level that is referenced (scoped) by another project.
See Also
Delete a Project (on page 30)
Delete a Project
1. In the Tree view, select the project node that you want to delete.
2. Right-click and select the Delete command.
3. Select the options on the Delete Plant Structure dialog box.
▪ Before you can access the Delete command from within a project, the project status must
be marked as merged or canceled in Smart P&ID Drawing Manager or in Smart Electrical,
and you must have full control permissions in Smart Engineering Manager.
▪ Prior to deleting the project, all users must be logged out of all software components that
use the project schemas. Smart Engineering Manager checks for open sessions of all
database users before deleting the project.
▪ The Delete command is not available for projects containing in-use satellite slots. All
satellite slot connections must be disconnected before the project can be deleted.
▪ The Delete command is not available if the project contains drawings at any plant group
level. All drawings in the project's plant group level must be deleted before the project can
be deleted.
▪ Deleting a project cannot be undone.
▪ When deleting plant group levels, all drawings in the plant group level must be deleted
before that level can be deleted. Furthermore, the Delete command is not available for a
plant group level that is referenced by a drawing in another level.
See Also
Deleting Projects (on page 30)
▪ Drop proxy users — Deletes the Workshare proxy users from the project schema
database. This option appears only if the project used Workshare.
The following individual application options appear only if that application is associated with the
project being deleted.
Disabling Projects
Disabling the Plant for projects returns the Plant to a pre-projects state. When you disable a
plant for projects, the Plant returns to its original plant structure status, and the Projects node is
removed from under the plant node.
Before you can access the Disable Projects command, all projects under the
Project node must be deleted.
See Also
Disable the Plant for Projects (on page 33)
Delete a Project (on page 30)
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 Smart P&ID Modeler User's Guide or the
Smart Electrical User's Guide.
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 49).
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.
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.
▪ 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.
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 42).
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 Smart 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.
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 check-out operation.
Replace existing P&ID — Overwrites the existing P&ID in the project if you have previously
fetched a version of this drawing. If you have more than one drawing selected, at least one of
them must exist in the project as a fetched drawing for this option to be available. 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.
Create New Version — Saves a new version of the drawing before overwriting the existing
version. This option is not enabled if the current drawing does not already exist in the
project. Also, if the drawing being checked out is already fetched to the project, you must first
select Replace existing P&ID to enable the option.
Comments — Allows you to enter comments pertinent to this check-out operation.
▪ 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.
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
39).
▪ 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.
▪ 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 Smart P&ID Modeler
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 46).
▪ 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.
▪ 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 39).
▪ 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.
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 Smart 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 52).
▪ 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.
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.
▪ Use the Compare command to compare two drawing versions selected in the History list.
For more information, see Compare Drawing Versions (on page 50).
▪ 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 51).
▪ Use the Delete command to delete a selected drawing version. You cannot delete the
current drawing version.
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 command 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
command 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. This command is not available unless you are in a project or 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 Smart P&ID. You can manipulate the view or select drawing items and
review their properties.
Fetch — Opens the Fetch Comments dialog box. This command 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 command is not available if you open this dialog box by clicking History on
the Fetch dialog box.
This command is not available in .
Delete — Removes the selected drawing version. You must have the appropriate permissions,
assigned in Smart Engineering Manager, to delete versions. You cannot delete the current
version of a drawing by using this command. 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.
▪ 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 44).
▪ 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.
▪ 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 44).
▪ 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.
▪ 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.
▪ 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 52).
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.
These .dll files are delivered to the Programmer's Guide\Sample Source Code\Item Tag
Validation folder on the product media. These files are not installed on your computer during
setup.
To use these files, you must rename the ItemTag.dll file installed on your computer (for
example, rename the file to DeliveredItemTag.dll), then copy from one of the product media
sub-folders (ActiveProjectAgainstAs-Built or ActiveProjectAgainstAs-BuiltAndProjects)
the ItemTag.dll flavor that you want to use. Place this copy in the same location as the installed
ItemTag.dll that you just renamed. When you are finished, remove the ItemTag.dll copy, then
rename the delivered copy back to its original name.
Claiming Items
A project in the Plant frequently deals with a subset of items within a drawing. The Claim
functionality provided by Smart P&ID allows you to grant control of an item to a project. Since
claiming makes it possible for a project to work on an item-by-item basis, claiming fosters an
ability to define the scope of work as narrowly as necessary.
However, when an existing drawing is fetched or checked out to a project, none of the items on
that drawing are initially claimed. Before you can modify any of those items, you must claim
them.
After you have claimed an item, you can modify it using the same methods that you would use in
a plant that is not project enabled.
Properties of items that are not claimed by the active project cannot be changed. The
Properties window and the Engineering Data Editor do not allow editing of properties on items
that are not claimed: the properties are read-only as if the drawing is in a read-only state. No
other explicit prompts let you know that you cannot edit an item that you have not claimed.
However, you can manipulate the Drawing view properties so that the claim state of items is
visually apparent.
You do not need to check out a drawing to claim objects; you can fetch a drawing with read/write
permissions and claim its objects. Claim commands appear on shortcut menus in the Drawing
view, in the Engineering Data Editor, and on the Edit menu.
Releasing Claims
From inside a project, you can invoke a claim at any time to expand the scope of your project,
and any new item created in a project is automatically claimed by that project. You can also
release a claim at any time, but you cannot release the claim that is automatically created when
your project creates a new item.
Claims are automatically released on all drawing items when that drawing is checked into the
Plant; however, a drawing cannot be checked in if any objects that are not claimed differ from
the Plant.
Claim Mode
The claim mode can be set to either Exclusive or Shared by using the Settings option in Smart
P&ID Options Manager. The claim mode controls how items are claimed by concurrent projects.
If the claim mode is set to Exclusive, only one project can claim an item at any given
time. Exclusive mode enforces the rule that concurrent projects do not overlap at the object
level. With this setting, conflict resolution at check in time is simplified.
If the claim mode is set to Shared, a single item can be claimed to more than one
project. Shared mode allows concurrent projects to overlap at the object level. This setting
may be required for plants that have overlapping projects. Conflict resolution at check in time
will be more complex.
Invalid Claims
When an item is claimed by a project, it must be consistent with the state of the item in the
Plant. Otherwise, an invalid claim exists. Invalid claiming can happen only for Plants that support
shared claiming of database items. Invalidly claimed items differ from the Plant items in that you
cannot modify them and check a drawing into the Plant without first establishing a valid claim.
When the Plant uses Shared claim mode and a project checks in a drawing, the claims made by
other projects to objects on that same drawing are now invalid if the project that checked in the
drawing also changed an item claimed by a different project.
You can determine the validity of a claim by using the Claim Status command. Invalidly claimed
items cannot be modified.
If an invalid claim is found but the item in question matches the item in the Plant, run Verify for
Check In to resolve the situation. This process automatically sets the claim to valid and allows
the check in to occur.
Partial Claim
When an item has a relationship with another item that has been claimed, but is not itself
explicitly claimed, it is said to have Partial Claim status, denoted by . Partial claim only
applies to objects connected to pipe runs (inline components such as instrumentation and piping
components).
Partial claim works automatically when a claimed pipe run is ‘broken’. There is a routine that
determines which side of the broken pipe run gets the new GUID and which side maintains the
original GUID. Inline components on the side that gets the new GUID receive Partial Claims
status, which is only for the purpose of changing their database relationship to the pipe run with
new GUID. Data cannot be edited on items that are ‘claimed for relationship purposes’.
▪ Drawing Manager is the only tool for checking in, checking out, and fetching drawings.
▪ You must have full control user access permissions for P&ID Objects before you can claim
objects. For more information about setting user access permissions, see Smart
Engineering Manager Help.
▪ Remember that objects are claimed by the project, not by a single user. Once a project
claims an item, it can be modified by anyone with the appropriate permissions in that
project.
▪ In Exclusive claim mode, the software allows the user to claim all the selected items that
were not already claimed by other projects. The claim log shows which items could not be
claimed because they were already claimed by other projects.
▪ Claiming items clears the Undo stack. Thus claiming is not a command that can be
undone.
See Also
Claim a Drawing Item (on page 57)
▪ Remember that objects are claimed by the project, not by a single user. Once a project
claims an item, it can be modified by anyone with the appropriate permissions in that
project.
▪ In Exclusive claim mode, the software allows the user to claim all the selected items that
were not already claimed by other projects. The claim log shows which items could not be
claimed because they were already claimed by other projects.
▪ Claiming items clears the Undo stack. Thus claiming is not an undoable command.
▪ You can only claim an item in the Engineering Data Editor if that item belongs to the active
drawing.
Claim Command
Gives control of the selected items to the current active project. The Claim dialog box opens,
allowing you to confirm the "claim-ability" of the items and enter claim comments. Claim
comments can be viewed later by anyone in the Plant when the claim status is displayed.
This command can only be used for items that belong to the active drawing.
See Also
Claim a Drawing Item (on page 57)
Enforcing Claims
Whether you are using shared or exclusive claiming mode, claiming objects to your project
involves many special relationships. The following topics discuss some of the ways that claiming
restricts your activities.
The claim mode (Exclusive or Shared) is defined in Options Manager for the Plant
and all its projects. When you claim an item, it is claimed to your active project. No items are
ever claimed by the Plant.
See Also
Controlling Access (on page 58)
Modifying Properties (on page 58)
Controlling Access
Each command in the software checks your permissions for the items that it modifies. When
possible, commands simply do not allow the operation to proceed if you do not have the
necessary permissions.
You must have full control permissions on P&ID Objects before you can claim any drawing
items. For more information, see User Access in Smart Engineering Manager Help.
Modifying Properties
Claiming impacts properties modifications in the following manner.
Properties Window
When you select a claimed item, the Properties window allows the properties of that item to be
viewed and modified. When you select an item that has not been claimed, the Properties
window allows the properties to be viewed but not modified. The properties of unclaimed items
are read-only.
When you select a line segment, the Properties window displays the properties of the
associated pipe or signal run. If the run has been claimed, the properties can be edited;
otherwise, the properties are read-only.
When you select multiple items, if they are all claimed, the Properties window allows them to be
modified. If any of the selected items are not claimed, the Properties window treats the whole
group as read-only.
Implied Items
When a drawing item is claimed, it means that you can modify that model item and all of its
implied items. If a model item is not claimed, the user cannot modify any of the implied items
that the model item owns.
Placement Rules
When a new relationship is created, such as when you place a nozzle on a vessel, the
applicable rules copy property values across the relationship. When a relationship to an
unclaimed item is created, properties can be copied from that item without any problem;
however, if the rule calls for properties to be copied to an unclaimed item, the action is not
allowed, and the properties are not copied. An inconsistency indicator shows the inconsistency
between the two related items.
See Also
Claim a Drawing Item (on page 57)
Geometric Modifications
Geometric operations include a geometric move, with the ALT key pressed where necessary, a
rotation, a mirroring, and a scale or parametric modification. The selected symbol does not have
to be claimed to perform these operations. None of the connected items have to be claimed
either.
the operations. Therefore, the lines, but not the selected symbol, must be claimed before these
operations are allowed. If the lines are not claimed, the standard claim violation message
displays.
Rule-Based Moves
All connected items must be claimed, as described above. If the required connected items are
not all claimed, the move operation can become a geometric move, as if you pressed the ALT
key.
See Also
Claim a Drawing Item (on page 57)
Geometric Modification
If you move a line segment or a line vertex that is internal to a line, then the piping or signal run
that owns the selected segment does not have to be claimed.
Placing Gaps
Placing a gap symbol into a piping or signal line implies that the target line must be claimed. If
the target line run is not claimed, it is not highlighted as a valid target when you move the pointer
over it.
See Also
Claim a Drawing Item (on page 57)
Replace Mode
The claim status check takes place as you move the pointer over the target. If the target is not
claimed, the target is not highlighted as a valid replacement target.
Deleting Items
Claiming impacts item deletion in the following manner.
Drawing Items
Drawing items are deleted from a design using a number of different commands: Delete to
Stockpile > Plant, Delete to Stockpile > Drawing, Delete from Model, and Cut. When
implementing these commands, all dependent items must be claimed. That is, all items that are
to be deleted along with a selected item must be claimed. Any lines attached to or dependent on
selected items must be claimed. If any attached or dependent items are not claimed, an error
message appears if you attempt to delete them. The following table lists dependent items which
must be claimed, item type by item type.
Item in Select Set Additional items that must be claimed for Delete
Item in Select Set Additional items that must be claimed for Delete
Line Segment The pipe or signal run that owns the segment
All components in that run
Branch Point All runs with lines that attach to that branch point
All item notes
Stockpile Items
Most items in the stockpile do not have any relationships. For these items, if the item is claimed,
it can be deleted from the stockpile. If the item is not claimed, the Delete command opens the
standard claim violation message.
Plant item groups, for example loops, packages, and so forth, exist in the stockpile and have
relationships to member items on a drawing or in a stockpile. If the plant item group is claimed
and all of its members are claimed, then the plant item group can be deleted. If the plant item
group or any of its members is not claimed, the Delete command opens the standard claim
violation message.
When an OPC is in the stockpile, it maintains its relationship to the partner OPC. OPCs can be
deleted from the stockpile only if both OPCs in a pair are in the stockpile and are deleted at the
same time. In a project context, both OPCs in a pair must be claimed before they can be
deleted.
See Also
Claim a Drawing Item (on page 57)
Validating Properties
The software uses validation functions before setting properties on items. The software checks
the claim status before setting any values. If the item is claimed, the property can be changed. If
the item is not claimed, the property cannot be changed. For more information about validating
properties, select Start > Programs > Intergraph Smart P&ID > Programming Help and see
the Extending the Capabilities of Smart P&ID and Logical Model Automation Reference topics.
From version 2009, you can use the validation and calculation functions on drawing
item type. The software uses the same automation interface managing all other item types.
Opens when you select one or more items and click Edit > Claim Status on the main menu bar.
You can review the details of the claimed state of the selected items, claim items, release the
claims to items, and discover other details of the claim status. To perform an action on an item
(claim, release claim, or show details), you must first select the row of the item. Hold down
CTRL or SHIFT to select multiple items.
Item Tag — The tag that identifies the item. If a selected item that appears in this dialog box
does not have an item tag, the value is blank.
Item Type — The item type to which the item belongs, for example: Mechanical, Nozzle,
PipingComp, SignalRun.
Claimed — Indicates the claim status of items claimed in the current project. An item claimed
by your active project is denoted by ; an item with an invalid claim on it is denoted by ; an
item which has a relationship with another item that has been claimed, but which itself was not
explicitly claimed is denoted by (partial claim); otherwise, this field is blank.
Claimed by Others — Indicates the claim status of items claimed by other projects. The
symbols are the same as for the Claimed column. If you are working in 'Exclusive mode', you
cannot claim an item that is already claimed by another project.
Claim — Opens the Claim dialog box, where you can claim the item and record claim
comments.
Release Claim — Releases the claim from your project. A confirmation message is displayed;
choose Yes to release the claim.
Details — Opens the Details dialog box, where you can discover what project has claimed the
selected item, the user that claimed it, and any claim comments that were entered when it was
claimed.
See Also
Claim a Drawing Item (on page 57)
▪ After setting the claim mode to Release Claim, the status of the items still remains behave
exactly in the same way as the scoped items as the software re-scopes them.
▪ To claim the items whose claim mode to Release Claim, right-click in the Project
Management table and then on the shortcut menu, click Mark as Reclaimed.
▪ After setting the claim mode to Release Claim, the status of the items still remains behave
exactly in the same way as the scoped items as the software re-scopes them.
▪ You cannot release a claimed item in the Engineering Data Editor if that item does not
belong to the active drawing.
▪ If you are working in a SmartPlant environment and there are any differences between an
item in the Project and an item in the As-Built, the claim cannot be released. If you are not
working in the SmartPlant environment, the claim can be released. Also, items that display
no warnings or errors are released.
▪ This command can only be used for items that belong to the active drawing.
Change details displays information about selected groups in the Change groups
area. Values for the Change details include the following.
▪ Add — Indicates that the selected group will be added to the version displaying on the right.
▪ Delete — Indicates the selected group will be removed from the version displaying on the
right.
▪ Modify — Indicates the selected group will be modified on the version displaying on the
right.
The two versions are displayed in two Drawing views, described as left and right views. The
relationship between the two views depends on whether you are comparing two versions in your
own database or comparing your version to a version in another database.
▪ Two versions are in the active database — The left-hand view is the older version, and the
right-hand view is the newer version. That is, they are displayed in time-order from left to
right.
▪ Two versions exist in different databases — The right-hand view is reserved for the version
in your active Plant or project database, and the left-hand view belongs to the version in
another database because you cannot be assured that time-order is the logical order to
display the versions.
You can also compare the differences between the typicals of either drawing. Using the select
list situated in the drawing name bar of each view, you can display the primary, typical, or both
views of the selected version.
3. In the History list box, select the drawing you want to compare your current drawing with.
4. Click OK.
5. On the Compare and Refresh dialog box, review the information in the Change groups
and Change details areas. Your current drawing displays on the right side of the
screen. The version you are comparing it to displays on the left.
8. Click OK to refresh the drawing and accept any changes or Cancel to dismiss the dialog
box.
Data Example
In this example, a jacketed tower exists in the version to be selected for the compare. The
current version contains the same jacketed tower but a change has been made to the Cleaning
Requirements property. When the current version is compared to the selected version, a data
change is found during the compare.
The current version appears on the right and the version it is compared to appears on the
left. Change groups indicates that there is only one group and a data change was located. All
items in the group are valid claims. Change details indicates that the comparison located a
different property value (Cleaning Requirement) in the current version.
Graphic Example
In this example, a jacketed tower exists in the version to be selected for the compare. The
current version contains the same jacketed tower but it has been moved to a new
location. When the current version is compared to the selected version, a graphic change is
found during the compare.
The current version appears on the right and the version it is compared to appears on the
left. Change groups indicates that there is only one group and a graphic change was
located. All items in the group are valid claims. Change details indicates that the comparison
located a graphic modification to a vessel (Jacketed Vessel) in the current version. If you
refresh the version, the graphic modification will be accepted as shown in the Change
column. Clicking in the Action column of the Change groups data allows you to take no action
or refresh (accept the previous location of the vessel). The settings are not applied to a version
until you click OK.
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 , the refresh action is not allowed.
Check box column — Displays colors in the drawings as defined using Compare Options. If
not selected, the Default items color displays.
Number — Displays an arbitrary number that is assigned to a logical change group when this
dialog box is opened. The number has no intrinsic meaning and may apply to a different group
the next time you open this dialog box.
Action — Defines which action is to be taken involving the selected change. In Smart P&ID
Engineering, this option is unavailable because it is not possible to refresh drawings.
Identifier — Lists item tags for the principal member of the change group, if an item tag is
assigned to that object. For instance, if a change group centers around data differences for a
vessel and its nozzles, then the item tag for the vessel is displayed in this column.
Category — Displays the category of the change, listed in order of highest to lowest priority.
Options include:
▪ Data — Indicates that a property value has changed (for example, a property value for a
vessel).
▪ Graphic — Indicates that a change has been made to an item in the drawing (for example,
a vessel has been moved).
Claimed — Displays an overview of the claim status of the individual items in the group.
Possible values are All, Some, or None.
Valid Claim — Indicates that the claimed item is a valid claim.
Change details
Lists all the individual items that belong to the group that you select from the Change groups
list. You can sort this list by clicking on any of the column headings.
Result — Displays one of three possible values: Left-Only, Right-Only, and Different.
Left-Only denotes an item that exists in the left-hand version only, implying that the item is
deleted from the right-hand version. Right-Only denotes an item that exists in the right-hand
version only, implying that the item was added to the right-hand version. Different denotes a
difference between the properties or graphical elements of an item that exists in both versions.
Change — Describes what action is required to make the drawing in the right frame match the
drawing in the left frame. Actions include:
▪ Add — Adds the listed item to the version on the right.
▪ Delete — Removes the listed item from the version on the right.
▪ Modify — Changes the listed item in the version on the right.
When a plant item group is sent to the Plant Stockpile and after creating a new
version of the drawing, that plant item group is assigned to a piece of equipment or an
instrument, the Change column displays the value Delete. Plant Item Group types that are
affected by this behavior are: Contract Package, Hydro Test Package, Package, Instrument
Safety Class, Test System, and Hydraulic Circuit. If the plant item group is sent to the drawing
stockpile, the behavior is identical; however, the Change column displays the value Modify.
Item Type — Describes the item type, such as Instrument, PipeRun, or Nozzle.
Specific Item Type — Displays the specific type of item, such as 3-Way Ball Valve, Piping, or
Flange Orifice.
Item Tag — Displays the item tag of the individual item in question if a tag has been assigned to
the item.
Category — Displays the highest priority category of change that applies. Possible categories
are:
▪ Data — Indicates that a property value has changed (for example, a property value for a
vessel).
▪ Graphic — indicates that a change has been made to an item in the drawing (for example,
a vessel has been moved).
Claimed — Displays the claim status of the object:
▪ — Valid claim
▪ — Invalid claim
▪ Not claimed.
▪ Added to Primary
▪ Added to Typical
▪ Moved to Typical
▪ Moved to Primary
▪ No Change in Typical
▪ No Change in Primary
Status bar — Displays the currently defined colors for illustrating comparison status. You can
change the color scheme by clicking the Compare Options button on the toolbar and
defining options on the Compare Options dialog box.
See Also
Claim a Drawing Item (on page 57)
Show Modified — Toggles the display of only those properties that are different between the
properties that belong to a selected drawing item. This button only applies to modified items that
exist in both versions; for added and deleted items, all properties are listed.
See Also
Claim a Drawing Item (on page 57)
3. In , do the following:
a. Open Drawing A.
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 Drawing Manager, create a version of Drawing G and make a note of the version
number (1).
5. In Smart 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 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 78).
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
For details, see Compare and Refresh Drawing Versions (on page 68).
b. Place a Revision Cloud around Control Valve FV-100 and Actuator ACT-100.
c. Place a Revision Triangle on the Revision Cloud. Label the Revision Triangle RT- 1.
d. Exit Drawing B'.
Drawing B' becomes Drawing B'''.
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''.
Key
Fetch drawing
Check in drawing
Check-in unsuccessful
▪ Standalone Workshare allows you to mix the type of databases used in a Workshare
collaboration.
▪ When a project is used as a Workshare host, the satellites synchronize their reference data
with the Plant reference data.
▪ When transferring ownership of a drawing to another Workshare site, the corresponding
versions are not transferred. Only the current version of the drawing is transferred.
▪ New plant groups (plants, areas, units, and so forth) cannot be created by satellites hosted
by a project.
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 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 95)
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 95)
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 95)
▪ You can work only in online mode that is, As-Built and projects must be connected to the
same database.
▪ When working in a plant that is registered with SmartPlant Foundation, the software
automatically determines the project status in the database according to the SmartPlant
project status.
▪ To be able to view and edit data in As-Built, make sure that in the Options Manager, on the
General Settings page, the Allow Full Access to As-Built is set to Yes.
Select a Project
This procedure shows you how to select a project for the current As-Built plant. Note that you
have to select a project every time you reopen the Project Management table. For more
information, see Select a Project (on page 115).
Scope Items
Once the Plant Administrator has scoped your project, you can start scoping the items that will
be available for viewing in the project. For more information, Scope Items (on page 117).
Understanding Statuses
A project status shows the stage of the project life-cycle. Possible project statuses are:
▪ Active — The initial state of a project right after its creation.
▪ Completed — Indicates that all the work on the project items has been completed and that
the items are ready to be merged back into the As-Built. You cannot claim items in a project
whose status has been set to Completed or Merged.
In a project, when searching for completed items in the Project Management
window, it is possible to select the related items which have not been completed yet and
change their status to Completed.
▪ Merged — Indicates that all the project items have been merged back into the As-Built.
▪ Canceled — Indicates that the project has been canceled and it can be deleted. Selecting
this project status changes the status of the items in the project from Claimed to Scoped.
The status of an item in a project determines what you can do with the item, for example,
editing the properties in the project. Possible item statuses in the project are:
▪ Scoped — Indicates that the item becomes available for viewing in the project and that it
can be claimed.
▪ Claimed — Indicates scoped items that have been copied to the project and they are
enabled for editing. There are two modes of claiming:
▪ Exclusive — Items can only be edited in the current project and cannot be claimed for
another project.
▪ Shared — Items can be claimed for another project and edited in that project.
▪ Completed — Indicates that the work on the item has been completed and the item is ready
to be merged back into the As-Built.
▪ Merged — Indicates that the item has been merged back into the As-Built.
The Project Management table displays the status of claimed items.
2. On the Project Management toolbar, click to open the Project Status dialog box.
3. In the SmartPlant project status area, ascertain the current status of your project with
respect to the Plant.
A check mark denotes the current status. Possible statuses include Active,
Completed, Merged, and Canceled.
4. To change an active project to completed, click Complete Project. This button is available
only when the SmartPlant project status is Active.
When you change the project status to Completed, the software automatically sets
the status of all the items in the project to Completed, except for registered reports and all
documents (SLDs, schematics, miscellaneous drawings and electrical analysis SLDs). To
include these items when merging the project, you must mark them manually as completed
in a separate session.
5. To change a completed project back to active, click Return to Active. This button is
available only when the Smart Electrical project status is Completed.
6. To merge a completed project into the Plant, click Merge Project. This button is available
only when the Smart Electrical project status is Completed.
7. To cancel the active project, click Cancel Project.
▪ If you are registered with SmartPlant Foundation, click Refresh Status on the Project
Status dialog box to update the SmartPlant project status display.
▪ 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.
Claim Items
You claim items by opening the project to which they were scoped, and then you select
individual items to claim. Note that you can claim main or related items separately. When
claiming an item in a project, with the appropriate Options Manager setting, you can choose
claim mode Shared or Exclusive. For more information, see Claim Items (on page 119).
Release Claim
Releasing the claim of an item enables you to cancel the claim of an item. This action makes it
possible to re-scope the item in As-Built if you need to update the data in the project. After the
item has been re-scoped, you can claim it again in the project and then edit the updated
data. Note that when releasing the claim of an item, it status in the project remains
Claimed. However, the claim mode changes to Release Claim. Items whose claim mode is
Release Claim behave exactly in the same way as the scoped items as the software re-scopes
these items. For more information, see Release Claim in Smart Electrical (on page 66).
▪ Click on the Project Management toolbar and then select the required option.
▪ Right-click in the Project Management table, click Display, and then click a command:
Main Items Only, Main Items with Related Items, or All Items as List.
Backup a Project
1. In an As-Built plant or project, click Windows > New > Project Management.
2. If your work environment is an As-Built plant, select the desired project. For details, see
Select a Project (on page 115).
3. In the Project Management table, do one of the following:
▪ The software saves the entire data in the current project to a Microsoft Access database
(.mdb) file.
▪ Project backup in Smart Electrical is compliant with SmartPlant backup and restore
instructions.
Restore a Project
When restoring a backed-up project, the software completely overwrites the
data of the current project with the data in the Microsoft Access database (.mdb) file that you
select. Since this process is irreversible, please exercise extreme caution before restoring a
project.
1. In an As-Built plant or project, click Windows > New > Project Management.
2. If your work environment is an As-Built plant, select the desired project. Select a Project
(on page 115).
3. Do one of the following:
4. On the Select MDB File for Restore dialog box, a desired Microsoft Access database
(.mdb) file and click Open.
Project restore in Smart Electrical is compliant with SmartPlant backup and restore
instructions.
Scoping Items
Once the Plant Administrator has scoped the project, you can start specifying which items will
be available for viewing in the project. This selection is called scoping items.
You scope items by selecting the required items in As-Built. The selection can be one of the
following:
▪ The entire plant hierarchy that was assigned in Smart Engineering Manager, according to
the scoping definitions that the Plant Administrator has made.
▪ Individual in the Electrical Engineer.
▪ Individual items in the Electrical Index.
▪ Several items in the EDE.
You can select loads, converting equipment, power sources, free cables, PDBs, and so
forth. Note that the software automatically scopes all the items that are associated with the
scoped items. These items are called related items. Related items are those items that have
an electrical or functional relationship to a main item. Related items may include control
stations, associated cables, circuits, and signals.
In addition to the items that are included in the scoped plant groups, you can also scope items
that belong to unscoped plant groups. However, you will not be able to claim these items or edit
them in the project.
When scoping, the software follows certain rules that govern which items become available for
viewing in the project. For details, see Rules for Scoping Items (on page 116).
Select a Project
1. In an As-Built plant, click Windows > New > Project Management.
2. In the Project Management table, do one of the following:
▪ You have to select a project every time you reopen the Project Management table.
▪ After closing the Project Management table, the software removes all the items from the
Project Management table.
Loads, converting Cables of any category (from / to Any cables connected to the
equipment, power sources sides) circuit rather than directly to
(generators, battery banks, the scoped load will not be
Control stations and their cables
offsite power) scoped with the circuit.
Instruments and their cables Instead, those cables will be
scoped with related
I/O signals
equipment like control
Associated Circuits, their stations.
internals and their PDB-Bus-Cell
associations
Metering equipment
Power distribution boards All buses, circuits and internals, No associated items external
up to the boundary of the PDB to the PDB items, such as
cables or signals associated
Metering equipment included as
with the PDB or circuits will
internals
be scoped.
You can scope the same item for more than one project.
Scope Items
1. In Smart Electrical, click File > Open > Plant Group to open an As-Built plant.
2. On the Open Plant Group dialog box, click Select Plant.
3. On the Open Plant Group dialog box, select the appropriate plant hierarchy level and click
OK.
4. Click Windows > New > Project Management.
Note that you can use the buffer to make a preliminary selection of items that you
may want to add to the Project Management tables. For details, see Use the Buffer to
Scope Items (on page 118).
8. Select the check box beside each main item that you want to scope.
▪ Select multiple items the Electrical Index, or the EDE and click .
▪ After closing the Project Management table, the software clears the all the items from the
table.
▪ You have to add items every time you reopen the Project Management table.
Claim Items
1. In a project, click Windows > New > Project Management.
2. Add the items that you require. For details, see Add Items to the Project Management
Table in a Project (on page 119).
3. Select the check box beside each item that you want to claim. For details of item statuses
in the project that determine which items you can mark for claiming, see Rules for Changing
Statuses (on page 109).
4. For each item that you want to claim, select Shared or Exclusive as the claim mode. Note
that if, in the Options Manager, General Settings, the As-Built Claim Mode option is set to
Exclusive, the Shared claim mode is not available.
5. Click the Apply command to claim the items.
▪ The items are now available for editing in the project. When you have finished editing
items, you can change their status to Completed. Items with status Completed are ready
for merging into As-Built.
▪ Check the data under Result Status to make sure that there are no problems.
▪ Click on the Project Management toolbar and then select Exclusive, Shared, or
Release Claim.
▪ Right-click in the Project Management table and then on the shortcut menu, point to
Set Claim Mode and then click Exclusive, Shared, or Release Claim.
5. Click the Apply command to claim the items.
The Shared claim mode is only available after selecting the appropriate setting in the
Options Manager.
▪ After setting the claim mode to Release Claim, the status of the items still remains behave
exactly in the same way as the scoped items as the software re-scopes them.
▪ To claim the items whose claim mode to Release Claim, right-click in the Project
Management table and then on the shortcut menu, click Mark as Reclaimed.
▪ If you add a new item in the project, after merging the item, the software creates it in
As-Built.
▪ If you modify data for an item in the project, after merging, the software overwrites the
existing data for that item in As-Built.
▪ If you delete an item in the project, after merging the item, the software deletes it in As-Built.
▪ You can claim an item in a project and subsequently modify its data in As-Built. If you then
want to transfer the item changes from As-Built to the project, you must update the item
manually in the project. To assist you in doing this, it is recommended that you run a
comparison report first. You can also run the Release Claim command in the project to
automatically re-scope the item with the updated data from As-Built, but in this case any
changes you have made to the item in the project will be lost.
▪ You can only edit data in As-Built if, in the Options Manager General Settings, the Allow
Editing in As-Built property is set to Yes.
▪ The revision numbering of a document in a project is done manually. The software does
not raise the revision number automatically after a document was claimed and then changed
in the project.
▪ In a multi-project environment, the software does not check the revision number of a
claimed document in other projects even if the document was claimed for other projects.
▪ After merging the document into As-Built, the revision number of the document will be the
one that was set in the project from which it was merged.
▪ In SLDs and schematics, the software displays clouds around the items that differ from the
current data. The last revision number is shown in a triangle beside the cloud.
▪ The software uses index numbers to identify the changes in associations between electrical
items.
▪ The software generates a tabular report where it shows all the changes and shows the
changes in associations using index numbers as they appear in the drawing.
▪ For registered reports, the software opens two Excel files. One of the Excel files displays
changed data with a blue shading. The second file is a summary of all changes and it is
called Registered Comparison Report. This report displays the previous and current data
for each tag that has undergone a change. Note that you can compare a registered report
only if this is a simple tabular report.
▪ In SLDs, the software indicates the following changes:
▪ All added and deleted electrical items except for control stations.
▪ Added, deleted, and updated properties of electrical items.
▪ Changes in associations.
▪ Attachment to a different document template.
▪ In schematic drawings, the software indicates the following changes:
▪ Added, deleted, and updated properties of electrical items.
T
To Do List and Correlating Items • 64
U
Understanding Statuses • 108
Understanding the Basic Project Concepts •
6
Undo a Checkout • 80
Undo a Drawing Checkout • 42
Undo Checkout Command (Project Menu) •
43
Undo Checkout Dialog Box • 43
Use the Buffer to Scope Items • 118
Using a Project for New Design Work • 9
Using Projects for Multiple, Overlapping
Projects • 10
Using Projects to Explore Alternative
Designs • 11
Using Projects with an As-Built Facility
Model • 10
Using Projects Within SmartPlant • 7
Using Workshare with Projects • 94
V
Validating Properties • 64
Verify a Drawing for Checkin • 46
Verify for Checkin Command (Project
Menu) • 47
Version History Command (Revisions
Menu) • 49
Version History Dialog Box • 49
W
What is a Plant? • 6
What is a Project? • 7
What is a Site? • 6
What is Claiming? • 7
Working Directly in a Plant • 9
Working with Drawings within a Project • 33
Working with Off-Site Projects • 13
Working with Plants and Projects • 9
Working with Projects • 12