SmartPlant Explorer Users Guide

SmartPlant Explorer
User's Guide
Version 2009 HF2 (06.00.00)

May 2010/August 2010
DSPE2-PE-200002G - Updated
Copyright
Copyright 1997-2010 Intergraph Corporation. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement;
contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret
law, and international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph
Corporation.
U.S. Government Restricted Rights Legend

Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the
United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813
Street address: 170 Graphics Drive, Madison, AL 35758
Terms of Use
Use of this software product is subject to the End User License Agreement ("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.
Warranties and Liabilities

All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software or
applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this document or
its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes the information in
this publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the terms
of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by
Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS
TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
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
SmartPlant Explorer .................................................................................................................................... 7
New Features in SmartPlant Explorer .................................................................................................... 7
Version 2009 .................................................................................................................................... 7
Administering SmartPlant Explorer........................................................................................................... 9
Administrating Common Tasks ............................................................................................................... 9
SmartPlant Explorer COM+ Application Identity Utility ........................................................................... 9
CAD Loop Drawings ............................................................................................................................. 10
System Security .................................................................................................................................... 11
Integrated Windows Authentication ................................................................................................ 12
Certificate Authentication................................................................................................................ 12
Switch Authentication Method ........................................................................................................ 13
Change Session Timeout ............................................................................................................... 13
Users and Roles.................................................................................................................................... 14
Add a User ...................................................................................................................................... 15
Delete a User.................................................................................................................................. 16
Add a Role ...................................................................................................................................... 16
Delete a Role .................................................................................................................................. 17
Application Modules .............................................................................................................................. 17
Add an Application.......................................................................................................................... 18
Remove an Application................................................................................................................... 18
Understanding the Interface ..................................................................................................................... 21
Using the Tree View .............................................................................................................................. 22
Command Menu.................................................................................................................................... 22
Related Items Command ................................................................................................................ 23
Properties Command...................................................................................................................... 24
Generate SmartPlant Instrumentation Reports .............................................................................. 24
Generate SmartPlant Reports ........................................................................................................ 26
View in 3D Command ..................................................................................................................... 27
View CAD Loop Command ............................................................................................................ 27
Viewing Drawings ................................................................................................................................. 27
View Properties ..................................................................................................................................... 28
Toolbars ................................................................................................................................................ 29
Main Toolbar................................................................................................................................... 29
Report Toolbar................................................................................................................................ 30
Graphic Toolbar .............................................................................................................................. 33
Application Toolbar ......................................................................................................................... 35
Favorites ..................................................................................................................................................... 37
Access Tab (Favorite) ........................................................................................................................... 37
Create a Favorite .................................................................................................................................. 38
Rename a Favorite ............................................................................................................................... 38
Save As IE Favorite .............................................................................................................................. 39
Edit Access to a Favorite ...................................................................................................................... 39
Delete a Favorite ................................................................................................................................... 39
SmartPlant Explorer User's Guide
Contents
Display Favorite Properties ................................................................................................................... 39
Administer Favorites ............................................................................................................................. 40
Actions........................................................................................................................................................ 41
URL Tab ................................................................................................................................................ 41
Parameters Tab .................................................................................................................................... 42
Name Tab (Action) ................................................................................................................................ 42
Access Tab (Action) .............................................................................................................................. 43
Applies To Tab (Action) ........................................................................................................................ 43
Create a New Action ............................................................................................................................. 44
List Actions ............................................................................................................................................ 44
Edit Action ............................................................................................................................................. 44
Delete an Action .................................................................................................................................... 45
Explorer Defined Reports ......................................................................................................................... 47
Common Tasks for Reports .................................................................................................................. 47
Report Results Tab ............................................................................................................................... 48
Definition Tab ........................................................................................................................................ 49
Name Tab (Report) ............................................................................................................................... 52
Access Tab (Report) ............................................................................................................................. 52
Applies To Tab (Report)........................................................................................................................ 53
Create a New Report ............................................................................................................................ 53
Edit Report Definition ............................................................................................................................ 54
Define Criteria for a Report ................................................................................................................... 54
Name a Report ...................................................................................................................................... 55
Set Report Access to Yourself .............................................................................................................. 55
Set Report Access to a Single User...................................................................................................... 55
Set Report Access to Specified Roles .................................................................................................. 56
Delete a Report ..................................................................................................................................... 56
Delete a Report Name .......................................................................................................................... 56
Graphic Reports ........................................................................................................................................ 57
Definition (Graphic Reports) ................................................................................................................. 57
Name Tab (Report) ............................................................................................................................... 60
Access Tab (Report) ............................................................................................................................. 60
Applies To Tab (Report)........................................................................................................................ 61
Create a New Graphic Report............................................................................................................... 61
Edit Graphic Report Definition .............................................................................................................. 61
Delete a Graphic Report ....................................................................................................................... 62
Navigating Between Modules ................................................................................................................... 63
Access the PDS 3D Module from the SmartPlant Instrumentation Module ......................................... 66
Access the PDS 3D Module from the SmartPlant PID Module ............................................................ 68
Create Model Actions ............................................................................................................................ 70
Access the PDS 3D Module from the PDS PID Module ....................................................................... 70
Access the SmartPlant Instrumentation Module from the SmartPlant PID Module.............................. 72
Access the SmartPlant Instrumentation Module from the PDS PID Module ........................................ 73
Access the PDS PID Module from the SmartPlant Instrumentation Module ........................................ 74
Access the PDS PID Module from the SmartPlant PID Module ........................................................... 75
Linking to PDS PID ............................................................................................................................... 76
Access the SmartPlant PID Module from the SmartPlant Instrumentation Module.............................. 79
Contents
Access the SmartPlant PID Module from the PDS PID Module ........................................................... 80
Navigate Between Modules Using the Intermodule Navigation Wizard ............................................... 81
PDS 3D Module .......................................................................................................................................... 87
Add a Project (PDS 3D Module) ........................................................................................................... 87
Create a DSN Using SQL Server ODBC Driver ............................................................................. 88
Configuration of Oracle Networking Components .......................................................................... 88
Remove a Project (PDS 3D Module) .................................................................................................... 89
Models Tab (PDS 3D Module) .............................................................................................................. 89
Item Tag Tab (PDS 3D Module) ........................................................................................................... 90
Location Tab (PDS 3D Module) ............................................................................................................ 90
SmartPlant Instrumentation Module ........................................................................................................ 91
Administrating SmartPlant Instrumentation Common Tasks ................................................................ 91
Add a Site (SmartPlant Instrumentation Module) ................................................................................. 92
Update a Site (SmartPlant Instrumentation Module) ............................................................................ 92
Update Properties (SmartPlant Instrumentation Module) ..................................................................... 93
Update Administrator Database Password (SmartPlant Instrumentation Module) ............................... 93
Remove a Site (SmartPlant Instrumentation Module) .......................................................................... 93
Add a Domain (SmartPlant Instrumentation Module) ........................................................................... 94
Update a Domain .................................................................................................................................. 94
Remove a Domain (SmartPlant Instrumentation Module) .................................................................... 94
Define SmartPlant Instrumentation Web Server ................................................................................... 95
Add a Plant (SmartPlant Instrumentation Module) ............................................................................... 95
Add a Plant ..................................................................................................................................... 95
Update a Plant ...................................................................................................................................... 96
Remove a Plant..................................................................................................................................... 96
Defining SmartPlant Instrumentation Engineer Users .......................................................................... 96
Add a User as a SmartPlant Instrumentation Engineer ........................................................................ 96
SmartPlant Electrical Module ................................................................................................................... 97
Add a Site Server (SmartPlant Electrical Module) ................................................................................ 97
Remove a Site Server (SmartPlant Electrical Module) ......................................................................... 97
PDS PID Module......................................................................................................................................... 99
Add a Project (PDS PID Module) .......................................................................................................... 99
Update a Project (PDS PID Module)................................................................................................... 100
Remove a Project (PDS PID Module) ................................................................................................. 100
SmartPlant PID Module ........................................................................................................................... 101
Administering SmartPlant PID Module ............................................................................................... 101
Add a Site Server (SmartPlant PID Module) ................................................................................ 101
Remove a Site Server (SmartPlant PID Module) ......................................................................... 101
SmartPlant PID Module Reports ......................................................................................................... 102
Generate SmartPlant Reports ...................................................................................................... 102
SmartPlant Layout and Filter Defined .......................................................................................... 103
Activate a Display Set on a Drawing (SmartPlant PID Module) ................................................... 103
View Equipment within a Drawing ................................................................................................ 104
Contents
Printable Guides ...................................................................................................................................... 105
Printing PDF Files ............................................................................................................................... 105
Index ......................................................................................................................................................... 107
SECTION 1
SmartPlant Explorer
Intergraph SmartPlant Explorer unlocks the value of your plant information for the entire life
cycle. Using the simple interface of Microsoft Internet Explorer, SmartPlant Explorer gives you
controlled access to a wide array of project-generated information.
Because SmartPlant Explorer has three levels of access; Administrator, User, and Viewer;
you may not have permission, depending on your access level, to some commands or
features described in help. Help identifies the commands and features that are only available
to administrators or users.
After upgrading to Version 2009, or after installing a service pack you must restart your
computer.
New Features in SmartPlant Explorer

The following new features have been added:
Version 2009
The SmartPlant Instrumentation module now displays Enhanced SmartLoop drawings as they
were generated by the software, using the specific preferences and settings from the domain
that the drawing was generated in, based on the user configuration in SmartPlant Explorer.
You must have installed SmartPlant Instrumentation 2007 SP6 HF 13 or higher or

SmartPlant Instrumentation 2009 SP1, for this feature to work.
In the Settings.js file, change the var INtools_DomainSpecificEslPreferences =false;
to true. This file can be found in the home folder where you installed SmartPlant Explorer
in the Web Server folder.
In the SmartPlant P&ID module when opening a report for one of the following categories;
Equipment
Mechanical
Vessel
Heat Transfer
When the item you select appears in more than one drawing, you can now select a specific
drawing to be displayed instead of the default drawing. For example, if you choose a vessel
that appears in drawing 1 and drawing 2, you can now select which of the drawings to display.
SmartPlant Explorer 2009 supports Windows Vista Business Client 32-bit mode with Users
Access Control (UAC) on.
When installing Active X controls UAC must be turned off. Once installed you can
restart UAC on your machine.
The SmartPlant P&ID module now supports the display and control of Typicals.
The SmartPlant Electrical module now allows you to preview registered documents prior to
printing.
SmartPlant Explorer
It is now possible for users registered in one domain, to access data and reports in another
domain and save them to Excel.
SmartPlant Explorer now gives you the option to generate your reports in the current browser
window or in a new browser window.
For this functionality to work you must disable you browsers pop-up
blocker.
It is now possible when working in SmartPlant Explorer to connect to different SmartPlant
Instrumentation databases from the same SmartPlant Explorer server.
SECTION 2
Administering SmartPlant Explorer

The following section contains information for use by the SmartPlant Explorer Administrator on
adding and removing modules, the application modules, system security, users, and roles.
Administrating Common Tasks

The following tasks are performed when you administer SmartPlant Explorer.
Add and remove application modules
Add the application modules to your SmartPlant Explorer server. For more information, see
Add an Application (on page 18).
Remove the application modules from your SmartPlant Explorer server. For more information,
see Remove an Application (on page 18).
Add and remove roles and users

Add or remove roles and users to the SmartPlant Web Server package in Microsoft Component
Services, thereby controlling access to SmartPlant Explorer.
Add roles to the web server package. For more information, see Add a Role (on page 16).
Add users to roles. For more information, see Add a User (on page 15).
Remove users so they cannot access SmartPlant Explorer. For more information, see Delete
a User (on page 16).
Remove a role so users in that role cannot access SmartPlant Explorer. For more information,
see Delete a Role (on page 17).
SmartPlant Explorer COM+ Application Identity Utility

The SmartPlant Explorer COM+ Application Identity utility enables you to grant SmartPlant
Explorer users access to specific SmartPlant Explorer application modules. Also, you can use
this utility to restart all the SmartPlant Explorer COM+ applications. This is especially useful as
you do not have to run the Windows Component Services and restart each application one by one.
To start the SmartPlant Explorer COM+ Application Identity utility, in the SmartPlant Explorer
home folder navigate to the following path and run the SPEUserAdmin.exe file:
SmartPlant Explorer home folder > WebServer > System > SPEUserAdmin.exe
The options are as follows:
Available COM+ applications

This group box contains all the available COM+ applications that you can select when granting
application module access to SmartPlant Explorer users. Note that SmartPlant Web Server,
SPWebDependencies, and SmartPlant Explorer Viewers are not available here because these
three applications must be selected at all times when granting access rights. The software
selects these applications automatically.
SmartPlant Explorer PDS 3D Module Grants access to the PDS 3D Module application
module.

SmartPlant Explorer PDS PID Module Grants access to the PDS PID Module.
SmartPlant Explorer SmartPlant Instrumentation Module Grants access to the SmartPlant
Instrumentation Module.
SmartPlant Explorer SmartPlant Electrical Module Grants access to the SmartPlant
Electrical Module.
Select all Selects all the available applications.
Drawing converter
Drawing converter module Grants access to the Drawing converter module.
Restart All Applications

Restarts all the existing SmartPlant Explorer COM+ applications (including SmartPlant Web
Server, SPWebDependencies, and SmartPlant Explorer Viewers). This command does the
same thing as the Windows Component Services.
Account
These options allow you to define a SmartPlant Explorer user account to receive access rights to
the application modules that you selected in the Available COM+ applications group box.
Interactive user - The current logged on user Grants access rights to the user who is
currently logged to Windows.
This user Grants access rights to the user whose use name and password is defined below.
User Allows you to type a user name, usually a Windows logon name.
Password Allows you to type a password, usually a Windows logon password.
Confirm password Allows you to type the password again for confirmation.
CAD Loop Drawings

To view CAD Loop drawings in SmartPlant Explorer, the CAD drawing extension used by your
CAD software must be recognized by the Internet Information Services (IIS). To add the extension
to those recognized by SmartPlant Explorer's IIS do the following:
1. Log on to the computer where the SmartPlant Explorer Web Server is installed.
2. From the Windows Start menu, select Control Panel > Administrative Tools > Internet
Information Services (IIS) Manager.
3. On the Internet Information Services (IIS) Manager dialog box navigate to Web Sites >
Default Web Site > SPEX.
4. On the SPEX icon, right-click and from the shortcut menu select Properties.
5. On the SPEX Properties dialog box, click on the HTTP Headers tab.
6. Click MIME Types.
7. On the MIME Types dialog box, click New.
8. Type the extension and MIME type, for example .igr or .dwg.
9. Click OK on all the subsequent dialog boxes until you finish the process.
10
System Security
Every time a user attempts to access the SmartPlant Explorer Web Server, the Web server
authenticates, or confirms, the identity of the user to ensure that the user has a valid Windows
account. This method is indispensable for limiting access to your data. Different authentication
methods are available from which you can choose:
Basic Authentication - Prompts users to type user names and passwords.
Integrated Windows Authentication - Cryptographically obtains user identification
information from the web browser of the user.
Secure Sockets Layer (SSL) Client Certification Authentication - Authenticates users by
checking the contents of an encrypted digital identification that the web browser submits
during the logon process.
You selected either the Basic or the Integrated Windows Authentication method when you
installed the SmartPlant Explorer Web Server.
SmartPlant Explorer does not support Anonymous Authentication or Digest Authentication.
Basic Authentication
The Basic authentication method is a widely used, industry- standard method for collecting user
name and password information. Basic authentication proceeds as follows:
1. The user's Web browser displays a dialog box where users can enter their previously
assigned Windows account user names and passwords.
2. The Web browser then attempts to establish a connection using this information. (The
password is Base64 encoded before being sent over the network).
3. If the server rejects the information, the Web browser repeatedly displays the dialog box until
the user either enters a valid user name and password or closes the dialog box.
4. When your Web server verifies that the user name and password correspond to a valid
Windows user account, a connection is established.
For information about setting up Basic authentication, see IIS Documentation.
The disadvantage is that Web browsers using Basic authentication transmit passwords in an
unencrypted form. By monitoring communications on your network, someone could easily
intercept and decipher these passwords by using publicly available tools.
Therefore, Basic authentication is not recommended unless you are confident that the connection
between the user and your Web server is secure, such as a direct cable connection or a dedicated
line.
Integrated Windows authentication takes precedence over Basic authentication. The
browser will choose integrated Windows authentication and will attempt to use the current
Windows logon information before prompting the user for a user name and password.
11
Integrated Windows Authentication

Integrated Windows authentication is a secure form of authentication because the user name and
password are not sent across the network. When you enable integrated Windows authentication,
the user's browser proves its knowledge of the password through a cryptographic exchange with
your Web server, involving hashing.
Integrated Windows authentication can use both the Kerberos v5 authentication protocol and its
own challenge/response authentication protocol. If Directory Services is installed on the server,
and the browser is compatible with the Kerberos v5 authentication protocol, both the Kerberos v5
protocol and the challenge/response protocol are used; otherwise only the challenge/response
protocol is used.
The Kerberos v5 authentication protocol is a feature of the Windows Distributed Services
architecture. In order for Kerberos v5 authentication to be successful, both the client and server
must have a trusted connection to a Key Distribution Center (KDC) and be Directory Services
compatible. For more information about the protocol, see the Windows documentation.
Integrated Windows authentication proceeds as follows:
1. Unlike Basic authentication, it does not initially prompt users for a user name and password.
The current Windows user information on the client computer is used for the integrated
Windows authentication. Note, Internet Explorer, version 4.0 and later, can be configured to
initially prompt for user information if needed.
2. However, if the authentication exchange initially fails to identify the user, the browser will
prompt the user for a Windows user account user name and password, which it will process
by using integrated Windows authentication.
3. Internet Explorer will continue to prompt the user until the user enters a valid user name and
password, or closes the prompt dialog box.
Although integrated Windows authentication is secure, it does not work over HTTP Proxy
connections. Therefore, integrated Windows authentication is best suited for an intranet
environment, where both user and Web server computers are in the same domain.
Certificate Authentication
You can also use your Web server's Secure Sockets Layer (SSL) security features for two types of
authentication. You can use a server certificate to allow users to authenticate your Web site before
they transmit personal information, such as a credit card number. Also, you can use client
certificates to authenticate users requesting information on your Web site. SSL authenticates by
checking the contents of an encrypted digital identification submitted by the user's Web browser
during the logon process. (Users obtain client certificates from a mutually trusted third-party
organization.)
Server certificates usually contain information about your company and the organization that
issued the certificate. Client certificates usually contain identifying information about the user and
the organization that issued the certificate.
12
Client Certificate Mapping

You can associate, or map, client certificates to Windows user accounts on your Web server. After
you create and enable a certificate map, each time a user logs on with a client certificate, your
Web server automatically associates that user to the appropriate Windows user account. This
way, you can automatically authenticate users who log on with client certificates, without requiring
the use of either Basic or integrated Windows authentication. You can either map one client
certificate to one Windows user account or many client certificates to one account. For example, if
you had several different departments or businesses on your server, each with its own Web site,
you could use many-to-one mapping to map all of the client certificates of each department or
company to its own Web site. This way each site would provide access only to its own clients.
Switch Authentication Method

1. Click Start > Settings > Control Panel > Administrative Tools > Internet Services
Manager.
2. Open the computer where you installed the SmartPlant Explorer Web Server.
3. Double-click Default Web Site on the server.
4. Right-click SPEx.
5. Click Properties on the shortcut menu.
6. Click the Directory Security tab.
7. Click Edit in the Anonymous Access and Authentication Control group.
8. Select Basic Authentication or Integrated Windows Authentication. You cannot use both
authentication methods at the same time with SmartPlant Explorer. You must select one or
the other.
9. Click OK.
10. Click OK.
11. Exit the Internet Services Manager.
Change Session Timeout

1. Log on as an administrator on the web server.
2. Click Start > Settings > Control Panel > Administrative Tools > Internet Services
Manager.
3. Open the Internet Information Server folder.
4. Double-click your computer name to expand the branch.
5. Double-click Default Web Site to expand the branch.
6. Right-click SPEx and select Properties on the shortcut menu.
7. Select the Virtual Directory tab.
8. Under the Application Settings, click Configuration.
9. Select the App Options tab.
10. Change the Session timeout option to new timeout period.
11. Click OK.
12. Click OK on the SPEx Properties dialog box.
13

The SmartPlant Explorer Web Server disconnects an inactive client connection after 20
minutes (the IIS default setting). This disconnection ensures that memory and processing
resources on the web server are not wasted on inactive connections. However, if you are
frequently receiving the "Your connection to the SmartPlant Explorer server has timed out"
message, you may want to increase this timeout period. We do not recommend setting the timeout
period greater than 20 minutes unless your web server has the memory and processing resources
to handle it.
Users and Roles

After installing the SmartPlant Explorer Web Server, you need to define which roles and users
have access to SmartPlant Explorer. Roles are groups of users who have access to SmartPlant
Explorer. You add users to roles using their standard logon details for the Windows domain. Users
can be individual Windows users or Windows user groups. Users login to the SmartPlant Explorer
Web Server using their regular Windows user name and password. SmartPlant Explorer checks
the defined roles and users in the Component Services on Windows to verify that they have been
granted access. If they have access, SmartPlant Explorer starts.
All users must have Windows logon privileges to the SmartPlant Explorer Web Server.
Users without logon privileges cannot access SmartPlant Explorer even though they have been
added to a SmartPlant Explorer Role.
By default, the software creates three roles, or groups, when you install SmartPlant Explorer:
Administrator, User, and Viewer. You can add more roles, for example, Purchasing, by using the
Component Services Explorer. You should add more roles when you want to more finely control
who can view what reports.
Administrators - Full access to all SmartPlant Explorer features, including defining reports,
editing reports, and controlling who can run which reports and actions. In addition, Administrators
can add and remove application modules and projects from the SmartPlant Explorer tree view.
Users - Less access than Administrators, but can still define and edit report definitions and
actions. Users cannot control who can run which reports.
Viewers - Most limited access. Viewers can only run reports and view the results. Viewers cannot
create any new report definitions or actions.
14

Users who belong to more than one role are granted the access privileges of the higher role. For
example, if John were in the User and Viewer roles, John would have User privileges. Users who
belong to more than one role are able to run all Actions available to all the roles of which they are
members.
In addition to adding a user to a role, the user must have Windows logon privileges to the
SmartPlant Explorer Server, either directly or by being a member of a Windows User Group that
has logon privileges.
You can add your own roles using the Component Services Explorer. If you create roles, you must
add those roles to the component interface so SmartPlant Explorer knows the needed access
privileges. The four component interfaces in SmartPlant Explorer are:
_AllActions - Roles in this interface can modify every Action menu in the application regardless to
whom and to what the Actions apply. By default, the Administrator role belongs to this interface.
_Application - Roles in this interface can add and remove SmartPlant Explorer Modules. By
default, the Administrator role belongs to this interface.
_SPApplication - Roles in this interface can access SmartPlant Explorer. By default, the
Administrator, User, and Viewer roles belong to this interface.
_UserSpecificActions - Users in Roles in this interface can create, delete, and modify their own
Actions. Other users do not see these Actions. The user cannot modify Actions that other users
own. By default, the Administrator and User roles belong to this interface.
In addition to one of the component interfaces, you must add your own roles to the ObjectControl
interface.
If you do not want to add your custom roles to the interfaces, you can still define access privileges
by adding the user to both your custom role (to control what Actions they see) and to one of the
delivered roles (to control access privileges). In some ways, this is a better than the alternative
because you can define a single Administrator for your custom role and set the remaining role
members as Users or Viewers.
Roles that are not in _UserSpecificActions or _AllActions cannot modify actions or reports
at all.
Add a User
1. Click Start > Settings > Control Panel > Administrative Tools > Component Services.
2. Select the computer on which the SmartPlant Explorer Server is installed.
3.
4.
5.
6.
7.
8.
9.
10.
11.
If the SmartPlant Explorer Server is not listed under Computers, right-click the
Computers folder and click New. Then type the name of the server.
Double-click COM+ Applications.
Double-click SmartPlant Web Server.
Double-click Roles.
Double-click the roles to which you want to add a user.
Right-click the Users folder under the role.
On the shortcut menu, point to New, and click User.
Identify the user you want to add.
Click OK.
Right-click the SmartPlant Web Server package.
15

12. On the shortcut menu, click Shut down.
All users, regardless of the roles to which they belong, must have Windows logon privileges on
the SmartPlant Explorer Server. Users without logon privileges cannot access SmartPlant
Explorer even if they have been added to a Role.
You can add a Windows User Group instead of individual users.
Delete a User
2. Double-click the computer on which SmartPlant Explorer Server is installed.
3.
4.
5.
6.
7.
8.
9.
10.
11.
If the SmartPlant Explorer Server is not in the list of computers, right-click the
Double-click Roles.
Double-click the role from which you want to remove a user.
Double-click the Users folder under the role.
Select the user.
Press Delete.
On the menu, click Shut down.
Add a Role
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
16
If the SmartPlant Explorer Server is not in the list of computers, right-click the Computers
folder and click New. Then type the name of the server.
Right-click Roles.
Point to New, and click Role.
Type the role name.
Click OK when prompted if you are certain that SmartPlant Explorer Web Server supports the
changes.
Double-click Components.
Right-click SPEApplication.SPApplication, and then select Properties.
Select the Security tab.
Place a check by your role.
Users must belong to one of the three delivered roles; Administrator, User, or Viewer; in
addition to any custom-defined roles.
You must add new roles to the ObjectControl interface in addition to one of the other
interfaces (see "Users and Roles" on page 14).
You need to restart SmartPlant Explorer in Internet Explorer to see the change.
Delete a Role
3.
4.
5.
6.
7.
8.
9.
10.
If the SmartPlant Explorer Server is not listed under computers, right-click on the
Double-click Roles.
Select the roles that you want to delete.
Press Delete.
Click OK when prompted if you are certain that SmartPlant Explorer Web Server supports the
changes.
You need to restart SmartPlant Explorer in Internet Explorer to see the change.
Application Modules
SmartPlant Explorer has two main parts: the SmartPlant web server and one or more SmartPlant
application module servers.
The web server provides the central services for the SmartPlant application modules. These
services include the roles, components, and basic actions required to interact with the individual
application module servers.
Users connect to the web server using the http protocol, for example, http://myserver/spe.
Through Internet Explorer, the user requests to see application data. The web server forwards
this request for information to the corresponding application module server (PDS 3D Module,
SmartPlant Instrumentation Module, SmartPlant Electrical Module, SmartPlant PID Module, or
PDS PID Module).
The application module server retrieves requested information from the application-specific
database and passes that information back to the web server. The web server formats the
information as HTML pages and then displays the pages to the user.
The web server and the application modules servers must be installed on the same computer.
You do not have to add all the available application modules. For example, if you only use
SmartPlant Explorer to view SmartPlant Instrumentation data, you do not need to add the PDS
3D, SmartPlant Electrical, SmartPlant PID, or PDS PID modules.
Note that you can navigate between the data of different application modules that have been
added to the web server, for example SmartPlant P&ID and SmartPlant Instrumentation. For
details about navigating between application modules, see Navigating Between Modules (on
page 63).
17
Add an Application
1. Start SmartPlant Explorer in Internet Explorer by typing http://<server>/spex/ where <server>
is the name of the web server.
You must allow session cookies. You can verify this setting by opening the Internet
Options dialog box, selecting the Privacy tab, and then clicking Advanced.
2. Right-click SmartPlant Explorer Web Server
.
3. On the shortcut menu, click Add Application.
4. Type the server name where the SmartPlant Explorer application module that you want to add
is installed.
5. Click Search to display which modules are installed on that server.
6. From the list, select the module to load.
7. Click Add Selected Module.
8. On the Installation Done message box, click OK.
9. If you have saved application data, you are asked if you want to reuse the data. Click Yes to
reuse the data. Click No to install default application data.
10. If you are using the saved data, your published sites must be updated. Choose whether or
not to let SmartPlant Explorer update the sites for you if prompted.
If you choose not to reuse the application data, the saved data is deleted from the server and
the default data is installed.
You must add an application before you can view any projects created with that application.
You must have administrator privileges to add an application.
The application module that you are adding must have already been installed.
Remove an Application
1. Right-click one of the following application icons:
2.
3.
4.
5.
18
PDS 3D
SmartPlant Instrumentation
PDS PID
SmartPlant PID
.
.
.
.
SmartPlant Electrical
.
On the shortcut menu, click Remove Application.
Select Save information.
Click Yes to confirm that you want to remove the application.
If prompted, click Yes to save data from the application that you are removing or No to remove
the application without saving data.
You can save custom actions, reports, favorites, and published application data when you
remove the application. SmartPlant Explorer can then reuse this information when you
reinstall this application. If you are not sure, we recommend that you save the information.
The software does not delete or affect your production application data in any way. You are
only removing the ability to view that data from the SmartPlant Explorer Web Server.
You must have administrator privileges to remove an application.
19
20
SECTION 3
Understanding the Interface

The SmartPlant Explorer interface is divided into several areas:
The Tree View is the primary navigational area of the interface.
The Main View displays reports, drawings, and other information that you requested to see.
The Properties View displays the properties of a selected item. The Properties View is hidden
by default but appears automatically when you ask to view properties.
When viewing the properties of an item, the note section, for example the Loop note,
Instrument note, Panel note, and so forth, only displays the first 2,000 characters of the note.
Several toolbars provide relevant commands for the current activity.
Popup menus (also called context menus) display commands for a selected item.
21
Using the Tree View

The tree view, located on the left of the SmartPlant Explorer window, is a hierarchical view of all
the applications, sites, domains, projects, plants, plant structures, and other plant items for which
you have permission to view. The tree functions similarly to other tree views that are familiar to you
to expand items and click
to collapse items. You can
such as Windows Explorer. Click
resize the tree view, or you can hide it entirely using the
toolbar command.
Each item in the tree has commands associated with it. Right-click the item to display a shortcut
menu. Click the item to activate the default command. For each item, the default command is the
first listed command on the menu followed by a separator. If there is no dividing line on the menu,
there is no default command defined. For example, in this picture the default command is View
Plant Structures. In addition to the delivered commands, you can add your own custom
commands to an item.
Only those nodes that the user has been given access rights in the Plant Role Properties
> SmartPlant P&ID > P&ID Objects in SmartPlant Engineering Manager, are visible in the tree
view. For example, a user has access rights to plants 1 and 3, but plant 2 the user has None
selected in the P&ID Objects, only plants 1 and 2 will be visible in the tree view.
Command Menu
The command menu appears when you right-click an item. In this example, New Refinery was
right-clicked. However, there are command menus available for all of the items in the tree view as
well as the item icons in the title bar.
22

You can click the item to activate the default command without displaying the menu. For each
item, the default command is listed first on the menu separated from other commands by a break
line. In this example, the View Item Types command is the default command.
SmartPlant Explorer associates commands with a plant item and a particular user or role. This
feature gives you the flexibility to allow some users the ability to run a command on a particular
plant item while other users cannot. For example, users in a role called Maintenance can run a
report called Service Location. However, users who are not in the Maintenance role do not see the
report on their command menu. Furthermore, reports and actions are set so that they are only
available for certain plant items. For example, an equipment report does not appear on a relief
valve's command menu.
You can add your own Actions and Reports to the command menus by right-clicking the plant item
type, and then selecting Reports > New > Explorer Defined or Actions > New.
Related Items Command

When a selected item has other item related to it, a Related Items... command appears on the
right-click menu. In this example, Document, Equipment, Line, Loop, Panel:Device and Unit are
related items to the selected tag item. Different plant items have different related items.
23
Properties Command
The Properties command appears on the menu when a selected item has viewable properties.
Properties appear in the Properties view.
Generate SmartPlant Instrumentation Reports

The Generate SmartPlant Instrumentation Reports command menu appears on the menu
when SmartPlant Instrumentation reports are available for the selected item. Different plant items
have different reports available for them.
You must setup the SmartPlant Instrumentation Web Server before you can generate
reports. For more information, see Define SmartPlant Instrumentation Web Server (on page 95).
The following SmartPlant Instrumentation reports are available in SmartPlant Explorer:
Domains
Instrument Type Report (Standard)
Instrument Type Report (Details)
Equipment Report (No Grouping)
Equipment Report (Grouping by Type)
Equipment Type Report
I/O Type Report
Line Numbers Report (No Grouping)
Line Numbers Report (Grouping by Type)
Line Type Report
Location Report
Manufacturer Report
Model Report
P&ID Drawing Number Report
Status Report
Plant and Other Hierarchy Items at this Level

Cable Summary Take-Off Report
Cable Gland Take-Off Report
Control System Tag List
Device Panel List Report (per Plant)
24

Cabinet List Report
All Tag Numbers (For all Units)
Device Cables List
Non-Device Cables List
Device Panel Connection
Distant DSC/PLC List
Junction Box List Report
Loop Summary Report (For all Units)
Repair Details Report
Marshaling Rack List Report
Non-Distant DCS/PLC List
Spare Parts Without Connection (available only with INtools version 5)
Unit or Lowest Item in the Hierarchy

Device Panel List Report (per Unit)
All Tag Numbers (For Current Unit)
Loop Summary Report (For Current Unit)
Tag
Calculation
Tag Signal
Instrument Specification
Process Data
I/O Card Tag Assignment (Per Tag)
Calibration Point Summary Report
Instrument Calibration Result Sheet
Enhanced SmartLoop
Fieldbus Segment Diagram
Loop
Smart Loop
Point to Point
Loop Tag Numbers
Cable
Cable Layout Style 1
Cable Layout Style 2
Cable Schedule
Panel, DCS Panels, and PLC Panels

I/O Card Tag Assignment (Per Panel and Strip)
I/O Map
Panel-Strip with Adjacent Connections
Panel-Strip without Adjacent Connections (Style 1)
Cabinet Panel, Device Panel, Junction Box Panel, and Marshalling Rack Panel
Panel-Strip with Adjacent Connections
Enhanced Panel-Strip without Adjacent Connections (Style 2)
25
Terminal Strip
I/O Card Tag Assignment (Per Panel)
I/O Map
Panel Strip With Adjacent Connections
Panel Strip Without Adjacent Connections (Style 1)
Panel Strip Without Adjacent Connections (Style 2)
Enhanced I/O Card Assignment (available only with INtools version 6 or newer)
Enhanced Internal Cross Wiring (available only with INtools version 6 or newer)
Enhanced Panel-Strip (available only with INtools version 6 or newer)
Enhanced Strip Signals (available only with INtools version 6 or newer)
Wiring Equipment
I/O Card Tag Assignment (Per Panel)
I/O Map
Enhanced I/O Card Assignment
Enhanced Internal Cross Wiring
Enhanced Panel-Strip
Enhanced Strip Signals
Generate SmartPlant Reports

The Generate SmartPlant Reports command displays all of the system level SmartPlant P&ID
reports that are available for the selected item type. You can then select the SmartPlant P&ID
report that you want to run from SmartPlant Explorer. You cannot define or edit SmartPlant P&ID
reports in SmartPlant Explorer.
26
You need to have Microsoft Excel 2003, or 2007 to view SmartPlant Reports.
After a SmartPlant P&ID report is displayed in Internet Explorer, you can drag the icon from
the Address ribbon to your desktop to create a shortcut that can be used to re-run the report
without having to go through SmartPlant Explorer.
Some SmartPlant Reports are not available unless you install SmartPlant P&ID on the same
computer as the SmartPlant Explorer SmartPlant PID Module. The following error message
appears when you try to run one of these reports: "Error running SmartPlant report 'Report
Name'. This report contains a reference to a component that does not exist on the SmartPlant
PID Module server. One possible solution to this problem is to load SmartPlant P&ID on the
SmartPlant Explorer SmartPlant PID Module server."
For the reporting services to function correctly, the Microsoft Management Console (MMC) 3.0
(for Microsoft Windows Server 2003 and Microsoft Windows XP Professional) must be
installed.
View in 3D Command
The View in 3D command displays all the 3D SmartPlant Review models that contain the selected
item. This command is only available in the PDS PID application module when viewing an item
type report. In addition, you must have the PDS 3D application module installed and have a
common project between PDS PID and PDS 3D.
View CAD Loop Command

The View CAD Loop command is the default command on the Command menu when creating
Loop reports. You use this command to display the CAD Loop drawing of the selected loop.
For this command to function correctly you must have added the drawing extension
of your CAD software to the MIME Types of the SPEX properties in the Internet Information
Services (IIS) Manager.
See also
CAD Loop Drawings (on page 10)
Viewing Drawings
Drawings display in the main area of SmartPlant Explorer. You can use the drawing view controls
to zoom in or out, fit, pan, and magnify different areas of the drawing to better view the drawing.
If you are viewing a SmartPlant P&ID drawing, the display criteria indicators show if the drawing
labels, borders are displayed and the level of the errors and warnings that are being displayed in
the drawing. Click on the label and border indicators to toggle off and on the display. Use the Set
command to edit the error and warning settings. The indicators can also be
Display Criteria
used to change the settings they represent. If the settings are simple toggles, clicking the indicator
changes the value and the drawing is updated immediately. If the setting requires additional
information (such as level), the Set Display Criteria dialog appears.
To find out more about an item in the drawing, place the cursor over the item. When the item
highlights, you can right-click to display the available item commands, or left-click to display the
properties of the item.
27

If you have Intergraph SmartPlant Markup installed, you can use the Markup File
to open the drawing in SmartPlant Markup.
command
View Properties
Displays the properties of the selected item. You can view item properties either in alphabetical
order or categorized by type.
28
You can show or hide the Properties view by clicking Toggle Properties Display
on the
main toolbar.
You can display or hide properties whose values are null, by clicking on the Hide/Display
blank values button.
Some item properties do not support being viewed by category.
Toolbars
Toolbars provide fast access to frequently-used commands. SmartPlant Explorer provides
several toolbars depending on the active command.
The Main toolbar is always visible in the upper-left corner of SmartPlant Explorer and toggles
the display of the tree view, properties view, favorites, and displays help.
The Report toolbar appears when you are working with or viewing tabular or graphic reports
and provides access to create, save, and edit reports. A similar toolbar displays in the same
location when defining and editing actions.
The Graphic toolbar appears when you are viewing a drawing.
An application toolbar (not shown above) displays when application specific commands are
available in certain circumstances.
Main Toolbar
Log Off
Closes your connection to the SmartPlant Explorer web server. While you are not absolutely
required to log off, we recommend that you log off when you have finished using SmartPlant
Explorer. Logging off immediately releases the memory and other server resources required to
support your connection. If you do not log off, the server resources for your connection remain
open for another 20 minutes (the default session timeout), preventing the resources from being
used by another person.
For instructions on changing the default session timeout period, see Change Session Timeout (on
page 13).
29
Toggle Tree Display

Displays or hides the tree view. You may want to hide the tree view when you are viewing a
wide report or if a report and the View Properties window are both active.
Toggle Properties Display

Displays or hides the Properties window.
Select Display Set

Opens a dialog box that allows you to select a display set defined in SmartPlant P&ID.
This command is only available when a drawing is displayed.
Show Favorites
Activates the favorites page in the main view. After the favorites page is active, you can run,
rename, or delete the favorites that you have access to.
You can access your favorites directly from any page by clicking the word Favorites on the
main toolbar, and selecting a favorite from the menu.
Views
Select whether you want to view large icons, small icons, or no icons.
Add SmartPlant Explorer to Your Internet Explorer Favorites

Click to add SmartPlant Explorer to your Internet Explorer Favorites. Note that you should
not use the Internet Explorer Add to Favorites command for this purpose as it can cause
SmartPlant Explorer to time out. Use only this SmartPlant Explorer command.
Report Toolbar
Set Report Result Display Options
If you are viewing a SmartPlant Explorer tabular report, click this command to customize the
Report Results table.
Wrap Text - Makes text extend to multiple lines as needed to fit in the column width.
No Wrap Text - Makes all long text appear on one line.
Set Table Filtering Case Sensitive - Sets case sensitivity for column filtering for the table.
For example, if you define custom filtering for a column using the word Plant, if this option is
on, the filter ignores the word plant.
Reset All Defaults - Returns all table settings that you have altered to the settings used to
create the table.
30
Set Display Criteria

If you are viewing a drawing, click this command to customize the display of drawing
properties and inconsistency indicators. A set of icons above the drawing on the right side
indicates the table options.
Labels - Toggle on or off to display labels in the drawing.
Drawing Borders - Toggle on or off to display the drawing border.
Notes - Toggle on or off to display notes in the drawing.
Errors above severity - Toggle on or off to display errors in the drawing. You can specify the
severity level of the errors that appear.
Warnings above severity - Toggle on or off to display warnings in the drawing. You can
select the severity level of the warnings to appear.
Approved Warnings - Toggle on or off to display approved warnings in the drawing.
Save
Records your changes to the current report or action. If you are saving a new report or action,
but have not defined a name, the Name tab appears. After defining a name, click Save again.
After you save the changes, the software overwrites the original report or action. If you want to
keep the original report or action, use the Save as New
command to create a new report
or action.
If the report or action you are saving is the default for a plant item, you are prompted whether
or not to keep the default setting.
Viewers cannot create new reports. You must have User or Administrator access to create
new reports.
Save as New
Saves the changes that you made to an existing report or Action as a new report or Action.
The software does not change the original report or Action. If you want to change the original
report or Action, use the Save
command.
The Save As New command prompts you for a new report or Action name. When you type the
name, the software removes all existing names associated with the original report or Action
from the new report or Action.
Viewers cannot create new reports or actions. You must have User or Administrator access to
create new reports or actions.
31
Save As Favorite
Saves a copy of the active report, drawing, or page to the Favorites page. Click Show
to display the Favorites page.
Favorites
Put Data in Excel

Moves the Report Results data into a Microsoft Excel workbook. SmartPlant Explorer
automatically writes a Web Query into the workbook that you can use to automatically update the
report in Excel without returning to SmartPlant Explorer.
You must have Microsoft Excel 97 or later loaded on your computer to use this option.
Define New Report

Creates a new SmartPlant Explorer defined tabular report and activates the Definition tab so
you can define the report contents. Be sure to click Save
if you want to keep the report after
you have defined it.
new reports.
Define New Application Report

Creates a new application defined report. For example, you can create a SmartPlant Explorer
report using layouts and filters defined for a SmartPlant P&ID Engineering Data Editor View. Be
sure to click Save
if you want to keep the SmartPlant Explorer report after you have defined it.
This command is disabled if the application you are using does not include application specific
reports.
You cannot define SmartPlant Instrumentation or PDS PID reports using this command.
new reports.
Markup File
Opens the drawing that you are currently viewing in SmartPlant Markup. This command is
only available when you have Intergraph SmartPlant Markup loaded on your computer and you
are viewing a drawing.
32
Move Up
Moves a selected row up in the report definition. Moving a row up in the definition moves the
corresponding column to the left in the report. This toolbar command is only available when you
select a single row on the Definition tab.
Delete
Deletes the selected row or rows from the report definition. This toolbar command is only
available when you select rows on the Definition tab.
Deleting a row cannot be undone. You have to redefine the row or exit the report without
saving your changes if you change your mind.
Move Down
Moves a selected row down in the report definition. Moving a row down in the definition moves
the corresponding column to the right in the report. This toolbar command is only available when
you select a single row on the Definition tab.
Graphic Toolbar
Set Colors
Sets the background, selected item, and highlight colors on a drawing. The background color
selection is valid for only the active drawing. The selected item and highlight colors are saved on a
per session basis. That is, each drawing you view until you log off uses the selected item and
highlight color you select.
You can set the default selected item and highlight colors for the software by having your system
administrator to edit the settings.js file that is found where you installed SmartPlant Explorer in
the folders\SmartPlant\Explorer\Web Server. See Color Table Reference (ColorTable.htm) for
more information on available colors.

You can define different color settings for SmartPlant and PDS P&ID drawings.
Zoom In
Increases the drawing view magnification so you can better see details in the drawing. You
remain in zoom in mode until you right-click, click Select
, or press Esc.
33
Zoom Out
Decreases the drawing view magnification so you can better see the overall drawing. You
remain in zoom out mode until you right-click, click Select
, or press Esc.
Fit
Resets the drawing view magnification so you can see the entire drawing.
Pan
Repositions the drawing so you can see another drawing area without changing the view
magnification. You remain in pan mode until you right-click, click Select
, or press Esc.
Zoom Area
Increases the drawing view magnification of an area that you define with two points.
Magnify
Activates a second window that displays the immediate area around your cursor with
increased magnification. You can transfer what is displayed in the second magnification window
to the main window by pressing the SHIFT key and clicking in the main window. The magnification
level of the window is controlled by scroll bar on the right side. Move the scroll bar up to decrease
the magnification. Move the scroll bar down to increase the magnification.
Previous View
Provides a graphic undo for the last view manipulation. You cannot undo more than one
operation.
34
Select
Activates the Select mode. When in Select mode, you can click an item in the drawing to view
that item's properties. Right-click on an item to view the context menu for that item. You can use
Select to exit the continuous zoom and pan modes.
Application Toolbar
Engineering Project
Filters the report results to include only those items in the engineering project. You can use the
Include As-Built
command to view both the engineering project data and the as-built project
data in the same report.
This command is only available when you are logged in as a SmartPlant Instrumentation
Engineer user, and you are running a report from an Engineering Project Plant in an
Owner/Operator domain.
Include As-built
Reruns the active report to include the plant as-built information. SmartPlant Explorer then
filters the report results to create a comparison report between the plant engineering project data
and the plant as-built data.
You can use the Engineering Project
data.
command to view only the plant engineering project
This command is only available when you are logged in as a SmartPlant Instrumentation
Engineer user, and you are running a report from an Engineering Project Plant in an
Owner/Operator domain.
By default, the as-built items appear in blue in the report for all users. If you prefer another
color for the as-built items, ask your system administrator to edit the c:\Program
Files\SmartPlant\Explorer\Web Server\settings.js file. See Color Table Reference
(ColorTable.htm) for more information on available colors.
35
36
SECTION 4
Favorites
A Favorite is a one-click way to run a SmartPlant Explorer report, to display a drawing, or to show
item types without having to navigate down through the tree view to a specific point. The favorite
does all of the necessary connections for you. Favorites are located on the Favorites page, which
on the main toolbar. You also can activate a
you can access by clicking Show Favorites
favorite from any page by selecting the word Favorites from the toolbar, and then selecting the
favorite from the menu.
You can add SmartPlant Explorer to your Internet Explorer Favorites. You can then use
SmartPlant Explorer Favorites command to access a drawing or report that you need.
Similar to reports, the ability to save, rename, and delete a favorite is based on user access level.
Viewers can open favorites and display favorite properties. Users can open, rename, and delete
favorites for those reports and drawings that they can edit. Administrators can open, rename, and
delete any favorite.
Access to an individual favorite is based initially on the report or drawing access that the favorite
was saved. For example, if you define a report that is only available to yourself, the favorite saved
for that report would only be available to you. If the report is available to everyone is a specific
group, then the favorite is available to everyone in that group. You can change the access rights to
the favorite by using the Access tab on the favorite properties dialog box.
Access Tab (Favorite)

Specifies the users who can run this Favorite.
You must own the Favorite to define new access privileges for it.
Make the favorite available only to myself - Select this option to make the favorite available
only to yourself. No other users can see this favorite.
Make the favorite available only to this user - Select this option to make the favorite available
only to one specified user. Only the user that you specify can see and run this favorite.
Make the favorite available to all users in the following roles - Select this option to make the
favorite available to all users in the roles that you specify. Only users in the roles that you specify
can see and run this favorite.
Add Role - Adds a role to the list of roles that can see and run this favorite. Select the All Roles
option to add all the currently defined roles to the list.
Delete Selected Role - Removes the selected role from availability to run this favorite.
Delete All Roles - Removes all listed roles from availability to run this favorite.
Make the favorite available to all users - Select this option to make the favorite available to all
users in all roles. The favorite is even available to users and roles that you may add in the future.
37
Favorites
Create a Favorite
1. Navigate to the report, graphic report, drawing, or item type page that you want to create a
favorite for.
.
2. Click Save as Favorite
3. Select a language for the favorite name. The default language is the Internet Explorer default
language.
4. Type a name for the favorite. The suggested name is comprised of the application,
connection, item type, and current page title.
5. Click Add Name.
6. Click OK.
You must have User or Administrative access to create a favorite.

Use slashes [ / ] in the name where you want the favorite name to wrap on the Favorites page.
If you do not include slashes, the name wraps where necessary according to the space
available. If you want a slash in the name, use two slashes. The slash is also used to define
where a new submenu occurs on the Favorites menu.
You can create one name for the favorite per language.
Rename a Favorite
1.
2.
3.
4.
5.
6.
7.
Click Show Favorites .

Right-click the favorite that you want to rename.
Select Rename from the menu.
Select the language of the name that you want to change.
Edit the name.
Click Update Name.
Click OK.
You must have User or Administrative access to rename a favorite. Users can only rename
favorites that they have created.
Use slashes [ / ] in the name where you want the favorite name to wrap. If you do not include
slashes, the name wraps where necessary according to the space available. If you want a
slash in the name, use two slashes.
38
Favorites
Save As IE Favorite
This option allows you to add SmartPlant Explorer to your Internet Explorer favorites.
1.
2.
3.
4.
Click Add SmartPlant Explorer to Internet Explorer Favorites

.
On the Add Favorite dialog box, type a name for the Internet Explorer favorite.
Select a folder for the favorite.
Click OK.
Do not use the Internet Explorer menu command or toolbar icon to add a page to the Internet
Explorer favorites. Use only the method described in this procedure.
Edit Access to a Favorite

1.
2.
3.
4.
5.
6.

Right-click the favorite to edit access for.
Select Favorite Properties from the menu.
Select the Access tab.
Modify the Favorites access rights as needed.
Click OK.
Delete a Favorite
1.
2.
3.
4.

Right-click the favorite that you want to delete.
Select Delete from the menu.
Click Yes to confirm that you want to delete this favorite.
You must have User or Administrative access to delete a favorite. Users can only delete
favorites that they created.
Display Favorite Properties

1. Click Show Favorites .
2. Right-click the favorite that you want to view properties for.
3. Select Favorite Properties from the menu.
Favorite properties display the SmartPlant Explorer module, connection, item type, and
favorite names used to create the favorite. The names of users or roles that have access to the
favorite also display.
39
Favorites
Administer Favorites
This feature allows a SmartPlant Explorer Administrator to manage all the existing favorites that
have been created on the current web server. Users who do not have administrative privileges do
not have access to this feature. Administrators can view all the existing favorites that are
organized in a table. It is possible to filter the data in the table and perform a number of actions
with the existing favorites.
1. In the SmartPlant Explorer tree view, right-click SmartPlant Explorer Web Server.
2. On the shortcut menu, click Favorites Administration to open the SmartPlant Explorer
Favorites page.
3. To filter the data display on the SmartPlant Explorer Favorites page, do one or more of the
following:
From the Application list, select an application module or filter according to SmartPlant
Explorer actions.
Under Connection, type a value that shows where a favorite points to.
Under Class, type a value that shows the tree hierarchy level that a favorite belongs to.
From the Users list, select a user's group level assigned to a favorite.
Under Favorite Page Name, type a name according to which you want to filter the
display.
4. Right-click a favorite page name or click the row select buttons and then on the shortcut menu
click one of the following commands:
Open opens the selected favorite page (you must have appropriate access rights to
open a page)
Delete deletes the selected favorite
Favorite Properties allows you to view the properties of a favorite
Rename renames the favorite page
Save as IE Favorite saves the selected favorite as an Internet Explorer favorite
40
You can use the Tab key to apply the filter you entered under Connection, Class, and
Favorite Page Name.
You can select multiple rows by holding down Ctrl or Shift keys and clicking the rows.
SECTION 5
Actions
Actions are calls to other web applications that pass data gathered by SmartPlant Explorer to the
other applications. The receiving application must support Universal Resource Locator (URL)
calls. You can define new Actions by right-clicking the plant item you want to assign an Action to
and clicking Action > New on the command menu.
To run an action, right-click the plant item, and then select the Action to run from the menu.
You must have Administrative access to create, modify, or delete external page type
actions.
URL Tab
Specifies the Uniform Resource Locator (URL) of an external application that you want to call and
where you want the external application to appear.
You must have SmartPlant Explorer Administrator permissions to define URL settings.
URL of External Page to Call Type the URL to the external application page that you want to
call. Refer to the external application documentation for the correct URL address. If calling another
SmartPlant Explorer module, you can use relative paths to files under the SP Explorer hierarchy
(for example, ..\applications\speintools\intermodule.asp).
Open in - Specifies where the external web page appears.
The Main Frame of SPEx The external application appears in the main frame of
SmartPlant Explorer. The main frame is to the right of the tree view where reports appear.
Using this option, you can still access the tree view and main toolbar of SmartPlant Explorer.
The Current Internet Explorer Window The external application replaces SmartPlant
Explorer in the active Internet Explorer window. Using this option, you must click Back to
return to SmartPlant Explorer.
A New, Independent Window The external application appears in a new Internet Explorer
window with all of the Internet Explorer toolbars you current have displayed. Using this option,
you have full access to both SmartPlant Explorer and the external application.
A New, Independent Window with only a Title Bar The external application appears in a
new Internet Explorer window without any toolbars. Using this option, you have full access to
SmartPlant Explorer.
A Hidden Window The external application runs in a hidden Internet Explorer window. Use
this option when you need to complete an action, like displaying a dialog box in the external
application, but you do not need to see anything in the web page that starts the process.
Preview - Displays the URL and parameters as you have currently defined them.
41
Actions
Parameters Tab
Specifies constants and parameters that you need to pass to the external application. Refer to the
external application documentation for a listing of available parameters and acceptable values.
You must have SmartPlant Explorer Administrator access privileges to define parameter
settings.
Table/Parameter - Specifies whether you want to pass a database table or a parameter constant
to the external application. To pass a parameter, select CONSTANT. Otherwise, select the
database table from which you want to pass an attribute to the external application.
Attribute/Parameter Value - Specifies the parameter value to pass or the database table
attribute to pass depending on what you selected in the Table/Parameter box.
For a parameter, type the parameter value to pass. See the documentation of the external
application for a list of acceptable values.
For a database table attribute, select the attribute to pass from the list.
Parameter Name - Specifies the parameter name to pass. The parameter name cannot contain
spaces.
Preview - Displays the URL and parameters as you have currently defined them.
Name Tab (Action)

This tab defines a name for the action.
You must have SmartPlant Explorer Administrator or User access privileges to define
Name settings.
Language - Specifies the language for the action name. The name that you type displays only
when the browser of the user is set to this language. If the action does not have a name defined for
the language requested by the user, the English name of the action displays. Actions can have
one name defined for each language.
Name - Type a name for this action. If you want to place the action name on a submenu, type a
slash (/) in the name. For example, to see Reports > Instrument Index on the menu, type
Reports/Instrument Index. If you want a slash in the action name, use two slashes. For example,
for I/O Report, type I//O Report. The Name field is not available until you select a Language.
You cannot use caret (^), single quote ('), or double quote (") characters in a name.
Add Name - Assigns the name specified in the Name field to the list of existing names for this
action.
Update Name - Replaces the existing name specified for the selected language in the list of
existing names for this action.
Delete Name - Removes the name specified in the Name field.
Existing Names for This Action - Displays all names currently associated with this action. The
language abbreviation for each name appears at the end of the name in parentheses. To edit or
delete one of these names, select the corresponding name using the Language option.
42
Actions
Access Tab (Action)

Specifies the users who can run this Action.
You must have SmartPlant Explorer Administrator access privileges to define Action
Access settings.
Make the action available only to myself - Select this option to make the Action available only to
yourself. No other users can see this Action on their menus or run this Action.
Make the action available only to this user - Select this option to make the Action available only
to one specified user. Only the user that you specify can see and run this Action.
Make the action available to all users in the following roles - Select this option to make the
Action available to all users in the roles that you specify. Only users in the roles that you specify
can see and run this Action.
Add Role - Adds a role to the list of roles that can see and run this Action. Select the All Roles
Delete Selected Role - Removes the selected role from availability to run this Action.
Delete All Roles - Removes all listed roles from availability to run this Action.
Make the action available to all users - Select this option to make the Action available to all
users in all roles. The Action is even available to users and roles that you may add in the future.
Applies To Tab (Action)

Specifies where the action can be run.
Applies To settings.
This Action Applies To - Specifies whether the action is associated only to a specific plant or for
all plants. If the action contains attributes that are only available in one plant, the action will not run
in other plants.
Default Action- Specifies that this action is the default action for the specified item. The default
action is the action that runs when you click the item label. The default action is always the first
entry in the menu.
Hidden Action- Specifies to remove this action from the menu. Actions that have been hidden
cannot be accessed and therefore cannot be run. However, you can clear this option later to make
the action available again. Use the Action > List (see "List Actions" on page 44) command to find
hidden actions. Select the action that you want to show, and click Edit (see "Edit Action" on
page 44).
This option is useful when you want to remove an action but do not want to permanently delete it.
43
Actions
Create a New Action

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
Locate the item for which you want to create a new Action.
Right-click the item and select Action > New.
Type the main URL of the external application that you want to call.
Specify where you want the external application opened.
Click the Parameters tab.
Define parameters that you want to pass to the external application.
Click the Name tab.
Select the language for the name.
Type a name for the Action.
Click Add Name.
Click the Access tab.
Specify the users who can see and run this Action.
Click the Applies To tab.
Specify what this Action applies to.
15. Click Save
You must have Administrator privileges to create a new Action.

Refer to the external application documentation for the parameters and values that the
application accepts.
List Actions
1. Open the Action menu from a plant item type.
2. Click Actions > List.
Edit Action
1.
2.
3.
4.
5.
Right-click the plant item type.

On the menu, click Actions > List.
Select the Action you want to edit from the list.
Right-click and select Edit.
Change the Action definition as needed.
6. Click Save
44
Actions
Delete an Action
1.
2.
3.
4.
Open the Action menu from a plant item type.

Click Actions > List.
Select the Action that you want to delete.
Right-click and select Delete.
45
Actions
46
SECTION 6
Explorer Defined Reports

Explorer Defined Reports provide a fast way to view project information. The format, or layout, of
the Explorer Defined Report is fully customizable. You can save the layout definitions to create
custom reports that you can reuse.
Explorer Defined Reports are defined and displayed using tabs:
Report Results - Displays the data in a tabular form. You can do some limited sorting and
filtering of the data on this tab on a per column basis. All users can see this tab.
Definition - Defines what, and how, data displays in the report. Only users with Administrator
or User privileges can view this tab.
Name - Defines the name of the report. Only users with Administrator or User privileges can
view this tab.
Access - Defines who can see the report. Only users with Administrator privileges can view
this tab.
Applies To - Defines the item type or item instance for which you want the report available.
Only users with Administrator or User privileges can view this tab.
You can navigate among the tabs by selecting the tab you want, using the navigation arrows, or by
using CTRL + Page Up or CTRL + Page Down keys. If all tabs do not fit in the available space,
small << and >> arrows appear indicating there are more tabs in that direction.
A toolbar, located on the left side of the window, provides fast access to the report commands.
Some of the default reports delivered with SmartPlant Explorer cannot be modified. Only
the Report Results tab appears for these reports regardless of your access privileges.
Common Tasks for Reports

The following tasks are frequently performed when working with Explorer Defined Reports.
Create a new report for a plant item. For more information, see Create a New Report (on
page 53).
Modify an existing report. For more information, see Edit Report Definition (on page 54).
Define criteria for report data. For more information, see Define Criteria for a Report (on
page 54).
Delete a report. For more information, see Delete a Report (on page 56).
Name a report. For more information, see Name a Report (on page 55).
Delete a report name. For more information, see Delete a Report Name (on page 56).
47
Report Results Tab

The Report Results tab displays the results of the report that you defined or modified. The report
name (Action name) and the origin of the information always appears in the report title.
Note for SmartPlant Instrumentation Users - If you are viewing an item report from a
SmartPlant Instrumentation Owner/Operator domain, you can select whether to see just the
project items, or both the project items and the as-built items. By default, the as-built items appear
in blue in the report. For more information, see Include As- built (see "Include As-built" on
page 35).
Although the report results appear in the defined layout, you can still perform some minor layout
changes to help you review the information. If you right-click a column heading, a menu appears
with the following commands:
Sort - Sorts all information in the column in alphabetical order. Click Sort again to sort the column
in reverse alphabetical order. You can sort only one column at a time. You also can sort the
column by clicking the column heading.
Filter (All) - Turns off any custom filtering that you have defined for the column and displays all
occurrences.
Filter (Custom) - Defines custom filtering criteria that you can apply to the column data. Only data
that meets the specified filtering criteria appears. You can define one or two filtering criteria. If you
define two criteria, you can join them using AND or OR. Use the * wildcard to match multiple
characters.
Filter (Column Listing) - Displays all the values in this column. Select one of the column values
to filter the results by that value.
Hide - Collapses the selected column so you cannot see the column contents. The column is not
entirely hidden so you can unhide the column if needed. This feature is useful if you are viewing a
wide report and want to make the report narrower. You also can use the Toggle Tree Display
command on the toolbar to provide more viewing area for a wide report.
Wrap Text - Specifies whether or not text in the column automatically wraps to the next line when
needed. You can control text wrapping for the entire report at one time by using the Set Report
command.
Result Display Options
Column Properties - Displays the Definition attributes used to define the column data. These
properties values are read-only. If you want to change an attribute, use the Definition tab. For
more information, see Definition Tab (on page 49).
Items to Display - By default, the first 15 items appear. You can change the number of items that
appear by typing in a new number and pressing Tab. To view all items, clear the box and press
Tab.
to view the next group of items.
Click
Click
to view the last group of items.
Click
to view the previous group.
Click
to view the first group of items.
48
Definition Tab
The Definition tab defines the layout, or format, of a report including sort order and filtering for the
data. This tab defines the default format. You can sort and filter a report after it appears by
selecting the column header, similar to Microsoft Excel, on the Report Results (see "Report
Results Tab" on page 48) tab.
Using the Prompt (see "Report Results Tab" on page 48) option, you can dynamically define
search criteria each time that the report is run. This option provides the flexibility to search for
different items with only a single report format.
report layouts.
Quick Report Definition - Allows you to select from a list of all attributes for the selected item
type. After you select the attributes that you want to include in the report, you can modify their
captions, sort their results, and change their criteria on the Definition tab. You can display the
Quick Report Definition dialog box multiple times to define attributes for the report.
Row select button - The leftmost button of the definition table is the row select button. Use the
button to select a row for manipulation. You can select more than one row by holding the Ctrl or
Shift keys when you select rows. Select all rows by clicking the top row select button. Click the top
row select button again to unselect all rows. You can also unselect rows by clicking anywhere
outside the table.
If you have a single row selected, you can move that row up or down in the report definition.
Moving a row up in the definition moves the corresponding column to the left in the results. Moving
the row down in the definition moves the corresponding column to the right in the results. You can
also delete the selected row from the definition. If you have more than one row selected, you can
only delete the selected rows from the definition.
Table - Specifies the database table with the attribute that you want to read from the database and
put into the report. You can change the table by clicking it and selecting another table.
Attribute - Specifies the attribute that you want to read from the database table that you selected in
the Table field. You can change the attribute by clicking it and selecting another attribute.
Attributes that are available only for filtering are identified with an asterisk (*) at the beginning.
Filtering attributes cannot be displayed.
Caption - Specifies the caption or column heading that you want to view in the Report Results grid.
The caption also appears in the Define Search for Report dialog box if you select the Prompt
(see "Report Results Tab" on page 48) option for this row. You can change the caption by
selecting it and typing a new caption. You cannot use the period (.) or colon (:) characters in the
caption.
Display - Specifies if the attribute appears in the Report Results grid.
Sort - Specifies the default sort operation for the report results. You can sort the results differently
after they appear. Three options are available:
Unsorted - The Report Results grid is not sorted based on the attribute.
Sort Ascending - The Report Results grid is sorted in ascending order based on this
attribute.
Sort Descending - The Report Results grid is sorted in descending order based on this
attribute.
If you sort the Report Results grid on more than one attribute, you can control which attribute is
sorted first, second, third, and so forth by changing the order number in the Sort row for that
attribute. To remove sorting on an attribute, click the sort order number and select Unsorted from
the list.
49

Criteria - Specifies the criteria to use to filter the contents of the column. You can define multiple
criteria statements for a single column and can combine the statements using either AND or OR. If
you want to define criteria each time the report runs, select the Prompt (see "Report Results Tab"
on page 48) option. If you select the Prompt option, the Criteria option is disabled.
If you are defining search criteria for a string attribute, you can use wildcards to match one or more
characters in the string. You must use the is like operator to use wildcards. A percent sign (%)
matches zero or more characters in your search. For example, if you specify pa%, the software
finds pan, park, part, panel, and other word that starts with the characters pa.
An underscore ( _) matches a single character. For example, if you specify pi_, the software finds
pid, pit, pip, but not pipe. To search for the underscore or percent sign character in the database,
enclose the underscore or percent sign character in square brackets. For example, specify 100[%]
to find 100% but not 100abc.
You also can use square brackets to search for a single character in a range of characters (for
example, [a-f] matches to a, b, c, d, e, or f) or in a set of characters (for example, [abcdef]). For
example, if you specify pi[a-p], the software finds pid and pip, but not pit.
To search for a character not in a range or set, use a caret (^) character (for example, [â-f] or
[âbcdef]). For example, if you specify pi[â-p], the software finds pit, but not pid or pip.
to activate the criteria definition dialog box.
Click
Currently defined criteria - Displays all the criteria that you have defined for this column. This list
of criteria also appears in the report definition grid after you click OK.
Operator - You can use search operators to narrow your search. Two sets of operators are
available depending on the attribute type for which you are defining the criteria. Operators for
strings, doubles, integers, small integers, and select lists are:
is equal to - Include items with an attribute that exactly matches what you typed in the Value
box.
is not equal to - Include items with attributes that do not match what you typed in the Value
box.
is less than - Include items with attributes that are less than what you typed in the Value box.
is greater than - Include items with attributes that are greater than what you typed in the
Value box.
is less than or equal to - Include items with attributes that are equal to or less than what you
typed in the Value box.
is greater than or equal to - Include items with attributes are equal to or greater than what
you typed in the Value box.
is like - Include items with an attribute that matches what you typed including wildcards a
Value.
Only the is equal to and is not equal to operators are available if the attribute is a
code-listed item (you select a value from a list) or if you use the words Null or Blank as the Value.
The operator automatically changes to is equal to when you enter Null or Blank.
Operators for dates are:
on - Include items with a date that exactly matches what you selected.
not on - Include items with a date that does not match what you selected.
before - Include items with a date that occurs before what you selected.
on/before - Include items with a date that occurs on or before the date you selected.
since - Include items with a date that occurs after what you selected.
on/since - Include items with a date that occurs on or after the date you selected.
50

Value - Specifies the value that you want to compare against. Depending on the criterion for the
attribute type that you are defining, you need to type different types of information. For example, if
the attribute is a double, 12.53 would be a valid Value. However, if the attribute is an integer, 12 is
valid. Use the ToolTips that display over the Value field to determine the type of information
(integer, character string, and so forth) that the attribute requires. Depending on the data type,
some characters are not allowed in the Value field. For example, if the data type is an integer, only
digits, the minus sign (-), and the letters n, u, and l (for null) are valid.
You can use the words Null or Blank to search the database for the word null.
If the attribute is a date, click the Value field to display a calendar to select the date.
NULL - Enters a NULL value in the date Value field.

Clear - Removes the value from the date Value field.
Today - Enters the current date in the date Value field. A red box marks the current date.
OK - Enters the selected date (highlighted in blue) in the date Value field. You can also
double-click on a date to enter it.
Cancel - Dismisses the calendar without selecting a date.
Add Criterion - Adds the specified operator and value to the list of defined criteria.
Update Criterion - Updates a selected criterion when you change the operator, the value, or both.
Delete All Criteria - Deletes all defined criteria from the list.
Delete Selected Criterion - Deletes the selected criterion from the list.
Criteria should be joined using - Specifies whether to join multiple criterion using AND or OR.
You cannot mix AND and OR when defining multiple criteria for a single column.
Use AND if you want all the criteria to match before including the item in the report. This
search is more restrictive than OR.
Use OR if you want only a single criterion to match before including the item in the report.
Prompt - Specifies whether or not SmartPlant Explorer should prompt you for search criteria for
this row each time you run the report. For example, you may want to be prompted for a tag number
or service type when you run the report so only that item or those items in that service appear in
the report results. You do not have to fill in values for all of the attributes prompted for. If you do not
provide a value, no criterion is defined for that attribute when the report is run.
If you select the Prompt option, the Criteria option is disabled. In addition, any criterion that you
defined is deleted from the report definition.
51
Name Tab (Report)

This tab defines a name for the report.
Name settings.
Language - Specifies the language for the report name. The name that you type displays only
when the browser of the user is set to this language. If the report does not have a name defined for
the language requested by the user, the English name of the report displays. Reports can have
Name - Type a name for this report. If you want to place the report name on a submenu, type a
Reports/Instrument Index. If you want a slash in the report name, use two slashes. For example,
report.
existing names for this report.
Existing Names for This Report- Displays all names currently associated with this report. The
Access Tab (Report)

Specifies the users who can run this Report.
You must have SmartPlant Explorer Administrator access privileges to define Report
Access settings.
Make the report available only to myself - Select this option to make the Report available only
to yourself. No other users can see this Report on their menus or run this Action.
Make the report available only to this user - Select this option to make the Report available
only to one specified user. Only the user that you specify can see and run this Report.
Make the report available to all users in the following roles - Select this option to make the
Report available to all users in the roles that you specify. Only users in the roles that you specify
can see and run this Report.
Add Role - Adds a role to the list of roles that can see and run this Report. Select the All Roles
Delete Selected Role - Removes the selected role from availability to run this Report.
Delete All Roles - Removes all listed roles from availability to run this Report.
Make the report available to all users - Select this option to make the Report available to all
users in all roles. The Report is even available to users and roles that you may add in the future.
52
Applies To Tab (Report)

Specifies where the report can be run.
This Report Applies To - Specifies whether the report is associated only to a specific plant or for
all plants. If the report contains attributes that are only available in one plant, the report will not run
in other plants.
Default Report- Specifies that this report is the default report for the specified item. The default
report is the report that runs when you click the item. The default report is always the first entry in
the menu.
Hidden Report- Specifies to remove this report from the menu. Reports that have been hidden
the report available again. Use the Report > List (or Graphic Report > List if this is a graphic
report) command to find hidden reports. Select the report that you want to show, and click Edit.
This option is useful when you want to remove a report but do not want to permanently delete it.
Create a New Report

1. Click Define New Report
on the toolbar.
2. Select the item type for the new report.
3. Define the report contents by selecting the table and the attribute from that table that you want
displayed in each column.
4. Define the sort order, if needed, by clicking sort .
5. Define the search criteria, if needed, by clicking define criteria .
6. Click the Name tab, and name the report.
7. Click the Access tab, and specify who can view the report.
8. Click the Report Results tab to verify that the report layout is acceptable.
9. Click Save
1.
2.
3.
4.
5.
6.
7.
8.
You must have Administrator or User access privileges to create a new report. Users can
create reports only for themselves.
You can view the report that you are defining at any time on the Report Results tab.
Instead of defining search criteria in the report definition, consider using the Prompt option. By
using the Prompt option, users can define what they want to see when the report is run.
If you are not in the report tabs environment, you can create a new report by clicking Report >
New > Explorer Defined on the menu for an item.
Click Define New Application Report
on the Report Toolbar.
Select the item type for the new report.
Select the Filter you want to use.
Select the Layout you want to use.
Click OK.
Click the Name tab and name the report.
Click the Access tab and specify who can view the report.
Click the Report Results tab to verify that the report layout is acceptable.
53

9. Click Save
You must have Administrator or User access privileges to create a new report.
If you are not in the report tabs environment, you can also create a new report by clicking
Report > New > SmartPlant Layout and Filter Defined from the context menu of the item
you want to create a report for.
Edit Report Definition

1. Display the report that you want to modify.
2.
3.
4.
5.
6.
7.
You can sort and filter report information by clicking the column headings on the
Report Results tab.
Click the Definition tab.
Change the sort order, if needed, by clicking sort .
Change the search criteria, if needed, by clicking define criteria .
Click the Name tab to change the name of the report.
Click the Access tab to change who can view the report.
Click the Applies To tab to change what the report applies to.
8. Click Save as New
If the report you are modifying is the default report and you did not modify the Default Action
setting on the Applies To tab, the software asks you if this new report is to become the new
default report.
You must have administrator or user access privileges to modify a report. Users can only
modify reports that belong to them.
You can view the report that you are modifying at any time on the Report Results tab.
Define Criteria for a Report
54
1.
2.
3.
4.
5.
6.
Click the Definition tab.

Click define criteria
in the row for which you want to define criteria.
Select the type of comparison to perform in the Operator list.
Type the value to compare against.
Click Add Criterion.
Click OK.
You must have Administrator or User access privileges to define criteria for a report.
You can join multiple criteria statements using AND or OR (see "Definition Tab" on page 49).
Name a Report
1.
2.
3.
4.
5.
Display the report that you want to name.

Click the Name tab.
Select the language for the name.
Type the name for the report for the selected language.
Click Add Name.
6. Click Save
You must have Administrator or User access privileges to name a report.

The same report can have different names in different languages but only one name per
language.
If you add a slash (/) to the report name, all text after the slash appears on a sub-menu. If you
want a slash in the report name, use two slashes (//). When the report is run, only the text after
the last single slash is shown as the title of the report.
You can delete an existing report name by selecting the language and clicking Delete Name.
Set Report Access to Yourself

1. Display the report you want to modify.
2. Click the Access tab.
3. Select Make report available only to myself.
4. Click Save
You must have Administrator access privileges to modify report access.
Set Report Access to a Single User

1.
2.
3.
4.
Display the report for which you want to modify access.

Select Make report available only to this user.
Type the Windows logon user name.
5. Click Save
55
Set Report Access to Specified Roles

1.
2.
3.
4.
5.
Display the report for which you want to modify access.

Select Make the report available to all users in the following roles.
Select the role for which you want the report available.
Click Add Role.
6. Click Save
Delete a Report
1.
2.
3.
4.
Click Report > List on the plant item menu associated with the report.
Select the report that you want to delete from the list.
Confirm that you want to delete the report (Action).
You must have Administrator or User access privileges to delete a report. Users can only
delete reports that belong to them.
You cannot recover a report after you delete it. To remove a report temporarily, select Hidden
Action on the Applies To (Report) (see "Applies To Tab (Report)" on page 53) tab.
Delete a Report Name

1.
2.
3.
4.
5.
6.
Click Report > List on the item type menu associated with the report.
Click the report that you want to edit from the list.
Click Edit.
Click the Name tab.
Select the language with the name that you want to delete.
Click Delete Name.
7. Click Save.
56
You must have Administrator or User access privileges to delete a report name.
If you are a User, you must own the report to delete a report name.
Reports can have only one name per report per language.
All Reports must have at least one name.
Optionally, you can run the report to display the Name tab instead of using Report > List.
SECTION 7
Graphic Reports
Graphic Reports provide a quick way to view only those items in a drawing that you want to see.
You can save the definitions to create custom graphic reports that you can reuse. When you
create a graphic report for a drawing, an entry for the graphic report appears on that drawing's
command menu. To run a graphic report, right-click the drawing, then select the graphic report to
run.
Graphic Reports are defined using tabs:
Definition - Defines what should display in the drawing. Only users with Administrator or User
privileges can view this tab.
Name - Defines the name of the graphic report. Only users with Administrator or User
privileges can view this tab.
Access - Defines who can see the graphic report. Only users with Administrator privileges can
view this tab.
Applies To - Defines what item type or item instance you want the graphic report available for.
Only users with Administrator or User privileges can view this tab.
You can navigate between the tabs by selecting the tab you want, using the navigation arrows, or
by using CTRL + Page Up or CTRL + Page Down keys. If all tabs cannot be displayed in the
available space, small << and >> arrows display indicating there are more tabs in that direction.
A toolbar for reports, located on the left side, provides quick access to the report commands.
Viewing a drawing uses the Graphic Report page displaying only the Display tab.
If you are editing a Graphic Report and not actually running the report against a drawing, the
Display tab is not available.
As with the tabular report page, the tabs that appear depend on your access level. Viewer see
only the Display tab. Users see all tabs but the Access tab. Administrators see all tabs.
Definition (Graphic Reports)

The Definition tab defines the criteria to use to select which items display in the graphic report
(drawing).
criteria.
Row select button - The leftmost button of the definition table is the row select button. Use the
button to select a row for manipulation. You can select more than one row by holding the Ctrl or
Shift keys when you select rows. Select all rows by clicking the top row select button. Click the top
row select button again to unselect all rows. You can also unselect rows by clicking anywhere
outside the table.
If you have a single row selected, you can move that row up or down in the report definition. You
can also delete the selected row from the definition. If you have more than one row selected, you
can only delete the selected rows from the definition.
Table - Specifies the database table with the attribute that you want to read. You can change the
table by clicking it and selecting another table.
57
Graphic Reports
Attribute - Specifies the attribute that you want to read from the database table that you selected
in the Table field. You can change the attribute by clicking it and selecting another attribute.
Attributes that are available only for filtering are identified with an asterisk (*) at the beginning.
Filtering attributes cannot be displayed.
Criteria - Specifies the criteria to use to filter the contents of the column. You can define multiple
criteria statements for a single column and can combine the statements using either AND or OR.
If you are defining search criteria for a string attribute, you can use wildcards to match one or more
characters in the string. You must use the is like operator to use wildcards. A percent sign (%)
matches zero or more characters in your search. For example, if you specify pa%, the software
finds pan, park, part, panel, and other words that start with the characters pa regardless of how
many characters follow (zero or more characters).
An underscore ( _) matches a single character. For example, if you specify pi_, the software finds
pid, pit, pip, but not pipe. To search for the underscore or percent sign character in the database,
enclose the underscore or percent sign character in square brackets. For example, specify 100[%]
to find 100% but not 100abc.
You also can use square brackets to search for a single character in a range of characters (for
example, [a-f] matches to a, b, c, d, e, or f) or in a set of characters (for example, [abcdef]). For
example, if you specify pi[a-p], the software finds pid and pip, but not pit.
To search for a character not in a range or set, use a caret (^) character (for example, [â-f] or
[âbcdef]). For example, if you specify pi[â-p], the software finds pit, but not pid or pip.
to activate the criteria definition dialog box.
Click
Currently defined criteria - Displays all the criteria that you have defined for this column. This list
of criteria also displays in the report definition grid after you click OK.
Operator - You can use search operators to narrow your search. Two sets of operators are
available depending on the attribute type for which you are defining the criteria. Operators for
strings, doubles, integers, small integers, and select lists are:
is equal to - Include items with an attribute that exactly matches what you typed for a Value.
is not equal to - Include items with attributes that do not match what you typed for a Value.
is less than - Include items with attributes that are less than what you typed for a Value.
is greater than - Include items with attributes that are greater than what you typed for a
Value.
is less than or equal to - Include items with attributes that are equal to or less than what you
typed for a Value.
is greater than or equal to - Include items with attributes are equal to or greater than what
you typed for a Value.
is like - Include items with an attribute that matches what you typed including wildcards for a
Value.
Only the is equal to and is not equal to operators are available if the attribute is a
code-listed item (you select a value from a list) or if you use the words Null or Blank as the Value.
The operator automatically changes to is equal to when you enter Null or Blank.
Operators for dates are:
on - Include items with a date that exactly matches what you selected.
not on - Include items with a date that does not match what you selected.
before - Include items with a date that occurs before what you selected.
on/before - Include items with a date that occurs on or before the date you selected.
since - Include items with a date that occurs after what you selected.
on/since - Include items with a date that occurs on or after the date you selected.
58
Graphic Reports
Value - Specifies the value you want to compare against. Depending on the criterion for the
attribute type that you are defining, you need to type different types of information. For example, if
the attribute were a double, 12.53 would be valid Value. However, if the attribute is an integer, 12
is valid. Use the ToolTips that display over the Value field to determine the type of information
(integer, character string, and so forth) that the attribute requires. Depending on the data type,
some characters are not allowed in the Value field. For example, if the data type is an integer, only
digits, the minus sign (-), and the letters n, u, and l (for null) are valid.
You can use the words Null or Blank to search the database for the word null.
If the attribute is a date, click the Value field to display a calendar to select the date.
NULL - Enters a NULL value in the date Value field.

Clear - Removes the value from the date Value field.
Today - Enters today's date in the date Value field. A red box marks Today's date.
OK - Enters the selected date (highlighted in blue) in the date Value field. You can also
double-click on a date to enter it.
Cancel - Dismisses the calendar without selecting a date.
Add Criterion - Adds the specified Operator and Value to the list of defined criteria.
Update Criterion - Updates a selected criterion when you change the Operator, the Value, or
both.
Delete All Criteria - Deletes all defined criteria from the list.
Delete Selected Criterion - Deletes the selected criteria from the list.
Criteria should be joined using - Specifies whether to join multiple criterion using AND or OR.
You cannot mix AND and OR when defining multiple criterion for a single column.
Use AND if you want all the criteria to match before including the item in the report. This
search is more restrictive than OR.
Use OR if you want only a single criterion to match before including the item in the report.
Display Drawing with - Specifies how you want to view the resulting items. You can select to
display all items in the drawing and highlight only the items that match the search criteria, or you
can have only the items that match the search criteria display.
59
Graphic Reports
Name Tab (Report)

This tab defines a name for the report.
Name settings.
Language - Specifies the language for the report name. The name that you type displays only
when the browser of the user is set to this language. If the report does not have a name defined for
the language requested by the user, the English name of the report displays. Reports can have
Name - Type a name for this report. If you want to place the report name on a submenu, type a
Reports/Instrument Index. If you want a slash in the report name, use two slashes. For example,
report.
existing names for this report.
Existing Names for This Report- Displays all names currently associated with this report. The
Access Tab (Report)

Specifies the users who can run this Report.
You must have SmartPlant Explorer Administrator access privileges to define Report
Access settings.
Make the report available only to myself - Select this option to make the Report available only
to yourself. No other users can see this Report on their menus or run this Action.
Make the report available only to this user - Select this option to make the Report available
only to one specified user. Only the user that you specify can see and run this Report.
Make the report available to all users in the following roles - Select this option to make the
Report available to all users in the roles that you specify. Only users in the roles that you specify
can see and run this Report.
Add Role - Adds a role to the list of roles that can see and run this Report. Select the All Roles
Delete Selected Role - Removes the selected role from availability to run this Report.
Delete All Roles - Removes all listed roles from availability to run this Report.
Make the report available to all users - Select this option to make the Report available to all
users in all roles. The Report is even available to users and roles that you may add in the future.
60
Graphic Reports
Applies To Tab (Report)

Specifies where the report can be run.
This Report Applies To - Specifies whether the report is associated only to a specific plant or for
all plants. If the report contains attributes that are only available in one plant, the report will not run
in other plants.
Default Report- Specifies that this report is the default report for the specified item. The default
report is the report that runs when you click the item. The default report is always the first entry in
the menu.
Hidden Report- Specifies to remove this report from the menu. Reports that have been hidden
the report available again. Use the Report > List (or Graphic Report > List if this is a graphic
report) command to find hidden reports. Select the report that you want to show, and click Edit.
This option is useful when you want to remove a report but do not want to permanently delete it.
Create a New Graphic Report

1.
2.
3.
4.
5.
Display the drawing on which you want to base your graphic report.
Click Define New Report .
Select the item type for your new report.
Click OK.
On the Definition tab, select the tables and attributes for the item type, and then define the
criteria for your report.
6. Click the Name tab and name the report.
7. Click the Access tab and specify who can view the report.
8. Click Save
You must have Administrator or User access privileges to create a new report.
You can also create a new graphic report using Graphic Reports > New command on the
Drawing
item type.
Edit Graphic Report Definition

1.
2.
3.
4.
5.
6.
7.
8.
9.
Right-click the Drawing

item type icon to display the context menu.
Select Graphic Reports > List from the context menu.
Click the graphic report you want to edit from the list of graphic reports.
Right-click and select Edit.
Click the Definition tab if not already active.
Edit the definition as needed. Change the search criteria by clicking .
Click the Name tab to change the name of the report.
Click the Access tab to change who can view the report.
Click the Applies To tab to change what the report applies to.
61
Graphic Reports
10. Click Save
or Save as New
You must have Administrator or User access privileges to modify a report.
Delete a Graphic Report
62
1.
2.
3.
4.
Right-click the Drawing

item type icon to display the context menu.
Select Graphic Reports > List from the context menu.
Click the graphic report you want to delete from the list of graphic reports.
You must have Administrator or User access privileges to delete a report.

You cannot recover a report after you delete it. To remove a report temporarily, use the
Hidden Action option on the Applies To tab.
SECTION 8
Navigating Between Modules

You can define actions in one SmartPlant Explorer module to activate another SmartPlant
Explorer module. This feature is useful when you want to view the same item in another module.
For example, you are viewing an equipment report in the SmartPlant PID Module and want to see
if a particular piece of equipment is defined in a model in the PDS 3D Module.
Because each application that SmartPlant Explorer explores has different item types, the
intermodule communication feature maps item types in each module to item types in the other
modules. You need to know this item type mapping when defining the actions.
When calling the PDS PID module from either the SmartPlant PID or SmartPlant Instrumentation
modules, the following item type mappings are used:
PDS PID Module
SmartPlant PID
Module
SmartPlant Instrumentation Module
InstrComponent
Instrument
Tag, Pressure, ReliefValve, Flow,

Level, Temperature, ControlValve
InstrLoop
InstrLoop
Loop
PipingSegment
PipeRun
PipingComponent
PipingComp
EquipGroup
Equipment,
Exchanger,
Mechanical,
EquipmentOther,
Vessel
EquipComponent
EquipComponent
EquipNozzle
Nozzle
PipingConnector
OPC
Drawing
Drawing
Equipment
Document
InstrAccessory
InstrConnector
When calling the SmartPlant PID Module from either the PDS PID or SmartPlant Instrumentation
modules, these item type mappings are used:
SmartPlant PID
Module
PDS PID Module
Instrument
InstrComponent
Tag, Pressure, ReliefValve, Flow,

Level, Temperature, ControlValve
Equipment
EquipGroup
Equipment
InstrLoop
InstrLoop
Loop
63

PipeRun
PipingSegment
PipingComp
PipingComponent
EquipComponent
EquipComponent
Nozzle
EquipNozzle
OPC
InstrConnector,
PipingConnector
Drawing
MasterDrawing,
Drawing
AreaBreak
EquipmentOther
Exchanger
ItemNote
Mechanical
ModelItem
Package
PlantItem
Safety
SignalLine
SignalRun
System
Vessel
When calling the SmartPlant Instrumentation Module from either the SmartPlant PID or PDS PID
modules, the following item type mappings are used:
SmartPlant Instrumentation Module SmartPlant PID Module
PDS PID Module
Tag
Instrument
InstrComponent
Equipment
Equipment,
EquipComponent,
Exchanger, Mechanical,
EquipOther, Vessel
EquipComponent,
EquipGroup
Loop
InstrLoop
InstrLoop
Unit
Unit
Area
Cabinet
Cable
ControlValve
DCS
Device
64

Document
Flow
JunctionBox
Level
Line
MarshallingRack
Panel
PanelStrip
PLC
Pressure
ReliefValve
Temperature
When calling the PDS 3D Module from any of the other modules, the following TypeID numbers
are used:
Item Type
Module
SmartPlant PID
Module
PDS PID Module
Instrument Tag
2 (Tag)
2 (Instrument)
2 (Instrument Comp)
Equipment
3 (Equipment Group)
Pipelines
1 (Line)
1 (Pipe Run)
1 (Piping Segment)
Equipment
Nozzles
4 (Nozzle)
Piping Specialty 6 (Piping Component)

When navigating between modules, there are often situations where the "source" module attribute
does not directly correlate to the "destination" module attribute. For example, for SmartPlant P&ID
instruments, the Measured Variable Code attribute and the Instr Type Modifier attribute do not
correlate to any attributes in the SmartPlant Instrumentation Module. But when the two attributes
are concatenated together, they correspond to the SmartPlant Instrumentation Instrument Type
attribute. To concatenate the attributes, you can run "macros" against the parameters before
defining the criteria for the report on the destination module data. The macros can use named
variables, which are typically populated using source module attributes.
When defining the intermodule action, if the parameter name is bracketed using square brackets,
it is assumed to be a name variable that can be used in macros delivered by SmartPlant Explorer.
The Table and Attribute columns should contain a valid source attribute. The value of the source
attribute on the selected item is placed in the named variable when the intermodule action is run.
The following macros are supported:
SPEFormat(<string>) - The <string> argument is just treated as a string and can contain
named variables. When the intermodule page is run, the named variables are replaced by the
values from the source module.
SPEVal(<VBScript code>) - The <VBScript code> is assumed to be valid VBScript code that
generates a string. It can contain named variables. When the intermodule page is run, the
named variables are replaced by the values from the source module.
65
You can write your own VBScript functions in the file ..\Web
Server\ASP\include\IntermoduleCustom.inc in the SmartPlant Explorer product folder. You
should regularly backup this file, especially when installing a new version of SmartPlant
Explorer.
Example for SPEFormat
This is an example of an action on the SmartPlant Instrument type that uses the Measured
Variable Code attribute and Instr Type Modifier to find SmartPlant Instrumentation tags with the
corresponding SmartPlant Instrumentation Instrument Type attribute. The SmartPlant
Instrumentation Instrument Type attribute is typically two characters (example "FE"). The first
character corresponds to the SP Measured Variable Code attribute (example "F") and the second
character corresponds to the SP Instr Type Modifier (example "E"). The SPEFormat macro
combines the two named variables [1] and [2] into one string and passes this string as criteria on
the SmartPlant Instrumentation Instrument Type attribute.
Example for SPEVal

This is an example of an action on the SmartPlant Instrumentation Tag type that uses the
Instrument Type attribute find SmartPlant instruments with the corresponding Measured Variable
Code and Instr Type Modifier attributes. The Instrument Type attribute is passed as the named
variable [IT]. The SPEVal macro is used to return the first character of [IT], which is used as
criteria on the SP Measured Variable Code attribute. The SPEVal macro is used again to return
the last character of [IT], which is used as criteria on the SP Instr Type Modifier attribute.
Access the PDS 3D Module from the SmartPlant

Instrumentation Module
You can define an action in the SmartPlant Explorer SmartPlant Instrumentation Module to
activate the SmartPlant Explorer PDS 3D Module's View Models report. This allows you to select
the action on the tag or equipment menu in the SmartPlant Instrumentation Module and have
SmartPlant Explorer automatically display the models in which the tag or equipment is located in
the PDS 3D Module. You then select a model to view and SmartPlant Review opens the model,
highlights the item, and zooms in to the item.
You can search for pipelines, equipment, or instrument items in the PDS 3D Module models.
Defining actions for all items is basically the same. Step-by-step instructions for defining an action
for instruments is provided below, with example parameters provided for the other item types.
66

1. Start the SmartPlant Explorer SmartPlant Instrumentation Module.
plant item in the tree view.
Right-click the SmartPlant Instrumentation
On the menu, click View Item Types.
Right-click the tag
item.
On the menu, click Actions > New.
In the URL of external page to call box, type:
http://servername/spe/applications/spe3d/viewmodels.asp
where servername is the name of the SmartPlant web server where the PDS 3D Module is
served.
7. Select the Parameters tab.
8. Define the parameters as shown below where the Attribute/Parameter Value of My Project
Name is the name of the project in the 3D Module. The third parameter, in this example
Component and Tag Number, is the tag attribute that you want to query with. The values in the
Parameter Name column must appear exactly as shown.
2.
3.
4.
5.
6.
9.
10.
11.
12.
Select the Name tab, and define a name.

Select the Access tab, and define the access.
Select the Applies To tab.
Select the option for the current plant only. Do not select All Plants.
13. Click Save
For Equipment
For Pipelines
67
Optional Parameters
Additional optional parameters are available when accessing the PDS 3D Module. If you set
ViewAllModels equal to 1, both .dri and .vue files display in the search results. If you set
DisplayModel equal to 1, if only one model matches the search criteria, SmartPlant Explorer
automatically opens the model in SmartPlant Review. If you set PublisherNode to the computer
name where SmartPlant Review Publisher has deposited files, SmartPlant Explorer looks at that
computer for models. If PublisherNode is not set or set to an empty string, then SmartPlant
Explorer uses the model location specified in the PDS project control database.
Access the PDS 3D Module from the SmartPlant PID

Module
You can define an action in the SmartPlant PID Module to activate the PDS 3D Module's View
Models report. This allows you to select the action on the tag or equipment menu in the
SmartPlant PID Module and have SmartPlant Explorer automatically display the models in which
the tag or equipment is located in the PDS 3D Module. You then select a model to view and
SmartPlant Review opens the model, highlights the item, and zooms in to the item.
You can create these actions automatically by using the Create Model Action command.
The actions created by that command can be edited, if needed, using the information found here.
For more information on the command, see Create Model Actions (on page 70).
You can search for pipelines, equipment, equipment nozzles, instruments, or piping specialty
items in the PDS 3D Module models. Defining actions for all items is basically the same.
Step-by-step instructions for defining an action for instruments is provided below, with example
parameters provided for the other item types.
1. Start the SmartPlant PID Module.
plant item in the tree view.
Right-click the SmartPlant
Right-click the instrument
item.
served from.
Name is the name of the project in the PDS 3D Module. The third parameter, in this example
Plant Item and Item Tag, is the tag attribute that you want to query with. The values in the
2.
3.
4.
5.
6.
68

9.
10.
11.
12.

13. Click Save
For Equipment
For Equipment Nozzles
For Pipelines
Optional Parameters
69
Create Model Actions

This command creates the intermodule actions needed to view models in the PDS 3D Module that
contain items selected in the SmartPlant PID Module. The command is available on the right-click
menu for SmartPlant PID Module connections (one level below the site in the tree view). The
actions that this command creates can be edited using the information described in Access the
PDS 3D Module from the SmartPlant PID Module (on page 68).
1. Right-click on the SmartPlant PID Module connection.
2. Select Create Model Actions from the right-click menu.
3. Select the PDS 3D Module project that corresponds to your SmartPlant PID Module
connection.
4. Type a name for the Actions that will be created.
5. Select the View All Models option if you want both .vue files and .dri files display for selection.
6. Select the Display Single Model Automatically option if you want the .vue or .dri file to
display automatically if the item is only found in one file.
7. Click OK.
This command is only available to administrators when both the SmartPlant Explorer PDS
3D Module and the SmartPlant Explorer SmartPlant PID Module are installed.
Access the PDS 3D Module from the PDS PID Module

You can define an action in the SmartPlant Explorer PDS PID Module to activate the SmartPlant
Explorer PDS 3D Module's View Models report. This allows you to select the action on the tag or
equipment menu in the PDS PID Module and have SmartPlant Explorer automatically display the
models in which the tag or equipment is located in the PDS 3D Module. You then select a model to
view and SmartPlant Review opens the model, highlights the item, and zooms in to the item.
You can search for pipelines, equipment, equipment nozzles, instruments, or piping specialty
items in the PDS 3D Module models. Defining actions for all items is basically the same.
Step-by-step instructions for defining an action for instruments is provided below, with example
parameters provided for the other item types.
1. Start SmartPlant Explorer.
project item in the tree view.
Right-click the PDS PID
Right-click the instrument component
item.
served from.
2.
3.
4.
5.
6.
70

Name is the name of the project in the 3D Module. The third parameter, in this example Instr
comp and P&ID instr tag no, is the tag attribute that you want to query with. The values in the
9.
10.
11.
12.

13. Click Save
For Equipment
For Equipment Nozzles
For Piping Specialty
For Pipelines
71
Optional Parameters
Access the SmartPlant Instrumentation Module from

the SmartPlant PID Module
You can define an Action in the SmartPlant Explorer SmartPlant PID Module to activate the
SmartPlant Explorer SmartPlant Instrumentation Module's report interface.
1. Start the SmartPlant Explorer SmartPlant PID Module.
2. Right-click a plant item in the tree view.
3. On the menu, click View Item Types.
4. Right-click the item type for which you want to create the action. For example, to search for a
tag in SmartPlant Instrumentation, right-click the instrument item . See the tables in
Navigating Between Modules (on page 63) to know which item types map to which in the
different modules.
5. On the menu, click Actions > New.
6. In the URL of external page to call box, type
http://servername/spe/applications/speintools/intermodule.asp where servername is the
name of the SmartPlant Explorer Web Server the SmartPlant Instrumentation Module is
served.
8. Define parameters as shown below (blue text explicitly, red text replaced as specified below):
where:
site_name is the name of the SmartPlant Instrumentation site that you want to query
domain_name is the name of the SmartPlant Instrumentation domain that you want to
query in the site you specified
72
9.
10.
11.
12.
project_name is the name of the SmartPlant Instrumentation project. If the

domain_name is an EPC domain, this parameter is ignored. If domain_name is an
Owner/Operator domain and you do not pass this argument, "As built" is assumed.
plant_name is the name of the SmartPlant Instrumentation plant that you want to query in
the project you specified
item_type is the item that you want to query in SmartPlant Instrumentation. This
parameter is optional. If you do not specify this parameter, the software uses the tables
specified in Navigating Between Modules (on page 63) to make an educated guess at the
item type.
your_title is title that displays at the top of the resulting report
table_name is the name of the SmartPlant module item type table that you want to match
from
attribute_name is the attribute in the SmartPlant PID Module table_name that you want
to match from
Table.Attribute is the database table and attribute that that you want to query against in
SmartPlant Instrumentation. The Table.Attribute information must be in the correct
syntax, for example: Equipment.Equip Name. The easiest way to get the correct syntax
and spacing is to go to the SmartPlant Instrumentation Module and open a report for the
item type. Change to the Definition tab and view the table and attribute pulldowns.
13. Click Save
Access the SmartPlant Instrumentation Module from

the PDS PID Module
You can define an action in the SmartPlant Explorer PDS PID Module to activate the SmartPlant
Explorer SmartPlant Instrumentation Module's report interface.
1. Start the SmartPlant Explorer PDS PID Module.
in the tree view.
2. Right-click a project
item. See the
tag in SmartPlant Instrumentation, right-click the instrument component
tables in Navigating Between Modules (on page 63) to know which item types map to which in
the different modules.
http://servername/spe/applications/speintools/intermodule.asp where servername is the
name of the SmartPlant Explorer Web Server the SmartPlant Instrumentation Module is
served from.
73

9.
10.
11.
12.
where:
site_name is the name of the SmartPlant Instrumentation site that you want to query
domain_name is the name of the SmartPlant Instrumentation domain that you want to
query in the site you specified
project_name is the name of the SmartPlant Instrumentation project. If the
domain_name is an EPC domain, this parameter is ignored. If domain_name is an
Owner/Operator domain and you do not pass this argument, "As built" is assumed.
plant_name is the name of the SmartPlant Instrumentation plant that you want to query in
the project you specified
item_type is the item that you want to query in SmartPlant Instrumentation. This
parameter is optional. If you do not specify this parameter, the software uses the tables
specified in Navigating Between Modules (on page 63) to make an educated guess at the
item type.
table_name is the name of the PDS PID item type table that you want to match from
attribute_name is the attribute in the PDS PID table_name that you want to match from
SmartPlant Instrumentation. The Table.Attribute information must be in the correct
syntax, for example: Equipment.Equip Name or Component.Tag Number. The easiest
way to get the correct syntax and spacing is to go to the SmartPlant Instrumentation
Module and open a report for the item type. Select the Definition tab and look at the table
and attribute columns.
13. Click Save
Access the PDS PID Module from the SmartPlant

Instrumentation Module
You can define an action in the SmartPlant Instrumentation Module to activate the PDS PID
Module's report interface.
1. Start the SmartPlant Explorer SmartPlant Instrumentation Module.
item in the tree view.
2. Right-click a plant
74

4. Right-click the corresponding item type for which you want to create the action. For example,
item. See the
to search for an instrument component in PDS PID, right-click the tag
http://servername/spe/Applications/SPEPDS2D/Intermodule.asp where servername is the
name of the SmartPlant Explorer Web Server the PDS PID Module is served from.
9.
10.
11.
12.
where:
project is the name of the PDS PID project that you want to query
Task specifies whether the project is task or master project. Valid values are Task,
Master, T, and M.
item_type is the item that you want to query in PDS PID. This parameter is optional. If you
do not specify this parameter, the software uses the tables specified in Navigating
Between Modules (on page 63) to make an educated guess at the item type.
table_name is the name of the SmartPlant Instrumentation item type table that you want
to match from
attribute_name is the attribute in the SmartPlant Instrumentation table_name that you
want to match from
PDS PID. The Table.Attribute information must be in the correct syntax, for example:
Equipment.Equip Name. The easiest way to get the correct syntax and spacing is to go to
the PDS PID module and open a report for the item type. Change to the Definition tab and
look at the table and attribute columns.
13. Click Save
Access the PDS PID Module from the SmartPlant PID

Module
You can define an action in the SmartPlant PID Module to activate the PDS PID Module's report
interface.
1. Start the SmartPlant Explorer SmartPlant PID Module.
75

2. Right-click a plant
item in the tree view.
4. Right-click the corresponding item type for which you want to create the action. For example,
item. See the
to search for an instrument component in PDS PID, right-click the instrument
http://servername/spe/Applications/SPEPDS2D/Intermodule.asp where servername is the
name of the SmartPlant Explorer Web Server the PDS PID Module is served from.
9.
10.
11.
12.
where:
project is the name of the PDS PID project that you want to query
Task specifies whether the project is task or master project. Valid values are Task,
Master, T, and M.
item_type is the item that you want to query in PDS PID. This parameter is optional. If you
do not specify this parameter, the software uses the tables specified in Navigating
table_name is the name of the SmartPlant item type table that you want to match from
attribute_name is the attribute in the SmartPlant table_name table that you want to
match from
PDS PID. The Table.Attribute information must be in the correct syntax, for example:
Equip group.Eq group no. The easiest way to get the correct syntax and spacing is to go
to the PDS PID module and open a report for the item type. Change to the Definition tab
and look at the table and attribute columns.
13. Click Save
Linking to PDS PID

You can access the SmartPlant Explorer PDS PID application module from another application
that supports web hyperlinks (for example, Microsoft Excel). You can navigate to a particular
drawing or an item using a URL command line.
76
Linking to a Drawing
To display a drawing, you must specify the SmartPlant Explorer project, type, schema, and
drawing filename or drawing number.
The syntax for displaying a drawing using the drawing filename:
http://server/spe/asp/en/main/PDS2DExternal.asp?project=project&schema=task/master&type=
drawing&drawing_filename=drawing name.pid
where:
server is the SmartPlant Explorer server name
project is the SmartPlant Explorer project name
schema is either task or master
drawing name.pid is the name of the drawing to display
Example:
http://pdsserver/spe/asp/en/main/PDS2DExternal.asp?project=62proj&schema=task&type=draw
ing&drawing_filename=41pi0001.pid
The syntax for displaying a drawing using the drawing number:
drawing&drawing_no=drawing number
where:
server is the SmartPlant Explorer server name
project is the SmartPlant Explorer project name
schema is either task or master
drawing number is the value of the attribute "dgn file no" in the drawing report
Example:
ing&drawing_no=41-E- 0001
Linking to an Item in a Drawing

To display a drawing that contains a particular item, you must specify the item type and the P&ID
tag number. If multiple items with the given tag exist, a list displays from which you can select the
item you want. If the selected item exists on multiple drawings, a list of drawings displays from
which you can select the drawing to display. The drawing automatically displays if the item only
exists in one drawing.
Syntax:
drawing&item_class=class&tag_no=tag
where:
server is the SmartPlant Explorer server name.
project is the SmartPlant Explorer project name.
schema is either task or master.
The values of class and tag can be found in this table:
Item Type
Table
Attribute
Use as item_class
Equipment Group
Equip group
Eq group no
eq_group
Equipment
Component
Equip comp
Eq comp no
eq_comp
77

Equipment Nozzle
Equip nozzle
Eq comp no
eq_nozz
Instrument Accessory Instr comp
Instr comp.P&ID instr tag no instr_accessory
Instrument
Component
P&ID instr tag no
instr_comp
Instrument Connector Instr connector
Connector no
instr_conn
Instrument Loop
Instr loop
Loop no
instr_loop
Piping Component
Piping comp
Piping comp no
piping_comp
Piping Connector
Piping connector
Connector no
piping_conn
Piping
Macrocomponent
Piping
macrocomponent
Piping comp no
piping_macrocomp
Instr comp
Piping Segment
Piping segment
Line no label
piping_seg
Example:
ing&item_class=eq_group&tag_no=38E-105
Linking to an Item
To display a specific item, the type, item class, and P&ID tag number must be specified (in
addition to the type, project and schema.) You can then select an option from the context menu.
Example:
http://pdsserver/spe/asp/en/main/PDS2DExternal.asp?project=62proj&schema=task&type=item
&item_class=eq_group&tag_no=38E-105
where:
server is the SmartPlant Explorer server name.
project is the SmartPlant Explorer project name.
schema is either task or master.
The values of class and tag can be found in this table:
Determine the input value of yourTagValue from
78
Item Type
Table
Attribute
Use as item_class
Document
Document
Name
document
Drawing
Drawing/Master
Drawing
Dgn file no
drawing_name
Drawing
Drawing/Master
Drawing
Drawing no
drawing_no
Equipment Group
Equip group
Eq group no
eq_group
Equipment
Component
Equip comp
Eq comp no
eq_comp
Equipment Nozzle
Equip nozzle
Eq comp no
eq_nozz
Instrument
Accessory
Instr comp
Instr comp.P&ID instr tag

no
instr_accessory
Instrument
Component
Instr comp
P&ID instr tag no
instr_comp

Instrument
Connector
Instr connector
Connector no
instr_conn
Instrument Loop
Instr loop
Loop no
instr_loop
Piping Component
Piping comp
Piping comp no
piping_comp
Piping Connector
Piping connector
Connector no
piping_conn
Piping
Macrocomponent
Piping
macrocomponent
Piping comp no
piping_macrocomp
Piping Segment
Piping segment
Line no label
piping_seg
Unit
Unit
Unit code
unit_code
Unit
Unit
Unit name
unit_name
Unit
Unit
Unit no
unit_no
For example, to display the default Equipment Group report and show the records whose
eq_group_no attribute is 38E- 105, the URL would be:
http://pdsserver/spe/asp/en/main/PDS2DExternal.asp?project=Shoals&schema=Task&type=ite
m&item_class=eq_group&tag_no=38E-105
Access the SmartPlant PID Module from the

You can define an Action in the SmartPlant Instrumentation Module to activate the SmartPlant
Module's report interface.
1. Go to the SmartPlant Explorer SmartPlant Instrumentation Module.
plant item in the tree view to display the
2. Right-click the SmartPlant Instrumentation
context menu.
3. Select View Item Types.
icon. See the tables in Navigating Between
instrument in SmartPlant, right-click the tag
Modules (on page 63) to know which item types map to which in the different modules.
5. Select Actions > New from the menu.
6. Type http://servername/spe/applications/spesp/intermodule.asp for the URL of external
page to call where servername is the name of the SmartPlant Explorer Web Server the
SmartPlant PID Module is served from.
where:
79
9.
10.
11.
12.
site_name is the tree view display name of the SmartPlant P&ID site that you want to
query
plant_name is the name of the plant that you want to query
item_type is the item that you want to query in SmartPlant. This parameter is optional. If
you do not specify this parameter, the software uses the tables specified in Navigating
table_name is the name of the SmartPlant Instrumentation item type table that you want
to match from
attribute_name is the attribute in the SmartPlant Instrumentation table_name table that
you want to match from
Table.Attribute is the database table and attribute that you want to query against in
SmartPlant. The Table.Attribute information must be in the correct syntax, for example:
Equipment.Equip Name. The easiest way to get the correct syntax and spacing is to go to
the SmartPlant PID Module and open a report for the item type. Change to the Definition
tab and view the table and attribute pull downs.
Select the option for the current plant only (do not select All Plants).
13. Click Save
Access the SmartPlant PID Module from the PDS PID

Module
You can define an Action in the SmartPlant Explorer PDS PID Module to activate the SmartPlant
Explorer SmartPlant PID Module's report interface.
1. Go to the SmartPlant Explorer PDS PID Module.
item in the tree view to display the context menu.
2. Right-click a project
3. Select View Item Types.
4. Right-click the item type for which you want to create the action. For example, to search for an
icon. See the tables in
instrument in SmartPlant, right-click the instrument component
Navigating Between Modules (on page 63) to know which item types map to which in the
different modules.
5. Select Actions > New from the menu.
6. Type http://servername/spe/applications/spesp/intermodule.asp for the URL of external
page to call where servername is the name of the SmartPlant Explorer Web Server the
SmartPlant PID Module is served from.
80

9.
10.
11.
12.
where:
site_name is the tree view display name of the SmartPlant P&ID site that you want to
query
plant_name is the name of the plant that you want to query
item_type is the item that you want to query in SmartPlant. This parameter is optional. If
you do not specify this parameter, the software uses the tables specified in Navigating
table_name is the name of the PDS PID item type table that you want to match from
attribute_name is the attribute in the PDS PID table_name table that you want to match
from.
Table.Attribute is the database table and attribute that you want to query against in
SmartPlant. The Table.Attribute information must be in the correct syntax, for example:
Equipment.Equip Name or Component.Tag Number. The easiest way to get the correct
syntax and spacing is to go to the SmartPlant PID Module and open a report for the item
type. Change to the Definition tab and view the table and attribute pull downs.
Select the option for the current plant only (do not select All Plants).
13. Click Save
Navigate Between Modules Using the Intermodule

Navigation Wizard
The Intermodule Navigation Wizard enables you to define an action to navigate between the data
of two applications that have been added in SmartPlant Explorer. You select an application to
which you want to connect and then select a destination application.
You can make the following connections:
From SmartPlant Instrumentation you can connect to SmartPlant P&ID and PDS P&ID.
From SmartPlant P&ID you can connect to SmartPlant Instrumentation.
From PDS P&ID you can connect to SmartPlant Instrumentation and SmartPlant P&ID.
1. Expand the SmartPlant Explorer tree view of any of the following application modules:
SmartPlant P&ID
PDS P&ID
81

2. Expand the tree view of the application that you require to display the connection points of that
application. All plant level nodes in the tree view can be connection points for the
Intermodule Wizard.
3. To open the Intermodule Navigation Wizard, right-click a connection point and then on the
shortcut menu, click Intermodule Wizard and then click the command that suits your
destination application.
4. In the Intermodule Wizard, click Next.

5. On the Select Destination page, select the destination project.
The select list shows the names of the published connection level items with additional
information in parentheses if appropriate. For example, if SmartPlant Instrumentation is your
destination project, the additional information is the site and domain name for the connection
level item.
6. Click Next.
82

7. On the Select Item Type to Match page, select a destination item type from which you want
to navigate. Each application has its own destination item types depending on whether they
are available in the list of item types for the published connections. Here is an example for
SmartPlant Instrumentation destination item types:
8. Click Next.
83

9. On the Select the Attributes to Match page, select the source and destination application
item type attributes that need to be matched. Make the selection by clicking a source and a
destination attribute and then click Match. You can match as many attributes as you
require. The matched attributes appear below the source and destination data
windows. Example:
10. Click Next.
84

11. On the Name Your New Action page, type the text that you want to appear on the report title
bar (the results page) and the menu command that you will use to perform this action. The
software copies the text from the upper text box to the lower as you type your text. Note
these labels do not have to be identical and you can change the text in the lower box if you
require. Example:
12. Click Next.

13. On the final page of the wizard, read the instructions carefully as you are told about the action
that will be created, how to execute, and edit it. Note that these instructions differ depending
on the source and destination applications and the names you choose for the title and menu
command.
14. Do one of the following on the Completing the Intermodule Navigation Wizard page:
Select Edit the new action the check box and then click Finish to create the new action
and immediately edit it.
Click Finish to create the new action, close the wizard, and return to the Show Favorites
page.
85

For more information about editing intermodule actions, see Navigating Between Modules (on
page 63).
86
SECTION 9
PDS 3D Module
The SmartPlant Explorer PDS 3D Module organizes your PDS .dri and .vue files in a web
environment by listing all models available in the PDS Project Control Database. When you select
the model that you want to view, SmartPlant Explorer PDS 3D Module automatically opens
SmartPlant Review and the model file from the project folder appears.
If you use SmartPlant Review Publisher, you are not limited to viewing models from the PDS
project server. SmartPlant Review Publisher reads the .dri files in the PDS project and batch
creates corresponding .vue files for each .dri file. The .vue files are then distributed to servers
anywhere in the world. When you are ready to view your models, SmartPlant Explorer PDS 3D
Module reads the PDS Project Control Database to find which models are associated with the
project, and then gives you the option to view those models that have been distributed to a
particular remote server. So instead of opening the model file from the PDS project server that
may be across the country, you can open the model from your local server while still being
assured that you are viewing the most current model.
SmartPlant Explorer PDS 3D Module also allows you to identify the tag number of an item.
SmartPlant Explorer limits the models that appear to only those models that contain the item
specified. When the selected model is opened, SmartPlant Review automatically locates and
highlights the item for you.
Add a Project (PDS 3D Module)

1.
2.
3.
4.
5.
6.
Right-click the 3D icon

.
Click Add Project.
Type a project name.
Select the Data Source Name (DSN) for the project control database.
Type the user name and password for the project control database.
Enter the Universal Naming Convention (UNC) path to the folder where SmartPlant Review
Publisher has stored the model data.
7. Click Add Project.
The SmartPlant Review model data folder must be shared, and the impersonated user for the
PDS 3D Module must have permission to access the share. See the SmartPlant Review
Publisher help for more information about publishing and distributing models.
You must define the path to the model data folder using a UNC path. An example is,
\\myserver\project).
You must have administrator access privileges to add a project.
You must create the SQL (see "Create a DSN Using SQL Server ODBC Driver" on page 88) or
Oracle (see "Configuration of Oracle Networking Components" on page 88) DSN before you
can add the project.
87
PDS 3D Module
Create a DSN Using SQL Server ODBC Driver

1. Load the ODBC Driver for SQL Server. You can load this ODBC Driver by installing the
newest Microsoft Data Access Components (MDAC) release.
2. Click Start > Settings > Control Panel.
3. Double-click Data Sources ODBC.
4. Click the System DSN tab.
5. Click Add to add your new System DSN.
6. Select SQL Server from the list.
7. Click Finish.
8. Type a name of your new DSN.
9. Define the database server from which you want to read. The description field is optional.
10. Click Next.
11. Define the configuration that the DSN needs to access the SQL Server Database. (The logon
user name sa is a default trusted logon for SQL Server.)
12. Click Next.
13. Define the default SQL Server database for the DSN to access. This database contains your
project data that you want to explore.
14. Click Next.
15. Confirm the default settings on this page.
16. Click Finish.
17. Verify that the displayed information in the ODBC Microsoft SQL Server Setup dialog box is
correct.
18. Click Test Data Source.
19. If you have correctly defined your new DSN, a dialog box appears indicating that the Data
Source test was successful. The new DSN is now ready for SmartPlant Explorer to use.
Configuration of Oracle Networking Components

You must load and configure Oracle SQL*Net on the database server and on the SmartPlant
Explorer server for SmartPlant Explorer to access a project. If the database server and the
SmartPlant Explorer server are the same computer, you still must load and configure Oracle
SQL*Net.
Oracle SQL*Net consists of a client, a listener, and a network adapter, each of which can be
individually selected from within the Oracle loader utility. You must load the SQL*Net listener and
the network adapter (typically TCP/IP) on the database server. You must load the SQL*Net client
and the TCP/IP adapter on the SmartPlant Explorer server. The version of SQL*Net client and
listener must be the same on both computers. When the database server and the SmartPlant
Explorer server are the same computer, you must configure both SQL*Net client and listener.
Please refer to the Oracle documentation for help on installing the Oracle networking
components. You may want to check Intergraph's Knowledge Base (http://smart.intergraph.com)
for additional information.
Any attempts to configure an Oracle ODBC data source rely on a functional SQL*Net
connection.
88
PDS 3D Module
When creating an ODBC data source you are asked for a connect string, and possibly database
user name and password. The connect string is the alias name. If your ODBC driver does not
require that a database user name be specified as part of the data source definition, you are
prompted for a database user name and password when the connection is made.
SmartPlant Explorer takes this into consideration and asks for the database user name and
password.
Creating an Oracle DSN

1.
2.
3.
4.
5.
6.
7.
Click Start > Settings > Control Panel.

Double-click ODBC to open ODBC Data Source Administrator.
Select the System DSN tab.
Click Add to create a new DSN.
Select the Microsoft ODBC for Oracle on the Create New Data Source form.
Click Finish.
Type a new name for the data source. This is user definable, but should be something easy to
remember.
8. Type a description for the data source. This can be left blank.
9. Type a Windows user name that is valid on the database server.
10. Type the alias name in the server field.
11. Click OK.
You can now use the new DSN for connecting to a project in SmartPlant Explorer. If you want to
verify that the ODBC connection is functioning correctly, you can use any application or utility that
allows access a database through ODBCs.
Remove a Project (PDS 3D Module)

1. Right-click the project icon.
2. Select Remove Project.
Removing a project does not delete or affect your application data. You are removing the
ability to view that data from SmartPlant Explorer Web Server.
You must have administrator access privileges to remove a project.
Models Tab (PDS 3D Module)

The Models tab displays the models that you can view using SmartPlant Review. To determine
which models appear, SmartPlant Explorer PDS 3D Module first reads the PDS Project Control
Database to obtain the master list of models. If you selected a server on the Location tab,
SmartPlant Explorer edits the master list of models to include only those models that SmartPlant
Review Publisher distributed to the specified server. SmartPlant Explorer then edits the model list
to include only those models that contain the item, if any, specified in the Item Tag tab. If you have
not specified a server or item, then all models in PDS Project Control Database appear.
Name - Displays the names of the .vue and .dri files in the project. If you selected the View
Models command, the .vue files display if they are available. If the .vue files are not available, the
.dri files display. If you selected the View All Models command, both .vue files and .dri files
display.
Description - Displays the model description.
89
PDS 3D Module
Review Type - Display the review type of the model.
Sort - By default, models are sorted alphabetically by name. You can sort the column in reverse
alphabetical order by clicking
. You can sort only one column at a time.
Items to Display - By default, the first 15 models appear. You can change the number of models
that appear by typing in a new number and pressing Tab. To view all models, clear the box and
press Tab. Click the right arrow to view the next group of models. Click the left arrow to view the
previous group.
Item Tag Tab (PDS 3D Module)

You can use the Item Tag tab to identify the tag number of an item. SmartPlant Explorer then
limits the models that appear on the Models tab to only those models that contain the item that
you specified. When you open one of the models, SmartPlant Explorer automatically locates and
highlights the item for you in SmartPlant Review.
Item Tag - Type the item tag. You must type the exact item tag you want. You cannot use
wildcards.
Item Type - Select the type of item you are looking for.
Location Tab (PDS 3D Module)

You can use the Location tab to identify the location of the models that you want to open.
SmartPlant Explorer limits the models that appear on the Models tab to only those models that
SmartPlant Review Publisher distributed to that location.
If SmartPlant Review Publisher has not published and distributed models for this project,
these options are not available.
Located on the servers specified in the Project Control Database - Specifies that you want to
open models from the server specified in the PDS Project Control Database (PDS table 151).
Located on - Specifies that you want to open models from a different server than was specified in
the PDS Project Control Database. All servers to which SmartPlant Review Publisher has
distributed models appear in the list. Select the server closest to you.
90
If you want to view models on a server to which SmartPlant Review Publisher has distributed
models, you must have Full Control permission to the server share that contains the models.
The Located on option displays a list of servers that is read from the SmartPlant Review
Model Data database. You specified the location of this database using the UNC path to
SmartPlant Review model data box when you added this project to the PDS 3D Module.
SECTION 10

The SmartPlant Instrumentation Module allows you to view and analyze changes to the
SmartPlant Instrumentation database. With Web access, physical and geographical boundaries
are eliminated. Because the instrumentation data is viewed as a Web page, users can easily
navigate among data objects, such as plants, areas, loops, and tags. This ability facilitates tabular
reports, such as instrumentation indexes or wiring lists, and graphical reports such as instrument
loops or point-to-point wiring diagrams. With a single mouse click, data can be transferred to
Microsoft Excel using Microsoft Web Query technology, providing direct access to your plant
information using an Excel spreadsheet.
Administrating SmartPlant Instrumentation Common

Tasks
The following tasks are performed when you administer the SmartPlant Explorer SmartPlant
Instrumentation Module.
Administer sites
Add Sites to SmartPlant Explorer. For more information, see Add a Site (SmartPlant
Instrumentation Module) (on page 92).
Update Sites. For more information, see Update a Site (SmartPlant Instrumentation Module)
(on page 92).
Update the database's administrator password. For more information, see Update Properties
(SmartPlant Instrumentation Module) (on page 93).
Remove Sites from SmartPlant Explorer. For more information, Remove a Site (SmartPlant
Instrumentation Module) (on page 93).
Administer domains
Add Domains to SmartPlant Explorer. For more information, see Add a Domain (see "Add a
Domain (SmartPlant Instrumentation Module)" on page 94).
Update Domains. For more information, see Update a Domain (on page 94).
Define SmartPlant Instrumentation Web Server. For more information, see Define SmartPlant
Instrumentation Web Server (on page 95).
Delete Domains. For more information, see Remove a Domain (see "Remove a Domain
(SmartPlant Instrumentation Module)" on page 94).
Administer plants
Add Plants to SmartPlant Explorer. For more information, see Add a Plant (see "Add a Plant
(SmartPlant Instrumentation Module)" on page 95).
Update Plants. For more information, see Update a Plant (on page 96).
Delete Plants. For more information, see Remove a Plant (on page 96).
91
Add a Site (SmartPlant Instrumentation Module)

Oracle Database
1. Right-click SmartPlant Instrumentation
.
2. Select Add Site.
3. In the Site display name box, type the name to appear in the tree view for the SmartPlant
Instrumentation site.
4. In the Associated document server name box, type the computer name where the
associated documents are located.
5. In the CAD loop server name box, type the computer name where the CAD loops are
located.
6. Select Oracle as the database type.
7. Enter the Oracle Net Service Name for the database.
8. Enter the SmartPlant Instrumentation administrator database user name and password.
SmartPlant Instrumentation uses in_dbamn for the default user name and password for
the administrator database.
9. Click Add Site.
The site server computer name is used to locate documents for reports. You must enter the
actual computer name in the Site server name field or certain reports will fail.
You must add the SmartPlant Instrumentation Application before you can add a SmartPlant
Instrumentation Site.
You must have administrator access privileges to add a site.
Update a Site (SmartPlant Instrumentation Module)

1. Right-click the site icon
.
2. On the menu, click Update Site.
92
You must have Administrator access privileges to update a site.

Update a site in SmartPlant Explorer when you need to show changes in the supporting tables
or in the user-defined fields (UDFs) in the SmartPlant Instrumentation plants of the site.
You do not have to update the domains and plants that belong to the site that you are
updating.
You cannot update a site if there are SmartPlant Explorer users connected to the site.
Update Properties (SmartPlant Instrumentation

Module)
1.
2.
3.
4.
5.
Right-click on the site icon

.
Select Update Properties from the context menu.
Type the new computer name for the associated documents.
Type the new computer name for the CAD loops.
Click Update.
You must republish the site if you need to change the site display name.
Update Administrator Database Password (SmartPlant

Instrumentation Module)
1.
2.
3.
4.
5.
6.
Right-click on the site icon

.
Select Update Administrator Database Password from the context menu.
Type the old database administrator password.
Type the new database administrator password.
Type the new database administrator password again to confirm.
Click Update.
You must republish the site if you need to change the database's administrator user name
or the site display name.
Remove a Site (SmartPlant Instrumentation Module)

.
2. On the menu, click Remove Site.
3. Click Yes to remove the site.
Do not remove a site if you are upgrading to the next version of SmartPlant Explorer or if you
are reinstalling the same version of SmartPlant Explorer. Instead, use the Remove Application
command and save the application data.
The software removes all domains, projects, and plants associated with the site that you are
removing.
Removing a site does not delete or affect your application data in any way. You are removing
the ability to view from SmartPlant Explorer that data.
You must have administrator access privileges to remove a site.
93
Add a Domain (SmartPlant Instrumentation Module)

1.
2.
3.
4.
5.
Right-click the site icon

.
On the menu, click Add Domain.
Select the domain name.
Type the domain database password.
Click Add Domain.
In INtools versions earlier than 5.1, Domains were called Projects. If you want to explore
INtools version 4.2 projects, use the Add Domain command to add your project.
You must add the SmartPlant Instrumentation site before you can add a SmartPlant
Instrumentation domain.
You must have administrator access privileges to add a domain.
Update a Domain
1. Right-click the domain icon
.
2. On the menu, click Update Domain.
You must have administrator access privileges to update a domain.

Update a domain in SmartPlant Explorer when you need to show changes in the supporting
tables or the user-defined fields (UDFs) in the SmartPlant Instrumentation plants of the
domain.
You do not have to update plants that belong to the domain that you are updating.
You cannot update a domain if there are SmartPlant Explorer users connected to the domain.
Remove a Domain (SmartPlant Instrumentation

Module)
1. Right-click the domain icon.
2. On the menu, click Remove Domain.
94
The software removes all plants associated with the domain that you are removing.
Removing a domain does not delete or affect your application data. You are removing the
ability to view from SmartPlant Explorer that data.
You must have administrator access privileges to remove a domain.
Define SmartPlant Instrumentation Web Server

1.
2.
3.
4.
5.
6.
7.
Right-click the domain icon.

On the menu, click Define SmartPlant Instrumentation Web Server.
Select SmartPlant Instrumentation Web Server.
Type the server name.
Type the SmartPlant Instrumentation user name to use.
Type the password for the SmartPlant Instrumentation user name.
Type the profile name of the SmartPlant Instrumentation database if you are working in a
multi-database environment. The profile must be one that appears in the Intools.ini file.
8. Click Test Connection.
At this point, the you may be asked if it is okay to access information not under the pages
control. The test may need to access data across domains and in that case, the security
setting Access data sources across domains (under Miscellaneous) will need to be set
at least to Prompt. You need to click OK.
The Test Connection feature works only with INtools version 05.01.03.08 or later. Earlier
versions of INtools, including 4.3 versions, give incorrect failure notices for the test.
However, if you provide the correct server name, user name, and user name password,
SmartPlant Explorer can still run INtools reports from the earlier versions. Just be sure to
click Add/Update SmartPlant Instrumentation Web Server after entering the server
name and user information.
9. If the test was successful, click Add/Update SmartPlant Instrumentation Web Server.
Refer to your SmartPlant Instrumentation documentation for information on how to setup a

SmartPlant Instrumentation Web Server.
You must specify the SmartPlant Instrumentation Web Server before you can view reports
from SmartPlant Instrumentation in SmartPlant Explorer.
Add a Plant (SmartPlant Instrumentation Module)

Add a Plant
1.
2.
3.
4.
5.
Right-click the domain icon.

On the menu, click Add Plant.
Select the plants that you want to add.
Click Add >.
Click Add Plant.
You must have administrator privileges to add a plant.

The software automatically creates a favorite to the item types page for each plant that you
add.
95
Update a Plant
1. Right-click the plant icon.
2. On the menu, click Update Plant.
You must have administrator privileges to update a plant.

Update a plant in SmartPlant Explorer when you need to show changes in the supporting
tables or the user defined fields (UDFs) of a SmartPlant Instrumentation plant.
You cannot update a plant if there are SmartPlant Explorer users connected to the plant.
Remove a Plant
1. Right-click the plant icon.
2. On the menu, click Remove Plant.
Removing a plant does not delete or affect your application data. You are removing the ability
to view from SmartPlant Explorer that data.
You must have administrator privileges to remove a plant.
Defining SmartPlant Instrumentation Engineer Users

Users who belong to the SmartPlant Instrumentation Engineer role can view both the engineering
project data and the as- built data for a plant in an owner/operator domain.
Users who do not belong to the SmartPlant Instrumentation Engineer role can only view as-built
data in an owner/operator domain.
SmartPlant Explorer SmartPlant Instrumentation Module uses Microsoft Component Services to
define SmartPlant Instrumentation Engineers. You add users using their standard logon
information for the Windows domain. Users can be individual Windows users or Windows user
groups.
Add a User as a SmartPlant Instrumentation Engineer

2. Select the computer on which the SmartPlant Explorer SmartPlant Instrumentation Module is
installed.
96
All SmartPlant Instrumentation Engineer users must also belong to SmartPlant Explorer Web
Server role (Administrator, User, or Viewer) in order to have access to SmartPlant Explorer.
You can add a Windows User Group in addition to individual users.
SECTION 11
SmartPlant Electrical Module

The SmartPlant Electrical Module accesses the information in the SmartPlant Electrical database,
providing search and view capabilities through a logical, hierarchical structure such as
plant-unit. You can quickly locate, query, and display SmartPlant Electrical item properties.
Add a Site Server (SmartPlant Electrical Module)

1. Right-click the SmartPlant Electrical icon
.
2. Click Add Site Server.
3. Type a name for the site as you want it to appear in the tree view. This name is limited to 30
characters and cannot contain quotes ("), ampersand (&), single quote ('), backslash (\), caret
(^), semicolon (;), less than (<), or pipe (|) characters.
4. Type the full UNC path to the SmartPlant site server smartplantv4.ini file, for example,
\\server\site_folder\smartplantv3.ini. You also can use the Browse button to locate the
smartplantv4.ini file on the site server.
The Impersonated User used by SmartPlant Explorer must be an administrator on the

computer where the site smartplantv4.ini file is shared and be granted network login access to
the computer.
In addition to adding users to the SmartPlant Explorer user access control (using Component
Services), all users accessing this SmartPlant Engineering Manager site must be granted
access to the site using SmartPlant Engineering Manager's user access functionality.
Remove a Site Server (SmartPlant Electrical Module)

2. Select Remove Site.
Removing a site does not delete or affect your application data. You are removing the ability to
view that information from SmartPlant Explorer Web Server.
You must have Administrator access privilege to remove a site.
97
SmartPlant Electrical Module
98
SECTION 12
PDS PID Module

The SmartPlant Explorer PDS PID Module organizes your PDS PID design files and data in a web
environment.
If you want to review PDS2D drawings but certain layers need to be turned off (e.g. level
62), you need to do the following:
In the settings.js file, add the appropriate value to the variable PDS_LayersOff, for
example:
// Comma delimited list of layers to always turn off when displaying PDS2D drawings
var PDS_LayersOff = "15,62";
Add a Project (PDS PID Module)

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
Right-click the PDS PID icon

.
Click Add Project.
Type a project name. The software displays this name in the tree view.
Select whether you are connecting to an Oracle or SQL Server PDS database.
For Oracle databases, enter the Oracle alias name, database administrator user name and
password, and the PDS PID database user name and password.
For SQL Server databases, enter the database server name, database name, database
administrator user name and password, and the PDS PID database user name and
password.
Click Next.
Enter the P&ID Task, P&ID Master, Document Task, and Document Master database users.
Type the passwords for the P&ID Task, P&ID Master, Document Task, and Document Master
database users.
Optionally, select which unit attribute to use to identify the unit in the tree view and in report
titles. The default attribute is the unit name.
Optionally, enter the UNC path to your drawing border files if they are not stored in the
standard reference data location.
Click Add Project.
You must have administrator access privileges to add a project.
If one or more of the four possible schemas are not available in the database that you
selected, the software disables the missing item.
The software automatically creates a favorite to the item types page for each project that you
add.
99
PDS PID Module
Update a Project (PDS PID Module)

1.
2.
3.
4.
5.
Right-click the project icon

.
On the menu, click Update Project.
Enter the task and master databases usernames.
Type the passwords for the task and master databases that you want to update.
Optionally, modify which unit attribute to use to identify the unit in the tree view and in report
titles.
6. Optionally, edit the UNC path to your drawing border files if they are not stored in the standard
reference data location.
7. Click Yes.
You must have administrator access privileges to update a project.
Remove a Project (PDS PID Module)

1. Right-click the project icon.
2. Select Remove Project.
100
Removing a project does not delete or affect your application data. You are removing the
ability to view that data from SmartPlant Explorer Web Server.
You must have administrator access privileges to remove a project.
SECTION 13
SmartPlant PID Module

The SmartPlant Explorer SmartPlant PID Module accesses the information in the P&ID database,
providing search and view capabilities through a logical, hierarchical structure such as plant-unit.
You can quickly locate, query, and display P&IDs, as well as associated data created in
SmartPlant P&ID. This module provides for the on-demand conversion of P&ID schematics to a
Web-viewable format. Intelligent data is hyper linked to the graphics, resulting in rapid, enterprise
wide access and display of the P&ID database, with agile window navigation.
Administering SmartPlant PID Module

Add a Site Server (SmartPlant PID Module)
1. Right-click the SmartPlant icon
.
3. Type a name for the site as you want it to appear in the tree view. This name is limited to 30
characters and cannot contain quotes ("), ampersand (&), single quote ('), backslash (\), caret
(^), semicolon (;), less than (<), or pipe (|) characters.
4. Type the full UNC path to the SmartPlant site server smartplantv4.ini file, for example,
\\server\site_folder\smartplantv3.ini. You also can use the Browse button to locate the
smartplantv4.ini file on the site server.
The Impersonated User used by SmartPlant Explorer must be an administrator on the

computer where the site smartplantv4.ini file is shared and be granted network login access to
the computer.
In addition to adding users to the SmartPlant Explorer user access control (using Component
Services), all users accessing this SmartPlant Engineering Manager site must be granted
access to the site using SmartPlant Engineering Manager's user access functionality.
Remove a Site Server (SmartPlant PID Module)

2. Select Remove Site.
Removing a site does not delete or affect your application data. You are removing the ability to
view that information from SmartPlant Explorer Web Server.
You must have Administrator access privilege to remove a site.
101
SmartPlant PID Module Reports

Generate SmartPlant Reports
The Generate SmartPlant Reports command displays all of the system level SmartPlant P&ID
reports that are available for the selected item type. You can then select the SmartPlant P&ID
report that you want to run from SmartPlant Explorer. You cannot define or edit SmartPlant P&ID
reports in SmartPlant Explorer.
You need to have Microsoft Excel 2003, or 2007 to view SmartPlant Reports.
After a SmartPlant P&ID report is displayed in Internet Explorer, you can drag the icon from
the Address ribbon to your desktop to create a shortcut that can be used to re-run the report
without having to go through SmartPlant Explorer.
Some SmartPlant Reports are not available unless you install SmartPlant P&ID on the same
computer as the SmartPlant Explorer SmartPlant PID Module. The following error message
appears when you try to run one of these reports: "Error running SmartPlant report 'Report
Name'. This report contains a reference to a component that does not exist on the SmartPlant
PID Module server. One possible solution to this problem is to load SmartPlant P&ID on the
SmartPlant Explorer SmartPlant PID Module server."
installed.
Generate a P&ID SmartPlant Report

1. In the Tree view, click on the required P&ID plant.
2. On the Main view, click on the required Item Type.
3. On the Define Search for Report dialog box, do one of the following:
Define your search criteria, and click Search.
Click Search.
4. Right-click on the item you want to generate a report for, and from the shortcut menu click
Generate SmartPlant P&ID Reports.
5. On the Select SmartPlant Reports dialog box, select the report you want to generate.
6. Click OK, a progress bar is displayed and the report opens on completion.
To stop generating a report, click the Close Window icon in the top right corner of the
window.
102
To generate a P&ID SmartPlant Report the latest report template must be used. A message is
displayed if the report template being used is incorrect. For more information contact your
System Administrator.
installed.
SmartPlant Layout and Filter Defined

The SmartPlant Layout and Filter Defined command creates SmartPlant Explorer reports using
the layouts and filters that have defined for a SmartPlant P&ID Engineering Data Editor. You can
access this command by right-clicking on any plant item, and then clicking Reports > New >
SmartPlant Layout and Filter Defined. The filters and layouts defined in SmartPlant P&ID for
that plant item display for selection.
After the report appears in SmartPlant Explorer, you can edit the report definition the same way
you edit a SmartPlant Explorer defined report. You also can save the report as a SmartPlant
Explorer report.
You cannot define filters or layouts in SmartPlant Explorer.

If you are viewing a SmartPlant Explorer report, you can create a new report using the
SmartPlant P&ID filters and layouts by clicking Define New Application Report
on the
Report toolbar. Then select the plant item type, the filter, and the layout.
SmartPlant Layout and Filter Defined Reports provide a way to view reports in SmartPlant
Explorer using layouts and filters you have defined in SmartPlant P&ID.
SmartPlant Layout and Filter Defined Reports are defined and displayed using tabs:
Report Results - Displays the data in a tabular form. All users can see this tab.
Definition - Defines how the data should be displayed in the report. The layouts and filters
defined in SmartPlant P&ID are used to create the original set of report criteria. You can
modify the report definition if needed, however, changes are not posted back to SmartPlant
P&ID. Only users with Administrator or User privileges can view this tab.
Name - Defines the name of the report. Only users with Administrator or User privileges can
view this tab.
Access - Defines who can see the report. Only users with Administrator privileges can view
this tab.
Applies To - Defines what item type or item instance you want the report available for. Only
users with Administrator or User privileges can view this tab.
You can navigate between the tabs by selecting the tab you want, using the navigation arrows, or
by using CTRL + Page Up or CTRL + Page Down keys. If all tabs cannot be displayed in the
available space, small << and >> arrows display indicating there are more tabs in that direction.
A toolbar for reports, located on the left side, provides quick access to the report commands.
Activate a Display Set on a Drawing (SmartPlant PID Module)

This procedure is used to activate a display set created in P&ID. Depending on the where the
display set has been saved, effects what folders (and sub-folders) are displayed in the Select
Display Set dialog box. The three main folder types are:
Plant Folder This folder appears with the plant name and contains display sets saved in
SPP&ID drawings.
Project Folder This folder appears with the project name and contains display sets saved in
a project.
My Display Sets Contains display sets saved by the specific user in the My Display Sets
folder.
1. Click SmartPlant PID
2. Click
to expand the hierarchy down to the Site
and Plant
levels.
103

3.
4.
5.
6.
Select a plant.
Under Item types click Drawing.
Select a drawing to display.
On the Define Search for Report dialog box, if desired, select filter criteria to narrow the
number of drawings returned.
7. Do one of the following to view a drawing:
Right-click a drawing name, and on the shortcut menu, click View Drawing.
Click the drawing name.
8. On the main toolbar, click Select Display Set .

9. On the Select Display Set dialog box, select one of the available folders.
10. Expand the hierarchy in the desired branch and select the display set that you want to
activate.
If you add or modify display sets in SmartPlant P&ID while SmartPlant Explorer is running,
to see the changes, you must close Internet Explorer and then reopen SmartPlant Explorer.
View Equipment within a Drawing

In the P&ID module it is possible to select and view certain equipment within their drawings. The
equipment that can be viewed are from the categories:
Equipment
Equipment: Heat Transfer
Equipment: Mechanical
Equipment: Vessel
Equipment: Other
To view an item of equipment in a drawing, do the following;
1. From the Tree View, select the P&ID plant where the equipment resides.
2. On the Main View pane, click the category required. For example, Equipment: Component.
3. On the Define Search for Report dialog box select and enter your search parameters, and
then click Search.
You can click Search without setting any search parameters.
4. Right-click on the item you want to display, and select View Drawing(s).
If the selected item appears in only one drawing, the drawing opens automatically.
5. From the Drawing List click on the drawing you want to view, and select View Drawing.
104
SECTION 14
Printable Guides
Printing PDF Files
User's guides in PDF format, are an accessible, flexible, and fully-searchable alternative to Help.
The information found in user's guides is also available from Help.
SmartPlant Explorer Installation Guide (SPEInstallGuide.pdf)
SmartPlant Explorer User's Guide (SPEUsersGuide.pdf)
Adobe Acrobat Reader 8.0 or later compatible version (required for viewing the Software License
Agreement and Printable Guides). The latest version is downloadable from the Adobe Web site.
If you prefer printed documents over Help, you can easily print selected pages or entire
documents to any printer. Because these files are delivered as PDF files, an industry-standard
format, most photocopy vendors can print them for you. You can make as many copies as you
need for your internal, non- commercial use.
105
Printable Guides
106
Index
A
access 37, 39, 43, 52, 55, 56
access control 14, 96
favorites 39
roles 56
users 55
yourself 55
actions 31, 41, 42, 44, 45, 66, 68, 70, 72, 73,
74, 75, 76, 79, 80
calling 3D from PDS PID 70
calling 3D from SmartPlant 68, 70
calling PDS 3D from SmartPlant
Instrumentation 66
calling PDS PID from another application
76
calling PDS PID from SmartPlant 75
calling PDS PID from SmartPlant
Instrumentation 74
calling SmartPlant from PDS PID 80
calling SmartPlant Instrumentation from
PDS PID 73
SmartPlant 72
calling SmartPlant PID from SmartPlant
Instrumentation 79
creating 44
deleting 45
editing 44
listing 44
name 42
overview 41
parameters 42
save 31
save as new 31
URL 41
adding 15, 16, 18, 38, 87, 92, 94, 95, 96, 99,
101
applications 18
domains 94
favorites 38
modules to server 18
plants 95
projects 87, 99
roles 16
sites 92, 101
SmartPlant Instrumentation Web Server
95
users 15, 96
applications 17, 18, 32, 41, 53

adding 18
create reports 53
external 41
new report 32
overview 17
passing data 41
removing 18
applies to 43, 53
approved warnings 31
as-built 35
include 35
associated documents 93
changing server location 93
attribute 49, 57
authentication method 11, 13
B
basic authentication 11, 13
C
cables 24
reports 24
CAD loops 93
changing server location 93
calling 66, 68, 70, 72, 73, 74, 75, 76, 79, 80
PDS 3D Module 66, 68, 70
PDS PID module 74, 75, 76
SmartPlant Instrumentation Module 72,
73
SmartPlant PID Module 79, 80
caption 49
categorize 28
changing 44, 54, 61
actions 44
graphic reports 61
reports 54
colors 33
background 33
highlight 33
selected item 33
settings 33
commands 22, 23, 24, 26, 27, 103
Generate SmartPlant Reports 26
overview 22
properties 24
related items 22, 23
SmartPlant Layout and Filter Defined 103
107
Index
view in 3D 27
common tasks 9, 47, 91
administrator 9
reports 47
SmartPlant Instrumentation administrator
91
component services 14
connection timed out 13
creating 32, 38, 39, 44, 53, 61
actions 44
application reports 53
favorites 38
graphic reports 61
IE favorites 39
new reports 32
reports 53
criteria 49
criteria for reports 54
D
database 92, 94, 96
database server 92
database setup 88
databases 93
changing associated documents 93
changing CAD loops 93
changing password 93
supporting table changes 92, 94, 96
defining 32, 44, 53, 61
actions 44
application reports 53
graphic reports 61
new application report 32
new reports 32
reports 53
definition 33, 49, 57
move down 33
move up 33
delete 33
deleting 16, 17, 39, 45, 56, 62, 89, 93, 94,
96, 100
actions 45
domains 94
favorites 39
graphic reports 62
plants 96
projects 89, 100
report name 56
reports 56
roles 17
sites 93
users 16
display 49, 57
108
drawing with 57
displaying actions 44
distributed models 90
domains 24, 94
adding 94
removing 94
reports 24
updating 94
drawings 27, 31, 32, 33
background color 33
borders 31
color settings 33
highlight color 33
markup 32
overview 27
selected item color 33
dri files 89
DSN 88
Oracle 88
SQL Server 88
E
editing 44, 54, 61
actions 44
graphic reports 61
reports 54
engineering data editor 103
tabular view, filter and layout reports 103
engineering project 35
equipment 66, 68, 70, 72, 73, 74, 75, 79, 80
Instrumentation 66
Instrumentation 74
PDS PID 73
SmartPlant 72
Instrumentation 79
errors above severity 31
Excel 26, 32
reports from SmartPlant 26
export data to Excel 32
external applications 41
F
favorites 30, 32, 37, 38, 39
Index
access 39
adding 38
creating 38
deleting 39
displaying 30
listing 30
overview 37
properties 39
renaming 38
save as 32
saving 38
saving as IE favorite 39
showing 30
filters 48, 103
fit 34
G
graphic reports 57, 61, 62
creating 61
definition 57
deleting 62
editing 61
overview 57
graphic toolbar 29
H
hide 30, 48
properties 30
tree 30
hyperlinks 76
calling PDS PID 76
large icons 30
layouts 103
listing 44
actions 44
location tab 90
log off 29
loops 24
reports 24
M
magnify 34
main toolbar 29
mapping item types 63
markup drawings 32
menus 22, 23, 24, 27
overview 22
properties 24
view in 3D 27
Microsoft Excel 32
model data 87
models 89, 90
distributed 90
limiting based on item tag 90
locating 89, 90
viewing 89
modules 17, 18
adding 18
overview 17
removing 18
move 33
down 33
up 33
IDEAL server 95
installing 95
testing 95
include as-built 35
interface 21
overview 21
intermodule communication 66, 68, 70, 72,
73, 74, 75, 79, 80
item tag 90
item types 63, 90
operator 49
Oracle 88
creating a DSN 88
overview 89
PDS 3D Module 89
overviews 11, 14, 17, 21, 22, 23, 27, 29, 37,
41, 47, 57, 63, 87, 91, 96, 99, 101, 103
actions 41
jumping between modules 72, 73, 74, 75,

79, 80
L
labels 31
language 42, 52
name 42, 52
naming 55
reports 55
navigating between modules 63
no icons 30
no wrap text 30
notes 31
109
Index
application modules 17
commands 22
drawings 27
favorites 37
graphic reports 57
interface 21
navigating between modules 63
PDS PID Module 99
related items 23
reports 47
SmartPlant Instrumentation engineer 96
SmartPlant Instrumentation Module 91
SmartPlant PID Module 101
SmartPlant reports 103
system security 11
toolbars 29
tree view 22
users and roles 14
P
pan 34
panel strips 24
reports 24
panels 24
parameters 42
passing data to other applications 41
passwords 93
changing database 93
PDF reports 95
PDS 3D Module 18, 87, 89
adding to server 18
overview 87, 89
removing from server 18
PDS PID 18, 70, 80, 99, 100
PDS PID Module 73
adding to server 18
calling 3D 70
calling SmartPlant Instrumentation 73
overview 99
updating projects 100
PDS table 151 90
plants 24, 95, 96
adding 95
removing 96
reports 24
updating 96
point to point reports 95
previous view 34
project control database 87, 89, 90
projects 87, 89, 99, 100
adding 87, 99
removing 89, 100
110
updating 100
prompt 49
properties 24, 28, 30, 39
favorites 39
show/hide 30
viewing 28
Q
quick definition report 49
R
removing 16, 17, 18, 45, 56, 89, 93, 94, 96,
100, 101
actions 45
applications 18
domains 94
modules from server 18
plants 96
projects 89, 100
reports 56
roles 17
sites 93, 101
users 16
renaming 38
favorites 38
reports 24, 26, 29, 31, 32, 35, 47, 48, 49, 52,
53, 54, 55, 56, 61, 62, 95, 103
access 55, 56
as-built 35
calculation 95
common tasks 47
creating 53
creating graphic 61
criteria 54
definition 49
deleting 56
deleting a name 56
deleting graphic 62
editing 54
editing graphic 61
instrument specification 95
move data to Excel 32
name 52
naming 55
new 32
overview 47
PDF 95
point to point 95
renaming 56
results 48
save 31
Index
save as new 31
SmartLoop 95
SmartPlant Instrumentation 24
SmartPlant Layout and Filter Defined 103
SmartPlant reports 26
toolbar 29
roles 14, 16, 17, 56
adding 16
deleting 17
overview 14
report access 56
S
save 31
save as 31, 32
favorites 32
new 31
saving 38, 39
favorites 38, 39
searching 90
item in models 90
Secure Sockets Layer 11
select 35
server 11, 13
authentication method 11, 13
session timeout 13
system security 11
session timeout 13
set colors 33
set table options 30
show 30
favorites 30
properties 30
tree 30
sites 92, 93, 101
adding 92, 101
removing 93, 101
updating 92
small icons 30
SmartLoop reports 95
SmartPlant 68, 70
SmartPlant Instrumentation 18, 24, 66, 74,
79, 91, 92, 93, 94, 95, 96
adding domains 94
adding plants 95
adding sites 92
adding to server 18
adding web server 95
calling PDS 3D 66
calling PDS PID 74
changes to supporting tables 92, 94, 96
changing database password 93
common administrator tasks 91
database server 92
overview 91
removing domains 94
removing plants 96
removing sites 93
reports 24
SmartPlant Instrumentation Engineer 96
supporting table changes 92, 94, 96
updating domains 94
updating plants 96
updating sites 92
user defined fields 92, 94, 96
SmartPlant Markup 32
SmartPlant PID Module 72, 75, 79, 80, 101
accessing from PDS PID Module 80
accessing from SmartPlant Instrumentation
Module 79
calling PDS PID 75
calling SmartPlant Instrumentation 72
Instrumentation 79
overview 101
SmartPlant Review 89
SmartPlant Review Publisher 87, 89, 90
calling 3D 68, 70
sort 49, 89
SQL Server 88
creating a DSN 88
SSL 11
sub-menus 55
system security 11
T
table 49, 57
tabs 37, 41, 42, 43, 48, 49, 52, 53, 57, 89, 90
access 37, 43, 52
applies to 43, 53
definition 49, 57
item tag 90
location 90
models 89
name 42, 52
parameters 42
report results 48
URL 41
tags 24, 66, 68, 70, 72, 73, 74, 75, 79, 80, 90
Instrumentation 66
111
Index
Instrumentation 74
PDS PID 73
SmartPlant 72
Instrumentation 79
item tag tab 90
reports 24
timeout session 13
toolbars 29
overview 29
tree view 22, 30
show/hide 30
integrated Windows authentication 11, 13

session timeout 13
wrap text 30, 48
Z
zoom 33, 34
area 34
in 33
U
undo graphic manipulation 34
units 24
reports 24
updating 92, 94, 96, 100
domains 94
plants 96
projects 100
sites 92
URL 41
URL calls 41
user access 14, 15, 16, 17, 96
adding roles 16
adding users 15, 96
deleting roles 17
deleting users 16
user defined fields 92, 94, 96
users 14, 15, 16, 17, 55, 96
adding 15, 96
adding roles 16
deleting 16
deleting roles 17
overview 14
report access 55
SmartPlant Instrumentation engineer 96
V
view in 3D 27
vue files 89
W
warnings above severity 31
web server 95
wildcards 49
Windows 11, 13
112

SmartPlant Explorer Users Guide

Încărcat de

Informații document

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

SmartPlant Explorer Users Guide

Încărcat de

Drepturi de autor:

Formate disponibile

SmartPlant Explorer

Version 2009 HF2 (06.00.00)

U.S. Government Restricted Rights Legend

Warranties and Liabilities

SmartPlant Explorer User's Guide

SmartPlant Explorer User's Guide

SmartPlant Explorer User's Guide

SmartPlant Explorer User's Guide

New Features in SmartPlant Explorer

You must have installed SmartPlant Instrumentation 2007 SP6 HF 13 or higher or

SmartPlant Explorer User's Guide

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

Administrating Common Tasks

Add and remove application modules

Add and remove roles and users

SmartPlant Explorer COM+ Application Identity Utility

Available COM+ applications

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

Restart All Applications

CAD Loop Drawings

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

Integrated Windows Authentication

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

Client Certificate Mapping

Switch Authentication Method

Change Session Timeout

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

Users and Roles

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

You must have administrator privileges to remove an application.

SmartPlant Explorer User's Guide

Administering SmartPlant Explorer

SmartPlant Explorer User's Guide

Understanding the Interface

SmartPlant Explorer User's Guide

Understanding the Interface

Using the Tree View

SmartPlant Explorer User's Guide

Understanding the Interface

Related Items Command

SmartPlant Explorer User's Guide

Understanding the Interface

Generate SmartPlant Instrumentation Reports

Plant and Other Hierarchy Items at this Level

SmartPlant Explorer User's Guide

Understanding the Interface

Unit or Lowest Item in the Hierarchy

Panel, DCS Panels, and PLC Panels