SmartPlant Foundation Web Client

Configuration Guide
Version 2018 R1 (7.1)
March 2018
Copyright
Copyright © 2016-2018 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
This computer program, including software, icons, graphic symbols, documentation, file formats, and audio-visual displays; may be
used only as pursuant to applicable software license agreement; contains confidential and proprietary information of Hexagon AB
and/or third parties which is protected by patent, trademark, copyright law, trade secret law, and international treaty, and may not be
provided or otherwise made available without proper authorization from Hexagon AB and/or its subsidiaries and affiliates.
Portions of the user interface copyright 2016-2018 Telerik AD.
Brava! is a product of OpenText. For more information, see www.opentext.com.
mMapSDK.js, mMapSDK.wrapper.js, worker.js, and worker-loader.js are from myVR Software AS (Copyright 2015 myVR Software
AS)

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.
Hexagon PPM
305 Intergraph Way
Madison, AL 35758

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 Software License Agreement ("SLA") 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 SLA 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 use. 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 SLA 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.

SmartPlant Foundation Web Client Configuration Guide 2

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.

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 commercial-off-the-shelf software products, customized software and/or third-party software, including any
technical data related thereto (“Technical Data”), obtained from Intergraph Corporation, its subsidiaries or distributors, is subject to
the export control laws and regulations of the United States of America. Diversion contrary to U.S. law is prohibited. To the extent
prohibited by United States or other applicable laws, Intergraph Corporation software products, customized software, Technical Data,
and/or third-party software, or any derivatives thereof, obtained from Intergraph Corporation, its subsidiaries or distributors must not
be exported or re-exported, directly or indirectly (including via remote access) under the following circumstances:
a. To Cuba, Iran, North Korea, the Crimean region of Ukraine, or Syria, or any national of these countries or territories.
b. To any person or entity listed on any United States government denial list, including, but not limited to, the United States
Department of Commerce Denied Persons, Entities, and Unverified Lists, the United States Department of Treasury Specially
Designated Nationals List, and the United States Department of State Debarred List
(https://build.export.gov/main/ecr/eg_main_023148).
c. To any entity when Customer knows, or has reason to know, the end use of the software product, customized software,
Technical Data and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors 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 Customer knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export/re-export of relevant Intergraph Corporation software product, customized software, Technical Data
and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors, should be addressed to PPM’s
Export Compliance Department, 305 Intergraph Way, Madison, Alabama 35758 USA or at [email protected].
Customer shall hold harmless and indemnify PPM and Hexagon Group Company for any causes of action, claims, costs, expenses
and/or damages resulting to PPM or Hexagon Group Company from a breach by Customer.

Trademarks
Intergraph®, the Intergraph logo®, Intergraph Smart®, SmartPlant®, SmartMarine, SmartSketch®, SmartPlant Cloud®, PDS®,
FrameWorks®, I-Route, I-Export, ISOGEN®, SPOOLGEN, SupportManager®, SupportModeler®, SAPPHIRE®, TANK, PV Elite®,
CADWorx®, CADWorx DraftPro®, GTSTRUDL®, and CAESAR II® are trademarks or registered trademarks of Intergraph Corporation
or its affiliates, parents, subsidiaries. Hexagon and the Hexagon logo are registered trademarks of Hexagon AB or its subsidiaries.
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 Client Configuration Guide 3

Contents
Preface .......................................................................................................................................................... 7
SmartPlant Foundation Web Client Product Documentation .................................................................. 7
Customer support and technical forum ................................................................................................... 7

Configure SmartPlant Foundation Web Client sites ................................................................................ 8

Create a SmartPlant Foundation Web Client site ................................................................................... 8
Register SmartPlant Foundation Web Client with the Intergraph Authorization Server ......................... 9
Update a SmartPlant Foundation Web Client site ................................................................................ 10
Modify properties for a SmartPlant Foundation Web Client site ........................................................... 10
SmartPlant Foundation Web Client site diagnostics ............................................................................. 11
Configure SSL for a SmartPlant Foundation Web Client site ............................................................... 11
Configure Brava! Server on SmartPlant Foundation sites .................................................................... 11
Configure access to Brava! Server ....................................................................................................... 12
Configure Microsoft SharePoint data .................................................................................................... 12
Download documents from a non-secure SharePoint site ............................................................. 13
Setting up SmartPlant Foundation Web Client logging......................................................................... 14
SmartPlant Foundation Web Client deployment ................................................................................... 15

SmartPlant Foundation Web Client Localization ................................................................................... 16

Generating localization resource files ................................................................................................... 16

Configure security rules ........................................................................................................................... 18

Configure the client in the Web Client .................................................................................................... 20

Configure API Entry Points in SmartPlant Foundation Web Client....................................................... 20
Create an API Entry Point from a class or interface definition ....................................................... 21
Create an API Entry Point from a Quick Find method.................................................................... 21
Configure an API Entry Point ......................................................................................................... 21
Navigate the API Entry Point using the Info Map ........................................................................... 21
Create feature sets ............................................................................................................................... 22
Relate a method to a feature set .................................................................................................... 22
Column set resolution ........................................................................................................................... 23
Configuring List Edit .............................................................................................................................. 23

Configuring the client in the SmartPlant Foundation Desktop Client ................................................. 24

Create a feature set .............................................................................................................................. 24
Modify a feature set ........................................................................................................................ 24
Configure methods to display in a feature set ...................................................................................... 25
Modify the display of functions in a feature set .............................................................................. 25
Manage method access groups ..................................................................................................... 26
Create a new method to add as a function..................................................................................... 26
Configure API Entry Points to display in a feature set .......................................................................... 26
Modify the display of API Entry Point functions in a feature set ..................................................... 27

SmartPlant Foundation Web Client Configuration Guide 4

 Contents

Manage API Entry Point access groups ......................................................................................... 27

Configure actions menu items .............................................................................................................. 27
Display a method icon on the actions menu .................................................................................. 28
Configure search menu items ............................................................................................................... 28
Edit the display name of a search menu item ................................................................................ 29
Edit property comparison criteria .................................................................................................... 29
Configuring column items in dynamic forms................................................................................... 29
Configure display items ......................................................................................................................... 30
Control the access to display item hyperlinks ................................................................................ 30
Configure viewing page titles ................................................................................................................ 30
Configure the display of reports ............................................................................................................ 31
Generate OpenXML Word report for an object ..................................................................................... 31
Create custom OpenXML Word reports ......................................................................................... 32
Filter template documents to generate OpenXML Word reports for classified
objects ............................................................................................................................................ 37
Configure the Exchange Data functionality........................................................................................... 38
Create a new export details object ................................................................................................. 40
Create a new report configuration object ....................................................................................... 40
Manage view definition options ...................................................................................................... 42
Manage class definitions for inverted CSVs ................................................................................... 42
Create a user-defined method for exchanging data ....................................................................... 43

Manage plant or project data.................................................................................................................... 44

Configure plant or project data.............................................................................................................. 44
Create a load job ................................................................................................................................... 45
Create dynamic display items in load job form ..................................................................................... 46
My load jobs actions ............................................................................................................................. 47

Configure document management .......................................................................................................... 49

Configure viewing for Hexagon PPM file types ..................................................................................... 50
Set up the SmartPlant Foundation File Server for WebGL viewer file display ............................... 51
Set up the SmartPlant Foundation Application Server for WebGL viewer file
display............................................................................................................................................. 53
Enable automatic generation of WebGL viewer files for Hexagon PPM 2D and 3D
files ................................................................................................................................................. 53
Manually generate WebGL viewer files for Hexagon PPM 2D and 3D files already
in the database ............................................................................................................................... 54
Update graphics mappings for previously published files .............................................................. 57
Configure client computers to display WebGL viewer files ............................................................ 57
Configure locking and unlocking of markup layers ............................................................................... 59
Configure view item commands after upgrade ..................................................................................... 60

Configure workflow ................................................................................................................................... 61

Configure methods to automatically attach objects to a workflow ........................................................ 61

SmartPlant Foundation Web Client Configuration Guide 5

 Contents

Glossary ..................................................................................................................................................... 63

Index ........................................................................................................................................................... 73

SmartPlant Foundation Web Client Configuration Guide 6

Preface
This document provides SmartPlant Foundation administrators with information about how to
configure SmartPlant® Foundation Web Client.

SmartPlant Foundation Web Client Product

Documentation
SmartPlant Foundation Web Client documentation is available as Help and as PDF files. To
view printable guides in the SmartPlant Foundation Web Client, click Help and then open the
Printable Guides topic in the SmartPlant Foundation Web Client help file.
Hexagon PPM 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.

Documentation
 Intergraph SmartPlant Foundation Web Client User's Guide - Provides general conceptual
information, procedures, and vocabulary necessary to use the SmartPlant Foundation Web
Client application.
 Intergraph SmartPlant Foundation Web Client Configuration Guide - Provides information for
system administrators on how to configure SmartPlant Foundation Web Client in SmartPlant
Foundation and describes the underlying data model.

Customer support and technical forum

For the latest support information for this product, use a web browser to connect to
http://hexagonppm.com/ppm-support (http://hexagonppm.com/ppm-support). Also, you can
submit any documentation comments or suggestions you might have on our support site.
To access the Technical User Forum, go to https://www.linkedin.com/groups/3924003
(https://www.linkedin.com/groups/3924003).

SmartPlant Foundation Web Client Configuration Guide 7

SECTION 1

Configure SmartPlant Foundation Web

Client sites
After you have installed SmartPlant Foundation Web Client with SmartPlant Foundation, a new
SmartPlant Foundation Web Client Sites node appears under the SmartPlant Foundation
Server Manager Sites node.
You must configure a site so that SmartPlant Foundation Web Client can access the SmartPlant
Foundation application server and the Intergraph Authorization Server. The SmartPlant
Foundation Web Client site contains all the server configuration and connection settings to
access data in the database.

 For information on how to configure a SmartPlant Foundation Web Client site using a
SmartPlant Fusion database, see Configure SmartPlant Foundation Web Client for
SmartPlant Fusion in the SmartPlant Fusion Installation and Configuration Guide.
 For information on how to configure a SmartPlant Foundation Web Client site using a Smart
Data Validator database, see Configure SmartPlant Foundation Web Client for Smart Data
Validator in the Smart Data Validator Installation and Setup Guide.

Create a SmartPlant Foundation Web Client site

1. In SmartPlant Foundation Server Manager, right-click the SmartPlant Foundation Web
Client Sites node, and click New.
2. In the Create New SmartPlant Foundation Web Client Site wizard, step through the
pages to configure the site:
 SmartPlant Foundation Web Client Details - Type the site name and virtual directory
path.
 SPF Server Details - Type the URL paths for connection to the SmartPlant Foundation
server and the configuration service for the Intergraph Authorization Server.
The Validate URLs check box is selected by default and ensures that the
entered URLs are valid. If you have a URL validation error, you can clear the Validate
URLs check box, so that the validation checks only that the URL is in the correct format.
This allows you to progress to the next page of the wizard and create a site. You can
update the SmartPlant Foundation Web Client site server URL details in Server
Manager later.
For more information on specific settings, see Register SmartPlant Foundation Web
Client with the Intergraph Authorization Server (on page 9).

SmartPlant Foundation Web Client Configuration Guide 8

 Configure SmartPlant Foundation Web Client sites

 Summary - Review the details, and click Next to create the SmartPlant Foundation
Web Client site. Click Yes to confirm you want to create the site.
 Configure SmartPlant Foundation Web Client Application - Click Configure
Authentication to register the SmartPlant Foundation Web Client application on the
Intergraph Authorization Server.
The values displayed are required to configure the SmartPlant Foundation Web Client
application in the Intergraph Authorization Server. You can also manually navigate to
the web address and enter the values on the Create Application page of the Intergraph
Authorization Server, or you can print the details so that you can enter them later. For
more information on the Intergraph Authorization Server, see the How to Configure API
Services guide.

 The new site can be used only after the SmartPlant Foundation Web Client application has
been configured with the Intergraph Authorization Server.
 You must use a fully qualified domain name when creating a SmartPlant Foundation Web
Client site. For example, http://[ServerName.DomainName.com]/SPFServer.
 If the SmartPlant Foundation application server uses SSL to communicate with the
Intergraph Authorization Server, you must configure the settings for each SmartPlant
Foundation Web Client site to use SSL and ensure that https is used as the protocol.

 You can have more than one SmartPlant Foundation Web Client site with each site
accessing a different SmartPlant Foundation server.
 For more information on creating sites using Server Manager, see Create a new site in the
SmartPlant Foundation Server Manager User's Guide.
 For more information on the Intergraph Authorization Server and SSL configuration, see
Configuring API Services in the How to Configure API Services guide.

Register SmartPlant Foundation Web Client with the

Intergraph Authorization Server
When you create a SmartPlant Foundation Web Client site, you must enter the following settings
to register the application with the Intergraph Authorization Server:
Client ID - The identity of the SmartPlant Foundation Web Client site. For example,
SPFWebClient.
Client Name - The name of the SmartPlant Foundation Web Client site. For example,
SPFWebClient.
Flow - The authorization protocol flow type that must be used to obtain a license token. Set the
flow type to Implicit for a SmartPlant Foundation Web Client site.
Redirect URI - The locations where the authorization service redirects the user after authorizing
the application. For example:
http://[myserver.mydomain]/SPFWebClient/
http://[myserver.mydomain]/SPFWebClient/_session.html/

SmartPlant Foundation Web Client Configuration Guide 9

 Configure SmartPlant Foundation Web Client sites

Post Logout Redirect URI - The location where the authorization service redirects the user
after logging out of the application. For example:
http://[myserver.mydomain]/SPFWebClient/

Update a SmartPlant Foundation Web Client site

 In SmartPlant Foundation Server Manager, right-click the existing SmartPlant Foundation
Web Client site, and click Tools > Update SmartPlant Foundation Web Client Site.
If you see an access denied message, cancel the update, and check that the application
pools have been stopped in IIS.

Modify properties for a SmartPlant Foundation Web

Client site
After the SmartPlant Foundation Web Client site has been created, a node for that site is
displayed in the tree view of Server Manager. The properties for a SmartPlant Foundation Web
Client site are described below.
Site Path – Physical path to the SmartPlant Foundation Web Client site files (physical location
of the virtual directory).
Site Virtual Directory – Name of the SmartPlant Foundation Web Client site, as defined in IIS.
OAuth URL – Fully-qualified URL to the Intergraph Authorization Server.
OAuth Client ID – Identifier used by the Intergraph Authorization Server to identify SmartPlant
Foundation Web Client.
OAuth Redirect URL – Fully-qualified URL to the SmartPlant Foundation Web Client logon
page on the Intergraph Authorization Server.
Identity Provider – Unique identifier provided by the Smart API Manager to indicate the identity
provider to be used for user authentication.
OData URL – Fully-qualified URL to the Smart API Services entry point for SmartPlant
Foundation Web Client.
DefaultSPFServerURL – Fully-qualified URL to the SmartPlant Foundation Web Client site.
SDAClientURL - Fully-qualified URL to the SmartPlant Foundation Web Client site that is used
for building the full URL to objects; for example, creating email definitions for To Do List
notifications.
SmartPlant Foundation Web Client default query page size (1-1000) - Specifies the default
number of objects that are returned in one page of a paged query. The default setting is 25. The
range is 1-1000.
The default query page value is defined by the API Default Query Page Size (1-1000)
property, and the maximum value allowed is defined by the API Services max Page Size
property.
SmartPlant Foundation Web Client inactivity timeout (minutes) - Period of time, in minutes,
before the SmartPlant Foundation Web Client application on the server times out. Default
timeout is set to 10 minutes.

SmartPlant Foundation Web Client Configuration Guide 10

 Configure SmartPlant Foundation Web Client sites

Enable Diagnostics - Indicates that the site diagnostic tools are available to check the
configuration and services settings. The default is True.
Max batch size - Indicates the maximum object limit for site operations. If the limit is exceeded,
there may be a performance impact. The default is 100.

SmartPlant Foundation Web Client site diagnostics

You can check if a SmartPlant Foundation Web Client site is ready to start by running the
SmartPlant Foundation Web Client Diagnostics.
 Right-click the SmartPlant Foundation Web Client site, and click Tools > Diagnostic Tools
> SmartPlant Foundation Web Client Diagnostics.
The diagnostics results display if all the system connections are operating correctly, so you can
log in and start using the SmartPlant Foundation Web Client site. The diagnostics provide SPF
Services, Intergraph Authorization Server, and SDA Services configuration information. If a URL
connection error is found, a message appears and provides exception and resolution details.

Configure SSL for a SmartPlant Foundation Web

Client site
To enable secure communication with your SmartPlant Foundation Web Client site, perform the
following:
1. Setup HTTPS/SSL for the SmartPlant Foundation site.
For detailed procedures, see Set up HTTPS in the SmartPlant Foundation Installation and
Setup Guide.
2. When you create your SmartPlant Foundation Web Client site, use HTTPS and fully
qualified domain names for the site.
If your site has already been created without HTTPS, manually edit all URLs in the site
properties to include HTTPS.
3. If using Brava Server for viewing, be sure you have a Brava Server that is configured for
HTTPS.

Configure Brava! Server on SmartPlant Foundation

sites
To view third-party files in the SmartPlant Foundation Web Client, you must set the
BravaServer property on the SmartPlant Foundation site. This allows the SmartPlant
Foundation application server access to the Brava! Enterprise Server, a component of
SmartPlant Markup Plus Server. You must also modify the BravaMaximumRasterDimensions
and BINZConversion.Timeout properties to suit your environment.
BravaServer - Location of the Brava! Enterprise Server in the following format:
http[s]://[BravaEnterpriseServerName.domain.com]:[PortNumber].

SmartPlant Foundation Web Client Configuration Guide 11

 Configure SmartPlant Foundation Web Client sites

BravaMaximumRasterDimensions - Specifies the maximum height or width for raster

graphics, in pixels. Resolution increases as the total number of pixels is increased. The default
setting is 3500 pixels, and the maximum is 10000.
BINZConversion.Timeout - Defines the amount of time, in seconds, after which the operation
to convert a 3D model to a web file will timeout. The default setting is 300 seconds.

 For more information on creating and configuring SmartPlant Foundation sites, see the
SmartPlant Foundation Server Manager User's Guide.
 For more information on Brava! Enterprise Server and SmartPlant Markup Plus, see the
SmartPlant Markup Plus Installation and Setup Guide.

Configure access to Brava! Server

To access Brava! Enterprise Server from one or more SmartPlant Foundation application
servers, the IP addresses of the servers must match those specified by the
legal.ip.to.get.sessionid property. This property is in the server.properties file on the
Brava! Enterprise Server. This file is delivered to [installation
location]\SmartPlant\Markup\Brava! Enterprise\Brava! Server by default. For example, if
legal.ip.to.get.sessionid is set to a wildcard IPv4 address such as 192.*, requests will
only be accepted from servers with matching 192.* addresses. The default is set to the localhost
IP address.
For more information on Brava! Enterprise Server and SmartPlant Markup Plus, see
the SmartPlant Markup Plus Installation and Setup Guide. For a list of acceptable
legal.ip.to.get.sessionid property values, see the OpenText® Brava!® Enterprise
Administration and Installation Guide.

Configure Microsoft SharePoint data

You can configure SmartPlant Foundation Web Client to display data from a Microsoft
SharePoint server site using the sharepoint-configuration.json file. You can also restrict
access to search the SharePoint server site by associating user groups with the
SharePointSearchAccess method.
Once set, only the selected user groups can include data from a SharePoint site by selecting the
Include SharePoint Results option in an advanced search query. Also, this allows only the
selected user groups to attach files from a SharePoint site.
To configure the SharePoint site to display the data in SmartPlant Foundation Web Client:
1. Open the sharepoint-configuration.json file using Visual Studio or Notepad.
The default file location of the sharepoint-configuration.json file is: C:\SmartPlant
Foundation 2018 Server Files\SDAClient_Sites\[Site_Name].
2. Remove the comment coding for all the lines in the file.
3. Add the site URL for the SharePoint server site in the siteUrl line.
For example, "siteUrl": "http://SHP-SERVER/".
4. Edit the column refiners to match the columns that exist in the SharePoint site so that each
of the file type's mapped values can be displayed in SmartPlant Foundation Web Client.

SmartPlant Foundation Web Client Configuration Guide 12

 Configure SmartPlant Foundation Web Client sites

An administrator can control the display of mapped extension values by adding or

removing specific file types from the list in the sharepoint-configuration.json file. The
default file types are PDF, Word, PowerPoint, Excel, Email, and Zip.
5. Edit the sharepointColumn settings to match the same column field values that exist in the
SharePoint site so that the column values can be displayed in SmartPlant Foundation Web
Client. In the column settings:
 Set the isRefiner property to true to display a mapped value set by the column refiners.
 Set the display property to true to display the SharePoint column value in the Object
Details > SharePoint tab but not in a results grid.
 Set the map to property to a valid property definition to populate the columns with
document metadata on creation. For example, SPFSharePointDocAuthor.
6. Edit the documentConfiguration settings to map the required settings.
 Set enableSharepointDocumentCreation to true to create a SharePoint document in
the database.
 Set revisionSchemeUID to the revision scheme used for the documents created from
SharePoint. For example, RS_Rev01A.
 Set classificationUID to the document classification created from SharePoint files. For
example, SharepointReferenceDocument.
 Set createmethodUID to the method to create the documents. For example,
MTH_SDACreateDocument.
 Set relDefToNavigateToClassDefUID to the relationship definition used for the
navigation from the SharePoint classification to the document class definition. For
example, SDADocClassDef.
7. Click Save.

 You must have knowledge of SharePoint administration and access to the SharePoint
library to configure the column refiners and column settings to return the correct data. For
more information, see the Microsoft SharePoint documentation.
 You must clear the browser cache after modifying the sharepoint.configuration.json file
for the correct data to be displayed. This is dependent on the browser. For example, press
CTRL + SHIFT + DEL, and select the options required to clear the cache.

Download documents from a non-secure SharePoint site

You can configure the SmartPlant Foundation Web Client system to allow you to download files
from a non-secure server site by adding a domain name entry in the ProxyDomains setting of
the SDAClientServices web.config file. For example, located at: [Drive]:\SmartPlant Foundation
2018 Server Files\SDAClient_Sites\[SDA_Site_Name]\SDAClientServices.
Add the domain name of each of the non-secure hosts to which you require access. Each
non-secure host entry must be separated by a semicolon.
The following example adds the domain entry sharepoint.intergraph.com to allow the download
of document files from that location:
<appSettings>

SmartPlant Foundation Web Client Configuration Guide 13

 Configure SmartPlant Foundation Web Client sites

<add key="ClientServicesSafeFileDirectory"
value="C:\Products\SPFScannedFileDir"/>
<add key="TargetVirtualDir" value="SDAClient"/>
<add key="ImagesDir" value="src\content\images"/>
<add key="ProxyDomains"
value="sharedserver.intergraph.com;sharepoint.intergraph.com"/>
</appSettings>
When you log off of SmartPlant Foundation Web Client, you are directed to the LogOut page.
From here you can click a link that returns you to the application Login page.
You can configure your site in Intergraph Authorization Server to automatically go to the
Login page after you log out.
1. In Intergraph Authorization Server, log on as Admin with the Authorization Server
administrator's password.
2. Click Server Configuration > Edit, and select Enable Post Sign Out Auto option.

Setting up SmartPlant Foundation Web Client logging

SmartPlant Foundation Web Client activity is logged on the server using the built-in logging
software. You can use the log file to investigate and resolve any issues encountered during
normal use of SmartPlant Foundation Web Client. Any issues encountered during a user
session are automatically captured and saved to the SDALog file.
The default folder location for the log file is:
C:\SmartPlant Foundation 2018 Server Files\SPFWebClient_Sites\[SmartPlant
Foundation Web Client site name]\SDAClientServices\SDALogs

SmartPlant Foundation Web Client Configuration Guide 14

SECTION 2

SmartPlant Foundation Web Client deployment

SmartPlant Foundation Web Client requires no deployment or set up for a user to access data.
Each user enters a URL in their web browser on a computer or mobile device to connect to
SmartPlant Foundation Web Client.

SmartPlant Foundation Web Client Configuration Guide 15

SECTION 3

SmartPlant Foundation Web Client

Localization
SmartPlant Foundation Web Client is globally enabled. The user can set the language and
cultural preferences using their browser setting. This setting governs:
 What language the user interface text appears in - Text such as button labels and error
messages can appear in any language that is supported by the browser and for which
localized resource files have been created.
 How the number, date, and currency values are displayed - Information such as pipe
lengths, approval dates, and cost per unit are displayed in the formats that are common to
the selected culture.
However, SmartPlant Foundation Web Client does not translate or change any user-entered
text. Information stored in the data source, such as document names and tag numbers appear
as stored. Text entered by the user, such as search terms and bookmark names, appears as
entered.

How a user changes language and culture settings

The language and culture settings depend on the browser type being used:
 Safari – Typically does not allow a language setting different from that of the operating
system.
 Others – The language preference is set for the browser itself, and that setting can differ
from the operating system setting.
For assistance with setting the preferred locale for a browser, see the browser documentation.

Generating localization resource files

SmartPlant Foundation Web Client supports the localization of the client user interface into
different languages. The strings used for the display of each language in the user interface are
stored in a JSON file in the SmartPlant Foundation Web Client site directory. To create a new
language JSON file:
1. Locate the en.json file. For example, located at: C:\SmartPlant Foundation [Version] Server
Files\SPFWebClient_Sites\[Site Name]\content\lang\core.
2. Copy the en.json file.
3. Rename the copied en.json file to match the language being translated. For example, if you
are translating to Japanese, rename the file to ja.json.
4. Translate the strings in the copied file into the required language.
5. Save the new language JSON file in the same location as the English language en.json file.

SmartPlant Foundation Web Client Configuration Guide 16

 SmartPlant Foundation Web Client Localization

A browser setup for the Japanese language now reads the ja.json file and displays the
translated strings in SmartPlant Foundation Web Client.

SmartPlant Foundation Web Client Configuration Guide 17

SECTION 4

Configure security rules

For more information about configuring users, access groups, roles, domains, owning
groups, and so forth, see the How to Configure Security Model guide.
You can use security rules in addition to or in place of owning groups to limit the classes of
objects users have access to. You can restrict data returned from the database by creating a
security rule that links one or more class definitions to one or more access groups with a
condition. When used with owning groups, the rule further segregates user access to different
classes of objects. When used in place of owning groups, the rule limits user access to different
classes of objects.
For example, an organization has a number of transmittals organized by owning groups based
on internal requirements, such as Classified, Restricted, and Open. The organization can create
user accounts for external customers using the same roles and access groups as for internal
users, but with security rules in place. These rules ensure that each external customer accesses
transmittals only for their organization.
The SPFSecurityRule class definition, and SPFClassDefSecurityRule and
SPFSecurityRuleAccessGroup relationship definitions, are used to configure the security
rules. In addition, the following relationship definitions allow you to use a specific security rule on
an edge or relationship expansion rather than deriving it from the interface definition, which may
be too generic, that a relationship links to.
 SPFRelDefSecurityRule12 - Apply security rules when expanding rel from End1 to End2
 SPFRelDefSecurityRule21 - Apply security rules when expanding rel from End2 to End1
 SPFEdgeDefSecurityRule - Apply security rules while expanding EdgeDef

Create a security rule

You can group multiple class definitions and access groups together into a security rule and
restrict access based on a condition.
1. Click File > New > Administration > Security Rule in the Desktop Client.
2. Type a name and description for the new security rule.
3. In the Security Rule definition text box, type the syntax to describe the condition that must
be met by the object for the methods related to the access group to appear. Example:
obj->SPFCXmtlExternalCompany_12.Name=ENV.USERORGANIZATIONNAME.
The security rule syntax is the same as that used to create conditions, except that
the security rules do not support keywords like ‘NOT’, 'OBJ1', 'OBJ2', or function keywords
like ‘ISSET’, ‘ISSETB’, and so on. For more information about creating conditions, see
Configuring conditions in the How to Configure the Infrastructure Model guide.
4. Find and select one or more class definitions from the Class Definition list to associate with
the security rule.
5. Find and select one or more access groups from the Access Group list to associate with
the security rule.

SmartPlant Foundation Web Client Configuration Guide 18

 Configure security rules

6. Find and select one or more edge definitions to expand and apply the security rule.
7. Find and select one or more relationship definitions to expand from end1 to end2 and apply
the security rule.
8. Find and select one or more relationship definitions to expand from end2 to end1 and apply
the security rule.
The following is an example security rule definition with a relationship definition expansion:
Obj->SDAItemSecurityCode_12.Name = Env.SecurityCodesForUserInQueryConfig Or
obj.objdefuid = ‘SDAArea’
In this example, the results must match a security code or be an SDAArea, which may not
have a security code.

SmartPlant Foundation Web Client Configuration Guide 19

SECTION 5

Configure the client in the Web Client

You can configure certain features of the SmartPlant Foundation Web Client using the web
client. All other configuration must be done in SmartPlant Foundation Desktop Client. For more
information, see Configuring the client in the SmartPlant Foundation Desktop Client (on page
24).
You must regenerate the metadata in the SmartPlant Foundation Desktop Client to
apply any changes made to API entry points, schema, or user interface items in SmartPlant
Foundation Web Client. Click Administration > API Services > Regenerate Metadata.

Configure API Entry Points in SmartPlant Foundation

Web Client
SmartPlant Foundation Web Client uses API Entry Points to expose system objects, such as
class definitions and interface definitions, so that the objects they represent appear in the user
interface when called. As a system administrator, you can expose the system objects by
creating an API Entry Point and configuring the details on a form in the SmartPlant Foundation
Web Client. Any exposed system object automatically exposes any relationship and edge
definitions and requires no further configuration.
You have access to the System Administration feature set, which details the following system
objects that you can use to create API Entry Points and add them to a feature set:
 Class definitions
 Interface definitions
 Methods
 Quick Find methods
 API Entry Points
 Feature sets

 All the procedures in this section are performed in the SmartPlant Foundation Web Client.
However, you can also configure API Entry Points in SmartPlant Foundation Desktop Client.
For more information, see Configuring the client in the SmartPlant Foundation Desktop
Client (on page 24).
 The SmartPlant Foundation OData API Services uses the SPFAPIEntryPoint class definition
to expose system objects, so that they appear in the SmartPlant Foundation Web Client
metadata. For more information on using the SmartPlant Foundation OData API Service,
see the How to Configure API Services guide.

SmartPlant Foundation Web Client Configuration Guide 20

 Configure the client in the Web Client

Create an API Entry Point from a class or interface definition

1. Select a class or interface definition in a results list or select an existing class or interface
definition node in an Info Map display.
2. Click Actions > Create API Entry Point.
3. On the Create API Entry Point form, enter the details in the boxes.
4. Relate the new API Entry Point to a selected feature set using the Relationship Builder.

Create an API Entry Point from a Quick Find method

1. Select a Quick Find method, and click Actions > Create API Entry Point.
2. On the Create API Entry Point form, edit the details in the boxes.
The form is pre-populated with the configuration details from the selected
method.
3. Relate the new API Entry Point to a selected feature set using the Relationship Builder.

Configure an API Entry Point

 Select an existing API Entry Point, and click Actions > Configure API Entry Point.

Navigate the API Entry Point using the Info Map

API Entry Points are displayed in the Configure Entry Point page using the Info Map, which
visualizes relationships by displaying the related objects as nodes.
You can configure the API Entry Point by selecting individual nodes in the Info Map. The
configuration actions available to you depend on the type of node selected:

Node Type What can you do?

Configures the central node using actions displayed on the Actions

Central Node
menu.

Expands the interface definition to view the available edge and

Interface Definition
relationship definition nodes.

Opens the Edit EdgeDef dialog box, so you can select the column
Edge Definition set, the access groups, and choose to hide the objects from the user
interface or the Info Map.

Opens the Edit RelDef dialog box, so you can select the End 1 and
End 2 column sets, the roles, the access groups, and choose to hide
Relationship Definition
the objects from the user interface or the Info Map using the End 1
and End 2 attributes.

SmartPlant Foundation Web Client Configuration Guide 21

 Configure the client in the Web Client

Select the role to view navigations

The navigations displayed are role-dependent. You can select a role from the Roles menu to
view which navigations are available from the API Entry Point objects.

View navigations visible in the Info Map

You can control the visibility of object navigations in the Info Map by selecting the Info Map
Navigation option. For example, you might want a navigation to appear on a context or action
menu, but not in the Info Map. You can choose to hide or display the object navigations by
selecting the attribute options when you edit a relationship or edge definition.
The display of objects exposed in the Info Map depends on whether the user's role is
in an access group with the SPFRelDefAccessGroup relationship definition. For more
information on managing relationships and access groups, see Relationship manipulation and
navigation in the How to Configure Security Model guide.

Show all navigations in the Info Map

You can control which object expansions are visible to the user by selecting the Show All
option. This overrides any security restrictions on the objects displayed in the Info Map.
Selecting this option shows all the object navigations to which the user's selected role may not
have access. This allows you to configure navigations that would normally be hidden from the
selected role.

Create feature sets

1. Select the System Administration feature set, and click Create Feature Set.
2. In the Create Feature Set form, enter the name and description.
3. In the Display as box, type the name to appear in the GUI.
4. In the Feature set image URL box, enter the name of the URL image to display.
5. In the Sort Order on Home Page box, set the order number for the feature set to display on
the Home page.

Relate a method to a feature set

Using the Relationship Builder, you can create relationships between methods and feature
sets so they are displayed as function tiles on the Home page.
1. Select a method, and click Actions > Relationship Builder.
You can select a previously pinned feature set, a new feature set, or use the search
to locate existing feature sets.
2. Click Relate.

SmartPlant Foundation Web Client Configuration Guide 22

 Configure the client in the Web Client

Column set resolution

The SmartPlant Foundation Web Client uses two mechanisms to resolve which column set to
use when displaying items:
 When you query for data using an Entry Point, the SmartPlant Foundation Web Client
selects the column set configured for the Entry Point using the SPFAPIEntryPointColumnSet
relationship.
 When you query for data by expanding a relationship, the SmartPlant Foundation Web
Client can select the column set in two ways:
 The server selects the column set for the expansion using the
SPFRelDefEnd1ColumnSet, SPFRelDefEnd2ColumnSet, or SPFEdgeDefColumnSet
relationships.
 The server selects a column set directly linked to the end interface of the relationship
definition or edge definition using the SPFInterfaceDefColumnSet relationship.

Configuring List Edit

The ability to use List Edit must be configured by the system administrator for specific objects
and data types. You must enable List Edit to use it.:
1. Locate the Settings.js file. For example, [Drive]\SmartPlant Foundation 2018 Server
Files\SPFWebClient_Sites\SPFWC.
2. In the application section, set the enableListEdit flag to true.
"application": {
"inactivityTimeout": 10,
"enableProdMode": false,
"defaultPageSize": 25,
"enableListEdit": true
},

SmartPlant Foundation Web Client Configuration Guide 23

SECTION 6

Configuring the client in the SmartPlant

Foundation Desktop Client
You can also configure the feature sets, functions, and menu items to display in the SmartPlant
Foundation Web Client using the SmartPlant Foundation Desktop Client.
When a feature set is selected, the functions display as tiles on the Home page. Each feature
set contains a set of functions that carry out specific actions or run predefined searches. They
are made from either a method or an API Entry Point and also appear on the Search menu.

 You can manage the configuration of various SmartPlant Foundation Web Client
components in the SmartPlant Foundation Desktop Client. All the procedures in this section
are performed in that application.
 You must regenerate the metadata in the SmartPlant Foundation Desktop Client to apply
any changes made to API entry points, schema, or user interface items in SmartPlant
Foundation Web Client. Click Administration > API Services > Regenerate Metadata.
 You can access the SmartPlant Foundation Web Client and Intergraph Smart Digital Asset
Client API Reference Guide on the Hexagon PPM Support
(http://hexagonppm.com/ppm-support) site.

Create a feature set

1. Click Find > New > Administration > Feature Set.
2. In the New Feature Set dialog box, enter a name and description for the feature set.
3. In the Display as box, type the name to appear in the GUI.
4. In the Feature set image URL box, enter the name of the URL image, and click Finish.

Modify a feature set

1. Find the feature set you want to update, right-click it, and click Update.
2. In the SmartPlant Foundation Web Client details section, click the Description and
Display as boxes to update the description and name for the feature set.

Change the feature set order

1. Find the feature set you want to update, right-click it, and click Update.
2. In the Feature Set details section, set the order number in the Sort Order on Home Page
box for the feature set to display on the Home page.
The default value is NULL or zero so that the feature set appears first in any sort
order. Feature sets that share the same number are sorted alphabetically.

SmartPlant Foundation Web Client Configuration Guide 24

 Configuring the client in the SmartPlant Foundation Desktop Client

Change the icon

1. Find the feature set you want to update, right-click it, and click Update.
2. In the Feature Set details section, type the icon name in the Feature set image URL box.
The URL points to the directory location of the feature set images for your site.
For example, content > images > feature-sets.

Configure methods to display in a feature set

1. Right-click the method that you want to add as a new function in a feature set.
2. Drag the method onto a feature set to associate it. The method appears as a function tab in
the feature set tile.

Modify the display of functions in a feature set

You can modify how existing method functions are displayed in a feature set.

Sort the display order of functions in a feature set

1. Find the feature set you want to change, right-click it, and click Manage Methods.
2. In the Manage Methods dialog box, enter a value in the Order Value column to specify the
order each method's function will be displayed in. Functions will be arranged from low Order
Value to high.

Group the functions in a feature set

1. Find the feature set you want to change, right-click it, and click Manage Methods.
2. In the Manage Methods dialog box, enter the same value in the Cascade column to group
each method together as a group of functions in the feature set.

 The Cascade column value is not displayed on the Home page.

 The order that groups of functions are displayed on the Home page is controlled by the
lowest order value for a method within the group. For example, if an administrator sets a
method to an order value of 1 for a group, it is displayed before a method with the order
value of 2 within the group.

SmartPlant Foundation Web Client Configuration Guide 25

 Configuring the client in the SmartPlant Foundation Desktop Client

Manage method access groups

You can manage access to each function tab that appears in a feature set using the methods
access groups.
1. Right-click the feature set you want to change the access groups, and click Manage Access
Groups.
2. In the Manage Related Items dialog box, select each access group to have access to the
method, and click Relate Selected Item .

Create a new method to add as a function

You can create a new method to display as a function in a feature set. The following example
creates a new method function, which can then be associated with a feature set:
1. Click File > New > Administration > Method, and type the name and description for the
new method in the New Method dialog box, such as WFInbox and Show Users To Do
List.
2. In the Client API box, select the client API that will provide the functionality for the new
method, such as ShowInbox.
The method details and boxes that appear depend on the client API selected.
3. In the Inbox title box, type the title to display, such as To Do List.
4. In the ColumnSet box, type the name of the column set to use in the window opened by this
command, such as InboxColumnSet.
5. Select the Available in Desktop Client option as required.
6. Click Finish to create the new method.
You can additionally set the Container ID if you want to associate a new method to a
SmartPlant Foundation container, such as Core.Workflow_Admin. In this way, the same types
of methods can be separated into sub-groups. For more information about container
management, see Manage object and relationship containers in the How to Set Up and
Configure SmartPlant Foundation guide.

Configure API Entry Points to display in a feature set

1. Right-click the feature set in which you want to display the API Entry Points, and click
Manage Entry Points.
2. In the Manage Entry Points dialog box, click Find, and select the API Entry Point you want
to add to the feature set.

3. Click Relate Selected Item , and enter a value in the Order Value column to specify the
order in which the API Entry Point is displayed as a function in the feature set.
For information on how to expose new objects as an API Entry Point, see Exposing
Objects in the How to Configure API Services guide.

SmartPlant Foundation Web Client Configuration Guide 26

 Configuring the client in the SmartPlant Foundation Desktop Client

Modify the display of API Entry Point functions in a feature

set
1. Find the feature set for which you want to modify the display of the API Entry Points,
right-click it, and click Update.
2. In the Entry Point for APIs UI details section of the Update form:
 Click Hide API entry point from list in the UI to hide the API Entry Point function from
the search functionality.
 Click Hide from Home Page to hide the API Entry Point function from the Home page.
 Click Home Page Group, and select the sub-group to which you want the API Entry
Point function to be grouped with.
If the functions are grouped, the order that each function appears in is
controlled by the order value set for the API Entry Point in the Manage Entry Points
dialog box. For example, if the API Entry Point is set to an order value of 1, in a group it
will appear before an API Entry Point with the order value of 2.

Manage API Entry Point access groups

You can control which access groups have permission to see an API Entry Point menu item or
function.
1. Find the feature set for which you want to manage the access groups of the API Entry
Points, right-click it, and click Update.
2. On the Update form, select the Required Access Groups tab, and click Maintain
Relationships .
3. In the Maintain Relationships for Entry Point dialog box, click Find.
4. Select each access group, and click Relate Selected Item to give it access to the API
Entry Point.

Configure actions menu items

You can configure a method to appear as an item on the Actions menu by relating it to an
applicable client API.
Only methods that use a client API supported by SmartPlant Foundation Web Client can
be included on the Actions menu.
For a complete list of all the supported client APIs in SmartPlant Foundation Web Client, see
Client APIs in the SmartPlant Foundation Web Client and Intergraph Smart Digital Asset Client
API Reference guide.

SmartPlant Foundation Web Client Configuration Guide 27

 Configuring the client in the SmartPlant Foundation Desktop Client

Display a method icon on the actions menu

1. Find the method, and click Update.
2. On the method update form, locate the Shortcut toolbar details section.
3. In the Shortcut icon box, enter the name of the image to be used as the shortcut icon.
4. In the Shortcut Display Text box, enter the text to be displayed.
5. In the Shortcut Tooltip box, enter the text for the tooltip.
6. In the Shortcut Sequence box, enter the number for the icon to appear in a sequence
ordered from low to high. If the lowest number is two, it will be the first icon on the actions
menu.
Sample icon images are available within the server site. For example, located at:
[SPFServerSite]> content > images > feature-sets.

Configure search menu items

You can select a defined object category or feature function on the Search menu to run specific
searches for each object type. The objects returned are all displayed in the Results table.

Exposing API Entry Points

You can use API Entry Points to expose the various types of object data in the database so they
are displayed on the Search menu as a specific object category or feature function.
You can create new API Entry Points to expose objects, so that each new category is displayed
as a searchable item on the Search menu. You can also edit any existing API Entry Points by
locating the API Entry Point and clicking Update.

Hiding API Entry Points

If you want to hide an API Entry Point to prevent the item from appearing as an object category,
use the following steps:
1. Find the the API Entry Point you want to hide, right-click it, and click Update.
2. In the Update API Entry Point dialog box:
a. Click Hide API entry point from list in UI to hide the API Entry Point item from the
Search menu.
b. Click Hide API entry point from home page to hide the API Entry Point item from the
Home page.
Setting these options does not affect relationship navigation. For example, if you hide
the DEVTag entry point, you can still navigate the relationships to the areas.
For more information on how to create API Entry Points, see Exposing Objects in the
How to Configure API Services guide.

SmartPlant Foundation Web Client Configuration Guide 28

 Configuring the client in the SmartPlant Foundation Desktop Client

Edit the display name of a search menu item

You can also edit existing API Entry Points in the SmartPlant Foundation Desktop Client and
change the display name of the search menu item by editing the name in the Metadata Entity
Collection Name box.
1. Find the API Entry Point of a search menu item you want to edit, right-click it, and click
Update.
2. Edit the display name of the search menu item in the Metadata Entity Collection Name
box.

Edit property comparison criteria

In the API Entry Point, use the Property Comparison box to configure additional criteria to
expose a specific object type using standard property comparison syntax. For example, you can
add a tag category to a tag query to return only tags that match the specified category.
1. Find the API Entry Point of a search menu item, and click Update.
2. Edit the Property Comparison box by adding additional property comparison syntax
criteria.

Configuring column items in dynamic forms

You can configure property attribute column items in a column set to conditionally display in the
same dynamic form section when selected from different configurations or plants. This
functionality allows you to choose to display the properties in a form based on the selected
configuration.
Do not use configuration top or the column items will not appear in the column
set. This is due to a technical limitation.
To configure a property attribute using the Manage Column Items dialog box, click in the
Configs column for the property, and choose the configuration from the list.

SmartPlant Foundation Web Client Configuration Guide 29

 Configuring the client in the SmartPlant Foundation Desktop Client

Configure display items

Display items are used to present data or relationships on a form by assigning attributes to the
display items. Users can create new display items using SmartPlant Foundation Desktop Client
or re-use existing display items from the database. The options for each display item type vary
according to the type of display item being created. You can also control the format of the
display item type using a picture mask.
For more information on display items and using picture masks, see Create new display items
and Picture mask types in the How to Configure the GUI Model guide.

Control the access to display item hyperlinks

You can control the access to hyperlinks used to display the object details on a form in
SmartPlant Foundation Web Client. This functionality is configured by selecting the Disable
Relationship Hyperlink option when creating or updating a display item type in the SmartPlant
Foundation Desktop Client.
For more information, see Display item types in the How to Configure the GUI Model guide.

Configure viewing page titles

The SPFDocumentVersionTreeDisplay column set controls what properties are displayed in
the following viewing page titles:
 View and Markup
 View Native
 View Alternate
 View item in Drawing
 View item in Model
 Edit Files
 Save Target As
Column sets are composed of column items. Each column item represents a property or
relationship value for the item. You can configure what column items are displayed using the
Manage Column items dialog box in the SmartPlant Foundation Desktop Client. The following
are included by default:
 Name
 Revision
 Version
 Workflow Status
For more information on how column sets work, see Configure column sets in the
SmartPlant Foundation How to Configure the GUI Model guide.

SmartPlant Foundation Web Client Configuration Guide 30

 Configuring the client in the SmartPlant Foundation Desktop Client

Configure the display of reports

When creating a report definition in SmartPlant Foundation Desktop Client, you can select the
Context object required option. This option ensures that the report can be run only from a
contextual object, such as a method configured on the Actions menu. If you set this option, the
report will not appear in the Reports feature set in the SmartPlant Foundation Web Client.
For more information, see Create a report in the SmartPlant Foundation Desktop Client Help.

Generate OpenXML Word report for an object

You can generate an OpenXML Word report for an object of any class definition.
The Word Open XML Template classification has been added to the Template Documents
classification tree to support the creation of OpenXML Word report templates. You can create a
custom report template based on the Word Open XML template classification. After creating a
custom report template, you must create a template (.docx) file and a control (.xml) file, and
attach them to the custom report template. The template file contains the layout of the OpenXML
Word report, and the control file contains mapping information that links fields in the template file
to properties in view definitions. After configuring a custom report template, you can create a
new method using the OpenXMLWordReport client API to generate a report based on that
custom template.

 For more information about creating custom OpenXML Word reports, see Create custom
OpenXML Word reports (on page 32).
 Five OpenXML Word report templates are delivered with the software: DocumentTemplate,
External Transmittal Word OpenXML Template, Internal Transmittal Word OpenXml
Template, Cancelled External Transmittal Word OpenXML Template, and Cancelled
Internal Transmittal Word OpenXML Template. DocumentTemplate is used to generate
OpenXML Word reports for classified objects, such as documents. The other four templates
are used to generate OpenXML Word reports for transmittals, which are non-classified
objects.

OpenXMLWordReport client API

The OpenXMLWordReport client API is delivered in the Core.Core_Admin container.
The OpenXMLWordReport client API provides the ability to generate an open XML Word report
for a selected object. This client API is used by the following delivered methods:
 DocumentRevisionOpenXMLWordReport
 ExternalCancelledXmtlOpenXMLWordReport
 InternalCancelledlXmtlOpenXMLWordReport
 RunExternalXmtlOpenXMLWordReport
 RunInternalXmtlOpenXMLWordReport
 SCLBTechnicalQueryReportPreview

SmartPlant Foundation Web Client Configuration Guide 31

 Configuring the client in the SmartPlant Foundation Desktop Client

 SDAXmtlReportPreview

 The DocumentRevisionOpenXMLWordReport method is used to generate an OpenXML

word report for classified objects, such as design documents. The other four methods are
used to generate OpenXML word reports for transmittals.
 For more information about how the software filters the template documents for classified
objects when a report category is specified, see Filter template documents to generate
OpenXML Word reports for classified objects (on page 37).

Create custom OpenXML Word reports

This section describes how to create custom OpenXML Word reports for an object of any class
definition.
Before you begin creating a custom OpenXML Word report, change your
Create scope to Configuration Top so that this template can be used in all plants in the site;
otherwise, you can use it only to create custom reports in the plant under which it was created.
The process for creating a custom OpenXML Word report includes the following tasks:
 Create a template (.docx) file
 Create a control (.xml) file
 Create a template document for OpenXML Word report
 Create a method using the OpenXMLWordReport client API

Create a template (.docx) file

A template file is a Microsoft Word document that contains the layout of the OpenXML Word
report. You can define the layout of the report by adding controls, such as labels, text boxes,
check boxes, list boxes, and so on. A template file can contain both tabular data and non-tabular
data.

SmartPlant Foundation Web Client Configuration Guide 32

 Configuring the client in the SmartPlant Foundation Desktop Client

A sample template file delivered for the transmittals object is shown in the following image:

Number Description

1 Labels for non-tabular data.

2 Labels for tabular data.

3 Static text.

The following procedure describes how to create and configure a template file.
1. Open Microsoft Word.
2. Click the DEVELOPER menu to switch to the Developer mode.
If the DEVELOPER menu is not visible, click File > Options > Customize Ribbon
to enable the Developer mode.
3. To add controls, such as a label, text box, and so on, to the template file, click the
appropriate control in the ribbon, as shown below:

4. After adding the required controls, select a control, and click Properties in the ribbon. The
Content Control Properties dialog box appears.
5. Type a Title and Tag for a control. Each control must have a unique tag. This tag is linked in
the control file to the view definition and property that contains the data for the control.

SmartPlant Foundation Web Client Configuration Guide 33

 Configuring the client in the SmartPlant Foundation Desktop Client

After defining all the tags, click Design View on the ribbon to view all the tags.
6. Specify other properties for controls, as needed.
7. Save the template file.
A sample Design View for the template file delivered for transmittals is shown in the following
image:

Number Description

1 Tags for tabular data

2 Tags for non-tabular data

 When specifying a tag name for a date control in the Content Control Properties dialog
box, always begin the tag name with “dat”, for example, datCurrentdate.
 When specifying a tag name for a check box in the Content Control Properties dialog box,
always begin the tag with “chk”, for example, chkSpaces.

Create a control (.xml) file

The control file is an xml file where you map the controls defined in the template file to specific
properties in view definitions in the database.

SmartPlant Foundation Web Client Configuration Guide 34

 Configuring the client in the SmartPlant Foundation Desktop Client

A sample control file delivered for transmittals is shown in the following image:

The following procedure describes how to create and configure a control file:
1. Open Notepad or any XML editor.
2. Add the root tag as <Control Mapping>.
3. Add the <ViewDefs> tag.
To include properties from multiple view definitions in the control file, list all the view
definitions here. For example:
<ViewDef Name ="ExternalXmtlReportViewDef"/>
<ViewDef Name ="ExternalOpenXMLReportViewDef"/>
4. Create <Controls> tag to define non-tabular data. A Controls tag includes a source and
target that link a control in the template file to its matching property in a view definition. For
example, the following syntax links a text box with the unique tag txtName to the matching
Name property in the ExternalXmtlReportViewDef view definition:
<Controls source ="ExternalXmtlReportViewDef.Name" target ="txtName"/>

 Create a separate control tag for each non-tabular control defined in the template file.
 You can also specify multiple properties in a single control by separating them with a
comma. For example:
<Controls source =
"ExternalXmtlReportViewDef.Name,ExternalXmtlReportViewDef.Description" target
="txtName"/>
5. If the report includes data in a table, add a <Tables> tag.
6. For each table in the report, specify the view definition name as: <Table ViewDef="View
definition name">. For example, <Table ViewDef="ExternalXmtlReportViewDef">.

SmartPlant Foundation Web Client Configuration Guide 35

 Configuring the client in the SmartPlant Foundation Desktop Client

7. Beneath each Table tag, map the property for each column using a Column tag. The
Column tag includes a source and target that link a column in the table to its matching
property in the view definition. For example, the following syntax links a text box with the
unique tag txtRevision to the matching Document Revision property in the view definitions
defined in the preceding Table tag:
<Column source = "Document Revision" target="txtRevision"/>

 Create a separate column tag for each tabular control defined in the template file.
 Close all the tags.
8. Save the file as a .xml file when all controls are mapped.

Create a template document for OpenXML Word report

1. In the tree view in SmartPlant Foundation, expand Document Category > Template
Documents.
2. Expand the Template Documents node.
3. Right-click Word OpenXML Template, and click New Template Document.
4. In the New Template Document dialog box, enter the required information.
5. In the Word OpenXML Report section, enter the following optional information if you will be
configuring different templates for use based on the classification or condition of the objects:
 Report category - A label that represents a group of report templates that are available
to certain types of objects. For this report to be available to an object, the report
category value here must match the value in the Report Category for Classified
Objects box for the method.
 Object Classifications - Any classification for the classified object that uses this
template document for OpenXML Word reports. For example, P&ID, 3D Documents,
Electrical, Civil, and so on.
 Object Condition - An additional level of condition, where you can associate different
templates for different classified objects. For example, you might want to have separate
report templates for current and working documents.
If you have only one template for objects using this method, leave these fields blank.
6. Attach the template file and control file to the template document.
7. Click Finish.

SmartPlant Foundation Web Client Configuration Guide 36

 Configuring the client in the SmartPlant Foundation Desktop Client

Create a method based on the OpenXMLWordReport client API

1. Click File > New > Administration > Method.
2. Type a Name and Description for the method.
3. In the Client API list, select OpenXMLWordReport.
4. In the Template Document Name box, type the name of the template document to be used
when creating a report with this method.
If you are creating a method for classified objects, and if you want the software to
return a different template based on the classification of the object or a condition met by the
object, then leave the Template Document Name box empty.
5. Select the Truncate Time check box to specify that dates included in the report show only
the date, and not the date and time stored in the database.
6. In the Report Category for Classified Objects box, type the report category that you
specified on the template document that will be available using this method.
The software uses the report category value to return a set of matching templates
for the selected object classification.
7. In the Condition list, select a condition.
8. Enter other information, as needed.
9. Click Finish.
For classified objects, if the custom method includes a value in the Template
Document Name box, this template document is always used to generate an OpenXML Word
report with the custom method. Any value specified in the Report Category for Classified
Objects box is ignored.

Filter template documents to generate OpenXML Word

reports for classified objects
If you provide a value for Report Category for Classified Objects on the custom method, then
when that method is called, the software searches for template documents with the same value
in the Report Category property and the Object Classification. If one or more templates are
found with the above combination, the software considers the object condition specified on each
of the template documents and finds the condition that matches the object that the method was
called from. The template document with the matching category and condition is used to
generate the OpenXML Word report.
If the object that the method was called from does not meet the conditions set on any of the
template documents with matching report category and object classification values, the software
navigates up the classification tree from the classification of the selected object and looks for a
matching template document with that classification. This process continues until a template is
found that matches both the report category and condition of the object or until it reaches the
root classification.
This behavior is explained using the following example.
You create two template documents with the following properties:

SmartPlant Foundation Web Client Configuration Guide 37

 Configuring the client in the SmartPlant Foundation Desktop Client

Name Report Category Object Classification Object Condition

Template 1 DocumentRevisions 3D Documents IsReserved

Template 2 DocumentRevisions 3D Documents IsIssued

You also create the following objects:

 A method that has DocumentRevisions as the value for the Report Category for
Classified Objects
 Documents with a subtype of Civil Details in both the Reserved and Issued states
When you generate an OpenXML Word report for any of these design documents, the software
looks for the matching template document with the Object Classification of Civil Details and
Report Category of DocumentRevisions. Because there is no template document with this
combination, the software navigates up the classification tree to the parent classification of Civil
Details that is Civil, and looks for a template document that has an Object Classification of
Civil and a Report Category of DocumentRevisions.
If the software does not find a template document with this combination of values, it navigates
up another level to the parent classification of Civil that is 3D Documents, and looks for a
template with the Object Classification of 3D Documents and Report Category of
DocumentRevisions.
The software finds two template documents with a matching combination of values, so it
evaluates the conditions of each template document and uses the template with the condition
that matches the object the method was called from.
The software ignores the filtering process (described above) if the custom
method includes a value in the Template Document Name box, this template document is
always used to generate an OpenXML Word report with the custom method. Any value specified
in the Report Category for Classified Objects box is ignored.

Configure the Exchange Data functionality

The Exchange Data functionality enables you to export data and documents to CSV files. You
can validate and export these CSV files to a target system using Smart Data Validator. To use
this feature, you must create a custom method using the delivered SPFExchangeData client API
and associate it with the type of object you want to export.
The Exchange Data command allows you to:
 Create a report configuration object to generate basic and inverted CSV files using view
definitions and graph definitions, respectively.
 Create an export details object that is used to generate a control file in XML format with all
the required parameters. This control file is used to run a Smart Data Validator job silently
that will validate and export the documents and data in the CSV files to a target system.
The report configuration object contains details of view definitions and graph definitions, as well
as additional parameters, such as the type of CSV file, inclusion of superseded revisions and
working revisions, CFIHOS format for export, and so on. For more information on how to create
view definitions and graph definitions, see Edge Definitions, Graph Definitions, and View
Definitions in the SmartPlant Schema Editor User's Guide. The view definitions and graph
definitions are used to gather objects by traversing relationships.

SmartPlant Foundation Web Client Configuration Guide 38

 Configuring the client in the SmartPlant Foundation Desktop Client

Access groups and roles

Two access groups, the SPFExchangeDataAdmin access group and the
SPFExchangeDataUser access group, and two roles, the ExchangeData Administrator role and
the ExchangeData User role are delivered with the software.
The SPFExchangeDataAdmin access group and the ExchangeData Administrator role enable
you to access the Exchange Data menu options and associated methods for creating and
finding the report configuration and export details objects. These access groups and roles are
mapped to the Superuser user group by default. If required, they can be mapped to other users.
For more information about access groups and roles, see the How to Configure the Security
Model guide.

CFIHOS format
You can export data and documents to CSV files using the Capital Facilities Information
HandOver Specification (CFIHOS) format. The CFIHOS format is a common data exchange
language that standardizes the specifications of information handover requirements for a project
for owner operators, contractors, equipment manufacturers, and suppliers. The ICFIHOSDetails
interface stores the CFIHOS details and exposes three properties: CFIHOSName,
CFIHOSNumber, and CFIHOSDescription.
The delivered CFIHOS format is supported for:
 FDW tag classification
 FDW material classification
 SDA document classification
 Properties, EnumEnums, and UoMEnums

 You can also export assets, models, and tags in CFIHOS format.
 To export data and documents in CFIHOS format, ensure the class definitions for the
objects being exported realize the ICFIHOS interface.

Sample data for exchange of published documents

You can load the sample data provided at
[drive]\SmartPlant\Foundation\2018\Models\ExchangeData\Sample ExchangeData
Configuration with the SmartPlant Foundation Desktop Client Loader. Use this sample data for
the exchange of published documents. The following sample files are provided:
 Exchange PublishInstructions View Graph EdgeDef.xml - This file contains the sample view
definition, graph definition, and edge definition needed for generating basic and inverted
CSV files.
 ReportConfiguration And ExportDetails.xml - This file contains the sample report
configuration and export details object.
 Exchange PublishInstructions RHM Method.xml - This file contains the sample method for
configuring the shortcut menu command to exchange published documents.
For more information, see the following topics:
 Create a new export details object (on page 40)
 Create a new report configuration object (on page 40)

SmartPlant Foundation Web Client Configuration Guide 39

 Configuring the client in the SmartPlant Foundation Desktop Client

 Manage view definition options (on page 42)

 Manage class definitions for inverted CSVs (on page 42)
 Create a user-defined method for exchanging data (on page 43)

Create a new export details object

An export details object generates a control file in XML format with all the required parameters
to run a Smart Data Validator job silently to validate the documents and data in the CSV files
and export them to a target system.
Generation of the control file for inverted CSV files is not supported.
1. Click File > New > Exchange Data > Export Details.
2. In the New Export Details dialog box, type a name and description for the export details
object.
3. In the Target system name text box, specify a target system name to export the data to.
For example, if you have configured Target1 as the target system object in the Smart Data
Validator staging system, you can specify your target system name as Target1.
4. Specify a configuration to which to export the data in the Target system configuration text
box. For example, ConfigurationTop~PlantA~Project1.
5. In the User name text box, specify a user name for logging into the Smart Data Validator
Job Management module.
6. In the Job definition text box, specify a job definition for running the Smart Data Validator
job.
7. Select the Suppress ENS check box if you want the ENS to be suppressed and objects to
be named according to the values in the CSV file.

Create a new report configuration object

A report configuration object generates basic and inverted CSV files using view definitions and
graph definitions, respectively.
1. Click File > New > Exchange Data > Report Configuration.
2. In the New Report Configuration dialog box, type a name and description for the report
configuration.
3. Specify a shared location to save the generated CSV files and control files in the Export
directory path text box.
4. To create a basic CSV file, click Find beside the View definition box, and select the view
definition to use to collect data about the object.
5. To create an inverted CSV file, click Find beside the Graph definitions for inverted csv
box, and select the graph definition to use to collect data about the object.
6. Select an export details object from the Export details for control file generation list.
7. Select a revision state from the Filter revisions list to export the required revisions of a
document to your CSV file.

SmartPlant Foundation Web Client Configuration Guide 40

 Configuring the client in the SmartPlant Foundation Desktop Client

8. Select the required CFIHOS format from the Export CFIHOS format list to export the data.

 If you do not select either the By CFIHOS Name or the By CFIHOS Number option, the
object name is exported.
 For UoM values, only the CFIHOS name is exported, whether you select the By
CFIHOS Name or the By CFIHOS Number option.
9. Select the Export in background check box if you want a Scheduler task for generating the
CSV files to run in the background.
A notification is generated and displayed in the List of Notifications if the
Scheduler task is successful.
10. Select the Export UIDs for Inverted CSV check box to export the UIDs of the objects.
11. Select the Is CSV repeated check box if your CSV must be generated in repeated rows.
12. Select the Is published data check box if you are exporting published documents.

 IObject properties other than Name and Description will not be exported in an inverted
CSV file.
 Generation of inverted CSV files for documents is not supported. However, you can
generate inverted CSV files for any relationship between documents and other objects.
 You can control the document revisions by selecting the required revision state from the
Filter revisions list. However, if you have already configured your graph definition to
expand edge definitions to collect the specific revisions, you need not use the Filter
revisions option.
For example, if your graph definition is configured to expand issued revisions of
documents only, but you select the Working revision in the Filter revisions list, then
the generated CSV will not contain any revisions. We recommend selecting revision
states from the Filter revisions list only if your graph definition is not configured to
collect the required revisions of your documents.
 If you are exporting published documents, you must also select an export details object
from the Export details for control file generation list, as it contains the details of the
target system to which you are exporting the published documents.
 If you are exporting a document published for a specific tool from SmartPlant
Foundation for the first time, the SPFOriginatorGUID property will be instantiated on the
ISPFTEFSignature interface with a unique UID. This property is used to uniquely
identify the tool signature of the authoring tool on the target system.

SmartPlant Foundation Web Client Configuration Guide 41

 Configuring the client in the SmartPlant Foundation Desktop Client

Manage view definition options

Manage Viewdef Options is available as a shortcut menu command on a report configuration.
Use this dialog box to specify the import definitions to map to the view definition and the
recursive relationship definition to recursively collect objects.
1. Right-click the report configuration.
2. On the shortcut menu, click Manage Viewdef Options. The Manage Viewdef Options
dialog box displays the view definitions available for the selected report configuration.
If the selected report configuration has no associated view definitions, you can query
for view definitions in the library pane and move it to the list of view definitions.
3. In the Importdef Name for Viewdef text box, type the name of a valid import definition
available in the Smart Data Validator staging system to map the view definition to. This is
required in the XML control file generated when creating the export details object.
If you do not specify an import definition, then the name of the view definition is
taken as the import definition name in the XML control file.
4. In the Recursive Reldef UID text box, type the name of the recursive relationship definition
you want to map to the view definition.
This relationship definition is used to expand objects recursively. For example,
the recursive relationship definition, SPXDossierChapterComposition, can be specified in
any of the supported formats as: SPXDossierChapterComposition_12,
SPXDossierChapterComposition_21, +SPXDossierChapterComposition,
-SPXDossierChapterComposition. You can also use comma separated values to include
multiple recursive relationship definitions.

Manage class definitions for inverted CSVs

If you do not want to export the properties of all the objects collected by the graph definition for
creating the inverted CSV, use the Manage Class Definitions for Inverted CSV dialog box to
specify the required class definitions to map to the inverted CSV.
1. Right-click the report configuration.
2. On the shortcut menu, click Manage Class Definitions for Inverted CSV.
3. Find the required class definition in the library pane, and move it to the list of class
definitions.

SmartPlant Foundation Web Client Configuration Guide 42

 Configuring the client in the SmartPlant Foundation Desktop Client

Create a user-defined method for exchanging data

1. Click File > New > Administration > Method.
2. Type a Name and Description for the new method.
3. In the Display as box, type the text that will appear on the shortcut menu of objects if this
method is associated with an interface.
4. In the Client API box, select SPFExchangeData.
5. In the Report Configuration name box, type the name of the report configuration with
which you want to associate the method.
6. If necessary, define a condition that must be met by an object for this method to be available
on the shortcut menu. See the How to Configure the Security Model guide for more details.
7. Select Available in Desktop client to make this option available to objects when viewed in
the SmartPlant Foundation Desktop Client application.
8. Select Available in Web portal to make this option available to objects when viewed in a
Web portal.
9. If the command should appear on a submenu available from the shortcut menu, type the
name of the submenu in the Cascade name box.
Use any of the remaining steps in this procedure if you want to add this new method
to the shortcut menu of objects of an associated type. All these properties are optional.
10. In the Shortcut Icon box, provide the name of the icon image that will be displayed for this
command on the shortcut toolbar.
11. In the Shortcut Display Text box, provide the text that will be displayed on the shortcut
toolbar button for this command.
12. In the Shortcut Sequence box, provide a sequence number that will be used to determine
the placement of this command on the shortcut toolbar.
13. In the Shortcut Tooltip box, type the text that will appear when a user rests the cursor on
the shortcut toolbar button for this command.

 Configure access to this method by relating it to one or more access groups. For more
information, see the How to Configure the Security Model guide.
 To make this new method available on a shortcut menu for items of a specific type, relate
the method to an interface definition for that type of object.

SmartPlant Foundation Web Client Configuration Guide 43

SECTION 7

Manage plant or project data

You can control the type and integrity of data entering your system using the Load Manager
feature set. You create a load job for the different types of objects based on their classification
and configure the required properties or prompted values as dynamic display items in the load
job form for each classification. The load job is automatically placed on to the Loader workflow
and the object is imported into a staging system, where it is validated and exported to a target
system using the Smart Data Validator. You can view your jobs and monitor their progress in the
My load jobs page.

 You can only see this functionality as a feature set if you are connected to an existing Smart
Data Validator database or the Smart Data Validator schema is configured in the SmartPlant
Foundation site.
 Any user mapped to the VTL Data Mapper or Business Administrator role can access the
Load Manager functionality.
For more information, see the following topics:
 Configure plant or project data (on page 44)
 Create a load job (on page 45)
 Create dynamic display items in load job form (on page 46)
 My load jobs actions (on page 47)

Configure plant or project data

You configure the mapping for importing plant or project data using Smart Data Validator. Smart
Data Validator imports files in CSV format into the staging system where the validation takes
place. Smart Data Validator uses import definitions to map the column headers in the input CSV
file to the correct column headers for objects, properties, and relationships in the staging area.
The import mapping not only uses the physical column headers that already exist in the input
data file, but it also supports other column headers that are computed or provided by the user
during the import process. Smart Data Validator validates the quality of the incoming data in the
supplied files before they are loaded into the system. For more information on import mappings
and validation, see the Intergraph Smart Data Validator Administration User’s Guide.
You also configure data using the CreateClassObjAndLoad client API, which is used to create
classified objects and provide the capability to upload files into the Smart Data Validator
workflow using a CSV control file.
The client API parameter 12 is used to specify the CSV control file quantity, and parameter 13 is
used to show a second upload page in the wizard from which you can upload files:

Parameter Description

Parameter 12 Maximum Number of Control Files

SmartPlant Foundation Web Client Configuration Guide 44

 Manage plant or project data

Parameter Description

Parameter 12 Specifies the maximum number of control files that may be

description selected.

Parameter 12 type Integer

Parameter 12 default None

Parameter 13 Show File Upload Page

Parameter 13 Boolean to control whether to show the file upload page in

description the wizard.

Parameter 13 type Boolean

Parameter 13 default False

Create a load job

You can create a load job in the SmartPlant Foundation Web Client when setting up a plant or
project. This allows you to control the type of data entering your system and validate it by
converting the SmartPlant Foundation object into a load job. The load job contains one or more
control files with all the details of the data that must be validated before entering into the system,
such as tags or documents and their attached files. Each load job has a defined classification
that determines which type of data must be validated using Smart Data Validator.
You can use the sample load files and CSV file located at: [drive]:\Program Files
(x86)\Smart\SDV\2018\SampleData\LoadManagerForSPFFolder to create a new classification
for folders and a load job for that classification using the SmartPlant Foundation Desktop Client.
Alternatively, you can use the following steps and create your own load job for any classification,
using the SmartPlant Foundation Desktop Client:
1. Create a new classification under the Loader Types classification by loading an XML file
using the Loader.
2. Create a job details object and relate the job details object to the newly created
classification.
For more information, see Create a new job details object in the Intergraph Smart
Data Validator Administration User’s Guide.
3. Create a new method and relate it to the CreateClassObjAndLoad client API and the
LoaderOptions feature set using the SPFFeatureSetMethods relationship definition.
Ensure the following arguments are configured in the method:

Argument Description Example

SPFArgument1 RelDef to navigate to the SDALoaderClassificationClassD

ClassDef ef

SmartPlant Foundation Web Client Configuration Guide 45

 Manage plant or project data

Argument Description Example

SPFArgument3 UID of classification LC_Folders

SPFArgument4 Classification tree filtering ISDALoaderClass

SPFArgument6 File attachment configuration SPFDesignFile~SPFFileCompos

ition~PROMPT

SPFArgument8 Workflow processing option Loader Workflow

SPFArgument12 Maximum number of control 1

files

The workflow specified in SPFArgument8 of the new method you create will override
any other workflow specified in the job definition in Smart Data Validator Administration.

Create dynamic display items in load job form

You can configure the properties or prompted values as dynamic display items in the load job
form for each classification using the Smart Plant Foundation Desktop Client. The property
values in the display items must be entered when you create load jobs, as the data is used to
process Smart Data Validator jobs with the GetJobDetails computed column API.
You configure forms with dynamic display items in sections unique to each classification as
follows:
1. Create a new sub-classification. For example, create Folder under the Loader Types
classification by loading an XML file using the Loader. Use the sample code below to create
the Folder sub-classification XML file:
<Container>
<SDALoaderClassification>
<IObject UID="LC_Folders" Name="Folders" Description="Folders
classification"/>
<ISDALoaderClass />
<ISPFObjClass />
<ISDALoaderClassification />
</SDALoaderClassification>
<Rel>
<IObject UID="LDRC_Loader_Types.LC_Folders"/>
<IRel UID1="LDRC_Loader_Types" DefUID="SPFClassMember"
UID2="LC_Folders" />
</Rel>
<Rel>

SmartPlant Foundation Web Client Configuration Guide 46

 Manage plant or project data

<IObject UID="SDALoaderClassification.Realizes.ISPFFolder"
ContainerID="SDA.LoaderSchema" />
<ISchemaObj />
<IRel UID1="SDALoaderClassification" IsRequired="False"
DefUID="Realizes" UID2="ISPFFolder" OrderValue="0" />
</Rel>
</Container>
2. Create a form. For example, create Load Folders and relate it to the newly created Folder
classification. The form must contain the ISPFPDisplayOverride section, which is required
to dynamically display the required column sets on the load job form based on the
classification.
3. Create a new interface. For example, create ISDALoaderPromptedValues by loading an
XML file using the Loader and expose the required property definitions, such as,
SPFFolderMessage and SPFFTRFailureMsg. Relate the new interface to the Loader
Types classification.
4. Create a new column set. For example, create Folder_CS and relate it to the Folder
classification and the ISDALoader interface definition. Use the
SPFInterfaceDefColumnSet relationship definition to relate the column set to the
ISDALoader interface definition.
5. Create a column item for the column set. For example, create Folder Message and type
SPFFolderMessage in the Property definition UID text box.
6. Create a job details object and relate the job details object to the Folder classification.
For more information, see Create a new job details object in the Intergraph Smart
Data Validator Administration User’s Guide.
7. Log into the SmartPlant Foundation Web Client and navigate to the Load Manager feature
set to view the dynamically generated section with the Folder Message display item in the
Load Folders form.

My load jobs actions

1. In the Load Manager feature set, click Show My Load Jobs.
2. On the My Load Jobs page, select a load job, and click Actions.
You can monitor progress of the load jobs you created in the current scope, or you can
select one of the following options:

Click This To do this

Approve Approve and trigger the next workflow step of the

selected load job.

Delete Delete the selected load job, along with any attached
files.

SmartPlant Foundation Web Client Configuration Guide 47

 Manage plant or project data

Click This To do this

Download Download the validation report for the selected load job
Report as a Microsoft Excel file to a location of your choice. You
can view the report and take any corrective actions.

View Summary View the summary of the selected load job.

The load job will remain in the database if you do not delete it, even after the job is
successfully processed.

SmartPlant Foundation Web Client Configuration Guide 48

SECTION 8

Configure document management

While you can manage documents similarly in the SmartPlant Foundation Web Client, the
actions on your menu are slightly different than what you see in SmartPlant Foundation Desktop
Client. These actions are configured out of the box on design and vendor documents for basic
functionality as described in the following table. You can configure the methods further, for
example, creating new major or minor revisions on revise.

You will see What it does Instead of

Edit files Checks out the document, revising it if necessary  Check out
 Revise

Replace files Checks out the document so you can replace the attached file  Check out
and revises the document, if necessary. Checks in the  Revise
document and optionally signs it off.

Undo edit files Changes the document from checked out to checked in. Undo check
Removing any new version created by the check out. out

Check in files Checks in the document and signs it off if necessary Check in

Sign off Changes the status of the document from Working to Current. Sign off

Undo sign off Changes the status of the document from Current to Working. Undo sign off

 If you have created your own custom document classes, you will need to configure the new
methods to work with your documents and their interfaces.
 Do not configure the SmartPlant Foundation Web Client actions on SmartPlant Foundation
Desktop Client documents. While the actions will appear and can be selected, they do not
work.

SmartPlant Foundation Web Client Configuration Guide 49

 Configure document management

Configure viewing for Hexagon PPM file types

Users can view Hexagon PPM 2D drawings and 3D models without any additional software
installed on their client computers. To do so, SmartPlant Foundation uses WebGL viewer files
generated from the Hexagon PPM 2D drawings and 3D models, as follows:
 Hexagon PPM 2D models - .vecz file types
 Hexagon PPM 3D drawings - .binz file types
The following MicroStation files can also be viewed in a web browser without
additional software installed on client computers or additional configuration beyond the tasks in
this section: MicroStation V8 .dgn files and MicroStation .dwg files that contain proxy objects.
However, additional software must be installed on the server computer. For more information,
see Set up the SmartPlant Foundation File Server for WebGL viewer file display (on page 51).
For this to work, you must:
1. Set up both the SmartPlant Foundation File Server and the SmartPlant Foundation
Application Server so that the WebGL viewer files can be displayed. For instructions, see:
 Set up the SmartPlant Foundation File Server for WebGL viewer file display (on page
51)
 Set up the SmartPlant Foundation Application Server for WebGL viewer file display (on
page 53)
2. Use the Desktop Client to configure SmartPlant Foundation so that WebGL viewer files can
be generated automatically. For instructions, see Enable automatic generation of WebGL
viewer files for Hexagon PPM 2D and 3D files (on page 53).
After you complete this configuration, WebGL viewer files will be automatically
generated anytime a Hexagon PPM file is published to or stored in the SmartPlant
Foundation database.
3. If you are upgrading SmartPlant Foundation from a version earlier than 2018, or if there
were already Hexagon PPM 2D or 3D files published to or stored in the database before you
configured SmartPlant Foundation Web Client, you must manually generate the WebGL
viewer files for those files. You can generate in batch using the Create Renditions in Batch
command. See CreateRenditionsInBatch client API and its delivered method and Create
and view batch renditions for more information. For instructions, see Manually generate
WebGL viewer files for Hexagon PPM 2D and 3D files already in the database (on page 54).
Check the combination of hardware, software, and browser settings on client computers to make
sure they can display WebGL viewer files. For instructions, see Configure client computers to
display WebGL viewer files (on page 57).

SmartPlant Foundation Web Client Configuration Guide 50

 Configure document management

Set up the SmartPlant Foundation File Server for WebGL

viewer file display
These procedures must be completed on the server that hosts the SmartPlant
Foundation File Service software. In many deployments, this server is the same as the
SmartPlant Foundation application server. But if you have created a separate SmartPlant
Foundation File Server to host the File Service software, you will need to perform these steps on
that server instead.
To set up the SmartPlant Foundation File Server for WebGL viewer file display:
 Verify prerequisites on the SmartPlant Foundation File Server (on page 51)
 Activate MicroStation on the SmartPlant Foundation File Server (on page 51)
 Set the Load User Profile property and grant permissions (on page 52)

Verify prerequisites on the SmartPlant Foundation File Server

Before you configure viewing for Hexagon PPM file types, make sure that the
SmartPlant Foundation File Server has the prerequisite hardware and software, as defined in
SmartPlant Foundation Hardware and Software Recommendations in the SmartPlant
Foundation Installation and Setup Guide. In particular:
 Intergraph Smart® Interop Publisher 2017 R2 must be installed on the SmartPlant
Foundation File Server.
 Both MicroStation V8i SS3 and RealDWG 2013 SP1 must also be installed on the
SmartPlant Foundation File Server if the SmartPlant Foundation database contains any files
that are:
 MicroStation V8 .dgn files
 .dwg files that contain proxy objects
This is required because, even though Microstation V8 .dgn files and .dwg files are
Microstation file types, WebGL viewer files are used to display them in a browser, and this
software is used to correctly generate the WebGL viewer files.

Activate MicroStation on the SmartPlant Foundation File Server

If the SmartPlant Foundation site contains any files that are either MicroStation V8 .dgn files or
.dwg files that contain proxy objects, you must activate MicroStation on the SmartPlant
Foundation File Server. Otherwise, you can skip this task.
MicroStation must be activated for every File Service application pool identity
user (by default, [sitename]FileService) on each SmartPlant Foundation site on the server.
1. Log on to the file server as the File Service application pool identity user (by default,
[sitename]FileService).
2. Open MicroStation and activate a license using the product's activation wizard.
For more information, see the license management documentation in the MicroStation Help file.

SmartPlant Foundation Web Client Configuration Guide 51

 Configure document management

Set the Load User Profile property and grant permissions

Your SmartPlant Foundation File Service application pool identity user (by default,
[sitename]FileService) must be a member of the SPFUsers group on the SmartPlant Foundation
File Server.
The SmartPlant Foundation File Service application pool identity user must be
a domain user account if you are not using your SmartPlant Foundation application server as
your file server.
To generate WebGL viewer files, you must:
 Set the Load User Profile property to True.
 Grant local launch and activation permissions for the SPFUsers group or the File Service
application pool identity user account.

Set the Load User Profile property

1. Set the Load User Profile property for your file service site in IIS to True.
For more information on setting the Load User Profile property in IIS, refer to your
Microsoft IIS documentation.
2. Recycle all application pools for the site using SmartPlant Foundation Server Manager.

Grant local launch and activation permissions for the SPFUsers group or the File Service
application pool identity user account
Permissions must be correctly set for the SPFUsers group or for the File Service application
pool identity user (by default, [sitename]FileService) for every SmartPlant Foundation site on the
SmartPlant Foundation File Server.
1. Open Component Services, and expand Component Services > Computers.
2. Right-click My Computer, and click Properties.
3. Click the COM Security tab.
4. In the Launch and Activation Permissions area, click Edit Default.
5. Click Add.
6. Type SPFUsers or the File Services application pool identity user name, and then click OK.
7. Select SPFUsers or the File Services application pool identity user name.
8. Check the Allow check box for the following items:
 Local Launch
 Local Activation
9. Click OK, and then click OK again.

SmartPlant Foundation Web Client Configuration Guide 52

 Configure document management

Set up the SmartPlant Foundation Application Server for

WebGL viewer file display
Make sure that the SmartPlant Foundation Application Server has the
prerequisite hardware and software, as defined in SmartPlant Foundation Hardware and
Software Recommendations in the SmartPlant Foundation Installation and Setup Guide.

Configure CORs on the SmartPlant Foundation Application Server

If SmartPlant Foundation Web Client and SmartPlant Foundation Application Server are on
different machines, you must configure CORS on the SmartPlant Foundation Application Server.
This is required so that WebGL viewer files can be displayed.
To configure CORS, you edit the allowedOrigins setting in the SmartPlant Foundation
Application Server’s web.config file to include the base URI of the SmartPlant Foundation Web
Client client domain. This allows requests from the SmartPlant Foundation Web Client server
domain.
1. On the SmartPlant Foundation Application Server, open the site's virtual directory
web.config file for editing. The default file location is:
C:\SmartPlant Foundation 2018 Server
Files\Web_Sites\[Sitename]\web.config
2. Locate the intergraph.webApi > cors element, and edit the allowedOrigins value to include
the machine and domain name of an allowed source of requests. For example:
allowedOrigins="http://mySubDomain.MyCustomDomain.com"
Setting allowedOrigins to * allows any server to request files from SmartPlant
Foundation Web Client. This can pose a grave security risk for your organization.
3. Set the value of the allowCredentials setting to True. For example:
allowCredentials="true"

Enable automatic generation of WebGL viewer files for

Hexagon PPM 2D and 3D files
For Hexagon PPM 2D or 3D files published to or stored in the database after this configuration
is complete, SmartPlant Foundation can automatically generate the WebGL viewer files, attach
them to the document, and store them in the vault. For WebGL viewer files to be automatically
generated, you must enable the Auto generate WebGL viewer files option in SmartPlant
Foundation.
1. Click Find > Administration > SmartPlant Foundation Options in the Desktop Client.
2. In the Name box, type SystemOptions, and click OK.
3. Right-click SystemOptions, and click Update on the shortcut menu.
4. Select the Auto generate WebGL viewer files option in the Update - SPF System
Options dialog box.

SmartPlant Foundation Web Client Configuration Guide 53

 Configure document management

Troubleshooting tips
 If WebGL viewer files are not automatically generated, verify that the default configuration
has not been changed. For more information, see Problems generating WebGL viewer files
in the SmartPlant Foundation Troubleshooting Guide.
 Enabling automatic generation does not create WebGL viewer files for Hexagon PPM 2D or
3D files published to or stored in the database prior to this configuration. If you are
upgrading SmartPlant Foundation from a version earlier than 2018, or if there were already
Hexagon PPM 2D or 3D files published to or stored in the database before you configured
SmartPlant Foundation Web Client, you must manually generate the WebGL viewer files for
those files. You can generate in batch using the Create Renditions in Batch command.
See CreateRenditionsInBatch client API and its delivered method and Create and view
batch renditions for more information. For instructions, see Manually generate WebGL
viewer files for Hexagon PPM 2D and 3D files already in the database (on page 54).

Manually generate WebGL viewer files for Hexagon PPM 2D

and 3D files already in the database
If you are upgrading SmartPlant Foundation from a version earlier than 2018, or if there were
already Hexagon PPM 2D or 3D files published to or stored in the database before you
configured SmartPlant Foundation Web Client, you must manually generate the WebGL viewer
files for those files. You can generate in batch using the Create Renditions in Batch command.
See CreateRenditionsInBatch client API and its delivered method and Create and view batch
renditions for more information. Otherwise, you can skip these steps and continue with
Configure client computers to display WebGL viewer files (on page 57).
After you enable the Auto generate WebGL viewer files option, WebGL viewer files
will be automatically generated anytime a Hexagon PPM file is published to or stored in the
SmartPlant Foundation database. For more information, see Enable automatic generation of
WebGL viewer files for Hexagon PPM 2D and 3D files (on page 53).
To manually generate WebGL viewer files from Hexagon PPM 2D and 3D files, you must
configure the CreateRenditionsInBatch method to generate the correct WebGL viewer files,
then use the Create Renditions In Batch command to generate the WebGL viewer files.
For more information, see the CreateRenditionsInBatch client API and Create and view
batch renditions topics in the How to Configure Document Management guide.
The process is similar for both Hexagon PPM 2D and 3D files. For instructions, see:
 Manually generate WebGL viewer files for Hexagon PPM 2D files already in the database
(on page 55)
 Manually generate WebGL viewer files for Hexagon PPM 3D files already in the database
(on page 56)

SmartPlant Foundation Web Client Configuration Guide 54

 Configure document management

Manually generate WebGL viewer files for Hexagon PPM 2D

files already in the database
If you have problems manually generating WebGL viewer files, verify that the default
configuration has not been changed. For more information, see Problems generating WebGL
viewer files in the SmartPlant Foundation Troubleshooting Guide.

Generate WebGL viewer files for all Hexagon PPM 2D files in your SmartPlant Foundation
database
Hexagon PPM 2D file types include .igr, .pid, .sma, .spe, .sha, and .zyq.
1. Log on to the Desktop Client as an administrator.
2. Find the CreateRenditionsInBatch method.
3. Right-click the method, and select Update.
4. In the Update dialog box, set Rendition file type to FT_VECZ.
5. Set File Types to the values representing the Hexagon PPM 2D file types in your
SmartPlant Foundation database:
 FT_igr
 FT_pid
 FT_sma
 FT_spe
 FT_sha
 FT_zyq
If your database has more than one file type, use commas to separate the values.
6. Click File > Create Renditions In Batch.
Because the process can take a long time, a BatchWebFileGenTask-FT_vecz scheduled
task is created for the file generation. When the tasks are complete, a notification appears in
List of Notifications. To see the number of submitted files and any failures, click View Log
File.
7. If generation fails for individual files, correct any problems with the files, and then follow the
steps below to generate WebGL viewer files for specific Hexagon PPM 2D files.

Generate WebGL viewer files for specific Hexagon PPM 2D files

You can generate WebGL viewer files at either the document or file level:
 Right-click a document, and select Files > Generate 2D WebGL Viewer Files.
 Right-click a file, and select Generate 2D WebGL Viewer File.

SmartPlant Foundation Web Client Configuration Guide 55

 Configure document management

Manually generate WebGL viewer files for Hexagon PPM 3D

files already in the database
If you have problems manually generating WebGL viewer files, verify that the default
configuration has not been changed. For more information, see Problems generating WebGL
viewer files in the SmartPlant Foundation Troubleshooting Guide.

Generate WebGL viewer files for all Hexagon PPM 3D files in your SmartPlant Foundation
database
Hexagon PPM 3D file types include .zvf and .vue.
1. Log on to the Desktop Client as an administrator.
2. Find the CreateRenditionsInBatch method.
3. Right-click the method, and select Update.
4. In the Update dialog box, set Rendition file type to FT_BINZ.
5. Set File Types to the values representing the Hexagon PPM 3D file types in your
SmartPlant Foundation database:
 FT_zvf
 FT_vue
If your database has both file types, use commas to separate the values.
6. Click File > Create Renditions In Batch.
Because the process can take a long time, a BatchWebFileGenTask-FT_binz scheduled
task is created for the file generation. When the tasks are complete, a notification appears in
List of Notifications. To see the number of submitted files and any failures, click View Log
File.
7. If generation fails for documents or individual files, correct any problems with the files, and
then follow the steps below to generate WebGL viewer files for specific Hexagon PPM 3D
files.
By default, .mdb2 file generation timeout is 30 seconds. You can adjust this under
the File Service Settings node of your SmartPlant Foundation site in SmartPlant
Foundation Server Manager. For more information, see File Service Settings node
properties in the SmartPlant Foundation Server Manager User's Guide.

Generate WebGL viewer files for specific Hexagon PPM 3D files

You can generate WebGL viewer files at either the document or file level:
 Right-click a document, and select Files > Generate 3D WebGL Viewer Files.
 Right-click a file, and select Generate 3D WebGL Viewer File.

SmartPlant Foundation Web Client Configuration Guide 56

 Configure document management

Update graphics mappings for previously published files

When a user searches for a tag in a browser or mobile application such as SmartPlant
Foundation Web Client, the search results include links to Hexagon PPM 2D graphic files and
3D model files that contain the tag. To determine whether files contain a tag, Smart Enterprise
Portal relies on graphical object IDs for the tags stored in a graphics map file.
Graphics map files are stored in SmartPlant Foundation, but are typically hidden. When the
Hexagon PPM file is published, the associated graphics map file is created and stored along
with it. For example, when an authoring tool publishes to SmartPlant Foundation, a hidden
graphics map file is created and stored along with the viewable file.
For Hexagon PPM viewable files that were last published to a version of
SmartPlant Foundation earlier than 2017 (6.0) Hotfix 10, the graphics map files must be updated
with the graphical object IDs assigned to the tags in the CDW. Otherwise, when a user searches
for a tag, that file will not be found until after the next time it is republished to SmartPlant
Foundation.
The Update View Item in Drawing command in SmartPlant Foundation updates all the
graphics map files in the database at one time, adding the IDs assigned to the tags in the CDW
to any files where they are missing.
1. Log on to SmartPlant Foundation Desktop Client as an administrator.
2. From the Administration menu, select Update View Item in Drawing.
A scheduled task adds the CDW graphical object IDs for the tags in each viewable file to its
associated graphics map file.

Configure client computers to display WebGL viewer files

 Make sure that the client computers have the prerequisite hardware and software, as
defined in SmartPlant Foundation Hardware and Software Recommendations in the
SmartPlant Foundation Installation and Setup Guide.
 WebGL viewer files cannot be viewed on virtual machines.
Depending on browser preferences and requirements, additional configuration may be required
for client computers to display WebGL viewer files:
 Test client computers support for WebGL (on page 58)
 Set Internet Explorer to run in 64-bit mode (on page 58)
 Set Chrome graphic rendering and acceleration options (on page 59)

SmartPlant Foundation Web Client Configuration Guide 57

 Configure document management

Test client computers support for WebGL

The hardware, software, and browser combination determine whether the client computer can
display WebGL viewer files. To test support:
1. Go to https://get.webgl.org.
2. If the website indicates that WebGL is not supported, follow the instructions provided to
determine the cause.
3. If more than one browser will be used on the client computer to view WebGL viewer files,
repeat these steps for each browser.

Set Internet Explorer to run in 64-bit mode

For users to view WebGL viewer files in Internet Explorer, the browser must be configured to run
in 64-bit mode.
1. In the Internet Explorer Internet Options dialog box, go to the Advanced tab.
2. In the Security section, select Enable Enhanced Protected Mode.

3. Restart the computer for the setting to take effect.

SmartPlant Foundation Web Client Configuration Guide 58

 Configure document management

Set Chrome graphic rendering and acceleration options

For users to view WebGL viewer files in Chrome, the browser must be set to override the
software rendering list and use hardware acceleration.
1. Go to Chrome://settings, and go to the Advanced section.
2. In the system section, turn on the Use hardware acceleration when available option.

3. Go to Chrome://flags.
4. In the Experiments list, find the Override software rendering list item, and click Enable.

5. Restart Chrome.

Configure locking and unlocking of markup layers

To filter locking and unlocking of markup layers by owning group, you must:
 Set the condition on the LockMarkupFile method to
IsMarkupUnlockedAndUserInOwningGroup (it is set to IsMarkupLocked by default).
 Create and set the following condition on the UnlockMarkupFile method:
Name - IsMarkupLockedAndUserInOwningGroup
Description - Markup Locked
Condition definition - Obj.SPFIsMarkupLocked=True and
(Count(Obj->SPFItemOwningGroup_12)=0 or (instr
(Env.OwningGroupsForUserInQueryConfig, Obj->SPFItemOwningGroup_12.Name) > 0))

SmartPlant Foundation Web Client Configuration Guide 59

 Configure document management

Configure view item commands after upgrade

If you want to perform View Item in Drawing and View Item in Model in SmartPlant
Foundation Web Client after upgrading to the latest version of SmartPlant Foundation, update
Arg1 on the ViewItemInDrawing and ViewItemInModel methods after upgrade.
Alternatively, you can run the SmartPlant Foundation Reconsolidation Utility. For more
information, please contact your customer support representative.
1. Log on to the SmartPlant Foundation Desktop Client.
2. Click Find > Administration > Method.
3. Type *ViewItemIn*, and click OK.
Do the following for each method:
1. Right-click the method, and click Update.
2. Set EdgeDef or GraphDef to Versions to
DGD_GetAllDocumentsForConsolidatedObjNoRel.
3. Click Finish.

SmartPlant Foundation Web Client Configuration Guide 60

SECTION 9

Configure workflow
Typical workflows are delivered with the client. The following topics detail how to manage
workflows between users.
For creating new workflow and making them available in the client, see How to Configure the
Workflow Model guide deliver with SmartPlant Foundation.

Configure workflow access

You can configure roles and users that can access or edit workflows using the following access
groups.
 SDAWorkflow and WorkflowView access groups allows user to perform basic actions on a
workflow or workflow step, such as view, reassign, or complete. All users can view
workflows in the delivered software.
 WorkflowAdmin access group allows users to edit workflows. Users in the business
administrator role can edit workflows. Workflows used by the web client are edited in
SmartPlant Foundation Desktop Client.
For more information about configuring workflows, see the How to Configure the Workflow
Model guide.

Configure methods to automatically attach objects to

a workflow
For the CreateObj and CreateClassObj client APIs, you can configure the methods so that when
an object is created it is automatically added to a specific workflow. This means a user does not
have to select a workflow definition when creating the object.
If a single workflow cannot be identified when an object is created, the user can select the
workflow based on the setting of the following options in the Workflow processing option
parameter:

SmartPlant Foundation SmartPlant Foundation Web

Name Desktop Client Client

None No Workflow page appears in the No Workflow page appears in the

wizard, and the object is not wizard, and the object is not
attached to a workflow. attached to a workflow.

Specific Workflow No Workflow page appears in the No Workflow page appears in the
Name wizard, and the object is attached wizard, and the object is attached
to the named workflow. to the named workflow.

SmartPlant Foundation Web Client Configuration Guide 61

 Configure workflow

SmartPlant Foundation SmartPlant Foundation Web

Name Desktop Client Client

Select The Workflow page appears in The Workflow page does not
the wizard, but the user does not appear in the wizard, but the
have to select a workflow to workflow is automatically selected
attach to the object. It is optional. using the interface definition
relationships and conditions.
If more than one workflow is
identified, the software does not
attach the object to any workflow.

SelectRequired The Workflow page appears in The Workflow page does not
the wizard, and the user must appear in the wizard, but the
select a workflow to attach to the workflow is automatically selected
object. using the interface definition
relationships and conditions.
If more than one workflow is
identified, the software does not
attach the object to any workflow.

SmartPlant Foundation Web Client runs this process asynchronously to help

performance. However, the process runs synchronously in SmartPlant Foundation Desktop
Client.

SmartPlant Foundation Web Client Configuration Guide 62

Glossary
access token
A system object that contains client and user information used by APIs to authorize data access.
An access token can be validated by a resource. Clients request access tokens and forward
them to an API.
actions
A common operation on one or more selected objects. Actions are specific to an object type and
are grouped for display in the actions menu, which contains commands to create, update, view,
and manage objects.
active scope
A configuration in which you may view, create, modify, and delete information in the SmartPlant
Foundation client.
API
The Application Programming Interface.
API Services
A configurable interface that provides access to data within a SmartPlant Foundation site
through an Application Programming Interface (API), which uses RESTful APIs provided in a
standardized format using the Open Data Protocol (OData).
as-built
The set of data that describes the existing conditions of a plant or site; the completed and
approved state of a project.
asset
A physical object which is the physical part located in the facility, with its own serial number.
attribute
An object characteristic.
authorization token
A system object that contains enough information for the process to achieve sufficient
confidence in the binding to request that the user can be authenticated by the Authorization
Server.
business administrator
A user that is responsible for the project infrastructure and configuration, as well as managing
contracts, disciplines, users, the WBS, and the PBS.

SmartPlant Foundation Web Client Configuration Guide 63

 Glossary

cache
Memory that stores recently-accessed data so that subsequent requests to access the same
data can be processed quickly.
client API
A .dll (dynamic link library) that performs a particular function in SmartPlant Foundation. Client
APIs are processed by a specific section of code in a component.
common UI
An ActiveX component (.dll) that provides a standard user interface for integration functionality,
such as publish, retrieve, and register. The authoring tools display the common UI when the
user clicks particular SmartPlant commands in the authoring tool.
condition
An object that can restrict access to a method, workflow, or relationship based on specified
criteria.
configuration
A sub-set of a database system that acts as a suppository for managing configuration items as
well as relationships to the assets for that specific part or plant. A system can be made up of
multiple configurations.
contract
A group of documents that are collected and issued for bid, construction, review, and so on.
CORS
Cross-origin resource sharing (CORS) is a mechanism that allows restricted resources found in
a web site, such as Fonts, JavaScript and so on, to be requested from a domain outside of the
originating domain.
create scope
A configuration for data creation, modification, and termination in SmartPlant Foundation.
current document
A document that has been signed off. Current documents can be revised in SmartPlant
Foundation, but not checked out or in.
data list
A list of plant items that can be modified outside SmartPlant Foundation. You can generate data
lists to view and edit SmartPlant Foundation data in Microsoft Excel, and then save the data
back into SmartPlant Foundation.
data sheet
A file that allows users to view, edit, and print object data in a customizable format.
database
Collection of files of comprehensive information that have predefined structure and organization;
a specific program can communicate, interpret, or process these files.

SmartPlant Foundation Web Client Configuration Guide 64

 Glossary

deputy
A user that is selected as a substitute for an out-of-office or disabled user.
design file
A file generated by a design tool, such as SmartPlant P&ID or Aspen Basic Engineering.
display item
Object used to present data or relationships on a form in SmartPlant Foundation.
document
An object used to track revisions to a design file in the software.
document master
An object used to group all the revisions of a document in SmartPlant Foundation.
document revision
An officially recognized change to a document.
domain
A set of data (for example: tool data, SmartPlant Foundation administration data, and schema
data) that is segregated and managed independently in SmartPlant Foundation. Data
segregation improves performance and maintains data integrity. The SmartPlant Enterprise
authoring tools create data in one SmartPlant Foundation domain and publish into another
domain.
edge definition
Single or multiple relationship definitions with direction. In the SmartPlant schema, an edge
definition is used to traverse from a starting object to related objects.
entry point
Provides access to the underlying SmartPlant Foundation data to the Web Client. They can be
configured to provide full access control for each of the exposed object class definitions or
interface definitions. The system automatically configures any relationship definitions or edge
definitions that are valid between the exposed types.
enumerated entry
A member of an enumerated list that defines one possible value for a property in the SmartPlant
schema. Enumerated values are sometimes called enumerated entries.
exposes
The relationship between interface definitions and property definitions in the SmartPlant
schema. Interface definitions expose the property definitions for class definitions.
feature sets
A configured set of object functions that can be used to quickly access data or run reports and
commands.

SmartPlant Foundation Web Client Configuration Guide 65

 Glossary

file server
A service that handles direct file transfer between vaults and the SmartPlant Foundation client.
file type
A setting in SmartPlant Foundation that specifies the format of attached files based on file
extension. This setting determines how files are viewed, edited, and printed in SmartPlant
Foundation.
folder
A grouping object that can contain a number of items. A folder can contain other folders, to build
up a folder hierarchy. A folder can have an owner, which makes it visible only for that user, and
it can have an owning group, which allows access for members of the group. Some uses of a
folder include grouping objects, putting a folder's contents through a workflow, and generating a
data list from a folder's contents.
form
A part of the SmartPlant Foundation client user interface that allows users to specify values for
class definition properties.
function
A process that runs a predefined task, search, or administrative action. Related functions can be
grouped into sets relevant to a selected feature set.
GET
A request-response method between a client and server. A GET requests data from a specified
resource.
graphic report
A filtered view of a drawing or model, displayed graphically in SmartPlant Foundation.
hierarchy
A classified structure with superiors, or roots, and subordinates, or dependents, used for
grouping data.
host
A computer that stores files.
identity token
A system object that contains information about the user and details on how that user was
authenticated and validated by the SmartPlant Foundation Web Client.
implies
The relationship between two interface definitions in the SmartPlant schema. If an interface
definition implies another interface definition, then any class definition that realizes the first
interface definition can also realize the implied interface definition.

SmartPlant Foundation Web Client Configuration Guide 66

 Glossary

Info Map
A display system that uses a systematic approach to analyze, organize, and present clear and
user-focused information, so that you can quickly visualize the relationship details of an
individual object.
integration
Technology that standardizes and improves communication among the various SmartPlant
Enterprise authoring tools used in design, construction, and operation of a plant. Integration
manages data exchange among these authoring tools, which enables sharing and re-use of
plant information throughout the plant lifecycle.
interface definition
A named collection of property definitions that represents a role for a class definition in the
SmartPlant schema.
IWA
Integrated Windows Authentication (IWA) refers to automatically authenticated connections
between Microsoft Internet Information Services and other active directory aware applications.
JSON
JavaScript Object Notation (JSON) is an open standard format that uses human-readable text to
transmit data objects, consisting of attribute-value pairs, between a server and web application.
JSON is an alternative to XML.
method
A call to an API that allows users to perform actions on objects or interfaces in SmartPlant
Foundation.
model
A physical object which is the requisitioned item and includes a model number.
notifications
Alerts to specific events in the SmartPlant Foundation Web Client that appear by registering
your interest in objects or object classes, such as the latest revision to a document.
OAuth
An open standard for authorization. OAuth provides client applications a secure delegated
access to server resources on behalf of a resource owner.
OData
Open Data Protocol (OData) is an OASIS standard that defines the best practices for building
and consuming RESTful APIs.
owning group
The user group to which an object is assigned in SmartPlant Foundation.
picklist
A list of applicable values for a given property in SmartPlant Foundation.

SmartPlant Foundation Web Client Configuration Guide 67

 Glossary

pins
Bookmarked objects that provide quick access to items that you create, save, or pin to the
pinboard in the current session, to quickly recall and manage them in the system.
plant
An object that can represent the top level in the delivered SmartPlant Foundation data hierarchy.
If you use a custom hierarchy, the object at the top level of the hierarchy may have a different
name.
POST
A request-response method between clients and servers. A POST submits data to a specified
resource for processing.
progress
Functionality that allows users to track the development of deliverables, such as documents or
items, against a project plan, indicating any deviations from the original plan.
project
A logical unit of data that is a subset of the items that make up a plant. A project is used for
making controlled, incremental changes to the data in a plant. There can be multiple projects for
a plant at any given time.
property
An object characteristic.
property definition
A basic attribute shared by all members of an object class. Property definitions are grouped
using interface definitions in the SmartPlant schema.
publish
To share a document and its data with other authoring tools by exporting an XML file containing
the document data and relationships. When a document is published, the software places the
XML file in the appropriate SmartPlant Foundation vault and loads the data from the XML file
into the SmartPlant Foundation database. After the document is published, users can retrieve
the data from the XML file located in the SmartPlant Foundation vault into other authoring tools.
query
A detailed search based on object properties.
query scope
A configuration for data queries and relationship expansions in SmartPlant Foundation.
realizes
The relationship between class definitions and interface definitions in the SmartPlant schema.
Class definitions realize interface definitions. The interface definitions that are realized by a
class definition expose the properties for that class definition.

SmartPlant Foundation Web Client Configuration Guide 68

 Glossary

Reason For Issue (RFI)

The reason a document is released as part of a transmittal.
Reason For Receipt (RFR)
The reason why a specific recipient was included on a transmittal or workflow step.
register interest
To subscribe or indicate a stake an object. When a new one becomes available or is updated, a
notification appears in your notification list.
Relationship Builder
A tool to quickly and easily select objects and relate them to each other using selected
relationship definitions.
relationship definition
Associations between interface definitions in the SmartPlant schema. Relationship definitions
identify two specific objects that fulfill the roles on each end of the relationship.
REST
A set of architectural principles used to design Web services that focus on systems resources,
including how resource states are addressed and transferred over HTTP by a wide range of
clients written in different languages. Web services employing a REST architecture read a
designated Web page containing an XML file that describes and includes the desired content.
RESTful APIs
When Web services use REST architecture, they are called RESTful, or REST APIs.
retrieve
A process that imports document data from an .XML file submitted to maintain data consistency
across the system. When you retrieve a document, the retrieved data is analyzed in the
database, which can place workflow tasks on a user's To Do List. The tasks on the To Do List
allow you to create, delete, or modify items at the appropriate time in the design or review
process.
revision
An officially recognized change to a document. Each revision of a document may have multiple
versions.
revision scheme
A numbering convention for document revisions.
role
Determines a user's level of access to data and functionality in a specific plant/project
configuration. Users can belong to more than one role per configuration. Roles are defined by
system administrators and are based on related access groups, domains, and owning groups.
schema
A model used to describe and validate the structure of XML files.

SmartPlant Foundation Web Client Configuration Guide 69

 Glossary

Schema Component
A suite of ActiveX components that provide functionality surrounding the creation, parsing,
validation, and comparison of the SmartPlant schema and data. The tool adapters interact with
the Schema Component to read the SmartPlant schema, to create data for publish, and to
retrieve data.
scope
A selected configuration in which users can view, create, modify, and terminate data.
scoped by
The relationship between property definitions and property types in the SmartPlant schema. The
scoped by relationship specifies the property type that defines acceptable values, or scopes, a
particular property definition. Every property definition in the SmartPlant schema is scoped by
one and only one property type. All properties of that property definition must be of that property
type.
section
A collection of display items used on SmartPlant Foundation forms.
security codes
Configuration-independent items that are used to set different security levels, which can be
applied to objects in a configuration. They can be used to control the confidentiality or restrict
the availability of the objects.
security rules
Security measures that limit the types of data that users have access to in the system. A user’s
access group is used to determine which security rules are relevant.
server
A computer that stores or processes files.
sign off
To approve a particular revision of a document in SmartPlant Foundation. Signing off a
document sets the document to be the current released revision, makes it official, and
supersedes any previous released revisions. Document revisions that have been signed off are
frozen and cannot be checked out.
site
The SmartPlant Foundation server settings that point to SmartPlant Foundation Administration
and Data databases and vaults. Each site allows you to run SmartPlant Foundation operations
on data associated with plants and projects configured in the database.
SSL
Secure Sockets Layer (SSL) provides a secure, encrypted connection between a web server
and a browser application, such as a website. This allows you to transmit encrypted private data
online.

SmartPlant Foundation Web Client Configuration Guide 70

 Glossary

status
The state of a change object at the completion of each step in a workflow.
step
A process that must be performed in order to complete a workflow.
subscribe
To register interest in an object so that you receive a notification when the object is modified.
You can manually subscribe to change notifications in the SmartPlant Foundation client.
superseded
Indicates that a newer, working version of the selected document exists.
tag
A database object that is the physical part as designed.
terminate
The action of changing an object's status to terminated without removing it from the database.
Terminating objects, instead of deleting them, allows you to continue to see the history of the
object after termination.
To Do List
A graphical list of tasks that require attention from the user. In SmartPlant Foundation, the To
Do List contains workflow steps assigned to the user. In the authoring tools, such as SmartPlant
P&ID and SmartPlant Instrumentation, the To Do List contains create, delete, and update tasks
generated when a user retrieves a document.
unit
Group of parts of the schematic and individual worlds of a plant that together perform a given
process function. The identifying number of the unit is unique within the project and within the
plant. Most companies, but not all, use the concept of unit.
UoM
A unit of measurement.
user
An object that specifies data about a person who is authorized to use SmartPlant Foundation.
user profile
Information about windows, configuration, and interface settings, saved by the SmartPlant
Foundation client when you close the application and used to configure the application when
you reopen it.
vault
A folder where files are stored on a host computer.

SmartPlant Foundation Web Client Configuration Guide 71

 Glossary

version
An intermediate update to an existing document that is tracked by the SmartPlant Foundation
software.
virtual directory
A Web folder created in IIS that points to a physical folder on the Web server. Virtual directories
are used by SmartPlant Foundation to run applications and services from the SmartPlant
Foundation server and to transfer files between file servers and clients.
wildcard
A character that helps you narrow your search for objects in the SmartPlant Foundation
database. You can use wildcards in any text box in the Find and Query dialog boxes.
Text wildcards in SmartPlant Foundation include the following:
 ? - Finds any single character
 * - Finds any string of characters
 % - Performs the same function as *
workflow
A series of steps defining actions to be taken on an object in SmartPlant Foundation.
working document
A document that has not been signed off in SmartPlant Foundation.
XML
Extensible Markup Language; the format for all documents published or retrieved in an
integrated environment. These XML files must conform to the structure defined by the
SmartPlant schema.

SmartPlant Foundation Web Client Configuration Guide 72

Index
Configure SmartPlant Foundation Web
A Client sites • 8
access token • 63 Configure SSL for a SmartPlant Foundation
actions • 63 Web Client site • 11
Activate MicroStation on the SmartPlant Configure the client in the Web Client • 20
Foundation File Server • 51 Configure the display of reports • 31
active scope • 63 Configure the Exchange Data functionality •
API • 63 38
API Services • 63 Configure view item commands after
as-built • 63 upgrade • 60
asset • 63 Configure viewing for Hexagon PPM file
attribute • 63 types • 50
authorization token • 63 Configure viewing page titles • 30
Configure workflow • 61
B Configuring column items in dynamic forms
• 29
business administrator • 63
Configuring List Edit • 23
Configuring the client in the SmartPlant
C Foundation Desktop Client • 24
cache • 64 contract • 64
client API • 64 Control the access to display item
Column set resolution • 23 hyperlinks • 30
common UI • 64 CORS • 64
condition • 64 Create a control (.xml) file • 34
configuration • 64 Create a feature set • 24
Configure access to Brava! Server • 12 Create a load job • 45
Configure actions menu items • 27 Create a method based on the
Configure an API Entry Point • 21 OpenXMLWordReport client API • 37
Configure API Entry Points in SmartPlant Create a new export details object • 40
Foundation Web Client • 20 Create a new method to add as a function •
Configure API Entry Points to display in a 26
feature set • 26 Create a new report configuration object •
Configure Brava! Server on SmartPlant 40
Foundation sites • 11 Create a SmartPlant Foundation Web Client
Configure client computers to display site • 8
WebGL viewer files • 57 Create a template (.docx) file • 32
Configure display items • 30 Create a template document for OpenXML
Configure document management • 49 Word report • 36
Configure locking and unlocking of markup Create a user-defined method for
layers • 59 exchanging data • 43
Configure methods to automatically attach Create an API Entry Point from a class or
objects to a workflow • 61 interface definition • 21
Configure methods to display in a feature Create an API Entry Point from a Quick
set • 25 Find method • 21
Configure Microsoft SharePoint data • 12 Create custom OpenXML Word reports • 32
Configure plant or project data • 44 Create dynamic display items in load job
Configure search menu items • 28 form • 46
Configure security rules • 18 Create feature sets • 22
create scope • 64

SmartPlant Foundation Web Client Configuration Guide 73

 Index

current document • 64 host • 66

D I
data list • 64 identity token • 66
data sheet • 64 implies • 66
database • 64 Info Map • 67
deputy • 65 integration • 67
design file • 65 interface definition • 67
Display a method icon on the actions menu IWA • 67
• 28
display item • 65 J
document • 65
document master • 65 JSON • 67
document revision • 65
domain • 65 M
Download documents from a non-secure Manage API Entry Point access groups • 27
SharePoint site • 13 Manage class definitions for inverted CSVs
• 42
E Manage method access groups • 26
edge definition • 65 Manage plant or project data • 44
Edit property comparison criteria • 29 Manage view definition options • 42
Edit the display name of a search menu Manually generate WebGL viewer files for
item • 29 Hexagon PPM 2D and 3D files already in
Enable automatic generation of WebGL the database • 54
viewer files for Hexagon PPM 2D and 3D Manually generate WebGL viewer files for
files • 53 Hexagon PPM 2D files already in the
entry point • 65 database • 55
enumerated entry • 65 Manually generate WebGL viewer files for
exposes • 65 Hexagon PPM 3D files already in the
database • 56
method • 67
F model • 67
feature sets • 65 Modify a feature set • 24
file server • 66 Modify properties for a SmartPlant
file type • 66 Foundation Web Client site • 10
Filter template documents to generate Modify the display of API Entry Point
OpenXML Word reports for classified functions in a feature set • 27
objects • 37 Modify the display of functions in a feature
folder • 66 set • 25
form • 66 My load jobs actions • 47
function • 66
N
G Navigate the API Entry Point using the Info
Generate OpenXML Word report for an Map • 21
object • 31 notifications • 67
Generating localization resource files • 16
GET • 66 O
graphic report • 66
OAuth • 67
OData • 67
H owning group • 67
hierarchy • 66

SmartPlant Foundation Web Client Configuration Guide 74

 Index

P Set up the SmartPlant Foundation

Application Server for WebGL viewer file
picklist • 67
display • 53
pins • 68
Set up the SmartPlant Foundation File
plant • 68
Server for WebGL viewer file display • 51
POST • 68
Setting up SmartPlant Foundation Web
Preface • 7
Client logging • 14
progress • 68
Show all navigations in the Info Map • 22
project • 68
sign off • 70
property • 68
site • 70
property definition • 68
SmartPlant Foundation Web Client
Publish • 68
deployment • 15
SmartPlant Foundation Web Client
Q Localization • 16
query • 68 SmartPlant Foundation Web Client site
query scope • 68 diagnostics • 11
SSL • 70
status • 71
R step • 71
realizes • 68 subscribe • 71
Reason For Issue (RFI) • 69 superseded • 71
Reason For Receipt (RFR) • 69
register interest • 69
Register SmartPlant Foundation Web Client
T
with the Intergraph Authorization Server • tag • 71
9 terminate • 71
Relate a method to a feature set • 22 Test client computers support for WebGL •
Relationship Builder • 69 58
relationship definition • 69 To Do List • 71
REST • 69
RESTful APIs • 69 U
retrieve • 69
unit • 71
revision • 69
UoM • 71
revision scheme • 69
Update a SmartPlant Foundation Web
role • 69
Client site • 10
Update graphics mappings for previously
S published files • 57
schema • 69 user • 71
Schema Component • 70 user profile • 71
scope • 70
scoped by • 70 V
section • 70
vault • 71
security codes • 70
Verify prerequisites on the SmartPlant
security rules • 70
Foundation File Server • 51
Select the role to view navigations • 22
version • 72
server • 70
View navigations visible in the Info Map • 22
Set Chrome graphic rendering and
virtual directory • 72
acceleration options • 59
Set Internet Explorer to run in 64-bit mode •
58 W
Set the Load User Profile property and wildcard • 72
grant permissions • 52 workflow • 72

SmartPlant Foundation Web Client Configuration Guide 75

 Index

working document • 72

X
XML • 72

SmartPlant Foundation Web Client Configuration Guide 76