Smartplant Interop Publisher: Installation and Setup Guide
Smartplant Interop Publisher: Installation and Setup Guide
Version 2015 R1
June 2015
DSP3D-PE-200127D
Copyright
Copyright © 2015 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
305 Intergraph Way
Madison, AL 35758
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.
Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, CADWorx, CAESAR II, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip,
INtools, ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, SupportModeler, Freeview, and Sapphire are trademarks
or registered trademarks of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and
Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other
brands and product names are trademarks of their respective owners.
SmartPlant® Interop Publisher incorporates portions of: (1) ST-Developer software licensed by STEP Tools, Inc.; (2) ACIS
and Interop components owned by Spatial Corp. © 1986-2015; (3) Portions of the user interface copyright 2012-2015 Telerik AD; All
Rights Reserved.
Troubleshooting ........................................................................................................................................ 43
Index ........................................................................................................................................................... 52
Documentation Comments
For the latest support information for this product, comments or suggestions about this
documentation, and documentation updates for supported software versions, please visit
Intergraph Smart Support (https://smartsupport.intergraph.com).
Version 2015 R1
After installation, upgrade your site database and projects to the current version. For more
information, see Upgrade Site Databases and Projects (on page 20) and Upgrade a project.
You can schedule translation, publish, and Smart Model update operations once or on a
recurring basis. For more information, see Schedule Jobs.
SmartPlant Interop Publisher performs scheduled translation and Smart Model update
operations only if the associated source files have been changed. This allows you the
flexibility to schedule recurring jobs with SmartPlant Interop Publisher making efficient use of
system resources. For more information, see Schedule a translation job and Schedule a
Smart Model update job.
SmartPlant Interop Publisher supports the following SQL Server operations:
Remote SQL server access is provided for a multi-user environment.
All databases are created with SQL server data and log path settings by default.
However, you can specify an alternate location for each data and log file. These
locations and the database name are listed in the Projects grid.
The following options have been added to the Translation Settings dialog box:
MicroStation: The Keep construction text option has been modified to Keep
construction elements. This option allows you to turn on and off the translation of
construction geometry.
PDMS: The Conduit Specs option allows you to filter conduit specifications.
For more information, see MicroStation options and PDMS options.
Civil objects such as trench runs, trench features, and trench parts in models are now
supported. The required class, interface, and property information for civil objects has been
added to the SmartPlant Interop Publisher (SPIOP) schema, and the Smart 3D default
mapping files provided with SmartPlant Interop Publisher have been updated.
SmartPlant Interop Publisher supports the creation of Smart Drawings. A Smart Drawing
contains data and 2D graphics that are translated from Smart 3D-generated orthographic
and isometric drawings. When you create a Smart Drawing in SmartPlant Interop Publisher,
the graphics and data are extended so that they can be published to SmartPlant
Foundation. You can publish Smart Drawings without revising them. For more information,
see Drawings View and Use Drawing Source Files.
You can show or hide columns in the Source Files and Smart Models grids in the Models
view. For more information, see Customize the Views.
The IOP Home button has changed and you can now click on the button to access the
Home menu. For more information, see IOP Home menu.
The Open File Location command has been added to the shortcut menus in the Source
Files and Smart Models grids so that you can immediately go to the location of a selected
file. For more information, see Open file locations.
The CADWorx 2014 Plant Object Enabler utility is included in the SmartPlant Interop
Publisher DVD. This utility allows you to view CADWorx Plant 2014 components stored in
an AutoCAD drawing (.dwg) file. For more information, see the Requirements section in the
SmartPlant Interop Publisher Installation and Setup Guide and also Supported 3D Model
Formats: What source files can I use?.
SmartPlant Interop Publisher can translate the PDMS DATAL format for the Intergraph
target applications. For more information, see Define Translation Settings and Translate
PDMS source files.
For .rvm files created from PDMS 12.0 SP5 or later, obstruction objects are translated as
transparent if they are exported with Representation enabled. For more information, see
PDMS options.
In the error message display, click on blue Information icon to see additional information
about the error and possible ways to resolve it. For more information, see Status and Error
Messaging.
For generic mapping, if you have used the GenerateMapping tool to generate a
GenericToR3DMapping.xls file, SmartPlant Interop Publisher recognizes the existing
mapping file and appends any new classes and properties from the input .drv files to this
mapping file. The existing GenericToR3DMapping.xls file must be in the output folder you
designate when using the GenerateMapping tool. For more information, see Use the
GenerateMapping tool.
SmartPlant Interop Publisher includes a PDS 3D setting for configuring the translation of
PDS-published and PDS legacy source files to Smart Models. The PDS-published source
files are .zvf, .xml, and .xrg files. The PDS legacy files are .dgn and .drv files in which you
can define nozzle-to-equipment, and pipe parts-to-pipeline relationships. For more
information, see PDS 3D options.
SmartPlant Interop Publisher has been integrated with the Intergraph SmartPlant Fusion
product so that you can translate source files and then use SmartPlant Fusion to publish
them. For more information, see Supported 3D Model Formats: What source files can I use?
and Use 3D Model Source Files.
A .vue source file with a supporting property data .mdb2 file is identified in the Source Files
grid with the Source File Type specified as Intergraph Visualization File. Previously, the
source file type was listed as SPRDirect for .vue source files. For more information, see
Source Files Grid (Models View) and Supported 3D Model Formats: What source files can I
use?.
A new worksheet has been added to the PDMSToR3DMapping default and custom mapping
files to provide equipment nozzle properties. This new worksheet allows you to get
additional nozzle properties from your PDMS catalog so that they are available in the
translated Smart Model. For more information, see Create a custom mapping of PDMS
equipment nozzles.
For the SmartPlant Review target application, the Keep Project Database option allows you
to update Smart Model object data without overwriting the project database (.mdb) file that is
generated by the initial translation. SmartPlant Review uses this project .mdb file to store
features and settings such as display set definitions, measurements, animations, and so
forth. If this option is not checked, the project database file gets overwritten. For more
information, see Update Smart Models.
Mechanical Computer-aided Design (MCAD) support:
Install the Mechanical Computer-aided Design (MCAD) module to translate source files
from third party MCAD applications. The MCAD module provides defeaturing translation
settings that allow you to simplify your model for loading and reviewing in the Intergraph
target applications. For more information, see Translate MCAD files with defeaturing
options and Mechanical CAD (MCAD) defeaturing options.
SmartPlant Interop Publisher supports MCAD assemblies. You can select only the
required assembly files for translation. For more information, see Define Translation
Settings and Translate MCAD assembly files.
SmartPlant Interop Publisher supports translation of property data from MCAD CATIA
and NX formats. Document level (part and assembly) and Instance level user-defined
properties are supported. Feature or body level user-defined properties are not
supported. Default and custom mapping spreadsheet files have been added to support
CATIA and NX MCAD data translation.
SmartPlant Interop Publisher supports the graphic translation for Parasolid files
(.x_t,.x_b,.xmt_txt,and .xmt_bin). For more information, see Supported 3D Model Formats:
What source files can I use?.
A command line argument text box has been added to the MicroStation translation settings.
This allows you to enter MicroStation-specific arguments to further refine the translation of
.dgn source files.For more information, see MicroStation options.
SmartPlant Interop Publisher no longer requires multiple licenses to translate a .dri file
containing .dgn or .rvm files. You can have a single license for .dri file translation. For more
information on translating, see Translate to Smart Models.
SmartPlant Interop Publisher can translate source files that are in read-only folders.
Generated .drv files are now placed in the [Smart Model Location]\Supporting Files folder.
For more information on translating, see Translate to Smart Models.
You can create a Smart Model for one or all design models in a MicroStation V8 .dgn file.
SmartPlant Interop Publisher provides options in the MicroStation translation settings that
allow you to:
Translate the active design model in a V8 .dgn file,
Translate the individual design models in the V8 .dgn file to create separate Smart
Models.
Translate all design models in the V8 .dgn file into one Smart Model.
For more information, see MicroStation options.
You can select and edit just one project at a time in the Projects view. Also, the toolbar and
shortcut menu commands in the Projects view are available or enabled when specific
conditions are met. For example, if you select a 2014 or 2014R1 project in the grid, the
Upgrade command is enabled and the Register, Project Settings, and Translation
Settings commands are not available. For more information on projects, see Organize Your
Work with Projects and Projects View.
An Occlusion translation setting reduces the translated model size by removing internal
objects, or any blocked objects that are not visible from the outside. You can use hardware
acceleration to perform occlusion during model translation. For more information, see Define
Translation Settings.
The Occlusion translation setting, along with general graphic options, have been grouped
together in a Common translation section. Common translation options can be applied to all
file formats you are using. The following options have been moved from Project Settings to
the Common page in the Translation Settings dialog box:
Keep lines and line strings
Turn on validation
For more information, see Define Translation Settings.
The Translate view has been renamed to the Models view. For more information about this
view, see Models View.
Supported Formats
The following tables list the source files of Intergraph and the main third-party authoring tools
supported by SmartPlant Interop Publisher. The Source Files column in each table lists the
graphics or data and graphics file combinations used for translation. The Notes/Requirements
column lists any information or requirements specific to a format type.
Intergraph
Products Version Source Extension Notes/Requirements
CADWorx Plant 2015 .dwg For .dwg files containing proxy objects, the following software is
Professional, required:
CADWorx
Equipment MicroStation V8i and RealDWG 2013 SP1
Install and activate MicroStation V8i SS3, and then
install RealDWG 2013 SP1 to translate any proxy
objects inside these files. For normal AutoCAD
entities, the presence of MicroStation is ignored.
However, if the file contains at least one proxy object
and MicroStation V8i is installed, translation is done
using MicroStation.
CADWorx Plant 2014 Object Enabler:
For CADWorx data, you must install the CADWorx
Plant 2014 Object Enabler to view CADWorx Plant
2014 components stored in an AutoCAD drawing
(.dwg) file. You can install the utility from the
SmartPlant Interop Publisher DVD (Prerequisite
Software), or go to the Intergraph Smart Support
website and download this executable from
CADWorx Freeware Tools and Utilities.
SmartPlant Interop Publisher supports AutoCAD 2014 or earlier
.dwg files.
You can use CADWorx 2015 SP1 to export .vue and .mdb2
files that can be opened in SmartPlant Review.
Intergraph
Products Version Source Extension Notes/Requirements
PDS, V7 Graphics: .dri, .dgn, The .prp file can have accompanying data file types: .lin,.sld
FrameWorks® .prp and .nmg.
Plus Data: .drv, .lin,.sld
and .nmg
Smart 3D (3D 2014 Graphics: .vue Data is translated based on the P3DComponent.xml schema
Model R1 and Data: .xml file and the RelationshipMapping.txt file.
earlier
using
3D
Model
Data
Drawing
ACIS - Design ACIS R25 .sat The size of the SAT file to be translated should not
model data from and earlier exceed 2 GB.
products such as Graphics only.
AutoCAD
Inventor, Creo, JT
Open, Solid Edge,
and SolidWorks
AutoCAD 2014 and .dwg, .dxf MicroStation V8i and RealDWG 2013 SP1 are required for DWG
earlier files containing proxy objects.
Install and activate MicroStation V8i, and then install
RealDWG 2013 SP1 to translate any proxy objects
inside these files.
AutoPlant - SmartPlant Interop Publisher MicroStation V8i SS3 and RealDWG 2013 SP1 are required for
supports versions that can export .dwg, .dgn, AutoPLANT graphics files.
and i.dgn files.
Install and activate MicroStation V8i. Then download
and install install RealDWG 2013 SP1 to translate any
proxy objects inside the graphics files.
Source files must be exported from AutoPlant using
the Project Packager utility.
CATIA V5 .CATPart, For CATIA V6, you must export your database objects as CATIA
(R8–R24) .CATProduct V5 CATParts and CATProducts.
and V6
(V6 You must have an MCD license and the Intergraph MCAD
R2014x). module installed with SmartPlant Interop Publisher to translate
MCAD source files.
You can set defeaturing options to reduce model complexity. For
more information, see Define Translation Settings and
Mechanical CAD (MCAD) defeaturing options.
Graphics and data. Document level (part and assembly) and
Instance level user-defined properties are supported. Feature or
body level user-defined properties are not supported.
CIS/2 (design 203, 214 .stp, .step Where possible, we recommend using the IFC format for data
model data from exchange.
products such as
SDS/2, StruCAD, For more information on CIS/2 supported entities, see CIS/2
Tekla Structures, Entities and Cross-Section Data.
and ProSteel,
among others)
CREO Parametric 16 - Creo .prt, .prt.*, You must have an MCD license and the Intergraph MCAD
(formerly 3.0 .asm, .asm.* module installed with SmartPlant Interop Publisher to translate
Pro/Engineer), MCAD source files.
Siemens
You can set defeaturing options to reduce model complexity. For
more information, see Define Translation Settings and
Mechanical CAD (MCAD) defeaturing options.
IGES (products 5.3 and .igs, .iges The size of the file to be translated should not exceed 2 GB.
that export IGES) earlier
Graphics only.
Industry 2x3_TC1 This is the recommended data exchange format for reading
Foundation schema .ifc SDS/2, Tekla, and Revit projects. SmartPlant Interop Publisher
Classes (IFC) version only supports IFC 2x3_TC1 schema.
Inventor V11 - .ipt, .iam You must have the Intergraph MCAD module and MCD license
2015 installed with SmartPlant Interop Publisher to translate MCAD
source files.
You can set defeaturing options to reduce model complexity. For
more information, see Define Translation Settings and
Mechanical CAD (MCAD) defeaturing options.
MicroStation J V07.01.05. .dgn In the MicroStation Translation Settings, you can turn on the
03 Change SmartSolids to surfaces for V7 DGN files option.
V07.02.00.
00
(Required
for
supporting
Smart
Solids
display)
MicroStation V8i V8.11.09 .dgn, .dtm MicroStation V8i SS3 and earlier
NX NX 1 - NX .prt You must have the Intergraph MCAD module and MCD license
9 installed with SmartPlant Interop Publisher to translate MCAD
source files.
You can set defeaturing options to reduce model complexity. For
more information, see Define Translation Settings and
Mechanical CAD (MCAD) defeaturing options.
Graphics and data. Document level (part and assembly) and
Instance level user-defined properties are supported. Feature or
body level user-defined properties are not supported.
Parasolid 9.0 – 27.0 .x_t, .xmt_txt, You must have an MCD license and the Intergraph MCAD
x_b, .xmt_bin module installed with SmartPlant Interop Publisher to translate
MCAD source files.
You can set defeaturing options to reduce model complexity. For
more information, see Define Translation Settings and
Mechanical CAD (MCAD) defeaturing options.
PDMS V12.1 and Graphics: .rvm When there is an .att and .datal file, SmartPlant Interop Publisher
earlier (Binary only) uses only the .att file. If the .rvm and .datal are used, not all
objects can have properties. You might have to go back to your
Data: .att/.datal PDMS application and ensure that tags are written for all objects
in the .datal file.
ProStructures v8i .dwg, .dgn, .dxf MicroStation V8i SS3 and the ProStructures v8i SELECTseries 6
SELECTs plugin are required for ProStructures graphics files.
eries 6
Install and activate MicroStation V8i. Then download
and install ProStructures v8i SELECTseries 6 plugin to
translate any ProStructures proxy objects inside the
graphics files.
Solid Edge V18 - ST7 .par, .asm, You must have an MCD license and the Intergraph MCAD
.psm module installed with SmartPlant Interop Publisher to translate
MCAD source files.
You can set defeaturing options to reduce model complexity. For
more information, see Define Translation Settings and
Mechanical CAD (MCAD) defeaturing options.
SolidWorks 2003 - .sldprt, .sldasm You must have an MCD license and the Intergraph MCAD
2014 module installed with SmartPlant Interop Publisher to translate
MCAD source files.
You can set defeaturing options to reduce model complexity. For
more information, see Define Translation Settings and
Mechanical CAD (MCAD) defeaturing options.
Speedikon, Tribon M2 / M3 - SmartPlant Interop MicroStation V8i SS3 and RealDWG 2013 SP1 are required.
Publisher supports versions that can export MicroStation v8i SS3 must be installed and activated.
MicroStation .dgn files.
Tekla , StruCAD, IFC: .stp, .step, .ifc For more information on CIS/2 supported entities, see CIS/2
Xsteel, SDS/2, 2x3_TC1 Entities and Cross-Section Data.
Autodesk Revit, schema
ProSteel version We recommend using the IFC format for data exchange.
To find the schema version of an .ifc file, open the file in any text
editor such as Windows Notepad, and check the FILE_SCHEMA
version listed in the File Header section. For IFC files that are
supported by SmartPlant Interop Publisher, the File Header has
the FILE_SCHEMA(('IFC2X3')); entry. For more information, see
Translate IFC source files.
XMpLant - SmartPlant Interop Publisher Supports xml files that have the root node as "PlantModel".
supports versions that can export .xml files.
See Also
SmartPlant Interop Publisher Requirements (on page 17)
General Requirements
SmartPlant Interop Publisher and drawing source file translation require:
SmartPlant License Manager (SPLM) Client 2010 and 2012; Server 2012 (depending on the
SmartPlant Foundation setup)
SmartPlant Interop Publisher translation license (SRP)
Source
Products Version Extension Notes
Smart 3D 2011 .sha, .xml Orthographic and isometric drawings files generated from the
R1 - Smart 3D Drawings and Reports task.
2014
R1
For Isometric Drawings, Composed Drawings, or Volume Drawings in Smart 3D, use the
SmartPlant Foundation (*.xml) target file type to generate an .sha file and two XML files; an
.xml data file and an .xml metadata file. The data .xml file is named ToolData_<Drawing Name>.
The metadata file is named MetaData_<Drawing Name>. You can then add the .sha file in
SmartPlant Interop Publisher for translation and publish to SmartPlant Foundation. For more
information on generating the .sha and .xml files in Smart 3D, refer to the Save as SmartPlant
Foundation (*.xml) topic in the Smart 3D Reports User's Guide and Online Help.
Licensing
SRP - SmartPlant Interop Publisher translation license. You can purchase a single
translation license, which enables the sequential translation of source files, or you can
purchase multiple licenses to support concurrent translations. Contact your Intergraph
Consultant for more information.
SIP - SmartPlant Interop Publisher Adaptor-to-SmartPlant Foundation. In addition to
translation, this license provides functionality to register, revise, and publish to a SmartPlant
Foundation site.
If you purchase a SIP license, SmartPlant Foundation, SmartPlant Client, and the
SmartPlant Client Schema Component are supported.
MCD - Mechanical Computer-Aided Design (MCAD) module license. This license is required
if you purchase the MCAD module for SmartPlant Interop Publisher.
SmartPlant License Manager:
Client 2010 and 2012
Server 2012 (depending on your SmartPlant Foundation setup)
Scheduling
Intergraph Batch Services 2010 SP1 HF 06.01.09.00.
Software Compatibility
For the most current information on SmartPlant Interop Publisher and supported products, see
the PPM Compatibility Matrix - Product Report on Intergraph Smart Support:
https://smartsupport.intergraph.com. Go to the website and type your Smart Support user name
and password. From the View Downloads page, click the Product Compatibility link. Select
SmartPlant Interop Publisher, and then the version number.
Intergraph target applications:
Smart 3D 2011 R1 (HF 43), 2014 (HF 23), and 2014 R1
SmartPlant Review 2014 R1 and 2015 R1
SmartPlant Foundation/SmartPlant Client/SmartPlant Client Schema Component: 2014
R1(5.1) and 2014 R2 (5.2)
Alias ISOPAC 2.x (included with SmartPlant Interop Publisher)
Citrix XenApp 7.6 and XenServer 6.5
Microsoft Office 2010 SP1 or later (32- and 64-bit)
Microsoft SQL Server 2008 SP3 Express Edition (64-bit)
Microsoft SQL Server 2008 SP3 Standard Edition (64-bit)
Microsoft SQL Server 2008 SP3 Enterprise Edition (64-bit)
Microsoft SQL Server 2012 SP2 Express Edition (64-bit)
Microsoft SQL Server 2012 SP2 Standard Edition (64-bit)
Microsoft SQL Server 2012 SP2 Enterprise Edition (64-bit)
Microsoft SQL Server 2014 SP2 Express Edition (64-bit)
Microsoft SQL Server 2014 SP2 Standard Edition (64-bit)
Microsoft SQL Server 2014 SP2 Enterprise Edition (64-bit)
Microsoft Visual C++ Redistributable Packages:
Microsoft Visual C++ 2008 SP1 (32-bit)
Microsoft Visual C++ 2010 SP1 (32-bit)
Microsoft Visual C++ 2013 with Update 2 (32-bit)
Microsoft Data Access Components (MDAC) 2.8.1 (Available on the product CD.)
If you are running SmartPlant Interop Publisher on a non-English operating
system and locale, you must download the appropriate locale-specific version of the
Microsoft Data Access Components (MDAC) from Microsoft. SmartPlant Interop Publisher
might not work correctly with multi-byte characters when using the English version of MDAC.
Microsoft .NET Framework 4.5.1 (Installed during SmartPlant Interop Publisher installation)
Microsoft Internet Explorer 7.0 or later (Required for viewing the online documentation
delivered with the software.)
A PDF reader (Required to view the License Agreement and printable guides.)
System Permissions
You must have administrator privileges to install SmartPlant Interop Publisher. Administrator
privileges are not required to translate files.
1. (Optional) If you require scheduling, install Intergraph Batch Services. After installation, you
must set up batch services to work with SmartPlant Interop Publisher. For more information,
see Configuring Batch Services (on page 41).
2. Install Your New SmartPlant Interop Publisher (on page 19). Run the SmartPlant Interop
Publisher installation program from the delivered media.
3. Upgrade Site and Project Databases. Upgrade the SmartPlant Interop Publisher site
databases and projects.
4. Migrate a Database Server (Local to Remote) (on page 24). This step is optional to migrate
your local server to a remote, multi-user server.
If you are a first-time user, follow the instructions in the next section How Do I Install for the First
Time? (on page 26).
See Also
SmartPlant Interop Publisher Requirements (on page 17)
In This Section
Install Your New SmartPlant Interop Publisher ............................. 19
Upgrade Site Databases and Projects .......................................... 20
Migrate a Database Server (Local to Remote) .............................. 24
MS VC++ 2010 SP1 Redistributable Package with MFC Security Update. This package
is required for the installation process to continue.
4. Click Installation for SmartPlant Interop Publisher.
If the MS VC++ 2010 SP1 Redistributable Package with MFC Security Update is not
found on your system, you are prompted about the requirement. Click Yes to install this MS
package and continue, or click No to return to the start page.
5. Click Next.
6. Type your name, company name, and the SmartPlant Interop Publisher serial number you
received with your purchase.
7. Verify your information, and then click Next.
8. Click Display to read and accept the license agreement, and then click Yes.
You must have a PDF reader to view the license agreement.
9. Specify the destination folder, and then click Next.
10. Click Install.
SmartPlant Interop Publisher displays the Completed the Intergraph SmartPlant Interop
Publisher Setup Wizard page upon successful installation.
11. Click Finish.
12. Close the SmartPlant Interop Publisher page.
See Also
How Do I Install SmartPlant Interop Publisher in Silent Mode? (on page 38)
Option A: Upgrade
1. Click the SmartPlant Interop Publisher icon on your desktop .
OR
From the Start menu, click All Programs > Intergraph SmartPlant Interop Publisher.
3. In the SQL Server Name box, select the SQL Server instance name you created for
SmartPlant Interop Publisher.
4. Type a name for your site database Name.
Minus (-)
Period (.)
Comma (,)
Question mark (?)
Quotation mark (")
Greater than (>)
Less than (<)
Pipe or bar (|)
Forward slash (/)
Back slash (\)
Asterisk (*)
Colon (:)
Semicolon (;)
Site names cannot start with a number.
Do not insert spaces in the site name.
Site names cannot be longer than 16 characters.
5. When you create a new SmartPlant Interop Publisher site or project database, you can use
either the default SQL Server location or specify your own location. Clear Default Path to
select different locations for SQL Server Data Path and SQL Server Log File Path.
OR
Keep the Default Path option selected to use the default location. Default SQL Path
displays and the software uses the locations defined for these in SQL Server. SQL Server
Data Pathname and SQL Server Log File Pathname become read-only and are not active.
After you create a database, you cannot change the SQL Server Data and SQL Log
File locations.
6. To check the paths, open the SQL Server Configuration Manager and look at the site
Properties.
7. In the SQL Server Data Path Name box, browse to the folder for the site database file.
8. In the SQL Server Log File Path Name box, browse to the full path of the SQL
Server-generated log file.
9. Keep the Create default project (new site only) option checked for SmartPlant Interop
Publisher to automatically create a project called [site database name]_General. Otherwise,
you must create a project before you can add source files.
10. Click Configure.
When the process finishes, SmartPlant Interop Publisher displays the Projects view.
11. Use the default project.
OR
Create new projects.
For more information, see Create a project in the SmartPlant Interop Publisher User's
Guide.
For creation, the permissions must be set to the DBCreator role on the SQL Server instance
level.
To allow reading data only, use the db_datareader server role.
To allow read and write, use the db_datawriter server role.
1. Designate a shared folder to contain Smart Model files and source files.
2. Use SQL Management Studio to back up your SmartPlant Interop Publisher project (.mdf)
files.
3. Back up and then move your Smart Models and source files to that shared location.
4. Use SQL Management Studio to back up your site database files.
5. Make a list of your site database files and corresponding projects.
6. Create target folders on the remote server to contain the database files and project files.
7. If you have several files, make a list of your source files and Smart Models to include their
name, old path, and then the new path of the folders you just created on the remote server:
Name Old Path New Path
8. Connect to your remote serve and go to the new target folders.
9. Create new, empty site database files using the naming convention [site file
name]_SSDB.mdf to replace each local site database file you have.
10. Create new, empty project files using the naming convention [project name] _SPDB to
replace each project file.
You must use the "_SSDB" and "_SPDB" designation in the name. Otherwise,
SmartPlant Interop Publisher cannot open these files.
11. Use the SQL Management Studio Restore command to restore the site database file first
and then each project file contained in that site database. Repeat this step for each site
database and project file to move.
12. Use the SQL Management Studio New Query to run the following queries to change the
path of each source file and Smart Model in your list to the new shared location:
Source Files
use <DatabaseName>;
update SourceFiles
Installation
1. Set up your environment. Some of the settings you define in the SQL Server are based on
your environment setup.
2. (Optional) Install Microsoft Office if you are working with mapping files or CIS/2 files.
3. Install SmartPlant License Manager (SPLM). SmartPlant Interop Publisher supports SPLM
Client 2010 and SPLM Server 2010 or 2012. If you are publishing to SmartPlant Foundation,
you need an SPLM 2012 Server. Refer to the SmartPlant License Manager User's Guide
and the SmartPlant Foundation Desktop Client User's Guide for install and setup
information.
4. (Optional) To use scheduling, install and configure Intergraph Batch Services. After
installation, you must set up batch services to work with SmartPlant Interop Publisher. For
more information, see Configuring Batch Services (on page 41).
5. Install the SmartPlant Interop Publisher-supported Microsoft SQL Server version, and then
create an instance.
See Install and Configure (New SQL Server Setup) (on page 27).
OR
If you have SQL Server installed, create an instance for SmartPlant Interop Publisher.
See Create an Instance and Configure (Existing SQL Server Setup) (on page 32).
6. Perform any required network configuration.
In This Section
Work with SQL Server .................................................................... 27
Install SmartPlant Interop Publisher ............................................... 37
If you have a supported SQL Server Express edition installed, skip to the section Create an
Instance and Configure (Existing SQL Server Setup) (on page 32).
The current installation of SmartPlant Interop Publisher is only available for the local
computer.
For other users or groups to access this database, click Add and then enter their names
or group names.
20. From the Installation Progress page, wait as the install process finishes.
Verify that you have access to your original installation media. Otherwise, you cannot
continue the configuration steps below.
Verify that you have Administrator privileges on the computer.
1. Click Start > All Programs > Microsoft SQL Server [Version Number] > Configuration
Tools > SQL Server Installation Center (64-bit).
2. Click Installation > New SQL Server stand-alone installation or add features to an
existing installation.
6. Click Next.
7. From the Feature Selection page, select the Database Engine Services.
8. For Shared feature directory and Shared feature directory (x86), use the default paths,
or choose a custom location.
9. Click Next.
10. From the Instance Configuration page, we suggest the following names. You can use
whatever name and ID is required for your system setup.
Named instance: SPIOPSQLExpress
Instance ID: SPIOPSQLExpress
For other users or groups to access this database, click Add and then enter their names
or group names.
16. From the Installation Progress page, wait as the install process finishes.
Required Arguments:
Optional Arguments:
4. Type * for the Map From Account Domain/Host and the User.
5. In the Map To Account Domain/Host box, select the domain of the Windows user account
you want to run jobs as.
6. In the Map To Account User box, type the user name to use.
7. Click Add.
8. Type and confirm the password for the "to account" user name.
9. Click OK.
Troubleshooting
This section contains general troubleshooting information for SmartPlant Interop Publisher.
SmartPlant Client
SmartPlant Schema Component
Schedule Button
SmartPlant Interop Publisher requires version 2010 SP1 HF 06.01.09.000 of Intergraph
Batch Services. If you do not have this version, contact your Intergraph support
representative for upgrade information.
Translate Command
Make sure you have the SmartPlant License Manager client installed on the same computer
on which SmartPlant Interop Publisher is installed.
Upgrade Command
Indicates a project that requires upgrading. The command is not active after you have
upgraded the project.
Prerequisites
The following requirements apply to both interactive and silent installations.
SmartPlant Interop Publisher Version 2015 R1 must be installed on your computer before
you can install the MCAD module. For more information, refer to the SmartPlant Interop
Publisher Installation Guide.
The MCAD module version number and the SmartPlant Interop Publisher version must
match before the MCAD module can be installed. For example, for SmartPlant Interop
Publisher version 11.0, you can only install the MCAD module version 11.0. You can refer to
the Intergraph Smart Support website for the latest compatibility information.
For .dwg source files containing proxy objects, and V8 .dgn, and i-model i.dgn files, you
must install MicroStation V8i.
SmartPlant License Manager:
Client 2010
Server 2010 and 2012 (depending on your SmartPlant Foundation setup)
You must obtain an MCAD (MCD) module license key and serial number.
You must have a minimum of 700 MB free disk space.
Interactive Installation
1. Insert the MCAD Module DVD into your DVD drive. If the installation does not start
automatically, double-click setup.exe in the main folder.
2. From the Welcome page, click Next.
3. Type your name, company name, and the MCAD Module serial number.
The serial number is used for installation purposes only. The MCD license key is
required to run the MCAD Module with SmartPlant Interop Publisher.
4. Verify your information, and then click Next.
5. Click Display to read and accept the license agreement, and then click Yes.
You must have a PDF reader to view the license agreement.
6. Note the destination folder, and then click Next.
7. Click Install.
The MCAD Module setup displays the Completed page upon successful installation.
8. Click Finish to exit the setup.
Silent Installation
Silent mode installations can be performed using command-line arguments executed from a
command prompt, a batch file, or a third-party software deployment tool. Silent installations are
performed with no user interaction or with pre-filled values requiring minimal interaction. This
section provides the setup command and describes the available command-line arguments that
can be used to perform silent installations for the MCAD module using the provided setup
executable.
Command-line install with all arguments:
msiexec.exe /i "<path>\<msifilename>.msi" <SLAACCEPT=yes> USERNAME=<name>
COMPANYNAME=<company_name> SERIALNUMBER=<assigned_serial_number>
[/Lv*x<path_to_log_file>] /qn
If any names or paths contain one or more spaces, enclose the name in quotation marks.
For example: USERNAME= "Pat Smith".
Required Arguments:
Optional Arguments:
After MCAD module installation, you can open SmartPlant Interop Publisher to add your MCAD
source files for translation. The MCAD module also provides translation settings for defeaturing
to simplify your model during the translation. For more information on MCAD translations, refer
to the Define translation settings topic in the SmartPlant Interop Publisher User's Guide and
online Help.
Performance Issues
A Citrix Presentation Server implements a virtualization environment that uses an emulated
graphics card instead of a native hardware 3D CAD Workstation graphics card. This means that
all clients running SmartPlant Interop Publisher in Citrix will notice a severe degradation in
performance because SmartPlant Interop Publisher cannot take advantage of full hardware
acceleration on this emulated graphics card.
To install software on a Citrix server, you must log on with an account that has administrator
level access.
SmartPlant Interop Publisher requires SQL Server to be loaded on the Citrix server. Each
user must have their own unique database location also on this server.
Integration
Follow the information in the SmartPlant Enterprise Citrix Configuration Guide to install
SmartPlant Foundation on a XenApp server.
1. In the Registry, copy the data of the Path value for the application executable:
32-bit O/S: HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App
Paths\App_name.exe
64-bit O/S: HKLM\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\App
Paths\App_name.exe
I
Install and Configure (New SQL Server
Setup) • 27
Install SmartPlant Interop Publisher • 37
Install the Mechanical Computer-Aided
Design (MCAD) Module • 45
Install Your New SmartPlant Interop
Publisher • 19
M
Migrate a Database Server (Local to
Remote) • 24
P
Preface SmartPlant Interop Publisher
Installation Guide • 5
S
SmartPlant Interop Publisher and Citrix • 48