Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Terms of Use
Use of this software product is subject to the End User License Agreement and Limited Product Warranty ("EULA") delivered with this
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. 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.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools, ISOGEN,
MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph
Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of Microsoft
Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are trademarks of their
respective owners.
Contents
Welcome to SmartPlant ............................................................................................................................. 1
Installation Checklist .............................................................................................................................. 1
Introducing SmartPlant P&ID ................................................................................................................ 1
SmartPlant P&ID Program Group ................................................................................................... 2
SmartPlant Engineering Manager .......................................................................................................... 3
SmartPlant Engineering Manager Program Group .......................................................................... 3
Internationalization .................................................................................................................................... 5
Welcome to SmartPlant
The Intergraph SmartPlant family of process industry solutions is an open line of
discipline-specific software tools that provide an integrated solution for the entire plant life
cycle. Knowledge-based, intuitive, easy-to-use, accessible, flexible, and data-driven, SmartPlant
supports global workflows. The software enables users to create logical and physical definitions
of the plant model and enables access to plant data from conceptual design to decommissioning.
SmartPlant is the fulfillment of the Intergraph vision to speed and improve the creation of
information and to provide this data to multiple users at any moment in the appropriate form.
Workflows are compressed, reducing production time, lowering costs, enhancing global
execution, and extending the life and usability of plant information.
The successor to the Intergraph Plant Design System (PDS), SmartPlant includes expanded
functionality for front-end engineering and design (FEED), construction, operation, and
maintenance phases.
Installation Checklist
For the recommended installation workflow, see the SmartPlant P&ID Installation Checklist:
(SPPIDInstall_Checklist.xls), delivered during product setup to the \Program
Files\SmartPlant\P&ID Workstation\Program\resdlls\0009\ folder.
design rule-base confirms data consistency and compliance with plant and engineering
standards, allowing faster, more efficient design with less iteration.
SmartPlant P&ID incorporates the latest Microsoft technologies, such as OLE automation, to
provide integration with existing data and other systems. Running on various Microsoft
Windows operating system platforms, SmartPlant P&ID does not require a traditional, expensive
CAD engine for P&ID creation. The open architecture of SmartPlant P&ID permits integration
with other systems, such as Intergraph PDS, SmartPlant Instrumentation, and Aspen Basic
Engineering, all of which allow users to share data with third-party software.
Internationalization
Supporting internationalization in a homogeneous environment is one of the enhancements
available in SmartPlant Enterprise. A homogeneous environment uses elements from only a
single locale. For example, a German customer running on a German operating system using
only German characters and German cultural conventions is a fully supported homogeneous
environment configuration.
Homogeneous Environments
When starting a new project, use extra care during installation and configuration to ensure the
proper creation and maintenance of homogeneous environments:
All the computers (servers and clients) within an integrated SmartPlant Enterprise
implementation must have the same regional settings, and no one should change the regional
settings after the project has started.
Do not cross the decimal locale boundary. This is the most common cause of numeric data
corruption and calculation errors. Having users with different regional settings (like with a
period versus a comma for the decimal point) causes the software to interpret values
unpredictably. For example, a pipe run with a pressure of 35.3 psi can be read by the
software as 353 psi to the user with different regional settings. A cable length defined as 39
ft 11,21 inches has been interpreted as 121718910971323 meters when published to an XML
file. These incorrect interpretations may be used in internal software calculations and can be
impossible to backtrack or correct. Do not change the decimal point character to try to solve
an issue. Doing so will only corrupt values in the database or in text files.
Do not cross the character-set locale boundary. For example, the character set boundary
between Western (Latin-based) and Eastern Europe (Cyrillic-based), or between Eastern
Europe and Japan.
Create Oracle databases using AL32UTF8 for the database character set and AL16UTF16
for the NLS character set.
Never modify the NLS_LANG registry entry on an Oracle client. Doing so causes the
character data not to convert to Unicode.
Create Microsoft SQL Server databases with locale-specific collation settings and ensure
that all databases have the same setting.
Heterogeneous Environments
In contrast, a heterogeneous environment using elements from different, or even multiple
locales, is not supported. Many customers are currently operating in unsupported heterogeneous
environments and are often not aware of that fact. Examples of heterogeneous environments:
Entering or viewing Japanese data on an US/English operating system
Using German Regional Settings (where the decimal point is a comma) on a US/English
operating system
The SmartPlant database management server installation was certified on 64-bit hardware
with a 64-bit operating system (Windows Server 2003) and 64-bit database software. The client
machine installation was certified on 64-bit hardware with a 64-bit operating system (Windows
Server 2003) and 32-bit database software.
Microsoft Windows Enterprise Server 2003 R2 Service Pack 2 (32-bit and 64-bit)
The operating system must be installed in the account where you have administrator
privileges.
Do not use Oracle 'light client' as it does not include some of the required .dll files.
The client database software must be of the same version as the server database software.
SmartPlant Schema 25 MB
Component
SmartPlant Client 30 MB
Software Prerequisites
Adobe Reader 8.0 (required to view the Software License Agreement and Printable
Guides).
SmartPlant License Manager 2009 (10.00.05.00). The licensing is delivered on its own CD
that comes with your SmartPlant P&ID product CD.
Microsoft Internet Explorer 7.0 (required for viewing the online documentation delivered
with the software)
Microsoft XML Core Services (MSXML) 6.0 Service Pack 1
Microsoft .NET Framework 3.5
Microsoft Data Access Components (MDAC) 2.8 Service Pack 1 (MDAC 2.8 is delivered as
part of Microsoft Windows XP Service Pack 3).
Microsoft Office 2003 or 2007 (Microsoft Excel is required for working with report
templates and for viewing the Installation Checklist and various other files).
SmartPlant 3D Piping Specification Remote Access Client, Version 01.00. The Piping
Specification Client software is required for using SmartPlant 3D specifications in the
SmartPlant P&ID Piping Specification Utility and is available on the SmartPlant P&ID
product CD.
Optional Software
Apart from SmartSketch, the following software programs are not Intergraph
corporation software and are owned by third parties. It is the responsibility of the customer to
select in its sole discretion the applicable third party software the customer desires to use to
generate reports and Intergraph makes no recommendation as to the choice of said third party
software. The customer is responsible for obtaining a valid license to use said third party
software from the owner of said third party software and to pay any license fees to the owner of
said third party software for the use of said third party software. INTERGRAPH DISCLAIMS
Oracle Instances
If one server hosts the databases of several products, Intergraph recommends that each product's
database be a separate instance, each of which can host multiple plants.
The advantage of placing each product's database its own instance is that only the affected
application will be off-line during backup, performance tuning, and other database maintenance
activities. Additionally, global tuning parameters that apply to one instance can be tailored to the
specific product requirements.
According to Oracle documentation, the only limit to the number of instances you can have on
any machine is the availability of resources. However, the number of instances on one database
server should be minimized, because each additional instance puts additional load on the server.
Each instance adds redundant tablespaces, rollback segments, background processes, and
memory requirements for each SGA (System Global Area). For this reason, you should start by
putting the database of one product for several plants into a single instance. Then, when the
number of plants increases, or a plant becomes very large, consider separating the database into
new instances, adding server memory, or even adding database servers.
We recommend installing and configuring Oracle locally, not by remote desktop connection.
Oracle recommends that database activity on the database server consume no more than 50
percent of the available memory.
For SmartPlant P&ID to access the database, you must load and configure Oracle Net
Services on the database server and on each end-user SmartPlant workstation. If SmartPlant
Engineering Manager is installed on the database server, you must load and configure
Oracle Net Services on that server, in addition to the Oracle TCP/IP Protocol Adapter.
If SmartPlant Engineering Manager is installed on a workstation other than the database
server, you must load the Net Services and the Oracle TCP/IP Protocol Adapter on the
SmartPlant Engineering Manager computer. You must also load the Net Services and the
Oracle TCP/IP Protocol Adapter on the Oracle database server.
Net Manager is installed with the Net Services software and allows you to create a database
Net Service Name, which SmartPlant uses to communicate with the database.
The version of Net Services must be the same on all computers.
6. If the OUI-10030 warning message appears, if the disk of the target folder has enough
space, click Yes.
7. On the Summary page, click Install.
8. Complete the installation and then click Exit.
9. Restart the server machine.
Before creating an Oracle instance, make sure that you have Administrator's access rights in
both your Oracle server database and the operating system installed on the server machine.
If you still need to create an instance from the account in which you do not have
Administrator's rights, and if your company's policy allows you to change the Oracle
security, you can do the following: in the Sqlnet.ora file, add the # symbol before the
Sqlnet.Authentication_Services = (NTS) parameter to comment it out. The default
location of the Sqlnet.ora file will look similar to the following path:
\\<Oracle home folder>\Product\<Version*>\db_1\Network\Admin\
(* An example of the 7.x folder name is 10.2.0)
Before starting an Oracle database you need to ensure that the RAM that this database occupies
does not exceed the available RAM on your server. You can calculate the amount of RAM
needed for the database by using the following Oracle parameters:
SHARED_POOL_SIZE (at least 10 MB)
DB_BLOCK_SIZE
LOG_BUFFER
SORT_AREA_SIZE
JAVA_POOL_SIZE and LARGE_POOL_SIZE are additional parameters that affect the
RAM that the Oracle database occupies. These parameters appear if you select certain options
when running the Oracle Database Configuration Assistant using a custom installation type.
For the DB_BLOCK_SIZE parameter, make sure that the value is at least 8192.
As an alternative to the above calculation, you can use the following target parameters to
determine the maximum amount of RAM:
sga_target (at least 100 MB is recommended)
pga_aggregate_target (at least 20 MB is recommended)
Make sure that all passwords, user names, folders, and files of the new instance are different
from those of any existing instance.
All user names and passwords must use ASCII / English characters. Oracle does not support
non-ASCII / English characters in user names or passwords and will not work. This
limitation is an Oracle limitation, not Intergraph's.
1. On the Start menu, click All Programs > Oracle OraDb10g_home1 > Configuration
and Migration Tools > Database Configuration Assistant.
2. On the Welcome page, click Next.
3. In the Database Configuration Assistant Wizard, click Next until you reach the page Step
2 of 12: Database Templates.
The recommended total memory for one Oracle 10g instance is 260 M Bytes.
The same database character set and national character set values should also be
defined on your server.
The Default Language and Default Date Format values will reflect locale-specific
information.
f. Accept the settings on the other tabs and click Next.
11. On the page Step 11 of 12: Database Storage, if you intend to create a SmartPlant
Electrical or SmartPlant P&ID database in the current Oracle database, change the data file
size of the TEMP and USERS tablespaces to 100 MB.
To change the size, double-click the field under Size.
12. Click Next.
13. On the page Step 12 of 12: Creation Options, click Finish.
14. On the Confirmation dialog box, click OK.
15. Restart the server machine.
ARCHIVELOG Mode
We also recommend running Oracle in ARCHIVELOG mode, which copies filled online redo
logs to disk. You must specify the mode at database creation or by using the ALTER
DATABASE statement. You can enable automatic archiving either dynamically using the
ALTER SYSTEM statement or by setting the initialization parameter LOG_ARCHIVE_START
to TRUE.
Running the database in ARCHIVELOG mode has several advantages over NOARCHIVELOG
mode. You can:
Back up the database while it is open and being accessed by users.
Recover the database to any desired point in time.
To protect the ARCHIVELOG mode database in case of failure, back up the archived logs.
For more information, please see the SQL*Plus Backup and Recovery Concepts document in
your Oracle documentation.
Other Recommendations
Some users have found using the following settings beneficial.
System Tablespace Max_Extents = UNLIMITED (If you choose to set this parameter to
505, the database monitoring system will warn you if the system tablespace is growing
heavily. This setting has no impact on performance.)
Tablespace System / initial und next set to 64KB (Setting the pctincrease parameter to 50
allows you to take advantage of the dynamic growth provided by Oracle, leading to larger
extents in a large database.)
RollBackSegment und Temp-Tablespace create rollback segment <name> tablespace
rbs storage (optimal 10MB)
begin dbms_stats.gather_database_stats (cascate => TRUE); end;/ (Gathers statistics on
the schemas. Use with the OPTIMIZER_MODE variable set to ALL_ROWS.)
SQL Server Client is required on any SmartPlant computer on which you intend to create
sites, plants, or projects, or on any computer that performs backup or restore operations.
When creating and configuring your databases, keep in mind that plant structures must be
created in a SQL Server database separate from the site server database and that each plant
must be in its own database. Database node names may not include periods or spaces.
If the backup location for your SQL site is located on a separate computer from your
database, you must modify the logon information for the SQL Server services using the
procedure that follows.
When creating a database for SmartPlant Engineering Manager, the database name must not
include periods (.) or spaces.
If the national environment of the client machines is identical with the national
environment defined for the server, just accept the default values on this page.
Ensure that the Case sensitive check box is cleared.
9. Click Next and complete the remaining steps.
10. After clicking Finish, restart the server machine.
You must enclose the name of your database within the quotes and parentheses as
shown.
Identical syntax applies for the CHECKDB command.
4. Click Query > Execute.
5. View the Messages window for the results of the query.
You can save the results to an external file. To do so, click Query > Results To >
Results to File.
The software automatically corrects basic problems. For more complex problems, you
must refer to the query results and correct these problems manually.
USE Site_Server1_DB
GO
EXEC SP_UPDATESTATS
This script updates the statistics for every table in the database.
SmartPlant 3D Piping Specification Remote Access Client, Version 01.00. The Piping
Specification Client software is required for using SmartPlant 3D specifications in the
SmartPlant P&ID Piping Specification Utility and is available on the SmartPlant P&ID
product CD.
If you are reinstalling SmartPlant Engineering Manager, you must first remove the previous
SmartPlant Engineering Manager installation using the Add/Remove Programs option in
the Windows Control Panel.
Be sure to apply all available SmartPlant Engineering Manager service packs for the version
you are installing. For more information, please contact Intergraph Customer Support.
If you do not plan to immediately make use of the system editing functionality introduced in
SmartPlant P&ID Version 4.2, you must take steps to make the Version 2009.1 software
behave more like Version 4.1, such as running the validation programs that are delivered
with Version 4.1 instead of the new programs delivered with Version 2009.1. All validation
programs that were configured for the plant before upgrading remain configured after
upgrade. The Upgrade Utility does not change the ProgIDs of validation programs in the
data dictionary. However, the uninstall and reinstall of the software on a client machine
deletes the Version 4.1 validation programs if you do not take measures to avoid it.
Before installing SmartPlant P&ID 2009.1, the old validation programs delivered with
Version 4.1 should be moved to a different folder so that when the Version 4.1 software is
uninstalled, the old validation programs will not be deleted. When you install the Version
2009 software, the new validation programs are installed in their normal locations. After
installing the Version 2009.1 software, you must re-register the old Version 4.1 validation
programs. For more information, see Running in Version 4.1 Compatibility Mode.
Be sure to apply all available SmartPlant P&ID service packs for the version you are
installing. For more information, please contact Intergraph Customer Support.
If you try to install SmartPlant P&ID software when you do not have write permissions to
the registry on the computer on which you are installing, the following warning message
appears. For more information, see Grant Permissions to Write to a Registry Key (on page
32).
If Oracle software is not detected on the computer during the installation of SmartPlant
P&ID, the following warning message appears:
If you plan to use Oracle, click No to stop the installation process and install the Oracle
software before you proceed further. If you are planning to use Microsoft SQL Server
software, click Yes to continue with the installation process.
The driver used for printing the PDF files, SmartPlant PDF Converter 302, is included in the
SmartPlant P&ID installation. This printer is used for PDF generation and should not be
removed or used for any other purpose.
Because SmartPlant P&ID installation requires SmartPlant License Manager software for
concurrent licensing, you must install the SmartPlant License Manager software on your
workstation prior to creating a silent setup of SmartPlant P&ID and on each workstation
where you will be silently installing SmartPlant P&ID. For more information about
installing and configuring SmartPlant License Manager, see the SmartPlant License
Manager Installation and User's Guide (SPLMInstall_UserGuide.pdf).
The environment of the machine on which you run the normal setup to create the .iss file and
the environment of the workstations on which you perform the silent mode installation must
be identical; that is, they must have the same database platforms, software versions, installed
files, drive partitions, and so forth. You must also ensure that there is sufficient disk space
on each workstation for the installation.
Prior to creating a silent setup of SmartPlant P&ID over a network, ensure that the following
conditions exist:
For a new release, all previous existing versions of SmartPlant P&ID on the target
machine have been uninstalled prior to network installation.
The target machine does not have a directory by the same name to which SmartPlant
P&ID is to be installed.
The target machine meets the free disk space recommendations specified in SmartPlant
P&ID Workstation (SPELInstall_Workstation_Reqs_1a.htm).
All applications are closed.
The -r parameter tells setup to automatically generate the silent setup file
(<filename>.iss), and to record all setup input.
The - f1"<path>\<filename>.iss" parameter specifies the path and filename for the
silent setup file. The double quotes are required around this path, with no space between
the -f1 and the opening double quotes. For example, if you type the following command
string, the software places the resulting .iss file in the c:\installfiles folder.
\\sourceserver\sppid\setup.exe -r - f1"c:\installfiles\silentsetup.iss"
3. Work through the standard software installation on your database platform. For details, refer
to the appropriate procedure in the SmartPlant P&ID Installation and Upgrade Guide.
When you click Display on the License Agreement dialog box while running setup
in record mode, the following message appears.
Click OK to acknowledge that you are accepting the license agreement for all users on
whose computers you will install the product. Setup then returns you to the normal
installation process by displaying the license agreement and enabling the Yes button on
the License Agreement dialog box.
4. At each workstation on which you want to install the software, open a Command Prompt
window and type:
"<setup source folder path>\setup.exe" -s -f1"<path>\<filename>.iss" -
f2"<path>\<filename>.log"
Be sure to use the same setup executable that you used in step 2 above.
The -s parameter tells setup to run in silent mode using the indicated .iss file.
The - f1"<path>\<filename>.iss" parameter specifies the path and the filename for the
silent setup (.iss) file you want to run. The double quotes are required, with no space
between the -f1 and the opening double quotes. For example, -
f1"c:\installfiles\silentsetup.iss".
(Optional) Use the - f2"<path>\<filename>.log" parameter to record a log file of the
setup process. The double quotes are required, with no space between the -f2 and the
opening double quotes. For example, - f2"c:\installfiles\silentsetup.log". If -f2 is not
defined, a log file is created in the same location as the .iss file.
5. Check the .log file to ensure that the installation proceeded without errors. A successful
silent installation produces a .log file looking something like this:
[InstallShield Silent]
Version=v7.00
File=Log File
[ResponseResult]
ResultCode=0
[Application]
Name=SmartPlant P&ID
Version=2009 (xx.xx.xx.xx)
Company=Intergraph
Lang=0009 In general, if an error occurred, the ResultCode will be a number less than
zero. Possible result codes include the following:
Any value greater than 0 = Success.
-1 General error
-2 Invalid mode
-3 Required data not found in the
Setup.iss file
-4 Not enough memory available
-5 File does not exist
-6 Cannot write to the response file
-7 Unable to write to the log file
-8 Invalid path to the InstallShield
Silent response file
-9 Not a valid list type (string or
number)
-10 Data type is invalid
-11 Unknown error during setup
-12 Dialog boxes are out of order
-51 Cannot create the specified folder
-52 Cannot access the specified file or
folder
This procedure also applies to the uninstall operation. The uninstall procedure should use
the same command and procedures as for the installation, both for the record mode and for each
workstation mode; however, you should specify a different name for the .iss file so as not to
overwrite the file used for the installation.
You no longer need to set the default data locations in Options Manager before creating a
P&ID in SmartPlant Drawing Manager. These locations are set at the time of plant structure
creation. The drawing template path should be set to the correct node name and share name
so that the software can locate the templates for P&ID creation. For the correct share name,
see Install SmartPlant Reference Data (on page 41).
For a configuration in an integrated environment, be sure the Integration Resource Path
setting in Options Manager points to the Integration Resource Files installed with the
SmartPlant P&ID Reference Data.
After installation, be sure the Integration Resource Path setting in Options Manager
points to this folder.
9. Review your Current Settings, then click Next to install the reference data.
10. Click Finish to close the installation wizard.
11. After installation, share the folder that contains the reference data. All SmartPlant users
must be granted read permission to this share. Write permission to the share is required to
make changes to the symbols, rules, templates, and other reference data.
We recommend that you make a copy of the reference data and store it with your
plant files. This common practice will help you with future service pack installations, data
recovery, and so forth.
When you access the SmartPlant P&ID application via Citrix, we strongly recommend that
you do not perform any administration activities that run automatically for a long time on a
client machine. When you execute administration activities via Citrix client, the software
actually performs these activities on the server side, while the client remains idle, and the
connection to Citrix is lost, possibly resulting in corruption of data. Examples of these types
of administration activities are: upgrading the database to a new version or importing a large
number of drawings.
As a workaround, we recommend that you perform these kinds of activities either on your
database server machine or on a client machine using a configuration other than Citrix.
When using thin client mode, all users share a common database, resulting in intellectual
property being shared between all sites.
To prevent performance problems that may be caused if the software maps drive U: to a
server that is very remote from the Citrix server, ensure that the U: drive is on or local to
the Citrix server and that the 'TS Roaming Profiles' option is enabled.
Make sure that the common folder path contains the SmartPlantV4.ini file. You can also
use this folder for temporary files.
2. Modify the system path statement on the server to include the common folder path in the
system path.
If you are upgrading from an earlier version of SmartPlant P&ID than Version 2009, you
must first upgrade that version to SmartPlant P&ID 2009 (SmartPlant Engineering Manager
2009.1) using Version 2009.1 of the Upgrade Utility, before upgrading to Version 2009.1.
For more information, visit the Intergraph support Web site (http://support.intergraph.com).
SmartPlant Engineering Manager 2009.2 can display sites and plants created in earlier
versions of SmartPlant Engineering Manager. While the 2009 plants that have not been
upgraded will appear in the Tree view, none of the data below the plant will be available.
Attempting to work in a non-upgraded plant results in a message stating that the plant must
be upgraded first.
Before using the new version of the software, we strongly recommend that you completely
upgrade your plant and update all drawings to the current version. A plant with a mixture of
upgraded and non-upgraded data may result in some data being permanently inaccessible.
If you are using Microsoft SQL Server, you can skip this database constraints process.
For additional information on resolving discrepancies listed in the database constraint report,
contact your custom service representative.
in the list box on the right side of the Database Constraint Exception Report Utility
dialog box.
5. Exit the Database Constraint Exception Report utility.
6. Open the report using Microsoft Excel and save a copy of the report to another location other
than the temp directory.
7. Review the completed report for discrepancies that must be resolved before you can upgrade
to the new version of SmartPlant P&ID. We recommend running this utility again until no
discrepancies are reported.
Microsoft Excel must be installed on any workstation from which you run the
Database Constraint Exception Report utility.
Constraint Utilities
Delivered with SmartPlant P&ID, the following constraint utilities help you correct any database
constraint exceptions reported in the database constraint exception report.
In general, each utility attempts to repair the constrain violation. However, in some cases the
violation could not be cleaned up by the utility and the item is band-aided in the drawing. This
situation is noted and logged in each utility's corresponding log file. For more information, see
Constraint Utilities Log Files (on page 51).
You must manually fix any band-aided items in a drawing by deleting the item and
replacing it. If you have difficulty finding the band-aided items, click Tools > Options in
SmartPlant P&ID, then select the Display as Printed option on the Options > General tab.
cmdnotconnectedcomps.dll Repairs items that have a relationship to a PipeRun or
SignalRun (sp_piperunid or sp_signalrunid are not null), but are not referenced by a
corresponding connector. If the relationship cannot be repaired, you must delete it and replace
it.
cmdLPCheck.dll Checks for LabelPersist records pointing to a representation that does not
exist. If the graphical label is watching a graphic, the database is updated to match, thus
repairing the LabelPersist. If the label cannot be repaired, the utility band-aids it. You should
delete and replace these band-aided items.
cmdRepOIDCheck.dll Checks for symbol records with a null graphic OID. If the graphical
symbol exists, the utility repairs the item by updating the database with its graphic OID value. If
the graphical symbol does not exist, the utility sets the InStockpile flag = True to repair the item.
ConnectorItem12.dll Checks for connector records pointing to a symbol that does not exist.
If the graphical connector is connected to a symbol, the utility repairs the connector by updating
the database to match. If the connector cannot be repaired, the utility band-aids it. You should
delete and replace these band-aided items.
OPCFK.dll Checks for OPC records with a partner that does not exist. If the graphical OPC
exists, fix it. You should delete these items.
PointIndexCheck.dll Checks for PipingPoint records and SignalPoint records with non-
unique indices or point numbers, then repairs the item by deleting from the database whichever
one of the duplicate points is not loaded into the cache.
RelationshipOIDMacro.dll Checks for relationship records with a null graphic OID. If the
graphical relationship indicator exists, the utility repairs the item by updating the database with
its graphic OID value. If the graphical relationship indicator does not exist, the utility deletes the
relationship from the database.
RepairBadConnector.dll Checks for connectors with the same start and end objects and
connectors with the wrong number of vertices. The utility band-aids the graphical connector,
which you should delete.
RepairNullFileNameCmd.dll Checks for LabelPersist records with a null file name value.
If the number of LabelPersist records equals the number of SmartLabel objects locked to the
watched symbol, the utility repairs the LabelPersist record by updating the filename value
for the LabelPersist.
If the number of LabelPersist records does not equal the number of SmartLabel objects
locked to the watched symbol, then the utility band-aids the watched symbol. You should
delete band-aided items.
For the remaining LabelPersist records with a null filename, if the graphic exists, the utility
band-aids it. You should delete band-aided items. If the graphic does not exist, the utility
deletes the representation from the database.
RepairOrphanedNozzleCmd.dll - Checks for the following situations.
Nozzle records without a Parent If the Nozzle graphic is not in the drawing, the utility
repairs the nozzle by setting the Instockpile flag = True. If the Nozzle graphic is in the
drawing, the utility tries to set either the SP_EquipmentID or SP_PartOfID based on the
graphic relationship. The graphic parent must be an equipment or equipment component for
the relationship to be re-established. If the relationship cannot be re-established, the utility
band-aids it. You should delete band-aided items.
Nozzles associated via SP_EquipmentID to a Parent in the stockpile - If the Nozzle
graphic is not in the drawing, the utility repairs the Nozzle by setting the Instockpile flag =
True. If the Nozzle graphic is in the drawing, the utility band-aids it. You should delete
band-aided items.
Nozzles associated via SP_PartOfID to a Parent in the stockpile If the Nozzle graphic
is not in the drawing, the utility repairs the Nozzle by setting Instockpile flag = True. If the
Nozzle graphic is in the drawing, the utility band-aids it. You should delete band-aided
items.
Nozzles that are a Part of a Run The utility clears the SP_PartOfID attribute. If the
Nozzle graphic is not in the drawing, the utility repairs the Nozzle by setting the Instockpile
flag = True. If the Nozzle graphic is in the drawing, the utility band-aids it. You should
delete band-aided items.
You are not required to upgrade all plants in a particular site at the same time.
Upgrading a Site
When you open a site created in Version 2009 or 2009.1 using SmartPlant Engineering Manager
2009.2, you are prompted to upgrade that site to Version 2009.2.
Use the Upgrade Site command to perform the upgrade.
Upgrade a Plant
After you select the site containing the plants you want to upgrade, the SmartPlant Engineering
Upgrade Utility displays a list of active plants that are available for upgrade.
1. Select the plant in the Tree view to see the available applications that can be upgraded for
that plant.
2. Right-click the active plant and select Upgrade Plant from the shortcut menu. The utility
moves the plant from the Active plants node to the Upgrades in progress node and
displays the list of upgrade tasks required to upgrade the selected plant.
3. Right-click in either view and select Finish Next Task to start the first upgrade task.
4. If there is more than one task in the Upgrade Tasks view, click Finish All Tasks to
complete the plant upgrade. After the plant is upgraded, the utility moves it back under the
Active plants node and updates the plant status in the Upgrade Tasks view to Up-to-date.
You must complete all upgrade tasks for a plant before you upgrade the reference data or
drawings in the plant.
The rules file for the upgraded plant is marked as out-of-date for the Update Drawings
commands in Drawing Manager. The formats and select lists will also be marked as out-of-
date.
2. The utility moves the plant from the Active Plants node to the Upgrades in progress node
and displays the list of upgrade tasks required to upgrade the P&ID application.
3. Right-click in either view and select Finish Next Task to start the first upgrade task.
4. When the first task finishes, click Finish All Tasks to complete the application upgrade.
5. After the application is upgraded, the utility moves the plant back under the Active plants
node and updates the application status in the Upgrade Tasks view to Up-to-date.
See Also
Finish Next Task Command (File Menu) (on page 57)
Run to Selected Task Command (File Menu) (on page 58)
Upgrade P&ID Command (Upgrade Menu) (on page 59)
The upgrade log file contains a list of all changes made during the upgrade, including each
upgrade subtask.
The log file, named UpgradeV600_plant name.log, is saved in the folder where the
drawings for the plant are stored.
Click File > Finish Next Task or File > Finish All Tasks to actually start the upgrade process.
If you have not yet run a task, you can cancel the upgrade process by selecting the plant under
the Upgrades in Progress node and clicking File > Cancel to restore the pre-upgrade state.
You must complete all upgrade tasks for a plant before you upgrade the reference data or
drawings in the plant.
The rules file for the upgraded plant is marked as out-of-date for the Update Drawings
commands in Drawing Manager. The formats and select lists will be marked as up-to-date.
You cannot upgrade a backed-up plant without restoring it first.
For a list of all changes made during the plant upgrade, including each upgrade subtask, see
the plant upgrade log file. The log file, named UpgradeV600_plant name.log, is saved in
the folder where the plant structure resides.
To view the plant upgrade log file, select the plant in the Tree view, and then click File >
Show Log.
See Also
Upgrade SmartPlant P&ID (on page 56)
User Access
Before you can upgrade the reference data and drawings for an upgraded plant, you must define
user access for the plant in SmartPlant Engineering Manager. For more information about
defining user access, see the SmartPlant Engineering Manager User's Guide.
After you upgrade reference data, you cannot view it in earlier versions of the software.
For information about changes made during the reference data upgrade, see the
V4RefDataUpgrade.log file. This log file is saved in the folder where the symbols are
stored. For more information about upgrading reference data, see SmartPlant P&ID Options
Manager Help.
4. Click OK.
After you upgrade reference data, you should not view it in earlier versions of the software.
For information about changes made during the reference data upgrade, see the
V4RefDataUpgrade.log file. This log file is saved in the folder where the symbols are
stored.
For more information about upgrading reference data, see SmartPlant P&ID Options
Manager Help.
Updating Drawings
Changes are often made to the SmartPlant P&ID reference data while work is being managed on
the P&IDs. When these changes are made, they apply to all drawings items after the time of
change, but do not apply to existing drawing items. The Update Drawings functionality
(provided by the set of Out-of-Date Drawings commands in Drawing Manager) allows you to
manage which drawings are updated with the latest reference data changes by defining values
that define out-of-date drawings criteria and by resolving any symbols that have been deleted,
moved, or renamed.
You can also schedule these update operations and create reports. For more information about
this functionality, see the Drawing Manager Help.
Using the Update Drawings functionality is not required as part of the upgrade
process, but it is strongly recommended.
When you submit a selection of P&IDs to the Out-of-Date Drawings > Update command,
Drawing Manager analyzes the drawing for changes to the following:
Data Dictionary (select lists)
Formats
Symbols (moved and missing symbols, and changes to the .sym file)
Rules Manager
Options Manager (heat tracing, gapping, and symbology)
Model Items (via Llama)
OPCs (moved)
Drawings in a recreate state
Drawing Properties
After this analysis process, a summary displays, listing the number of drawings selected, the
number of out-of-date drawings, and the number of drawings with missing symbols. You must
manually resolve the missing symbols using the Resolve Missing Symbols dialog box, which
lists the symbols in question and allows you to define the new location of each symbol.
In addition to the interactive approach of updating drawings, you can schedule the entire update
process, except for the resolution of missing symbols, which is a manual process as described
above.
Reporting capability provides a summary of the selected drawings and the out-of-date criteria
detected during the analyze step. This report format is non-configurable.
Manager is invalid. An error message displays and the report displays Drawings with a ? in the
criteria column have missing or incorrect reference data.
In order to resolve any missing symbols, you must have an existing symbol in the catalog to
define as the replacement for the missing symbol.
You cannot resolve missing symbols for offline instruments of a different class using this
command.
Old Path - Displays the relative path of the missing symbol.
New Path - Displays possible options for defining correct locations for the missing symbol(s).
Drawings - Displays the list of drawings that contain the missing symbol(s).
See Also
Update Command (see "Update Command (File > Out-of-Date Drawings Menu)" on page 62)
Rule Changes Rules GUID on the drawing item is not equivalent to the GUID from the
Rules file.
Heat Trace Changes Heat Trace GUID on the drawing is not equivalent to the Heat Trace
GUID in Option Manager Setting.
Gapping Changes Gapping GUID on the drawing item is not equivalent to the Gapping
GUID in Option Manager Setting.
Symbology Changes Symbology GUID on the drawing item is not equivalent to the
Symbology GUID in Option Manager Setting.
Out-of-Date Model Items SP_ModelItemTimeStamp for at least one representation in the
drawing is not equivalent to the TimeStamp on the History Item of its Model Item. This criteria
covers model items updated via Llama (Outside the drawing).
Moved OPCs MatingOPCPath (will have Drawing Id of its mate) on the OPC is not
equivalent to the SP_DrawingId of its mate OPC. The OPC label is in a to-be-updated state as
its mate has been moved.
Recreate State The drawing is in a Recreate state.
Drawing Property Changes Property Changes GUID on the drawing item is not equivalent
to Drawing Property Changes GUID on the drawing item. Drawing Property Changes GUID is
set when drawing properties are modified from Drawing Manager.
The figure below shows the schemas that would exist in the database for this configuration
example, assuming that both applications are in the same database instance. On a given database
server, we recommend putting all plants in one database instance.
The majority of database activity occurs in the application schemas (SPPID Schema, SPPID
Data Dictionary Schema, SPEL Schema, SPEL Data Dictionary Schema, and SPEL Reference
Schema) since this is where the application data is stored. The plant schema contains the
smallest amount of data compared with the other schemas.
The software sets the related password defaults for each of the above user names
automatically (Oracle uses the default user name, while SQL Server 2005 appends '1' to the
default user name). In the case of SQL Server 2005 running on Windows Server 2003, if
you are using SQL Server authentication, you can specify that SQL Server 2005 is to use the
password validation rules that are used by Windows Server 2003.
Oracle database user names are limited to 30 characters. Because plant names can be up to
64 characters long, the software uses only the first 12 characters of the plant name in
creating the default database user names using the formulas above.
The software removes all spaces or special characters in a plant name before using that name
to create a default database user name.
Database usernames cannot contain any of the following characters: . < , > ? \ / ' ; { } [ ] ~ ` !
%*()&$@#"
See Also
New Site Server Wizard (on page 84)
Associate Applications Wizard (on page 85)
The data dictionary template file is a collection of all filters, plant group types, Options
Manager settings, and other database-related items (anything that's not stored in external
files, like Rules or Symbols). When using a data dictionary template to create a plant in
another site, you must have the proper rules file (which relies on filters) to go with that
template. Rules, insulation specification, symbols, and other file-based reference data are
not included in data dictionary templates.
In a Workshare collaboration, you cannot create a plant or application data dictionary
template at a satellite site. You must create the templates at the host site.
Data dictionary templates cannot be upgraded. However, you can use the Data Dictionary
Template Comparison Utility to compare your existing template with the default template
delivered with the latest version of SmartPlant Engineering Manager. For more information,
see the SmartPlant Data Dictionary Template Comparison Utility User's Guide.
See Also
New Data Dictionary Template Command (see "New Data Dictionary Template Command
(Tools Menu)" on page 72)
Data Dictionary Manager Command (see "Data Dictionary Manager Command (Tools Menu)"
on page 70)
New Data Dictionary Template Dialog Box (on page 72)
To add, modify, or delete attributes for the plant group types, select the Plant Group Types
node and then click Tools > Data Dictionary Manager. Attributes added to a plant group type
using this method are not automatically included in the attributes for active plant group
structures that use that plant group type.
To access the site data dictionary, start Data Dictionary Manager outside SmartPlant
Engineering Manager. When started from within SmartPlant Engineering Manager, Data
Dictionary Manager can access only the plant data dictionaries. You cannot swap between
data dictionaries once Data Dictionary Manager is running.
After accessing Data Dictionary Manager from within SmartPlant Engineering Manager and
making changes, you must either exit and restart SmartPlant Engineering Manager or reopen
the site to see the changes from within SmartPlant Engineering Manager.
Do not use Oracle reserved words (for example, "address") as attribute names.
See Also
New Data Dictionary Template Dialog Box (on page 72)
New Data Dictionary Template Command (see "New Data Dictionary Template Command
(Tools Menu)" on page 72)
To create a plant data dictionary template, select the Plant node in the Tree view.
To create an application data dictionary template, select the Applications node in the
Tree view and then select the application in the List view.
2. In the Template file box, browse to the path where you want the template file saved and
then type a file name for the template file.
3. If you are creating an application template, type the Source name for the application data
dictionary template. By default, this field displays the name of the source data dictionary
template used to create the existing application data dictionary.
Data dictionary templates cannot be upgraded. You cannot use a template created using an
older version of SmartPlant Engineering Manager to create a plant or application schema.
Data dictionary templates are not database-specific. In other words, a given data dictionary
template can be used in both Oracle and SQL Server environments.
When using a data dictionary template to create a plant in another site, you must have the
proper rules file (which relies on filters) to go with that template. Rules, insulation
specification, symbols, and other file-based reference data are not included in data dictionary
templates.
See Also
Data Dictionary Manager Command (see "Data Dictionary Manager Command (Tools Menu)"
on page 70)
New Data Dictionary Template Command (see "New Data Dictionary Template Command
(Tools Menu)" on page 72)
Data dictionary templates cannot be upgraded. You cannot use a template created using an
older version of SmartPlant Engineering Manager to create a plant or application schema.
Data dictionary templates are not database-specific. In other words, a given data dictionary
template can be used in both Oracle and SQL Server environments.
When using a data dictionary template to create a plant in another site, you must have the
proper rules file (which relies on filters) to go with that template. Rules, insulation
specification, symbols, and other file-based reference data are not included in data dictionary
templates.
See Also
Data Dictionary Manager Command (see "Data Dictionary Manager Command (Tools Menu)"
on page 70)
New Data Dictionary Template Dialog Box (on page 72)
Template file Allows you to specify the path and file name for the new template.
Source name Available only when creating an application template, this field displays the
internal name of the source data dictionary template used to create the existing application data
dictionary. You can type a new name to be used in place of Imperial or Metric in the Plant
Settings table in the plant schema.
See Also
Data Dictionary Manager Command (see "Data Dictionary Manager Command (Tools Menu)"
on page 70)
New Data Dictionary Template Command (see "New Data Dictionary Template Command
(Tools Menu)" on page 72)
See Also
Default Settings Dialog Box (on page 73)
Default Settings Command (see "Default Settings Command (Tools Menu)" on page 73)
Use Default Settings Command (see "Use Default Settings Command (Tools Menu)" on page
See Also
Default Settings Command (see "Default Settings Command (Tools Menu)" on page 73)
Default Settings Dialog Box (on page 73)
Using Default Settings (on page 73)
See Also
Use Default Settings Command (see "Use Default Settings Command (Tools Menu)" on page
Default Settings Dialog Box (on page 73)
Using Default Settings (on page 73)
Oracle Select this option if you are using an Oracle database. This information is carried
forward from the site properties, but you can modify it for subsequent plant creations.
Oracle alias Type the name of the Oracle net service alias used by the site in which the plant
will be created.
Refresh Click this button to update the entries in the tablespace lists if you have changed the
system user name or password entries.
System user Type a database system user name. This name does not have to be the database
administrator user name, but this user must have system privileges.
System password Type the system password.
Oracle tablespace Select a default Oracle tablespace name for your plant database.
We recommend that you do not use SYSTEM for the default tablespace, because
Oracle uses this tablespace for its own use.
Oracle temp tablespace Select a default Oracle temporary tablespace name for your plant
database. If this list is empty, contact your database administrator.
SQL Server Select this option if you are using a SQL Server database. This information is
carried forward from the site properties, but you can modify it for subsequent plant creations.
Server Type the node name of the server on which the SQL Server database resides.
Refresh Click this button to update the database information if you have changed the system
user name or password entries.
System user Type a database system user name. This name does not have to be the database
administrator user name, but this user must have system privileges.
System password Type the system password.
Database usernames and passwords cannot contain any of the following characters: . < , >
?\/';{}[]~`!%*()&$@#"
Plant structure root directory Specify the path to the storage location for the plant data and
the drawing files. Folders for individual plant structures are automatically appended to this path
as they are created.
You must create the plant structure root directory and share it out before using these
default settings during plant creation.
Backup root directory Specify the path to the shared storage folder for backing up the plant
files. Folders for individual plant structures are automatically appended to this path as they are
created.
Seed location Specifies the folder where all the templates are stored. The site administrator
sets this path during installation.
Data Dictionary source Select the default source for the new plant data dictionary.
Use default template Select this option to create the plant data dictionary using the delivered
template.
Use custom template Select this option to create the plant data dictionary using a custom
template.
Template path Specify the path where the custom template file is located. This field is
enabled only if the Use custom template option is selected. This path is limited to 255
characters and must be in UNC format. The software verifies that the specified template is of the
proper template type.
Data dictionary templates are not database-specific. In other words, a given data
dictionary template can be used in both Oracle and SQL Server environments. For more
information about using data dictionary templates, see Working with Data Dictionaries (on page
70).
Hierarchy Select the default hierarchy that you want to use for new plants. All currently
defined hierarchies display in this list.
If you want to use a custom hierarchy, you must create it before using these default
settings to create a plant structure. Hierarchies cannot be modified during plant structure
creation.
Hierarchy definition Displays the plant breakdown structure items in the currently selected
hierarchy.
Show warning message when the hierarchy has less than 3 levels Displays a warning
when the plant hierarchy has less than three levels. Clear this check box if you do not want the
warning to be displayed.
Data Dictionary source Select the default source for the SmartPlant P&ID data dictionary.
Use default template Select this option to create the SmartPlant P&ID data dictionary using
the delivered template.
Use custom template Select this option to create the SmartPlant P&ID data dictionary using
a custom template.
Template path Specify the path where the custom template file is located. This field is
enabled only if the Use custom template option is selected. This path is limited to 255
characters and must be in UNC format. The software verifies that the specified template is of the
proper template type.
Data dictionary templates are not database-specific. In other words, a given data
dictionary template can be used in both Oracle and SQL Server environments. For more
information about using data dictionary templates, see Working with Data Dictionaries (on page
70).
SmartPlant P&ID reference data path Type or browse to the SmartPlant P&ID reference
data path. This path is limited to 255 characters and must be in UNC format.
System of units Select the system used for displaying units in SmartPlant P&ID.
For more information about how SmartPlant Engineering Manager applies user access and
site administration privileges, see User Access (see "Change the Site Administrator User
Group" on page 82).
All users in Groups other than the Administrators group must have write access to the
C:\Program Files\SmartPlant folder (or the folder where SmartPlant Engineering Manager is
installed) in order to use the software.
You can change the user group assigned as the site administrator group after site creation.
For more information, see Change the Site Administrator User Group (on page 82).
4. On the New Group dialog box, type the name and description for the new group.
5. Click Add and, from the Select Users, Computers or Groups dialog box, select users to
add to the new group. Each user added to this group must be a Windows domain user.
6. Click Create to create the new group. The new SiteAdmins group should appear in the list
of groups.
3. Add the same users to this group that you added to the SiteAdmins group in the section
above.
All users in Groups other than the Administrators group must have write access to the
C:\Program Files\SmartPlant folder (or the folder where SmartPlant Engineering Manager is
installed) in order to use the software.
3. On the Local Security Setting dialog box, click Add User or Group and browse to the
group you created above (for example, SiteAdmins).
Role name Click the Browse button , and select the user group to which you
want to assign site administrator privileges.
Role description (Optional) Type a descriptive note about the user group you
selected, such as noting that this group is assigned site administrator privileges. If a
description was defined when the group was created, it appears by default.
5. Click OK on the New Site Administrator Group dialog box.
6. Click OK on the Site Properties dialog box to complete the change.
You must have Site Administrator privileges to change the Site Administrator User Group.
You (or the person who changes the Site Administrator User Group) retain Site
Administrator privileges until you either select a new site or you restart the software.
However, if you are also a member of the user group now assigned Site Administrator
privileges, you will retain your Site Administrator privileges.
When the Site Properties dialog box is dismissed, the software checks to see if the Site
Administrator User Group has changed and, if so, replaces the group in the T_Roles table
and the users in the T_RoleUsers group. If any error occurs or the same group is selected, no
changes occur.
See Also
New Site Administrator Group Dialog Box (on page 83)
Use local machine and domain groups Use this option when you want to choose an existing
user group or domain that is accessible from your machine.
Use site server and domain groups Use this option when you want to choose a user group
or domain that is accessible from the site server machine.
Role name Type the name of or select the Windows user group you want to assign to this
new role. The name of the SmartPlant role will be the same as the name of the selected user
group. To quickly find the user group in your domain, you can type a partial name into this field
and click Check Name.
Check Name Displays the Microsoft Select dialog box, which allows you to select the
Windows user group you want to assign to this new role. The name of the SmartPlant role will
be the same as the name of the selected user group.
Role description Type a descriptive note about the role that you are creating. You can make
notes that indicate the privileges assigned to the group. If a description was defined when the
group was created, it appears by default.
See Also
SmartPlant Engineering Manager Rights (on page 90)
Change the Site Administrator User Group (on page 82)
You cannot create a new site unless you log on using a domain account that has
administrator privileges on the computer where you are running SmartPlant Engineering
Manager.
Before you can create a site using an Oracle database, you must create a database instance in
Oracle and the database must be started. In the Windows Control Panel, select Services to
verify that the database is running.
The Site Server Options dialog box appears during future sessions only if SmartPlant
Engineering Manager cannot find the site SmartPlantV4.ini file.
See Also
New Data Dictionary Template Command (see "New Data Dictionary Template Command
(Tools Menu)" on page 72)
You can use the Default Settings commands on the Tools menu to specify default values to
simplify the plant creation process. For more information, see Using Default Settings (on
page 73).
After creating your new plant structure, be sure to associate applications (see "Associate
Applications Wizard" on page 85) with your plant and to assign user access (see "Create a
New Role" on page 86) for the new plant structure.
Creating, restoring, or copying different plants on the same site, from two terminals, at the
same time, is not possible, a Run-time error 91:Object variable or With block variable
not set message is displayed on both terminals.
See Also
Associate Applications Wizard (on page 85)
User Access (on page 89)
When associating SmartPlant P&ID or SmartPlant Electrical, you can use the Default
Settings commands on the Tools menu to specify default values to simplify the application
association process. For more information, see Using Default Settings (on page 73).
In an integrated environment, if only one application is associated with the plant at the time
it is registered, only that application is registered. If another application is later associated
with the plant, the Register command is enabled so that you can register the new application
with the plant. For more information, see Register Command.
If users experience access problems after you create a role for the group to which the user is
assigned, check with your Information Technology group to see if that user was created on a
Windows NT domain that has been upgraded to Windows XP. Microsoft provides a method
for adding users to the built-in Pre-Windows 2000 Compatible Access Group to handle
this backward-compatibility issue. For more information, see the Microsoft Knowledge
Base article number 303973 at http://support.microsoft.com.
The new role will not be created if you do not select any rights.
When setting the rights for the new role, be sure to not only set the rights for the
applications, but also set the access permissions available under the SmartPlant Engineering
Manager rights.
You can automatically include the site administrators group in each plant you create by
selecting the Add the site administrator group to each plant created option on the Site
Properties > General tab. Doing this saves you the step of creating a new role to grant these
users access to the new plant.
See Also
SmartPlant Engineering Manager Rights (on page 90)
SmartPlant P&ID User Access Rights (see "SmartPlant P&ID Access Rights" on page 92)
User Access
User access identifies the users allowed to work at specified access levels within the site and
related plant structures. With user access, administrators can control access to data and thereby
ensure the security of their project data.
SmartPlant Engineering Manager incorporates user access as an integral product feature by using
roles to define and maintain user privileges and rights at the plant structure level, where each
application has its own set of rights. Roles are the primary focus, with each role associated to a
single Windows user group. Each role is then assigned specific rights for each engineering
application and for SmartPlant Engineering Manager.
To see the roles currently defined for a plant, click the Roles node under the plant node in
the Tree view.
To view the rights settings for a particular role, right-click the role in the List view and click
Properties.
Mutually-Exclusive Rights
Users can have access privileges that vary from one plant to another in the same site. These
rights are defined by categories. Categories with radio button options indicate that the rights
contained within are mutually exclusive, meaning you can choose only one right in that category
to apply to the role. In other categories, you can choose multiple rights, as denoted by check
boxes.
None The user is not allowed to execute the application or utility for this plant structure.
Read-Only The user can execute the application or utility for this plant structure to view
the data held within it.
Modify Settings The user can execute the application or utility for this plant structure to
view the data held within it and to modify any custom settings.
Full Control The user can execute the application or utility for this plant structure and
perform all commands and modifications. This right is not available to a satellite site when
operating in the Workshare mode because the reference data must be controlled by the host
site.
SmartPlant Engineering Manager provides roles templates to help you easily create new roles.
Because the most labor-intensive part of a role creation is setting the values for the rights, you
can create templates for specific roles and then use those templates multiple times. This feature
is useful for defining a role template in one site and then reusing that same role template
throughout all of your sites.
See Also
SmartPlant Engineering Manager Rights (on page 90)
Create a New Role (on page 86)
SmartPlant P&ID Access Rights (on page 92)
Site administrator privileges do not extend by default to full privileges in the engineering
applications.
Additional site administrators can be added to the Site Administrator User Group by using
the administrative tools provided by Windows. Be sure that these users are granted network
access rights to the computer where SmartPlant Engineering Manager is installed.
You can change the user group assigned as the site administrator group after site creation.
For more information, see Change the Site Administrator User Group (on page 82).
You can automatically include the site administrators group in each plant you create by
selecting the Add the site administrator group to each plant created option on the Site
Properties > General tab. Doing this saves you the step of creating a new role to grant
these users access to the new plant.
The following rights are available to the Plant Structure Access category and are mutually
exclusive.
Category Right
Plant Structure Access None The user is not allowed to see any part of the
plant structure, including the plant structure node.
Read-Only The plant structure is visible, but the user
cannot create, modify, or delete any data within the
plant structure.
Full Control The user can create plant groups, add
applications and roles, and create projects and satellites,
but cannot see the hierarchies or the plant group types.
This right is valid only within the SmartPlant
Engineering Manager software.
Formats None The user is not allowed to launch Format
Manager.
Read-Only The user can launch Format Manager and
view the format settings but cannot create, modify, or
delete formats.
Full Control The user can launch Format Manager
and can create, modify, or delete formats.
See Also
Change the Site Administrator User Group (on page 82)
Plant Administrators
This user group has full control over all aspects of the plant structure for drawings,
administrative tasks, and reference data. The users should have the capability to create plant
groups, add applications and roles, create projects, enable Workshare, and create satellites, but
should not see the hierarchy templates or plant group types.
Category Right
SPEM Plant Structure Access Full-Control
Catalog Full-Control
Plant Filters Full-Control
Display Sets Full-Control
Default Views Full-Control
Formats Full-Control
Plant Reports Full-Control
Rules Full-Control
Data Dictionary Full-Control
Options Full-Control
Insulation Specifications Full-Control
Drawing Management Create P&ID, Delete P&ID, Archive, Retrieve
Category Right
P&ID Objects Full Control
Workshare Publish, Get Latest Version, Assign Drawing
Ownership,
Synchronize Reference Data, Synchronize
Shared Items
SmartPlant Publish, Retrieve
Plant Users
This group has full control on all drawings, can set personal filters, set up personal display sets,
set up My Reports, create drawings, and archive drawings (needed for personal use in case there
are big changes to the drawing design).
Category Right
SPEM Plant Structure Read-Only
Access
Catalog None
Plant Filters Read-Only
Display Sets Full-Control
Default Views Read-Only
Formats None
Plant Reports Read-Only
Rules None
Data Dictionary None
Options None
Insulation Specifications None
Drawing Management Create P&ID
Archive
P&ID Objects Full Control
Workshare Undefined (do not choose
anything)
SmartPlant Undefined (do not choose
anything)
Engineers
This group has access to drawings to view and modify data reports but not graphics. They can
set up personal filters, set up personal display sets, and create My Reports. They should not be
able to modify any project reference data or perform any administrative tasks with respect to
drawing management, projects, or Workshare activities.
Category Right
SPEM Plant Structure Read-Only
Access
Catalog None
Plant Filters Read-Only
Display Sets Full-Control
Default Views Read-Only
Formats None
Plant Reports Read-Only
Rules None
Data Dictionary None
Options None
Insulation Specifications None
Drawing Management Undefined (do not choose
anything)
P&ID Objects Modify Properties
Workshare Undefined (do not choose
anything)
SmartPlant Undefined (do not choose
anything)
Managers
This group needs only view data access. They can set up personal filters, set up personal display
sets, and create My Reports. They should not be able to modify any project reference data or
perform any administrative tasks with respect to drawing management or Workshare activities.
Category Right
SPEM Plant Structure Read-Only
Access
Catalog None
Plant Filters Read-Only
Display Sets Full-Control
Default Views None
Category Right
Formats None
Plant Reports None
Rules None
Data Dictionary None
Options None
Insulation Specifications None
Drawing Management Undefined (do not choose
anything)
P&ID Objects Read-Only
Workshare Undefined (do not choose
anything)
SmartPlant Undefined (do not choose
anything)
Recommended Configuration
Select the plant whose reference data you want to use as the source reference data.
Create a data RDS package from the source plant.
Back up the target plant.
Lock down (set to read-only) the user access to the reference data at the source plants. Allow
full-control user access to the reference data only at the target plant.
Synchronize the target plants with the source plant RDS package.
Do not use the RDS Manager to synchronize reference data between a host and
satellites in a Workshare collaboration. Use the Workshare Synchronize Reference Data
command instead.
Metric Templates
Template File Border File Page Size
A0-Size.pid A0border.igr A0 Wide
(1189mm x
841mm)
A1-Size.pid A1border.igr A1 Wide
(841mm x
594mm)
A1-Wide(Metric).pid A1-Wide(Metric).igr A1 Wide
(841mm x
594mm)
A1-Wide Note Area.pid A1-Wide Note Area.igr A1 Wide
(841mm x
594mm)
A2-Size.pid A2border.igr A2 Wide
(594mm x
420mm)
A2-Wide(Metric).pid A2-Wide(Metric).igr A2 Wide
(594mm x
420mm)
A2-Wide Note Area.pid A2-Wide Note Area.igr A2 Wide
(594mm x
420mm)
A3-Size.pid A3border.igr A3 Wide
(420mm x
297mm)
English Templates
Template File Border File Page Size
A-Size.pid A-Wide.igr A Wide
(11in x 8.5in)
A-Wide (Imperial).pid A-Wide (Imperial).igr A Wide
(11in x 8.5in)
B-Size.pid B-Wide.igr B Wide (17in
x 11in)
B-Wide (Imperial).pid B-Wide (Imperial).igr B Wide (17in
x 11in)
C-Size.pid C-Wide.igr C Wide (22in
x 17in)
C-Wide (Imperial).pid C-Wide (Imperial).igr C Wide (22in
x 17in)
C-Wide Note Area C-Wide Note Area C Wide (22in
(Imperial).pid (Imperial).igr x 17in)
D-Size.pid D-Wide.igr D Wide
(34in x 22in)
D-Wide (Imperial).pid D-Wide (Imperial).igr D Wide
(34in x 22in)
D-Wide Note Area D-Wide Note Area D Wide
(Imperial).pid (Imperial).igr (34in x 22in)
E-Size.pid E-Wide.igr E Wide (44in
x 34in)
Recreating Drawings
SmartPlant P&ID continually updates the database as you edit a drawing; however, the drawing
file is not updated until the file is saved (that is, when you click File > Save or when you exit
SmartPlant P&ID). Occasionally, the software may terminate abnormally due to power outages,
and so forth. As a result, the database is up-to-date with changes posted to the drawing, but the
drawing file reflects the status when it was last saved. When a drawing is re-opened, the
software recognizes that the drawing file is different from the database.
When the software notifies you that a re-create is necessary, click OK to re-create the drawing
from the database. Do not interfere with the re-create process once it is started or else the
drawing can become unusable.
For best system performance, close all other applications except for SmartPlant P&ID when
running the re-create process.
During the re-create process the status bar at the bottom of the P&ID window displays
updates about the particular elements currently being reconciled with the database. You can
check the log file, Recreate[Drawing#].log, located in the Temp directory, for any problems
that may have occurred during the re-create process.
If your reference data has changed, use the Update Drawings functionality to incorporate
those changes into your existing drawings. For more information, see the SmartPlant P&ID
Drawing Manager User's Guide.
After the re-create process finishes, SmartPlant P&ID reinitializes the drawing. Review the re-
created drawing and resolve any errors that occurred.
Filtered Printing
The Display Set functionality allows you to print a drawing using multiple filters. Using the
Print filter options on the Print dialog box in Drawing Manager, you can select the display set
that specifies which symbols in the drawing to print. If no display set is applied, the entire
drawing prints.
SmartPlant P&ID interacts with SmartPlant Foundation by correlating items between the plant
database and the SmartPlant Foundation database, retrieving documents from SmartPlant
Foundation. Also, SmartPlant P&ID creates a set of tasks in the To Do List that you can run to
update the plant database. In SmartPlant P&ID, you can also use the commands on the
SmartPlant menu to publish documents and retrieve data, access the SmartPlant Foundation
Web Portal in order to browse in SmartPlant Foundation, and subscribe to change notifications
and compare documents.
You can only use the SmartPlant menu commands after your plant is registered. For more
information, see SmartPlant Engineering Manager Help.
Registering Tools
Before you can publish and retrieve documents from any of the other authoring tools, such as
SmartPlant Electrical or SmartPlant Instrumentation, you must register each plant in SmartPlant
P&ID with a SmartPlant Foundation database. The connection allows SmartPlant P&ID to use
the commands on the SmartPlant menu. A SmartPlant Engineering Manager administrator
typically registers a plant.
The software maps a plant and all its projects to a single SmartPlant Foundation URL, which
points to one, and only one, SmartPlant Foundation plant database and its projects. When you
use the Register command in any of the authoring tools, you are registering an authoring tool
plant with a SmartPlant Foundation URL and plant that you specify.
The system administrator must register each plant in the authoring tool once; this action takes
place in SmartPlant Engineering Manager. After the plant is registered, you can publish and
retrieve documents.
applications, create separate plants in the project, then enable SmartPlant P&ID for one plant
and SmartPlant Electrical for the other.
4. Edit the SmartPlant resource path setting in Options Manager to point to the folder where
you installed the Integration Resource Files.
The path specified in Options Manager must contain the tool schema (for
example, SPIDDataMap.xml) for publish and retrieve operations between the tool and
SmartPlant to work properly. For more information, see the SmartPlant P&ID User's Guide.
5. Register your SmartPlant plant with SmartPlant Foundation, as described in the SmartPlant
Engineering Manager Help.
When you register your plant, you must specify the location of the SmartPlant
Engineering Manager schema map file (SPEMDataMap.xml). For more information,
see the Specify Map File Dialog Box topic in the SmartPlant Engineering Manager
User's Guide.
If only one application is associated with the plant at the time it is registered, only that
application is registered. If another application is later associated with the plant, the
Register command is enabled so that you can register the new application with the plant.
All non-piped offline equipment instruments must be connected to vessels through non-
electric signal lines and nozzles in SmartPlant P&ID. This enables SmartPlant
Instrumentation to recognize that instruments are connected to vessels.
If SmartPlant P&ID assigns an object to an intermediate level in the hierarchy and publishes,
SmartPlant Instrumentation will assign the object to the level in the hierarchy in SmartPlant
Instrumentation determined by their logic. Because instruments belong to units in
SmartPlant Instrumentation, an instrument assigned to the intermediate level in SmartPlant
P&ID will be assigned to the unit in SmartPlant Instrumentation. Panels will be assigned to
the plant. SmartPlant P&ID may get an update on retrieve to move the object to another
level in their hierarchy than where it was published based on the move done automatically
by SmartPlant Instrumentation. Instruments will move to the top level; panels will move to
the bottom.
Ports
SmartPlant Instrumentation uses physical ports, while SmartPlant P&ID uses logical ports.
SmartPlant Instrumentation publishes the physical ports with the Dimensional Data Sheets
and not the Instrument Index. SmartPlant P&ID retrieves the Instrument Index and does not
retrieve the Dimensional Data Sheets.
When the workflow goes from SmartPlant P&ID to SmartPlant Instrumentation, followed by
SmartPlant Instrumentation publishing the Dimensional Datasheet, a Same As relationship is
created between the ports in the SmartPlant Foundation database. That Same As relationship
is required by SmartPlant 3D to correctly match the design basis ports to the 3D
representation of the ports.
When the workflow goes from SmartPlant Instrumentation to SmartPlant P&ID, however, a
Same As relationship is not created in the SmartPlant Foundation database. Without the
Same As relationship created in the SmartPlant Foundation database, the result may be
additional ports in SmartPlant 3D. To obtain the Same As relationship on the ports requires
that SmartPlant P&ID publish the P&ID with the instrument, this P&ID be retrieved by
SmartPlant Instrumentation and then having SmartPlant Instrumentation publish the
Dimensional Data Sheet.
The same holds true for the equipment and nozzle issue. SmartPlant P&ID permits an
equipment object to be claimed to the project without requiring the nozzles to be claimed,
even if the nozzles are seen on the P&ID. The claim method of Basic Engineering does not
support this. When Basic Engineering retrieves the equipment claim it claims the nozzles
along with the equipment. When P&ID retrieves from Basic Engineering the nozzles are
Create tasks since P&ID is not looking to retrieve Claim status from other tools.
In these cases, either the P&ID user will have to delete the create tasks or agree to add the
objects to the project scope. If they agree to add them to the project scope they should delete
the create tasks first, then claim the objects and then re-retrieve the Basic Engineering
document. This would generate update tasks. Optionally, since Basic Engineering requires
all related nozzles to be claimed when claiming equipment, when claiming equipment in
SmartPlant P&ID, all nozzles could be claimed. This causes the scopes of the claims
between Basic Engineering and SmartPlant P&ID to match.
Search Based on Subclass Value Searches the catalog index for all rows with matching
ItemTypeName and SubClass values and IsDefaultForSubclass = true. If one or more rows are
found, the software uses the CatalogItemName from the first one. If no match is found, the
software performs the search based on Class.
Search Based on Class Value Searches the catalog index for all rows with matching
ItemTypeName and Class values and IsDefaultForClass = True. If one or more rows are found,
the software uses the CatalogItemName from the first one. If no match is found, the software
returns an empty string.
If you add an enumerated list attribute to the plant data dictionary, see the Hierarchical
Enumerated Lists topic in the SmartPlant P&ID User's Guide for information about
mapping these complex data types.
The default SPEMdatamap.xml file contains the EF_SPAPlant attributes (CompanyName,
SiteName, SiteLocation, DivisionName, DivisionLocation). To use these default attributes,
use the EF_SPAPLANT.ddt when creating your plant in SmartPlant Engineering Manager.
The default SPEMdatamap.xml and the EF_SPAPLANT.ddt files are delivered to the
C:\Program Files\SmartPlant\Engineering Manager\EFResources folder.
After registering, SmartPlant Engineering Manager cannot retrieve the PBS document if the
plant and SmartPlant hierarchies are not compatible. To be compatible with the SmartPlant
hierarchy, your plant hierarchy can contain less than or equal, but not more than the number
of levels in the SmartPlant hierarchy.
SmartPlant Engineering Manager retrieves from the SmartPlant hierarchy only the hierarchy
levels it needs. For example, if your plant hierarchy contains 4 levels and the SmartPlant
hierarchy contains 8 levels, only the top 4 levels of the SmartPlant hierarchy are retrieved.
Hierarchy item names at the same level do not have to match. Hierarchies are mapped by
depth (level), not by name.
In addition to requiring a minimum of three-levels in hierarchies, SmartPlant integration also
requires that the names of hierarchy items cannot be changed after they are created and that
the hierarchy structure cannot be modified after you create the project. For more
information, see the SmartPlant Enterprise Installation and Setup Guide.
You must install the Schema Component and the SmartPlant Client, delivered with
SmartPlant Foundation, on your SmartPlant Engineering Manager workstation before you
can register. For more information, see the topic Configure SmartPlant P&ID for an
Integrated Environment in the appropriate Installation and Upgrade Guide.
If only one application is associated with the plant at the time it is registered, only that
application is registered. If another application is later associated with the plant, you must
also register the new application with the plant.
We recommend that you re-register each tool with SmartPlant Foundation after upgrading
that tool to the current software version.
After the plant is registered, the SmartPlant tab is added to the Plant Structure Properties
dialog box. The SmartPlant tab displays the SmartPlant Foundation URL, the SmartPlant
Foundation plant database, and the unique application identifiers returned by the registration
process.
B D
backing up .................................................. 59 Data Dictionary Manager ......................... 100
upgraded plants....................................... 59 data model ................................................ 100
backup locations ......................................... 78 customizing........................................... 100
sharing .................................................... 78 database .......................................... 11, 19, 31
border templates ............................... 102, 104 database constraints .................. 48, 49, 50, 51
configuring ........................................... 102 utilities .............................................. 49, 50
creating ................................................. 104 database servers ............................................ 7
delivered ....................................... 102, 104 configuration..................................... 11, 31
break componenet....................................... 63 networking components .......................... 11
update drawings ...................................... 63 Oracle ARCHIVELOG mode ................. 19
break labels ................................................. 61 Oracle Cost Based Optimizer ................. 19
upgrading ................................................ 61 system requirements ................................. 7
tuning ...................................................... 19
display sets ............................................... 109
C
printing ................................................. 109
catalog index ............................................ 113 Drawing Manager ................................. 2, 107
CatalogIndex.mdb ................................ 113 overview ................................................... 2
out-of-date ............................................ 113 starting SmartPlant P&ID ..................... 107
retrieving symbols ................................ 113 drawings ............................................. 62, 109
updating ................................................ 113 printing ................................................. 109
configuring ....................... 11, 41, 67, 78, 102 re-creating ............................................. 109
border templates ................................... 102 re-creating errors................................... 109
Integration Resource Path....................... 41 updating .................................................. 62
network shares ........................................ 78
Oracle networking .................................. 11 E
reference data ......................................... 41
SmartPlant Engineering Manager........... 67 error conditions......................................... 109
correcting .................................................. 109
error conditions..................................... 109 F
creating ....................................... 79, 104, 108 Filter Manager ............................................ 99
border templates ................................... 104 filtered printing ......................................... 109
P&IDs ................................................... 108 filters ........................................................... 99
user groups ............................................. 79 customizing............................................. 99
customizing ................ 99, 100, 101, 102, 104 Format Manager ......................................... 99
border templates ........................... 102, 104 formats .................................................. 61, 99
data model ............................................ 100 upgrading ................................................ 61
filters....................................................... 99
formats .................................................... 99
labels..................................................... 100
H statistics .................................................. 60
hardware ................................................... 7, 8 tuning ...................................................... 60
hardware requirements ................................. 7 out-of-date ............................................ 63, 64
database servers ........................................ 7 resolve drawings ..................................... 64
requirements ............................................. 7 update drawings ...................................... 63
workstation ............................................... 8 overviews...................................................... 1
SmartPlant P&ID ...................................... 1
I
P
installation .................................................. 36
Installation Guide ......................................... 2 permissions ................................................. 32
overview ................................................... 2 piping specification .................................... 32
silent mode ............................................. 36 PipingPoint ................................................. 60
installing ............................. 31, 32, 33, 34, 41 placing ...................................................... 108
database .................................................. 31 items ..................................................... 108
reference data ......................................... 41 plant structures............................................ 78
SmartPlant .............................................. 31 sharing .................................................... 78
SmartPlant 3D client............................... 32 printing ..................................................... 109
SmartPlant Engineering Manager........... 33 filtered................................................... 109
SmartPlant P&ID .............................. 32, 34 P&IDs ................................................... 109
Insulation Manager ....................................... 2
integration........................................... 31, 112 R
preparing the environment .................... 112 recommendations.......................................... 7
supported Oracle versions ...................... 31 database servers ........................................ 7
re-creating drawings ................................. 109
L reference data.................................. 41, 61, 99
labels......................................................... 100 configuring ............................................. 41
customizing .......................................... 100 customizing............................................. 99
logs ............................................................. 60 installing ................................................. 41
Integration Resource Files ...................... 41
Integration Resource Path ....................... 41
N Options Manager .................................... 99
network access privileges ........................... 82 upgrading ................................................ 61
granting to user groups ........................... 82 registering ................................................. 111
network shares ............................................ 78 with SmartPlant Foundation ................. 111
backups ................................................... 78 registry ........................................................ 32
plant structure ......................................... 78 requirements ............................................. 7, 8
role template ........................................... 78 database servers ........................................ 7
site server ................................................ 78 hardware ................................................... 7
software .................................................... 7
O workstation ............................................... 8
Options Manager .................................... 2, 99 role templates.............................................. 78
customizing ............................................ 99 sharing .................................................... 78
overview ................................................... 2 Rule Manager ....................................... 2, 101
Oracle ................................................... 19, 60 overview ................................................... 2
Oracle analyzer scripts ............................... 60 rules .......................................................... 101
analyzer scripts ....................................... 60 rules for integrating authoring and viewing
ARCHIVELOG mode ............................ 19 tools
Cost Based Optimizer ............................. 19 customizing........................................... 101
S U
servers........................................................... 7 updating ...................................................... 62
database .................................................... 7 P&IDs ..................................................... 62
silent mode installation ............................... 36 upgrade ....................................................... 60
site administrators................................. 81, 82 upgrade tasks .............................................. 60
network access privileges ....................... 82 logs ......................................................... 60
user group ............................................... 81 manual changes ...................................... 60
site servers .................................................. 78 tasks ........................................................ 60
sharing .................................................... 78 understanding ......................................... 60
SmartPlant .................................................. 31 upgrading .... 49, 50, 51, 52, 53, 59, 60, 61, 63
SmartPlant 3D ............................................ 32 after ......................................................... 59
installing remote access client ................ 32 backing up after ...................................... 59
SmartPlant Engineering Manager 33, 67, 111 backing up old data ................................. 52
configuring ............................................. 67 break labels ............................................. 61
installing ................................................. 33 cleanup macros ....................................... 51
SmartPlant Foundation ............................. 111 constraint utilities ............................. 49, 50
SmartPlant integration ........................ 31, 112 formats .................................................... 61
preparing the environment .................... 112 memory management ............................. 53
supported Oracle versions ...................... 31 Oracle ..................................................... 60
SmartPlant P&ID........................ 1, 2, 32, 107 plants....................................................... 60
Drawing Manager ............................. 2, 107 reference data.......................................... 61
installing ................................................. 32 setting Open_Cursors parameter ............ 52
Insulation Manager ................................... 2 sharing paths ........................................... 52
Options Manager ...................................... 2 update drawings ...................................... 63
overviews.................................................. 1 user customizations .................................... 60
Rule Manager ........................................... 2 user groups ..................................... 79, 81, 82
starting .................................................. 107 adding users ............................................ 81
using ..................................................... 107 creating ................................................... 79
SmartPlant SmartPlant P&ID ..................... 34 network access privileges ....................... 82
installation .............................................. 31 customization.............................................. 60
installing ................................................. 34 utilities ........................................................ 49
software ........................................................ 8 Clean Data .............................................. 49
requirements ............................................. 7 DelOrphModItem.dll .............................. 49
workstation ............................................... 8
starting .............................................. 107, 108 W
P&IDs ................................................... 108 Workshare ................................................ 113
SmartPlant P&ID .................................. 107
subtasks ...................................................... 60
Z
symbols............................................. 100, 113
customizing .......................................... 100 Zyqad ........................................................ 113
retrieving .............................................. 113 retrieving documents ............................ 113
system requirements ..................................... 7
database servers ........................................ 7
T
tasks ............................................................ 60
understanding ......................................... 60