Vous êtes sur la page 1sur 128

SmartPlant Foundation Web Portal

User's Guide

SmartPlant Foundation Web Portal User's Guide Version 2009 R3 SP2 July 2009 / November 2010 DSPF1-PE-200004K-Updated

Version 2009 R3 SP2

July 2009 / November 2010

DSPF1-PE-200004K-Updated

SmartPlant Foundation Web Portal User's Guide Version 2009 R3 SP2 July 2009 / November 2010 DSPF1-PE-200004K-Updated

Copyright

Copyright © 2002 - 2010 Intergraph Corporation. All Rights Reserved.

Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.

U.S. Government Restricted Rights Legend

Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS 252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.

Unpublished - rights reserved under the copyright laws of the United States. Intergraph Corporation P.O. Box 240000 Huntsville, AL 35813 Street address: 170 Graphics Drive, Madison, AL 35758

Terms of Use

Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for resale or redistribution.

Warranties and Liabilities

All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software or applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes the information in this publication is accurate as of its publication date.

The information and the software discussed in this document are subject to change without notice and are subject to applicable technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.

The software discussed in this document is furnished under a license and may be used or copied only in accordance with the terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data. Users should verify for themselves that the data is accurate and suitable for their project work.

Trademarks

Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools, ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are trademarks of their respective owners.

Contents

Preface

5

SmartPlant Foundation Product Documentation

5

Documentation Comments

9

What's New in SmartPlant Foundation Web Portal

10

Using the SmartPlant Foundation Web Portal

15

Customizing the Web Portal

16

Samples

18

Exploring the Web Portal Interface

21

Specify an Effective Date and Time for Viewing Data

25

Setting Web Portal Preferences

26

Setting the Active Scope

28

Set the Active Scope by Query

29

Set the Active Scope by Roles

30

Searching

for

Objects

33

Search for items with a particular name

40

Search properties and content of an object

40

Run a saved query from the Discover web part

40

Using the List View

 

43

Sort a list

44

Print the complete contents of a search

44

Print only what displays on your monitor in the List web part

44

Create a Microsoft Excel spreadsheet containing your search results

45

Using the Discover View

 

47

Clear the Search Results tree

48

View a text description in the tree

49

Viewing Drawings and Graphics

51

View a design document

53

View a drawing

53

View an object in a drawing

53

Using the SmartPlant Foundation 3D View Control

54

3D

Navigation

Controls

54

3D

Navigation

Tips

63

Graphics Card Information

65

Troubleshoot 3D Navigation

65

Reviewing Information

 

75

View relationships for a selected item

85

Contents

View properties for a selected item

85

View the history for a selected item

85

Store objects for viewing later

85

View properties of a shared object

86

View related items for a selected item

86

View a summary view of a published object

89

To Do List

91

Claim a workflow step

92

View

step details

93

View history of a step

94

Sign off a step

96

Reassign

a step

97

Update a step description

98

Update a step duration

98

View workflow details report

99

View workflow history

99

View a workflow

100

Applications and Tasks

105

Glossary

107

Index

127

Preface

This document is a user's guide for the SmartPlant® Foundation Web Portal and provides conceptual information and procedural instructions for a standard SmartPlant Foundation installation. The content is the same as the online Help delivered as part of the software.

Depending on the model you have loaded, and the customization for that model, you may or may not see all the commands and functionality documented here. Intergraph gives you permission to print as many copies of this document as you need for non-commercial use at your company. You cannot print this document for resale or redistribution outside your company.

document for resale or redistribution outside your company. SmartPlant Foundation Product Documentation SmartPlant

SmartPlant Foundation Product Documentation

SmartPlant Foundation documentation is available as Help and as Adobe® PDF files. To view printable guides for SmartPlant Foundation, click Help > Printable Guides in the software. Intergraph gives its customers permission to print as many copies of the delivered PDF files as they need for their non-commercial use. Do not print the PDF files for resale or redistribution.

Installation and Overviews

SmartPlant Foundation Core Functionality & Enterprise Integration Capabilities Release

Bulletin - Provides information on new SmartPlant Foundation and integration features for the current release. SmartPlant Enterprise Overview - Provides an overview of SmartPlant Enterprise and

integration concepts and data exchange among integrated SmartPlant Enterprise authoring tools. SmartPlant Enterprise Data Exchange Diagrams - Includes full-size graphics that describe the

exchange of data among SmartPlant Enterprise authoring tools. These graphics are also included in the SmartPlant Enterprise Overview. SmartPlant Enterprise Integration Example Guide - Provides an overview of integrating

SmartPlant Enterprise and describes a typical example of full integration within SmartPlant Enterprise, including publishing and retrieving plant information using SmartPlant authoring tools and Aspen Basic Engineering™. SmartPlant Foundation Installation and Setup Guide - Provides installation and setup

instructions and troubleshooting information for stand-alone SmartPlant Foundation. SmartPlant Enterprise Hardware and Software Recommendations - Provides information

about the hardware recommendations and software requirements of the authoring tools that are part of the SmartPlant Enterprise suite. Integration Setup Guide - Provides information about setting up and using SmartPlant

Enterprise products in an integrated environment. Also provides integration troubleshooting information. How to Set Up and Configure SmartPlant Foundation - Provides system administrators with

information on setting up and configuring the SmartPlant Foundation system after all software has been installed. SmartPlant Enterprise Backup and Restore Guide - Provides backup, restore, and resynchronization procedures for SmartPlant Foundation, SmartPlant Basic Integrator, and integrated SmartPlant Enterprise authoring tools. The procedures are designed to minimize data loss and downtime when restoring data in an integrated environment.

Preface

SmartPlant Foundation/Integration Architecture Guide - Describes the architecture of the SmartPlant Foundation and integration software. Integration: A Gentle Introduction to the SmartPlant Schema - Provides an introduction to the SmartPlant schema and the data model that describes how the SmartPlant schema is constructed. Token Licensing Installation and Reference Guide - Provides reference and user information for installing and configuring daily and perpetual token licenses in SmartPlant Foundation. SmartPlant Foundation Upgrade Guide - Provides step-by-step instructions for upgrading from SmartPlant Foundation or SmartPlant Basic Integrator version 2008, 2008 Service Pack 1, 2009, or 2009 Service Pack 1 to version 2009 R3 SP2. SmartPlant Enterprise Citrix Configuration Guide - Provides information on configuring integrated SmartPlant® Enterprise applications to run in a Citrix environment.

User's Guides

SmartPlant Foundation Web Portal User's Guide - Provides instructions for using the SmartPlant Foundation Web Portal. SmartPlant Foundation Desktop Client User's Guide - Provides instructions for creating, viewing, updating, and managing objects and their relationships. Additionally, it provides information about completing workflow steps and using SmartPlant Foundation in an integrated environment. SmartPlant Markup Plus User's Guide - Provides information on using SmartPlant Markup Plus, either alone or from within the SmartPlant Foundation interface, to view and annotate files created with any authoring tool. If SmartPlant Markup Plus is installed on the local computer, it is available from within SmartPlant Foundation through the View and Markup command in the Desktop Client. Integration User's Guide - Provides information about using SmartPlant Enterprise products in an integrated environment. Also provides a basic understanding of integration and common integration tasks. Integration Administrator's Guide - Provides information for system administrators on how to set up and configure an integrated environment.

Administrative Guides

SmartPlant Foundation Server Manager User's Guide - Provides instructions for using SmartPlant Foundation Server Manager to configure the SmartPlant Foundation server and to upgrade SmartPlant Foundation databases. Schema Editor User's Guide - Provides instructions for using the Schema Editor to view and extend the SmartPlant schema, view and modify authoring tool mapping, and compare schema files. SmartPlant Mapping User's Guide - Provides guidelines, procedures, and examples of mapping between the SmartPlant schema and integrated authoring tools. SmartPlant Model Loader User's Guide - Provides instructions for using the Model Loader to load documents exported from PDS™ or AVEVA PDMS into the SmartPlant Foundation database. SmartPlant Foundation Administrator's Guide - Provides SmartPlant Foundation administrators with basic information about how to administer standalone SmartPlant Foundation.

Troubleshooting Guide

SmartPlant Foundation Troubleshooting Guide - Contains information about troubleshooting the installation and configuration of SmartPlant Foundation.

Preface

Model Configuration Guides

How To Guide Master Table of Contents - Provides a copy of the table of contents of each how

to document in the SmartPlant Foundation documentation set to be used this to locate the guide that contains a particular topic without opening each how to guide to search for the topic. How to Configure Classified Objects - Provides information for system administrators on how

to configure classified objects in SmartPlant Foundation and describes the underlying data model. How to Configure Concurrent Engineering - Provides information for system administrators on

how to configure concurrent engineering in SmartPlant Foundation and describes the underlying data model. How to Configure Document Management - Provides information for system administrators on

how to configure document management in SmartPlant Foundation and describes the underlying data model. How to Configure Reports - Provides information for system administrators on how to

