Project Management

User's Guide

Version 2016 (11.0)

November 2016
Copyright
Copyright © 1999-2016 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.
Portions of this software are owned by Spatial Corp. © 1986-2016. All Rights Reserved.
Portions of the user interface are copyright © 2012-2016 Telerik AD.

U.S. Government Restricted Rights Legend

Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the
United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
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 use. The Other Documentation
may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and
for any reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Project Management User's Guide 2

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

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

Export Controls
Intergraph Corporation’s 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, FrameWorks, I-Sketch, SmartMarine, IntelliShip, ISOGEN, SmartSketch,
SPOOLGEN, SupportManager, SupportModeler, Sapphire, and Intergraph Smart are trademarks or registered trademarks of
Intergraph Corporation or its subsidiaries in the United States and other countries. Hexagon and the Hexagon logo are registered
trademarks of Hexagon AB or its subsidiaries. Microsoft and Windows are registered trademarks of Microsoft Corporation. ACIS is a
registered trademark of SPATIAL TECHNOLOGY, INC. Infragistics, Presentation Layer Framework, ActiveTreeView Ctrl,
ProtoViewCtl, ActiveThreed Ctrl, ActiveListBar Ctrl, ActiveSplitter, ActiveToolbars Ctrl, ActiveToolbars Plus Ctrl, and ProtoView are
trademarks of Infragistics, Inc. Incorporates portions of 2D DCM, 3D DCM, and HLM by Siemens Product Lifecycle Management
Software III (GB) Ltd. All rights reserved. Gigasoft is a registered trademark, and ProEssentials a trademark of Gigasoft, Inc.
VideoSoft and VXFlexGrid are either registered trademarks or trademarks of ComponentOne LLC 1991-2013, All rights reserved.
Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle Corporation and/or its affiliates. Tribon is a
trademark of AVEVA Group plc. Alma and act/cut are trademarks of the Alma company. Other brands and product names are
trademarks of their respective owners.

Project Management User's Guide 3

Contents
Preface ........................................................................................................................................................ 12

What's New in Project Management ........................................................................................................ 12

Project Management ................................................................................................................................. 16

The Databases ...................................................................................................................................... 17
Menu Commands and Toolbar ............................................................................................................. 18
Project Management Hierarchy ............................................................................................................ 24
Moving Through the Hierarchy ....................................................................................................... 26
Managing Items in the Hierarchy .................................................................................................... 28

Create New Database Objects .................................................................................................................. 33

New Model ............................................................................................................................................ 33
Create a new model (MS SQL Server model database) ................................................................ 35
Create a new model (Oracle model database) .............................................................................. 35
New Model Dialog Box ................................................................................................................... 36
New Catalog.......................................................................................................................................... 38
Create a new catalog...................................................................................................................... 39
New Catalog Dialog Box................................................................................................................. 40
New Location ........................................................................................................................................ 42

Create Reference Models.......................................................................................................................... 43

Point Cloud Model Reference ............................................................................................................... 43
Reference a point cloud.................................................................................................................. 44
Modify reference point cloud .......................................................................................................... 45
Remove a point cloud reference .................................................................................................... 45
Point Cloud Properties Dialog Box ................................................................................................. 45
Reference 3D Model ............................................................................................................................. 47
Attach a Reference 3D model ........................................................................................................ 50
Modify a Reference 3D model ........................................................................................................ 51
Detach a Reference 3D model ....................................................................................................... 53
Update multiple Reference 3D projects.......................................................................................... 53
New Reference 3D Model Dialog Box ............................................................................................ 55
Reference 3D Model Properties Dialog Box .................................................................................. 58
Custom Schema and Mapping Files .............................................................................................. 59
Reference 3D Tools ........................................................................................................................ 63

Define Properties ....................................................................................................................................... 70

Define Model Properties ....................................................................................................................... 70
Define a custom property for a model ............................................................................................ 71
Delete a custom property from a model ......................................................................................... 71
Define Model Custom Properties Dialog Box ................................................................................. 71
Define Permission Group Properties .................................................................................................... 72

Project Management User's Guide 4

 Contents

Define a custom property for a permission group .......................................................................... 72

Copy a custom property for a permission group ............................................................................ 73
Delete a custom property from a permission group ....................................................................... 73
Define Permission Group Custom Properties Dialog Box .............................................................. 73
Define Permission Group Folder Properties ......................................................................................... 74
Define a custom property for a permission group folder ................................................................ 74
Copy a custom property for a permission group folder .................................................................. 75
Delete a custom property from a permission group folder ............................................................. 75
Define Permission Group Folder Custom Properties Dialog Box................................................... 75

Edit Properties ........................................................................................................................................... 77

Edit catalog database properties .......................................................................................................... 78
Edit model properties ............................................................................................................................ 78
Edit permission group properties .......................................................................................................... 79
Edit permission group folder properties ................................................................................................ 79
Update database locations when a server changes ............................................................................. 79
Change the location of a permission group .......................................................................................... 81
Database Properties Dialog Box ........................................................................................................... 81
Model Properties Dialog Box ................................................................................................................ 82
General Tab (Model Properties Dialog Box) .................................................................................. 82
Databases Tab (Model Properties Dialog Box) .............................................................................. 83
Permission Group Folder Properties Dialog Box .................................................................................. 83
Permission Group Properties Dialog Box ............................................................................................. 84
Interference Server Settings Dialog Box ............................................................................................... 84
Database Detect Tab (Interference Server Settings Dialog Box) .................................................. 85
Status Tab (Interference Server Settings Dialog Box) ................................................................... 86

Managing the Databases .......................................................................................................................... 88

Database Maintenance ......................................................................................................................... 88
Clean a database ........................................................................................................................... 89
Delete references to symbol flavors and deleted objects in the database ..................................... 89
Remove database errors ................................................................................................................ 90
Database Maintenance Dialog Box ................................................................................................ 90
Clean Database Dialog Box ........................................................................................................... 92
Database Integrity ................................................................................................................................. 93
Check database integrity ................................................................................................................ 94
Schedule Check Data Consistency task using Batch Services...................................................... 94
Run database administration processes ........................................................................................ 95
Check Data Consistency Dialog Box .............................................................................................. 96
Backup .................................................................................................................................................. 97
Create a backup file ........................................................................................................................ 99
Backup Dialog Box ....................................................................................................................... 100
Schedule Backup Dialog Box ....................................................................................................... 101
Restore ................................................................................................................................................ 102
Restore a model from backup ...................................................................................................... 103
Restore a backup model for selective recovery in an active model ............................................. 105
Restore a model as a copy ........................................................................................................... 106
Fully restore an existing model from backup ................................................................................ 108
Fully restore an existing catalog from backup .............................................................................. 109

Project Management User's Guide 5

 Contents

Partially restore catalog data from backup ................................................................................... 110

Schedule data restore using Batch Services................................................................................ 111
Restore Wizard ............................................................................................................................. 111
Synchronize Model with Catalog......................................................................................................... 117
Update a model globally with catalog changes ............................................................................ 118
Create optimal performance in a Global Workshare Configuration ............................................. 119
Synchronize Model with Catalog Dialog Box ............................................................................... 120
Configure Queues for Jobs ................................................................................................................. 121
Configure Optional Queues Dialog Box ....................................................................................... 122
SQL Database Maintenance ............................................................................................................... 123

Reports ..................................................................................................................................................... 124

Regenerate Reports Database ........................................................................................................... 124
Regenerate the reports database ................................................................................................. 125
Regenerate the reports database with linked SQL servers.......................................................... 125
Regenerate the reports database with linked Oracle servers ...................................................... 129
Regenerate Reports Database Dialog Box .................................................................................. 130
Run Report .......................................................................................................................................... 131
Run an existing catalog report ...................................................................................................... 132
Run an existing personal report ................................................................................................... 132
Run Report Dialog Box ................................................................................................................. 133
Report Parameters Dialog Box ..................................................................................................... 136
Filter Properties Dialog Box .......................................................................................................... 137

Permissions, Permission Groups, and Permission Group Folders ................................................... 147

Permissions......................................................................................................................................... 147
Assign access permission ............................................................................................................ 149
Change level of access permission .............................................................................................. 150
Remove user permissions ............................................................................................................ 150
Access Permissions Dialog Box ................................................................................................... 151
Add Users and Groups Dialog Box .............................................................................................. 151
New Permission Group ....................................................................................................................... 153
Create a new permission group ................................................................................................... 157
New Permission Group Dialog Box .............................................................................................. 157
New Permission Group Folder ............................................................................................................ 158
Create a new permission group folder ......................................................................................... 159
New Permission Group Folder Dialog Box ................................................................................... 159

Update Custom Symbol Configuration ................................................................................................. 160

Create or update the custom symbol configuration file ...................................................................... 160
Move custom .dlls to SharedContent folder ........................................................................................ 161
Update Custom Symbol Configuration Dialog Box ............................................................................. 163

Upgrade Version ...................................................................................................................................... 164

Upgrade versions for all databases .................................................................................................... 165
Upgrade replicated databases ............................................................................................................ 166
Upgrade Version Dialog Box............................................................................................................... 166

Project Management User's Guide 6

 Contents

Global Workshare .................................................................................................................................... 170

Global Workshare and SQL Server Databases .................................................................................. 172
Configure each server for replication ........................................................................................... 175
Configure the SQL Server Distributor agent................................................................................. 176
Set the SQL Server Distributor agent profile ................................................................................ 178
Set up Global Workshare with SQL Server .................................................................................. 178
Set up two-way replication between SQL Server models ............................................................ 179
Set Up one-way subscriptions for SQL Server ............................................................................. 180
Restore a satellite for SQL Server replication .............................................................................. 182
Regenerate the reports database ................................................................................................. 182
Install and configure the Duplication Synchronization Service (DuSS) ........................................ 183
Add an additional satellite to an existing SQL Global Workshare Configuration ......................... 184
Disable replication on a SQL Server instance .............................................................................. 185
Monitor replication in SQL Server ................................................................................................ 185
Remove SQL Server replication ................................................................................................... 185
Consolidate an existing SQL Server configuration ....................................................................... 186
SQL Database Maintenance ........................................................................................................ 187
Catalog Data Recovery for SQL Server ....................................................................................... 187
Satellite Failure and Recovery for SQL Server ............................................................................ 191
Task Limitations When Working in a Global Workshare Environment ............................................... 192
Considerations for Performing Large Transactions ............................................................................ 194
Workflow to Synchronize Catalog Changes between Host and Satellites.......................................... 194
Combining SmartPlant Foundation and Global Workshare ................................................................ 196
New Location ...................................................................................................................................... 198
Create a new location ................................................................................................................... 198
New Location Dialog Box ............................................................................................................. 199
Consolidate Model from Workshare.................................................................................................... 199
Consolidate Models from Workshare Dialog Box ......................................................................... 200
Location Properties Dialog Box........................................................................................................... 200
Duplicate Model for Workshare ........................................................................................................... 201
Duplicate the Model for Global Workshare Configuration ............................................................ 201
Duplicate Model for Workshare Dialog Box.................................................................................. 202
Back Up and Restore Global Workshare ............................................................................................ 203
Scenario 1: Restore Model as Copy............................................................................................. 204
Scenario 2: Amputate and Re-Duplicate ...................................................................................... 205
Failure and Recovery Overview .......................................................................................................... 208
Host Failure and Recovery ........................................................................................................... 208
Model Data Recovery ......................................................................................................................... 209
Overall Workflow to Configure a Global Workshare ........................................................................... 210
Global Workshare Configuration ......................................................................................................... 214
Verify Databases Have Supplemental Logging Enabled ............................................................. 214
Verify Databases are Running in ARCHIVELOG Mode ............................................................... 215
Verify Databases are enabled for GoldenGate Replication ......................................................... 216
Allocate streams pool size ............................................................................................................ 217
Edit the Undo Retention Value ..................................................................................................... 218
Install GoldenGate ........................................................................................................................ 218
Create the Oracle GoldenGate Administrator account ................................................................. 222
Create the Smart 3D GoldenGate User Alias .............................................................................. 223
Register all Oracle instances on Smart 3D administrative machine ............................................ 227
Create Locations .......................................................................................................................... 227

Project Management User's Guide 7

 Contents

Duplicate Model for Workshare .................................................................................................... 229

Copy generated scripts into GoldenGate folders ......................................................................... 232
Execute PreBackup scripts .......................................................................................................... 232
Make a Smart 3D backup ............................................................................................................. 233
Restore Duplicated Databases at Satellite Locations .................................................................. 233
Execute PostRestore scripts ........................................................................................................ 235
Regenerate the reports database ................................................................................................. 235
Install and configure the Duplication Synchronization Service (DuSS) ........................................ 236
Monitoring Replication ........................................................................................................................ 237
Firewall Exceptions for GoldenGate ................................................................................................... 239
Add a Satellite to an Existing Oracle Global Workshare .................................................................... 239
Workflow for Consolidating Oracle Databases ................................................................................... 240
Consolidate all Oracle databases ................................................................................................. 241
Remove a satellite from an existing Oracle Global Workshare .................................................... 242
Consolidate Models from Workshare Dialog Box ......................................................................... 244
Task Limitations When Working in a Global Workshare Environment ............................................... 244
Considerations for Performing Large Transactions ............................................................................ 246
Workflow to Synchronize Catalog Changes between Host and Satellites.......................................... 247
Combining SmartPlant Foundation and Global Workshare ................................................................ 249
Global Workshare Configuration across Untrusted Networks ............................................................ 250
Duplicate Model for Workshare across Untrusted Networks........................................................ 250
Consolidate Model from Workshare across Untrusted Networks................................................. 251
Failure and Recovery Overview .......................................................................................................... 252
Host Failure and Recovery ........................................................................................................... 252
Satellite Failure and Recovery (GWC) ......................................................................................... 253
Model Data Recovery ......................................................................................................................... 253
Deleting Archive Logs ......................................................................................................................... 255

Model Data Reuse (MDR) ........................................................................................................................ 256

Model Data Reuse Wizard .................................................................................................................. 262
Model Data Reuse Wizard: Welcome ................................................................................................. 263
Model Data Reuse Wizard: Begin New Operation .............................................................................. 264
Model Data Reuse Wizard: Source Model .......................................................................................... 265
Select Source Model Dialog Box .................................................................................................. 266
Select Site Dialog Box .................................................................................................................. 266
Model Data Reuse Wizard: Source Systems ...................................................................................... 267
Model Data Reuse Wizard: Source Objects by Filter ......................................................................... 267
Using Filters .................................................................................................................................. 269
Lowest Common Parent ............................................................................................................... 270
Select Filter Dialog Box ................................................................................................................ 271
Filter Properties Dialog Box .......................................................................................................... 272
Model Data Reuse Wizard: Disciplines ............................................................................................... 282
Model Data Reuse Wizard: Destination Model ................................................................................... 284
Select Destination Model Dialog Box ........................................................................................... 284
Model Data Reuse Wizard: Destination .............................................................................................. 285
Model Data Reuse Wizard: System Tab ...................................................................................... 286
Model Data Reuse Wizard: Assembly Tab................................................................................... 288
Model Data Reuse Wizard: Work Breakdown Structure Tab ....................................................... 290
Model Data Reuse Wizard: Space Tab ........................................................................................ 292
Model Data Reuse Wizard: Drawings Tab ................................................................................... 294

Project Management User's Guide 8

 Contents

Model Data Reuse Wizard: Permission Group Dialog Box .......................................................... 295
Model Data Reuse Wizard: Add the Destination System Parent ................................................. 296
Model Data Reuse Wizard: Add the Destination Assembly Parent ............................................. 297
Model Data Reuse Wizard: Add the Destination Space Parent ................................................... 297
Model Data Reuse Wizard: Add the Destination Drawing Parent ................................................ 297
Model Data Reuse Wizard: Use the Permission Group Map ....................................................... 298
Model Data Reuse Wizard: Transformations ...................................................................................... 299
Troubleshooting Results of MDR Transformation ........................................................................ 301
Model Data Reuse Wizard: Compare Catalogs .................................................................................. 302
View & Map Dialog Box ................................................................................................................ 302
Model Data Reuse Wizard: Restart Existing Operation ...................................................................... 305
Model Data Reuse Wizard: Confirmation ........................................................................................... 307
Model Data Reuse Wizard: Operation Properties Dialog Box ............................................................ 308
General Tab (Operation Properties Dialog Box) .......................................................................... 308
By Class Tab (Operation Properties Dialog Box) ......................................................................... 309
Configuration Tab (Operation Properties Dialog Box) .................................................................. 309
Review Model Data Reuse Operation Results ................................................................................... 310
View the MDR Log File ................................................................................................................. 310

Model Data Transform (MDT) ................................................................................................................. 312

Best Practices for Model Data Transform Operations ........................................................................ 313
Model Data Transform Wizard: Welcome ........................................................................................... 318
Model Data Transform Wizard: Begin New Operation........................................................................ 319
Model Data Transform Wizard: Restart Existing Operation ................................................................ 319
Model Data Transform Wizard: Model ................................................................................................ 320
Model Data Transform Wizard: Systems ............................................................................................ 321
Model Data Transform Wizard: Objects by Filter ................................................................................ 321
Model Data Transform Wizard: Transformations ................................................................................ 322
Model Data Transform Wizard: Confirmation ..................................................................................... 323
Check Write Access - Results ............................................................................................................. 323
Operation Properties Dialog Box ........................................................................................................ 324
General Tab (Operation Properties Dialog Box) .......................................................................... 324
By Class Tab (Operation Properties Dialog Box) ......................................................................... 326
Messages Tab (Operation Properties Dialog Box) ....................................................................... 326
Configuration Tab (Operation Properties Dialog Box) .................................................................. 327

Model Data Reuse (MDR) Validation Tool ............................................................................................. 328

Configure the MDR validation tool ...................................................................................................... 329
Start the MDR validation tool .............................................................................................................. 329
Process and generate data using the MDR log file ............................................................................ 331
Process and generate data using objects list files .............................................................................. 332
View results ......................................................................................................................................... 333
Generate reports ................................................................................................................................. 336
Mitigate MDR results Dialog Box Options .................................................................................... 336

Custom Commands ................................................................................................................................. 338

Create custom commands .................................................................................................................. 345
Add custom commands ...................................................................................................................... 345
Run a custom command ..................................................................................................................... 346

Project Management User's Guide 9

 Contents

Edit a custom command ..................................................................................................................... 346

Delete a custom command ................................................................................................................. 346
Custom Commands Dialog Box .......................................................................................................... 347
Add Custom Command Dialog Box .................................................................................................... 347
Edit Custom Command Dialog Box .................................................................................................... 348

Integrated Environment Overview (Smart 3D) ...................................................................................... 349

Register ............................................................................................................................................... 351
Register from Smart 3D ................................................................................................................ 351
Smart 3D Registration Wizard ...................................................................................................... 352
Generate Design Basis ....................................................................................................................... 353
Generate a design basis............................................................................................................... 353
Update Project Status ......................................................................................................................... 354
Update Project Status Dialog Box ................................................................................................ 355
Project Status Update................................................................................................................... 356
Upgrade Schema Command .............................................................................................................. 360
Upgrade Schema.......................................................................................................................... 361

Project Settings ....................................................................................................................................... 362

Import .................................................................................................................................................. 362
Import default style rules .............................................................................................................. 362
Import Project Settings Dialog Box ............................................................................................... 363
Export .................................................................................................................................................. 363
Export default style rules .............................................................................................................. 363
Export Project Settings Dialog Box .............................................................................................. 363
Configure Default Colors ..................................................................................................................... 364
Add a default style rule ................................................................................................................. 364
Customize style rules based on role ............................................................................................ 365
Default Color Configuration Dialog Box ........................................................................................ 365
Select Object Type Dialog Box ..................................................................................................... 366
Apply Default Colors ........................................................................................................................... 367

Utilities and Services .............................................................................................................................. 368

Database Wizard................................................................................................................................. 368
Create a New Site ........................................................................................................................ 370
Create Site Database and Schema Page .................................................................................... 378
Restore a Site from a Backup Set ................................................................................................ 380
New Catalog, Site Name Generator Server, or Existing Site ....................................................... 386
Upgrade a Site Database ............................................................................................................. 393
Modify Database and Schema Location ............................................................................................. 396
Database Conversion Wizard ............................................................................................................. 397
Convert a Smart 3D Oracle database to SQL Server .................................................................. 398
Convert a Smart 3D SQL Server database to Oracle .................................................................. 399
Modify the interface names of the target database ...................................................................... 400
Database Conversion Wizard ....................................................................................................... 401
Schema Name Validator ..................................................................................................................... 405
Report Workbook .......................................................................................................................... 406
Schema Name Validator Dialog Box ............................................................................................ 408
Log File ......................................................................................................................................... 410

Project Management User's Guide 10

 Contents

Troubleshooting the Schema Name Validator ............................................................................. 410

View Generator ................................................................................................................................... 411
Make changes to the catalog without synchronizing with the model ........................................... 411
Add custom attributes to the model .............................................................................................. 412
IFC Permissions at Satellite Locations ............................................................................................... 412
Assign IFC Permissions at Satellite Locations ............................................................................. 414
Check Database Interferences ..................................................................................................... 414
Server-Based Interference Checking (Database Detect) ................................................................... 417
Configure Interference Service Properties ................................................................................... 419
Start the Database Interference Detection Service ...................................................................... 419
Set IFC Permission Requirements ............................................................................................... 420
Create IFC Permission Group Folder and Permission Group ...................................................... 420
Set IFC Permissions ..................................................................................................................... 421
Check Database Interferences ..................................................................................................... 421
Update the ProgID of the Post Processor Rule ............................................................................ 423
Scheduling Project Management Tasks with Batch Services ............................................................. 424
Schedule Check Data Consistency task using Batch Services.................................................... 424
Schedule data backup using Batch Services ............................................................................... 425
Schedule data restore using Batch Services................................................................................ 425
Schedule [Task] Dialog Box ......................................................................................................... 425
Optional Schedule Properties Dialog Box .................................................................................... 427
Oracle Role Creation Utility ................................................................................................................. 427
Create Oracle Roles ..................................................................................................................... 428
Oracle Role Creation Utility Dialog Box ........................................................................................ 428

Glossary ................................................................................................................................................... 430

Index ......................................................................................................................................................... 444

Project Management User's Guide 11

Preface
This document is a user's guide for the Project Management functionality of Intergraph SmartTM
3D and provides command reference information and procedural instructions.

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).

What's New in Project Management

The following changes have been made to the Project Management task.
Version 2016 (11.0)
 Reorganized throughout for improved readability.
 Added information about the Model Data Reuse wizard operations. For more information,
see Model Data Reuse (MDR) (on page 256). (P1 CP:227829)
 Updated the Run Database Administration Processes table to show that there is a risk
running the drawing extraction processes concurrent with the bulkload process. For more
information, see Run database administration processes (on page 95). (P1 CP:227829)
 You can now register multiple point cloud vendors separately for a particular model
database. For more information, see Reference a point cloud (on page 44). (P1 CP:246829)
 The default Reference 3D Model Type is now SmartPlant Interop Publisher. For more
information, see New Reference 3D Model Dialog Box (on page 55). (P1 CP:278917)
 You can now specify unit delimiter in reports as needed while generating the report. For
more information, see Report Parameters Dialog Box (P2 CP:140982)
 Added a new Permission Group option to the Reference 3D Model Properties dialog box.
This new option allows you to assign a permission group to the attached Reference 3D
models. The permission group controls the modification operations on Reference 3D objects
by different users. For more information, see Reference 3D Model Properties Dialog Box (on
page 58). (P2 CP: 173162)
 You can now attach Reference 3D models at both the host and the satellite locations. For
more information, see Reference 3D Model (on page 47). (P2 CP:193130)
 You can now manage duplicate ProgID's by selecting the library you want to use for a
specific ProgID in the Update Custom Symbol Configuration dialog box. For more
information, see Update Custom Symbol Configuration Dialog Box (on page 163). (P2
CP:212862)
 Added instructions for regenerating the Reports database with linked servers. For more
information, see Regenerate the reports database with linked SQL servers (on page 125)
and Regenerate the reports database with linked Oracle servers (on page 129). (P2
CP:229440)
 Added new information about database upgrade performance. For more information, see
Upgrade versions for all databases (on page 165). (P2 CP:239169)

Project Management User's Guide 12

 Preface

 The Upgrade Command is now enhanced to upgrade multiple databases simultaneously

with more usability, better performance, and a better interface. For more information, see
Upgrade Version (on page 164).(P2 CP:249049)
 You can now register (attach) point cloud models at the satellite location. For more
information, see Point Cloud Properties Dialog Box (on page 45). (P2 CP:251950)
 You can now move or rotate the attached point cloud in the Project Management. For more
information, see Reference a point cloud (on page 44). (P2 CP:251950)
 Smart 3D now supports Oracle database servers running on a Linux-based computer for
non-Global Workshare installations. You cannot use Linux if you intend to use Global
Workshare. (P2 CP:253571)
 You can now register the point cloud project file using the Point Cloud Properties dialog
box in Project Management. This helps you to load the point cloud project as the default file
directly in Smart 3D while defining the workspace. However, you can choose to load other
point cloud projects using the Open Project or Import Point Cloud Data commands in the
CloudWorx menu bar. This saves lot of time for multiple users working on a common
project. The software no longer prompt you for point cloud source while defining the
workspace in Smart 3D. (P2 CP:256000)
 When you reopen a saved Smart 3D session file that contains the CloudWorx project, then
the project file that is saved with the session is opened by default. This is not applicable
when you reopen a session file that contains ModelSpace View. (P2 CP:256000)
 A new utility, Schema Name Validator, allows you to report and update any part class,
custom interface, or attribute name that does not conform to the Oracle name length
constraints. For more information, see Schema Name Validator (on page 405). (P2
CP:257901)
 Model type (plant, marine, platform, or material handling mode) is now defined when
creating the model database and is stored in the model database. In previous versions, the
model type (mode) was defined by the catalog database and stored in the site database.
Model databases upgraded from previous software versions will maintain their previous site
mode setting with that setting now stored in the model database. (P2 CP:261960)
 Removed the No Action option from the Action To Take column of the Clean Database
dialog box. For more information, see Clean Database Dialog Box (on page 92). (P2
CP:262183)
 Added information about database integrity limitations to the Task Limitation section. For
more information, see Task Limitations When Working in a Global Workshare Environment
(on page 192). (P2 CP:263544)
 If you run Model Data Reuse and encounter low memory conditions, you must restart
Project Management and the Model Data Reuse operation to continue. For more
information, see Model Data Reuse (MDR) (on page 256). (P2 CP:266052)
 Documented the new Repair Permission Groups and Duplicate Part Numbers custom
commands. For more information, see Custom Commands (on page 338). (P2 CP:269428
and P2 CP:276194)
 Added recommended practices for Model Data Reuse. For more information, see Model
Data Reuse (MDR) (on page 256). (P2 CP:270506, P2 CP:270512)
 Added best practice information for using Delete Optional during Model Data Reuse and
Model Data Transform operations. (P2 CP:270710)

Project Management User's Guide 13

 Preface

 Updated the Compare Catalogs step in the Model Data Reuse wizard. The View & Map
dialog box now displays the results of the comparison between source catalog items and
destination catalog items, including pipe spec elements, short code elements, option code
values, and schema elements. For more information, see Model Data Reuse Wizard:
Compare Catalogs (on page 302). (P2 CP:271154, P2 CP:271156, P2 CP:275499, P2
CP:276402)
 Updated note information addressing replicated databases in Upgrade the Databases and
Regenerate Reports section. For more information, see Upgrade Version (on page 164).
(P2 CP:272892)
 Information related to PDS Model Reference has been removed. For more information, see
Create Reference Models (on page 43). (P2 CP:276780)
 Added the Repair Duplicate Permission Group ID custom command. For more
information, see Custom Commands (on page 338). (P2 CP:278891)
 Added a new custom command, Placing Supports from XLS. For more information, see
Custom Commands (on page 338). (P2 CP:284643)
 Updated throughout with new tree view icons. (P2 CP:288300)
 A new utility, Configure Project Settings for Drawings, allows you to specify the issue and
revision mode for all drawings in a project. For more information, see Configure Project
Settings for Drawings (on page 416). (P3 CP:94887)
 Added a note about SQL-server level permissions and use of the View server state
permission. For more information, see Permissions, Permission Groups, and Permission
Group Folders (on page 147). (P3 CP:258004)
 Smart 3D now upgrades custom symbol configurations before it upgrades catalogs. For
more information, see Upgrade Version (on page 164). (P3 CP:261875)
 The Move by Relative Distance option in the Point Cloud Properties dialog box has been
replaced with Target Point. For more information, see Point Cloud Properties Dialog Box
(on page 45). (P3 CP:277501)
 Added new information about Default Queues. For more information, see Configure Queues
for Jobs (on page 121). (P4 CP:256931)
 Added note to Model Data Reuse section addressing Oracle tablespace extensions. For
more information, see Model Data Reuse (MDR) (on page 256).(P4 CP:259621)
 Added notes to Database Conversion Wizard section regarding running database integrity
before running database conversion. For more information, see Database Conversion
Wizard (on page 397). (P4 CP:261977)
 Synchronize Model with Catalog does not automatically synchronize Reference 3D
models, but you can choose to synchronize the model when you update the Reference 3D
project. For more information, see Synchronize Model with Catalog (on page 117) and
Update multiple Reference 3D projects (on page 53). (P4 CP:266148)
 Added information about the Model Data Transform wizard operations. For more
information, see Model Data Transform (MDT) (on page 312). (P4 CP:266150)
 Added the process to update the ProgID of the Post Processor rule. For more information,
see Update the ProgID of the Post Processor Rule (on page 423). (P4 CP:270686)

Project Management User's Guide 14

 Preface

 Added new information about Read-Only objects in the Model Data Transform (MDT)
section. For more information, see Model Data Transform (MDT) (on page 312). (P4
CP:295624)

Project Management User's Guide 15

SECTION 1

Project Management
Project Management allows you, in the role of an administrator, to manage the design and the
related hierarchy of permission groups and access privileges. You can also create models,
maintain databases, define global workshare locations, and work with Reference 3D models. To
start Project Management, click Start > All Programs > Intergraph Smart 3D > Project
Management.

 Prior to using the Project Management software, you must use the Database Wizard (on
page 368) to create the site, site schema, catalog, and catalog schema databases. The
Database Wizard is located at Start > All Programs > Intergraph Smart 3D > Database
Tools > Database Wizard.
 If the Project Management task does not point to the appropriate database, errors result
when you open that database. To correct this problem, close Project Management, and use
Start > All Programs > Intergraph Smart 3D > Database Tools > Modify Database and
Schema Location to change the site database that the task is viewing. For more
information about this utility, see the Installation Guide available using Help > Printable
Guides in the software.

How You Can Use Project Management

Examples of the Project Management tasks that you can perform include:
 Granting administrative permissions to other site administrators.
 Defining models and their related properties.
 Defining permission groups and the folders that organize them.
 Granting read, write, and other access privileges to users in specific permission groups.
 Defining and managing locations for Global Workshare.
 Creating Reports databases for an individual models.
 Backing up and restoring Smart 3D databases.
 Migrating catalog and model databases to the currently installed version of the software
 Managing the administration of projects through the stages of active, complete, and merged
with as-built.
 Configuring and managing the database interference detection service.
 Copying portions of a model to a different location or to another model.

Project Management User's Guide 16

 Project Management

The Databases
Before you begin designing with the software, you must first create a set of seven databases.
These databases are the site, site schema, catalog, catalog schema, model, reports, and
reports schema. The following illustration depicts the order of creation and the relationships
between these databases.

1 - Site
2 - Site schema
3 - Catalog
4 - Catalog schema
5 - Model
6 - Reports
7 - Reports schema

Site database
Serves as the primary or main database and the container for the other databases. The site
contains all permission groups and related data and allows you to access the model and
catalog databases. You must create the site database before creating the model or catalog
databases. A site database can point to multiple model databases and multiple catalog
databases.
Site schema database
Contains metadata describing and managing backup and maintenance needs for all
databases. When you create the site database, you also create the site schema database.
Catalog database
Contains reference data information, which includes market information for commodity
components, physical dimensions, and standards based on industry specifications. Catalog
data includes:

Project Management User's Guide 17

 Project Management

 Graphical symbols that you can place in the model, such as equipment or piping
components
 Non-graphical, tabular data, such as specification data
 Parts that you place in the model, such as piping components and equipment
 Rules that govern how the parts are placed and connected
Catalog schema database
Contains metadata that describes the format of business objects, such as pipe and
structural shapes, and their relationships. When you create the catalog database, you also
create the catalog schema. Model and catalog databases share the same catalog schema
database.
Model database
Contains all of the physical data and three-dimensional objects in the model.
Reports database
Interacts with the catalog and model databases to generate tabular reports from Smart 3D
data. The reports database is a set of queries and views that point to the data in the other
databases. The reports database and schema are created during the model creation
process.
Reports schema database
Contains metadata that describes the report formats.
You can use the Database Wizard (on page 368) to create the site, the site schema, the
catalog, and the catalog schema. You then create the model, reports, and reports schema
databases using the Database > New > Model command in the Project Management task. For
more information, see Create New Database Objects (on page 33)

Menu Commands and Toolbar

The Project Management user interface includes a menu bar, a toolbar, a console pane on the
left, and a detail pane on the right. The menu bar includes the menus Database, Edit, View,
Go, Tools, SmartPlant, and Help. The toolbar includes buttons for navigating and managing
the project, catalog, and model using the console. The console pane displays the hierarchy of
the databases and permissions in a tree format. The detail pane displays property data for the
selected console item in a grid format.
Some Project Management commands reside on the menu bar, the toolbar, and the
right-click shortcut menu of the console pane.

Database Menu
New
Creates the following new items:
 Model - Creates a new model database and associates the appropriate catalog
database with this model. For more information, see New Model (on page 33).
 Catalog - Creates a new catalog database and schema. For more information, see New
Catalog (on page 38).

Project Management User's Guide 18

 Project Management

 Location - Creates a new global workshare location. For more information, see New
Location (on page 42) and Global Workshare (on page 170).
Permission Group Folder
Creates a new folder for organizing permission groups in the selected catalog or model. For
more information, see New Permission Group Folder (on page 158). This command is also
available by right-clicking an item in the Project Management tree view.
Permission Group
Creates a new permission group in the selected permission group folder. For more
information, see New Permission Group (on page 153). This command is also available by
right-clicking an item in the Project Management tree view.
 Point Cloud Model Reference - Adds point cloud data to the model. A point cloud
represents the visible surface of an object that has been scanned or digitized. For more
information, see Point Cloud Model Reference (on page 43). This command is also
available by right-clicking an item in the Project Management tree view.
 Reference 3D Model - References external model data within the selected model. For
more information, see Reference 3D Model (on page 47). This command is also
available by right-clicking an item in the Project Management tree view.
Define Properties
Defines properties for the following:
 Model - Defines custom properties for your model database. For more information, see
Define Model Properties (on page 70).
 Permission Group Folder - Defines custom properties for permission group folders.
For more information, see Define Permission Group Folder Properties (on page 74).
 Permission Group - Defines custom properties for a permission group. For more
information, see Define Permission Group Properties (on page 72).
Maintenance
Provides a tool to purge temporary data that may cause performance issues. For more
information, see Database Maintenance (on page 88).
Integrity
Runs directly on a database (site, catalog, model, or reports) and creates records for the
objects that need to be cleaned. For more information, see Database Integrity (on page 93)
and Check Data Consistency Dialog Box (on page 96).
Exit
Closes Project Management.

Edit Menu
Undo
Reverses your most recent transactions in reverse chronological order. For more
information, see Undo (on page 29).
Copy
Copies the selected permission group or permission group folder to the clipboard. For more

Project Management User's Guide 19

 Project Management

information, see Copy (on page 29). This command is also available by right-clicking an item
in the Project Management tree view.
Paste
Inserts the permission group or permission group folder clipboard contents into the selected
area of the project management hierarchy. This command is unavailable if the clipboard is
empty. For more information, see Paste (on page 29). This command is also available by
right-clicking an item in the Project Management tree view.
Move
Moves the selected permission group to a permission group folder of your choice. For more
information, see Move (on page 30).
Delete
Permanently removes the selected item from the database. For more information, see
Delete (on page 30). This command is also available by right-clicking an item in the Project
Management tree view.
Regenerate Reports Database
Regenerates the reports and reports schema databases. For more information, see
Regenerate Reports Database (on page 124). This command is also available by right-
clicking an item in the Project Management tree view.
Rename
Renames the selected item. For more information, select Rename (on page 31). This
command is also available by right-clicking an item in the Project Management tree view.
Properties
Displays the properties and property values of the selected item. For more information, see
Properties (on page 31). This command is also available by right-clicking an item in the
Project Management tree view.
Permissions
Assigns access permissions for model and catalog databases. For more information, see
Permissions (on page 147). This command is also available by right-clicking an item in the
Project Management tree view.
Update Reference 3D Model(s)
Simultaneously updates multiple Reference 3D projects. For more information, see Update
multiple Reference 3D projects (on page 53). This command is also available by right-
clicking an item in the Project Management tree view.

View Menu
Refresh
Refreshes the display.
Toolbars
Toggles the toolbar display.
Status Bar
Toggles the status bar display.

Project Management User's Guide 20

 Project Management

Go Menu
Back
Returns the focus in the Project Management hierarchy to the previously selected item or
folder. For more information, see Back (on page 27).
Forward
Advances the focus in the Project Management hierarchy forward to the item that you
selected just before you used Back. For more information, see Forward (on page 27).
Up One Level
Moves the focus up one level in the Project Management hierarchy. For more information,
see Up One Level (on page 28).

Tools Menu
Backup
Saves selected model databases and their associated site and catalog databases to a
single folder. The command is only available on the Tools menu. For more information, see
Backup (on page 97).
Restore
Restores a previously backed up version of a model database and its reference data to
selected servers. The command is only available on the Tools menu. For more information,
see Restore (on page 102).
Synchronize Model with Catalog
Updates the model database with all changes from the catalog database, including property
and symbol changes. The command is only available on the Tools menu. For more
information, see Synchronize Model with Catalog (on page 117).
Update Custom Symbol Configuration
Creates and updates the custom symbol mapping file. For more information, see Update
Custom Symbol Configuration (on page 160).
Upgrade Version
Upgrades the selected catalog or model database to the same version as the site database.
For more information, see Upgrade Version (on page 164). This command is also available
by right-clicking an item in the Project Management tree view.
Update Project Status
Modifies the status of a project from active to complete to merge (or cancel), and
communicates those changes with SmartPlant Foundation. The command is only available
on the Tools menu. For more information, see Update Project Status (on page 354).
Project Settings
Provides a set of commands to work with the default style rules in the model database. For
more information, see Project Settings (on page 362). This command is also available by
right-clicking an item in the Project Management tree view.
Duplicate Model for Workshare
Creates copies of a model database to support global worksharing between the host server

Project Management User's Guide 21

 Project Management

and its associated satellite locations. For more information, see Duplicate Model for
Workshare (on page 201). This command is also available by right-clicking an item in the
Project Management tree view.
Consolidate Model from Workshare
Consolidates data from the different satellite servers to the databases on the host server to
form a single model database. For more information, see Consolidate Model from
Workshare (on page 199). This command is also available by right-clicking an item in the
Project Management tree view.
Model Data Reuse
Copies large amounts of data from a source model database and reuses that data within the
same model or other models. For more information, see Model Data Reuse (MDR) (on page
256).
Model Data Transform
Moves and/or rotates a large amounts of objects in a model from one location in the model
to another. The objects to be transformed are disconnected from the surrounding objects
before they are transformed. For more information, see Model Data Transform (MDT) (on
page 312).
Run Report
Selects a report template and runs a report. For more information, see Run Report (on page
131).
Configure Queues for Jobs
Configures different queues for the Smart 3D jobs. For more information, see Configure
Queues for Jobs (on page 121). This command is also available by right-clicking an item in
the Project Management tree view.
Custom Commands
Provides you with application programming capability for the software. A set of custom
commands is also delivered with the software. For more information, see Custom
Commands (on page 338).

SmartPlant Menu
Available only if SmartPlant Client is installed. For more information, see Setting Up
Client Workstations in the Integration Setup Guide, available with the SmartPlant Integration
software.
Register
Registers a model database with an instance of SmartPlant Foundation. Each model must
be registered before you can connect to SmartPlant Foundation to perform any specific
tasks, such as publishing or retrieving files. For more information, see Register (on page
351).
Generate Design Basis
Generates a design basis .xml file and updates the associated map files. For more
information, see Generate Design Basis (on page 353).

Project Management User's Guide 22

 Project Management

Upgrade Schema
Updates the existing tool map schemas associated with the site to a newer version. For
more information, see Upgrade Schema Command (on page 360).

Project Management Toolbar

Back - Returns the focus in the Project Management hierarchy to the previously selected
item or folder. For more information, see Back (on page 27).

Forward - Advances the focus in the Project Management hierarchy forward to the item
that you selected just before you used Back. For more information, see Forward (on page
27).

Up One Level - Moves the focus up one level in the Project Management hierarchy. For
more information, see Up One Level (on page 28).

Copy - Copies the selected permission group or permission group folder to the clipboard.
For more information, see Copy (on page 29).

Paste - Inserts the permission group or permission group folder clipboard contents into
the selected area of the project management hierarchy. This command is unavailable if
the clipboard is empty. For more information, see Paste (on page 29).

Undo - Reverses your most recent transactions in reverse chronological order. For more
information, see Undo (on page 29).

Delete - Permanently removes the selected item from the database. For more
information, see Delete (on page 30).

Properties - Displays the properties and property values of the selected item. For more
information, see Properties (on page 31).

Permissions - Assigns access permissions for model and catalog databases. For more
information, see Permissions (on page 147).

New Permission Group Folder - Creates a new folder for organizing permission groups
in the selected catalog or model. For more information, see New Permission Group Folder
(on page 158).

New Permission Group - Creates a new permission group in the selected permission
group folder. For more information, see New Permission Group (on page 153).

New Object - This option is not currently available.

Project Management User's Guide 23

 Project Management

Project Management Hierarchy

The console pane on the left side of the Project Management window displays the hierarchy of
your model in a tree format. The detail pane on the right side displays property data for the
selected console item in a grid format.

Hierarchy Icons
Project Management uses the following icons to show the type and status of items.

- Top level of the hierarchy.

- Locations folder.
- Location.
- Reference data folder.

- Catalog associated with a model.

- Catalog created using an earlier version of the software, requiring an upgrade to the
current version.

- Catalog associated with a model, but missing the database. This icon also displays when
you do not have permissions to the catalog.

- Catalog not associated with a model.

- Catalog not associated with a model. Missing database.

- Models folder.

- Plant model.

- Plant model created using an earlier version of the software, requiring an upgrade to the
current version.

- Plant model with a missing database. This icon also displays when you do not have
permissions to the model.

- Marine model.

- Marine model created using an earlier version of the software, requiring an upgrade to the
current version.

- Marine model with a missing database. This icon also displays when you do not have
permissions to the model.
- Material handling model.

- Material handling model created using an earlier version of the software, requiring an
upgrade to the current version.

- Material handling model with a missing database. This icon also displays when you do not
have permissions to the model.
- Platform model.

Project Management User's Guide 24

 Project Management

- Platform model created using an earlier version of the software, requiring an upgrade to the
current version.
- Platform model with a missing database. This icon also displays when you do not have
permissions to the model.

- The model is not restored and it does not exist on the database server. The model type is
not known.
- Permission group folder.
- Permission group.

- Interference server.

- Reference 3D model folder.

- Reference 3D model.
- Reference 3D model that is out of date and needs to be updated.

Tree View
The console panel tree view displays the logical hierarchy of your model, including satellite
locations, databases, permission group folders, and permission groups. All items in the tree are
contained within the same site database. Under the root of the tree view are three main
branches: Locations , Reference Data , and Models .

Locations
Displays the locations that have been defined for the global workshare environment. After
creation, locations can be associated with permission groups and models as part of the
workshare replication process.

The software creates the first location during site database generation.
Reference Data
Groups the catalog databases in the site and their associated permission group folders and
permission groups. Permissions are assigned to each catalog to control administrative
access of the catalog database. This provides more granular and specific permissions on
catalog objects, including equipment items, piping components, valves, and other reference
data.

Project Management User's Guide 25

 Project Management

Models
Groups all models in the site and their associated permission group folders and permission
groups. Permissions are assigned to each model to control which users have read/write
access to various objects in the model.

List View
If the selected node in the console panel tree contains children, the detail panel list view
displays property data for the children. If the selected node has no children, then the list view
displays property data for that node.
In the following illustration, the model database named Plant_12 is selected in the tree view. The
list view displays information regarding its immediate children, or the three permission group
folders nested under it.

In the next illustration, the permission group Hsv_CableGroup is selected in the tree view.
Because this item has no children nested under it, the list view displays property data for the
item itself.

Moving Through the Hierarchy

Navigating the Project Management hierarchy is similar to navigating Windows Explorer. You
can click to expand and collapse nodes in the Project Management tree view hierarchy, or
double-click to expand or collapse nodes. You can use the navigational commands on the
horizontal toolbar to move backward and forward through the items in the hierarchy, or to move
up to a higher order in the hierarchy.
The commands on the Go menu also allow you to move through the tree view. You can move
backward and forward through the items, or you can move up to a higher order in the hierarchy.

Project Management User's Guide 26

 Project Management

Back
Returns the focus in the Project Management tree to the last selected item or folder. You can
also access this command by clicking Go > Back. You can click Back repeatedly to retrace your
path through several levels. The Back command is not available:
 When you first open the task
 If you have not selected an item or folder during this work session
 If you are displaying the top classification in the hierarchy

Move back to the previous level

1. Click Go > Back. You can also click Back on the horizontal toolbar.
The Back command highlights the last node that you selected in the Project Management
tree.
2. Click Back repeatedly to retrace your path through several levels
This command is not available if you are displaying the first level in the history list.

Forward
Advances the display forward to return the browser display to the last item that you selected
just before you used the Back command.
You can also access this command by clicking Go > Forward. You can click Forward
repeatedly to retrace your path through several levels. This command is not available if you are
displaying the top classification in the hierarchy.

Project Management User's Guide 27

 Project Management

Return to the previous display

1. Click Go > Forward. You can also click Forward on the horizontal toolbar.
This command highlights the last node that you selected in the Project Management tree
before you clicked Back.
2. Click Forward repeatedly to retrace your path through several levels.
This command is not available if you are displaying the last level in the history list.

Up One Level
Moves the focus up one level in the hierarchy. This command is not available when you
select the root level of the tree. You can also access this command by clicking Go > Up One
Level.

Go to the parent classification

1. Click Go > Up One Level. You can also click Up One Level on the horizontal toolbar.
The parent classification in the hierarchy highlights.
This command is not available if you are displaying the top classification in the
hierarchy.

Managing Items in the Hierarchy

The software provides several simple methods for organizing existing items within the model
hierarchy. You can quickly move, rename, delete, or copy an existing item. Only permission
group folders and permission groups can be moved or copied. Moving and copying elements
saves you time by eliminating the need to recreate information, as well as help you maintain
consistent data throughout your model.

Copying and Pasting Items

You can copy a permission group folder or permission group by selecting it and clicking Copy
on the horizontal toolbar. Copying places the selected item on the Clipboard. When you click
Paste on the horizontal toolbar, the item is placed in the location that you have specified in
the model hierarchy. As with folders in Windows Explorer, the Paste command creates all the
items that are nested under the item that you select for copy. The new item retains permissions,
but there is no link to placed items.

Moving Items
You can move permission group folders and permission groups from one location to another
within the hierarchy tree by selecting the item you want to move, selecting the Move command
on the Edit menu, and then selecting a destination for the item in the model hierarchy.
Permission groups can only be moved to other folders within the same model.

Deleting Items
You can delete models, permission group folders, and permission groups from the model
hierarchy by selecting them and clicking Delete on the horizontal toolbar. After an item is

Project Management User's Guide 28

 Project Management

deleted, it is permanently removed from the hierarchy. You cannot delete a permission group
folder with children.

Renaming Items
You can use Edit > Rename to change the name you originally assigned to the models,
permission group folders, and permission groups that you create.

Undo
Reverses the effect of your previous transactions. You can also access this command by
clicking Edit > Undo. You can click Undo repeatedly to undo your transactions in reverse order.

Copy
Copies the selected item and its nested contents to the clipboard. You can also access this
command by clicking Edit > Copy. The copied items replace the previous contents of the
clipboard. You can then use Paste to place a copy of the item in the model hierarchy.
You can copy an individual permission group or a permission group folder and its contents.
Copy only copies the name and permissions from permission groups, not the model items
contained within. You can also copy and paste the items across models and/or catalogs within
the same site.

Copy an item
1. In the tree view, select the permission group folder or permission group to copy.
2. Click Copy on the horizontal toolbar. You can also select Copy on the Edit menu.

Paste
Inserts the clipboard contents in a selected area of the model hierarchy. You can also
access this command by clicking Edit > Paste. This command is unavailable if the clipboard is
empty.
You can paste an individual permission group or a permission group folder and its contents.
Paste enforces hierarchy restrictions and naming conventions. Upon placement, the
software automatically generates the name Copy of <original permission group name>.
Permission group names must be unique within the model database.

Project Management User's Guide 29

 Project Management

Paste an item
1. Select the location in the model hierarchy in which to paste the permission group folder or
permission group that you copied to the clipboard.
2. Click Paste on the horizontal toolbar. You can also select Paste on the Edit menu.

Move
Edit > Move moves items from one location to another. You specify the original or present
location of the item and then indicate the destination location. You can move one item or select
multiple items to move simultaneously.
You can move an individual permission group or a permission group folder and its contents.

Move an item
1. In the Project Management tree, select the permission group item to move.
2. Click Edit > Move.
3. Select a destination in the tree to place the item.

Delete
Permanently removes the selected item from the database. You can also access this
command by clicking Edit > Delete.
You can select and delete a permission group folder or permission group, as long as that item
belongs to a model for which you have Write permission.
Deleting items can create inconsistencies in the logical design of your model hierarchy. You
cannot re-insert or paste items after you remove them with this command. However, you can
retrieve the data and reconcile the inconsistencies by immediately clicking Undo .
Use care when deleting a model. You cannot use Undo to reverse the
deletion.

Delete an item
1. In the Project Management tree, select the model, permission group folder or permission
group to delete.
2. Click Edit > Delete. You can also click Delete on the toolbar.
3. Click Yes in the confirmation box.

Project Management User's Guide 30

 Project Management

Rename
Edit > Rename changes the names that you originally assigned to models, permission group
folders, and permission groups. You cannot use the Rename command to rename a catalog
database.
You can also access Rename from the shortcut menu when you right-click an item in the Project
Management tree.

Rename Dialog Box

Changes the name that you have assigned to an item.
Current location
Specifies the location of the selected item on the Project Management tree.
From
Displays the current name of the selected item.
To
Specifies a new name for the selected item.

Rename an item
1. Select the item to rename.
2. Click Edit > Rename.
3. On the Rename dialog box, type the new name of the item in the To box.

Properties
Displays the properties and property values of the selected item.
You can also access this command by clicking Edit > Properties or from the shortcut menu
when you right-click an item in the Project Management tree.
To define new custom properties, use Define Properties (on page 70) in the
Database menu.

Project Management User's Guide 31

 Project Management

Location Properties Dialog Box (on page 200)

Database Properties Dialog Box (on page 81)

Model Properties Dialog Box (on page 82)

Permission Group Folder Properties Dialog Box (on page 83)

Permission Group Properties Dialog Box (on page 84)

Interference Server Settings Dialog Box (on page 84)

What do you want to do?

 Edit model properties (on page 78)
 Edit catalog database properties (on page 78)
 Edit permission group properties (on page 79)
 Edit permission group folder properties (on page 79)
 Update database locations when a server changes (on page 79)
 Change the location of a permission group (on page 81)

Project Management User's Guide 32

SECTION 2

Create New Database Objects

Prior to using the software, you must use the Database Wizard (on page 368) to
create the site, site schema, catalog, and catalog schema databases.
The site database and schema organize the interactions of the other databases. The site
database stores user access for the model and can contain multiple model and catalog
databases. Typically, there is one site database set for each customer location, or for each set
of interrelated model designs.
After creating the site, site schema, catalog, and catalog schema databases, you can create
other database objects by clicking Database > New.

New Model (on page 33)

New Catalog (on page 38)

New Location (on page 42)

New Model
Database > New > Model creates a new model database and allows you to associate the
appropriate catalog database with this model. This command is available only when the model's
root is selected in the Project Management tree. During the model creation process, the reports
and reports schema databases are also created.
The model database organizes all of the three-dimensional objects in the physical model.
Although used interchangeably with model database, a model configuration is all three
databases — catalog database, catalog schema, and model database — used together.
After you create your model, you can use Edit > Properties to view and change descriptive
information about the model, including giving it a different name or modifying access
permissions.
Before using this command to create your models, you must run the Database
Wizard (on page 368), a utility that resides outside Project Management, to create the site and
site schema databases and to restore the catalog and catalog schema databases. Typically, you
perform this action one time as part of the product installation and configuration process.

Using this Command with SQL

 You must have administrator privileges on the site database to create a new model.
 The procedure in this section is for MS SQL Server 2014.
 The computer used to create the new model must have Project Management and Server
Connectivity options installed.
 Before creating a new model database, you must run the Database Wizard to create the
site and site schema databases and restore the catalog and catalog schema databases. For
more information, see Create a New Site (on page 370).

Project Management User's Guide 33

 Create New Database Objects

 When model generation completes, an icon for the Smart 3D Interference Detection Service
also displays under the model node in the tree view of the Project Management task.
 After you create the model, you can open the software on a client computer and begin
designing the model.
 During the model database creation process, you can specify the location for the physical
database files when you create the model.

Using this Command with Oracle

 You must have administrator privileges on the site database to create a new model.
 If you are running Oracle on Linux, you must configure an Oracle wallet with administrator
user privileges.
 The computer used to create the new model must have Project Management and 3D
Server Connectivity options installed.
 Before creating a new model database, you must run the Database Wizard to create the
site and site schema databases and restore the catalog and catalog schema databases. For
more information, see Create a New Site (on page 370).
 When model generation completes, an icon for the Smart 3D Interference Detection Service
also displays under the model node in the tree view of the Project Management task.
 You can specify the location for the physical database files when the model is created.
 After you create the model, you can open the software on a client computer and begin
designing the model.
 Although the reports and reports schema database are created automatically during the
model generation process, they do not appear in the tree view of the model hierarchy.
Reports database information can only be accessed via the Database tab of the Model
Properties dialog box. To display this dialog box, right-click a model and select Properties
on the shortcut menu.
 Run the Oracle Role Creation Utility to define specific user roles for each schema or
collection of schemas, if necessary. For more information, see Oracle Role Creation Utility
(on page 427).

What do you want to do?

 Create a new model (MS SQL Server model database) (on page 35)
 Create a new model (Oracle model database) (on page 35)

Project Management User's Guide 34

 Create New Database Objects

Create a new model (MS SQL Server model database)

1. Open the Project Management task.

2. Select the Models folder in the tree view.

3. Click Database > New > Model.
The New Model dialog box displays.
4. On the General tab, type a value for Name. Optionally, type values for Description, Site,
and Owner.
5. Select a model type.
6. On the first row of the Databases tab, select Catalog as Type, and define the following
values:
a. Server - Select the server on which the catalog database resides.
b. Name - Select an existing catalog database.
7. On the second row, select Model as Type and select a Server.
The software automatically populates the Name field.
8. On the third row, select Reports as Type and select a Server.
The software automatically populates the Name.
9. In the Name generator server for model box, type the name of the server on which the
name generator service is installed.
10. In the Physical database and Log file boxes, specify the path for the location of the model
database files and log files. You can use the default SQL location.
11. Click OK on the New Model dialog box, and wait for your computer to complete its
processing.
Icons for the new model and its associated catalog database display in the tree view of the
Project Management task.
Although the reports and reports schema databases are created automatically during
the model generation process, they do not appear in the tree view of the model hierarchy.
Reports database information can only be accessed via the Database tab of the Model
Properties dialog box. For more information, see Model Properties Dialog Box (on page 82).

Create a new model (Oracle model database)

1. Select the Models folder in the Project Management tree view.
2. Click Database > New > Model.
The New Model dialog box displays.
3. On the General tab, type a value for Name. Optionally, type values for Description, Site,
and Owner.
4. Select a model type.
5. On the first row of the Databases tab, select Catalog as Type, and define the following
values:

Project Management User's Guide 35

 Create New Database Objects

a. Service - Select the Oracle net service for the catalog database.
b. Name - Select an existing catalog database.
6. On the second row, select Model as Type and select a Server.
The software automatically populates the Name field.
7. On the third row, select Reports as Type and select a Server.
The software automatically populates the Name field.
8. In the Name generator server for model box, type the name of the server on which the
name generator service is installed.
9. In the Physical database and Index table space path boxes, specify the path for the
location of the model database files and model index table space.
10. Click OK, and wait for database creation to complete.
Icons for the new model and its associated catalog database display in the tree view of the
Project Management task.
Although the reports and reports schema databases are created automatically during
the model generation process, they do not appear in the tree view of the model hierarchy.
Reports database information can only be accessed via the Database tab of the Model
Properties dialog box. For more information, see Model Properties Dialog Box (on page 82).

New Model Dialog Box

Adds a new model database to the hierarchy in the site database. When you create a new
model, you can define its properties. You can open the command by clicking Database > New >
Model in the Project Management task.
General Tab (New Model Dialog Box) (on page 36)
Databases Tab (New Model Dialog Box) (on page 37)

General Tab (New Model Dialog Box)

Defines properties associated with the new model.
Name
Specifies the model name. You cannot use the following special characters when naming a
new model.
Description
Specifies a description of the model.
Site
Specifies a name to describe the model site, such as Huntsville.
Owner
Specifies a name to describe the owner, such as the XYZ Group.
Model Type
Select the type of model to create: Plant, Marine, Platform, or Material Handling.

Project Management User's Guide 36

 Create New Database Objects

Databases Tab (New Model Dialog Box)

Identifies the catalog, model, and reports databases that are associated with the new model that
you are creating.

MS SQL Server Databases

Type
Specifies the database types. Select Catalog in the first row of the grid, Model in the
second row, and Reports in the third row.
DB Provider
Specifies MSSQL as the database provider.
Server
Designates the name of the server where the database resides. Select a server from the list.
The server must be registered using Microsoft SQL Server™ Enterprise Manager to display
in the list.
Name
Specifies the name of the database. In the first row, select the catalog database to which the
model will be associated. In the second row, type a model name. The default name is the
value typed for Name on the General tab, appended with _MDB. In the third row, type a
reports name. The default name is the value typed for Name on the General tab, appended
with _RDB.
Name generator server for model
Specifies the name of a computer that is configured to run the Name Generator Service. For
more information about configuring the Name Generator Service, see the Installation Guide
available from Help > Printable Guides.
Physical database
Specifies the location for the model database file.
Log file
Specifies a location for the model database log file. This option displays only if MSSQL is
the database type.

Oracle Databases
Type
Specifies the database types. Select Catalog in the first row of the grid, Model in the
second row, and Reports in the third row.
DB Provider
Specifies ORACLE as the database provider.
Service
Specifies the name of the Oracle net service for the database connection.

Project Management User's Guide 37

 Create New Database Objects

Name
Specifies the name of the database. In the first row, select the catalog database to which the
model will be associated. In the second row, type a model name. The default name is the
value typed for Name on the General tab, appended with _MDB. In the third row, type a
reports name. The default name is the value typed for Name on the General tab, appended
with _RDB.
Name generator server for model
Specifies the name of a computer that is configured to run the Name Generator Service. For
more information about configuring the Name Generator Service, see the Installation Guide
available from Help > Printable Guides.
Physical database
Specifies the location for the model database file.
Index table space path
Displays the location of the model index table space. This option displays only if ORACLE is
the database type.

New Catalog
Database > New > Catalog creates a new, empty catalog database and schema without
bulkloaded data. You can also create a new catalog database and schema with data by using a
template. In addition, this command uses the active site's catalog database type, Microsoft ®
SQL Server or Oracle®, to create the new catalog databases.
An empty catalog is a catalog database that contains the database schema, such as tables,
procedures, and views, but does not contain any data, such as part data or specifications. In
addition to creating the schema for the new catalog, the command creates the default
permission groups and access rules in the catalog. The command also creates the default root
nodes in the catalog, which display in the tree view in the Catalog task.
You can use the Create a new catalog from a template option to begin work from a seed
catalog. A catalog database with data contains reference data such as part dimensions,
specifications, and industry standards.
After you create a new catalog with this command, the catalog displays under the Reference
Data folder in Project Management. You can bulkload data into the new catalog at any time.
You cannot create or modify data in the new catalog through the Catalog task until you
associate the catalog with a model. After you associate the catalog with a model, you can open
a session file and add parts and specification data to the catalog in the Catalog task. Adding
data to a catalog requires administrator privileges.
In a Global Workshare configuration, Database > New > Catalog is available at the
host location, but not at satellite locations. You cannot create or modify reference data at
satellite locations. In addition, Smart 3D does not support Linux for Global Workshare. You must
run Oracle on a Windows-based server if you intend to use Global Workshare.
For more information about loading information into a new catalog, see the Reference Data
Guide available from Help > Printable Guides.

Project Management User's Guide 38

 Create New Database Objects

What do you want to do?

 Create a new catalog (on page 39)

Create a new catalog

1. In Project Management, click Database > New > Catalog.
The New Catalog dialog box displays.
2. Specify the Catalog information as needed for the new catalog database.
The software specifies Schema information based on the specified Catalog
information.
3. Select Create an empty catalog and specify the template file (such as AppRepos.dat or
SM_EmptyShipCatalogDB.dat, delivered with the software) to be used in creating the
catalog schema.
-OR-
Select Create a new catalog from a template and specify the template file in the field
provided.
Smart 3D reference data includes sample template files containing example
data. This data is not certified for production use by Intergraph.
4. For SQL databases, browse to locate the Physical database and Log file.
- OR -
For Oracle databases, type the Data tablespace file name and the Index tablespace file
name.
5. Browse to specify the Symbol and custom program file location.
6. Click OK to create the new catalog.
A progress bar displays while the software creates catalog and catalog schema databases.
After the software creates the new catalog, it displays in the Reference Data node in the
Project Management tree. The tree view icon indicates that the catalog is not associated
with a model.

7. Select Database > New > Model to associate the new catalog with a model.
Create a new model (MS SQL Server model database) (on page 35)
Create a new model (Oracle model database) (on page 35)

Project Management User's Guide 39

 Create New Database Objects

New Catalog Dialog Box

Provides options for creating a new catalog database and schema. You access this dialog box
with Database > New > Catalog.
In a Global Workshare configuration, Database > New > Catalog is available at the
host location, but not at satellite locations. You cannot create or modify reference data at
satellite locations. In addition, Smart 3D does not support Linux for Global Workshare. You must
run Oracle on a Windows-based server if you intend to use Global Workshare.

Catalog information
Catalog database server
Specifies the name of the server on which to create the catalog database. This option is only
available when the database type is MS SQL Server.
Oracle service
Specifies the name of the Oracle net service to use to create the catalog database. This
option is only available when the database type is Oracle.
Catalog database name
Specifies the name of the new catalog database. You can type a new name or select an
existing catalog database from the list. If you select an existing database, the software
replaces the existing catalog database with a new catalog database.

Schema information
Catalog schema server
Displays the name of the server where the software creates the catalog schema database.
This is the same server you specified for Catalog database server. This option is only
available when the database type is MS SQL Server.
Oracle service
Displays the name of the Oracle net service for the catalog schema database connection.
This option is only available when the database type is Oracle.
Catalog schema name
Displays the name that the software assigns to the catalog schema database. This name is
the same string you specified for the catalog database name with _SCHEMA appended.

Template options
Create an empty catalog
Indicates creation of a new, empty catalog. An empty catalog contains all schema, such as
tables, procedures, and views, but does not contain any data, such as part data or
specifications. When you select this option, the Template file to be used to create catalog
schema field is available.
Template file to be used to create catalog schema
Specifies the path and name of the .dat file (such as AppRepos.dat or
SM_EmptyShipCatalogDB.dat, delivered with the software) to use to create the catalog
schema. You can type the full path and file name or click the ellipsis button to select the file

Project Management User's Guide 40

 Create New Database Objects

from the Browse dialog box.

Create a new catalog from a template
Indicates that a new catalog database and schema is to be created from an existing
template. You can use this option to begin work from a seed catalog containing data. When
you select this option, the Template file to be used to create catalog database and
schema field is available.
Template file to be used to create catalog database and schema
Specifies the path and name of the file to use to create the catalog database and schema.
You can type the full path and file name or click the ellipsis button to select the file from the
Browse dialog box. You will typically select a .dat file certified for use by your company.
Smart 3D reference data includes sample template files containing example
data. This data is not certified for production use by Intergraph.

Paths for catalog database files

Physical database
Specifies the location for the catalog database file. Click the ellipsis button to select the file
from the Browse dialog box. This option is only available when the database type is MS
SQL Server.
Log file
Specifies the location for the catalog database log file. Click the ellipsis button to select the
file from the Browse dialog box. This option is only available when the database type is MS
SQL Server.
Database tablespace file name
Specifies the location of the catalog database table space. This option is only available
when the database type is Oracle. By default, the text in this field is Oracle Managed File.
This means that the tablespace file name is placed into a predefined Oracle location. You
can edit this field to use an unmanaged file for the tablespace. If ASM is enabled in Oracle,
the text in this field is the disk group name, such as +Data1, instead of a tablespace file
name.
Index tablespace file name
Specifies the location of the catalog index table space. This option is only available when
the database type is Oracle. By default, the text in this field is Oracle Managed File. This
means that the tablespace file name is placed into a predefined Oracle location. You can
edit this field to use an unmanaged file for the tablespace. If ASM is enabled in Oracle, the
text in this field is the disk group name, such as +Data1, instead of a tablespace file name.
Symbol and custom program file location
Specifies where the catalog symbol files are located. Click the ellipsis button to select the
file from the Browse dialog box.

 Smart 3D does not delete a partially created catalog after displaying an error message. You
must manually delete the database from the database server before trying again.
 If you are running Oracle on Linux, then the database templates must be on the Linux
computer on which the Oracle service is running.

Project Management User's Guide 41

 Create New Database Objects

 Linux is a case-sensitive environment. Make sure that you use the correct case when typing
the database template names (CatalogDB.DMP and AppRepos.DMP) and the folder when
creating the database.

New Location
New > Database > Location creates a new location object. A location is a geographical place,
such as a city, country, or some other region. A location can also identify the purpose of a
computer involved in a Global Workshare Configuration, such as Host, Satellite1, or Satellite2.
The location can be any string identifier that represents an informative name for the location.
Data is typically transferred between workshare locations consisting of a host and its various
satellites.
Unlike permission group objects that are available only to the given model database, the
location object is a site-wide object. After a location is created, it is available to any model in the
site.
New Location is not available at satellite locations. New locations can only be
created at the host.

Project Management User's Guide 42

SECTION 3

Create Reference Models

You can add external reference data to your model with commands under Database > New.

Point Cloud Model Reference (on page 43)

Smart 3D supports using point cloud data from third-party applications as reference data in a
Smart 3D model. To make the point cloud data available, the third-party software is installed and
integrated with Smart 3D.

Reference 3D Model (on page 47)

Reference 3D (R3D) functionality facilitates the attachment of external 3D data as a reference
model. This external data might have been published from another Smart 3D model or from a
third-party model such as PDMS. The data from external models is expected as a set of graphic
(.ZVF) and data (.XML or .DRV) files. This command significantly augments the current global
workshare solution because it does not require replicated databases.

Point Cloud Model Reference

Database > New > Point Cloud Model Reference adds a point cloud model to the Smart 3D
model. You can also access this command by selecting New Point Cloud Model Reference
from the shortcut menu when you right-click a model in the Project Management tree.
Before using this command, you must first install third-party software and integrate the software
with Smart 3D. For more information, see Point Cloud User's Guide, available using Help >
Printable Guides.
From the Point Cloud Model Reference dialog box, select the required vendor to reference as
the source for the point cloud data. Use point cloud data from only one vendor at a time with a
Smart 3D model.

Point Cloud Properties Dialog Box (on page 45)

What do you want to do?

 Reference a point cloud (on page 44)
 Modify reference point cloud (on page 45)
 Remove a point cloud reference (on page 45)

Project Management User's Guide 43

 Create Reference Models

Reference a point cloud

Load the point cloud vendor software on your computer before referencing it from Project
Management.
1. In the Project Management tree view, right-click the model icon, and then select New Point
Cloud Model Reference.
The Point Cloud Model Reference dialog box displays.
2. Select the vendor to use, and then click Register.

3. In the Point Cloud Properties dialog box, click Browse to select a point cloud vendor
source file for Point Cloud Source.

Project Management User's Guide 44

 Create Reference Models

4. Click OK.

 You can register multiple point cloud vendors separately. Based on the vendor selection, the
appropriate vendor specific dialog box displays.
 For CloudWorx, the Import Point Cloud Data dialog box displays. You can select either
model space view or jetstream point cloud source as needed.
 You can see the status of the vendor as Registered under the Status column in the Point
Cloud Model Reference dialog box. The options Register and Unregister change
dynamically based on the vendor status.
 When defining the workspace, the point cloud displays on the New Filter Properties dialog
box on both the Point Cloud tab and Object Type tab. When the point cloud is defined, it
displays in Smart 3D on the Workspace Explorer view. Vendor-specific commands display
on the Accessories menu.

Modify reference point cloud

1. In the Project Management tree view, right-click the model icon, and then select New Point
Cloud Model Reference.
The Point Cloud Model Reference dialog box displays.
2. Select the registered vendor to modify, and then click Properties.
The Point Cloud Properties dialog box displays.
3. Modify the required properties.
4. Click OK to save the changes.

Remove a point cloud reference

1. In the Project Management tree view, right-click the model icon, and then select New Point
Cloud Model Reference.
The Point Cloud Model Reference dialog box displays.
2. Select the vendor to unregister, and then click Unregister.

Point Cloud Properties Dialog Box

Defines properties associated with the referenced point cloud vendor.
If the point cloud vendor does not support point cloud transformation, the software
deactivates options related to transformation.
Point Cloud Vendor
Specifies a point cloud vendor name.
Point Cloud Source
Specifies the path or location of the point cloud vendor source file. For example, files with
extension *.imp represent Leica CloudWorx.

Project Management User's Guide 45

 Create Reference Models

 You can register (attach) the point cloud models at the satellite location. The software
replicates the data related to the point cloud model in the database from the host to the
satellite. The software does not automatically copy file paths, point cloud source, and
transformation details to and from the host and satellite locations. You can modify the
file path for the point cloud models at the satellite location so that the point cloud files
can be accessed from the local satellite folders.
 Copy the files to the satellite location to keep the point cloud data synchronized. Verify
that the point cloud vendor software and other related software are installed at the host
and satellite locations.
 Specify a complete path for the folder. The software does not accept a relative path
such as a path relative to the SharedContent symbol share folder.
 The software does not synchronize changes made to and from the reference points,
rotation of the points, and a target point at the host location with the points available at
the satellite location.
Reference Point
Specifies easting, northing, and elevation of a point in the source reference model relative to
the global coordinate system origin (0, 0, 0) of the active model. This point could be
considered as the origin or anchor point of the reference model used to position and orient
the reference model in the active model coordinate space. The easting, northing, and
elevation of the reference point can be specified in any of the supported units.
 Easting - Specifies the easting coordinate to position the reference point cloud model.
 Northing - Specifies the northing coordinate to position the reference point cloud model.
 Elevation - Specifies the elevation coordinate to position the reference point cloud
model.
Point Cloud Model Transformation
Specifies the rotation angles, scale factor, and move vector that the software uses in the
transformation. These values are related to the global coordinate system.
Rotation
Rotates the reference point cloud model. Rotation is calculated around the origin of the
attached point cloud model (reference point). The software measures rotation in the
clockwise direction from the North axis.
 East Angle (deg) - Specifies the angle in degrees to rotate the reference point cloud
model about the east axis of the active model.
 North Angle (deg) - Specifies the angle in degrees to rotate the reference point cloud
model about the north axis of the active model.
 Up Angle (deg) - Specifies the angle in degrees to rotate the reference point cloud
model about the up axis of the active model.
Target Point
Specifies the position of the reference point cloud model.
 East Distance - Specifies the distance east to position the reference point cloud model.
 North Distance - Specifies the distance north to position the reference point cloud
model.

Project Management User's Guide 46

 Create Reference Models

 Up Distance - Specifies the up distance to position the reference point cloud model.

Reference 3D Model
Database > New > Reference 3D Model facilitates the attachment of external 3D data to the
Smart 3D model as a reference. You can also access this command by selecting New
Reference 3D Model from the shortcut menu when you right-click a model or the Reference 3D
Models folder in the Project Management tree.
The external data might have been published from another Smart 3D model or from a third-party
model such as PDMS. The data from external models must be a set of graphic (.zvf) and data
(.xml or .drv) files.
This command significantly augments the current global workshare solution, because it does not
require replicated databases. With Reference 3D (R3D) you can do the following:
 Attach and orient (position, rotate, and scale) the R3D model relative to the active model so
that you can view the reference model data graphically and model against it.
 Control (add) R3D objects, hierarchy, and properties with user-defined schema and mapping
files to extend the delivered R3D schema.
 Inspect the R3D model objects' properties and view their names through Tool Tips.
 Use a Smart 3D filtering mechanism to filter objects from R3D models based on their type,
regardless of the authoring tool used for creation.
 Extract simple general arrangement drawings showing relative positioning of objects from
R3D models, with limited annotation.

Key Advantages
Supports disconnected workshares
Because you publish the data to files at the source site and attach as a reference at the
target site, the software does not require a live connection between the databases. Periodic
publish and update of the R3D models would allow multiple partners to work on a joint
venture product in a disconnected manner.
Preserves intellectual property in joint venture projects
The publisher can control the quality of published information which can protect intellectual
property of individual firms participating in joint venture projects. In addition, sensitive data
such as piping specifications are not published.
Allows for better security in joint venture projects
This solution allows for better security because trusted network connectivity is not required.
Published files can be transferred using any appropriate mechanism.
Provides compatibility between datasets from different Smart 3D versions
You can publish 3D model data to a relatively neutral format that allows mapping. Therefore,
data from different versions of Smart 3D can be mixed and matched.
Bridges differences between Smart 3D datasets on disparate databases
Because the data is published to a set of files, the underlying database platform (MS SQL
Server or Oracle) is not a concern.

Project Management User's Guide 47

 Create Reference Models

Work with datasets from external tools such as PDMS and XMpLant
Data from other tools such as PDMS and XMpLant can be translated to the format
recognized by R3D and then referenced into Smart 3D. This allows for heterogeneous tools
to be used on a single project.
Supports parallel design for increased productivity
If a project has many similar units, only one unit can be modeled and published. This
published unit can then be attached multiple times with the required positioning. Additional
modeling such as civil work can be performed simultaneously on all the units by working
with the references. In addition, if the original unit is changed, using R3D can be more
productive because R3D is more flexible for updates. When the original unit is completed,
Model data reuse functionality can be used to replicate the unit to obtain real Smart 3D
objects.

 You can attach R3D models at the host and at the satellite. You must create an R3D model
at the host location before you can attach a model at the satellite location.
 The software does not automatically copy files from the host to the satellite location. The file
path for the R3D models can be modified at the satellite location so that the graphic files
(.zvf files) can be accessed from the local satellite folders. However, the files must be copied
to the satellite location by other means to keep the folders synchronized.
 You must specify the complete path to the folder. The software does not accept a relative
path such as a path relative to the symbol share.

R3D Schema
The R3D schema is a light-weight schema that includes the basic classes and their
properties. The R3D schema is based on the P3D schema, which is the schema used to publish
Smart 3D data to SmartPlant Foundation. The R3D schema represents a subset of the P3D
schema. The delivered R3D schema contains discipline-specific R3D objects, their hierarchy,
and basic properties.
The properties of the R3D schema classes are grouped into interfaces for logical access. In
addition to specifying classes and their properties, the R3D schema allows you to meld these
new classes into the Smart 3D business object classification hierarchy so that all these classes
may be presented in an organized fashion for filtering.
Classes and properties from other tools can be mapped to the classes and properties in the
R3D schema by specifying such mapping in a simple Excel spreadsheet. You may customize
the delivered mapping file to modify or add classes or properties. In addition to the standard
delivered schema, Smart 3D also allows you to extend the schema through customization. For
more information, see Custom Schema and Mapping Files (on page 59).

Project Management User's Guide 48

 Create Reference Models

Transformation
The R3D model can be oriented and positioned using transformation, which allows rotation and
scaling relative to the reference point and to the point location of the target.

Transformation and SmartPlant Interop Publisher

If you have SmartPlant Review and Smart 3D applications, you can change transformation
settings in one application, and then see the resulting change in the other application through
SmartPlant Interop Publisher. You can attach a smart model translated from the SmartPlant
Interop Publish application as a Reference 3D model in Smart 3D, and then opened as a 3D
project in SmartPlant Review. The .iop file generated by SmartPlant Interop Publisher allows
transformation settings to be shared between applications. SmartPlant Interop Publisher creates
an .iop text file when you translate a model and places the .iop file the same folder as the
generated Smart Model .zvf file. You can then change transformation settings in one application
and the software propagates the changes to the other applications.
To see transformation changes made in SmartPlant Interop Publisher, select the Reference 3D
model in the Project Management tree view, open the Properties dialog box in Smart 3D, and
then click Apply. For information on defining transformation settings in SmartPlant Interop
Publisher, see Move, Rotate, and Scale (Transform) Smart Models in the SmartPlant Interop
Publisher User's Guide. For more information on the transformation settings in Smart 3D, see
New Reference 3D Model Dialog Box (on page 55).

 To translate third-party data such as PDMS and MicroStation V8 to .zvf files, you must have
a SmartPlant Review Publisher license or a SmartPlant Interop Publisher translation (SRP)
license. However, it is not required that either of these applications be installed on the
computer performing the translation.
 For translating MicroStation V8 .dgn files, you must also have MicroStation V8, V8 XM, or
V8i installed on the computer performing the translation.

Project Management User's Guide 49

 Create Reference Models

 Reference 3D models that contain tessellated data take a significant amount of time for
interference checking to process. For faster performance, do not include these models in
interference detection.

New Reference 3D Model Dialog Box (on page 55)

Reference 3D Model Properties Dialog Box (on page 58)

Custom Schema and Mapping Files (on page 59)

Reference 3D Tools (on page 63)

What do you want to do?

 Attach a Reference 3D model (on page 50)
 Modify a Reference 3D model (on page 51)
 Detach a Reference 3D model (on page 53)
 Update multiple Reference 3D projects (on page 53)

Attach a Reference 3D model

1. In Project Management, select the model to attach as the reference model.
2. Click Database > New > Reference 3D Model.
-OR-
Right-click the model node, and select New Reference 3D Model.
-OR-
Right-click the Reference 3D Models node in the Project Management tree view; and select
New Reference 3D Model.
The New Reference 3D Model dialog box displays.
3. Define model information in the boxes, and click OK.
The software examines the Reference 3D and the CustomReference3D schema packages
to see if they require updating. The process of creating and updating the schema packages
can take several minutes, so an informational progress form displays during this time.
4. Click Yes to confirm that the schema packages should be updated.
Updating the Reference 3D or the CustomReference3D schema packages
causes other Reference 3D models which are attached to any Smart 3D models that use the
same catalog database to be displayed as out of date. A Reference 3D model can also
become out of date if any of the input files in the Reference 3D folder are updated. The

Project Management User's Guide 50

 Create Reference Models

following example shows the icon displayed in the Project Management tree view for an out-
of-date Reference 3D model:

The software reads the files containing Reference 3D data and then populates the model
database. If any data files are missing, the Reference 3D Model data form displays.
5. Verify that the correct type is selected and that all files have been copied to the folder. Click
Yes to confirm that the process of loading the data should continue.
You must either start a new Smart 3D session or save and reopen an existing
session to see the new Reference 3D model graphics. For further modifications, you can refresh
the workspace to see any updated objects and data.

Modify a Reference 3D model

1. In Project Management, select the Reference 3D model to modify.
2. Click the Properties button on the toolbar.
-OR-
Click Edit > Properties in the toolbar.
-OR-
Right-click to open the context menu, and then click Properties .
The Reference 3D Model Properties dialog box displays.
3. Modify the required properties.

 If the Reference 3D model shows as Out of Date (such as when an attached file is
updated or an R3D schema version is increased), or if changes that do not trigger an
Out of Date notification occur (such as adding new files into folders or removing files),
you must reimport the R3D model data by clicking Update. If you change the mapping,
use the second option to force the update of all Reference 3D models.
 When you make transformation changes to a Smart Model .zvf file from the SmartPlant
Interop Publisher application, the Out of Date status does not display. To see
transformation changes made in SmartPlant Interop Publisher, select the Reference 3D
model in the tree view, open the Properties dialog box in Smart 3D, and then click
Apply. The software refreshes transformation values and displays the current changes.
4. If you changed the Reference 3D schema or updated, added, or removed the .zvf files, click
Reference 3D Model data has been updated... (files added, removed, or modified).

Project Management User's Guide 51

 Create Reference Models

5. If there were no indicated changes but an import of the R3D data is necessary, click Force
Update all Reference Files (Including those not modified).
The software rescans all subfolders listed in the path. It then updates, adds, or removes
individual .vue files within the File Path, and then reimports the modified data or added files.

 If you modify the .zvf file which was already attached, the Out of date reference 3D
model notification displays in the Reference 3D hierarchy. The software processes new
files along with modified ones, and then updates data.
 You can use Force Update all Reference Files when, for example, the mapping file
was modified or the data file was alternated without updating the corresponding graphic
file(s).
6. Optionally, assign a Permission Group that applies to the Reference 3D model at the
object level.
For global workshare operations:
 Assignment at host - If you create a Reference 3D model at the host location, you can
assign a permission group to the model which can belong to the host or any of the
satellites.
 If you assign a permission group to a Reference 3D model created at the host that
belongs to the host location itself, only users at the host location with sufficient
access permissions can modify objects in the model.
 If you assign a permission group to a model created at the host that belongs to a
satellite location, only the users at that satellite location with sufficient access
permissions can modify the Reference 3D model objects.
 Assignment at satellite - If you create a Reference 3D model at a satellite location, only
the permission groups that belong to that satellite location can be assigned. A
permission group that belongs to the host or to other satellite locations cannot be
assigned to a Reference 3D model created at that satellite location.
7. Click Apply or OK to apply the changes.
The software examines the Reference 3D and the CustomReference3D schema packages
to see if they require updating. The process of updating the schema packages can take
several minutes, so an informational progress form displays during this time.
If you are using a Smart Model from the SmartPlant Interop Publisher application as your
Reference 3D model, any changes to transformation settings made in the SmartPlant
Interop Publisher application automatically display when you click Apply in the Properties
dialog box.
8. Click Yes to confirm that the schema packages must be updated.
Updating the schema packages causes other Reference 3D models attached to
any Smart 3D models that use the same catalog database to be out of date. A Reference
3D model can also become out-of-date if any of the input files in the Reference 3D folder are

Project Management User's Guide 52

 Create Reference Models

updated. The following example shows the icon that displays in the Project Management
tree view for an out-of-date Reference 3D model:

The software reads the files containing Reference 3D data, and populates the model
database. If any data files are missing, the Reference 3D Model dialog box displays. Click
Yes to continue loading.

Detach a Reference 3D model

1. In Project Management, select the Reference 3D model to detach.
2. Click Delete in the toolbar.
You can also access the Delete command by right-clicking to open a shortcut menu
or by selecting Edit > Delete.
3. Click Yes on the Detach Reference 3D Model dialog box to detach the model.
The software detaches the Reference 3D model; however, the software does not delete the
model files.
Detaching the existing Reference 3D model can cause some loss of data,
primarily associations with Smart 3D objects and impacts to existing drawings. Therefore,
exercise caution before detaching. Reattaching the same data does not fix the deleted
associations.

Update multiple Reference 3D projects

 You must configure the batch queues before scheduling a batch job using the Update
Reference 3D Model(s) command. The batch job is submitted to the Project Management
queue on the batch server.
 Verify that the folder C:\Windows\sysWOW64\config\systemprofile\Desktop exists if you are
using Windows 7 (64-bit) or Windows Server 2012 R2. Have your system administrator
create the Desktop folder with full permissions if it does not exist. Excel does not function
properly without this desktop folder; therefore the Reference 3D projects will not update in
batch.
1. Open Project Management and select the Reference 3D Models node in the tree view.
2. Right-click and select Update Reference 3D Model(s). You can also click Edit > Update
Reference 3D Model(s).
The Reference 3D Batch Update dialog box displays the Reference 3D models that are

Project Management User's Guide 53

 Create Reference Models

attached at the current location.

3. Select the Reference 3D projects to update.

 A Reference 3D project that is out of date is italicized and is represented by .

 A Reference 3D project that is up to date is represented by .
4. If necessary, select Synchronize S3D Model with R3D to update the Smart 3D model
objects that have relationships with objects in the selected Reference 3D models. The
software ignores this option if you use Submit Job to batch process.
Selecting the Synchronize S3D Model with R3D option is not a common
workflow.
5. Click Submit Job.
The job is scheduled to run on a preconfigured queue.
-OR-
Click Update.

Project Management User's Guide 54

 Create Reference Models

The projects updates.

 Steps updated successfully are indicated by .

 Steps that failed to update are indicated by .

6. Click Close.

New Reference 3D Model Dialog Box

Defines properties associated with the 3D model that you are referencing.
One Reference 3D model cannot be compounded with another Reference 3D model.
Model Name
Specifies a model name.
Description
Specifies a description of the model.
Model Type
Indicates the authoring tool used to create a referenced model. The following options are
available:
 S3D - Use this option for a 3D model generated from Smart 3D in .zvf and .xml format.
 PDMS - Use this option for a Reference 3D model converted to .zvf and .drv from
PDMS files in .rvm and .att formats.
 PDS - Use this option for a 3D model generated from PDS as legacy SPR data in .drv
and .dgn graphics converted to .zvf or published PDS data in .zvf and .xml format. Each
option uses a different set of mapping files.
 Generic - Use this option for all Reference 3D models with data files in the standard
.drv format. Generic schema and mapping files might be required using the delivered

Project Management User's Guide 55

 Create Reference Models

Generate Mapping Tool utility. For more information, see Use the GenerateMapping
tool (on page 65).
 SmartPlant Interop Publisher - Use this option for all Reference 3D models with data
files generated from the SmartPlant Interop Publisher application. This option reads .zvf
and .mdb2 files created from SmartPlant Interop Publisher to persist graphic data,
mapped property data, and relationships. If you have added new classes, interfaces,
and properties using the customized mapping files from SmartPlant Interop Publisher,
you must create the CustomR3DSchema.xls file, and place it in the
Reference3DComponents subfolder of the SharedContent folder. For more information,
see Custom Schema and Mapping Files (on page 59).
 Graphic_Only - Use this option for all Reference 3D models that do not have data files.
 CADWorx - Use this option for all reference 3D models with data files in the .dwg format
generated from CADWorx, and then published by SmartPlant Review Publisher. Sample
schema and mapping files are delivered with Smart 3D.
Interference Detection
Indicates whether the Reference 3D model participates in interference detection.
Reference 3D models that contain tessellated data take a significant amount of
time for interference checking to process. For better performance, do not include these
models in interference detection.
File Path
Specifies the path or location of the Reference 3D folder. You can create and organize
subfolders for additional levels of filtering and level/layer control.
The software only supports .zvf graphic files with corresponding data in .xml or
.drv files.
If the Reference 3D data is not common or requires individual mapping, the respective
mapping (and optional schema.xls files) can be copied to the Reference 3D model folder. In
this case, data is processed according to these files. Otherwise, the software uses default
mapping and schema files from the SharedContent folder.

Reference Point
Specifies easting, northing, and elevation of a point in the source reference model relative to the
global system origin (0,0,0) of the active model. This point could be considered as the origin or
anchor point of the reference model that would be used to position and orient the reference
model in the active model coordinate space. The easting, northing and elevation of the
reference point can be specified in any of the supported units.
Easting
Specifies the distance east to position the Reference 3D model.
Northing
Specifies the distance north to position the Reference 3D model.
Elevation
Specifies the up distance to position the Reference 3D model.
Units
Specifies the units of measure for calculating the move. You can select the units of measure

Project Management User's Guide 56

 Create Reference Models

from the list. The default is meters (m).

Selection of the distance unit is temporary. It is used for the current positioning
only, and it is not stored in the database or any session defaults. If you select units other
than the default (m), be sure to select the same units for subsequent modification to obtain
correct results.

Transformation
Specifies the rotation angles, scale factor, and move vector that the software uses in the
transformation. These values are related to the global coordinate system.
If you are using a Smart Model from SmartPlant Interop Publisher as your Reference
3D model:
 Make sure the <Smart Model name>.iop file is in the same folder location as the Smart
Model .zvf file which you specify in the File Path option. Otherwise, the software does not
update any changes you make to transformation settings. SmartPlant Interop Publisher
generates the .iop file and allows transformation settings to be shared and updated between
applications.
 When you collect multiple Smart Models in one folder hierarchy and attach them as a
Reference 3D model, Smart 3D uses the transformation settings from only the first Smart
Model (in alphanumeric order) to control the transformation of the entire Reference 3D
model. If you change the Reference 3D transformation settings in Smart 3D, this change
only affects that Smart Model, and not any others in the designated folder. You can see the
transformation changes from Smart 3D in SmartPlant Interop Publisher and SmartPlant
Review. We recommend that you organize Smart Models having the same transformation
settings in the same folder hierarchy. Otherwise, place each Smart Model in its own folder.
Rotation
Rotate the Reference 3D model. The software calculates rotation around the origin of the
attached 3D model (the reference point). A positive rotation is in the clockwise direction from
the North axis.
 East Angle (deg) - Specifies the angle in degrees to rotate the Reference 3D model
about the east axis of the active model.
 North Angle (deg) - Specifies the angle in degrees to rotate the Reference 3D model
about the north axis of the active model.
 Up Angle (deg) - Specifies the angle in degrees to rotate the Reference 3D model
about the up axis of the active model.
Scale Factor
Specifies the scale factor for the Reference 3D model relative to the active model. Scale is
applied relative to the specified Reference Point. The scale factor is initialized to 1.0 by
default, and this scale factor works for Smart 3D models. For other types of models, apply
an appropriate scale factor.
Target Point
Use to specify the position of the Reference Point of the transformed model in the Smart 3D
model.
 Easting - Specifies the distance east to position the Reference 3D model.
 Northing - Specifies the distance north to position the Reference 3D model.

Project Management User's Guide 57

 Create Reference Models

 Elevation - Specifies the elevation distance to position the Reference 3D model.

 Units - Specifies the units of measure for the previous coordinates. You can select the
units of measure from the list. The default is meters (m).
Selection of the distance unit is temporary. It is used for the current positioning only,
and it is not stored in the database or any session defaults. If you select units other than the
default (m), select the same units for subsequent modification to obtain correct results.

Reference 3D Model Properties Dialog Box

Defines properties associated with the 3D model that you are modifying.
Model Name
Specifies a model name.
Description
Specifies a description of the model.
Model Type
Indicates the authoring tool used to create a referenced model. The following options are
available:
 S3D - Use this option for a 3D model generated from Smart 3D in .zvf and .xml format.
 PDMS - Use this option for a Reference 3D model converted to .zvf and .drv from
PDMS files in .rvm and .att formats.
 PDS - Use this option for a 3D model generated from PDS as legacy SPR data in .drv
and .dgn graphics converted to .zvf or published PDS data in .zvf and .xml format. Each
option uses a different set of mapping files.
 Generic - Use this option for all Reference 3D models with data files in the standard
.drv format. Generic schema and mapping files might be required using the delivered
Generate Mapping Tool utility. For more information, see Use the GenerateMapping
tool (on page 65).
 SmartPlant Interop Publisher - Use this option for all Reference 3D models with data
files generated from the SmartPlant Interop Publisher application. This option reads .zvf
and .mdb2 files created from SmartPlant Interop Publisher to persist graphic data,
mapped property data, and relationships. If you have added new classes, interfaces,
and properties using the customized mapping files from SmartPlant Interop Publisher,
you must create the CustomR3DSchema.xls file, and place it in the
Reference3DComponents subfolder of the SharedContent folder. For more information,
see Custom Schema and Mapping Files (on page 59).
 Graphic_Only - Use this option for all Reference 3D models that do not have data files.
 CADWorx - Use this option for all reference 3D models with data files in the .dwg format
generated from CADWorx, and then published by SmartPlant Review Publisher. Sample
schema and mapping files are delivered with Smart 3D.
Interference Detection
Indicates whether the Reference 3D model participates in interference detection.
Reference 3D models that contain tessellated data take a significant amount of
time for interference checking to process. For better performance, do not include these

Project Management User's Guide 58

 Create Reference Models

models in interference detection.

File Path
Specifies the path or location of the Reference 3D folder. You can create and organize
subfolders for additional levels of filtering and level/layer control.
The software only supports .zvf graphic files with corresponding data in .xml or
.drv files.
Permission Group
Specifies object level modifications to Reference 3D models such as excluding and
including an element in Smart 3D, and changing construction properties. However, the
defined model permissions control new Reference 3D model attachment, detachment, and
update operations. If you do not assign a permission group to a model, the model
permissions control the operations on Reference 3D model objects. The menu list displays
the permission groups that have been created for the model.

Custom Schema and Mapping Files

Smart 3D provides the definition of classes, interfaces, properties, and mappings for a basic set
of items common to most Reference 3D models. You can extend the delivered Reference 3D
schema to include the addition of new classes and properties, and to extend the classification
hierarchy with these new classes. These extensions and their mappings are specified in Excel
.xls spreadsheets.

Customized Schema File

CustomReference3D adds customized classes, interfaces, properties, and mappings to the
Smart 3D schema. These additions define items and their attributes in a Reference 3D model.
CustomR3DSchema.xls contains the definitions of the classes, interfaces, properties, and
classification nodes you want to add to the schema definition. If you create this file, place it in
the Reference3DComponents subfolder of the SharedContent folder. A template file is delivered
in the [Reference Data Product Folder]\SharedContent\Data\
Reference3DComponents\Templates folder.
To add new object types or properties, copy this file to the Reference3DComponents folder of
the active SharedContent folder for the respective catalog. Modifications to the template impact
all Reference 3D models attached to the active model and other models sharing the same
catalog. If you make modifications to the template, increase the version number on the
PackageInformation sheet.

Customized Mapping File

CustomP3DtoR3Dmapping contains unmapped properties that come from the reference source
and do not have matching properties in the Reference 3D schema. They have source
information but no target information. When encountered in the input data, unmapped properties
identified in the custom mapping file are assigned to Reference 3D objects.
CustomP3DtoR3Dmapping.xls contains the class-to-class and interface/property-to-
interface/property mapping required to map classes and properties from Smart 3D schema to
classes and properties in the Reference 3D schema. A template file is delivered in the
[Reference Data Product Folder]\SharedContent\Data\Reference3DComponents\Templates
folder. To use this template file, place it in the same folder as the .zvf and .xml/.drv input files of
the respective R3D model. Changes there are specific to an individual Reference 3D model.

Project Management User's Guide 59

 Create Reference Models

When publishing through SmartPlant integration, the data model published from
Smart 3D is called the P3D schema.

The Rules
 New classes, interfaces, and properties can be added in the CustomReference3D schema.
 An interface can be added to a class in either the delivered Reference3D package or the
user-defined CustomReference3D package.
 A new property cannot be added to an existing interface defined in the delivered
Reference3D package.
 An existing property defined in the delivered Reference3D package cannot be modified or
deleted from its interface.
 Any mapping defined in the delivered mapping files cannot be overwritten.
For example, suppose a mapping exists between an interface/property pair defined in the
P3D schema and an interface/property pair defined in the R3D schema. You cannot replace
that mapping with one the interface/property pair defined in the P3D schema and a new
interface/property pair defined in the CustomP3DSchema. If the
CustomP3DToR3DMapping.xls workbook contains such overwrite, it is ignored during the
data import and logged as a warning.
 Any mapping defined in the delivered mapping files cannot be removed.
 The delivered mapping files cannot be edited. The software ignores any changes you make.
You can add required mapping by creating a CustomP3DToR3DMapping.xls file as
defined above.
You can add a new property to an existing class that is defined in either the delivered Reference
3D package or the customized CustomReference3D package defined in
CustomR3DSchema.xls. Create a new line on the following worksheets:
1. Define a new class in the Custom Reference 3D package. For more information, see
Classes Worksheet (on page 61).
2. Define a new interface in the CustomReference3D package. For more information, see
Interfaces Worksheet (on page 61).
3. Define the new property of the new interface in the CustomReference3D package. For more
information, see InterfaceAttributes Worksheet (on page 62).
4. Define in the CustomReference3D package that the class implements the new interface. For
more information, see ClassInterfaces Worksheet (on page 61).
5. Define a Business Object Classification (BOC) node in the Custom Reference 3D package.
For more information, see BOCNodes Worksheet (on page 62).
6. Define in the CustomReference3D package the interface that identifies the new BOC node.
For more information, see BOCDefiningInterfaces Worksheet (on page 63).

Project Management User's Guide 60

 Create Reference Models

Classes Worksheet
Describes user-defined classes in CustomR3DSchema.xls.
ClassName
Specifies the name of the class.
UserName
Specifies the name of the class as it displays in the software.
DBTableName
Specifies the name of the table in the database required to persist data for this class.
DBViewName
Specifies the name of the view in the database where this class is exposed.
GUID
Specifies the unique identifier of this class.

ClassInterfaces Worksheet
Describes user-defined class interfaces.
ClassName
Specifies the name of the class that implements the new interface.
InterfaceName
Specifies the name of the interface. It must match the InterfaceName value on the
Interfaces sheet.
InterfaceGUID
Specifies a unique identifier of the interface. It must match the Globally Unique Identifier
(GUID) value on the Interfaces sheet.

Interfaces Worksheet
Describes user-defined interfaces.
InterfaceName
Specifies the name of the interface.
UserName
Specifies the name of the interface as it displays in the software.
CategoryID
Not used.
DBViewName
Specifies the name of the database view in which this interface is exposed.

Project Management User's Guide 61

 Create Reference Models

GUID
Specifies the unique identifier of this interface.

InterfaceAttributes Worksheet
Describes user-defined interface attributes.
InterfaceName
Specifies the name of the interface that has this property.
AttributeName
Specifies the name of the property.
UserName
Specifies the name of the property.
DispID
Specifies a sequence ID for the property. This must be an integer that is unique among the
properties of an interface. The properties display on the property page in this sequence.
Type
Specifies the code for the type of property.
DBColumnName
Specifies the name of the column in the interface table or view in which this property is
stored or exposed.
GUID
Specifies a unique identifier for this property.

BOCNodes Worksheet
Describes user-defined Business Object Classification (BOC) nodes.
BOCNodeName
Specifies the name of the BOC node.
UserName
Specifies the name of the BOC node as it displays in the software.
GUID
Specifies the unique identifier of this BOC node.

Project Management User's Guide 62

 Create Reference Models

BOCDefiningInterfaces Worksheet
Describes the interfaces that define the user-defined BOC nodes.
BOCNodeName
Specifies the name of the BOC node.
DefiningInterfaceName
Specifies the name of the interface that defines the BOC node.
DefiningInterfaceGUID
Specifies the unique identifier of the defining interface.

Reference 3D Tools
To aid in the administration of reference models and the management of data from other
sources, Reference 3D provides two tools: ConvertToZVF and GenerateMappingTool.

ConvertToZVF Tool
Reads graphic information from diverse sources and generates .zvf format files which can be
read by Reference 3D. The .zvf files are the standard format of graphics files read by the
Reference 3D component.
The ConvertToZVF.exe tool is located in the [Product Folder]\Core\Tools\Administrator\Bin
folder.

 To translate third-party data such as PDMS and MicroStation V8 to .zvf files, you must have
a SmartPlant Review Publisher license or a SmartPlant Interop Publisher translation (SRP)
license. However, it is not required that either of these applications be installed on the
computer performing the translation.
 For translating MicroStation V8 .dgn files, you must also have MicroStation V8, V8 XM, or
V8i installed on the computer performing the translation.
 Reference 3D models that contain tessellated data take a significant amount of time for
interference checking to process. For faster performance, do not include these models in
interference detection.
The ConvertToZVF tool supports the following file formats:
 ACIS (.sat)
 ALIAS ISOGEN (.idf and .pcf)
 AutoCAD (.dwg)
 Intergraph VUE (.vue)
 MicroStation V7, V8 and V8i, AutoPlant and PlantSpace (.dgn and .dtm)
 PDMS (.rvm)
 PDS Frameworks plus (.prp)
To use ConvertToZVF, edit the [Product Folder]\Core\Runtime\SPFSPRB\Translator.ini settings
under [MICROSTATION Options] to set the CADPlatform Path to find the ustation.exe

Project Management User's Guide 63

 Create Reference Models

(MicroStation) path and CADPlatform Version to the corresponding version number of

ustation.exe.
For example:
[MICROSTATION Options]
CADPlatform Version = xx.xx.xx.xx
CADPlatform Path = [MicroStation Product
Folder]\Bentley\MicroStation\ustation.exe
For more information, see Translator.ini File Options (on page 65).

Generate Mapping Tool

Generates the mapping and schema files that are used to attach a model in Project
Management.
 The generated mapping file GenericToR3DMapping.xls lists source classes and their
properties. You must specify additional information for mapping, such as target class, source
interface, target interface, and target property after the file is generated.
 The generated schema file GenericSchema.xls lists the class names and their properties.
These files are required for each project and must reside in the project when the model is
attached in Project Management.
GenerateMappingTool.exe is located in [Product Folder]\Core\Tools\Administrator\Bin folder.

What do you want to do?

 Use the ConvertToZVF tool (on page 64)
 Use the GenerateMapping tool (on page 65)

Use the ConvertToZVF tool

To convert data from third-party tools such as PDMS, you must have a SmartPlant
Review Publisher or SmartPlant Interop Publisher license.
1. Run [Product Folder]\Core\Tools\Administrator\Bin\ConvertToZVF.exe.
The ConvertToZVF dialog box displays.
2. Define the following information:
 Input Folder – Specify the folder that contains the input files.
 Output Folder – Specify the folder to which the new .zvf files are written.
3. Click Convert to generate the output .zvf graphics files.
One .zvf file is created for each input graphic data file.
ConvertToZVF can also be executed from the command line with the following
arguments:
ConvertToZVF –i <input folder path> -o <output folder path>

Project Management User's Guide 64

 Create Reference Models

Use the GenerateMapping tool

1. Run [Product Folder]\Core\Tools\Administrator\Bin\GenerateMappingTool.exe.
The GenerateMappingTool dialog box displays.
2. Type the class identifying label, which is the property name in the .drv files that corresponds
to the class names.
3. Type the input folder location, or click Browse to navigate to the input folder that contains
the .DRV files.
4. Type the output folder location, or click Browse to navigate to the output folder, in which the
mapping and schema files are generated.
5. Click Generate.
The status bar of the tool shows the state of the generating process.
6. After the files generate, click Open Map to display the mapping file.
7. Edit the mapping file to provide additional information for mapping such as target class,
target interface, and target property.
8. Click Open Schema to display the schema file.

Translator.ini File Options

The Translator.ini file provides Smart 3D the measurement units to use when translating files.
Translator.ini is divided into the supported graphics file types. Each type section defines
separate working units. If you do not modify the units setting in this file, the default output is in
meters. After making the necessary changes in the Translator.ini file, save it and republish the
project file to observe the log setting changes.
Translator.ini is located in [Product Folder]\Core\Runtime\SPFSPRB folder.
The main options provided in the Translator.ini file are described below.
For help in translating AutoCAD files, see Suggested Conversion Factors for
AutoCAD (on page 67) for recommendations.

Master Units
Possible values for the Master Units field:

Metric Values Units Denoted

59 = meters

61 = millimeters

62 = centimeters

63 = kilometers

Project Management User's Guide 65

 Create Reference Models

Imperial Values Units Denoted

64 = inches

65 = feet

66 = yards

67 = miles

Sub Units
Possible values for the Sub Units field are the same as those for the Master Units. The Sub
Units should be defined the same as the Master Units unless the Positional Units Per Master
Unit are greater than the conversion factor between the defined Master Unit and the defined
Sub Unit. For example, if the Master Units are in meters, then the Sub Units should also be in
meters. If the number of Positional Units Per Master Unit is 100, then the Sub Units should
be defined as centimeters. If the number of positional units per master unit is 1000, then the
Sub Units should be defined as millimeters.
For most situations, the Sub Units can be set equal to the Master Units to simplify
the equation.

Sub Units Per Master Units

Defines the actual conversion factor between the defined Sub Units and Master Units. For
example, if the Master Unit is defined as meters and the Sub Unit is defined as centimeters,
then this field MUST be defined as 100. If the Master Units and Sub Units are set to the same
unit type, then the Sub Units Per Master Units must be set to 1.

 To simplify, the Sub Units can be set equal to the Master Units, and Sub Units Per Master
Units set to 1.
 The Sub Units Per Master Units field can only have whole integer values (no decimals) of
1 or larger.

Positional Units Per Sub Unit

Defines the number of positional units in the model dataset that equals a single Sub Unit. A
positional unit is the smallest whole number (unit of resolution) used to represent model
coordinates in the dataset. Modify this value to scale your data as required.
Increase this value to scale your model data to be smaller in terms of the defined Master Units.
Decrease this value to scale your model data to be larger in terms of the Master Units. This
field can only have whole integer values (no decimals) of 1 or larger.

Display Proxy
In AutoCAD, to cancel the proxy translation, add the option below to the AutoCAD section:
Display Proxy Entities = 0
AutoCAD applications that create proxy objects must be able to export their graphics
into a standard AutoCAD file, or into another format that can be read by SmartPlant Review

Project Management User's Guide 66

 Create Reference Models

Publisher. Otherwise, the converters cannot read the graphics for display in SmartPlant
Review. An example of this is if graphic entities are generated using object enablers. If you have
AutoCAD formats that cannot be converted, please contact the application provider for a
solution to export the graphics into a readable format.

Client
Use the setting in this section to support multiple clients. Set the Client Code as SP3D or
SPRPub (SmartPlant Review Publisher).

Global Options
Enable Logging
If this option is set to 1, the software generates the log file in the Temp folder with the name
ReaderLogFile.txt. If the option is set to zero (0), then no log file is generated.
LogSetting
If this option is set to 1, the software generates a detailed log with the detailed information of
all the graphic objects in the file, such as handle information, color, and layer. If the option is
set to 0, the software only generates a summary of all the graphic objects, such as the
number of graphic objects that passed or failed.

Suggested Conversion Factors for AutoCAD

The information below provides suggested metric and imperial conversion factors when using
AutoCAD or MicroStation data files. The conversion factor has been commented out.
You can clear the Acis Conversion Factor and assign any factor (such as 1.0, or 25.4, or
1000.0)

AutoCAD Conversions

AutoCAD source file scaled for kilometers

[AutoCAD Options]
Master Units = 63
Sub Units = 63
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1
;Acis Conversion Factor = 1.0 // or 25.4 or 1000.0
AutoCAD source file scaled for centimeters
[AutoCAD Options]
Master Units = 62
Sub Units = 62
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1
;Acis Conversion Factor = 1.0 // or 25.4 or 1000.0
AutoCAD source file scaled for meters
[AutoCAD Options]
Master Units = 59
Sub Units = 59
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1
;Acis Conversion Factor = 1.0 // or 25.4 or 1000.0

Project Management User's Guide 67

 Create Reference Models

AutoCAD source file scaled for millimeters

[AutoCAD Options]
Master Units = 61
Sub Units = 61
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1
;Acis Conversion Factor = 1.0 // or 25.4 or 1000.0
AutoCAD source file scaled for Feet
[AutoCAD Options]
Master Units = 65
Sub Units = 65
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1
;Acis Conversion Factor = 1.0 // or 25.4 or 1000.0
AutoCAD source file scaled for Inches
[AutoCAD Options]
Master Units = 64
Sub Units = 64
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1
;Acis Conversion Factor = 1.0 // or 25.4 or 1000.0

Scaling Data Examples

This section lists some examples in setting up the working units and data scaling using the
Translator.ini file. See Translator.ini File Options (on page 65) for a description of the main
conversion options provided by the Translator.ini file.

No Scaling Required
If the source data is in known working units, then set up the working units to match those used
in the source data.
Source Data: 1 positional unit = 1 mm
Output: 1 positional unit = 1 mm
Settings:
Master Units = 61 (mm)
Sub Units = 61 (mm)
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1

Keep the Same Working Units But Scale Model Up

You have an AutoCAD file that was originally designed in millimeters, but Smart 3D sees all
distances scaled to meters. To remedy this, you can modify the AutoCAD section in the
translator.ini file as shown below:
[AutoCAD Options]
Master Units = 61
Sub Units = 61
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1

Project Management User's Guide 68

 Create Reference Models

The number 61 corresponds to millimeters. This tells Smart 3D that all AutoCAD files were
originally designed in millimeters and should be converted using the same value.

Conversion Between Imperial and Metric Unit Systems

The settings below are used by Smart 3D to perform limited conversions between systems. If
scaling other than the system conversion is required, adjust either the assumed source unit or
adjust the Positional Units Per Sub Unit (before rounding), as appropriate.
METRIC TO IMPERIAL
Convert from metric to miles to minimize round-off error.
 Source Data: 1 positional unit = 1 m
Settings:
Master Units = 67 (mile)
Sub Units = 67 (mile)
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1609 (1609.344 m per mi)
Source Data: 1 positional unit = 1 mm
Settings:
Master Units = 67 (mile)
Sub Units = 67 (mile)
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 1609344 (1609344 mm per mi)
IMPERIAL TO METRIC
Convert from imperial to kilometers to minimize round-off errors.
 Source Data: 1 positional unit = 1 ft
Settings:
Master Units = 63 (km)
Sub Units = 63 (km)
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 3281 (3280.839895 ft per km)
 Source Data: 1 positional unit = 1 in
Settings:
Master Units = 63 (km)
Sub Units = 63 (km)
Sub Units Per Master Units = 1
Positional Units Per Sub Unit = 39370 (39370.07874 in per km)

Project Management User's Guide 69

SECTION 4

Define Properties
The commands under Database > Define Properties create custom properties for your
databases.

Define Model Properties (on page 70)

Define Permission Group Properties (on page 72)

Define Permission Group Folder Properties (on page 74)

Define Model Properties

Database > Define Properties > Model creates custom properties for your model, such as a
contact person or project number. As you refine your model hierarchy, you will want to define
properties for the various items you create. For example, you may want to define a location
property for a selected model or add a completion date to a permission group.

 If you add custom attributes to the model, you must regenerate the model and catalog views
using the View Generator, and then regenerate the Reports database. For more
information, see View Generator (on page 411) and Regenerate Reports Database (on page
124).
 Before creating or updating properties, you should create at least one new model with
Database > New > Model.
For each custom property that you create for your model, you can indicate the data type. You
must select the correct data type for the kind of information that you are storing. For example,
typing dates or numeric data into string data types can create results that you do not want. If you
select UOM as the date type for the property, you must select the appropriate option from the
Unit Type list.
Custom properties defined with this command apply to all models in the site database.

Define Model Custom Properties Dialog Box (on page 71)

What do you want to do?

 Define a custom property for a model (on page 71)
 Delete a custom property from a model (on page 71)

Project Management User's Guide 70

 Define Properties

Define a custom property for a model

1. In Project Management, select the Models folder or a model in the tree view.
2. Click Database > Define Properties > Model.
The Define Model Custom Properties dialog box displays.
3. Click an empty row in the Property Name column, and type the name of the new property.
4. Click the Data Type cell, and select the appropriate data type from the drop down list.
5. Confirm the information that appears in the Unit Type column. If Data Type is set to UOM,
select a unit value.
6. To add other properties during this editing session, click Apply to save your work and
continue.
7. Click OK.

 Custom properties display on the Properties dialog box for a model.

 An asterisk highlights the next line on which you can add a property. The edit icon
displays when you add the property.

Delete a custom property from a model

1. In Project Management, select the Models folder or a model in the tree view.
2. Click Database > Define Properties > Model.
The Define Model Custom Properties dialog box displays.
3. Select the custom property you want to delete, and click Delete.
4. Click Yes in the confirmation box.
5. Click OK.
Deleting a custom property removes all the data assigned to that property in every
model database in the site.

Define Model Custom Properties Dialog Box

Adds properties that are associated with the selected model.
Property Name
Specifies a descriptive phrase for a custom property. The software specifies Name as a
property by default. Typical custom properties names include Owner and Description.
Data Type
Defines the data type. Select String, Long, Short, Float, Double, Date, and UOM (for unit
of measurement).
Unit Type
Defines the unit type to use for the UOM data type. The value is None for other data types.

Project Management User's Guide 71

 Define Properties

Delete
Removes the selected custom property from the schema. If you select Yes in the
confirmation box, all information assigned to that property is lost in every existing object.
You cannot use Undo to reverse this action.

Define Permission Group Properties

Database > Define Properties > Permission Group creates custom properties for a
permission group.
For each custom property that you create for your permission group, you can indicate the data
type. You must select the correct data type for the kind of information you are storing. For
example, typing dates or numeric data into string data types can create results that you do not
want. If you select UOM as the data type for the property, you must select the appropriate option
from the Unit Type list.
Custom properties defined with Permission Group apply to all permission groups of a model.

Define Permission Group Custom Properties Dialog Box (on page 73)

What do you want to do?

 Define a custom property for a permission group (on page 72)
 Copy a custom property for a permission group (on page 73)
 Delete a custom property from a permission group (on page 73)

Define a custom property for a permission group

1. Click Database > Define Properties > Permission Group.
The Define Permission Group Custom Properties dialog box displays.
2. Select the model in the list.
3. Click an empty row in the Property Name column, and type the name of the new property.
4. Click the Data Type cell, and select the appropriate data type from the drop down list.
5. Confirm the information that appears in the Unit Type column. If Data Type is set to UOM,
select a unit value.
6. To add other properties during this editing session, click Apply to save your work and
continue.
7. Click OK.

 Custom properties display on the Properties dialog box for a permission group.
 Permission group custom properties apply to all permission groups in the model.

Project Management User's Guide 72

 Define Properties

 An asterisk highlights the next line on which you can add a property. The edit icon
displays when you add the property.

Copy a custom property for a permission group

1. Click Database > Define Properties > Permission Group.
The Define Permission Group Custom Properties dialog box displays.
2. Click Copy From.
The Copy From dialog box displays.
3. Select the model containing the properties to copy.
4. Select one or more custom properties to copy.
5. Click OK to close the Copy From dialog box.
6. Click OK.

Delete a custom property from a permission group

1. Click Database > Define Properties > Permission Group.
The Define Permission Group Custom Properties dialog box displays.
2. Select the custom property to delete, and click Delete.
3. Click Yes in the confirmation box.
4. Click OK to return to Project Management.
Deleting a custom property removes all the data assigned to that property in every
permission group in the model.

Define Permission Group Custom Properties Dialog Box

Adds properties that are associated with all permission groups for the selected model.
Model
Specifies the model to work with.
Property Name
Specifies a descriptive phrase to name the custom property. Name is the default property.
Data Type
Defines the data type. Select String, Long, Short, Float, Double, Date, and UOM (for unit
of measurement).
Unit Type
Defines the unit type to use for the UOM data type. The value is None for other data types.
Delete
Removes the selected custom property from the schema. If you select Yes in the
confirmation box, all information assigned to that property is lost in every existing object.
You cannot use Undo to reverse this action.

Project Management User's Guide 73

 Define Properties

Copy From
Opens the Copy From Dialog Box (on page 76) so that you can copy custom properties from
another model.

Define Permission Group Folder Properties

Database > Define Properties > Permission Group Folder creates custom properties for
permission group folders. A permission group folder is a container in which you can store sets of
similar permission groups.
For each custom property that you create for your permission group folder, you can indicate the
data type. You must select the correct data type for the kind of information you are storing. For
example, typing dates or numeric data into string data types can create results that you do not
want. If you select UOM as the data type for the property, you must select the appropriate option
from the Unit Type list.
Custom properties defined with Permission Group Folder apply to all permission group folders
of a model.

Define Permission Group Folder Custom Properties Dialog Box (on page 75)

What do you want to do?

 Define a custom property for a permission group folder (on page 74)
 Copy a custom property for a permission group folder (on page 75)
 Delete a custom property from a permission group folder (on page 75)

Define a custom property for a permission group folder

1. Click Database > Define Properties > Permission Group Folder.
The Define Permission Group Folder Custom Properties dialog box displays.
2. Select the model in the list.
3. Click an empty row in the Property Name column, and type the name of the new property.
4. Click the Data Type cell, and select the appropriate data type from the drop down list.
5. Confirm the information that appears in the Unit Type column. If Data Type is set to UOM,
select a unit value.
6. To add other properties during this editing session, click Apply to save your work and
continue.
7. Click OK.

 Custom properties display on the Properties dialog box for a permission group folder.
 Permission group folder custom properties apply to all permission group folders in the
model.

Project Management User's Guide 74

 Define Properties

 An asterisk highlights the next line on which you can add a property. The edit icon
displays when you add the property.

Copy a custom property for a permission group folder

1. Click Database > Define Properties > Permission Group Folder.
The Define Permission Group Folder Custom Properties dialog box displays.
2. Click Copy From.
The Copy From dialog box displays.
3. Select the model containing the properties to copy.
4. Select one or more custom properties to copy.
5. Click OK to close the Copy From dialog box.
6. Click OK.

Delete a custom property from a permission group folder

1. Click Database > Define Properties > Permission Group Folder.
The Define Permission Group Folder Custom Properties dialog box displays.
2. Select the custom property you want to delete, and click Delete.
3. Click Yes in the confirmation box.
4. Click OK to return to Project Management.
Deleting a custom property removes all the data assigned to that property in every
permission group folder in the model.

Define Permission Group Folder Custom Properties Dialog

Box
Adds properties that are associated with all permission group folders for the selected model.
Model
Specifies the model to work with.
Property Name
Specifies a descriptive phrase to name the custom property. Name is the default property.
Data Type
Defines the data type. Select String, Long, Short, Float, Double, Date, and UOM (for unit
of measurement).
Unit Type
Defines the unit type to use for the UOM data type. The value is None for other data types.
Delete
Removes the selected custom property from the schema. If you select Yes in the

Project Management User's Guide 75

 Define Properties

confirmation box, all information assigned to that property is lost in every existing object.
You cannot use Undo to reverse this action.
Copy From
Opens the Copy From Dialog Box (on page 76) so that you can copy custom properties from
another model.

Copy From Dialog Box

Sets options for selecting a custom property to copy from another model.
Model
Lists all models defined in the site. Select the model containing properties to copy.
Permission group properties or Permission group folder properties
Displays the properties defined for the selected model. Select the properties to copy, using
the CTRL and SHIFT keys to select multiple properties.

Project Management User's Guide 76

SECTION 5

Edit Properties
Displays the properties and property values of the selected item.
You can also access this command by clicking Edit > Properties or from the shortcut menu
when you right-click an item in the Project Management tree.
To define new custom properties, use Define Properties (on page 70) in the
Database menu.

Location Properties Dialog Box (on page 200)

Database Properties Dialog Box (on page 81)

Model Properties Dialog Box (on page 82)

Permission Group Folder Properties Dialog Box (on page 83)

Permission Group Properties Dialog Box (on page 84)

Interference Server Settings Dialog Box (on page 84)

What do you want to do?

 Edit model properties (on page 78)
 Edit catalog database properties (on page 78)
 Edit permission group properties (on page 79)
 Edit permission group folder properties (on page 79)
 Update database locations when a server changes (on page 79)
 Change the location of a permission group (on page 81)

Project Management User's Guide 77

 Edit Properties

Edit catalog database properties

1. Select a catalog database in the Project Management tree view.
2. Click Properties .
The Database Properties dialog box displays.
3. Type new values for Schema to change the server and name of the schema.
4. Type or browse to a new path for Symbol and custom program file locations as required.

 The Type and Path rows are read-only.

 When the catalog database is restored on a satellite server participating in a Global
Workshare configuration, the path information for the SharedContent folder persists.
Administrators at the satellite locations must edit the information in Symbol and custom
program file locations to make the path to SharedContent location-specific.

Edit model properties

1. Select a model in the Project Management tree view.
2. Click Properties .
The Model Properties dialog box displays.
3. On the General tab, type a new value for Name to change the name of the model database,
if needed.
4. Type new values for Description, Site, and Owner as required.
5. Type new values for any custom properties as required.
To define new custom properties, use Define Properties (on page 70) in the
Database menu.
6. Select a new model type from the Model Type list if needed. Only project administrators
with project level permissions can modify the model type.
Changing the model type after objects have been created in the model
should only be done when absolutely required.
7. On the Databases tab, type a new name in the Name generator server for model box if
needed.

Project Management User's Guide 78

 Edit Properties

Edit permission group properties

1. Select a permission group in the Project Management tree view.
2. Click Properties .
The Permission Group Properties dialog box displays.
3. On the General tab, type a new value for Name to change the name of the permission
group, if needed.
4. Type new values for any custom properties as required.
To define new custom properties, use Define Properties (on page 70) in the
Database menu.
5. Click Permissions to add or remove users or change access permissions on the Access
Permissions Dialog Box (on page 151).
To change the location of a permission group, follow the recommended workflow
outlined in Change the location of a permission group (on page 81).

Edit permission group folder properties

1. Select a permission group folder in the Project Management tree view.
2. Click Properties .
The Permission Group Folder Properties dialog box displays.
3. Type a new value for Name to change the name of the permission group folder, if needed.
4. Type new values for any custom properties as required.
To define new custom properties, use Define Properties (on page 70) in the
Database menu.

Update database locations when a server changes

Use this procedure to update server locations for your databases when the database files have
moved to a different server.
1. In the tree view of the Project Management task, select a model that has one or more
missing databases.
The icon of a missing database displays as a red question mark in the tree view, such as a
model or a catalog .
2. Click Edit > Properties.
The Model Properties dialog box displays.
3. Click the Databases tab.
Missing databases display the Server cell as white (active) on the grid. In the following
example, the catalog and reports databases (along with their respective schemas) are

Project Management User's Guide 79

 Edit Properties

missing.

4. For each missing database, select the appropriate server from the Server list.
If the software finds the database on the selected server, the updated server name changes
to grey and inactive.
If the software cannot find a database on the selected server, a message box displays.
5. Click OK to return to Project Management.
The tree view refreshes, and the database icons display without the red question mark, such
as a model or a catalog .

 Although the software alerts you to missing databases, it is unable to determine why a
database cannot be found on the specified server.
 In situations where the software is unable to relocate the named database on the server you
specify in the Server list, you must use Restore (on page 102) on the Tools menu.
 When multiple models use one catalog, correcting the server information of a moved catalog
or catalog schema database corrects the location for every model.
 The software automatically regenerates the reports databases if you relocate the catalog,
catalog schema, or model database. In situations where you must relocate the reports
databases, use Edit > Regenerate Reports Database to regenerate the reports databases.
 Additional SQL settings can be required when relocating databases on linked servers.
Contact your system administrator.

Project Management User's Guide 80

 Edit Properties

Change the location of a permission group

The following workflow can only be performed at the host location within a replicated
environment.
Before changing the workshare location of a permission group, back up the catalog
and model databases.
1. Select a permission group in the tree view.
2. Click Properties .
3. Use the Workshare location list to assign the selected permission group to another
satellite. The location that you select must be one that is involved in the current replication
setup.
4. Click OK.

 Before changing the workshare location of the permission group, verify that the database
IFC is stopped and that no one is modifying any items belonging to or related to the selected
permission group; otherwise, those changes will be lost.
 The Workshare location list is disabled at satellite locations.

Database Properties Dialog Box

Sets the properties associated with the selected catalog database. This dialog box is available
by clicking Properties , Edit > Properties, or right-clicking the catalog in the Project
Management tree.
Property
Specifies a property type.
Value
Specifies the required information for a property.
Type
Specifies the database property as the catalog.
Path
Specifies the server path property, defined as the server and database names.
Schema
Specifies the server schema path property, defined as the server and schema database
names.
Permissions
Sets catalog permissions on the Access Permissions Dialog Box (on page 151).
Symbol and custom program file locations
Specifies the location of the symbol share. Typically, the symbol share is in a folder named
SharedContent and is located in a centrally shared server.

Project Management User's Guide 81

 Edit Properties

Model Properties Dialog Box

Sets the properties associated with the selected model database. This dialog box is available by
clicking Properties , Edit > Properties, or right-clicking the model in the Project
Management tree.
General Tab (Model Properties Dialog Box) (on page 82)
Databases Tab (Model Properties Dialog Box) (on page 83)

General Tab (Model Properties Dialog Box)

Sets general properties associated for the selected model database.
Property
Specifies a property type.
Value
Specifies the required information for a property.
Name
Specifies the name of the model.
Description
Specifies descriptive text for the model.
Site
Specifies a descriptive text for the location of the product built from the model, such as a
manufacturing location or a location.
Owner
Specifies descriptive text about the product owner.
Model Type
Defines the type of model. Select Plant, Marine, Platform, or Material Handling.
Permissions
Sets model permissions on the Access Permissions Dialog Box (on page 151).
Any custom properties that you define also display.

Project Management User's Guide 82

 Edit Properties

Databases Tab (Model Properties Dialog Box)

Displays database information for the selected model. The information on this tab is read-only
except where otherwise stated.
When a database is missing, the software makes the appropriate cell on the
Database tab available so that you can select the new server location.
Location
Displays the location for each database associated with the model database.
Type
Displays the database type for each database associated with the model, such as Catalog,
Catalog Schema, Model, Reports, and Report Schema.
Server
Displays the name of the server on which each associated database resides.
Name
Displays the name of each database associated with the selected model.
Node for Duplication Synchronization Service
Displays the computer/node name for the replication monitoring service and is used for
recomputing inconsistencies that are detected after the model database is replicated. The
field is required only for the model databases of the model/location combination. If the
database has not been replicated, the cell displays N/A.
Name generator server for model
Specifies the name of the computer that has been configured to run the name generator
service used by the model database. A name generator server must be a valid computer
running on the Windows domain and one that has been properly configured to run as a
name generator server. For more information about configuring the name generator service,
see the Intergraph SmartTM 3D Installation Guide available from Help > Printable Guides.

Permission Group Folder Properties Dialog Box

Sets the properties associated with the selected permission group folder. This dialog box is
available by clicking Properties , Edit > Properties, or right-clicking the permission group
folder in the Project Management tree.
Property
Specifies a property type.
Value
Specifies the required information for a property.
Name
Specifies the name of the permission group folder.
Any custom properties that you define also display.

Project Management User's Guide 83

 Edit Properties

Permission Group Properties Dialog Box

Sets the properties associated with the selected permission group. This dialog box is available
by clicking Properties , Edit > Properties, or right-clicking the permission group in the
Project Management tree.
Property
Specifies a property type.
Value
Specifies the required information for a property.
Name
Specifies the name of the permission group folder.
Permissions
Defines permissions in the Access Permissions Dialog Box (on page 151).
Workshare location
Displays the workshare location to which the permission group was assigned. An
administrator at the host location can use the list of available location objects to move the
selected permission group to another satellite location within a replicated model. This option
is not available at satellite locations.
Any custom properties that you define also display.

Interference Server Settings Dialog Box

Sets the properties associated with the selected interference server:
 Changes or accepts the default properties for the interference marker size.
 Checks the status of those interferences.
 Assign interference checking priorities to aspects and indicate whether the interferences are
optional or required.
 Optionally, you can indicate if you want interference checking to include a clearance rule.
This dialog box is available by clicking Properties , Edit > Properties, or right-clicking the
interference server in the Project Management tree.
If you change any of the options on the Database Detect tab and then click Start, the software
displays a message box asking if you want to recheck the entire model while preserving the
existing approved interferences.
The GSCADFoulCheckCmds.cSetIFCForRestart custom command is available if you
need to delete all preexisting interferences from the database and start checking from scratch.
For more information, see GSCADFoulCheckCmds.cSetIFCForRestart.
The Interference Server Settings dialog box is only available on computers
on which the Project Management and Database Interference Detection Service options are
installed.

Project Management User's Guide 84

 Edit Properties

Database Detect Tab (Interference Server Settings Dialog Box) (on page 85)
Status Tab (Interference Server Settings Dialog Box) (on page 86)

Database Detect Tab (Interference Server Settings Dialog

Box)
Provides options for assigning interference checking priorities to aspects, specifying the
comparison methods, and optionally including a clearance rule. You can also assign the
interference results to a selected permission group. All properties on this tab when viewed
outside the Project Management task are read-only.
You must run Database Detect before running the delivered Interference report. The
Interference report is not intended to run on local interferences.
Server
Specifies the name of the server on which the interference checking is processed for the
identified model.
Property
Specifies each aspect that you want to check. Lists all the object aspects that are identified
for use in the mode, such as Simple physical, Detailed physical, Insulation, and
Maintenance. This includes system-defined aspects and custom aspects.
Type
Defines the checking you can apply to the selected aspect: Required, Optional, and Not
checked. Choose the appropriate type for each aspect. Not checked means the selected
aspect is not used for interference checking.
Compare
Specifies the types of comparisons to perform to find interferences.
 Required - Required - Defines interferences classified as hard/hard. For example, one
pipe physically intersects another pipe.
 Required - Optional - Defines interferences that are not as severe and are classified as
hard/soft. For example, one pipe overlaps the optional maintenance aspect of the other
object but does not actually intersect the other object.
 Optional - Optional - Defines interferences that are not severe and are classified as
soft/soft. For example, the maintenance aspect of one piece of equipment overlaps the
maintenance aspect of another.
 Smart 3D - External Data - Includes Reference 3D models, referenced MicroStation
objects, and 3D AutoCAD files in interference checking. For Local Detect, the software
by default considers objects in Reference 3D models, MicroStation, and 3D AutoCAD
files that are in the workspace.

 This option only checks active model objects against R3D external objects. IFC also
checks clashes between R3D objects belonging to different R3D projects. The
option does not check for interferences between other external objects such as
MicroStation to 3D AutoCAD.

Project Management User's Guide 85

 Edit Properties

 Reference 3D models that contain tessellated data take a significant amount of time
for interference checking to process. For quicker IFC performance, set Interference
Detection to Do Not Participate.
 Smart 3D - Point Cloud - Includes an attached point cloud during interference
checking. The point cloud must have a valid connection to the model with no unresolved
vendor licensing issues for this option to be available.
Include clearance rule
Specifies the clearance rule to add to the Required type of interference check.
Assign results to permission group
Specifies the permission group to which all the detected interferences are assigned. The list
displays only those permission groups to which the server containing the interference
checking software has write access.
Marker size
Specifies the size of the interference graphic marker. Choose a size that is clearly visible,
but one that does not interfere with the smaller details in the workspace view.
Start
Begins the Local Detect interference checking process. This option is only available in the
Project Management task.
Stop
Stops the Local Detect interference checking the process. This option is only available in the
Project Management task.

Status Tab (Interference Server Settings Dialog Box)

Displays the status of the Database Detect process on the server. The status information
includes the percentage of checking that has been completed, the amount remaining, when the
process was started, and the estimated completion time.
The information on this tab is read-only.
The Interference Server Settings dialog box is only available on computers on
which the Project Management and Database Interference Detection Service options are
installed. For more information about installing this service, see the Smart 3D installation guide,
which is available from Help > Printable Guides.
Model
Displays the name of the model that is checked.
New and modified parts at process start
Displays the following time information for any new and modified parts after the process was
started.
 Last part modified - Displays the date and time (mm/dd/yyyy hh:mm:ss) at which the
last part was created or modified in the Model database.
 Current range to - Displays the date and time (mm/dd/yyyy hh:mm:ss) at which the last
part modified was in consideration for interference checking.

Project Management User's Guide 86

 Edit Properties

 From - Displays the date and time (mm/dd/yyyy hh:mm:ss) at which the interference
check completed checking the last part modified.
 Elapsed time - Displays the amount of time (hour, min, sec) during which the
interference checking has been running for the new or changed parts.
 Estimated completion - Displays the amount of time (hour, min, sec) estimated until
the interference checking process completes.
Process start
Displays the time (mm/dd/yyyy hh:mm:ss) the process started.
Existing parts at process start
Displays the following time information for existing parts when the process was started.
 Current range to - Displays the date and time (mm/dd/yyyy hh:mm:ss) at which the
interference checking started for the existing parts.
 From - Displays the date and time (mm/dd/yyyy hh:mm:ss) at which the interference
checking ended for the existing parts.
 First part created - Displays the date and time (mm/dd/yyyy hh:mm:ss) at which the
first part was created in the database.
 Elapsed time - Displays the amount of time (hour, min, sec) during which the
interference checking has been running for the existing parts.
 Estimated completion - Displays the amount of time (hour, min, sec) estimated until
the interference checking process completes.
Status message
Displays textual information about the current status of the process on the server.

Project Management User's Guide 87

SECTION 6

Managing the Databases

The following commands help you manage databases.
Database Maintenance (on page 88)
Database > Maintenance purges temporary data that may cause performance issues from
a model or catalog database.
Database Integrity (on page 93)
Database > Integrity runs directly on a database (site, catalog, model, or reports) and
creates records for objects that need to be cleaned.
Backup (on page 97)
Tools > Backup saves backup copies of the selected model databases and their
associated site and catalog databases to a single folder.
Restore (on page 102)
Tools > Restore launches the Restore Wizard with which you can reconstruct a previously
backed up version of a model database and its associated site and catalog databases to
selected servers.

Database Maintenance
Database > Maintenance opens the Database Maintenance dialog box, a tool to purge data
that may cause performance issues. For example, when an object is deleted in the model, the
deletion time and user data are maintained in a deleted objects table. This table can become
quite large and periodically rebuilding the indexes on the database can provide significant
performance improvements.
In most situations, back up your databases before performing maintenance.
See Backup (on page 97) and Restore (on page 102) before using this command.
If your database becomes corrupt, do not perform a full backup. Doing so will
destroy your active log file. For more information, see Remove database errors (on page 90).

Database Maintenance Dialog Box (on page 90)

What do you want to do?

 Clean a database (on page 89)
 Delete references to symbol flavors and deleted objects in the database (on page 89)
 Remove database errors (on page 90)

Project Management User's Guide 88

 Managing the Databases

Clean a database
In some cases, cleaning objects causes a loss of data. Before working through
this procedure, you should try to find a matching error message in the Database Integrity Guide.
The What You Should Do section of each error topic may contain steps that fix the error
without loss of data. The Database Integrity Guide is available from Help > Printable Guides.
Before running this command, use Tools > Backup to make a backup of all the databases. You
can later provide this backup to Intergraph if further analysis is necessary. For more information,
see Backup (on page 97).
To clean objects, you must have access to the objects. You must have Full Control on all
permission groups in order to delete the objects.
1. Start the software.
2. Click Tools > Custom Commands.
3. Click Add on the dialog box.
4. In the Command ProgID box, type SP3DCleanDatabaseCmd.CCheckObj.
5. In the Command name box, type text such as Clean Database.
6. Click OK on the Add Custom Command dialog box.
7. Select the command, and then click Run.
The Clean Database Dialog Box (on page 92) displays.
8. Specify the type of database in the Database type box.
9. In the grid, select the objects to clean and click Clean Now.
10. When the process finishes, click View Log and review the log file. It is possible that the
cleaning operation was not successful.
You do not need to have the objects with errors loaded in the workspace to run this
command. However, if the objects are not in the workspace, you will not see the graphical
results of running the command when you refresh the workspace.

Delete references to symbol flavors and deleted objects in

the database
For consistent performance and to report accurate data over time, it is important to run some
basic maintenance operations on the project databases. Failure to do so results in performance
degradation over time.
1. Open Project Management.
2. Select a model database.
3. Click Database > Maintenance.
The Database Maintenance Dialog Box (on page 90) displays.
4. Select Delete temporary symbol variations (flavors) in database and Delete database
objects that users have deleted from model.
5. Click OK.

Project Management User's Guide 89

 Managing the Databases

A progress bar displays the deletion process.

6. Click Analyze on the Database Maintenance dialog box.
The Analyze Database dialog box displays.
7. If the analysis reports that there are still existing flavors in the database, repeat steps 4-6.

Remove database errors

In the event of database corruption, use the following guidelines to restore the database to its
condition prior to when the corruption occurred.
If your database becomes corrupt, do not perform a full backup. Doing so will
destroy your active log file.
1. Perform an immediate backup of the corrupted database's transaction log.
2. Attempt to repair the database using consistency checks and other available tools. If the
repair attempt fails, follow steps 3 through 5 to restore the database.

 For more information about checking database integrity, see Database Integrity (on
page 93).
 For detailed information regarding disaster recovery, see the online documentation for
Microsoft® SQL Server.
3. Apply the last full backup.
4. Apply the last differential backup.
5. Apply all transaction log backups in succession, from the most recent (after the last
differential backup) up to and including the transaction log backup obtained immediately
after the database failure.

Database Maintenance Dialog Box

Allows you to select database maintenance options.

Performance options
Delete temporary symbol variations (flavors) in database
Deletes any orphan flavors in the database. These are temporary symbol variations that the
software used during creation or placement of certain symbols, but are no longer necessary.
This option is unavailable if you selected a catalog, or if the selected model (either host or a
satellite) is participating in a global workshare configuration.
Delete database objects that users have deleted from model
Cleans up the CoreDeletedObjects table. When you delete an object in the model, the
software creates an entry for that object in the table because Drawings and Reports may still
have representations of that deleted object that need to be referenced. The
CoreDeletedObjects table can become quite large.
In a global workshare configuration, this option is only available for the host machine. This
option is not available at satellite locations. The delete action made on the host is replicated

Project Management User's Guide 90

 Managing the Databases

one-way to the satellites.

Only delete information older than
Limits the deletion to those records whose last-modified date is less than the values you
specify in this text box. This option is only available when you select Delete database
objects that users have deleted from the model.
In a global workshare configuration, this option is only available for the host machine.

Index optimization
No optimization
Suppresses optimization of all database tables. This is the default option.
Rebuild selected indexes
Rebuilds the indexes on the database tables for the selected tables in the grid. The software
automatically determines a fill factor for the database tables. This fill factor is dependent on
the activity in the database. When a model is very dynamic, the fill factor is low, but when
few modifications occur in the model (for example, in a reference or "as-built" model), the fill
factor is high. Similarly, during catalog creation (for example, during heavy bulkload
periods), the fill factor is low, but when the catalog becomes stabilized and used in
production, the fill factor is high.
If this option is selected but no tables are checked in the associated grid, nothing
happens.
This option can be performed on a global workshare configuration at the host and all
satellites.
Reorganize selected indexes
Reorganizes the indexes on the database tables for the selected tables in the grid. If this
option is selected but no tables are checked in the associated grid, nothing happens.
This option can be performed on a global workshare configuration at the host and all
satellites.
Select
Specifies which tables are processed on the grid.
The grid is only available when you select Rebuild selected indexes or Reorganize
selected indexes.
Table Name
Displays the name of each table that is available for processing.
Fragmentation Index
Displays the level of fragmentation for each table.
An experienced Oracle or SQL Server DBA may prefer to use specific database
management tools to optimize indexes instead of accepting the Project Management
defaults.
Select All
Selects all tables listed in the grid.

Project Management User's Guide 91

 Managing the Databases

Clear All
Clears all table selections in the grid.
OK
Displays a confirmation message and then initiates the actions for database maintenance.
The confirmation message advises you that the process is time intensive and asks if you
want to continue. If you click Yes, the dialog box clears and a progress bar displays. If you
click No, the command cancels.
Cancel
Dismisses the Database Maintenance dialog box without performing any action.
Analyze
Queries the database and displays a count of deleted and orphaned flavors.

Clean Database Dialog Box

Specifies objects to clean. You can sort the columns in the grid by clicking the column headings.
Database type
Specifies whether you want to clean the site, catalog, or model database.
Select objects to clean
Shows a list of all the objects with integrity problems.
OID
Shows a unique identifier for each object.
Permission Group
Displays the permission group for each object.
Status
Displays the current status of each object: New, Existing, Resolved, Closed, or
Processed.
Action To Take
Describes what to do to fix the problem. The actions include To Be Removed, To Be
Repaired, and To Be Checked by DBChecker.
Severity
Displays the severity of the problem: Fatal, Crucial, High, or Normal.
Description
Provides a brief description of the problem.
Date Created
Shows the date when the problem was first detected.
Date Last Modified
Shows the date when the problem was last checked.

Project Management User's Guide 92

 Managing the Databases

Code List Name

Shows the name of the codelist that applies to the object.
Clean Now
Cleans all objects selected in the grid.
Select All
Selects all objects in the grid. You can also select multiple objects on this dialog box by
holding SHIFT or CTRL while clicking the objects.
Clear All
Clears all objects in the grid.
View Log
Displays a log file for the process in a separate window.

Database Integrity
Database > Integrity in Project Management runs directly on a database (site, catalog, model,
or reports), and creates records for the objects that need to be cleaned.
You can run this command:
 To check the database for objects with integrity problems
 To confirm that objects have been deleted or cleaned
 To check for new problems
After you scan the database for problems, you can use Tools > Run Report in the Common
task to review the errors that Database > Integrity generated.
In addition, you can use Submit Job on the Check Data Consistency Dialog Box (on page 96)
to access batch services to check integrity at times when the server may be less busy. For
information on setting up batch services, see the Batch Services Quick Start Guide.
In a global workshare configuration, Database > Integrity is only available at the host
location. Satellite locations cannot run this command.
For more information on database integrity, see the Database Integrity Guide.

What do you want to do?

 Check database integrity (on page 94)
 Schedule Check Data Consistency task using Batch Services (on page 94)
 Run database administration processes (on page 95)

Project Management User's Guide 93

 Managing the Databases

Check database integrity

1. Select a model, catalog, or site in the Project Management tree view. Your selection
determines the databases available for checking database integrity:
 Select a model if you want to check all of the databases associated with that model.
 Select a catalog if you want to check only the catalog database.
 Select a site to check only the site database.
2. Select Database > Integrity.
The Check Data Consistency dialog box displays. For more information, see Check Data
Consistency Dialog Box (on page 96).
3. Select one or more databases to process.
4. Select Basic check or Full check.
5. Click Run to start the command.
Processing displays in the Checking window.
6. When processing completes, click Exit to dismiss the dialog box.
7. Select Tools > Run Reports.
The Run Reports dialog box displays.
8. On the Catalog Reports tab, select a Diagnostic Clean report in the Types of Reports >
Diagnostic folder.

 You can also run Tools > Run Reports in the Common task.
 Reports can be created persistently in the Drawings and Reports task and scheduled in
the drawing batch server to run periodically after a scheduled database integrity (DBI)
check.

Schedule Check Data Consistency task using Batch

Services
1. In Project Management, click Database > Integrity.
The Check Data Consistency dialog box displays. For more information, see Check Data
Consistency Dialog Box (on page 96).
2. Select one or more databases to process.
3. Select Basic check or Full check.
4. Click Submit Job.
The Schedule Data Consistency Check dialog box displays.
5. Set the batch scheduling options.
6. Click Options to schedule optional start and end dates.
7. Click OK.

Project Management User's Guide 94

 Managing the Databases

Run database administration processes

When you perform administrative tasks on a database, you should not run certain processes
concurrently. In other cases, running certain processes concurrently might also affect
performance. The table below shows a matrix of these different processes:

Process 2 Make Model Bulkload Backup Report or

Changes Drawing
Extraction

Process 1 Bulkload Sync Project SQL

model with Management Backup
Catalog Backup

Bulkload Bulkload Risk - No No No Risk

Synchronize model Risk No - No No Yes

with Catalog

Regenerate Report Risk No No Slow Slow No

DB

DB Database Integrity Slow Yes Slow Yes Yes Slow

Maintenance
Clean DB Command Risk Yes Yes Yes Yes Yes

DB Maintenance No No No No No No

Check Fragmentation Yes Yes Yes No No Yes

Backup Project Management Yes No No - Slow Yes

Backup

SQL Backup Yes No No Slow - Yes

Report & Report Extraction Yes Yes Yes Yes Yes Yes
Drawing
Drawing Extraction Yes Risk Yes Yes Yes Yes

SPR SPR Data Creation Slow Slow No Yes Yes Yes

IFC IFC Yes Yes Yes Yes Yes Yes

Legend
 Yes - Processes can be run concurrently with no risks or performance impact.
 No - Processes cannot be run concurrently.
 Risk - Processes can be run concurrently, but there are risks involved.
 Slow - Processes can be run concurrently. However, you will see slower performance while
the processes are running.

Project Management User's Guide 95

 Managing the Databases

Check Data Consistency Dialog Box

Provides the options for Database > Integrity to run directly on a database (site, catalog,
model, or reports) and create records for objects that need to be cleaned.
After you scan the database for problems, you can use Tools > Run Report (in
Project Management or in the Common task) to review the errors that Database > Integrity
generates.
Check database
Lists the names of the databases to check. If you select a model in the Project Management
hierarchy prior to running the command, the list shows the catalog, model, reports, and site
databases associated with that model. If you select a catalog in the hierarchy, the list only
shows the catalog database. You can check more than one database in the list.
Checking
Shows the progress information for the command after you click Run.
Basic check
Specifies that you want to run a faster database check that checks for the most common
problems. The Basic check can be run on a regular basis.
Full check
Specifies that you want to run a deep integrity check that checks for any type of problem. A
full check can take much longer to complete than a basic check. You can run Full check
when an uncommon problem is encountered or on an infrequent schedule, such as once per
week.
The software checks a file in the [Product Folder]\<Discipline>\Server\Schema\<Database
type>\IntegrityScripts folder to determine which queries are run for the basic or full check.
The files in this folder (Site.lst, Catalog.lst, and Model.lst) correspond to the database
options that display when you run the database integrity check. You can edit these files with
any standard text editor.
Submit Job
Opens the Schedule [Task] dialog box (on page 425) so you can schedule this process.
Run
Runs Database Integrity for the selected databases. This button also creates a text file in
the same TEMP folder as your log files. This text file contains a command with the
parameters for running Database Integrity from the command line with the same
parameters and options as used interactively. If only one database is selected, the text file
name format is DbIntegrityCommandLine-<DbName>.txt. If more than one database is
selected, the text file name format is DbIntegrityCommandLine-<ModelName>.txt.
Exit
Closes the dialog box.

Project Management User's Guide 96

 Managing the Databases

Backup
Tools > Backup creates a single folder of backup files for the selected model databases and
their associated site and catalog databases. In addition, the command duplicates symbol
definition data associated with the catalog. In the event of a system failure or database
corruption, or if you need the databases in another location, you can use the backup files to
restore the databases with Restore (on page 102).
You can use Submit Job on the Backup Dialog Box (on page 100) to access batch
services to back up your data when the server may be less busy. For more information, see
Scheduling Project Management Tasks with Batch Services (on page 424).

Set up the Backup

The Backup dialog box identifies the model by name, database size, and description, and
allows you to specify the folder location (server and folder) in which to store the backup files. If
necessary, you can save more than one model to a single folder location. If several models refer
to the same catalog database, the software saves the catalog database only once. You can also
configure the client computer to work with only one site database at a time.

 To transfer model configurations to another office, perform a complete backup in the Project
Management task. Include new and modified files in the SharedContent folder, as well as
any customized .dll files. You must re-register the .dll files for every client.
 The folder in which the backup configuration file (.bcf) is stored must be shared and write
permissions given to users and all accounts used as logon for Oracle services. In addition, if
you are running Oracle on Linux, the .bcf file must be saved on a Windows-based computer.

Backup Location
The software saves the site, model, and catalog databases to the same folder. The reports and
reports schema databases are not included in the backup set. If the model is restored on-site
(that is, restored in the same server location and the schema of the restored catalog database
has not changed), you can continue to use the original reports databases without incident. If,
however, the model is restored off-site (at a different location), or the structure of the restored
catalog database is different, you must use Edit > Regenerate Reports Database to recreate
the reports databases. A log file recording the results of the backup process and describing any
problems is created in the backup location.
When using an Oracle Linux environment, the database backup location must be on
the Linux computer where the Oracle service is running. The account used to run the Oracle
service must have write permission to the backup location. Linux is a case-sensitive
environment. Make sure that you use the correct case when typing the path for the database in
the database backup utility.

Backup Schedule
In order to keep consistent performance and report accurate data over time, it is important to
perform some basic maintenance operations on your project databases. Failure to do so will
result in performance degradation over time.
An established backup plan is mandatory for your databases for performance and as a means of
disaster recovery. If the databases are never backed up, the log file will continue to grow until no
more drive space is available, thus causing the database to come to a halt.

Project Management User's Guide 97

 Managing the Databases

The full recovery model is the SQL server default and the one recommended for
production systems.
For more information about what backup option is right for you, read the Backing Up and
Restoring Databases chapter of the SQL server books online. The chapter contains Analyzing
Availability and Recovery Requirements that presents several viable options. The following
recommendation is adequate for a pilot project and system monitoring:
"Back up the log file on a regular basis. A log file is truncated after it is backed up, and
backing up the log file is the only way to keep the transaction log file size in check with a full
recovery model."
Intergraph recommends that you back up the log file once every 24 hours. Full
database backup is a heavy operation and should be planned on a regular basis, such as once
a week. Perform regular differential backups to save all changes since the last full backup. A
typical backup schedule might be as follows:

Backup Type Schedule

Full Weekly

Differential Nightly

Transaction log Hourly

The right backup strategy depends on your business requirements and the activity on the
database.

 Using SQL Server to back up and restore your project data is not supported. Backup and
restore functionality is limited to the tools provided in the Database Wizard (on page 368)
and the Project Management task.
 For more information on checking database integrity, see Database Integrity (on page 93).

Symbol Share
Some reference data for your databases is stored in the symbol share (a collection of rules,
templates, filters, and symbols). This reference data can be customized. An identical symbol
share must be available to a restored backup.
If you have a local reference data installation, the default location of the shared folder is
C:\Program Files (x86)\Smart3D\3DRefData\SharedContent. On an enterprise installation, the
SharedContent folder resides on a network server location.
You can restore a backup and connect it to its original symbol share if it is available. If the
symbol share is not available, you need to back up the SharedContent folder and move it to a
new location. You can create a copy of the folder, or zip the folder.

What do you want to do?

 Create a backup file (on page 99)
 Schedule data backup using Batch Services (on page 425)

Project Management User's Guide 98

 Managing the Databases

Create a backup file

1. Click Tools > Backup.
The Backup dialog box displays.
2. In the Select model to back up list, select one or more models that you want to backup.
The related model database, site database and schema, and catalog database
and schema are automatically included in the backup.
3. Click Calculate Size to determine the size of the selected items for backup. The size
displays in the Size column.
If you are backing up an Oracle database model, this calculation could take
several minutes.
4. In the Select folder and name for backup configuration file, specify the destination folder
for the .bcf and log file.

 If you are running Oracle on a Linux computer, the .bcf file must be saved to a
Windows-based computer.
 Users, as well as accounts used as logon for Oracle services, must have write
permissions to the shared folder in which the .bcf file is stored. Before proceeding, verify
that the share, with the appropriate permissions, exists.
5. In the Save Database Backup Files in box, specify the destination folder for the database
backup files.

 When backing up Oracle databases, you must specify a location that is shared.
 When using an Oracle Linux environment, the database backup location must be on the
Linux computer where the Oracle service is running. The account used to run the Oracle
service must have write permission to the backup location. Linux is a case-sensitive
environment. You must use the correct case when typing the path for the database
backup in the database backup utility. You must also type the Linux folder location.
Browse (...) is not available for navigating to Linux folder locations.
6. Click OK.
During the backup process, a progress indicator at the bottom of the dialog box displays the
files that the software currently is accessing. The software generates a log file that
documents the results of the process.
To review the results of the backup in the backup log file, click Yes in the Project
Management message box.
7. Click Cancel to close the Backup dialog box.

 You can restore a model into an existing site database. First, select the backup configuration
file, and then locate the database backup files. Next, select the model. You can review the
databases involved in the list at the bottom of the dialog box. Click Restore.
 To send the backup files to another location, create a .zip file that contains all of the files.

Project Management User's Guide 99

 Managing the Databases

 If files that you have backed up exist in the destination folder, a message displays to
determine if you want to proceed. Click Yes to continue and overwrite the files in that folder.
Click No to cancel the back up.

Backup Dialog Box

Specifies guidelines for the backup process.
Select models to back up
Provides review information for the databases. Select one or more models to backup.
Name - Displays the name of the model database that you want to back up.
Size - Displays the size of the model that you want to back up. Click Calculate Size to
determine the size of the selected items for backup. Size is the combination of the size of
both the model database and the catalog database. If multiple models in the site use the
same catalog database, the software adds the size of that catalog database to only one
model.
Description - Displays a description of the model that you want to back up.
Calculate Size
Calculates the size of the selected model and displays the results in the Size column. You
can select one or more items to calculate their sizes. Size is the combination of the size of
both the model database and the catalog database. If multiple models in the site use the
same catalog database, the software adds the size of that catalog database to only one
model. For Oracle databases, this calculation can take several minutes.
Select folder and name for backup configuration file
Specifies the destination folder for the backup configuration file. The backup configuration
file lists the paths and names of the backed up files. The location you specify also applies to
the corresponding log file. You can click ... to navigate to the destination location. If you are
running Oracle on a Linux computer, the .bcf file must be saved to a Windows-based
computer.
Select server and folder for the site, catalog, and model database backup files
If you are using SQL databases, the table has the following columns:
Server - Displays the server on which the backup files will reside. This information cannot
be edited.
Save Database Backup Files in - Specifies the destination folder for the database backup
files. You can click ... to navigate to the destination location. This option displays only when
you are backing up SQL databases.
Select service and folder for the site, catalog, and model database backup files
If you are using Oracle databases, the table has the following columns:
Server - Displays the Oracle net service connection for the backup files. This information
cannot be edited.
Save Database Backup Files - Specifies the destination folder for the database backup
files. You must specify a folder that is shared. This option is displayed only when you are
backing up Oracle databases. When using an Oracle Linux environment, the database
backup location must be on the Linux computer where the Oracle service is running. The
account used to run the Oracle service must have write permission to the backup location.

Project Management User's Guide 100

 Managing the Databases

Linux is a case-sensitive environment. You must use the correct case when typing the path
for the database backup in the database backup utility. You must also type the Linux folder
location. Browse (...) is not available for navigating to Linux folder locations. However, you
can click ... to navigate to the destination location if you are running Oracle on a Windows-
based computer.
Submit Job
Schedules a time for backing up files using batch services. Displays the Schedule Backup
Dialog Box (on page 101).
OK
Starts the backup process for the selected models to the identified location.

Schedule Backup Dialog Box

Sets up a schedule for batch processing Backup commands.
Queue
Displays the name of the queue to which the job belongs.
Run job
Sets the frequency with which the job runs. Select Immediately, Once, Daily, Weekly, or
Monthly.
Run on
Sets the time to start running the job.
Options
Opens the Optional Schedule Properties Dialog Box (on page 101).
Run on box
Contains a calendar from which you can select the run time.
Job Start
Notifies you when the job starts, if Outlook is set up.
Job Completion
Notifies you when the job completes, if Outlook is set up.
Job Abort
Notifies you if the job aborts, if Outlook is set up.
Address Book
Selects the name of the person to be notified by e-mail of the job status, if Outlook is set up.

Optional Schedule Properties Dialog Box

Provides more options on the Schedule Backup dialog box. This dialog box opens when you
click Options.
Start date
Sets an optional start date.

Project Management User's Guide 101

 Managing the Databases

End date
Sets an optional end date, if checked.

Restore
Tools > Restore opens the Restore Wizard (on page 111), which you use to reconstruct one or
more previously backed up models, site, and catalogs to selected servers. This feature is useful
when you are moving information from one location to another, when information is lost due to
system failure, or when you want to undo changes made to a set of objects since the last
backup. Restore is also useful for creating a copy of the catalog and model to use as a test area
for working on reference data changes before introducing those changes in the production
environment.

 You can use Submit Job on the Restore Wizard (on page 111) to access batch services to
restore your data when the server may be less busy. For more information, see Scheduling
Project Management Tasks with Batch Services (on page 424).
 Use Restore model as Copy if you want to restore a replicated model on a testing server or
on any server that does not participate in GWC.

Symbol Share
Some reference data for your databases is stored in the symbol share (a collection of rules,
templates, filters, and symbols). This reference data can be customized. An identical symbol
share must be available to a restored backup.
If you have a local reference data installation, the default location of the shared folder is
C:\Program Files (x86)\Smart3D\3DRefData\SharedContent. On an enterprise installation, the
SharedContent folder resides on a network server location.
You can restore a backup and connect it to its original symbol share if it is available. If the
symbol share is not available, you need to back up the SharedContent folder and move it to a
new location. You can create a copy of the folder, or zip the folder.

Partial Restore
The partial restore, or selective recovery, capability lets you use the backup and restore
functionalities as a way to undo changes that have been made to particular objects since the
last backup. For example, if you make several changes to a tower, you can use the Restore
Wizard to restore only the tower to its state at the time of the last backup. This is done using the
Copy and Paste and Restore commands in the Smart 3D modeling environment after restoring
a model for selective recovery of model objects.

Intergraph Batch Services

Use Intergraph Batch Services to check database integrity and to schedule backup and restore
sessions when network traffic is low. To schedule the sessions, click Submit Job on the

Project Management User's Guide 102

 Managing the Databases

Restore models from Backup wizard page or on the Check Data Consistency and Backup
dialog boxes.

 The site and site schema databases can only be restored using the Database Wizard. For
more information, see Database Wizard (on page 368).
 If you are using Oracle databases, you should run the Oracle Role Creation Utility to
define specific user roles for each schema or collection of schemas if necessary. For more
information, see Oracle Role Creation Utility (on page 427).

Restore Wizard (on page 111)

What do you want to do?

 Restore a model from backup (on page 103)
 Restore a backup model for selective recovery in an active model (on page 105)
 Restore a model as a copy (on page 106)
 Fully restore an existing model from backup (on page 108)
 Fully restore an existing catalog from backup (on page 109)
 Partially restore catalog data from backup (on page 110)
 Schedule data restore using Batch Services (on page 111)

Restore a model from backup

You must first use the Database Wizard to restore the site and site schema
databases before you restore the catalog, catalog schema, and model databases. For more
information, see Restore a site database (on page 380).
1. Click Tools > Restore.
The Restore Wizard displays.
2. Click Restore one or more model databases from backup, and then click Next.
3. In the Backup configuration file to restore box, specify the location of the backup
configuration .bcf file.
If you are running Oracle on a Linux computer, the .bcf file must be on a
Windows-based computer.
4. In the Models to restore section, select the model that you want to restore.
5. For SQL databases, verify or redefine the server and file path where the database backup
files are located in the Server and Database Backup Files Path columns.
-OR-
For Oracle databases, verify or redefine the Oracle net service connection and file path
where the database backup files are located in the Service and Database Backup Files
Path columns.

Project Management User's Guide 103

 Managing the Databases

When using an Oracle Linux environment, the database backup location must be
on the Linux computer where the Oracle service is running. You must also type the Linux
folder location. Browse (...) is not available for navigating to Linux folder locations.
6. In the Paths for new databases section, select the database type in the Type column.
You must restore the catalog database before you restore the model database.
7. For SQL Server databases, specify values for Server, Database Path, and Log Path.
-OR-
For Oracle databases, specify values for Server, Database Path, and Index Tablespace
Path.
The software automatically displays the database default paths on the selected
server/service.
8. Specify the path for Symbol and custom file location. If you are running Oracle on Linux,
the SharedContent folder must be on a Windows-based computer.
9. Specify the server for Name generator server for model.
10. Click Finish.

 The software names each restored database with the same name that the database had
before you backed up the files.
 After restoring, you can check the name generator server on the Databases tab of the
Model Properties dialog box.
 When you restore a model to an existing catalog, the restored reports database must
accurately reflect the catalog and model databases. Reports database regeneration is
necessary if:
 The catalog database has a different structure.
 The model is restored off-site (that is, at another workshare location).
For more information, see Regenerate the reports database (on page 125).
 If you are using Oracle databases, you should run the Oracle Role Creation Utility to
define specific user roles for each schema or collection of schemas if necessary. For more
information, see Oracle Role Creation Utility (on page 427).

Project Management User's Guide 104

 Managing the Databases

Restore a backup model for selective recovery in an active

model

1. Click Tools > Restore.

The Restore Wizard displays.
2. Click Restore model for selective recovery of model objects, and then click Next.
3. In the Backup configuration file to restore box, specify the location of the backup
configuration .bcf file.
If you are running Oracle on a Linux computer, the .bcf file must be on a
Windows-based computer.
4. In the Models to restore section, select the model that you want to restore.
5. For SQL databases, verify or redefine the server and file path where the database backup
files are located in the Server and Database Backup Files Path columns.
-OR-
For Oracle databases, verify or redefine the Oracle net service connection and file path
where the database backup files are located in the Service and Database Backup Files
Path columns.
When using an Oracle Linux environment, the database backup location must be
on the Linux computer where the Oracle service is running. You must also type the Linux
folder location. Browse (...) is not available for navigating to Linux folder locations.
6. In the Paths for new databases section, select the database type in the Type column.

Project Management User's Guide 105

 Managing the Databases

7. For SQL Server databases, specify values for Server, Database Name, Database Path,
and Log Path.
-OR-
For Oracle databases, specify values for Server, Database Name, Database Path, and
Index Tablespace Path.
The software automatically displays the database default paths on the selected
server/service.
8. Optionally, type a different name in the New model name box, and type a description in the
Description box.
9. Click Finish.
10. Open the restored model in one session of Smart 3D.
11. Open the active model in another session Smart 3D.
12. Use the Paste and Restore command to copy objects from the restored model to the active
model. For more information, see Restore model objects from backup in the Common
User's Guide.

 The software generates a log file (<ModelName>Restore.log) that documents the results of
the process and stores it in the backup configuration .bcf file folder. To review the results of
the restore process, click Yes on the Restore dialog box.
 When you finish restoring selected objects into the active model, you should delete the
restored backup model.
 If you are using Oracle databases, you should run the Oracle Role Creation Utility to
define specific user roles for each schema or collection of schemas if necessary. For more
information, see Oracle Role Creation Utility (on page 427).

Restore a model as a copy

You must first use the Database Wizard to restore the site and site schema
databases before you restore the catalog, catalog schema, and model databases. For more
information, see Restore a site database (on page 380).
1. Click Tools > Restore.
The Restore Wizard displays.
2. Click Restore model as copy, and then click Next.
3. Type a different name in the New model name box, and, optionally, type a description in
the Description box.
4. In the Backup configuration file to restore box, specify the location of the backup
configuration .bcf file.
If you are running Oracle on a Linux computer, the .bcf file must be on a
Windows-based computer.
5. In the Models to restore section, select the model that you want to restore.
6. For SQL databases, verify or redefine the server and file path where the database backup
files are located in the Server and Database Backup Files Path columns.

Project Management User's Guide 106

 Managing the Databases

-OR-
For Oracle databases, verify or redefine the Oracle net service connection and file path
where the database backup files are located in the Service and Database Backup Files
Path columns.
When using an Oracle Linux environment, the database backup location must be
on the Linux computer where the Oracle service is running. You must also type the Linux
folder location. Browse (...) is not available for navigating to Linux folder locations.
7. In the Paths for new databases section, select the database type in the Type column.
8. For SQL Server databases, specify values for Server, Database Name, Database Path,
and Log Path.
-OR-
For Oracle databases, specify values for Server, Database Name, Database Path, and
Index Tablespace Path.
The software automatically displays the database default paths on the selected
server/service.
9. Optionally, type a different name for each database in the Database Name box.
10. If necessary, specify the path where the symbol and custom program files reside in the
Symbol and custom file location. If you are running Oracle on Linux, the SharedContent
share must be on a Windows-based computer.
This option is only available if the symbol and custom files are not stored in the
database you selected to restore.
11. Specify the path for Symbol and custom file location. If you are running Oracle on Linux,
the SharedContent folder must be on a Windows-based computer.
12. Specify the server for Name generator server for model.
13. Click Finish.

 Restore model as Copy can be used for restoring backups of replicated models. You can
also use this command to create a new consolidated model.
 After restoring, you can check the name generator server on the Databases tab of the
Model Properties dialog box.
 After the restore process is complete, you need to regenerate the Reports database. For
more information, see Regenerate the reports database (on page 125).
 If you are using Oracle databases, you should run the Oracle Role Creation Utility to
define specific user roles for each schema or collection of schemas if necessary. For more
information, see Oracle Role Creation Utility (on page 427).

Project Management User's Guide 107

 Managing the Databases

Fully restore an existing model from backup

Use this procedure to overwrite the existing production model with a backup of the model.

 Because this option replaces the existing model database, users must be locked out of the
production model during the restore operation.
 Any changes made to the model since the last backup will be lost.

1. Click Tools > Restore.

The Restore Wizard displays.
2. Click Restore one or more model databases from backup, and then click Next.
3. Perform the standard restore steps. For more information, see Restore a model from backup
(on page 103).
4. Click Finish.
The software displays a warning that a catalog database with the name that you have
specified already exists in the server location. The message asks if you want to link the
existing catalog database with the newly restored model database instead of restoring a
catalog database from backup.
5. Click Yes.
The software displays a message asking if you want to overwrite the existing model
database.
6. Click Yes.
The existing production model database is replaced with the model database from the
backup. The catalog database is not restored. The log file displays after the restore
completes.
7. Click Close in the Restore Wizard.
8. Select the restored model in the tree, and then click Properties . Verify that the name
generator server is correct on the Databases tab.
9. Click Edit > Regenerate Reports Database for the restored model.

Project Management User's Guide 108

 Managing the Databases

10. Click Tools > Synchronize Model with Catalog for the restored model.
11. Allow users to resume work in the production model.

Fully restore an existing catalog from backup

Use this procedure to overwrite the existing production catalog with a backup of the catalog
while continuing to use the existing production model.
Restoring the catalog database from backup without the associated model is a
risky workflow. For example, if you made any catalog schema changes and then placed model
objects, restoring to an older catalog version may result in severe problems when you try to
synchronize that older catalog with your current production model.
Because this option replaces the existing catalog and model databases, users
must be locked out of the production model during the restore operation.

1. Click Tools > Restore.

The Restore Wizard displays.
2. Click Restore one or more model databases from backup, and then click Next.
3. Perform the standard restore steps. For more information, see Restore a model from backup
(on page 103).
4. Click Finish.
The software displays a warning that a catalog database with the name that you have
specified already exists in the server location. The message asks if you want to link the
existing catalog database with the newly restored model database instead of restoring a
catalog database from backup.
5. Click No.
The software displays another warning asking if you want to overwrite the existing catalog
database with a copy of the catalog database from backup.
6. Click Overwrite.
The software displays a message asking if you want to overwrite the existing model
database.

Project Management User's Guide 109

 Managing the Databases

7. Click No.
The existing production catalog database is replaced with the catalog database from the
backup. The model database is not restored. The log file displays after the restore
completes.
8. Click Close in the Restore Wizard.
9. Click Tools > Synchronize Model with Catalog.
10. Allow users to resume work in the production model.

Partially restore catalog data from backup

Use this procedure to restore selected data from a restored catalog to an existing production
catalog.

1. Click Tools > Restore.

The Restore Wizard displays.
2. Click Restore model for selective recovery of model objects, and then click Next.
3. Perform the standard restore steps. For more information, see Restore a backup model for
selective recovery in an active model (on page 105).
Under Paths for new databases, be sure to define a new name for a
catalog database.
4. Click Finish.
5. Open the restored catalog in one session of Smart 3D.
6. Open the production catalog in another session Smart 3D.
7. In the Catalog task of the restored catalog session, copy objects such as piping
specifications or select lists.
You cannot copy and paste part classes, interfaces, or properties from
one catalog to another catalog. You must back up and restore an entire catalog to restore
this type of catalog data.

Project Management User's Guide 110

 Managing the Databases

8. Switch to the production catalog session. In the Catalog task, use Paste to replace the
production catalog data with the copied catalog data.
9. To restore symbol data, use Windows Explorer to copy symbol files from your backup
SharedContent folder to the production SharedContent folder.
10. In Project Management, run Tools > Synchronize Model with Catalog against the
production model. This command globally updates the model database with all catalog
changes, including properties and symbol changes, and optionally regenerates the database
views.
11. Delete the restored model and catalog databases from Project Management when you finish
restoring all required catalog data.
For more information, see Managing Catalog Changes in the Catalog User's Guide.

Schedule data restore using Batch Services

1. In Project Management, click Tools > Restore.
2. Select Restore one or more model databases from backup, and click Next.
3. Perform the standard restore steps. For more information, see Restore a model from backup
(on page 103).
4. Click Submit Job.
5. Complete the Schedule [Task] dialog box (on page 425).
6. Complete the Restore Options for Batch Process dialog box.
 Restore Both - Restores and overwrites the existing catalog and model.
 Restore Catalog - Restores and overwrites only the existing catalog but will not restore
the existing model.
 Restore Model - Restores and overwrites only the model but will not restore existing
catalog.
 If the model or catalog databases do not exist on the specified server, they are created.

Restore Wizard
You access the Restore Wizard by selecting Tools > Restore. The Restore Wizard provides
options for performing the following:
Restore one or more model databases from backup
Restores one or more models to the site. This is the default option on the Introduction page
of the Restore Wizard.
You can also use this option to create a test model and catalog databases. Test
and production databases must have the same name to merge changes from the test
database into the production database using the Restore Wizard.
Restore model for selective recovery of model objects
Restores a model from backup, without overwriting the existing model. You can then use the
Copy and Paste and Restore commands in the Smart 3D modeling environment to restore
objects from that backup into the existing model without losing object identities and
relationships. If you are performing regular backups of the model, you can use this option to

Project Management User's Guide 111

 Managing the Databases

recover portions of the model from different versions, such as from yesterday's backup or
last month's backup.
Restore Ship for Selective Recovery does not support selective recovery of
marine and material handling model objects.
When using selective recovery, you should:
 Recreate missing or bad design data from scratch.
 Stop global workshare, distribute the best available backup set between the host and
satellites, restore, and restart workshare.
Restore Model as a copy
Restores a copy of an entire model. You can use this option to restore a copy of a model
that you have already restored to the site. The restored copy is a separate model.

Restore Models from Backup (Restore Wizard)

This page displays when you select Restore one or more model databases from backup on
the Restore Wizard (on page 111) page.
Backup configuration file to restore
Specifies the location of the .bcf containing configuration information for your database
backup files. Click Browse (...) to navigate to the appropriate location.
When you are running Oracle on Linux, the .bcf file must be on a Windows-based
computer.
Model to restore
Displays the name, database size, and date of backup for all models saved in the backup
defined in the selected .bcf file. The list displays after you select the .bcf file. You can select
multiple models to restore.
Server and path to existing database backup files
Displays the server and location of the database .dat backup files. Specify the path, and
then click Browse (...) to navigate to the location. This option displays only when you are
restoring a SQL database.
Service and path to existing database backup files
Displays the Oracle net service and location of the database .dmp backup files. You must
type the Linux path. The Browse (...) feature is not available for navigation to Linux
locations. This option displays only when you are restoring an Oracle database.

 When you are using an Oracle database on Linux, the backup file must be located on
the Linux server where the Oracle service is running.
 The account used to run Oracle must have write permission to the backup location.
 Linux is a case-sensitive environment. Make sure that you use the correct case when
typing the path for the database backup in the database backup utility.
Paths for new databases
Specifies the server/service and locations of the model databases and log files that you
want to restore. If you select multiple models, the software restores all databases of the

Project Management User's Guide 112

 Managing the Databases

same type to the same server and to the same database path and log path.
Type - Specifies the database type you want to restore. You must restore the catalog
database before restoring model databases.
Server - Specifies the server for the restored databases. Only registered SQL servers
appear in the list. The default is the server from which the backup was made, as defined in
the .bcf file. This option displays only when you are restoring a SQL database.
Service - Specifies the Oracle net service connection for the restored databases. This
option displays only when you are restoring an Oracle database.
Database Path - Displays the database default path on the selected server. Click Browse
(...) to define another location.
Log Path - Displays the database default path on the selected server/service. Click Browse
(...) to define another location. This option displays only when you are restoring a SQL
database.
Index Tablespace Path - Displays the database default path on the selected service. Click
Browse (...) to define another location. This option displays only when you are restoring an
Oracle database.
Symbol and custom program file location
Defines the location of the SharedContent folder containing symbol and custom files. Click
Browse to define the location. If you are running Oracle on Linux, the SharedContent folder
must be on a Windows-based computer.
Name generator server for model
Specifies the name of the name generator server.
Finish
Restores the databases.
Submit Job
Schedules a time for restoring the databases using batch services. Displays the Schedule
Backup Dialog Box (on page 101).
If you want to restore databases from the same backup on different servers, you must
run the Restore Wizard for each server location.

Restore Model for Selective Recovery of Model Objects

(Restore Wizard)
This page displays when you select Restore model for selective recovery of model objects
on the Restore Wizard (on page 111) page.
Restore Ship for Selective Recovery does not support selective recovery of marine
and material handling model objects.
Backup configuration file to restore
Specifies the location of the .bcf containing configuration information for your database
backup files. Click Browse (...) to navigate to the appropriate location.
When you are running Oracle on Linux, the .bcf file must be on a Windows-based
computer.

Project Management User's Guide 113

 Managing the Databases

Models to restore
Displays the name, database size, and date of backup for all models saved in the backup
defined in the selected .bcf file. The list displays after you select the .bcf file. You can select
one model to restore.
Server and path to existing database backup files
Displays the server and location of the database .dat backup files. Specify the path, and
then click Browse (...) to navigate to the location. This option displays only when you are
restoring a SQL database.
Service and path to existing database backup files
Displays the Oracle net service and location of the database .dmp backup files. You must
type the Linux path. The Browse (...) feature is not available for navigation to Linux
locations. This option displays only when you are restoring an Oracle database.

 When you are using an Oracle database on Linux, the backup file must be located on
the Linux server where the Oracle service is running.
 The account used to run Oracle must have write permission to the backup location.
 Linux is a case-sensitive environment. Make sure that you use the correct case when
typing the path for the database backup in the database backup utility.
Paths for new databases
Specifies the server/service and locations of the model databases and log files that you
want to restore. If you select multiple models, the software restores all databases of the
same type to the same server and to the same database path and log path.
Type - Specifies the database type you want to restore. You must restore the catalog
database before restoring model databases.
Server - Specifies the server for the restored databases. Only registered SQL servers
appear in the list. The default is the server from which the backup was made, as defined in
the .bcf file. This option displays only when you are restoring a SQL database.
Service - Specifies the Oracle net service connection for the restored databases. This
option displays only when you are restoring an Oracle database.
Database Name - Specifies the restored model and catalog database names.
Database Path - Displays the database default path on the selected server. Click Browse
(...) to define another location.
Log Path - Displays the database default path on the selected server/service. Click Browse
(...) to define another location. This option displays only when you are restoring a SQL
database.
Index Tablespace Path - Displays the database default path on the selected service. Click
Browse (...) to define another location. This option displays only when you are restoring an
Oracle database.
New model name
Displays the restored model name, with the date of the backup appended, as it displays in
Smart 3D. You can type a different name, which is especially useful for partial recovery at
satellite locations.

Project Management User's Guide 114

 Managing the Databases

The name of the model database is defined in Database Name.

Description
Specifies a description of the restored model.
Finish
Restores the databases.

Restore Model as Copy (Restore Wizard)

This page is only available if you selected Restore model as a copy on the Restore Wizard (on
page 111) page.
New model name
Displays the restored model name, with the date of the backup appended, as it displays in
Smart 3D. You can type a different name, which is especially useful for partial recovery at
satellite locations.
The name of the model database is defined in Database Name.
Description
Specifies a description of the restored model.
Backup configuration file to restore.
Specifies the location of the .bcf containing configuration information for your database
backup files. Click Browse (...) to navigate to the appropriate location.
When you are running Oracle on Linux, the .bcf file must be on a Windows-based
computer.
Model to restore
Displays the name, database size, and date of backup for all models saved in the backup
defined in the selected .bcf file. The list displays after you select the .bcf file. You can select
one model to restore.
When the selected model to restore is registered in an integrated environment,
the registration is removed from the copy during the restore. This prevents restoring the
copy to a different location to which SmartPlant Foundation is not accessible. For more
information, see Integration Reference Guide.
Server and path to existing database backup files
Displays the server and location of the database .dat backup files. Specify the path, and
then click Browse (...) to navigate to the location. This option displays only when you are
restoring a SQL database.
Service and path to existing database backup files
Displays the Oracle net service and location of the database .dmp backup files. You must
type the Linux path. The Browse (...) feature is not available for navigation to Linux
locations. This option displays only when you are restoring an Oracle database.

 When you are using an Oracle database on Linux, the backup file must be located on
the Linux server where the Oracle service is running.

Project Management User's Guide 115

 Managing the Databases

 The account used to run Oracle must have write permission to the backup location.
 Linux is a case-sensitive environment. Make sure that you use the correct case when
typing the path for the database backup in the database backup utility.
Paths for new databases
Specifies the server/service and locations of the model databases and log files that you
want to restore. If you select multiple models, the software restores all databases of the
same type to the same server and to the same database path and log path.
Types - Specifies the database type you want to restore. You must restore the catalog
database before restoring model databases.
Server - Specifies the server for the restored databases. Only registered SQL servers
appear in the list. The default is the server from which the backup was made, as defined in
the .bcf file. This option displays only when you are restoring a SQL database.
Service - Specifies the Oracle net service connection for the restored databases. This
option displays only when you are restoring an Oracle database.
Database Name - Specifies the restored model and catalog database names. For the
catalog database, the software displays the original name. For the model database, the
software displays the name you specified in the New model name box appended with
_MDB.
Database Path - Displays the database default path on the selected server. Click Browse
(...) to define another location.
Log Path - Displays the database default path on the selected server/service. Click Browse
(...) to define another location. This option displays only when you are restoring a SQL
database.
Index Tablespace Path - Displays the database default path on the selected service. Click
Browse (...) to define another location. This option displays only when you are restoring an
Oracle database.
Symbol and custom program file location
Defines the location of the SharedContent folder containing symbol and custom files. Click
Browse to define the location. If you are running Oracle on Linux, the SharedContent folder
must be on a Windows-based computer.
Finish
Restores the databases.
If you want to restore databases from the same backup on different servers, you must
run the Restore Wizard for each server location.

Project Management User's Guide 116

 Managing the Databases

Synchronize Model with Catalog

Tools > Synchronize Model with Catalog updates all changes from the catalog database,
including property, specification, rule, and symbol changes, to the model database. You must
review all changes to catalog definitions in the catalog database before you complete this
command. You most typically use this command with a newly restored model.
During the synchronization process, the software updates the catalog database with any
changes to 2D symbols, Visual Basic symbols, Solid Edge parts, or other graphics. The model is
refreshed to include the following:
 Modifications to properties bulkloaded into the catalog.
 Modifications to name rules.
 Parts deleted from the catalog are added to the To Do List.
 When the symbol definition for any part created with Edit > Copy to Catalog in Smart 3D
tasks is updated from non-cached to cached, those references are updated in the catalog
database. You can convert parts created with Copy to Catalog from non-cached to cached
to improve performance.
The catalog database contains reference data for placing parts. The model contains all
instances of parts. When the catalog definition of a part changes, Synchronize Model with
Catalog changes the symbol and properties for instances of the part in the entire model without
allowing review of individual changes. These changes can alter relationships between existing
objects in the model. This command carries the risk of inserting inconsistencies and other errors
into the model, so it must be used with caution; however, it is essential to run this command to
avoid corruptions in the model.

Permissions
Prior to beginning the synchronization process, the software checks to determine if there are
any permission groups to which you do not have full control or write access. If any are detected,
the software displays a warning message.
The software does not detect write access that is granted to an individual as a
member of a group. Your access must be individually listed in order for the software to
accurately evaluate the level of access.

Reference 3D Models
Synchronize Model with Catalog does not automatically synchronize Reference 3D models.
You can choose to synchronize the Smart 3D model with the Reference 3D model when you
update the Reference 3D project. For more information, see Update multiple Reference 3D
projects (on page 53).

Global Workshare
Running Synchronize Model with Catalog at the host location has the following ramifications
in a Global Workshare Configuration (GWC) setup:
 Items at satellite locations that need updating are placed on the To Do List and can be
resolved by running Synchronize Model with Catalog at each satellite location.
Alternatively, each satellite location can display the To Do List and update out-of-date items
manually.

Project Management User's Guide 117

 Managing the Databases

 Model database views are updated only at the host location. Each satellite location will need
to run Synchronize Model with Catalog to update the views on their model database.
Alternatively, a satellite location can run the View Generator to update the model views. For
more information, see View Generator (on page 411).

Model Name Restore log file

The software generates a log file (ModelNameRestore.log) for Synchronize Model with
Catalog to resolve any mismatches between the newly restored model database and the
existing catalog database. The Synchronize Statistics table in the log file displays the
following:
Site Proxies
Displays the number of site proxies, or the number of interfaces between two objects. A site
proxy manages the relationship information between the model database and the catalog
database. Examples of site proxies are material and material grade.
Symbol Definitions
Displays the number of relationships that a symbol has with the catalog. Relationships can
represent version numbers, inputs, outputs, and time stamps of the symbol definition files
(for example, .dlls and 2D symbols).
Proxy Stoppers
Displays the number of proxies that are flagged so that they are not updated during specific
workflows. When you perform a full synchronization, the software overrides these flags and
updates the proxies.
Symbol Updates
Displays the number of symbols in the model that are updated as a result of their symbol
definitions being updated.

What do you want to do?

 Update a model globally with catalog changes (on page 118)
 Create optimal performance in a Global Workshare Configuration (on page 119)

Update a model globally with catalog changes

1. Review the changes to catalog definitions in the catalog database to confirm that you want
to update the model data to match the catalog database.
2. Select a model database in the tree view.
3. Click Tools > Synchronize Model with Catalog.
The Synchronize Model with Catalog dialog box displays.
4. Select one or both of the options provided: Synchronize model with catalog and
Regenerate views. For more information on the options, see Synchronize Model with
Catalog Dialog Box (on page 120).
5. Select Mark out-of-date occurrences if you want the software to scan the model database
and mark all objects that are out of date with the catalog. In workshare configurations, this

Project Management User's Guide 118

 Managing the Databases

option is not available when the selected model is a satellite. This option is also unavailable
if the Synchronize model with catalog option is not selected.
6. Select Update out-of-date occurrences if you want the software to update all objects that
have been marked as out of date in the model database. In workshare configurations, this
option is available for both host and satellite locations. All locations can run Synchronize
Model with Catalog at the same time using this option to reduce the overall time to update
the model. This option is also unavailable if the Synchronize model with catalog option is
not selected.
You can use the Tools > Synchronize Workspace with Catalog
command to identify and manage out-of-date occurrences. For more information, see
Synchronize with Catalog in the Common User's Guide. You can access this document with
the Help > Printable Guides command in the software.
7. Click OK to start the synchronization process.
8. When all processing is complete, open a Smart 3D session and review the To Do List.
Updates are made to model objects based on your permissions and object status. If you do
not have permission to modify an object, the software places the object on the To Do List. If
the object is not in Working status, the software places the object on the To Do List.
Objects that have an Approved status are ignored in the To Do List and
therefore are not visible. Select Ignored Items in the To Do List Properties dialog box to
show the Approved objects in the To Do List.
After running Synchronize Model with Catalog, regenerate the reports database.
For more information, see Regenerate the reports database (on page 125).

Create optimal performance in a Global Workshare

Configuration
At the Host
1. Select the host model in the Project Management tree.
2. Click Tools > Synchronize Model with Catalog.
3. Select Synchronize model with catalog and Mark out-of-date occurrences.
4. Click OK.
5. When processing is complete, replicate the updated model to the satellites.

At the Satellites
1. At each of the satellites, select the satellite model in the tree.
2. Click Tools > Synchronize Model with Catalog.
3. Select Synchronize model with catalog and Update out-of-date occurrences.
4. Optionally, select the Regenerate views command.
5. Click OK.

Project Management User's Guide 119

 Managing the Databases

Synchronize Model with Catalog Dialog Box

Specifies options for synchronization and displays read-only database information for the
selected model.
The time required for synchronization depends on the selected options.
Synchronize model with catalog
Indicates that you want to synchronize the model with the catalog.
In a global workshare configuration, you can turn this option off and only
regenerate the views.
Mark out-of-date occurrences
Scans the model database and marks all objects that are out of date with the catalog. In
workshare configurations, this option is unavailable when the selected model is a satellite.
This option is available when Synchronize model with catalog is selected.
Update out-of-date occurrences
Updates all model objects that are out of date with the catalog. In workshare configurations,
this option is available for both host and satellite locations. This option is available when
Synchronize model with catalog is selected.
Host and satellite locations can run Synchronize model with catalog at the same time
using this option to reduce the overall time to update the model. You can also interrupt
(cancel) the process and then continue at another time. This capability allows you to
process a large job during multiple sessions.
Regenerate views
Indicates that you want to regenerate the database views. A view is a subset of the
database that is generated from a query and stored as a virtual table. Because the view
does not contain data, the software retrieves data from the database when you access the
view.
You can regenerate views without synchronizing the model.
Model database server
Displays the model database server name.
Model database name
Displays the model database name.
Version
Displays the software version of the database.
Catalog database server
Displays the catalog database server name.
Catalog database name
Displays the catalog database name.
Catalog schema server
Displays the catalog schema server name.

Project Management User's Guide 120

 Managing the Databases

Catalog schema name

Displays the catalog schema name.

Configure Queues for Jobs

Tools > Configure Queues for Jobs displays the Configure Queue For Jobs dialog box
where you can configure batch queues for Smart 3D jobs. You must have administrator
privileges to access this tool.
For the site, you must have the following privileges:
 In Oracle, you must have the SP3DProjectAdministrator role.
 In SQL Server, you must be a system administrator on the server. If you are working in a
multiple domain environment, you must run SQL Server with a network service account, and
not with a domain account.
For a model, you must have full access or write permissions on the selected model database.
Time displayed in
Specifies the unit of measurement for Maximum Allowed Time. The available units of
measurement are sec (seconds), min (minutes), hr (hours), and day. The default unit is hr.
Job Type
Displays the name of the job. The jobs listed are specific to the site or model.
Job Description
Displays a brief description of the job.
Default Queue
Displays the default queue for a specific job, which can be a batch queue or a pipe queue.
When this dialog box displays for the first time, it shows the first queue in the list of available
queues on the local server. You can type a new default queue into this box, or you can
select any queue from the list of available queues on the local server.

 Ensure that the default queue is configured for a job in Project Management, and that
the configured queue exists on all client computers.
 For pipe queues, you need to add the required destinations to the queue. For more
information, see Creating and Configuring Pipe Queues in the Smart 3D Intergraph
Batch Services User’s Guide.
Optional Queues
Displays the Configure Optional Queues dialog box.
Configure Optional Queues Dialog Box (on page 122)
Maximum Allowed Time
Specifies the maximum allowed time to process a job type in the queue. If the job is not
completed in the allowed time, it terminates and the software sends a time-out notification to
the mailing list specified at the time that you submitted the job. By default, the Maximum
Allowed Time is not specified, and the job runs without any time limit. To specify a
Maximum Allowed Time, you must first select Is TimeOut Supported.

Project Management User's Guide 121

 Managing the Databases

When queue times are defined on the Configure Optional Queues dialog box, Maximum
Allowed Time displays the total of those times.

 Set a value for Maximum Allowed Time that allows enough time for each job to
execute.
 If a job is submitted on a pipe queue but is executed on a different queue, the
Maximum Allowed Time for the job is read from the submitted pipe queue.
Is TimeOut Supported
Enables Maximum Allowed Time functionality. This option is not selected by default.
You can create custom batch jobs. For more information, see Creating and
Scheduling Custom Batch Jobs in the Smart 3D Reference Data Guide.

Configure Optional Queues Dialog Box

Time displayed in
Displays the unit of measurement for Maximum Allowed Time, as defined on the
Configure Queues for Jobs dialog box.
Available Queues
Displays all of the queues registered in Intergraph Batch Server. To move an available
queue into the Allowed Queues column, select the queue and click the > arrow.
Allowed Queues
Displays the queues that the administrator has configured for a job type. To remove a queue
from this column, select the queue and click the < arrow.
Maximum Allowed Time
Specifies the maximum allowed time to process an optional queue. If the queue is not
completed in the allowed time, it terminates and the software sends a time-out notification to
the mailing list specified at the time that you submitted the job. By default, the Maximum
Allowed Time is not specified, and the queue runs without any time limit. To specify a
Maximum Allowed Time, you must first select Is TimeOut Supported.

 Set a value for Maximum Allowed Time that allows enough time for each job to
execute.
 If a job is submitted on a pipe queue but is executed on a different queue, the
Maximum Allowed Time for the job is read from the submitted pipe queue.
Is TimeOut Supported
Enables Maximum Allowed Time functionality. This option is not selected by default.

Project Management User's Guide 122

 Managing the Databases

SQL Database Maintenance

SQL Server contains additional maintenance procedures that can improve database
performance. These procedures are performed directly in SQL Server—not in the Smart 3D
software—and are performed by a SQL administrator. Detailed procedures are not described in
this section.

Backing Up Transaction Logs

Transaction logs are backed up to release space on the transaction log file and to prevent
indefinite growth.
In a Global Workshare environment, transaction log backups are only needed for the set of host
databases. These databases experience the largest log file growth due to the Recovery Model
property being set to Full. For more information, see Recovery Models (SQL Server) in SQL
Server Help.
Transaction log backups are not used for restoring databases. You should
schedule Smart 3D backups for disaster recovery. For more information, see Backup (on page
97) in the Project Management User's Guide.
You can create a single maintenance plan for multiple databases (such as the site, site schema,
catalog, catalog schema, and model that comprise a standard Smart 3D database set), or create
a separate maintenance plan for each database.
For more information, see Maintenance Plan Wizard in SQL Server Help.

Updating Statistics to Optimize Queries

The SQL Server Query Optimizer uses database statistics to efficiently retrieve and update data.
The Query Optimizer automatically updates statistics. You can also manually update statistics
more frequently to improve query performance, especially when creating and updating drawings.
You can use UPDATE STATISTICS or the Transact-SQL stored procedure sp_updatestats.
For more information, see Statistics Used by the Query Optimizer and UPDATE STATISTICS
(Transact-SQL) in SQL Server Help.

Project Management User's Guide 123

SECTION 7

Reports
Project Management includes commands to create reports that you can use to produce a
printed report of the information in your database.
Regenerate Reports Database (on page 124)
Edit > Regenerate Reports Database recreates the reports and reports schema
databases.
Run Report (on page 131)
Tools > Run Report creates a report from an existing catalog template or a personal report
template.

Regenerate Reports Database

Edit > Regenerate Reports Database recreates the reports and reports schema databases.
The reports database is a set of views that points to the data in the other databases. This
command is available when you select a model database in the Project Management tree view.
The command is also available from the shortcut menu of a selected model.
Before starting this procedure, check with your Smart 3D administrator to
verify that all users are disconnected from the database.
If metadata changes are made to the model or catalog, such as when new attributes
or custom interfaces are added to the reference data, you must regenerate the model and
catalog views using the View Generator (on page 411) (an external utility), and then regenerate
the reports database.

Regenerate Reports Database Dialog Box (on page 130)

What do you want to do?

 Regenerate the reports database (on page 125)
 Regenerate the reports database with linked SQL servers (on page 125)
 Regenerate the reports database with linked Oracle servers (on page 129)

Project Management User's Guide 124

 Reports

Regenerate the reports database

Before starting this procedure, check with your administrator to verify that all
users are disconnected from the database.
1. Select a model database in the Project Management tree view.
2. Click Edit > Regenerate Reports Database.
The Regenerate Reports Database dialog box displays.
3. Review and, if necessary, edit the information displayed for the reports databases and
servers.
4. Click OK to regenerate the reports database.

 Reports databases must have unique names. If the reports database name you specify
already exists, the software prompts you to either rename the database or reuse the existing
reports database.
 If the software is unable to successfully create the reports schema, an error message
displays and the process ends.

Regenerate the reports database with linked SQL servers

If the site, catalog, and model databases are not on a single server, then you cannot regenerate
reports databases until you configure linked servers, as shown in the following procedure.

Verify that both servers support both SQL Server Authentication and Windows
Authentication
1. From the Start menu, open SQL Server Management Studio.
2. Right-click the server in the Object Explorer, and select Properties.

The Server Properties dialog box displays.

Project Management User's Guide 125

 Reports

3. Click Security, and verify that Server authentication is set to SQL Server and Windows
Authentication mode.

4. Repeat this process for the other server.

Create a login with SQL server authentication for both servers

1. Right-click <ServerName> > Security > Logins, and select New Login.

The Login - New dialog box displays.

2. Type the name in the Login name box.
3. Select SQL Server authentication, and type and confirm the password. Clear User must
change password at next login if necessary.

Project Management User's Guide 126

 Reports

4. Click Server Roles, select sysadmin, and click OK.

5. Repeat these steps for the other server.

6. Disconnect both servers, and then verify that you can connect to them with the new SQL
login.

Link the servers

1. Right-click <ServerName> > Server Objects > Linked Servers, and select New Linked
Server.

The New Linked Server dialog box displays.

Project Management User's Guide 127

 Reports

2. Type the name for the other server in the Linked server box.

3. Click Security, and select Be made using this security context.

4. Type the user name into the Remote login box.
5. Type the password into the With password box.

6. Repeat these steps for the other server.

Verify the link between the servers

1. From one of the servers, run the following query:
Select * from [otherservername].[dbname].[tablename]
 [otherservername] - The name of the other server.
 [dbname] and [tablename] - The names of any existing database and table.
2. Repeat this process for the other server.

Troubleshooting
Error: Server 'A' is not configured for DATA ACCESS
Recovery: Type the following command into the Run dialog box on both server A and the linked
server:

Project Management User's Guide 128

 Reports

Exec sp_serveroption 'A', 'data access', 'true'

Regenerate the reports database with linked Oracle servers

If the site, catalog, and model databases are not on a single server, then you cannot regenerate
report databases until you configure linked servers, as shown in the following procedure.
1. In Oracle, run the following scripts to create a database login on both servers:
DROP USER "LINKUSER" CASCADE;
CREATE USER "LINKUSER” PROFILE DEFAULT IDENTIFIED BY linkpass
DEFAULT
TABLESPACE USERS TEMPORARY
TABLESPACE TEMP ACCOUNT UNLOCK;
GRANT UNLIMITED TABLESPACE TO "LINKUSER" WITH ADMIN OPTION;
GRANT EXECUTE ON SYS.UTL_FILE TO "LINKUSER" WITH GRANT OPTION;
GRANT EXECUTE ON SYS.DBMS_RANDOM TO "LINKUSER" WITH GRANT OPTION;
GRANT SELECT ON V_$SESSION TO "LINKUSER" WITH GRANT OPTION;
GRANT SELECT ON V_$INSTANCE TO "LINKUSER" WITH GRANT OPTION;
GRANT ANALYZE ANY TO "LINKUSER";
GRANT SP3D_PROJECT_ADMINISTRATORS TO "LINKUSER";
COMMIT;
 LINKUSER - The user name for the link.
 linkpass - The password for the link.
2. Create the database link on one server by executing the following query:
CREATE PUBLIC DATABASE LINK <global db name>
CONNECT TO "<link user>" IDENTIFIED BY <link user password> USING
'<service name>';
 <global db name> - The linked Oracle Service name.
 <link user> - The user name for the link.
 <link user password> - The password for the link.
 <service name> - The service name in the tnsnames.ora file.
For example:
Execute Query On Server 1
CREATE PUBLIC DATABASE LINK MyServer2.MyCompany.COM
CONNECT TO "LINKUSER" IDENTIFIED BY linkpass USING 'MyServer2';
3. Repeat the previous step for the other server, changing the server name as necessary.
For example:
Execute Query On Server 2
CREATE PUBLIC DATABASE LINK MyServer1.MyCompany.COM
CONNECT TO "LINKUSER" IDENTIFIED BY linkpass USING 'MyServer1';
4. Add the tns entries to the tnsnames.ora file on each server.

Verify that the database link is working

1. Execute the following query:

Project Management User's Guide 129

 Reports

Select * from dual@<global db name>

 <global db name> - The fully qualified name of the Oracle server.

Regenerate Reports Database Dialog Box

Specifies the name and location options for regenerating a reports database. The options
displayed on the dialog box vary depending on the database type.
Database type
Displays the type of database. The software supports SQL Server and Oracle databases.

SQL Server Databases

These options display only if MSSQL displays in the Database type box.
Reports database server
Specifies the server on which the regenerated reports database will reside. By default, the
software uses the same server as the model database server.
Reports database name
Specifies the name of the regenerated reports database. By default, the software appends
_RDB to the name of the model that you selected in the tree view.
Paths for the reports database files
Physical database - Displays the default location of the SQL database file. Click Browse to
navigate to another location.
Log file - Displays the default location of the SQL log file. Click Browse to navigate to
another location.
Reports schema server
Specifies the server on which the regenerated reports database schema will reside. By
default, the software uses the same server as the reports database server.
Reports schema name
Displays the name of the regenerated reports database schema. By default, the software
appends _SCHEMA to the reports database name.
Paths for the reports schema files
Physical database - Displays the default location of the SQL database schema file. Click
Browse to navigate to another location.
Log file - Displays the default location of the SQL schema log file. Click Browse to navigate
to another location.

Oracle Databases
These options display only if Oracle displays in the Database type box.
Oracle service (1)
Displays the name of the Oracle net service for the reports database connection.

Project Management User's Guide 130

 Reports

Reports database name

Specifies the name of the regenerated reports database. By default, the software appends
_RDB to the name of the model you selected in the tree view.
Paths for the reports database files
Displays the location of the reports database and index table space. Click Browse to
navigate to another location.
Oracle service (2)
Displays the name of the Oracle net service for the reports schema database connection.
Reports schema name
Displays the name of the regenerated reports database. By default, the software appends
_SCHEMA to the reports database name.
Paths for the reports database files
Displays the location of the reports schema database and index table space. Click Browse
to navigate to another location.

Run Report
Tools > Run Report runs an existing catalog or personal report. By default, all reports
generated with this command are in Excel format (.xls). However, you can customize .xml files
to report in other formats. You can review each completed report with Excel.
You can also use Tools > Run Report in any Smart 3D task to generate reports.
Reports are divided into two overall categories: catalog reports and personal reports. Catalog
reports include report templates delivered with the software and templates created by a reports
designer. Personal reports use templates you create and save.
Depending on the report definition, you may need to specify additional information such as filters
or parameters when running a report. Here are some examples.
 Specifying a filter on the Select Filter Dialog Box (on page 271).
 Specifying inputs for an asking filter on the Filter Properties Dialog Box (on page 137).
 Specifying parameters on the Report Parameters Dialog Box (on page 136).
If a required filter does not exist, the software displays a message asking you to create the
required catalog filter. When you provide the necessary information, the command displays the
report in Excel.

 If any errors occur during the processing of a report, the command generates an error log
called SP3DReports.log in your local Temp folder.
 Reports can have a maximum of 65,536 rows. If a report reaches the maximum, printing
stops. The log file message alerts you about the limit.
 You must enable Trust access to the VBA project object model in Excel. For more
information, see Enable or disable macros in Office files in Excel Help.
 For information about creating report databases, see the Intergraph SmartTM 3D Installation
Guide available from Help > Printable Guides.

Project Management User's Guide 131

 Reports

Run Report Dialog Box (on page 133)

What do you want to do?

 Run an existing catalog report (on page 132)
 Run an existing personal report (on page 132)

Run an existing catalog report

1. Select a model in the tree view, and click Tools > Run Report.
The Run Report dialog box displays.
2. On the Catalog Reports tab, expand the tree view to select the category for your report
(such as Piping or Equipment), and then select the report template you want to use in the
right pane.
3. Optionally, type a name for the output file in the File name box, or click Browse.
4. Click Run. If the report requires additional input, such as a filter or parameter, the command
displays the necessary dialog boxes, such as the Select Filter Dialog Box (on page 271),
Filter Properties Dialog Box (on page 137), and Report Parameters Dialog Box (on page
136).

 Before running a report, confirm that your system administrator created the necessary
reporting databases. The reports database must exist before you can run a report.
 If you attempt to run a report template but the reports database does not exist, the software
displays the message Cannot get Reports Database connection. Contact your system
administrator for the prerequisite databases.
 In Smart 3D, you can define the path to your output report in advance by clicking Tools >
Options and then selecting the File Locations tab.
 Reports can have a maximum of 65,536 rows. If a report reaches the maximum, a message
in the error log of the software alerts you: Excel sheet limit (65,536 rows) was reached.
 If you click No to avoid overwriting an existing report, the software displays the Browse
dialog box so that you can specify a different report name.

Run an existing personal report

Before following this procedure, open Smart 3D and define the path to your personal
report (.rpt) files by clicking Tools > Options and then selecting the File Locations tab.
1. Select a model in the tree view, and click Tools > Run Report.
The Run Report dialog box displays.
2. On the My Reports tab, select the personal report template you want to use.
3. Optionally, type a name for the output file in the File name box, or click Browse.
4. Click Run. If the report requires additional input, such as a filter or parameter, the command
displays the necessary dialog boxes, such as the Select Filter Dialog Box (on page 271),

Project Management User's Guide 132

 Reports

Filter Properties Dialog Box (on page 137), and Report Parameters Dialog Box (on page
136).

 If you attempt to run a report template but the reports database does not exist, the software
displays the message Cannot get Reports Database connection. Contact your system
administrator for the prerequisite databases.
 Because each user generates personal reports, the My Reports folder is initially empty.
 Reports can have a maximum of 65,536 rows. If a report reaches the maximum, a message
in the error log of the software alerts you: Excel sheet limit (65,536 rows) was reached.
 If you click No to avoid overwriting an existing report, the software displays the Browse
dialog box so that you can specify a different report name.

Run Report Dialog Box

Runs a specified type of report. You can select a catalog report from the list on the Catalog
Reports tab, or select a personal report from the list on the My Reports tab. You can also view
the properties of catalog reports.
My Reports Tab (Run Report Dialog Box) (on page 133)
Catalog Reports Tab (Run Report Dialog Box) (on page 134)

My Reports Tab (Run Report Dialog Box)

Specifies a personal report template from the list and runs it. All reports are in Excel format
(.xls).
You can create and modify report templates in the Drawings and Reports task and save
them to the catalog.
Available report templates
Lists all of your available personal report templates.
File name
Displays the default name for a report generated from the selected report template. You can
type a different name.
Browse
Displays the Select Report dialog box so that you can open a report from a different
location.
Run
Runs the selected report. If the report requires additional input, such as a filter or parameter,
the command displays the necessary dialog boxes, such as Select Filter Dialog Box (on
page 271), Filter Properties Dialog Box (on page 137), or Report Parameters Dialog Box (on
page 136).
Cancel
Cancels all changes, and closes the dialog box.

Project Management User's Guide 133

 Reports

Catalog Reports Tab (Run Report Dialog Box)

Specifies a catalog report template from the list and runs it. All reports are in Excel format (.xls).
Some toolbar options are not available because they are used for creating new
reports and cannot be used with Run Report. You can create new report templates in the
Drawings and Reports task.
Available report templates
Lists all of the catalog report templates currently available in an expandable hierarchy.
For a listing of which engineering check report to run for a piping part class, refer to
the Engineering Check Reports: Piping Parts in the Catalog User's Guide.
Properties
Opens the Properties dialog box. For more information, see Properties Dialog Box (Run
Report) (on page 134).
List View
Displays the template properties in a list format.
Grid View
Displays the template properties in a grid format.
File name
Displays the default name for a report generated from the selected report template. You can
type a different name.
Browse
Displays the Select Report dialog box so that you can open a report from a different
location.
Use Select Set
Specifies that the reports only return records associated with the objects in the select set.
Run
Runs the selected report. If the report requires additional input, such as a filter or parameter,
the command displays the necessary dialog boxes, such as Select Filter Dialog Box (on
page 271), Filter Properties Dialog Box (on page 137), or Report Parameters Dialog Box (on
page 136).
Cancel
Cancels all changes, and closes the dialog box.

Properties Dialog Box (Run Report)

Displays the general properties and configuration of a selected report template. This dialog box
does not allow you to change the properties of the template.
Definition Tab (Run Report Properties Dialog Box) (on page 135)
Configuration Tab (Project Management) (on page 135)

Project Management User's Guide 134

 Reports

Definition Tab (Run Report Properties Dialog Box)

Displays the general properties and property values of a selected report template.
Property
Displays the properties of a selected report template. These properties typically include
Name, Description, and Type. Type can be a standard report template or a catalog report
template.
Value
Displays the value of each property in the Property column.

Configuration Tab (Project Management)

Displays the creation, modification, and status information about an object.
Model
Displays the name of the model. You cannot change this value.
Permission Group
Displays the permission group to which the report belongs.
Transfer
Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group. This option is only available if the active model is
replicated in a workshare configuration. The option is not available if all of the objects in the
select set already belong to another location and are non-transferable. For more
information, see Transfer Ownership Dialog Box (on page 135).
Status
Specifies the current status of the report.
Created
Displays the date and time that the report was created.
Created by
Displays the name of the person who created the report.
Modified
Displays the date and time that the report was modified.
Modified by
Displays the name of the person who modified the report.

Transfer Ownership Dialog Box

Allows you to specify a new location and permission group for the selected model objects.
Current location
Displays the name of the location with which the current permission group is associated. All
of the objects in the select set must belong to the same location.

Project Management User's Guide 135

 Reports

Current permission group

Displays the name of the permission group with which the selected objects are currently
associated. If all of the objects in the select set do not belong to the same permission group,
this box appears blank.
New location
Specifies the name of the location to which you want to assign the objects. In a global
workshare configuration, this box lists all the locations in which you have write access to one
or more permission groups. The selection in this box filters the entries in the New
permission group box.
New permission group
Specifies the new permission group to which to assign the selected objects. If you specify a
value in the New location box, this list displays all permission groups to which you have
write access in the selected location. If you do not specify a value in the New location box,
this list includes all permission groups to which you have write access in all locations except
the current location. This box is blank if you do not have write access to any permission
groups at any locations other than the current one.
We strongly recommend that administrators follow naming convention rules that
include the location as a prefix in the permission group name.

Report Parameters Dialog Box

Specifies parameters for a report deliverable, such as units of measure and coordinate systems.
This dialog box only displays when you run a report that requires parameter input. In addition,
the controls on this dialog box may vary, depending on the report definition. For more
information on configuring parameters for a report, see Design Layout in the Reports User's
Guide.
Unit of Measure
Sets the units of measure for the report.
Matrix
Specifies information about the coordinate system. For more information about the columns
displayed in the matrix, see Unit of Measure Dialog Box (Label Editor) in the Common
User's Guide.

 For some reports, several dialog boxes requiring report parameters display. The dialog
boxes take the form of a wizard with Back, Next, and Finish at the bottom.
 The query you set up for running a report can generate dialog boxes that prompt for certain
report parameters. In this way, your query can customize the report creation.

Project Management User's Guide 136

 Reports

Filter Properties Dialog Box

Builds a filter or displays the properties of an existing filter. You access this dialog box from the
Select Filter dialog box, which is available as follows:
 File > Define Workspace - Filter option, or Properties button, if a filter is selected.
 Tools > Select by Filter.
This dialog box is entitled New Filter Properties or simply Filter Properties, depending on
whether you are creating a new filter or modifying an existing filter. Its behavior is the same.
The dialog box tabs let you pick the appropriate criteria for the filter. For example, the System,
Assembly, or Named Space tabs on the Filter Properties dialog box provide for extensive
searches, while the Properties, Volume, Permission Group, and Object Type tabs assist with
more restrictive searches. The Configuration tab specifies the permission group assignment of
the filter. The Work Breakdown Structure (WBS) tab identifies objects in the selected WBS for
the filter. For example, you can select projects, contracts, or documents from the WBS.
Name
Specifies the name of the object. If a Name Rule is specified, then the software uses that
rule to determine this name. If the Name Rule value is User Defined, then you must type a
name in this box.
Asking Filter - user of filter will supply value
Creates an asking filter. An asking filter prompts you for specific values for certain
properties.
Include nested objects
Specifies whether you want your search to include all objects under a selected node. For
example, when you check this box and then select an object, the software selects all sub-
objects under that object. If you do not check this box, you can select objects separately.
This option is unavailable for certain tabs on this dialog box.
Lock CTRL key
This option changes the selection mode and allows you to select multiple items across filter
tabs without holding down the CTRL key.
Clear All
Removes the object definition. Click Clear All if you want to start over and redefine the
search criteria.

 When the New dialog box displays, the default is always the last-selected option.
 When you double-click a filter on the Select Filter dialog box, the software applies the filter
and dismisses the dialog box.

Project Management User's Guide 137

 Reports

Topics
System Tab (Filter Properties Dialog Box) .....................................138
Assembly Tab (Filter Properties Dialog Box) .................................139
Named Space Tab (Filter Properties Dialog Box) ..........................139
Analysis Tab (Filter Properties Dialog Box)....................................140
Work Breakdown Structure Tab (Filter Properties Dialog Box) ......140
Permission Group Tab (Filter Properties Dialog Box) ....................141
Object Type Tab (Filter Properties Dialog Box) .............................142
Volume Tab (Filter Properties Dialog Box) .....................................142
Properties Tab (Filter Properties Dialog Box) ................................143
Reference Tab (Filter Properties Dialog Box) ................................144
Reference 3D Tab (Filter Properties Dialog Box) ...........................145
Point Cloud (Filter Properties Dialog Box)......................................145
Configuration Tab ...........................................................................145

System Tab (Filter Properties Dialog Box)

Provides a tree view list of all the available systems you can include in your filter search criteria.
A Model is the highest system in the hierarchy and includes all subsystems. Systems can span
disciplines and include many types of objects.

You can select the Include nested objects option to specify that you want your search criteria
to include all objects within a system. For example, if you select this option, the software selects
all children objects when you select a parent system. If you do not select this option, you select
only the systems. You can also use the CTRL and SHIFT keys to select multiple objects on this
tab.
Nodes with more than 1,000 children display in bold type rather than auto-expanding if some of
their children are selected in the filter properties. The selected child nodes highlight when you
expand the parent node.

Project Management User's Guide 138

 Reports

Assembly Tab (Filter Properties Dialog Box)

Provides a tree view list of all the available assemblies you can include in your filter search
criteria.

You can select the Include nested objects option to specify that you want your search criteria
to include all objects within a category. For example, if you select this option, the software
selects all objects when you select a category. If you do not select this option, you select the
assembly objects separately. You can also use the CTRL and SHIFT keys to select multiple
objects on this tab.
The Include nested assemblies only option includes all nested assemblies, assembly blocks,
blocks, spools, and penetration spools under the selected assemblies, but not the parts.

 The Include nested assemblies only option explicitly includes the assemblies and
assembly parents that you are working on so that the Refresh Workspace command
updates the assembly information without including all of the parts nested under the selected
assemblies, such as plate parts, that are not of interest.
 You can only select one of the Include nested objects and Include nested assemblies
only options. You can clear both options.

Named Space Tab (Filter Properties Dialog Box)

Provides a list of all the named spaces and drawing volumes you can include in your search.

Named spaces are regions in the model, like fire or blast zones. Filtering on named spaces is
useful particularly when you work in the Space Management task and need to see the size,

Project Management User's Guide 139

 Reports

shape, and position of the named spaces that already exist. Drawing volumes are used in the
Drawings and Reports task in the drawing creation process.
You can select the Include nested objects option to specify that you want your search criteria
to include all objects within a category. For example, if you select this option, the software
selects all objects when you select a category. If you do not select this option, you select the
category and individual objects separately. You can also use the CTRL and SHIFT keys to
select multiple objects on this tab.

Analysis Tab (Filter Properties Dialog Box)

Provides a list of all the structural analysis models you can include in your search.

Analysis models are associated with the Structural Analysis task in the software. An analysis
model is a non-graphical and logical grouping of member systems that can be sent to a third-
party analysis and design solver package.
You can select the Include nested objects option to specify that you want your search criteria
to include all objects within a category. For example, if you select this option, the software
selects all objects when you select a category. If you do not select this option, you select the
category and individual objects separately. You can also use the CTRL and SHIFT keys to
select multiple objects on this tab.

Work Breakdown Structure Tab (Filter Properties Dialog Box)

Browses a tree view of the model work breakdown structure to include WBS entities only if the
Work Breakdown Structure tab is used, or restrict the filters to objects assigned to the
selected WBS, if other tabs are used.

A simple filter shows only objects assigned to the selected WBS items and the WBS
items themselves. To see WBS objects on the Workspace Explorer tab, you must create a
compound filter. If you define a filter that contains only one WBS project, this filter returns the
WBS project selected on the WBS tab of the Workspace Explorer and any objects assigned to
that particular WBS project on the Systems tab in the Workspace Explorer. To see all WBS

Project Management User's Guide 140

 Reports

objects on the WBS tab in the Workspace Explorer, you must create a compound filter. For
example, you might create a filter that contains All Systems or WBS Objects. This filter would
return all objects on the Systems tab and all WBS objects.
The WBS is the breakdown of the Model by the construction work to be performed. The
breakdown can consist of the Model at the top level, as well as projects, contracts, and
documents. You can modify a property for an object to associate it to a project. You can
associate published documents to a contract and then reassign the document from one contract
to another. Objects are associated to a document.
You can select the Include nested objects option to specify that you want your search criteria
to include all objects within a category. For example, if you select this option, the software
selects all objects when you select a category. If you do not select this option, you select the
category and individual objects separately. You can also use the CTRL and SHIFT keys to
select multiple objects on this tab.

Permission Group Tab (Filter Properties Dialog Box)

Displays a tree view list of all the permission groups that you can select for your search. The
filter selects objects that belong to the groups that you highlight. If you do not highlight any
groups, the filter includes all groups in the list.

You can add permission groups in the Project Management task.

Project Management User's Guide 141

 Reports

Object Type Tab (Filter Properties Dialog Box)

Provides options for you to select specific object types to restrict your filter. The objects are
organized by discipline.

This tab provides a list of all the major object types you can include in your search. The filter
selects the objects you highlight. If you do not select any objects, the filter includes all objects in
the list. To include one or more object types in your filter, press CTRL and click the name of
each object type that you want to include.

Volume Tab (Filter Properties Dialog Box)

This tab restricts filter selection to objects within the selected volume and provides two options
for defining the volume search method: Named spaces or Planes. The tree view displays the
Named Spaces hierarchy or the coordinate system hierarchy depending on the option that you
select.

Project Management User's Guide 142

 Reports

Define by
Named spaces
Displays a tree view of the space hierarchy from which you can choose one or more spaces
to include in your search. This option is useful for filtering all objects located within specific
spaces. In addition to selecting all the objects inside the specified named spaces, the
software retrieves the space itself. You do not need to select the object on the Named
Space tab as well. To select a particular named space, press CTRL and click as many
spaces as you want to include in your search. If you do not select any named spaces, the
filter includes all objects in all named spaces.
Planes
Displays a tree view of the reference coordinate system hierarchy in the window, and a
group of first and second position coordinate boxes at the bottom. The coordinate system
hierarchy is a list of predefined coordinate systems for the model, each having a different
origin point. For example, one coordinate system might have an origin point at the corner of
a boiler room, another at the center of the building, and so forth.
When you select one of these coordinate systems, the software displays a list of coordinate
planes for that system. By selecting a plane and specifying the first and second positions
along that plane, your filter selects all objects that fall between the two positions on that
plane. The positions automatically appear in the first and second position boxes at the
bottom of the dialog box. This option is useful when you want to select objects that are all on
a specific level or plane. You can hold CTRL to select the first and second positions in the
tree view.
Coordinate system
Specifies a coordinate system. You can define coordinate systems in the Grids task.
1st Position (N, E, EL) or (Y, X, n)
Displays the names of the planes that you select to define the first position of the volume.
2nd Position (N, E, EL) or (Y, X, n)
Displays the names of the planes that you select to define the second position of the
volume.

Properties Tab (Filter Properties Dialog Box)

Provides options for selecting object properties that you can use to restrict your search.

Filter Method
You can combine multiple properties on individual rows.

Project Management User's Guide 143

 Reports

Match All
Returns only those objects matching all of the properties listed in the grid. This method is
the same as using the Boolean operator AND.
Match Any
Returns objects matching any property listed in the grid. This method is the same as using
the Boolean operator OR.
Property
Lists the properties of objects in the data model in the Select Properties dialog box. To
select properties and set their data type, select More in the field drop-down.
Operator
Select an operator such as <> (not equal) or = (equal).
If you use a wildcard character (*), you must use the Contains comparison
operator. For example, pumps P-1000A and P-1000B exist in the model. To query for the
pumps using properties, select Match All and type Name Contains P*.
Value
Specifies the value of the property.
Ask
Creates an Asking Filter that allows you to specify a value for the property when you run
the filter. The Ask column is so named because the software asks or prompts you to type a
value. An administrator or other user with the required permissions establishes the asking
filter and defines a default value. While defining a workspace, you can type a different value
for the property. This is not a valid option for Model Data Reuse.
Remove
Removes the selected property from the grid.

Reference Tab (Filter Properties Dialog Box)

Provides a tree view list of the available reference files you can include in your search.

You can also use the CTRL and SHIFT keys to select multiple objects on this tab.

 To view this tab, you must first insert a file using the Insert > File command.
 When you copy a filter that contains Reference tab information into the Catalog or into a
different Model database, the software removes the Reference tab information. Because of
this, you cannot create a compound filter that uses Reference tab information. Filters that
use Reference tab information are hidden from the tree view on the Compound Filter
dialog box. The compound filter ignores any Reference tab information.

Project Management User's Guide 144

 Reports

Reference 3D Tab (Filter Properties Dialog Box)

Provides a list of all the Reference 3D models you can include in your search.

You can also use the CTRL and SHIFT keys to select multiple objects on this tab.
When you copy a filter that contains Reference 3D tab information into the Catalog or
into a different Model database, the software removes the Reference 3D tab information.

Point Cloud (Filter Properties Dialog Box)

Provides a list of all the registered point cloud vendors. You can reference only one point cloud
object in your search. You cannot select the parent node to filter the search.

To select point cloud objects for filters, you must install the point cloud vendor
software and associate a point cloud model reference with the Model in the Smart 3D Project
Management task.

Configuration Tab
Displays the creation, modification, and status information about an object.
You cannot define the filters using the Configuration tab.
Plant
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the object belongs. You can select another
permission group, if needed. Permission groups are created in Project Management.

Project Management User's Guide 145

 Reports

Transfer
Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group. This option is only available if the active model or
project is replicated in a workshare configuration. The option is not available if all of the
objects in the select set already belong to another location and are non-transferable. For
more information, see Transfer Ownership Dialog Box in the Common User's Guide.
The Transfer option does not apply to the filters and surface style rules.
Approval State
Specifies the current status of the selected object or filter. The display depends on your
access level. You might be unable to change the status of the object. The list is defined by
the ApprovalStatus codelist.
You can only edit or manipulate an object with a status of Working.
Status
Specifies the location of the object in the workflow process. Changing this property sets the
Approval State. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file. For more information, see
ApprovalReason in the Reference Data Guide.
Date Created
Specifies the creation date of the object.
Created by
Specifies the name of the person who created the object.
Date Last Modified
Specifies the date when the object was last modified.
Last Modified by
Specifies the name of the person who last modified the object.

Project Management User's Guide 146

SECTION 8

Permissions, Permission Groups, and

Permission Group Folders
This section describes the following commands:
Permissions (on page 147)
Assigns access permission levels for the model database and the catalog database, as well
as for individual permission groups.
New Permission Group (on page 153)
Defines a group of people. You can then assign specific permissions to this group.
New Permission Group Folder (on page 158)
Organizes permission groups.
Define Permission Group Properties (on page 72)
Creates user-defined properties for a permission group.
Define Permission Group Folder Properties (on page 74)
Creates user-defined properties for permission group folders.
Some permissions are assigned at the SQL server level by a system administrator.
For example, the View server state permission allows users to query the databases for locks
created by other users, such as when you try to open a drawing already opened by another
user. For more information, see Assign Access Permissions for SQL and Assign Server
Permissions for SQL in the Smart 3D Installation Guide.

Permissions
Assigns access permission levels for the model and the catalog, as well as for individual
permission groups. You can also access this command by clicking Edit > Permissions or by
selecting Permissions from the shortcut menu when you right-click a catalog, model, or
permission group in the Project Management tree.
The types of access that you can assign for each user are:
 Read - User is permitted to view objects.
 Write - User is permitted to create, modify, and delete objects.
 Full Control - User is permitted to perform all operations on all objects.
You can assign permissions to users and groups in a manner similar to changing permissions
within the Windows® environment. The level of access that you grant to an individual defines the
actions that are available when that user is working with the software.
Catalog-level permissions control your ability to:
 Create, edit, and delete catalog permission groups

Project Management User's Guide 147

 Permissions, Permission Groups, and Permission Group Folders

 Create, edit, and delete catalog filters

 Bulkload to the catalog
Catalog permission group-level permissions control your ability to:
 Copy, paste, and delete catalog objects in the Catalog task
Model-level permissions control your ability to:
 Create, edit, and delete model permission groups
 Create, edit, and delete model filters
Model permission group-level permissions control your ability to:
 Create, move, modify, and delete catalog objects in the model
 Set object status

 Only users assigned with system administrator, db_owner, or db_accessadmin privileges in

SQL Server can add new users to a Smart 3D database. For more information, see Assign
System Administrator Privileges in the Installation Guide available from Help > Printable
Guides.
 You must use Windows-based domain groups and accounts to administer users in a multi-
machine configuration.
Permission groups that you create in the Project Management task display in the Active
Permission Group box on the horizontal toolbar of Smart 3D. When you create an object in
Smart 3D, the software associates that object with the active permission group.

Approval Status and Permissions

In addition to permission groups, the approval status of an object controls change during the
phases of a project. The approval status for an object can be Working, In Review, Rejected,
and Approved. Approval status is an object property defined in Smart 3D. For example, you can
specify the propagation of properties down the hierarchy, from parents to children. However, if
any of the objects in the hierarchy are set to Approved, the properties are not propagated.
Likewise, objects set to Approved cannot be deleted or updated. For example, if an isometric
drawing is approved, you cannot re-extract the drawing from the model.
You can use the following guidelines to edit the approval status of an object:

Project Management User's Guide 148

 Permissions, Permission Groups, and Permission Group Folders

 When you have Write permission, you can change the status for an object from either
Working to In Review, or from In Review to Working.
 When you have Write permission, you can change the status for an object from Rejected to
Working.
 When you have Full Control permission, you can change an object to any status.

Example
An equipment designer selects the Equipment permission group and places a piece of
equipment in the model. The software automatically associates the equipment with the
Equipment permission group.
Another user who is not a member of the Equipment permission group moves a slab on which
the equipment was placed. Because the user does not have permission, the equipment does not
move to its new location. However, the software adds that equipment the To Do List. Any user
who is a member of the Equipment permission group can accept the change to move the
equipment to its new location by using the To Do List dialog box.

Access Permissions Dialog Box (on page 151)

What do you want to do?

 Assign access permission (on page 149)
 Change level of access permission (on page 150)
 Remove user permissions (on page 150)

Assign access permission

1. Click the appropriate item in the tree view. You can assign access permissions to the model
database, the catalog database, and to permission groups.
2. Click Permissions .
You can also click Edit > Permissions, or right-click the selected item and select
Permissions on the shortcut menu.
The Access Permissions dialog box displays.
3. Click Add.
The Add Users and Groups dialog box displays.
4. Double-click in the User cell in the Add names grid, and then type the Windows domain
and the user or group that you want to add. Use the format <domain name>/<user or group
name>.

 The Add To list is only available when you select multiple users or groups in the Add
Users and Groups dialog box. For more information, see Add Users and Groups dialog
box (on page 151).

Project Management User's Guide 149

 Permissions, Permission Groups, and Permission Group Folders

 You can also click Add and search for users using the Select Users and Groups
dialog box. This is a common Windows dialog box. For information regarding the
options in this dialog box, see your Windows documentation.
 To remove a user or group from the Add names grid, select the appropriate row and
click Remove.
5. In the Type of access list, select the type of access to assign.
The software automatically updates the associated row in the Add names grid.
6. Click OK, then click OK again to close the Access Permissions dialog box.

Change level of access permission

1. Click the appropriate item in the tree view. You can assign access permissions to the model
database, the catalog database, and to permission groups.
2. Click Permissions .
You can also click Edit > Permissions, or you can right-click the selected item
and select Permissions on the shortcut menu.
The Access Permissions dialog box displays.
3. Select one or more users or groups in the grid.
4. In the Type of access list, select the new access type.

Remove user permissions

1. Click the appropriate item in the tree view. You can assign access permissions to the model
database, the catalog database, and to permission groups.
2. Click Permissions .
You can also click Edit > Permissions, or right-click the selected item and select
Permissions on the shortcut menu.
The Access Permissions dialog box displays.
3. Select the user or group to remove from the grid.
4. Click Remove.
You cannot remove all write permissions to the permission group. If you attempt a
change that would remove all permissions, the software displays an error message instructing
you to specify at least one user with full control or write permission.

Project Management User's Guide 150

 Permissions, Permission Groups, and Permission Group Folders

Access Permissions Dialog Box

Provides the options for assigning access permissions and for editing the content of permission
groups. Smart 3D permissions are similar to Windows permissions.
List the users and groups in
Displays the selected model, catalog, or permission group.
Select the user row to adjust access
Lists users, user groups, and their access types.
Add
Displays the Add Users and Groups dialog box, where you can add new user and groups.
For more information, see Add Users and Groups Dialog Box (on page 151).
Remove
Deletes the selected users and groups.
You cannot remove all write permissions to the permission group. If you attempt
a change that would remove all permissions, the software displays an error message
instructing you to specify at least one user with full control or write permission.
Type of access
Assigns the required access level for the selected user or user group. Select Full Control,
Read, or Write.

Add Users and Groups Dialog Box

Adds users and groups to the selected item. This dialog box displays when you click Add on the
Access Permissions dialog box. Adding users and groups in the software works similarly to the
Windows process.
Add names
Displays the list of users and groups that you want to add. Click Add to select and search
for users and groups or type the domain and user name directly into a User cell to add
names to this list.
Only allow users from trusted domains
Restricts entries in the Add names grid to users who are verified and part of the trusted
domain. When you clear this check box, the software allows you to type names of users and
groups into the grid without validating them. For example, if you are setting up global
workshare satellites, you can clear this option so that you can type the satellite user names
into the permission groups.

Project Management User's Guide 151

 Permissions, Permission Groups, and Permission Group Folders

Add
Displays the Windows common dialog box for selecting and searching for users and groups.

Remove
Deletes the selected user or group and permissions from the Add names grid. This option is
only available when a row is selected.
Type of access
Assigns the appropriate access level for the users in the Add names list. Options include:
Full Control, Read, or Write. When you select a type of access, the software automatically
updates the associated row in the Add names grid.
Add To
Lists the following options:
 Objects selected in list view
 All permission groups in site database
 All models in site database
 All catalogs in site database

Project Management User's Guide 152

 Permissions, Permission Groups, and Permission Group Folders

When you select a new value, the associated row in the grid automatically updates. The
Add To column is only available when you select multiple users or groups in the list view.
When you select only one user or group, the option is unavailable and the Add names grid
only displays the User and Type of Access columns.
OK
Places the information in the Add names grid to the Select user row to adjust access grid
on the Access Permissions dialog box.
Cancel
Discards any users or groups that you defined in the dialog box and closes the dialog box.

New Permission Group

Creates a new permission group. A permission group is a portion of the model over which
people have various levels of responsibility or access rights. You can also access this command
by clicking Database > New > Permission Group or by right-clicking a permission group folder
in the Project Management tree and selecting New Permission Group.
By default, the software assigns the permission group creator to the group with Full Control
permissions. You assign additional users and permissions to the group by using Permissions
. For more information, see Permissions (on page 147).
The software places a permission group under a permission group folder in the tree view. You
cannot create permission groups and permission group folders at the same level.

 The permission group hierarchy does not display in Smart 3D tasks. Instead, depending on
the access rights of an individual user, permission groups display on the toolbar and in
Properties dialog boxes.
 You can define custom properties for the permission group using Database > Define
Properties > Permission Group. For more information, see Define Permission Group
Properties (on page 72).
 After you create a new permission group, you can edit the properties assigned to it by
selecting it and clicking Edit > Properties. The properties that you create or modify for a
permission group apply to all the permission groups within the given model. The properties
do not apply to permission groups in other models.

Permission Groups and Routing

Several different users in different permission groups can work together when routing if you
know how the software handles the different situations. Piping fully supports different users who
have different sets of privileges and work on different runs, such as when working in a Global
Workshare Configuration.
The software creates an Intermediate End Feature (IEF) at the end of a pipe run connected to
another pipe run and creates a logical connection between the two IEFs/runs. The legs stop at
the IEF and are not shared between pipe runs. You do not need to create a separate permission
group for the pipe run or the pipe run features. All piping objects can be in the same permission
group.

Project Management User's Guide 153

 Permissions, Permission Groups, and Permission Group Folders

Assignment of Permission Groups

Permission groups are assigned as follows:
 Objects that you create directly are assigned to the active permission group.
 Objects the software creates are automatically assigned a permission group determined by
an internal set of rules. The permission group assigned is not necessarily the active
permission group. Examples of automatically placed objects include connections and a pipe
automatically inserted when two touching valves are separated.
 Parts generated by features are assigned the permission group of the parent feature;
however, runs can be in a different permission group than their collective features and parts.
 End features use the permission group of the run to which they belong.
 Connections use the permission group of the parts to which they are connected. If the
connection is between parts with different permission groups, the permission group to which
you have write access is used. If the connection is between an equipment nozzle and a
route part, the route part permission group is used for the connection.
 Piping connection objects (such as welds, bolt sets, gaskets, and clamps) use the
permission group of the connection that generated the object.

Systems and Permission Groups

A system is a logical grouping of sub-systems. When you add or remove a sub-system, you also
modify the parent system definition. Therefore, you must have write access to the parent
system. You do not need write access to the grandparent system. For example, to create a pipe
run, you need write access to the parent pipeline. However, you do not need access to the
system to which the pipeline belongs.
When participating in a Global Workshare Configuration, you must manage all permission
groups at the host site. The sub-system requirement for write access to the parent system is not
possible if the sub-system's permission group is created at the satellite site and the parent
system's permission group is created at the host site.
For example, your host site is Houston and your satellite site is London. You create a system
called Pipe Rack 100 and its controlling permission group is in Houston. You assign write
access to a user who works in London. During the workshare replication process, the Pipe Rack
100 system and permission group are duplicated in London. The user in London can add
objects such as columns, beams, and braces to the Pipe Rack 100 system because you gave
that user write access to the system's permission group in Houston. The London user cannot
delete or change any of the properties of the Pipe Rack 100 system in London because the host
site, Houston, owns it. He can only add objects to the system. If the London user travels to
Houston and logs on there, that user can delete or change any of the properties of the Pipe
Rack 100 system because the Houston host site owns it.

Example Configuration A
In this example, two users, John and Peter, are working on the same run with exclusive access.
John is responsible for part of the run, and Peter is responsible for the other part of the run.
Neither John nor Peter should be able to modify the work of the other person.
The administrator should configure the permission groups as follows:
 Create three different permission groups: PG-Run, PG-John, and PG-Peter.
 Both John and Peter should have full control access to PG-Run.

Project Management User's Guide 154

 Permissions, Permission Groups, and Permission Group Folders

 John should have full control access to PG-John while Peter should have read-only access
to PG-John.
 Peter should have full control access to PG-Peter while John should have read-only access
to PG-Peter.
The run should be created using the PG-Run permission group. When John works on his parts
of the run, he should use PG-John as the active permission group. When Peter works on his
parts of the run, he should use PG-Peter as the active permission group. The two halves of the
run should connect at a component such as a valve (piping) or a union (electrical).
For example, John routes his part of the run, places a flange, and then places a gate valve.
Peter then places a flange manually connecting to the open port of the gate valve, and then
continues his part of the run.

Example Configuration B
In this example, two users, John and Peter, are working on different but in-line connected runs
with exclusive access. For example, John places an elbow, a straight piece, and a union, then
stops. Peter connects to the open port of the union, and then continues routing. The
administrator should configure the permission groups as follows:
 Create two different permission groups: PG-John and PG-Peter.
 John should have full control access to PG-John while Peter should have read-only access
to PG-John.
 Peter should have full control access to PG-Peter while John should have read-only access
to PG-Peter.
John should create the run using the PG-John permission group and route his part of the run.
When Peter works on his part of the run, he should use PG-Peter as the active permission
group. The Intermediate End Features will handle the connection between the two parts of the
run.

Example Configuration C
In this example, two users, John and Peter, are working on different runs connected by
branching components such as a tee. The administrator should configure the permission groups
as follows:
 Create two permission groups: PG-John and PG-Peter.
 John should have full control access to PG-John; Peter should have read-only access to
PG-John.
 Peter should have full control access to PG-Peter; John should have read-only access to
PG-Peter.
John creates an initial header run using PG-John as the active permission group and routes it
as needed. Peter now wants to branch from John's run. Peter sets PG-Peter as the active
permission group and selects the header in John's run from which to branch. Instead of creating
the header component (such as a tee), the software generates a To Do List item for John.
When John updates the out-of-date To Do List item, the software modifies the header to add
the tee, and then generates a To Do List item for Peter.
When Peter updates his out-of-date To Do List item, the software fixes the branch leg (the end
of the branch leg is adjusted to the tee port). This is called a double hand-shaking mechanism.

Project Management User's Guide 155

 Permissions, Permission Groups, and Permission Group Folders

Example Configuration D
In this example, an administrator has created two separate Windows® Active Directory groups,
each with different permissions, under the model.
 The first Windows® Active Directory group, Group A, has been assigned write privileges to
the permission group, PG-1. A user, John, is a member of this group.
 The second Windows® Active Directory group, Group B, has been assigned read-only
access privileges to PG-1. John is also a member of this group.
 Because John is a member of Group A, which has write privileges, John therefore has write
privileges to PG-1.

Permission Groups and Global Workshare

Permission groups manage the read and write access to all objects across the host and satellite
locations. At the host, you can create/modify permission groups for the satellite locations to have
read or read/write access to various parts of the model data. In general, only one location can
have read/write access to the model object at a time.

 Smart 3D system objects are exceptions to the rule that only one location can have write
access to model objects. Users with write access to the permission group of a system can
add children objects to it regardless of the location of the permission group. However,
properties of the system object can only be modified by a user who has both write access
and is at the same location as the system.
 The Drawings and Reports root node ignores location when determining accessibility. Users
with write access to the permission group of Drawings and Reports root node can add
children objects regardless of the location of the permission group.
 The space folders created on the Space tab of the Workspace Explorer when you first
enter the Drawings and Reports task ignore location when determining accessibility. Users
with write access to the permission group of the space folders can add child objects
regardless of the location of the permission group. Children to these space folders are
added when adding certain nodes in the Drawings and Reports task or when adding drawing
volumes to the model.
When a permission group is created in a model participating in a Global Workshare
Configuration (GWC), it is assigned a location. For a user working at Location1, only the
permission groups that were assigned to Location1 upon its creation are available. As the user
places objects in the model, they are, in turn, associated to a Location1 permission group. You
can, however, use the Project Management task to change ownership of a permission group
from one location to another. Also, a user in any location can transfer a selection set to a
permission group in another location using the Transfer command on the Configuration tab of
the Properties dialog box.

New Permission Group Dialog Box (on page 157)

What do you want to do?

 Create a new permission group (on page 157)

Project Management User's Guide 156

 Permissions, Permission Groups, and Permission Group Folders

Create a new permission group

To add a permission group, click either the default permission group folder or a permission
group folder that you created.
1. Click New Permission Group . You can also select Database > New > Permission
Group.
The New Permission Group dialog box displays.
2. Type a name for the permission group.
3. In the Workshare location list, specify the workshare location where the permission group
should be used.
Use logical permission group names that associate the workshare location with a
permission group. For example, if you create a permission group for structure users located at
the Huntsville location, you can name the group HSV Structure.

New Permission Group Dialog Box

Adds a new permission group to the hierarchy of all the models and permission groups in the
site database.
Property
Displays the permission group properties defined for the database. Name displays by
default.
Properties previously defined by Database > Define Properties > Permission Group also
display. For more information, see Define Permission Group Properties (on page 72).
Value
Specifies the value for the permission group property.
Workshare location
Specifies the workshare location where the permission group is assigned. The list displays
all the location objects that are currently available. An administrator at the host location can
use the list of available location objects to move the selected permission group to another
satellite location within a replicated model.

Project Management User's Guide 157

 Permissions, Permission Groups, and Permission Group Folders

New Permission Group Folder

Creates a new permission group folder that you can use to organize permission groups in
your model. You can also access this command by clicking Database > New > Permission
Group Folder or by right-clicking a catalog or model in the Project Management tree and
selecting New Permission Group Folder from the shortcut menu.
You can use a variety of criteria in creating a permission group hierarchy, as shown in the
following examples.
Hierarchy by department:

Hierarchy by design area:

After you create the hierarchy for your model, you can view and change the permission group
folder properties. For more information, see Properties (on page 31) and Define Permission
Group Folder Properties (on page 74).

 A folder can nest inside a folder.

 You can nest multiple levels of folders.
 You cannot drag folders to other locations within the hierarchy.

New Permission Group Folder Dialog Box (on page 159)

What do you want to do?

 Create a new permission group folder (on page 159)

Project Management User's Guide 158

 Permissions, Permission Groups, and Permission Group Folders

Create a new permission group folder

You must have administrator privileges on the model database in order to create a new
permission group folder.
1. Select a model, catalog, or permission group folder in the tree view.
2. Click New Permission Group Folder on the horizontal toolbar. You can also select
Database > New > Permission Group Folder.
The New Permission Group Folder dialog box displays.
3. Type a name for the permission group folder and click OK.

New Permission Group Folder Dialog Box

Adds a new permission group folder to a model or a catalog. You must have administrator
privileges to use this command.
Property
Displays the permission group folder properties defined for the database. Name displays by
default.
Properties previously defined by Database > Define Properties > Permission Group
Folder also display. For more information, see Define Permission Group Folder Properties
(on page 74).
Value
Specifies the value for the permission group folder property.

Project Management User's Guide 159

SECTION 9

Update Custom Symbol Configuration

Tools > Update Custom Symbol Configuration creates and updates the custom symbol
mapping file, CustomSymbolConfig.xml, in the [Reference Data Folder]\SharedContent\Xml
folder. You can also access this command by selecting Update Custom Symbol
Configuration from the shortcut menu when you right-click a catalog in the Project
Management tree.
The custom symbol mapping file contains the program ID (ProgID), the class ID (CLSID), and
the .dll location for each of your custom symbols. When a custom symbol .dll is added or
updated, run Update Custom Symbol Configuration to update the custom symbol mapping
file. You do not need to register the custom .dlls on local computers.
For more information on symbols, see the Smart 3D Programmer's Guide, located in
the [Product Folder]\Programming\Help folder when you have Programming Resources
installed.

Update Custom Symbol Configuration Dialog Box (on page 163)

What do you want to do?

 Create or update the custom symbol configuration file (on page 160)
 Move custom .dlls to SharedContent folder (on page 161)

Create or update the custom symbol configuration

file
1. Compile custom symbols to create a .dll for each symbol. You can create symbols using
Visual Basic 6, .NET, or Visual C++. For more information, see Move custom .dlls to
SharedContent folder (on page 161).
2. In Windows Explorer, locate the SharedContent folder on the reference data computer.

 In the Address bar, the path must be in the form of a Universal Naming Convention
(UNC). A standard UNC path uses double slashes or double back slashes preceding
the name of the computer. For example, \\server.ingrnet.com\SharedContent, where
\\server.ingrnet.com is the reference data computer name.
 If you are running Oracle on Linux, the SharedContent folder must be on a Windows-
based computer.
3. If you are creating the symbol mapping file for the first time, add a folder under the
SharedContent folder called Custom Symbols.
4. Copy the symbol .dll files into the Custom Symbols folder. You can organize the symbols as
needed, with or without sub-folders.

Project Management User's Guide 160

 Update Custom Symbol Configuration

5. In the Project Management task, select a catalog that uses the SharedContent folder where
your custom .dlls are located.
6. Click Tools > Update Custom Symbol Configuration.
The Update Symbol Configuration dialog box displays.
7. Click Start to begin processing.
When processing finishes, the status bar shows the status of the process as "Successfully
updated the custom symbols configuration file."
If the software finds duplicate ProgIDs between existing symbols in the reference data and
symbols in the Custom Symbols folder, the Update Custom Symbol Configuration
dialog box (on page 163) displays.
8. If there are duplicate ProgIDs, select the .dll to use for each duplicate, and then select
Update.
9. Click Close to close the dialog box.

Move custom .dlls to SharedContent folder

You must save custom .dlls, including delivered .dlls that you have modified, in the [Reference
Data Folder]\SharedContent\Custom Symbols folder on a central reference data server.
Use the following workflow to copy your customized .dlls.
1. Recompile each project in a Version 2016 (11.0) client installation.
2. Copy the new .dlls to the [Reference Data Folder]\SharedContent\Custom Symbols folder.

 You can create hierarchy folders as needed under the Custom Symbols folder.
 If a custom .dll has a localizer .dll, both files must be located in the same folder.
 .dlls ending with "–Ref..dll" or "_Ref..dll" are treated as reference .dlls and are ignored.
Do not copy these .dlls from the client machine containing the Visual Basic source code.
3. Run Tools > Update Custom Symbol Configuration.
Create or update the custom symbol configuration file (on page 160)

 Whenever a symbol or naming rule class is accessed, the software searches for the .dll as
follows:
a. The software checks for the ProgID entry in the xml files. If an entry exists, then the
corresponding .dll is loaded, and an instance of the class is created.
b. If an entry does not exist, the software searches previously registered .dlls on the local
computer.
c. If any entry is not found for the ProgID in either .xml file, and the .dll is also not
registered on the local machine, the software returns an error. In this case, you should
copy the .dll to the [Reference Data Folder]\SharedContent\Custom Symbols folder and
run Update Custom Symbol Configuration in Project Management.

Project Management User's Guide 161

 Update Custom Symbol Configuration

If a ProgID entry exists in the .xml files, that .dll is used even though another or the same
copy of the .dll is registered on the local machine. The order of priority when creating an
instance of an object is: CustomSymbolConfig.xml, SystemSymbolConfig.xml, and then the
registry.
 When you add a new custom .dll to the [Reference Data Folder]\SharedContent\Custom
Symbols folder or modify an existing custom .dll, you must re-run Update Custom Symbol
Configuration in Project Management.
 If a Visual Basic 6 component uses helper classes, and the helper classes are instantiated
by calling CreateObject, you must replace CreateObject. If the helper class is in the
same project, then replace it with new. If the helper class is in a different project, then
replace it with SP3DCreateObject. SP3DCreateObject tries to instantiate the object
using the information in .xml files. If the software does not find an entry in .xml files for the
given ProgID, then it calls CreateObject, and implements SP3DCreateObject in the
[Product Folder]\Core\Runtime\SP3DCoCreateInstance..dll. When SP3DCreateObject
needs to be used, [Product Folder]\Core\Runtime\SP3DCoCreateInstance.dll needs to be
referenced in the Visual Basic project. Example usage of SP3DCreateObject is shown
below:
Set oHelperObject = SP3DCreateObject(strHelperProgId)
 If the Visual Basic 6 symbol class has any public structures or types, they should be made
private. For example:
Public Type InputType
Name As String
Description As String
Properties As IMSDescriptionProperties
uomValue As Double
End Type
Should be changed to:
Private Type InputType
Name As String
Description As String
Properties As IMSDescriptionProperties
uomValue As Double
End Type
 Debugging and maintaining Visual Basic project references, reference .dlls, and binary
compatibility are beyond the scope of this document. Contact your Intergraph Support
representative if you have questions.

Project Management User's Guide 162

 Update Custom Symbol Configuration

Update Custom Symbol Configuration Dialog Box

Specifies the library you want to use for a specific ProgID. This dialog box displays when
duplicate symbol .dlls use the same ProgID.
Select the .dll that you want to use for each ProgID
Displays duplicate ProgIDs in a tree view with the location of each duplicate .dll. The
software selects the most recent custom symbol for each ProgID by default. Change the
default selection as required.

Update
Updates the custom symbol configuration with the selected .dlls.
Cancel
Closes the dialog box without making any changes.

Project Management User's Guide 163

SECTION 10

Upgrade Version
Tools > Upgrade Version in the Project Management task upgrades the selected catalog or
model database to the same version as the site database. This command is also available by
right-clicking an item in the Project Management tree view.
Back up the catalog and model databases before beginning the upgrade
process.
In Project Management, the icon for a model or catalog database that is out of date (that is,
older than the site database to which it is linked) displays in the tree view as a yellow triangle,
such as:

With the software version-to-version upgrade functionality, you can upgrade the databases and
their associated schema metadata to match the currently installed version of the software.
You can start Upgrade Version by selecting different nodes in the Project Management tree
view. The following nodes are available:

 Smart 3D project root folder - Upgrades all of the out-of-date catalog and model
databases available under that site database.
 Reference Data folder - Upgrades all of the out-of-date catalog databases.

 Catalog database - Upgrades the selected catalog database.

 Models folder - Upgrades all of the out-of-date models and their associated catalogs for
the upgrade process.

 Model , , , database - Upgrades the selected model database.

Upgrading your databases from a previous version to the latest installed software version
involves several different upgrade tasks using the Database Wizard and the Project
Management task. You must have the Project Management and Server Connectivity options
installed on the computer you are using to perform the upgrade.
Migrating symbols and updating reference data are detailed processes. For
detailed upgrade information, refer to the Upgrade Guide delivered on the Smart 3D DVD, or
contact Intergraph Support.

Upgrade Version Dialog Box (on page 166)

What do you want to do?

 Upgrade versions for all databases (on page 165)
 Upgrade replicated databases (on page 166)

Project Management User's Guide 164

 Upgrade Version

Upgrade versions for all databases

You can only upgrade a configuration using the same database type. You cannot
upgrade, for example, an older version on a SQL Server database to the current version on an
Oracle database. However, you can use the Database Conversion Wizard to convert SQL
Server databases to Oracle or Oracle databases to SQL Server databases after they have been
upgraded. For more information, see Database Conversion Wizard (on page 397).
Upgrading databases to the latest installed version of the software includes the following
upgrade tasks:
1. Upgrade the site and site schema databases using the Database Wizard. For more
information, see Upgrade a Site Database (on page 393).
2. Upgrade the catalog and catalog schema databases using Tools > Upgrade Version in the
Project Management task.
3. In the tree view, select the catalog database to upgrade.
a. Click Tools > Upgrade Version.
The Upgrade Version dialog box displays.
b. Click OK.
4. Upgrade the model database using Tools > Upgrade Version in the Project Management
task.
a. In the tree view, select the model database to upgrade.
b. Click Tools > Upgrade Version.
The Upgrade Version dialog box displays.
c. Click OK.
5. Migrate the SharedContent.
6. Update the Excel reference data workbooks to fit the current software version.
7. Bulkload delta workbooks.
8. Synchronize the model with the catalog database using the Tools > Synchronize Model
with Catalog in the Project Management task. For more information, see Synchronize
Model with Catalog (on page 117).
9. Regenerate the reports and reports schema databases using Edit > Regenerate Reports in
the Project Management task. For more information, see Regenerate the reports database
(on page 125).

Project Management User's Guide 165

 Upgrade Version

Upgrade replicated databases

Do not deviate from the following sequence of steps. Additionally, do not
proceed to a subsequent step in the workflow until the previous one is complete.
1. Stop the replication process.
Disable the transfer of data between the host server and the satellite servers. For more
information, see Disable replication on a SQL Server instance (on page 185).
2. Upgrade the site and site schema databases.
Using the current version of the software, connect to the host site database through the
Database Wizard and upgrade it to the currently installed version. For more information,
see Upgrade the site and site schema databases (on page 394).
3. Consolidate the replicated databases.
Use Tools > Consolidate Model from Workshare in the Project Management task to
merge all replicated databases at the satellite locations to the databases at the host location
to form a single database of each type. For more information, see Consolidate an existing
SQL Server configuration (on page 186). If you are using Oracle, see Consolidate all Oracle
databases (on page 241).
4. Upgrade the catalog and model databases.
Use Tools > Upgrade Version in the Project Management task to upgrade the catalog and
model databases to the currently installed version. For more information, see Upgrade
versions for all databases (on page 165) in the Project Management User's Guide.
5. Regenerate the reports database.
Right-click the model database in the Project Management tree view, and then select
Regenerate Reports Database. For more information on regenerating a reports database,
see Regenerate the reports database (on page 125).
The database upgrade runs in multiple processes to improve the performance, and is
applicable only for model databases for the current software version. The model upgrade log file
displays the number of processes. For example, "5-5-2016 4:48:59 PM Executing Parallel
MTMC Processing with 4 Processors."

Upgrade Version Dialog Box

Displays all the databases that you want to upgrade. The list includes both out-of-date catalog
and model databases in separate grids. You can upgrade all of the out-of-date databases one at
a time using the Upgrade command. You can also use this command to perform the upgrade on
the Update Custom Symbol Configuration and Regenerate Reports database.
You can select either all the out-of-date databases or only the required database to
upgrade.

Catalog grid
The Catalog grid displays information for all of the out-of-date catalog databases. The following
information displays:

Project Management User's Guide 166

 Upgrade Version

Indicates that a database is out of date.

Check box
Indicates the databases to upgrade.
Catalog Name
Displays the catalog database name.
Version
Displays the catalog database version. Smart 3D updates the version number when the
database upgrade completes.
Status
This column is blank by default. The software updates this column with an icon based on the
upgrade status.

Status Icon

Upgrading

Upgraded

Failed to upgrade

Upgraded, but custom

symbol configuration failed

If the selected catalog database is upgraded successfully but the associated

Custom Symbol Configuration fails, then the out-of-date icon displays.
Log File
Displays the log file icon. Click to open the upgrade log. The icon is only available after
the selected database is upgraded.
Update Custom Symbol Configuration
This option is selected by default when you select an out-of-date catalog to upgrade.
If you clear this option, Smart 3D displays a message warning you that
clearing the option can lead to failure or erroneous upgrade of the databases if some of the
objects try to use updated symbols during the upgrade. Click Yes to proceed if you do not
want to update the custom symbol configuration.
The Update Custom Symbol Configuration and Regenerate Reports options
are selected by default for all the nodes except Reference data root node. Only the
Update Custom Symbol Configuration option is selected for Reference data root node.

Project Management User's Guide 167

 Upgrade Version

Model grid
The Model grid displays information for all of the out-of-date model databases. The following
information displays:

Indicates that a database is out of date.

Check box
Indicates the databases to upgrade.
Model Name
Displays the model database name.
Version
Displays the model database version. Smart 3D updates the version number updates when
the database upgrade completes.
Status
This column is blank by default. The software updates this column with an icon based on the
upgrade status.

Status Icon

Upgrading

Upgraded

Failed to upgrade

Upgraded, but regenerate

reports failed

Log File
Displays the log file icon. Click to open the upgrade log. The icon is only available after
the selected database is upgraded.
Regenerate Reports
This option is selected by default when you select an out-of-date model database to
upgrade. Clear the check box to avoid regenerating the reports.

Upgrade Status
Displays the upgrade status for each database that you upgrade.
Log File
By default, the log file path is '%temp%. Click Browse to change the location of the log file,
if required.

Project Management User's Guide 168

 Upgrade Version

Upgrade
Upgrades the selected model and catalog databases.

 You cannot upgrade the site database using Upgrade Version.

 You cannot upgrade replicated databases that are participating in Global Workshare. These
databases are unavailable whenever Upgrade Version is used. You must consolidate the
databases before you begin the upgrade process.

Project Management User's Guide 169

SECTION 11

Global Workshare
The Global Workshare Configuration (GWC) allows you to share all the data within one model
structure with remote sites. Designed for companies running models from multiple sites (EPCs
or Owner/Operators, for example) or for multiple companies that are working on a single model,
the Global Workshare functions involve a single, central database in which all the changes come
together as if they were created at the same site.
Pivotal in the sharing of data within a workshare environment are the geographical hubs known
as locations. Two types of locations are required in order to share model data among multiple
sites: host location and satellite location. The host location is a set of one or more database
servers on a local area network (LAN) that contains the original set of databases associated with
a site. The satellite location is a set of one or more database servers on a LAN that contains the
replicated database associated with a site.
The host location is created automatically during generation of the site database using the
Database Wizard. As such, the host location is the first location created. It is the site database
generation process that also governs such things as the name, name rule ID, and server of the
host location.
For more information about the site database generation process, see the Installation
Guide available from Help > Printable Guides.
Satellite locations, on the other hand, are created manually within the Project Management task
using the Database > New > Location command on the host. You must have administrator
privileges on the Site database to create a new location. After they are created, locations can be
associated with permission groups and models as part of the workshare replication process.
In the Global Workshare solution, data sharing between different locations is achieved through
real-time model database replication of the entire model at all satellite locations. The catalog
and catalog schema databases and the site and site schema databases are maintained on the
host server while satellite locations have a read-only replication of these databases. Reports
databases are regenerated (not replicated) at each satellite location.
Multiple models (in the same Site and Site schema) can be configured for Global
Workshare provided they use the same set of locations as the first GWC. However, not all
locations have to be involved in all workshares.

Project Management User's Guide 170

 Global Workshare

The following diagram illustrates the Global Workshare Configuration:

The site, site schema, catalog, and catalog schema databases are replicated in a one-way
fashion. The one-way replication copies data from the host database server to each of the
satellite servers, but it does not copy data from each satellite database back to the site, site
schema, catalog, or catalog schema on the host server.
The implications are that all reference data modifications and permission group management
must be performed at the host location for propagation to the satellite locations.

 The SharedContent folder should be modified to point to a unique server at each of the
satellite locations.
 Inserted reference files, which should be available at satellite locations, must be located in
the SharedContent and be manually distributed to each satellite location. For more
information about inserting files, see the Common User's Guide available from Help >
Printable Guides.
 In a local area network (LAN) setup where multiple servers are being used in the same LAN,
it is recommended that catalog databases in the host/satellite workshare point to the same
SharedContent folder.
 In a wide area network (WAN) setup where multiple servers are spread across low
bandwidth connections (ISDNs, Fractional T1s, and so on), it is recommended that catalog
databases in the host/satellite workshare set point to a "close" SharedContent that exists on
the same LAN as the database referencing it.

Project Management User's Guide 171

 Global Workshare

The model database is replicated in a two-way fashion with each satellite. Data is replicated
between the host and each satellite. As a result, all satellite data is sent to the host, and then re-
distributed from the host to the other satellites. Because of this form of replication, any work
performed in the model at any location results in the same data being pushed to all databases
that participate in the GWC.

 After the GWC is established, use the backup tools in the Project Management task to
create a backup set of the replicated databases from all locations. In the event of a
corruption of data, you can recover the databases participating in the GWC and resume the
replication by using any backup in the workshare.
 Configuring Global Workshare within an integrated environment is a detailed and
complicated process. For more information, contact Intergraph Support at
http://www.intergraph.com/support.

Network Requirements
Global Workshare requires a fractional T1 (256-384 Kbps) connection for large projects.
Replicating data between the host and satellite is a latency-bound task, so increasing the
bandwidth does not increase the replication delivery speed. Increasing the bandwidth can be
helpful at setup time, but not over the course of the project.
The network latency between a workstation client and the local database server needs to be as
low as possible.

Virtualization
It is possible to use virtual servers to implement a database server. You must test and verify that
the environment is suitable for a production project and that the configuration allows you to
reach your milestones on time. Performance or incompatibility problems could delay you. In
most cases, the major performance bottleneck is caused by poor I/O which could be the result of
improper hard drive configuration or overloading shared resources in the virtual server.

Global Workshare and SQL Server Databases

Before starting your configuration for Global Workshare with SQL Server, you need to decide
how the data is managed or controlled.
For the Catalog, Catalog schema, Site, and Site schema, the Host should control the data. The
other machines are Satellites of the Host. The Host is a Publisher of Catalog, Schema, and
Model data to the Satellites and a Subscriber of Model data from the Satellites. The Satellites
are Subscribers to the Host for Catalog, Schema, and Model data. They are Publishers of
Model data to the Host. In small and midsize configurations, the database server is usually its
own distributor. However, in the case of large configurations or multiple smaller configurations, it
is possible to use a dedicated distributor server. You can specify whether you want to use a
dedicated distributor server when you configure the SQL Server Distributor Agent.

One-Way Transactional Replication

Using One-Way Transactional Replication, you have a Host machine for your Catalog, Catalog
schema, Site, and Site schema. This means that the Host machine communicates information to
your Satellite machines, but the Satellites do not communicate information back to the Host. The

Project Management User's Guide 172

 Global Workshare

Host machine is the Publisher, and the Satellites are Subscribers. The communication is all one-
way from the Host to the Satellites.

Two-Way (Peer-to-Peer) Replication

For the Model database, you set up Two-Way (Peer-to-Peer) Replication. The Host machine
operates as both a Publisher and a Subscriber, pushing information to the Satellites and
receiving changes from them. Likewise, your Satellite machines are Publishers and Subscribers
so they can communicate changes to the Host and receive information from the Host. The
communication is two-way.

The following workflow steps pertain only to configuring Global Workshare for SQL Server
databases.
Project administrators manage all Satellite creation and administration from the Host location,
and use permission groups to determine data access for both Host and Satellite locations.
The term "Peer-to-Peer" in SQL Server documentation is what we refer to as "Hub
and Spoke" configuration.
The procedures below assume some familiarity with the Project Management environment for
Global Workshare and are targeted to specific SQL Server settings. For more information, see
your Microsoft SQL Server documentation.

Set Up a Configuration of Replicated Servers

Several steps are involved when setting up a first-time configuration of replicated servers for
SQL Server.

Project Management User's Guide 173

 Global Workshare

The SQL Server Replication feature must be installed on the SQL Server instance set
up for the Global Workshare configuration.
1. Configure each server for replication.
2. Set up a SQL Server Distributor Agent.
3. Create a profile for the distributor agent.

Set Up Global Workshare with SQL Server

After you create the SQL Server Distributor Agent, you can set up the Global Workshare
configuration (GWC) for the SQL Server databases.
For information on setting up permissions for your data, see Permission Groups and
Global Workshare.

Set Up Replication Using the SQL Server Wizard

You need to set up one-way replication subscriptions for the Catalog, Catalog Schema, Site,
and Site Schema. For the Model, use Peer-to-Peer, two-way replication.
 Set Up One-Way Subscriptions for SQL Server
 Set Up Two-Way Replication between SQL Server Models

Regenerate Reports Databases

For performance reasons, the Reports and Reports schema databases are not replicated from
the Host location. Instead, at each Satellite location you must point to the Site and Site schema
databases on the respective servers, right-click the model in the Project Management tree view,
and then select Regenerate Reports Database.

Add Satellites to Existing Global Workshare Configurations

After you have set up a Global Workshare configuration with SQL Server, you can add new
Satellite locations to the existing configuration.

Remove Replication between a Host and a Satellite

You can remove the replication between a Host and a Satellite in a Global Workshare
configuration with SQL Server.
You can also consolidate an existing configuration, or remove all replicated Satellites.

Disable Replication on a SQL Server Instance

If you need to "start from scratch", it can be useful to completely disable all replications within a
SQL Server instance.

Monitor Replication in SQL Server

You can use the SQL Server Management Studio to monitor replication activity.
Configuring Global Workshare within an integrated environment is a detailed and
complicated process. For more information, contact Intergraph Support at
http://www.intergraph.com/support.

Project Management User's Guide 174

 Global Workshare

What do you want to do?

 Configure each server for replication (on page 175)
 Configure the SQL Server Distributor agent (on page 176)
 Set the SQL Server Distributor agent profile (on page 178)
 Set up Global Workshare with SQL Server (on page 178)
 Set up two-way replication between SQL Server models (on page 179)
 Set Up one-way subscriptions for SQL Server (on page 180)
 Restore a satellite for SQL Server replication (on page 182)
 Regenerate the reports database (on page 125)
 Add an additional satellite to an existing SQL Global Workshare Configuration (on page 184)
 Disable replication on a SQL Server instance (on page 185)
 Monitor replication in SQL Server (on page 185)
 Remove SQL Server replication (on page 185)
 Consolidate an existing SQL Server configuration (on page 186)

Configure each server for replication

All SQL Server servers that will take part in replication should be registered through the
Microsoft SQL Server Management Studio. For more detailed information on the Microsoft
SQL Server Management Studio, see your SQL Server documentation.
1. In the Microsoft SQL Server Management Studio, expand Database Engine in the
Registered Servers window.
2. Right-click Local Server Groups, and select New Server Registration.

Project Management User's Guide 175

 Global Workshare

3. On the New Server Registration dialog box General tab, specify the name of the SQL
2014server that will participate in replication.
4. Click Save.

 When you select an SQL Server in the Registered Servers window, check the Object
Explorer window to make sure that the SQL Server Agent is running.
 Make sure that the SQL Server Agent is running on all the database servers and that it
is running using an account that has access to all the database servers. Do not use the
local system account.
i. Select Control Panel > Administrative Tools > Services.
ii. Right-click SQL Server Agent, and select Properties.
iii. On the General tab, select Automatic as the Startup type.
iv. On the Log On tab, select This Account, and type a user name and password for a
user that has access to the other database servers.
 You can use Start > All Programs > Microsoft SQL Server > Configuration Tools >
SQL Server Configuration Manager to check the status of the SQL Server Agent. For
more information, see your SQL Server documentation.

Configure the SQL Server Distributor agent

The SQL Server Replication feature must be installed on the SQL Server instance set
up for the Global Workshare configuration.
You must configure the distributor on each server participating in replication.
This must be done before you start replication. For more detailed information on the Microsoft
SQL Server Management Studio, see your SQL Server documentation.
1. In the Microsoft SQL Server Management Studio, right-click Replication in the Object
Explorer window, and select Configure Distribution to start the Configure Distribution
Wizard.
2. On the introduction page of the Configure Distribution Wizard, click Next.

Project Management User's Guide 176

 Global Workshare

3. On the Distributor page of the wizard, specify that each server will be its own distributor,
and then click Next to continue.

Optionally, you can configure a dedicated Distributor server for large or complex
configurations.
4. On the SQL Server Agent Start page, select Yes, configure the SQL Server Agent
service to start automatically and click Next.
5. The next page of the wizard is the Snapshot Folder page. By default, the wizard points to a
local folder on the server. Because the current version of Smart 3D does not support pull
subscriptions for one-way replication or merge replication, pointing to a local folder is
acceptable. Click Next to continue.
6. On the Distribution Database page, configure the distribution database, and then click
Next.
For better performance, make sure the two folders specified are on drives that have
ample free disk space and are not the computer's system drive.
7. Complete the remaining wizard pages as necessary for your situation and complete the
configuration.
After you configure the SQL Server distributor, set up the distributor agent profile. For more
information, see Set the SQL Server Distributor agent profile (on page 178).

Project Management User's Guide 177

 Global Workshare

Set the SQL Server Distributor agent profile

You must configure the distributor on each server participating in replication. This must be done
before you start replication. For information on configuring the distributor, see Configure the
SQL Server Distributor agent (on page 176). For more detailed information on the Microsoft
SQL Server Management Studio, see your SQL Server documentation.
Repeat the procedure below for each registered server that participates in replication.
1. In the Microsoft SQL Server Management Studio, right-click Replication in the Object
Explorer window, and select Distributor Properties.
The Distributor Properties dialog box appears.
2. Select the General page, and click Profile Defaults in the Agent Profile section of the
page.
3. On the Agent Profiles dialog box, select the Distribution Agents page, and click New in
the Agent Profiles section of the page.
4. In the New Agent Profile dialog box, select Distribution Profile for OLEDB Streaming,
and click OK.
5. Set up the new agent profile as needed. For example: specify the name as "Sp3dProfile"
and set an appropriate value (2601:2627:50000:20598:532) for the SkipErrors profile
parameter. Click OK to accept the new profile settings.
The Agent Profiles dialog box now shows the new profile in the Agent profiles list.
6. Select the new profile and click Change Existing Agents.
SQL Server updates all existing Distribution Agents to use the specified profile.
7. Click OK to close the dialog box, and then click OK again to return to the Object Explorer
window.

Set up Global Workshare with SQL Server

After you set up the SQL Server database servers, you can use the Project Management task to
set up Global Workshare.
1. Add the Satellite locations and associate them with the name of the SQL Server database
server. For more information, see New Location (on page 42).
2. Back up the SQL Server database.
3. Run Tools > Duplicate Model for Workshare. For more information, see Duplicate Model
for Workshare (on page 201).
The Duplicate Model for Workshare command generates scripts that you must
run to complete the process. The scripts are located in a subfolder named
Replication<ModelName> in the local the temp folder. You can click Start > Run and type
%temp% in the Run dialog box to locate the local temp folder.
4. From a DOS command line, run the ToRunPreBackup.bat file on the Host machine.
You may want to redirect the output to a log file to check for errors later. For
example: ToRunPreBackup.bat >out, which would output to a file called out.log.
5. Make a second backup of the databases and transfer the backup files to all Satellite
locations.

Project Management User's Guide 178

 Global Workshare

6. Restore the backups to all satellite locations.

7. From a DOS command line, run the ToRunPostRestore_n.bat file (where n is the Satellite
number on the model) for each location. These batch files can be run from the Host location
or remotely to the other servers.

Set up two-way replication between SQL Server models

You use the Microsoft SQL Server Management Studio to set up two-way subscriptions for
the Model. For more information on the Management Studio, see your SQL Server
documentation.
The following procedure must be performed on the host machine.
1. From Microsoft SQL Server Management Studio, in the Object Explorer, right-click the
publication created on the host machine for the appropriate database.
2. Expand Replication > Local Publications.
3. Right-click the Model database, and select Configure Peer-to-Peer Topology.
The Peer-to-Peer Topology Wizard appears.
4. Click Next to go to the Publication page of the wizard. Select the publication to which to
add a new subscriber and click Next.
5. Right-click an empty area on the Configure Topology page, and select Add a New Peer
Node.
The Connect to Server dialog box displays.
6. Select the first satellite in the Server name list, and then click Next.
The Add a New Peer Node dialog box displays.
7. Select the Model database from the Select Database list. Set the Peer Originator ID to 2
for the first satellite, and then click OK to close any open dialog boxes.
The wizard returns to the Configure Topology page.
8. Repeat steps 5 through 7 to add more satellite servers.
Increment the Peer Originator ID in step 7 for each new satellite server
you add. For example, set the Peer Originator ID to 3 when you add a second satellite.
9. On the Configure Topology page, right-click the Host server icon and select Add a New
Connection.
A small arrow displays.
10. Extend the arrow to the first satellite server you added.
11. Repeat the previous two steps for each satellite you added.
To set up a Hub and Spoke configuration, make connections only between the
host and each satellite. Do not connect a satellite to another satellite.
12. Optional: To configure a pull subscription for a satellite, right-click the arrow that links the
host to that satellite, and then select Use Pull Subscription.
Although a pull subscription is more difficult to manage than a push subscription,
a pull subscription delivers better replication performance on a high latency network.

Project Management User's Guide 179

 Global Workshare

Consider using a pull subscription if the network latency is greater than 100 ms, such as
when servers are located on different continents.
13. On the Log Reader Agent Security page, specify how the Log Reader Agent connects to
each server. Click the ellipsis button to set up the connection information for each server on
the Log Reader Agent Security dialog box. If the same user can connect to the host and
satellite, check Use the first peer's security setting for other peers.
14. Specify a user name and password for the Log Read Agent process. Click OK to accept the
settings and return to the wizard.
15. Click Next on the Log Reader Agent Security page to continue to the Distribution Agent
Security page, where you can specify a different user for each server or select the Use the
first peer's security settings for all other peers check box.
If you click the ellipsis button, the Distribution Agent Security dialog box displays, allowing
you to specify who can connect to the distributor. For the Connect to the Subscriber
section, specify who has enough access on the remote server. Click OK to return to the
Distribution Agent Security wizard page, and then click Next to continue through the
wizard.
You can configure the distribution and log reader agent security details to run
under the SQL Server Agent service account if all necessary database privileges are met for
the actions that the agents will perform.
16. On the New Peer Initialization wizard page, we recommend that you select I restored a
backup of the original publication database, and the publication was changed after
the backup was taken, and then specify the location of the Model backup that was
transferred to the other locations. Consult the SQL Server documentation for more
information.
Select I created the peer database manually, or I restored a backup of
the original publication database which has not been changed since the backup was
taken only if you are sure that no one has worked on the Model (including quick test), and
that no services (such as Interference Checking Service) were running on the Model since
the backup. However, we recommend that you select I restored a backup of the original
publication database, and the publication was changed after the backup was taken
because any problems caused by choosing the first option might not appear for weeks.
17. Click Next to continue.
18. Verify the choices you made in the wizard, and click Finish to process the peer-to-peer
configuration.

Set Up one-way subscriptions for SQL Server

You use the Microsoft SQL Server Management Studio to setup one-way subscriptions for
the Catalog, Catalog schema, Site, and Site schema. For more information on the Microsoft
SQL Server Management Studio, see your SQL Server documentation.
Each user you specify in the wizards referenced in this procedure must have
administrator privileges to connect to each server.
1. From Microsoft SQL Server Management Studio, connect to the Host machine.
2. In the Object Explorer, right-click the publication created on the Host machine for the
appropriate database.

Project Management User's Guide 180

 Global Workshare

3. Expand Replication > Local Publications.

4. Right-click the Site, and select New Subscriptions.
The New Subscription Wizard appears.
5. Click Next to go to the Publication page of the wizard. Select the publication to which to
add a new subscriber, and click Next.
6. On the Distribution Agent Location page of the wizard, select Run all agents at the
distributor, and then click Next.
7. On the Subscribers page, select the remote server name. Do not check Subscriber for the
Host machine. If you have more than one Satellite, select Add Subscriber and add all of
the Satellite locations (one at a time) before continuing.
8. When you are finished adding Subscribers, click Next to continue.
9. On the Distribution Agent Security page, specify the security information for each
subscription. Click the ellipsis button to display the Distribution Agent Security dialog box.
Specify only users that can connect to the distributor. For Connect to the Subscriber,
make sure you specify a user with enough access on the remote server. If you have more
than one subscriber (Satellite), do this for each subscriber. Click OK to accept your security
settings, and then click Next to continue through the New Subscription Wizard.
The distribution and log reader agent security details can be configured to run
under the SQL Server Agent service account provided all necessary database privileges are
met for the actions that the agents will perform.
10. The next page of the wizard is the Synchronization Schedule page. The most common
selection is Run continuously, but you should set it as needed for your database setup.
Click Next.
11. On the Initialize Subscriptions page, if you are sure the databases have not been modified
since the backup, clear the Initialize check box for the Catalog, Catalog schema, and Site
schema, and click Next.
Clearing the Initialize check box allows the subscription to start faster as
no data needs to be sent to the server. However, if the data has changed since your
backup, the remote server will not receive the changes. We strongly recommend avoiding
modification of the databases and using the "quick start without initialization" option,
especially in the case of larger databases, such as the Catalog database.
12. Click Next to Create the subscriptions, and then Finish on the final wizard page. The final
wizard page should display a Success status when the subscription is created.
13. Run the New Subscription Wizard again for the Site schema, Catalog, and Catalog
schema. Do not create a subscription for the Model database.

Project Management User's Guide 181

 Global Workshare

Restore a satellite for SQL Server replication

The tasks below are for restoring and restarting global workshare for SQL Server databases. Do
not deviate from the following sequence of steps. Additionally, do not proceed to a subsequent
step in the workflow until the previous step is complete.

Restore the Model

1. Stop the replication between the Host and Satellite.
2. Make a backup of the Host.
3. Send the backup of the Host to the Satellite.
4. Delete the database(s) at the Satellite.
From this point on, the following steps are the same as adding a new satellite.
5. Restore the backup of the Host.
6. Run the script PostRestore_[N].sql (where [N] is the satellite number on the Model).
7. Restore the peer-to-peer SQL replication between the Host and Satellite.

Restore the Catalog, Catalog Schema, Site, and Site Schema

1. Stop the replication between the Host and Satellite.
2. Make a backup of the Host.
3. Send the backup of the Host to the Satellite.
4. Delete the database(s) at the Satellite.
From this point on, the following steps are the same as adding a new satellite.
5. Restore the backup of the Host
6. Restore the SQL transactional replication between the Host and Satellite.

Regenerate the reports database

Before starting this procedure, check with your administrator to verify that all
users are disconnected from the database.
1. Select a model database in the Project Management tree view.
2. Click Edit > Regenerate Reports Database.
The Regenerate Reports Database dialog box displays.
3. Review and, if necessary, edit the information displayed for the reports databases and
servers.
4. Click OK to regenerate the reports database.

 Reports databases must have unique names. If the reports database name you specify
already exists, the software prompts you to either rename the database or reuse the existing
reports database.

Project Management User's Guide 182

 Global Workshare

 If the software is unable to successfully create the reports schema, an error message
displays and the process ends.

Install and configure the Duplication Synchronization

Service (DuSS)
The Duplication Synchronization Service (DuSS) works with the database replication service to
maintain a healthy model at each Global Workshare Configuration location. If users at different
locations are working on unrelated objects within the model, or if they are working on related
objects at different times, the basic replication engine handles everything, and the DuSS is not
activated. However, if users at different locations are working on closely related objects in a
model at the same time, the DuSS is required to step in and resolve conflicts by preventing
certain inconsistencies and ensuring that the model data is accurate at all locations. The DuSS
must be configured and running at each location within a Global Workshare Configuration. You
must activate the DuSS at the Host and each Satellite location at the end of the Global
Workshare setup.

Configure the Duplication Synchronization Service

1. Log on as an administrator on the local computer and add [Product
Folder\Smart3D\Core\Runtime] to environment path variable.
2. Click Start > All Programs > Accessories > Command Prompt.
If the computer is running on a Windows 7 or Windows Server 2012 operating
system, you must open a command prompt with full administrator permissions. Type CMD in
the Run dialog box, and press CTRL + SHIFT + ENTER.
3. Use the cd command to switch to <Installation folder>\ProjectMgmt\Middle\bin.
4. Type the following command line:
DuplicationSyncService.exe –I
To uninstall the Duplication Synchronization Service, type the following command
line:
DuplicationSyncService.exe –u
5. Close the Command Prompt window.
6. Open Start > All Programs > Intergraph Smart 3D > Database Tools > Modify Database
and Schema Location and set the Site database connection that needs to be processed by
DuSS.
The Site database information must be set with the user account that is running
the DuSS service.
7. Click Start > Run. Type services.msc, and then click OK.
The Services window is displayed.
8. In the Services window, right-click S3D Duplication Synchronization Service and select
Properties.
9. Select the Log On tab and type a user who has local machine administrator privileges and
access to Smart 3D databases.
10. On the General tab, set the Service to Automatic, and then select Start.

Project Management User's Guide 183

 Global Workshare

11. Click OK.

12. Open Project Management while connected to the Host server.
13. Right-click the model to configure for DuSS, then select Properties.
14. Under the Databases tab, scroll to the Node for Duplication Synchronization Service
column, and type the name of the corresponding computer where the DuSS service was
installed for Host and Satellite servers.

 You must install Smart 3D software on the DuSS configured computer.

 If you have the Global Workshare environment on different Smart 3D software versions, then
you must install a separate DuSS service for each version.

Monitor the Duplication Synchronization Service

The DuSS writes status information to log files that are located in the temp folder on the
computer where the DuSS is running. The two log files used are Duss.logA and Duss.logB. The
status information is written to one log file until it reaches a maximum size, and then the service
switches over to use the other log file. Each time a log file is reused, the previous data is
overwritten. In this way, the recent activity is always recorded without allowing the log files to
become huge. You can monitor the DuSS activity by reviewing these log files.

Add an additional satellite to an existing SQL Global

Workshare Configuration
1. Use the New Location command to add the location for the new Satellite. For more
information, see New Location (on page 42).
2. Run Tools > Duplicate Model for Workshare. For more information, see Duplicate Model
for Workshare (on page 201).
The Duplicate Model for Workshare command generates scripts that you run to
complete this procedure. The scripts are located in the
AddSatellite<LocationName>_<ModelName> subfolder in the local temp folder. You can
click Start > Run, and type %temp% in the Run dialog box to locate the local temp folder.
3. Back up the Model.
4. Transfer the backup to the new Satellite location, and restore the backup.
5. Run the ToRunPostRestore_1<LocationName>.bat file.
You may want to redirect the output to a log file to check for errors later. For
example: ToRunPostRestore_NewLocation.bat > out.log, which would output to a
file called out.log.
6. Set up the appropriate subscriptions between the Host machine and the new Satellite
following the instructions in one of the following topics:
Set Up one-way subscriptions for SQL Server (on page 180) - Make sure you specify to
Initialize the subscription as you go through the New Subscription Wizard.
Set up two-way replication between SQL Server models (on page 179) - For the Model
database, on the Peer-to-Peer Topology Wizard > New Peer Initialization page, select
the second option for a restored backup of an original publication database.

Project Management User's Guide 184

 Global Workshare

You can add a Satellite without shutting down all the activities at the other
locations. However, make sure the correct options are selected in the SQL Server wizards.
Refer to your SQL Server documentation for more information on the New Subscription
Wizard and the Peer-to-Peer Topology Wizard.

Disable replication on a SQL Server instance

If you need to "start from scratch", it can be useful to completely disable all replications within a
SQL Server instance.
For more information on the Microsoft SQL Server Management Studio, see your SQL Server
documentation.
1. Open Microsoft SQL Server Management Studio. In the Object Explorer, expand the
server instance name you want to disable.
2. Right-click Replication, and select Disable Publishing and Distributor.
3. Follow the instructions in the SQL Server wizard.
If a database uses two-way replication, as with the Model database, you still have to
remove the replication coming from the other servers before you can delete the database.

Monitor replication in SQL Server

You can use the Microsoft SQL Server Management Studio to monitor replication activity. For
more information on the Microsoft SQL Server Management Studio, see your SQL Server
documentation.
1. From the Microsoft SQL Server Management Studio, in the Object Explorer, expand the
server instance name that you want to monitor.
2. Right-click Replication, and select Launch Replication Monitor.

 One very useful feature of the Replication Monitor is "tracer tokens" which allow you to
measure the latency between the Publisher, Distributor, and the Subscriber. It is also useful
to check the activity levels between the servers.
 You can also use the Warnings and Agents feature to configure alerts so an administrator
can be notified by e-mail of any agent failures.

Remove SQL Server replication

Refer to your SQL Server documentation for more detailed information concerning the SQL
Server steps in the following procedures.
In the following procedures, only delete the subscriptions relative to the Satellite that
you want to remove. If you accidentally delete a subscription, you will have to send a backup to
the other location and add the new subscription back in the Microsoft SQL Server
Management Studio to recover the deleted subscription.

Delete a Subscription at the Host

Repeat the following steps for each server as needed: Catalog, Catalog schema, Model, Site,
and Site schema.

Project Management User's Guide 185

 Global Workshare

1. In the Microsoft SQL Server Management Studio, select the Host server, and expand the
Replication folder in the Object Explorer window.
2. Under Replication, further expand the Local Publications folder.
3. Right-click the subscription corresponding to the remote server to remove, and select
Delete.
4. On the confirmation dialog box, select Connect to Subscriber and delete record of this
subscription at Subscriber also, and click Yes to confirm the deletion.
If you do not have access to the subscriber, you cannot delete the record
remotely. You have to gain access to the subscriber and remove the subscriptions from it
directly.

Delete Subscriptions at the Satellites

This procedure is for the Model database only.
1. In the Microsoft SQL Server Management Studio, select the Satellite server, and expand
the Replication folder in the Object Explorer window.
2. Under Replication, further expand the Local Publications folder.
3. Right-click the subscription corresponding to the Host to remove, and select Delete.

Delete the Unused Publication from the Satellite

1. In the Microsoft SQL Server Management Studio, select the Satellite server, and expand
the Replication folder in the Object Explorer window.
2. Under Replication, further expand the Local Publications folder.
3. Right-click the appropriate publication, and select Delete.
If you do not delete the publication, SQL Server will not allow you to delete or restore
the database from another backup.

Remove the Global Workshare Configuration between the Host and Satellite
In Project Management, use the Tools > Consolidate Model from Workshare command to
remove the Global Workshare configuration between the Host and Satellite. For more
information, see Consolidate Model from Workshare (on page 199).

Consolidate an existing SQL Server configuration

Refer to your SQL Server documentation for more detailed information concerning the SQL
Server steps in the following procedure.
1. In the Microsoft SQL Server Management Studio, remove the replication between the
Host and all Satellite locations. For more information, see the Delete a Subscription at the
Host section in Remove SQL Server replication (on page 185). Follow the steps for each
Satellite location in the Global Workshare configuration.
2. Under Replication, further expand the Local Publications folder.
3. Right-click the publications, and select Delete for each.

Project Management User's Guide 186

 Global Workshare

4. In Project Management, use the Tools > Consolidate Model from Workshare command
to remove the Global Workshare configuration between the Host and one or more Satellite
locations. For more information, see Consolidate Model from Workshare (on page 199).

SQL Database Maintenance

SQL Server contains additional maintenance procedures that can improve database
performance. These procedures are performed directly in SQL Server—not in the Smart 3D
software—and are performed by a SQL administrator. Detailed procedures are not described in
this section.

Backing Up Transaction Logs

Transaction logs are backed up to release space on the transaction log file and to prevent
indefinite growth.
In a Global Workshare environment, transaction log backups are only needed for the set of host
databases. These databases experience the largest log file growth due to the Recovery Model
property being set to Full. For more information, see Recovery Models (SQL Server) in SQL
Server Help.
Transaction log backups are not used for restoring databases. You should
schedule Smart 3D backups for disaster recovery. For more information, see Backup (on page
97) in the Project Management User's Guide.
You can create a single maintenance plan for multiple databases (such as the site, site schema,
catalog, catalog schema, and model that comprise a standard Smart 3D database set), or create
a separate maintenance plan for each database.
For more information, see Maintenance Plan Wizard in SQL Server Help.

Updating Statistics to Optimize Queries

The SQL Server Query Optimizer uses database statistics to efficiently retrieve and update data.
The Query Optimizer automatically updates statistics. You can also manually update statistics
more frequently to improve query performance, especially when creating and updating drawings.
You can use UPDATE STATISTICS or the Transact-SQL stored procedure sp_updatestats.
For more information, see Statistics Used by the Query Optimizer and UPDATE STATISTICS
(Transact-SQL) in SQL Server Help.

Catalog Data Recovery for SQL Server

The workflow in this topic explains how to recover catalog data if there is a mismatch of
information for the Catalog or Catalog schema databases between the Host and any of the
Satellite locations in a Smart 3D Global Workshare environment. This workflow does not affect
the replication of the Site or Model databases and involves a much smaller maintenance window
than what is required when performing the full consolidation and duplication workflows used to
recover a lost Satellite.
Recovery of catalog data consists of removing the replication link (represented by the
subscriptions) that exists for the Catalog and Catalog schema databases. Removing these
subscriptions is necessary so that the databases can be overwritten during the restore operation
at the Satellite location. After the replication link is down, a backup of the Catalog database is

Project Management User's Guide 187

 Global Workshare

made at the Host. This backup is then transferred to the Satellite location where it is restored,
and the replication link is subsequently re-established.
The Catalog and Catalog schema databases must be recovered as a pair,
even when only one of the databases is presenting a problem.
1. Suspend any activities that write data to the Catalog database at the Host. These activities
include, but are not limited to, the following:
 Bulkloading data into the catalog.
 Creating catalog filters.
 Using the Copy to Catalog command to copy assemblies into the catalog.
 Modifying catalog data in the Catalog task.
Modeling activities can continue during the recovery workflow as long as they do
not modify the Catalog or the Catalog schema.
2. At the Host and the Satellite location, make a backup of the Catalog database involved in
the operation. This backup serves as a fail-safe recovery point. For more information, see
Create a backup file (on page 99) in the Project Management User's Guide.
3. In the Microsoft SQL Server Management Studio, connect to the Host location and then
remove the replication link between the Host and the Catalog and Catalog schema
databases at the Satellite location being repaired. For more information, see Delete a
Subscription at the Host in Remove SQL Server replication (on page 185).
If there are multiple Satellite locations, delete only the subscriptions for the
Satellite location at which catalog is being recovered.
In the example below, the Catalog and Catalog Schema subscriptions outlined in red are
being removed:

Do not delete the publication of the Catalog or Catalog schema databases

(represented with the icon). Deletion of publications aborts the recovery workflow and
requires a full consolidation and duplication of the Model at the Satellite location.

Project Management User's Guide 188

 Global Workshare

4. In the message box that displays, make sure Connect to Subscriber and delete record of
this subscription at Subscriber also is selected, and then click OK.
To allow deletion of subscription records, the Satellite server must be running and
accessible. Otherwise, these records must be deleted manually at the Satellite.
5. If prompted, provide login details for the Satellite server.
Only the subscriptions for the Model, Site, and Site schema databases remain, as shown in
the example below:

6. At the Host location, navigate to the destination folder that you specified when the backup
file was created, and then locate the .dat file for the catalog.

7. To send the backup file to the Satellite location, create a .ZIP file that contains only the
compressed Catalog file data.
8. At the Satellite location, integrate the Catalog database backup file that was transferred from
the Host into one of the Satellite backups.
When the integration is complete, the backup at the Satellite location consists of the four
files required for a Smart 3D backup; however, the Catalog database contains the
information from the Host server.
9. Open the Project Management task at the Satellite location.

Project Management User's Guide 189

 Global Workshare

10. Click Tools > Restore, and select the Restore one or more Model databases from
backup option to restore the catalog. For more information, see Restore a model from
backup (on page 103) in the Project Management User's Guide.
The software displays a warning that a catalog database with the same name currently
exists in the server location and asks if you want to link the existing catalog database
instead of restoring the catalog database from backup.
11. Select No in the message box to indicate that the catalog database should be restored and
not be linked.
12. Select Overwrite in the next message box to overwrite the Catalog database.
13. Select No to prevent the Model database from being overwritten.
14. When the restore operation at the Satellite location is complete, review the log file for any
errors.
15. Open the Microsoft SQL Server Management Studio at the Host location, and recreate
the subscriptions for the Catalog and Catalog schema databases. For more information, see
Set Up one-way subscriptions for SQL Server (on page 180). The example below shows the
subscriptions for the five databases participating in the Global Workshare:

When recreating the subscriptions, clear the Initialize check box on the
Initialize Subscriptions page of the New Subscription Wizard.
16. Open the Replication Monitor, and verify that replication of data for the new subscription is
working appropriately. For more information, see Monitor replication in SQL Server (on page
185).

Project Management User's Guide 190

 Global Workshare

After you have verified that the replication of data for the Catalog and Catalog schema
databases is working appropriately, normal activities can be resumed.

Satellite Failure and Recovery for SQL Server

The following workflow explains a procedure for recovering a Satellite server in the Global
Workshare (GWS) environment. A server can fail due to hardware or other catastrophic failure.
This procedure applies to systems using SQL Server only.

1. In Microsoft SQL Server Management Studio, expand the Host server, and select
Replication > Local Publications.
2. Right-click the subscription that corresponds to the Satellite location, and then click Delete.
Repeat this step for the Catalog, Catalog schema, Model, Site and Site schema.
3. In the Microsoft SQL Server Management Studio dialog box, select the Connect to
Subscriber and delete record of the subscription at Subscriber also check box.
4. For the Model database only, delete the subscription at the Satellite.
5. Connect to the Satellite, and delete the Host subscription.
6. At the Satellite location, delete the publication that is now not used. Select Replication >
Local Publications, right-click the publication that is no longer used, and then click Delete.
7. The publication must be deleted before you can delete or restore that database
from another SQL Server backup.
8. If there are any remaining subscriptions related to the failed Satellite, right-click the
subscription that corresponds to the Satellite, and then click Delete.
9. In the Project Management task, run Consolidate Model from Workshare. Select only the
location that you want to consolidate. This location represents the one Satellite that is being
replaced or repaired.
10. If the Satellite server is repaired, clean the Satellite database using Clean a database (on
page 89).
11. If the Satellite server is a replacement computer with a different name from the failed
Satellite server, delete the previous location object from within Project Management, and
then Create a new location (on page 198) object for the replacement computer.
Add the repaired or replacement Satellite back into the GWS using Add an additional satellite to
an existing SQL Global Workshare Configuration (on page 184).
See Also
Host Failure and Recovery (on page 208)
Model Data Recovery (on page 209)
Consolidate Model from Workshare (on page 199)

Project Management User's Guide 191

 Global Workshare

Task Limitations When Working in a Global

Workshare Environment
Not all tasks can be performed at all locations participating in the Global Workshare
Configuration (GWC). Some tasks can only be performed at the Host location; additional tasks
can be performed at a Satellite location given that certain conditions are met. Consider the
following before setting up a GWC:

Administrative Tasks
The following administrative tasks must be performed from a computer on which the Project
Management option is installed:
In the following table, Conditional indicates that this action is dependent on the user
having the normally expected privilege (as in a non-GWC setup) to the object being modified or
deleted, or to the parent object if a child is being created.

Action Host location Satellite location

Execute Duplicate Model for Workshare Conditional No

command

Create Permission groups Conditional No

Create Permission group folders Conditional No

Add user or group to permission groups Conditional No

Modify user or group in permission group Conditional No

Assign permission group to location Conditional No

Change SharedContent for the Catalog Conditional Can execute only for the
database Catalog database at that
Satellite location.

Regenerate the Reports database Yes (for host) Yes (for Satellite)

Add new properties to object types Conditional No

Create Location objects Yes No

Execute Synchronize Model with Catalog Yes (for Host) Yes (for Satellite)
command

Database IFC Conditional Replicated from Host

location.

Bulkload to the Catalog database Conditional Replicated from Host

location.

Project Management User's Guide 192

 Global Workshare

Action Host location Satellite location

Run Database Integrity command Yes No

Running the Synchronize Model with Catalog command at the Host location has the following
ramifications in a GWC setup:
 Items at Satellite locations that need updating are placed on the To Do List and can be
resolved by running the Synchronize Model with Catalog command at each Satellite
location. Alternately, each Satellite location can display the To Do List and update out-of-
date items manually.
 Model database views are updated only at the Host location. Each Satellite location needs to
run the Synchronize Model with Catalog command with respective options to update the
views on their Model database. Alternately, a Satellite location can run the View Generator
to update the model and/or catalog views. The ViewGenerator.exe file is delivered to the
[Product Folder]\Core\Tools\Administrator\Bin folder.

Modeling Environment Tasks

In the following table, Conditional indicates that this action is dependent on the user
having the normally expected privilege (as in a non-GWC setup) to the object being modified or
deleted, or to the parent object if a child is being created.

Action Host location Satellite location

View reference data in the Catalog task. Yes Yes

Use any of the commands in any of the Smart 3D Conditional Conditional

tasks (excluding the Project Management and
Catalog tasks).

Create/modify/delete objects under any system Conditional Conditional

created in the Systems and Specifications task.

Create/modify/delete a new branch in the Conditional Conditional

hierarchy tree in the Drawing and Reports task.

Create view styles. Conditional Conditional

Create/modify/delete catalog. Conditional No

Create/modify/delete model filters/filter folders. Conditional Conditional

Transfer selection set into permission group of Conditional Conditional

another location

Create/modify/delete items under the location- Conditional Conditional

specific branch (Drawings and Reports hierarchy
tree), including Report, Orthographic Drawings,
Isometric Drawings, and the output they
generate.

Project Management User's Guide 193

 Global Workshare

See Also
Utilities and Services (on page 368)

Considerations for Performing Large Transactions

When you perform large transactions in Global Workshare, you need to take the following
precautions:
 Perform large transactions during off-peak hours when system resources are not as heavily
loaded.
 Break large transactions into smaller chunks. For example, use smaller select sets when
deleting structure imported from TEKLA.
 Delete small sets of drawings or other objects rather than deleting a large set all at once.
The following types of transactions can become large:
 Performing Model Data Reuse tasks.
 Performing Database Integrity tasks. Use the following workflow:
a. Run DBI on the Host from the Project Management task.
b. Run DBClean on the Host from a Smart 3D session.
c. Wait for the transactions to complete.
d. Run DBClean at each Satellite location. Wait for the transactions to complete at one
location before processing the next location.
 Performing database maintenance. In particular, deleting database objects that users have
deleted from the model can create a transaction with several million records. This can take
days to replicate.
 Deleting existing TEKLA data before importing.
 Deleting large numbers of drawings. For example, deleting a snap-in of isometrics.
 Deleting large numbers of orthographic drawings.
 Deleting, copying, or moving large numbers of objects while inside the model.

Workflow to Synchronize Catalog Changes between

Host and Satellites
The majority of catalog changes are propagated in the Global Workshare Configuration (GWC).
However, if new catalog data is bulkloaded at the Host, the workflow depicted in the illustration
below must be conducted on the Host server and on all Satellite servers in the GWC. This
procedure regenerates the data that is not propagated to the Satellite and returns the workshare
to a synchronized state.

Project Management User's Guide 194

 Global Workshare

Intergraph does not recommend overwriting the Satellite catalog with a copy
of the Host catalog and then linking it to the model. Doing so increases the risk of breaking the
workshare.

Tasks Performed at the Host Location

1. Bulkload the required data to the Host catalog.
2. In the Project Management task, select the Host model in the tree.
3. Click Tools > Synchronize Model with Catalog.
4. In the dialog box, ensure Mark out-of-date, Update out-of-date, and Regenerate views
are selected, and click OK.
If the object is owned by the Host, the object is updated. If the object is owned by the
Satellite, the object is flagged for update. If a To Do List record is necessary, one is
created.
5. Click Edit > Regenerate Reports Database.
The software updates the views at the Host only.
The Reports database is a set of views that point to data in other databases.
Although the Reports database does not participate in the workshare, it must be kept up-to-
date.

Tasks Performed at the Satellite Location

After the required tasks are completed at the Host location, perform the following tasks at each
Satellite location participating in the GWC.
1. After replication has propagated changes from the Host to the Satellite, run the View
Generator against the catalog at the Satellite location. The View Generator executable,
ViewGenerator.exe, is delivered in the [Product Folder]\Core\Tools\Administrator\Bin folder.
You must select the Catalog as the data database and the Catalog schema as the schema
database to run this utility.
2. In the Project Management task, select the Satellite model in the tree.
3. Click Tools > Synchronize Model with Catalog.

Project Management User's Guide 195

 Global Workshare

4. In the dialog box, ensure that Update out-of-date and Regenerate views are selected, and
click OK.
The software updates the table content and the views on the model. Any objects that are
owned by the Satellite are flagged or updated. If a To Do List record is necessary, one is
created.
5. Click Edit > Regenerate Reports Database.
The software updates the views at the respective Satellite only.

 Mark out-of-date instructs the software to scan the model database and mark all objects
that are out-of-date with the catalog. In Workshare configurations, this option is disabled
when the selected model belongs to a Satellite.
 Update out-of-date instructs the software to update all objects that have been marked as
out-of-date in the model database. In Workshare configurations, this option is available for
both Host and Satellite locations.

Combining SmartPlant Foundation and Global

Workshare
In an integrated environment, SmartPlant Enterprise publishes and retrieves data through a
central repository, SmartPlant Foundation (SPF). A global workshare configuration (GWC)
environment shares all data within one model with multiple remote sites. You can combine the

Project Management User's Guide 196

 Global Workshare

two environments, allowing the use of a central repository at remote sites. A typical configuration
is shown below:

The software supports publishing to SPF for all levels of access, write or read-only. For
example, you can publish documents in permission groups owned by a Satellite on the GWC
Host or another Satellite even if you do not have write permissions in those permission groups.

 Revise and Update are available only if you have write access permissions.
 When publishing from other locations, read-only documents cannot be updated with the last
published timestamp. The software detects these drawings as new.
The following practices must be followed for effective coordination of SPF and GWC:
1. All data retrieval must be performed on one GWC Host or Satellite. The permission group
used for retrieval must only be available on that same Host or Satellite. This prevents a
design basis object from being moved so that it has ownership in multiple permission groups
and on multiple GWC sites. If this design basis object is later modified, it fails. Despite this
restriction, GWC replicates all retrieved objects to all sites. For more information, see
Retrieving Data in the Integration Reference Guide and Permission Groups in the Global
Workshare User's Guide.
2. Smart 3D model registration with the SPF site must be performed on the GWC Host. For
more information, see Register (on page 351) in the Integration Reference Guide.
For more information, see Publishing 3D Data in the Integration Reference Guide, and
Permission Groups and Global Workshare in the Global Workshare User's Guide.

Project Management User's Guide 197

 Global Workshare

New Location
New > Database > Location creates a new location object. A location is a geographical place,
such as a city, country, or some other region. A location can also identify the purpose of a
computer involved in a Global Workshare Configuration, such as Host, Satellite1, or Satellite2.
The location can be any string identifier that represents an informative name for the location.
Data is typically transferred between workshare locations consisting of a host and its various
satellites.
Unlike permission group objects that are available only to the given model database, the
location object is a site-wide object. After a location is created, it is available to any model in the
site.
New Location is not available at satellite locations. New locations can only be
created at the host.

Create a new location

1. Click Database > New > Location.
2. In the New Location dialog box, type a name for the location.
3. In the Site server list, select the site server for the new location.
Only those servers that are registered through SQL Server on the Host computer
are available. For more information about registering a server, see the Intergraph SmartTM
3D Installation Guide available from the Help > Printable Guides.
4. In the Name rule ID text box, modify the name rule if necessary.
The Name rule ID is useful in determining which location placed a specific item in
the model.

 By default, the value in the Name rule ID field is identical to the value of the LocationID. The
LocationID is an integer generated by the software. Because the Host site is created first, its
value is 1. The first Satellite location created is given a value of 2, and so on.
 After a location is created, its properties cannot be modified and can only be deleted when
the Global Workshare is not active.

Project Management User's Guide 198

 Global Workshare

New Location Dialog Box

Sets options for creating a new location. The first location, or Host location, is created
automatically during the Site database generation process.
See Also
New Location (on page 42)
Create a new location (on page 198)
General Tab (New Location Dialog Box) (on page 199)

General Tab (New Location Dialog Box)

Specifies general information for the new location.
Name
Specifies the new location name. A location can be a city, country, or any other region. A
location can also identify the purpose of a computer involved in a Global Workshare
Configuration, such as Host, Satellite1, Satellite2, and so on.
Site server
Sets a site server for the new location. Only those servers that are registered on the Host
computer through SQL Server are listed.
Name rule ID
Specifies the name rule ID. This string appears as part of the name rule for new objects
created by the Satellite location.
See Also
New Location (on page 42)

Consolidate Model from Workshare

Merges back replicated databases on one or more Satellite servers to the databases on the
Host server so as to form a single database of each type. You can use this command to
consolidate a single satellite, multiple satellites, or all satellites. If the databases from all the
satellite locations are consolidated, the resulting merged databases resemble the original
databases and users can work with them as if the databases were never replicated or, at a point
later in the design process, the databases can be replicated again with either the same or with
different satellite locations.
Additionally, permission groups that were assigned to the selected Satellite locations for the
duplicated model are re-assigned to the Host location for a consolidated model.
Starting with version 2007 (7.0), you can use the Consolidate Model from
Workshare command to remove a selected satellite from a workshare configuration without
being forced to consolidate all models back to the host.
See Also
Consolidate Models from Workshare Dialog Box (on page 200)

Project Management User's Guide 199

 Global Workshare

Consolidate Models from Workshare Dialog Box

Displays information about the model to be consolidated and provides a grid control that lists the
Location, Type, Server, and Name of the duplicated Model databases. You can use this grid to
select one or more satellites to consolidated back to the host location. Selecting a row header to
consolidate a Model, highlights all rows for that Model. Each location plus databases
combination is selectable as a unit. If you do not select anything, then the entire workshare is
consolidated.
Select duplicated models to consolidate
Displays the location, type, server, and name for the duplicated model. You can use this grid
to select one or more satellites to consolidate back to the host location. If you select a row
header to consolidate a model, all rows for that model are highlighted. You cannot select
just one row of the grid. You must select at least one model before the OK button is
enabled.
The Server column changes to Service when the database type for the site is
Oracle.
GoldenGate administrator password
Allows you to type the GoldenGate administrator password for the Host and all Satellite
locations participating in the workshare. The username of the GoldenGate administrator can
be GGADMIN, for example. The GoldenGate administrator username and password is used
for connection purposes and must be shared among all locations participating in the
Workshare for the lifetime of the Global Workshare Configuration.
See Also
Duplicate Model for Workshare (on page 201)
Utilities and Services (on page 368)
Duplicate the Model for Global Workshare Configuration (on page 201)

Location Properties Dialog Box

Displays property information for the location that you selected in the tree view. The information
cannot be edited.
Property
Organizes the details about the location in this column of the grid.
Value
Specifies the appropriate facts about the location in this column of the grid.
Name
Displays the name of the selected location.
Site server
Specifies the name of the server for the selected location.
Naming String
Specifies the name rule ID that is assigned to the selected location.

Project Management User's Guide 200

 Global Workshare

Duplicate Model for Workshare

The Tools > Duplicate Model for Workshare command collects the name of the model to be
replicated, the Satellite locations involved in the workshare, and the Satellite server names for
the various databases. After the information is collected, the command generates the replication
scripts. You can add one or more satellite locations to an existing global workshare without
having to first consolidate all the satellite locations.
The Duplicate Model for Workshare command is only enabled when a Model database is
selected in the tree view at the Host location. Satellite locations cannot duplicate models.
Duplicate Model for Workshare cannot be run on satellite locations.
No modeling should occur on the Host or Satellite machines during the
Duplication process. Any work performed during this process, such as the creation of new
objects or filters, could be lost if they are not included in the backup of the databases.
See Also
Duplicate the Model for Global Workshare Configuration (on page 201)
Utilities and Services (on page 368)
Duplicate Model for Workshare Dialog Box (on page 202)
Duplicate Model for Workshare across Untrusted Networks (on page 250)

Duplicate the Model for Global Workshare Configuration

Before starting this procedure, we recommend that you create a backup of the non-replicated
databases. You must have also added the locations for any satellites you intend to add. For
more information, see New Location (on page 42).
No modeling should occur on the Host or Satellite computers during the
Duplication process. Any work performed during this process, such as the creation of new
objects or filters, could be lost if they are not included in the backup of the databases.
See Duplicate Model for Workshare across Untrusted Networks (on page 250)
for special instructions when this environment is to be configured when using Oracle.
1. In the tree view, select a Model (Model database).
2. Click Tools > Duplicate Model for Workshare. You can also right-click on the model in the
tree and select Duplicate Model for Workshare.
If you have not yet created a backup of the non-replicated model, Intergraph PPM
recommends that you step out of the duplication process and create a backup at this time.
In the event that you encounter problems during the Workshare process, you can restore
the backup set of databases on the server and continue working.
3. On the Duplicate Model for Workshare dialog box, select one or more Satellite locations in
the Available locations list and click Add.

 For each location selected, one row for each database type is added to the grid.
 You can remove a location from the Locations and servers where model will be
duplicated grid with the Remove button.
 You can add one or more satellites to an existing Global Workshare Configuration
without consolidating other satellites.

Project Management User's Guide 201

 Global Workshare

 You must type the GoldenGate administrator user name and password.
4. Click OK to start the duplication process.

 A variety of replication scripts and a batch files are generated during execution of the
Duplicate Model for Workshare command. These files are generated on the Smart 3D
administrative computer on which the command is executed and delivered to sub-
folders created in the local temp folder of the user executing the replication process.
 You can click Start > Run and type %temp% in the Run dialog box to locate the local
temp folder.
 In the initial duplication of one or more satellites, the files are created in the
ReplicationModelName subfolder of the local temp folder. When a single satellite is
added to an existing Global Workshare Configuration, the files are created in the
AddSatellite<LocationName>ModelName subfolder and the batch file names are
ToRunPrebackup.bat and ToRunPostRestore_<n>.bat, where <n> is a sequential
number with 1 being for the host, 2 being for the first satellite, 3 for the second satellite,
and so forth.
 For disaster recovery purposes, it is recommended that you backup these scripts and
batch files into a separate folder.
5. When the duplication process completes, click OK.

Duplicate Model for Workshare Dialog Box

Sets options for the Satellite locations that will be involved in the workshare and the Satellite
server names for the various databases.
Model to duplicate
Displays the name of the model database selected in the tree view. This model is duplicated
at each of the specified Satellite locations.
Available locations
Lists all of the Satellite locations. You can use the Windows Shift and Ctrl select options for
multiple locations.
Locations and servers where model will be duplicated
Displays the locations you have added to the table, as well as the database types, names
and servers. Only those servers that are registered on the Host computer through SQL
Server are available for selection and association with the location.
The Server column changes to Service when the database type for the site is
Oracle. The drop-down list of Oracle Services comes from Oracle Net Configuration
Assistant.
Add
Moves the location selected in the Available locations list to the Locations and servers
where model will be duplicated table. For each location selected, one row for each
database is added to the table. Note that the Reports and Reports schema databases are
excluded from the duplication process. You must regenerate the Reports databases at each
Satellite location after replication is complete.

Project Management User's Guide 202

 Global Workshare

Remove
Removes all rows for the selected location from the Locations and servers where model
will be duplicated table.
GoldenGate administrator user name and password
Allows you to type the GoldenGate administrator user name and password for the Host and
all Satellite locations participating in the workshare. The username of the GoldenGate
administrator can be GGADMIN, for example. The GoldenGate administrator username and
password is used for running the batch files used to set up goldengate processes. This
username and password is used for connection purposes and must be shared among all
locations participating in the global workshare for the lifetime of the GWC.
This field is only enabled when the database type is Oracle.
See Also
Duplicate Model for Workshare (on page 201)
Utilities and Services (on page 368)
Duplicate the Model for Global Workshare Configuration (on page 201)

Back Up and Restore Global Workshare

In the event that one of the locations participating in a Global Workshare Configuration (GWC)
must be taken off-line, Intergraph recommends using one of the following supported workflows
to ensure minimal adverse impact to the remaining locations in the GWC. Each of the following
scenarios presumes the following basic initial configuration:
 The GWC consists of three database servers, with each server functioning as both SQL
Distribution and Data Server. For the purposes of these scenarios, the Host server is named
HSVSRV1. The two Satellite servers are named HOUSRV1 and OSLSRV1.

Project Management User's Guide 203

 Global Workshare

Scenario 1: Restore Model as Copy

When the Host location experiences a work stoppage, Intergraph recommends using this
workflow to achieve a stand-alone configuration. For more information, see Scenario 1: Restore
Model as Copy (on page 204).

Scenario 2: Amputate and Re-Duplicate

When a Satellite server experiences a catastrophic failure (but the Host location remains in-
place and operable), Intergraph recommends using this workflow to restore the Global
Workshare Configuration. For more information, see Scenario 2: Amputate and Re-Duplicate
(on page 205).

Scenario 1: Restore Model as Copy

Use the following workflow when the Host server in a Global Workshare Configuration (GWC) is
"lost" and can no longer participate in the GWC. This workflow requires you to use a backup of
the Host databases that was completed while the GWC was in-place.
As part of the restore process for the model, the software performs the consolidation process.
This is the same series of actions that you perform manually during the standard consolidation
workflow; however, in this workflow, the software performs them automatically.
The databases that result from this workflow will behave as they would in a standard, non-
workshare setup, and all permission groups are reset to the new Host location. The restored
dataset is fully supported for future replication.

 Do not substitute the workflow in this scenario for the standard consolidation workflow as
queued or error data will be lost.
 Do not deviate from the following sequence of steps. Additionally, do not proceed to a
subsequent step in the workflow until the previous one is complete.

Create a New Site and Site Schema Database

Using the Database Wizard, create a new, empty Site and Site schema database on the Host
server. Because you will be restoring the original Catalog and Catalog schema databases in a
later step, create these new Site databases using an existing Catalog.

Project Management User's Guide 204

 Global Workshare

For more information on SQL databases, see Create site database from an existing catalog for
SQL (on page 376). If you are using Oracle, see Create site database from an existing catalog
for Oracle (on page 374).
The names of the new Site and Site schema databases are not required to be the
same as in the backup set from the Host.

Restore the Model Configuration at the Host Location

Use the Restore Wizard to restore the Catalog, Catalog schema, and Model databases on the
Host server from the backup that was completed prior to the work stoppage. For more
information, see Restore a model as a copy (on page 106).
When the restore is complete, review the consolidate .LOG file in the %temp% folder
of the logged-in user who ran the restore.

Regenerate the Reports Database

Regenerate the Reports databases after the project databases are restored on the Host server.
For more information on regenerating Reports databases, see Regenerate the reports database
(on page 125).

 The workflow outlined in this scenario can also be used to test the consolidation of the
databases in order to pre-screen for possible errors without affecting the live dataset. Such
pre-screening is useful in preparation of migrating data or for ensuring minimal downtime
during consolidation. In instances where pre-screening is the objective, you must perform
the workflow on a server that is independent of any of the servers participating in the live
GWC.
 You can also implement this workflow for the purposes of conducting a design review. The
databases participating in the live GWC can remain intact and operable, while the latest
work from the backup set can be restored onto a laptop and presented in the design review.
See Also
Back Up and Restore Global Workshare (on page 203)

Scenario 2: Amputate and Re-Duplicate

Use the following workflow when one of the Satellite servers participating in a Global Workshare
Configuration (GWC) experiences a catastrophic failure and can no longer participate in the
GWC. This workflow allows the GWC to remain active; only the lost Satellite location
experiences an immediate work stoppage.

Remove Subscriptions / Streams to the Lost Satellite Server

Delete all subscriptions (MSSQL) / streams (Oracle) with regard to the Satellite server to be
amputated. For example, in the following configuration, Satellite server HOUSRV1 has suffered

Project Management User's Guide 205

 Global Workshare

massive failure and will be periodically unavailable. As a result, SQL Agents for the Push
Subscriptions HSVSRV1 > HOUSRV1 and OSLSRV1 > HOUSRV1 are failing.

Permission groups cannot be moved and must stay with the "amputated"
Satellite.

Project Management User's Guide 206

 Global Workshare

After the incoming and outgoing distributions are removed for the failed satellite, the resulting
configuration resembles the following illustration:

In this scenario, the remaining Locations can continue participating in the GWC with no work
stoppage.

Consolidate the Replicated Databases

As soon as it becomes practical to do so, perform the standard consolidation workflow to merge
the replicated databases at the remaining Satellite locations to the databases at the Host
location to form single database of each type.

Re-Duplicate to Include the Amputated Satellite Location

Use the standard replication workflow to re-duplicate the resulting consolidated dataset.
Because consolidation scripts only execute against the Host server, the absence of
any Satellite is recoverable. As a result, you can extend the amputate and re-duplicate workflow
to a situation involving multiple Satellite servers failing due to a broader network failure that has
a long-term fix date.
See Also
Back Up and Restore Global Workshare (on page 203)

Project Management User's Guide 207

 Global Workshare

Failure and Recovery Overview

In the Smart 3D Global Workshare (GWS) environment, it is possible for a Host server or
Satellite server to fail due to hardware or other catastrophic failure. The GWC Host Failure-
Recovery and GWC Satellite Failure-Recovery workflows describe methods for recovering from
such failures.
See Also
Host Failure and Recovery (on page 208)
Satellite Failure and Recovery for SQL Server (on page 191)
Catalog Data Recovery for SQL Server (on page 187)
Satellite Failure and Recovery (GWC) (on page 253)
Model Data Recovery (on page 209)

Host Failure and Recovery

The following workflow explains a procedure for recovering the Host server in a Global
Workshare Configuration (GWC) environment in the event of a failure. A Host server can fail due
to hardware or other catastrophic failure. The GWC Host Failure-Recovery workflow is not
intended for temporary network outages from which the GWC can recover without intervention.
If you have lost your Host location in a GWC, please contact Intergraph support
(www.intergraph.com\support) for advice before you start the recovery operation.
When the Host server fails, GWC data begins to accumulate on each of the
Satellite servers. When it is clear that the Host server is down, stop work on each Satellite
server until the Host server is repaired or replaced.
1. Determine which dataset to copy for recovery from the remaining Satellite servers. Use the
most complete dataset available from the Workshare location.
You must recover data from all the other Satellite locations that were not
chosen using copy/paste and restore after the GWC is running again.
To integrate the data not chosen, see Model Data Recovery (on page 209).
2. Backup the dataset to be copied. For more information, see Backup (on page 97).
3. Remove Smart 3D data from all servers that participated in the previous Smart 3D Global
Workshare Configuration.
4. Create a new Site and Site schema using the Database Wizard. For more information see
Create Site Database and Schema Page (on page 378).
5. Populate the new Site using the backup dataset with the Restore Model as Copy feature in
the Restore Wizard. For more information, see Restore a model as a copy (on page 106).
6. Backup the restored model. For more information, see Backup (on page 97).
7. Configure Global Workshare. For more information, see Global Workshare Configuration (on
page 214).Global Workshare and SQL Server Databases (on page 172).
See Also
Satellite Failure and Recovery for SQL Server (on page 191)
Catalog Data Recovery for SQL Server (on page 187)
Model Data Recovery (on page 209)
Workflow for Consolidating Oracle Databases (on page 240)

Project Management User's Guide 208

 Global Workshare

Model Data Recovery

In the event that Model data is deleted or modified, and you want to return to the previous state
to recover the data, the workflow in this topic describes how to do so in a Global Workshare
Configuration (GWC) environment. For this to be effective, regular backups must be conducted
at each Workshare location.

Recover Data from the Model Database

1. Locate the most recent backup that contains the intact modified or deleted objects.
2. Connect to the GWC location at which the model data was deleted or modified.
3. In Project Management, select Tools > Restore.
4. In the Restore Wizard dialog box, select Restore model for selective recovery of model
objects, and then click Next.
5. In the Backup configuration file to restore box, type the path to the backup configuration
file (.BCF), or click Browse , navigate to the file location, and then select the file.
The Restore Wizard dialog box is populated with the following information:
 The Model to restore box displays the name, database size, and the date of the
backup file for all the models saved in the specified backup location. The list is
populated after you select the backup configuration file you want to restore. You can
only select a single model to restore.
 The Server and path to existing database backup files table displays the server and
database backup files path where the database backup files are located. Click Browse
and navigate to the path on the specified server. This option displays only when you
are restoring a SQL database.
 The Service and path to existing database backup files table displays the Oracle net
service and database backup files path for the database backup files. This option
displays only when you are restoring an Oracle database.
 The Paths for new databases table lists the database types saved to the backup file,
including the server (when restoring SQL databases),the Oracle net service (when
restoring Oracle databases) and paths for the restored database and log file.
 The New model name dialog box displays the restored model name with the date of the
selected backup file (.BCF) as a suffix. The root object in the Model database is not
renamed. You can change the name, which is especially useful for partial recovery at
Satellite locations.
 The Description box provides a space for you to type a description of the restored
model.
6. Click Finish, to restore the portion of the Model database to the existing model database as
defined by the permission groups you selected.
7. In the Restore model as Copy dialog box, you are prompted to choose whether to link to
the existing catalog. Select Yes.
You must select Yes at this prompt, or you will overwrite the Workshare
Catalog for the GWC.

Project Management User's Guide 209

 Global Workshare

8. Use the copy and paste and restore options within the model to restore the objects to the
previous state.
9. Open Smart 3D.
10. Open two Smart 3D sessions.
11. In one session, define a workspace with the workshare model.
12. In the other session, define a workspace with the model that was restored for selective
recovery.
13. In the session with the workspace of the model restored for selective recovery of modeled
objects, select all objects, and perform a Copy.
14. Switch to the other open session, which has the workspace defined for the model.
15. Click Edit > Paste and Restore.
See Also
Restore a backup model for selective recovery in an active model (on page 105)
Restore Wizard (on page 111)
Restore Model for Selective Recovery of Model Objects (Restore Wizard) (on page 113)

Overall Workflow to Configure a Global Workshare

The following workflow pertains only to configuring a Hub and Spoke Global Workshare
Configuration for Oracle databases between one Host and one or more Satellites.
GoldenGate is used as the driving software for the replication of data to all locations. It connects
and captures database changes at the Host location, stages the changes into local files,
propagates the changes to the remote servers, and then applies the changes at the Satellite
database locations. Model database changes at Satellite locations are similarly propagated back
to the Host location.
You cannot use Global Workshare if you are running Oracle on Linux. You must run Oracle on a
Windows-based computer to use Global Workshare.

Verify Databases Have Supplemental Logging Enabled

All Oracle databases that participate as either Hosts or Satellites must be configured to write
supplemental data to the redo log files. This supplemental data is required for successful
replication.

Verify Databases are in ARCHIVELOG Mode

When you run a database in ARCHIVELOG mode, you enable the archiving of the redo log. The
changes (to data, tables, schemas, and so on) that take place at the Host and Satellite locations
are recorded in the database redo log files. Because the GoldenGate Extract process reads
information from the redo log files of the database, any database producing changes that are
captured must be running in ARCHIVELOG mode.

Verify Databases are enabled for GoldenGate Replication

The ENABLE_GOLDENGATE_REPLICATION parameter of the Oracle instance must be
enabled. You must also modify the UNDO_RETENTION value. For more information, see Verify
Databases are enabled for GoldenGate Replication (on page 216).

Project Management User's Guide 210

 Global Workshare

Allocate streams pool size

Smart 3D uses the Integrated Capture mode for reading data. For Integrated Capture mode,
Oracle requires that the streams pool size value be set to handle heavy workloads from the
extract processes. To do this, you must set the value to prevent performance and memory
issues with the Oracle database. For more information, see Allocate streams pool size (on page
217).

Install GoldenGate
GoldenGate 12.1.2.1.0 is an installation program that prompts you for the input needed to install
the GoldenGate software. You must also install the patch 12.1.2.1.8 (for example, Oracle
GoldenGate 12.1.2.1.8) which is a requirement. For more information, see Install GoldenGate
(on page 218).
GoldenGate replication produces a significant amount of input and output operations
on the disk where it is installed. To avoid any performance impacts, install GoldenGate into a
folder that is located on a physically independent disk or RAID array from the Oracle database
files.

Create the GoldenGate Administrator account

The GoldenGate environment is managed by an administrative database user account. To
manage the GoldenGate environment, you must create a GoldenGate administrator user
GGADMIN with the appropriate privileges. Do not use the SYS or SYSTEM user as the
GoldenGate administrator.
The GoldenGate administrative user can have any valid name. In the case of a
multiple Global Workshare configuration, Intergraph recommends that each site has its own
GoldenGate administrative user with his or her own tablespace.

Create the Smart 3D GoldenGate User Alias

The Smart 3D GoldenGate user alias is an encrypted GoldenGate representation of an Oracle
account. The alias is used to configure and run the GoldenGate processes. This alias is
essential to operate the GoldenGate software in a Global Workshare configuration.

Register all Oracle instances on Smart 3D administrative machine

The Smart 3D administrative computer is required to have all the servers registered that are
participating in the workshare. The administrative machine executes the command Duplicate
model for workshare for all locations, which is essential for the proper generation of replication
scripts.

Create Locations
After the Oracle instances are registered on the S3D administrative computer, you can use the
New > Location command in the Project Management task to create your Satellite locations.
For more information on creating Satellite locations, see Create Locations (on page 227).

Duplicate Model for Workshare

After the Satellite locations are created, use the Duplicate Model for Workshare command in
the Project Management task to replicate the Host databases.

Project Management User's Guide 211

 Global Workshare

A variety of replication scripts and batch files are generated during execution of the Duplicate
Model for Workshare command. These files are created in a subfolder of the user's local temp
folder on the administrative computer on which you ran the Duplicate Model for Workshare
command. If you are creating a new GWC, the subfolder is named
Replication<LocationName>_<ModelName>. If you are adding a single Satellite to an existing
GWC, the subfolder is named AddSatellite<LocationName>_<ModelName>.

Copy generated scripts into GoldenGate folders

The contents of the scripts generated in your temp folder must be copied to their corresponding
GoldenGate installation directories for each server instance. Copy the files under each location
from the Temp folder to their corresponding GoldenGate installation directories.

Execute PreBackup scripts

The administrator account of the database server executes the PreBackup scripts from a
command line. The scripts create the initial objects required for replication including the
GoldenGate manager service. Execute scripts on the Host and all corresponding Satellite
servers.

Make a Smart 3D backup

With Project Management, you can make a backup of the Host databases on the administrative
computer. These databases are then transferred and restored on the Satellite servers. Include a
copy of the SharedContent folder along with any additional supporting data (Reference 3D files,
DGN, DWG referenced files, and so on) on the backup.

Restore Duplicated Databases at Satellite Locations

The duplicated databases are restored on each Satellite location server using the same names
as the original databases on the Host server. First, use the Database Wizard to restore the Site
and Site schema database. Then, use Tools > Restore in the Project Management task to
restore the Catalog, Catalog schema, and Model databases. For more information about
restoring databases, see the Project Management User's Guide available from Help > Printable
Guides.
Make sure the Site Database Workshare Location box contains the correct
location name when restoring the site.

Execute PostRestore scripts

The administrator account of the database server executes the PostRestore scripts from a
command line. The scripts create the remaining objects required for replication and starts the
GoldenGate processes. Execute scripts on the Host and on all corresponding Satellite servers.

Regenerate Reports Databases

For performance reasons, the Reports and Reports schema databases are not replicated from
the Host location and therefore need to be locally generated at each location. At each satellite
location, right-click the Model in the Project Management tree view, and then select Regenerate
Reports Database. For more information on regenerating the Reports database, see the
Project Management User's Guide available from Help > Printable Guides.

Project Management User's Guide 212

 Global Workshare

Install and configure the Duplication Synchronization Service (DuSS)

You must activate the Duplication Synchronization Service (DuSS) at the end of the Global
Workshare setup. This service is run to prevent dangling relationships between objects that are
propagated or replicated between the servers. The Duplication Synchronization Service helps
prevent certain inconsistencies, particularly those involving to do list entries that arise during the
updates that occur in Global Workshare Configuration. The DuSS addresses these issues to
keep the model data accurate at all locations. For more information on installing and configuring
the Duplication Synchronization Service, see Install and configure the Duplication
Synchronization Service (DuSS) (on page 183).

Firewall Exceptions for GoldenGate

There are certain firewall exceptions that needs to be set for GoldenGate software. For more
information, see Firewall Exceptions for GoldenGate (on page 239).

 Do not delete the Oracle Archive Log files, unless you are certain they can be safely
removed. Deleting these files while GoldenGate still requires them causes the Extract
processes to hang. This hang event can be complicated to resolve and sometimes the only
solution is to consolidate and reconfigure the Global Workshare.
 Oracle GoldenGate should be monitored daily to confirm that the changes are being
propagated and that all processes are enabled and healthy. Immediately contact Smart 3D
Support for an investigation if problems are noticed, as these issues compound with time.
For more information, see Monitoring Replication (on page 237).
 Configuring Global Workshare within an integrated environment is a detailed and
complicated process. For more information, contact Intergraph Support at
http://www.intergraph.com/support (http://www.intergraph.com/support).

What do you want to do?

 Verify Databases are Running in ARCHIVELOG Mode (on page 215)
 Verify Databases are enabled for GoldenGate Replication (on page 216)
 Verify Databases Have Supplemental Logging Enabled (on page 214)
 Install GoldenGate (on page 218)
 Create the Oracle GoldenGate Administrator account (on page 222)
 Register all Oracle instances on Smart 3D administrative machine (on page 227)
 Create Locations (on page 227)
 Duplicate Model for Workshare (on page 201)
 Copy generated scripts into GoldenGate folders (on page 232)
 Execute PreBackup scripts (on page 232)
 Make a Smart 3D backup (on page 233)
 Restore Duplicated Databases at Satellite Locations (on page 233)
 Execute PostRestore scripts (on page 235)

Project Management User's Guide 213

 Global Workshare

 Regenerate the reports database (on page 125)

 Install and configure the Duplication Synchronization Service (DuSS) (on page 183)
 Add a Satellite to an Existing Oracle Global Workshare (on page 239)
 Monitoring Replication (on page 237)
 Firewall Exceptions for GoldenGate (on page 239)
 Workflow for Consolidating Oracle Databases (on page 240)

Global Workshare Configuration

The following procedure leads you through setting up the Host and Satellite locations for a new
Global Workshare Configuration (GWC).

Verify Databases Have Supplemental Logging Enabled

You must perform the following procedure at the Host and at all Satellite locations that
participate in the Workshare.
1. Open SQL*Plus, and connect as a user with SYSDBA privileges.
2. At the SQL prompt, type SELECT supplemental_log_data_min, force_logging FROM
v$database;, and press ENTER.
The system responds by printing the value of the property. If the value is YES, as displayed,
then supplemental logging is enabled.

If the value returned is NO, you must enable supplemental logging on the database
server.
1. Open SQL *Plus on the database server.
2. At the command prompt, type the following:

Project Management User's Guide 214

 Global Workshare

CMD> SQLPLUS /NOLOG

SQL> CONNECT SYS/[password] AS SYSDBA
SQL> SHUTDOWN IMMEDIATE;
SQL> STARTUP MOUNT;
SQL> ALTER DATABASE ADD SUPPLEMENTAL LOG DATA;
SQL> ALTER DATABASE FORCE LOGGING;
SQL> ALTER DATABASE OPEN;
SQL> ALTER SYSTEM SWITCH LOGFILE;
SQL> EXIT;

Verify Databases are Running in ARCHIVELOG Mode

Perform the following procedure at the Host and all of the Satellite locations that participate in
the Workshare.
1. Open SQL *Plus, and connect as a user with SYSDBA privileges.
2. At the SQL prompt, type ARCHIVE LOG LIST, and press ENTER.

Project Management User's Guide 215

 Global Workshare

The value for Database log mode is Archive mode, indicating that the database is in
ARCHIVELOG mode. If the database is not in ARCHIVELOG mode, then the value for
Database log mode is No Archive Mode.

 Set the initial archiving mode as part of the database creation:

 If the database was created in No Archive Mode, you can change the archiving mode by
using the ALTER DATABASE statement with the ARCHIVELOG clause. To change the
archiving mode, you must be connected to the database with administrator privileges (as
SYSDBA). For step-by-step guidelines about switching from one archive mode to another,
see Managing Archived Redo Logs in the Oracle Database Administrator's Guide delivered
with the Oracle Database software.

Verify Databases are enabled for GoldenGate Replication

Perform the following procedure at the Host and all of the Satellite location servers that
participate in the Workshare.
This procedure is only applicable for Oracle versions 12.1.0.2 and later.
1. Open SQL *PLUS, and connect as a user with SYSDBA privileges.

Project Management User's Guide 216

 Global Workshare

2. At the SQL prompt, type show parameter goldengate, and press ENTER.

If the enable_goldengate_replication parameter value is FALSE, you must enable

GoldenGate replication on the database server.
1. Open SQL *Plus on the database server.
2. At the command prompt, type the following:
CMD> SQLPLUS /NOLOG
SQL> CONNECT SYS/[password] AS SYSDBA
SQL> ALTER SYSTEM SET ENABLE_GOLDENGATE_REPLICATION=TRUE
SCOPE=SPFILE;
SQL> SHUTDOWN IMMEDIATE;
SQL> STARTUP;
SQL> EXIT;

Allocate streams pool size

Perform the following procedure at the Host and all of the Satellite location servers that
participate in the Workshare.
1. Open SQL *PLUS, and connect as a user with SYSDBA privileges.
2. Open SQL *Plus on the database server.
3. At the command prompt, type the following:
CMD> SQLPLUS /NOLOG
SQL> CONNECT SYS/[password] AS SYSDBA

Project Management User's Guide 217

 Global Workshare

SQL> ALTER SYSTEM SET STREAMS_POOL_SIZE=1280M SCOPE=SPFILE;

SQL> SHUTDOWN IMMEDIATE;
SQL> STARTUP;
SQL> EXIT;

 You can increase the value as additional configurations are added to the location. Set this
value using the following formula:
(1G*NUMBER_OF_SETUPS) + 25% head room
25% must be added for every catalog and model database added to an existing Workshare.
 1G is the default MAX_SGA_SIZE used by Smart 3D's GoldenGate setup.
If this value is minimized, you might experience problems with backing up and
restoring. If such errors arise, then try increasing the value size and retry the operation.

Edit the Undo Retention Value

To ensure the best performance for GoldenGate, we recommend the value for the
undo_retention parameter to be at least 86400. Perform the following process at the Host and
all Satellite location servers that participate in the Workshare.
1. Open SQL *Plus on the database server.
2. At the command prompt, type the following:
CMD> SQLPLUS /NOLOG
SQL> CONNECT SYS/[password] AS SYSDBA
SQL> ALTER SYSTEM SET UNDO_RETENTION=86400 SCOPE=SPFILE;
SQL> SHUTDOWN IMMEDIATE;
SQL> STARTUP;
SQL> EXIT;

Install GoldenGate
Prior to installing GoldenGate, create a new folder on the database server. Rename the folder to
GoldenGate for easy identification. Install GoldenGate 12.1.2.1.0 software by running the
setup.exe, and also install GoldenGate 12.1.2.1.8 patch.
You must have administrator privileges on the computer to install the software.
1. Unzip the setup file.
2. Right-click setup.exe under (\ggs_Windows_x64_shiphome\disk1) folder, and select Run
as Administrator.

Project Management User's Guide 218

 Global Workshare

3. On the Select Installation Option page, select Oracle GoldenGate for Oracle Database
12c (381.0MB) to install, and then click Next.

4. On the Specify Installation Details page, specify the following:

a. In the Software Location box, type the path, or click Browse to specify the installation
location.
b. Select the Start Manager check box to perform the default configuration functions, such
as creating the Oracle GoldenGate subfolders in the installation location, setting library
paths, and starting Manager on the specified port number.
The Database Location and Manager Port options are displayed.
c. In the Database Location box, specify the location of the Oracle database home. The
database version in the specified location must be Oracle Database 12c if you are
installing Oracle GoldenGate for Oracle Database 12c.
d. By default, the Manager Port box displays 7809 as the port number.

Project Management User's Guide 219

 Global Workshare

If you are installing multiple instances of the Oracle GoldenGate on the same
computer, you must use a different port number for each instance.

5. Click Next.
6. Important: On the Summary page, make sure that there is enough space for installation
and all the installation details are correct.
7. Click Save Response File to save the installation information.

Project Management User's Guide 220

 Global Workshare

You can use the response file as input to install on other systems when you run
the installer from the command line.

8. Click Install.
The software is installed successfully on the computer.
9. Click Close.
A command line window is displayed running the manager locally.

 You must close the Oracle GoldenGate Manager for Oracle window as the software
creates a service to run this process later when the workshare is setup.
 Install GoldenGate 12.1.2.1.8 patch.

Project Management User's Guide 221

 Global Workshare

Create the Oracle GoldenGate Administrator account

The GoldenGate administrator account is an Oracle account used to configure the Global
Workshare inside Smart 3D. This account is essential to operate the GoldenGate software
during the life of the Global Workshare Configuration.
You must perform the following procedure at the Host and all Satellite location server.
1. Open a text editor, such as Notepad.
2. Type the following text:
DROP USER GGADMIN CASCADE;
CREATE USER GGADMIN
IDENTIFIED BY password
DEFAULT TABLESPACE USERS
QUOTA UNLIMITED ON USERS;
GRANT CONNECT, RESOURCE, DBA TO GGADMIN;
The username (GGADMIN) and password can be customized, but must be the
same on all participating servers.
3. Save the script with the name S3D_GoldenGate_admin.sql.

 To guarantee that the GoldenGate administrator username and password remains the
same across all servers, it is recommended to reuse the same script on all participating
servers.
 You can use any valid name and password combination for the GoldenGate
administrative user account. The combination must match across all instances of the
Global Workshare configuration.
4. Open SQL *Plus, and connect to the Oracle instance as an administrative user who can
create users, grant privileges, create tablespaces, and alter users (as sysdba).
5. At the SQL prompt, type the following statement, and press ENTER:
@"<file location>\S3D_GoldenGate_admin.sql";
6. Review the output of the script, and resolve any reported errors.
When you run S3D_GoldenGate_admin.sql on a server for the first time, the
following error may display. This error is expected and resolves itself:
ORA-01918: user 'GGADMIN' does not exist

Project Management User's Guide 222

 Global Workshare

Create the Smart 3D GoldenGate User Alias

The Smart 3D GoldenGate user alias is an encrypted GoldenGate representation of an Oracle
account. The alias is used to configure and run the GoldenGate processes. This alias is
essential to operate the GoldenGate software in a Global Workshare configuration.
See Also
Create the Smart 3D GoldenGate User Alias for Standalone Configurations (on page 223)
Create the Smart 3D GoldenGate User Alias for Multitenant Configurations (on page 224)

Create the Smart 3D GoldenGate User Alias for Standalone

Configurations
Perform the following procedure at the Host and all Satellite locations that are configured as
standalone Oracle databases.
1. Click Start > All Programs > Accessories > Notepad.
2. Type the following text:
DROP USER s3dgguser CASCADE;
CREATE USER s3dgguser IDENTIFIED BY password
DEFAULT TABLESPACE users quota unlimited on users;
GRANT connect, resource, FLASHBACK ANY TABLE, SELECT ANY TABLE,
INSERT ANY TABLE, UPDATE ANY TABLE, DELETE ANY TABLE,
CREATE TABLE, SELECT ANY TRANSACTION, SELECT ANY SEQUENCE,
SELECT ANY DICTIONARY, LOCK ANY TABLE, DROP ANY TABLE, EXECUTE ANY
PROCEDURE, SYSDBA TO s3dgguser;
GRANT EXECUTE ON SYS.DBMS_FLASHBACK TO s3dgguser;
EXEC dbms_goldengate_auth.grant_admin_privilege('s3dgguser');
3. Save the script with the name S3D_GoldenGate_alias_user.sql.
You can provide any valid user name and password combination on each server.
Make sure that each username and password combination is unique.
4. Open SQL *Plus and connect to the Oracle instance as an administrative user who can
create users, grant privileges, create tablespaces, and alter users (as sysdba).
5. At the SQL prompt, type the following statement, and press ENTER:
@"<file location>\S3D_GoldenGate_alias_user.sql";
6. Review the output of the script, and resolve any reported errors.
The first time you run S3D_GoldenGate_alias_user.sql on a server, the following
error might display. This error is expected and resolves itself:
ORA-01918: user s3dgguser does not exist
7. Click Start > All Programs > Accessories > Command Prompt (Run as Administrator),
and then navigate to the GoldenGate home folder.
8. Type the following command to open the GoldenGate command interface.
ggsci.exe
9. Type the following:

Project Management User's Guide 223

 Global Workshare

ADD CREDENTIALSTORE
If the credential store already exists, you are prompted for a warning. This is not
a problem.
ALTER CREDENTIALSTORE ADD USER s3dgguser ALIAS s3dgoldengate
You must replace the USER and s3dgguser with the user you created in step 2.
The ALIAS required to work with Smart 3D Workshare is s3dgoldengate.
10. After entering the second command in step 9, you are prompted for the password of the
s3dgguser. This information is encrypted and stored within the GoldenGate installation and
is only accessible by the GoldenGate process.

By default, the process creates the cwallet.sso file in .\dircrd\ in the GoldenGate
installation folder. When this file is created, only the current user has access to the credentials
created through GoldenGate. Full Control permissions on this file must be granted to the user
who interacts with the GoldenGate processes.

Create the Smart 3D GoldenGate User Alias for Multitenant

Configurations
Perform the following procedure at the Host and each Satellite locations if they are configured
as multitenant Oracle databases.
Smart 3D is now tolerant of the multitenant configuration, but does not allow for
plugging and unplugging of databases within a container.
1. Click Start > All Programs > Accessories > Notepad.
2. Type the following text:

DROP USER c##s3dgguser CASCADE;

CREATE USER c##s3dgguser IDENTIFIED BY password
DEFAULT TABLESPACE users quota unlimited on users;

Project Management User's Guide 224

 Global Workshare

GRANT connect, resource, FLASHBACK ANY TABLE, SELECT ANY TABLE,

INSERT ANY TABLE, UPDATE ANY TABLE, DELETE ANY TABLE,
CREATE TABLE, SELECT ANY TRANSACTION, SELECT ANY SEQUENCE,
SELECT ANY DICTIONARY, LOCK ANY TABLE, DROP ANY TABLE, EXECUTE ANY
PROCEDURE, SYSDBA TO c##s3dgguser container = all;
GRANT EXECUTE ON SYS.DBMS_FLASHBACK TO c##s3dgguser container = all;
EXEC dbms_goldengate_auth.grant_admin_privilege('c##s3dgguser',
container => 'all');

ALTER session set container = <Pluggable Database Name>;

DROP USER s3dpluguser CASCADE;
CREATE USER s3dpluguser IDENTIFIED BY password
DEFAULT TABLESPACE users quota unlimited on users;
GRANT connect, resource, FLASHBACK ANY TABLE, SELECT ANY TABLE,
INSERT ANY TABLE, UPDATE ANY TABLE, DELETE ANY TABLE,
CREATE TABLE, SELECT ANY TRANSACTION, SELECT ANY SEQUENCE,
SELECT ANY DICTIONARY, LOCK ANY TABLE, DROP ANY TABLE, EXECUTE ANY
PROCEDURE TO s3dpluguser;
GRANT EXECUTE ON SYS.DBMS_FLASHBACK TO s3dpluguser;
EXEC dbms_goldengate_auth.grant_admin_privilege('s3dpluguser');
3. Save the script with the name S3D_GoldenGate_alias_user.sql.
You can provide any valid user name and password combination on each server.
Make sure that each username and password combination is unique.
4. Open SQL *Plus, and connect to the Oracle instance as an administrative user who can
create users, grant privileges, create tablespaces, and alter users (as sysdba).
5. At the SQL prompt, type the following statement, and press ENTER:
@"<file location>\S3D_GoldenGate_alias_user.sql";
6. Review the output of the script, and resolve any reported errors.
The first time you run S3D_GoldenGate_alias_user.sql on a server, the following
error might display. This error is expected and resolves itself:
ORA-01918: user s3dgguser does not exist
7. Click Start > All Programs > Accessories > Command Prompt, and then navigate to the
GoldenGate home folder.
8. Type the following command to open the GoldenGate command interface.
ggsci.exe
9. Type the following.
ADD CREDENTIALSTORE
If the credential store already exists, you are prompted with a warning. This is not
a problem.
ALTER CREDENTIALSTORE ADD USER c##s3dgguser ALIAS s3dgoldengate
ALTER CREDENTIALSTORE ADD USER s3dpluguser@<Pluggable database name>
ALIAS s3dplug_<Pluggable database name>

You must replace the USER and s3dgguser with the user you created in step 2.
The ALIAS is s3dgoldengate for the container and s3dplug_##### to work with Smart 3D

Project Management User's Guide 225

 Global Workshare

Workshare, where ##### is the pluggable database name. The user name created for the
pluggable database must be specified as s3dpluguser@#####, where ##### is the
pluggable database name.
10. After entering the second command in step 9, you are prompted for the password of the
s3dgguser. This information is encrypted and stored within the GoldenGate installation and
is only accessible by the GoldenGate process.
By default, the process creates the cwallet.sso file in .\dircrd\ in the GoldenGate
installation folder. When this file is created, only the current user who has access to the
credentials created through GoldenGate. Full Control permissions on this file must be granted to
the user who interacts with the GoldenGate processes.

Verifying User Alias Configurations

Open ggsci under the Goldengate home and run the following command to verify that the alias
is configured properly:
dblogin useridalias s3dgoldengate
This should successfully log into the database. If not, you might need to reconfigure the alias.

In multitenant, the pluggable alias should be tested using the same command:
dblogin useridalias s3dplug_#####

If either alias needs to be reconfigured due to failure to log in, the alias credential will need to be
dropped before being added again:
ALTER CREDENTIALSTORE DELETE USER s3dgguser ALIAS s3dgoldengate

Project Management User's Guide 226

 Global Workshare

Register all Oracle instances on Smart 3D administrative

machine
When you execute the Duplicate Model for Workshare or Consolidate Model from
Workshare commands in Smart 3D, the software performs an Oracle connection to the Host
and all Satellite servers involved in the Global Workshare Configuration. To do so, all Oracle
instances must be registered on the Smart 3D administrative machine. If the connection cannot
be established to one or more servers, the operation fails and must be aborted.
To register all Oracle instances on the Smart 3D administrative machine, see Configure Oracle
Net Services in the Smart 3D Installation Guide.

Create Locations
A location is a geographical place, such as a city, country, or some other region. A location can
also identify the purpose of a computer involved in a Global Workshare Configuration, such as
Host, Satellite1, or Satellite2. The location can be any string identifier that represents an
informative name for the location. Data is typically transferred between workshare locations
consisting of a host and its various satellites.
Unlike permission group objects that are available only to the given model database, the
location object is a site-wide object. After a location is created, it is available to any model in the
site.
New Location is not available at satellite locations. New locations can only be
created at the host.

New Location
New > Database > Location creates a new location object. A location is a geographical place,
such as a city, country, or some other region. A location can also identify the purpose of a
computer involved in a Global Workshare Configuration, such as Host, Satellite1, or Satellite2.
The location can be any string identifier that represents an informative name for the location.
Data is typically transferred between workshare locations consisting of a host and its various
satellites.
Unlike permission group objects that are available only to the given model database, the
location object is a site-wide object. After a location is created, it is available to any model in the
site.
New Location is not available at satellite locations. New locations can only be
created at the host.

Project Management User's Guide 227

 Global Workshare

Create a new location

1. Click Database > New > Location.
2. In the New Location dialog box, type a name for the location.
3. In the Site server list, select the site server for the new location.
Only those servers that are registered through SQL Server on the Host computer
are available. For more information about registering a server, see the Intergraph SmartTM
3D Installation Guide available from the Help > Printable Guides.
4. In the Name rule ID text box, modify the name rule if necessary.
The Name rule ID is useful in determining which location placed a specific item in
the model.

 By default, the value in the Name rule ID field is identical to the value of the LocationID. The
LocationID is an integer generated by the software. Because the Host site is created first, its
value is 1. The first Satellite location created is given a value of 2, and so on.
 After a location is created, its properties cannot be modified and can only be deleted when
the Global Workshare is not active.

New Location Dialog Box

Sets options for creating a new location. The first location, or Host location, is created
automatically during the Site database generation process.
See Also
New Location (on page 42)
Create a new location (on page 198)
General Tab (New Location Dialog Box) (on page 199)

General Tab (New Location Dialog Box)

Specifies general information for the new location.
Name
Specifies the new location name. A location can be a city, country, or any other region. A
location can also identify the purpose of a computer involved in a Global Workshare
Configuration, such as Host, Satellite1, Satellite2, and so on.
Site server
Sets a site server for the new location. Only those servers that are registered on the Host
computer through SQL Server are listed.
Name rule ID
Specifies the name rule ID. This string appears as part of the name rule for new objects
created by the Satellite location.
See Also
New Location (on page 42)

Project Management User's Guide 228

 Global Workshare

Location Properties Dialog Box

Displays property information for the location that you selected in the tree view. The information
cannot be edited.
Property
Organizes the details about the location in this column of the grid.
Value
Specifies the appropriate facts about the location in this column of the grid.
Name
Displays the name of the selected location.
Site server
Specifies the name of the server for the selected location.
Naming String
Specifies the name rule ID that is assigned to the selected location.

Duplicate Model for Workshare

The Tools > Duplicate Model for Workshare command collects the name of the model to be
replicated, the Satellite locations involved in the workshare, and the Satellite server names for
the various databases. After the information is collected, the command generates the replication
scripts. You can add one or more satellite locations to an existing global workshare without
having to first consolidate all the satellite locations.
The Duplicate Model for Workshare command is only enabled when a Model database is
selected in the tree view at the Host location. Satellite locations cannot duplicate models.
Duplicate Model for Workshare cannot be run on satellite locations.
No modeling should occur on the Host or Satellite machines during the
Duplication process. Any work performed during this process, such as the creation of new
objects or filters, could be lost if they are not included in the backup of the databases.
See Also
Duplicate the Model for Global Workshare Configuration (on page 201)
Utilities and Services (on page 368)
Duplicate Model for Workshare Dialog Box (on page 202)
Duplicate Model for Workshare across Untrusted Networks (on page 250)

Project Management User's Guide 229

 Global Workshare

Duplicate the Model for Global Workshare Configuration

Before starting this procedure, we recommend that you create a backup of the non-replicated
databases. You must have also added the locations for any satellites you intend to add. For
more information, see New Location (on page 42).
No modeling should occur on the Host or Satellite computers during the
Duplication process. Any work performed during this process, such as the creation of new
objects or filters, could be lost if they are not included in the backup of the databases.
See Duplicate Model for Workshare across Untrusted Networks (on page 250)
for special instructions when this environment is to be configured when using Oracle.
1. In the tree view, select a Model (Model database).
2. Click Tools > Duplicate Model for Workshare. You can also right-click on the model in the
tree and select Duplicate Model for Workshare.
If you have not yet created a backup of the non-replicated model, Intergraph PPM
recommends that you step out of the duplication process and create a backup at this time.
In the event that you encounter problems during the Workshare process, you can restore
the backup set of databases on the server and continue working.
3. On the Duplicate Model for Workshare dialog box, select one or more Satellite locations in
the Available locations list and click Add.

 For each location selected, one row for each database type is added to the grid.
 You can remove a location from the Locations and servers where model will be
duplicated grid with the Remove button.
 You can add one or more satellites to an existing Global Workshare Configuration
without consolidating other satellites.
 You must type the GoldenGate administrator user name and password.
4. Click OK to start the duplication process.

 A variety of replication scripts and a batch files are generated during execution of the
Duplicate Model for Workshare command. These files are generated on the Smart 3D
administrative computer on which the command is executed and delivered to sub-
folders created in the local temp folder of the user executing the replication process.
 You can click Start > Run and type %temp% in the Run dialog box to locate the local
temp folder.
 In the initial duplication of one or more satellites, the files are created in the
ReplicationModelName subfolder of the local temp folder. When a single satellite is
added to an existing Global Workshare Configuration, the files are created in the
AddSatellite<LocationName>ModelName subfolder and the batch file names are
ToRunPrebackup.bat and ToRunPostRestore_<n>.bat, where <n> is a sequential
number with 1 being for the host, 2 being for the first satellite, 3 for the second satellite,
and so forth.
 For disaster recovery purposes, it is recommended that you backup these scripts and
batch files into a separate folder.

Project Management User's Guide 230

 Global Workshare

5. When the duplication process completes, click OK.

Duplicate Model for Workshare Dialog Box

Sets options for the Satellite locations that will be involved in the workshare and the Satellite
server names for the various databases.
Model to duplicate
Displays the name of the model database selected in the tree view. This model is duplicated
at each of the specified Satellite locations.
Available locations
Lists all of the Satellite locations. You can use the Windows Shift and Ctrl select options for
multiple locations.
Locations and servers where model will be duplicated
Displays the locations you have added to the table, as well as the database types, names
and servers. Only those servers that are registered on the Host computer through SQL
Server are available for selection and association with the location.
The Server column changes to Service when the database type for the site is
Oracle. The drop-down list of Oracle Services comes from Oracle Net Configuration
Assistant.
Add
Moves the location selected in the Available locations list to the Locations and servers
where model will be duplicated table. For each location selected, one row for each
database is added to the table. Note that the Reports and Reports schema databases are
excluded from the duplication process. You must regenerate the Reports databases at each
Satellite location after replication is complete.
Remove
Removes all rows for the selected location from the Locations and servers where model
will be duplicated table.
GoldenGate administrator user name and password
Allows you to type the GoldenGate administrator user name and password for the Host and
all Satellite locations participating in the workshare. The username of the GoldenGate
administrator can be GGADMIN, for example. The GoldenGate administrator username and
password is used for running the batch files used to set up goldengate processes. This
username and password is used for connection purposes and must be shared among all
locations participating in the global workshare for the lifetime of the GWC.
This field is only enabled when the database type is Oracle.
See Also
Duplicate Model for Workshare (on page 201)
Utilities and Services (on page 368)
Duplicate the Model for Global Workshare Configuration (on page 201)

Project Management User's Guide 231

 Global Workshare

Copy generated scripts into GoldenGate folders

The scripts generated by the Duplicate Model for Workshare command are broken down into
the servers participating in the Global Workshare Configuration. The script and files contained in
the subfolders need to be copied into their corresponding GoldenGate folder on each server.
1. Locate the replication scripts in the temp folder.
2. Copy the contents of the folder corresponding to the Host server.
3. On the host database server, paste the files onto the GoldenGate folder.
If prompted, allow the files to be overwritten.
4. Repeat the procedure for the remaining folders corresponding to satellite servers.

 The files need to be copied to the root of the GoldenGate folder. If the files are executed on
a folder that is not in the GoldenGate folder, a warning message displays.
 Network policies can delete your Temp folder after you log off of a machine. If this is your
company’s policy, make a backup of the scripts, or move these scripts to a non-volatile
location.

Execute PreBackup scripts

The Duplicate Model for Workshare command generates a series of scripts that have a
specific order of execution. The PreBackup<InstanceName>_<SiteDB>_<LocationID>.bat
scripts are the first in a series of scripts that need to be copied to the GoldenGate folder. These
scripts create the initial objects required for replication, including the GoldenGate manager
service. The scripts must be executed on the Host and all corresponding Satellite servers while
logged in with the administrator account.
1. Log on to the Host or Satellite server as an administrator with the
SP3D_PROJECT_ADMINISTRATORS Oracle role.
You can execute the PreBackup scripts on all Satellite servers simultaneously.
2. Go to Start > All Programs > Accessories > Command Prompt (Run as Administrator),
and navigate to the GoldenGate installation folder.
3. Type the following command, and press ENTER:
PreBackup_<Instance>_<SiteDB>_<LocationID>.bat >
PreBackup_<Instance>_<SiteDB>_<LocationID>.log
The names for the scripts above are for illustrative purposes. Ensure the names
for your scripts are correct before running them.
4. Review the log file output of the script, and resolve any reported errors.

Project Management User's Guide 232

 Global Workshare

Make a Smart 3D backup

After executing the PreBackup<InstanceName>_<SiteDB>_<LocationDB>.bat scripts, make
a backup of the Model in Project Management. This backup serves as the backup for all Satellite
servers in the Global Workshare network.
1. Open Project Management, and make a backup of the model.
2. Save the files to a location where they can be retrieved.
3. Transfer the backup files, and a copy of the SharedContent folder, to each of the Satellites
being configured.

 Because the database backup file set is highly compressible, Intergraph recommends that
you compress the dataset to improve transfer time to the Satellite locations.
 After completing the backup, users can resume working on the Host while the initial Global
Workshare Configuration setup is in progress.

Restore Duplicated Databases at Satellite Locations

The transferred database backups are restored on each Satellite location server using the same
names as the original databases on the Host server. First, use the Smart 3D Database Wizard
to restore the Site and Site schema databases. Then, use Tools > Restore in the Project
Management task to restore the Catalog, Catalog schema, and Model databases.
1. Open the Smart 3D Database Wizard, and restore the Site and Site schema.

Project Management User's Guide 233

 Global Workshare

Make sure the Site database workshare location field contains the
correct location name when restoring the site.

2. Use Project Management to restore the Model and Catalog databases onto the Satellite
server.

Project Management User's Guide 234

 Global Workshare

3. Run the Regenerate Reports Database command on the Satellite locations.

 You must run this command when you execute the PostRestore script.
 When the Catalog database is restored on a Satellite server participating in a Global
Workshare Configuration, the path information for the SharedContent folder is saved.
Administrators at the Satellite locations can use the Project Management task to make the
path to the SharedContent folder location-specific.

Execute PostRestore scripts

The Duplicate Model for Workshare command generates a series of scripts that have a
specific order of execution. The PostRestore<InstanceName>_<SiteDB>_<LocationDB>.bat
scripts are the second in a series of scripts that need to be copied to the GoldenGate folder.
These scripts finish the creation of the objects required for replication, including the GoldenGate
manager service. The scripts must be executed on the Host and all corresponding Satellite
servers while logged in with the administrator account.
1. Log on to the Host or Satellite server as an administrator with the
SP3D_PROJECT_ADMINISTRATORS Oracle role.

 You can execute the PostRestore scripts on all Satellite servers simultaneously.
 If a different login other than the administrator account is used to run the scripts, it must
be able to connect to the Oracle instance with the connect /@server as sysdba
privilege.
2. Click Start > All Programs > Accessories > Command Prompt (Run as Administrator),
and navigate to the GoldenGate installation folder.
3. Type the following command, and press ENTER:
PostRestore_<Instance>_<SiteDB>_<LocationID>.bat >
PostRestore_<Instance>_<SiteDB>_<LocationID>.log
The names for the scripts above are for illustrative purposes. Ensure the names
for your scripts are correct before running them.
4. Review the log file output of the script, and resolve any reported errors.

Regenerate the reports database

Before starting this procedure, check with your administrator to verify that all
users are disconnected from the database.
1. Select a model database in the Project Management tree view.
2. Click Edit > Regenerate Reports Database.
The Regenerate Reports Database dialog box displays.
3. Review and, if necessary, edit the information displayed for the reports databases and
servers.

Project Management User's Guide 235

 Global Workshare

4. Click OK to regenerate the reports database.

 Reports databases must have unique names. If the reports database name you specify
already exists, the software prompts you to either rename the database or reuse the existing
reports database.
 If the software is unable to successfully create the reports schema, an error message
displays and the process ends.

Install and configure the Duplication Synchronization

Service (DuSS)
The Duplication Synchronization Service (DuSS) works with the database replication service to
maintain a healthy model at each Global Workshare Configuration location. If users at different
locations are working on unrelated objects within the model, or if they are working on related
objects at different times, the basic replication engine handles everything, and the DuSS is not
activated. However, if users at different locations are working on closely related objects in a
model at the same time, the DuSS is required to step in and resolve conflicts by preventing
certain inconsistencies and ensuring that the model data is accurate at all locations. The DuSS
must be configured and running at each location within a Global Workshare Configuration. You
must activate the DuSS at the Host and each Satellite location at the end of the Global
Workshare setup.

Configure the Duplication Synchronization Service

1. Log on as an administrator on the local computer and add [Product
Folder\Smart3D\Core\Runtime] to environment path variable.
2. Click Start > All Programs > Accessories > Command Prompt.
If the computer is running on a Windows 7 or Windows Server 2012 operating
system, you must open a command prompt with full administrator permissions. Type CMD in
the Run dialog box, and press CTRL + SHIFT + ENTER.
3. Use the cd command to switch to <Installation folder>\ProjectMgmt\Middle\bin.
4. Type the following command line:
DuplicationSyncService.exe –I
To uninstall the Duplication Synchronization Service, type the following command
line:
DuplicationSyncService.exe –u
5. Close the Command Prompt window.
6. Open Start > All Programs > Intergraph Smart 3D > Database Tools > Modify Database
and Schema Location and set the Site database connection that needs to be processed by
DuSS.
The Site database information must be set with the user account that is running
the DuSS service.
7. Click Start > Run. Type services.msc, and then click OK.
The Services window is displayed.

Project Management User's Guide 236

 Global Workshare

8. In the Services window, right-click S3D Duplication Synchronization Service and select
Properties.
9. Select the Log On tab and type a user who has local machine administrator privileges and
access to Smart 3D databases.
10. On the General tab, set the Service to Automatic, and then select Start.
11. Click OK.
12. Open Project Management while connected to the Host server.
13. Right-click the model to configure for DuSS, then select Properties.
14. Under the Databases tab, scroll to the Node for Duplication Synchronization Service
column, and type the name of the corresponding computer where the DuSS service was
installed for Host and Satellite servers.

 You must install Smart 3D software on the DuSS configured computer.

 If you have the Global Workshare environment on different Smart 3D software versions, then
you must install a separate DuSS service for each version.

Monitor the Duplication Synchronization Service

The DuSS writes status information to log files that are located in the temp folder on the
computer where the DuSS is running. The two log files used are Duss.logA and Duss.logB. The
status information is written to one log file until it reaches a maximum size, and then the service
switches over to use the other log file. Each time a log file is reused, the previous data is
overwritten. In this way, the recent activity is always recorded without allowing the log files to
become huge. You can monitor the DuSS activity by reviewing these log files.

Monitoring Replication
After replication is configured, it is critical that replication run without issues so that all data is
replicated between all locations. Because replication is accomplished using the GoldenGate
software, the database administrator is responsible for monitoring and maintaining replication
using the tools available in the GoldenGate installation. There are several methods that can be
used to monitor replication from simple SQL scripts through reports to sophisticated utilities.
Issues with replication must be resolved promptly because they might impact
modeling.

Verify GoldenGate Manager Windows Service is running

The manager is the control process of GoldenGate. It serves as the parent process for all
processes extracting and replicating data from the databases.
1. Open the Windows Services console, and verify that the GoldenGate manager service is
running. Manually start the service if it is not running. The service has the following name
format:
GGSMGR_S3D
2. Verify that the GoldenGate manager service has been set to Automatic (Delayed Start).

Project Management User's Guide 237

 Global Workshare

If you want to use a graphical tool to monitor the GoldenGate installation, refer the
Oracle GoldenGate Monitor Installation Guide.

Verify GoldenGate processes are running

There are three types of GoldenGate processes:
Extract
Connects to the source database to capture changes and writes them to a local file called
the trail file.
Data Pump
Reads information from the trail file and sends it across the network to the corresponding
trail file on the target server. This is a secondary process to the Extract process.
Replicat
Reads the information from the trail file on the system on which it resides and applies it to
the corresponding target database.
At the Host server, the number of Extract processes corresponds to the number of databases
being replicated. For a one Model workshare, there is a total of 5 Extract processes, 5 Data
Pumps, and 1 Replicat.
The GoldenGate command interface can be used to retrieve status information from each one of
these processes.
1. Click Start > All Programs > Accessories > Command Prompt, and then navigate to the
GoldenGate home folder.
2. Type the following command to open the GoldenGate command interface:
ggsci
3. Type the following command:
status *
A list of the GoldenGate processes displays.
4. Verify that the status of each Extract, Data Pump, and Replicat process is set to RUNNING.
If a process is not running, start the process by typing the command "start" followed by the
process name on the command line and then pressing ENTER. You can start all processes
simultaneously by Typing start * on the command line.
The process type is identified by the last letter of the process. Extract, Data
Pump, and Replicat are represented by E, P, and R, respectively. For example, a process
with the name "07601SSE" is an Extract process.

 The status of the GoldenGate manager service can be obtained by typing INFO MGR in the
GoldenGate command line interpreter.
 The GoldenGate Data Pump is not related to the database engine Data Pump.

Project Management User's Guide 238

 Global Workshare

Firewall Exceptions for GoldenGate

Following are the firewall exceptions for GoldenGate software:
 The firewall must support Stateful Packet Inspection (SPI) and should be ON.
 The TCP port 7809 or any other ports assigned to the GoldenGate Manager service must be
open.
 Executables such as mgr.exe, server.exe, ggsci.exe, replicat.exe, and extract.exe from
the GoldenGate installation folder must have exceptions in the Windows firewall.

Add a Satellite to an Existing Oracle Global

Workshare
This procedure steps you through adding a new Satellite to an existing Oracle Global Workshare
Configuration (GWC).
For information on setting up a new Oracle GWC, see Global Workshare Configuration (on page
214).
The new Satellite must be properly configured for GoldenGate replication before
proceeding. This includes creating the GoldenGate administrator account, creating the
GoldenGate service account, installing the GoldenGate software, and configuring the network
connectivity between the administrative workstation and the two servers.
1. Connect to the Host server, and open Project Management.
2. Add the location for the new Satellite.
Create a new location (on page 198)
3. Run the Duplicate Model for Workshare command for the new Satellite location.
Duplicate the Model for Global Workshare Configuration (on page 201).
The Duplicate Model for Workshare dialog box displays.
4. Select the new Satellite location, and click Add >>>. When prompted, type the GoldenGate
administrator account password.
A new set of scripts is created and placed in the AddSatellite_<Location>_<Model> folder.
5. Navigate to the local temp folder, and open AddSatellite_<Location>_<Model>.
To locate the local temp folder, click Start > Run, and type %temp% in the Run
dialog box.
6. Copy the scripts into their corresponding servers. For more information on copying scripts,
see Copy generated scripts into GoldenGate folders (on page 232).
7. Execute the PreBackup scripts on the Host server and the newly added Satellite server. For
more information, see Execute PreBackup scripts (on page 232).
8. Create a backup of the Model. For more information, see Make a Smart 3D backup (on
page 233).
Create a backup file (on page 99)

Project Management User's Guide 239

 Global Workshare

9. Copy the backup files, and a copy of the SharedContent folder, to the new Satellite server
and restore the database to the Satellite location.
Restore a site database (on page 380)
10. Execute the PostRestore scripts on the Host server and the newly added Satellite server.
For more information, see Execute PostRestore scripts (on page 235).
11. Regenerate the Reports database at the newly added Satellite server. For more information,
see Regenerate the reports database (on page 125).
12. After the scripts finish executing, monitor the replication to ensure that all GoldenGate
processes are running. For more information, see Monitoring Replication (on page 237).

 Users do not have to stop working on existing satellites when a new Satellite is added to an
existing Oracle GWC.
 To track any unusual errors that might occur, it is recommended that you output the setup
Golden Gate batch files to a .log file. For example, to create an output log file when you
execute a batch file named PostRestore.bat located in a subfolder of the C:\temp folder, type
the following in the Run dialog box: C:\temp\ReplicationPlant1\PostRestore.bat >
C:\temp\ReplicationPlant1\PostRestore.log.
 You must run the PreBackup.bat or PreBackup<ServiceName>.bat file before you make
the backup files on the host. The PostRestore.bat or PostRestore<ServiceName>.bat file
must be run after you restore the backup files on the Satellites.

Workflow for Consolidating Oracle Databases

Consolidation merges back replicated databases on one or more Satellite servers to the
databases on the Host server so as to form a single database of each type. You can use this
command to consolidate a single Satellite, multiple Satellites, or all Satellites. If the databases
from all the Satellite locations are consolidated, the resulting merged databases resemble the
original databases, and users can work with them as if the databases were never replicated or,
at a point later in the design process, the databases can be replicated again with the same or
with different Satellite locations.
Additionally, permission groups that were assigned to the selected Satellite locations for the
duplicated model are reassigned to the Host location for a consolidated model.
You can use the Consolidate Model from Workshare command to remove a
selected satellite from a workshare configuration without being forced to consolidate all Models
back to the host.

Consolidate the Oracle Databases

Use the Tools > Consolidate Model from Workshare command to merge back all the
replicated databases at one or more of the Satellite locations to form a single database of each
type. For more information, see Consolidate all Oracle databases (on page 241).
A series of files and scripts are generated during execution of the Consolidate Model from
Workshare command. In the case where you are consolidating all the satellite databases, these
files are created in the Consolidate<ModelName> subfolder under the local temp folder. If you
are consolidating a single satellite, these files are created in a subfolder named
RemoveSatellite<LocationName>_<ModelName> in the local temp folder.

Project Management User's Guide 240

 Global Workshare

To locate the local temp folder, click Start > Run and type %temp% in the Run dialog
box.

Regenerate Reports Databases

After the databases are merged back to the Host, right-click the model in the tree view, and then
select Regenerate Reports Database. For more information on regenerating Reports
databases, see Regenerate the reports database (on page 125).

What do you want to do?

 Consolidate all Oracle databases (on page 241)
 Remove a satellite from an existing Oracle Global Workshare (on page 242)

Consolidate all Oracle databases

You must perform this procedure at the Host location on which the replication process was first
initiated.
1. In the Project Management tree view, select the replicated model to consolidate.
2. Click Tools > Consolidate Model from Workshare.
You can also right-click a replicated model in the tree, and select Consolidate
Model from Workshare on the shortcut menu.
3. Type the GoldenGate administrator password, and click OK.
A series of scripts are generated in a subfolder named "Consolidate<ModelName>" in the
local temp folder.
4. Copy the scripts into their corresponding servers. For more information, see Copy generated
scripts into GoldenGate folders (on page 232).
5. Using the administrative account, connect to the Host server and all Satellite servers being
removed.
6. Run the following script from the command prompt:
Consolidate_<Instance>.bat > Consolidate_<Instance>.log

 You can click Start > Run and type %temp% in the Run dialog box to locate the local temp
folder.
 Although not a mandatory part of the consolidation of replicated databases workflow, it is
recommended that you run the View Generator on the Model database. The View
Generator is delivered to [Product
Folder]\Administrator\Core\Tools\Administrator\Bin\ViewGenerator.exe.
 The Reports database is excluded from the consolidation process. Consequently, you must
regenerate the Reports database. For more information, see Regenerate the reports
database (on page 125).
 After successful consolidation, the permission groups (and their objects) that were
associated to the Satellite locations now belong to the Host location; the consolidated
databases now behave as normal, non-replicated databases.

Project Management User's Guide 241

 Global Workshare

Remove a satellite from an existing Oracle Global

Workshare
1. Using the Administrative computer, connect to the Host database of the Global Workshare
Configuration.
2. In the Project Management tree view, select the replicated model from which to remove the
Satellite.
3. Click Tools > Consolidate Model from Workshare in Project Management on the Host
server.

You can also right-click a replicated model in the tree, and select Consolidate
Model from Workshare on the shortcut menu.

Project Management User's Guide 242

 Global Workshare

4. Highlight the satellite Location(s) to remove, and type the GoldenGate administrator
password.

5. Click OK.
A series of scripts are generated in the RemoveSatellite<Location>_<Model> subfolder and
the local temp folder.
6. Copy the scripts into their corresponding servers. For more information, see Copy generated
scripts into GoldenGate folders (on page 232).
7. Using the administrative account, connect to the Host server and all Satellite servers being
removed, and run the following script from the command prompt (as Run as
Administrator):
Consolidate_<Instance>.bat > Consolidate_<Instance>.log

 When you are executing this command from the Host server, you must select to consolidate
or keep the Data Pump process for either the Site or the Catalog databases of the target
database, depending on the specifics of the workshare. The Data Pump process is
consolidated for the Model automatically.
 You can click Start > Run, and type %temp% in the Run dialog box to locate the local temp
folder.

Project Management User's Guide 243

 Global Workshare

 The Reports database is excluded from the consolidation process. Consequently, you must
regenerate the Reports database. For more information on regenerating Reports databases,
see Regenerate the reports database (on page 125).

Consolidate Models from Workshare Dialog Box

Displays information about the model to be consolidated and provides a grid control that lists the
Location, Type, Server, and Name of the duplicated Model databases. You can use this grid to
select one or more satellites to consolidated back to the host location. Selecting a row header to
consolidate a Model, highlights all rows for that Model. Each location plus databases
combination is selectable as a unit. If you do not select anything, then the entire workshare is
consolidated.
Select duplicated models to consolidate
Displays the location, type, server, and name for the duplicated model. You can use this grid
to select one or more satellites to consolidate back to the host location. If you select a row
header to consolidate a model, all rows for that model are highlighted. You cannot select
just one row of the grid. You must select at least one model before the OK button is
enabled.
The Server column changes to Service when the database type for the site is
Oracle.
GoldenGate administrator password
Allows you to type the GoldenGate administrator password for the Host and all Satellite
locations participating in the workshare. The username of the GoldenGate administrator can
be GGADMIN, for example. The GoldenGate administrator username and password is used
for connection purposes and must be shared among all locations participating in the
Workshare for the lifetime of the Global Workshare Configuration.
See Also
Duplicate Model for Workshare (on page 201)
Utilities and Services (on page 368)
Duplicate the Model for Global Workshare Configuration (on page 201)

Task Limitations When Working in a Global

Workshare Environment
Not all tasks can be performed at all locations participating in the Global Workshare
Configuration (GWC). Some tasks can only be performed at the Host location; additional tasks
can be performed at a Satellite location given that certain conditions are met. Consider the
following before setting up a GWC:

Administrative Tasks
The following administrative tasks must be performed from a computer on which the Project
Management option is installed:
In the following table, Conditional indicates that this action is dependent on the user
having the normally expected privilege (as in a non-GWC setup) to the object being modified or
deleted, or to the parent object if a child is being created.

Project Management User's Guide 244

 Global Workshare

Action Host location Satellite location

Execute Duplicate Model for Workshare Conditional No

command

Create Permission groups Conditional No

Create Permission group folders Conditional No

Add user or group to permission groups Conditional No

Modify user or group in permission group Conditional No

Assign permission group to location Conditional No

Change SharedContent for the Catalog Conditional Can execute only for the
database Catalog database at that
Satellite location.

Regenerate the Reports database Yes (for host) Yes (for Satellite)

Add new properties to object types Conditional No

Create Location objects Yes No

Execute Synchronize Model with Catalog Yes (for Host) Yes (for Satellite)
command

Database IFC Conditional Replicated from Host

location.

Bulkload to the Catalog database Conditional Replicated from Host

location.

Run Database Integrity command Yes No

Running the Synchronize Model with Catalog command at the Host location has the following
ramifications in a GWC setup:
 Items at Satellite locations that need updating are placed on the To Do List and can be
resolved by running the Synchronize Model with Catalog command at each Satellite
location. Alternately, each Satellite location can display the To Do List and update out-of-
date items manually.
 Model database views are updated only at the Host location. Each Satellite location needs to
run the Synchronize Model with Catalog command with respective options to update the
views on their Model database. Alternately, a Satellite location can run the View Generator
to update the model and/or catalog views. The ViewGenerator.exe file is delivered to the
[Product Folder]\Core\Tools\Administrator\Bin folder.

Project Management User's Guide 245

 Global Workshare

Modeling Environment Tasks

In the following table, Conditional indicates that this action is dependent on the user
having the normally expected privilege (as in a non-GWC setup) to the object being modified or
deleted, or to the parent object if a child is being created.

Action Host location Satellite location

View reference data in the Catalog task. Yes Yes

Use any of the commands in any of the Smart 3D Conditional Conditional

tasks (excluding the Project Management and
Catalog tasks).

Create/modify/delete objects under any system Conditional Conditional

created in the Systems and Specifications task.

Create/modify/delete a new branch in the Conditional Conditional

hierarchy tree in the Drawing and Reports task.

Create view styles. Conditional Conditional

Create/modify/delete catalog. Conditional No

Create/modify/delete model filters/filter folders. Conditional Conditional

Transfer selection set into permission group of Conditional Conditional

another location

Create/modify/delete items under the location- Conditional Conditional

specific branch (Drawings and Reports hierarchy
tree), including Report, Orthographic Drawings,
Isometric Drawings, and the output they
generate.

See Also
Utilities and Services (on page 368)

Considerations for Performing Large Transactions

When you perform large transactions in Global Workshare, you need to take the following
precautions:
 Perform large transactions during off-peak hours when system resources are not as heavily
loaded.
 Break large transactions into smaller chunks. For example, use smaller select sets when
deleting structure imported from TEKLA.
 Delete small sets of drawings or other objects rather than deleting a large set all at once.
The following types of transactions can become large:
 Performing Model Data Reuse tasks.

Project Management User's Guide 246

 Global Workshare

 Performing Database Integrity tasks. Use the following workflow:

a. Run DBI on the Host from the Project Management task.
b. Run DBClean on the Host from a Smart 3D session.
c. Wait for the transactions to complete.
d. Run DBClean at each Satellite location. Wait for the transactions to complete at one
location before processing the next location.
 Performing database maintenance. In particular, deleting database objects that users have
deleted from the model can create a transaction with several million records. This can take
days to replicate.
 Deleting existing TEKLA data before importing.
 Deleting large numbers of drawings. For example, deleting a snap-in of isometrics.
 Deleting large numbers of orthographic drawings.
 Deleting, copying, or moving large numbers of objects while inside the model.

Workflow to Synchronize Catalog Changes between

Host and Satellites
The majority of catalog changes are propagated in the Global Workshare Configuration (GWC).
However, if new catalog data is bulkloaded at the Host, the workflow depicted in the illustration
below must be conducted on the Host server and on all Satellite servers in the GWC. This
procedure regenerates the data that is not propagated to the Satellite and returns the workshare
to a synchronized state.
Intergraph does not recommend overwriting the Satellite catalog with a copy
of the Host catalog and then linking it to the model. Doing so increases the risk of breaking the
workshare.

Tasks Performed at the Host Location

1. Bulkload the required data to the Host catalog.
2. In the Project Management task, select the Host model in the tree.

Project Management User's Guide 247

 Global Workshare

3. Click Tools > Synchronize Model with Catalog.

4. In the dialog box, ensure Mark out-of-date, Update out-of-date, and Regenerate views
are selected, and click OK.
If the object is owned by the Host, the object is updated. If the object is owned by the
Satellite, the object is flagged for update. If a To Do List record is necessary, one is
created.
5. Click Edit > Regenerate Reports Database.
The software updates the views at the Host only.
The Reports database is a set of views that point to data in other databases.
Although the Reports database does not participate in the workshare, it must be kept up-to-
date.

Tasks Performed at the Satellite Location

After the required tasks are completed at the Host location, perform the following tasks at each
Satellite location participating in the GWC.
1. After replication has propagated changes from the Host to the Satellite, run the View
Generator against the catalog at the Satellite location. The View Generator executable,
ViewGenerator.exe, is delivered in the [Product Folder]\Core\Tools\Administrator\Bin folder.
You must select the Catalog as the data database and the Catalog schema as the schema
database to run this utility.
2. In the Project Management task, select the Satellite model in the tree.
3. Click Tools > Synchronize Model with Catalog.
4. In the dialog box, ensure that Update out-of-date and Regenerate views are selected, and
click OK.
The software updates the table content and the views on the model. Any objects that are
owned by the Satellite are flagged or updated. If a To Do List record is necessary, one is
created.
5. Click Edit > Regenerate Reports Database.
The software updates the views at the respective Satellite only.

 Mark out-of-date instructs the software to scan the model database and mark all objects
that are out-of-date with the catalog. In Workshare configurations, this option is disabled
when the selected model belongs to a Satellite.
 Update out-of-date instructs the software to update all objects that have been marked as
out-of-date in the model database. In Workshare configurations, this option is available for
both Host and Satellite locations.

Project Management User's Guide 248

 Global Workshare

Combining SmartPlant Foundation and Global

Workshare
In an integrated environment, SmartPlant Enterprise publishes and retrieves data through a
central repository, SmartPlant Foundation (SPF). A global workshare configuration (GWC)
environment shares all data within one model with multiple remote sites. You can combine the
two environments, allowing the use of a central repository at remote sites. A typical configuration
is shown below:

The software supports publishing to SPF for all levels of access, write or read-only. For
example, you can publish documents in permission groups owned by a Satellite on the GWC
Host or another Satellite even if you do not have write permissions in those permission groups.

 Revise and Update are available only if you have write access permissions.
 When publishing from other locations, read-only documents cannot be updated with the last
published timestamp. The software detects these drawings as new.
The following practices must be followed for effective coordination of SPF and GWC:
1. All data retrieval must be performed on one GWC Host or Satellite. The permission group
used for retrieval must only be available on that same Host or Satellite. This prevents a
design basis object from being moved so that it has ownership in multiple permission groups
and on multiple GWC sites. If this design basis object is later modified, it fails. Despite this
restriction, GWC replicates all retrieved objects to all sites. For more information, see

Project Management User's Guide 249

 Global Workshare

Retrieving Data in the Integration Reference Guide and Permission Groups in the Global
Workshare User's Guide.
2. Smart 3D model registration with the SPF site must be performed on the GWC Host. For
more information, see Register (on page 351) in the Integration Reference Guide.
For more information, see Publishing 3D Data in the Integration Reference Guide, and
Permission Groups and Global Workshare in the Global Workshare User's Guide.

Global Workshare Configuration across Untrusted

Networks
An untrusted network is defined as a network where a domain user is not able to authenticate
when attempting to access resources, either because there is no trust between the domains
involved, or because the networks are distanced by an intermediate layer such as the open
Internet.
A Global Workshare Configuration across untrusted networks is sometimes the only option for
interoperability between two companies on separate domains (for example, between an Owner
and an EPC). This section provides information on how to execute the Duplicate and
Consolidate workflows under untrusted networks.

Duplicate Model for Workshare across Untrusted Networks

This is only required if you are using Oracle as your database.
The Duplicate Model for Workshare command generates the scripts and batch files to setup
the replication process between the Host and each of the Satellites defined for the command.
The process to create the scripts requires the Smart 3D workstation to make an Oracle
connection to all database servers involved in the GWC. If a database server is on a domain
that is untrusted, the connection fails and the scripts are not generated without first adjusting the
AUTHENTICATION_SERVICES sqlnet variable.
Follow these steps to setup workshare across untrusted domains:
1. At the Host workstation, register the database servers from untrusted domains into the local
TNSNAMES.ORA file.
2. At the Satellite database server (untrusted) - Edit the Oracle sqlnet.ora file, and set
authentication services to NONE. By default, this file is located in the
ORACLE_HOME\network\admin folder.
SQLNET.AUTHENTICATION_SERVICES=(NONE)
3. Connect to the Host administrative workstation with Project Management, and create
corresponding locations for the servers in untrusted domains.
4. Using the administrative client computer at the Host location, run the Duplicate for
Workshare command, and add Satellites as usual. No errors should occur.
5. At the Satellite database server (untrusted) - Edit the Oracle sqlnet.ora file, and set
authentication back to Windows NT native authentication.
SQLNET.AUTHENTICATION_SERVICES=(NTS)
6. Copy the generated scripts from the Temp folder to their corresponding GoldenGate
installation folders.

Project Management User's Guide 250

 Global Workshare

7. Using the local administrator account, connect to the Host and Satellite servers, and
execute the PreBackup scripts. For more information, see Execute PreBackup scripts (on
page 232).
8. Using the administrative client computer at the Host location, create the required database
backups.
9. Copy the backup files to the servers in the untrusted domains.
10. Using the administrative client computer at the Satellite location, restore the database
backups to the servers on the domain in which replication is being setup.
11. Using the local administrator account, connect to the Host and Satellite servers, and
execute the PostRestore scripts. For more information, see Execute PostRestore scripts (on
page 235).
12. Finish the Global Workshare by performing additional configuration actions (Regenerate the
Reports database at all satellites, Setup the DuSS server, and Monitor replication).
See Also
Duplicate Model for Workshare (on page 201)
Duplicate the Model for Global Workshare Configuration (on page 201)
Monitoring Replication (on page 237)

Consolidate Model from Workshare across Untrusted

Networks
This is only required if you are using Oracle as your database.
The Consolidate Model from Workshare command generates the scripts and batch files that
must be run to merge back one or more Satellite servers to the databases on the Host server. If
a database server is on a domain that is untrusted, its connection fails and the consolidation for
that server is not executed. You need to do the following:
1. Using the administrative client computer at the Host location, run the Consolidate Model
from Workshare command.
2. Copy the generated scripts from the temp folder to their corresponding GoldenGate
installation folders.
3. Using the local administrator account, connect to the Host server and each Satellite server
being removed, and run the following command in the command prompt:
Consolidate_<Instance>.bat > Consolidate_<Instance>.log
If you execute the script at the Host server and only one of the servers in a multi-
satellite workshare is being consolidated, additional prompts may display.
See Also
Duplicate Model for Workshare across Untrusted Networks (on page 250)
Copy generated scripts into GoldenGate folders (on page 232)

Project Management User's Guide 251

 Global Workshare

Failure and Recovery Overview

In the Smart 3D Global Workshare (GWS) environment, it is possible for a Host server or
Satellite server to fail due to hardware or other catastrophic failure. The GWC Host Failure-
Recovery and GWC Satellite Failure-Recovery workflows describe methods for recovering from
such failures.
See Also
Host Failure and Recovery (on page 208)
Satellite Failure and Recovery for SQL Server (on page 191)
Catalog Data Recovery for SQL Server (on page 187)
Satellite Failure and Recovery (GWC) (on page 253)
Model Data Recovery (on page 209)

Host Failure and Recovery

The following workflow explains a procedure for recovering the Host server in a Global
Workshare Configuration (GWC) environment in the event of a failure. A Host server can fail due
to hardware or other catastrophic failure. The GWC Host Failure-Recovery workflow is not
intended for temporary network outages from which the GWC can recover without intervention.
If you have lost your Host location in a GWC, please contact Intergraph support
(www.intergraph.com\support) for advice before you start the recovery operation.
When the Host server fails, GWC data begins to accumulate on each of the
Satellite servers. When it is clear that the Host server is down, stop work on each Satellite
server until the Host server is repaired or replaced.
1. Determine which dataset to copy for recovery from the remaining Satellite servers. Use the
most complete dataset available from the Workshare location.
You must recover data from all the other Satellite locations that were not
chosen using copy/paste and restore after the GWC is running again.
To integrate the data not chosen, see Model Data Recovery (on page 209).
2. Backup the dataset to be copied. For more information, see Backup (on page 97).
3. Remove Smart 3D data from all servers that participated in the previous Smart 3D Global
Workshare Configuration.
4. Create a new Site and Site schema using the Database Wizard. For more information see
Create Site Database and Schema Page (on page 378).
5. Populate the new Site using the backup dataset with the Restore Model as Copy feature in
the Restore Wizard. For more information, see Restore a model as a copy (on page 106).
6. Backup the restored model. For more information, see Backup (on page 97).
7. Configure Global Workshare. For more information, see Global Workshare Configuration (on
page 214).Global Workshare and SQL Server Databases (on page 172).
See Also
Satellite Failure and Recovery for SQL Server (on page 191)
Catalog Data Recovery for SQL Server (on page 187)
Model Data Recovery (on page 209)
Workflow for Consolidating Oracle Databases (on page 240)

Project Management User's Guide 252

 Global Workshare

Satellite Failure and Recovery (GWC)

The following workflow explains a procedure for recovering the Satellite server in a Global
Workshare Configuration (GWC) environment in the event of a failure. A Satellite server can fail
due to hardware or other catastrophic failure. This workflow allows the GWC to remain active;
only the lost Satellite location experiences an immediate work stoppage.
The overall workflow consists of removing the failed satellite, performing cleanup actions, and
adding the new satellite server.
1. Using the Host administrative client, open the Project Management task, and run
Consolidate Model from Workshare. For more information, see Workflow for
Consolidating Oracle Databases (on page 240).
2. Copy the scripts generated onto the corresponding servers. For more information, see Copy
generated scripts into GoldenGate folders (on page 232).
Because the Satellite server being repaired may be unavailable, you only need to
copy the consolidation scripts onto the Host server's GoldenGate folder.
3. Run the consolidation scripts on the Host and all corresponding Satellite servers.
4. If the Satellite server is online, delete all Smart 3D databases that were previously
participating in replication.
See Also
Add a Satellite to an Existing Oracle Global Workshare (on page 239)
Remove a satellite from an existing Oracle Global Workshare (on page 242)

Model Data Recovery

In the event that Model data is deleted or modified, and you want to return to the previous state
to recover the data, the workflow in this topic describes how to do so in a Global Workshare
Configuration (GWC) environment. For this to be effective, regular backups must be conducted
at each Workshare location.

Recover Data from the Model Database

1. Locate the most recent backup that contains the intact modified or deleted objects.
2. Connect to the GWC location at which the model data was deleted or modified.
3. In Project Management, select Tools > Restore.
4. In the Restore Wizard dialog box, select Restore model for selective recovery of model
objects, and then click Next.
5. In the Backup configuration file to restore box, type the path to the backup configuration
file (.BCF), or click Browse , navigate to the file location, and then select the file.
The Restore Wizard dialog box is populated with the following information:
 The Model to restore box displays the name, database size, and the date of the
backup file for all the models saved in the specified backup location. The list is
populated after you select the backup configuration file you want to restore. You can
only select a single model to restore.

Project Management User's Guide 253

 Global Workshare

 The Server and path to existing database backup files table displays the server and
database backup files path where the database backup files are located. Click Browse
and navigate to the path on the specified server. This option displays only when you
are restoring a SQL database.
 The Service and path to existing database backup files table displays the Oracle net
service and database backup files path for the database backup files. This option
displays only when you are restoring an Oracle database.
 The Paths for new databases table lists the database types saved to the backup file,
including the server (when restoring SQL databases),the Oracle net service (when
restoring Oracle databases) and paths for the restored database and log file.
 The New model name dialog box displays the restored model name with the date of the
selected backup file (.BCF) as a suffix. The root object in the Model database is not
renamed. You can change the name, which is especially useful for partial recovery at
Satellite locations.
 The Description box provides a space for you to type a description of the restored
model.
6. Click Finish, to restore the portion of the Model database to the existing model database as
defined by the permission groups you selected.
7. In the Restore model as Copy dialog box, you are prompted to choose whether to link to
the existing catalog. Select Yes.
You must select Yes at this prompt, or you will overwrite the Workshare
Catalog for the GWC.
8. Use the copy and paste and restore options within the model to restore the objects to the
previous state.
9. Open Smart 3D.
10. Open two Smart 3D sessions.
11. In one session, define a workspace with the workshare model.
12. In the other session, define a workspace with the model that was restored for selective
recovery.
13. In the session with the workspace of the model restored for selective recovery of modeled
objects, select all objects, and perform a Copy.
14. Switch to the other open session, which has the workspace defined for the model.
15. Click Edit > Paste and Restore.
See Also
Restore a backup model for selective recovery in an active model (on page 105)
Restore Wizard (on page 111)
Restore Model for Selective Recovery of Model Objects (Restore Wizard) (on page 113)

Project Management User's Guide 254

 Global Workshare

Deleting Archive Logs

Deleting archive logs that are no longer needed is an efficient way to free disk space. There
might be instances where incorrect deletion of archive logs can lead to potential data loss and
workshare instability. To determine which archive logs to delete, refer to the Purging Archive
logs section in the Oracle GoldenGate for Windows and UNIX Administrator's Guide.
We recommend that you do not delete archive logs until you verify that the backup
log files are functioning properly.

Project Management User's Guide 255

SECTION 12

Model Data Reuse (MDR)

The Tools > Model Data Reuse (MDR) command supports:
 Copying large amounts of data from a source model in one site to a destination model in a
different site.
 Copying large amounts of data from a source model and reuse that data within the same
site, either within one model or from one model to other models.

Model Data Reuse Wizard

Model Data Reuse opens a wizard that sets up the data reuse operation. Use the wizard to do
the following:
 Identify the source model that the data is copied from and the source object selection
method that you are using. You can select source data by Source System or Source
Objects by Filter.
 Identify disciplines to copy in order to filter unnecessary objects.
 Identify the destination model where the data is copied and the destination parent system in
the destination for the copied objects.
 Identify the permission group for the copy destination and perform any permission mapping,
if necessary.
 Select the mode of transformation to determine where the copied objects appear in the
destination.
 Resume Model Data Reuse (MDR) copy operations that are stopped manually or interrupted
by a hardware or software failure.
The full set of objects to be copied is divided into a sequence of smaller partitions, and each
partition is copied in a separate transaction. Relationships between objects in different partitions
are copied along with the objects in later transactions. If a single partition cannot be copied, the
operation does not stop, but instead continues with the next partition.
When the MDR operation completes, an Operation Properties dialog box displays. It shows the
general information of the operation, the status of the operation, and a breakdown of the number
of design objects copied, copied successfully, and failed to copy.
If you encounter low memory conditions while running Model Data Reuse, the
current operation is stopped, and an error message displays. You must first restart Project
Management, and then you must restart Model Data Reuse to continue. After completion, the
Operation Status displays as Stopped: Low Memory in the Operation Properties dialog box.
For more information, see Model Data Reuse Wizard (on page 262).

Best Practices with Model Data Reuse

To achieve the highest rate of success when copying objects, run these tasks before you begin
copying to ensure the database integrity:

Project Management User's Guide 256

 Model Data Reuse (MDR)

1. Run Synchronize Model with Catalog.

2. Run Database Integrity.
3. Run Database Clean.
4. Fix as many issues as possible listed in the To Do List.
5. If you are in a Global Workshare environment, make sure the data replication is working at
all Host and Satellite locations and that the data replication is complete.
6. If you are using different catalogs, run Compare Catalogs to ensure that the catalog data
for the copied objects is the same.
7. Save all changes made to catalogs and workbooks.
If the source specs and destination specs are in different units, computing errors may
occur. Make sure that the units are the same to ensure best results.

Recommended Practices for Model Data Reuse

In plant models, you can copy an entire unit system or area system . A unit or area
typically includes many structural members, slabs, walls, equipment, foundations, pipe runs,
ducts, cable trays, conduits, and hangers.
In marine models, you can copy major sections of marine structure and outfitting. The sections
may be organized into assemblies or blocks . While you cannot select an assembly or a
block as a filter type, you can preserve assignments of parts in assemblies with the Copy
related assemblies option. For more information, see Model Data Reuse Wizard: Disciplines
(on page 282). You can also copy the systems possible for plant models.
In material handling models, you can copy an entire conveyor system, including belts,
equipment, modules, chutes, trusses, and trestles. You can also copy the sections and systems
possible for plant and marine models.
You can also exclude any objects form the source select set and MDR will copy the remaining
objects.
Copying small quantities of individual children objects without a parent system
is not supported in MDR. For example, copying piping features without the parent pipe run is not
supported. Copying marine profiles or seams without the parent plate is not supported.

Compatibility between Sites

Model Data Reuse can only copy between models from compatible sites. Compatibility includes
the following criteria:
 DBMS Provider - MDR can only copy between models that are based on the same type of
underlying database management system (Microsoft SQL Server or Oracle). The Select
Site dialog box only allows the selection of a site from a compatible server. For more
information, see Select Site Dialog Box (on page 266).
 Software Version - MDR can only copy between models that were created with (or
upgraded to) the same software version. If you select a source site with a different version
from the active site, an error dialog box displays, and you are prevented from continuing.
 Catalog and Schema - MDR can copy between models with different catalogs and catalog
schemas. If you copy across sites, or if you have multiple catalogs in the same site, the
source and destination models are attached to different catalogs and catalog schemas. In

Project Management User's Guide 257

 Model Data Reuse (MDR)

this situation, a warning dialog box displays stating that the catalogs are different. You can
still proceed with the copy operation. Later in the Model Data Reuse Wizard, the Compare
Catalogs page displays. Use this page to compare the catalogs and catalog schemas to
identify differences in the catalog schema before you start the Model Data Reuse operation.
The Compare Catalogs page also allows you to map the catalog's content, if there are
differences. During the MDR operation, the copied objects are automatically adapted to their
destination environment. The adaptation logic ensures that the schema identifiers (GUIDs)
stored in the model are updated to be consistent with the destination schema.
When you copy pipe specs across two different catalogs, make sure that the
source and destination specs are in the same units of measurement (NPD). If the units are
different, computing errors may occur. For more information, see Model Data Reuse Wizard:
Compare Catalogs (on page 302).
 Compatibility Verification - Only compatible sites are available for you to select.
Incompatible sites display, but they are not selectable. If you select an incompatible site, the
software displays a message box explaining why that site is invalid.

Oracle Tablespace Extension Before Large Copy Operations

The Oracle database system is normally configured to automatically extend the tablespaces by
a small increment. During interactive work, data is added in small increments, and the automatic
extension of the tablespaces works fairly well. However, during a large MDR copy operation, in
which a large amount of data is added, many incremental extensions of the tablespaces can
cause slower performance. To address this issue, you can extend the tablespaces one time to
accommodate all of the new data before starting the MDR operation. This allows the MDR
operation to proceed at full speed without waiting for the software to extend the tablespaces
multiple times.
You can calculate how much to extend each tablespace by determining the total amount of data
in your database and multiplying by the percent of the model intended for copying. For example,
if your current model occupies 1.2 GB of storage space in a tablespace and you will be copying
one quarter of that model, you can estimate that you will need at least 1.5 GB to hold the model
after the copy is complete. You can calculate the amount to extend the tablespace by finding the
difference between the current tablespace and the required size. Follow a similar procedure for
both the data and the index tablespaces, rounding up to the next larger 100 MB. Contact your
database administrator for details about how to extend the tablespace.

Model Data Reuse and Model Data Transform Workflow using Delete Optional
Smart 3D can delete optional inputs of the marine objects (plates, profiles, and so forth)
including detailing objects during copy paste, Model Data Reuse (MDR), and Model Data
Transform (MDT) processes so that objects can be copied and moved without having to select
all the inputs at the new location.
For example, plate system boundaries are inputs that should be redefined at the new plate
location. However, by selecting Delete Optional, you can replace all the optional inputs
(including boundaries, coordinate system, and so forth) with dummy objects (Dummy Plane,
Dummy Surface, and so forth). After the copy is complete, you can then go back and replace the
plate's dummy objects with real objects. However, in a large model, it is sometimes difficult to
identify the plates that have dummy optional inputs.
How to Identify Objects with Dummy Inputs
Smart 3D provides filters to identify objects with dummy inputs. You can access the Select
Filter dialog box using:

Project Management User's Guide 258

 Model Data Reuse (MDR)

 File > Define Workspace > Properties

 Tools > Select by Filter
For example, to find all the standalone and the lapped plate parts whose boundaries are
replaced by dummy objects, define the workspace using the Standalone and Lapped Plates
with Substituted Boundary catalog filter.

Similarly, if these plates whose definition objects are replaced by dummy objects, define the
workspace with the filter Standalone and Lapped Plates with Definition Object.

Project Management User's Guide 259

 Model Data Reuse (MDR)

You can define your own filters to find specific detailing objects in the workspace that have
dummy boundaries or definition-objects by defining the property Has Substituted Boundary or
Has Substituted definition object. To create a new filter:
1. Click File > Define Workspace.
2. In the Model list, select the model.
3. In the Filters list, click Create New Filter.
4. On the Properties tab, select the object properties to restrict your search.
5. Click More… and select the object type used and the property name Has Substituted
Boundary, and click OK.

Project Management User's Guide 260

 Model Data Reuse (MDR)

6. On the Object Type tab, select the object type to highlight. If you do not select any objects,
the filter includes all objects in the list. To include one or more object types in your filter,
press CTRL and click the name of each object type that you want to include. Click OK.

In This Section
Model Data Reuse Wizard ............................................................. 262
Model Data Reuse Wizard: Welcome............................................ 263
Model Data Reuse Wizard: Begin New Operation ........................ 264
Model Data Reuse Wizard: Source Model .................................... 265
Model Data Reuse Wizard: Source Systems ................................ 267
Model Data Reuse Wizard: Source Objects by Filter .................... 267
Model Data Reuse Wizard: Disciplines ......................................... 282
Model Data Reuse Wizard: Destination Model .............................. 284
Model Data Reuse Wizard: Destination......................................... 285
Model Data Reuse Wizard: Transformations ................................ 299
Model Data Reuse Wizard: Compare Catalogs ............................ 302
Model Data Reuse Wizard: Restart Existing Operation ................ 305
Model Data Reuse Wizard: Confirmation ...................................... 307
Model Data Reuse Wizard: Operation Properties Dialog Box ....... 308
Review Model Data Reuse Operation Results .............................. 310

Project Management User's Guide 261

 Model Data Reuse (MDR)

Model Data Reuse Wizard

The Model Data Reuse (MDR) command is available in Smart 3D Project Management. To
access the Model Data Reuse command, click Tools > Model Data Reuse.
The Model Data Reuse wizard contains multiple pages. You can navigate back and forth
through the pages using the Back and Next buttons located on each page.
The following illustration shows the general workflow for using MDR:

Next step:
Model Data Reuse Wizard: Welcome (on page 263)

Project Management User's Guide 262

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Welcome

Selects whether to define a new Model Data Reuse operation or resume an existing operation
that is stopped or is incomplete.
Begin new operation
Allows you to define a new Model Data Reuse operation. Opens the Begin New Operation
wizard page. This is the default selection.
Restart existing operation
Opens the Restart Existing Operation wizard page where you can view the status of
existing Model Data Reuse operations and resume an interrupted operation.
Upon creation, a Model Data Reuse operation is saved as an object in the
database. You must have write access to the permission group of the operation object in
order to restart an existing operation.

Next step:
Model Data Reuse Wizard: Begin New Operation (on page 264)
Or
Model Data Reuse Wizard: Restart Existing Operation (on page 305)

Project Management User's Guide 263

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Begin New Operation

Defines the operation name for the new Model Data Reuse operation.
Operation name
Specifies the operation name for the new Model Data Reuse operation. Every operation
must have a name. The default name is Copy_Operation_[Date]_[Time].

Next step:
Model Data Reuse Wizard: Source Model (on page 265)

Project Management User's Guide 264

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Source Model

Selects the model containing the objects to copy.
Source model
Displays the source model. By default, the selected model displays here. If no model is
selected, then one of the up-to-date models listed in the Project Management hierarchy
displays. You can select a model from the any compatible site; you do not have to select
from the active site.
Select Model
Allows you to select a different model from the default model as the source. You can select
a model from any compatible site. You do not have to select from the active site, but only
up-to-date models display for selection. For more information, see Select Source Model
Dialog Box (on page 266).
Source systems
Opens the Source Systems wizard page that allows you to select a system, or systems, to
copy. For more information, see Model Data Reuse Wizard: Source Systems (on page 267).
Source objects by filter
Opens the Source Objects by Filter wizard page that allows you to select a source filter.
This filter is used to find the source objects to copy. For more information, see Model Data
Reuse Wizard: Source Objects by Filter (on page 267).
You can select only a single method at a time for retrieving source objects.

Next step:
Model Data Reuse Wizard: Source Systems (on page 267)
-OR-

Project Management User's Guide 265

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Source Objects by Filter (on page 267)

Select Source Model Dialog Box

Controls parameters for selecting the source model.
Site
Specifies the site from which to copy the data. Click ... to display the Select Site dialog box.
For more information, see Select Site Dialog Box (on page 266). If the file name is too long
to display entirely, you can hover the cursor over the box to display the complete file name.
Models
Specifies the selected model. The list displays all models in the active site. If the file name is
too long to display entirely, you can hover the cursor over the box to display the complete
file name.

Select Site Dialog Box

Controls parameters for selecting a different site.
Site database server
Specifies the site database server. The list contains all registered database servers which
are of the same database management type (SQL Server or Oracle) as the active site. You
can type part of the name to jump directly to an item in the list that matches those
characters. These database servers can be registered through SQL Server Management
Studio for SQL or registered in the tnsnames.ora file for Oracle.
Site database name
Specifies the current site database name. The list contains all site databases in the selected
database server. You can type part of the name to jump directly to an item in the list that
matches those characters. The software displays a warning message if you do not have
permission to open and read from the selected site database.
For more information on compatibility between sites, see Model Data Reuse (MDR)
(on page 256).

Project Management User's Guide 266

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Source Systems

Selects the systems to copy. The software opens this page when you select Source Systems
on the Model Data Reuse Source Model page.
Source systems
Displays the source systems. You can select one or more systems.
Press and hold CTRL while clicking the mouse to select multiple items.

Next step:
Model Data Reuse Wizard: Disciplines (on page 282)

Model Data Reuse Wizard: Source Objects by Filter

Selects a filter to locate the objects to copy. The software opens this page of the wizard when
you select Source objects by filter on the Source Model page.
Filter
Allows you to create new filters or view existing filters.
Select Create New Filter, and then click More to open the standard Select Filter dialog
box.
Select Filter Dialog Box (on page 271)
Select an existing filter, or click Create New Filter, to open the New Filter Properties
dialog box. The New Filter Properties dialog box is similar to the Filter Properties dialog
box. Compound filters are not supported in MDR.
Filter Properties Dialog Box (on page 137)

Project Management User's Guide 267

 Model Data Reuse (MDR)

Properties
Displays the Filter Properties dialog box for the selected filter.
Filter Properties Dialog Box (on page 137)

 For more information on valid filter types, see Using Filters (on page 269).
 If you are using MDR across site databases, the source filter properties are not available.
Next step:
Model Data Reuse Wizard: Disciplines (on page 282)

Project Management User's Guide 268

 Model Data Reuse (MDR)

Using Filters
When you use the Select By Filter method to select a filter to define source objects, Model
Data Reuse inspects the selected filter and takes appropriate action. Currently, five types of
filters are valid for use with MDR: System, Permission Group (PG), Object Type, Volume, and
Properties.

Simple Filter or Single Tab Filter

When a single filter type defines the filter criteria, the behavior is as follows:

Filter Type Logical Get Related System Destination

Operator Parents Systems

System Expand No Parents of initial

systems

Permission Group (PG), Object Restrict Yes Lowest Common

Type, Volume, Properties Parent (on page 270)

Simple Filter or Multiple Tab Filters

When you use a simple filter defined on the System, Permission Group, Object Type,
Volume or Properties tab, or when you use multiple filter types to define the filter criteria, the
behavior is as follows:

Filters Used Get Related System Destination Systems

Parents

Any combination of System, PG, Object Yes Lowest Common Parent

Type, Volume, Properties (on page 270)

Project Management User's Guide 269

 Model Data Reuse (MDR)

Lowest Common Parent

When you select a Volume, Permission Group, Object Type, or Properties filter from which to
select data to copy, the software searches upward in the hierarchy until it locates the lowest
common parent. This search is conducted at processing time or when the MDR Wizard is
"preparing to copy."
The following illustration shows a simple system hierarchy and the lowest common parent. The
software considers the data selected by filter, and locates the first parent that all have in
common.

 The Lowest Common Parent, in this example Building 1, is not copied as part of the MDR
process.
 In MDR, if a filter that is defined only on the System tab is used, then MDR behaves in the
same way it does when you choose the Source system selection method; that is, the parts
of all source systems selected are mapped to a destination or target system.
See Also
Model Data Reuse Wizard: Source Objects by Filter (on page 267)

Project Management User's Guide 270

 Model Data Reuse (MDR)

Select Filter Dialog Box

Creates, edits, deletes, and selects filters for use with the Define Workspace, Surface Style
Rules, and other Select by Filter commands, including Project Management's Model Data
Reuse (MDR), Drawings View Styles, and Reports commands that require runtime filter
selection. You can access this dialog box in several ways.
 Select File > Define Workspace, and select the More option in the Filter box.
 Select Format > Surface Style Rules, click New or Modify, and then select the More
option in the Filter box.
 Select Tools > Select by Filter.
The tree view displays the following types of filters:
 Catalog Filters - These filters are used to reference data in the Catalog. For example, a
catalog filter could apply to company-wide operations. Your administrator can define
Company_Filter_1, Company_Filter_2, and so forth.
 Model Filters - These filters are available to everyone assigned to a specific model
database. There are delivered catalog filters to query on the different types of model objects.
You must have the appropriate privileges to create, edit, or delete these filters.
 My Filters - These are personal filters that you create and place in the My Filters folder.
They are visible only to you, the owner. You cannot see the personal filters of others, and
they cannot see your personal filters. Select a filter from one of the listed filters, or create a
new filter to meet your specific requirements.
New Folder
Creates a new folder.
New Filter (Simple or Asking)
Displays the New Filter Properties dialog box so that you can create a new filter. Asking
filters allow you to specify the parameters of the search. An asking filter has built-in
functionality to ask for values (with boxes that you are required to supply). The values apply
to properties that you have already designated you will supply when the filter runs. Asking
filters are portable between models.
Model Data Reuse (MDR) does not support asking filters. The only valid filter
types for an MDR transaction are System, Permission Group, Object Type, Volume and
Properties. You can define the filter on any one of these tabs or in a combination using
multiple tabs.

New Compound Filter

Displays the New Compound Filter Properties dialog box, which you use to create a new
compound filter containing the Or, And, or Not operators. Compound filters are not
supported for MDR.
New SQL Filter
Displays the New SQL Filter Properties dialog box, in which you can type the text of an
SQL query. SQL filters are not supported for MDR
Delete
Removes a filter or folder from the Select Filter list. If you delete a folder, the software also

Project Management User's Guide 271

 Model Data Reuse (MDR)

deletes its contents.

Rename
Changes the name of an existing filter or folder from the Select Filter list.
Properties
Displays the Filter Properties dialog box so that you can select the properties that
determine your filter search criteria.

 If this dialog box is activated from the Select by Filter command, you can select multiple
filters on this dialog box. Hold CTRL or SHIFT, and click each filter. When you click OK, all
objects that fit the selected filters are selected.
 If this dialog box is activated from the Select by Filter command, it clears the select set
before adding objects to the select set.

Filter Properties Dialog Box

Builds a filter or displays the properties of an existing filter. You access this dialog box from the
Select Filter dialog box, which is available as follows:
 File > Define Workspace - Filter option, or Properties button, if a filter is selected.
 Tools > Select by Filter.
This dialog box is entitled New Filter Properties or simply Filter Properties, depending on
whether you are creating a new filter or modifying an existing filter. Its behavior is the same.
The dialog box tabs let you pick the appropriate criteria for the filter. For example, the System,
Assembly, or Named Space tabs on the Filter Properties dialog box provide for extensive
searches, while the Properties, Volume, Permission Group, and Object Type tabs assist with
more restrictive searches. The Configuration tab specifies the permission group assignment of
the filter. The Work Breakdown Structure (WBS) tab identifies objects in the selected WBS for
the filter. For example, you can select projects, contracts, or documents from the WBS.
Name
Specifies the name of the object. If a Name Rule is specified, then the software uses that
rule to determine this name. If the Name Rule value is User Defined, then you must type a
name in this box.
Asking Filter - user of filter will supply value
Creates an asking filter. An asking filter prompts you for specific values for certain
properties.
Include nested objects
Specifies whether you want your search to include all objects under a selected node. For
example, when you check this box and then select an object, the software selects all sub-
objects under that object. If you do not check this box, you can select objects separately.
This option is unavailable for certain tabs on this dialog box.
Lock CTRL key
This option changes the selection mode and allows you to select multiple items across filter
tabs without holding down the CTRL key.

Project Management User's Guide 272

 Model Data Reuse (MDR)

Clear All
Removes the object definition. Click Clear All if you want to start over and redefine the
search criteria.

 When the New dialog box displays, the default is always the last-selected option.
 When you double-click a filter on the Select Filter dialog box, the software applies the filter
and dismisses the dialog box.

Topics
System Tab (Filter Properties Dialog Box) .....................................273
Assembly Tab (Filter Properties Dialog Box) .................................274
Named Space Tab (Filter Properties Dialog Box) ..........................275
Analysis Tab (Filter Properties Dialog Box)....................................275
Work Breakdown Structure Tab (Filter Properties Dialog Box) ......276
Permission Group Tab (Filter Properties Dialog Box) ....................276
Object Type Tab (Filter Properties Dialog Box) .............................277
Volume Tab (Filter Properties Dialog Box) .....................................277
Properties Tab (Filter Properties Dialog Box) ................................278
Reference Tab (Filter Properties Dialog Box) ................................279
Reference 3D Tab (Filter Properties Dialog Box) ...........................280
Point Cloud (Filter Properties Dialog Box)......................................280
Configuration Tab ...........................................................................280

System Tab (Filter Properties Dialog Box)

Provides a tree view list of all the available systems you can include in your filter search criteria.
A Model is the highest system in the hierarchy and includes all subsystems. Systems can span
disciplines and include many types of objects.

You can select the Include nested objects option to specify that you want your search criteria
to include all objects within a system. For example, if you select this option, the software selects
all children objects when you select a parent system. If you do not select this option, you select
only the systems. You can also use the CTRL and SHIFT keys to select multiple objects on this
tab.

Project Management User's Guide 273

 Model Data Reuse (MDR)

Nodes with more than 1,000 children display in bold type rather than auto-expanding if some of
their children are selected in the filter properties. The selected child nodes highlight when you
expand the parent node.

Assembly Tab (Filter Properties Dialog Box)

Provides a tree view list of all the available assemblies you can include in your filter search
criteria.

You can select the Include nested objects option to specify that you want your search criteria
to include all objects within a category. For example, if you select this option, the software
selects all objects when you select a category. If you do not select this option, you select the
assembly objects separately. You can also use the CTRL and SHIFT keys to select multiple
objects on this tab.
The Include nested assemblies only option includes all nested assemblies, assembly blocks,
blocks, spools, and penetration spools under the selected assemblies, but not the parts.

 The Include nested assemblies only option explicitly includes the assemblies and
assembly parents that you are working on so that the Refresh Workspace command
updates the assembly information without including all of the parts nested under the selected
assemblies, such as plate parts, that are not of interest.
 You can only select one of the Include nested objects and Include nested assemblies
only options. You can clear both options.

Project Management User's Guide 274

 Model Data Reuse (MDR)

Named Space Tab (Filter Properties Dialog Box)

Provides a list of all the named spaces and drawing volumes you can include in your search.

Named spaces are regions in the model, like fire or blast zones. Filtering on named spaces is
useful particularly when you work in the Space Management task and need to see the size,
shape, and position of the named spaces that already exist. Drawing volumes are used in the
Drawings and Reports task in the drawing creation process.
You can select the Include nested objects option to specify that you want your search criteria
to include all objects within a category. For example, if you select this option, the software
selects all objects when you select a category. If you do not select this option, you select the
category and individual objects separately. You can also use the CTRL and SHIFT keys to
select multiple objects on this tab.

Analysis Tab (Filter Properties Dialog Box)

Provides a list of all the structural analysis models you can include in your search.

Analysis models are associated with the Structural Analysis task in the software. An analysis
model is a non-graphical and logical grouping of member systems that can be sent to a third-
party analysis and design solver package.
You can select the Include nested objects option to specify that you want your search criteria
to include all objects within a category. For example, if you select this option, the software
selects all objects when you select a category. If you do not select this option, you select the
category and individual objects separately. You can also use the CTRL and SHIFT keys to
select multiple objects on this tab.

Project Management User's Guide 275

 Model Data Reuse (MDR)

Work Breakdown Structure Tab (Filter Properties Dialog Box)

Browses a tree view of the model work breakdown structure to include WBS entities only if the
Work Breakdown Structure tab is used, or restrict the filters to objects assigned to the
selected WBS, if other tabs are used.

A simple filter shows only objects assigned to the selected WBS items and the WBS
items themselves. To see WBS objects on the Workspace Explorer tab, you must create a
compound filter. If you define a filter that contains only one WBS project, this filter returns the
WBS project selected on the WBS tab of the Workspace Explorer and any objects assigned to
that particular WBS project on the Systems tab in the Workspace Explorer. To see all WBS
objects on the WBS tab in the Workspace Explorer, you must create a compound filter. For
example, you might create a filter that contains All Systems or WBS Objects. This filter would
return all objects on the Systems tab and all WBS objects.
The WBS is the breakdown of the Model by the construction work to be performed. The
breakdown can consist of the Model at the top level, as well as projects, contracts, and
documents. You can modify a property for an object to associate it to a project. You can
associate published documents to a contract and then reassign the document from one contract
to another. Objects are associated to a document.
You can select the Include nested objects option to specify that you want your search criteria
to include all objects within a category. For example, if you select this option, the software
selects all objects when you select a category. If you do not select this option, you select the
category and individual objects separately. You can also use the CTRL and SHIFT keys to
select multiple objects on this tab.

Permission Group Tab (Filter Properties Dialog Box)

Displays a tree view list of all the permission groups that you can select for your search. The
filter selects objects that belong to the groups that you highlight. If you do not highlight any
groups, the filter includes all groups in the list.

You can add permission groups in the Project Management task.

Project Management User's Guide 276

 Model Data Reuse (MDR)

Object Type Tab (Filter Properties Dialog Box)

Provides options for you to select specific object types to restrict your filter. The objects are
organized by discipline.

This tab provides a list of all the major object types you can include in your search. The filter
selects the objects you highlight. If you do not select any objects, the filter includes all objects in
the list. To include one or more object types in your filter, press CTRL and click the name of
each object type that you want to include.

Volume Tab (Filter Properties Dialog Box)

This tab restricts filter selection to objects within the selected volume and provides two options
for defining the volume search method: Named spaces or Planes. The tree view displays the
Named Spaces hierarchy or the coordinate system hierarchy depending on the option that you
select.

Project Management User's Guide 277

 Model Data Reuse (MDR)

Define by
Named spaces
Displays a tree view of the space hierarchy from which you can choose one or more spaces
to include in your search. This option is useful for filtering all objects located within specific
spaces. In addition to selecting all the objects inside the specified named spaces, the
software retrieves the space itself. You do not need to select the object on the Named
Space tab as well. To select a particular named space, press CTRL and click as many
spaces as you want to include in your search. If you do not select any named spaces, the
filter includes all objects in all named spaces.
Planes
Displays a tree view of the reference coordinate system hierarchy in the window, and a
group of first and second position coordinate boxes at the bottom. The coordinate system
hierarchy is a list of predefined coordinate systems for the model, each having a different
origin point. For example, one coordinate system might have an origin point at the corner of
a boiler room, another at the center of the building, and so forth.
When you select one of these coordinate systems, the software displays a list of coordinate
planes for that system. By selecting a plane and specifying the first and second positions
along that plane, your filter selects all objects that fall between the two positions on that
plane. The positions automatically appear in the first and second position boxes at the
bottom of the dialog box. This option is useful when you want to select objects that are all on
a specific level or plane. You can hold CTRL to select the first and second positions in the
tree view.
Coordinate system
Specifies a coordinate system. You can define coordinate systems in the Grids task.
1st Position (N, E, EL) or (Y, X, n)
Displays the names of the planes that you select to define the first position of the volume.
2nd Position (N, E, EL) or (Y, X, n)
Displays the names of the planes that you select to define the second position of the
volume.

Properties Tab (Filter Properties Dialog Box)

Provides options for selecting object properties that you can use to restrict your search.

Filter Method
You can combine multiple properties on individual rows.

Project Management User's Guide 278

 Model Data Reuse (MDR)

Match All
Returns only those objects matching all of the properties listed in the grid. This method is
the same as using the Boolean operator AND.
Match Any
Returns objects matching any property listed in the grid. This method is the same as using
the Boolean operator OR.
Property
Lists the properties of objects in the data model in the Select Properties dialog box. To
select properties and set their data type, select More in the field drop-down.
Operator
Select an operator such as <> (not equal) or = (equal).
If you use a wildcard character (*), you must use the Contains comparison
operator. For example, pumps P-1000A and P-1000B exist in the model. To query for the
pumps using properties, select Match All and type Name Contains P*.
Value
Specifies the value of the property.
Ask
Creates an Asking Filter that allows you to specify a value for the property when you run
the filter. The Ask column is so named because the software asks or prompts you to type a
value. An administrator or other user with the required permissions establishes the asking
filter and defines a default value. While defining a workspace, you can type a different value
for the property. This is not a valid option for Model Data Reuse.
Remove
Removes the selected property from the grid.

Reference Tab (Filter Properties Dialog Box)

Provides a tree view list of the available reference files you can include in your search.

You can also use the CTRL and SHIFT keys to select multiple objects on this tab.

 To view this tab, you must first insert a file using the Insert > File command.
 When you copy a filter that contains Reference tab information into the Catalog or into a
different Model database, the software removes the Reference tab information. Because of
this, you cannot create a compound filter that uses Reference tab information. Filters that
use Reference tab information are hidden from the tree view on the Compound Filter
dialog box. The compound filter ignores any Reference tab information.

Project Management User's Guide 279

 Model Data Reuse (MDR)

Reference 3D Tab (Filter Properties Dialog Box)

Provides a list of all the Reference 3D models you can include in your search.

You can also use the CTRL and SHIFT keys to select multiple objects on this tab.
When you copy a filter that contains Reference 3D tab information into the Catalog or
into a different Model database, the software removes the Reference 3D tab information.

Point Cloud (Filter Properties Dialog Box)

Provides a list of all the registered point cloud vendors. You can reference only one point cloud
object in your search. You cannot select the parent node to filter the search.

To select point cloud objects for filters, you must install the point cloud vendor
software and associate a point cloud model reference with the Model in the Smart 3D Project
Management task.

Configuration Tab
Displays the creation, modification, and status information about an object.
You cannot define the filters using the Configuration tab.
Plant
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the object belongs. You can select another
permission group, if needed. Permission groups are created in Project Management.

Project Management User's Guide 280

 Model Data Reuse (MDR)

Transfer
Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group. This option is only available if the active model or
project is replicated in a workshare configuration. The option is not available if all of the
objects in the select set already belong to another location and are non-transferable. For
more information, see Transfer Ownership Dialog Box in the Common User's Guide.
The Transfer option does not apply to the filters and surface style rules.
Approval State
Specifies the current status of the selected object or filter. The display depends on your
access level. You might be unable to change the status of the object. The list is defined by
the ApprovalStatus codelist.
You can only edit or manipulate an object with a status of Working.
Status
Specifies the location of the object in the workflow process. Changing this property sets the
Approval State. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file. For more information, see
ApprovalReason in the Reference Data Guide.
Date Created
Specifies the creation date of the object.
Created by
Specifies the name of the person who created the object.
Date Last Modified
Specifies the date when the object was last modified.
Last Modified by
Specifies the name of the person who last modified the object.

Project Management User's Guide 281

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Disciplines

Allows you to make additional choices that affect the source objects to copy.

All disciplines
Copies all object types within the source data selection, or selections.
Select disciplines
Copies only the object types that belong to the selected disciplines within the source data
selection, or selections.
Copy related assemblies
Copies all assemblies related to the objects to copy. The parents of those assemblies, up to
the Lowest Common Parent in the assembly hierarchy, are also included in the copy
process. By default, this options is not selected; however, when this option is selected, you
can define the destination for the copied assemblies by selecting the destination assembly
parent on the Destination page. If the objects to copy belong to multiple Blocks, those
Blocks are also included in the copy process. However, when a Block is copied, it loses its
geometry and it is transformed into an ordinary Assembly.
Copy structural manufacturing objects
Copies structural manufacturing objects related to the portion of the model that you want to
copy. This option is only available when Copy related assemblies is selected.
Copy related WBS

Project Management User's Guide 282

 Model Data Reuse (MDR)

Copies the Work Breakdown Structure (WBS) items related to the objects to copy. By
default, this copy option is not checked. When you check this option, you can define the
destination WBS parent for the copied objects on the Work Breakdown Structure tab of
the Destination page. If the objects to copy belong to multiple WBS Projects, those Projects
are also included in the copy process. However, when a Project is copied, it loses its identity
and it is transformed into a WBS item.
Copy volumes in range
Copies the volumes that contain or intersect the other objects being copied and to maintain
the hierarchical structure of the space hierarchy. By default, this copy option is not selected.
When you select this option, you can define the destination space parent for the copied
objects on the Space tab of the Destination page.
Some types of filters work better than others when Source object by filter and
Copy related assemblies are selected. For example, a system filter, a volume filter, or a
permission group filter usually works well for this purpose. An object type filter or a property
filter that does not return parts does not work for this purpose because the command finds
the related assemblies by starting with the source objects returned by the filter. If the objects
returned by the filter are not members of assemblies, then no assemblies are copied. The
members of an assembly are always parts. Therefore, to get good results, the filter should
return parts. For example, if an object type filter with pipe runs only is defined, the pipe runs
are copied correctly, but the associated assemblies are not copied; therefore, you must
include the pipe parts in the object type filter to copy the assemblies.
Copy composed drawings
Copies the composed drawings that depict one or more of the model objects being copied,
and maintains the hierarchical structure of the drawings hierarchy. Copy composed
drawings also copies the supporting volumes (including areas, zones, interference
volumes, and drawings volumes), and maintains the hierarchical structure of the space
hierarchy. When you select this option, you can define the destination space parent for the
copied objects on the Space tab of the Destination page, and the destination drawing
folder parent for the copied drawings on the Drawings tab of the Destination page.
Next step:
Model Data Reuse Wizard: Destination Model (on page 284)

Project Management User's Guide 283

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Destination Model

Specifies the destination model to copy to.
The current destination model displays as the default. You can change the model by clicking
Select Model and locating the appropriate model in the Select Destination Model dialog box
list. For more information, see Select Destination Model Dialog Box (on page 284). The
destination model can only be selected from the active site.

Next step:
Model Data Reuse Wizard: Destination (on page 285)

Select Destination Model Dialog Box

Controls parameters for selecting the destination model.
Models
Specifies the selected model. The list displays all models in the active site. If the file name is
too long to display entirely, you can hover the cursor over the box to display the complete
file name.

Project Management User's Guide 284

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Destination

Selects Destination System Parents, Destination Assembly Parents, the WBS Parent, the Space
Parent, Drawings, and Permission Groups. Click the System tab, Assembly tab, Work
Breakdown Structure tab, Space tab, Drawings tab, or Map button, respectively, to make
selections. To select a different default permission group, click the arrow in the Default
permission group box.

 If you are copying within a single model, the Source System Parent is assigned to the
Destination System Parent by default. You can assign new destination systems for the
copied data by clicking next to the destination name and then clicking . For more
information, see Model Data Reuse Wizard: Add the Destination System Parent (on page
296).
 If you are copying across models, the Destination System Parent list is blank by default.
You must browse and manually assign destination systems. You can assign new destination
systems for the copied data by clicking next to the destination name and then clicking .
For more information, see Model Data Reuse Wizard: Add the Destination System Parent
(on page 296).
 If the source systems have a single parent system, map that parent system to a single
destination model.
 If all source systems have a single parent system, then select a single destination system. If
multiple source systems with multiple parent systems are selected, then you also must
select multiple destination systems, corresponding with the systems selected for the source
data.
 If multiple source systems with multiple parent systems are selected, map them to
corresponding destination models. In other words, if you have multiple source parents, you
also have multiple destination parents.
 If the Copy related WBS option is active, you must select a destination WBS parent. For
more information, see Model Data Reuse Wizard: Work Breakdown Structure Tab (on page
290).
 If the Copy related assemblies option is active, you must select a destination assembly.
For more information, see Model Data Reuse Wizard: Assembly Tab (on page 288).
 If the Copy volumes in range option is active, you must select a destination space parent.
For more information, see Model Data Reuse Wizard: Space Tab (on page 292).
 If the Copy composed drawings option is active, you must select both a destination space
parent and a destination drawings parent. For more information, see Model Data Reuse
Wizard: Space Tab (on page 292) and Model Data Reuse Wizard: Drawings Tab (on page
294).
 You may select different permission group(s) to which the copied objects are assigned by
clicking the Permission group list and selecting a new Permission group, if available. For
more information, see Model Data Reuse Wizard: Use the Permission Group Map (on page
298).
See Also
Model Data Reuse Wizard: System Tab (on page 286)
Model Data reuse Wizard: Assembly Tab (on page 288)
Model Data Reuse Wizard: Work Breakdown Structure Tab (on page 290)

Project Management User's Guide 285

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Space Tab (on page 292)

Model Data Reuse Wizard: Drawings Tab (on page 294)
Model Data Reuse Wizard: Use the Permission Group Map (on page 298)

Model Data Reuse Wizard: System Tab

Defines the destination system parents for the objects copied from the source system that you
previously selected.
Source System Parent
Shows the parent of each copied system.
Destination System Parent
Shows the destination parent for the system to be copied to.

See Also
Model Data Reuse Wizard: Select Destination System Dialog Box (on page 287)
Model Data Reuse Wizard: Add the Destination System Parent (on page 296)

Project Management User's Guide 286

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Select Destination System Dialog

Box
Displays the destination systems available for selection. Click to expand the options.

See Also
Model Data Reuse Wizard: System Tab (on page 286)

Project Management User's Guide 287

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Assembly Tab

Defines the destination assembly parents for the objects copied from the source assembly. This
tab is only available if you selected Copy related assemblies on the Disciplines page.
Source Assembly Parent
Displays Lowest Common Parent (TBD). The actual lowest common parent of the source
assembly is determined during the MDR process.
Destination Assembly Parent
Shows the destination assembly parent. No default destination assembly parent is
automatically set. You must select the parent by clicking this column, and then clicking the
browse button .

See Also
Model Data Reuse Wizard: Select Destination Assembly Dialog Box (on page 289)
Model Data Reuse Wizard: Add the Destination Assembly Parent (on page 297)

Project Management User's Guide 288

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Select Destination Assembly Dialog

Box
Displays the assembly parents available for selection. Click to expand the options.

See Also
Model Data Reuse Wizard: Assembly Tab (on page 288)

Project Management User's Guide 289

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Work Breakdown Structure Tab

Defines the destination WBS parent for the copied objects. This tab is available only if you have
selected the Copy related WBS option on the Disciplines page.
Source WBS Parent
Displays Lowest Common Parent (TBD). The actual lowest common parent of the source
WBS is determined during the MDR process.
Destination WBS Parent
Shows the destination WBS parent. To select the destination WBS parent, click this column,
and then click the browse button to display the Select Destination WBS dialog box.

See Also
Model Data Reuse Wizard: Disciplines (on page 282)
Model Data Reuse Wizard: Select Destination WBS Dialog Box (on page 291)

Project Management User's Guide 290

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Select Destination WBS Dialog Box

Displays the WBS tree view from the destination model for selection. Click to expand the
options.
The only types of objects that can serve as the destination WBS parent are WBS
Project and WBS Item.

See Also
Model Data Reuse Wizard: Work Breakdown Structure Tab (on page 290)

Project Management User's Guide 291

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Space Tab

Defines the destination space parent for the copied volumes. This tab is available only if you
have selected the Copy volumes in range option or the Copy composed drawings option on
the Disciplines page.
Source Space Parent
Displays Lowest Common Parent (TBD). The actual lowest common parent of the source
space is determined during the MDR process.
Destination Space Parent
Shows the destination space parent. No default destination space parent is automatically
set. You must select the parent by clicking this column and then clicking the browse button
.

See Also
Model Data Reuse Wizard: Disciplines (on page 282)
Model Data Reuse Wizard: Select Destination Space Folder Dialog Box (on page 293)
Model Data Reuse Wizard: Add the Destination Space Parent (on page 297)

Project Management User's Guide 292

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Select Destination Space Folder

Dialog Box
Displays the Space Hierarchy tree view from the destination model for selection. Click to
expand the options.

See Also
Model Data Reuse Wizard: Space Tab (on page 292)

Project Management User's Guide 293

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Drawings Tab

Defines the destination drawings parent for the copied drawings. This tab is available only if you
have selected the Copy composed drawings option on the Disciplines page.
Source Drawing Parent
Displays Lowest Common Parent (TBD). The actual lowest common parent of the source
drawing is determined during the MDR process.
Destination Drawing Parent
Shows the destination drawing parent. No default destination drawing parent is
automatically set. You must select the parent by clicking this column, and then clicking the
browse button .

See Also
Model Data Reuse Wizard: Disciplines (on page 282)
Model Data Reuse Wizard: Select Destination Drawings Dialog Box (on page 295)
Model Data Reuse Wizard: Add the Destination Drawing Parent (on page 297)

Project Management User's Guide 294

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Select Destination Drawings Dialog

Box
Displays the Drawings Hierarchy tree view from the destination model for selection. Click to
expand the options.

See Also
Model Data Reuse Wizard: Drawings Tab (on page 294)

Model Data Reuse Wizard: Permission Group Dialog Box

Defines the Destination Permission Group for the copied objects. You can keep the original
permission group assignments, or you can select alternative groups. Click Map on the
Destination page to open this dialog box.
Use Default
Replaces every Destination Permission Group selection with the selection made in the
Default permission group box on the Destination page.
Keep Originals
Replaces every Destination Permission Group with the matching Source Permission
Group, if available.
Source Permission Group
Lists the available source permission groups.
Destination Permission Group
Specifies the destination permission group. Click to display a list from which you can select

Project Management User's Guide 295

 Model Data Reuse (MDR)

a different destination permission group.

See Also
Model Data Reuse Wizard: Use the Permission Group Map (on page 298)

Model Data Reuse Wizard: Add the Destination System

Parent
1. Under Destination System Parent on the System tab, click beside the destination system
parent name, and then click .
2. From the System list on the Select Destination System dialog box, select a new
destination system.
3. Click OK.
The new name appears in the Destination System Parent list adjacent to the
corresponding Source System Parent.
4. Click Next to continue.
You can select different permission group(s) to which the copied objects are assigned
by clicking the Permission group list and selecting a new Permission group, if available.

Project Management User's Guide 296

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Add the Destination Assembly

Parent
1. Under Destination Assembly Parent on the Assembly tab, click beside the destination
assembly parent name, and then click .
2. From the list on the Select Assembly Parent dialog box, select a new assembly parent.
3. Click OK.
The new name appears in the Destination Assembly Parent list adjacent to the
corresponding Source Assembly Parent.
4. Click Next to continue.

 Valid Object Types – In general, Model, Block, AssemblyBlock, or Assembly can serve as
the destination assembly parent.
 Invalid Object Types – The following object types are displayed in the assembly tree view,
but are not valid selections for the destination assembly parent: Penetration Spool, Spool,
and Part.
 You can select different permission group(s) to which the copied objects are assigned by
clicking the Permission group list and selecting a new Permission group, if available.

Model Data Reuse Wizard: Add the Destination Space Parent

1. On the Space tab, click the Destination Space Parent beside the source space parent
name, and then click .
2. On the Select Destination Space Folder dialog box, select a new destination space parent
from the Space Hierarchy list.
3. Click OK.
The new name appears in the Destination Space Parent list adjacent to the corresponding
Source Space Parent.
4. Click Next to continue.

Model Data Reuse Wizard: Add the Destination Drawing

Parent
1. On the Drawings tab, click the Destination Drawings Parent box beside the source
drawing parent name, and then click .
2. On the Select Destination Drawings Folder dialog box, select a new destination drawing
parent from the Drawings Hierarchy list.
3. Click OK.
The new name appears in the Destination Drawing Parent list adjacent to the
corresponding Source Drawing Parent.

Project Management User's Guide 297

 Model Data Reuse (MDR)

4. Click Next to continue.

Model Data Reuse Wizard: Use the Permission Group Map

1. Click Map on the Destination page.
2. Select Use Default to replace every Destination Permission Group with the selection
made in the Permission group list on the Destination Systems page of the wizard (the
default).
-OR-
Select Keep Originals to replace every Destination Permission Group with the matching
Source Permission Group, if available.
Keeping the original permission groups when copying to a different model is only
possible when the permission group names in the destination model match exactly. If the
original permission group cannot be found, the default permission group is used.
-OR-
Manually select a Permission group in the list for each Destination Permission Group.
3. Click OK.

 You must have write access (or higher) in order to change the Destination Permission
Group options.
 Only permission groups for which you have write access (or higher) are displayed in the
Destination Permission Group options lists.
 If you do not have sufficient privileges to change the permission group, the default
permission group is used.
Next Step:
Model Data Reuse Wizard: Transformations (on page 299)

Project Management User's Guide 298

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Transformations

Controls how copied design objects are transformed. These design objects can be transformed
using Move, Rotate, Mirror, and Transform options. Only one of the transformation options
can be used at a time.
If the Copy composed drawings option is active, only the None and Move by
relative distance options are available.

None
Select None if you have no transformations and then click Next to proceed to the next
wizard page.
This option is only available when copying across two different models. It is
similar to the Paste in place option for common Copy/Paste procedures.
Move by Relative Distance
Specifies east, north, and up distances from the source object location.
1. Click Move by Relative Distance.
2. Select the units of measurement from the Units list, and then type a value for the distance in
each direction.

Project Management User's Guide 299

 Model Data Reuse (MDR)

3. Click Next to go to the Confirmation page.

Data is always moved with respect to the Global coordinate system. If the area you
are moving was modeled with respect to a rotated coordinate system, the results of the move
may not be as expected. This is because the software calculates the move based on the
orientation of the Global coordinate system, which is zero (0) degrees.
Rotate
Rotates the copied system about a vertical axis. Type the name of an existing coordinate
system and an angle of rotation.
1. Click Rotate.
2. In the Axis coordinate system box, click More .
3. In the Select Coordinate System dialog box, select an existing coordinate system, and
then click OK.
4. In the Angle of rotation (deg) box, type the angle by which the system rotates.
5. Click Next to go to the Confirmation page.

 The Z-axis of the coordinate system is used as the axis of rotation.

 It is recommended that the Z-axis of the coordinate system is vertical.
 If you are copying data between models, the Axis coordinate system must be selected
from the source model.
Mirror
Reflects the copied system about a vertical plane.
1. Click Mirror.
2. In the Plane coordinate system box, click More .
3. In the Select Coordinate System dialog box, select an existing coordinate system, and
then click OK.
4. In the Mirror plane list, select the horizontal axis defining the vertical plane by which to
mirror the system, either East-West, or North-South.
5. Click Next to go to the Confirmation page.

 The ZX plane or the ZY plane is used as the plane of reflection.

 It is recommended that the orientation of the Z-axis is vertical for the Plane coordinate
system.
 If you are copying data between models, the Plane coordinate system must be selected
from the source model.
Transform by coordinate system
Transforms the copied objects from the originating coordinate system to the destination
coordinate system; that is, the software honors the orientation of the target coordinate
system. This action may result in a move and/or rotation of the copied objects.
1. Click Transform by coordinate system.

Project Management User's Guide 300

 Model Data Reuse (MDR)

2. In the From coordinate system box, click More .

3. In the Select Coordinate System dialog box, select the originating coordinate system that
you want to move the system from, and then click OK.
4. In the To coordinate system box, click More .
5. In the Select Destination System dialog box, select the destination coordinate system that
you want to move the system to, and then click OK.
6. Click Next to go to the Confirmation page.
In the following illustration, the original objects are aligned with the "From" coordinate system.
The copied objects are moved and rotated to align with the "To" coordinate system.

Next step:
Model Data Reuse Wizard: Compare Catalogs (on page 302)
Model Data Reuse Wizard: Confirmation (on page 307)

Troubleshooting Results of MDR Transformation

If objects fail or do not paste in the correct location after a Model Data Reuse Transformation,
follow the steps below to troubleshoot the issue:
1. Check Database Integrity Reports.
2. Check the To Do List in both the source and the target models. This may point you in the
correct direction. For example, missing catalog data or missing symbols are reported in the
To Do List.
3. Attempt to copy/paste/mirror/rotate the object(s) using the common copy/paste/mirror/rotate
commands. See if this produces any To Do List entries or errors.
4. Use the Review MDR Results custom command to find particular objects quickly. This
command produces a report in Microsoft® Excel format that you can use to help with
debugging the results of the MDR operation.

Project Management User's Guide 301

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Compare Catalogs

Compare the source catalog and the destination catalog. Compare Catalogs is used only if you
copy across models with different source and destination catalogs. If the source and destination
catalogs are identical, this step is skipped.
Compare
Compares the source catalog items to the corresponding items in the destination catalog.
View & Map
Opens the View & Map dialog box, which displays the results from the catalog comparison.
You can map the missing items for pipe spec elements, code lists, and option codes. For
more information, see View & Map Dialog Box (on page 302).
Pipe spec and short code mapping will be used
Determines whether or not to use the mapping file to map items.
Next step:
Model Data Reuse Wizard: Confirmation (on page 307)

View & Map Dialog Box

Displays the results of the comparison between source catalog items and destination catalog
items. The results are categorized into four groups: pipe spec elements, short code elements,
option code values, and schema elements.
Only show items used by current operation
Displays only the short codes and option codes that are used in the copy set.
Report
Generates an Excel report containing the errors and warnings that the software found during
the comparison. The report file contains the pipe specs, short codes, and option codes
mapping results, and the catalog schema comparison result.
See Also
Pipe Specs Tab (View & Map Dialog Box) (on page 303)
Short Codes Tab (View & Tab Dialog Box) (on page 303)
Option Codes Tab (View & Tab Dialog Box) (on page 304)
Schema Tab (View & Tab Dialog Box) (on page 305)

Project Management User's Guide 302

 Model Data Reuse (MDR)

Pipe Specs Tab (View & Map Dialog Box)

Displays the comparison results of the pipe spec elements.
Count at time of comparison
Displays the number of model objects to be copied that reference the pipe specification.
Source Pipe Spec
Displays the name of the pipe specification in the source catalog.
Destination Pipe Spec
Displays the name of the pipe specification in the destination catalog. If the Status is
Different, Missing, or Mapped, click the Destination Pipe Spec cell to select a new
destination pipe specification.
Status
Displays the status of the comparison. The status of a comparison can be:
 Found - The name and related data of a pipe specification in the source catalog is
matched to a pipe specification in the destination catalog.
 Different - The name of a pipe specification in the source catalog is matched to a pipe
specification in the destination catalog, but the data of the two pipe specifications are
different. Click the ellipses to display the differences between the two pipe
specifications.
 Missing - The name of a pipe specification in the source catalog was not matched to a
pipe specification in the destination catalog. The missing pipe specification can be
bulkloaded into the destination catalog or mapped to an existing pipe specification.
 Mapped - The source pipe specification is mapped to a different pipe specification in the
destination catalog. Click the ellipses to display the differences between the two pipe
specifications.

Short Codes Tab (View & Tab Dialog Box)

Displays the short code information necessary to map missing short codes in the destination
model. The tree view displays the hierarchy of short code classes and types.
Short Code Class
Displays the short code classes, based on the selection in the tree hierarchy.
Short Codes Used in Copy Set
Displays the mapping status for the short code class.
The following columns display when you select the lowest-level short code in the tree hierarchy:
Count at time of comparison
Displays the number of model short codes to be copied that reference the short code.
Source Short Codes
Displays the name of the short code in the source catalog.
Destination Short Codes

Project Management User's Guide 303

 Model Data Reuse (MDR)

Displays the name of the short code in the destination catalog. If the Status is Different,
Missing, or Mapped, click the Destination Options cell to select a new destination short
code.
Status
Displays the status of the comparison. The status of a comparison can be:
 Found - The name and related data of a short code in the source catalog is matched to
a short code in the destination catalog.
 Missing - The name of a short code in the source catalog was not matched to a short
code in the destination catalog. The missing short code can be bulkloaded into the
destination catalog or mapped to an existing short code.
 Mapped - The source short code is mapped to a different short code in the destination
catalog. Click the ellipses to display the differences between the two short codes.

Option Codes Tab (View & Tab Dialog Box)

Displays the option information necessary to map missing code list values in the destination
model. The tree view displays the hierarchy of code list classes and options.
Category Options
Displays the code list option classes, depending on the selection in the tree hierarchy.
Option Codes Used in Copy Set
Displays the mapping status for the code list option class.
The following columns display when you select the lowest-level code list option in the tree
hierarchy:
Count at time of comparison
Displays the number of model code list options to be copied that reference the code list
option.
Source Options
Displays the name of the code list option in the source catalog.
Destination Options
Displays the name of the code list option in the destination catalog. If the Status is
Different, Missing, or Mapped, click the Destination Options cell to select a new
destination code list option.
Status
Displays the status of the comparison. The status of a comparison can be:
 Found - The name and related data of a code list option in the source catalog is
matched to a code list option in the destination catalog.
 Missing - The name of a code list option in the source catalog was not matched to a
code list option in the destination catalog. The missing code list option can be
bulkloaded into the destination catalog or mapped to an existing code list option.

Project Management User's Guide 304

 Model Data Reuse (MDR)

 Mapped - The source code list option is mapped to a different code list option in the
destination catalog. Click the ellipses to display the differences between the two code
list options.

Schema Tab (View & Tab Dialog Box)

Displays the comparison results of the schema elements.
Packages compared
Displays the compared packages.
Warnings
Displays the warnings that the software found during the comparison. To view the schema
elements that generated a warning, right-click the warning, and then click Find.
Errors
Displays the list of errors that the software found during the comparison. To view the
schema elements that generated an error, right-click the error, and then click Find.

Model Data Reuse Wizard: Restart Existing Operation

Selects the operation to be restarted.
Upon creation, a Model Data Reuse operation is saved as an object in the database.
You must have write access to the permission group of the operation object in order to restart an
existing operation.
Model
Displays the name of the destination model.
Select Model
Allows you to select a different destination model.
Operations
Displays the existing operations in the selected destination model. You can click the column
headers to sort the table. Click a row to select an operation.
Name
Displays the name of each existing operation for the selected destination model.
Status
Displays the status of each existing operation. The status of an operation can be:
 Complete: The operation has completed successfully. The Next button is disabled for
operations in Complete status.
 In Progress: The operation is running on a different client. The Next button is disabled
for operations in In Progress status.
 Incomplete: The operation was terminated due to a hardware or software failure on
either the server or the client. You can click the row of an operation in Incomplete
status and then click Next to resume the operation.

Project Management User's Guide 305

 Model Data Reuse (MDR)

 Stopped: The operation was stopped manually by clicking Stop on the progress bar.
You can click the row of an operation in Stopped status and then click Next to resume
the operation.
Properties
Opens the Operation Properties dialog box where you can view the general operation
information, operation status, and operation statistics for the selected operation. For more
information, see Model Data Reuse Wizard: Operation Properties Dialog Box (on page 308).
Delete
Deletes the selected operation.

Next step:
Model Data Reuse Wizard: Confirmation (on page 307)

Project Management User's Guide 306

 Model Data Reuse (MDR)

Model Data Reuse Wizard: Confirmation

Previous releases of the software required you to manage the GUID tabs on
bulkload workbooks in order to copy data across models that used different catalogs. This
ensured that identical definitions had the same GUIDs. In this release, the Model Data Reuse
command automatically manages the GUIDs. You can now copy data across models without
manually ensuring that the GUIDs in the source and destination catalogs match.
Click Copy to start the process.

A progress bar appears on the Model Data Reuse processing dialog box.

In the Model Data Reuse processing dialog box, the status of the copy operation is updated
and appears in the progress bar. The term design object refers to a top-level application object
such as Area System, Unit System, Equipment, Pipeline, Pipe Run, Column, Beam, Slab, and
so on. The Copying objects page reports the status of the following items:
 Total number of design objects to be copied
 Design objects copied successfully
 Design objects failed to copy
 Estimated time remaining
The undo command (CTRL + Z) does not work after this operation starts.
You can stop the operation during processing by clicking Stop in the Model Data Reuse
processing dialog box. You can resume or delete the operation using the Model Data Reuse
wizard Restart Existing Operation option.

Project Management User's Guide 307

 Model Data Reuse (MDR)

When the processing is complete or when you click Stop to pause the operation, the Operation
Properties dialog box is then displayed showing the general operation information, operation
status, and operation statistics for this operation.
See Also
Model Data Reuse Wizard: Operation Properties Dialog Box (on page 308)
Model Data Reuse Wizard: Restart Existing Operation (on page 305)

Model Data Reuse Wizard: Operation Properties

Dialog Box
Displays the general operation information, the operation status, and the operation statistics for
a Model Data Reuse operation. The operation is saved as an object in the database.
See Also
General Tab (Operation Properties Dialog Box) (on page 308)
By Class Tab (Operation Properties Dialog Box) (on page 309)
Configuration Tab (Operation Properties Dialog Box) (on page 309)

General Tab (Operation Properties Dialog Box)

Displays the general operation information, the operation status, and the summary operation
statistics for the Model Data Reuse operation.
Name
Specifies the name of the operation.
Except for operations in In Progress status, you can change the operation name.
Source Model
Displays the source model of the operation.
Destination Model
Displays the destination model of the operation.
Operation Status
Displays the status of the operation.
Design Objects
Displays the total number of design objects that should be copied in the operation.
Succeeded
Displays the number of design objects that have been successfully copied to the destination
model.
Failed
Displays the number of design objects that have failed to be copied to the destination model.
Remaining
Displays the number of design objects that are waiting to be copied to the destination model.

Project Management User's Guide 308

 Model Data Reuse (MDR)

Processing Time
Displays the length of time the operation has taken.
Number of Restarts
Displays the number of restarts that have been attempted for the operation.
See Also
Model Data Reuse Wizard: Operation Properties Dialog Box (on page 308)

By Class Tab (Operation Properties Dialog Box)

Displays the operation statics broken down by object class.
Class
Displays each object class in the operation.
Design Objects
Displays the total number of design objects in an object class.
Succeeded
Displays the number of design objects in an object class that have successfully been copied
to the destination model.
Failed
Displays the number of design objects in an object class that have failed to be copied to the
destination model.
Remaining
Displays the number of design objects in an object class that are waiting to be copied to the
destination model.
See Also
Model Data Reuse Wizard: Operation Properties Dialog Box (on page 308)

Configuration Tab (Operation Properties Dialog Box)

Displays the permission group, creation, and modification for a Model Data Reuse operation
object.
Model
Displays the name of the destination model where the operation object is saved.
Permission group
Specifies the permission group assigned to the operation object. Only users who have write
access to the permission group can restart an operation. You can select another permission
group if needed.
For operations in In Progress status, you cannot change the permission group.
Transfer
Reassigns ownership of the operation object from its current permission group to another
satellite or host permission group. This option is only available if the active model or project
is replicated in a workshare configuration. The option is not available if all of the objects in

Project Management User's Guide 309

 Model Data Reuse (MDR)

the select set already belong to another location and are nontransferable. For more
information, see Transfer Ownership Dialog Box in the Common User's Guide.
Date Created
Displays the date and time the operation was created.
Created by
Displays the user name of the person who created the operation.
Date Last Modified
Displays the date and time the operation was modified last.
Last Modified by
Displays the user name of the person who modified the operation last.
See Also
Model Data Reuse Wizard: Operation Properties Dialog Box (on page 308)

Review Model Data Reuse Operation Results

You can review the operation results from the Operation Properties dialog box that is displayed
after the processing finishes. The dialog box shows the final status of the operation, including
the total number of objects copied, how many objects copied successfully, and how many
objects failed to copy. Results by class are displayed in a dialog box tab.
In addition to viewing the Operation Properties dialog box, you can use the Review
MDR Results dialog box to review details of the MDR operation in the Smart 3D graphical
environment. Click Tools > Utilities > Review MDR Results. For more information, see Review
MDR Results Command in the Common User's Guide.
See Also
Model Data Reuse Wizard: Operation Properties Dialog Box (on page 308)
View the MDR Log File (on page 310)

View the MDR Log File

The Model Data Reuse (MDR) command generates a log file for each MDR operation. This log
file contains information about each design object that was part of the operation. For the objects
that were successfully copied, the original object ID (OID) and the copy OID are shown in the
log. For the objects that failed to copy, only the original OID displays.
Use Windows Explorer or another browser to locate the MDR log file, which is stored at
%temp%. The name of the log file is MDR[file_number].log where file_number is replaced by a

Project Management User's Guide 310

 Model Data Reuse (MDR)

number to make it unique. The text file appears similarly to the one shown in the following
illustration.

Project Management User's Guide 311

SECTION 13

Model Data Transform (MDT)

The Tools > Model Data Transform command enables you to move and/or rotate a large
portion of the design objects in a model from one location in the model to another. The objects
to be transformed are disconnected from the surrounding objects before they are transformed.
This operation does not transform read-only objects or volumes. However, there is an option to
allow the transformation of objects that are not in Working status.
As you cannot undo a Model Data Transform command operation, you need to
make a backup of the model before starting a model data transform (MDT) operation.

Operation Summary
The Model Data Transform command uses a wizard to set up the transformation operation.
Use the wizard to do the following:
 Identify the source model containing the objects to be transformed.
 Specify the name of the operation. (This will be useful if you need to restart the operation.)
 Select the objects to be transformed. You can select source objects by Systems or by
Filter.
 Select the type of transformation (move, rotate, or move and rotate), and specify the details
of the transformation (distance to be moved, for example).
The full set of design objects to be transformed is divided into a sequence of smaller partitions.
Each partition is processed in a separate transaction.
The processing is done in two phases. In the first phase, the objects in each partition are
disconnected from the surrounding objects. In the second phase, the disconnected objects in
each partition are transformed to their new location.
The Operation Properties dialog box automatically displays when the MDT operation has
finished. This dialog box displays the results of the MDT operation. These results include the
overall status of the operation, the total number of design objects, the number of objects that
were transformed, the number of objects found to be read-only, and the number of objects that
failed.

Read-Only Objects
The set of objects to be transformed can include read-only objects. If the current user does not
have write access to the permission groups of the selected objects, those objects are read-only.
MDT could be unable to disconnect a read-only object, or the disconnection could succeed but
the transformation fails because of the read-only objects. A successful disconnection depends
on the specific objects involved. If a read-only object prevents disconnection or transformation,
MDT allows you to correct the situation and restart the operation.

Interrupted Operations
If a hardware or software failure occurs midway through an MDT operation, the operation is
terminated. For example, if the power goes out while an MDT operation is in progress, it results

Project Management User's Guide 312

 Model Data Transform (MDT)

in an abnormal termination. Similarly, if the user clicks on the Stop button of the progress bar,
the operation is terminated. In both of these cases, you can restart the operation.

Restarting an Operation
An operation that has been interrupted or was found to have read-only objects can be restarted.
To restart an operation, run the MDT command again and select the Restart Existing
Operation option on the Welcome screen. When you restart an operation, the software
continues with the design objects that remain to be processed.

Volumes
Volumes can be used for many purposes and might or might not be related to objects inside that
volume that are a part of a MDT operation. Therefore, volumes are never included in an MDT
operation. You must manually determine which volumes are associated with drawings and views
containing objects in the MDT operation and manually move the volumes yourself.

Global Workshare
When working in a global workshare configuration, you can run the MDT command at the host
or any satellite location.
All the objects to be transformed must be owned by the location where you run the MDT
command. If the set of objects to be transformed is entirely owned by the current location, the
operation can be completed normally. However, if the set of objects to be transformed is owned
by multiple locations, the operation cannot be completed. The design objects from the other
locations are reported as read-only.

Best Practices for Model Data Transform Operations

Create a Backup
Create a backup of your model database before starting an MDT operation. This preserves the
state of your model before you start the MDT operation. If you accidentally specify an incorrect
transformation, you can recover by restoring the model from the backup.

Disconnect Objects at the Boundary

Before you begin an MDT operation, we recommend that you manually disconnect the objects to
be transformed from the surrounding objects. By doing the disconnections manually, you can be
assured that you will achieve the results that you want. If you do not disconnect manually, the
MDT command will automatically disconnect and report the objects that were disconnected.

Have Write Permission

Before you begin the MDT operation, ensure that you have at least write permission to each
object to be transformed. Otherwise, you must restart the operation after adding the necessary
permissions in Project Management.
You can also use the Check Write Access command to determine if you have write access to
all necessary objects. Any objects to which you don't have write access to will be displayed in a
report. For more information, see Check Write Access - Results (on page 323).

Project Management User's Guide 313

 Model Data Transform (MDT)

Avoid Concurrent Editing

While an MDT operation is running, other users should not be editing the portion of the model
that is being transformed. If other users are allowed to add, delete, and/or modify objects within
that portion of the model, unexpected results might occur.

Model Data Reuse and Model Data Transform Workflow using Delete Optional
Smart 3D can delete optional inputs of the marine objects (plates, profiles, and so forth)
including detailing objects during copy paste, Model Data Reuse (MDR), and Model Data
Transform (MDT) processes so that objects can be copied and moved without having to select
all the inputs at the new location.
For example, plate system boundaries are inputs that should be redefined at the new plate
location. However, by selecting Delete Optional, you can replace all the optional inputs
(including boundaries, coordinate system, and so forth) with dummy objects (Dummy Plane,
Dummy Surface, and so forth). After the copy is complete, you can then go back and replace the
plate's dummy objects with real objects. However, in a large model, it is sometimes difficult to
identify the plates that have dummy optional inputs.
How to Identify Objects with Dummy Inputs
Smart 3D provides filters to identify objects with dummy inputs. You can access the Select
Filter dialog box using:
 File > Define Workspace > Properties
 Tools > Select by Filter
For example, to find all the standalone and the lapped plate parts whose boundaries are
replaced by dummy objects, define the workspace using the Standalone and Lapped Plates
with Substituted Boundary catalog filter.

Project Management User's Guide 314

 Model Data Transform (MDT)

Similarly, if these plates whose definition objects are replaced by dummy objects, define the
workspace with the filter Standalone and Lapped Plates with Definition Object.

You can define your own filters to find specific detailing objects in the workspace that have
dummy boundaries or definition-objects by defining the property Has Substituted Boundary or
Has Substituted definition object. To create a new filter:
1. Click File > Define Workspace.
2. In the Model list, select the model.
3. In the Filters list, click Create New Filter.
4. On the Properties tab, select the object properties to restrict your search.

Project Management User's Guide 315

 Model Data Transform (MDT)

5. Click More… and select the object type used and the property name Has Substituted
Boundary, and click OK.

Project Management User's Guide 316

 Model Data Transform (MDT)

6. On the Object Type tab, select the object type to highlight. If you do not select any objects,
the filter includes all objects in the list. To include one or more object types in your filter,
press CTRL and click the name of each object type that you want to include. Click OK.

Project Management User's Guide 317

 Model Data Transform (MDT)

Model Data Transform Wizard: Welcome

The Tools > Model Data Transform command is available on the Project Management menu
bar.
The Model Data Transform wizard contains multiple pages. You can navigate back
and forth through the pages using the Back and Next buttons on each page.

What would you like to do?

Begin a New Operation - Starts a new operation.
Restart an Existing Operation - Restarts an operation that was previously interrupted.
The following illustration shows the general workflow for using Model Data Transform:

Next step:
Model Data Transform Wizard: Begin New Operation (on page 319)
-OR-
Model Data Transform Wizard: Restart Existing Operation (on page 319)

Project Management User's Guide 318

 Model Data Transform (MDT)

Model Data Transform Wizard: Begin New Operation

Starts a new transformation operation.
Operation name
Specifies a name for this operation. Every operation must have a name.
Next step:
Model Data Transform Wizard: Model (on page 320)

Model Data Transform Wizard: Restart Existing

Operation
Restarts an operation that was interrupted.
Model
Displays the model containing the objects to transform. By default, the selected model
displays here. If no model is selected, then one of the up-to-date models listed in the Project
Management hierarchy displays.
Select Model
Allows you to select a different model as the source. Only up-to-date models display for
selection.
Operations
Displays the existing MDT operations. The Name, Phase, Status, Created By, and
Created Date properties are displayed for each operation. This table supports row selection
only. You can sort this table by clicking in any of the column headers.
You can only restart an operation if you have write access to it and its status is
not complete. If these criteria are true for the selected operation, then the Next button is
enabled.
Properties
Displays the standard Properties dialog box for the selected operation. This allows you to
review the full set of properties for the selected operation.
Delete
Removes the selected operation. After an operation is completed, it remains in existence for
historical purposes. When it is no longer needed, it can be deleted.
Next step:
Model Data Transform Wizard: Confirmation (on page 323)

Project Management User's Guide 319

 Model Data Transform (MDT)

Model Data Transform Wizard: Model

Selects the model containing the objects to transform.
Model
Displays the model containing the objects to transform. By default, the selected model
displays here. If no model is selected, then one of the up-to-date models listed in the Project
Management hierarchy displays.
Select Model
Allows you to select a different model as the source. Only up-to-date models display for
selection.

Object selection method

Specifies the transformation method.
Systems
Select systems to transform all of the objects in those systems.
Objects by filter
Select filters to determine the objects to transform.

Options
Ignore approval status during transform
Allows you to honor or ignore the approval status of the selected objects. If you select this
option, all the selected objects will be transformed regardless of their approval status. This
option is selected by default.
This option only applies to the transformation phase of processing, and does not
apply to the disconnection phase.
Operation permission group
Specifies the permission group for the operation object itself. The list contains all of the
permission groups for which you have write access. The default permission group is the first
one from that list.
This permission group only applies to the MDT objects, and does not
apply to the rest of model objects.
Next step:
Model Data Transform Wizard: Systems (on page 321)
-OR-
Model Data Transform Wizard: Objects by Filter (on page 321)

Project Management User's Guide 320

 Model Data Transform (MDT)

Model Data Transform Wizard: Systems

Select systems to transform.
Systems
Displays the system hierarchy for the selected model. You can select one or more systems
in this tree view. All objects nested under those systems will be transformed.
When you select a system, it highlights. The set of all highlighted nodes constitutes the
select set. Click on any system to clear the current select set, and then select the specified
system. In addition to the specified system, all of the systems nested under that system are
also selected. The selected tree view node does not automatically expand, although the
items are selected. The extent of the select set is only visible if you expand the node.
Use CTRL+Click to add a system to the selected set. CTRL+Click does not clear the select
set. In addition to the specified system, all of the systems nested under that system are also
selected.
You can also use CTRL+Click to remove a system that is already selected from the select
set. In addition to the specified system, all of the systems nested under that system are also
removed.
SHIFT+Click selection and button down selection (down+drag+up) are not
supported.
Next step:
Model Data Transform Wizard: Transformations (on page 322)

Model Data Transform Wizard: Objects by Filter

Select a filter. The wizard runs this filter against the model to find the objects to transform.
When you select a filter to define the source objects, the Model Data Transform command
inspects the filter and takes appropriate action. Some types of filters are not accepted by Model
Data Transform. The only types of filters accepted by the Model Data Transform command
are:
 System
 Permission Group
 Object Type
 Volume
 Properties
Combinations of the filter types listed above are also accepted. If you define the selected filter
using a tab not included in the list above, the software displays a warning message, and rejects
the filter.
Filter
Select the filter from the list. The list contains the entries Create New Filter, More, and
recently used filters. If you click More, the Select Filter dialog box displays. For more
information, see Select Filter Dialog Box (on page 271).
Properties

Project Management User's Guide 321

 Model Data Transform (MDT)

Displays the Filter Properties dialog box so that you can review the properties of the
selected filter. For more information, see Filter Properties Dialog Box (on page 137).
Next step:
Model Data Transform Wizard: Transformations (on page 322)

Model Data Transform Wizard: Transformations

Specifies the transformation for the selected objects.

Move options
Move
Specifies that the selected objects are moved.
Data is always moved with respect to the Global coordinate system. If the area
you are moving was modeled with respect to a rotated coordinate system, the results of the
move may not be as expected. This is because the software calculates the move based on
the orientation of the Global coordinate system, which is zero (0) degrees.
East distance
Specifies the distance to move in the east direction.
North distance
Specifies the distance to move in the north direction.
Up distance
Specifies the distance to move in the up direction.
Units
Specifies the units of measurement for the distances.

Rotate options
Rotate
Specifies that the transformed objects are to be rotated about a vertical axis. You must
select an existing coordinate system and type an angle. The axis of rotation will be the up
axis of the selected coordinate system.
Axis coordinate system
Specifies the axis coordinate system. Select a coordinate system from the list of existing
coordinate systems.
Angle of rotation
Specifies the rotation angle.

Move and Rotate options

Move and Rotate
Specifies that the transformed objects are to be moved and rotated in the same way that
would transform the from coordinate system into the to coordinate system.

Project Management User's Guide 322

 Model Data Transform (MDT)

From coordinate system

Specifies the from coordinate system. Select a coordinate system from the list of existing
coordinate systems.
To coordinate system
Specifies the to coordinate system. Select a coordinate system from the list of existing
coordinate systems.
Next step:
Model Data Transform Wizard: Confirmation (on page 323)

Model Data Transform Wizard: Confirmation

Check Write Access - Displays Check Write Access - Results report. This is an optional
command.
This command allows you to verify that you have sufficient permissions to disconnect
the objects at the boundary and transform the selected objects. If you have selected the Ignore
approval status during transform option, Check Write Access only verifies the approval
status for the selected objects. Otherwise, the command also checks for Permission Group. In a
Global Workshare configuration, Check Write Access checks if the selected objects are
assigned to the current location. For more information, see Check Write Access - Results (on
page 323).
Click Transform to start the process.
The Model Data Transform processing dialog box is shown. The progress bar shows,
first, the status of disconnecting the boundary objects, and then the status of transforming
the objects. The term design object refers to a top-level application object such as Area
System, Unit System, Equipment, Pipeline, Pipe Run, Column, Beam, Slab, and so on.
The Undo command (CTRL + Z) will not work after this operation starts. You
can cancel the operation during processing, but the objects that have already been processed
are present in the model. If you need to rollback the changes made by the MDT command, you
must restore the model to the most recent backup. If you need to continue the MDT command,
you can restart the operation.
When the operation completes, the Operation Properties dialog box displays. For more
information, see Operation Properties Dialog Box (on page 324).

Check Write Access - Results

Displays any objects that belong to a permission group that you do not have permissions to
modify. The message includes the system hierarchy path to the object.
The software also displays messages for any transformed boundary object that might get
disconnected. The message includes the system hierarchy path of the object that might
transform and disconnect.
The User Action column tells you if you must take any action before the MDT operation can
succeed. Displays Yes if you do not have write access to all the permission groups for the object
to be transformed. You need to login as a user with write access to all permission groups.

Project Management User's Guide 323

 Model Data Transform (MDT)

The software also displays any additional information related to the object. You can also copy
the results to MS Excel using the Copy to Clipboard option.

Operation Properties Dialog Box

Displays the properties associated with a Model Data Transform operation.
See Also
General Tab (Operation Properties Dialog Box) (on page 324)
By Class Tab (Operation Properties Dialog Box) (on page 326)
Messages Tab (Operation Properties Dialog Box) (on page 326)
Configuration Tab (Operation Properties Dialog Box) (on page 327)

General Tab (Operation Properties Dialog Box)

Displays general operation information, including the operation status and the summary
operation statistics.

Name
Displays the name associated with the operation.
Type
Displays the type associated with the operation.
Operation Status
Displays the status of the operation. The events that lead to different operation status values
are listed in the following table:

Project Management User's Guide 324

 Model Data Transform (MDT)

Event Action Operation Status Able to Restart the

Operation?

Operation completes Processing Completed No

successfully without completes
any read-only objects. normally.

Operation completes Processing Incomplete Yes

successfully with read- completes
only objects. normally.

User clicks Stop on Processing is Stopped Yes

the Progress Bar terminated in
an orderly way.

Hardware/software Processing Incomplete Yes

failure terminates
abnormally.

Another client has In Progress No

started this operation

Design Objects
Displays the number of objects selected for the transformation.
Succeeded
Displays the number of objects transformed.
Failed
Displays the number of objects that failed to transform.
Read Only
Displays the number of objects that have read only privileges. If you have selected a design
object for a transform operation that is read-only because of its approval status or
permission group, the software does not transform the object. If a subordinate object is
found to be read-only, the entire design object is not transformed.
If some of the objects selected for a transform operation are found to be read-only, they are
not transformed. However, the operation continues, and those objects that are writable are
transformed.

 You can make a read-only object writable by changing its approval status, changing its
permission group, or logging in as a user who has write access to the object.
 When a transform operation is not able to complete successfully because of read-only
objects, you can restart the operation after you make the read-only objects writable. To
restart an operation, start the command again. On the Operation page, select Restart
an existing operation.
Remaining
Displays the number of objects remaining to transform if the process is interrupted.

Project Management User's Guide 325

 Model Data Transform (MDT)

Processing Time
Displays the time taken to complete the transformation process.
Number of restarts
Displays the number of the times the transformation process was restarted.

By Class Tab (Operation Properties Dialog Box)

Displays operation statistics broken down by class.

Design Objects
Displays the number of objects selected for the transformation.
Succeeded
Displays the number of objects transformed.
Failed
Displays the number of objects that failed to transform.
Read Only
Displays the number of objects that have read only privileges. If you have selected a design
object for a transform operation that is read-only because of its approval status or
permission group, the software does not transform the object. If a subordinate object is
found to be read-only, the entire design object is not transformed.
If some of the objects selected for a transform operation are found to be read-only, they are
not transformed. However, the operation continues, and those objects that are writable are
transformed.

 You can make a read-only object writable by changing its approval status, changing its
permission group, or logging in as a user who has write access to the object.
 When a transform operation is not able to complete successfully because of read-only
objects, you can restart the operation after you make the read-only objects writable. To
restart an operation, start the command again. On the Operation page, select Restart
an existing operation.
Remaining
Displays the number of objects remaining to transform if the process is interrupted.

Messages Tab (Operation Properties Dialog Box)

Displays messages that are generated during the MDT process. These messages are similar to
those generated by the Check Write Access command.
The software displays any objects that belong to a permission group that you do not have
permission to modify. The message includes the system hierarchy path to the object.

Project Management User's Guide 326

 Model Data Transform (MDT)

The software also displays messages for any transformed boundary object that has been
disconnected. The message includes the system hierarchy path of the object that was
transformed and disconnected.
The software also displays any additional information related to the object.

Configuration Tab (Operation Properties Dialog Box)

Displays the creation, modification, and status information about the MDT operation.

Model
Displays the name of the model. You cannot change this value.
Permission Group
Specifies the permission group to which the MDT operation belongs. You can select another
permission group, if needed. Permission groups are created in the Project Management
task.
Date Created
Displays the date and time that the MDT operation was created.
Created by
Displays the user name of the person who created the MDT operation.
Date Last Modified
Displays the date and time when the MDT operation was modified.
Last Modified by
Displays the user name of the person who modified the MDT operation.

Project Management User's Guide 327

SECTION 14

Model Data Reuse (MDR) Validation Tool

The Model Data Reuse (MDR) Validation Tool helps you analyze the results of any model data
reuse, synchronization, upgrade, conversion, or modification operations within the same or
between similar data sets. For example, you can use this utility on a session file to compare
changes made to objects from one day to the next. For model data reuse or other migration-type
operations occurring across two session files, you are able to review differences and resolve
any unexpected changes.
The utility checks the designated source and destination dataset for changes in the following
three areas:
 Data changes
 Position changes
 Orientation changes
 Content changes
The utility provides the resulting differences in a View Results dialog box as well as within
Smart 3D graphic views. As you analyze the differences, you can use options in the utility that
work interactively with commands in Smart 3D to help resolve unexpected changes. Within
source and destination graphic views, you can highlight and fit to a selected object to visualize
graphically any size, position, or orientation changes. The differences in a graphic view are
displayed by a color-coding scheme defined by the utility.

Object List or Model Data Reuse Log File Analysis

When using this utility, you can choose between two basic methods for data comparison. You
can analyze the results of a model data reuse operation using the generated log file or use an
object list file to look only at specific objects. After you have data generated for your source and
destination datasets, you can run the utility at any time as you do your work.

General Workflow
After you load the MDR Validation tool into Smart 3D, the basic workflow is:
1. Generate data for validation.
2. Process the generated data.
3. Review results.
4. Generate reports.
Use Custom Commands in Smart 3D to add this tool to the application, and then run it to
display the Validate MDR Results - Generate Data dialog box.

What do you want to do?

 Configure the MDR validation tool (on page 329)
 Start the MDR validation tool (on page 329)

Project Management User's Guide 328

 Model Data Reuse (MDR) Validation Tool

 Process and generate data using the MDR log file (on page 331)
 Process and generate data using objects list files (on page 332)
 View results (on page 333)
 Generate reports (on page 336)

Configure the MDR validation tool

Follow the steps below to add the MDR Validation Tool as a custom command in Smart 3D.
1. Open Smart 3D, and select any template.
2. Click Tools > Custom Commands.
3. Click Add in the Custom Commands dialog box.
4. Type MDRValidation.CValidateGeometry as the Command Progid.
5. Type MDR Validation Utility as the Command name.
6. Type in a brief description for the utility.
7. Select Normal as the command priority.
8. Click OK.

Start the MDR validation tool

1. In Smart 3D open a session with a workspace containing source and/or result data.
If Model Data Reuse was performed across models, the MDR Validation
tool must be run on both the source and the destination models to analyze the results. In
this case, open a session for the source as well as a session for the destination.
2. With the MDR Validation Tool selected in the Command names list, click Run in the
Custom Commands dialog box.

The system displays the Validate MDR Results - Generate Data dialog box.

Validate MDR Results - Generate Data Dialog Box Options

The MDR Validation command displays the Validate MDR Results - Generate Data dialog box
containing options to set up data for analysis, process the data, generate the results, and create
reports. You can analyze data from a model data reuse operation or from an object list file.
Select MDR Log File
Type in the pathname or browse to the MDR Log file containing the data to be analyzed.
The selected log file must correspond to the active model.
If several model data reuse operations are performed on a model, you can select
each of those MDR log files as inputs in separate analysis sessions.

Project Management User's Guide 329

 Model Data Reuse (MDR) Validation Tool

Objects List File

Processes data based on user-defined objects. Click either Source or Destination, and
then type in the pathname or browse to an existing object list file. You can also click Create
Objects List File for the utility to generate a file. You must use a previously-created Objects
List File, or create one from a source dataset.
Create Objects List File
Creates an objects list file. You must create a file for both source and destination data sets.
Limit Analysis to Selected Objects
Analyzes objects you currently have selected in the current session. With this option, you
must select nested objects and not select just high level objects.
Limit Analysis to Selected Object Types
Analyzes a few object types and ignores others. When you select this option, the Object
Types list becomes enabled and you can select one or more object types.
Coordinate Precision
Selects the precision value to use the coordinate values. This precision value helps resolve
minor differences in values by rounding off the values to the specified precision.
Length Precision
Selects the precision value to use for linear dimensions. This precision value helps resolve
minor differences in values by rounding off the values to the specified precision.

 The Coordinate and Length Precision options both determine the precision tolerance
of the comparison.
 Although the model may be set to display objects in inches or feet, the precision options
use millimeters (mm) for absolute measurement.
Generate Data for Validation
Processes the selected log file. Progress messages display in the Smart 3D status bar until
the process is completed. This option is enabled when you select a valid MDR log file or
object list file.
Process Generated Data
Analyzes the data generated from the Generate Data for Validation process. This option
becomes enabled after the data generation process has been completed on both the source
and destination datasets. You must perform this option each time the data has been
regenerated for any settings change. The status bar displays progress messages when
processing the data and also when the processing is completed.
Review Results
Opens the Validate MDR Results - Review Findings dialog box, which provides graphical
views and descriptions of the resulting data validation check. This option is enabled when
data has been generated and processed.
Differences Only
Select this option to review only objects where there were changes between the source and
destination.

Project Management User's Guide 330

 Model Data Reuse (MDR) Validation Tool

Process and generate data using the MDR log file

To run the MDR Validation Tool, you must be connected to the model in which the MDR results
are to be analyzed.
1. Start the MDR Validation tool in Smart 3D (Tools > Custom Commands).
2. Select Model Data Reuse Log File, and browse to the log file associated to the current
model.
3. If you want to limit the comparison, select one or both of the analysis options.
 Limit Analysis to Selected Objects
 Limit Analysis to Selected Object Types
4. When you select Limit Analysis to Object Types, place a checkmark beside each object
type you want to use.
5. Set the Coordinate and Length Precision options, which enable you to control the
precision of validation.
6. Click Generate Data For Validation.
7. When the data for validation gets generated, click Process Generated Data. You must
select this command each time the data has been regenerated for any change in settings.
The status bar displays progress messages when processing the data and also when the
processing is completed.
8. Repeat steps 1-6 with a session open in the destination model if you have performed model
data reuse across two different models.
Progress messages display in the Smart 3D status bar. When the data generation for the
source objects is completed, the status bar displays the message Generated Data for
Source Objects. Similarly on the destination side, the message is Generated Data for
Source Objects. If the model data reuse was performed within the same model, the
message is Generated Data for Source and Destination Objects.
Make sure you use the same data generation options (Limit Analysis
options, object types, and precision settings) for both source and destination data.
Otherwise, you will not get accurate comparisons.
9. When the process is completed, you can review the results. Click Review Results. Select
Differences Only if you want to see only the differences that were found. See View results
(on page 333)

Project Management User's Guide 331

 Model Data Reuse (MDR) Validation Tool

Process and generate data using objects list files

1. Start the MDR Validation tool in Smart 3D (Tools > Custom Commands).
2. Open the related session file. Select Objects List File, and click Source.
3. If you already have an objects list file, type in the pathname or browse to the file.
OR
Click Create Objects List File for the utility to automatically generate a list file for your
source data set.
The Smart 3D status bar displays Created Objects List File.
4. If the destination data set is in another session file, go to the utility in that session file and
select Destination. Repeat step 3.
5. To limit the comparison, select one of the analysis options.
 Limit Analysis to Selected Objects
 Limit Analysis to Selected Object Types
6. When you select Limit Analysis to Object Types, place a checkmark beside each object
type you want to use.
7. Set the Coordinate and Length Precision options, which enable you to control the
precision of validation.
8. Click Generate Data For Validation.
9. When the data for validation gets generated, click Process Generated Data. You must
select this command each time the data has been regenerated for any change in settings.
The status bar displays progress messages when processing the data and also when the
processing is completed.
10. Repeat steps 5-10 if you have a separate session file containing the destination data.
Make sure you use the same data generation options (Limit Analysis
options, object types, and precision settings) for both source and destination data. Otherwise,
you will not get accurate comparisons.
When the process is completed, you can review the results. Click Review Results. Select
Differences Only if you want to see only the differences that were found.

Project Management User's Guide 332

 Model Data Reuse (MDR) Validation Tool

View results
The Validate MDR Results - Review Findings dialog box enables you to set up graphic views
of the processed data, view descriptions of resulting differences, and then generate reports on
the differences. The Add, Remove, Highlight, and Fit options work within graphic views so that
you can run the utility interactively with Smart 3D.

Validate MDR Results - Review Findings Dialog Box Options

User interface elements and text information displayed in green represent the source data.
Elements and text information in black represent the destination data. Additional color codes
include:
 The individual sub objects such as features/connections, nozzles, or support parts in the
source and destination objects display in blue and yellow, respectively.
 Blue - All data matches.
 Magenta - Some data matches.
 Black - Matching data / sub-object not found between the source and destination.
This dialog box displays when you click Review Results in the Validate MDR Results -
Generate Data dialog box.
Review
Select All or a specific task to review.

Takes you to the previous or next object in the selection set.

Differences Only
Displays objects that have differences between the source and destination.
Selection Clear
Removes the objects from the selection set.
Source
Adds a specific source object to the selection set.
Source
Removes a source object from the selection set.
Destination
Adds a specific object in the destination to the selection set.
Destination
Removes an object in the destination from the selection set.
Highlight
Highlights an object in the selection set.
Fit
Fits the highlighted object to the graphic view.

Project Management User's Guide 333

 Model Data Reuse (MDR) Validation Tool

Setup Views
Creates the graphic views in the source and destination.
Next
Opens the Mitigate MDR Results window for you to generate reports and create discipline
filters.
Back
Opens the previous screen.
Source & Copy Objects - Names, Hierarchy
Lists each object by name and system path in the designated selection set. The top line
represents the source object and the bottom line shows the destination object. Click to
scroll through available objects.
Summary of Anomalies
Provides a brief description of any data differences.
Show/Hide Details
Expands or collapses the Source & Destination Objects - Compared Data section. As you
select an object in this list, the object is automatically selected in the graphic views.
Differences
Shows the expected result and then the actual result in the destination. For example, any
differences in the coordinate locations between source objects and corresponding
destination objects are listed as:
 The Expected column lists the attributes of the destination object defined in the model
data reuse operation.
 The Actual column displays the actual attribute value of the destination object.

Results Display in Graphic Views

To indicate the results in graphics views and list views, the MDR Validation tool provides specific
color codes for source and destination objects.
Successful transformation
To indicate a successful transformation of objects in a graphic view:
 Source objects display in green and the destination objects display in black.
 Sub-objects (features/connections, nozzles, and support parts, for example) in the source
object display in blue; destination sub-objects display in yellow.
 List Views containing the compared data of the objects show the status by:
 All data matches display in blue text.
 The Differences table at the bottom will be empty.
 There is no black text if the transformation is successful.
Transformation of the source object fails
 Source objects display in green, but the object does not exist in the destination and is not
shown.

Project Management User's Guide 334

 Model Data Reuse (MDR) Validation Tool

Transformation of the source object is completed, but the destination object did not
transform as expected.
 Source objects display in green and the destination objects display in black in the graphic
view.
 List Views containing the compared data of the objects show the status by:
 Some data matches display in magenta.
 The Differences table at the bottom will show expected data versus actual data for the
destination object.
 Black text indicates one of the following:
 Matching data/sub-objects were not found between the source and destination.
 Source and destination object have attribute differences.
 Destination object is not at the expected location.
 The Differences table at the bottom will show expected data versus actual data for the
destination object.
The steps below provide a general workflow in using options in the Validate MDR Results -
Review Findings dialog box.
1. Select ALL or a specific category of objects.

2. Click Setup Views.

For model data reuse comparisons within the same session file, the utility generates four
graphic views. Two graphic views are generated from an objects list comparison.
When the source and destination are within the same model, the top graphic
views represent the source and the bottom views represent the destination.

3. Click the scroll buttons to see each object available in the selected category. As you
scroll through the objects, they are displayed in the graphic views in Smart 3D.

Project Management User's Guide 335

 Model Data Reuse (MDR) Validation Tool

4. You can clear, add or remove each object from your Smart 3D selection set.
5. Select Highlight and Fit to better see the objects in graphics views. You can also use
commands in Smart 3D to further manipulate objects in the graphic views.
6. Click Show Details to get more in-depth descriptions of changes or anomalies that were
found.

 Select an object in the Validate MDR Results - Review Findings dialog box. Click on
any window or element in Smart 3D to get the focus and press CTRL+T to open the To
Do List dialog box. Click Filter To Do List by Select Set to see if any selected objects
have a To Do record.
 As you move through the list views in the Compared Data section of the Validate MDR
Results dialog box, the cursor automatically selects each related source and
destination object. To prevent this and freely scroll down through the objects in the list
views, press and hold the CTRL key.

7. You can now generate a report or create discipline-specific folders to show data anomalies.
Select Differences Only and then click Next.

Generate reports
You must select the Differences Only option to generate a text report.
Follow the steps below to create text reports listing the validation results.
1. Click Create Text Report.
The system generates a text (.TXT) file using the name of the MDR log file. For example,
testing.txt file is generated from the log file, testing.log. The file is placed in the same
location as the model data reuse log file you used in the MDR Validation tool. The text report
provides a summary of the data of all the objects both in the source and in the destination.
2. Click Create Discipline Filters to create source (Src), destination (Copy), and source-and-
destination (Src-And-Copy) folders based on discipline. When they are created, the folders
display in the Select Filter dialog box (Tools > Select by Filter) in Smart 3D.

Mitigate MDR results Dialog Box Options

Create Text Report
Generates a report that gives a summary of the data of all the objects both in the source and
in the destination locations.

Project Management User's Guide 336

 Model Data Reuse (MDR) Validation Tool

Filter Folder Prefix

Displays the prefix that will be used for the filter folders you create. You can use the default
prefix or type in your own.
Create Discipline Filters
Creates folders based on the different disciplines. Each of the folders serve as filters as a
way to show reports on the objects with anomalies. These folders are created under your
%temp% folder.
Back
Returns to the Validate MDR Results - Review Findings dialog box.

Project Management User's Guide 337

SECTION 15

Custom Commands
Provides end-user application programming capability for the 3D software. Using Microsoft®
Visual Basic, you can create a custom command that groups a series of commands and
instructions into a single command that runs as an operation in the 3D software. As a result, you
can access the customized commands that directly relate to the work routine in your operation.
Use the Visual Basic Command Wizard to help you build a custom command. For example,
the wizard's first step prompts you to identify general information including command name,
project name, author, and company. Start the wizard in Visual Basic by clicking Command
Wizard on the Add-Ins menu. For more information about installing the Command Wizard and
other programming resources, see the Intergraph SmartTM 3D Installation Guide, available by
clicking Help > Printable Guides in the software.
After adding a custom command in the 3D software, you can edit it using the Edit Custom
Command dialog box which requires you to specify the program identifier (prog_id), command
name and description, command priority, and a command line of arguments in a string.

Delivered Custom Commands

The following list provides descriptions and ProgIDs for the delivered custom commands. For
more information consult the Database Integrity (DBI) Guide and the Common User's Guide
(Tools Menu > Custom Commands). Both are available from Help > Printable Guides.

Custom Command Check Database Integrity

ProgID SP3DCheckDatabaseIntegrity.CCheckObj

Description Creates records for the objects that need to be cleaned. Run this
custom command directly on a database (site, catalog, or model).
Then, you can generate a report to review the errors that the Check
Database Integrity command generated.
For more information on this command, see the Database Integrity
Guide.

Custom Command Clean Database

ProgID SP3DCleanDatabaseCmd.CCheckObj

Description Deletes or cleans an object. Use this command when an action on the
Check Database Integrity report is To Be Removed or To Be
Repaired.
For more information on deleting and cleaning objects in the database,
see the Database Integrity Guide.

Project Management User's Guide 338

 Custom Commands

Custom Command Create Drawing View

ProgID MenuDrawView.CMenuDrawView

Description Saves and converts the contents of a three-dimensional graphic view

window into a snapshot view. This command creates a rectangular
object associated to a clipping volume, or volumes, in the three-
dimensional model.
Before you create a snapshot view using this command, you must
have added at least one composed drawing type to the Management
Console in the Drawings and Reports task.
You can save additional views by updating the view contents and then
saving the new design. If you used the Tools > Hide command to
avoid displaying certain objects, those objects are included in a
composed drawing you create.
To use the Tools > Snapshot View command, you must have
appropriate permissions to access composed drawing types. If you
have only read permission, you receive a message that alerts you to
this condition.
After you create the snapshot views, you can add them to composed
drawings when you use the Tools > Drawings Console command.

Custom Command Duplicate Part Numbers

ProgID DuplicatePartNumbers,Ingr.SP3D.ProjectMgmt.Client.Commands.Dup
licatePartNumbersCommand

Description Repairs duplicate parts that exist in the catalog, including any proxies
that might also exist in all the associated models. The command is
available only when you have selected a catalog in the Project
Management tree.
In a Global Workshare environment, you must run
this command only from the host location.

Project Management User's Guide 339

 Custom Commands

Custom Command Find Object by OID

ProgID SP3DFindObjectByReport.FindObjects

Description Finds objects with integrity problems in a graphic view. Before running
this command, you must define your workspace to include these
objects. Run a database integrity report, and use the reported OIDs of
the objects in the workspace definition.
For more information on this command, see the Database Integrity
Guide.

Custom Command Fix Project Root

ProgID SP3DPRJMGTRepairCmd.FixCnfgProjectRoot

Description Synchronizes the model name in the model database and the site
database. The name in the site database prevails.
You must run this command from a task in the model, not from Project
Management.

Custom Command Large Sector Utility

ProgID DwgBinaryEditorCmd.FixSectorSize

Description Converts existing production drawings from a small to a larger sector

format to avoid exceeding Microsoft structured storage limits and
causing errors to occur.

Custom Command Model Data Reuse (MDR) Validation Tool

ProgID MDRValidation.CValidateGeometry

Description Helps you in analyzing the MDR results. If MDR is performed across
models, you must run this tool on both the source and the destination
models to enable analysis of the results. The tool locates the objects in
the model that failed to copy as well as the objects that have a data
mismatch with the source and the destination. Information for this tool
is provided in the Project Management User's Guide.

Project Management User's Guide 340

 Custom Commands

Custom Command Modify Style

ProgID ModifyStyleCmd.ModifyStyles

Description Modifies system-based styles existing in a custom model database.

For information on creating correct style colors, see Format Style.
For older databases (created before version 06.00.22xx), run this
custom command to update the database; then exit the application.
Delete the old session file and open with a new session file. The new
colors are available.
New databases (created after version 06.00.22xx) automatically use
the corrected colors.

Custom Command Place Piles

ProgID PileFoundation,PileFoundation.PileFoundation

Description Provides a placement wizard to facilitate the modeling of pile

members. Through the Place Piles command, you can specify the
number of piles in each direction as well as edge clearances and
depth dimensions. You can also specify the member cross section and
material for the piles.

Custom Command Placing Supports from XLS

ProgID PlacingSupportsFromXLS,PlacingSupportsFromXLS.PlacingSupports
FromXLS

Description Places support information from an .xls file into Smart 3D. You must
run this command from Smart 3D, and not from Project Management.
For more information, see Placing Supports from XLS Command in
the Smart 3D Hangers and Supports User's Guide.

Project Management User's Guide 341

 Custom Commands

Custom Command Remove Design Basis

ProgID IMSEngFrameworkCmd.RemoveDsgnBasis

Description Removes all correlation relationships and then deletes all design basis
objects in the 3D model.
This command is useful when you want to register to a different
SmartPlant foundation database.
After running this command, you must register the model, retrieve
information, and correlate the objects again.
You must run this command from a task in the model, and not from
Project Management.

Custom Command Repair Documents

ProgID DwgRepairCmd.RepairDocuments

Description Updates invalid Styles.sha or Symbol Browser file paths on a

document or a set of documents. Invalid file paths can occur when you
change the symbol share. This causes overhead while editing, saving,
or updating documents.

Custom Command Repair Duplicate Permission Group ID

ProgID RepairDuplicatePermissionGrpID,Ingr.SP3D.ProjectMgmt.Client.Com
mands.
RepairDuplicatePermissionGrpIDCommand

Description Lists all catalogs and models that have a duplicate permission group
ID.
Select the catalogs and models to repair. You cannot select all of the
databases under a particular duplicate permission group ID.
This command can only be invoked from Project Management.
This command cannot be run from a satellite location. You should run
this command only from the host location.

Project Management User's Guide 342

 Custom Commands

Custom Command Repair Permission Groups

ProgID PermissionGroupsAndLocations,Ingr.SP3D.ProjectMgmt.Client.Comm
ands.PermissionGroupsAndLocationsCommand

Description Repairs the corrupted relationship between permission groups and the
location for both catalog and model permission groups.
If a permission group has lost the relationship with a location or has
multiple relationships, then this command re-establishes a proper
relation. This command cannot be run from a satellite location. You
should run this command only from the host location.
Users with full permissions in the corrupted permission
group can only re-establish the relationship.

Custom Command Repair Style Path

ProgID DwgRepairCmd.RepairDocuments

Description Fixes Symbol and Style paths on RAD documents.

Custom Command Synchronize Drawing Component Templates

ProgID DwgSynchTemplatesCmd.SynchTemplates

Description Repairs a drawing component that has become corrupted by

synchronizing it with a different, uncorrupted drawing component. This
command requires that the source component is the same type as the
corrupted component, and that the source component cannot be
corrupted. Also, the number of views on the source component must
be the same as the number of views on the corrupted component. The
names of the views on the source component must match the view
names of the corrupted component.

Custom Command Synchronize Drawing Templates

ProgID DwgSynchTemplatesCmd.SynchTemplates

Description Synchronizes, or copies, a template from one drawing component to

another.

Project Management User's Guide 343

 Custom Commands

Custom Command Verify P&ID Integrity

ProgID SP3DDisplayPIDService.VerifyPIDCmd

Description Validates the internal connections between objects on a P&ID and

objects in the model database. This command is useful when there is
a problem displaying a P&ID or selecting objects on a P&ID. The
command provides some basic troubleshooting statistics: number of
design basis objects, number of 3D objects (correlated), number of
P&ID objects, number of deleted P&ID OIDs, and number of duplicate
OIDs.

Custom Command Profile Auto Bound

ProgID mhprofileautobound.AutoBoundProfile

Description Creates mutual bounding between stiffeners profiles or profile edge

reinforcements present on the chute plates. The command requires
that the chute plates be mutually bounded to each other and that the
distance between the stiffener\edge reinforcement is between 0 to
0.01m.

Custom Command Audit Tool

ProgID stAnalysisTool.AuditTool

Description Compares two databases using an SQL query. The databases can be
on different servers and have different catalog schema. Changed
objects can be displayed in the workspace of the current model. This
command is useful after performing a migration, synchronization, or
hull swap.

Custom Command GC Menu

ProgID GCMenu.Activate

Description Places the GC menu on the software toolbar. This menu contains
commands for creating geometric constructions, GC sets, and GC
macros. For more information, see Geometric Construction Macros
(GC Menu) in the Molded Forms User's Guide.

Project Management User's Guide 344

 Custom Commands

Custom Command Verify Seam Pattern to Split

ProgID SplitCommands.VerifySeamPatternToSplit

Description Checks the status of seams and plates split by the seams. This
command provides a count of successful and failed splits, and
modified, new, identical, and deleted leaf systems. You can also
display the objects affected by the seams by selecting one or more of
the following options: Identical Bodies (Green), Modified Bodies
(Yellow), New Bodies (Red), Deleted Bodies (White), or Bad
Splitters (Blue). This command is useful when swapping an old
imported hull system with a new hull. For more information, see Swap
Hulls on a Detailed Model Using Molded Forms Delay in the Molded
Forms User's Guide.

What do you want to do?

 Create custom commands (on page 345)
 Add custom commands (on page 345)
 Run a custom command (on page 346)
 Edit a custom command (on page 346)
 Delete a custom command (on page 346)

Create custom commands

1. Open Microsoft® Visual Basic.
2. In Visual Basic, click Add-Ins > Command Wizard.
3. Complete all steps on each page of the Command Wizard.

 You do not create custom commands within the software. You create them in Visual
Basic using the Command Wizard.
 You must install the Command Wizard software in Visual Basic. The setup for the
Command Wizard (SP3DCommandWizardV2.exe) is located in the [Product
Folder]\Programming\Tools\CommandWizard folder.

Add custom commands

1. Click Tools > Custom Commands.
2. On the Custom Commands dialog box, click Add.

Project Management User's Guide 345

 Custom Commands

3. On the Add Custom Command dialog box, type the program identifier you assigned to the
command in Microsoft® Visual Basic in the Command ProgID box.
4. Type the name you assigned to the command in the Command name box.
5. Type a phrase that describes the command in the Description box.
6. If necessary, change the option in the Priority section.
7. Type command line arguments in a string in the Argument box.
After you complete this procedure, the Custom Commands dialog box lists the
command you added to the software. You can run the command, edit the settings, or delete
the command.

Run a custom command

1. Click Tools > Custom Commands.
The Custom Commands dialog box opens.
2. To start a custom command you created, select the command in the list box, and click Run.
3. After the command runs, click Close on the Custom Commands dialog box.

Edit a custom command

1. Click Tools > Custom Commands.
The Custom Commands dialog box opens.
2. To change the options for a custom command, select the command in the list box, and click
Edit. For example, you can change the name and description of the command.
3. After completing the needed changes, click Close on the Custom Commands dialog box.
You must open the command in Microsoft® Visual Basic if you want to edit the
underlying code.

Delete a custom command

1. Click Tools > Custom Commands.
The Custom Commands dialog box opens.
2. Select the command in the list box, and click Delete. The software removes the command
from the list box; however, the command code is not deleted.
3. After completing the needed changes, click Close on the Custom Commands dialog box.
This action does not delete the DLL for the custom command. It just removes access
to the custom command from the user interface.
See Also
Custom Commands Dialog Box (on page 347)
Add Custom Command Dialog Box (on page 347)
Edit Custom Command Dialog Box (on page 348)

Project Management User's Guide 346

 Custom Commands

Custom Commands Dialog Box

Adds and edits customized commands you have created with the Command Wizard in
Microsoft® Visual Basic. For information on creating custom commands, see Create custom
commands (on page 345).
Command names
Lists the names of commands that have been added.
Run
Starts the custom command you select in the list box. For more information, see Run a
custom command (on page 346).
Close
Cancels the Custom Commands dialog box.
Edit
Opens the Edit Custom Command dialog box. You can change settings for the command,
such as the program identifier (prog_ID) and command name. For more information, see
Edit a custom command (on page 346).
Add
Installs the custom command into the software. For more information, see Add custom
commands (on page 345).
Delete
Removes the custom command from the software. For more information, see Delete a
custom command (on page 346).
Clear
Deletes the information you have typed in the boxes on the Custom Commands dialog
box.
Description
Contains an identifying phrase so you can better recognize the custom command with which
you are working

Add Custom Command Dialog Box

Accesses a customized command you created in Microsoft® Visual Basic and saves the
command within the software.
Command ProgID
Identifies the program identifier for the custom command you created in Visual Basic.
Command name
Specifies the name you assigned to the custom command.
Description
Describes the custom command.

Project Management User's Guide 347

 Custom Commands

Priority
Assigns a priority of High, Normal, or Low.
Argument
Specifies command line arguments in a string.

Edit Custom Command Dialog Box

Changes options for a customized command you added to the software.
Command ProgID
Specifies the program identifier for the custom command you created in Microsoft® Visual
Basic.
Command name
Provides a text box for you to change the name you assigned to the custom command.
Description
Provides a text box to provide a descriptive phrase for the custom command.
Priority
Changes priority to High, Normal, or Low.
Argument
Change the command line arguments in a string.
Reset Default
Returns the dialog box to its default settings.

Project Management User's Guide 348

SECTION 16

Integrated Environment Overview (Smart

3D)
Using Smart 3D in an integrated environment standardizes and improves the communication
among the various authoring tools you use in the course of designing, constructing, and
operating a facility. Smart 3D integration manages data exchange among the authoring tools,
which enables sharing and re-use of information throughout the facility lifecycle. SmartPlant
Foundation acts as a repository for data and a medium through which information is shared
among other tools, such as SmartPlant Instrumentation, SmartPlant P&ID, SmartPlant Electrical
and Smart 3D.
Most of the commands that provide access to Smart 3D functionality exist in the common user
interface available on the SmartPlant menu in the Smart 3D tasks. The SmartPlant commands
in the Project Management task allow you to register the model and update the status of
projects. Additionally, you use the Generate Design Basis command in the Project
Management task to update the project catalog schema with any changes that are made to the
SmartPlant Schema.
In the other Smart 3D tasks, you can use the SmartPlant commands to publish and retrieve
documents from within other tasks. For example, you can publish orthographic drawings that
you create in the Drawings and Reports task, or you can retrieve P&IDs and view them using

Project Management User's Guide 349

 Integrated Environment Overview (Smart 3D)

the P&ID Viewer. You can also publish the entire model for 3D viewing in SmartPlant
Foundation or SmartPlant Review.

For more information about working in an integrated environment, see the Intergraph SmartTM
3D Integration Reference Guide and the SmartPlant Foundation Administrator's Guide.

In This Section
Register ......................................................................................... 351
Generate Design Basis .................................................................. 353
Update Project Status .................................................................... 354
Upgrade Schema Command ......................................................... 360

Project Management User's Guide 350

 Integrated Environment Overview (Smart 3D)

Register
Registers a model database. Each model must be registered before you can connect to the
integrated environment to perform any specific tasks, such as publishing or retrieving files. You
can register each model only once. To more efficiently distribute design work, you can register
multiple 3D models to a single SmartPlant Foundation model.
During registration, the software maps the model and all of the projects associated with it to a
single SmartPlant Foundation URL, which points to one SmartPlant Foundation database, and
returns a unique signature for the tool/model combination being registered.
In an integrated environment, the term "model" is synonymous with the top level of
the PBS hierarchy.
The SmartPlant > Register command displays a wizard that steps you through the following
tasks:
 Specifying the node name and virtual folder for the SmartPlant Foundation database.
 Selecting the model you want to register.
 Providing a description for uniqueness when used in a multi-registration configuration.
After the model is registered, the information is added to the Databases tab of the Model
Properties dialog box.
You must have full control privileges at the model level to access the SmartPlant >
Register command.

Register from Smart 3D

To register a model, you must first configure Smart 3D to work in an integrated environment. For
more information, see the Installation Guide, available from Help > Printable Guides.
Because tool registration information is not upgraded in certain versions of
SmartPlant Foundation, you might be required to re-register with SmartPlant Foundation after
the upgrade of the SmartPlant Foundation site.
You must have full control privileges at the Model level to register a Model.
1. In Project Management, click Model (Model Database) in the tree view and then click
SmartPlant > Register.
Smart 3D Registration Wizard appears. See Smart 3D Registration Wizard - SmartPlant
Foundation URL (on page 352)
To register a model, you can also right-click a model in the tree view, and select
Register with Smart 3D.
2. Type the node name and virtual folder of the SmartPlant Foundation database with which
you want to register. Use the following format: http://SPFServer/VirtualFolder.

 Click Browse to search for the node name. However, you must append the virtual folder
to that node name by typing it in the SmartPlant Foundation URL box.
 Replace SPFServer with the name of your SmartPlant Foundation Web server.

Project Management User's Guide 351

 Integrated Environment Overview (Smart 3D)

 Replace VirtualFolder with the name of the virtual folder for the SmartPlant Foundation
Web Client. By default, the virtual folder for the first instance of the Web Client that you
install is SPFASP. However, if you install multiple instances of the Web Client to
connect to multiple databases, the virtual folder name may be different.
3. Click Next.
The SmartPlant Foundation Plant page appears. See Smart 3D Registration Wizard -
SmartPlant Foundation Plant (on page 352).
4. Select the SmartPlant Foundation project to register your Model.
5. Click Finish.
The model is registered with Smart 3D and is added to the Databases tab of Smart 3D
properties dialog box.

Smart 3D Registration Wizard

Steps you through the process of associating models with a valid SmartPlant Foundation model.

Smart 3D Registration Wizard - SmartPlant Foundation URL

Specifies the SmartPlant Foundation URL to which you want to register your Smart 3D model.
SmartPlant Foundation URL
Specifies the node name and virtual folder of the SmartPlant Foundation database with
which to register your model. Use the following format: http://SPFServer/VirtualFolder.
Browse
Displays a list of available nodes. After selecting the node name, you must add the name of
the virtual folder to the end of the path.
Next
Opens the next page in the wizard: SmartPlant Foundation Plant.
In an integrated environment, the term "plant" is synonymous with the top level of the
PBS hierarchy.

Smart 3D Registration Wizard - SmartPlant Foundation Plant

Specifies the SmartPlant Foundation plant to which your model will be registered.
Plant name
Specifies the SmartPlant Foundation plant with which to associate your model. This list
reflects the SmartPlant Foundation plants available at the URL that you specified on the
previous wizard page.
Next
Opens the next page in the wizard - a tool plant description is required. This field is required
to support multi-instance registration, which allows multiple 3D models to be registered to a
single SmartPlant Foundation database. The description should distinguish the plant.
Finish

Project Management User's Guide 352

 Integrated Environment Overview (Smart 3D)

Completes the registration process and closes the dialog. This button is not available until
you type a tool plant description.
In an integrated environment, the term "plant" is synonymous with the top level of the
PBS hierarchy.

Generate Design Basis

Generates a design basis XML file and updates the associated map files. When you use Smart
3D in an integrated environment, you may need to change the SmartPlant schema to meet the
needs of your company. For example, you might want to add a new property to the schema.
Changes in the SmartPlant schema need to propagate to the Smart 3D catalog schema
database.
To update the Smart 3D catalog schema, you can use the SmartPlant > Generate Design
Basis command, which creates a design basis package that the software loads into the catalog
schema database. The following list shows the steps that the Generate Design Basis
command accomplishes:
 Read the delivered component schemas.
 Read and modify the design basis map file that is used to create design basis objects during
a document retrieve.
 Generate the design basis schema package that is loaded into the Smart 3D catalog
schema database.
The Generate Design Basis command uses as input the file names of the component schemas
and a design basis map XML file. The output of the tool is the design basis package, which the
software automatically loads into the Smart 3D catalog schema database.
If the SmartPlant schema (EFSchema) has been changed, you must generate
component schemas in the Schema Editor before running Generate Design Basis.

Generate a design basis

1. In Project Management, select a catalog in the tree view, and click SmartPlant > Generate
Design Basis.
2. In the Select Component Schemas Path dialog box, specify the path to the modified
component schemas.
3. Click OK. You can click and navigate to the location.
During processing, the software locates and reads the input schema component XML files
and the design basis map file. Next, the software generates the design basis schema
package. Finally, the software updates the views on the catalog schema database.
4. Click OK on the message box that displays notifying the user that the process is complete.
After a model is registered and the Generate Design Basis processing
completes, you must generate model views and regenerate the reports database before
continuing with the integration workflows. For more information, see Regenerate the reports
database (on page 125).

Project Management User's Guide 353

 Integrated Environment Overview (Smart 3D)

To generate views in the model database, perform one of the following actions:
 In Project Management, select the Synchronize Model with Catalog command. Check
Regenerate views and clear all other options. Then click OK.
 Run the View Generator on the model. The View Generator (ViewGenerator.exe) is
delivered to the [Product Folder]\Core\Tools\Administrator\Bin folder. Select the appropriate
databases (Model and associated catalog schema).

Update Project Status

Modifies the status of a project. During a project lifecycle, administrators create projects and
manage their administration through the stages of active, complete, and merged with as-built.
Occasionally, an administrator will need to cancel projects. The Update Project Status
command is only available on the Tools menu in the Project Management task.
There are two status types. One is the Active/Complete/Merged/Canceled status on
the project as it exists. The other is the Working/Approved status for each object in the project.
In this release of the software, the status of the as-built project object must stay set to Working.
Setting the status of the as-built object project to Approved makes it read-only. (For the Project
Management environment, commands like Claim and Release Claim no longer work.)

Status Project Activities

Active Create, modify, and delete model objects.

Create and publish drawings.
Create and publish 3D model documents.

Complete Change WBS assignments from project to as-built on model

objects.
Set 3D project status to Merged.
Delete project drawings.
Perform a final publish of drawings and release claims (Project
Management environment only).

Merged Set 3D project status to Finished.

You can use the options on the Update Project Status dialog box to manage the migration of
project information back into the as-built model.

 The Update Project Status command is not supported in an integrated environment.

 In the Project Management environment, after the project administrator creates a new
project and registers it, you can begin claiming objects to the project, making modifications,
and generating project drawings. When the project team determines that the project is ready
to complete, the project leader is notified to Check Consistency, which appears in the
SmartPlant Foundation To Do List.

Project Management User's Guide 354

 Integrated Environment Overview (Smart 3D)

What do you want to do?

 Update project status to Complete (on page 357)
 Update project status to Merged with As-Built (on page 358)
 Update project status to Merged with SmartPlant (on page 358)
 Return the status of a project to Active (on page 359)
 Cancel a project (on page 360)

Update Project Status Dialog Box

Provides options for managing project status.
Project name
Lists the names of all of the Smart 3D projects (excluding as-built projects) that are
associated with the selected model and that you have write permission to modify.
SmartPlant project status
Displays the status of the active model. Both this field and the Refresh Status button are
disabled if the active model is not registered with a SmartPlant Foundation project.
Refresh Status
Searches for and displays the current status of this project as it exists in the associated
repository. Although the project status is always determined from the design basis, the
software checks the SmartPlant Foundation database. When a status mismatch exists, the
software displays a message that the inconsistency exists. This button is disabled if the
active model or project is not registered.
Return to Active
Returns the Smart 3D project status to an Active status and publishes the information.
This status is the default status when a new project is created. This button is only available
when the Smart 3D project status is Completed, but the SmartPlant project status, if
applicable, is still Active. As an additional safety check, this button automatically calls the
Refresh Status command to query the status before modifying the Smart 3D status. If the
SmartPlant project status is found to be Completed, then the software displays a
message informing you that the project cannot be set back to Active.
If the selected Smart 3D project is not registered, then you can return the project
status from Completed to Active without restriction.
Complete Project
Sets the Smart 3D project status to Completed and publishes this information in
preparation for merge with as-built. This status locks the project to read-only for all Smart 3D
users. When working in an integrated environment, all engineering tools must publish their
status as Completed before the Smart 3D status changes to Completed. After the
SmartPlant project status changes to Completed, no projects can return to the Active
status. This button is available only when the Smart 3D project status is Active, and the
SmartPlant project status is Active. If there is a status mismatch, then the software
displays a message informing you to retrieve the latest documents before completing the
project. The software checks whether all of the documents to be published and associated

Project Management User's Guide 355

 Integrated Environment Overview (Smart 3D)

to the project are up-to-date, and that they have all been published since they were last
updated. The software also checks whether all objects have a status of Approved.
If the selected Smart 3D project is not registered, then you can return the project
status from Active to Completed without restriction.
Merge with As-Built
Sets the Smart 3D project status to Merged, overwrites the current Smart 3D as- built data
with the project version of the data, and, in the Project Management environment, releases
the claims. In Smart 3D, Merge with As-Built does not delete the Work Breakdown
Structure contracts from the project. Project administrators have the option of keeping or
discarding them from the as-built. This button is only available when the Smart 3D project
status is Complete, and the SmartPlant project status is Completed.
Merge with SmartPlant
Updates the Smart 3D project status to Finished. This button is only available when the
Smart 3D project status is Merged, and the SmartPlant project status is Completed.
Cancel Project
Sets the Smart 3D project status to Canceled, and publishes the information. In the
Project Management environment, this status removes the project from the software. This
status does not release claims. No further project status actions are possible at this point.
This button is available only when the SmartPlant project status is Canceled. If the
selected Smart 3D project is not registered, then you can cancel the project without
restriction.

Project Status Update

After the project administrator creates a new project and registers it, you can begin making
modifications and generating project drawings.
For more information about using the software in an integrated environment, see the
Common User's Guide, available from Help > Printable Guides.
When the project team determines that the project is ready to complete, the project leader is
notified to Check Consistency, which appears in the SmartPlant Foundation To Do List. The
following steps guide you through the actions required in order to move a project through the
stages of Complete, Merge with As-Built, and Merge with SmartPlant.
There are two kinds of statuses. One is the Active/Complete/Merged/Canceled status
on the project as it exists. The other is the Working/Approved status for each object in the
project. In this release of the software, the status of the as-built project object must stay set to
Working. Setting the status of the as-built object project to Approved makes it read-only.

What do you want to do?

 Update project status to Complete (on page 357)
 Update project status to Merged with As-Built (on page 358)
 Update project status to Merged with SmartPlant (on page 358)
 Return the status of a project to Active (on page 359)
 Cancel a project (on page 360)

Project Management User's Guide 356

 Integrated Environment Overview (Smart 3D)

Update project status to Complete

Before you update the status of a project to Complete, you must verify the following:
 All of the project drawings are complete, up-to-date, and published, including the document
or set of documents that contain all of the 3D model objects in the project.
 In the Project Management environment, all of the objects that have been claimed to the
project have been set to an Approved status.
You can create a filter to locate the project objects that are still set to a Working status. For
more information about filters, see the Common User's Guide, available from Help > Printable
Guides.
You can change the status of a project object using the Configuration tab on the object
Properties dialog box. For more information about object properties, see the Common User's
Guide, available from Help > Printable Guides.
1. In the Project Management task, select a model in the Project Management tree.
2. Click Tools > Update Project Status.
3. In the Update Project Status dialog box, select the name of the active project in the
Project Name list whose status you want to update to Complete.
4. Click Refresh Status to display the status of the project in the SmartPlant project status
box.
5. Click Complete Project.
6. When processing completes, click Close.

 If there is a status mismatch, then the software displays a message informing you to
retrieve the latest documents before completing the project. The software checks
whether all of the documents to be published and associated to the project are up-to-
date, and that they have all been published since they were last updated. The software
also checks whether all of the objects have a status of Approved.
 If additional changes come in from SmartPlant Instrumentation, SmartPlant P&ID,
SmartPlant Electrical, or Zyqad while the SmartPlant project is still active, the project
status must be set to Return to Active, the 3D model updated with those changes, and
the drawings regenerated. After all of the tools have confirmed that no more changes
are required, follow the steps above to complete the project. For more information on
returning the project status to active, see Return the status of a project to Active (on
page 359).
7. After all of the tools have confirmed that no more changes are required, the project
administrator approves the Check Consistency workflow step in SmartPlant Foundation,
and the SmartPlant project status is set to Complete.
The step to approve Check Consistency in SmartPlant Foundation is non-
reversible; consequently, it is imperative to ensure that no further changes are necessary.

Project Management User's Guide 357

 Integrated Environment Overview (Smart 3D)

Update project status to Merged with As-Built

After the SmartPlant status updates to Complete, the project administrator receives a To Do
List task in SmartPlant Foundation to Closeout Tool, or merge the as-built data.
Prior to performing the following procedure, use the SmartPlant > Retrieve command to
retrieve the Project List and verify that all of the tools, including SmartPlant Foundation, have
their project statuses set to Complete. For more information about retrieving documents, see
the Common User's Guide, available from Help > Printable Guides.
After you verify that the status of the project is synchronized with the status of the projects in the
other tools, you must delete all the project drawings that will not be a part of the final publish
when you update the project status to Merged with SmartPlant. For more information about
deleting drawings and performing a final publish, see the Orthographic Drawings User's Guide,
available from Help > Printable Guides.
1. In the Project Management task, select a model in the Project Management tree.
2. Click Tools > Update Project Status.
3. In the Update Project Status dialog box, select the name of the project in the Project
Name list whose status you want to update to Merged with As-Built.
4. Click Refresh Status to display the current status of the project in the SmartPlant project
status box.
5. Click Merge with As-Built.
6. When processing completes, click Close.
In the Project Management environment, the Merge with As-Built process
overwrites the current as-built data with the project version of the data, but without the
corresponding unclaimed operation.

Update project status to Merged with SmartPlant

The first part of this procedure is performed in the Drawings and Reports task and is
completed in the Project Management task.
1. Set Active Project on the Drawings and Reports toolbar to the as-built WBS item, and use
the Update command to update the remaining drawings in preparation for the final publish.
2. Set Active Project on the Drawings and Reports toolbar to the WBS project name, and use
the SmartPlant > Final Publish command to publish all of the drawings and documents
from the root model node.

 Final Publish is only enabled when the SmartPlant project status is set to Complete,
and the project status is set to Merged.
 For more information about Update and Final Publish, see the Orthographic Drawings
User's Guide, available from Help > Printable Guides.
3. In the Project Management task, select a model in the Project Management tree.
4. Click Tools > Update Project Status.
5. In the Update Project Status dialog box, select the name of the project in the Project
Name list whose status you want to update to Merged with SmartPlant.

Project Management User's Guide 358

 Integrated Environment Overview (Smart 3D)

6. Click Refresh Status to display the current status of the project in the SmartPlant project
status box.
7. Click Merge with SmartPlant.
8. After processing completes, click Close.
9. In SmartPlant Foundation, approve the workflow step to Closeout Tool.
10. In the Drawings and Reports task, retrieve the Project List and verify that the status of all
of the projects is set to Finished.
11. In SmartPlant Foundation, verify that the Claims Report does not contain any project
objects.
After all tools approve the workflow step to Closeout Tool, an automation script
performs an error check. If errors are found, then SmartPlant Foundation initiates the
ProjectCompleteReject workflow and sends additional tasks to the SmartPlant Foundation To
Do List for correction.

Return the status of a project to Active

You can return the status of a project from Complete to Active only when one of the following
conditions applies:
 The selected project is not registered.
 The selected project status is Completed, but the SmartPlant project status is still Active.
1. In the Project Management task, select a model in the Project Management tree.
2. Click Tools > Update Project Status.
3. In the Update Project Status dialog box, select the project in the Project Name list whose
status you want to return to Active.
4. Click Return to Active.
5. After the project status is modified and published, click Close.

 When you click Return to Active, the software queries the SmartPlant status before
modifying the status of the selected project. If the project is registered and the SmartPlant
project status is Completed, the software displays a message informing you that you cannot
return the project status to active.
 After the project status is set to Active, you can update the model with further changes, and
you can regenerate drawings. When the project is ready to complete, follow the steps
outlined in Project Status Update (on page 356).

Project Management User's Guide 359

 Integrated Environment Overview (Smart 3D)

Cancel a project
When the project administrator determines that a project needs to be canceled, the Project
Completion Workflow starts, resulting in a Cancel Project task being displayed in the SmartPlant
Foundation To Do List.
1. Select a model in the Project Management tree view.
2. Click Tools > Update Project Status.
3. In the Update Project Status dialog box, select the name of the project that you want to
cancel.
4. Click Cancel Project.
5. When processing completes, click Close.

 After the project status is cancelled, you must approve the Cancel Project step in the
SmartPlant Foundation To Do List.
 In the Project Management environment, canceling a project releases all claims.
See Also
Update Project Status Dialog Box (on page 355)

Upgrade Schema Command

Updates the existing tool map schemas associated with the active site to a newer version. This
command is primarily used when you are upgrading between major software versions. For more
information about the upgrade of Smart 3D, see the Smart 3D Upgrade Guide.
The tool map schema files are normally write-protected as delivered. Before you execute the
command, ensure that these files in the symbols\xml folder and in the DesignBasisSchemas
subfolder and all associated files are writable.
Backups are made of all files that are processed. To access the command, click SmartPlant >
Upgrade Schema. Upgrade Schema can take several minutes to complete processing.
The following SharedContent file shares are processed:
 SP3DPublishMap.xml - Upgraded to Version 2016 (11.0).
 P3DComponent.xml - Upgraded to Version 2016 (11.0).
 DesignBasis_Map.xml - Copied to the SharedContent folder.

Project Management User's Guide 360

 Integrated Environment Overview (Smart 3D)

Upgrade Schema
1. In Project Management, click a model database in the tree view.
2. Click SmartPlant > Upgrade Schema.

Project Management User's Guide 361

SECTION 17

Project Settings
Provides a set of commands to work with the default style rules in the model database. These
commands are available on the Tools menu as well as the shortcut menu for Model nodes.
 Import (on page 362)
 Export (on page 363)
 Configure Default Colors (on page 364)
 Apply Default Colors (on page 367)

Import
Imports a set of default style rules into a model database. This is useful when you need to port a
set of rules from one model to another.
This command displays the Import Project Settings Dialog Box (on page 363). Use this dialog
box to specify a valid .xml file. Use Export (on page 363) to create this file.

Import default style rules

1. Select a model node.
2. Click Tools > Project Settings > Import.
This command is also available on the shortcut menu when you select a model
node.
The Import Project Settings dialog box displays.
3. Specify the .xml file to import. You can type the file name and location, or click ... to navigate
to the file.
You must create the .xml file using Export (on page 363).
The software displays a message telling you that the import was successful.
Exporting style rules creates .xml and .txt files. The .txt file defines style data and the
.xml file defines the rules for applying the styles. These files are then available for importing the
style rules.

Project Management User's Guide 362

 Project Settings

Import Project Settings Dialog Box

Controls parameters for importing an .xml file containing default style rules. Use Export (on
page 363) to create this file.
Project styles
Specifies the name and location of a default style rules .xml file. You can type the name and
location, or click ... to browse to the file.

Export
Exports a default style rules .xml file. This is useful when you need to port a set of rules from
one model to another.
This command displays the Export Project Settings Dialog Box (on page 363). Use this dialog
box to specify the name and location for the .xml file. Use Import (on page 362) to add the file to
a model.

Export default style rules

1. Select a model node.
2. Click Tools > Project Settings > Export.
This command is also available on the shortcut menu when you select a model
node.
The Export Project Settings dialog box displays.
3. Specify the .xml file to export. You can type the file name and location, or click ... to navigate
to the file.
You can apply the .xml file into a different model using Import (on page 362).
The software displays a message telling you that the export was successful.

Export Project Settings Dialog Box

Controls parameters for exporting an .xml file containing default style rules. Use Import (on
page 362) to apply this file to a different model.
Project styles
Specifies the name and location of a default style rules .xml file. You can type the name and
location, or click ... to browse to the file.

Project Management User's Guide 363

 Project Settings

Configure Default Colors

Defines default style rules for different application objects available in the software. This rule
includes the color for specific object types. You can refine the criteria to a more granular level to
include properties of the object or related object. Objects receive a particular color styling based
on eligible criteria. Because of this, it is referred to as the Default Style Rule.
You must define the rules so that no object satisfies more than one rule.
This command displays the Default Color Configuration Dialog Box (on page 365). The title bar
on this dialog box includes the model on which the command is run and the location of the
model database. The model and database name display to help you keep track of the model for
which you are defining styles.
Configure Default Colors is available for both host and satellite locations. However, the
command is read-only for satellite locations. Because of this, the title bar displays <Location
(read-only)> for satellite locations.
You can only define default style rules for native Smart 3D objects. The software does not
support default style rule definition for Reference 3D or External Reference objects.
You cannot apply surface styles to aspects using Configure Default Colors.

What do you want to do?

 Add a default style rule (on page 364)
 Customize style rules based on role (on page 365)

Add a default style rule

1. Click Insert Row on the Default Color Configuration Dialog Box (on page 365).
Alternatively, click Click here to add new item at the top of the grid.
The software adds a blank row to the grid and sets the focus to the Object Type box.
2. Specify the object type on the Object Type box. If necessary, click ... to display the Select
Object Type Dialog Box (on page 366).
3. Select the color from the Style (Color) list.
4. If necessary, specify additional criteria in the Criteria box. Click ... to display the Filter
Properties Dialog Box (on page 137).
5. After all the rules are defined, click Project Settings > Apply Default Colors.
This is a time-consuming task. The software displays a progress bar indicating the
work accomplished. If necessary, click Stop to end the process when the software
completes the current rule.
To see the newly applied default colors, you must open a new session file.

Project Management User's Guide 364

 Project Settings

Customize style rules based on role

1. Click + next to the row to customize.
2. Click Click here to add new item.
The software displays a list of available designers.
3. Select a role from the Role list.
The list of available designers is based on the Optimization for Role .xml file in the
Shared Content folder. You cannot add a new row without a valid designer.
The software sets the color for the new designer to Default.
4. Select the color from the Color list.
5. After all the rules are defined, click Project Settings > Apply Default Colors.
This is a time-consuming task. The software displays a progress bar indicating the
work accomplished. If necessary, click Stop to end the process when the software
completes the current rule.

Default Color Configuration Dialog Box

Controls parameters for defining default colors for specific object types.
The parameters are applied in the same order as the rules in Format > Surface Style Rules in
a model session file. When an object is created or edited, the object is checked against the rules
starting at the top of this list. When the object matches a style rule, the software assigns that
color and no further checking occurs for the remainder of the list.

Save
Writes the changes you have made to the database. This option is only available after you
have made changes. Changes include adding, deleting, and changing the sequence of
rules.
Insert Row
Adds a row to the dialog box.

Delete
Removes the highlighted rules. You can select multiple rules to delete.
Move Up
Moves the selected rule up one position within the application group.
Move Down
Moves the selected rule down one position within the application group.
Move First
Moves the selected rule to the top of the list within the application group.
Move Last
Moves the selected rule to the bottom of the list within the application group.
Object Type

Project Management User's Guide 365

 Project Settings

Specifies the object type for the rule. Click ... to display the Select Object Type Dialog Box
(on page 366) to browse to the object type. You must specify an object type before you can
specify any other criteria for the default style rule.
Style (Color)
Specifies the color to apply to the object type. The available colors display in the list.
Style Set (Role)
This field is not available when editing default style rules. This option is used when defining
workspace roles. For more information, see Define roles in the Common User's Guide.
Contact Intergraph Support if you want to create style sets for roles.
Criteria
Specifies a filter so that you can create a more specific definition for the default style rule.
Click ... to display the Filter Properties Dialog Box (on page 137) and specify a filter.
The grid displays the default style rules grouped by application. Click to expand a
group. Click to collapse a group.

Select Object Type Dialog Box

Specifies the categories of objects, the feature type, and the component to which you want to
add a ToolTip or label. This dialog box is available for multiple tasks.
In the Common task, you can access this dialog box when you are specifying an object type for
filter properties. You can also access this dialog box when you are editing labels for ToolTips.
When you are working with filter properties or labels, this dialog box opens after you click More
in the Object type box on the Select Properties dialog box. When you are working with
ToolTips, the Select Object Type dialog box opens after you click the browse button on the
ToolTips tab on the Options dialog box.
In the Drawings and Reports task, you can access this dialog box when you use the Edit
Template command on a report template to add properties to a filter query.
In the Project Management task, you can access this dialog box when you use the Configure
Default Colors command to add default style rules.
When the Select Object Type dialog box opens, a tree view lists categories of objects available
in the software. When you double-click an object, the view expands to show the available
feature types. After you select a feature type, another level is available for some categories to
show the component features you can select. For example, double-click HVAC, double-click
HVAC Features, and then click HVAC Transition as the feature, and accept the dialog box.
If objects appear in italics, you cannot select that object on this dialog box. The software uses
your previous selections as the basis for this determination. Italicized text for objects in the
Workspace Explorer indicates the objects are hidden with the Show/Hide options.

Project Management User's Guide 366

 Project Settings

Apply Default Colors

Applies the styling for different objects based on the rules defined by Configure Default Colors
(on page 364). This is a time-consuming task. The software displays a progress bar indicating
the work accomplished. If necessary, click Stop to end the process when the software
completes the current rule.

Project Management User's Guide 367

APPENDIX A

Utilities and Services

You can use the following utilities and services with Project Management.

In This Appendix
Database Wizard ........................................................................... 368
Modify Database and Schema Location ........................................ 396
Database Conversion Wizard ........................................................ 397
Schema Name Validator ................................................................ 405
View Generator .............................................................................. 411
IFC Permissions at Satellite Locations .......................................... 412
Server-Based Interference Checking (Database Detect) .............. 417
Scheduling Project Management Tasks with Batch Services ....... 424
Oracle Role Creation Utility ........................................................... 427

Database Wizard
The Database Wizard utility is external to Project Management. It plays a very important role in
working with databases because prior to using the software, you must create the site, site
schema, catalog, and catalog schema databases using the Database Wizard.
The Database Wizard is located at Start > All Programs > Intergraph Smart 3D > Database
Tools > Database Wizard and is only available when the Server Connectivity option is
installed on the computer.
The site database and schema are containers for the other databases. The site database stores
user access for the model. A site database can have multiple model and catalog databases.
Typically, there is one site database set for each customer location. The catalog database
contains reference data, which includes part dimensions, specifications, and industry standards.
You can create a starting catalog database and schema with the data file delivered with the
software. After creating the catalog database, you can modify the delivered reference data by
editing the delivered Excel workbooks and then using the Bulkload utility to update the catalog
database. You also can use your own custom Excel workbooks and custom symbols to create a
new catalog database specifically for your project. In addition, you can edit catalog data directly
through the catalog user interface.
After you create the databases for site, catalog, and their associated schemas, you can use the
Database > New > New Model (on page 33) command to create the model database. Use Edit
> Regenerate Reports Database (on page 124) to create the Reports database.
For more information about editing reference data, see the Catalog User's Guide. For more
information about editing and bulkloading the Excel workbooks, see the Smart 3D Reference
Data Guide.

Project Management User's Guide 368

 Utilities and Services

Creating Databases for the Site, the Catalog, and their Schemas
When you are satisfied with the settings you have defined for the site and catalog databases,
click Create DB. If you want to make changes, click Back, make your changes, and click Create
DB.
Create DB - Executes the process for creating the site, site schema, catalog, and catalog
schema databases.
After the wizard successfully creates the required databases, you can view a summary page
that displays the name and server location of each of the databases you created. You should
verify that the folder location you specified for the symbols and custom program files has been
shared and assigned with the appropriate access permissions.
When using an Oracle Linux environment, the .bcf file must be on a Windows-based computer
and the database template location must be on the Linux computer where the Oracle service is
running. The account used to run the Oracle service must have write permission to the template
location. Linux is a case sensitive environment. The database template names must be typed as
case sensitive. You must type the Linux folder location. The Browse feature is not available for
navigating to Linux folder locations.

Creating the Model and Reports Databases

After you create the site and catalog databases, along with their respective schema databases,
you can create the model and reports databases using tools in the Project Management task.
First, click Finish to close the Database Wizard, and then open Project Management. Do one,
or more, of the following:
 Create a new model (Oracle model database) (on page 35)
 Create a new model (MS SQL Server model database) (on page 35)
 Create a reports database, using Edit > Regenerate Reports Database (on page 124)
See Also
Create new database objects for SQL (on page 375)
Create new database objects for Oracle (on page 373)
Create site database from an existing catalog for SQL (on page 376)
Create site database from an existing catalog for Oracle (on page 374)
Change the active site database (on page 387)
Change the name generator server for the active site (on page 388)
Restore a site database (on page 380)
Upgrade the site and site schema databases (on page 394)

Project Management User's Guide 369

 Utilities and Services

Create a New Site

Defines the server location and name of the new site and site schema databases.
Because the site database and site schema are containers for the other required databases,
they are the first databases you create after installing the software. The site database stores
work-breakdown and user access for the models. Typically, there is one site database set for
each customer location.

Catalog and Catalog Schema Databases

Optionally, you can create a starting catalog and catalog schema database within the same
workflow using the database template file delivered with the software. The catalog template file
delivered with the software is a backup of an already complete catalog database. It contains the
definition of a default catalog of objects, including specific sizes of pipes, pipe specifications,
steel section sizes, and so forth. After the catalog database is created, you can then bulkload
your customized piping specifications into the catalog database, as needed.

General Information for Creating a New Site (Oracle)

Dump files
The dump files used to create the site and catalog database are delivered on the server
computer to the [Product Folder]\3DRefData\DatabaseTemplates\Model folder. This location
must be shared and write permissions given to both the user login used to create the Smart
3D databases and the account on which the Oracle service (OracleService<SID>) is running
(for example, NT AUTHORITY\SYSTEM). Before proceeding, verify that the share (with the
appropriate permissions) exists on the server computer.
If you are running Oracle on Linux, the database template location must be on the Linux-
based computer where the Oracle service is running. Linux is case sensitive environment.
The database template names (CatalogDB.DMP and AppRepos.DMP) and the folder path
must be typed correctly when creating the database. The Browse feature is not available for
navigating to Linux folder locations.
Log files
The software delivers two log files on the server computer at the local user %temp% folder:
one for the site database generation process and one for the catalog database restore
process.
Naming
You must name the databases with unique entries. To better differentiate between one
database and another, include the type of database in the name you type, such as
Model1SiteDB. Do not use a name that starts with a digit as its first character. For example,
if you typea name such as 1ModelSiteDB, Oracle will not create the database. When you
name the site database, the Oracle service (for the site schema) and site schema name
default to match the Oracle service for the site database and the site database name.
Tablespace
Intergraph recommends that you increase and/or redefine initial tablespace values based on
the expected scope of your project(s). For more information, see your Oracle
documentation.

Project Management User's Guide 370

 Utilities and Services

View errors
During the site database creation process for an Oracle model, the software attempts to
connect to the site database to create the user interface prior to generating the views,
resulting in a "table or view does not exist" error being reported in the various log files.
Because views are generated after the user interface is created, these errors cannot be
avoided. Additionally, these errors do not have any negative impact on using the software
and can be disregarded when reviewing the log files.

Notes for Create Site database and Schema Page (Oracle)

Site database workshare location notes
 This location is the location of the host site database and is required even if the host is not
going to be replicated for worksharing purposes.
 You can use any string that represents your physical location.
 During generation of the site database, the software creates a location object and associates
it with the site database.
Name rule ID notes
 By default, the software leaves this field blank.
 You can type any string identifier, numeric or alpha; however, special characters are not
supported.
 The value typed in the Name rule ID text box functions as a substring (an internal ID
number) that represents the location at which an item is placed into the replicated model.
Name generator server for site notes
 The name generator server must be a valid server running on the Windows domain and one
that has been properly configured to run as a name server.
 The name generator service that runs on the server computer supplies unique names to
items placed in the model database.
 In a replicated configuration, there are multiple servers and multiple instances of the name
generator service running at each location; consequently, there is no way to ensure unique
and sequential naming of placed objects.

Notes for "Catalog Database and Schema" Page (Oracle)

Oracle service list
 The option control at the top of the page allows you either to create a new catalog database
by restoring a backup or use an existing catalog database. If you choose to create a new
catalog database using the Restore option, the wizard will restore the .DMP file specified in
the Template file to be used to create the Catalog database and schema box. The
software delivers one selection for this, CatalogDB.dmp. The default setting is Restore
catalog from backup. If you select Use existing catalog, then no further options are
available.
 If you intend to create a custom catalog, you must select the Use existing catalog option and
use the Bulkload utility delivered with the product.
 If you are running Oracle on Linux, the database template must be on the Linux computer
running the Oracle service. Linux is case sensitive environment. The database template

Project Management User's Guide 371

 Utilities and Services

name CatalogDB.DMP and the folder path must be typed correctly when creating the
database.
Catalog database name
 Also automatically populates the name of the catalog schema database in the Catalog
schema name text box.
Browse
 Located to right of Symbol and custom program file folder.
 The SharedContent share is created automatically on the server during the Smart 3D
Reference Data installation.
 The path in the Symbol and custom program file folder box must be a UNC path. To
obtain a UNC path, click Browse and browse under My Network Places, not under My
Computer.
 If you are running Oracle on Linux, the SharedContent share must be on a Windows-based
computer.

General Information for Creating a New Site (Microsoft SQL-Server)

You must name the databases with unique entries.
Site database workshare location
This location is the location of the host site database and is required even if the host is not
going to be replicated for worksharing purposes. During generation of the site database, the
software creates a location object and associates it with the site database.
Name Generator Service
The Name Generator Service that runs on the server computer you specify in the Name
generator server for site box supplies unique names to items placed in the model
database. In a replicated configuration, there are multiple servers and multiple instances of
the Name Generator Service running at each location; consequently, there is no way to
ensure unique and sequential naming of placed objects. The value typed in the Name rule
ID text box functions as a substring (an internal ID number) that represents the location at
which an item is placed into the replicated model.
Catalog Database and Schema Page
The option control at the top of the page allows you either to create a new vatalog database
by restoring a backup or use an existing vatalog database. If you choose to create a new
vatalog database using the Restore option, the wizard will restore the .DAT file specified in
the Template file to be used to create the Catalog database and schema field. The
software delivers one selection for this field, CatalogDB.dat. The default is to Restore
catalog from backup. If you select Use existing catalog, then no further options are
available.
The CatalogDB.dat template file contains sample Smart 3D reference data
and, while this template contains many useful examples, it is not certified for production use
by Intergraph.
If you intend to create a custom catalog, select the Use existing catalog and use the
Bulkload utility delivered with the product. Alternatively, you can customize your catalog data
using the Catalog task.

Project Management User's Guide 372

 Utilities and Services

Symbols and custom program file folder

The SharedContent is created automatically on the server during the Smart 3D Reference
Data installation. The path in the Symbol and custom program file folder box must be a
UNC path. To obtain a UNC path, click the ellipsis button and browse under My Network
Places, not under My Computer.

What do you want to do?

 Create new database objects for Oracle (on page 373)
 Create site database from an existing catalog for Oracle (on page 374)
 Create new database objects for SQL (on page 375)
 Create site database from an existing catalog for SQL (on page 376)

Create new database objects for Oracle

This procedure is for Oracle databases. Site and catalog database creation requires that you
install the Project Management and Server Connectivity components. You must have the
appropriate server components from Oracle server software installed on the server computer in
order to create the databases.
1. Open the Database Wizard, select Create a new site, and click Next.
2. On the Create Site Database and Schema page, do the following:
a. Select Oracle from the Database type list.
b. In the Oracle service list, select the name of the Oracle net service for the site
database connection.
c. Type the name of your site database in the Site database name text box.
d. Type the workshare location for the site database in the text box.
e. Type a name rule ID in the Name rule ID text box.
f. In the Name generator server for site box, type the name of the server computer on
which the Name Generator Service is installed.
g. Use the default paths for the site database files in the Data tablespace file name and
Index tablespace file name boxes.
h. Click the Browse button to the right of the Template file to be used to create site
schema text box to browse for the name of the dump file (AppRepos.dmp) the software
uses when creating your site schema database. The location of the file is on the
reference data computer at \\[Server Name]\3DRefData\DatabaseTemplates\<model
type>\AppRepos.dmp.
If you are running Oracle on Linux, then the database templates must be on the Linux
computer where the Oracle service is running.
Linux is case sensitive environment. The database template name AppRepos.DMP and
the folder path must be typed correctly when creating the database. The Browse
feature is not available for navigating to Linux folder locations.
3. Click Next.

Project Management User's Guide 373

 Utilities and Services

4. On the Catalog Database and Schema page, do the following:

a. Select the name of the Oracle net service for the catalog database connection in the
Oracle service list.
b. Type the name of your catalog database in the Catalog database name box.
c. Use the default paths for the catalog database files in the Data tablespace file name
and Index tablespace file name boxes.
d. Click Browse to the right of the Symbol and custom program file folder box to
browse for and select the SharedContent folder on the Smart 3D server.
e. Click Browse to the right of the Template file to be used to create catalog database
and schema text box to browse for the name of the dump file (CatalogDB.dmp) you
want the software to use when creating your catalog and schema databases. The
location of the file is on the reference data computer at \\[Server
Name]\3DRefData\DatabaseTemplates\<model type>\CatalogDB.dmp.
If you are running Oracle on Linux, then the database templates must be on the Linux
computer where the Oracle service is running.
Linux is case sensitive environment. The database template name CatalogDB.DMP and
the folder path must be typed correctly when creating the database. The Browse
feature is not available for navigating to Linux folder locations.
5. Click Next.
6. On the Ready to Create Databases page, click Create DB to create your Smart 3D
databases.
7. When the Database Wizard displays the database names that you typed, click Finish.

Create site database from an existing catalog for Oracle

This procedure is for Oracle. Site and catalog database creation requires that you install the
Project Management and Server Connectivity components. You must have the appropriate
server components from Oracle server software installed on the server computer in order to
create the databases. For more information about installing Oracle, see the Installation Guide
available from Help > Printable Guides command in the software.
1. Open the Database Wizard, select Create a new site, and click Next.
2. On the Create Site Database and Schema page, do the following:
a. Select Oracle from the Database type list.
b. In the Oracle service list, select the name of the Oracle net service for the site
database connection.
c. Type the name of your site database in the Site database name text box. Include the
type of database in the name you type. For example, type Model1SiteDB.
d. Type the workshare location for the site database in the Site database workshare
location box. You can use any string that represents your physical location.
e. Type a name rule ID in the Name rule ID text box. By default, the software leaves this
field blank. You can type any string identifier, numeric or alpha; however, special
characters are not supported.

Project Management User's Guide 374

 Utilities and Services

f. In the Name generator server for site box, type the name of the server computer on
which the Name Generator Service is installed.
g. Use the default paths for the site database files in the Data tablespace file name and
Index tablespace file name boxes.
h. Click the Browse button to the right of the Template file to be used to create site
schema text box to browse for the name of the dump file (AppRepos.dmp) the software
uses when creating your site schema database. The location of the file is on the
reference data computer in the [Product
Folder]\\3DRefData\DatabaseTemplates\<model type> folder.
If you are running Oracle on Linux, then the database templates must be on the Linux
computer where the Oracle service is running. Linux is case sensitive environment. The
database template name AppRepos.DMP and the folder path must be typed correctly
when creating the database. The Browse feature is not available for navigating to Linux
folder locations.
3. Click Next.
4. On the Catalog Database and Schema page, select Use existing catalog and click Next.
5. On the Ready to Create Databases page, click Create DB to create your databases.
6. When the Database Wizard displays the site database names that you typed, click Finish.

Create new database objects for SQL

This procedure is for SQL Server databases. Site and catalog database creation requires that
you install the Project Management and Server Connectivity components. You must have the
appropriate server components from Microsoft SQL Server installed on the server computer in
order to create the databases. The user login used to create the databases must be part of the
Administrators group on the local computer and the database server. Other users do not need to
be part of the Administrators group on the local computer in order to run the product.
1. Open the Database Wizard, select Create a new site, and then click Next.
2. On the Create Site Database and Schema page, do the following:
a. Select MSSQL from the Database type list.
b. Select the name of the server in the Site database server list on which your site
database will reside. Only registered SQL Servers appear in the Site database server
list.
c. Type the name of your site database in the Site database name box. Include the type
of database in the name you type, such as Model1SiteDB. When you name the site
database, the site schema server and site schema name default to match the site
database server and name.
d. Type the workshare location for the site database in the Site database workshare
location box. You can use any string that represents your physical location.
e. Type a name rule ID in the Name rule ID text box. You can type any string identifier,
numeric or alpha.
f. Type the name of the server computer on which the Name Generator Service is
configured in the Name generator server for site box. A name server must be a valid

Project Management User's Guide 375

 Utilities and Services

computer running on the Windows domain and one that has been properly configured to
run as a name server.
g. Use the default paths for the site database files in the Physical database and Log file
boxes.
h. Click the ellipsis button to the right of the Template file to be used to create site
schema text box and browse for the name of the template file (AppRepos.dat) the
software uses when creating your site schema database. The location of the file is on
the reference data computer in the [Product Folder]\3DRefData\DatabaseTemplates
folder.
3. Click Next.
4. On the Catalog Database and Schema page, click Restore catalog from backup, and do
the following:
a. Select the name of the server in the Catalog database server list on which your catalog
database will reside.
b. Type the name of your catalog database in the Catalog database name box. This step
also automatically populates the name of your catalog schema database in the Catalog
schema name text box.
c. Use the default paths for the catalog database files in the Physical database and Log
file boxes.
d. Click the ellipsis button to the right of the Symbol and custom program file folder box,
and browse for and select the SharedContent folder on the Smart 3D server.
e. Click the ellipsis button to the right of the Template file to be used to create catalog
database and schema text box and browse for the name of the template file
(CatalogDB.dat) you want the software to use when creating your catalog and schema
databases. The location of the file is on the reference data computer in the [Product
Folder]\3DRefData\DatabaseTemplates\ folder.
The CatalogDB.dat template file contains sample Smart 3D reference
data and, while this template contains many useful examples, it is not certified for
production use by Intergraph.
5. Click Next.
6. On the Ready to Create Databases page, click Next to create your databases.
7. When the Database Wizard displays the database names that you typed, click Finish.

Create site database from an existing catalog for SQL

This procedure is for SQL Server 2014. Site and catalog database creation requires that you
install the Project Management and Server Connectivity components. You must have the
appropriate server components from Microsoft SQL Server installed on the server computer in
order to create the databases. For more information about installing Microsoft SQL Server
software, see the Installation Guide available from Help > Printable Guides. The user login
used to create the Smart 3D databases must be part of the Administrators group on the local
computer and the database server. Other users do not need to be part of the Administrators
group on the local computer in order to run the product. You must name the databases with
unique entries. Write down the names as you proceed.
1. Open the Database Wizard, select Create a new site, and click Next.

Project Management User's Guide 376

 Utilities and Services

2. On the Create Site Database and Schema page, do the following:

a. Select MSSQL from the Database type list.
b. On the Create Site Database and Schema page, select the name of the server in the
Site database server list on which your site database will reside. Only registered SQL
Servers appear in the Site database server list. For more information about registering
a SQL server, see the Installation Guide available from Help > Printable Guides.
c. Type the name of your site database in the Site database name text box. Include the
type of database in the name you type. For example, type Model1SiteDB. When you
name the site database, the site schema server and site schema name default to match
the site database server and name.
d. Type the workshare location for the site database in the Site database workshare
location text box. You can use any string that represents your physical location. This
location is the location of the host site database and is required even if the host is not
going to be replicated for worksharing purposes. During generation of the site database,
the software creates a location object and associates it with the site database.
e. Type a name rule ID in the Name rule ID text box. By default, the software leaves this
field blank. You can type any string identifier, numeric or alpha.
The Name Generator Service that runs on the server computer you specify in the Name
generator server for site box supplies unique names to items placed in the model
database. In a replicated configuration, there are multiple servers and multiple instances
of the Name Generator Service running at each location; consequently, there is no way
to ensure unique and sequential naming of placed objects. The value typed in the Name
rule ID text box functions as a substring (an internal ID number) that represents the
location at which an item is placed into the replicated model.
f. Type the name of the server computer on which the Name Generator Service is
configured in the Name generator server for site box. A name server must be a valid
computer running on the Windows domain and one that has been properly configured to
run as a name server. For more information about installing and configuring the Name
Generator Service, see the Installation Guide available from Help > Printable Guides.
g. Use the default paths for the site database files in the Physical database and Log file
boxes.
h. Click the ellipsis button to the right of the Template file to be used to create site
schema text box and browse for the name of the template file (AppRepos.dat) the
software uses when creating your site schema database. The location of the file is on
the reference data computer in the [Product Folder]\3DRefData\DatabaseTemplates
folder.
3. Click Next.
4. On the Catalog Database and Schema page, select Use existing catalog, and click Next.
5. On the Ready to Create Databases page, click Create DB to create your databases.
6. When the Database Wizard displays the site database names that you typed, click Finish.

Project Management User's Guide 377

 Utilities and Services

Create Site Database and Schema Page

When you create a new site database, you must identify its server location (for SQL Server
databases) or its Oracle net service (for Oracle databases), specify a name, workshare location,
a Name rule ID, and the server computer on which the Name Generator Service is configured.
You must also select the site schema template file, and identify the schema server location and
name.
This page of the Database Wizard is only available as part of the Create a new site
database workflow.
Database type
Specifies the type of database.
Site database server
Sets the server on which the new site database will reside. Only registered SQL Servers
appear in the list. After you select a server for the site database, the Site schema server
box defaults to match that of the site database server. This option appears only if you select
SQL Server in the Database type list.
Oracle service (Site database)
Sets the name of the Oracle net service for the site connection. After you select the Oracle
service, the Oracle service box for the site schema defaults to match that of the site. This
option appears only if you select Oracle in the Database type list.
Site database name
Specifies a name for the new site database. After you type a name for the site database, the
Site schema name field defaults to match the site database name.
Site database workshare location
Specifies a name for the workshare location of the new site database. The workshare
location is the location of the host site database and is required whether or not you intend to
replicate the host site database for worksharing purposes. During generation of the site
database, the software creates a location object and associates it with the site database.
Name rule ID
Applies a name rule ID for the workshare location. You can type any string identifier,
numeric or alpha. The Name Generator Service that runs on the server computer supplies
unique names to items placed in the model database. In a replicated configuration, there are
multiple servers and multiple instances of the Name Generator Service running at each
location; consequently, there is no way to ensure unique and sequential naming of placed
objects. The value typed in the Name rule ID text box functions as a substring (an internal
ID number) that represents the location at which an item is placed into the replicated model.
Name generator server for site
Specifies the name of the computer on which the Name Generator Service is configured. A
name server must be a valid computer running on the Windows domain and one that has
been properly configured to run as a name server. For more information about installing and
configuring the Name Generator Service, see the Installation Guide available from Help >
Printable Guides.
Paths for site database files: Physical database
Identifies the location of the physical database. Unless you specify otherwise, the software

Project Management User's Guide 378

 Utilities and Services

uses the default SQL Server 2014 location. This option appears only if you select SQL
Server in the Database type list.
Paths for site database files: Log file
Identifies the location of the log file for the site. Unless you specify otherwise, the software
uses the default SQL Server 2014 location. This option appears only if you select SQL
Server in the Database type list.
Paths for site database files: Data tablespace file name
Identifies the location of the data tablespace for the site. By default, the text in this field is
Oracle Managed File, which means that tablespace file name will be placed into a
predefined Oracle location. You can edit this field to use an unmanaged file for the
tablespace. If ASM is enabled in Oracle, the text in this field is the disk group name, such as
+Data1 instead of a tablespace file name. This option appears only if you select Oracle in
the Database type list.
Paths for site database files: Index tablespace file name
Specifies the location of the index tablespace for the site. By default, the text in this field is
Oracle Managed File, which means that tablespace file name will be placed into a
predefined Oracle location. You can edit this field to use an unmanaged file for the
tablespace. If ASM is enabled in Oracle, the text in this field is the disk group name, such as
+Data1 instead of a tablespace file name. This option appears only if you select Oracle in
the Database type list.
Template file to be used to create site schema
Specifies or browses to the location of the template file used to build the site schema
database. For SQL Server databases, the template file delivered with the software is on the
server computer in [Product Folder]\3DRefData\DatabaseTemplates\ and is called
AppRepos.dat. For Oracle databases, the template file is AppRepos.DMP.
If you are running Oracle on Linux, then the database templates must be on the Linux
computer where the Oracle service is running.
Linux is a case sensitive environment. The database template name AppRepos.DMP and
the folder path must be typed correctly when creating the database. The Browse feature is
not available for navigating to Linux folder locations.
Site schema server
Identifies the server on which the new site schema database will reside. By default, the
software displays the server location that you specified in the Site database server box.
This option appears only if you select SQL Server in the Database type list.
Oracle service (Site schema)
Sets the name of the Oracle net service for the site schema connection. By default, the
software displays the service that you specified in the Oracle service box for the site
database. This option appears only if you select Oracle in the Database type list.
Site schema name
Identifies the name of the new site schema. By default, the software appends the name you
typed for the site with the word SCHEMA. For example, if you type My_SiteDB as the site
database name, the schema name defaults to My_SiteDB_SCHEMA.
Paths for site schema files: Physical database

Project Management User's Guide 379

 Utilities and Services

Identifies the location of the physical database. Unless you specify otherwise, the software
uses the default MS SQL Server 2014 location. For Oracle databases, this information is
read-only.
Paths for site schema files: Log file
Identifies the location of the log file. Unless you specify otherwise, the software uses the
default MS SQL Server 2014 location. This option appears only if you select SQL Server in
the Database type list.
Paths for site schema files: Data tablespace file name
Identifies the location of the sata tablespace for the site schema. By default, the text in this
field is Oracle Managed File, which means that tablespace file name will be placed into a
predefined Oracle location. You can edit this field to use an unmanaged file for the
tablespace. If ASM is enabled in Oracle, the text in this field is the disk group name, such as
+Data1 instead of a tablespace file name. This option appears only if you select Oracle in
the Database type list.
Paths for site schema files: Index tablespace path
Specifies the location of the index tablespace for the site schema. By default, the text in this
field is Oracle Managed File, which means that tablespace file name will be placed into a
predefined Oracle location. You can edit this field to use an unmanaged file for the
tablespace. If ASM is enabled in Oracle, the text in this field is the disk group name, such as
+Data1 instead of a tablespace file name. This option appears only if you select Oracle in
the Database type list.

Restore a Site from a Backup Set

You use the Database Wizard to reconstruct a previously backed up version of a site database
and its associated metadata to a selected server. The software provides you with some latitude
when restoring the site databases. You can restore the site databases to their original server
location or to an alternative location; you can also restore the databases using their original
names, or you can restore them to a different name.

Restore a site database

1. Open the Database Wizard.
2. On the Introduction to Database Wizard page, select Restore a site from a backup set,
and click Next.
3. On the Create Site Database and Schema page, select the type of database from the
Database type list.
4. For SQL Server databases, use the Destination database server list to select the server
on which you want the restored site database to reside. Only those servers that are
registered with Microsoft SQL Server display in the drop-down list
For Oracle databases, select the name of the Oracle net service in the Oracle service list
for the site database. Only those Oracle local net services that are added with the Oracle
Net Configuration Assistant display in the drop-down list.
5. In the Backup configuration file to restore box, type the location of the configuration file to
be used to restore the site and site schema databases. Click Browse button to navigate to

Project Management User's Guide 380

 Utilities and Services

the folder. If you are running Oracle on Linux, the .bcf file must be on a Windows-based
computer.
6. In the Database backup files are stored on the server in box, type the location of site and
site schema database backup file. Click Browse to navigate to the folder. If you are running
Oracle on Linux, the database backup files must be on the Linux computer where the Oracle
service is running. The Linux account used for the Oracle service must have access to the
folder. Remember that Linux is a case sensitive environment. Folder paths and file names
must have the correct case when typed. The Browse feature is not available for navigating
to Linux folder locations.
7. In the Site database name and Site schema name boxes, type a name for the restored
site and site schema databases. By default, the software populates these fields with the
original site and site schema database names as specified in the backup configuration file. If
you are restoring the site database at a satellite location participating in a Workshare, the
site and site schema databases must be named identically to those that reside at the host
location.
8. In the Site database workshare location box, type the name of the workshare location for
the site database. The workshare location is the location of the host site database and is
required even if the host is not going to be replicated.
9. In the Name generator server for site box, type the name of the server computer on which
the Name Generator Service is configured. A name server must be a valid computer running
on the Windows domain and one that has been properly configured to run as a name server.
For more information about installing and configuring the Name Generator Service, see the
Installation Guide available from Help > Printable Guides.
10. In the Paths for site database and schema files section, check the Use new paths for
physical databases and log files box. If you are not restoring the site and site schema
databases on the same computer that created the backup file, you must type the path
information for that computer.
11. Click Next.
12. On the Ready to Restore Database page, click Next.
13. Click Finish on the Final Instructions Completing the Database Wizard.

 After you have restored the site and site schema databases, you can then restore the
catalog, catalog schema, and model databases using the Restore command in the Project
Management task.
 In order to be restored, the model must exist in the site. If the model was deleted, it cannot
be restored unless the whole site is restored.
 If the backup set you used to restore site and site schema databases was created with a
previous version of the software, you can use the Database Wizard to upgrade the site and
site schema databases to the current software version.

Project Management User's Guide 381

 Utilities and Services

Ready to Restore Databases

If you are satisfied with the settings, click Finish. Otherwise, click Back to change one or more
of the settings. After you restore the site databases, you can use the Restore Wizard (on page
111) in the Project Management task to restore the catalog, catalog schema, and model
databases.
Finish
Executes the process for restoring the site and site schema databases. After the databases
are successfully restored, click Close to exit the Database Wizard.

Restore a Site Database from Backup Page

Database type
Specifies the type of database.
Destination database server
Specifies the server on which the restored site databases is to reside. Only those servers
that are registered with Microsoft SQL Server display in the drop-down list. This option
appears only if you select MSSQL as the database type.
Oracle service
Specifies the name of the Oracle net service for the site database connection. This option
appears only if you select Oracle as the database type.
Local Net Services needs to be added with the Oracle Net Configuration Assistant. See your
Oracle installation documentation for more information. You can also refer to the topic
Configure Oracle Networking Components in the Installation Guide available from Help >
Printable Guides.
Backup configuration file to restore
Identifies or browses to the location of the backup configuration file to be used in restoring
the site and site schema databases. The backup configuration file is the file that was created
during the backup process and lists the paths and names of the backed up files. If you are
running Oracle on Linux, the .bcf file must be on a Windows-based computer.
Database backup files are stored on the server in
Identifies or browses to the folder location where the site and site schema database backup
files are stored. If you are running Oracle on Linux, the database backup location must be
on the Linux computer where the Oracle service is running. The Oracle service account
must have access to this folder. Remember that Linux is a case sensitive environment. You
must type the folder path and file names in the correct case. The Browse feature is not
available for navigating to Linux folder locations.
Site database name
Specifies a name for the restored site database. By default, the software populates this field
with the original site database name as specified in the backup configuration file.
Site schema name
Specifies a name for the restored site schema database. By default, the software populates
this field with the original site schema database name as specified in the backup
configuration file.

Project Management User's Guide 382

 Utilities and Services

Site database workshare location

Specifies a name for the workshare location for the site database. The workshare location is
the location of the host site database and is required regardless of whether the host site
database is going to be replicated.
Name generator server for site
Specifies a name for the server computer on which the Name Generator Service is
configured. A name server must be a valid computer running on the Windows domain and
one that has been properly configured to run as a name server. For more information about
installing and configuring the Name Generator Service, see the Installation Guide available
from Help > Printable Guides.
Use new paths for physical database and log files
Specifies whether to use the default location or new locations for the Physical database
and Log file (for SQL databases) or Data tablespace and Index tablespace (for Oracle
database). If you do not select the checkbox, the software uses the default location.
Physical database
Identifies or browses to the location of the physical database. This field is only editable if you
select the Use new paths for physical database and log files checkbox.
Log file
Identifies or browses to the location of the database log file. This field is only editable if you
select the Use new paths for physical database and log files checkbox. This option
appears only if you select SQL Server in the Database type list.
Data tablespace file name
Identifies or browses to location of the data tablespace for the site. This field is only editable
if you select the Use new paths for physical database and log files checkbox. This option
appears only if you select Oracle in the Database type list.
Index tablespace file name
Identifies or browses to location of the index tablespace for the site. This field is only
editable if you select the Use new paths for physical database and log files checkbox.
This option appears only if you select Oracle in the Database type list.
This page of the Database Wizard is only available as part of the Restore a site
database from a backup set workflow.

Catalog Database and Schema Page

In addition to the site and site schema database, you also need a catalog database in order to
use the software to create a model. Using the Database Wizard, you can restore the sample
catalog that is delivered with the software, or you can use a catalog database that already exists
on the server.
Restore catalog from backup
Creates a new catalog database by restoring a backup of the .DAT file specified in the
Template file to be used to create the Catalog database and schema field.
Use existing catalog already on server
Specifies that you want to create a custom catalog using the Bulkload utility delivered with

Project Management User's Guide 383

 Utilities and Services

the software. For more information about using the Bulkload utility, see the Smart 3D
Reference Data Guide available from Help > Printable Guides. Choosing this option
disables all the text boxes and option buttons on the Catalog Database and Schema page.
Database type
Specifies the type of database.
Catalog database server
Sets the server on which the catalog database will reside. Only registered SQL Servers
appear in the list. After you select a server for the catalog database, the Catalog schema
server field defaults to match the name of the catalog database server. This option appears
only if you select SQL Server in the Database type list.
Oracle service (Catalog database)
Sets the name of the Oracle net service for the catalog database connection. After you
select the Oracle service, the Oracle service box for the catalog schema defaults to match
that of the catalog database. This option appears only if you select Oracle in the Database
type list.
Catalog database name
Specifies a name for the catalog database. After you type a name the catalog database, the
Catalog schema name field defaults to match the catalog database name.
Paths for catalog database files: Physical database
Identifies the location of the physical database. Unless you specify otherwise, the software
uses the default MS SQL Server 2014 location. For Oracle databases, this information is
read-only.
Paths for catalog database files: Log file
Identifies the location of the log file. Unless you specify otherwise, the software uses the
default MS SQL Server 2014 location. This option appears only if you select SQL Server in
the Database type list.
Paths for catalog database files: Data tablespace file name
Identifies the location of the data tablespace for the catalog database. By default, the text in
this field is Oracle Managed File, which means that tablespace file name will be placed into
a predefined Oracle location. You can edit this field to use an unmanaged file for the
tablespace. If ASM is enabled in Oracle, the text in this field is the disk group name, such as
+Data1 instead of a tablespace file name. This option appears only if you select Oracle in
the Database type list.
Paths for catalog database files: Index table space path
Specifies the location of the catalog database index table space. By default, the text in this
field is Oracle Managed File, which means that tablespace file name will be placed into a
predefined Oracle location. You can edit this field to use an unmanaged file for the
tablespace. If ASM is enabled in Oracle, the text in this field is the disk group name, such as
+Data1 instead of a tablespace file name. This option appears only if you select Oracle in
the Database type list.
Symbol and custom program file locations
Specifies the path or browses to the server location of the SharedContent folder and custom
program files. The path in the Symbol and custom program file folder box must be a

Project Management User's Guide 384

 Utilities and Services

UNC path. To obtain a UNC path, click Browse under My Network Places, not under My
Computer. The SharedContent folder is created automatically on the server during the
Smart 3D Reference Data installation. If you are running Oracle on Linux, the
SharedContent folder must be on a Windows-based computer.
Template file to be used to create catalog database and schema
Specifies the template file you want the software to use when creating your catalog and
schema databases. For SQL Server databases, the template file delivered with the software
is located on the reference data computer at [Product
Folder]\3DRefData\DatabaseTemplates. The SQL Server template file is CatalogDB.dat. For
Oracle databases, the template file is CatalogDB.dmp.
If you are running Oracle on Linux, then the database templates must be on the Linux
computer where the Oracle service is running. The account used for the Oracle service must
have access to the folder. Remember that Linux is a case sensitive environment so the
database dump file (CatalogDB.DMP) and the folder path must be typeed in the correct
case. The Browse feature is not available for navigating to Linux folder locations.
The CatalogDB.dat (for MSSQL) and CatalogDB.dmp (for Oracle) template
files contain sample Smart 3D reference data and, while they contain many useful
examples, they are not certified for production use by Intergraph.
Catalog schema server
Identifies the server on which the catalog schema database will reside. By default, the
software displays the server location you specified in the Catalog database server box.
This option appears only if you select SQL Server in the Database type list.
Oracle service (Catalog schema)
Sets the name of the Oracle net service for the catalog schema database connection. By
default, the software displays the service that you specified in the Oracle service box for
the catalog database. This option appears only if you select Oracle in the Database type
list.
Catalog schema name
Identifies the name of the catalog schema database. By default, the software appends the
name you typed for the catalog database with the word SCHEMA. For example, if you type
Catalog_CDB as the database name, the schema name defaults to
Catalog_CDB_SCHEMA.
Paths for catalog schema files: Physical database
Identifies the location of the physical database. Unless you specify otherwise, the software
uses the default MS SQL Server 2014 location. For Oracle databases, this information is
read-only.
Paths for catalog schema files: Log files
Identifies the location of the log file. Unless you specify otherwise, the software uses the
default MS SQL Server 2014 location. This option appears only if you select SQL Server in
the Database type list.
Paths for catalog schema files: Data tablespace file name
Identifies the location of the data tablespace for the catalog schema. By default, the text in
this field is Oracle Managed File, which means that tablespace file name will be placed into
a predefined Oracle location. You can edit this field to use an unmanaged file for the

Project Management User's Guide 385

 Utilities and Services

tablespace. If ASM is enabled in Oracle, the text in this field is the disk group name, such as
+Data1 instead of a tablespace file name. This option appears only if you select Oracle in
the Database type list.
Paths for catalog schema files: Index table space path
Specifies the location of the catalog schema index table space. By default, the text in this
field is Oracle Managed File, which means that tablespace file name will be placed into a
predefined Oracle location. You can edit this field to use an unmanaged file for the
tablespace. If ASM is enabled in Oracle, the text in this field is the disk group name, such as
+Data1 instead of a tablespace file name. This option appears only if you select Oracle in
the Database type list.

New Catalog, Site Name Generator Server, or Existing Site

Using the Database Wizard to select an existing site database (and an associative site schema
database) allows you to change the active site database as an alternative to using the Modify
Database and Schema Location utility. After activation, the site database will display in the
tree view. For more information about changing the active site database, see Change the active
site database (on page 387).
You can also use the Select an Existing Site Database option to create a new catalog
database using the active database and schema location. For more information about creating a
new catalog database in SQL, see Create a new catalog in the active site SQL Server database
(on page 391). If you are using Oracle, see Create a new catalog in the active site Oracle
database (on page 389). Additionally, you can use this option to change the name generator
server for the active site database. For more information, see Change the name generator
server for the active site (on page 388).
For more information about loading information into a new catalog, see the Reference
Data Guide available from Help > Printable Guides.

What do you want to do?

 Change the active site database (on page 387)
 Change the name generator server for the active site (on page 388)
 Create a new catalog in the active site Oracle database (on page 389)
 Create a new catalog in the active site SQL Server database (on page 391)

Project Management User's Guide 386

 Utilities and Services

Change the active site database

1. Open the Database Wizard.
2. Select Create a New Catalog, Select Name Generator Server for Site, or Select an
Existing Site, and then click Next.
3. On the Create Site Database and Schema page, select the type of database from the
Database type list.
4. For SQL Server databases, select the name of the server in the Site database server list
on which the site database currently resides. For Oracle databases, select the name of the
Oracle net service in the Oracle service list for the site database.
Only registered SQL Servers appear in the Site database server list. For more
information about registering a SQL server, see the Installation Guide available from Help >
Printable Guides.
5. In the Site database name list, select the site database to activate. The software populates
the Site database workshare location, the Name rule ID, and the Name generator
server for site boxes with the appropriate information.
The software populates the Site database workshare location, Name rule ID, and
Site database name server boxes with information as it was defined during the initial
creation of the site database you select for activation. Because the Name Generator Service
can be configured on multiple server computers, you can specify an alternative name server
in the Site database name server box. The other two boxes are read-only.
6. For SQL Server databases, select the name of the server in the Site schema server list on
which the site schema database currently resides. For Oracle databases, select the name of
the Oracle net service in the Oracle service list for the site schema database.
7. In the Site schema name list, select the site schema database you want to activate.
8. Click Next.
9. On the Catalog Database and Schema page, select Use existing catalog already on
server.
10. Click Next.
11. On the Ready to Activate Selected Site Database page, click Finish to activate the site
databases you selected.
12. When the Database Wizard displays the database names that you typed, click Finish.

 After the site database is activated, click Close to exit the Database Wizard.
 You use the New Model command in the Project Management task to create a new model
database. Part of the process includes selecting the catalog database you want to associate
with the new model. When using SQL databases, see Create a new model (MS SQL Server
model database) (on page 35). If using Oracle, see Create a new model (Oracle model
database) (on page 35).

Project Management User's Guide 387

 Utilities and Services

Change the name generator server for the active site

1. Open the Database Wizard.
2. Select Create a New Catalog, Select Name Generator Server for Site, or Select
Existing Site, and then click Next.
3. On the Create Site Database and Schema page, select the type of database from the
Database type list.
4. For SQL Server databases, select the name of the server in the Site database server list
on which the site database currently resides. For Oracle databases, select the name of the
Oracle net service in the Oracle service list for the site database.
If using SQL Server databases, only registered SQL Servers appear in the Site
database server list. For more information about registering a SQL server, see the
Installation Guide available from Help > Printable Guides.
5. In the Site database name list box, select the name of the active site database. The
software populates the Site database workshare location, the Name rule ID, and the
Name generator server for site boxes with the information as it was defined during the
initial creation of the site database you select.
6. For SQL Server databases, select the name of the server in the Site schema server list on
which the site schema database currently resides. For Oracle databases, select the name of
the Oracle net service in the Oracle service list for the site schema database.
7. In the Site schema name list box, select the name of the active site schema database.
8. In the Name generator server for site box, type the name of the server computer on which
the Name Generator Service is installed.
A name server must be a valid server running on the Windows domain and one
that has been properly configured to run as a name server.
9. Click Next.
10. On the Catalog Database and Schema page, select Use existing catalog already on
server.
11. Click Next.
12. On the Ready to Activate Selected Site Database page, click Finish to activate the site
databases you selected.
13. When the Database Wizard completes processing, click Finish.

Project Management User's Guide 388

 Utilities and Services

Create a new catalog in the active site Oracle database

This procedure is for Oracle You must have the appropriate server components from Oracle
server software installed on the server computer in order to create the databases. For more
information about installing Oracle, see the Installation Guide, available from Help > Printable
Guides.
The dump files used to create the site and catalog database are delivered on the
reference data computer to [Product Folder]\3DRefData\DatabaseTemplates. This location must
be shared and write permissions given to both the user login used to create the Smart 3D
databases and the account on which the Oracle service (OracleService<SID>) is running.
Before proceeding, verify that the share (with the appropriate permissions) exists on the server
computer.
If you are running Oracle on Linux, the database dump file must be on the Linux computer
where the Oracle service is running. The account used for the Oracle service must have access
to the folder. The Browse feature is not available for navigating to Linux folder locations.
1. Open the Database Wizard.
2. Click Select an existing site database (Choose which will be active in Project
Management tree view), and then click Next.
3. On the Create Site Database and Schema page, select Oracle from the Database type
list.
4. In the Oracle service list, select the name of the Oracle net service for the site database
connection.
5. In the Site database name list box, select the site database to activate. The software
populates the Site database workshare location, Name rule ID, and Site database name
server boxes with information as it was defined during the initial creation of the site
database you select for activation. Because the Name Generator Service can be configured
on multiple server computers, you can specify (optionally) an alternative name server in the
Site database name server box. The other two boxes are read-only.
6. Select the name of the Oracle net service for the site schema database connection in the
Oracle service list.
7. In the Site schema name list box, select the site schema database you want to activate.
8. Click Next.
9. On the Catalog Database and Schema page, select the name of the Oracle net service for
the catalog database connection in the Oracle service list.
10. Type the name of your catalog database in the Catalog database name box. This step also
automatically populates the name of the catalog schema database in the Catalog schema
name text box.
11. Use the default paths for the catalog database files in the Physical database box.
12. Click the Browse button to the right of the Symbol and custom program file folder box to
browse for and select the SharedContent folder on the reference data server (usually the

Project Management User's Guide 389

 Utilities and Services

database server). However, if you are running Oracle on Linux, the SharedContent folder
must be on a Windows-based computer.

 The SharedContent folder is created automatically on the server during the Smart 3D
Reference Data installation.
 The path in the Symbol and custom program file folder box must be a UNC path. To
obtain a UNC path, click the Browse button, and browse under My Network Places,
not under My Computer.
13. Click Browse to the right of the Template file to be used to create catalog database and
schema text box to browse for the name of the dump file (CatalogDB.DMP) you want the
software to use when creating your catalog and schema databases. The location of the file
is on the reference data computer at [Product
Folder]\3DRefData\DatabaseTemplates\<model type>\CatalogDB.DMP.
If you are running Oracle on Linux, the CatalogDB.DMP file must be on the Linux computer
where the Oracle service is running. The Oracle service user account must have access to
the folder. Remember that Linux is a case sensitive environment. The folder path and file
name must be typed using the correct case. The Browse feature is not available for
navigating to Linux folder locations.
14. Click Next.
15. On the Ready to Load Databases page, click Finish.
16. When processing completes, click Close.

 During the site database creation process for an Oracle model, the software attempts to
connect to site database to create the user interface prior to generating the views, resulting
in a "table or view does not exist" error being reported in the various log files. Because views
are generated after the user interface is created, these errors cannot be avoided.
Additionally, these errors do not have any negative impact on using the software and can be
disregarded when reviewing the log files.
 You use the Database > New > Model command in the Project Management task to create
a new model database. Part of the process includes selecting the catalog database you
want to associate with the new model. When using Oracle, see Create a new model (Oracle
model database) (on page 35). For more information, see Create a new model (MS SQL
Server model database) (on page 35).

Project Management User's Guide 390

 Utilities and Services

Create a new catalog in the active site SQL Server database

This procedure is for SQL Server 2014.
1. Open the Database Wizard.
2. Select Create a New Catalog, Select Name Generator Server for Site, or Select an
Existing Site, and then click Next.
3. On the Create Site Database and Schema page, select MSSQL from the Database type
list.
4. Select the name of the server in the Site database server list on which the site database
currently resides.
Only registered SQL Servers appear in the Site database server list. For more
information about registering a SQL server, see the Installation Guide available from Help >
Printable Guides.
5. In the Site database name list box, select the site database to activate. The software
populates the Site database workshare location, Name rule ID, and Site database name
server boxes with information as it was defined during the initial creation of the site
database you select for activation. Because the Name Generator Service can be configured
on multiple server computers, you can specify (optionally) an alternative name server in the
Site database name server box. The other two boxes are read-only.
6. Select the name of the server in the Site schema server list on which the site schema
database currently resides.
7. In the Site schema name list box, select the site schema database you want to activate.
8. Click Next.
9. On the Catalog Database and Schema page, select Restore catalog from backup.
10. Type the name of your catalog database in the Catalog database name box. This step also
automatically populates the name of your catalog schema database in the Catalog schema
name text box.
11. Use the default paths for the catalog database files in the Physical database and Log file
boxes.
12. Select the ellipsis button to the right of the Symbol and custom program file folder box,
and browse for and select the SharedContent folder on the Smart 3D server.

 The SharedContent folder is created automatically on the server during the Smart 3D
Reference Data installation.
 The path in the Symbol and custom program file folder box must be a UNC path. To
obtain a UNC path, click the ellipsis button and browse under My Network Places, not
under My Computer.
13. Select the ellipsis button to the right of the Template file to be used to create catalog
database and schema text box and browse for the name of the template file
(CatalogDB.dat) you want the software to use when creating your catalog and schema
databases. The location of the file is on the reference data computer in [Product
Folder]\3DRefData\DatabaseTemplates\.

Project Management User's Guide 391

 Utilities and Services

The CatalogDB.dat template file contains sample Smart 3D reference data

and, while this template contains many useful examples, it is not certified for production use
by Intergraph.
14. Click Next.
15. On the Ready to Load Databases page, click Finish.
16. When processing completes, click Close.

 You use the New Model command in the Project Management task to create a new model
database. Part of the process includes selecting the catalog database you want to associate
with the new model. When using SQL databases, see Create a new model (MS SQL Server
model database) (on page 35). For more information, see Create a new model (MS SQL
Server model database) (on page 35).
 For more information about loading information into a new catalog, see the Smart 3D
Reference Data Guide available from Help > Printable Guides.

Ready to Activate Existing Site Database

If you are satisfied with the settings you have defined for the site and catalog databases, click
Finish to activate the site and site schema databases. Otherwise, click Back to change one or
more of the settings. After the Database Wizard has activated the site and site schema
database you selected, you can use the New Model (on page 33) command to create the model
and reports databases and specify the catalog database you want to associate with the new
model.
This page of the Database Wizard is only available when you choose Use existing
catalog already on server on the Catalog Database and Schema page of the Select an
existing site database (Choose which will be active in Project Management tree view)
workflow.
Finish
Executes the process for activating the specified site and site schema databases.

Select Site Database and Schema Page

When you change which site database is active, you must identify either the server location for
SQL Server databases or the Oracle net service for Oracle databases and name of the site
database you want to activate. You must also specify the name and server location of its
associative schema.
This page of the Database Wizard is only available as part of the Select an existing site
database workflow.
Database type
Specifies the type of database.
Site database server
Sets the server on which the site database you want to activate currently resides. Only
registered SQL Servers appear in the drop-down list. After you select a server for the site
database, the Site schema server box defaults to match that of the site database server.
This option appears only if you select SQL Server in the Database type list.

Project Management User's Guide 392

 Utilities and Services

Oracle service (1)

Specifies the name of the Oracle net service for the site database connection. After you
select the Oracle service, the Oracle service box for the site schema defaults to match that
of the site database. This option appears only if you select Oracle in the Database type list.
Site database name
Sets the site database you want to activate. When you select the database, the software
automatically populates the Site database workshare location and Name rule ID fields
with the information that was defined for the specified database during its initial creation.
Site database workshare location
Displays the workshare location defined for the selected site database during its initial
creation. This information is read-only.
Name rule ID
Displays the name rule ID of the selected site database as defined during its initial creation.
This information is read-only.
Site schema server
Identifies the server on which the site schema database to activate resides. By default, the
software displays the server location that you specified in the Site database server box.
This option appears only if you select SQL Server in the Database type list.
Oracle service (2)
Specifies the name of the Oracle net service for the site schema database connection. By
default, the software displays the service that you specified in the Oracle service box for
the site database. This option appears only if you select Oracle in the Database type list.
Site schema name
Sets the site schema database you want to activate.
Name generator server for site
Displays the name of the server computer (as defined during the initial creation of the site
database) on which the Name Generator Service is configured. You can specify an
alternative server computer; however, it must be a valid computer running on the Windows
domain and one that has been properly configured to run as a name server. For more
information about installing and configuring the Name Generator Service, see the
Installation Guide available from Help > Printable Guides.

Upgrade a Site Database

When upgrading your databases to the latest installed version of the software, the site database
and its associated metadata must be upgraded first using the Database Wizard. The process
involves specifying the server location and the names of the site and site schema databases
that you want to upgrade. After you have successfully upgraded those two databases, you can
then proceed with the other tasks involved in migrating your other Smart 3D data.
You cannot upgrade the site database if any model associated with the site database
contains a PDS reference. Before upgrading the site database, we recommend you to remove
the PDS references from all the models associated with the site database.

Project Management User's Guide 393

 Utilities and Services

Upgrade the site and site schema databases

Intergraph recommends that you back up the databases prior to beginning the upgrade process.
For more information, see Create a backup file (on page 99).
If you are upgrading the site and site schema databases from a backup set, you must first
restore them. For more information, see Restore a site database (on page 380).
1. Select Start > All Programs > Intergraph Smart 3D > Database Tools > Database
Wizard
2. On the Introduction to Database Wizard page, select Upgrade site and its schema to
your currently installed version.
3. Click Next.
4. On the Create Site Database and Schema page, select the type of database from the
Database type list.
5. For SQL Server databases, select the name of the server in the Site database server list
on which the site database currently resides.
For Oracle databases, select the name of the Oracle net service in the Oracle service list
for the site database.
Only registered SQL Servers appear in the Site database server list. For more
information about registering a SQL server, see Register the Microsoft SQL Server in the
Installation Guide available from Help > Printable Guides command in the software.
6. In the Site database name list, select the site database you want to upgrade.
7. For SQL Server databases, select the name of the server in the Site database server list
on which the site database currently resides.
For Oracle databases, select the name of the Oracle net service in the Oracle service list
for the site schema database.
8. In the Site schema name list, select the name of the site schema database you want to
upgrade, and click Next.
9. On the Ready to Update Databases page, click Finish to begin the upgrade process.
The Status section displays informational messages regarding the progress of the
upgrade process.
10. When the upgrade process is complete, click Done to close the Database Wizard.
A log file, SiteMigration.log, is generated during the upgrade process and is delivered
locally to C:\Documents and Settings\<your_user_name>\Local Settings\Temp.

Project Management User's Guide 394

 Utilities and Services

Select Site Database and Schema to Upgrade Page

The process of upgrading the site databases to the currently installed version of the software
involves specifying the server location and names of the site and site schema databases to be
upgraded.
This page of the Database Wizard is only available as part of the Upgrade site
database and its schema to your currently installed version workflow for the site and site
schema databases.
Database type
Specifies the type of database.
Site database server
Sets the server on which the new site database will reside. Only registered SQL Servers
appear in the drop-down list. After you select a server for the site database, the Site
schema server box defaults to match that of the site database server. This option appears
only if you select SQL Server in the Database type list.
Oracle service (Site database)
Specifies the name of the Oracle net service for the site database connection. After you
select the Oracle service, the Oracle service box for the site schema defaults to match that
of the site database. This option appears only if you select Oracle in the Database type list.
Site database name
Specifies a name for the new site database. After you type a name for the site database, the
Site schema name field defaults to match the site database name.
Site schema server
Identifies the server on which the new site schema database will reside. By default, the
software displays the server location that you specified in the Site database server box.
This option appears only if you select SQL Server in the Database type list.
Oracle service (Site schema)
Specifies the name of the Oracle net service for the site schema database connection. By
default, the software displays the service that you specified in the Oracle service box for
the site database. This option appears only if you select Oracle in the Database type list.
Site schema name
Identifies the name of the new site schema database. By default, the software appends the
name you typed for the site database with the word SCHEMA. For example, if you type
SiteName_SDB as the site database name, the schema name defaults to
SiteName_SDB_SCHEMA.
Next
Takes you to the Ready to Upgrade Databases page of the wizard.

Project Management User's Guide 395

 Utilities and Services

Ready to Update Databases Page

Displays the information that you defined for upgrading the site and site schema databases. The
Version box display the current version number of the site and site schema databases being
upgraded. Review these settings carefully. If you are satisfied with the settings, click Finish.
Otherwise, click Back to change one or more of the settings.
Finish
Executes the upgrade process, during which the Status section displays informational
messages regarding the progress of the upgrade process. When the process completes, the
Status section displays an Upgrade is complete message, and the version number in the
site and site schema databases Version box will update to match the latest installed version
of the software.
A log file, SiteMigration.log, is generated during the upgrade process and is delivered
locally to the Temp folder.

Modify Database and Schema Location

The Modify Database and Schema Location utility defines which site database to connect to
when using Project Management or Smart 3D.
Database type
Specifies the database provider.
Site database server
Specifies the name of the site database server. The database server must be registered on
this computer using SQL Server Management Studio before you can select it from this list.
This option is only available if you are using SQL Server.
Oracle service name
Specifies the Oracle instance name. This option is only available if you are using Oracle.
Site database name
Specifies the site database to work with.
Site schema server
Specifies the name of the site schema database server. This is read from the site database
and cannot be edited. This option is only available if you are using SQL Server.
Oracle service name
Specifies the name of the site schema database server. This is read from the site database
and cannot be edited. This option is only available if you are using Oracle.
Site schema name
Specifies the name of the site schema database. This is read from the site database and
cannot be edited.

Project Management User's Guide 396

 Utilities and Services

Database Conversion Wizard

The Database Conversion Wizard is a separate utility delivered with the Project Management
task in the [Product Folder] \Core\Container\Bin\Assemblies\Release folder as
S3DDBConvertWizard.exe. You can use the utility to convert a Smart 3D Microsoft SQL Server
database to an Oracle database, or to convert a Smart 3D Oracle database to a Microsoft SQL
Server database. The utility runs independently of the Project Management task.
The utility supports these database conversions:
 Site and site schema from SQL Server to Oracle or from Oracle to SQL Server.
 Catalogs and catalog schemas from SQL Server to Oracle or from Oracle to SQL Server.
 Models from SQL Server to Oracle or from Oracle to SQL Server.

 You must run database integrity and clean all corrupted objects that are of fatal or crucial
severity before running database conversion on a source database.
 You can convert all Smart 3D databases at the same time; however, if you choose to
convert databases separately, the databases must be converted in the following order:
a. Site and site schema
b. Catalogs and catalog schemas
c. Models
 All users must be logged out of the source databases. No one can access or change the
source databases during the conversion process.
The conversion process generates two log files in the Temp folder:
 ConvertDBStatus.log - Shows source and target database details, conversion status, and
validation of converted databases. This file indicates whether there is any mismatch in the
count of rows in the source and target databases.
 ConvertDBError.log - Shows conversion errors, if any exist.

Limitations
When converting databases, you must be aware of the following limitations:
 This utility supports only non-replicated databases. The replicated databases must be
consolidated before conversion.
 If you are converting a SQL Server database to Oracle, the name of the target Oracle
database must not exceed 30 characters or start with a numeric character.
 If you are converting a SQL Server database to Oracle, Oracle database table names, view
names, and column names must not exceed 30 characters or start with a numeric character.
If any table name or column name exceeds 30 characters or starts with a numeric character,
the software logs a warning message in the conversion log file.
 Reports under a drawing snap-in that have parametric inputs (asking filters) must be
redefined.

Project Management User's Guide 397

 Utilities and Services

 Custom reports have to be written to support both SQL Server and Oracle SQL query
statements. SQL query statements written only to work for SQL Server must be rewritten to
work with Oracle. Likewise, Oracle query statements written only to work with Oracle must
be rewritten to work with SQL.
 If a table only contains data created by a data-validation task, such as Database Integrity or
Verify Consistency Report, then such tables are not converted. You must run these tasks
again on the converted databases to get the latest information. All batch jobs that were
created before conversion must be recreated after conversion.

What do you want to do?

 Convert a Smart 3D Oracle database to SQL Server (on page 398)
 Convert a Smart 3D SQL Server database to Oracle (on page 399)
 Modify the interface names of the target database (on page 400)

Convert a Smart 3D Oracle database to SQL Server

 You must run database integrity and clean all corrupted objects that are of fatal or crucial
severity before running database conversion on a source database.
 You can convert all Smart 3D databases at the same time; however, if you choose to
convert databases separately, the databases must be converted in the following order:
a. Site and site schema
b. Catalogs and catalog schemas
c. Models
 All users must be logged out of the source databases. No one can access or change the
source databases during the conversion process.
1. Open the Database Conversion Wizard by clicking Start > All Programs > Intergraph
Smart 3D > Database Tools > Database Conversion Wizard.
2. On the Source and Target Databases page, the source database is set by default to the
database to which you are connected.
If you need to change the source database, you must use the Modify Database
and Schema Location utility. You cannot change the source database in this wizard.
3. On the Server Mapping Information page, review and update if needed, the server
mapping information, and select the databases to be converted. Click Next.
4. On the Conversion Details page, review the conversion settings you have defined, and
click Next.
5. Click Convert.
The Conversion Status page shows the conversion process and conversion errors, if any.
The conversion status information is also written to the log file.
6. Click Close to exit the wizard when the conversion is complete.
7. Review conversion log files in the Temp folder, and correct conversion errors.

Project Management User's Guide 398

 Utilities and Services

 ConvertDBStatus.log - Shows source and target database details, conversion status,

and validation of converted databases. This file indicates whether there is any mismatch
in the count of rows in the source and target databases.
 ConvertDBError.log - Shows conversion errors, if any exists.

Convert a Smart 3D SQL Server database to Oracle

 You must run database integrity and clean all corrupted objects that are of fatal or crucial
severity before running database conversion on a source database.
 You can convert all Smart 3D databases at the same time; however, if you choose to
convert databases separately, the databases must be converted in the following order:
a. Site and site schema
b. Catalogs and catalog schemas
c. Models
 All users must be logged out of the source databases. No one can access or change the
source databases during the conversion process.
1. Open the Database Conversion Wizard by clicking Start > All Programs > Intergraph
Smart 3D > Database Tools > Database Conversion Wizard.
2. On the Source and Target Databases page, the source database is set by default to the
database to which you are connected.

 If you need to change the source database, you must use the Modify Database and
Schema Location utility. You cannot change the source database in this wizard.
 The name of the target Oracle database must not exceed 30 characters or start with a
numeric character.
3. On the Server Mapping Information page, review and update, if needed, the server
mapping information, and select the databases to be converted. Click Next.
4. On the Conversion Details page, review the conversion settings you have defined, and
click Next.
5. Click Convert.
The Conversion Status page shows the conversion process and conversion errors, if any.
The conversion status information is also written to the log file.
6. Click Close to exit the wizard when the conversion is complete.
7. Review conversion log files in the Temp folder, and correct conversion errors.
 ConvertDBStatus.log - Shows source and target database details, conversion status,
and validation of converted databases. This file indicates whether there is any mismatch
in the count of rows in the source and target databases.
 ConvertDBError.log - Shows conversion errors, if any exists.
Conversion errors caused by table or column names exceeding 30 characters or
starting with a numeric character can be resolved by modifying the interface names of the

Project Management User's Guide 399

 Utilities and Services

target database. For more information, see Modify the interface names of the target
database (on page 400).

Modify the interface names of the target database

If any table name or column name exceeds 30 characters or starts with a numeric character, the
software displays a warning message similar to the following example:
WARNING:
Invalid View Name: JCURTEPipingSpecialtyStockPartDataO
Identifier has too many (35) characters for Oracle
View for interface: JCURTEPipingSpecialtyStockPartDataO
Belonging to package: UDP
Cannot be generated
In this example, the interface name is more than 30 characters.
You can use the following procedure to change the interface names of the target database and
resolve such errors:
1. Preserve the interface IID or the OID of interface with the invalid name for conversion. You
can get the IID using MetaDataBrowser.exe to connect to the catalog schema.
2. Delete the interface using Bulkload.exe. Make sure that you have enabled the update object
type hierarchy and catalog views in Bulkload.exe.

3. Modify the InterfaceName to comply with the Oracle limitations. You can also modify the
AttributeName, if required, as shown below.

AttributeUserName and SymbolParameter must be the same as the source

database interface properties.
4. Modify the part class definition and part definition that implements the new interface to
reflect the updated attribute names in the occurrence properties, as shown below.

Project Management User's Guide 400

 Utilities and Services

5. Update the GUIDs sheets for the updated interface and properties.

 The GUID of the updated interface must be identical to that of the source database
interface, as shown below.
 The DispID of properties must not be changed.

6. Bulkload the sheet in Add/Modify/Delete mode using Bulkload.exe. Make sure that you have
enabled the update object type hierarchy and catalog views in Bulkload.exe. For more
information about using the Bulkload.exe utility, see Loading Reference Data into the
Catalog in the Smart 3D Reference Data Guide.
7. When the bulkload process is complete, review the bulkload output log file, and verify that
there are no failures related to the above changes.
8. Regenerate the views for catalog and model using ViewGenerator.exe. Make sure that the
updated view is generated in catalog and model database.
9. Regenerate the report database.

Database Conversion Wizard

Converts a Smart 3D Microsoft SQL Server database to an Oracle database, or converts a
Smart 3D Oracle database to a Microsoft SQL Server database.
See Also
Source and Target Databases (on page 402)
Server Mapping Information (on page 403)
Conversion Details (on page 404)
Conversion Status (on page 405)

Project Management User's Guide 401

 Utilities and Services

Source and Target Databases

Defines the source database to convert and the location of the target database. You cannot
change the location of the source database. You must use the Modify Database and Schema
Location (on page 396) utility to select the source database.

Source Database Details

Site database
Displays the source site database to which you are currently connected.
Site schema database
Displays the source site schema database to which you are currently connected.
Server or service name
Displays the database server name on which the source site and site schema exists.
Database provider
Displays the source database provider.
Name generator server site
Displays the server name on which the name generator service that the source site
database uses is located.

Target Database Details

Site database
Specifies the target site database name after converting. The default is the same name as
the source site database.
If you are converting a Smart 3D Microsoft SQL Server database to Oracle, the
name of the target Oracle database must not be more than 30 characters or start with a
numeric character.
Site schema database
Specifies the target site schema database name after converting. The default is the same
name as the source site schema database.
Server or service name
Select the target database server on which the site and site schema database will be
created.
Database provider
Displays the target database provider.
Name generator server site
Specifies the server name running the name generator service to associate with the
converted site database.

Project Management User's Guide 402

 Utilities and Services

Server Mapping Information

Defines the database objects for the target databases. Database names for the model and
catalog databases can be customized to suit your needs.
The Server Mapping Information cells customize the servers associated to the site database
objects. Databases to be converted can be identified by specifying Create or Overwrite in the
Selection column, and databases that do not need to be converted can be identified by
specifying Ignore.

 You must run database integrity and clean all corrupted objects that are of fatal or crucial
severity before running database conversion on a source database.
 You must convert the site before you convert catalogs and models. If the site is set to be
ignored in the conversion process, the software checks whether the site is available on the
target server and compares the source and destination site databases to know if it is a
converted database. If any check fails, you cannot proceed any further.
 You must convert catalogs before you convert models. If a catalog is set to be ignored in the
conversion process, the software checks whether the catalog is available on the target
server. If the corresponding catalog is not available on the target server, you cannot proceed
any further.
 By default, if the source database has more than one location object, all the locations are
mapped to the target server that you have defined on the Source and Target Databases (on
page 402) page. You cannot change the host location server name, but are required to
change the server names for the other locations. The host location should not match the
other location servers.

Server mapping information

Type
Displays the object type as defined in the site database, for example: Location, Model,
Catalog, and so forth. This cell is read-only.
Source Name
Displays the name of the object in the source site database. This cell is read-only.
Target Name
Specifies the name of the object in the target site database after conversion. Double-click
the cell to type the target name.
Existing Server or Service
Displays the server name on which the source object exits. This cell is read-only.
Target Server or Service
Specifies the server name on which the target object is created. Double-click the cell to
select from the registered servers.

Project Management User's Guide 403

 Utilities and Services

Select the databases that need to be converted

Type
Displays the database type, for example: Site, Model, or Catalog.
Name of Database
Specifies the name of the database after conversion. The default is the source database
name.
If you are converting a Smart 3D Microsoft SQL Server database to Oracle, the
name of the target Oracle database must not be more than 30 characters or start with a
numeric character.
Schema Database Associated to Database
Specifies the schema database name associated to the name of database after conversion.
Selection
Specifies whether to convert the database. Select Create/Overwrite to create the new
database with the specified name and overwrite any existing database with the same name
on the selected target server. Select Ignore to exclude the database from further
processing.

Conversion Details
Displays the complete details of the conversion process that is about to be run. Review the
details carefully. If you need to make any changes, click Back.
Type
Displays the database type.
Source
Displays the source database name.
Source Server
Displays the source database server name.
Target
Displays the target database name. This is the name of the database after the conversion.
Target Server
Displays the name of the server on which the target database is created.
Status
Displays whether the database is converted.

Project Management User's Guide 404

 Utilities and Services

Conversion Status
Displays the conversion status, log files, and any errors. Click Convert to convert the
databases. Click Close to exit the wizard.

Schema Name Validator

The bulkload data files are common to both MSSQL and Oracle databases. However, Oracle
has a 30 character naming constraint in the code as well as in the delivered catalog data. For
cases in which you are not using the default delivered catalog, you can use the Schema Name
Validator application to identify and correct these names in the databases.
This utility identifies part classes, custom interfaces, and custom interface attributes that violate
the Oracle character limitation. This allows you to bulk load the data into an Oracle database, as
long as the changes are updated in the bulkload data files. This is particularly useful when
converting MSSQL databases to Oracle databases.
This utility is delivered by default to the SchemaNameValidator.exe file in the <Product
Folder>\Core\Container\Bin\Assemblies\Release\ folder.

Prerequisites
 Microsoft Office 2010 or later.
 SQL Server 2008 or later.
 Smart 3D version 2016 or later.

Impacts
 You must update any custom code such as shared content or reports so that they use the
truncated part class, custom interface, and attribute names.
 You must update the changed names in the code for custom symbols, if they are used.
 You must update all data files (such as Excel workbooks) so that they use the new names.
The names in GUIDs sheets must be replaced to ensure that the GUID values associated
with the old and new names are identical. You must update the GUID sheets to avoid errors
in future bulk loads.

After Updating
 Update all data files, reports, and shared content code with the truncated names.
 Regenerate views on all of the model databases.
 Run Synchronize model with catalog with the Regenerate views option selected on all of
the projects. For more information, see Synchronize Model with Catalog (on page 117).
 Regenerate the reports database for each model database. For more information, see
Regenerate Reports Database (on page 124).

Automatically Filling in Truncated Names

If you type values in the Truncated Names column in an input file, and specify that file in the
Map file location box on the Schema Name Validator dialog box, the utility can automatically

Project Management User's Guide 405

 Utilities and Services

fill in those names as appropriate when you generate the report. For more information, see
Report Workbook (on page 406), and Schema Name Validator Dialog Box (on page 408).

Report Workbook
The report workbook has the following worksheets. The worksheets display the details for the
data present in the catalog and side databases.

Worksheet Name Database Type of Data Reported

Index General information Displays information about the server,

databases, computer, and user name.

CDB_Attributes Catalog database Displays attributes exceeding 30

characters.

CDB_CustomInterfaces Catalog database Displays custom interfaces exceeding 30

characters.

CDB_PartClasses Catalog database Displays part class names that are prone
to fail when you generate views. This
worksheet reports names that exceed 23
characters.

SDB_Attributes Site database Displays attributes exceeding 30

characters.

SDB_CustomInterfaces Site database Displays custom interfaces exceeding 30

characters.

Because the data in the model database is a subset of the catalog database, the utility
generates the report by querying only the catalog database. During the updating phase,
Schema Name Validator checks for occurrences in all of the model databases under the
catalog and updates them accordingly.
These workbooks follow the same format as bulkload data files. The keywords are the same
with the addition of Data Base Info.
The keywords are not case-sensitive. They are space-sensitive, however. Do not add
or remove spaces.

Keyword Significance Notes

Data Base Info Displays the selected catalog on catalog Do not edit this keyword. For
sheets and the selected site on site example DataBaseInfo is not
sheets. supported.

Project Management User's Guide 406

 Utilities and Services

Keyword Significance Notes

Start Schema Name Validator reads only the PackageName, Truncated

values between the Start and End key Names, Attributes,
words for the columns defined in the Head CustomInterfaces, and
row. PartClasses are standard
columns. The utility does not
recognize any additional
columns.

End Schema Name Validator does not

process any values after the End
keyword.

! Indicates a comment row. If !Schema

Name Validator reads ! between the
Head and End keywords, it skips that row.

Attributes
Specifies the attributes of custom interfaces.
PackageName
Indicates the package to which the value is associated. By default, every value belongs to a
user-defined package (UDP).Because the system-defined data is corrected and delivered
with Smart 3D, the software only considers custom data when looking for Oracle naming
constraints. Because of this, every value under the PackageName column is UDP.
Truncated Names
Indicates the shortened name to use as a replacement for the name that exceeds the Oracle
limit.
Custom interfaces and attributes must be 30 characters or fewer.
Part class names must be 23 characters or fewer because those names use the package
name as a prefix and the view type as a suffix for view creation. For example, if
BPS_5S_LapSup1Sup2Sup3Sup4 is the part class name, you would expect the following:
CUSSBPS_5S_LapSup1Sup2Sup3Sup4O

Project Management User's Guide 407

 Utilities and Services

CUSSBPS_5S_LapSup1Sup2Sup3Sup4OV

Schema Name Validator Dialog Box

Sets options for reporting all of the user classes (PartClasses), user interfaces
(CustomInterfaces), and user attribute (Attributes) names that violate the Oracle length
constraint in an MSSQL database. You can also correct these violations by taking inputs from a
file that you specify. This dialog box identifies names that are prone to fail due to the Oracle 30-
character limitation in the site, catalog, and model databases. It then writes that data into a
Microsoft Excel workbook with each type of data on a work sheet.
Report
Indicates that the utility writes all of the user classes, user interfaces, and user attributes that
violate the Oracle naming constraints for a database to an Excel workbook.
Update
Indicates that the utility updates the selected database with the truncated names.
Database Type
Displays the source database type. By default this is MSSQL. You cannot edit this value.
Server
Displays the name of the database server. All servers registered on the computer are
available on the list.
Site database
Displays the site database name. All site databases on the Server are available on the list.
Site schema database
Displays the schema name for the Site Database.
Catalog database
Displays the catalog database name. All catalog databases on the Server are available on
the list.
Catalog schema database

Project Management User's Guide 408

 Utilities and Services

Displays the schema name for the Catalog database.

Report location
If Report is selected, this box displays the folder to which the utility writes the report. You
can type the path, or click the browse button to navigate to the folder.
The software automatically generates a report file name based on the Catalog database
value and the system time. For example,
SM3D_v1001140000_CDB_01_08_2014_17_58_39.xlsx.
If Update is selected, this box displays the path and file name of the Excel workbook that
contains the truncated names for the update. You can type the path and file name, or click
the browse button to navigate to the file.

 If you do not supply a value for this box, Smart 3D uses the system Temp location as
the default.
 Schema Name Validator uses the same system time for both the log file and the report
file names.
Map file location
Displays the path and file name of an Excel workbook that has the Truncated Names
column defined. This is an optional step. If you provide this file, the utility uses your inputs to
add the truncated names to the output report.
You can type the path and file name, or click the browse button to navigate to the file.
Log file
Displays the path and file name of the log file. You can type the path, or click the browse
button to navigate to the folder.
The software automatically generates a log file name based on the Catalog database value
and the system time. For example, Chamfer_CDB_26_09_2014_18_23_45.log.

 If you do not supply a value for this box, Smart 3D uses the system Temp location as
the default.
 Schema Name Validator uses the same system time for both the log file and the report
file names.
Report/Update
 Report
Starts the reporting process. When the process completes, the software writes a Report
Generated.xlsx file to the folder specified in the Report location box.
 Update
Starts the updating process. The software updates all of the model databases under the
specified catalog. At the end of the process, the software regenerates views for the
catalog database only. You must regenerate the views for the model databases.
Schema Name Validator makes the following verifications:

Project Management User's Guide 409

 Utilities and Services

 The database name in the Data Base Info row of each worksheet in the workbook
must match the value in Site database or Catalog database. If there is a
discrepancy, the software displays an error message.
 Each value in the Truncated Names column must be unique on each work sheet. If
there is a duplication, the software displays an error message.
 The values in the Truncated Names column must meet the Oracle length
constraints. Custom interfaces and attributes must be 30 characters or fewer. Part
class names must be 23 characters or fewer. If there is a length violation, the
software displays an error message.
 The characters _, $, and # are not allowed at the start of a truncated name value,
but they can exist elsewhere in the string. The characters ! and @ are not allowed in
any part of the truncated name string. If these characters are present, the software
displays an error message.
 If the Truncated Names box is blank, the software skips that row and displays a
warning message. You have the option to continue to the next value.
When the reporting or updating finishes, the software generates a log file. For more
information, see Log File (on page 410).
Cancel
Cancels the operation and closes the dialog box. The utility does not save any of the
changes that you made to the dialog box.

Log File
Schema Name Validator writes a log file when you generate a report or update names using
the Schema Name Validator dialog box. This log file contains all messages that the software
generates as it goes through the validation process.
The software writes the log file to the location specified by the Log file box on the Schema
Name Validator dialog box. If you do not specify a location, the software writes the file to the
system Temp folder. The file name is automatically generated by catalog database name and
the system time stamp.

Troubleshooting the Schema Name Validator

The following messages can display.
Access denied to the selected folder. Check for permissions on the folder
You may not have full control permissions to the folder specified for the report or log file.
Verify that you have full control for both folders.
Failed to load catalog database names
The utility could not retrieve the catalog database names. The message box displays the
reason for the failure.
Follow the instructions on the message box to correct the failure.
Failed to load site database names
The utility could not retrieve the site database names. The message box displays the reason
for the failure.

Project Management User's Guide 410

 Utilities and Services

Follow the instructions on the message box to correct the failure.

Verify the existence of the selected server
The utility could not connect to the registered server. The computer could be unavailable or
turned off.
Restart the server, and then restart the report or update.
Work book provided for updating does not belong to the selected catalog. Please provide
appropriate work book
The workbook specified in the Report box does not belong to the specified site or catalog
database.
Specify a different workbook.

View Generator
When you make changes to model properties, such as adding custom attributes, you need to
regenerate the views for the model and catalog, and then regenerate the reports database. The
software delivers a utility, the View Generator, to regenerate the views. The View Generator
executable, ViewGenerator.exe, is delivered in the [Product
Folder]\Core\Tools\Administrator\Bin folder. You must select the catalog schema in order to run
this utility.
When you make metadata changes in the site schema, you must apply the same changes to the
catalog schema. After you modify the schemas, you must regenerate the model and catalog
views using the View Generator. This must be done before you regenerate the reports
database. After you regenerate the views, use the Regenerate Reports Database command in
Project Management to update the reports database.

What do you want to do?

 Make changes to the catalog without synchronizing with the model (on page 411)
 Add custom attributes to the model (on page 412)

Make changes to the catalog without synchronizing with the

model
You make changes to the catalog by bulkloading, either adding new data or modifying existing
data. For example, you could add new part classes, attributes, or custom interfaces.
1. The bulkload process generates the views for the catalog database for the added items.
2. If you run the Synchronize Model with Catalog command in Project Management, the
model views are regenerated. However, if you do not synchronize with the model, the model
views are not regenerated to match the catalog changes. Use the View Generator to
regenerate the model views.
For information on the Synchronize Model with Catalog command, see
Synchronize Model with Catalog (on page 117).

Project Management User's Guide 411

 Utilities and Services

3. After regenerating the model views, go to Project Management and use Edit > Regenerate
Reports Database to update the Reports database with the changes. For more information,
see Regenerate Reports Database (on page 124).

Add custom attributes to the model

1. You use the Define Properties command in Project Management to add custom attributes
to the model. For more information, see Define Model Properties (on page 70).
2. Use the View Generator to regenerate the model and catalog views with the new
properties.
3. In Project Management, after the views are regenerated, use Edit > Regenerate Reports
Database to update the reports database.

 You should regenerate the views and the reports database even if attributes are added in
stages.
 You can only add custom attributes to the model, permission group folder, and permission
group objects using the Project Management task.

IFC Permissions at Satellite Locations

From Project Management at the host location, satellite users can be assigned write permission
for the following interference checking (IFC) properties:
 Required Action
 Notes
No other properties are editable from a satellite location.
Required Action and Notes properties are accessible from the following places:
 Interference List dialog box
 Interference Properties dialog box
 Local Interference Detection ribbon

Project Management User's Guide 412

 Utilities and Services

Interference List Dialog Box

The Interference List dialog box displays interferences from both the Local Detect Tab
(Interference Dialog Box) process, and from database interferences derived from the Refresh
Workspace or Define Workspace.

Interference Properties Dialog Box

Project Management User's Guide 413

 Utilities and Services

Assign IFC Permissions at Satellite Locations

Satellite users who can edit interferences at satellite locations must have the following
permissions:
 Write permission at the satellite location, that is, be a valid model user.
 Write permission to the IFC permission group at the host location.
No other properties are editable from a satellite location.

Permissions
The Host administrator can grant permissions to satellite users. If any satellite user is not from a
trusted domain, the Host administrator clears the Only allow names from trusted domains
check box in the Add Users and Groups dialog box. The host administrator then adds the
corresponding user names.

For information see, Add Users and Groups Dialog Box (on page 151).

Check Database Interferences

Before performing the following procedure, you must first manually configure the Smart 3D
Interference Detection Service on the computer with the service installed. For more information
about installing and configuring the service, see the Smart 3D Installation Guide available with
the Help > Printable Guides command in the software.

1. In the Project Management tree, right-click the Interference Server icon under the
model for which you want to start Database Detect. Then select Properties on the shortcut
menu.
2. In the Interference Server Settings dialog box, assign interference checking priorities to
aspects.

Project Management User's Guide 414

 Utilities and Services

Maintenance, for example, is a typical aspect listed in the Aspect column. If a

check of this aspect is important, you can indicate the priority as Required. If Maintenance
is low priority or not important, you can indicate the priority as Optional or Not Checked.
3. Specify the interference comparison criteria:
 Required - Required - Defines interferences classified as hard/hard. For example, one
pipe physically intersects with another pipe. Severe interferences are shown in red.
 Required - Optional - Defines interferences that are not as severe and are classified as
hard/soft. For example, one pipe overlaps the optional aspect of the other object.
Optional interferences are shown in yellow.
 Optional - Optional - Defines interferences that are not severe and are classified as
soft/soft. For example, the maintenance aspect of one piece of equipment overlaps the
maintenance aspect of another. Optional interferences are shown in yellow.
 Smart 3D - External Data - Considers objects outside the active model for
interferences. For Local Detect, this option is enabled by default. For Database Detect,
this box must be checked if you want attached Reference 3D models, inserted
MicroStation and AutoCAD files to be considered. This option only checks objects
against objects in external references and also checks for interferences between two
external R3D objects.
 Smart 3D - Point Cloud - Considers Smart 3D objects and point cloud objects for
interferences. For Database Detect, this option must be selected to consider Smart 3D
objects and point cloud objects. For Local Detect, select the Smart 3D Point Cloud
check box to consider local interferences. The point cloud must have a valid connection
to the model with no unresolved vendor licensing issues for this check box to be
available.
4. In the Include clearance list, select the needed clearance rule. Clearance interferences are
shown in green.
5. From the Assign results to permission group box, choose the permission group to which
all the detected interferences are assigned.
6. In the Marker size field, type the value for the size of the interference symbols that generate
in the model.
Choose a marker size that is clearly readable, but one that does not interfere with
the smaller details in the workspace view.
7. Click Start on the Database Detect tab. After you click Start, the Status tab on the
Interference Server Settings dialog box displays the progress of the processing for parts
that existed previously and for new or changed parts during the run.
If the IFC Server detects that your system resources are too low (due to a
significant process requiring the majority of system memory), then the IFC process stops and
displays a message box notifying you that the service has stopped for this reason. The IFC
process will automatically attempt to restart when it runs out of memory.

 The Smart 3D Interference Detection service does not consume a license when it starts. It
consumes a license only while processing the model. For more information, see Checking
Interferences in the Interference Checking User's Guide.
 To start the server interference detection process, you must have at least Read access to all
objects in the model and Write access to the model itself. Access privileges are assigned for

Project Management User's Guide 415

 Utilities and Services

each permission group in the Project Management task. During the IFC process, if the
software denies access to an object, the server process stops and a message appears.
 To view the status of the database interference detection process, right-click the
Interference Server icon in the Project Management tree, and click Properties. On the
Interference Server Settings dialog box, click the Status tab.
 When the database interference check process is running, only the Stop command is
available. When the process is not running, the Start command and all process property
gadgets are available. The Stop command is not available.
 When the database interference check is running and you add any permission group without
Read permissions for the server, the server automatically receives Read permissions and
finds collisions with the placed objects in that permission group.
 When you modify permission groups in Project Management, the host for the existing,
running task does not receive the changes. To update the information, you must exit and
restart the interference detection process.
See Also
Interference Server Settings Dialog Box (on page 84)

Configure Project Settings for Drawings

The Configure Project Settings for Drawings utility allows you to make project-wide changes
to drawing settings. The utility, ConfigureDrawingsProjectSettings.exe, is located in the product
installation folder under \ProjectMgmt\Tools\bin.

Project Name
Specifies the project to which the drawings settings apply.
Issue and Revision mode
Specifies which issue and revision mode to use on drawing documents. The following
modes are available:
 Smart 3D Drawings Issues and Revisions
When you use Smart 3D Drawings Issues and Revisions, the Revise
option does not display when you right-click drawings or drawing components in the

Project Management User's Guide 416

 Utilities and Services

Management Console. Use the Drawings Properties dialog box to make your
revisions.
 SmartPlant Foundation Issues and Revisions
This option is only available if your project is registered with SmartPlant Foundation. If
your project is not registered with SmartPlant Foundation, the software automatically
uses Smart 3D Drawings Issues and Revisions.
To change the issue and revision mode, you must have permission to modify the
project. Contact your project administrator for permissions.

Server-Based Interference Checking (Database

Detect)
Unlike the traditional file-based method of manually defining groups of parts to check against
each other, Check Interference is a separate software process that runs directly on the Model
database. Although the interference detection process can be run on any computer with the
Database Interference Detection Service installed, due to the intensive nature of the
interference check computations, the recommendation is to have a computer dedicated as the
interference server.
In order to monitor interferences, you must install the Database Interference
Detection Service option on the same computer that the Project Management option is
installed.

Database detection options are set in the Project Management task. You can also start and stop
the interference database detection process in the Project Management task.

Project Management User's Guide 417

 Utilities and Services

Interference detection requires disk space for the file cache that temporarily stores the
interference data. Before starting the interference process, the interference server checks to see
if enough space exists in the TMP location for the file cache. The server also checks to see if
you have the proper permissions to write, read, and delete files in the TMP location. During the
process, if the space becomes too low, the software stops IFC, and then displays an error
message. These checks primarily apply to the server-based interference process. Although,
they can apply to the local checking process if extremely low or no disk space is available for the
temporary folder on the local computer.
Configure automatic disk defragmentation in order to free space for the file
cache.
After you start the process, use the Status tab on the Interference Server Settings dialog box
to monitor the start time, progress of the interference checking, time when the last part was
modified, and the status of the checking. A box at the top of the dialog box identifies the model
that you are checking.
The software automatically checks new or modified objects apart from existing objects. When
you create or modify an object, the software checks for interference against all objects in the
Model database. The interferences generated by this process are persistent; that is, the
interferences are stored in the database like any other objects in the software. You can also
modify these objects by changing the properties. Interferences are also assigned to a
permission group; thereby the entire process is under the control and restrictions of an
administrator.
You can interrupt the automatic interference checking process during a work session without
forcing a recheck of all parts in the database when the process is brought back online. When
you restart the interference check process, the software begins checking where it left off when
the process went offline. However, if you change any of the options on the Interference Server
Settings dialog box for Database Detect, all pre-existing interference checking processes are
cleared from the database, and checking restarts from the beginning.
The server-based interference checking runs continuously. Therefore, you can perform an
interference check at any time and view the interferences of interest that result from the
background check by refreshing the workspace. After you have reviewed the interferences, you
can remove an interference automatically from the database by editing the objects so that the
interference no longer exists. You can then see the results of your edit by refreshing the
workspace. Because certain types of interferences are allowable, you also have the capability to
mark such interferences as acceptable.
Be aware that there is a four minute interval between the time you make your edits and the time
that the database detect service rechecks the objects. After the database detect process
reaches 100%, the software issues a query only every two minutes to locate newly modified
objects. Therefore, it is possible that there is a six minute delay before a modified object is
processed. We do not recommend changing the default four minute interval. However, if you are
in Project Management with the Interference Server Setting dialog box open, press
CTRL+SHIFT+F12 to change the default four minute interval.
You must run the Database Detect process before running an interference report.
The report is not intended to run on local interferences.

What do you want to do?

 Install Database Interference Detection Service
 Services Authentication Settings

Project Management User's Guide 418

 Utilities and Services

 Configure Interference Service Properties (on page 419)

 Start the Database Interference Detection Service (on page 419)
 Set IFC Permission Requirements (on page 420)
 Create IFC Permission Group Folder and Permission Group (on page 420)
 Set IFC Permissions (on page 421)
 Check Database Interferences (on page 414)

Configure Interference Service Properties

1. Click Start > All Programs (All Apps for Windows 10) > Intergraph Smart 3D > Database
Tools (Windows 7 only) > Configure Interference Checking Service.
2. In the Configure Interference Service dialog box, select your database type.
3. Select the site database server (Microsoft SQL Server) or the Oracle Service for the site
database.
4. Select the site database on which the interference service is to run.
5. Click OK.

Start the Database Interference Detection Service

Prior to starting the Database Interference Detection Service, you must configure its properties.
For more information, see Configure Interference Service Properties (on page 419).
1. Log on with Administrative privileges to the computer on which the Project Management
and Database Interference Detection Service options are installed.
2. Open the Control Panel, and then double-click Administrative Tools.
3. In the Administrative Tools window, double-click Services.
4. Right-click either the Smart 3D Interference Detection Service or the Smart 3D
Interference Detection Service 64-bit, and then select Properties from the shortcut menu.
The 64-bit Smart 3D Interference Detection Service does not process
Point Clouds. Use Reference 3D if you are running 64-bit IFC, or you can switch to a 32-bit
IFC server to process Point Clouds.
5. On the Log On tab, select the This account option, and then type the user name that has
Administrative privileges.
This version of the software does not support the Local System account option.
6. In the Password and Confirm password boxes, type the password for the user account.
7. On the Recovery tab, set the First failure, Second failure, and Subsequent failures
options to Restart the Service.
8. Set Restart service after to a minimum of 6 minutes.
9. On the General tab, verify that the Startup type is set to Automatic.
10. In the Service status section, click Start.
11. Click OK.

Project Management User's Guide 419

 Utilities and Services

 The interference checking service does not consume a license when it starts. It consumes a
license only while processing the model. For more information, see Checking Interferences.
 Errors that are encountered during startup of the Database Interference Detection service
are logged to the Event Viewer Application Log with the source name IFCNTSvc. The
service can automatically recover from these situations:
 network interruptions
 lost database connection
 the interference checking process runs out of memory
 the interference checking process or service is terminated for any reason
 Do not run the 32-bit and 64-bit interference detection services simultaneously on a
computer. IFC must only run as a single instance for the entire model.

Set IFC Permission Requirements

You must install the Database Interference Detection Service option in order to monitor
interferences. For more information about installing and configuring this service, see the Smart
3D Installation Guide available from Help > Printable Guides.
The user account running the IFC Windows service must have at least Read
access to the SharedContent folder. Otherwise, IFC generates a bad part marker with clashes
against structural fireproofing.
A Smart 3D Interference Detection Service icon is placed under the model node in the Project
Management tree. After the proper access permissions are configured, you can start and stop
the Database Detect process from any computer on which the Project Management option is
installed.
The Smart 3D database hierarchy is comprised of a model configuration that consists of the
model and catalog databases. For the IFC Database Detection process to run correctly,
permissions must be set on the model and model permission groups according to the following
guidelines:
Log on privileges for the IFC Administrator include:
 Read access on the model database at a minimum.
 Full Control permissions or access on a minimum of one permission group.
In the Project Management task, create a new permission group folder and
permission group under the model icon to store the IFC results. For example, type IFC
Permission Group Folder and IFC Permission Group in the New Permission Group
Folder and New Permission Group dialog boxes, respectively. For more information, refer
to Create IFC Permission Group Folder and Permission Group (on page 420).
 Read access on all other model database permission groups at a minimum.

Create IFC Permission Group Folder and Permission Group

1. Log on with administrative privileges to the computer where you have installed the Project
Management and Database Interference Detection Service options.
2. In the Project Management tree view, navigate to the models icon.

Project Management User's Guide 420

 Utilities and Services

3. Expand the models folder.

4. Right-click a model under the models folder, and select New Permission Group Folder on
the shortcut menu.
5. Type IFC Permission Group Folder for the name of the new permission group folder.
6. Click OK to close the New Permission Group Folder dialog box.
7. In the tree view, navigate to the IFC Permission Group Folder icon.
8. Right-click the IFC Permission Group Folder, and select New Permission Group on the
shortcut menu.
9. Type IFC Permission Group for the name of the new permission group.
10. Click OK to close the New Permission Group dialog box.
After the IFC permission group is created, you must assign the proper access
permissions. For more information, see Set IFC Permissions (on page 421).

Set IFC Permissions

1. Log on with administrative privileges to the computer on which the Project Management
and Database Interference Detection Service options are installed.
2. In the Project Management tree, navigate to the IFC Permission Group icon.
3. Right-click the IFC Permission Group icon, and select Permissions.
4. On the Access Permissions dialog box, click Add.
5. In the Add names grid, double-click in the User cell, and type the domain and name of the
user or group to add.

 You can also click Add and search for users using the Select Users and Groups
dialog box. This is a common Windows dialog box. For information regarding the
options in this dialog box, see your Windows documentation.
 To remove a user or group from the Add names grid, select the appropriate row, and
then click Remove.
6. In the Type of access list, select the type of access you want to assign. The software
automatically updates the associated row in the Add names grid.
7. Click OK.
8. Click OK again to close the Access Permissions dialog box.

Check Database Interferences

Before performing the following procedure, you must first manually configure the Smart 3D
Interference Detection Service on the computer with the service installed. For more information
about installing and configuring the service, see the Smart 3D Installation Guide available with
the Help > Printable Guides command in the software.

1. In the Project Management tree, right-click the Interference Server icon under the
model for which you want to start Database Detect. Then select Properties on the shortcut
menu.

Project Management User's Guide 421

 Utilities and Services

2. In the Interference Server Settings dialog box, assign interference checking priorities to
aspects.
Maintenance, for example, is a typical aspect listed in the Aspect column. If a
check of this aspect is important, you can indicate the priority as Required. If Maintenance
is low priority or not important, you can indicate the priority as Optional or Not Checked.
3. Specify the interference comparison criteria:
 Required - Required - Defines interferences classified as hard/hard. For example, one
pipe physically intersects with another pipe. Severe interferences are shown in red.
 Required - Optional - Defines interferences that are not as severe and are classified as
hard/soft. For example, one pipe overlaps the optional aspect of the other object.
Optional interferences are shown in yellow.
 Optional - Optional - Defines interferences that are not severe and are classified as
soft/soft. For example, the maintenance aspect of one piece of equipment overlaps the
maintenance aspect of another. Optional interferences are shown in yellow.
 Smart 3D - External Data - Considers objects outside the active model for
interferences. For Local Detect, this option is enabled by default. For Database Detect,
this box must be checked if you want attached Reference 3D models, inserted
MicroStation and AutoCAD files to be considered. This option only checks objects
against objects in external references and also checks for interferences between two
external R3D objects.
 Smart 3D - Point Cloud - Considers Smart 3D objects and point cloud objects for
interferences. For Database Detect, this option must be selected to consider Smart 3D
objects and point cloud objects. For Local Detect, select the Smart 3D Point Cloud
check box to consider local interferences. The point cloud must have a valid connection
to the model with no unresolved vendor licensing issues for this check box to be
available.
4. In the Include clearance list, select the needed clearance rule. Clearance interferences are
shown in green.
5. From the Assign results to permission group box, choose the permission group to which
all the detected interferences are assigned.
6. In the Marker size field, type the value for the size of the interference symbols that generate
in the model.
Choose a marker size that is clearly readable, but one that does not interfere with
the smaller details in the workspace view.
7. Click Start on the Database Detect tab. After you click Start, the Status tab on the
Interference Server Settings dialog box displays the progress of the processing for parts
that existed previously and for new or changed parts during the run.
If the IFC Server detects that your system resources are too low (due to a
significant process requiring the majority of system memory), then the IFC process stops and
displays a message box notifying you that the service has stopped for this reason. The IFC
process will automatically attempt to restart when it runs out of memory.

 The Smart 3D Interference Detection service does not consume a license when it starts. It
consumes a license only while processing the model. For more information, see Checking
Interferences in the Interference Checking User's Guide.

Project Management User's Guide 422

 Utilities and Services

 To start the server interference detection process, you must have at least Read access to all
objects in the model and Write access to the model itself. Access privileges are assigned for
each permission group in the Project Management task. During the IFC process, if the
software denies access to an object, the server process stops and a message appears.
 To view the status of the database interference detection process, right-click the
Interference Server icon in the Project Management tree, and click Properties. On the
Interference Server Settings dialog box, click the Status tab.
 When the database interference check process is running, only the Stop command is
available. When the process is not running, the Start command and all process property
gadgets are available. The Stop command is not available.
 When the database interference check is running and you add any permission group without
Read permissions for the server, the server automatically receives Read permissions and
finds collisions with the placed objects in that permission group.
 When you modify permission groups in Project Management, the host for the existing,
running task does not receive the changes. To update the information, you must exit and
restart the interference detection process.
See Also
Interference Server Settings Dialog Box (on page 84)

Update the ProgID of the Post Processor Rule

When the Post Processor rule compiles with a new ProgID on a project where the IFC was
previously using a different Post Processor rule ProgID, or when you modify the ProgID of the
IFC rule in the catalog through a bulkload, you must update the ProgID of the Post Processor
rule in the model database with an SQL update query.
1. In the symbol share, locate the new IFC rule DLL.
2. Open Project Management.

3. Right-click the Interference Server icon and select Properties.

The Interference Server Settings dialog box displays.
4. Under Database Detect, click Stop.
5. Click Tools > Update Custom Symbol Configuration, and select Update Custom
Symbol Configuration. For more information, see Create or update the custom symbol
configuration file (on page 160) in the Smart 3D Project Management User's Guide.
6. Bulkload the new Post Processor rule.
The IFC rule is now defined by the ProgID in the catalog database, but the IFC rule in the
model database still refers to the old ProgID.

7. In Project Management, right-click the Interference Server icon and select Properties.
The Interference Server Settings dialog box displays.
8. Under Database Detect, click Start.
The ProgIDs are now updated, and Interference Checking performs as specified.

Project Management User's Guide 423

 Utilities and Services

Scheduling Project Management Tasks with Batch

Services
Project Management allows you to schedule some tasks during nonproductive hours, for
example, nights or weekends, using Smart Batch Services. You can schedule tasks by clicking
Submit Job on the Database > Check Data Consistency dialog box, the Tools > Backup
dialog box, and the Tools > Restore > Restore Model from Backup wizard page.
After you click Submit Job, the same scheduling dialog boxes open for each task. Although the
dialog box title differs, the appearance and functionality of the dialog box is the same.
Use Intergraph Batch Services to check database integrity and to schedule backup and restore
sessions when network traffic is low. To schedule the sessions, click the Submit Job button on
the Restore Models from Backup wizard page or on the Check Data Consistency and
Backup dialog boxes.

 If you back up multiple models that refer to the same catalog database, the software creates
only one backup copy of the catalog database and schema.
 If a model that you have selected for back up already exists in the destination folder, a
message appears to determine if you want to overwrite the existing files. Click Yes to
continue and overwrite the files in that folder. Click No to cancel the back up.
 You can use the Database Wizard to restore sites, but not to back up sites.
The backup and restore functionalities also facilitate sending model data to another site. For
example, an office in one location can back up the files in site, model and catalog databases to
a compressed file (for example, *.zip), and then forward the backup file to another site.

 For information on installing SmartPlant Batch Services and setting up the batch queues,
please refer to the Batch Services section of the Intergraph SmartTM 3D Installation Guide.
 Learn more about SmartPlant Batch Services in the Batch Services User's Guide and the
Batch Services Quick Start Guide. Batch Services is a separate product.

What do you want to do?

 Schedule Check Data Consistency task using Batch Services (on page 94)
 Schedule data backup using Batch Services (on page 425)
 Schedule data restore using Batch Services (on page 111)

Schedule Check Data Consistency task using Batch

Services
1. In Project Management, click Database > Integrity.
The Check Data Consistency dialog box displays. For more information, see Check Data
Consistency Dialog Box (on page 96).

Project Management User's Guide 424

 Utilities and Services

2. Select one or more databases to process.

3. Select Basic check or Full check.
4. Click Submit Job.
The Schedule Data Consistency Check dialog box displays.
5. Set the batch scheduling options.
6. Click Options to schedule optional start and end dates.
7. Click OK.

Schedule data backup using Batch Services

1. In Project Management, click Tools > Backup.
2. Complete the Backup dialog box.
3. Click Submit Job.
4. Complete the Schedule Backup dialog box.

Schedule data restore using Batch Services

1. In Project Management, click Tools > Restore.
2. Select Restore one or more model databases from backup, and click Next.
3. Perform the standard restore steps. For more information, see Restore a model from backup
(on page 103).
4. Click Submit Job.
5. Complete the Schedule [Task] dialog box (on page 425).
6. Complete the Restore Options for Batch Process dialog box.
 Restore Both - Restores and overwrites the existing catalog and model.
 Restore Catalog - Restores and overwrites only the existing catalog but will not restore
the existing model.
 Restore Model - Restores and overwrites only the model but will not restore existing
catalog.
 If the model or catalog databases do not exist on the specified server, they are created.

Schedule [Task] Dialog Box

Queue
Displays the name of the queues configured by an administrator for the job. For more
information on configuring the queues, see Configure Queues for Jobs (on page 121) in the
Project Management User's Guide.
Run job
Sets the frequency with which the job runs. Jobs can be scheduled to run once or on a
regular interval (daily, weekly, or monthly). Depending on the job frequency selected,
additional controls display. These controls allow you to define more specific scheduling

Project Management User's Guide 425

 Utilities and Services

information. The scheduling controls can be changed only at job submission.

Run on
Sets the time to start running the job.
Options
Opens the Optional Schedule Properties Dialog Box (on page 101) that you can use to
define a start and end date.
Run on box
Contains a calendar from which you can select the run date. This option is available when
you select Once from Run job.
Every X days
Specifies how many days pass between job runs. This option is available when you select
Daily from Run job.
Every X weeks
Specifies how many weeks pass between job runs. In addition, you can select on which
days the job runs. This option is available when you select Weekly from Run job.
Day X of the month
Specifies on which day of the month the job runs. This option is available when you select
Monthly from Run job.
The X Y of the month
Specifies on which day of the month the job runs. For example, you can select the last
Monday of the month. This option is available when you select Monthly from Run job.
Job Start
Notifies you when the job starts, if Outlook is set up.
Job Completion
Notifies when the job completes, if Outlook is set up.
Job Abort
Notifies you if the job aborts, if Outlook is set up.
Address Book
Selects the name of the person to be notified by e-mail of the job status, if Outlook is set up.
If Outlook is not available, this option does not work. You can also type the address
manually. The person you define here receives an email with the job log files after the job
finishes.

 The Batch Services SMTP option must be configured on the batch server for this to work.
For more information, see the Intergraph Smart Batch Services documentation.
 The WinZip application is no longer required on the batch server to compress any emailed
attachments. Compression is now done with functionality included in Smart 3D.

Project Management User's Guide 426

 Utilities and Services

Optional Schedule Properties Dialog Box

Provides more options on the Schedule Backup dialog box. This dialog box opens when you
click Options.
Start date
Sets an optional start date.
End date
Sets an optional end date, if checked.

Oracle Role Creation Utility

The Oracle Role Creation Utility provides the ability to define more conservative roles based
on object privileges in the Oracle database. You can define specific user roles for each schema
or collection of schemas if necessary. For example, Server 1 is the site and model schemas and
Server 2 is the catalog and reports schemas. You can have different roles defined for each
Oracle schema and your users will need permission to use each role. This is acceptable even if
the roles have exactly the same names.
The Oracle Role Creation Utility is accessed from Start > All Programs > Intergraph Smart
3D > Database Tools. You should run this utility after creating a new Oracle model or after
restoring a Oracle model.
If you start working with the SP3DUSER global role but decide to change to more conservative
Oracle roles, you can revoke the existing SP3DUSER role, then add the new roles.

 It is estimated that it will take 3-4 minutes per schema, or approximately 20 minutes per
model configuration (7 schemas), to create a new role, and creating all of the Oracle roles is
required before the model is available for use.
 If the new role already exists in the Oracle database, the Oracle Role Creation Utility
appends the permission to the existing role.

Project Management User's Guide 427

 Utilities and Services

Create Oracle Roles

The Oracle Role Creation Utility is accessed from Start > All Programs > Intergraph Smart
3D > Database Tools. You should run this utility after creating a new Oracle model or after
restoring an Oracle model.
1. After you create Oracle site and catalog databases using standard procedures, create a new
model in Project Management.
2. After you create the new model, select Start > All Programs > Intergraph Smart 3D >
Database Tools > Oracle Role Creation Utility.
3. On the Oracle Role Creation Utility dialog box, specify an Oracle service and a new role
name. For the role name, you can type the name of an existing Oracle role that is being
used for other models at this site or use a different role for each model.
4. Select the appropriate databases from the list.
5. Click Create. A status bar shows processing information while the Oracle tables update.

 It is estimated that it will take 3-4 minutes per schema, or approximately 20 minutes per
model configuration (7 schemas), to create a new role, and creating all of the Oracle
roles is required before the model is available.
 If the new role already exists in the Oracle database, the Oracle Role Creation Utility
appends the permission to the existing role.
6. Click Close when the process is complete.
See Also
Oracle Role Creation Utility Dialog Box (on page 428)

Oracle Role Creation Utility Dialog Box

Provides options for creating new Oracle roles. This dialog box appears when you select Start >
All Programs > Intergraph Smart 3D > Database Tools > Oracle Role Creation Utility.

Oracle service
Shows the name of the Oracle net service for the database connection.
Role name
Identifies a user-defined string for the new role. You can type the name of an existing Oracle
role that is being used for other models at this site or use a different role for each model.
Add permissions to role on selected schemas

Project Management User's Guide 428

 Utilities and Services

Lists the names of the possible databases where you can create the role. The list is filtered
based on the selected Oracle service. You can select one or more databases.
Create
Adds the new Oracle role to the selected schemas.

 It is estimated that it will take 3-4 minutes per schema, or approximately 20 minutes per
model configuration (7 schemas), to create a new role, and creating all of the Oracle
roles is required before the model is available for use.
 If the new role already exists in the Oracle database, the Oracle Role Creation Utility
appends the permission to the existing role.
Close
Closes the Oracle Role Creation Utility.

Project Management User's Guide 429

Glossary
abstract part
A part that is only defined by a partial specification and that cannot be materially provided by the
organization that defines the specification.
Active Template Library (ATL)
Set of class templates and wizards supplied with Microsoft C++ Version 5.0 and later. You can
use an ATL when you create ActiveX controls and any other type of object that uses the
Component Object Model (COM) model. Using an ATL is generally preferred over Microsoft
Foundation Classes (MFC), because the implementations are smaller, easier to use, and more
closely tied to the COM model.
angle
The circular measurement taken from the intersection of two pipes at a turn or branch.
approval state
Recorded state of acceptance of information contained in objects within the database. The
approval states indicate a level of confidence in the information stored in the database and
govern your ability to alter specific data about a product.
arrangement (accommodation)
Those components of a system arranged in three-dimensional space with accurate dimensional
representation for installation. Various types include electrical, HVAC, machinery, outfitting, and
piping.
attribute
A single type of non-graphics information that is stored about an object such as diameter or end
preparation.
axis
An imaginary line used to define the orientation of a system or object normally defined in terms
of an x-, y-, and z-axis. Some 3-D graphic objects have an associated axis used to define the
center or axis for rotations.
basic design
Engineering definition of the model and its systems.
bill of material (BOM)
Hierarchical decomposition of a product into constituent assemblies and parts. Specific types of
BOMs exist (for example, an EBOM is a bill of material from the point of view of an engineering
department; an MBOM is a bill of material from the point of view of manufacturing).
bulkload
The process by which reference data in Microsoft Excel workbooks is loaded into the Catalog
database.

Project Management User's Guide 430

 Glossary

catalog
Repository of information about components and materials used in construction. When you use
catalog parts in the model, the software places an occurrence of the catalog part in the project.
This occurrence is a copy of the actual catalog part.
Catalog database
The database that contains the reference data. Each model database can reference a different
Catalog database.
chain
A set of continuous and tangent segments.
change history
Process of recording information such as who, when, and why for any given modification.
change management
Software features or manual procedures for managing the consequence of change. For
example, software can support a change management feature to report drawings that need
updating as a result of a change in a 3-D model.
change propagation
Ability of the software to intelligently modify dependent design information to reflect change in a
higher order object.
class
Grouping of individual objects that share some very significant, common characteristics.
classification folder
A folder in the Catalog hierarchy that contains part classes. Classification folders are one level
above part classes. The ClassNodeType and R-ClassNodeDescribes sheets in the Microsoft
Excel workbooks define the classification folders.
codelist
A set of acceptable values for a particular property that can be referred to by an index number or
selected in a combo box. For example, the codelist for the material specification allows you to
select from a set of standard entries, such as ASTM A183-F316 Stainless Steel.
commodity code
A user-defined code that provides an index to parts in a catalog.
commodity item
A standard component found in a manufacturer catalog (an off-the-shelf component).
component
Physical part that a feature generates.

Project Management User's Guide 431

 Glossary

concurrent access
Ability of the software to allow multiple users to simultaneously access and modify the design of
a model.
consolidated tasks
A collection of tasks run in batch. For example, the software allows you to extract a set of
drawings immediately or to schedule the batch extraction for a future time.
constraints
A logical restriction that controls how part symbols ports relate to each other and to reference
ports. There are four constraints: parallel, perpendicular, coincident, and distance.
contract
A Work Breakdown Structure object representing a scope of work, usually performed by an
external supplier. The contract is related to a project and appears in the Work Breakdown
Structure hierarchy.
coordinate
The location of a point along the X-, Y-, or Z-axis.
coordinate system
A geometric relation used to denote the location of points in the model. The most common
coordinate system is the rectangular coordinate system, whereby points are located by
traversing the X-, Y-, and Z-axes of the model. Normally, coordinate systems have their origin
defined as 0,0,0.
cutting plane
A plane that cuts through an object.
damage records
Data relating to the damage and repair of structure or components that occurred during or after
construction of a plant.
data interchange
Capability to output the design, or portions of the design, in a standard format for use or
movement to another computer software system.
database
Repository for the product model data. The database contains information to describe individual
objects in the data model and the relationships between objects as appropriate.
database backup
Process of recording a backup copy of the complete database or the incremental changes after
the date that the last complete copy was created.
database break and recovery
Utilities used to restore a database after files are corrupted.

Project Management User's Guide 432

 Glossary

database copy
Functionality to copy large collections of model objects from one design project to another
design project.
database management
Functionality related to managing a product model database.
database monitor record
Transactions that occur in order to provide database (DB) recovery after a stop in response with
a minimum of lost data.
degree
The highest polynomial factor in the curve or surface mathematical definition. A line is a degree
1 curve, while a cubic B-spline is a degree 3 curve.
design alternative
Difference in a design represented by a separate version. A design alternative can be a new
design prepared as a proposed change, or one of several elective options that the builder or
customer selects. Each design alternative has an identification assigned so you can uniquely
refer to the design alternatives.
design approval log
Record of review and approval of parts of the design.
design data auto input
Automation in loading existing design data into a new design database.
design documents
Drawings, sketches, material lists, procedures, and so forth that are generated during the design
phase.
design object
Any object with properties that you can select. A design object can be related to one or more
contracts of different types, but related only to one contract of a given type.
design progress check
Analysis of the content of the design to some metric unit that gives an idea of the degree of
completion.
design review
Functionality to support rapid viewing of the design and markup of features with comments.
design service
Any general system services related to the design function.

Project Management User's Guide 433

 Glossary

design standard
Feature or object used in plant design that has been determined to the normal or approved way
of accomplishing a design requirement. In the context of computer software, the term refers to
computer functionality to support standards, not the standard itself.
detail schedule
Lowest level of schedule used to manage and track work progress.
distributed systems
Systems consisting of sequential parts with a distributive characteristic (for example, pipes
distribute fluids, HVAC distributes air, cabling distributes power, and structure distributes loads).
distribution systems
Term synonymous and used interchangeably with the term distributed systems.
documentation
Drawings and other records that you must produce to document, obtain approval, or build the
design.
drawing tool
Tool that helps in the process of creating, modifying, or manipulating objects. Examples are
PinPoint and SmartSketch.
easting
A term that describes an east coordinate location in a coordinate system.
edge
A topological object that represents a trimmed curve bounded by a start and end vertex.
edge distance
The distance from the center of a bolt or rivet to the edge of a plate or flange.
equipment catalog
Catalog of equipment geometry and limited properties that the software uses to identify and
visualize equipment and its placement in the model. The catalog is not the source for the total
specification and ordering data for the object.
fabricate
To cut, punch, and sub-assemble members in the shop.
face-to-face
The overall length of a component from the inlet face to the outlet face.
fasteners
Bolts and rivets used to connect structural members.

Project Management User's Guide 434

 Glossary

element
Primitive geometric shape such as a line, circle, or arc.
fence
Boundary or barrier that separates or closes off an area. To surround or close like a fence.
field adjustment
Material added to the neat design geometry of piping or structural parts to allow for fit up in the
case that extra material is required due to uncontrolled variance in the manufacturing and
construction process.
flavor
A different variation of a symbol. Each variation has different occurrence property values.
focus of rotation
A point or line about which an object or view turns.
full penetration weld
A type of weld in which the weld material extends through the complete thickness of the
components being joined.
function points
Part of the requirements documentation, function points are the smallest granularity of a
requirement statement that describe specific detailed actions that the software performs.
functional block diagram
Schematic representation of a system (piping, electrical, ventilation) showing system parts and
their relationship. You use symbols to represent equipment and components. A connecting
network of lines illustrates their relationship. Taken together, the symbols and the network
illustrate the function of the system.
furnishings
Parts such as movable articles and fittings that normally are not associated with a system (for
example, a chair).
generic specific
Object that is parametrically defined or defined to suit a family of specific parts (for example,
International Standards parametrics). For example, a 100 - 200 gpm pump in the catalog can
provide a general shape to appear in the model until a specific object has been identified. See
also specific and specific object.
GUIDs
Acronym that stands for Globally Unique Identifiers. The software automatically creates the
GUIDs sheet in the Excel workbooks when you create the Catalog database and schema. The
purpose of storing GUIDs within Excel workbooks is to help you keep track of what has been
loaded into the database. Storing GUIDs also helps to avoid the situation in which a
replacement Catalog database causes existing models to become invalid.

Project Management User's Guide 435

 Glossary

host location
The first location created for a Site. This host location is defined when the Database Wizard
creates the Site database.
host server
The database server on which the Site database was created using the Database Wizard.
Alternatively, if it is a restored database set, the Host Server is the database server where the
Site database is restored. The Host Server in a Workshare environment contains the origin for
the Site, Site Schema, Catalog, and Catalog Schema databases. Consequently, most Project
Management and reference data work must take place at the Host.
initial design
Early stage of design work, generally before contract, used to estimate construction costs and
provide a rough concept of the intended plant. Contains information relating to a plant created
during its initial (concept) design period.
initial structural plan
Principal structural plan for the plant; also called a construction profile.
instantiation
Occurrence of a catalog object at a specific geometric location in the model.
interference checking
A process that identifies possible collisions or insufficient clearance between objects in the
model.
job order
Industrial authorization for accomplishing work; synonymous with a work order.
kinematics analysis
Analysis of mechanical motion.
ksi
Kips per square inch.
leg length analysis
Preferred term is welding length analysis.
library
Resource of reference information that you can access in developing a plant design.
life cycle database
Information developed to assist in the maintenance and modernization of delivered plants.
link
Way to store information about another file in your document. You can update a link so that
changes in the file appear in your document.

Project Management User's Guide 436

 Glossary

lintel
A horizontal member used to carry a wall over an opening.
load group
A grouping in which all components feature uniform load limits and stress safety characteristics.
For example, if a pipe clamp from load group 5 has a maximum nominal load of 20kN, then so
does a threaded rod from load group 5.
location
A Location is defined by three user-defined inputs: 1) a unique name, 2) a unique name rule ID,
and 3) the server where the Site databases reside for that Location. A Location is defined and
created when the Site database is created using the Database Wizard. Additional Locations can
be created in the Project Management task. Each Location is a Site-level object, thus other
Plants within the same Site collection can use the Locations when the Plants are configured for
Workshare.
logical member
An object in the model used to represent the design topology.
machinery
Major pieces of equipment installed in a plant.
macro
A sequence of actions or commands that can be named and stored. When you run the macro,
the software performs the actions or runs the commands. You can create the macros in Visual
Basic or other OLE-aware programming applications. Some of the other OLE-aware
programming applications are Visual Basic for Applications, Visual C++, and so forth.
maintenance envelope
A rectangular box around the part for clearance during maintenance operations.
maintenance records
Records of breakdown, repair, and overhaul of equipment.
material analysis
Analysis of a completed design work for extracting detailed material requirements; also called
material lists.
material list
An option category that controls the format and content of the bill of materials.
methods
Objects in the database that describe the manufacturing methods to the component parts of a
plant.
model
A graphical representation showing the construction of one or more systems in a plant or ship.

Project Management User's Guide 437

 Glossary

node
 One of the set of discrete points in a flow graph.
 A terminal of any branch of a network or a terminal common to two or more branches of a
network.
 An end point of any branch or a network or graph, or a junction common to two or more
branches.
northing
A term that describes a north coordinate location in a coordinate system.
nozzle
A piping connection point to a piece of equipment.
nozzle standout
The shortest allowable distance between the connection point of a nozzle and the start point of a
turn on the leg connected to the nozzle.
NPD (Nominal Piping Diameter)
The diameter of a pipe.
object
A type of data other than the native graphic format of the application.
occurrence (of part or equipment)
Instantiation of a part of equipment in the model that refers to the part library; an instance of a
specific object. The design can be built several times, and therefore the occurrence can apply to
more than one hull. Typically, an occurrence points back to a specific object, either for its
complete definition, as in the case of a particular valve, or for its made from material, as in the
case of a steel plate part cut from sheets. Thus, when a designer selects a component from the
catalog and places it at a location in the space of the plant, the software creates an occurrence
of that object in the plant design.
occurrence property
A characteristic that applies to an individual object in the model. Occurrence properties are
designated with 'oa:' in the reference data workbooks. You can view and modify occurrence
properties on the Occurrence tab of the properties dialog boxes in the software. Depending on
the object, some occurrence properties are read-only.
origin
In coordinate geometry, the point where the X-, Y-, and Z-axes intersect.
origin point
The point at which the coordinate system is placed, providing a full Cartesian coordinate system
with positive and negative quadrants. Points are placed at coordinates relative to the origin
point, represented by the X, Y, and Z values.

Project Management User's Guide 438

 Glossary

orthogonal
The characteristic of an element consisting completely of elements positioned at 90-degree
angles. A square is an orthogonal element.
orthographic
A depiction of an object created by projecting its features onto a plane along lines perpendicular
to the plane.
P&ID
Diagram that shows the topology, functional components, and special requirements of a piping
system; generally represents the engineering design of the system.
package
Set of closely related classes. (UML)
painting
Computation of paint surface and recording of paint system requirements.
parameter
A property whose value determines the characteristics or behavior of something.
part class
A group of similar objects. You can define part classes in the Excel workbooks. A part class can
have multiple parts. For example, a heat exchanger part class can contain heat exchangers with
different dimensions.
part number
Unique identifier of a part.
PDS (Plant Design System)
A comprehensive, intelligent, computer-aided design and engineering application for the
process, power, and marine industries. PDS consists of integrated 2-D and 3-D modules that
correspond to engineering tasks in the design workflow.
plant
A collection of modeled objects that can be simultaneously displayed and edited in a
workspace. A Plant points to a Catalog (optionally shared with other Plants). Access control is
managed at the Plant level.
plant configuration
The set of databases and files required for work in a particular Plant. Each Plant must have the
following databases: Site database, Site Schema database, Plant database, Report database,
Report Schema database, Catalog database, and Catalog Schema database. Each Plant also
must have one shared file location for Catalog symbols and output files, such as drawings,
specific to the Plant.

Project Management User's Guide 439

 Glossary

principle of superposition
The principle that states that the stresses, strains, and displacements due to different forces can
be combined. This principle is only valid for linear analysis.
Product Data Management (PDM) System
Software intended to manage both product data and documents associated to the product data.
Functionality typically includes: object-based data modeling tools, user administration, business
rules, and document management. Document management typically includes document editing
or reviewing, document mark-up or redline, document storage, and full-text retrieval.
product structure
Hierarchical breakdown or decomposition of a product into constituent parts, volumes, or units.
(For example, a bill of material is one possible type of product structure.)
production planning
Functionality associated with the work breakdown and sequence of the construction of a plant.
promotion
Process of associating approval state with a product version. A product version begins its
existence at a working approval state. When the version is at some level of maturity, its approval
state is elevated to a higher approval state (that is, promoted). Then, further changes must be
carefully controlled and generally require the data set demoted to a working state. One or more
promotions can occur successively higher approval states (between working and approved) to
represent various intermediate levels of review or progressive approval.
query select sets
Set of objects that are selected in a query or queries on the database.
reference data
The data that is necessary to design plants or ships using the software. Reference data includes
graphical information, such as symbols. It also contains tabular information, such as physical
dimensions and piping specifications.
replication
Copying and distributing data and database objects from one database to another and then
synchronizing between databases to maintain consistency.
resource estimation
Rough estimate of material, manpower, and facility utilization for the design and construction of
the plant.
route
1) A line connecting a series of points in space and constituting a proposed or traveled route. 2)
The set of links and junctions joined in series to establish a connection.
satellite server
The database server where the replicated databases reside for Workshare. The Satellite Server
is not used unless Workshare is activated.

Project Management User's Guide 440

 Glossary

schema
A database that creates the structure of another database. For example, a schema specifies the
queries, tables, fields, and data types in a database.
schema update utility
Functionality used to assist in processing existing product models to an updated database
structure after you modify or add to the database structure.
site
The top level in the Project Management hierarchy. A Site configuration may contain several
Catalogs, each shared by multiple Plants.
site administrator
Person responsible for managing the standards and general parameters for a given plant site
within a Site database.
site setup
Functionality associated with establishing a new plant site or hull for design development.
sketch and trace
User interface for rough definition of a required design feature that typically works in a 2-D
mode.
specifications
Contracted requirements for the plant.
stud
A bolt, threaded on both ends, used to connect components.
suspended floor
A concrete floor system built above and off the ground.
symmetric node
Type of vertex on a curve. A curve with a symmetric node has the same curvature on each side
of the node. A handle can be attached to a symmetric node for editing.
system
A conceptual design grouping that organizes parts in hierarchical relationships. A system
represents a functional view of the model and includes information such as system name, type,
properties, and design specifications for the objects assigned to the system.
tag number
User-specific, unique number assigned to an object (for example, CV-101 for a control valve,
HE-2002 for a heat exchanger).

Project Management User's Guide 441

 Glossary

target point
The origin for coordinate measurements displayed by PinPoint. You can position the target point
anywhere on the drawing sheet or view.
tolerant geometry
A type of ACIS geometry - either an edge or a vertex - that is outside the tolerance for ACIS and
requires special handling.
trimmed surface
A surface whose boundary is fully or partially inside the "natural" geometric definition of the
surface. Some or the entire control polygon extends outside the face boundary.
trunk
Feature that quickly reserves space for the distributive systems and other systems that have a
path. Along the trunk are stations that define the cross section and identify part or system
membership.
unit/module modeler
Facility of the system to structure collections of equipment and components into a single
identifiable object.
user attributes
A customized property in the reference data. The Custom Interfaces sheets in the Excel
workbooks define these properties. You can list the customized properties on the individual part
class sheets.
version control
Ability of the system to manage multiple versions of a single part of the design. Version control
should support conditional analysis and promotion status, as well as alternate design features
among hulls within a plant site.
vertex
A topological object that represents a point in the three-dimensional model.
viewset
Set of objects (usually a subset of the entire database) that a view operation uses. Membership
or lack of membership for any object in a viewset does not affect the actual stored
representation of the object, but only its availability or desirability for viewing in the current
scenario.
weight and CG analysis
Routines that compute the weight of commodity materials as configured in a given design (for
example, plate and pipe) and determine total weight and center of gravity (CG) for a collection of
material and equipment, as well as the complete plant.
welding
Weld requirements for joining materials. Welding length analysis is the calculation of required
weld dimensions; also called leg length analysis.

Project Management User's Guide 442

 Glossary

wirebody
A topological object that represents a collection of edges jointed at their common endpoints.
wizard
Software routine attached to an application that provides guidance and expert help to you to
complete one of the functionalities of the application.
work content
Estimation development of metrics from the database that relates to the work hour content of the
various construction units.
work order
Plant authorization for completing work; synonymous with a job order.
working plane
The available 2-D plane of movement for endpoint selection.
workset
Set of objects (usually a subset of the entire database) used in an interactive change, add, or
delete operation. Membership or lack of membership for any object in a workset does not
necessarily affect the actual stored representation of an object. However, you can change or
delete an object in a workset that also results in a change or deletion of the stored object.
Similarly, when you add a new object (not currently stored) to a workset, the software also adds
the object container.
workspace
Area that represents the portion of the model data needed to perform the intended task and
includes the user modeling settings.
workspace document
Document into which you can extract a portion of the model data for a user task.
Workspace Explorer
Tree or list representation of objects in your workspace.

Project Management User's Guide 443

Index
A
C
abstract part • 430
Access Permissions Dialog Box • 151 Cancel a project • 360
Active Template Library (ATL) • 430 catalog • 431
Add a default style rule • 364 Catalog Data Recovery for SQL Server •
Add a Satellite to an Existing Oracle Global 187
Workshare • 239 Catalog database • 431
Add an additional satellite to an existing Catalog Database and Schema Page • 383
SQL Global Workshare Configuration • Catalog Reports Tab (Run Report Dialog
184 Box) • 134
Add custom attributes to the model • 412 chain • 431
Add Custom Command Dialog Box • 347 change history • 431
Add custom commands • 345 Change level of access permission • 150
Add Users and Groups Dialog Box • 151 change management • 431
Allocate streams pool size • 217 change propagation • 431
Analysis Tab (Filter Properties Dialog Box) • Change the active site database • 387
140, 275 Change the location of a permission group •
angle • 430 81
Apply Default Colors • 367 Change the name generator server for the
approval state • 430 active site • 388
arrangement (accommodation) • 430 Check Data Consistency Dialog Box • 96
Assembly Tab (Filter Properties Dialog Box) Check database integrity • 94
• 139, 274 Check Database Interferences • 414, 421
Assign access permission • 149 Check Write Access - Results • 323
Assign IFC Permissions at Satellite class • 431
Locations • 414 Classes Worksheet • 61
Attach a Reference 3D model • 50 classification folder • 431
attribute • 430 ClassInterfaces Worksheet • 61
axis • 430 Clean a database • 89
Clean Database Dialog Box • 92
codelist • 431
B Combining SmartPlant Foundation and
Back • 27 Global Workshare • 197, 249
Back Up and Restore Global Workshare • commodity code • 431
203 commodity item • 431
Backup • 97 component • 431
Backup Dialog Box • 100 concurrent access • 432
basic design • 430 Configuration Tab • 145, 280
Best Practices for Model Data Transform Configuration Tab (Operation Properties
Operations • 313 Dialog Box) • 309, 327
bill of material (BOM) • 430 Configuration Tab (Project Management) •
BOCDefiningInterfaces Worksheet • 63 135
BOCNodes Worksheet • 62 Configure Default Colors • 364
bulkload • 430 Configure each server for replication • 175
By Class Tab (Operation Properties Dialog Configure Interference Service Properties •
Box) • 309, 326 419
Configure Optional Queues Dialog Box •
122

Project Management User's Guide 444

 Index

Configure Project Settings for Drawings • Create Locations • 227

416 Create New Database Objects • 33
Configure Queues for Jobs • 121 Create new database objects for Oracle •
Configure the MDR validation tool • 329 373
Configure the SQL Server Distributor agent Create new database objects for SQL • 375
• 176 Create optimal performance in a Global
Considerations for Performing Large Workshare Configuration • 119
Transactions • 194, 246 Create or update the custom symbol
Consolidate all Oracle databases • 241 configuration file • 160
Consolidate an existing SQL Server Create Oracle Roles • 428
configuration • 186 Create Reference Models • 43
Consolidate Model from Workshare • 199 Create Site Database and Schema Page •
Consolidate Model from Workshare across 378
Untrusted Networks • 251 Create site database from an existing
Consolidate Models from Workshare Dialog catalog for Oracle • 374
Box • 200, 244 Create site database from an existing
consolidated tasks • 432 catalog for SQL • 376
constraints • 432 Create the Oracle GoldenGate
contract • 432 Administrator account • 222
Conversion Details • 404 Create the Smart 3D GoldenGate User
Conversion Status • 405 Alias • 223
Convert a Smart 3D Oracle database to Create the Smart 3D GoldenGate User
SQL Server • 398 Alias for Multitenant Configurations • 224
Convert a Smart 3D SQL Server database Create the Smart 3D GoldenGate User
to Oracle • 399 Alias for Standalone Configurations • 223
coordinate • 432 Custom Commands • 338
coordinate system • 432 Custom Commands Dialog Box • 347
Copy • 29 Custom Schema and Mapping Files • 59
Copy a custom property for a permission Customize style rules based on role • 365
group • 73 cutting plane • 432
Copy a custom property for a permission
group folder • 75 D
Copy an item • 29
Copy From Dialog Box • 76 damage records • 432
Copy generated scripts into GoldenGate data interchange • 432
folders • 232 database • 432
Create a backup file • 99 database backup • 432
Create a new catalog • 39 database break and recovery • 432
Create a new catalog in the active site Database Conversion Wizard • 397, 401
Oracle database • 389 database copy • 433
Create a new catalog in the active site SQL Database Detect Tab (Interference Server
Server database • 391 Settings Dialog Box) • 85
Create a new location • 198, 228 Database Integrity • 93
Create a new model (MS SQL Server Database Maintenance • 88
model database) • 35 Database Maintenance Dialog Box • 90
Create a new model (Oracle model database management • 433
database) • 35 database monitor record • 433
Create a new permission group • 157 Database Properties Dialog Box • 81
Create a new permission group folder • 159 Database Wizard • 368
Create a New Site • 370 Databases Tab (Model Properties Dialog
Create custom commands • 345 Box) • 83
Create IFC Permission Group Folder and Databases Tab (New Model Dialog Box) •
Permission Group • 420 37

Project Management User's Guide 445

 Index

Default Color Configuration Dialog Box • Duplicate Model for Workshare Dialog Box •
365 202, 231
Define a custom property for a model • 71 Duplicate the Model for Global Workshare
Define a custom property for a permission Configuration • 201, 230
group • 72
Define a custom property for a permission E
group folder • 74
Define Model Custom Properties Dialog easting • 434
Box • 71 edge • 434
Define Model Properties • 70 edge distance • 434
Define Permission Group Custom Edit a custom command • 346
Properties Dialog Box • 73 Edit catalog database properties • 78
Define Permission Group Folder Custom Edit Custom Command Dialog Box • 348
Properties Dialog Box • 75 Edit model properties • 78
Define Permission Group Folder Properties Edit permission group folder properties • 79
• 74 Edit permission group properties • 79
Define Permission Group Properties • 72 Edit Properties • 77
Define Properties • 70 Edit the Undo Retention Value • 218
Definition Tab (Run Report Properties equipment catalog • 434
Dialog Box) • 135 Execute PostRestore scripts • 235
degree • 433 Execute PreBackup scripts • 232
Delete • 30 export • 363
Delete a custom command • 346 Export default style rules • 363
Delete a custom property from a model • 71 Export Project Settings Dialog Box • 363
Delete a custom property from a permission
group • 73 F
Delete a custom property from a permission fabricate • 434
group folder • 75 face-to-face • 434
Delete an item • 30 Failure and Recovery Overview • 208, 252
Delete references to symbol flavors and fasteners • 434
deleted objects in the database • 89 feature • 435
Deleting Archive Logs • 255 fence • 435
design alternative • 433 field adjustment • 435
design approval log • 433 Filter Properties Dialog Box • 137, 272
design data auto input • 433 Firewall Exceptions for GoldenGate • 239
design documents • 433 flavor • 435
design object • 433 focus of rotation • 435
design progress check • 433 Forward • 27
design review • 433 full penetration weld • 435
design service • 433 Fully restore an existing catalog from
design standard • 434 backup • 109
Detach a Reference 3D model • 53 Fully restore an existing model from backup
detail schedule • 434 • 108
Disable replication on a SQL Server function points • 435
instance • 185 functional block diagram • 435
distributed systems • 434 furnishings • 435
distribution systems • 434
documentation • 434
drawing tool • 434
G
Duplicate Model for Workshare • 201, 229 General Tab (Model Properties Dialog Box)
Duplicate Model for Workshare across • 82
Untrusted Networks • 250 General Tab (New Location Dialog Box) •
199, 228

Project Management User's Guide 446

 Index

General Tab (New Model Dialog Box) • 36 library • 436

General Tab (Operation Properties Dialog life cycle database • 436
Box) • 308, 324 link • 436
Generate a design basis • 353 lintel • 437
Generate Design Basis • 353 load group • 437
Generate reports • 337 location • 437
generic specific • 435 Location Properties Dialog Box • 200, 229
Global Workshare • 170 Log File • 410
Global Workshare and SQL Server logical member • 437
Databases • 172 Lowest Common Parent • 270
Global Workshare Configuration • 214
Global Workshare Configuration across M
Untrusted Networks • 250
Go to the parent classification • 28 machinery • 437
GUIDs • 435 macro • 437
maintenance envelope • 437
maintenance records • 437
H Make a Smart 3D backup • 233
Host Failure and Recovery • 208, 252 Make changes to the catalog without
host location • 436 synchronizing with the model • 411
host server • 436 Managing Items in the Hierarchy • 28
Managing the Databases • 88
I material analysis • 437
material list • 437
IFC Permissions at Satellite Locations • 412 Menu Commands and Toolbar • 18
Import • 362 Messages Tab (Operation Properties Dialog
Import default style rules • 362 Box) • 326
Import Project Settings Dialog Box • 363 methods • 437
initial design • 436 Mitigate MDR results Dialog Box Options •
initial structural plan • 436 337
Install and configure the Duplication model • 437
Synchronization Service (DuSS) • 183, Model Data Recovery • 209, 253
236 Model Data Reuse (MDR) • 256
Install GoldenGate • 218 Model Data Reuse (MDR) Validation Tool •
instantiation • 436 328
Integrated Environment Overview (Smart Model Data Reuse Wizard • 262
3D) • 349 Add the Destination Assembly Parent •
InterfaceAttributes Worksheet • 62 297
Interfaces Worksheet • 61 Add the Destination Drawing Parent •
interference checking • 436 297
Interference Server Settings Dialog Box • Add the Destination Space Parent • 297
84 Add the Destination System Parent • 296
Assembly Tab • 288
J Begin New Operation • 264
job order • 436 Compare Catalogs • 302
Confirmation • 307
Destination • 285
K Destination Model • 284
kinematics analysis • 436 Disciplines • 282
ksi • 436 Drawings Tab • 294
Operation Properties Dialog Box • 308
L Permission Group Dialog Box • 295
leg length analysis • 436 Restart Existing Operation • 305

Project Management User's Guide 447

 Index

Select Destination Assembly Dialog Box • New Catalog, Site Name Generator Server,
289 or Existing Site • 386
Select Destination Drawings Dialog Box • New Location • 42, 198, 227
295 New Location Dialog Box • 199, 228
Select Destination Space Folder Dialog New Model • 33
Box • 293 New Model Dialog Box • 36
Select Destination System Dialog Box • New Permission Group • 153
287 New Permission Group Dialog Box • 157
Select Destination WBS Dialog Box • 291 New Permission Group Folder • 158
Source Model • 265 New Permission Group Folder Dialog Box •
Source Objects by Filter • 267 159
Source Systems • 267 New Reference 3D Model Dialog Box • 55
Space Tab • 292 node • 438
System Tab • 286 northing • 438
Transformations • 299 nozzle • 438
Use the Permission Group Map • 298 nozzle standout • 438
Welcome • 263 NPD (Nominal Piping Diameter) • 438
Work Breakdown Structure Tab • 290
Model Data Transform (MDT) • 312 O
Model Data Transform Wizard
Begin New Operation • 319 object • 438
Confirmation • 323 Object Type Tab (Filter Properties Dialog
Model • 320 Box) • 142, 277
Objects by Filter • 321 occurrence (of part or equipment) • 438
Restart Existing Operation • 319 occurrence property • 438
Systems • 321 Operation Properties Dialog Box • 324
Transformations • 322 Option Codes Tab (View & Tab Dialog Box)
Welcome • 318 • 304
Model Properties Dialog Box • 82 Optional Schedule Properties Dialog Box •
Modify a Reference 3D model • 51 102, 427
Modify Database and Schema Location • Oracle Role Creation Utility • 427
396 Oracle Role Creation Utility Dialog Box •
Modify reference point cloud • 45 428
Modify the interface names of the target origin • 438
database • 400 origin point • 438
Monitor replication in SQL Server • 185 orthogonal • 439
Monitoring Replication • 237 orthographic • 439
Move • 30 Overall Workflow to Configure a Global
Move an item • 30 Workshare • 210
Move back to the previous level • 27
Move custom .dlls to SharedContent folder • P
161 P&ID • 439
Moving Through the Hierarchy • 27 package • 439
My Reports Tab (Run Report Dialog Box) • painting • 439
133 parameter • 439
part class • 439
N part number • 439
Named Space Tab (Filter Properties Dialog Partially restore catalog data from backup •
Box) • 139, 275 110
New Catalog • 38 Paste • 29
New Catalog Dialog Box • 40 Paste an item • 30
PDS (Plant Design System) • 439

Project Management User's Guide 448

 Index

Permission Group Folder Properties Dialog Reference a point cloud • 44

Box • 83 reference data • 440
Permission Group Properties Dialog Box • Reference Tab (Filter Properties Dialog
84 Box) • 144, 279
Permission Group Tab (Filter Properties Regenerate Reports Database • 124
Dialog Box) • 141, 276 Regenerate Reports Database Dialog Box •
Permissions • 147 130
Permissions, Permission Groups, and Regenerate the reports database • 125,
Permission Group Folders • 147 182, 235
Pipe Specs Tab (View & Map Dialog Box) • Regenerate the reports database with
303 linked Oracle servers • 129
plant • 439 Regenerate the reports database with
plant configuration • 439 linked SQL servers • 125
Point Cloud (Filter Properties Dialog Box) • Register • 351
145, 280 Register all Oracle instances on Smart 3D
Point Cloud Model Reference • 43 administrative machine • 227
Point Cloud Properties Dialog Box • 45 Register from Smart 3D • 351
Preface • 12 Remove a point cloud reference • 45
principle of superposition • 440 Remove a satellite from an existing Oracle
Process and generate data using objects Global Workshare • 242
list files • 332 Remove database errors • 90
Process and generate data using the MDR Remove SQL Server replication • 185
log file • 331 Remove user permissions • 150
Product Data Management (PDM) System • Rename • 31
440 Rename an item • 31
product structure • 440 replication • 440
production planning • 440 Report Parameters Dialog Box • 136
Project Management • 16 Report Workbook • 406
Project Management Hierarchy • 24 Reports • 124
Project Settings • 362 resource estimation • 440
Project Status Update • 356 Restore • 102
promotion • 440 Restore a backup model for selective
Properties • 31 recovery in an active model • 105
Properties Dialog Box (Run Report) • 134 Restore a model as a copy • 106
Properties Tab (Filter Properties Dialog Restore a model from backup • 103
Box) • 143, 278 Restore a satellite for SQL Server
replication • 182
Q Restore a site database • 380
Restore a Site Database from Backup Page
query select sets • 440 • 382
Restore a Site from a Backup Set • 380
R Restore Duplicated Databases at Satellite
Ready to Activate Existing Site Database • Locations • 233
392 Restore Model as Copy (Restore Wizard) •
Ready to Restore Databases • 382 115
Ready to Update Databases Page • 396 Restore Model for Selective Recovery of
Reference 3D Model • 47 Model Objects (Restore Wizard) • 113
Reference 3D Model Properties Dialog Box Restore Models from Backup (Restore
• 58 Wizard) • 112
Reference 3D Tab (Filter Properties Dialog Restore Wizard • 111
Box) • 145, 280 Return the status of a project to Active • 359
Reference 3D Tools • 63 Return to the previous display • 28

Project Management User's Guide 449

 Index

Review Model Data Reuse Operation Set up Global Workshare with SQL Server •
Results • 310 178
route • 440 Set Up one-way subscriptions for SQL
Run a custom command • 346 Server • 180
Run an existing catalog report • 132 Set up two-way replication between SQL
Run an existing personal report • 132 Server models • 179
Run database administration processes • Short Codes Tab (View & Tab Dialog Box) •
95 303
Run Report • 131 site • 441
Run Report Dialog Box • 133 site administrator • 441
site setup • 441
S sketch and trace • 441
Smart 3D Registration Wizard • 352
Satellite Failure and Recovery (GWC) • 253 Smart 3D Registration Wizard - SmartPlant
Satellite Failure and Recovery for SQL Foundation Plant • 352
Server • 191 Smart 3D Registration Wizard - SmartPlant
satellite server • 440 Foundation URL • 352
Scaling Data Examples • 68 Source and Target Databases • 402
Scenario 1 specifications • 441
Restore Model as Copy • 204 SQL Database Maintenance • 123, 187
Scenario 2 Start the Database Interference Detection
Amputate and Re-Duplicate • 205 Service • 419
Schedule [Task] Dialog Box • 425 Start the MDR validation tool • 329
Schedule Backup Dialog Box • 101 Status Tab (Interference Server Settings
Schedule Check Data Consistency task Dialog Box) • 86
using Batch Services • 94, 424 stud • 441
Schedule data backup using Batch Services Suggested Conversion Factors for
• 425 AutoCAD • 67
Schedule data restore using Batch Services suspended floor • 441
• 111, 425 symmetric node • 441
Scheduling Project Management Tasks with Synchronize Model with Catalog • 117
Batch Services • 424 Synchronize Model with Catalog Dialog Box
schema • 441 • 120
Schema Name Validator • 405 system • 441
Schema Name Validator Dialog Box • 408 System Tab (Filter Properties Dialog Box) •
Schema Tab (View & Tab Dialog Box) • 305 138, 273
schema update utility • 441
Select Destination Model Dialog Box • 284
Select Filter Dialog Box • 271 T
Select Object Type Dialog Box • 366 tag number • 441
Select Site Database and Schema Page • target point • 442
392 Task Limitations When Working in a Global
Select Site Database and Schema to Workshare Environment • 192, 244
Upgrade Page • 395 The Databases • 17
Select Site Dialog Box • 266 tolerant geometry • 442
Select Source Model Dialog Box • 266 Transfer Ownership Dialog Box • 135
Server Mapping Information • 403 Translator.ini File Options • 65
Server-Based Interference Checking trimmed surface • 442
(Database Detect) • 417 Troubleshooting Results of MDR
Set IFC Permission Requirements • 420 Transformation • 301
Set IFC Permissions • 421 Troubleshooting the Schema Name
Set the SQL Server Distributor agent profile Validator • 410
• 178 trunk • 442

Project Management User's Guide 450

 Index

U Volume Tab (Filter Properties Dialog Box) •

142, 277
Undo • 29
unit/module modeler • 442
Up One Level • 28 W
Update a model globally with catalog weight and CG analysis • 442
changes • 118 welding • 442
Update Custom Symbol Configuration • 160 What's New in Project Management • 12
Update Custom Symbol Configuration wirebody • 443
Dialog Box • 163 wizard • 443
Update database locations when a server Work Breakdown Structure Tab (Filter
changes • 79 Properties Dialog Box) • 140, 276
Update multiple Reference 3D projects • 53 work content • 443
Update Project Status • 354 work order • 443
Update Project Status Dialog Box • 355 Workflow for Consolidating Oracle
Update project status to Complete • 357 Databases • 240
Update project status to Merged with As- Workflow to Synchronize Catalog Changes
Built • 358 between Host and Satellites • 194, 247
Update project status to Merged with working plane • 443
SmartPlant • 358 workset • 443
Update the ProgID of the Post Processor workspace • 443
Rule • 423 workspace document • 443
Upgrade a Site Database • 393 Workspace Explorer • 443
Upgrade replicated databases • 166
Upgrade Schema • 361
Upgrade Schema Command • 360
Upgrade the site and site schema
databases • 394
Upgrade Version • 164
Upgrade Version Dialog Box • 166
Upgrade versions for all databases • 165
Use the ConvertToZVF tool • 64
Use the GenerateMapping tool • 65
user attributes • 442
Using Filters • 269
Utilities and Services • 368

V
Verify Databases are enabled for
GoldenGate Replication • 216
Verify Databases are Running in
ARCHIVELOG Mode • 215
Verify Databases Have Supplemental
Logging Enabled • 214
Verifying User Alias Configurations • 226
version control • 442
vertex • 442
View & Map Dialog Box • 302
View Generator • 411
View results • 333
View the MDR Log File • 310
viewset • 442

Project Management User's Guide 451