SmartPlant Explorer Users Guide
SmartPlant Explorer Users Guide
User's Guide
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.
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.
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
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.
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.
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
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).
Drawing converter
Drawing converter module Grants access to the Drawing converter module.
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.
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
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
13
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
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
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
1. Click Start > Settings > Control Panel > Administrative Tools > Component Services.
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
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 role from which you want to remove a user.
Double-click the Users folder under the role.
Select the user.
Press Delete.
Right-click the SmartPlant Web Server package.
On the menu, click Shut down.
Add a Role
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.
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.
Double-click COM+ Applications.
Double-click SmartPlant Web 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.
Right-click the SmartPlant Web Server package.
On the menu, click Shut down.
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
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.
If the SmartPlant Explorer Server is not listed under computers, right-click on 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.
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.
Right-click the SmartPlant Web Server package.
On the menu, click Shut down.
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.
19
20
SECTION 3
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
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
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.
23
Properties Command
The Properties command appears on the menu when a selected item has viewable properties.
Properties appear in the Properties view.
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.
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
24
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
Cabinet Panel, Device Panel, Junction Box Panel, and Marshalling Rack Panel
Panel-Strip with Adjacent Connections
Panel-Strip without Adjacent Connections (Style 1)
Panel-Strip without Adjacent Connections (Style 2)
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
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.
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
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.
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.
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
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.
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
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
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.
Viewers cannot create new reports. You must have User or Administrator access to create
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.
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.
This command is only available when a drawing is displayed.
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.
This command is only available when a drawing is displayed.
Fit
Resets the drawing view magnification so you can see the entire drawing.
This command is only available when a drawing is displayed.
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.
This command is only available when a drawing is displayed.
Zoom Area
Increases the drawing view magnification of an area that you define with two points.
This command is only available when a drawing is displayed.
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.
This command is only available when a drawing is displayed.
Previous View
Provides a graphic undo for the last view manipulation. You cannot undo more than one
operation.
This command is only available when a drawing is displayed.
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.
This command is only available when a drawing is displayed.
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.
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.
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.
Rename a Favorite
1.
2.
3.
4.
5.
6.
7.
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.
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.
Delete a Favorite
1.
2.
3.
4.
You must have User or Administrative access to delete a favorite. Users can only delete
favorites that they created.
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.
42
Actions
43
Actions
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.
List Actions
1. Open the Action menu from a plant item type.
2. Click Actions > List.
Edit Action
1.
2.
3.
4.
5.
6. Click Save
44
Actions
Delete an Action
1.
2.
3.
4.
45
Actions
46
SECTION 6
47
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.
You must have SmartPlant Explorer Administrator or User access privileges to define
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
50
51
52
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
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.
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.
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.
54
1.
2.
3.
4.
5.
6.
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.
6. Click Save
5. Click Save
55
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.
Right-click and select Delete.
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.
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.
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, [^a-f] or
[^abcdef]). For example, if you specify pi[^a-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.
59
Graphic Reports
60
Graphic Reports
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.
61
Graphic Reports
10. Click Save
or Save as New
62
1.
2.
3.
4.
SECTION 8
SmartPlant PID
Module
InstrComponent
Instrument
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
Instrument
InstrComponent
Equipment
EquipGroup
Equipment
InstrLoop
InstrLoop
Loop
63
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
Tag
Instrument
InstrComponent
Equipment
Equipment,
EquipComponent,
Exchanger, Mechanical,
EquipOther, Vessel
EquipComponent,
EquipGroup
Loop
InstrLoop
InstrLoop
Unit
Unit
Area
Cabinet
Cable
ControlValve
DCS
Device
64
SmartPlant Instrumentation
Module
SmartPlant 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)
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.
66
2.
3.
4.
5.
6.
9.
10.
11.
12.
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.
2.
3.
4.
5.
6.
68
For Equipment
For Pipelines
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.
69
70
9.
10.
11.
12.
For Equipment
For Pipelines
71
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.
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.
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.
your_title is title that displays at the top of the resulting report
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
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 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.
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.
74
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.
your_title is title that displays at the top of the resulting report
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
Table.Attribute is the database table and attribute that that you want to query against in
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.
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.
75
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.
your_title is title that displays at the top of the resulting report
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
Table.Attribute is the database table and attribute that that you want to query against in
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.
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.
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:
http://server/spe/asp/en/main/PDS2DExternal.asp?project=project&schema=task/master&type=
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:
http://pdsserver/spe/asp/en/main/PDS2DExternal.asp?project=62proj&schema=task&type=draw
ing&drawing_no=41-E- 0001
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
Equip nozzle
Eq comp no
eq_nozz
Instrument
Component
instr_comp
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:
http://pdsserver/spe/asp/en/main/PDS2DExternal.asp?project=62proj&schema=task&type=draw
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_accessory
Instrument
Component
Instr comp
instr_comp
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
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
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 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 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).
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
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 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 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).
81
82
8. Click Next.
83
84
85
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.
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
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.
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.
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.
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
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
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.
92
You must republish the site if you need to change the database's administrator user name
or the site display name.
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
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.
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.
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.
95
Update a Plant
1. Right-click the plant icon.
2. On the menu, click Update 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.
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
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
98
SECTION 12
7.
8.
9.
10.
11.
12.
99
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
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
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.
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.
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.
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.
and Plant
levels.
103
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.
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
calling SmartPlant Instrumentation from
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
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
calling 3D from PDS PID 70
calling 3D from SmartPlant 68, 70
calling PDS 3D from SmartPlant
Instrumentation 66
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
calling SmartPlant Instrumentation from
SmartPlant 72
calling SmartPlant PID from SmartPlant
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
related items 22, 23
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
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
removing from server 18
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
related items 22, 23
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 from server 18
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 from PDS PID 80
calling SmartPlant Instrumentation 72
calling SmartPlant PID from SmartPlant
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
calling 3D from PDS PID 70
calling 3D from SmartPlant 68, 70
calling PDS 3D from SmartPlant
Instrumentation 66
calling PDS PID from SmartPlant 75
111
Index
calling PDS PID from SmartPlant
Instrumentation 74
calling SmartPlant from PDS PID 80
calling SmartPlant Instrumentation from
PDS PID 73
calling SmartPlant Instrumentation from
SmartPlant 72
calling SmartPlant PID from SmartPlant
Instrumentation 79
item tag tab 90
reports 24
timeout session 13
toolbars 29
overview 29
tree view 22, 30
show/hide 30
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