Vous êtes sur la page 1sur 71

SmartPlant Foundation

Web Portal Samples Overview

Version 2014 R2

September 2014

DSPF1-PE-200080F
Copyright
Copyright © 2008-2014 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
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.
Portions of the user interface copyright 2012-2014 Telerik AD.

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
300 Intergraph Way
Huntsville, AL 35813

Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.

Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.

Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
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.

2 SmartPlant Foundation Web Portal Samples Overview


Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
e. Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN,
SmartSketch, SPOOLGEN, SupportManager, SupportModeler, Sapphire, and FreeView 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.

SmartPlant Foundation Web Portal Samples Overview 3


4 SmartPlant Foundation Web Portal Samples Overview
Contents
Preface .......................................................................................................................................................... 7
Categorized Guide to Sample Contents ................................................................................................. 7
Documentation Comments ..................................................................................................................... 9

ChartReports .............................................................................................................................................. 11

CustomizationDemo .................................................................................................................................. 13

CustomProjectSearchMenu...................................................................................................................... 15

DefaultPageWithThemeChooser .............................................................................................................. 17

ExternalSourceLinks ................................................................................................................................. 19

LayoutDemoFiles....................................................................................................................................... 21

ProjectOverviewPage ................................................................................................................................ 23

SiteLocator ................................................................................................................................................. 25

SPFAppLayoutControl .............................................................................................................................. 27

SPFAttachFiles .......................................................................................................................................... 29

SPFChartReport ......................................................................................................................................... 31

SPFCustomApplicationInSingleWindow ................................................................................................. 33

SPFCustomAttachWorkflow ..................................................................................................................... 35

SPFCustomCreateComment .................................................................................................................... 37

SPFCustomFindAndClick ......................................................................................................................... 39

SPFCustomReview .................................................................................................................................... 41

SPFCustomRoleBasedSecurity ............................................................................................................... 43

SPFCustomSearch .................................................................................................................................... 45

SPFCustomView ........................................................................................................................................ 47

SPFCustomWebPortalAPIs ...................................................................................................................... 49

SPFFileUploadTask ................................................................................................................................... 51

SmartPlant Foundation Web Portal Samples Overview 5


Contents

SPFLightWeight3D .................................................................................................................................... 53

SPFReportsControl ................................................................................................................................... 55

SPFReportLinkListControl ....................................................................................................................... 57

SPFSharePointInteractions ...................................................................................................................... 59

SPFSummaryView ..................................................................................................................................... 63

SPFURLViewer........................................................................................................................................... 65

SPFWebPortalSpy ..................................................................................................................................... 67

ViewWebPart2D3D..................................................................................................................................... 69

Index ........................................................................................................................................................... 71

6 SmartPlant Foundation Web Portal Samples Overview