configure reporting in SmartPlant Foundation and describes the underlying data model. How to Configure the Authoring and Data Warehouse Models - Provides information for

system administrators on how to configure the authoring and data warehouse models in SmartPlant Foundation and describes the underlying data model. How to Configure the Data Sheet Model - Provides information for system administrators on

how to configure the data sheets model in SmartPlant Foundation and describes the underlying data model. How to Configure the GUI Model - Provides information for system administrators on how to

configure the graphical user interface (GUI) model in SmartPlant Foundation and describes the underlying data model. How to Configure the Infrastructure Model - Provides information for system administrators on how to configure the infrastructure model in SmartPlant Foundation and describes the underlying data model.

How to Configure the Line List Model

-

Provides information for system administrators on

how to configure the line list application in SmartPlant Foundation and describes the underlying data model. How to Configure the Progress Model - Provides information for system administrators on how

to configure the progress model in SmartPlant Foundation and describes the underlying data model. How to Configure the Security Model - Provides information for system administrators on how

to configure the security model in SmartPlant Foundation and describes the underlying data model. How to Set Up and Configure SmartPlant Foundation - Provides information for system

administrators on how to set up and configure SmartPlant Foundation and describes the underlying data model. How to Configure the Workflow Model - Provides information for system administrators on how to configure the workflow model in SmartPlant Foundation and describes the underlying data model.

Integration Guides

SmartPlant Foundation Core Functionality & Enterprise Integration Capabilities Release Bulletin - Provides information on new SmartPlant Foundation and integration features for the current release. SmartPlant Enterprise Overview - Provides an overview of SmartPlant Enterprise and integration concepts and data exchange among integrated SmartPlant Enterprise authoring tools.

Preface

SmartPlant Enterprise Data Exchange Diagrams - Includes full-size graphics that describe the

exchange of data among SmartPlant Enterprise authoring tools. These graphics are also included in the SmartPlant Enterprise Overview. SmartPlant Enterprise Integration Example Guide - Provides an overview of integrating

SmartPlant Enterprise and describes a typical example of full integration within SmartPlant Enterprise, including publishing and retrieving plant information using SmartPlant authoring tools and Aspen Basic Engineering™. SmartPlant Enterprise Hardware and Software Recommendations - Provides information

about the hardware recommendations and software requirements of the authoring tools that are part of the SmartPlant Enterprise suite. Integration Setup Guide - Provides information about setting up and using SmartPlant

Enterprise products in an integrated environment. Also provides integration troubleshooting information. Integrated Line List Configuration and User's Guide - Provides configuration and user

information for creating, publishing, or retrieving line list documents in SmartPlant Foundation and SmartPlant Materials. SmartPlant Enterprise Backup and Restore Guide - Provides backup, restore, and

resynchronization procedures for SmartPlant Foundation, SmartPlant Basic Integrator, and integrated SmartPlant Enterprise authoring tools. The procedures are designed to minimize data loss and downtime when restoring data in an integrated environment. SmartPlant Foundation/Integration Architecture Guide - Describes the architecture of the

SmartPlant Foundation and integration software. Integration: A Gentle Introduction to the SmartPlant Schema - Provides an introduction to the

SmartPlant schema and the data model that describes how the SmartPlant schema is constructed. SmartPlant Mapping User's Guide - Provides guidelines, procedures, and examples of

mapping between the SmartPlant schema and integrated authoring tools. SmartPlant Enterprise Mapping Spreadsheets - Provides Microsoft Excel files containing the

retrieve mapping for integrated SmartPlant Enterprise authoring tools. Integration User's Guide - Provides information about using SmartPlant Enterprise products in

an integrated environment. Also provides a basic understanding of integration and common integration tasks. Integration Administrator's Guide - Provides information for system administrators on how to

set up and configure an integrated environment. Schema Editor User's Guide - Provides instructions for using the Schema Editor to view and

extend the SmartPlant schema, view and modify authoring tool mapping, and compare schema files. SmartPlant Mapping User's Guide - Provides guidelines, procedures, and examples of

mapping between the SmartPlant schema and integrated authoring tools. SmartPlant Model Loader User's Guide - Provides instructions for using the Model Loader to

load documents exported from PDS™ or AVEVA PDMS into the SmartPlant Foundation database. SmartPlant Enterprise Citrix Configuration Guide - Provides information on configuring integrated SmartPlant® Enterprise applications to run in a Citrix environment.

Programming Guides

To view customization and programming documentation for SmartPlant Foundation and

integration, browse to the

computer where the SmartPlant Foundation server components are installed.

\SmartPlant\Foundation\7.x\ProgrammingHelp

folder on a

Preface

SmartPlant Foundation Server Customization Guide - Provides information for developers on

customizing the SmartPlant Foundation Server. SmartPlant Foundation Client Customization Guide - Provides information for developers on

customizing the SmartPlant Foundation Client. SmartPlant Foundation Web Portal Customization Guide (SPFWebPortalCustomization.chm)

- Provides information about customizing and configuring the SmartPlant Foundation Web Portal. SmartPlant Foundation Web Services Guide - Describes SmartPlant Foundation web

methods used for uploading data from and downloading data to the SmartPlant Foundation Server. SmartPlant Schema Modeling Guide - Provides an introduction to the techniques that were

used to develop the SmartPlant schema and create a data model. SmartPlant Adapter Interfaces Reference Guide - Provides information for tool developers

about the interface classes used to communicate data between the authoring tool and the common user interface and the common user interface and the tool adapter. SmartPlant Common UI Interfaces Reference Guide - Provides information for tool developers

about the API exposed through the EFCommonUI.dll, which is used by authoring tool developers to access integration functionality. SmartPlant Metadata Adapter Reference Guide - Provides information for tool developers

about programming the metadata adapter. The tool metadata adapter allows communication between the SmartPlant Schema Editor and the tool database to manage mapping between the tool and the SmartPlant schema. SmartPlant Schema Component API Reference Guide - Provides information for developers

about the Schema Component API. SmartPlant Enterprise SmartPlant Adapter for SmartPlant Electrical - Describes the

SmartPlant Adapter details, functionality and configuration in SmartPlant Electrical. SmartPlant Enterprise SmartPlant Adapter for SmartPlant Instrumentation - Describes the

SmartPlant Adapter details, functionality and configuration in SmartPlant Instrumentation. SmartPlant Enterprise SmartPlant Adapter for SmartPlant P&ID - Describes the SmartPlant

Adapter details, functionality and configuration in SmartPlant P&ID. SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D - Describes the SmartPlant

Adapter details, functionality and configuration in SmartPlant 3D. SmartPlant Enterprise SmartPlant Adapter for PDS 3D - Describes the SmartPlant Adapter

details, functionality, and configuration in PDS 3D.

Documentation Comments

Send documentation comments or suggestions to PPMdoc@intergraph.com.

What's New in SmartPlant Foundation Web Portal

What's New in SmartPlant Foundation Web Portal

The following changes have been made to SmartPlant Foundation Web Portal.

Version 2009 R3 SP2

A new out of-the-box page is supplied with this version. This new layout and theme illustrates

the configurability/flexibility for users to create web portals that are fit for purpose. For more information, see Customizing the Web Portal (on page 16) in the SmartPlant Foundation Web Portal help. In addition to the new default page, a demo driver page is provided that illustrates just a few of

the different types of layout and pages that projects could create and provide their users. You can have more than one portal page, and this page provides a quick look at how web parts can be moved, changed, presented and re-organized to create numerous portals that are "task-fit" for your customer. For more information, see Customizing the Web Portal (on page 16) in the SmartPlant Foundation Web Portal help. More web portal control samples have been added. Users have more feedback on

document/tag locations, window size, and themes than ever before. A full listing of samples can be found under the SmartPlant Foundation product directory. Each sample contains sample code and instructions that enable you to leverage these on your portals within minutes. The portal has added a new scripting infrastructure that provides an opportunity for users to

reduce the amount of mouse clicks and to automate several web part events automatically. Each object can have a defined ‘script’. Every time a user selects that object, a script will be run and the corresponding results posted to the portal page web parts. The script is an XML definition that can be easily defined, redefined, and managed. For more information, see the SmartPlant Foundation Web Portal Customization Guide. New web parts are supplied as samples. A Report web part that brings the available SmartPlant Foundation reports to the top level of the interface is supplied for those users that run reports often. A new Charting/Reporting interface and infrastructure allows customers to develop better dashboards for staying on top of the project trends and critical document statuses.

The Select All Scope option has been added to the Set Active Scope dialog box.

When

selected, the Select All Scope option selects all top configuration items for the Query

Configuration. For more information, see Setting the Active Scope (on page 28) in the SmartPlant Foundation Web Portal help.

New warning messages have been added.

These warning messages tell you when your

defined query limits are reached.

The values used to determine the query limits are defined

