Professional Documents
Culture Documents
Troubleshooting Guide
DSPF1-PE-200087C - UPDATED
Copyright
Copyright © 2008-2012 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement;
contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade
secret law, and international treaty, and may not be provided or otherwise made available without proper authorization from
Intergraph Corporation.
U.S. Government Restricted Rights Legend
Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of
the United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813
Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless
the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed
license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use
of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives
licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement
and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for
resale or redistribution.
Warranties and Liabilities
All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software
or applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this
document or its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes
the information in this publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the
terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not
supplied by Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks
of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered
trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product
names are trademarks of their respective owners.
Portions of the user interface copyright 2012 Telerik AD.
Contents
Preface .......................................................................................................................................................... 7
SmartPlant Foundation Product Documentation .................................................................................... 7
Documentation Comments ..................................................................................................................... 9
Integration .................................................................................................................................................. 33
Unable to Publish or Retrieve Documents ............................................................................................ 33
Unable to Publish Plant Breakdown Structure (PBS) Document.......................................................... 36
FTR .............................................................................................................................................................. 73
Unable to Run FTR Attribute and Content Searches............................................................................ 73
How to Set Up and Configure SmartPlant Foundation - Provides system administrators with
information on setting up and configuring the SmartPlant Foundation system after all
software has been installed.
SmartPlant Enterprise Backup and Restore Guide - Provides backup, restore, and
resynchronization procedures for SmartPlant Foundation, SmartPlant Basic Integrator, and
integrated SmartPlant Enterprise authoring tools. The procedures are designed to minimize
data loss and downtime when restoring data in an integrated environment.
SmartPlant Foundation/Integration Architecture Guide - Describes the architecture of the
SmartPlant Foundation and integration software.
Integration: A Gentle Introduction to the SmartPlant Schema - Provides an introduction to
the SmartPlant schema and the data model that describes how the SmartPlant schema is
constructed.
Integration: A Gentle Introduction to SmartPlant Schema Patterns, Process & Practice -
Provides an introduction to patterns in the SmartPlant schema.
SmartPlant Foundation Licensing Guide - Provides information for installing and configuring
licenses in SmartPlant Foundation.
SmartPlant Foundation Upgrade Guide - Provides step-by-step instructions for upgrading
from SmartPlant Foundation or SmartPlant Basic Integrator version 2008 and later to the
current version.
SmartPlant Enterprise Citrix Configuration Guide - Provides information on configuring
integrated SmartPlant® Enterprise applications to run in a Citrix environment.
SmartPlant Foundation Web Portal Samples Overview - Provides a brief overview of the
customization samples delivered with the SmartPlant Foundation Web Portal.
User's Guides
SmartPlant Foundation Server Manager User's Guide - Provides instructions for using
SmartPlant Foundation Server Manager to configure the SmartPlant Foundation server and
to upgrade SmartPlant Foundation databases.
Schema Editor User's Guide - Provides instructions for using the Schema Editor to view and
extend the SmartPlant schema, view and modify authoring tool mapping, and compare
schema files.
SmartPlant Mapping User's Guide - Provides guidelines, procedures, and examples of
mapping between the SmartPlant schema and integrated authoring tools.
SmartPlant Model Loader User's Guide - Provides instructions for using the Model Loader to
®
load documents exported from PDS or AVEVA PDMS into the SmartPlant Foundation
database.
SmartPlant Foundation Administrator's Guide - Provides SmartPlant Foundation
administrators with basic information about how to administer standalone SmartPlant
Foundation.
Integration Administrator's Guide - Provides information for system administrators on how to
set up and configure an integrated environment.
Administrator Guides
SmartPlant Foundation Server Manager User's Guide - Provides instructions for using
SmartPlant Foundation Server Manager to configure the SmartPlant Foundation server and
to upgrade SmartPlant Foundation databases.
Schema Editor User's Guide - Provides instructions for using the Schema Editor to view and
extend the SmartPlant schema, view and modify authoring tool mapping, and compare
schema files.
Documentation Comments
Send documentation comments or suggestions to PPMdoc@intergraph.com
mailto:ppmdoc@intergraph.com?subject=documentation comments.
Error Message
The error message that appears when you try to log on contains the following text: "Client found
response content type of 'text/html; charset=utf-8', but expected 'text/xml'. The request failed
with an empty response."
Solution
On the server, open Internet Explorer and enter the following address (or equivalent for your
site) http://localhost/spf42server/ServerRequest.asmx.
This action should produce an error screen. The Description should point to where the error is.
Possible Causes
Incorrect version of .NET.
You may need to reregister IIS with the Microsoft .NET Framework. To reregister IIS, use
the following command:
C:\WINDOWS\Microsoft.NET\Framework\version\aspnet_regiis.exe –i
Where version is your .Net framework 2.0 version.
For more information, see your IIS and .NET Framework documentation.
Error Message
The error message that appears when you try to log on contains the following text: "The RSA
key container could not be opened."
Solution
If you get this error on logging in to the client, it indicates a permissions problem for the user
account that is trying to access the registry key that contains the security information. The user
account that is configured as the identity running your site's application pool in IIS, needs to be
able to access this security key in the registry. You can perform either of the procedures below
to resolve this problem.
To give access to the local user account:
aspnet_regiis -pa "NetFrameworkConfigurationKey" Local_User_Account_Name
(Run this from C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727, and substitute your actual
account name for Local_User_Account_Name above)
-Or-
Set the user account to have system access to the Registry. (Normally this is only done if you
are running IIS with application pools and can set up a dedicated user account for the
SmartPlant Foundation application pools).
Error Message
The HTTP 500.21-Internal Server Error message may be encountered when you try to log on or
browse SmartPlant Foundation and contains the following text:
HTTP 500.21-Internal Server Error: Handler
"PageHandlerFactory-Integrated" has a bad module "ManagedPipelineHandler"
in its module list.
Solution
This occurs when .NET is installed before IIS or the application role has been added after the
Web Server Role. To fix this issue, open a command prompt and go to the .NET directory, for
example:%windir%\Microsoft.NET\Framework64\v4.0.30319
Open a command prompt and type the command: aspnet_regiis –iru
For more information, see your IIS and .NET Framework documentation.
Solution
The SmartPlant Foundation application pool identity must be set to a domain user account, not a
local user account, and this domain user account must be a member of the SPFUsers group on
that server.
Solution
When upgrading SmartPlant Foundation to version 2009 R4 you must Update Site in
SmartPlant Foundation Server Manager to bring in the new services installed, before attempting
to log into SmartPlant Foundation Desktop Client. For more information see the SmartPlant
Foundation Server Manager Guide.
Solution
For Windows 2000 computers, set DCOM permissions correctly for the user by assigning
everyone full access using DCOMCNFG.
1. Click Start > Run.
2. Type DCOMCNFG, and click OK.
3. On the Distributed COM Configuration Properties dialog box, click the Default Security
tab.
4. Under Default Access Permissions, click Edit Default.
5. Add Everyone to the Registry Value Permissions.
6. In the Type of Access list, click Allow Access.
7. Click OK. The users now appear in the Registry Value Permissions dialog box.
8. Click OK.
Solution
Ensure all pre-requisite hot fix packages have been applied to the SmartPlant Foundation
installation on the application server. When applying hot fixes to an installation of SmartPlant
Client, you must also apply any pre-requisite hot fix to the SmartPlant Foundation installation on
the application server. The SmartPlant Client readme will reference any pre-requisite SmartPlant
Foundation hot fixes.
Solution
Right-click Setup.exe and select Run as Administrator.
Solution
Before you can install SmartPlant Foundation on a server, you should have already installed the
Application Server role and Windows Process Activation Service Support role services
installed in Microsoft Server Manager.
2. Select the Roles node and click Add Roles in the right panel.
5. You are presented with the additional selections for the Application Server role.
6. Ensure that Windows Process Activation Service Support is selected. Click Next.
7. Confirm your installation selections are correct and click Install.
8. Review Installation Results. Click Close.
9. Open up a command prompt and type
%WINDIR%\Microsoft.NET\Framework64\v4.0.30319 to go to the .Net Framework 4
64bit folder. Then type the command:
aspnet_regiis-iru
iisreset
You must reset IIS when installing the Application Server role after the Web Server
(IIS) role has been installed to avoid errors.
3. Ensure that all Windows Process Activation Service Support items have been installed,
click Add Role Services in the right panel.
Solution
When SmartPlant Foundation and Schema Component are installed together on the same
machine, you must always uninstall SmartPlant Foundation before uninstalling Schema
Component.
Database Connections
This section contains troubleshooting information about database connections.
You may encounter errors due to the SmartPlant Foundation application server not connecting
to the SmartPlant Foundation database.
Problem
After installing the 64-bit Oracle client software on a Windows Server 2008 application server,
you receive an Oracle error, "Unable to connect to the database" on trying to test your
connection.
Solution
After installing the 64-bit Oracle client on Windows Server 2008, the server must be rebooted.
To see more details about the error, click Show Html Error.
Solution
If the error indicates that the Oracle Client cannot be found, do the following:
1. On the application server, browse to the directory where Oracle is installed.
2. Right-click the Oracle directory and then click Properties.
3. Click the Security tab.
4. Add the SPF_Server IIS user to the list of users for the directory and give it full control.
5. Click Advanced.
6. Select Replace permission entries on all child object with entries shown here that
apply to child objects.
7. Click OK.
8. Click OK.
Error Messages
ORA-12154: "TNS:could not resolve service name"
ORA-12198: "TNS:could not find path to destination"
ORA-12203: "TNS:unable to connect destination"
ORA-12224: "TNS:no listener"
ORA-12571: "TNS:packet writer failure"
Solutions
You can do the following to try to resolve these errors:
1. Check that you can connect to the database server and the data database using the
following Oracle utilities:
tnsping <service name>
sqlplus =<data database user>/<password>@<service name>
Replace the strings in italics with the appropriate information for your database.
2. Use the Oracle Net Configuration Assistant utility to check and test the <service name>. For
more information, see the Oracle documentation.
3. Recycle your Internet Information Services (IIS) application pools on the SmartPlant
Foundation application server. If the Oracle server has been recently rebooted, or if the
instance used by SmartPlant Foundation has been restarted, IIS connections to the instance
need to be reset.
Solution
If you are installing onto a 64-bit operating system, the destination path may default to
"C:\Program Files (x86)\..." In order for the SmartPlant Foundation server to connect to an
Oracle database with a version of Oracle previous to 10.2.0.3, the path string must not contain
parentheses (). Remove "(x86)" from the destination folder path in order to connect to Oracle.
This problem was fixed by Oracle in later versions of its database. Another
solution would be to upgrade Oracle to the latest recommended version. For
recommendations, see the SmartPlant Enterprise Hardware and Software Recommendation
Guide.
Problem
The Oracle.DataAccess dll file is not registered in the Global Assembly Cache (GAC). The
default assembly version of the DLL in the web.config file is different from the Oracle version
installed on the SmartPlant Foundation server.
This error message might also occur when the SmartPlant Foundation server is running on a
32-bit computer. SmartPlant Foundation is a 32-bit application, which requires that IIS run in
32-bit mode.
Solution
1. Register the Oracle.DataAccess dll file by moving the file from
<Oracle_install_directory>\product\11.2.0\client_1\ODP.NET\bin\2.x to
C:\Windows\Microsoft.NET\assembly.
2. Update the Oracle.DataAccess version in the web.config file of the SmartPlant Foundation
site with the version available in the C:\Windows\Microsoft.NET\assembly folder.
For 64-bit SmartPlant Foundation servers, turn on the Enable 32-bit Applications setting for
the SmartPlant Foundation site:
1. Open the Internet Information Services (IIS) Manager.
2. Expand Application Pools.
3. Select the application pool of the site.
To view the application pool of the site, navigate to <computer_name> > Web Sites >
Default Web Site > <SPF_Site>.
4. Click Advanced Settings under Default Application Pool.
5. Set Enable 32-bit Applications to True.
Error Message
The provider is not compatible with the version of Oracle client
Solution
A SmartPlant Foundation administrator should do one of the following:
Problem
Timeout errors occur on a SQL Server site when loading published documents and executing
queries.
Solution
Run the following SQL on your database. Replace <Databasename> with the name of your
database.
ALTER DATABASE <Databasename> SET READ_COMMITTED_SNAPSHOT ON.
If the errors persist, then increase the value for the DBCommandTimeoutSeconds setting for
your site. This property is available in SmartPlant Foundation Server Manager, on the Settings
node under each site node.
This issue is specific to SQL Server.
Solution
Perform the following procedure to make the index usable:
1. Run IIS reset on the selected site.
2. Log in to the site database and run the following SQL commands.
Each command should be executed one at a time, rather than in a batch.
select status from user_indexes where index_name ='PK_PUBOBJPRDETAIL';
(the status should be unusable)
alter table "PUBOBJPRDETAIL" drop constraint "PK_PUBOBJPRDETAIL";
drop index PK_PUBOBJPRDETAIL;
alter table "PUBOBJPRDETAIL" add constraint "PK_PUBOBJPRDETAIL" primary
key ("OBJPROBID");
Solution
1. On the database server, execute the following command to set the value of the following
Oracle parameter:
alter system set "_optim_peek_user_binds" = false;
2. On the application server, recycle the application pools for all sites that connect to that
database.
Solution
If your implementation uses multi-byte languages, such as Chinese, Japanese and Russian, and
you have upgraded to the current version of SmartPlant Foundation from version 2009 R3 SP3
or earlier, you will need to run a script to update the definition of certain columns in the database
in order to accommodate the full length of some properties. Please contact Support for more
information on performing this procedure.
The maximum number of worker processes that can be configured for the cache and
configuration services application pools is limited to 1. Multiple worker processes are not
supported for these application pools.
Due to the introduction of this new cache service, the previous cache synchronization
mechanism, using a distributed cache, is no longer supported. For more information see
the SmartPlant Foundation Installation and Setup Guide.
To achieve the architecture changes, some fundamental changes have been made to
some well-known and frequently used APIs; some of these have been removed. For
more information and a full list of the class and API changes, see the SmartPlant
Foundation Concurrency Changes document, which is delivered with the developer's
toolkit. Contact Intergraph Customer Support for assistance
(http://support.intergraph.com). This document is only intended for users who have done
SmartPlant Foundation server side development or customization.
Configuration Service
The Communication Object
System.ServiceModel.Channels.ServiceChannel Cannot be
Used
DefaultSPFServerURL
Error message
The Communication Object System.ServiceModel.Channels.ServiceChannel cannot be
used for communication because it is in a Faulted state.
This is a general message that you can get for a number of reasons. If you get this message
then browse the config or cache service and run the asmx to get a more specific error.
You will see this message display when you set the site to HTTPS in Server Manager but you
have not updated the DefaultSPFServerURL in the server site's settings to include HTTPS. The
error in the log file gives further detail:
Failed to connect to the default SPFServer specified in the configuration
file ---> SPF.Server.SPFException: Failed to connect to default
SPFServer at 'http://localhost/SPFServer/ServerRequest.asm'.
Solution
When you set a site to include HTTPS, you must change the DefaultSPFServerURL in the
server site's settings in SmartPlant Foundation Server Manager to HTTPS.
Behavior Protocols
Error message
The Communication Object System.ServiceModel.Channels.ServiceChannel cannot be
used for communication because it is in a Faulted state.
The error in the log file displays information that the SPF Application server failed to connect to
the Config service at 'net.pipe://localhost/SPFConfigService'.
Problem
The required protocols for cache service are net.pipe and net.tcp and one or both have not
been enabled on the site’s virtual directory.
Solution
Configure Internet Information Services (IIS) Manage to use net.pipe and net.tcp. See Setting
Up SmartPlant Foundation to Use Cache Service section in the SmartPlant Foundation
Installation and Setup Guide.
Cache Service
Could not load type
System.ServiceModel.Activation.HttpModule
After Windows features and additional roles are installed, you may find that you get this error:
Could not load type System.ServiceModel.Activation.HttpModule.
This is because you’ve installed some .Net 3.5 features on top of .Net 4.0 features. To resolve
this issue:
System.ServiceModel.FaultException
System.ServiceModel.FaultException: The server was unable to process the
request due to the internal error.
To resolve this, follow the steps on resolving this from Could not load type
System.ServiceModel.Activation.HttpModule.
Rejected Credentials
Initialization method ENSGenerationDocMgmtUnitTests.Test_Init threw
exception. System.ServiceModel.Security.SecurityNegotiationException:
System.ServiceModel.Security.SecurityNegotiationException: The server
has rejected the client credentials. --->
System.Security.Authentication.InvalidCredentialException: The server
has rejected the client credentials. --->
System.ComponentModel.Win32Exception: The logon attempt failed.
You will see this error on the server. If you see this error then you need to check that the
ConfigServiceURL in the SmartPlant Foundation server web.config file and the
CacheServiceURL in the ConfigService/SPFSharedSettings/SPFAppServer.config are all
set correctly.
System.ServiceModel.Security.SecurityNegotiationExceptio
n
System.ServiceModel.Security.SecurityNegotiationException: The server
has rejected the client credentials. --->
System.Security.Authentication.InvalidCredentialException: The server
has rejected the client credentials. --->
System.ComponentModel.Win32Exception: The logon attempt failed
You will see this error on the server. To resolve this, open the file web.config in the SPFServer
to check the ConfigServiceURL is correctly set and open the file
ConfigService/SPFSharedSettings/SPFAppServer.config to check the CacheServiceURL
and check that the CacheServiceURL is correctly set. Make sure to remove ingrnet.com (If
applicable). For example:
From
<add key="CacheServiceURL"
value="net.pipe://localhost.ingrnet.com/SPFCacheServer/CacheService.svc
" />
To
<add key="CacheServiceURL"
value="net.pipe://localhost/SPFCacheServer/CacheService.svc" />
Service Throttling
To run multiple processor threads (more than 10) you need to change the service throttling
settings in Internet Information services (IIS) Manager.
1. Select Manage WCF and WF Services > Configure > Throttling.
2. Change the settings to match your system requirements. For example:
Solution
This error can be caused by having multiple worker processes set greater than one on the
cache application pool, which leads to having multiple independent caches running on the
system that get out of synchronization.
Multiple worker processes are supported only on the main SPFServer service application pool.
The maximum number of worker processes that can be configured on the license, cache and
configuration service application pools is limited to one. Multiple worker processes are not
supported on these application pools. For more information, see the SmartPlant Foundation
Installation and Setup Guide.
Integration
This section contains troubleshooting information about working in an integrated environment.
Error Messages
Publish Error
The following message appears when you click Finish in the Publish Wizard:
When you view the log file, you will see the following error description:
Retrieve Error
The following message appears when you click Finish in the Retrieve Wizard:
When you view the log file, you will see the following error description:
For more information about this error, see the "BUG: COM/OLE Server Fails to Start on
Windows NT 4.0 (Q185126)" article on the Microsoft Support Web site at the following URL:
http://support.microsoft.com/default.aspx?scid=kb;en-us;Q185126.
Solution
Reinstall the SmartPlant Client. The path to the installation location must meet the following
criteria:
Folder names must contain no spaces.
Folder names must be no longer than eight characters.
The first eight characters of the folder name must not be identical to the first eight
characters of the name of another folder with the same path.
Alternate Solution
If reinstalling the SmartPlant Client software does not fix the problem, you can replace the long
path to EFProgressBar.exe with the short path in the registry. Be sure to try reinstalling the
SmartPlant Client software before you edit the registry.
Manually editing the registry incorrectly can cause problems that may require you to
reinstall the operating system. Problems created by the incorrect editing of the registry may not
be possible to solve. Edit the registry at your own risk.
Error Message
The following message appears when you attempt to publish the PBS document:
Solution
Add the server to the list of trusted sites.
1. In the Control Panel, double-click Internet Options.
You can also click Tools > Internet Options in Internet Explorer to access the Internet
Options dialog box.
2. Click Security.
3. Click Trusted Sites.
4. Click Sites.
5. Type the name of the SmartPlant Foundation server in the Add this Web site to the zone
text box.
6. Click Add.
7. Click OK.
8. Click OK.
Solution
If the domain name was included in the URL of the SmartPlant Foundation server, you will need
to re-register the authoring tools with SmartPlant Foundation.
Solution
The Arial Narrow font was used in when modifications were made to the file in SmartPlant P&ID,
but the font is not available on your computer. To solve this problem, install the Arial Narrow font
from Microsoft Office.
Solution
This error usually happens when the model has not been decompressed and cached on the
server previously. Make sure that in the Default.aspx file of SPFWebPortal, the
AsynchPostBackTimeout value is set to a value greater than its default value of 90.
The decompression process usually takes several minutes to complete.
Solution
Run the following command at the command prompt on the server:
%SYSTEMROOT%\Microsoft.NET\Framework\v2.0.50727\aspnet_regiis.exe -i
Error Massage
Solution
The plant name must begin with an alphabetical character. You must follow the plant naming
guidelines when naming your plant for top-level hierarchy items used in an integrated
environment.
Do not use a digit or a space as the first character for any plant name or any of the other
plant elements such as area or unit.
Do not use any special characters in any part of the plant name or plant breakdown
structure such as area or unit.
These limitations are imposed by the authoring tools and the database software. For further
information see the Plant Naming Guidelines section in the Using SmartPlant Foundation
Desktop Client Help Guide.
For example the user attempts to create a new design document with the name Design DOC01
but a document is already in the system, named Design_DOC01. The error message displays.
Solution
SmartPlant Foundation treats named objects with spaces exactly the same as documents
named with underscores. This limitation is imposed by the database software.
Solution
You must regenerate and reload your custom PBS Hierarchy graph definition.
1. To recreate the PBS Hierarchy graph definition used to expand the hierarchy in the tree
view, find the CMF you modified in the Desktop Client (Find > Integration > Schema
Documents).
2. Right-click the CMF file version (CMF_Ver), and click Launch CMF File manager (PBS).
3. Click Load.
One node should appear in the tree view.
4. Make sure the Inherit Clicked Item option is selected.
5. Select the PBSComponent object.
6. Select only the classdefs of your hierarchy.
7. Click Export.
8. Edit the generated file SPF_01_AuthoringSchema.xml.
9. Copy and paste the DirectedGraphDef, DeleteInstruction, and Rel object code into a new
XML file.
An example of this code is shown below (yours will vary, depending on your hierarchy).
<Container>
<DirectedGraphDef>
<IDirectedGraphDef
GraphDefn="+ISPFPlant/+ISPFPlant/,SPFPlant_SPFArea_21/SPFArea/+ISPFPlant/,SPFAr
ea_SPFUnit_21/SPFUnit/SPFArea/,SPFUnit_SPFBuilding_21/SPFBuilding/SPFUnit/,SPFB
uilding_SPFBlock_21/SPFBlock/SPFBuilding/,SPFBlock_SPFTrain_21/SPFTrain/SPFBlock
" />
<IObject UID="DGD_PBSHierarchy" Name="PBSHierarchy" />
<ISchemaObj SchemaRevVer="04.02.05" ByCust="True" />
</DirectedGraphDef>
<DeleteInstruction>
<IObject UID="DeleteInstruction-2"
Name="Delete_{E3D82BE6-7065-4B1B-8525-1B78D80FB472}" />
<IRefObject RefClass="Rel" RefUID="{E3D82BE6-7065-4B1B-8525-1B78D80FB472}"
RefName="" />
<IInstruction />
<IRefRel RefDefUID="GraphDefInterfaceDef" RefUID1="DGD_PBSHierarchy"
RefUID2="IPlant" />
<IDeleteInstruction DeleteTransition="Terminated" />
</DeleteInstruction>
<Rel>
<IObject UID="DGD_PBSHierarchy.ISPFPlant" />
<IRel UID1="DGD_PBSHierarchy" UID2="ISPFPlant" DefUID="GraphDefInterfaceDef" />
<ISchemaObj SchemaRevVer="04.02.05" ByCust="True" />
</Rel>
</Container>
10. Launch the Desktop Client Loader (File > Loader) and select the XML file you just created.
11. Click Process.
Client Connection
Unable to Log on to SmartPlant Foundation
You may receive one of the following errors when you try to logon to SmartPlant Foundation
software components.
Error Message
The error message that appears when you try to log on contains the following text: "Client found
response content type of 'text/html; charset=utf-8', but expected 'text/xml'. The request failed
with an empty response."
Solution
On the server, open Internet Explorer and enter the following address (or equivalent for your
site) http://localhost/spf42server/ServerRequest.asmx.
This action should produce an error screen. The Description should point to where the error is.
Possible Causes
Incorrect version of .NET.
You may need to reregister IIS with the Microsoft .NET Framework. To reregister IIS, use
the following command:
C:\WINDOWS\Microsoft.NET\Framework\version\aspnet_regiis.exe –i
Where version is your .Net framework 2.0 version.
For more information, see your IIS and .NET Framework documentation.
Error Message
The error message that appears when you try to log on contains the following text: "The RSA
key container could not be opened."
Solution
If you get this error on logging in to the client, it indicates a permissions problem for the user
account that is trying to access the registry key that contains the security information. The user
account that is configured as the identity running your site's application pool in IIS, needs to be
able to access this security key in the registry. You can perform either of the procedures below
to resolve this problem.
To give access to the local user account:
aspnet_regiis -pa "NetFrameworkConfigurationKey" Local_User_Account_Name
(Run this from C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727, and substitute your actual
account name for Local_User_Account_Name above)
-Or-
Set the user account to have system access to the Registry. (Normally this is only done if you
are running IIS with application pools and can set up a dedicated user account for the
SmartPlant Foundation application pools).
Error Message
The HTTP 500.21-Internal Server Error message may be encountered when you try to log on or
browse SmartPlant Foundation and contains the following text:
HTTP 500.21-Internal Server Error: Handler
"PageHandlerFactory-Integrated" has a bad module "ManagedPipelineHandler"
in its module list.
Solution
This occurs when .NET is installed before IIS or the application role has been added after the
Web Server Role. To fix this issue, open a command prompt and go to the .NET directory, for
example:%windir%\Microsoft.NET\Framework64\v4.0.30319
Open a command prompt and type the command: aspnet_regiis –iru
For more information, see your IIS and .NET Framework documentation.
Solution
This error is caused when the host or virtual directory is not accessible. To fix this problem, do
the following:
1. Check the corresponding <ServerName> value in the Desktop_client.exe.config file, located
in <SmartPlant Foundation Installation
Location>\SmartPlant\Foundation\1.0\SPFDesktopClient\CurrentVersion on the client
computer.
For example, make sure that the following key has the correct information, shown in italics:
<add key="<ServerName>" value="<HostName>:<Virtual Directory>" /> <!-- servername
-->.
2. If a local connection entry has been configured, check the settings.xml file for the user on
the client computer, located in C:\Documents and Settings\<YourUserName>\Application
Data\SmartPlant\Foundation\1.0\Settings.xml.
For example, make sure that the following key has the correct information, shown in italics:
<server dir="<Virtual Directory>" name="LocalEntry" host="<HostName>" />
3. Check that the host as specified (<HostName> /<Servername>) is accessible over the
network.
4. Check that the virtual directory on the SmartPlant Foundation server is accessible.
Solution
This error is caused when the Execute Permissions property for the virtual directory is set to
Scripts and Executables instead of Scripts only. To fix this problem, do the following:
1. In the Windows Control Panel, open Administrative Tools > Internet Information
Services.
2. Right-click the SmartPlant Foundation virtual directory and then click Properties.
3. In the Properties dialog box, set the Execute Permissions to Scripts only.
4. Click OK.
To run the SmartPlant Foundation Desktop Client using a UNC/Network path,
server share, or URL, the client needs to trust the application server containing the client
software, and full trust has to be given to trusted sites. For more information, see Increasing
Trust in the SmartPlant Foundation Installation and Setup Guide or the Integration Setup Guide.
Error Message
Connection Timed Out
Solution
Specify an SMTP server that can send e-mail outside the firewall.
1. On the SmartPlant Foundation server, open the Control Panel.
2. Click Administrative Tools > Internet Information Services to open the Internet
Information Services tool.
7. Click Advanced.
8. Type the name of the local mail server in the Smart Host box.
9. Click OK.
10. Click OK to close the Default SMTP Virtual Server Properties dialog box.
Solution
Review all objects in the configuration that are defined using fully qualified domain names, such
as hosts, server names, IIS host names, and so forth. Update the settings with the new names,
and recycle the application pools on the server.
Symptoms
When you right-click a published 3D model in the Web Portal List web part and click
Relationships > Show Drawing Items, items are not returned. The progress bar has stops
moving, and a yellow triangle appears in the bottom left corner of Internet Explorer, stating that
the server request has timed out.
Solution
Make both of the following changes. Back up your files before making any changes.
Add the following AsyncPostBackTimeout entry, shown below in italics, to the Default.aspx
file, located in <SmartPlant Foundation Installation
Location>\SmartPlant\Foundation\1.0\SPFWebPortal. The AsyncPostBackTimeout value
specified here can be changed as needed. This addresses the timeout problem.
<asp:ScriptManager ID="ScriptManager1" runat="server"
AsyncPostBackTimeout="1200" EnablePartialRendering="true"
EnableScriptGlobalization="true" EnableScriptLocalization="true" >
Add the following maxRequestLength entry to the </system.web> section of the
Web.Config file, located in <SmartPlant Foundation Installation
Location>\SmartPlant\Foundation\1.0\SPFWebPortal.
The maxRequestLength entry addresses the Server 500 error, which is caused by the web
service request return results size exceeding the default limits. The executionTimeout entry
addresses the timeout error. The values specified here can be changed as needed.
<httpRuntime maxRequestLength="16384" executionTimeout="1200" />
Error Message
"The remote certificate is invalid according to the validation procedure."
Solution
Use Internet Explorer to install the server certificate on the client.
1. Start Internet Explorer.
2. In the address box, type "https:\\server_name" using the name of the secure server.
3. In the Security Alert dialog box, click View Certificate.
4. In the Certificate dialog box, click Install Certificate.
5. Click Next in each window of the Install Certificate wizard, and then click Finish.
6. In the Security Warning dialog box, click Yes.
7. Click OK at the success confirmation message prompt.
8. Close Internet Explorer.
Solution
Right-click Setup.exe and select Run as Administrator.
Problems
Several situations can cause this error. Check for the following problems, in particular:
Prerequisite software is not installed, especially the software that connects with the
SmartPlant Foundation server, such as Oracle Client.
ASP .NET connections are not allowed on the IIS server.
Errors involving stdole.dll may be the result of an incomplete installation of a Microsoft Office
application, such as Excel, on the server.
Solution
Because an HTML 404 error can result from any number of problems, you should try to get a
more specific error message from the server.
On the server, open Internet Explorer and enter the following address (or equivalent for your
site):
http://localhost/spfserver/ServerRequest.asmx
This action should produce an error screen. The Description should point to where the error is.
Problem
The Web Portal is not compatible with Internet Explorer 8 Standards mode. The Web Portal only
supports Internet Explorer 8 running in Internet Explorer 7 (IE7) Standards mode. If you are
using Internet Explorer 8, perform one of the following procedures to ensure that the Web Portal
displays correctly.
Solutions
Choose one of the following configurations. It is not necessary to do both.
Add a custom HTTP header on the Web Portal server
1. Launch the IIS Manager.
2. Select the Web Portal site in the tree view.
3. Double-click HTTP Response Headers in the IIS section.
4. Click Add in the Actions section.
5. Type X-UA-Compatible in the Name box, and type IE=EmulateIE7 in the Value box.
6. Click OK.
7. Reset IIS.
You can also edit the Web Portal file directly (either default.aspx or defaultall.aspx) and add
the meta tag at the top of the <Head> section:
<meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7" />
Add a server to the Compatibility View Settings on each client
To ensure that all Web Portal sites on a server display correctly with Internet Explorer 8, you can
add individual servers to your compatibility view settings in Internet Explorer on each client.
If your administrator has added the custom header described in Add a Custom
HTTP Header on the Web Portal Server, it is not necessary to change the Compatibility View
settings on individual client machines.
1. On the client workstation, open Internet Explorer 8, and click Tools > Compatibility View
Settings.
2. Type the name of the server to add in the Add this website box.
3. Click Add to add the server to the Websites you've added to Compatibility View list.
All Web Portal sites on the server added to this list are displayed in compatibility
mode.
4. Click Close.
To ensure that Web Portal sites viewed directly on the Web Portal server display correctly,
add localhost to the compatibility view list for the instance of Internet Explorer 8 installed on the
Web Portal server.
Solution
Run the following command at the command prompt on the server:
%SYSTEMROOT%\Microsoft.NET\Framework\v2.0.50727\aspnet_regiis.exe -i
Solution
This error is the result of ending the Web Portal session that provided the data connection for
the SmartPlant Markup Plus window.
To avoid this error, you must keep your Web Portal session open (or stay logged on) while
viewing the file in the new window.
Solution
This error can be caused by the IIS property authPersistSingleRequest being set to True or
the IIS property authPersistNonNTLM being set to False. To resolve the problem:
For resolution at the site level, set authPersistSingleRequest to False. A sample set of
command lines to be run at the cmd prompt follows:
cd %SystemRoot%\System32\inetsrv
appcmd.exe set config -section:system.webServer/security/authentication/windowsAuthentication
/authPersistSingleRequest:"False" /commit:apphost
For resolution at the server level, set authPersistNonNTLM to True. A sample set of
command lines to be run at the cmd prompt follows:
cd %SystemRoot%\System32\inetsrv
appcmd set config /section:windowsAuthentication /authPersistNonNTLM:true
Solution
Verify that the SmartPlant Foundation application server web site is a trusted site on each
computer that needs to access the SmartPlant Foundation client.
Error Message
"Unable to run EF Document Comparison"
Microsoft may also log an event to the system event log.
Solution
Verify that the proper Excel security settings are configured on the SmartPlant Foundation
server.
Solution
Check the Do not show this dialog again checkbox, and then click OK in the interactive dialog
box.
Solution
This behavior is by design according to Microsoft. Any Office 2007 file opened inside an
Internet Explorer 7.0 frame will be opened outside the context of the Internet Explorer.
A workaround that requires editing the Windows registry is posted on the Microsoft Knowledge
Base Web site at this address:
http://support.microsoft.com/kb/927009
Repairing Office 2007 will restore the default values for the registry entries mentioned in
the Knowledge Base article.
Solution
The problem may be caused by permissions not being set properly on the SmartPlant
Foundation application server, where SmartPlant Foundation and the Web Portal are installed
and configured.
Specifically, the application pool identity that is assigned to run the Web Portal application pool
must be a member of a user group that has administrative rights on the server. This user group
assignment is performed automatically when the Web Portal is created in Server Manager, if the
option to automatically create user accounts and set permissions is selected.
If these permissions were not set up properly, refer to Appendix D: Configuring IIS Application
Pools and User Accounts Manually in the SmartPlant Foundation Installation and Setup Guide
for the detailed procedure for manually setting up these permissions.
Solution
You must ensure that you do the mapping correctly. This error message is encountered when
you do not configure the mapping in the required format. It is important to map left to right
exactly (or top to bottom, depending on your configuration) and in a continuous line. Check your
existing mapping for any errors, and redo the mapping in the correct format.
Graphical Navigation
Unable to Expand a Plant in Tree View or Publish Custom
PBS after Upgrade
Problem
After upgrading with a custom PBS, if you are unable to expand your plant in the tree view and
you are also unable to publish your custom PBS hierarchy, this problem may be the result of
having overwritten your custom PBS hierarchy graph definition during the upgrade.
Solution
You must regenerate and reload your custom PBS Hierarchy graph definition.
1. To recreate the PBS Hierarchy graph definition used to expand the hierarchy in the tree
view, find the CMF you modified in the Desktop Client (Find > Integration > Schema
Documents).
2. Right-click the CMF file version (CMF_Ver), and click Launch CMF File manager (PBS).
3. Click Load.
One node should appear in the tree view.
4. Make sure the Inherit Clicked Item option is selected.
5. Select the PBSComponent object.
6. Select only the classdefs of your hierarchy.
7. Click Export.
8. Edit the generated file SPF_01_AuthoringSchema.xml.
9. Copy and paste the DirectedGraphDef, DeleteInstruction, and Rel object code into a new
XML file.
An example of this code is shown below (yours will vary, depending on your hierarchy).
<Container>
<DirectedGraphDef>
<IDirectedGraphDef
GraphDefn="+ISPFPlant/+ISPFPlant/,SPFPlant_SPFArea_21/SPFArea/+ISPFPlant/,SPFAr
ea_SPFUnit_21/SPFUnit/SPFArea/,SPFUnit_SPFBuilding_21/SPFBuilding/SPFUnit/,SPFB
uilding_SPFBlock_21/SPFBlock/SPFBuilding/,SPFBlock_SPFTrain_21/SPFTrain/SPFBlock
" />
<IObject UID="DGD_PBSHierarchy" Name="PBSHierarchy" />
<ISchemaObj SchemaRevVer="04.02.05" ByCust="True" />
</DirectedGraphDef>
<DeleteInstruction>
<IObject UID="DeleteInstruction-2"
Name="Delete_{E3D82BE6-7065-4B1B-8525-1B78D80FB472}" />
<IRefObject RefClass="Rel" RefUID="{E3D82BE6-7065-4B1B-8525-1B78D80FB472}"
RefName="" />
<IInstruction />
<IRefRel RefDefUID="GraphDefInterfaceDef" RefUID1="DGD_PBSHierarchy"
RefUID2="IPlant" />
Error Message
"No map file available so navigation features will not be available" or similar message in the
status window.
Solution
Run the proxycfg utility from a command prompt. This utility configures WinHttp access on the
SmartPlant Foundation server.
Example syntax:
proxycfg -p "http://129.135.251.220 https://129.135.251.220"
"<local>;*.ingrnet.com"
The instructions depend on how the proxy server is set up. See the Microsoft Developer
Network for more information about using the Microsoft Windows HTTP Services (WinHTTP)
proxy configuration tool.
Batch Printing
Unable to Print File Types Associated with the Default
Printing Application
When you set the printing application for a file type to Default in Desktop Client, SmartPlant
Basic Integrator turns the printing of the file type over to the Windows operating system to
handle. If there is no printto action defined for the file type in the operating system or if the
action has incorrect parameters, printing will not occur correctly.
If you have problems printing file types that have a printing application of Default, you can do
the following to check the default printto application for the file type in the Windows operating
system.
Error Message
The following error message appears when there is a problem with the default printto application
in Windows.
Solution
1. Open Windows Explorer. For more information on opening Windows Explorer, see the
Windows Help.
2. Click Tools > Folder Options.
3. Click the File Types tab.
4. In the list, click the file type that you are having problems printing.
5. Click Advanced.
6. If a printto action for that file type already exists in the list, do the following:
Verify that the application and parameters used to perform the printto action are correct
for the file type, making any necessary modifications.
Type the path to the printing application, along with any necessary print parameters for
that application, in the Application used to perform action box.
Solution
The vault used for these processes cannot have a name that begins with a number.
In case you already have vaults starting with a numeric character, execute the following SQL
command to update the name, substituting your names for the ones in this example:
UPDATE SCHEMAOBJPR SET STRVALUE = 'ABC40Vault' WHERE OBJOBID = (SELECT OBID
FROM SCHEMAOBJ WHERE OBJUID = 'VLT_40Vault') AND PROPERTYDEFUID = 'Name'
AND STRVALUE = '40Vault'
The above SQL command example changes the name of the vault from “40Vault” to
“ABC40Vault.”
Menus
Menu Commands Are Not Legible in the Desktop Client
Some computers with older graphics cards have display problems with some menus in the
Desktop Client. The following graphic displays how menus may look on computers with these
graphic cards:
Solution
1. Open the Desktop Client.
2. Click File > Change User Preferences.
3. Click the Expansion tab.
4. Select Windows Classic menu Style.
5. Click OK.
Menu commands on all Desktop Client menus are now legible.
PDF Generation
Unable to Generate PDF Documents
If PDF generation fails, perform the following troubleshooting steps to determine the source of
the problem.
SmartPlant Foundation can use SmartPlant Markup Plus and SmartPlant Instrumentation
Title Block Component to generate PDF documents, depending on the type of file you are
converting to PDF. For more information about configuring PDF generation on the application
server, refer to either SmartPlant Foundation Installation and Setup Guide or the Integration
Setup Guide.
1. Confirm that SmartPlant Markup Plus or SmartPlant Instrumentation Title Block Component
is installed properly on the application server.
For information on installing SmartPlant Markup Plus, refer to the SmartPlant Markup
Plus Installation Guide. For more information on installing SmartPlant Instrumentation Title
Block Component, refer to either the SmartPlant Foundation Installation and Setup Guide or
the Integration Setup Guide.
2. Confirm the special printers for PDF generation are installed on the server: SmartPlant PDF
Converter XXX.
If the appropriate printer is not present, you may need to either reinstall the printer or
the component. For information on installing the printer for SmartPlant Markup Plus, see
Missing SmartPlant PDF Converter Printer (on page 72). If the title block component
printer is missing, you may need to reinstall SmartPlant Instrumentation Title Block
Component.
3. Execute the following command on the application server to test whether the application can
generate PDF documents.
If using SmartPlant Markup Plus, substitute your source file name and full path for
obj.Name and the full path to the target folder location for $OUTPUTDIR:
dmredl.exe -p obj.Name -pdf $OUTPUTDIR
Example: dmredl.exe -p "C:\PIDFiles\Turbine.pid" -pdf "C:\PIDFiles"
If using SmartPlant Instrumentation Title Block Component, substitute your source file
name and full path for obj.Name and the full path to the target folder location for the
$OUTPUTFILENAME:
updatectb.exe obj.Name $OUTPUTFILENAME
Example: updatectb.exe "C:\PIDFiles\c_192.brw" "C:\PIDFiles\c_192.brw.pdf"
4. Confirm that the source file type is configured for PDF generation in the SmartPlant
Foundation Desktop Client.
For information detailing the expected configuration for PDF generation in the
SmartPlant Foundation Desktop Client, refer to the "Setting Up PDF Generation" topics
within the "Configuring SmartPlant Foundation" section of either the SmartPlant Foundation
Installation and Setup Guide or the Integration Setup Guide.
5. Confirm that the user executing SPFRemoteServices on the application server has
permissions to all PDF-generation-related folders on the server.
These folder locations include the installation folders for SmartPlant Markup Plus and
the title block component and temporary folders on the server. For more information on
security and permissions settings, refer to the "Configuring Security for the Application
Server" topics within the "Setting Up the Application Server" section of either the SmartPlant
Foundation Installation and Setup Guide or the Integration Setup Guide.
Solution
The vault used for these processes cannot have a name that begins with a number.
In case you already have vaults starting with a numeric character, execute the following SQL
command to update the name, substituting your names for the ones in this example:
UPDATE SCHEMAOBJPR SET STRVALUE = 'ABC40Vault' WHERE OBJOBID = (SELECT OBID
FROM SCHEMAOBJ WHERE OBJUID = 'VLT_40Vault') AND PROPERTYDEFUID = 'Name'
AND STRVALUE = '40Vault'
The above SQL command example changes the name of the vault from “40Vault” to
“ABC40Vault.”
Solution
To review details of a document failure in an upgraded SmartPlant Foundation environment
(4.x.x to 2009 R3 SP3), you can use the Show Failure option on the scheduled task, rather than
on the document in the queue. Query for the scheduled task, then right-click the scheduled task
and select Show Failure to review the details of the failure.
For more information, see Retry a failed task in the SmartPlant Foundation User's Guide.
Solution
You must regenerate and reload your custom PBS Hierarchy graph definition.
1. To recreate the PBS Hierarchy graph definition used to expand the hierarchy in the tree
view, find the CMF you modified in the Desktop Client (Find > Integration > Schema
Documents).
2. Right-click the CMF file version (CMF_Ver), and click Launch CMF File manager (PBS).
3. Click Load.
One node should appear in the tree view.
4. Make sure the Inherit Clicked Item option is selected.
5. Select the PBSComponent object.
6. Select only the classdefs of your hierarchy.
7. Click Export.
8. Edit the generated file SPF_01_AuthoringSchema.xml.
9. Copy and paste the DirectedGraphDef, DeleteInstruction, and Rel object code into a new
XML file.
An example of this code is shown below (yours will vary, depending on your hierarchy).
<Container>
<DirectedGraphDef>
<IDirectedGraphDef
GraphDefn="+ISPFPlant/+ISPFPlant/,SPFPlant_SPFArea_21/SPFArea/+ISPFPlant/,SPFAr
ea_SPFUnit_21/SPFUnit/SPFArea/,SPFUnit_SPFBuilding_21/SPFBuilding/SPFUnit/,SPFB
uilding_SPFBlock_21/SPFBlock/SPFBuilding/,SPFBlock_SPFTrain_21/SPFTrain/SPFBlock
" />
<IObject UID="DGD_PBSHierarchy" Name="PBSHierarchy" />
<ISchemaObj SchemaRevVer="04.02.05" ByCust="True" />
</DirectedGraphDef>
<DeleteInstruction>
<IObject UID="DeleteInstruction-2"
Name="Delete_{E3D82BE6-7065-4B1B-8525-1B78D80FB472}" />
<IRefObject RefClass="Rel" RefUID="{E3D82BE6-7065-4B1B-8525-1B78D80FB472}"
RefName="" />
<IInstruction />
<IRefRel RefDefUID="GraphDefInterfaceDef" RefUID1="DGD_PBSHierarchy"
RefUID2="IPlant" />
<IDeleteInstruction DeleteTransition="Terminated" />
</DeleteInstruction>
<Rel>
<IObject UID="DGD_PBSHierarchy.ISPFPlant" />
<IRel UID1="DGD_PBSHierarchy" UID2="ISPFPlant" DefUID="GraphDefInterfaceDef" />
<ISchemaObj SchemaRevVer="04.02.05" ByCust="True" />
</Rel>
</Container>
10. Launch the Desktop Client Loader (File > Loader) and select the XML file you just created.
11. Click Process.
Queries
Queries Run from Classification Tree Cannot be Saved
Problem
If your system is configured so that you can run a new query from an object in the classification
tree using the shortcut menu, you cannot save the query as the Save button is missing from the
Query dialog box.
Solution
If you want to save your queries, run your query from the Query menu. The functionality for
saving queries from the Query dialog box is only available from queries run from the main
Query menu. You can save and manage your saved queries from within the Query menu, and
use the Query > Edit Query command to retrieve and modify criteria that you previously used to
perform a query. This allows you to re-perform a search without entering all new data, as well as
save the query so that you can run it again later.
Solution
After installing SmartPlant Markup Plus to the new location, restart IIS or recycle the application
pools to allow the new path to be set in the environment variable.
Solution
Use SPMPrint to queue SmartPlant Markup Plus Print requests as needed so that they are
processed one at a time.
To start dmredl -p from a DOS prompt, change the syntax to:
SPMPrint dmredl -p
To start dmredl -p from within a batch file, change the syntax to:
Call SPMPrint dmredl -p
In the event of a failure, SmartPlant Markup Plus batch print may stop responding. To restart the
batch print, use the following command from a DOS prompt:
SPMPrint /force_unlock
Solution
Disable, or set to minimum, the graphics accelerator drivers slider.
Problem
Cannot generate PDF files because the printer SmartPlant PDF Converter XXX is missing.
Solution
Run the executable file, SPMpdfInstall.exe -i, which is installed by default in the
<drive>:\Program Files\SmartPlant\Markup\bin folder.
Solution
This error is the result of ending the Web Portal session that provided the data connection for
the SmartPlant Markup Plus window.
To avoid this error, you must keep your Web Portal session open (or stay logged on) while
viewing the file in the new window.
FTR
This section contains troubleshooting information about FTR.
Error Message
"Underlying connection is closed or not working: unexpected error on receive."
Solution
To resolve this problem, do the following on the SmartPlant Foundation Server:
1. Click Start > Run.
2. Type mmc, and then press Enter.
3. On the File or the Action menu, click Add/Remove Snap-in.
4. In the Add/Remove Snap-in dialog box, click Add.
5. On the Standalone tab, click Add.
6. In the Available Standalone Snap-in dialog box, click Group Policy, and then click Add.
7. In the Group Policy Wizard, click Finish.
8. In the Add Standalone Snap-in window, click Close.
9. Click OK in the Add/Remove Snap-in dialog box.
10. Under User Configuration, expand Windows Settings > Internet Explorer Maintenance,
and then click Security.
11. In the right pane, double-click Security Zones and Content Ratings.
12. Under Security Zones and Privacy, click Import the current security zones and privacy
settings, and then click Modify Settings.
13. Select the zone that you would like to modify, and click Custom Level. The zone where the
setting should be enabled is determined by the zone where the target URL of the POST
operation is classified. For example, when you post to an Internet URL, you must enable this
option for the internet zone.
14. Select Submit nonencrypted form data.
15. Restart the process that is running ServerXMLHTTP. To do this, you may have to restart
your computer.
For more information about this solution, see Conformance and Security Changes in MSXML
4.0 SP2 on the Microsoft Web site: http://support.microsoft.com/?id=820882. If these steps do
not fix the problem, you can make the following modifications in the registry.
Manually editing the registry incorrectly can cause problems that may require you to
reinstall the operating system. Problems created by the incorrect editing of the registry may not
be possible to solve. Edit the registry at your own risk.
Solution
The default mail server address may be set incorrectly in the Registry due to a change in the
location of the key in the Registry between JMail versions.
Intergraph recommends only experienced users edit the registry settings.
The mail server's e-mail gateway address should be entered into the following registry keys,
depending on your JMail version:
JMail Version 4.3:
HKEY_LOCAL_MACHINE\SOFTWARE\Dimac\w3JMAIL4\Default Mailserver
JMail Version 4.5:
HKEY_LOCAL_MACHINE\SOFTWARE\Dimac Development\Jmail\Default Mailserver
The time is shown in parentheses after the number of relationships for that item. The time is
formatted in (minutes:seconds.milliseconds).
2. To select a test to run, select the test from the list of performance tests available in the Test
provided area.
3. Move the test into the Tests to be run area by clicking >> or pressing the Enter key. The
tests required appear in the Tests to be run area.
To remove tests from the Tests to be run area, select the test then press << or press
the Delete or Backspace key.
To select all the tests to be run from the Tests provided area click All.
To delete all the tests from the Tests to be run area click Clear.
4. In the Log file path line define the required path to the log file.
The Log file path is the path to the location where the software saves the log file at the
end of the tests. Each test will be appended to the end of the file.
Selecting Browse beside the Log file path line opens up a browse dialog box so the
user can select a new path for the log file.
If no log file exists, the software uses PerformanceTest.log as the default file name,
unless the user manually enters another .log file name.
5. To run the selected tests click Start Test or press Alt + S.
The Start Test button is available when at least one test is added to the Tests to run
area.
The Delay in seconds is the number of seconds of delay between each consecutive
test run.
The Number of runs is the number of times the user can choose the tests to be run.
If the user wants to exit before running any performance tests, click Close button or
press Esc key.
When Start Test is clicked a warning message box appears to warn of the considerable
time the tests could take to complete. Click Yes to confirm that you want to run the tests
or click No to exit the dialog box.
When the tests are running, they can take some time, so a wait cursor is displayed.
When each test completes, the results are shown in the Performance benchmark
results area.
When tests are running, all input buttons are disabled, except for the Stop button.
6. To stop the test, click Stop. This interrupts any test that is still running.
There is a delay between the user clicking Stop and the performance benchmark test
dialog box being available again for editing. This delay is dependent on the test being
interrupted.
The log file is created only with tests that have been run to completion as shown in the
example below. A test that is interrupted does not write any details to the log file.
Solution
The long time taken to refresh the To Do List is due to the Auto refresh/display To Do List
option being enabled in the SmartPlant Foundation Desktop Client user preferences. This option
forces a refresh of the To Do List each time a workflow step action is completed. Enabling the
Auto refresh/display To Do List option is not recommended for users with large numbers of
workflow steps.
To stop this, clear the Auto refresh/display To Do list option in the SmartPlant Foundation
desktop Client user preferences. Now, when a workflow action is completed, only the completed
workflow step is refreshed in the To Do List.
For further information, see Change user preferences section in the SmartPlant Foundation
Desktop Client User's Guide.
Tracing Overview
Tracing is used to provide useful information about a given process. For example, in the file
service MoveFileToVault method, as shown in the code sample below, trace information is
created for each action being performed on the file. This information details what is happening to
the file, and if an exception is thrown, you can see what action was being performed at the time
of the error.
Tracing can also be used to monitor the time taken to perform certain tasks, which is useful in
determining the source of a performance issue.
If lblnAllowOverwrite Then
'*** If a file of this name already exists then delete it
If File.Exists(lstrFullVaultFilePath) Then
Tracing.Info(Tracing.TracingTypes.Core, "Deleting the file "
& lstrFullVaultFilePath)
File.Delete(lstrFullVaultFilePath)
Tracing.Info(Tracing.TracingTypes.Core, "The file " &
lstrFullVaultFilePath &
" has been
deleted")
End If
Else
'*** If a file of this name already exists then throw an error
If File.Exists(lstrFullVaultFilePath) Then
Throw New SPFException(vbObjectError + 1282, "Unable to overwrite
file",
lstrFullVaultFilePath)
End If
End If
File.Delete(lstrFullTempFilePath)
Tracing.Info(Tracing.TracingTypes.Core, "The file " &
lstrFullTempFilePath &
" has
been deleted")
Throw lobjException
End Try
Service Tracing
Set to switchValue=Error to just log errors.
To open and start the Service Trace Viewer:
1. Open a command prompt to navigate to your WCF installation location C:\Program
Files\Microsoft SDKs\Windows\v6.0\Bin.
2. Type SvcTraceViewer.exe.
3. When Service Trace Viewer starts, click File and select Open.
4. Navigate to the location where your trace files are stored.
5. Click the trace file that you want to open.
For more information on Service Tracings follow the link:
http://msdn.microsoft.com/en-us/library/ms732023.aspx.
<listeners>
<!--<add name="XML Trace Listener"/>-->
<add name="Rolling TraceListener"/>
</listeners>
</add>
<add switchValue="Error" name="Performance">
<listeners>
<!--<add name="XML Trace Listener"/>-->
<add name="Rolling TraceListener"/>
</listeners>
</add>
<add switchValue="Error" name="RemoteServices">
<listeners>
<!--<add name="XML Trace Listener"/>-->
<add name="Rolling TraceListener"/>
</listeners>
</add>
<add switchValue="Error" name="Scheduler">
<listeners>
<!--<add name="XML Trace Listener"/>-->
<add name="Rolling TraceListener"/>
</listeners>
</add>
<add switchValue="Error" name="Schema">
<listeners>
<!--<add name="XML Trace Listener"/>-->
<add name="Rolling TraceListener"/>
</listeners>
</add>
<add switchValue="Error" name="SQL">
<listeners>
<!--<add name="XML Trace Listener"/>-->
<add name="Rolling TraceListener"/>
</listeners>
</add>
<add switchValue="Error" name="TEF">
<listeners>
<!--<add name="XML Trace Listener"/>-->
<add name="Rolling TraceListener"/>
</listeners>
</add>
<add switchValue="Error" name="WebRequest">
<listeners>
<!--<add name="XML Trace Listener"/>-->
<add name="Rolling TraceListener"/>
</listeners>
</add>
Switches
The switches allow you to enable tracing for specific areas in the code. Each switch name
describes the area of code for which the tracing can be enabled.
Setting the value for a switch to Off turns off tracing for that area. For example, setting the
DatabaseAccessTraceSource switch to Off turns off all the tracing for the DAL. Or, if you want
to trace only SQL statements, you can turn off all switches except the SQLTraceSource switch.
The switch values are:
Off – Turns off tracing
Error – Logs critical and error events
Warning – Logs critical, error and warning events
Information – Logs critical, error, warning and information events
Verbose – Logs critical, error, warning, verbose and information events
All - Same as verbose
Intergraph recommends setting all values to Error for normal running. When investigating a
specific issue, you can update the related switch to a higher value and then run the operation
you want to trace. You can then set the value back to Error after completing the operation.
listenerDataType="Microsoft.Practices.EnterpriseLibrary.Logging.Configu
ration.RollingFlatFileTraceListenerData,
Microsoft.Practices.EnterpriseLibrary.Logging, Version=5.0.414.0,
Culture=neutral, PublicKeyToken=31bf3856ad364e35"
traceOutputOptions="Callstack"
filter="All"
type="Microsoft.Practices.EnterpriseLibrary.Logging.TraceListeners.Roll
ingFlatFileTraceListener,
Microsoft.Practices.EnterpriseLibrary.Logging, Version=5.0.414.0,
Culture=neutral, PublicKeyToken=31bf3856ad364e35"
name="Rolling TraceListener"/>
Modify the filename to the path you require. Each log file needs to write to a separate folder to
the other web service log files, otherwise the log file may not write.
</tracesettings>
Switches
The switches allow you to enable tracing for specific areas in the code. Each switch name
describes the area of code for which the tracing can be enabled.
Setting the value for a switch to 0 turns off tracing for that area. For example, setting the
DatabaseAccessTraceSource switch to 0 turns off all the tracing for the DAL. Or, if you want to
trace only SQL statements, you can turn off all switches except the SQLTraceSource switch.
The switch values are:
0 – Turns off tracing
1 – Error
2 – Warning
3 – Info
4 – Verbose
The higher values provide increasing levels of tracing. Setting a value to 1 reports only errors.
Setting a value to 2 reports both warnings and errors, and so on. The verbose value outputs
everything.
Intergraph recommends setting all values to 1 for normal running. If investigating a
specific issue, you can update the related switch to a higher value and run the operation you
want to trace. You can then set the value back to 1 after completing the operation.
Delimiter
The delimiter value indicates what character is used to delimit information that is output to the
tracing log file. The default value is the character "|".
Close Files
The _CLOSE values are used to unlock the log files so they can be maintained. In order to
move the files to a different server or delete a large log file, the tracing routines must release
their locks on the files. Setting the value of any of the _CLOSE keys to "YES" (the value is not
case-sensitive) closes its related file.
initializeData=".\SPF40emailtrace.log"/>
</listeners>
</trace>
</system.diagnostics>
If the log files need to be moved, deleted, or edited, you can set the _CLOSE value for
the log file to YES in the tracesettings.config file to unlock the files. There is a decrease in
logging performance when the log files are unlocked. For more information on unlocking the log
files for maintenance, see Setting Logging Levels for a Server (see "Setting Logging Levels" on
page 90)
Make the following changes or additions to appsettings.config, see Maintaining Log Output
Files (on page 95).
…
<add name="GeneralfileOut"
type="System.Diagnostics.TextWriterTraceListener"
initializeData=".\SPF40GeneralTrace.log"/>
<add name="WebRequestOut"
type="System.Diagnostics.TextWriterTraceListener"
initializeData=".\SPF4WebRequestTrace.log"/>
<add name="CorefileOut"
type="System.Diagnostics.TextWriterTraceListener"
initializeData=".\SPF40CoreTrace.log"/>
Column Description
1 Server API; the server function that handles the client request.
2 Number of objects returned.
3 Amount of time (in seconds) taken for the server to process the
request and respond to the client.
4 Total latency; amount of time (in seconds) taken for the server to
process the request combined with the amount of time taken for
Desktop Client to process the response.
A
active scope
A configuration in which you may view, create, modify, and delete information in the SmartPlant
Foundation client.
adapter
Authoring tool software that facilitates the sharing of data between the authoring tool and other
integrated tools. Tool adapters generate XML files for publish operations and consume XML
when tools retrieve documents. Adapters are also called SmartPlant adapters.
API
1) Application Programming Interface. 2) American Petroleum Institute.
as-built
The set of data that describes the existing conditions of a plant or site; the completed and
approved state of a project.
attribute
An object characteristic.
authoring tools
Applications where documents are created and then shared through integration. Integrated
authoring tools include Aspen Basic Engineering, SmartPlant P&ID, SmartPlant Electrical,
SmartPlant Instrumentation, SmartPlant 3D, SmartPlant Materials, and SmartPlant Foundation.
B
batch printing
Printing files at a specified date and time from the SmartPlant Foundation client.
brownfield
An existing plant or site that is modified by one or more projects.
C
cache
Memory that stores recently-accessed data so that subsequent requests to access the same
data can be processed quickly.
cases
Configurations for instruments that may include specific parameters, settings, or even
components for use in a specific situation.
change notification
An e-mail message sent to a user when an action is performed on an object in SmartPlant
Foundation.
check out
Allows you to make changes to an existing document in SmartPlant Foundation. Only the user
who has checked out a document can save changes to it.
checklist
A series of items, tasks, or questions that the user finishes before a completing a step in a
workflow. Checklists can be optional or required.
claim
To take responsibility for a step in a SmartPlant Foundation workflow.
To identify the scope of a project by adding items to the project from a drawing or a 3-D
model. When authoring tools are integrated, SmartPlant P&ID claims items that are shared
among tools. Other authoring tools, such as SmartPlant Instrumentation and SmartPlant 3D,
claim items that they create and modify that are not shared.
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.
compare
To view the differences between two revisions of the same document in SmartPlant Foundation.
component
A .dll (dynamic link library) that handles requests on the SmartPlant Foundation server.
Components are also called business service layers (BSLs).
component schema
A subdivision of the complete SmartPlant schema that contains the set of class definitions that
are used within a specific domain or application area.
condition
An object that can restrict access to a method, workflow, or relationship based on specified
criteria.
configuration tree
A representation in a tree list, which may include plant, areas, units, and projects that indicates
the structure in which the data is stored in SmartPlant Foundation.
container
An object used by the tool adapters and the SmartPlant software components to pass data back
and forth between a tool and SmartPlant Foundation. A container may hold data or metadata
related to the data model or actual instance data.
contract
A group of documents that are collected and issued for bid, construction, review, and so on.
correlation
The relationship between items that represent the same object in multiple authoring tools.
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.
cut-off date
Any date on which progress information is calculated. Official cut-off dates are scheduled in
advance and are typically part of a reporting schedule. Unofficial cut-off dates are random dates
when rollups are not scheduled but progress is calculated anyway.
D
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.
design basis
An item in an authoring tool that represents an item from an upstream application (an application
used earlier in the lifecycle of the plant). Plant items placed with the authoring tool correspond to
a particular design basis item.
Design basis items provide a means of determining if the plant items within the authoring tool
are consistent with the items from the upstream application and help users maintain consistency
as changes are made in all authoring tools.
design file
A file generated by a design tool, such as SmartPlant P&ID or Aspen Basic Engineering.
digest
See e-mail digest.
display item
Object used to present data or relationships on a form in SmartPlant Foundation.
distribution matrix
A list of people who will receive a transmittal created in SmartPlant Foundation and an indication
of what is expected from each recipient. Workflows can also be configured to use a distribution
matrix for sending To Do List or e-mail notifications to workflow step recipients.
document
An object used to track revisions to a design file in SmartPlant Foundation.
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.
downstream forecasting
A feature that uses timestring information and actual dates when steps were completed to
provide an estimated completion date for subsequent steps.
dump file
A file that contains data exported from the SmartPlant Foundation data or system administration
database. You can import database dump files using SmartPlant Foundation Server Manager.
E
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.
effectivity date
The period of time for which historical data is displayed in SmartPlant Foundation.
e-mail digest
A collection of notification messages from SmartPlant Foundation that are sent together instead
of separately. You can set a user preference in the Desktop Client to receive digests instead of
individual e-mail messages.
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.
enumerated list
A list of possible string property values defined for a property definition in the SmartPlant
schema. Enumerated sets are sometimes called enumerated lists, picklists, codelists, and
lookups.
exposes
The relationship between interface definitions and property definitions in the SmartPlant
schema. Interface definitions expose the property definitions for class definitions.
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.
FTR
Full-Text Retrieval; a separate module of SmartPlant Foundation that allows you to store, index,
and search for text contained in or associated with objects managed by SmartPlant Foundation.
Full-text retrieval creates an inverted index (a list of the individual words with locations in the
files) and uses this index at search time.
G
governing case
The specific case used for an instrument.
graph definition
A connected network of edge definitions with structure. Each graph definition in the SmartPlant
schema starts at an interface definition and traverses through one or more relationship
definitions to another interface definition at the other end. Graph definitions are sometimes
referred to as directed graph definitions.
graphic report
A filtered view of a drawing or model, displayed graphically in SmartPlant Foundation.
greenfield
A new plant on a site with no existing infrastructure.
H
hierarchy
A classified structure with superiors, or roots, and subordinates, or dependents, used for
grouping data.
host
A computer that stores files.
hotspot
Graphical notification that a user can click a drawing item in a drawing or viewable file to display
the properties for the item in SmartPlant Foundation.
I
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.
integration
Technology that standardizes and improves the communication among the various SmartPlant
Enterprise authoring tools used in the course of designing, constructing, and operating 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.
issue
To release a document as part of a transmittal. The document is not considered issued until the
status of the transmittal has been changed to issued.
issue request
A staging of documents and drawings to be issued with a transmittal. An issue request means
that the documents or drawings are ready to be issued with a transmittal, but does not actually
cause the transmittal to be issued.
M
master file
A document file that references other files.
meta schema
A set of schema objects that describe the objects in the SmartPlant schema. The meta schema
provides the building blocks upon which the SmartPlant schema is built.
method
A call to an API that allows users to perform actions on objects or interfaces in SmartPlant
Foundation.
O
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.
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.
print server
A computer that processes print requests for a defined list of printers in SmartPlant Foundation.
process cases
Configurations for instruments that may include specific parameters, settings, or even
components for use in a specific situation.
profile
See user profile.
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 a 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.
punchlist
Provides a running to do list of outstanding scope for completions.
Q
query
A detailed search based on object properties.
query scope
A configuration for data queries and relationship expansions in SmartPlant Foundation.
R
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.
reference file
Files associated with a master file in SmartPlant Foundation.
register
To map an authoring tool and all its projects to a SmartPlant Foundation URL, which points to
one SmartPlant Foundation database. You must register your authoring tool plant before you
can publish and retrieve in an integrated environment.
relationship
An association between two objects.
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.
resurrected object
A deleted authoring tool object that is reintroduced to the SmartPlant Foundation database when
recovered tool data is republished. For example, a tool initially publishes a document containing
an object, but later deletes the object and republishes. SmartPlant Foundation then detects that
the object is deleted. However, if the tool restores data that was backed up before the object
was deleted, through a data restoration or other tool-specific mechanism, and republishes, then
SmartPlant Foundation recognizes that the object was previously deleted but has been
reintroduced (resurrected).
retrieve
To import document data from an .XML file that was published by another authoring tool for the
purpose of maintaining consistency of data across tools. When you retrieve a document, most
authoring tools analyze the impact of the newly retrieved data on the existing database and then
place tasks on the authoring tool'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 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
A 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.
rollup
The process of calculating progress data. Progress is calculated for every deliverable at every
level of the hierarchy, and all of that information is available for viewing or reporting when you
run a rollup. Rollups can be scheduled with official cut-off dates or can be run manually at any
time.
S
schema
A model used to describe and validate the structure of XML files.
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.
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.
server
A computer that stores or processes files.
sharing
The relationship between class definitions and shared object definitions in the SmartPlant
schema. This relationship indicates that a class definition can be shared.
SI
International System of Units, sometimes referred to as the metric system. When values for
units of measure are published, they are converted to SI units and stored, regardless of the units
of measure selected when the user defined the value in the authoring tool.
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
Refers to 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.
SmartPlant Enterprise
A suite of Intergraph engineering applications that are delivered together.
SmartPlant schema
An XML file that describes the structure of the XML files generated by integrated authoring tools
in much the same way as a data dictionary describes the structure of a database. As tools
publish documents in XML format, those documents must adhere to the format defined by the
schema to ensure that the XML data can be loaded into SmartPlant Foundation and retrieved
into the other authoring tools.
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.
symbology
Settings that determine how a drawing or model will appear when displayed as a graphical
report in SmartPlant Foundation.
T
TEF
The Engineering Framework; technology behind the integration of SmartPlant Enterprise
products.
terminate
To change the status of a SmartPlant Foundation object to terminated without removing it from
the SmartPlant Foundation database. Terminating objects, instead of deleting them, allows you
to continue to see the history of the object after termination.
timestring
A schedule that assigns a certain number of days for the completion for each step in the
lifecycle of a deliverable.
title block
The portion of a drawing that contains information about the drawing, such as who created the
drawing, when it was created, who approved it, and so on. The type of information included in
the title block varies by drawing type, industry, and organization.
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.
token
A license that provides timed access to users of SmartPlant Foundation. When a user opens the
software, a token is activated.
There are two types of tokens: daily and perpetual. Daily tokens are available to all users and
are valid for 12 consecutive hours after the user logs on to SmartPlant Foundation. When a daily
license token is checked out, a token is depleted from the daily token file. If there are no tokens
left in the daily token file, then other users cannot access the software. Perpetual tokens are
only available to a select group of system users and provide unlimited access to the software.
tombstone
Delete instructions for an object that has been removed in one of the authoring tools. Upon
retrieval of a tombstone, delete tasks are created in the authoring tool's To Do List to allow the
tool to delete the object from its database.
tool
See authoring tool.
tool adapter
See adapter.
tool schema
A set of schema objects that describe the data in the authoring tool databases before it is
transformed into the format prescribed by the SmartPlant schema. The tool schema also
specifies the mapping between objects in the tool database and the SmartPlant schema.
tool signature
A unique identifier for the relationship between a plant in SmartPlant Foundation and a specific
plant in an authoring tool database. The relationship is created when an authoring tool registers
with SmartPlant Foundation.
transmittal
A controlled package of documents used to perform, track, and record the distribution of project
documentation among different design teams.
U
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.
V
vault
A folder where files are stored on a host computer.
version
An intermediate update to an existing document that is tracked by the SmartPlant Foundation
software.
view definition
A named group of properties extracted from the possible properties that a graph definition
exposes. View definitions are used in an integrated environment to provide a different view of
data from that provided by the underlying schema.
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.
W
Web Portal
Provides the functionality of the SmartPlant Foundation client system through an easy-to-deploy
Internet Explorer web browser. Based on the software configuration and authorization of the
System Administrator, you can perform the following functions:
View information from the database about a specific object
Search for objects in the database
View drawings and 3D models
View a history for a particular object
View relationships between objects
weighting
The percentage of a project that is made up by a step, sub- step, or deliverable. When you
create a step or sub-step for a deliverable or assign a deliverable to workpack, you must
indicate what percentage of the work that item represents. For example, if a deliverable is 30
percent complete when a particular step is finished, the weighting for that step is 30.
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.
X
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.
V
vault • 117
version • 118
view definition • 118
View Native Command Opens New Window
• 57
virtual directory • 118
W
Web Portal • 118