Preface
The SmartPlant Foundation Web Portal is configurable and customizable. Style sheets, along
with skin files and images, make up a theme to change the display of the web parts. New
actions configured in SmartPlant Foundation are exposed in the Web Portal Review web part.
Custom code overrides and extends Web Portal web part behavior. Finally, new web parts
added to the Web Portal allow implementation of custom clients.
This document gives a brief overview of the customization samples available for the Web Portal.
These samples serve as training examples and starting points for further customization. For
more information about the samples, see the SmartPlant Foundation Web Portal Customization
Guide.
Each sample listed in this document is available for download from Intergraph Smart Support
Online (https://smartsupport.intergraph.com), under the Freeware Tools and Utilities section of
the SmartPlant Foundation product page. Each sample folder contains a Readme file that
describes the purpose of the sample, including screenshots, as well as information detailing how
to configure or compile that sample for your specific version of SmartPlant Foundation. In some
cases, the folder may contain sample HTML code and pre-built sample web pages.

Categorized Guide to Sample Contents


The Web Portal samples can be divided into the following categories. Some samples belong to
multiple categories.

Sample Pages
 ChartReports (on page 11)
 CustomizationDemo (on page 13)
 DefaultPageWithThemeChooser (on page 17)
 LayoutDemoFiles (on page 21)
 ProjectOverviewPage (on page 23)
 SiteLocator (on page 25)
 SPFAppLayoutControl (on page 27)
 SPFChartReport (on page 31)
 SPFCustomRoleBasedSecurity (on page 43)
 SPFReportsControl (on page 55)
 SPFReportLinkListControl (on page 57)
 SPFSharePointInteractions (on page 59)
 ViewWebPart2D3D (on page 69)

SmartPlant Foundation Web Portal Samples Overview 7


Preface

Customization (User Functions and Controls)


 CustomizationDemo (on page 13)
 CustomProjectSearchMenu (on page 15)
 DefaultPageWithThemeChooser (on page 17)
 ExternalSourceLinks (on page 19)
 SiteLocator (on page 25)
 SPFCustomRoleBasedSecurity (on page 43)
 SPFLightWeight3D (on page 53)
 SPFSharePointInteractions (on page 59)
 SPFURLViewer (on page 65)

Customization (Implementation Tools)


 ChartReports (on page 11)
 SPFAppLayoutControl (on page 27)
 SPFAttachFiles (on page 29)
 SPFChartReport (on page 31)
 SPFCustomApplicationInSingleWindow (on page 33)
 SPFCustomAttachWorkflow (on page 35)
 SPFCustomCreateComment (on page 37)
 SPFCustomFindAndClick (on page 39)
 SPFCustomReview (on page 41)
 SPFCustomSearch (on page 45)
 SPFCustomView (on page 47)
 SPFCustomWebPortalAPIs (on page 49)
 SPFFileUploadTask (on page 51)
 SPFReportsControl (on page 55)
 SPFReportLinkListControl (on page 57)
 SPFWebPortalSpy (on page 67)

Event Monitor (Spy)


 SPFWebPortalSpy (on page 67)

Sample Included with Default Web Portal


The following sample has been added as a default component of the Web Portal.
 SPFSummaryView (on page 63)

8 SmartPlant Foundation Web Portal Samples Overview


Preface

Documentation Comments
Send documentation comments or suggestions to PPMdoc@intergraph.com
(mailto:ppmdoc@intergraph.com?subject=documentation comments).

SmartPlant Foundation Web Portal Samples Overview 9


Preface

10 SmartPlant Foundation Web Portal Samples Overview


SECTION 1

ChartReports
The SmartPlant Foundation Chart Report sample shows you how to configure chart reports by
using the SPFWebPortalChartReport Web part delivered with SmartPlant Foundation.
By setting up the SPFWebPortalChartReport Web part, you can view document trend charts and
document reports for created design documents, published P&ID drawings, published Smart 3D
documents, published instruments and equipments, and published pipelines.
An example chart report is illustrated below:

SmartPlant Foundation Web Portal Samples Overview 11


ChartReports

12 SmartPlant Foundation Web Portal Samples Overview


SECTION 2

CustomizationDemo
This sample demo page and custom theme are intended to be used as a learning example on
how to make the various changes possible in the portal. A PowerPoint file is included with
details on all of the changes that were made for the demo.
To see this in action, copy the defaultCustomizationDemo.aspx page to the Web Portal virtual
directory, copy the SPFCustomizationDemo theme to the App_Themes directory under the Web
Portal virtual directory and run with the following URL:
http://MyServer/MyWebPortal/defaultCustomizationDemo.aspx

SmartPlant Foundation Web Portal Samples Overview 13


CustomizationDemo

14 SmartPlant Foundation Web Portal Samples Overview


SECTION 3

CustomProjectSearchMenu
The CustomProjectSearchMenu sample explains how to set up and configure a custom menu
displayed on a new tab in the Search web part. A nested tree of hyperlinks can be created, each
one linking to an external source such as a web page with the target of the link displaying in the
View web part or in a new window or a Quick Find command.

SmartPlant Foundation Web Portal Samples Overview 15


CustomProjectSearchMenu

16 SmartPlant Foundation Web Portal Samples Overview


SECTION 4

DefaultPageWithThemeChooser
The Default Page with Theme Chooser sample shows you how to add a control to the
SmartPlant Foundation Web Portal that allows a user to select the theme applied to the Web
Portal interface for that user.
The illustration below shows the control, in the upper-right of the window, available to a logged
in user.

SmartPlant Foundation Web Portal Samples Overview 17


DefaultPageWithThemeChooser

18 SmartPlant Foundation Web Portal Samples Overview


SECTION 5

ExternalSourceLinks
The ExternalSourceLinks sample explains how to set up and configure a Links menu item in the
Discover web part. A nested tree of hyperlinks can be created, each one linking to an external
source such as a web page, with the target of the link displaying in the View web part.

SmartPlant Foundation Web Portal Samples Overview 19


ExternalSourceLinks

20 SmartPlant Foundation Web Portal Samples Overview


SECTION 6

LayoutDemoFiles
The Layout Demo Files sample was designed to show the flexibility of page layout capable with
the Web Portal. This sample includes several different pages that can be accessed using the
DemoDriver page. Each page has a specific target audience. Some of the pages include some
automated scripts that execute to do actions on startup or when certain types of objects are
selected.
The requisite jQuery libraries and plug-in required for some pages in this sample are not
delivered with SmartPlant Foundation. An administrator desiring to enable this sample will have
to download the libraries and place them in the proper place in their virtual directory. Those files,
along with the sample files delivered in this sample, will enable the resizing capability in the
sample pages that use it. As implemented, the resizing is allowed below the Brain web part and
between the web part zones. Individual parts within a zone are still handled using the
auto-resize capability. Individual parts can be minimized and the available space in the zone will
be distributed among the parts in the zone according to the weights assigned to them in the skin
file of the selected theme. See the JQueryResize sample for more information.

SmartPlant Foundation Web Portal Samples Overview 21


LayoutDemoFiles

22 SmartPlant Foundation Web Portal Samples Overview


SECTION 7

ProjectOverviewPage
The ProjectOverviewPage sample was created to be part of the Document Portal application
and serves as an example. This page is intended to give users a more graphical indication of
active projects to increase the ease of identifying and accessing projects while eliminating the
need for a multitude of favorite links or other burdening collection process. In the delivered
sample, navigation icons rotate until the user hovers over the control which will cause the
rotation to pause and a tooltip with the object description to be displayed. Any navigation icon
can be selected regardless of the placement in the control.

SmartPlant Foundation Web Portal Samples Overview 23


ProjectOverviewPage

24 SmartPlant Foundation Web Portal Samples Overview


SECTION 8

SiteLocator
The SiteLocator sample allows you to create a graphical representation of where a user's plant
are located around the world. Clicking on a plant on the map displays information related to that
plant. This sample uses the Bing maps interface as a foundation.

SmartPlant Foundation Web Portal Samples Overview 25


SiteLocator

26 SmartPlant Foundation Web Portal Samples Overview


SECTION 9

SPFAppLayoutControl
The Portal Layout model was created to be part of the Web Portal application. The model
facilitates having different layouts for each application. You can have different layouts for
different logins for the same application with this model by using role/layout management.
The control is illustrated below, in the upper-left corner, below the Brain web part.

SmartPlant Foundation Web Portal Samples Overview 27


SPFAppLayoutControl

28 SmartPlant Foundation Web Portal Samples Overview


SECTION 10

SPFAttachFiles
The AttachFile client API, which is delivered as a Web Portal sample, allows Web Portal users
to attach files to existing documents. This sample allows users to use the Submit Document
action in the Review web part to attach files to an existing document.

The AttachFile API does not support reference file functionality, which is available from
the SmartPlant Foundation Desktop Client.

SmartPlant Foundation Web Portal Samples Overview 29


SPFAttachFiles

30 SmartPlant Foundation Web Portal Samples Overview


SECTION 11

SPFChartReport
The SPFChartReport control displays dashboard type charts to indicate several data/status
reports of the current project. The bar or pie charts are defined using and XML file and
templates.

SmartPlant Foundation Web Portal Samples Overview 31


SPFChartReport

32 SmartPlant Foundation Web Portal Samples Overview


SECTION 12

SPFCustomApplicationInSingleWindow
This sample demonstrates an approach for custom applications to display multiple items or
drawings in a single window. Normally when a SmartPlant Foundation Web Portal URL is called,
a new instance of Internet Explorer or a new tab is invoked. With this approach, the initial call to
a portal page is opened in a new instance of Internet Explorer and subsequent calls are
captured and treated like object select actions. With the appropriate settings in the invoked file,
multiple drawings can be displayed using tabs in a single View control, for example. In this
sample, two different URLs have been invoked by clicking hyperlinks in a separate application
but the two drawings referenced by those links display in the same window on tabs.

SmartPlant Foundation Web Portal Samples Overview 33


SPFCustomApplicationInSingleWindow

34 SmartPlant Foundation Web Portal Samples Overview


SECTION 13

SPFCustomAttachWorkflow
The SPFCustomAttachWorkflow sample demonstrates how to add a new action menu item to
the Review web part Actions tab. In addition, the command demonstrates how to attach a
workflow to an object. This API can be added to a Web Portal by running the load file provided
with the sample and updating the web.config file as described in the SmartPlant Foundation
Web Portal Customization Guide. The executeAPI method in the API class provides the
necessary code for attaching a custom workflow to an object.

SmartPlant Foundation Web Portal Samples Overview 35


SPFCustomAttachWorkflow

36 SmartPlant Foundation Web Portal Samples Overview


SECTION 14

SPFCustomCreateComment
The SPFCustomCreateComment sample demonstrates how to execute a custom API that is
found in the Actions tab of the Review web part. This API is added to a Web Portal by running
the load file and updating the web.config file as described in the SmartPlant Foundation Web
Portal Customization Guide. This API demonstrates how to launch a dialog from an API. It also
shows how to create a new (note) object that is related to the selected instrument object.

SmartPlant Foundation Web Portal Samples Overview 37


SPFCustomCreateComment

38 SmartPlant Foundation Web Portal Samples Overview


SECTION 15

SPFCustomFindAndClick
The SPFCustomFindAndClick sample demonstrates how to execute a custom API that is found
in the quick find menu drop-down list. This API is added to a Web Portal by running the load file
and updating the web.config file as described in the SmartPlant Foundation Web Portal
Customization Guide.
This API demonstrates how to do a custom quick find and show properties of an object without
the user having to click on the object.

SmartPlant Foundation Web Portal Samples Overview 39


SPFCustomFindAndClick

40 SmartPlant Foundation Web Portal Samples Overview


SECTION 16

SPFCustomReview
The SPFCustomReview sample demonstrates how to inherit from a SPFWebPart and then
change the web part. This example project takes the Review web part delivered with the Web
Portal and modifies it so that the DiscoverClick event is customized. When a DiscoverClick
event is raised processDiscoverClick function, in this custom web part, checks if the clicked
object is a class object, and if so, queries for classified items and displays them in the Discover
and List parts.

SmartPlant Foundation Web Portal Samples Overview 41


SPFCustomReview

42 SmartPlant Foundation Web Portal Samples Overview


SECTION 17

SPFCustomRoleBasedSecurity
The SPFCustomRoleBasedSecurity sample demonstrates how to show or hide web parts based
on a user's role. This sample can be used with a web part delivered with the Web Portal, or it
can be applied to a custom web part.

SmartPlant Foundation Web Portal Samples Overview 43


SPFCustomRoleBasedSecurity

44 SmartPlant Foundation Web Portal Samples Overview


SECTION 18

SPFCustomSearch
The SPFCustomSearch sample demonstrates how to inherit from a SPFWebPart and then
change the web part. This example project takes the Search web part delivered with the Web
Portal and modifies it so that the Quick Search control is the only control that appears. It then
makes the controls all appear on one line. The sample project also includes a custom style
sheet file and default.aspx page that can be used to display the Search web part as a toolbar
under the Brain we part.

SmartPlant Foundation Web Portal Samples Overview 45


SPFCustomSearch

46 SmartPlant Foundation Web Portal Samples Overview


SECTION 19

SPFCustomView
The SPFCustomView sample demonstrates how to inherit from a SPFWebPart and then change
the web part. This example project takes the View web part delivered with the Web Portal and
modifies it so that the DiscoverClick event is customized. When a DiscoverClick event is raised
processDiscoverClick function checks if the clicked object is a PBS Item, and if so, queries for a
document named same as the PBS Item clicked, and displays the view file in the custom View
part. It does not display the document object in the List or Discover part.

SmartPlant Foundation Web Portal Samples Overview 47


SPFCustomView

48 SmartPlant Foundation Web Portal Samples Overview


SECTION 20

SPFCustomWebPortalAPIs
This sample project demonstrates how to create custom Web Portal APIs. The project folder
contains a readme that explains how to setup the custom DLL. This API can be added to a Web
Portal by running the load file provided with the sample and updating the web.config as
described in the SmartPlant Foundation Web Portal Customization Guide. The new assembly
must be added to the customAssemblies section in SPFWebPortal web.config.
The project contains a single new API that performs a custom search for design documents.
After building the custom DLL, loading the load files, and updating the web.config file, the new
custom API is available in the Quick Search drop down menu.

SmartPlant Foundation Web Portal Samples Overview 49


SPFCustomWebPortalAPIs

50 SmartPlant Foundation Web Portal Samples Overview


SECTION 21

SPFFileUploadTask
The File Upload task sample is an example of a custom task designed to be used with the
Document Portal application. This sample provides an example of how to use the task and
application web parts functionality in the Web Portal, as well as demonstrating how to allow
users to attach files to documents in the Web Portal.
To use this sample you must also install the Attach File client API, which is also delivered as a
sample.

SmartPlant Foundation Web Portal Samples Overview 51


SPFFileUploadTask

52 SmartPlant Foundation Web Portal Samples Overview


SECTION 22

SPFLightWeight3D
The SPFLightWeight3D sample provides a way to view and navigate 3D models managed by
SmartPlant Foundation without installing SmartPlant Markup Plus on the client computer.
The approach demonstrated in this sample includes inheriting from the SmartPlant Foundation
Web Portal's View web part and adding the 3D View Control to the page.
A cab file with the 3D control files, 3DViewCtrl.cab, is available with the sample.
For more details, refer to the ReadMe document included in this sample's folder.

SmartPlant Foundation Web Portal Samples Overview 53


SPFLightWeight3D

54 SmartPlant Foundation Web Portal Samples Overview


SECTION 23

SPFReportsControl
The SPFReports control, gives a user direct access to a list of saved reports available to run by
selecting a link. When a report is selected, it is automatically run, and the results are displayed.

SmartPlant Foundation Web Portal Samples Overview 55


SPFReportsControl

56 SmartPlant Foundation Web Portal Samples Overview


SECTION 24

SPFReportLinkListControl
This control, the ReportLinkList, displays a hyperlink list of saved reports available for the user
to run by selecting a link. When a report is selected, it is automatically run, and the results are
displayed.

SmartPlant Foundation Web Portal Samples Overview 57


SPFReportLinkListControl

58 SmartPlant Foundation Web Portal Samples Overview


SECTION 25

SPFSharePointInteractions
The SPFSharePointInteractions folder contains examples of integrating SmartPlant Foundation
Web Portal and SharePoint. SmartPlant Foundation Web Portal web parts are independent of
each other and can be placed in SharePoint as needed. Only the Brain web part is required to
allow log in and communication to SmartPlant Foundation.

In addition, interaction between Web Portal web parts and SharePoint parts is possible through
customization. This sample contains four web parts demonstrating one potential method for
interactions between SharePoint and SmartPlant Foundation Web Portal web parts. One part,
named SPFSharePointTransformableFilter, serves as a filter provider from a SmartPlant
Foundation Web Portal web part. The second part, named ConsumerToSPFSimpleSearch,
serves as a filter consumer from a SharePoint (or other) web part and results in a QuickFind
search being executed against the SmartPlant Foundation data. The third part, named
AjaxSPGridListDisplay, is an Ajax-enabled version of the SharePoint SPGridView part with
columnar sorting and paging. The fourth part, named SPFPageViewer, displays a web page
which includes parameters retrieved from a clicked object.

SmartPlant Foundation Web Portal Samples Overview 59


SPFSharePointInteractions

These parts enable communication between SmartPlant Foundation and SharePoint by


converting the standard consumer/provider mechanism used in SharePoint (and standard
ASP.NET 2.0) to the event driven communication model used by the SmartPlant Foundation
web parts and vice versa.

60 SmartPlant Foundation Web Portal Samples Overview


SPFSharePointInteractions

SmartPlant Foundation Web Portal Samples Overview 61


SPFSharePointInteractions

62 SmartPlant Foundation Web Portal Samples Overview


SECTION 26

SPFSummaryView
The SmartPlant Foundation Summary View of Object sample was created to show how the
summary view of published objects can be created and configured. The summary view feature
collects multiple relationships of a published object and displays them on one dialog box.
The summary view dialog box consists of left and right panel containers. The left panel container
contains four panels and the right panel container contains three panels. The left panel
container's 2nd, 3rd and 4th panels are configurable through the Summary View Configuration
XML file, SummaryViewConfig.xml. The right panel container's 2nd and 3rd panels are also
configurable with the same XML file.
The Details panel of the left panel container and the View Shared panel of the right panel
container are not configurable.

SmartPlant Foundation Web Portal Samples Overview 63


SPFSummaryView

64 SmartPlant Foundation Web Portal Samples Overview


SECTION 27

SPFURLViewer
The SPFURLViewer sample demonstrates a custom web part that handles the standard Web
Portal click events before calling a preconfigured URL. This makes integrating with some
systems easier. The other system only needs to respond to a URL, thus providing common
presentation level integration.
The web part replaces placeholders in the defined URL with attributes from the selected object,
and then opens the URL in the web part.
Two URLs are specified as parameters for this web part—BlankURL, which is the URL
displayed in the Web Part when no object is selected, and BaseURL, which is the URL that is
called when an item is clicked.
The two examples of the sample web part below (Url Viewer Sample and Find Objects on
Google) display the URLs that were set as their BlankUrl properties.

SmartPlant Foundation Web Portal Samples Overview 65


SPFURLViewer

When the user clicks a node in the Discover web part, the BaseURL for each SPFURLViewer
web part is called, as pictured below.

66 SmartPlant Foundation Web Portal Samples Overview


SECTION 28

SPFWebPortalSpy
This sample demonstrates how to create a new Web Part and add it to the Web Portal. It also
shows how events are raised and captured by the Web Portal web parts. As each Web Portal
event is raised, the Event Spy captures it and displays the event and associated information,
such as the sender and the data passed with the event.

SmartPlant Foundation Web Portal Samples Overview 67


SPFWebPortalSpy

68 SmartPlant Foundation Web Portal Samples Overview


SECTION 29

ViewWebPart2D3D
The ViewWebPart2D3D sample shows how to configure the View web part so that it responds to
certain document types and click events. The SmartPlant Foundation Web Portal can be
configured to use two View web parts. In this sample, one View web part is configured to display
all document types except 3D models. The other View web part displays only 3D models. Both
View web parts respond to click events.
The View Item in Drawing action displays a plant item in the related 2D drawing in the 2D View
web part. The View Item in Model displays the plant item in the related 3D model in the 3D View
web part. Selecting any hot-spotted item in either the 2D drawing or the 3D model causes the
other View web part to zoom in on that item.

SmartPlant Foundation Web Portal Samples Overview 69


ViewWebPart2D3D

70 SmartPlant Foundation Web Portal Samples Overview


Index

C
ChartReports • 11
CustomizationDemo • 13
CustomProjectSearchMenu • 15

D
DefaultPageWithThemeChooser • 17

E
ExternalSourceLinks • 19

L
LayoutDemoFiles • 21

P
Preface • 7
ProjectOverviewPage • 23

S
SiteLocator • 25
SPFAppLayoutControl • 27
SPFAttachFiles • 29
SPFChartReport • 31
SPFCustomApplicationInSingleWindow • 33
SPFCustomAttachWorkflow • 35
SPFCustomCreateComment • 37
SPFCustomFindAndClick • 39
SPFCustomReview • 41
SPFCustomRoleBasedSecurity • 43
SPFCustomSearch • 45
SPFCustomView • 47
SPFCustomWebPortalAPIs • 49
SPFFileUploadTask • 51
SPFLightWeight3D • 53
SPFReportLinkListControl • 57
SPFReportsControl • 55
SPFSharePointInteractions • 59
SPFSummaryView • 63
SPFURLViewer • 65
SPFWebPortalSpy • 67

V
ViewWebPart2D3D • 69

SmartPlant Foundation Web Portal Samples Overview 71