using the Warning dialog number and Maximum query limit options on the Change User Preferences dialog box. For more information, see Setting Web Portal Preferences (on page 26) in the SmartPlant Foundation Web Portal help. Single character URL parameters are available. You can use either "user" or "u", "password" or "p", "server" or "s", "host" or "h", and "webdir" or "w". For more information, see Web Portal URL Parameters in the SmartPlant Foundation Installation and Setup Guide.

The Discover web part can be configured to display related items under the selected item's node in the Discover tree, instead of in the Search Results node. To configure the Discover web part in this way, use the web part's Expand Relationships in Place configuration option,

What's New in SmartPlant Foundation Web Portal

which is available in the Web Portal's Edit mode. For more information, see the SmartPlant Foundation Web Portal Customization Guide.

The Summary View Equipment / Summary View Documents commands have been added to the Web Portal. Published items will have a new "action" entry that starts with "Summary

View

".

You can use this command to view a summary of relationships and other properties

for published items or loaded documents in one dialog box

For more information about using

this dialog box, see View a summary view of a published object (on page 89) in SmartPlant

Foundation Web Portal Help. The contents of several sections of the Summary View Equipment dialog box are customizable through XML files. See the ReadMe document included with the SmartPlant Foundation Summary View of Object sample (typically located in C:\Program Files\SmartPlant\Foundation\2009\Samples\WebPortal\) for more information about customizing the Summary View Equipment dialog box.

To display a company logo or project image in the Web Portal user interface, modify the View web part’s cascading style sheet rules to show any image as the background image of the

View web part.

Customization Guide under Out of the Box Web Parts and Support > View Web Part.

For more information, see the SmartPlant Foundation Web Portal

Version 2009 SP1

The View Shared Data command has been added to the Web Portal. The View Shared Data command allows you to view data about a shared object, such as instruments, equipment, and pipelines, that has been published by multiple sources into their tool-specific domains, then correlated. See View properties of a shared object (on page 86) in SmartPlant Foundation Web Portal help for more information. The DisableAutoLogin URL parameter has been added. If this parameter is true, the Web Portal will prompt the user for login information. See Exploring the Web Portal Interface (on page 21) in SmartPlant Foundation Web Portal help for more information. The Web Portal now highlights inconsistent property values in ad hoc reports. Based on how your Web Portal is configured, you can view drawings and models in either the View web part or in a separate SmartPlant Markup Plus window. See the List Web Part section of the SmartPlant Foundation Web Portal Customization Guide for more information about how to configure this option. If the Web Portal is configured to view drawings and models in a separate window, the new Maximize external file viewing windows user preference option on the Change User Preferences controls whether the window is maximized by default. See Setting Web Portal Preferences (on page 26) in SmartPlant Foundation Web Portal help for more information. The View Related Items command has been added to the Review web part. This command allows you to view items related to the selected item in the List web part. See View related items for a selected item (on page 86) in SmartPlant Foundation Web Portal help for more information.

Version 2009

The To Do List web part has been added to the Web Portal. The To Do List provides a place for you to view all workflow steps that have been assigned to you and their statuses. The Clip Volume command has been added, which includes a 3D wireframe box that can be manipulated to limit the objects that can be seen in the view. The 3D Navigator control has been added, which supports the common navigation movements you can perform with the mouse and keyboard such as look and move. Additionally, it contains the Select, Home, and Fit navigation commands. Several usability enhancements have been added.

What's New in SmartPlant Foundation Web Portal

The ability to display a non-streaming 3D .VUE file (instead of streaming the 3D model
The ability to display a non-streaming 3D .VUE file (instead of streaming the 3D model
from the server) if one is found on the client.
Support for the display of SmartPlant P&ID typicals.
New settings in the View web part to specify supported file types.
New options in the Review web part to configure the tabs and automatic expansion of a
predefined relationship.
The option to display multiple tabs in the List and View web parts.
A Saved Search node in the Discover web part.
Optional name and description fields in Quick Find.
Case insensitive searches in the Search web part.
The following customization samples have been added.
Simultaneous 2D/3D Viewing - An example of how to configure the View web part to
synchronize navigation between displayed 2D and 3D views.
Reuse Web Portal IE Window - An example of how an external application can pass
multiple calls to a single instance of the Web Portal.
Custom Code Click Event - A sample that demonstrates how to generate a Web Portal
click event for an object returned from a query in custom code.
Open URL web part - An example of how to create a web part that uses the standard Web
Portal click events in calling a preconfigured URL.
Custom Role Based Security - An example of how to show and hide web parts based on
roles.
Attach Files - An API for attaching files to documents in the Web Portal.
File Upload Task - An example of a custom Web Portal role-based application and task
object.
Support for role-based applications and tasks has been added to the Web Portal. This gives
project services the ability to create one or more portal applications, with each application
containing one or more tasks. Two new web parts, SPFWebPortalApplicationsBar and
SPFWebPortalTasks, can be added to the Web Portal to display menu items (icons or text) for
the available applications and tasks.
See the Web Portal Customization Guide for more information about configuring the Web
Portal applications and tasks.

Version 2008 SP1

You can launch the Web Portal from a URL and execute an API or APIs.

For more

information, refer to Exploring the Web Portal Interface (on page 21). Using SmartPlant Markup Plus, you can now create and save layers in the View web part.

The Discover web part now supports the Add to home collection option. The Home

Collection allows you to return to objects for review later. The Set Active Scope dialog box includes a Clear Query Scope command.

The View web part now contains the Clear contents command.

This command removes

any displayed information. (on page 51).

For more information, refer to Viewing Drawings and Graphics

The List web part now contains a Clear List View command.

This command removes any

displayed information.

For more information, refer to Using the List View (on page 43).

The Web Portal now supports reporting. You can run reports with or without criteria to report on objects in the SmartPlant Foundation database.

What's New in SmartPlant Foundation Web Portal

Licensing functionality exists for Web Portal. is available.

Perpetual users, tokens, or site license access

What's New in SmartPlant Foundation Web Portal

S ECTION

1

Using the SmartPlant Foundation Web Portal

The SmartPlant Foundation Web Portal provides view, query, and print functionality of the SmartPlant Foundation client system through an easy-to-deploy Internet Explorer web browser. Based on the software configuration and user privileges, you can perform many functions including:

View information from the database about a specific object or categories of objects

Search for objects in the database

View drawings and 3D models

View a history for a particular object

View relationships between objects

a particular object View relationships between objects Depending on the model you have loaded, and the

Depending on the model you have loaded, and the customization for that model, you may or may not see all the commands and functionality documented here. To view files in the Web Portal client, you must have SmartPlant Markup Plus installed.

The SmartPlant Foundation Web Portal is comprised of several different components that can be assembled or arranged to best suit your business needs. Four important concepts and elements of the Web Portal are

Web Parts – unique and built-for purpose components that are placed within a web part zone.

Out of the box, SmartPlant Foundation supplies the Brain, Search, Discover, View, List, To Do List, Review, and Reports web parts. Web parts fire events that the Brain uses to communicate with the SmartPlant Foundation database or to other web parts. The Brain controls how information is handled among the other web parts, and is the only web part required to be on a page. Web Part Zones – the main areas of the page layout which contain and control the position of the embedded web parts.

Pages – how number, arrangement and space allocation of the page zones are controlled by the page. Multiple pages can be defined with different parts and layouts for different purposes.

For example,

if you have a dual-monitor system you may want to make your page two

monitors (in pixels) in width. Theme – the font, colors and zone allocation (the percentage of the page a web part zone consumes). Using these components, customers can build highly functional and built-for-purpose Web Portals to extend the value of SmartPlant Foundation.

Using the SmartPlant Foundation Web Portal

Customizing the Web Portal

The Web Portal is customizable. You may choose to only alter the theme of the Web Portal, or use the Web Part Editor to personalize the web parts. Or you may choose to create custom web pages or custom web parts. The amount of personalization and customization will be different for every customer. For example, the two Web Portals pictured below feature different layouts and color schemes. These customizations make them appear very different from the out-of-the-box Web Portal. In the Web Portal shown below, the search control was modified using CSS rules and properties to display only the quick search, and displays as if it were a toolbar. The Discover web part is not used on the page, and the View web part spans the entire width of the page at the bottom.

View web part spans the entire width of the page at the bottom. 16 SmartPlant Foundation

Using the SmartPlant Foundation Web Portal

The Web Portal below features two View web parts and a custom theme. This was accomplished by creating a custom aspx page in which the controls were rearranged and web parts and controls were added. A custom theme including skin files and CSS files was also created.

theme including skin files and CSS files was also created. Custom Themes Changing the default theme

Custom Themes

Changing the default theme can modify the look of the Web Portal. If needed, you can use themes, skin files and CSS files to modify the fonts, colors, and other styles. Several themes are delivered with the Web Portal. See the Styles section of the SmartPlant Foundation Web Portal Customization Guide (SPFWebPortalCustomization.chm) for more information about using styles and themes.

Personalized Web Parts

Each of the delivered Web Portal web parts has a set of publicly available properties that can be set to change the look or behavior of the web part. For example, the Search web part has properties that can be used to limit the options available, change the default style applied to each tab, or change the default tab. In the first example above, the Search web part was modified to display only the quick search, and to display as a toolbar. These properties can be set up either declaratively in the web page by the administrator or other person defining the page, or if personalization is available, by the user using the Web Part Editor interface. In general for web part pages, personalization can be enabled either at a shared level or per user. However, the SmartPlant Foundation custom personalization requires that personalization be available on a per user (per login) basis only. Shared personalization will have to be accomplished by the administrator using page modification and/or web.config changes. The personalization is stored in the SmartPlant Foundation database along with other user preferences.

Using the SmartPlant Foundation Web Portal

Custom Web Parts

To enhance or add functionality to a portal, administrators or other persons defining the portal can choose to create their own web parts. They may use the delivered web parts to inherit from or they can write new ones from scratch. Even the Controller (Brain) can be overridden. The same rules must be followed to ensure communication between the parts. Non-controller parts must implement the IBrainChild interface to use the auto-wireup system.

Custom .aspx pages

An administrator or other person can create a new default page if needed. The minimum requirements include the AJAX ScriptManager and the Controller (Brain) web part. Additional web parts or other server or HTML controls can be added as needed. For more information about customizing Web Portal,see the SmartPlant Foundation Web Portal Customization Guide (SPFWebPortalCustomization.chm) delivered with the SmartPlant Foundation programming documentation. To view programming documentation for SmartPlant Foundation and integration, click Start > Programs > Intergraph SmartPlant Foundation >

Programming Help

on a computer where the SmartPlant Foundation server components are installed.

or browse to the

\SmartPlant\Foundation\2009\ProgrammingHelp folder

Samples

Samples are delivered with the software that can serve as examples of how to create a custom web part or command, how to define default templates that you can add to Visual Studio 2008 to ease the creation of new parts and pages, how to add user customization to sites, and how to implement SharePoint communication. The samples are delivered in the Web Portal samples directory (typically, C:\Program Files\SmartPlant\Foundation\2009\Samples\WebPortal\). The document SPF Web Portal Samples.pdf contains summaries of all delivered samples.

Each sample is delivered in its own directory under the samples directory. A sample's directory includes:

A ReadMe document containing instructions for setting up and using the sample.

A sample aspx page that includes the Web Part or control.

In most cases, screenshots of the new Web Part or control.

Using the SmartPlant Foundation Web Portal

For example, the sample SPFBreadNCrumb is delivered with the Web Portal. When added to an .aspx page, this control allows users to click an object in the List view and expand the object's edge definition or graph definition from the menu that appears. The object's edge definition or graph definition is displayed in the List web part. An example of the sample control in a Web Portal is shown below.

of the sample control in a Web Portal is shown below. The sample's folder also contains

The sample's folder also contains an aspx page, SPFBreadCrumb.aspx, that uses the new control. The ReadMe document included with the sample provides instructions for adding the sample to a Web Portal page, with the necessary changes to the page highlighted, as shown below.

the necessary change s to the page highlighted, as shown below. SmartPlant Foundation Web Portal User's

Using the SmartPlant Foundation Web Portal

S ECTION

2

Exploring the Web Portal Interface

When you open the SmartPlant Foundation Web Portal, the software displays the standard Web Portal controls including User Name, Password, and Server option. When you login, default web parts display including Search, List, Discover, View, and Review. Web parts are data containers displayed on a web page that contain functionality and elements. The web parts can be customized (for example, colors, fonts, logos , and so forth).

See your Administrator for information about customizing the delivered web parts. For more information about customization, refer to the SmartPlant Foundation Web Portal Customization Guide (SPFWebPortalCustomization.chm) delivered with the SmartPlant Foundation programming documentation.

with the SmartPlant Foundation programming documentation. Launching the Web Portal Open the Web Portal in an

Launching the Web Portal

Open the Web Portal in an internet browser using a URL in the format http://<webserver>/<WebPortal_virtual directory>, where webserver is the name of your SmartPlant Foundation server, and WebPortal_virtual directory is the name of your Web Portal's virtual directory. A typical Web Portal URL is http://ServerName/SPFWebPortal/Default.aspx. See Configuring Web Portals in the SmartPlant Server Manager User's Guide for more information about creating and configuring Web Portals.

Based on the configuration of your system, this basic URL format can be customized with other file names and optional parameters. See Launch the Web Portal and Execute an API below for examples of URL parameters. Certain Internet security options must be set when using Web Portal and Microsoft Internet Explorer. In Microsoft Internet Explorer, your Web Portal server must be added as a Trusted site. Also, you must enable the security settings Script ActiveX controls marked safe for

http://<webserver>/<WebPortal_virtual directory>/ across domains.

The Web Portal is not compatible with Internet Explorer 8 Standards mode. The Web Portal only supports Internet Explorer 8 running in Internet Explorer 7 (IE7) Standards mode. Portal only supports Internet Explorer 8 running in Internet Explorer 7 (IE7) Standards mode.

,

scripting and Access data sources

Login/Logoff Toolbar

, scripting and Access data sources Login/Logoff Toolbar Enter your username and password in the User

Enter your username and password in the User name and Password fields. Select your server using the Server drop-down list. Click Login to start SmartPlant Foundation Web Portal.

If your system is configured for automatic logon, then the software automatically logs you on to SmartPlant Foundation using your Windows user name when you open the Web Portal.

using your Windows user name when you open the Web Portal. Web Portal Toolbar The toolbar

Web Portal Toolbar

user name when you open the Web Portal. Web Portal Toolbar The toolbar displays icons and

The toolbar displays icons and information using Tool Tips. To view the Tool Tips, move your mouse pointer over the icon and pause. The Tool Tip displays near your mouse pointer.

Exploring the Web Portal Interface

Exploring the Web Portal Interface You are logged in as < username > - Displays the

You are logged in as <username> - Displays the current user. Move your mouse over the icon to display a tooltip containing the current user name.

Effective Date - Displays the Effective Date dialog box. Use this dialog box to define the effective - Displays the Effective Date dialog box. Use this dialog box to define the effective date and time to use for viewing data. You can view data from the SmartPlant Foundation database as the data existed at a particular time in the past. Options include Now or you can define a specific date and time. Move your mouse pointer over this button to display a tooltip containing the current settings. For more information, see Specify an Effective Date and Time for Viewing Data (on page 25).

an Effective Date and Time for Viewing Data (on page 25). User Preferences - Displays the

User Preferences - Displays the Change User Preferences dialog box. Options include

query limits, defining units of measure, displaying hidden files, and so forth. information, see Setting Web Portal Preferences (on page 26).

Query Scope - Displays your current query configuration and active role. Use this dialog box to change the query scope used when retrieving data. If you change the scope, the currently displayed data is discarded and data matching the new scope displays in the web parts. Move your mouse pointer over this button to display a Tool Tip containing the current settings. For more information, see Setting the Active Scope (on page 28).

For more

see Setting the Active Scope (on page 28). For more About - Displays the currently installed
see Setting the Active Scope (on page 28). For more About - Displays the currently installed

About - Displays the currently installed version of SmartPlant Foundation, the server URL being used, links to technical support, and so forth.

URL being used, links to technical support, and so forth. Help - Displays the online Help

Help - Displays the online Help file. The Help contains procedures, reference information,

and conceptual overviews that can be accessed through a table of contents, keyword index, or full

text search engine.

F1.

LOGIN / LOG OFF - Click LOGIN to begin using the software or click LOGOFF to exit the software.

You can also get context-sensitive information in the software by pressing

context-sensitive information in the software by pressing Launch the Web Portal and Execute an API You

Launch the Web Portal and Execute an API

You can launch the Web Portal from a URL and execute one or more APIs. There are several optional parameters that you can add to the login URL. These parameters should be separated with an ampersand (&). Spaces in the URL format are denoted by a percent symbol followed by 20 (%20).

URL Parameter

Description

user or u

User name

password or p

User password

plant

Plant name

project

Project name

configuid

UID of the configuration

roles

Role name

server or s

Server name (as defined in the Login option)

host or h

Host name

webdir or w

Web directory

Exploring the Web Portal Interface

URL Parameter

Description

secure

"True" or "False" to indicate if "https" is used

task

Name of the customized task to start. The task may also require additional input parameters.

DisableAutoLogin

If the value of this parameter is true, then auto-login is disabled.

If this value of this parameter is false, then auto-login is enabled.

This parameter overrides the DisableAutoLogin setting in the SmartPlant Foundation server web.config file.

Launching Web Portal using a URL uses parameters including a single character (u) or the full

name (user).

and webdir or w.

The following are valid parameters: user or u, password or p, server or s, host or h,

For example:

http://nodename/directory/Default.asp?user=jqpublic&password=MyPassword&class=userinbox

or http://nodename/directory/Default.asp?u=jqpublic&p=MyPassword&class=userinbox When both user and u are used in URL parameters, the full-named parameter will be used.

For

example, if the following is provided by the user, http://demo/SPFWebPortal/Default.aspx?u=JohnDoe&user=JDoe&p=pwjdoe&server=url-demo the URL will become, http://demo/SPFWebPortal/Default.aspx?user=JDoe&password=pwjdoe&server=url-demo. To launch the API, you need the &api parameter. The arguments are optional and depend on the API being used. To launch the API of an object, the following class and name parameters are mandatory.

API Parameter

Description

api

The name of the API to be called. object is case-sensitive.

This

class

Class name

name

Name of the item.

uid

UID of the item (used instead of class and name)

arg1

Depends on the API called.

arg2

Depends on the API called.

arg3

Depends on the API called.

arg4

Depends on the API called.

arg5

Depends on the API called.

arg6

Depends on the API called.

arg7

Depends on the API called.

Exploring the Web Portal Interface

API Parameter

Description

arg8

Depends on the API called.

criteria

Specifies the search criteria for queries.

In order to call an API, you must provide an API name and its required and proper arguments for

that API (in order to run API from URL).

arguments for a client API by searching for that API. The following is an example URL to call ViewAndNavigate which displays SmartPlant Markup Plus in the Web Portal. http://demo/SPFWebPortal/Default.aspx?u=jdoe&p=jdoepwd&s=url-demo&API=Navigate&Class

=SPFDesignDocVersion&Arg1=FRAME&Arg3=True&Name=3D-CivilPlans_003

This URL logs in to the SmartPlant Foundation Web Portal site url-demo with user name jdoe and

password jdoepwd.

(including an attached file).

frame.

Each API has its own arguments, and you can find the

Once logged in, a design document of 3D-CivilPlans_003 is located

Then, SmartPlant Markup Plus displays in the Web Portal as a

If there are any redline objects in the file, they also display.

Example URLs

The following URL launches the Web Portal and uses the Navigate API to open a specific version (revision 2A, version 2) of the specified document (SB101). http://localhost/SPFWebPortal/Default.aspx?server=localhost&API=Navigate&Class=SPFDesign

DocVersion&Arg1=OPEN&Name=SB101&Arg8=2&Arg9=A&Arg10=2

The following example URL launches the Web Portal and displays the details dialog box for the SPFPlant named PlantA. http://SPFServer/SPFWebPortal/?&api=ShowObj&class=SPFPlant&name=PlantA The example below opens the appropriate drawing using the value specified for ARG1, and highlights in the drawing the object specified by the CLASS and NAME arguments.

http://spfdev1/SPFWebPortalDemo3/default.aspx?server=SPF42DemoServer&API=ViewInDraw

ing&ARG1=EDG_LatestVersionsContainingDrawingItem&CLASS=SPFTEFSharedEquipment&

NAME=T-181

As shown in the following example, you must include the SECURE parameter, and set the value to true, if you are using a secure site (https).

https://spfsrv64a/spfwebportal/default.aspx?user=sbarakam&password=&secure=true&server=l

ocalhost_SPFSRV64aAUTH&api=QFindObject&arg1=ISPFDesignDocVersion&arg2=False&Crit

eria=*

Exploring the Web Portal Interface

Specify an Effective Date and Time for Viewing Data

Specify an Effective Date and Time for Viewing Data You can specify an effective date and

You can specify an effective date and time to use for viewing data using the Effective Date

command.

the data existed at a particular time in the past.

and time.

command. Your current settings display in a tooltip.

You can set the controls to view data from the SmartPlant Foundation database as

Options include Now and setting a specific date

To view your current setting, move your mouse pointer over the Effective Date

setting, move your mouse pointer over the Effective Date Effective Date Options Show data available Now

Effective Date Options

Show data available

Now - Sets the current date and time to use for viewing data.

On - Allows you to set a specific date and time.

date and Selected time. Specified date and time Selected date - Set the effective date by keying in a date or click the calendar icon.

You must set the date and time using Selected

If you click

the calendar icon, a calendar displays allowing you to select a date or navigate to a different month or year.

Selected time - Set the effective time by keying in a time or click the clock icon to set the time to

the current time.

If an invalid time is entered, the field's background color changes as a warning.

Exploring the Web Portal Interface

Setting Web Portal Preferences

the Web Portal Interface Setting Web Portal Preferences The Change User Preferences default unit of measure,

The Change User Preferences

default unit of measure, a hidden files option, and so forth.

command allows you to set a maximum query limit, a

so forth. command allows you to set a maximum query limit, a Change User Preferences Options

Change User Preferences Options

General Preferences Warning dialog number - Sets the number of results to find in a query before the software displays a warning. The warning dialog number must be less than the maximum query limit. Maximum query limit - Sets the upper limit for the number of items found in a query.

Default UOM - Sets the default unit of measurement. Select a unit of measurement from the list.

For example, a Properties window displays data using UOM as defined using this option.

setting allows you to select a display set, typically Imperial or Metric.

selected, the value appears as it was stored in the database. Picklist item display - Specifies whether item names, descriptions, or both display when picklist values are available in the user interface.

Show description in tree - Specifies whether item names and descriptions display in the tree view. Show hidden files - Turns the display of hidden files on or off. Force Uppercase in Quick search - Indicates that text should be forced into uppercase when using Quick Find.

Display internal object names -

Display internal names for user interface - Displays the internal names for items used in the graphic user interface.

This

If a default setting is not

Displays the internal object names.

Exploring the Web Portal Interface

Turn on Look Ahead - Allows you to see the number of related objects in parentheses beside expansion headings in the tree view that display particular relationships. Case sensitive quick find - Allows you to find objects in the database using case-sensitive quick finds. In a case-sensitive search, the software searches for objects that match the case of the text you type (upper case, lower case, or mixed case). This option applies to the Quick and Find tabs of the Search web part. Maximize external file viewing windows - Indicates that when you view a drawing or model in a separate window, the window is maximized. This option is only applicable when the Web Portal is configured to view drawings and models in a separate SmartPlant Markup Plus window. 3D Viewing Preferences 3D model folder - Defines the location for .VUE files. By default, this option is blank until you define a location. Streamed 3D data folder - Defines a cache location for streamed 3D data files. By default, your Temporary Internet Files folder is used to cache 3D data files. Specifying none turns off the caching. View Item in Model Symbology - Selected items Color - Choose the display color for the selected item(s). From this list box, you can choose to use the native color, as defined in the drawing, or choose Custom, and click the corresponding box to choose the color you want to use for matching items. Line weight - Choose the display line weight for the selected item. Line style - Choose the display line style for the selected item. You can choose to use the native style from the drawing or select from a number of other line styles. Render mode - Choose how you would like to have selected items display. You can have items display with the render defined in the original drawing, or you may choose to have them displayed as outlines or as solid objects with shading. View Item in Model Symbology - Other Items Display - Allows for the display of non-selected items. If this check box is not selected, only the selected will appear in the display. Color - Choose the color in which the non-selected items display. From this list box, you can choose to use the native color, as defined in the drawing, or choose Custom, and click the corresponding box to choose the color you want to use for non-selected items. Line weight - Choose the line weight you want to use to display non-selected items. Line style - Select a line style to be used to display non-selected items. You can choose to use the native style from the drawing or select from a number of other line styles. Render mode - Choose how you would like to have non-selected items display. You can have items display with the render defined in the original drawing, or you may choose to have them displayed as outlines or as solid objects with shading. Reset User Personalization - If any customization has been made to the Web Portal display, it is removed and the delivered default values return. Using this option closes your Web Portal session. You must log in again.

Exploring the Web Portal Interface

Setting the Active Scope

Exploring the Web Portal Interface Setting the Active Scope The Set Active Scope view your current

The Set Active Scope

view your current setting, move your mouse pointer over the Set Active Scope icon. current settings display in a tooltip.

command defines the active scope used for all data retrieval.

Your

To

the active scope used for all data retrieval. Your To Set Active Scope Options Set active

Set Active Scope Options

Set active configuration by query - Defines a query scope that is used for all data queries and relationship expansions. Set active configuration by roles - Defines a query scope based on selected roles. Query scope - Displays configurations in SmartPlant Foundation represented by a tree of related business objects. Only business objects whose System Administration definition supports configurations can be part of the configuration tree. Typically, configuration trees contain plants, projects, and changes. Status filter - Defines the scope status for the query. Query by selected configurations only - Initiates the query based on the currently selected configurations. Select All Scope - Selects all top configuration items. Clear Query Scope - Clears all currently selected configurations.

Exploring the Web Portal Interface

Selected roles - Click to define roles to be used in the selected configurations.

Set the Active Scope by Query

When you set the active configuration by query, the available roles are filtered by the selected query scopes.

Your query scope defines the configuration in which you want to search for data. Your
Your query scope defines the configuration in which you want to search for data.
Your role determines the features and commands available in the selected configuration.
Your create scope defines the configuration in which you can create and update objects.
1.
Click Set Active Scope
.
2.
In the Set Active Scope dialog box, select Set active configuration by query.
3.
In the Query scope list, check the box beside the configuration(s) in which you want to search
for objects.

To select all top configuration items, click Select All Scope. To select all of the projects under a plant at once, press Shift as you check the check box beside the plant. If any projects under the plant are already checked, then all projects under the plant will be unchecked when you press Shift and check the check box beside the plant.

Exploring the Web Portal Interface

Exploring the Web Portal Interface Only configurations to which you have query access appear in the

Only configurations to which you have query access appear in the list.

4. In the Status filter box, select the lifecycle status filter(s) for the configurations.

the lifecycle status filter(s) for the configurations. By default, only the active configurations are displayed in

By default, only the active configurations are displayed in the list.

To display other configurations in the list, such configurations for newly created, merged,

or completed projects, select the appropriate filter. You can use the Query by selected configurations only option to restrict queries to only the selected configurations and not higher configurations. For example, if you select Project1 in PlantA with this option checked, your queries will return only data from Project1, not from PlantA.

5. Select the appropriate user role or roles from the Selected roles list.

user role or roles from the Selected roles list. The roles in the list are the

The roles in the list are the roles that are available for the selected query configurations. Menus and actions available to you in the Desktop Client are determined by your role selection.

6. Click OK to save your changes.

Set the Active Scope by Roles

When you set the active configuration by roles, the available query scopes are filtered by the selected roles. Setting the configuration by role is useful if you have two or more roles in your organization and you need to work in one of those roles across projects. The list of roles contains all of the roles to which you have access. As you select roles, the list of available configurations changes to show all of the configurations in which you have the selected roles. A configuration is displayed only if you have access to all of the selected roles in that configuration.

to all of the selected roles in that configuration. Your query scope defines the configuration in

Your query scope defines the configuration in which you want to search for data.

Your role determines the features and commands available in the selected configuration.

Your create scope defines the configuration in which you can create and update objects.

1.

Click Set Active Scope

.
.

Exploring the Web Portal Interface

2. In the Set Active Scope dialog box, select Set active configuration by roles.

dialog box, select Set active configuration by roles . 3. Select the appropriate user role or

3. Select the appropriate user role or roles from the Selected roles list.

The roles in the list are all of the roles available to you. Your role selection determines the configurations that are available in the Query scope list.

4. In the Query scope list, check the box beside the configuration(s) in which you want to search for objects.

To select all of the projects under a plant at once, press Shift as you check the check box beside the under a plant at once, press Shift as you check the check box beside the plant. If any projects under the plant are already checked, then all projects under the plant will be unchecked when you press Shift and check the check box beside the plant.

you press Shift and check the check box beside the plant. Only configurations to which you
you press Shift and check the check box beside the plant. Only configurations to which you

Only configurations to which you have query access appear in the list.

5. In the Status filter box, select the lifecycle status filter(s) for the configurations.

the lifecycle status filter(s) for the configurations. By default, only the active configurations are displayed in

By default, only the active configurations are displayed in the list. To display other configurations in the list, such configurations for newly created, merged, or completed projects, select the appropriate filter. You can use the Query by selected configurations only option to restrict queries to only the selected configurations and not higher configurations. For example, if you select

Exploring the Web Portal Interface

Project1 in PlantA with this option checked, your queries will return only data from Project1, not from PlantA.

6. Click OK to save your changes

S ECTION

3

Searching for Objects

The SmartPlant Foundation Web Portal Search web part allows you to find objects based on your search criteria. You can perform many types of searches in SmartPlant Foundation. Search results display in the List web part, the Discover web part, or both web parts.

Quick Find Toolbar

There are two primary configurations of the Search web part. In the default Web Portal, the Search web part is configured as a Quick Find toolbar. To search for objects, select the item type from the Item Type list, enter search criteria in the Name box, and then click Search. The Quick Find toolbar offers the same functionality as the Quick Tab in the full Search web part.

as the Quick Tab in the full Search web part. Full Search Web Part The Search

Full Search Web Part

The Search web part can also be configured to display multiple tabs, with several types of searches available.

multiple tabs, with several types of searches available. If the user preference Case sensitive quick find
multiple tabs, with several types of searches available. If the user preference Case sensitive quick find

If the user preference Case sensitive quick find is turned on, searches performed on the Quick tab and the Find tab are case sensitive. By default, this option is not checked; therefore, SmartPlant Foundation ignores whether the text you type is in upper-case, lower-case, or mixed case. The full Search web part contains the following tabs: Quick, Find, Content, Query, and Saved.

Searching for Objects

Quick Tab

Allows you to search for various objects using all or part of the object's name. During a quick find, you can specify the object name, part of the name, or a combination of the name and the valid wildcard characters (for example, n%).

name and the valid wildcard characters (for example, n% ). Quick Tab Options The following wildcards

Quick Tab Options

The following wildcards can be applied to searches for fine tuning:

? - Finds any single character * - Finds any string of characters % - Performs the same function as * Item type - Defines the item type you want to query.

Name

Force upper case - Forces text into uppercase for the current search. defined on the User Preferences dialog box.

- Defines the name of the object to find.

The default value can be

Searching for Objects

Enhanced Quick Search Tab

The Quick search also has an extended, or enhanced, version. The extended version offers the same functionality as the regular version, plus the ability to specify a description as well as a name as part of the search criteria. This enhanced Quick search is turned off by default, but can be enabled through customization of the Web Portal.

but can be enabled through customization of the Web Portal. Leaving the Description box blank returns

Leaving the Description box blank returns all items that match the other criteria on the tab (the items' descriptions are ignored). Typing an asterisk (*) in the Description box returns items that have any description and match the other criteria on the tab.

Find Tab

Allows you to search by name for objects of the selected type. The tree view displays the available types.

selected type. The tree view displays the available types. When you click a type in the

When you click a type in the tree view, the Find <Object> dialog box appears. For example, the Find Reports dialog box is shown below.

appears. For example, the Find Reports dialog box is shown below. SmartPlant Foundation Web Portal User's

Searching for Objects

Name - Defines the name of the object to find. Force upper case - Forces text into uppercase.

The Find tab is available only on the full Search web part. If your Web Portal Find tab is available only on the full Search web part. If your Web Portal is configured with the Quick Find toolbar, you do not see this functionality.

Content Tab

Allows you to search by entering the specific name of an object. Enter the * as a wildcard to search for all objects. You can display properties only, or properties and content, and matching objects or files.

or properties and content, and matching objects or files. Text to search - Defines the name

Text to search - Defines the name of the object to find. Type the name in the field. Properties - Select to search only properties of an object. Properties and content - Select to search the properties and content of an object. Display matching objects - Displays matching objects. If the matching object is a file, the parent object displays. Displays matching files - Displays matching files including any file objects.

The Content tab is available only on the full Search web part. If your Web Portal Content tab is available only on the full Search web part. If your Web Portal is configured with the Quick Find toolbar, you do not see this functionality.

Query Tab

Allows you to use wizards to query classes. Available queries include classification, attributes and properties, and so on. Classes include:

QueryObject

QueryClassObj

QueryClassObjFromClass

QueryByContainer

The following details describe the available wizard pages. Buttons that display at the bottom of each wizard page are only enabled when a selection or required information for that page is completed.

Searching for Objects

1. The Query Wizard page of the wizard displays a tree view composed of nodes based on the available methods that use the API classes. Select the node in the treeview that you want to query. Click Next.

node in the treeview that you want to query. Click Next . 2. The next wizard

2. The next wizard page allows you to select the classification of the object. Select the node in

Click Next.

the tree view that you want to query.

the node in Click Next . the tree view that you want to query. SmartPlant Foundation

Searching for Objects

3. The next wizard page allows you to define attribute and property values to use for the query. You can define attribute and property values by entering a name and description. You can also provide status and title details. Click Collapse sections automatically to close all open sections as soon as another section is opened. Click Next or click Save to save the current query.

Click Next or click Save to save the current query. 4. The Query by Container page

4. The Query by Container page is only available if you selected this type on the initial wizard

page.

for the saved query object. the Saved tab grid.

A saved query displays on the Saved tab.

You can provide a name and description

Information entered in the GUI display as field also displays on

Information entered in the GUI display as field also displays on 38 SmartPlant Foundation Web Portal

Searching for Objects

5. Click Finish.

The Query tab is available only on the full Search web part. If your Web Portal Query tab is available only on the full Search web part. If your Web Portal is configured with the Quick Find toolbar, you do not see this functionality.

Saved Tab

Lists your saved queries. You can edit and execute the saved queries. When a saved query is executed, the results display in the Discover and List web parts. After you define your search criteria for a query, you can save that query and run it again later. After you save queries, you can update the search criteria contained in queries.

you can update the search criteria contained in queries. Save Query List for <username> - Displays

Save Query List for <username> - Displays the user name of the user who saved the query list. Edit - Select to edit the query. The selected query displays on the Query tab.

Be sure to click Save on the Edit Saved Query dialog box to save the changes you make to Save on the Edit Saved Query dialog box to save the changes you make to the search criteria. Only clicking Apply or Finish runs the query with your new criteria, but does not save your changes. Search - Executes the query. The results display in the Discover and List web parts.

What do you want to do?

Search for items with a particular name (on page 40)

Search properties and content of an object (on page 40)

Run a Saved Query from the Discover Web Part (on page 40)

Searching for Objects

Search for items with a particular name

1. On the Quick tab of the Search web part, or on the Quick Find toolbar, enter a name in the

Name field you want to find.

a search for documents.

For example, type in Document or D* (using a wildcard) to start

2. Click Search. Your search results display in the Discover and List web parts.

Search properties and content of an object

1. On the Content tab of the Search web part, enter text in the Text to search field. You can also use a wildcard value for your search.

2. Select Properties and content.

3. Select either Display matching objects or Display matching files to search either objects or files. Your search results appear in the Discover web part tree as Search Results.

The properties and content search is available only on the full Search web part. If your Web Portal is configured with the Quick Find toolbar, you do not see this functionality.

the Quick Find toolbar, you do not see this functionality. Run a saved query from the

Run a saved query from the Discover web part

When you save a query, the query also appears under the Saved Queries node of the Discover tree view.

under the Saved Queries node of the Discover tree view. Click the query in the tree

Click the query in the tree view. The query appears in the Review web part.

the tree view. The query appears in the Review web part. Click Run Saved Query on

Click Run Saved Query on the Actions tab to run the query. The results display in the List web part. Click Edit Saved Query to use the Edit dialog box to edit the criteria for the query.

Searching for Objects

Searching for Objects Be sure to click Save on the Edit Saved Query dialog box to

Be sure to click Save on the Edit Saved Query dialog box to save the changes you make to the search criteria. Only clicking Apply or Finish runs the query with your new criteria, but does not save your changes.

Searching for Objects

S ECTION

4

Using the List View

The SmartPlant Foundation Web Portal List web part displays results based on your search criteria and related items expansions. Each time a new search, query, or expansion is executed,

the previous results are replaced. The displayed columns can be alphabetically sorted by clicking

on the header of a column. Microsoft Excel.

The columns displayed in this web part are determined by column sets that are created and configured in the Desktop Client. See the Desktop Client User's Guide and the How to Configure the GUI Model administration guide for more information about column sets. The Name column information is a hyperlink. Clicking an item in the Name column displays the object in the Review web part. Any viewable files for the object display in the View web part.

You can also print the displayed content or display the content in

also print t he displayed content or display the content in List View Options Print Contents
also print t he displayed content or display the content in List View Options Print Contents

List View Options

content or display the content in List View Options Print Contents - Prints the contents of

Print Contents - Prints the contents of all rows in the list.

Print Window - Prints only the displayed part of the list.

Extract list to Excel - Moves the list to Microsoft Excel. You can open the file or save the file. The two following options are available if tabs are enabled in the List web part. Tabs are enabled by default, but can be disabled through customization.

by default, but can be disabled through customization. Close Active Tab - Closes the active tab.

Close Active Tab - Closes the active tab.

customization. Close Active Tab - Closes the active tab. Close All Tabs - Closes all the

Close All Tabs - Closes all the tabs in the list. The following option is available if tabs are not enabled in the List web part.

is available if tabs are not enabled in the List web part. Clear List View -

Clear List View - Removes the displayed information.

Using the List View

What do you want to do?

Sort a list (on page 44) Print the complete contents of a search (on page 44) Print only what displays on your monitor in the List web part (on page 44) Create a Microsoft Excel spreadsheet containing your search results (on page 45)

Sort a list

Click the header of a column. The rows in the list are sorted according to the values in the selected column. If the sort order is ascending, an up-arrow icon in the column header indicates that the list is sorted by this column in ascending order. A down-arrow icon in the column header indicates that the list is sorted by this column in descending order.

that the list is sorted by this column in descending order. Print the complete contents of

Print the complete contents of a search

1. Complete a search.

2. Click in the List web part.

Your search results display in the List web part.

3. Click Print Contents

.
.

Print only what displays on your monitor in the List web part

1. Complete a search. Your search results display in the List web part.

2. Arrange the List web part so that the content displays as you want it to print.

3. Click Print Window

4. Click Print to print the contents or Close to dismiss the window.

to print the contents or Close to dismiss the window. . A preview of your print

. A preview of your print job displays.

Using the List View

Create a Microsoft Excel spreadsheet containing your search results

1. Complete a search. Your search results display in the List web part.

2. Click Extract list to Excel

3. Click Open to display the search results in Microsoft Excel, or click Save to save the file.

.
.

Using the List View

S ECTION

5

Using the Discover View

The SmartPlant Foundation Web Portal Discover web part contains a hierarchy used for navigating the data in the SmartPlant Foundation database. The default tree is based on your user access and configuration settings defined by your system administrator. When you expand a tree node, the active scope you have selected appears in the title bar of the tree view. The text displayed in the tree nodes can be the name, or the name and description (depending on User Preference settings).

Once the Web Portal is activated, make sure the query scope and role is set. If the query scope and role are not set, you will not be able to view or expand branches in the tree view.

not be able to view or expand branches in the tree view. Like Windows Explorer, you
not be able to view or expand branches in the tree view. Like Windows Explorer, you

Like Windows Explorer, you can expand and close nodes in the tree view to show and hide information in the database. When you expand a node in the tree view, the software expands the default relationship for the object. For example, expanding the DEV Equipment, Equipment type level-0 node in the tree view displays an existing plant and equipment. The default relationship for each object is defined by the system administrator.

for each object is defined by t he system administrator. If you enable the Look Ahead

If you enable the Look Ahead option, you can see the number of objects included in the relationship beside the expansion heading in the tree view. In the previous example, there are two equipment types defined in SmartPlant Foundation, designated by the number 2 in brackets.

Using the Discover View

When a search or relationship expansion is executed, the tree view in the Discover web part displays the results in the last top-level node in the tree. The Search Results node is the parent of all of the resulting values and displays the number of items returned as a tooltip. If there are no child nodes under Search Results, no results were found. This is always only one Search Results node and by default, it displays last in the tree. Subsequent search of expansion commands clears the previous results.

search of expansion commands clears the previous results. If you define values for the Warning dialog

If you define values for the Warning dialog number and the Maximum query limit options on

the Change User Preferences dialog box, a warning message displays when the query results

exceeds your warning dialog number but is less than your defined query limit.

continue running the query and display the query results.

If your Maximum query limit is reached, a separate warning message displays to inform you that, if displayed, your query exceeds your defined query limit value. Click OK to display the results. The total results displayed defaults to your defined query limit value. Click Cancel to stop the query.

To clear all expansions and reset the tree view back to its original state, click Clear Tree . Click

Click OK to

Or, click Cancel to stop the query.

. Click Click OK to Or, click Cancel to stop the query. Collapse All to close
. Click Click OK to Or, click Cancel to stop the query. Collapse All to close

Collapse All to close all expanded tree branches.

What do you want to do?

Clear the Search Results tree (on page 48) View a text description in the tree (on page 49)

Clear the Search Results tree

in the tree (on page 49) Clear the Search Results tree Click Clear Tree expansions that

Click Clear Tree

expansions that are displayed.

. This command resets the tree view to its original state by clearing any

Using the Discover View

View a text description in the tree

Place a check mark in the Show Description in Tree checkbox on the Change User Preferences dialog box.

Using the Discover View

S ECTION

6

Viewing Drawings and Graphics

The SmartPlant Foundation Web Portal View web part displays drawings, models, and other documents. SmartPlant 3D and PDS models display using the SmartPlant Foundation 3D View Control. See Using the SmartPlant Foundation 3D View Control (on page 54) for more information. If you choose to display a model in SmartPlant Review, you must have SmartPlant Review installed on the client computer. All other documents display using SmartPlant Markup Plus or by selecting View in Native. You can create and edit markup layers but you must have SmartPlant Markup Plus installed on the client computer.

All published drawings, published SmartPlant 3D models, and SmartConverted drawings can contain hotspots. Left-clicking on a hotspot item displays the item properties, actions, and related items in the Review web part. There are several ways you can view files:

Select a viewable file in the List or Discover web part, Select a document with viewable files in the List or Discover web part, Select one of the Viewing Actions (for example, View and Markup) on the Review web part Actions tab.

If you are viewing a SmartPlant P&ID typical plant item, the following layers display by default:

Typicals,

TypicalsNotes,

TypicalsLabels,

TypicalsHT,

TypicalsHeatTrace,

TypicalsConsistencyChecks.

By default, the following layers do not display when viewing a SmartPlant P&ID typical plant item:

Default,

Labels,

HeatTrace.

Viewing Drawings and Graphics

The following is an example of the View web part. It displays a SmartPlant P&ID drawing using SmartPlant Markup Plus.

a SmartPlant P&ID drawing using SmartPlant Markup Plus. Based on how your Web Portal is configured,

Based on how your Web Portal is configured, you can view drawings and models in either the View web part or in a separate SmartPlant Markup Plus window.

If you are using the View web part, you do not have the ability to use SmartPlant Markup

Plus layers, but you can use navigation and hotspotting on published 3D models and 2D drawings. If you are using a separate SmartPlant Markup Plus window, you cannot use navigation

and hotspotting on published 3D models, but you can use SmartPlant Markup Plus layers. For more information, see the SmartPlant Web Portal Customization Guide

(SPFWebPortalCustomization.chm) delivered with the SmartPlant Foundation programming documentation. The drawing can display in either SmartPlant Markup Plus or SmartPlant Review (depending on file requirements). To use SmartPlant Review or SmartPlant Markup Plus, the products must be installed. For details about using either product's command, please refer to the documentation delivered with that product.

What do you want to do?

View a design document (on page 53)

View a drawing (on page 53)

View an object in a drawing (on page 53)

Viewing Drawings and Graphics

View a design document

1. Search for a document, and then select a document.

2. In the Review web part, select the Actions tab.

3. Click View and Markup.

4. In the List web part, select a design document. The design document displays in the View web part using SmartPlant Markup Plus.

View a drawing

1. In the Search web part, click the Find tab.

2. Expand the Published Data tree and click Published Documents.

3. Select a SmartPlant P&ID drawing in the List web part. The drawing displays in the View web part using SmartPlant Markup Plus.

To clear the viewing area, click Clear contents . You can also click the title bar drop-down arrow and click Clear Clear contents. You can also click the title bar drop-down arrow and click Clear.

View an object in a drawing

1. In the Search web part, click the Find tab.

2. Expand the Published Data tree.

3. Select a plant item type (for example, equipment or instruments).

4. Search for a plant item.

5. In the Review web part, click the Actions tab.

6. Select View Item in Drawing. Select View Item in Model if you want to view a SmartPlant 3D model. SmartPlant 3D and PDS models display using the SmartPlant Foundation 3D View Control. For more information about using the SmartPlant Foundation 3D View Control, see Using the SmartPlant Foundation 3D View Control (on page 54).

the SmartPlant Foundation 3D View Control (on page 54). If you select View Item in Model

If you select View Item in Model, the item displays in Rotate mode by default.

You can review the objects properties on the Properties tab in the Review web part.

Viewing Drawings and Graphics

Using the SmartPlant Foundation 3D View Control

The SmartPlant Foundation Web Portal View web part displays SmartPlant 3D and PDS models using the SmartPlant Foundation 3D View Control.

PDS models using the SmartPlant Foundation 3D View Control. See Also 3D Navigation Controls (on page

See Also

3D Navigation Controls (on page 54) Use Keyboard-Only 3D Navigation (on page 56) Use Mouse Only or Mouse + Keyboard Combinations (Fly Mode) (on page 57) Use the 3D Navigator (on page 59) 3D Navigation Tips (on page 63)

3D Navigation Controls

Select navigation controls that are most comfortable or familiar to you. To access

navigation-specific help at any time, press Q or click the Help control access additional product help, press F1 or go to the Help menu.

product help, press F1 or go to the Help menu. in the 3D Navigator . To

in the 3D Navigator. To

Viewing Drawings and Graphics

Use the 3D Navigator (on page 59)

Use Keyboard Controls

Arrow keys as well as the gaming standard W (Move In), A (Left), S (Move Out) and D (Right) are supported.

A (Left), S (Move Out) and D (Right) are supported. Use Mouse Controls (Fly Mode) Press

Use Mouse Controls (Fly Mode)

Press F to enable Fly mode. You have the option to use just your mouse for navigation or use keyboard + mouse combinations.

your mouse for navigation or use keyboard + mouse combinations. SmartPlant Foundation Web Portal User's Guide

Viewing Drawings and Graphics

Application-Specific Information

The 3D Navigation component is integrated into the following Intergraph Process, Power & Marine applications:

SmartPlant Review SmartPlant 3D, SmartMarine 3D SmartPlant Construction SmartPlant Markup Plus

Any information or behavior that is specific to an application is noted. If your application is not listed, then there is no additional information.

is not listed, then there is no additional information. See Graphics Card Information (on page 65)

See Graphics Card Information (on page 65) for the basic requirements needed for 3D navigation. You can press and hold the 3D Navigator Look and Move controls for continuous motion.

needed for 3D navigation. You can press and hold the 3D Navigator Look and Move controls
needed for 3D navigation. You can press and hold the 3D Navigator Look and Move controls

needed for 3D navigation. You can press and hold the 3D Navigator Look and Move controls
needed for 3D navigation. You can press and hold the 3D Navigator Look and Move controls

Press and hold the center Move control on/off the view window.

Press and hold the center Move control on/off the view window. to drag the 3D Navigator

to drag the 3D Navigator to a different location

Use Keyboard-Only 3D Navigation

You can use the keys below for 3D navigation. The keyboard can be used at all times to move through the model data set.

The use of WASD keys offers an ergonomic solution when used in conjunction with a right-handed mouse. solution when used in conjunction with a right-handed mouse.

To

Use

Open quick-help to get information on 3D navigation controls

Q

Move in

W

Move Left

A

Move out

S

Move right

D

Move up

E

Move down

C

S Move right D Move up E Move down C To move or walk through your

To move or walk through your model in a first-person perspective. Press and hold the designated direction key. Move left and right is a sidestepping motion.

To

Use

Move forward and left.

W

+ A

Move forward and right

W

+ D

Move backward and left

S

+ A

Move backward and right

S

+ D

Viewing Drawings and Graphics

Viewing Drawings and Graphics Walk at various angles through your model. Hold down the desired two

Walk at various angles through your model. Hold down the desired two direction keys simultaneously.

To

Use

Look up

I

Look left

J

Look down

K

Look right

L

Look around the model as if you were turning your head. Simply move the mouse up/down, left/right from the crosshair point. your head. Simply move the mouse up/down, left/right from the crosshair point.

To

Use

Return to the default, isometric home view of your model

H

Create your own custom home view

CTRL+H

Reset a customized home view back to the original default home view

CTRL+SHIF

T+H

back to the original default home view CTRL+SHIF T+H Press the H key if you are

Press the H key if you are 'lost' in the model or need to return to the default model view.

Use Mouse Only or Mouse + Keyboard Combinations (Fly Mode)

Fly mode offers a fluid, first-person movement in any direction within your model. In Fly mode operation, use your mouse to look around as well as work in conjunction with your keyboard for motion in all directions. You change the viewing direction with the mouse and move around with the keyboard. By using mouse-only or mouse + keyboard controls, you can:

Look 360 degrees around from a stationary point. Travel through your model and move up/down stairs and ramps Move sideways in a sidestepping motion. Move up and down to change your elevation.

motion. Move up and down to change your elevation. When you are in Fly mode, your

When you are in Fly mode, your cursor changes to a crosshair that is located at the center of your view window. When you exit Fly mode, the cursor changes back to its original pointer.

Application-Specific Information

SmartPlant/SmartMarine 3D Fly Mode Information When you exit Fly mode, right-click or press ESC twice to exit 3D navigation.

SmartPlant Construction Fly Mode Information To encircle or rotate around a selected object, use the SmartPlant Construction Encircle Model command in the Toolbox. In SmartPlant Construction, you will not be able to use the left-mouse drag operation to encircle objects.

Viewing Drawings and Graphics

Fly mode actions:

To

 

Use

Open quick-help to get information on 3D navigation

Q

Enter/Exit Fly mode

F

(Toggle to enter/exit)

Exit fly mode, cancel all fly mode operations

F

again (Toggle on/off), ESC or

right-click

Turn on/off crosshair

X

(Toggle on/off)

Enter and exit fly mode to use mouse and keyboard combination navigation controls.

To

Use

Move in

Mouse Wheel Forward -or- W

Move in (factor of 2)

Middle Mouse Button/Wheel Click

Move left

A

Move out

Mouse Wheel Backward -or- S

Move out

(factor of 2)

SHIFT + Middle Mouse Button/Wheel Click

Move right

D

Move up

E

Move down

C

Walk through your model in the direction of the crosshair. Roll the middle mouse wheel forward and back, or press and hold the designated WASD key. A left or right move is a sidestepping motion. A middle mouse click moves you halfway in to your target point. Use SHIFT + middle mouse click to move back out the distance of the eye point from the target. The perspective angle does not change.

To

 

Use

 

Move in and left.