2/11/25, 9:44 AM Hexagon Documentation Site Export

Intergraph Smart 3D Project Management

Hexagon Documentation

Generated 02/11/2025

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 1/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Table of Contents
Welcome to Project Management
What's New in Project Management
Getting Started
The Smart 3D databases
Exploring the Project Management hierarchy
What do you want to do?
Set up a new project
Work with Smart 3D databases
Configure project security
Manage items in the Project Management hierarchy
Move through the Project Management hierarchy
Add point cloud data to the model
Attach external 3D data to the model
Edit object properties
Work with custom properties
Produce printed reports
Configure a project for Global Workshare
Use custom commands
Work with SmartPlant Integration
Set up default style rules for the model
Check for database interferences
Schedule Project Management tasks with Batch Services
Set up Model Data Reuse and Model Data Transform operations
Command Reference
Database menu
Edit menu
View menu
Go menu
Tools menu
SmartPlant menu
Appendix: Utilities and Services
Configure Project Settings for Drawings Utility
Database Conversion Wizard
Database Wizard
Modify Database and Schema Location
Smart 3D Database Tools Wizard
Oracle Role Creation Utility

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 2/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Schema Name Validator

View Generator
Appendix: Getting Started with Global Workshare
Task Limitations When Working in a Global Workshare Environment
Considerations for Performing Large Transactions
Combining SmartPlant Foundation and Global Workshare
Deleting Archive Logs
Legal Information
Copyright Notice
Anti-Piracy Statement
Customer Support
Third Party Software License Terms
Glossary
abstract part
Active Template Library (ATL)
angle
approval state
arrangement (accommodation)
attribute
axis
basic design
bill of material (BOM)
bulkload
catalog
Catalog database
chain
change history
change management
change propagation
class
classification folder
codelist
commodity code
commodity item
component
concurrent access
consolidated tasks
constraints
contract
coordinate
coordinate system

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 3/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

cutting plane
damage records
data interchange
database
database backup
database break and recovery
database copy
database management
database monitor record
degree
design alternative
design approval log
design data auto input
design documents
design object
design progress check
design review
design service
design standard
detail schedule
distributed systems
distribution systems
documentation
drawing tool
easting
edge
edge distance
element
equipment catalog
fabricate
face-to-face
fasteners
fence
field adjustment
flavor
focus of rotation
full penetration weld
function points
functional block diagram
furnishings
generic specific

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 4/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

GUIDs
host location
host server
initial design
initial structural plan
instantiation
interference checking
job order
kinematics analysis
ksi
leg length analysis
library
life cycle database
link
lintel
load group
location
logical member
machinery
macro
maintenance envelope
maintenance records
material analysis
material list
methods
model
native object
node
northing
nozzle
nozzle standout
NPD (Nominal Piping Diameter)
object
occurrence (of part or equipment)
occurrence property
origin
origin point
orthogonal
orthographic
P&ID
package

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 5/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

painting
parameter
part class
part number
PDS (Plant Design System)
plant
plant configuration
principle of superposition
Product Data Management (PDM) System
product structure
production planning
promotion
query select sets
reference data
replication
resource estimation
route
satellite server
schema
schema update utility
SIO object
site
site administrator
site setup
sketch and trace
specifications
stud
suspended floor
symmetric node
system
tag number
target point
tolerant geometry
trimmed surface
trunk
unit/module modeler
user attributes
version control
vertex
viewset
weight and CG analysis

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 6/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

welding
wirebody
wizard
work content
work order
working plane
workset
workspace
workspace document
Workspace Explorer

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 7/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Welcome to Project Management

Getting Started What do you want to do?

What's New in Project Management Create Smart 3D databases

The Smart 3D databases Create permission group folders and

permission groups
Exploring the Project Management hierarchy
Set access permissions
Set up a new Smart 3D project
Perform database maintenance

Create a backup of my model

Restore my databases from backup

Configure a project for Global Workshare

Work with SmartPlant Integration

Check for database interferences

Command Reference Getting Help

Database menu Customer Support

Edit menu Hexagon Documentation

<https://docs.hexagonali.com>
View menu

Go menu

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 8/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Tools menu

SmartPlant menu

Customer Support
Anti-Piracy Statement
Copyright © 1999-2024 Hexagon AB and/or its subsidiaries and affiliates
Version 11
Published 1/5/2024 at 4:27 PM

What's New in Project Management

You can link directly to this document using

https://docs.hexagonppm.com/go/S3D11PrjMgmt
<https://docs.hexagonppm.com/go/S3D11PrjMgmt>

The following changes have been made to the Project Management task.

Hot Fix and Service Pack Updates

Added information about running multiple Model Data Reuse jobs from different
Administrator computers simultaneously on the same model. See Model Data Reuse
(MDR) Command.

Reorganized the table of contents to create the following new sections:

Getting Started

What do you want to do?

Command Reference

A new option, Server Interference, has been added to the Point Cloud Model
Reference dialog in Project Management. This option allows you to select a point cloud
dataset for server-based clash detection. See Attach a Point Cloud model. (P1
CP:301821)

Added descriptions of the columns that display in the

SynchronizeModelWithCatalogError.log file. See Review the Synchronize Model with
Catalog error file. (P2 CP:355456).

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 9/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Version 2016 (11.0)

Reorganized throughout for improved readability.

Added information about the Model Data Reuse wizard operations. See Model Data
Reuse (MDR) Command. (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. See
Run database administration processes. (P1 CP:227829)

You can now register multiple point cloud vendors separately for a particular model
database. See Attach a Point Cloud model. (P1 CP:246829)

The default Reference 3D Model Type is now SmartPlant Interop Publisher. See New
Reference 3D Model Dialog. (P1 CP:278917)

You can now specify unit delimiter in reports as needed while generating the report.See
Report Parameters Dialog Box (P2 CP:140982)

Added a new Permission Group option to the Reference 3D Model Properties Dialog.
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. (P2 CP: 173162)

You can now attach Reference 3D models at both the host and the satellite locations.
See Reference 3D Model Command. (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. (P2
CP:212862)

Added instructions for regenerating the Reports database with linked servers. See
Regenerate the reports database with linked SQL servers and Regenerate the reports
database with linked Oracle servers. (P2 CP:229440)

Added new information about database upgrade performance.See Upgrade the catalog
and model databases. (P2 CP:239169)

The Upgrade Version Command is now enhanced to upgrade multiple databases

simultaneously with more usability, better performance, and a better interface. (P2

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 10/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

CP:249049)

You can now register (attach) point cloud models at the satellite location. See Point
Cloud Model Properties Dialog. (P2 CP:251950)

You can now move or rotate the attached point cloud in the Project Management. See
Attach a Point Cloud model. (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 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. (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. (P2 CP:262183)

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 11/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Added information about database integrity limitations. See Task Limitations When
Working in a Global Workshare Environment. (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. See Model
Data Reuse (MDR) Command. (P2 CP:266052)

Documented the new Repair Permission Groups and Duplicate Part Numbers
custom commands. See Custom Commands. (P2 CP:269428 and P2 CP:276194)

Added recommended practices for Model Data Reuse. See Model Data Reuse (MDR)
Command. (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)

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. See Model Data Reuse Wizard: Compare
Catalogs. (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. See Upgrade Version Command. (P2 CP:272892)

Information related to PDS Model Reference has been removed. See Attach external 3D
data to the model. (P2 CP:276780)

Added the Repair Duplicate Permission Group ID custom command. See Custom
Commands. (P2 CP:278891)

Added a new custom command, Placing Supports from XLS. See Custom
Commands. (P2 CP:284643)

Updated throughout with new tree view icons. (P2 CP:288300)

Added a new option, Improve database load time, for Reference 3D create and
update operations. See Update multiple Reference 3D projects and New Reference 3D
Model Dialog. (P2 CP:302652)

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 12/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

A new utility, Configure Project Settings for Drawings Utility, allows you to specify the
issue and revision mode for all drawings in a project. (P3 CP:94887)

Smart 3D now upgrades custom symbol configurations before it upgrades catalogs. See
Upgrade Version Command. (P3 CP:261875)

The Move by Relative Distance option in the Point Cloud Model Properties Dialog has
been replaced with Target Point. (P3 CP:277501)

Added new information about Default Queues. See Configure Queues for Jobs
Command. (P4 CP:256931)

Added note to Model Data Reuse section addressing Oracle tablespace extensions.See
Model Data Reuse (MDR) Command.(P4 CP:259621)

Added notes to Database Conversion Wizard section regarding running database

integrity before running database conversion. (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. See Synchronize Model with Catalog Command and Update multiple
Reference 3D projects. (P4 CP:266148)

Added information about the Model Data Transform wizard operations. See Model
Data Transform (MDT) Command. (P4 CP:266150)

Added the process to update the ProgID of the Post Processor rule. See Update the
ProgID of the Post Processor rule. (P4 CP:270686)

Added new information about Read-Only objects in the Model Data Transform (MDT)
section. See Model Data Transform (MDT) Command). (P4 CP:295624)

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 13/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Getting Started
Project Management enables you, in the role of an administrator, to manage the design and
the related hierarchy of permission groups and access privileges. Specific tasks that you can
perform in Project Management 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 model.

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.

A site and site schema database must currently exist before you can open
Project Management. You use the Database Wizard to create these databases. For more
information, see Set up a new project.

The Smart 3D databases

A Smart 3D project uses a set of seven interrelated databases: site, site schema, catalog,
catalog schema, model, reports, and reports schema. You must create these databases
before using Smart 3D.

The graphic below depicts the order of creation and the relationships between these
databases.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 14/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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
database 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. Typically, there is one site database set for each location.

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, which includes information for commodity components, physical
dimensions, and standards based on industry specifications. Catalog data includes:

Graphical symbols that you can place in the model, such as equipment or piping
components

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 15/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Non-graphical, tabular data, such as specification data, derived from the reference data
(in the form of Excel workbooks) delivered with the software.

Parts that you place in the model, such as piping components and equipment

Rules that govern how the parts are placed and connected

You can modify the delivered reference data by editing and bulk-loading Excel
workbooks. You can also use your own custom Excel workbooks and custom symbols to
create a project-specific catalog database. Information about customizing the delivered
reference data is available in the Smart 3D Reference Data Help.

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 instances of parts in the physical representation of in the model. The catalog and
model databases share the same schema. A model is all three databases used together:
catalog database, catalog schema database, and model database.

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.
See the Reports Help and the Drawings and Reports Reference Data Help.

Reports schema database

Contains metadata that describes the report formats.

For information about creating the required databases, see Set up a new Smart 3D project
and Create Smart 3D databases.

Exploring the Project Management hierarchy

The graphic below identifies the components in the user interface.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 16/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

1 Menus organize commands for performing

tasks specific to Project Management. For
more information, see Command Reference.

2 The toolbar includes command buttons for

navigating and managing the Project
Management hierarchy.

3 The Console pane displays the physical and

logical hierarchy of your model, including
Satellite locations, databases, permission
group folders, and permission groups, in a
tree view format. At the top of the tree is the
Site root, identified by the icon. The Site
root is created when the Smart 3D

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 17/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

administrator creates new site and site

schema databases.

The site database serves as the

main or primary database and allows you to
access the model and catalog databases and
their related schema databases. When you
create the site database, you also create the
site schema database. The site schema
database stores metadata that describes
objects for the software, such as pipe, fitting,
or a beam.

Under the Site root in the hierarchy tree are

three main branches or nodes: Locations,
Reference Data, and Models.

The Locations branch displays the

locations are defined for the global
workshare environment.After you create
a location, you can associate it with
permission groups and models as part
of the workshare replication process.

The Reference Data branch groups the

catalog databases that belong to the
active site, along with their associated
permission group folders and
permission groups. Assigning
permissions to each catalog controls
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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 18/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The Models branch groups all the

models in the active site along with their
associated permission group folders
and permission groups. Assigning
permissions to each model controls
which users have read/write access to
various objects in the model.

The hierarchy uses icons to indicate the type

and the status of hierarchy items. For more
information, see Hierarchy icons.

4 The Detail pane displays property data for

the object selected in the Console pane. If
the node selected in the Console pane
contains children, the Detail pane displays
data for the children. In the example, the
Project1 model is selected in the Project
Management tree. The Detail pane displays
information regarding its immediate children,
or the four permission group folders nested
underneath.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 19/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

If the selected node has no children, then

only data for node itself displays. In the next
example, because the selected permission
group has no children, the Detail pane
displays data for the item itself.

Hierarchy icons
The Project Management hierarchy uses the icons listed below to indicate the item type and
its related status.

- Top level of the hierarchy

- Locations root

- Location

- Reference data root

- Catalog associated with a model

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 20/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

- 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 root

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

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

- Permission group folder

- Permission group

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 21/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

- Interference server.

- Reference 3D model folder.

- Reference 3D model.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 22/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

What do you want to do?

You have a lot of options, and you know best what you need to accomplish. Here are some
general categories to help get you started.

Set up a new Work with Smart Configure project Manage items in Move through the
project 3D databases security the Project Project
Management Management
hierarchy hierarchy

Add point cloud Attach external Edit object Work with Produce printed
data to the model 3D data to the properties custom reports
model properties

Configure a Use custom Work with Check for Set up default

project for Global commands SmartPlant database style rules for the
Workshare Integration interferences model

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 23/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Schedule Project Set up Model

Management Data Reuse and
tasks with Batch Model Data
Services Transform
operations

Set up a new project

Setting up a new project from scratch involves creating the seven required databases,
creating permission group folders and permission groups to define the model hierarchy, and
then setting up appropriate access to the databases and database objects.

Create the required Define a model hierarchy Set up user access

databases

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 24/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Create the required databases

A Smart 3D project uses a set of seven interrelated databases: site, site schema, catalog,
catalog schema, model, reports, and reports schema. You must create these databases
before using Smart 3D.

The graphic below 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

Administrative privileges are required to create databases. Do not proceed

unless you are an administrator on the database server computer and in the database
provider software.

The site database and schema organize the interactions of the other databases. Because the
site database and site schema are containers for the other required databases, they are the

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 25/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

first databases you must 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, or for each set of interrelated model designs. You use the Database
Wizard to create the site and site schema databases.

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\Site 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, OracleUser\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 in Oracle. For
example, if you typea name such as 1ModelSiteDB, Oracle will not create the database.
When you name the site database, the name of the schema database will automatically
populate with _SCHEMA to match the site database.

Tablespace

We recommend 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 26/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

General information for creating a new site (SQL)

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 you type in the Name rule ID 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 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 .dat template file
specified in the Template file to be used to create the Catalog database and schema box.
The default is to Restore catalog from backup. If you select Use existing catalog, then no
further options are available.

The .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 Hexagon
PPM.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 27/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Symbols and custom program file folder

The SharedContent folder is created automatically on the server during the Smart 3D
Reference Data installation. The path you specify 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.

Optionally, you can create a starting catalog and catalog schema database using the
database template file delivered with the software within the site databases set creation
workflow. The catalog template file delivered with the software is a backup of an already
complete catalog database. This template 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.

After you create the databases for site, catalog, and their associated schemas, you use the
tools in Project Management to create the model and reports databases.

Standard workflows

The software supports two standard workflows for creating new databases when setting up
your project. The only difference between the two workflows is when you create the catalog
database set. In Workflow 1, the catalog databases are created as part of the site database
creation process using the Database Wizard. In Workflow 2, you first use the Database
Wizard to create the new site databases, and then you use Project Management to create the
new catalog databases.

Create the Databases: Workflow 1

Before you begin:

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 or Oracle
server software installed on the server computer in order to create the databases.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 28/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

need to be part of the Administrators group on the local computer in order to run the
product. For more information, see the Smart 3D Installation Guide.

You must name the databases with unique entries. Write down the names as you
proceed.

Click a box in the diagram to go to the associated procedure.

Create new site, catalog, and schema databases for SQL

This procedure is for SQL Server databases. If you are using Oracle, see Create new site,
catalog, and schema databases for Oracle.

1. Open the Database Wizard, select Create a new site, and then click Next.

2. From the Database type list, select MSSQL.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 29/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

3. Select the name of the server in the Site database server list on which your site
database will reside. Only registered SQL Servers display in the Site database server
list. If your server is not listed, see Register the Microsoft SQL Server in the Smart 3D
Installation Help.

4. Type the name of your site database in the Site database name box. Include the type
of database in the name you type. Using the database type in the name makes
identifying the site database in SQL Server Management Studio easier. For example,
type Project1SiteDB (where DB stands for database) or Project1_SDB (where SDB
stands for site database).

When you name the site database, the site schema server and site schema name
default to match the site database server and name.

5. Type the workshare location for the site database in the Site database workshare
location text box. 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. You can use any string that represents your physical location.

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

7. Type the name of the server computer on which the Name Generator Service is
configured in the Name generator server for site box. The 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. If you do not have a name generator server set up,
see Name Generator Service Setup in the Smart 3D Installation Help.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 30/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

8. Use the default paths for the site database files in the Physical database and Log file
boxes.

9. Click Browse to the right of the Template file to be used to create site schema
text box.

10. If you installed the reference data on your database server, navigate to the [Installation
folder for Smart 3D Reference Data]\DatabaseTemplates\<model type> folder.

If you did not install the Smart 3D reference data on your database server, you must
copy the files in the [Installation folder for Smart 3D Reference
Data]\DatabaseTemplates\<model type> folders on the reference data computer to a
folder on a local drive on the database server computer. You need the files in the Plant,
Marine, or MaterialHandling folder.

11. Select apprepos.dat. This is the file that the software uses when creating your site
schema database.

12. Click Next to go to the Catalog Database and Schema page.

13. Select Restore catalog from backup. This option restores a catalog from a Microsoft
SQL Server backup file. When you choose to create a new catalog database for the site
using this option, the wizard restores the .dat file that you specify in the Template file to
be used to create the Catalog database and schema box. Default catalog database
.dat files are delivered in the Plant, Marine, or MaterialHandling folder in the [Installation
folder for Smart 3D Reference Data]\DatabaseTemplates folder.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 31/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

14. Select the name of the server in the Catalog database server list on which your
catalog database will reside.

15. Type the name of your catalog database in the Catalog database name box. Include
the type of database in the name that you type. Using the database type in the name
makes identifying the catalog database in SQL Server Management Studio easier. For
example, type Project1CatalogDB (where DB stands for database) or Project1_CDB
(where CDB stands for catalog database).

This step automatically populates the name of your catalog schema database in
the Catalog schema name text box.

16. Use the default paths for the catalog database files in the Physical database and Log
file boxes.

17. Click Browse 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 path in the
Symbol and custom program file folder box must be a UNC path.

18. Click Browse 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 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\<model type> folder.

The catalogdb.dat (Plant), sm_shipcatalogdb.dat (Marine), and

mhe_catalogdb.dat (Material Handling) template files contain sample Smart 3D
reference data. Although the templates contain many useful examples, they are not
certified for production use.

19. Click Next.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 32/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

20. On the Ready to Create Databases page, click Next to create the specified databases.

21. After the site, catalog, and schema databases are created, the wizard displays a
summary page. Click Finish to close the Database Wizard.

The Name Generator Service that you specify in the Name generator server for
site box (step 7) 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 entered 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.

Create new site, catalog, and schema database for Oracle

This procedure is for Oracle databases. If you are using Microsoft SQL Server, see Create
new site, catalog, and schema databases for SQL.

The dump files used to create the site and catalog database are delivered on the
server computer to [Product Folder]\3DRefData\DatabaseTemplates. This location must be
shared and write permissions given to both the user login used to create the 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.

1. Open the Database Wizard, select Create a new site, and then click Next.

2. On the Create Site Database and Schema page, select Oracle from the Database
type list.

3. In the Oracle service list, select the name of the Oracle net service for the site
database connection.

4. Type the name of your site database in the Site database name text box.

To better differentiate between one database and another, include the type of
database in the name you type. For example, type Project1SiteDB (where DB
stands for database) or Project1_SDB (where SDB stands for site database).

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 33/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Do not use a name which starts with a digit as its first character. For example, if
you enter a name such as n, 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.

Oracle site database name cannot exceed 21 characters.

5. Type the workshare location for the site database in the Site database workshare
location text box. 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. You can use any string that represents your physical location.

6. Type a name rule ID in the Name rule ID text box. By default, the software leaves this
field blank. You can use any string identifier, numeric or alpha. However, special
characters are not supported/

7. In the Name generator server for site box, type the name of the server computer on
which the Name Generator Service is installed. The 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. If you do not have a name generator server set up, see Name
Generator Service Setup in the Smart 3D Installation Guide.

8. Use the default paths for the site database files in the Data tablespace file name and
Index tablespace file name boxes.

9. Click Browse 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.

10. Click Next to go to the Catalog Database and Schema page.

11. Select Restore catalog from backup. When you choose to create a new catalog
database using this option, the wizard restores the .dmp file you specify in the Template
to be used to create the Catalog database and schema box.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 34/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

12. Select the name of the server in the Catalog database server list on which your
catalog database will reside.

13. Type the name of your catalog database in the Catalog database name box .Include
the type of database in the name that you type. For example, type Project1CatalogDB
(where DB stands for database) or Project1_CDB (where CDB stands for catalog
database).

14. Use the default paths for the catalog database files in the Data tablespace file name
and Index tablespace file name boxes.

15. Click Browse 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 path in the
Symbol and custom program file folder box must be a UNC path.

16. 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 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> folder.

The catalogdb.dmp (Plant), sm_shipcatalog.dmp (Marine), and

mhe_catalogdb.dmp (Material Handling) template files contain sample reference data.
Although the templates contain many useful examples, they are not certified for
production use by Smart 3D.

17. Click Next.

18. On the Ready to Create Databases page, click Next to create the specified databases.

19. After the the site, catalog, and schema databases are created, the wizard displays a
summary page. Click Finish to close the Database Wizard.

The Name Generator Service that runs on the server computer that you specify in the
Name generator server for site box (step 7) 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 35/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

objects. The value you type 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.

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 site and catalog database template names
and their respective folder paths must be typed correctly when creating the site and
catalog databases.

Verify creation of a new site

1. Click Start > Intergraph Smart 3D > Modify Database and Schema Location to open
the utility and view the location of the site and site schema databases that you just
created.

2. Click OK.

Alternatively, you can also use the Create a new catalog, select name generator server
for site, or select existing site option in the Database Wizard. For more information, see
Change the active site database.

You can manually edit the connection information on the each individual Smart 3D
computer to allow for connection to the site database and the models that it contains.

Create a new model (MS SQL Server model database)

You must have administrator privileges on the site database to create a new model.

The computer on which you create the new model must have Project Management and
Server Connectivity options installed.

1. Open Project Management.

If Project Management does not point to the appropriate database, errors result
when you open that database. To correct this problem, close Project Management, and

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 36/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

use Modify Database and Schema Location to change the site database that the task is
viewing. For more information about this utility, see the Smart 3D Installation Help.

2. Select the Models root in the Project Management tree.

3. Click Database > New > Model to open the New Model Dialog.

4. On the General tab, type a name for the new model. Optionally, type values for
Description, Site, and Owner.

5. Select the type of model to create: Plant, Marine, Platform, or Material Handling.

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

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 to create the new model.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 37/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

When processing completes, the software adds icon for the new model in the Project
Management tree. As with the new catalog database, the software creates a default
permission group folder and default permission group. An icon for the Interference
Detection Service ( ) also displays in the tree view.

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.

To view and change descriptive information about the model, including giving it a
different name or modifying access permissions, use the Properties Command .

Create a new model (Oracle model database)

1. Open Project Management.

If Project Management does not point to the appropriate database, errors result
when you open that database. To correct this problem, close Project Management, and
use Modify Database and Schema Location to change the site database that the task is
viewing. For more information about this utility, see the Smart 3D Installation Help.

2. Select the Models root in the Project Management tree.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 38/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

3. Click Database > New > Model to open the New Model Dialog.

4. On the General tab, type a value for Name. Optionally, type values for Description,
Site, and Owner.

5. Select the type of model to create: Plant, Marine, Platform, or Material Handling.

6. On the first row of the Databases tab, select Catalog as Type, and define the following
values:

a. Service - Select the Oracle net service for the catalog database.

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

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 Index table space path boxes, specify the path for the
location of the model database files and model index table space.

11. Click OK to create the new Oracle model.

When processing completes, the software displays an icon for the new model in the
Project Management tree. As with the new catalog database, the software creates a
default permission group folder and default permission group. An icon for the
Interference Detection Service ( ) also displays in the tree view.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 39/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

After you create a new Oracle model, you must run the Oracle Role Creation Utility to
create the necessary schemas, users, and roles that are used to run the software. For
more information, see Create Oracle roles.

To view and change descriptive information about the model, including giving it a
different name or modifying access permissions, use the Properties command.

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 Databases tab of
the Model Properties Dialog.

Create the Databases: Workflow 2

Before you begin:

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 or Oracle
server software installed on the server computer 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 to run the product. See the Smart 3D
Installation Help.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 40/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

You must name the databases with unique entries. Write down the names as you
proceed.

Create a new site database for SQL

This procedure is for SQL Server 2016. If you are using Oracle, see Create a new site
database for Oracle.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 41/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

(where DB stands for database) or Project1_SDB (where SDB stands for site
database).

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.

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 Smart 3D Installation Guide.

g. Use the default paths for the site database files in the Physical database and
Log file boxes.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 42/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

3. Click Browse 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.

4. Select apprepos.dat. This is the file that the software uses when creating your site
schema database.

5. Click Next.

6. On the Catalog Database and Schema page, select Use existing catalog, and then
click Next.

7. On the Ready to Create Databases page, click Next to create the specified databases.

8. After the the site and site schema databases are created, the wizard displays a
summary page. Click Finish to close the Database Wizard.

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 you type 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 43/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Create a new site database for Oracle

This procedure is for Oracle. If you are using Microsoft SQL Server, see Create a new site
database for SQL.

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

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 44/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

6. When the Database Wizard displays the site database names that you typed, click
Finish.

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.

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 you type 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.

Verify creation of a new site

1. Click Start > Intergraph Smart 3D > Modify Database and Schema Location to open
the utility and view the location of the site and site schema databases that you just
created.

2. Click OK.

Alternatively, you can also use the Create a new catalog, select name generator server
for site, or select existing site option in the Database Wizard. For more information, see
Change the active site database.

You can manually edit the connection information on the each individual Smart 3D
computer to allow for connection to the site database and the models that it contains.

Create a new catalog

The following procedure is applicable for both SQL and Oracle databases.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 45/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

1. Open Project Management, and then click Database > New > Catalog to open the New
Catalog Dialog.

2. Specify the Catalog information as needed for the new catalog database. The software
specifies Schema information based on what you enter for Catalog information.

3. To create a new empty catalog, select Create an empty catalog, and navigate to the
Apprepos.dat file. An empty catalog is a a catalog databases that contains all of the
necessary tables, stored procedures, views, and objects but does not contains any
modeling data, such as part data or specifications.

To create a catalog from a template, select Create a new catalog from a template and
specify the Plant, Marine, or Material Handling template file to use in creating the
catalog database and schema.

If you are running Oracle on Linux, then the database template must be on the
Linux computer where the Oracle service is running.

Linux is a case-sensitive environment. The database template name and the folder
path must be typed correctly when creating the database. The Browse feature is
not available for navigating to Linux folder locations.

4. For SQL databases, browse to locate the Physical database and Log file. For Oracle
databases, type the Data tablespace file name and the Index tablespace file name.

5. Click Browse 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.

6. Click OK to create the new catalog.

A progress bar displays while the software creates the catalog and catalog schema
databases. After the software creates the new catalog, the software adds the new
catalog under the Reference Data root in the Project Management tree. The software
also creates a default permission group folder and a default permission group for the
new catalog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 46/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

7. Click Database > New > Model to associate the new catalog with a model.

Create a new model (MS SQL Server database)

Create a new model (Oracle database)

You can bulkload data into the new catalog at any time. For more information about
loading information into a new catalog, see Smart 3D Reference Data.

You can also use the Database Wizard to create a new catalog. For more information,
see Create a new catalog in the active site Oracle database or Create a new catalog in
the active site SQL Server database.

Create a new model (MS SQL Server model database)

You must have administrator privileges on the site database to create a new model.

The computer on which you create the new model must have Project Management and
Server Connectivity options installed.

1. Open Project Management.

If Project Management does not point to the appropriate database, errors result
when you open that database. To correct this problem, close Project Management, and
use Modify Database and Schema Location to change the site database that the task is
viewing. For more information about this utility, see the Smart 3D Installation Help.

2. Select the Models root in the Project Management tree.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 47/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

3. Click Database > New > Model to open the New Model Dialog.

4. On the General tab, type a name for the new model. Optionally, type values for
Description, Site, and Owner.

5. Select the type of model to create: Plant, Marine, Platform, or Material Handling.

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

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 to create the new model.

When processing completes, the software adds icon for the new model in the Project
Management tree. As with the new catalog database, the software creates a default
permission group folder and default permission group. An icon for the Interference
Detection Service ( ) also displays in the tree view.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 48/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

To view and change descriptive information about the model, including giving it a
different name or modifying access permissions, use the Properties Command .

Create a new model (Oracle model database)

1. Open Project Management.

If Project Management does not point to the appropriate database, errors result
when you open that database. To correct this problem, close Project Management, and
use Modify Database and Schema Location to change the site database that the task is
viewing. For more information about this utility, see the Smart 3D Installation Help.

2. Select the Models root in the Project Management tree.

3. Click Database > New > Model to open the New Model Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 49/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

4. On the General tab, type a value for Name. Optionally, type values for Description,
Site, and Owner.

5. Select the type of model to create: Plant, Marine, Platform, or Material Handling.

6. On the first row of the Databases tab, select Catalog as Type, and define the following
values:

a. Service - Select the Oracle net service for the catalog database.

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

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 Index table space path boxes, specify the path for the
location of the model database files and model index table space.

11. Click OK to create the new Oracle model.

When processing completes, the software displays an icon for the new model in the
Project Management tree. As with the new catalog database, the software creates a
default permission group folder and default permission group. An icon for the
Interference Detection Service ( ) also displays in the tree view.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 50/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

After you create a new Oracle model, you must run the Oracle Role Creation Utility to
create the necessary schemas, users, and roles that are used to run the software. For
more information, see Create Oracle roles.

To view and change descriptive information about the model, including giving it a
different name or modifying access permissions, use the Properties command.

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 Databases tab of
the Model Properties Dialog.

Define a model hierarchy

After you have created the project databases, you use the New Permission Group Folder
Command and New Permission Group Command commands to create the model
hierarchy. See Create permission group folders and permission groups.

Create permission group folders

Permission group folders are containers for permission groups. In this way, they serve as the
foundation of your permissions hierarchy.

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 Project Management tree. In
the example, the Project1 model is selected.

2. Click New Permission Group Folder Command to open the New Permission Group
Folder Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 51/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

3. Type a logical name for the permission group folder. For example, type Modeling to
create a folder to contain different design groups, and then click OK.

The new permission group folder displays in the hierarchy under the selected object

4. Continue creating permission group folders as needed for your project. The model in the
example has three permission group folders.

After you create the hierarchy for your model, you can view and change the permission
group folder properties. See Properties Command and Define Permission Group Folder
Properties Command.

A folder can nest inside another folder.

You can nest multiple levels of folders.

You cannot drag folder to other locations within the hierarchy.

Create permission groups

1. Select the default permission group folder or a permission group folder that you created.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 52/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. Click New Permission Group Command to open the New Permission Group Dialog.

3. Type a name for the permission group, and then specify the workshare location where
the permission group should be used. You can use logical permission group names that
associate the workshare location with a permission group. For example, if you create a
permission group for piping users located at the Huntsville location, you can name the
group HSV Piping.

4. Click OK.

The software adds the permission group to the hierarchy under the selected permission
group folder.

5. Continue adding permission groups as needed to build your model hierarchy. An

example is shown below.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 53/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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

You can define custom properties for the permission group using Database > Define
Properties > Permission Group.

After you create a new permission group, you can edit the properties assigned to it by
selecting it and clicking Edit > Properties Command. 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 that you create in Project Management display in the Active
Permission Group box on the horizontal toolbar of Smart 3D. When you create an

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 54/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

object in Smart 3D, the software associates that object with the active permission group.

Set up user access

You assign access permissions to the seven databases and to the SharedContent folder. You
can also grant Read, Write, or Full Control access to groups and users at the model and
catalog root level and at the permission group level.

You must use Windows-based domain groups and accounts to administer users in a
multi-machine configuration.

Permissions granted at the model and catalog level enable access to modify the permission
objects hierarchy and perform certain administrative tasks. Permissions granted at the
permission group level affect access to objects within that permission group and defines the
actions that are available when working with the software. Typically, this is the type of access
for general modeling purposes.

When a design object is placed in the model, the software automatically assigns it to the
specified permission group. An object can be modified or deleted only if the user has access
to the permission group assigned for the object. For 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 55/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

equipment was placed. Because the user does not have permission, the equipment does not
move to its new location. Instead, 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. See the Common Help for more
information about the To Do List.

Approval status and access permissions

In addition to permission groups, the approval status of an object controls the ability to modify
an object during the phases of a project. The approval status of an object can range from
Working, In Review, Rejected, or Approved.

Object status Description

Working Initial status of all objects. Objects can be

edited or deleted while in Working status.

In Review Object is in read-only mode and waiting for

approval/rejection.

Rejected If an object is found to be incorrect, the

reviewer can set the status to Rejected.

Approved If an object is found to be correct, the

reviewer can set the status to Approved.

You set object status on the Configuration tab of the object's property dialog

The graphic below summarizes the types of design and status changes that are allowed with
each permission access level.

Create/Modify/ Send to review/ Approve/

View
Delete bring back reject

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 56/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Read

Write

Full Control

Assign access permissions for SQL databases

This procedure is for SQL Server 2016. If you are using Oracle, see Assign access
permissions to the Oracle databases.

Perform the following steps on the database server computer.

1. Open Microsoft SQL Server Management Studio and expand your database server
in the left tree view.

2. Expand the list under Security in the left tree view.

3. In the left pane, right-click Logins.

4. Select New Login from the shortcut menu.

5. On the Login - New dialog, type the user account you want to be assigned
administrative privileges in the Login name text box. For example, type AdminUser1.

6. Select Server Roles under the Select a page heading to display the Server Roles list.

7. In the Server Roles list, for an administrator user select the sysadmin and public
check boxes. For a standard user, select the public role only. By default, users with
sysadmin privileges have administrator rights to all databases.

8. Select OK.

9. To assign permissions for a user or a group of users, follow steps 10 to 14.

10. Select User Mapping under the Select a page heading to display the Users mapped
to this Login list.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 57/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

11. Select the Map check box for one of the seven databases containing a Smart 3D
project.

12. Specify the database roles using the Database role membership list:

For an administrator user, select db_owner and public.

For a standard user, select public, db_datareader, and db_datawriter.

13. For a standard user, right-click the database name and select Properties.

a. Select the user login and on the Permissions, select the Explicit tab and grant
Execute.

b. Select the Effective tab and check that the standard user has the permission:
CONNECT, DELETE, EXECUTE, INSERT, SELECT, UPDATE permissions.

The six permissions above are required. A user might have additional
permissions but they are not required for a Smart 3D standard user.

14. Select OK.

15. Repeat the procedure for each of the remaining six databases.

Assign access permissions for Oracle databases

The Reference Data installation delivers a set of script files. You must use these script files to
create the necessary schemas, users, and roles that are used to run the software. The scripts
must be run in the order listed.

Create Roles for Smart 3D users:

SP3DUser_ROLES.SQL

SP3DProjectAdministrator_ROLES.SQL

Create users for Smart 3D:

SP3DUser.SQL (for Oracle) or Linux_SP3DUser.SQL (for Linux)

Create Administrative users:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 58/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

SP3DProjectAdministrator.SQL (for Oracle) or Linux_SP3DProjectAdministrator.SQL

(for Linux)

Running these scripts is typically part of setting up the database server. See
Initialize the Oracle Database in the Smart 3D Installation Help.

Assign permissions to the SharedContent folder

1. Use Windows Explorer to navigate to the SharedContent folder on the reference data
computer.

2. Right-click the SharedContent folder, and then click Properties to open the
SharedContent Properties dialog .

3. Select the Sharing tab, and then click Advanced Sharing.

4. Select Share this folder, and then click Permissions.

5. Click Add permissions as needed so that the appropriate users or user group has Full
Control access to the folder. In the example, the S3DQAUsers group has been given
Full Control access.

6. Click OK until you return to the Sharing tab.

7. Select the Security tab, and modify security permissions to add the specified group with
Full control access.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 59/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

8. Click OK, and then click Close.

Assign permissions to the catalog and the model

1. Select the catalog in the Project Management tree.

2. Click Permissions Command on the toolbar to open the Access Permissions Dialog.

3. Click Add to open the Add Users and Groups Dialog.

4. Double-click 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. For more information, see Add Users and
Groups dialog.

You can also click Add and search for users using the Select Users and Groups
dialog. This is a common Windows dialog. For information regarding the options in
this dialog box, see your Windows documentation.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 60/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

7. Select the model in the Project Management tree.

8. Repeat steps 2 through 6 to assign permissions to the model.

Add users to permission groups

1. Select a permission group in the Project Management tree.

2. Click Permissions Command on the toolbar to open the Access Permissions Dialog.

3. Click Add to open the Add Users and Groups Dialog.

4. Double-click 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. For more information, see Add Users and
Groups dialog.

You can also click Add and search for users using the Select Users and Groups
dialog. This is a common Windows dialog. 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 61/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

6. Click OK, then click OK again to close the Access Permissions dialog.

Work with Smart 3D databases

Create new Perform database Create a backup of Restore databases

databases maintenance the model from backup

Upgrade the model Convert my Synchronize the

databases to a model with the
different type catalog

Create new databases

The software provides you a lot of freedom when it comes to creating any of the seven Smart
3D databases. For example, you can create both Oracle-based and SQL Server-based

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 62/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

databases. You can create the site and catalog databases in tandem, or you can the site and
catalog databases separately.

Create new site, catalog, and schema databases for SQL

This procedure is for SQL Server databases. If you are using Oracle, see Create new site,
catalog, and schema databases for Oracle.

1. Open the Database Wizard, select Create a new site, and then click Next.

2. From the Database type list, select MSSQL.

3. Select the name of the server in the Site database server list on which your site
database will reside. Only registered SQL Servers display in the Site database server
list. If your server is not listed, see Register the Microsoft SQL Server in the Smart 3D
Installation Help.

4. Type the name of your site database in the Site database name box. Include the type
of database in the name you type. Using the database type in the name makes
identifying the site database in SQL Server Management Studio easier. For example,
type Project1SiteDB (where DB stands for database) or Project1_SDB (where SDB
stands for site database).

When you name the site database, the site schema server and site schema name
default to match the site database server and name.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 63/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

5. Type the workshare location for the site database in the Site database workshare
location text box. 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. You can use any string that represents your physical location.

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

7. Type the name of the server computer on which the Name Generator Service is
configured in the Name generator server for site box. The 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. If you do not have a name generator server set up,
see Name Generator Service Setup in the Smart 3D Installation Help.

8. Use the default paths for the site database files in the Physical database and Log file
boxes.

9. Click Browse to the right of the Template file to be used to create site schema
text box.

10. If you installed the reference data on your database server, navigate to the [Installation
folder for Smart 3D Reference Data]\DatabaseTemplates\<model type> folder.

If you did not install the Smart 3D reference data on your database server, you must
copy the files in the [Installation folder for Smart 3D Reference
Data]\DatabaseTemplates\<model type> folders on the reference data computer to a

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 64/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

folder on a local drive on the database server computer. You need the files in the Plant,
Marine, or MaterialHandling folder.

11. Select apprepos.dat. This is the file that the software uses when creating your site
schema database.

12. Click Next to go to the Catalog Database and Schema page.

13. Select Restore catalog from backup. This option restores a catalog from a Microsoft
SQL Server backup file. When you choose to create a new catalog database for the site
using this option, the wizard restores the .dat file that you specify in the Template file to
be used to create the Catalog database and schema box. Default catalog database
.dat files are delivered in the Plant, Marine, or MaterialHandling folder in the [Installation
folder for Smart 3D Reference Data]\DatabaseTemplates folder.

14. Select the name of the server in the Catalog database server list on which your
catalog database will reside.

15. Type the name of your catalog database in the Catalog database name box. Include
the type of database in the name that you type. Using the database type in the name
makes identifying the catalog database in SQL Server Management Studio easier. For
example, type Project1CatalogDB (where DB stands for database) or Project1_CDB
(where CDB stands for catalog database).

This step automatically populates the name of your catalog schema database in
the Catalog schema name text box.

16. Use the default paths for the catalog database files in the Physical database and Log
file boxes.

17. Click Browse 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 path in the

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 65/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Symbol and custom program file folder box must be a UNC path.

18. Click Browse 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 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\<model type> folder.

The catalogdb.dat (Plant), sm_shipcatalogdb.dat (Marine), and

mhe_catalogdb.dat (Material Handling) template files contain sample Smart 3D
reference data. Although the templates contain many useful examples, they are not
certified for production use.

19. Click Next.

20. On the Ready to Create Databases page, click Next to create the specified databases.

21. After the site, catalog, and schema databases are created, the wizard displays a
summary page. Click Finish to close the Database Wizard.

The Name Generator Service that you specify in the Name generator server for
site box (step 7) 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 entered 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.

Create new site, catalog, and schema database for Oracle

This procedure is for Oracle databases. If you are using Microsoft SQL Server, see Create
new site, catalog, and schema databases for SQL.

The dump files used to create the site and catalog database are delivered on the
server computer to [Product Folder]\3DRefData\DatabaseTemplates. This location must be
shared and write permissions given to both the user login used to create the 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 66/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

1. Open the Database Wizard, select Create a new site, and then click Next.

2. On the Create Site Database and Schema page, select Oracle from the Database
type list.

3. In the Oracle service list, select the name of the Oracle net service for the site
database connection.

4. Type the name of your site database in the Site database name text box.

To better differentiate between one database and another, include the type of
database in the name you type. For example, type Project1SiteDB (where DB
stands for database) or Project1_SDB (where SDB stands for site database).

Do not use a name which starts with a digit as its first character. For example, if
you enter a name such as n, 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.

Oracle site database name cannot exceed 21 characters.

5. Type the workshare location for the site database in the Site database workshare
location text box. 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. You can use any string that represents your physical location.

6. Type a name rule ID in the Name rule ID text box. By default, the software leaves this
field blank. You can use any string identifier, numeric or alpha. However, special
characters are not supported/

7. In the Name generator server for site box, type the name of the server computer on
which the Name Generator Service is installed. The 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. If you do not have a name generator server set up, see Name
Generator Service Setup in the Smart 3D Installation Guide.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 67/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

8. Use the default paths for the site database files in the Data tablespace file name and
Index tablespace file name boxes.

9. Click Browse 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.

10. Click Next to go to the Catalog Database and Schema page.

11. Select Restore catalog from backup. When you choose to create a new catalog
database using this option, the wizard restores the .dmp file you specify in the Template
to be used to create the Catalog database and schema box.

12. Select the name of the server in the Catalog database server list on which your
catalog database will reside.

13. Type the name of your catalog database in the Catalog database name box .Include
the type of database in the name that you type. For example, type Project1CatalogDB
(where DB stands for database) or Project1_CDB (where CDB stands for catalog
database).

14. Use the default paths for the catalog database files in the Data tablespace file name
and Index tablespace file name boxes.

15. Click Browse 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 path in the
Symbol and custom program file folder box must be a UNC path.

16. 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 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> folder.

The catalogdb.dmp (Plant), sm_shipcatalog.dmp (Marine), and

mhe_catalogdb.dmp (Material Handling) template files contain sample reference data.
Although the templates contain many useful examples, they are not certified for
production use by Smart 3D.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 68/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

17. Click Next.

18. On the Ready to Create Databases page, click Next to create the specified databases.

19. After the the site, catalog, and schema databases are created, the wizard displays a
summary page. Click Finish to close the Database Wizard.

The Name Generator Service that runs on the server computer that you specify in the
Name generator server for site box (step 7) 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 you type 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.

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 site and catalog database template names
and their respective folder paths must be typed correctly when creating the site and
catalog databases.

Create a new site database for SQL

This procedure is for SQL Server 2016. If you are using Oracle, see Create a new site
database for Oracle.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 69/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Project1SiteDB
(where DB stands for database) or Project1_SDB (where SDB stands for site
database).

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.

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 Smart 3D Installation Guide.

g. Use the default paths for the site database files in the Physical database and
Log file boxes.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 70/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

3. Click Browse 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.

4. Select apprepos.dat. This is the file that the software uses when creating your site
schema database.

5. Click Next.

6. On the Catalog Database and Schema page, select Use existing catalog, and then
click Next.

7. On the Ready to Create Databases page, click Next to create the specified databases.

8. After the the site and site schema databases are created, the wizard displays a
summary page. Click Finish to close the Database Wizard.

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 you type 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 71/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Create a new site database for Oracle

This procedure is for Oracle. If you are using Microsoft SQL Server, see Create a new site
database for SQL.

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

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 72/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

6. When the Database Wizard displays the site database names that you typed, click
Finish.

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.

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 you type 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.

Change the active site database

1. Open the Database Wizard, select Create a new catalog, select name generator server
for site, or select existing site, and then click Next.

2. On the Select Site Database and Schema page, select the type of database from the
Database type list.

3. For SQL Server databases, 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 Oracle databases, select the name of the Oracle net service in the Oracle service
list for the site database.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 73/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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

6. In the Site schema name list, select the site schema database you want to activate.

7. Click Next.

8. On the Catalog Database and Schema page, select Use existing catalog already on
server.

9. Click Next.

10. On the Ready to Make Changes page, click Next to activate the site databases you
selected.

11. When the Database Wizard displays the database names that you typed, click Finish.

12. Click Close to exit the Database Wizard.

You use the New Model Command to create a new model database. Part of the
process includes selecting the catalog database to associate with the new model. If using
SQL databases, see Create a new model (MS SQL Server database). If using Oracle, see
Create a new model (Oracle database).

Create a new catalog

The following procedure is applicable for both SQL and Oracle databases.

1. Open Project Management, and then click Database > New > Catalog to open the New
Catalog Dialog.

2. Specify the Catalog information as needed for the new catalog database. The software
specifies Schema information based on what you enter for Catalog information.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 74/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

3. To create a new empty catalog, select Create an empty catalog, and navigate to the
Apprepos.dat file. An empty catalog is a a catalog databases that contains all of the
necessary tables, stored procedures, views, and objects but does not contains any
modeling data, such as part data or specifications.

To create a catalog from a template, select Create a new catalog from a template and
specify the Plant, Marine, or Material Handling template file to use in creating the
catalog database and schema.

If you are running Oracle on Linux, then the database template must be on the
Linux computer where the Oracle service is running.

Linux is a case-sensitive environment. The database template name and the folder
path must be typed correctly when creating the database. The Browse feature is
not available for navigating to Linux folder locations.

4. For SQL databases, browse to locate the Physical database and Log file. For Oracle
databases, type the Data tablespace file name and the Index tablespace file name.

5. Click Browse 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.

6. Click OK to create the new catalog.

A progress bar displays while the software creates the catalog and catalog schema
databases. After the software creates the new catalog, the software adds the new
catalog under the Reference Data root in the Project Management tree. The software
also creates a default permission group folder and a default permission group for the
new catalog.

7. Click Database > New > Model to associate the new catalog with a model.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 75/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Create a new model (MS SQL Server database)

Create a new model (Oracle database)

You can bulkload data into the new catalog at any time. For more information about
loading information into a new catalog, see Smart 3D Reference Data.

You can also use the Database Wizard to create a new catalog. For more information,
see Create a new catalog in the active site Oracle database or Create a new catalog in
the active site SQL Server database.

Create a new catalog in the active site SQL Server database

This procedure is for SQL Server 2016.

1. Open the Database Wizard, select Create a new catalog, select name generator server
for site, or select existing site, and then click Next.

2. On the Select Site Database and Schema page, select MSSQL from the Database type
list.

3. 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. See the Smart 3D Installation Help.

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

5. Select the name of the server in the Site schema server list on which the site schema
database currently resides.

6. In the Site schema name list box, select the site schema database you want to
activate.

7. Click Next.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 76/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

8. On the Catalog Database and Schema page, select Restore catalog from backup.

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

10. Use the default paths for the catalog database files in the Physical database and Log
file boxes.

11. Click the Browse nutton 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.

12. Click the Browse 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\.

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 Hexagon Asset Lifecycle Intelligence.

13. Click Next.

14. On the Ready to Make Changes page, click Finish.

15. When processing completes, click Close.

You use the New Model Command to create a new model database. Part of the
process includes selecting the catalog database you want to associate with the new model.
See Create a new model (MS SQL Server database).

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 77/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

The dump files used to create the site and catalog databases are delivered on the
reference data computer to the [Product Folder]\3DRefData\DatabaseTemplates folder.
This location must be shared and write permissions given to both the user logon 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, click Create a new catalog, select name generator server
for site, or select existing site, and then click Next.

2. On the Select Site Database and Schema page, select Oracle from the Database type
list.

3. In the Oracle service list, select the name of the Oracle net service for the site
database connection.

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

5. Select the name of the Oracle net service for the site schema database connection in
the Oracle service list.

6. In the Site schema name list box, select the site schema database you want to
activate.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 78/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

7. Click Next.

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

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

10. Use the default paths for the catalog database files in the Physical database box.

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

12. Click the Browse button 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.

13. Click Next.

14. On the Ready to Load Databases page, click Finish.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 79/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

15. 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 New Model Command to create a new model database. Part of the process
includes selecting the catalog database you want to associate with the new model. See
Create a new model (Oracle database).

Create a new model (MS SQL Server model database)

You must have administrator privileges on the site database to create a new model.

The computer on which you create the new model must have Project Management and
Server Connectivity options installed.

1. Open Project Management.

If Project Management does not point to the appropriate database, errors result
when you open that database. To correct this problem, close Project Management, and
use Modify Database and Schema Location to change the site database that the task is
viewing. For more information about this utility, see the Smart 3D Installation Help.

2. Select the Models root in the Project Management tree.

3. Click Database > New > Model to open the New Model Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 80/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

4. On the General tab, type a name for the new model. Optionally, type values for
Description, Site, and Owner.

5. Select the type of model to create: Plant, Marine, Platform, or Material Handling.

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

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 to create the new model.

When processing completes, the software adds icon for the new model in the Project
Management tree. As with the new catalog database, the software creates a default
permission group folder and default permission group. An icon for the Interference
Detection Service ( ) also displays in the tree view.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 81/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

To view and change descriptive information about the model, including giving it a
different name or modifying access permissions, use the Properties Command .

Create a new model (Oracle model database)

1. Open Project Management.

If Project Management does not point to the appropriate database, errors result
when you open that database. To correct this problem, close Project Management, and
use Modify Database and Schema Location to change the site database that the task is
viewing. For more information about this utility, see the Smart 3D Installation Help.

2. Select the Models root in the Project Management tree.

3. Click Database > New > Model to open the New Model Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 82/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

4. On the General tab, type a value for Name. Optionally, type values for Description,
Site, and Owner.

5. Select the type of model to create: Plant, Marine, Platform, or Material Handling.

6. On the first row of the Databases tab, select Catalog as Type, and define the following
values:

a. Service - Select the Oracle net service for the catalog database.

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

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 Index table space path boxes, specify the path for the
location of the model database files and model index table space.

11. Click OK to create the new Oracle model.

When processing completes, the software displays an icon for the new model in the
Project Management tree. As with the new catalog database, the software creates a
default permission group folder and default permission group. An icon for the
Interference Detection Service ( ) also displays in the tree view.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 83/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

After you create a new Oracle model, you must run the Oracle Role Creation Utility to
create the necessary schemas, users, and roles that are used to run the software. For
more information, see Create Oracle roles.

To view and change descriptive information about the model, including giving it a
different name or modifying access permissions, use the Properties command.

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 Databases tab of
the Model Properties Dialog.

Regenerate the Reports databases

For performance reasons, the Reports and Reports schema databases are not replicated
from the Host location and must be locally generated at each Satellite location.

Before starting this procedure, check with your administrator to verify that all
users are disconnected from the database.

1. Select a model in the Project Management tree.

2. Click Edit > Regenerate Reports Database Command to open the Regenerate Reports
Database Dialog. The software automatically assigns the Model database server value
as the Reports database server and Reports schema server.

3. Review he information displayed for the reports databases and servers, and edit as
needed.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 84/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 to display the
Server Properties dialog.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 85/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Create a login with SQL server authentication for both servers

1. Right-click <ServerName> > Security > Logins, and select New Login to display the
Login - New dialog.

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.

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

5. Repeat these steps for the other server.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 86/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 to display the New Linked Server dialog.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 87/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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] is the name of the other server.

[dbname] and [tablename] are 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 on both server A and the linked
server:

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 88/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 89/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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:

Select * from dual@<global db name>

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

Perform database maintenance

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. The following Project Management commands
help you manage your project databases to better maintain optimal performance.

Database Maintenance

The Database > Maintenance command provides a tool to purge temporary data that might
cause performance issues. For example, you can delete temporary symbol variations (or
flavors) in the database. The software uses these temporary symbol variations during creation
or placement of certain symbols.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 90/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

You can use this command to delete records of objects that users have deleted from the
model. The command also enables you to rebuild and reorganize selected indexes.

Database Integrity

The Database > Integrity command verifies the consistency of model objects. The process
runs directly on a database (site, catalog, model, or reports) and creates records for objects
that need to be cleaned. Objects with database integrity problems can interfere with modeling
activities or impact the accuracy of project deliverables, such as drawings or reports. A typical
example of a database integrity issue is an object that exists without a mandatory relation to
another object in the model.

The workflow to address database integrity issues has three steps:

1. Run the Database > Integrity command.

2. Generate a report to review found issues.

3. Use the Clean Database custom command to address problems.

Hexagon PPM recommends that you check your databases regularly and promptly
report any unknown problems to customer support.

Database integrity errors are not expected. However, if they do occur, you can correct
them by performing the workflow outlined for the database integrity error in the
Database Integrity Reference documentation.

If you receive a database integrity error that is not listed in the documentation, contact
customer support.

Clean Database

The Clean Database custom command cleans the catalog or model database objects to
address issues found by running the Database > Integrity command. For more information,
see Clean a database.

Database Backup

The Tools > Backup command saves backup copies of the selected model databases and
their associated site and catalog databases to a single folder. An established backup plan is

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 91/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Purge temporary objects from the database and optimize indexes

1. Select a model database in the Project Management tree.

2. Click Database > Maintenance Command to open the Database Maintenance Dialog.

3. Select Delete temporary symbol variations (flavors) in database and Delete

database objects that users have deleted from model.

4. Click Analyze to open the Analyze Database Window, which displays the number of
deleted database objects and temporary flavors found in the selected database.

5. Click Close, and then click OK.

6. Click Yes, acknowledging that the process might take some time to complete.

7. Under Index optimization, select Rebuilt selected indexes.

The software lists the database tables with index fragmentation.

8. Select the database tables to rebuild, and then click OK.

The software displays a warning prompting you to verify that no users are connected to
the databases.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 92/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

9. After confirming that all users are disconnected, click Yes.

10. When processing completes, click Cancel to close the dialog.

11. 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 information about checking database integrity, see Database Integrity.

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.

Check database integrity

1. Select a model, catalog, or site in the Project Management tree. Your selection
determines the databases available for checking database integrity:

Select a model to check all of the databases associated with that model.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 93/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Select a catalog to check only the catalog database.

Select a site to check only the site database.

2. Click Database > Integrity Command to open the Check Data Consistency Dialog.

3. Select one or more databases to process.

4. Select Basic check. Selecting Basic Check runs a faster database check that looks for
the most common problems. You can run the basic check on a regular basis. Selecting
Full check runs a deep integrity check that looks for any type of problem. Because a full
check takes considerably longer to complete, we recommend doing so on an infrequent
schedule, such as once a week, or when an uncommon problem is encountered.

5. Click Run to start the command.

6. When processing completes, click Exit to close the dialog.

7. Open the Temp folder, and review each error log created by the database integrity
check. Verify that there are no catastrophic failures by looking for the word error or
making sure that the command completed successfully on each database. See
Intergraph Smart 3D Database Integrity Administration Help.

The DbIntegrityCommandLine-PlantName.txt file is also saved in the Temp folder. This

file contains the command line you need if you choose to run Database Integrity on a
batch script.

You can use Intergraph Batch Services to schedule this task to run on a regular basis.
See Schedule Check Data Consistency task using Batch Services.

Generate a catalog report of database integrity error messages

1. Click Tools > Run Report Command to open the Run Report Dialog.

2. On the Catalog Reports tab, expand the Types of Reports > Diagnostic node.

3. Select Diagnostic Clean Database Issues report.This report reflects any problems
found or fixed by the Database Integrity command.

Selecting one of the following report types is also appropriate:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 94/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Diagnostic Clean Database Issues Grouped by Problem Description

Diagnostic Clean Database Issues Grouped by Status

Diagnostic Clean Database Issues with Column Filters

4. Click Run. An example of the Excel report output is shown below:

Reports can be created persistently in Drawings and Reports and scheduled in the
drawing batch server to run periodically after a scheduled database integrity (DBI) check.

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 model Project SQL Backup

with Managemen
Catalog t Backup

Bulkload Bulkload Risk - No No No Risk

Synchroniz Risk No - No No Yes

e Model

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 95/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

with
Catalog

Regenerate
Risk No No Slow Slow No
Report DB

DB Database
Slow Yes Slow Yes Yes Slow
Maintenanc Integrity
e

Clean DB
Risk Yes Yes Yes Yes Yes
Command

DB
Maintenanc No No No No No No
e

Check
Fragmentati Yes Yes Yes No No Yes
on

Backup Project
Managemen Yes No No - Slow Yes
t Backup

SQL Backup Yes No No Slow - Yes

Report & Report

Yes Yes Yes Yes Yes Yes
Drawing Extraction

Drawing
Yes Risk Yes Yes Yes Yes
Extraction

SPR SPR Data

Slow Slow No Yes Yes Yes
Creation

IFC IFC Yes Yes Yes Yes Yes Yes

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 96/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Attach/Deta Attach/Deta
ch R3D ch R3D Slow Slow Slow Slow Slow Slow
Models Models

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.

Smart 3D Rule Checker Service

When some database intensive tasks are in progress, the Rule Checker service needs to be
stopped. Follow the guidelines provided in the table.

Can Rule Checker run? Comment

Recommend stopping the service

if Bulkload involves:

adding interfaces to
model objects

Bulkload Yes updating views

modifying objects in
the catalog for
Bulkload objects placed in the
model

Stop the service until the

Synchronize Model with Catalog No
Synchronize process finishes.

Filters in the model depend on the

Reports database views. As such,
Regenerate Report DB No
filters can fail if the Reports
database is being regenerated.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 97/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Database Integrity Yes

Recommend stopping the service.

The Clean DB command can
delete objects, potentially causing
Clean DB Command Yes
concurrency issues while Rules
are trying to access/modify an
object..

DB Maintenance

Strongly recommend stopping the

DB Maintenance No
service.

Strongly recommend stopping the

service as running it can slow
Check Fragmentation Yes down the SQL Server resources
available to the RuleChecker
process.

Recommend stopping the service

Logical Backup Yes
to produce a meaningful backup.

Recommend stopping the service

SQL Backup Yes
to produce a meaningful backup.

Restart the service from the

Backup / Retrieve Plant Retrieval (Overwrite) No
beginning.

Recommend stopping the service.

This command can delete/paste
objects, potentially causing
Selective Recovery of Objects Yes
concurrency issues while Rules
are trying to access/modify an
object.

Report Extraction Yes

Report & Drawing

Drawing Extraction Yes

SPR SPR Data Creation Yes

IFC IFC Yes

Modeling Modeling Yes Depending on the Rules logic,

such as whether objects are being
updated, it is possible to end up in
a concurrency situation. We
strongly recommend increasing
the delay time. Note that an

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 98/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

increased delay time only reduces

the chances of concurrency issues
but does not completely eliminate
them.

When a concurrency error

happens, one of the transactions
will be aborted. Should this
happen to the RuleChecker's
Rule's transaction, you will need to
scan the log files for the objects
included in that transaction and
then modify them to bring them
back into the queue of objects
processed by RuleChecker.

Clean a database

In some cases, cleaning objects causes a loss of data. Before working through this
procedure, try to find a matching error message in the Database Integrity Help. The
What You Should Do section of each error topic may contain steps that fix the error
without loss of data.

Before running this command, make a backup of all the databases. You can later
provide this backup to customer support if further analysis is needed. See Backup
Command.

1. Start the software.

2. Click Tools > Custom Commands.

3. Click Add on the dialog.

4. In the Command ProgID box, type SP3DCleanDatabaseCmd.CCheckObj.

5. In the Command name box, type descriptive text, such as Clean Database.

6. Click OK on the Add Custom Command dialog.

7. Select the command, and then click Run to display the Clean Database Dialog.

8. Specify the type of database in the Database type box.

9. In the grid, select the objects to clean and click Clean Now.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 99/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

10. When the process finishes, click View Log and review the log file. It is possible that the
cleaning operation was not successful.

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.

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.

Clean Database Dialog

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 100/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

Learn about 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 101/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. 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. See Backup Command.

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. 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. See Statistics Used by the Query Optimizer and UPDATE STATISTICS
(Transact-SQL) in SQL Server Help.

Create a backup of the model

The Backup Command creates a backup set that includes the selected model database and
its associated site and catalog databases. The reports and reports schema databases are not
included in the backup set.

During the backup process, the software creates a single backup configuration file (.bcf) that
contains information about the backup set. The software saves the backup configuration file
on the database server in a folder location that you have specified. A log file recording the

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 102/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

results of the backup process and describing any problems is also created in the specified
backup location.

To complete the backup set, you must manually backup the SharedContent folder for the
model.

Backup schedule

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. See
Backup Command.

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.

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.

Create a backup file

1. Click Tools > Backup Command to open the Backup Dialog.

2. In the Select model to back up list, select one or more models 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. If you are
backing up an Oracle database model, this calculation could take several minutes.

The size displays in the Size column.

4. In the Select folder and name for backup configuration file, specify the destination
folder for the .bcf and log file. Select a folder on a drive that has sufficient space to hold
the backup.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 103/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. If possible, save the .bcf and the database files in the same
folder location.

When backing up SQL databases, you can use Browse(…) to navigate to the
folder location on the server or you can use Browse(…) in the Browse window to
navigate to a UNC location.

When backing up Oracle databases, you must specify a location that is shared.
You can use Browse(…) to navigate to a UNC 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. 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 to begin the backup process.

7. Click Yes in the Project Management message box to review the results of the backup
in the log file. Otherwise, click No.

8. Click Cancel to close the Backup dialog.

To send the backup files to another location, create a .zip file that contains all of the
files.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 104/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

Restore databases from backup

To restore your databases from backup, you first use the Database Wizard to restore the site
database. You then use the Restore Wizard to restore the model database using one of the
three options.

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.

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 Restore a Site Database from Backup page, select the type of database from the
Database type list.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 105/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 the Browse button
to navigate to 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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 106/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

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.

Restore one or more model databases 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.

1. Click Tools > Restore Command to open the Restore Wizard.

2. Select 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 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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 107/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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 displays a warning that a catalog database with the name that you have
specified already exists in the server location. You can leave the existing catalog in
place (that is, link it to the restored model) or restore the catalog database from the
backup.

11. Click No to also restore the catalog from backup. See Fully restore an existing model
from backup for information about restoring a model and using a linked catalog
database.

12. When the restore is complete, click OK and view the log file.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 108/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

When you restore a model to an existing catalog, the restored reports database must
accurately reflect the catalog and model databases. You must regenerate the reports
database if one of the following conditions exists:

The catalog database has a different structure.

The model is restored off-site (that is, at another workshare location).

If you are using Oracle databases, run the Oracle Role Creation Utility to define specific
user roles for each schema or collection of schemas if necessary.

Restore a backup model for selective recovery in an active model

1. Click Tools > Restore Command to open the Restore Wizard.

2. Select 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 want to restore.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 109/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

7. For SQL Server databases, specify values for Server, Database Name, Database
Path, and Log Path.

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. If you choose not to type
a different name, the software the original name of the model being restored (1) with the
current date (2) by default.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 110/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

9. Type a description in the Description box.

10. Click Finish.

11. Select Yes to link the restored model to the existing catalog database.

12. Click OK to view the log file, and then close the Restore Wizard.

The software displays newly restored model in the Project Management tree. The
(Plant model), (Marine model), and (Material Handling) icons indicate that the
model is missing a database.

13. Right-click the newly restored database, and then click Regenerate Reports Database
Command.

14. Click OK in the message box box to create the reports databases, and then click OK to
close the message box.

15. Open the restored model in one session of Smart 3D.

16. Open the active model in another session Smart 3D.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 111/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

17. Use the Paste and Restore Command to copy objects from the restored model to the
active model. See Restore model objects from backup in the Common Help.

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.

When you finish restoring selected objects into the active model, you should delete the
restored backup model.

If you are using Oracle databases, run the Oracle Role Creation Utility to define specific
user roles for each schema or collection of schemas if necessary.

Restoring a Smart 3D model currently registered with SDx using the Restore a backup
model for selective recovery in an active model option clears all SDx registration
details. To recover your data, you must first re-register the restored model to the same
SDx plant as was used for the previous SDx registration. After you re-register the
restored Change Management model, you must define SDx retrieval settings.

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.

1. Click Tools > Restore Command to open the Restore Wizard.

2. Select 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 to restore.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 112/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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. 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. 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. 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 server for Name generator server for model.

12. Click Finish.

13. When the databases are restored, click OK.

14. Review the log file to verify restore operation integrity.

15. If necessary, right-click the restored plant in the Project Management tree, and then click
Regenerate Reports Database Command.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 113/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

You can use Restore model as Copy to restore 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.

After the restore process is complete, you need to regenerate the reports database. See
Regenerate the reports database.

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.

Fully restore an existing model from backup

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

You must first use the Database Wizard to restore the site and site schema databases
before restoring the other databases. For more information, see Restore a site
database.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 114/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

1. Click Tools > Restore to open the Restore Wizard.

2. Select Restore one or more model databases from backup, and then click Next.

3. Perform the standard restore steps. See Restore one or more model databases from
backup.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 115/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

10. Click Tools > Synchronize Model with Catalog for the restored model.

11. Allow users to resume work in the production 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.

Fully restore an existing catalog from backup

You must first use the to restore the site and site schema databases before
restoring the other databases. For more information, see Restore a site database.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 116/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

1. Click Tools > Restore Command to open the Restore Wizard.

2. Click Restore Wizard, and then click Next.

3. Perform the standard restore steps. See Restore one or more model databases from
backup.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 117/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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 Command to open the Restore Wizard.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 118/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. Click Restore model for selective recovery of model objects , and then click Next.

3. Perform the standard restore steps. See Restore a backup model for selective recovery
in an active model.

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.

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. Run Tools > Synchronize Model with Catalog Command 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. See Managing Catalog Changes in the Catalog
Help.

Schedule data restore using Batch Services

1. In Project Management, click Tools > Restore Command to open the Restore Wizard.

2. Select Restore one or more model databases from backup, and then click Next.

3. Perform the standard restore steps.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 119/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

4. Click Submit Job.

5. Complete the options in the Schedule [Task] Dialog.

6. Complete the Restore Options for Batch Process dialog.

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.

Upgrade the model

Database upgrades are required whenever there is a major change of software version.
Upgrading your databases from a previous version to the latest installed software version
involves several different tasks using the Database Wizard and the Upgrade Version
Command.

You can only upgrade a model configuration using the same database type, that is
Oracle to Oracle or SQL to SQL. 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. See
Convert my databases.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 120/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Backup the catalog and model databases before beginning the upgrade process.

Upgrade the site and site schema databases

PPM recommends that you back up the databases prior to beginning the upgrade
process. For more information, see Create a backup file.

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.

1. Open the Database Wizard.

2. On the Introduction to Database Wizard page, select Upgrade site database and its
schema to your currently installed version.

3. Click Next.

4. On the Select Site Database and Schema to Upgrade 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. Only registered SQL Servers appear in
the Site database server list.

For Oracle databases, select the name of the Oracle net service in the Oracle service
list for the site database.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 121/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

upgrade process.

10. When the upgrade process is complete, click Done to close the Database Wizard.

A log file, SiteUpgrade_<site database name>.log, is generated during the upgrade

process and is delivered locally to C:\Documents and Settings\<your_user_name>\Local
Settings\Temp.

Upgraded the catalog and model databases

You must upgrade the site and site schema databases before upgrading the catalog and
model. See Upgrade site database and its schema to your currently installed version.

The software uses a specific icon to indicate a model or catalog database is out-of-date
(that is, older than the site database to which it is linked). An out-of-date- catalog
database displays with a icon. An out-of-date model displays with a (Plant model),
(Marine model), or (Material Handling model).

1. In the Project Management tree, select the catalog database to upgrade.

2. Click Tools > Upgrade Version Command to open the Upgrade Version Dialog.

3. In the Catalog grid, select the check box for the catalog and catalog schema databases
to upgrade. The software includes the Update Custom Symbol Configuration option
by default.

4. In the Model grid, select the check box for the model database to upgrade. The
software includes the Regenerate reports option by default. If you clear this option, you
must run the Regenerate Reports Database Command after upgrading the model.

5. Click Upgrade.

The software displays the upgrade status as each database is upgraded. When
processing completes. Click Cancel to close the dialog.

6. If needed, update the Excel reference data workbooks to fit the current software version.
Bulkload required changes to the catalog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 122/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

7. Synchronize the model with the catalog database using Tools > Synchronize Model with
Catalog Command. See Update a model globally with catalog changes.

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 database replication and use consolidation, which disables data transfer between
databases.

2. Backup the databases.

3. Disable the transfer of data between the host server and the satellite servers. For more
information, see Disable replication on a SQL Server instance.

4. Consolidate the replicated databases. Use Tools > Consolidate Model from Workshare
Command in Project Management to merge all replicated databases at the satellite
locations to the databases at the host location to form a single database of each type.
See Consolidate an existing SQL Server configuration. If you are using Oracle, see
Consolidate all Oracle databases.

5. 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 the site
and site schema using the Upgrade site and its schema to your currently installed
version option. See Upgrade the site and site schema databases.

6. Upgrade the catalog and model databases. Use Tools > Upgrade Version Command to
upgrade the catalog and model databases to the currently installed version. See
Upgrade the catalog and model databases.

7. Regenerate the reports database.

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-2018 4:48:59 PM Executing Parallel
MTMC Processing with 4 Processors."

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 123/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Synchronize the model with the catalog

The Tools > Synchronize Model with Catalog Command propagates changes from the
catalog to the model. The model database is updated to include the following changes:

Modifications to properties that have been bulkloaded into the catalog

Modifications to name rules

Parts that have been deleted from the catalog are added to the To Do List.

The actions that are performed depend on the level of access for the user running the
command from Project Management.

User with Write access to model objects:

Extended execution time

Model objects are updated automatically with no user interaction

User with Read access to model objects:

Reduced execution time

Objects are not updated automatically

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 Project Management tree.

3. Click Tools > Synchronize Model with Catalog Command to open the Synchronize
Model with Catalog Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 124/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

4. Select one or both of the options provided: Synchronize model with catalog and
Regenerate views.

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

7. Click Run 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.

Any object with an Approved status is ignored in the To Do List and is 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. See
Regenerate the reports database.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 125/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Review the Synchronize Model with Catalog error file

The software generates a log file (SynchronizeModelWithCatalogError.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.

Initial

Displays the number of items in the category at the start of the synchronization.

Approved

Displays the number of related objects that are approved in the category.

Processed/Out-of-Date

Displays the number of items the software processed or marked as Out-of-Date during the
synchronization.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 126/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Failed

Displays the number of proxy stoppers that failed to update the object in the model connected
to that proxy stopper. If the update of the related object fails, then Smart 3D considers the
proxy stopper as Failed. For example, updating the related object could result in an infinite
loop and fail. The synchronization log contains information when the proxy stopper fails.

Remaining

Displays the number of proxy stoppers that remain after the synchronization operation
completes. When the related object of a proxy stopper is read only (could be because of the
Approval Status or permissions), Smart 3D skips that proxy stopper/related object
combination. This situation creates a remaining proxy. The software does not consider read
only access to a related object as a failure, so these objects are not included in the Failed
column.

Deleted

Displays the number of deleted items.

Missing Catalog Objects

Lists the objects that have been deleted from the catalog, but are still referenced by other
objects in the model. To resolve the items on this list, remove the model objects that reference
these items. You can view the relevant model objects on the To Do list.

Convert databases to a different type

You can convert a Smart 3D Microsoft SQL Server database to an Oracle database or convert
a Smart 3D Oracle database to a Microsoft SQL Server database using the Configure Project
Settings for Drawings Utility. The wizard is a stand-alone utility that runs independently of
Project Management. The utility is delivered to the [Product Folder]
\Core\Container\Bin\Assemblies\Release folder as S3DDBConvertWizard.exe.

The utility supports these database conversions:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 127/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

The database 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.

You must run the Database > Integrity Command 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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 128/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

Convert a Smart 3D Oracle database to SQL Server

You must run the Database > Integrity Command 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. Click Start > All Programs > Intergraph Smart 3D > Database Conversion Wizard.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 129/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. On the Source and Target Databases page, the source database is set by default as the
database to which you are connected. If you need to change the source database, you
must use Modify Database and Schema Location. 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 ConvertDBStatus.log and ConvertDBError.log files in the Temp

folder, and correct conversion errors.

Convert a Smart 3D SQL Server database to Oracle

You must run the Database > Integrity Command 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. Click Start > All Programs > Intergraph Smart 3D > Database Conversion Wizard.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 130/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Modify Database and Schema Location. 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 the conversion ConvertDBStatus.log and ConvertDBError.log files in the Temp

folder, and correct conversion errors. 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 target database. See Modify the interface names
of the target database.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 131/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

5. Update the GUIDs sheets for the updated interface and properties.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 132/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. Make sure that the updated view is
generated in catalog and model database. For more information, see View Generator.

9. Regenerate the reports database.

Configure project security

The project administrator is responsible for controlling user access to specific project data.
This is done in part by creating permission group folders and permission groups that control

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 133/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

access to design objects. You can also grant permissions to users at the model and catalog
level that enable users to perform certain administrative tasks.

Create permission group folders and Assign levels of access

permission groups

Create permission group folders and permission groups

Smart 3D manages access to design objects rather than to the application commands that
create the objects. For each model database, the site administrator creates a set of
permission group folders and permission groups in that model database. The permission
groups typically represent the management structure of an organization, such as design
disciplines, working groups, or even an individual.

The software does not constrain you to a specific pattern when designing the
permission objects hierarchy. Your company might have other ideas on using this access
control grouping.

Collectively, the model and its related permission group folders and permission groups make
up the model hierarchy. This hierarchy is a subset of the Project Management hierarchy and
displays within the tree view. An example of a model hierarchy is shown below.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 134/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Three levels of objects make up the hierarchy.The model resides at the top level, or root level.
Immediately below the root level are the permission group folders ( ). Permission group
folders provide the logical organization for the permission groups. At the last level are the
permission groups ( ). You use permission groups to control over which portion of the model
or catalog users have access and responsibility.

The model hierarchy is visible only in Project Management.

You can create an unlimited number permission group folder levels.

You cannot have permission group folders and permission groups at the same level.

Permission groups that you create in Project Management 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 135/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Learn about 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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 136/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 137/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Create three different permission groups: PG-Run, PG-John, and PG-Peter.

Both John and Peter should have full control access to PG-Run.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 138/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 139/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Create a new permission group folder

Permission group folders are containers for permission groups. In this way, they serve as the
foundation of your permissions hierarchy.

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 Project Management tree. In
the example, the Project1 model is selected.

2. Click New Permission Group Folder Command to open the New Permission Group
Folder Dialog.

3. Type a logical name for the permission group folder. For example, type Modeling to
create a folder to contain different design groups, and then click OK.

The new permission group folder displays in the hierarchy under the selected object

4. Continue creating permission group folders as needed for your project. The model in the
example has three permission group folders.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 140/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

After you create the hierarchy for your model, you can view and change the permission
group folder properties. See Properties Command and Define Permission Group Folder
Properties Command.

A folder can nest inside another folder.

You can nest multiple levels of folders.

You cannot drag folder to other locations within the hierarchy.

Create a new permission group

1. Select the default permission group folder or a permission group folder that you created.

2. Click New Permission Group Command to open the New Permission Group Dialog.

3. Type a name for the permission group, and then specify the workshare location where
the permission group should be used. You can use logical permission group names that
associate the workshare location with a permission group. For example, if you create a

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 141/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

permission group for piping users located at the Huntsville location, you can name the
group HSV Piping.

4. Click OK.

The software adds the permission group to the hierarchy under the selected permission
group folder.

5. Continue adding permission groups as needed to build your model hierarchy. An

example is shown below.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 142/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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

You can define custom properties for the permission group using Database > Define
Properties > Permission Group.

After you create a new permission group, you can edit the properties assigned to it by
selecting it and clicking Edit > Properties Command. 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 that you create in Project Management 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 143/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Assign levels of access

You assign access permission levels for the model and catalog database, as well as for
individual permission groups. A user's assigned permission group and level of access (Read,
Write, or Full Control) in that permission group, defines the actions that are available when
working with the software. The list below shows some of the actions that permission groups
affect.

Creating objects

Modifying objects

Deleting objects

Accessing menu commands

Changing properties of objects

Pasting and restoring objects from a backup

Claiming objects

Creating relationships between objects

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 Server Permissions for SQL in the Smart 3D
Installation Guide.

Learn about 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 144/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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:

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.

Assign access permissions for SQL databases

This procedure is for SQL Server 2016. If you are using Oracle, see Assign access
permissions to the Oracle databases.

Perform the following steps on the database server computer.

1. Open Microsoft SQL Server Management Studio and expand your database server
in the left tree view.

2. Expand the list under Security in the left tree view.

3. In the left pane, right-click Logins.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 145/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

4. Select New Login from the shortcut menu.

5. On the Login - New dialog, type the user account you want to be assigned
administrative privileges in the Login name text box. For example, type AdminUser1.

6. Select Server Roles under the Select a page heading to display the Server Roles list.

7. In the Server Roles list, for an administrator user select the sysadmin and public
check boxes. For a standard user, select the public role only. By default, users with
sysadmin privileges have administrator rights to all databases.

8. Select OK.

9. To assign permissions for a user or a group of users, follow steps 10 to 14.

10. Select User Mapping under the Select a page heading to display the Users mapped
to this Login list.

11. Select the Map check box for one of the seven databases containing a Smart 3D
project.

12. Specify the database roles using the Database role membership list:

For an administrator user, select db_owner and public.

For a standard user, select public, db_datareader, and db_datawriter.

13. For a standard user, right-click the database name and select Properties.

a. Select the user login and on the Permissions, select the Explicit tab and grant
Execute.

b. Select the Effective tab and check that the standard user has the permission:
CONNECT, DELETE, EXECUTE, INSERT, SELECT, UPDATE permissions.

The six permissions above are required. A user might have additional
permissions but they are not required for a Smart 3D standard user.

14. Select OK.

15. Repeat the procedure for each of the remaining six databases.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 146/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Assign access permissions for Oracle databases

The Reference Data installation delivers a set of script files. You must use these script files to
create the necessary schemas, users, and roles that are used to run the software. The scripts
must be run in the order listed.

Create Roles for Smart 3D users:

SP3DUser_ROLES.SQL

SP3DProjectAdministrator_ROLES.SQL

Create users for Smart 3D:

SP3DUser.SQL (for Oracle) or Linux_SP3DUser.SQL (for Linux)

Create Administrative users:

SP3DProjectAdministrator.SQL (for Oracle) or Linux_SP3DProjectAdministrator.SQL

(for Linux)

Running these scripts is typically part of setting up the database server. See
Initialize the Oracle Database in the Smart 3D Installation Help.

Assign permissions to the SharedContent folder

1. Use Windows Explorer to navigate to the SharedContent folder on the reference data
computer.

2. Right-click the SharedContent folder, and then click Properties to open the
SharedContent Properties dialog .

3. Select the Sharing tab, and then click Advanced Sharing.

4. Select Share this folder, and then click Permissions.

5. Click Add permissions as needed so that the appropriate users or user group has Full
Control access to the folder. In the example, the S3DQAUsers group has been given
Full Control access.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 147/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

6. Click OK until you return to the Sharing tab.

7. Select the Security tab, and modify security permissions to add the specified group with
Full control access.

8. Click OK, and then click Close.

Assign permissions to the catalog and the model

1. Select the catalog in the Project Management tree.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 148/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. Click Permissions Command on the toolbar to open the Access Permissions Dialog.

3. Click Add to open the Add Users and Groups Dialog.

4. Double-click 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. For more information, see Add Users and
Groups dialog.

You can also click Add and search for users using the Select Users and Groups
dialog. This is a common Windows dialog. 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.

7. Select the model in the Project Management tree.

8. Repeat steps 2 through 6 to assign permissions to the model.

Change level of access permission

1. Select the appropriate item in the Project Management tree. You can assign access
permissions to the model database, the catalog database, and to permission groups.

2. Click Permissions Command on the toolbar to open the Access Permissions Dialog.

3. Select one or more users or groups in the grid.

4. In the Type of access list, select the new access type.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 149/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Remove user permissions

1. Select the appropriate item in the Project Management tree. You can assign access
permissions to the model database, the catalog database, and to permission groups.

2. Click Permissions Command on the toolbar to open the Access Permissions Dialog.

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.

Manage items in the Project Management 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
Command on the toolbar. Copying places the selected item on the Clipboard. When you
click Paste Command on the 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 150/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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, clicking Edit > Move
Command, and then selecting a destination for the item in the model hierarchy. You can only
move permission groups 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 Command on the toolbar. After you delete
an item, it is permanently removed from the hierarchy. You cannot delete a permission group
folder with children.

Renaming Items

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

Copy an item
1. In the Project Management tree, select the permission group folder or permission group
to copy.

2. Click Copy Command on the toolbar.

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 Command on the toolbar.

Move an item
1. In the Project Management tree, select the permission group item to move.

2. Click Edit > Move Command.

3. Select a destination in the tree to place the item.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 151/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Delete an item
1. In the Project Management tree, select the permission group folder or permission group
to delete.

2. Click Delete Command on the toolbar.

3. Click Yes in the confirmation box.

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.

You cannot delete a permission group folder if any permission groups are under it.

You cannot delete a permission group that contains objects.

Delete a model
Use care when deleting a model. You cannot use Undo to reverse the
deletion.

1. In the Project Management tree, select the model to delete.

2. Click Delete Command on the toolbar.

3. Click Yes in the confirmation box. Deleting the model removes its pointer from the site
database.

4. Click Yes in the next message box to delete the physical database files. This action
releases hard drive space on the database server.

You must have Full Control or Write permission at the root level to delete a model.

If you delete an Oracle model, the software might not delete all of the associated
database objects (user, tablespace, and schema). To delete schema information after
deleting an Oracle model, you must use the Smart 3D Database Tools Wizard.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 152/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Delete a catalog
You can delete a catalog only if it is not associated with a model. The example below shows
the icons that display in the hierarchy for a catalog associated with a model (1) and for a
catalog not associated with a model (2).

1. In the Project Management tree, select the catalog to delete.

2. Click Delete Command on the toolbar.

3. Click Yes in the confirmation box.

4. Click Yes in the next message box to delete the physical database files. This action
releases hard drive space on the database server.

In an Oracle configuration, you must delete the catalog using the Smart 3D Database
Tools Wizard.

Rename an item
1. Select the item to rename.

2. Click Edit > Rename to open the Rename Dialog.

3. Type the new name of the item in the To box.

Move through the Project Management hierarchy

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 153/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Navigating the Project Management hierarchy is similar to navigating Windows Explorer. You
can click to expand and collapse nodes in the Project Management tree, 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 Project Management
tree. You can move backward and forward through the items, or you can move up to a higher
order in the hierarchy.

Move back to the previous level

1. Click Back Command on the toolbar so that the software highlights the last node that
you selected in the Project Management tree.

2. If needed, continue to click Back Command to retrace your path through several
levels

This 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 if you are displaying the first
level in the history list.

Return to the previous display

1. Click Forward Command on the toolbar so that the software highlights the last node
that you selected in the Project Management tree before you clicked Back Command
..

2. If needed, continue to click Forward Command to retrace your path through several
levels.

This command is not available if you are displaying the last level in the history list.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 154/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Go to the parent classification

Click Up One Level Command on the toolbar to highlight the parent classification in
the hierarchy highlights.

This command is not available if you are displaying the top classification in the
hierarchy.

Add point cloud data to the model

Smart 3D supports vendor-neutral point cloud data integration within the modeling
environment. Referencing point cloud data in your model enables you to add to a design
object without redrawing the object.

To make the point cloud data available, you must first install third-party software and
integrate the software Smart 3D. For more information about supported point cloud
vendors, see the Smart 3D Installation documentation.

In a Global Workshare environment, you can attach point cloud models at the host and
the satellite location.

Reference a point cloud

Load the point cloud software on your computer before referencing it from
Project Management.

1. Select the model node In the Project Management tree.

2. Click Database > New > Point Cloud Model Reference to open the Point Cloud Model
Reference dialog.

3. Select the point cloud to use, and then click Register.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 155/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

To select a point cloud dataset for server interference, click the corresponding
Server Interference row for that point cloud dataset.

You can run the remote server interference process for multiple point cloud data
sets separately.

The software considers only registered point cloud datasets for server
interference. By default, the software selects one point cloud dataset for server
interference.

4. In the Point Cloud Properties Dialog, click Browse to select a point cloud vendor
source file for Point Cloud Source.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 156/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

5. Click OK.

You can register multiple point clouds separately. Based on the point cloud selection,
the appropriate point cloud specific dialog box displays.

For CloudWorx, the Import Point Cloud Data dialog displays. You can select either
model space view or jetstream point cloud source as needed.

You can see the status of the point cloud as Registered under the Status column in the
Point Cloud Model Reference dialog. The options Register and Unregister change
dynamically based on the point cloud status.

When defining the workspace, the point cloud displays on the New Filter Properties
dialog 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 a point cloud reference

1. Right-click the model icon in the Project Management tree, and then click New Point
Cloud Model Reference to open the Point Cloud Model Reference dialog box.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 157/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. Select the registered point cloud to modify, and then click Properties to open the Point
Cloud Properties dialog box.

3. Modify the required properties.

4. Click OK to save the changes.

Remove a point cloud reference

1. Right-click the model icon in the Project Management tree view, and then click New
Point Cloud Model Reference Command to open the Point Cloud Model Reference
dialog.

2. Select the point cloud to unregister, and then click Unregister.

Attach external 3D data to the model

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 (.xmlor .drv) files.

Key Advantages

Supports disconnected workshares

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 158/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 159/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

You can attach R3D models at the host and at the satellite. You must attach 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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 160/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Transformation and Intergraph Smart® Interop Publisher

If you have Intergraph Smart® Review and Smart 3D applications, you can change
transformation settings in one application, and then see the resulting change in the other
application through Intergraph Smart® Interop Publisher. You can attach a smart model
translated from the Intergraph Smart Interop Publisher application as a Reference 3D model
in Smart 3D, and then opened as a 3D project in Smart Review. The .iop file generated by
Intergraph Smart Interop Publisher allows transformation settings to be shared between
applications. Intergraph Smart 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 Intergraph Smart 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
Intergraph Smart Interop Publisher, see Move, Rotate, and Scale (Transform) Smart Models
in the Intergraph Smart® Interop Publisher Help. For more information on the transformation
settings in Smart 3D, see New Reference 3D Model Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 161/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

To translate all third-party data files, you must have a SmartPlant Review Publisher
license or an Intergraph Smart® 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.

Learn about 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 all third-party data files, you must have a SmartPlant Review Publisher
license or an Intergraph Smart® 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:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 162/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 163/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Use the GenerateMapping tool

Use the ConvertToZVF tool

To convert data from third-party tools, you must have an Intergraph Smart® Interop
Publisher translation (SRP) license. However, it is not required that Intergraph Smart® Interop
Publisher be installed on the computer performing the translation.

1. Run [Product Folder]\Core\Tools\Administrator\Bin\ConvertToZVF.exe to display the

ConvertToZVF dialog.

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>

Use the GenerateMapping tool

1. Run [Product Folder]\Core\Tools\Administrator\Bin\GenerateMappingTool.exe to
displays the GenerateMappingTool dialog.

2. Type the class identifying label, which is the property name in the .drv files that
corresponds to the class names.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 164/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 for recommendations.

Master Units

Possible values for the Master Units field:

Metric Values Units Denoted

59 = meters

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 165/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

61 = millimeters

62 = centimeters

63 = kilometers

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,

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 166/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 167/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 168/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 169/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 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]

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 170/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Master Units = 61

Sub Units = 61

Sub Units Per Master Units = 1

Positional Units Per Sub Unit = 1

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 171/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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)

Attach external 3D data as a reference (R3D)

1. Place the .zvf and .xml files that you previously exported in to an accessible folder. The
recommended location is in the SharedContent folder (for example, [Product
Folder]:\3DRefData\SharedContent\Reference3D).

2. In the Project Management tree, select the model to attach as the reference model.

3. Click Database > New > Reference 3D Model to open the New Reference 3D Model
Dialog.

If the model currently has a R3D referenced object attached, you can
also right-click the Reference 3D Models root in the Project Management tree, and
then click New Reference 3D Model in the shortcut menu.

4. Define model information in the boxes.

Use a name that is related to the files being referenced.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 172/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

When browsing for files, you must use a UNC path.

5. Click OK.

The software begins the referencing process and displays an informational progress
message. When the process finishes, the referenced project displays as a new item
under the Reference 3D Models node.

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 following example shows the icon displayed in the Project Management
tree 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.

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

7. Review the import log file in the %temp% folder.

8. 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 the Project Management tree, select the Reference 3D model to modify.

2. Click Properties Command to open the Reference 3D Model Properties Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 173/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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
Intergraph Smart Interop Publisher application, the Out of Date status does not
display. To see transformation changes made in Intergraph Smart Interop
Publisher, select the Reference 3D model in the Project Management tree, open
the Properties dialog 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).

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

5. Optionally, assign a permission group that applies to the Reference 3D model at the
object level.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 174/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

6. 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 Intergraph Smart Interop Publisher as your
Reference 3D model, any changes to transformation settings made in the Intergraph
Smart Interop Publisher application automatically display when you click Apply in the
Properties dialog.

7. 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 updated. The following example shows the icon that
displays in the Project Management tree viewtree for an out-of-date Reference 3D
model:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 175/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 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 Command on the toolbar.

3. Click Yes in the Detach Reference 3D Model dialog 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 176/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

1. Select the Reference 3D Models root in the Project Management tree.

2. Click Edit > Update Reference 3D Model(s) Command to open the Reference 3D
Batch Update dialog and display the Reference 3D models that are 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. (Optional for SQL Server databases) Click Improve database load time to increase the
Reference 3D insert operation; improvements to performance can vary depending on
several factors. This option applies only to SQL Server databases and increases the
size of the generated SQL Server log file. By default, the option is not enabled.

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

6. Click Submit Job to schedule the job to run on a pre-configured queue. To update the
project, click Update.

Steps updated successfully are indicated by .

Steps that failed to update are indicated by .

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 177/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

7. Click Close.

Learn about custom schema and mapping tools

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 178/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 179/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

2. Define a new interface in the CustomReference3D package. For more information, see
Interfaces Worksheet.

3. Define the new property of the new interface in the CustomReference3D package. For
more information, see InterfaceAttributes Worksheet.

4. Define in the CustomReference3D package that the class implements the new interface.
For more information, see ClassInterfaces Worksheet.

5. Define a Business Object Classification (BOC) node in the Custom Reference 3D

package. For more information, see BOCNodes Worksheet.

6. Define in the CustomReference3D package the interface that identifies the new BOC
node. For more information, see BOCDefiningInterfaces Worksheet.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 180/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. The name of the custom interface must contain the “R3D” substring. Otherwise, the
software does not map the properties contained in the interface and inserts an error message
in the Reference 3D attachment log.

Correct custom interface names: CustomTestR3D, CustomR3DTest, and R3DCustomTest

Incorrect custom interface names: CustomTest, RDCustomTest, and Custom3DTest

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 181/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 182/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 183/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Edit object properties

As your project evolves and changes, so too can object properties.

Edit catalog database properties

1. Select a catalog database in the Project Management tree.

2. Click Properties Command on the toolbar to open the Database Properties Dialog.

3. Type new values for Schema to change the server and name of the schema.

4. Click Permissions to add or remove users or change access permissions on the

Access Permissions Dialog.

5. Type or browse to a new path for Symbol and custom program file locations as
required.

6. Click OK to save your changes and close the dialog.

The Type and Path settings 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.

2. Click Properties Command to open the Model Properties Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 184/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

6. Select a new model type from the Model Purpose 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. Click Permissions to add or remove users or change access permissions on the

Access Permissions Dialog.

8. On the Databases tab, type a new name in the Name generator server for model box
if needed.

9. Click OK to save your changes and close the dialog.

To define new custom properties, click Database > Define Properties > Model. See
Define a custom property for a model.

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 Project Management tree, select a model that has one or more missing
databases.

The icon of a missing database displays as a red question mark in the Project
Management tree, such as a model or a catalog .

2. Click Edit > Properties Command to open the Model Properties Dialog.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 185/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Tools > Restore Command.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 186/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 187/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Edit permission group folder properties

1. Select a permission group folder in the Project Management tree.

2. Click Properties Command to open the Permission Group Folder Properties Dialog.

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, click Database > Define Properties > Permission
Group Folder. For more information, see Define a custom property for a permission group
folder.

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 Project Management tree.

2. Click Properties Command on the toolbar to open the Permission Group Properties
Dialog.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 188/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Edit permission group properties

1. Select a permission group in the Project Management tree.

2. Click Properties Command to open the Permission Group Properties Dialog.

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.

5. Click Permissions Command to add or remove users or change access permissions

on the Access Permissions Dialog.

To define new custom properties, click Database > Define Properties > Permission
Group. See Define a custom property for a permission group.

To change the location of a permission group, follow the recommended workflow

outlined in Change the location of a permission group.

Modify a Point Cloud model

1. Select the Point Cloud model to modify in the Project Management tree.

2. Click Properties Command to open the Point Cloud Model Properties Dialog.

3. Modify the properties as needed.

4. Click OK.

Modify a Reference 3D model

1. In the Project Management tree, select the Reference 3D model to modify.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 189/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. Click Properties Command to open the Reference 3D Model Properties Dialog.

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
Intergraph Smart Interop Publisher application, the Out of Date status does not
display. To see transformation changes made in Intergraph Smart Interop
Publisher, select the Reference 3D model in the Project Management tree, open
the Properties dialog 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).

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 190/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

6. 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 Intergraph Smart Interop Publisher as your
Reference 3D model, any changes to transformation settings made in the Intergraph
Smart Interop Publisher application automatically display when you click Apply in the
Properties dialog.

7. 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 updated. The following example shows the icon that
displays in the Project Management tree viewtree for an out-of-date Reference 3D
model:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 191/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 displays. Click
Yes to continue loading.

Work with custom properties

As you refine your model hierarchy, you might want to define properties for the items that you
create. For example, you might want to define a location property for a selected model or add
a completion data to a permission group.

Custom property information for a model is stored in the site database to which it belongs.
Custom property information for permission group folders and permission groups is stored in
the model to which they belong

Define a custom property for a model

1. Select the Models node or a model in the Project Management tree.

2. Click Database > Define Properties > Model to open the Define Model Custom
Properties Dialog.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 192/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

5. Confirm the information that displays 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.

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 databases. See View
Generator and Regenerate Reports Database Command.

Custom properties for a model display on the Model Properties Dialog.

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

Define a custom property for a permission group

1. Click Database > Define Properties > Permission Group to open the Define
Permission Group Custom Properties Dialog.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 193/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Custom properties for a permission group display on the Permission Group Properties
Dialog.

Permission group custom properties apply to all permission groups in the model.

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

Define a custom property for a permission group folder

1. Click Database > Define Properties > Permission Group Folder to open the Define
Permission Group Folder Custom Properties Dialog.

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 displays 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 for a permission group folder display on the Permission Group Folder
Properties Dialog.

Permission group folder custom properties apply to all permission group folders in the
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. Select the Models node or a model in the Project Management tree.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 194/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. Click Database > Define Properties > Model to open the Define Model Custom
Properties Dialog.

3. Select the custom property 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.

Copy a custom property for a permission group folder

1. Click Database > Define Properties > Permission Group Folder to open the Define
Permission Group Folder Custom Properties Dialog.

2. Click Copy From to open the Copy From Dialog.

3. Select the model containing the properties to copy.

4. Select one or more custom properties to copy.

5. Click OK, and then click OK again.

Copy a custom property for a permission group

1. Click Database > Define Properties > Permission Group to open the Define
Permission Group Custom Properties Dialog.

2. Click Copy From to open the Copy From Dialog.

3. Select the model containing the properties to copy.

4. Select one or more custom properties to copy.

5. Click OK, and then click OK and again.

Delete a custom property from a permission group folder

1. Click Database > Define Properties > Permission Group Folder to open the Define
Permission Group Folder Custom Properties Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 195/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. Select the custom property to delete, and then click Delete.

3. Click Yes in the confirmation box.

4. Click OK.

Deleting a custom property removes all the data assigned to that property in every
permission group folder in the model.

Delete a custom property from a permission group

1. Click Database > Define Properties > Permission Group to open the Define
Permission Group Custom Properties Dialog.

2. Select the custom property to delete, and then click Delete.

3. Click Yes in the confirmation box.

4. Click OK.

Deleting a custom property removes all the data assigned to that property in every
permission group in the model.

Produce printed reports

You can create reports that you can use to produce a printed output of the information in your
database.

Run an existing catalog report

1. Select a model in the Project Management tree, and then click Tools > Run Report
Command to open the Run Report Dialog.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 196/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 dialogs, such as the Select Filter Dialog, Filter
Properties Dialog, and Report Parameters Dialog.

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 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 Project Management tree, and click Tools > Run Report
Command to open the Run Report Dialog.

2. On the My Reports tab, select the personal report template 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 dialogs, such as the Select Filter Dialog, Filter
Properties Dialog, and Report Parameters Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 197/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 so that you can specify a different report name.

Configure a project for Global Workshare

A Global Workshare Configuration (GWC) enables 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: a Host location and a 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 198/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

On the other hand, Satellite locations are created manually within Project Management using
the Database > New > Location Command on the Host. You must have administrator
privileges on the Site database to create a new location. After the location is created, it 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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 199/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Each Satellite location should have a shared content folder at that location.

Inserted reference files, which should be available at Satellite locations, must be located
in the SharedContent and be manually distributed to each Satellite location. See Insert
reference files in the Common Help.

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.

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. Contact support at http://www.hexagonppm.com.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 200/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Work with Global Workshare and SQL Databases

You have a lot of options, and you know best what you need to accomplish. Here are some
general categories to help get you started.

Set up a configuration Set up Global Work with permission Synchronize catalog

of replicated servers Workshare with SQL groups and Global changes between the
Server databases Workshare Host and Satellites

Remove replication
Back up and restore Recover from Host
between a Host and a
Global Workshare and Satellite failures
Satellite

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 201/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Configuring Global Workshare is a detailed and complicated process. Contact

support <https://hexagon.com/support-success/asset-lifecycle-intelligence/community> for
assistance.

Set up a configuration of replicated servers

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

The SQL Server Replication feature must be installed on the SQL Server instance set
up for the Global Workshare configuration.

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. Detailed information on the Microsoft SQL
Server Management Studio in 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 202/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

3. On the New Server Registration dialog General tab, specify the name of the SQL
server 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.

a. Click Control Panel > Administrative Tools > Services.

b. Right-click SQL Server Agent, and select Properties.

c. On the General tab, select Automatic as the Startup type.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 203/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Refer to 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. See your SQL Server documentation for
information on Microsoft SQL Server Management Studio.

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.

3. On the Distributor page of the wizard, specify that each server will be its own
distributor. Optionally, you can configure a dedicated Distributor server for large or
complex configurations.

4. Click Next to go to the SQL Server Agent Start page..

5. Select Yes, configure the SQL Server Agent service to start automatically, and then
click Next to go to the Snapshot Folder page.

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

7. On the Distribution Database page, configure the distribution database. 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.

8. Click Next and 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. See Set the
SQL Server Distributor agent profile.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 204/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.See Configure the SQL Server Distributor agent.

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 Distributor Properties
dialog.

2. Select the General page, and click Profile Defaults in the Agent Profile section of the
page.

3. On the Agent Profiles dialog, select the Distribution Agents page, and click New in
the Agent Profiles section of the page.

4. In the New Agent Profile dialog, 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 now shows the new profile in the Agent profiles list.

6. Select the new profile and click Change Existing Agents to update all existing
Distribution Agents to use the specified profile.

7. Click OK to close the dialog, and then click OK again to return to the Object Explorer
window.

Set up Global Workshare with SQL Server databases

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 205/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

After you create the SQL Server Distributor Agent, you can set up the Global Workshare
configuration (GWC) for the SQL Server databases. The steps discussed in this section
assume some familiarity with the Project Management environment for Global Workshare and
are targeted to specific SQL Server settings.

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 site, site schema,
catalog, 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 site, site schema, catalog,
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 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 206/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Create a new location

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.

1. Click Database > New > Location to open the New Location Dialog.

2. Type a name for the location.

3. In the Site server list, select the site server for the new location. For SQL Server
databases, only those servers that are registered through SQL Server on the Host
computer are available.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 207/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 administrators manage all Satellite creation and administration from the Host
location and use permission groups to determine access for both Host and Satellite
locations. See Work with permission groups and Global Workshare for information on
setting up permissions for your data.

Duplicate the model for a Global Workshare Configuration

After the Satellite locations are created, use the Duplicate Model for Workshare Command to
replicate the Host databases. Before doing so, we recommend that you create a backup of
the non-replicated databases. If you encounter problems during the Workshare process, you
can restore the backup set of databases on the server and continue working without any loss
of data. You must have also added the locations for any satellites you intend to add. See New
Location Command.

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 the model for Workshare across untrusted networks for special
instructions when this environment is to be configured when using Oracle.

1. In the Project Management tree, select a model.

2. Click Tools > Duplicate Model for Workshare Command to open the Duplicate Model for
Workshare Dialog.

3. Select one or more Satellite locations in the Available locations list and click Add. For
each location that you select, one row for each database type is added to the grid.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 208/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

For Oracle databases, you must type the GoldenGate administrator user name
and password.

4. Click OK to start the duplication process.

5. When the duplication process completes, click OK.

A variety of replication scripts and 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. 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>.

You can click Start > Run and type %temp% in the Run dialog to locate the local temp
folder.

For SQL Server, the files are created in the ReplicationModelName subfolder of the
local temp folder in the initial duplication of one or more satellites. 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, we recommend that you backup these scripts and
batch files into a separate folder.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 209/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. See your SQL Server documentation for information on using Microsoft SQL
Server Management Studio.

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 to open
the Peer-to-Peer Topology Wizard..

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 to open the Connect to Server dialog.

6. Select the first Satellite in the Server name list, and then click Next to open the Add a
New Peer Node dialog.

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 dialogs and return 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 to display a small arrow.

10. Extend the arrow to the first Satellite server you added.

11. Repeat the previous two steps for each Satellite you added.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 210/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 211/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 then 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. See your SQL Server documentation
for information on the Microsoft SQL Server Management Studio.

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.

3. Expand Replication > Local Publications.

4. Right-click the Site, and select New Subscriptions to open the New Subscription
Wizard.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 212/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

Regenerate the Reports databases

For performance reasons, the Reports and Reports schema databases are not replicated
from the Host location and must be locally generated at each Satellite location.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 213/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Before starting this procedure, check with your administrator to verify that all
users are disconnected from the database.

1. Select a model in the Project Management tree.

2. Click Edit > Regenerate Reports Database Command to open the Regenerate Reports
Database Dialog. The software automatically assigns the Model database server value
as the Reports database server and Reports schema server.

3. Review he information displayed for the reports databases and servers, and edit as
needed.

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)

At the end of the Global Workshare setup, you must configure and activate the Duplication
Synchronization Service (DuSS) at the Host and each Satellite location.

The Duplication Synchronization Service (DuSS) works with the database replication service
to maintain a healthy model at each Global Workshare Configuration location. This service is
run to prevent dangling relationships between objects that are propagated or replicated
between the servers. The service also 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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 214/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

conflicts by preventing certain inconsistencies and ensuring that the model data is accurate at
all locations.

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. You must open a
command prompt with full administrator permissions. Type CMD in the Run dialog, 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 > 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 to display the Services
window displays.

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 click Start.

11. Click OK.

12. Open Project Management while connected to the Host server.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 215/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

Monitor replication in SQL Server

You can use the Microsoft SQL Server Management Studio to monitor replication activity.
See your SQL Server documentation for information on the Microsoft SQL Server
Management Studio, .

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 216/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Add an additional satellite to an existing Global Workshare Configuration

1. Use the New Location Command to add the location for the new Satellite.

2. Click Tools > Duplicate Model for Workshare Command. The 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 to locate the local temp folder.

3. Back up the model.

4. Transfer the backup to the new Satellite location, and restore the backup.

Run the ToRunPostRestore_1<LocationName>.bat file. To check for errors at a later

point, you can redirect the output to a log file. For example:
ToRunPostRestore_NewLocation.bat > out.log, which would output to a file
called out.log.

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

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.

Back up and restore Global Workshare

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 217/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

In the event that one of the locations participating in a Global Workshare Configuration (GWC)
must be taken off-line, we recommend using one of the following supported workflows to
ensure minimal adverse impact to the remaining locations in the GWC. Each workflow
scenario presumes an initial GWC configuration 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.

Workflow Scenario 1: Restore Model as Copy

When the Host location experiences a work stoppage, we recommend using the
Restore model as copy workflow to achieve a stand-alone configuration.

Workflow Scenario 2: Amputate and Re-Duplicate

When a Satellite server experiences a catastrophic failure, but the Host location remains
in-place and operable, we recommend using the Amputate and re-duplicate workflow to
restore the SQL Global Workshare Configuration.

Restore model as copy

Use the workflow outlined below 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 218/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

1. Use the Database Wizard to 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.
Depending on the type of databases you are using, see Create a new site database for
SQL or see Create a new site database for Oracle in the Project Management Help.

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.

2. Use the Restore Wizard in Project Management to restore the catalog, catalog schema,
and model databases on the Host server from the backup that was completed prior to
the work stoppage. See Restore a model as a copy.

When the restore is complete, review the consolidate .LOG file in the %temp%
folder of the logged-in user who ran the restore.

3. Regenerate the reports database after the project databases are restored on the Host
server.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 219/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

1. Delete all subscriptions (MSSQL) or Golden Gate processes (Oracle) to the lost Satellite
server to be amputated. For example, in the following configuration, Satellite server
HOUSRV1 has suffered massive failure causing it to be periodically unavailable. As a
result, SQL Agents for the Push Subscriptions HSVSRV1 > HOUSRV1 and OSLSRV1 >
HOUSRV1 are failing. See Remove SQL Server replication.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 220/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

After the incoming and outgoing distributions are removed for the failed Satellite, the
resulting configuration resembles the illustration below. In this scenario, the remaining
locations can continue participating in the GWC with no work stoppage.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 221/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

2. As soon as it becomes practical to do so, use Tools > Consolidate Model from
Workshare Command to perform the consolidation workflow for the failed Satellite
location to merge at the Host location.

3. Use the standard replication workflow to re-duplicate the amputated satellite location to
create a consolidated dataset. See Duplicate the model for Global Workshare
Configuration.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 222/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Recover from Host and Satellite failures

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 in this section describe methods for
recovering from such failures.

Recover from Host failure

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 support
(www.hexagonppm.com) 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, or if the data is not replicating,
stop work on each Satellite server until the Host server is repaired or replaced, or until the
issue is resolved.

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.

2. Use the Backup Command to create a backup the dataset to be copied.

3. Remove Smart 3D data from all servers that participated in the previous Smart 3D
Global Workshare Configuration.

4. Use the Database Wizard to create a new Site and Site schema.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 223/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

5. Use the Restore a model as a copy feature in the Restore Wizard to populate the new
Site using the backup dataset.

6. Use the Backup Command to create a back up of the restored model.

7. Configure Global Workshare.

Recover from Satellite failure

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, 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. The publication must be deleted before you can delete or restore that database
from another SQL Server backup.

7. If there are any remaining subscriptions related to the failed Satellite, right-click the
subscription that corresponds to the Satellite, and then click Delete.

8. In the Project Management task, run the Tools > Consolidate Model from Workshare
Command. Select only the location that you want to consolidate. This location
represents the one Satellite that is being replaced or repaired.

9. If the Satellite server is repaired, clean the Satellite database using the Clean Database
Command.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 224/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

10. 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 object for the replacement computer.

11. Add the repaired or replacement Satellite back into the GWS using Add an additional
satellite to an existing Global Workshare Configuration.

Recover model data

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.

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, click the Tools > Restore Command to open the Restore
Wizard.

4. 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 to populate the window 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.

For a SQL database, 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. For an Oracle 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 225/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The Paths for new databases table lists the database types saved to the backup
file, including the server (when restoring SQL databases) or the Oracle net service
(when restoring Oracle databases) and the paths for the restored database and
log file.

The New model name dialog 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, 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 226/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Recover catalog data

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 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. See Create a backup
file.

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. See Delete a Subscription at the Host
in Remove SQL Server replication.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 227/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 228/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Project Management at the Satellite location.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 229/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

10. Click Tools > Restore, and select the Restore one or more model databases from
backup option to restore the catalog. See Restore one or more model databases from
backup.

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. See Set up
one-way subscriptions for SQL Server. 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 230/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

16. Open the Replication Monitor, and verify that replication of data for the new
subscription is working appropriately. See Monitor replication in SQL Server.

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 231/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Remove replication between a Host and a Satellite

You use Microsoft Management Studio to remove the replication between a Host and a
Satellite in a Global Workshare configuration with SQL Server. Afterwards, you use the
Consolidate Model from Workshare Command in Project Management to remove the Global
Workshare configuration between the Host the the associated Satellites.

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.

1. In the Microsoft SQL Server Management Studio, select the Host server, and expand
the Replication folder in the Object Explorer window.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 232/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 message 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. See Consolidate
Model from Workshare Command.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 233/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

See your SQL Server documentation for information on the Microsoft SQL Server
Management Studio.

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.

Work with Global Workshare and Oracle Databases

You have a lot of options, and you know best what you need to accomplish. Here are some
general categories to help get you started.

Set up a Hub and Set up an Oracle Monitor the replication Work with permission
Spoke configuration Global Workshare groups and Global
for Oracle databases Workshare

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 234/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Synchronize catalog Work with Global Recover from Host Consolidate Oracle
changes between the Workshare and Satellite failures databases
Host and Satellites Configuration across
untrusted networks

Configuring Global Workshare is a detailed and complicated process. Contact

support <https://hexagon.com/support-success/asset-lifecycle-intelligence/community> for
assistance.

Set up a Hub and Spoke configuration for Oracle databases

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 from the Host to all
Satellite 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 set up Global Workshare.

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. See Monitor replication.

Configuring Global Workshare within an integrated environment is a detailed and

complicated process. Contact PPM Smart Community <https://hexagon.com/support-
success/asset-lifecycle-intelligence/community> for assistance.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 235/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Create the Smart 3D GoldenGate user alias

Verify databases have supplemental logging enabled

Perform the following procedure at the Host and at all Satellite locations that participate in the
Workshare. All Oracle databases that participate as Host or Satellites must be configured to
write supplemental data to the redo log files. This supplemental data enabling is required for
successful replication.

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, follow the steps below to enable supplemental logging on
the database server.

1. Open SQL *Plus on the database server.

2. At the command prompt, type the following:

CMD> SQLPLUS /NOLOG

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 236/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 237/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 238/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 239/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 240/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 and perform the
following steps:

Rename the folder to GoldenGate for easy identification. Install GoldenGate 12.1.2.1.0
software by running the setup.exe.

Install GoldenGate 12.1.2.1.8 patch.

You must have administrator privileges on the computer to install the software.

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.

1. Unzip the setup file.

2. Right-click setup.exe under (\ggs_Windows_x64_shiphome\disk1) folder, and select

Run as Administrator.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 241/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

a. The Oracle database location displays by default in the database location. The
database version in the specified location must be pointing to Oracle Database
12c DBHome if you are installing Oracle GoldenGate for Oracle Database 12c.

b. By default, the Manager Port box displays 7809 as the port number.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 242/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 243/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Create the Oracle 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 244/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

The GoldenGate administrative user can have any valid name. In the case of a
multiple Global Workshare configuration, we recommend that each site has its own
GoldenGate administrative user with his or her own tablespace.

You must perform the following procedure at the Host and all Satellite location servers.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 245/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 as the user does not exist in the database:

ORA-01918: user 'GGADMIN' does not exist

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.

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');

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 246/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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:

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 247/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Veify user alias configurations

1. Open ggsci under the GoldenGgate 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.

2. In multitenant, test the pluggable alias using the same command:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 248/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

dblogin useridalias s3dplug_#####

If you need to configuration either alias due to failure to log in, the alias credential
must be dropped before being added again:

ALTER CREDENTIALSTORE DELETE USER s3dgguser ALIAS s3dgoldengate

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 Duplicate Model for
Workshare Command for all locations, which is essential for the proper generation of
replication scripts.

When you execute the Duplicate Model for Workshare Command or Consolidate Model from
Workshare Command 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.

See Configure Oracle Net Services in the Smart 3D Installation Help

Firewall Exceptions for GoldenGate

The firewall exceptions that you must set for GoldenGate are listed below.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 249/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Set up an Oracle Global Workshare

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

Create a new location

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.

1. Click Database > New > Location to open the New Location Dialog.

2. Type a name for the location.

3. In the Site server list, select the site server for the new location. For SQL Server
databases, only those servers that are registered through SQL Server on the Host
computer are available.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 250/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Duplicate the model for a Global Workshare Configuration

After the Satellite locations are created, use the Duplicate Model for Workshare Command to
replicate the Host databases. Before doing so, we recommend that you create a backup of
the non-replicated databases. If you encounter problems during the Workshare process, you
can restore the backup set of databases on the server and continue working without any loss
of data. You must have also added the locations for any satellites you intend to add. See New
Location Command.

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 the model for Workshare across untrusted networks for special
instructions when this environment is to be configured when using Oracle.

1. In the Project Management tree, select a model.

2. Click Tools > Duplicate Model for Workshare Command to open the Duplicate Model for
Workshare Dialog.

3. Select one or more Satellite locations in the Available locations list and click Add. For
each location that you select, 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 251/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

For Oracle databases, you must type the GoldenGate administrator user name
and password.

4. Click OK to start the duplication process.

5. When the duplication process completes, click OK.

A variety of replication scripts and 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. 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>.

You can click Start > Run and type %temp% in the Run dialog to locate the local temp
folder.

For SQL Server, the files are created in the ReplicationModelName subfolder of the
local temp folder in the initial duplication of one or more satellites. 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, we recommend that you backup these scripts and
batch files into a separate folder.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 252/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 executed from 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 253/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Make a Smart 3D backup

After executing the PreBackup<InstanceName>_<SiteDB>_<LocationDB>.bat scripts,

make a backup of the Host databases in Project Management. 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.

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, we recommend 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

You restore the transferred database backups 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 Command
to restore the catalog, catalog schema, and model databases.

1. Open the Database Wizard, and restore the site and site schema.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 254/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. Use the Restore Command to restore the catalog and modal databases onto the
Satellite server onto the Satellite server.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 255/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

You must regenerate the reports database after executing 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 Project Management tools to make the
path to the SharedContent folder location-specific.

Execute the 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 run from 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. The script names in the example
below are for illustrative purposes. Ensure the names for your scripts are correct before
running them.

PostRestore_<Instance>_<SiteDB>_<LocationID>.bat >
PostRestore_<Instance>_<SiteDB>_<LocationID>.log

4. Review the log file output of the script, and resolve any reported errors.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 256/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Regenerate the Reports databases

For performance reasons, the Reports and Reports schema databases are not replicated
from the Host location and must be locally generated at each Satellite location.

Before starting this procedure, check with your administrator to verify that all
users are disconnected from the database.

1. Select a model in the Project Management tree.

2. Click Edit > Regenerate Reports Database Command to open the Regenerate Reports
Database Dialog. The software automatically assigns the Model database server value
as the Reports database server and Reports schema server.

3. Review he information displayed for the reports databases and servers, and edit as
needed.

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)

At the end of the Global Workshare setup, you must configure and activate the Duplication
Synchronization Service (DuSS) at the Host and each Satellite location.

The Duplication Synchronization Service (DuSS) works with the database replication service
to maintain a healthy model at each Global Workshare Configuration location. This service is
run to prevent dangling relationships between objects that are propagated or replicated
between the servers. The service also 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 257/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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. You must open a
command prompt with full administrator permissions. Type CMD in the Run dialog, 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 > 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 to display the Services
window displays.

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 click Start.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 258/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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

The new Satellite must be properly configured for GoldenGate replication before
proceeding. This includes installing the GoldenGate software, creating the GoldenGate
administrator account, creating the GoldenGate service account, and configuring the
network connectivity between the administrative workstation and the two servers.

For information on setting up a new Oracle GWC, see Set up an Oracle Global
Workshare.

1. Connect to the Host server, and open Project Management.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 259/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. Create a new location for the new Satellite.

3. Duplicate the model for a Global Workshare Configuration for the new Satellite location.

4. In the Duplicate Model for Workshare Dialog, 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. See Copy generated scripts into
GoldenGate folders.

7. Execute the PreBackup scripts on the Host server and the newly added Satellite server.

8. Create a backup file of the model.

9. Transfer a copy the backup files and a copy of the SharedContent folder to the new
Satellite server and restore the database to the Satellite location using the correct
workshare location. See Restore a site database

10. Execute the PostRestore scripts on the Host server and the newly added Satellite
server.

11. Regenerate the reports database at the newly added Satellite server..

12. After the scripts finish executing, monitor the replication to ensure that all GoldenGate
processes are running.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 260/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 261/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

The status of the GoldenGate manager service can be obtained by typing INFO MGR in
the GoldenGate command line interpreter.

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 to display a list of the GoldenGate processes:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 262/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

status *

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 last letter
of the process identifies the process type. 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 GoldenGate Data Pump is not related to the database engine Data Pump.

Work with 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 the 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 modifying
the AUTHENTICATION_SERVICES sqlnet variable.

Follow these steps to setup workshare across untrusted domains:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 263/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

7. Using the local administrator account, connect to the Host and Satellite servers, and
execute the PreBackup scripts.

8. Using the administrative client computer at the Host location, create the required
database backups. See Make a Smart 3D backup.

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. See Restore
duplicated databases at Satellite locations.

11. Using the local administrator account, connect to the Host and Satellite servers, and
execute the PostRestore scripts.

12. Finish the Global Workshare by performing additional configuration actions (regenerate
the Reports databases at all satellites, setup the DuSS server, and monitor replication).

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 264/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Consolidate the 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.

Recover from Host and Satellite failures

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 in this section describe methods for
recovering from such failures.

Recover from Host failure

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 265/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 support
(www.hexagonppm.com) 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, or if the data is not replicating,
stop work on each Satellite server until the Host server is repaired or replaced, or until the
issue is resolved.

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.

2. Use the Backup Command to create a backup the dataset to be copied.

3. Remove Smart 3D data from all servers that participated in the previous Smart 3D
Global Workshare Configuration.

4. Use the Database Wizard to create a new Site and Site schema.

5. Use the Restore a model as a copy feature in the Restore Wizard to populate the new
Site using the backup dataset.

6. Use the Backup Command to create a back up of the restored model.

7. Configure Global Workshare.

Recover from Satellite failure

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 266/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

1. Using the Host administrative client, open the Project Management task, and run
Consolidate Model from Workshare for the failed satellite location. See Consolidate
Oracle databases.

2. Copy the scripts generated onto the corresponding servers. See Copy generated scripts
into GoldenGate folders. Because the Satellite server being repaired might 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.

Recover model data

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.

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, click the Tools > Restore Command to open the Restore
Wizard.

4. 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 to populate the window 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.

For a SQL database, the Server and path to existing database backup files
table displays the server and database backup files path where the database

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 267/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

backup files are located. Click Browse and navigate to the path on the specified
server. For an Oracle 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.

The Paths for new databases table lists the database types saved to the backup
file, including the server (when restoring SQL databases) or the Oracle net service
(when restoring Oracle databases) and the paths for the restored database and
log file.

The New model name dialog 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, 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 268/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

14. Switch to the other open session, which has the workspace defined for the model.

15. Click Edit > Paste and Restore.

Consolidate 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 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. See
Consolidate all Oracle databases.

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 269/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Regenerate Reports databases

After the databases are merged back to the Host, right-click the model in the Project
Management tree, and then click Regenerate Reports Database Command. See Regenerate
the reports database.

Consolidate all Oracle databases

You must perform this procedure at the Host location using the administrative computer on
which the replication process was first initiated.

1. In the Project Management tree, select the replicated model to consolidate.

2. Click Tools > Consolidate Model from Workshare Command to open the Consolidate
Models from Workshare Dialog.

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 in the folder to their corresponding servers. See Copy generated
scripts into GoldenGate folders.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 270/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The reports database is excluded from the consolidation process. Consequently, you
must regenerate the reports database. See Regenerate the reports database.

After a 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.

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 Command in Project Management on
the Host server.

4. Highlight the satellite Location(s) to remove, and type the GoldenGate administrator
password.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 271/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

5. Click OK to generate a series of scripts in the RemoveSatellite<Location>_<Model>

subfolder and the local temp folder.

6. Copy the scripts in the folder to their corresponding servers. See Copy generated
scripts into GoldenGate folders.

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 to locate the local temp
folder.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 272/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The reports databases are excluded from the consolidation process. Consequently, you
must regenerate the reports database.

Refer to your Oracle documentation for information about cleaning up the databases on
the removed satellite.

In a Global Workshare Configuration, all permission groups from the removed satellite
are assigned to the Host location. If necessary, they can be assigned to another location
using Project Management.

Work with 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 273/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Learn about 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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 274/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 275/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 276/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 277/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Learn about IFC permissions at Satellite locations

From Project Management at the host location, you can assign Write permissions to satellite
users for the following interference checking (IFC) properties:

Required Action

Notes

No other properties are editable from a satellite location. See Common Interference Checking
Tasks and Set interference checking parameters on a workstation.

You can access Required Action and Notes properties in the following places:

Interference List Dialog

Interference Properties Dialog

Check Interference Ribbon

Interference List Dialog

The Interference List Dialog displays interferences from both the Local Detect Tab
(Interference Dialog) process, and from database interferences derived from the Refresh
Workspace command or Define Workspace command. See Display the interference status.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 278/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Interference Properties Dialog

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 (a valid model user).

Write permission to the IFC permission group at the Host location.

No other properties are editable from a satellite location.

The Host administrator grants permissions to satellite users. If any satellite user is from an
untrusted domain, the Host administrator clears the Only allow names from trusted
domains check box in the Add Users and Groups Dialog. The Host administrator then adds
the corresponding user names.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 279/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Synchronize catalog changes between the 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.

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.

We do 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.

Perform synchronize tasks at the Host location

1. Bulkload the required data to the Host catalog.

2. Select the Host model in the Project Management tree.

3. Click the Tools > Synchronize Model with Catalog Command to open the Synchronize
Model with Catalog Dialog.

4. 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 the Edit > Regenerate Reports Database Command.

The software updates the views at the Host only.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 280/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Perform synchronize tasks 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. Select the Satellite model in the Project Management tree.

3. Click the Tools > Synchronize Model with Catalog Command to open the Synchronize
Model with Catalog Dialog.

4. 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 the Edit > Regenerate Reports Database Command.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 281/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Use custom commands

You can create your own commands to perform custom tasks more efficiently.

Create custom commands

Use the Command Wizard in Visual Basic to create custom commands. 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.

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.

Add custom commands

1. Select Tools Menu > Custom Commands to display the Custom Commands Dialog.

2. Select Add to display the Add Custom Command Dialog.

3. Type the program identifier you assigned to the command 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. The Custom
Commands Dialog shows the command you added to the software. You can run the
command, edit the settings, or delete the command.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 282/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Run a custom command

1. Select Tools Menu > Custom Commands to display the Custom Commands Dialog.

2. Select the command from the list, and then select Run.

3. After the command runs, select Close.

Edit a custom command

1. Click Tools Menu > Custom Commands to display the Custom Commands Dialog.

2. Select the command to change in the list, and then click Edit to display the Edit Custom
Command Dialog.

3. Make the necessary changes. For example, you can change the name and description
of the command.

4. After completing the needed changes, click Close on the Custom Commands Dialog.

You must open the command in Microsoft® Visual Basic if you want to edit the
underlying code.

Delete a custom command

1. Select Tools > Custom Commands to display the Custom Commands Dialog.

2. Select the command in the list, and then select Delete to remove the command from the
list box.

3. After completing the needed changes, select Close.

This action does not delete the DLL for the custom command. It only removes access
to the custom command from the user interface.

Work with SmartPlant Integration

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 283/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Using Smart 3D in an integrated environment standardizes and improves the communication

among the various authoring tools you use while 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 Intergraph Smart Instrumentation, Intergraph Smart P&ID,
Intergraph Smart 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 Project Management enable you to register the model and update the status of
projects. Additionally, you use the Generate Design Basis Command in Project Management
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 Drawings and Reports, or you can retrieve P&IDs and view them using the P&ID
Viewer. You can also publish the entire model for 3D viewing in SmartPlant Foundation or
Intergraph Smart Review.

For more information about working in an integrated environment, see the Intergraph Smart
3D Integration Reference Help and the SmartPlant Foundation Administrator's Help.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 284/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Model registration Design basis Tool map schemas Project status

Model registration

Before you can connect to the integrated environment, you must register your model
database. Registering the model database to a SmartPlant Foundation server enables you to
perform tasks such as publishing or retrieving files.

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 Smart 3D Installation documentation.

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. Select a model in the Project Management tree, and then click SmartPlant > Register to
open the SmartPlant 3D Registration Wizard.

2. On the SmarPlant Registration Wizard - SmartPlant Foundation URL page, 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 285/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

If the SPF site is a secure site, use the format

https://FullSPFServerNameWithDomain/VirtualFolder.

3. Click Next to go to the SmartPlant Registration Wizard - SmartPlant Foundation Plant

page.

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.

Design basis

A design basis is a collection of objects that represent the pieces of data from other authoring
tools outside of Smart 3D. When you use Smart 3D in an integrated environment, you might
need to change the SmartPlant schema to meet the needs of your company. Any changes
that you make to the SmartPlant schema need to propagate to the catalog schema database
associated with your project.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 286/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Generate a design basis

1. Select a catalog in the Project Management tree, and then click SmartPlant > Generate
Design Basis Command to open the Select Component Schemas Path dialog.

2. Specify the path to the modified component schemas. You can click and navigate to
the location.

3. Click OK.

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.

5. 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. See Regenerate the reports database.

To generate views in the model database, perform one of the following actions:

In Project Management, click Tools > 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).

Tool map schemas

When you upgrade your software to a newer version, you might also need to upgrade the tool
map schema associated with the active site database.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 287/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Upgrade the tool map schema

1. Select a model database in the Project Management tree. The model you select must
be registered with SmartPlant Foundation.

2. Click SmartPlant > Upgrade Schema Command.

Project status

After the project administrator creates a new project and registers it, you can begin 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. 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 each project object must stay set to
Working. Setting the status to Approved makes the project object read-only.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 288/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

You can change the status of a project object using the Configuration tab on the object
Properties dialog box.

1. Select a model in the Project Management tree.

2. Click Tools > Update Project Status Command to open the Update Project Status
Dialog.

3. 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 Intergraph Smart Instrumentation, Intergraph Smart

P&ID, Intergraph Smart 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. See Return
the status of a project to Active.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 289/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Update project status to Merge 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 the tools, including SmartPlant Foundation, have their
project statuses set to Complete.

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 Merge with SmartPlant. For more information
about deleting drawings and performing a final publish, see the Intergraph Smart 3D
Orthographic Drawings Help.

1. Select a model in the Project Management tree.

2. Click Tools > Update Project Status Command to open the Update Project Status
Dialog.

3. Select the name of the project in the Project Name list whose status you want to update
to Merge with As-Built.

4. Click Refresh Status to display the 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 Merge 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 290/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 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 Smart 3D
Orthographic Drawings Help.

3. Select a model in the Project Management tree.

4. Click Tools > Update Project Status Command to open the Update Project Status
Dialog.

5. Select the name of the project in the Project Name list whose status you want to update
to Merged with SmartPlant.

6. Click Refresh Status to display the 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 Smart 3D Drawings and Reports, retrieve the Project List and verify that the status of
all 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 291/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. Select a model in the Project Management tree.

2. Click Tools > Update Project Status Command to open the Update Project Status
Dialog.

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

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.

2. Click Tools > Update Project Status Command to open the Update Project Status
Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 292/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

Set up default style rules for the model

A default style rule lets you apply a particular color style to different model objects based on
eligible criteria. Typically, you use default colors for objects that are not expected to change
through the life of the project, such as object type or fluid code. To set colors based on
properties that change as the project progresses (for example, approval status), you use
surface style rules. For more information, see Surface Style Rules Command in the Common
Help.

The software applies default colors to the following aspects by defaults: insulation
(translucent white), maintenance (translucent red), and operation (translucent red). To
apply colors to other aspects, use surface style rules.

The time needed to apply default colors can impact testing time. Hexagon recommends
that you avoid testing on production models. For ease of testing, use a model that has a
single occurrence of each object type for ease of testing

Import default style rules

1. Select a model node.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 293/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

Export default style rules

1. Select a model node.

2. Click Tools > Project Settings > Export to open the Export Model Settings Dialog.

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.

The software displays a message telling you that the export was successful.

Add a default style rule

1. Click Insert Row on the Default Color Configuration Dialog. 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.

3. Select the color from the Style (Color) list.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 294/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

4. If necessary, specify additional criteria in the Criteria box. Click ... to display the Filter
Properties Dialog.

5. After all the rules are defined, click Project Settings > Apply Default Colors Command.

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.

Set a default color for fluid code

1. Select a model in the Project Management tree.

2. Click Tools > Project Settings > Configure Default Colors to open the Default Color
Configuration Dialog.

3. Click Insert Row .

The software adds a blank row to the grid and sets the focus to the Object Type box.

4. Click in the Object Type box, and then click to access the object type hierarchy, and
then select Piping > Piping Parts > Pipes as the object type.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 295/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

5. Select Green in the Style (Color) list.

6. Click in the Criteria box, and then click to open the Filter Properties Dialog.

7. Use the criteria listed below to define a filter based on the Fluid Code property.

Set Object type used as the basis for property identification to Piping >
Piping Parts > Pipes.

Set Relationship to Pipeline to Piping parts.

Set Related object type to Systems > Pipelines.

Set Display Properties in this category to Standard.

Select Fluid Code in the Select one or more properties grid.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 296/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

8. Click OK to return to the Filter Properties dialog box.

9. Select = in the Operator list, select P, Process in the Value list. and then click OK.

10. Save your changes in the Default Color Configuration Dialog.

11. To see the new rule in the proper section, click Tools > Project Settings > Configure
Default Colors on the root level of the model.

12. Expand the Piping discipline. Two rules are listed for Pipes:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 297/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

13. Select the new rule created for FluidCode = P.

14. Click the Move Up command until the new rule moves one row about the Default
Pipes rule, and then save your changes.

15. Select the model in the Project Management tree, and then click Tools > Project
Settings > Apply Default Colors to update the style IDs.

16. Open a new session and define your workspace. The software displays the pipes in
green.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 298/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Customize style rules based on role

1. Select a model in the Project Management tree.

2. Click Tools > Project Settings > Configure Default Colors to open the Default Color
Configuration Dialog Box.

3. Expand the Piping discipline, and then expand the Pipes rule.

Click Click here to add new item in he grid.

The software adds a blank row to the grid and sets the focus to the Style Set (Role)
box.

4. Select Piping in the Style Set (Role) list, and select Yellow in the Style (Color) list.

The list of available designers is based on the Optimization for Role .xml file in
the SharedContent folder. You cannot add a new row without a valid designer.

5. Press ENTER to finish creating the role assignment.

6. After all the rules are defined, click Project Settings > Apply Default Colors Command.

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.

7. Open a new session, and define a new workspace. In the Role list, select Piping
Designer (Aboveground), and then click OK.

The software displays piping parts in yellow.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 299/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

If you open a new session and set the role to None when you define your
workspace, the software no longer displays the pipes in yellow.

Check for database interferences

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 300/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. Smart 3D provides two methods for using interference checking: Server-
based interference checking (database detect) and Interactive interference checking (local
detection). The table below lists the main differences between the two methods.

Database Detect Local Detect

Runs continuously. Works only within the current session.

Dedicated server minimizes impacts on users Provides immediate graphical feedback.

and improves performance.

Creates persistent interferences that are Creates temporary interference markers in a

stored in the model database. user session that are not stored in the model
database.

Based on administrator settings and Based on individual settings.

controlled by permission groups.

Provides feedback about how much has been Checks only created and modified items in
checked in the entire model. the current session.

For more information about using Local Detect, see Interactive Interference Checking (Local
Detect) in the Common Help.

Server-based interference checking

In order to monitor interferences, you must install Database Interference Detection Service on
the same computer that Project Management is installed. You set database detection options
using the tools in Project Management. You can also start and stop the interference database
detection process in Project Management.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 301/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 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 for Database Detect, you are given an option to perform a warm reboot so that
all the approved interferences are preserved.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 302/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Settings dialog 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.

IFC permission requirements

You must install the Database Interference Detection Service option in order to monitor
interferences. See Smart 3D Installation for information about installing and configuring this
service.

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:

Write access to 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 303/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Folder and New Permission Group dialogs, respectively. See Create IFC permission
group folder and permission group.

Read access on all other model database permission groups at a minimum.

Install Database Interference Detection Service

You must have administrator privileges on the computer to install the software.
You cannot install and configure the interference detection service if you are using Intergraph
Smart 3D in Smart Cloud. Please open a service request using Cloud as the product.
Request that the interference detection service be configured for the model.

Prior to installing the Database Interference Detection Service on a computer, verify that all
prerequisite software has been installed. If you have an older version of the Database
Interference Detection Service installed on your computer, remove it before loading the new
software. Refer to the Smart 3D Installation documentation for more information.

1. Open Control Panel.

2. Open Programs and Features.

3. Select Intergraph Smart 3D from the list of installed applications, and then click
Change.

4. Select Database Interference Detection Service. To also install the 64-bit version of
the interference detection service, select 64-bit Services.

If you are running Oracle, you must install the 64-bit Oracle client on the
computer running 64-bit interference detection.

5. Click Update.

Set services authentication settings

The Database Authentication Settings - Services utility defines the location of the database
user's .ini file on the computers running the interference checking service, the naming rule
service, and batch services. Because these three services use logon credentials defined in
the service itself and not the active Windows OS logon, you must run this utility as an
administrator on the computer. This action allows the services to find and access the
database user's .ini file.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 304/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

You do not need to run this utility if you are using Windows Authentication to access
the databases. See Create Database Login ini File for information on creating the .ini file.

1. Right-click ..\Smart3D\ProjectMgmt\Tools\bin\ServicesAuthenticationSettings.exe, and

then select Run as administrator.

2. Select the database server type.

3. Select Database User Authentication.

4. Define the location and file name for the .ini file to use.

5. Select OK.

Configure Interference Service properties

1. Click Start > Intergraph Smart 3D > Configure Interference Checking Service to
open the Configure Interference Service dialog.

2. Select your database type: Oracle or SQL Server.

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 305/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

menu.

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

The interference checking service does not consume a license when it starts. It
consumes a license only while processing the model. See Learn about Interference
Checking.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 306/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

While working in a Global Workshare environment, you can only run and monitor IFC
status from the host location.

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, navigate to the models icon.

3. Expand the model's folder.

4. Right-click a model under the models folder, and then select the New Permission Group
Folder Command to open the New Permission Group Folder Dialog.

5. Type IFC Permission Group Folder for the name of the new permission group folder.

6. Select OK to close the New Permission Group Folder dialog.

7. In the tree, navigate to the new IFC Permission Group Folder icon.

8. Right-click the IFC Permission Group Folder, and then select the New Permission
Group Command to open the New Permission Group Dialog.

9. Type IFC Permission Group for the name of the new permission group.

10. Select OK to close the New Permission Group Dialog.

After you create the IFC permission group, you must assign the proper access
permissions. See Set IFC permissions.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 307/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

3. Right-click the IFC Permission Group icon, and select the Permissions Command to
open the Access Permissions Dialog.

4. Select 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 select Add and search for users using the Select Users and
Groups dialog. This is a common Windows dialog. See your Windows
documentation for information regarding the options in this dialog.

To remove a user or group from the Add names grid, select the appropriate row,
and then select 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. Select OK.

8. Select OK again to close the Access Permissions Dialog.

Check database interferences

Before performing the following procedure, you must first manually configure theSmart 3D
Interference Detection Service on the computer with the service installed. See Configure
Interference Service properties.

1. In the Project Management tree, right-click the Interference Server icon under the
model for which you want to start Database Detect, and then. select Properties on the
shortcut menu.

2. In the Interference Server Settings Dialog, 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 308/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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, you must select this check box if you
want the software to consider attached Reference 3D models, inserted MicroStation
files, and inserted AutoCAD files. 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 309/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 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 automatically attempts 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. See Learn about Interference
Checking.

To start the server interference detection process, you must have at least Read access
to all objects in the model and Read 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, 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 310/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

restart the interference detection process.

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. In the Project Management tree, right-click the Interference Server icon , and then
click Properties to open the Interference Server Settings Dialog.

4. On the Database Detect tab, click Stop.

5. Click Tools > Update Custom Symbol Configuration Command, and select Update
Custom Symbol Configuration. See Create or update the custom symbol
configuration file.

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. Right-click the Interference Server icon , and then click Properties to open the
Interference Server Settings Dialog.

8. On the Database Detect tab, click Start to update the ProgIDs.

Schedule 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 311/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

selecting Submit Job on the Check Data Consistency Dialog, the Backup Dialog, and the
Restore one or more model databases from backup page in the Restore Wizard.

After you select Submit Job, the same scheduling dialogs open for each task. Although the
dialog title differs, the appearance and functionality of the dialog is the same.

For information on installing Intergraph Smart Batch Services and setting up the batch
queues, please refer to the Batch Services section of the Intergraph Smart 3D
Installation Guide.

Learn more about Batch Services in the Batch Services User's Guide and the Batch
Services Quick Start Guide. Batch Services is a separate product.

Schedule [Task] Dialog

Optional Schedule Properties Dialog

Create Smart 3D-related queues

Before submitting any jobs, you must use the Configure SP3D Batch Queue utility to create
the queues to be used with Smart 3D. This utility also creates an additional environment
variable needed so the Batch server functions properly.

1. Open Windows Explorer on the computer on which Intergraph Batch Services is

installed.

2. Navigate to the [Product Folder]:\ProjectMgmt\Tools\bin folder, and double-click

ConfigureSP3DBatchQueue.exe.

3. Under System Defined Queues, select SP3DProjectManagement, SP3DApplication,

and SP3DPrinting.

4. If needed, specify the name of an SMTP server so that emails are sent to submitters
after jobs are processed (including error logs of the operation).

After the queues are created successfully, the software displays a confirmation
message.

5. Click OK.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 312/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

6. Open Windows services console, and restart the Intergraph Batch Server service.

The queues are not reflected in the Batch server interface until the services are
restarted.

7. Open Intergraph Batch Manager, and verify that the queues were created.

Configure queues for jobs

1. Select the Smart 3D node in the Project Management tree.

2. Click Tools > Configure Queues for Jobs Command to open the Configure Queues for
Jobs Dialog.

3. Review the job types, and then click OK.

4. Right-click the model to configure, and then click Configure Queues for Jobs Command
to re-open the Configure Queues for Jobs dialog.

5. Review the different job types, and map them to queues as appropriate.

6. Click OK.

Log files produced during a batch process are saved in a folder named
SP3DBatchSvcTemp. The folder is created under the location defined by the
%SYSTEMDRIVE% system variable (for example, C:\SP3DBatchSvcTemp)..

Print jobs require printer access on the client where the job is created and on the server
where the job will be performed. The server and the client machines must have exactly
the same printer setup, and every individual printer should have exactly the same name

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 313/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

on both the client and server machines. This issue is shared with the previous batch
implementation.

The ConfigureDrawingsBatch utility must be run each time mapped account settings
are changed.

If you are running 64-bit drawings batch services and Oracle, you must install the 64-bit
Oracle client on the computer running the batch services.

Schedule Check Data Consistency task using Batch Services

1. Click Database > Integrity Command to open the Check Data Consistency Dialog Box.

2. Select one or more databases to process.

3. Select Basic check or Full check.

4. Click Submit Job to open the Schedule [Task] Dialog.

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 Command to open the Backup Dialog.

2. Click Submit Job to open the Schedule Backup Dialog.

3. Set the options as needed, and then click OK.

Schedule data restore using Batch Services

1. In Project Management, click Tools > Restore Command to open the Restore Wizard.

2. Select Restore one or more model databases from backup, and then click Next.

3. Perform the standard restore steps.

4. Click Submit Job.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 314/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

5. Complete the options in the Schedule [Task] Dialog.

6. Complete the Restore Options for Batch Process dialog.

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

Queue

Displays the name of the queues configured by an administrator for the job. See Configure
Queues for Jobs Command.

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
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 that you can use to define a start and end
date.

Run on box

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 315/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 316/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The Batch Services SMTP option must be configured on the batch server for this to
work. See Intergraph Batch Services Help.

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.

Optional Schedule Properties Dialog

Provides more options on the Schedule Backup Dialog. This dialog opens when you click
Options.

Start date

Sets an optional start date.

End date

Sets an optional end date, if checked.

Set up Model Data Reuse and Model Data Transform

operations

Model Data Reuse breaks up a large copy operation into a sequence of small operations. The
result is that you can reliably copy large portions of the model without being constrained by
the amount of memory available in the system. This helps you reuse a unit multiple times in
the same project, or use best practices to copy from one model to start a new model. In a
similar way, Model Data Transform enables you to move and rotate a large portion of design
objects from one location in the model to another.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 317/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Set up a Model Data Reuse Run the MDR Validation tool Set up a Model Data
operation Transform operation

Set up a Model Data Reuse operation

Model Data Reuse (MDR) supplements the existing copy/paste process by enabling you to
copy large amounts of 3D model data in a robust, scalable, and intelligent way. You run MDR
from Project Management as a wizard. No interaction with objects is required. The software
breaks down the copy set into multiple transactions. In the event of a failure, the process will
continue the copy the remainder of objects.

The following table summarizes the recommended practices for using Model Data Reuse
according to model type.

Type of model Objects to copy

An entire unit system or area system,

including structural members, slabs, walls,
Plant
equipment, foundations, pipe runs, ducts,
cable trays, conduits, and hangers.

Major sections of marine structure or

Marine outfitting. The sections can be organized into
assemblies or blocks.

An entire conveyor system, including belts,

Material Handling equipment, modules, chutes, trusses, and
trestles.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 318/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Best Practices for Model Data Reuse operations

To achieve the highest rate of success when copying objects, you should maintain the
integrity of the data. Run the following tasks before you begin copying to help ensure the
database integrity:

1. Run the Synchronize Model with Catalog Command.

2. Run the Database Integrity.

3. Run the Clean Database Command.

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.

Model Data Reuse and Model Data Transform workflow using Delete Optional

Delete Optional is available in the Paste Dialog. See the Common Help.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 319/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 320/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 321/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 322/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Model Data Reuse Workflow

The following process diagram shows the general workflow for setting up a Model Data
Reuse operation:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 323/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Click a box in the diagram to go to the associated procedure.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 324/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Model Data Reuse Wizard: Welcome

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 325/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 326/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. See Select Source Model Dialog.

Source systems

Opens the Source Systems wizard page that allows you to select a system, or systems, to
copy. See Model Data Reuse Wizard: Source Systems.

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. See Model Data Reuse Wizard: Source
Objects by Filter.

You can select only a single method at a time for retrieving source objects.

Select Source Model Dialog

Controls parameters for selecting the source model.

Site

Specifies the site from which to copy the data. Click ... to display the Select Site Dialog. 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

Controls parameters for selecting a different site.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 327/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

See Model Data Reuse (MDR) Command for information on compatibility between
sites.

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.

You cannot select the top model node.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 328/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 or click More
to open the standard Select Filter Dialog.

Select an existing filter, or click Create New Filter, to open the New Filter Properties dialog.
The New Filter Properties dialog is similar to the Filter Properties Dialog

Properties

Displays the Filter Properties Dialog for the selected filter.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 329/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

See Using Filters for information on valid filter types.

If you are using MDR across site databases, the source filter properties are not
available.

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:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 330/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Filter Type Logical Operator Get Related System Destination Systems

Parents

System Expand No Parents of initial

systems

Permission Group Restrict Yes Lowest Common

(PG), Object Type, Parent
Volume, Properties

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 Parents Destination Systems

Any combination of System, Yes Lowest Common Parent

PG, Object Type, Volume,
Properties

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 331/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Select Filter Dialog

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 332/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Select Tools > Select by Filter.

Select Source Filter > Select Filter on the Copy by Family Ribbon.

The tree view displays the following types of filters:

Catalog 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 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 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 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, 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 333/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Displays the New SQL Filter Properties dialog, 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
deletes its contents.

Rename

Changes the name of an existing filter or folder from the Select Filter list.

Properties

Displays the Filter Properties dialog so that you can select the properties that determine
your filter search criteria.

If this dialog is activated from the Select by Filter Command, you can select multiple
filters on this dialog. Hold CTRL or SHIFT, and click each filter. When you click OK, all
objects that fit the selected filters are selected.

If this dialog is activated from the Select by Filter Command, it clears the select set
before adding objects to the select set.

Filter Properties Dialog

Builds a filter or displays the properties of an existing filter. You access this dialog from the
Select Filter Dialog, which is available in a variety of areas in the software, such as:

File > Define Workspace - Filter option, or Properties button, if a filter is selected.

Tools Menu > Select by Filter Command.

This dialog 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 tabs let you pick the appropriate criteria for the filter. For example, the System,
Assembly, or Named Space tabs on the Filter Properties Dialog 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 334/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

assignment of the filter. The Work Breakdown Structure 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 filter.

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, when Smart 3D evaluates the
filter (such as when you define a workspace), the software selects all sub-objects under that
object. If you do not check this box, only the selected object is included in the objects returned
when the software evaluates the filter. This option is unavailable for certain tabs on this dialog.

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, the default is always the last-selected option.

When you double-click a filter on the Select Filter Dialog, the software applies the filter
and dismisses the dialog.

System Tab (Filter Properties Dialog)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 335/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 select Lock CTRL key or 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.

Assembly Tab (Filter Properties Dialog)

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

The Assembly tab is not used in Model Data Reuse. You can include assemblies in
the copy operation by selecting Copy related assemblies. See Model Data Reuse Wizard:
Disciplines in the Project Management Help.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 336/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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)

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

In Model Data Reuse, the Name Space tab is not used. You can include volumes in
the copy operation by selecting Copy volumes in range. See Model Data Reuse Wizard:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 337/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Disciplines in the Project Management Help.

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)

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

The Analysis tab is not used in Model Data Reuse.

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-

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 338/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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)

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.

The Work Breakdown Structure tab is not used in Model Data Reuse. You can
include WBS items in the copy operation by selecting Copy related WBS. See Model Data
Reuse Wizard: Disciplines in the Project Management Help.

WBS items override any other filter that applies to them. The objects assigned to the WBS
items do honor the settings from other filters. Examples of tabs that are overridden for WBS
items include:

Permission Group

Property

Object Type

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 339/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

A simple filter shows only objects assigned to the selected WBS items and the WBS
items themselves. To see WBS objects on the Systems 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.

Permission Group Tab (Filter Properties Dialog)

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 Project Management.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 340/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Object Type Tab (Filter Properties Dialog)

The Object Type tab provides a list of all the major object types you can include in your
search. The objects in this tab are organized by discipline or task and apply restrictions to
their respective hierarchy in combination with the other expanding hierarchy tabs, for
example, System, Named Space, Reference 3D, and so on.

The filter selects the objects you highlight. If you do not select any objects, the filter uses the
definition from the expanding hierarchy tabs without restricting their object types. If you select
an object type without selecting any hierarchies, the software returns all objects of that type in
the model. If you select object types and hierarchies, the software returns only those object
types that are contained in the selected hierarchies. The table contains examples of the object
types returned based on the object type and hierarchy tab selections.

Object type selection Hierarchy tab selection Object types returned

Piping None All piping objects in the model

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 341/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

None System hierarchy All objects in the System

selection

Equipment Reference 3D Only equipment objects in the

Reference 3D selection

To include one or more object types in your filter, press CTRL while selecting multiple object
types, or select Lock CTRL Key before selecting objects.

Volume Tab (Filter Properties Dialog)

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 342/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 343/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Filter Method

You can combine multiple properties on individual rows.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 344/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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)

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

In Model Data Reuse, the Reference tab is not used.

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 > 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 Properties Dialog. The compound filter ignores any Reference tab
information.

Reference 3D Tab (Filter Properties Dialog)

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

The Reference 3D tab is not used in Model Data Reuse.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 345/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 346/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Specifies 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 required. Permission groups are created in Project Management.

Transfer

Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group using the Transfer Ownership Dialog. 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.

Approval State

Specifies the status of the selected object or filter. Changing this property sets the Status.
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. Smart 3D saves an object to the
database when you change that object's status. Use Undo (CTRL + Z) to reverse the
status change.

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 the Approval State
sets this property. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file.

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 of the last modification to the object.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 347/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Last Modified by

Specifies the name of the person who last modified the object.

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.

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 option 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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 348/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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. See Select Destination Model Dialog. The destination model can only be selected from
the active site.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 349/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Select Destination Model Dialog

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.

Model Data Reuse Wizard: Destination

Selects Destination System Parents, Destination Assembly Parents, the WBS Parent, the
Space Parent, Drawings Parent, 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, select a group in the
Default permission group box.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 350/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 . See Model
Data Reuse Wizard: Add the Destination System Parent.

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 . See Model Data Reuse Wizard: Add the Destination System Parent.

If the source systems have a single parent system, map that parent system to a single
destination model.

If multiple source systems with multiple parent systems are selected, then you also must
select multiple destination systems.

If the Copy related WBS option is active, you must select a destination WBS parent.
FSee Model Data Reuse Wizard: Work Breakdown Structure Tab.

If the Copy related assemblies option is active, you must select a destination
assembly parent. See Model Data Reuse Wizard: Assembly Tab.

If the Copy volumes in range option is active, you must select a destination space
parent. See Model Data Reuse Wizard: Space Tab.

If the Copy composed drawings option is active, you must select both a destination
space parent and a destination drawings parent. See Model Data Reuse Wizard: Space
Tab and Model Data Reuse Wizard: Drawings Tab.

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. See Model Data Reuse Wizard: Use the Permission Group Map.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 351/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Shows the parent of each copied system.

Destination System Parent

Shows the destination parent for the system to be copied to.

Model Data Reuse Wizard: Select Destination System Dialog

Displays the destination systems available for selection. Click in the hierarchy to expand the
options.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 352/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 .

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 353/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Model Data Reuse Wizard: Select Destination Assembly Dialog

Displays the assembly parents available for selection. Click to expand the options.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 354/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 355/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Model Data Reuse Wizard: Select Destination WBS Dialog

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 356/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 .

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 357/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Model Data Reuse Wizard: Select Destination Space Folder Dialog

Displays the Space Hierarchy tree view from the destination model for selection. Click to
expand the options.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 358/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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
.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 359/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Model Data Reuse Wizard: Select Destination Drawings Dialog

Displays the Drawings Hierarchy tree view from the destination model for selection. Click
to expand the options.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 360/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Model Data Reuse Wizard: Permission Group Map Dialog

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 a
different destination permission group.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 361/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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, select a new destination
system.

3. Click OK.

The new name displays 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 362/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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, select a new assembly parent.

3. Click OK.

The new name displays 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 displays in the Destination Space Parent list adjacent to the
corresponding Source Space Parent.

4. Click Next to continue.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 363/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 displays in the Destination Drawing Parent list adjacent to the
corresponding Source Drawing Parent.

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

To replace every Destination Permission Group with the matching Source

Permission Group, if available. select Keep Originals. 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.

Alternatively, 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 364/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

If you do not have sufficient privileges to change the permission group, the default
permission group is used.

Model Data Reuse Wizard: Transformations

Controls how copied design objects are transformed. These design objects can be
transformed using None, Move by relative distance, Rotate, Mirror, and Transform by
coordinate system 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.

Move by Relative Distance

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 365/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

3. Click Next to go to the Confirmation page.

Data is always moved with respect to the Global coordinate system, including data in
areas modeled with respect to a rotated coordinate system. 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 366/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 367/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 368/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Pipe spec and short code mapping will be used

Determines whether or not to use the mapping file to map items.

View & Map Dialog

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.

Pipe Specs Tab (View & Map Dialog)

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 369/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 370/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 371/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Mapped

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 372/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 373/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

Delete

Deletes the selected operation.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 374/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 displays 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 375/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

Model Data Reuse Wizard: Operation Properties Dialog

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.

General Tab (Operation Properties Dialog)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 376/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

By Class Tab (Operation Properties Dialog)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 377/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Remaining

Displays the number of design objects in an object class that are waiting to be copied to the
destination model.

Configuration Tab (Operation Properties Dialog)

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 the
select set already belong to another location and are nontransferable. For more information,
see Transfer Ownership dialog box in the Common Help.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 378/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Displays the user name of the person who modified the operation last.

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

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 number to make it unique. The text file appears similarly to the one shown in the following
illustration.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 379/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Run the MDR Validation tool

You must use the Custom Commands Command to add the Model Data Reuse
Validation tool to Project Management.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 380/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Orientation changes

Content changes

The utility provides the resulting differences in a View Results dialog 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.

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.

4. Type MDRValidation.CValidateGeometry as the Command Progid.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 381/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 to display the Validate MDR Results - Generate Data Dialog.

Validate MDR Results - Generate Data Dialog

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 382/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Precision 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 383/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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. Click Tools > Custom Commands, and start the MDR Validation tool.

2. Select Model Data Reuse Log File, and browse to the log file associated to the current
model.

3. To limit the comparison, select one or both of the analysis options.

Limit Analysis to Selected Objects

Limit Analysis to Selected Object Types

If you select Limit Analysis to Selected Object Types, place a check mark
beside each object type to use.

4. Set the Coordinate and Length Precision options, which enable you to control the
precision of validation.

5. Click Generate Data For Validation.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 384/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The status bar displays progress messages when processing the data and also when
the processing is completed.

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

8. When the process is completed, you can review the results. Click Review Results.
Select Differences Only to see only the differences that were found. See View results

Process and generate data using objects list files

1. Click Tools > Custom Commands, and start the MDR Validation tool.

2. Open the related session file. Select Objects List File, and click Source.

3. If you have an objects list file, type in the pathname or browse to the file. For the utility
to automatically generate a list file for your source data set, click Create Objects List
File.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 385/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

If you select Limit Analysis to Selected Object Types, place a check mark
beside each object type to use.

6. Set the Coordinate and Length Precision options, which enable you to control the
precision of validation.

7. Click Generate Data For Validation.

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

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

10. When the process is completed, click Review Results to review the results. Select
Differences Only to see only the differences that were found.

View results
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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 386/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 387/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 388/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

As you move through the list views in the Compared Data section of the Validate
MDR Results - Review Findings Dialog, 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.

Validate MDR Results - Review Findings Dialog

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 displays when you click Review Results in the Validate MDR Results - Generate
Data Dialog.

Review

Select All or a specific task to review.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 389/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 390/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 391/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

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.

Set up a Model Data Transform operation

Model Data Transform (MDT) enables you to move and/or rotate a large portion of the design
objects in a model from one location to another. The software completes the process in two
phases:

1. The software disconnects the objects in each partition from the surrounding objects.

2. The software transforms the disconnected objects in each partition to their new location.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 392/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The set of design objects can include read-only objects. If a read-only object
prevents disconnection or transformations, MDT enables you to correct the situation and
restart the operation.

Best Practices for Model Data Transform operations

Create a backup

Create a backup of your model database before starting a Model Data Transform (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 Model Data Transform (MDT) Command automatically disconnects and reports
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. See Check Write Access - Results.

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

Delete Optional is available in the Paste Dialog. See the Common Help.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 393/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 394/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 395/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 396/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Model Data Transform Workflow

The following diagram shows the general workflow for setting up a Model Data Transform
operation:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 397/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Click a box in the diagram to go to the associated procedure.

Model Data Transform Wizard: Welcome

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.

The following illustration shows the general workflow for using Model Data Transform:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 398/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 399/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 400/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

The software highlights the system that you select. The set of all highlighted nodes constitutes
the select set. Click 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 401/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Model Data Transform Wizard: Transformations

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

Properties

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 402/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Displays the Filter Properties Dialog so that you can review the properties of the selected
filter.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 403/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

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 of your selection 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. See Check Write Access - Results.

Click Transform to start the process.

The Model Data Transform processing dialog displays. The progress bar shows, first, the
status of disconnecting the boundary objects, and then the status of transforming the objects.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 404/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

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

Displays the properties associated with a Model Data Transform operation.

General Tab (Operation Properties Dialog Box)

By Class Tab (Operation Properties Dialog Box)

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 405/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Messages Tab (Operation Properties Dialog Box)

Configuration Tab (Operation Properties Dialog Box)

General Tab (Operation Properties Dialog

Displays general operation information, including the operation status and the summary
operation statistics.

Name

Displays the name associated with the operation.

Model

Displays the name of the model database.

Operation Status

Displays the status of the operation. The events that lead to different operation status values
are listed in the following table:

Event Action Operation Status Able to Restart the

Operation?

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 406/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Operation completes Processing completes Completed No

successfully without normally.
any read-only objects.

Operation completes Processing completes Incomplete Yes

successfully with normally.
read-only objects.

User clicks Stop on Processing is Stopped Yes

the Progress Bar terminated in an
orderly way.

Hardware/software Processing terminates Incomplete Yes

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 407/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 408/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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)

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 409/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The software also displays any additional information related to the object.

Configuration Tab (Operation Properties Dialog)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 410/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Command Reference

The Project Management menu bar includes the menus Database, Edit, View, Go, Tools,
SmartPlant, and Help. The following topics provide reference information on the commands
available in Project Management.

Some Project Management commands reside on the menu bar, the toolbar, and the
right-click menu of the console pane.

Database menu

Edit menu

View menu

Go menu

Tools menu

SmartPlant menu

Database menu
The Database menu provides commands for creating new catalog and model databases,
creating new permission group folders and permission groups, defining custom properties for
database objects, attaching reference data, and performing database maintenance.

New Model Command

You cannot run this command if you are using Intergraph Smart 3D in Smart Cloud.
Please open a service request using Cloud as the product. Request creation of a new model.

Creates a new model database and allows you to associate the appropriate catalog database
with this model. The model database organizes all the three-dimensional objects in the
physical model. The Database > New > Model command is available only when you select
Models in the Project Management tree.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 411/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Although used interchangeably with model database, a model configuration is all

three databases (catalog database, catalog schema, and model database) used together.

New Model Dialog

New Model Dialog

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)

Databases Tab (New Model Dialog)

General Tab (New Model Dialog)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 412/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Databases Tab (New Model Dialog)

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 413/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

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 Command

You cannot run this command if you are using Intergraph Smart 3D in Smart Cloud.
Please open a service request using Cloud as the product. Request creation of a new
catalog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 414/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Creates a new, empty catalog database and schema without bulkloaded data. 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. You can also
create a new catalog database and schema with data by using a template. A catalog
database with data contains reference data such as part dimensions, specifications, and
industry standards.

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 Catalog tree view.

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.

New Catalog Dialog

Provides options for creating a new catalog database and schema. You access this dialog box
with Database > New > Catalog Command.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 415/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 416/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Hexagon Asset Lifecycle Intelligence.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 417/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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 Command

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.

New Location Dialog

New Location Dialog

Sets options for creating a new location. The first location, or Host location, is created
automatically during the Site database generation process.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 418/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

General Tab (New Location Dialog)

General Tab (New Location Dialog)

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.For SQL Server databases, 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.

New Permission Group Command

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.

The New Permission Group command is also available on the shortcut menu that
displays when you right-click a permission group folder in the Project Management tree.

New Permission Group Dialog

New Permission Group Dialog

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 using the Define Permission Group Properties Command also

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 419/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

display.

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.

New Permission Group Folder Command

Creates a new permission group folder that you can use to organize permission groups in
your model.

The New Permission Group Folder command is also available on the shortcut menu
that displays when you right-click a catalog or model in the Project Management tree.

New Permission Group Folder Dialog

New Permission Group Folder Dialog

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 that you defined using the Define Permission Group Folder Properties
Command also display.

Value

Specifies the value for the permission group folder property.

Point Cloud Model Reference

Adds a point cloud model to the Smart 3D model.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 420/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Before using this command, you must first install third-party software and integrate the
software with Smart 3D. For more information, see the Point Cloud Help.

The New Point Cloud Model Reference command is also available on the shortcut
menu that displays when you right-click a model or the Point Cloud Models root in the
Project Management tree.

Reference 3D Model Command

Facilitates the attachment of external 3D data to the Smart 3D model as a reference. The
software supports attaching external data 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.

The New Reference 3D Model command is also available on the shortcut menu that
displays when you right-click a model or the Reference 3D Models root in the Project
Management tree.

Reference 3D Model 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 object properties and view their names through ToolTips.

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 (GA) drawings showing relative positioning of

objects from R3D models, with limited annotation.

To translate all third-party data files, you must have a SmartPlant Review Publisher
license or an Intergraph Smart® Interop Publisher translation (SRP) license. However, it
is not required that either of these applications be installed on the computer performing
the translation.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 421/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

New Reference 3D Model Dialog

Reference 3D Model Properties Dialog

New Reference 3D Model Dialog

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

Specifies 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 422/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. See Use the GenerateMapping tool.

Intergraph Smart® Interop Publisher

Use this option for all Reference 3D models with data files generated from the Intergraph
Smart® Interop Publisher application. This option reads .zvf and .mdb2 files created from
Intergraph Smart® 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 Intergraph Smart® Interop Publisher, you must create the
CustomR3DSchema.xls file, and place it in the Reference3DComponents subfolder of the
SharedContent folder. See Custom Schema and Mapping Files.

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

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 423/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 424/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

If you are using a Smart Model from Intergraph Smart® 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. Intergraph Smart® 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 Intergraph Smart®
Interop Publisher and Intergraph Smart 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 425/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

Improve database load time

Reduces the time to insert the Reference 3D data into the database; however, the overall
performance can vary depending on several factors. This option applies only to SQL Server
databases and increases the size of the generated SQL Server log file. By default, this option
is not enabled.

Define Model Properties

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 426/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

create. For example, you might want to define a location property for a selected model or add
a completion date to a permission group.

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.

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. See View
Generator and Regenerate Reports Database Command.

Before creating or updating properties, use Database > New > Model to create at least
one new model.

Custom properties that you define with the Database > Define Properties > Model
command apply to all models in the site database.

Define Model Custom Properties Dialog

Define Model Custom Properties Dialog

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.

Delete

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 427/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Command

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 that you define with the Database > Define Properties >
Permission Group command apply to all permission groups of a model.

Define Permission Group Custom Properties Dialog

Define Permission Group Custom Properties Dialog

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 428/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Copy From

Opens the Copy From Dialog so that you can copy custom properties from another model.

Define Permission Group Folder Properties Command

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 that you define with the Database > Define Properties >
Permission Group Folder command apply to all permission group folders of a model.

Define Permission Group Folder Custom Properties Dialog Box

Define Permission Group Folder Custom Properties Dialog

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 429/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Copy From

Opens the Copy From Dialog so that you can copy custom properties from another model.

Copy From Dialog

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.

Integrity Command
Runs directly on a database (Site, Catalog, or Model), and creates records for the objects that
need to be cleaned.

You can run this command multiple times:

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 Command in the
Common task to review the errors that Database > Integrity generated.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 430/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

In addition, you can use Submit Job on the Check Data Consistency Dialog to access batch
services to check integrity at times when the server may be less busy. See the Batch Services
Quick Start Help.

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

Check Data Consistency Dialog

Provides the options for Database > Integrity Command 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
Command (in Project Management or in Common) 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 431/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

Maintenance Command
Opens the Database Maintenance Dialog, which is a tool you can use to purge data that
might 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.

Before running the Database > Maintenance command, use the Tools > Backup Command
to make a backup of all the databases. You can later provide this backup to customer support
if further analysis is necessary.

If your database becomes corrupt, do not perform a full backup. Doing so will
destroy your active log file. See Remove database errors.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 432/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Database Maintenance Dialog

Database Maintenance Dialog

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 might 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
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 setting.

Rebuild selected indexes

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 433/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. The fill factor is low when a model is very dynamic, but the fill
factor is high when modifications occur in the model (for example, in a reference or "as-built"
model). Similarly, the fill factor is also low during catalog creation or heavy bulkload periods,
but the fill factor is high when the catalog becomes stabilized and used in production.

Rebuilding selected indexes can be performed in a Global Workshare Configuration at the

host and all satellite locations.

This option is enabled for both Oracle and SQL standard editions. In this instance, the
command runs the Rebuild index in offline mode. Offline mode should only be used during
scheduled downtime periods when there is no DML activity on the model database.

If you select this option but do not choose any tables in the associated grid, no action
is taken.

Reorganize selected indexes

Reorganizes the indexes on the database tables for the selected tables in the grid.

Reorganizing selected indexes can be performed in a Global Workshare Configuration at the

host and all satellite locations.

If you select this option but do not choose any tables in the associated grid, no action
is taken.

Select

Specifies which tables in the grid are processed.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 434/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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 select Yes, the dialog clears and a progress bar displays. Selecting No
cancels the command.

Cancel

Dismisses the Database Maintenance dialog without performing any action.

Analyze

Queries the database and displays a count of deleted and orphaned flavors.

Edit menu
The Edit menu provides commands undoing incorrect actions, copying and pasting,
modifying objects, and assigning permissions.

Undo Command
Reverses the effect of your previous transactions. You can click Undo repeatedly to
undo your transactions in reverse order.

Copy Command
Copies the selected item and its nested contents to the clipboard. 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 435/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

The Copy command is also available on the shortcut menu that displays when you
right-click an item in the Project Management tree.

Paste Command
Inserts the clipboard contents in a selected area of the model hierarchy. The Paste
command is not available 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.

The Paste command is also available on the shortcut menu that displays when you
right-click an item in the Project Management tree.

Move Command
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.

Delete Command
Permanently removes the selected item from the database. Deleting items can create
inconsistencies in the logical design of your model hierarchy. You cannot re-insert or paste
items after you remove them using Delete . However, you can retrieve the data and
reconcile the inconsistencies by immediately clicking Undo .

The Delete command is also available on the shortcut menu that displays when you
right-click an item in the Project Management tree.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 436/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Regenerate Reports Database Command

You cannot run this command if you are using Intergraph Smart 3D in Smart Cloud.
Please open a service request using Cloud as the product. Request regeneration of the
Reports databases.

Recreates the reports and reports schema databases. This command is available when you
select a model database in the Project Management tree.

The Edit > Regenerate Reports Database command is also available on the shortcut
menu that displays when you right-click a model in the Project Management tree.

The reports database is a set of views that points to the data in the other databases.

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 (an external utility), and then regenerate the
reports database.

Regenerate Reports Database Dialog

Regenerate Reports Database Dialog

Specifies the name and location options for regenerating a reports database. The options
displayed on the dialog 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 437/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Project Management tree.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 438/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Project Management tree.

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.

Rename Command
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.

The Rename command is also available on the shortcut menu that displays when you
right-click an item in the Project Management tree.

Rename Dialog

Rename Dialog
Changes the name that you have assigned to an item.

Current location

Specifies the location of the selected item on the Project Management tree.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 439/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

From

Displays the current name of the selected item.

To

Specifies a new name for the selected item.

Properties Command
Displays the properties and property values of the selected object.

The Edit > Properties command is also available on the shortcut menu that displays
when you right-click an object in the Project Management tree.

Location Properties Dialog

Database Properties Dialog

Interference Server Settings Dialog

Model Properties Dialog

Permission Group Folder Properties Dialog

Permission Group Properties Dialog

Point Cloud Properties Dialog

Reference 3D Model Properties Dialog

Database Properties Dialog

Sets the properties associated with the selected catalog database.

Property

Specifies a property type.

Value

Specifies the required information for a property.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 440/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

Location Properties Dialog

Displays property information for the location that you selected in the Project Management
tree. 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 441/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Naming String

Specifies the name rule ID that is assigned to the selected location.

Model Properties Dialog

Sets the properties associated with the selected model database.

General Tab (Model Properties Dialog)

Databases Tab (Model Properties Dialog)

General Tab (Model Properties Dialog)

Sets the general properties of the selected Model database. You can also assign new or edit
current permissions.

Property

Organizes the details about the model in this column of the grid.

Value

Specifies the appropriate facts about the model in this column of the grid.

Name

Specifies a word or phrase that identifies the model in this row of the grid.

Description

Sets a descriptive phrase for the new model in this row of the grid.

Site

Specifies a word or phrase that identifies the site in this row of the grid.

Owner

Specifies a word or phrase that identifies the owner in this row of the grid.

Permissions

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 442/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Sets permissions on the Access Permissions Dialog. You can set permissions when you
select a plant in the tree view.

Databases Tab (Model Properties Dialog)

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. See the Intergraph Smart 3D Installation Help.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 443/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Interference Server Settings Dialog

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.

The Interference Server Settings dialog is available only on computers on which the
Project Management and Database Interference Detection Service options are
installed. See Smart 3D Installation.

You access the dialog by selecting the Properties Command 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 select 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 Command is available if you need to

delete all preexisting interferences from the database and start checking from scratch.

Database Detect Tab (Interference Server Settings Dialog)

Status Tab (Interference Server Settings Dialog)

Database Detect Tab (Interference Server Settings Dialog)

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 Project Management are read-only.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 444/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 445/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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 Project
Management.

Stop

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 446/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Stops the Local Detect interference checking the process. This option is only available in
Project Management.

Status Tab (Interference Server Settings Dialog)

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 is only available on computers on which the
Project Management and Database Interference Detection Service options are installed.
See Smart 3D Installation for information about installing this service, .

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 447/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 448/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Displays textual information about the current status of the process on the server.

Permission Group Folder Properties Dialog

Sets the properties associated with the selected permission group folder.

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.

Permission Group Properties Dialog

Sets the properties associated with the selected permission group.

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 449/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Point Cloud Properties Dialog Box

Defines properties associated with the referenced point cloud.

If the point cloud does not support point cloud transformation, the software
deactivates options related to transformation.

Point Cloud

Specifies a point cloud name.

Point Cloud Source

Specifies the path or location of the point cloud source file. For example, files with extension
*.imp represent Leica CloudWorx.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 450/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 451/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Up Distance

Specifies the up distance to position the reference point cloud model.

Reference 3D Model Properties Dialog

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

Specifies 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 452/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. See Use the GenerateMapping tool.

Intergraph Smart® Interop Publisher

Use this option for all Reference 3D models with data files generated from the Intergraph
Smart® Interop Publisher application. This option reads .zvf and .mdb2 files created from
Intergraph Smart® 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 Intergraph Smart® Interop Publisher, you must create the
CustomR3DSchema.xls file, and place it in the Reference3DComponents subfolder of the
SharedContent folder. See Custom Schema and Mapping Files.

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

Specifies 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 453/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Permissions Command
Assigns access permission levels for the model and the catalog, as well as for individual
permission groups.

The Edit > Permissions command is also available on the shortcut menu that displays
when you right-click a model, catalog, or permission group in the Project Management tree.

You can assign a user one of three types of access:

Read allows the user to view objects.

Write allows the user create, modify, and delete objects.

Full Control allows the user 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

Create, edit, and delete catalog filters

Bulkload to the catalog

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 454/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. See Assign
System Administrator Privileges.

You must use Windows-based domain groups and accounts to administer users in a
multi-machine configuration.

Access Permissions Dialog

Add Users and Groups Dialog

Access Permissions Dialog

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 455/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Displays the Add Users and Groups dialog box, where you can add new user and groups.
See Add Users and Groups Dialog.

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

Adds users and groups to the selected item. This dialog displays when you click Add on the
Access Permissions dialog. 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.

Add

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

Remove

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 456/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 457/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Places the information in the Add names grid to the Select user row to adjust access grid
on the Access Permissions dialog.

Cancel

Discards any users or groups that you defined in the dialog and closes the dialog.

Update Reference 3D Model(s) Command

Updates multiple Reference 3D products simultaneously.

The Update Reference 3D Model(s) command is also available on the shortcut menu
when you right-click a model in the Project Management tree.

View menu
The View menu provides commands for refreshing the view of the Project Management
hierarchy and for turning on and off the display of the Project Management toolbar and status
bar.

Refresh

Refreshes the display.

Toolbars

Toggles the toolbar display.

Status Bar

Toggles the status bar display.

Go menu
The Go menu provides commands that assist you in moving through the Project Management
hierarchy quickly and efficiently.

Back Command
Returns the focus in the Project Management tree to the last selected item or folder. You
can click the Back command repeatedly to retrace your path through several levels.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 458/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The Go > 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

Forward Command
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 click Forward command
repeatedly to retrace your path through several levels.

This command is not available if you are displaying the top classification in the
hierarchy.

Up One Level Command

Moves the focus up one level in the hierarchy.

This command is not available when you select the root level of the tree.

Tools menu
The Tools menu provides commands for backing up and restoring you model and for
upgrading your catalog and model databases to the same version as the site database. It also
provides commands duplicating and consolidating models that are participating in a Global
Workshare configuration. You can synchronize the model with changes from the catalog
database, modify the status of a project, access custom commands, and access the wizards
setting up Model Data Reuse and Model Data Transform operations.

Backup Command
If you are using Intergraph Smart 3D in Smart Cloud and want to restore this backup
off-cloud, please open a service request using Cloud as the product. Request a backup for
the model.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 459/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

need the databases in another location, you can use the backup files to restore the databases
with the Restore Command.

Set up the backup

The Backup Dialog identifies the model by name, database size, and description, and allows
you to specify the folder location (server and folder or UNC location) 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.

You can use Submit Job on the Backup Dialog to access batch services to back up
your data when the server may be less busy. See Schedule Project Management tasks
with Batch Services.

To transfer model configurations to another office, perform a complete backup in Project

Management. Include new and modified files in the SharedContent folder, as well as
any customized .dll files.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 460/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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. The full
recovery model is the SQL server default and the one recommended for production systems.

Refer to the Backing Up and Restoring Databases chapter of the SQL server books online for
information about what backup option is right for you. 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."

Full database backup is a heavy operation and should be planned on a regular basis, such as
once a week. The right backup strategy depends on your business requirements and the
activity on the database. 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

Hexagon recommends that you back up the log file once every 24 hours.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 461/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 and in
Project Management.

Backup Dialog

Schedule Backup Dialog

Optional Schedule Properties Dialog

Backup Dialog
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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 462/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 server location, or you can use Browse(...) in the Browse window to navigate
to the destination UNC 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. You can use Browse(...) to navigate to the destination UNC location. This option
displays 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. 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 463/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

OK

Starts the backup process for the selected models to the identified location.

Schedule Backup Dialog

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 464/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

Provides more options on the Schedule Backup Dialog. This dialog opens when you click
Options.

Start date

Sets an optional start date.

End date

Sets an optional end date, if checked.

Restore Command
You cannot run this command if you are using Intergraph Smart 3D in Smart Cloud.
Please open a service request using Cloud as the product. Provide information about what
databases need to be restored.

Opens the Restore Wizard so you can 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. The Tools > Restore
command 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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 465/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Command and Paste and Restore Command commands in the Smart 3D modeling
environment after restoring a model for selective recovery of model objects.

The site and site schema databases can only be restored using the Database Wizard.

If you are using Oracle databases, you should run the Oracle Role Creation Utility.

Restoring a Smart 3D model registered with SDx from a backup clears SDx registration
details as follows:

Restore one or more model databases from backup clears the

AuthroizationCodeWithProofKey credentials.

Restore model for selective recovery of model objects clears all SDx registration
details.

Restore model as copy clears all SDx registration details.

To recover your data, you must first re-register the restored model to the same SDx
plant as was used for the previous SDx registration. After you re-register the restored
Change Management model, you must define SDx retrieval settings.

Restore Wizard

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 466/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Restore Wizard
You access the Restore Wizard by clicking 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. 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. This
is the default option on the Introduction page of the Restore Wizard.

The intent of the Restore one or more databases from backup option is to restore a model
that already exists (or has pointers) in the current site database. Typically, this situation
happens when the production model needs to be rolled back to a previous date or
immediately after restoring a backup of the site database onto a new server. In the latter case,
only the pointer to the site is present and you would want to follow that action by restoring the
model and the catalog databases on that server as well.

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
recover portions of the model from different versions, such as from yesterday's backup or last
month's backup.

The intent of the Restore model for selective recovery of model objects option is to
restore a model database into a site database where a current version of the model already
exists. The restored model (which represents old data) will exist in the site database in
parallel to the current model and will share the same catalog database. In this respect, users
can open two sessions: one that points to the restored model and one that points to the
current model, select items from the restored model to copy, and then use the paste and
restore into the current model. This type of workflow allows for selective recovery of work from
previous versions of the same model.

Restore Ship for Selective Recovery does not support selective recovery of marine
and material handling model objects.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 467/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 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 one or more model databases from backup

This page displays when you select Restore one or more model databases from backup
on the Restore Wizard 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

Specifies 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

Specifies 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

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 468/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Path

Specifies the database default path on the selected server. Click Browse (...) to define
another location.

Log Path

Specifies the database default path on the selected server or service. Click Browse (...) to
define another location. This option displays only when you are restoring a SQL database.

Index Tablespace Path

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 469/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Specifies 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

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

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

This page displays when you select Restore model for selective recovery of model
objects on the Restore Wizard 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.

Models to restore

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 470/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Specifies 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

Specifies 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

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 471/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

Specifies the database default path on the selected server. Click Browse (...) to define
another location.

Log Path

Specifies the database default path on the selected server or service. Click Browse (...) to
define another location. This option displays only when you are restoring a SQL database.

Data and Index Tablespace Path

Specifies 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

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

Finish

Restores the databases.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 472/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Restore model as copy

This page is only available if you selected Restore model as a copy on the Restore Wizard
page.

New model name

Specifies 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

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

Server and path to existing database backup files

Specifies 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 473/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 474/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Database Path

Specifies the database default path on the selected server. Click Browse (...) to define
another location.

Log Path

Specifies the database default path on the selected server or service. Click Browse (...) to
define another location. This option displays only when you are restoring a SQL database.

Index Tablespace Path

Specifies 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

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

Synchronize Model with Catalog Command

You cannot run this command if you are using Intergraph Smart 3D in Smart Cloud.
Please open a service request using Cloud as the product. Request regeneration of the
Reports databases.

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:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 475/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Command
in Smart 3D 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. See Update multiple Reference 3D projects Project
Management Help.

Global Workshare

Running Synchronize Model with Catalog at the host location has the following
ramifications in a Global Workshare Configuration (GWC) setup:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 476/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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 utility to update
the model views. See View Generator in Project Management Help.

Synchronize Model with Catalog Dialog

Synchronize Model with Catalog Dialog

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 477/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Catalog schema name

Displays the catalog schema name.

Run

Starts the synchronization process.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 478/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Update Custom Symbol Configuration Command

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
right-clicking a catalog in the Project Management tree, and then clicking Update Custom
Symbol Configuration.

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

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 .NET or Visual C++. For more information, see Move custom .dlls to
SharedContent folder.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 479/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

4. Copy the symbol .dll files into the Custom Symbols folder. You can organize the symbols
as needed, with or without sub-folders.

5. In Project Management, select a catalog that uses the SharedContent folder where your
custom .dlls are located.

6. Click Tools > Update Custom Symbol Configuration Command to open the Update
Custom Symbol Configuration Dialog Box.

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

8. If there are duplicate ProgIDs, select the .dll to use for each duplicate, and then click
Update.

9. Click Close.

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

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 480/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

.dlls ending with "–Ref.dll" or "_Ref.dll" are treated as reference .dlls and are
ignored. Do not copy these .dlls from the client computer containing the source
code.

3. In Project Management, run Tools > Update Custom Symbol Configuration Command.

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.

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 computer. The priority order 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.

Debugging and maintaining project references, reference .dlls, and binary compatibility
are beyond the scope of this document. Contact your support representative if you have
questions.

Update Custom Symbol Configuration Dialog Box

Specifies the library to use for a specific ProgID. This dialog box displays when duplicate
symbol .dlls use the same ProgID.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 481/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 without making any changes.

Database Integrity
Runs directly on a database (Site, Catalog, or Model), and creates records for the objects that
need to be cleaned.

You can run this command multiple times:

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 Command 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 to access batch
services to check integrity at times when the server may be less busy. See the Batch Services
Quick Start Help.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 482/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

Schedule Check Data Consistency task using Batch Services

1. Click Database > Integrity to open the Check Data Consistency dialog box.

2. Select one or more databases to process.

3. Select Basic check or Full check.

4. Click Submit Job to open the Schedule Data Consistency Check dialog box.

5. Set the batch scheduling options.

6. Click Options to schedule optional start and end dates.

7. Click OK.

Upgrade Version Command

Upgrades the selected catalog or model database to the same version as the site database.
Upgrading your databases from a previous version to the latest installed software version
involves several different upgrade tasks using the Database Wizard and Project Management.
You must have the Project Management and Server Connectivity options installed on the
computer you are using to perform the upgrade.

The Upgrade Version command is also available on the shortcut menu that displays
when you right-click a catalog or model in the Project Management tree.

Migrating symbols and updating reference data are detailed processes. For
detailed upgrade information, refer to the Upgrade Guide delivered on the Smart 3D media, or
contact Customer Support.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 483/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Upgrade Version Dialog

Upgrade Version Dialog

Displays all the databases that available for 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 Version Command. You can also use this
command to perform the upgrade on the Update Custom Symbol Configuration 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:

Indicates that a database is out of date.

Check box

Indicates the databases to upgrade.

Catalog Name

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 484/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 for all nodes 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 485/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

to use updated symbols during the upgrade. Click Yes to proceed if you do not want to update
the custom symbol configuration.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 486/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

Upgrade

Upgrades the selected model and catalog databases.

You cannot upgrade the site database using Upgrade Version Command.

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

Update Project Status Command

Modifies the status of a project. During a project lifecycle, administrators create projects and
manage their administration through the stages of Active, Complete, and Merge with As-Built.
Occasionally, an administrator will need to cancel projects.

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 each project object must stay set to Working.
Setting the status to Approved makes the project object read-only. (For the Project
Management environment, commands like Claim and Release Claim no longer work.)

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 487/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 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 Project Management, 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.

Update Project Status Dialog

Update Project Status Dialog

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 488/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Provides options for managing project status.

Project name

Lists the names of all the Smart 3D projects (excluding As-Built) 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 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 option 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 489/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 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 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 option 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 Settings Commands

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 Command

Export Command

Configure Default Colors Command

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 490/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Apply Default Colors Command

Import Command
Imports a set of default style rules (in the format of a .xml file) into a model database. This is
useful when you need to port a set of rules from one model to another.

Import Project Settings Dialog

Import Project Settings Dialog

Controls parameters for importing an .xml file containing default style rules. Use the Export
Command 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 Command
Exports a default style rules .xml file. This is useful when you need to port a set of rules from
one model to another.

Export Model Settings Dialog

Export Project Settings Dialog

Controls parameters for exporting an .xml file containing default style rules. Use the Import
Command 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.

Configure Default Colors Command

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 491/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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 cannot apply surface styles to aspects using Configure Default Colors.

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.

Default Color Configuration Dialog

Select Object Type Dialog

Default Color Configuration Dialog

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

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. In the example, the active model is
SP3DTrain and is located in Huntsville.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 492/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Insert Row

Adds an empty row.

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

Specifies the object type for the rule. Click ... to display the Select Object Type Dialog 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. See Define roles in the Common Help. Contact customer 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 and specify a filter.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 493/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The grid displays the default style rules grouped by application. Click to expand a
group. Click to collapse a group.

Select Object Type Dialog

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 Common, you can access this dialog 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. When you are working with
ToolTips, the Select Object Type dialog opens after you click the browse button on the
ToolTips tab on the Options dialog.

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

Apply Default Colors Command

Applies the styling for different objects based on the rules defined by the Tools > Configure
Default Colors command. 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 494/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Project Management tree 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.

Duplicate Model for Workshare Dialog

Duplicate Model for Workshare Dialog

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 Project Management tree. 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. When the database type for the site
is Oracle, the Server column changes to Service. The drop-down list of Oracle Services
comes from Oracle Net Configuration Assistant.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 495/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 option is
available only when the database type is Oracle.

Consolidate Model from Workshare Command

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 you assigned to the selected Satellite locations for the
duplicated model are re-assigned to the Host location for a consolidated model.

You can use the Tools > 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 496/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Consolidate Models from Workshare Dialog

Consolidate Models from Workshare Dialog

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.

When the database type for the site is Oracle, the Server column changes to
Service.

You can use this grid to select one or more satellites to consolidate 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 OK is enabled.

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. This option is applicable
only for Oracle databases.

Model Data Reuse (MDR) Command

Do not run multiple Model Data Reuse jobs in the same model database
simultaneously from different Administrator computers. Doing so can cause a higher number
of failures because multiple jobs are trying to access the same model objects at the same
time.

Supports the following tasks:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 497/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Clicking Tools > Model Data Reuse opens a wizard that you use to set up the data reuse
operation. You 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, the Operation Properties dialog displays and 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 stops, and an error message displays. To continue, 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 498/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

See Model Data Reuse Wizard.

Copying

You can exclude any objects from 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 only allows the selection of a site from a compatible server.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 499/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

are different, computing errors may occur. For more information, see Model Data Reuse
Wizard: Compare Catalogs.

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 Wizard

Model Data Reuse Wizard

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 diagram shows the general workflow for setting up a Model Data Reuse
operation:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 500/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Click a box in the diagram to go to the associated procedure.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 501/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Model Data Transform (MDT) 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.

You cannot undo a Model Data Transform (MDT) operation. As such, you must
create a backup of the model before starting a Model Data Transform operation.

Operation Summary

The Tools > 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 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 502/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 503/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

owned by multiple locations, the operation cannot be completed. The design objects from the
other locations are reported as read-only.

Model Data Transform Wizard

Model Data Transform Wizard

The Model Data Transform 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 diagram shows the general workflow for setting up a Model Data Transform
operation:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 504/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Click a box in the diagram to go to the associated procedure.

Run Report Command

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 505/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Specifying inputs for an asking filter on the Filter Properties Dialog.

Specifying parameters on the Report Parameters Dialog.

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.

You can also use Tools > Run Report in any Smart 3D task to generate reports.

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 and Disable VBA
macros except digitally signed macros in Microsoft Excel. For more information, see
Enable or disable macros in Office files in Excel Help.

For information about creating report databases, see the Intergraph Smart 3D
Installation Help.

Run Report Dialog

Run Report Dialog

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 506/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

My Reports tab (Run Report Dialog)

Catalog Reports tab (Run Report Dialog)

My Reports tab (Run Report Dialog)

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 Drawings and Reports and save them to
the catalog.

Available report templates

Lists all of your available personal report templates.

File name

Specifies the default name for a report generated from the selected report template. You can
type a different name.

Browse

Displays the Select Report dialog 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, Filter
Properties Dialog, or Report Parameters Dialog.

Cancel

Cancels all changes, and closes the dialog.

Catalog Reports Tab (Run Report Dialog)

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 507/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Drawings and Reports.

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 Engineering
Check Reports: Piping Parts in the Catalog Help.

Properties

Opens the Properties Dialog (Run Report).

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 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, Filter
Properties Dialog, or Report Parameters Dialog.

Cancel

Cancels all changes, and closes the dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 508/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Properties Dialog (Run Report)

Displays the general properties and configuration of a selected report template. You cannot
change the properties of the template.

Definition tab (Run Report Properties Dialog)

Configuration tab (Project Management)

Definition tab (Run Report Properties Dialog)

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. See Transfer
Ownership Dialog.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 509/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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
the objects in the select set must belong to the same location.

Current permission group

Displays the name of the permission group with which the selected objects are currently
associated. If all the objects in the select set do not belong to the same permission group, this
box displays 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 510/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

Specifies parameters for a report deliverable, such as units of measure and coordinate
systems.

This dialog 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. See Design Layout in
the Reports Help.

Unit of Measure

Sets the units of measure for the report.

Matrix

Specifies information about the coordinate system. See Unit of Measure Dialog Box (Label
Editor) in the Common Help.

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.

Filter Properties Dialog

Builds a filter or displays the properties of an existing filter. You access this dialog from the
Select Filter Dialog, which is available in a variety of areas in the software, such as:

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 511/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

File > Define Workspace - Filter option, or Properties button, if a filter is selected.

Tools Menu > Select by Filter Command.

This dialog 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 tabs let you pick the appropriate criteria for the filter. For example, the System,
Assembly, or Named Space tabs on the Filter Properties Dialog 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 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 filter.

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, when Smart 3D evaluates the
filter (such as when you define a workspace), the software selects all sub-objects under that
object. If you do not check this box, only the selected object is included in the objects returned
when the software evaluates the filter. This option is unavailable for certain tabs on this dialog.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 512/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

When the New Dialog Box, the default is always the last-selected option.

When you double-click a filter on the Select Filter Dialog, the software applies the filter
and dismisses the dialog.

System Tab (Filter Properties Dialog)

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 select Lock CTRL key or 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.

Assembly Tab (Filter Properties Dialog)

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 513/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The Assembly tab is not used in Model Data Reuse. You can include assemblies in
the copy operation by selecting Copy related assemblies. See Model Data Reuse Wizard:
Disciplines in the Project Management Help.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 514/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Named Space Tab (Filter Properties Dialog)

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

In Model Data Reuse, the Name Space tab is not used. You can include volumes in
the copy operation by selecting Copy volumes in range. See Model Data Reuse Wizard:
Disciplines in the Project Management Help.

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)

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

The Analysis tab is not used in Model Data Reuse.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 515/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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)

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.

The Work Breakdown Structure tab is not used in Model Data Reuse. You can
include WBS items in the copy operation by selecting Copy related WBS. See Model Data
Reuse Wizard: Disciplines in the Project Management Help.

WBS items override any other filter that applies to them. The objects assigned to the WBS
items do honor the settings from other filters. Examples of tabs that are overridden for WBS
items include:

Permission Group

Property

Object Type

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 516/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

A simple filter shows only objects assigned to the selected WBS items and the WBS
items themselves. To see WBS objects on the Systems 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.

Permission Group Tab (Filter Properties Dialog)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 517/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

You can add permission groups in Project Management.

Object Type Tab (Filter Properties Dialog)

The Object Type tab provides a list of all the major object types you can include in your
search. The objects in this tab are organized by discipline or task and apply restrictions to
their respective hierarchy in combination with the other expanding hierarchy tabs, for
example, System, Named Space, Reference 3D, and so on.

The filter selects the objects you highlight. If you do not select any objects, the filter uses the
definition from the expanding hierarchy tabs without restricting their object types. If you select
an object type without selecting any hierarchies, the software returns all objects of that type in
the model. If you select object types and hierarchies, the software returns only those object

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 518/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

types that are contained in the selected hierarchies. The table contains examples of the object
types returned based on the object type and hierarchy tab selections.

Object type selection Hierarchy tab selection Object types returned

Piping None All piping objects in the model

None System hierarchy All objects in the System

selection

Equipment Reference 3D Only equipment objects in the

Reference 3D selection

To include one or more object types in your filter, press CTRL while selecting multiple object
types, or select Lock CTRL Key before selecting objects.

Volume Tab (Filter Properties Dialog)

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 519/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 520/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Properties Tab (Filter Properties Dialog)

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

Filter Method

You can combine multiple properties on individual rows.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 521/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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)

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

In Model Data Reuse, the Reference tab is not used.

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 > 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 Properties Dialog. The compound filter ignores any Reference tab
information.

Reference 3D Tab (Filter Properties Dialog)

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

The Reference 3D tab is not used in Model Data Reuse.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 522/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 523/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Specifies 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 required. Permission groups are created in Project Management.

Transfer

Reassigns ownership of the selected model objects from their current permission group to
another satellite or host permission group using the Transfer Ownership Dialog. 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.

Approval State

Specifies the status of the selected object or filter. Changing this property sets the Status.
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. Smart 3D saves an object to the
database when you change that object's status. Use Undo (CTRL + Z) to reverse the
status change.

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 the Approval State
sets this property. The list is controlled by the ApprovalReason codelist in the
ApprovalReason.xls file. You must bulkload this file.

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 of the last modification to the object.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 524/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Last Modified by

Specifies the name of the person who last modified the object.

Configure Queues for Jobs Command

Opens the Configure Queues for Jobs dialog 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 525/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

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 Queues for Jobs Dialog

Provides options for configuring a batch queue. You must have administrator privileges to
access this tool.

Time displayed in

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 526/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 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. See Creating
and Configuring Pipe Queues in the Intergraph Batch Services Help.

Optional Queues

Displays the Configure Optional Queues Dialog.

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 527/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Configure Optional Queues Dialog

Time displayed in

Displays the unit of measurement for Maximum Allowed Time, as defined on the Configure
Queues for Jobs Dialog.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 528/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Is TimeOut Supported

Enables Maximum Allowed Time functionality. This option is not selected by default.

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. See the Intergraph Smart 3D Installation Help available by
clicking Help > Printable Guides Command in the software.

After adding a custom command in the 3D software, you can edit it using the Edit Custom
Command Dialog 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.
Consult the Database Integrity (DBI) Guide and the Common User's Guide (Tools Menu >
Custom Commands).

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 529/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

See Database > Integrity Command in the

Database Integrity Help.

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.

See the Database Integrity Help.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 530/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 > Drawing Console Command.

Custom Command Duplicate Part Numbers

ProgID DuplicatePartNumbers,Ingr.SP3D.ProjectMg
mt.Client.Commands.DuplicatePartNumbers
Command

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.

Custom Command Find Object by OID

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 531/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.FixCnfgProjectRo
ot

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 532/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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 Style
Command.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 533/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

New databases (created after version

06.00.22xx) automatically use the corrected
colors.

Custom Command Place Piles

ProgID PileFoundation,PileFoundation.PileFoundatio
n

Description Provides a placement wizard to facilitate the

modeling of pile members. Through the Place
Piles custom 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,PlacingSupportsFr
omXLS.PlacingSupportsFromXLS

Description Places support information from an .xls file

into Smart 3D. You must run this command
from Smart 3D, and not from Project
Management. See Placing Supports from
XLS Command in the Smart 3D Hangers and
Supports Help.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 534/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Only run this command on a

model in Smart 3D. Running this command in
Project Management will result in an
application error.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 535/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Custom Command Repair Duplicate Permission Group ID

ProgID RepairDuplicatePermissionGrpID,Ingr.SP3D.
ProjectMgmt.Client.Commands.
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.

Custom Command Repair Permission Groups

ProgID PermissionGroupsAndLocations,Ingr.SP3D.P
rojectMgmt.Client.Commands.PermissionGro
upsAndLocationsCommand

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 536/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 537/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Custom Command Synchronize Drawing Templates

ProgID DwgSynchTemplatesCmd.SynchTemplates

Description Synchronizes, or copies, a template from one

drawing component to another.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 538/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. See Create a geometric construction
macro in the Molded Forms Help.

Custom Command Verify Seam Pattern to Split

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 539/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. See Swap Hulls on a
Detailed Model Using Molded Forms Delay in
the Molded Forms Help.

Custom Commands Dialog

Adds and edits the custom commands you have created.

Command names

Lists the names of commands that have been added.

Run

Starts the custom command you select in the list box. See Run a custom command.

Close

Cancels the Custom Commands dialog.

Edit

Opens the Edit Custom Command dialog. You can change settings for the command, such
as the program identifier (prog_ID) and command name. See Edit a custom command.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 540/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Add

Installs the custom command into the software. See Add custom commands.

Delete

Removes the custom command from the software. See Delete a custom command.

Clear

Deletes the information you have typed in the boxes on the Custom Commands dialog.

Description

Contains an identifying phrase so you can better recognize the custom command with which
you are working.

Add Custom Command Dialog

Accesses a customized command you created and saves the command within the software.

Command ProgID

Specifies the program identifier for the custom command you created.

Command name

Specifies the name you assigned to the custom command.

Description

Describes the custom command.

Priority

Assigns a priority of High, Normal, or Low.

Argument

Specifies command line arguments in a string.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 541/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Edit Custom Command Dialog

Changes options for a customized command you added to the software.

Command ProgID

Specifies the program identifier for the custom command you created.

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 to its default settings.

SmartPlant menu
The SmartPlant menu provides commands for registering your models with a SmartPlant
Foundation server. This menus also provides the tools for generating a design basis and
upgrading the schema.

Register Command
Registers a model database with a SmartPlant Foundation (SPF) server. You must register a
model before you can connect to the integrated environment to perform tasks, such as
publishing, retrieving, or revising files. You can register each model only once. To more
efficiently distribute design work, you can register multiple Smart 3D models to a single SPF
server.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 542/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

The Register command displays a wizard that steps you through the following tasks:

Selecting the model to register

Specifying the node name and virtual folder for the SmartPlant Foundation database

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.

In an integrated environment, the term "model" is synonymous with the top level of the
PBS hierarchy.

SmartPlant 3D Registration Wizard

SmartPlant 3D Registration Wizard

Guides you through the process of associating models with a valid SmartPlant Foundation
server.

SmarPlant Registration Wizard - SmartPlant Foundation URL

SmartPlant Registration Wizard - SmartPlant Foundation Plant

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 543/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

If the SPF site is a secure site, use the format

https://FullSPFServerNameWithDomain/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.

SmartPlant 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

Completes the registration process and closes the page. 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 544/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Generate Design Basis Command

Produces a design basis XML file and updates the associated map files. When you use Smart
3D in an integrated environment, you might 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 that you make in the SmartPlant schema need to propagate to the catalog
schema database.

The SmartPlant > Generate Design Basis command creates a design basis package that
the software loads into the catalog schema database. The steps that the Generate Design
Basis command accomplishes are listed below.

Reads the delivered component schemas.

Reads and modifies the design basis map file that is used to create design basis objects
during a document retrieve.

Generates the design basis schema package that is loaded into the Smart 3D catalog
schema database.

The Generate Design Basis command uses the file names of the component schemas and a
design basis map XML file as input. 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.

Upgrade Schema Command

Updates the existing tool map schemas associated with the active site to a newer version.
You primarily use the SmartPlant > Upgrade Schema command when you are upgrading
between major software versions. See the Smart 3D Upgrade Guide.

As delivered, the tool map schema files are usually write-protected. Before you use the
Upgrade Schema command, make sure that the files in the [Product
Folder]\SharedContent\Xml folder, the files in the [Product Folder]\SharedContent\Xml
folder\DesignBasisSchemas folder, and all associated files are writable.

Backups are made of all files that are processed. Upgrade Schema can take several minutes
to complete processing.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 545/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

The following SharedContent file shares are processed:

SP3DPublishMap.xml - Upgraded to 11.

P3DComponent.xml - Upgraded to 11.

DesignBasis_Map.xml - Copied to the SharedContent folder.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 546/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Appendix: Utilities and Services

The following utilities and services are specific to the Administrator tasks you can perform in
Project Management.

Configure Project Settings for Drawings Utility

Enables you to make project-wide changes to drawing settings. To run the utility, navigate to
the [Product Folder]:\ProjectMgmt\Tools\bin folder, and double-click
ConfigureDrawingsProjectSettings.exe.

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 Management Console.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 547/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 548/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 549/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

You must run the Database > Integrity Command 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 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 550/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Specifies the server name on which the target object is created. Double-click the cell to select
from the registered servers.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 551/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Conversion Status
Displays the conversion status, log files, and any errors. Click Convert to convert the
databases. Click Close to exit the wizard.

Database Wizard
The Database Wizard 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. Beyond the
initial creation of the site and site schema databases, you must use the Database Wizard
used to restore site databases from a backup and to upgrade from a previous software
version. You can also use the Database Wizard to change the active site database or change
the name generator server.

The Database Wizard is located at Start > All Programs > Intergraph Smart 3D >
Database Wizard and is only available when the Server Connectivity option is installed on
the computer.

If you are using Intergraph Smart 3D in Smart Cloud, you do not have access to this
utility. Please open a service request using Cloud as the product. Request what needs to be
done with this utility.

Create a new site

Defines the server location and name of the new site and site 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 552/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

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\Site 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, OracleUser\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 in Oracle. For
example, if you typea name such as 1ModelSiteDB, Oracle will not create the database.
When you name the site database, the name of the schema database will automatically
populate with _SCHEMA to match the site database.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 553/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Tablespace

We recommend 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.

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.

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 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 .DAT file specified in
the Template file to be used to create the Catalog database and schema field. The

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 554/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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
Hexagon Asset Lifecycle Intelligence.

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.

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.

Create Site Database and Schema Page

Catalog Database and Schema Page

Ready to Load Databases Page

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. Select MSSQL or Oracle.

Site database server

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 555/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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. You can use any string
that represents your physical location. 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. 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. By default, the software leaves this field blank.

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. 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. For more information about installing and

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 556/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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
uses the default SQL Server 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 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 557/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

Identifies the location of the physical database. Unless you specify otherwise, the software
uses the default MS SQL Server 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 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 data 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 558/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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 for SQL, or .DMP for
Oracle, 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 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 MSSQL in the Database type list.

Oracle service (Catalog database)

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 559/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 560/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 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 Hexagon Asset Lifecycle Intelligence.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 561/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

Ready to Load Databases Page

If you are satisfied with the settings that you have defined, click Next to create the new
catalog databases. Otherwise, click Back to change one or more settings. After the Database
Wizard has created the catalog databases, you use New Model Command to create a new
model database. Part of the process includes selecting the catalog database to associate with
the new model.

Next

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 562/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Begins the process for creating the new catalog and schema databases.

Create a new catalog, select name generator server for site, or

select existing site
The Create a new catalog, select name generator server for site, or select existing site
option enables you to do the following:

Change the active site database as an alternative to using Modify Database and
Schema Location. After activation, the site database displays in the Project
Management tree.

Create a new catalog database using the active site database and schema location.

Change the name generator server for the active site database.

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 563/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 564/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Ready to Make Changes Page

If you are satisfied with the settings you have specified, click Next to make the requested
changes. Otherwise, click Back to change one or more of the settings.

Next

Executes the process for making the specified changes.

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 from Backup Page

Ready to Restore Databases Page

Restore a Site Database from Backup Page

This page of the Database Wizard is only available as part of the Restore a site
database from a backup set workflow.

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
displays only if you select Oracle as the database type.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 565/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Local Net Services needs to be added with the Oracle Net Configuration Assistant. See your
Oracle installation documentation for more information.

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 566/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 567/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Upgrade site database and its schema to your currently installed

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

Select Site Database and Schema to Upgrade Page

Ready to Update Databases Page

Select Site Database and Schema to Upgrade Options

This page of the is only available as part of the Upgrade Site to Latest Version
workflow for the site and site schema databases.

Database Type

Specifies the type of database. Select MSSQL or Oracle.

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 MSSQL as the database type.

Oracle Services

Specifies the name of the Oracle net service for the site database connection. After you select
the Oracle service, the Oracle Services box for the site schema defaults to match that of the
site database. This option appears only if you select Oracle as the database type.

Site Database Name

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 568/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Specifies a name for the new site database. After you type a name for the site database, the
Schema Name box 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 MSSQL as the database type.

Oracle Services

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 Services box for
the site database. This option appears only if you select Oracle as the database type.

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.

Cancel

Discards all your settings and returns you to the Home page.

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, SiteUpgrade_<site database name>.log, is generated during the upgrade

process and is delivered locally to the Temp folder.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 569/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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, SiteUpgrade_<site database name>.log, is generated during the upgrade

process and is delivered locally to the Temp folder.

Modify Database and Schema Location

Specifies which site database to connect to when using Project Management or Smart 3D.

You can also use the Create a new catalog, select name generator server for site, or
select existing site option in the Database Wizard. See Change the active site database.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 570/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Specifies the name of the site schema database server. The software reads this value from
the site database, and it 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. The software reads this value from
the site database, and it cannot be edited. This option is only available if you are using
Oracle.

Site schema name

Specifies the name of the site schema database. The software reads this value from the site
database, and it cannot be edited.

Smart 3D Database Tools Wizard

When you delete an Oracle model in Project Management, the software might not delete all of
the associated database objects (user, tablespace, and schema). To delete schema
information after deleting an Oracle model, you must use the Smart 3D Database Tools
Wizard.

1. Navigate to the [Product Folder]:\ProjectMgmt\Tools\bin folder, and then double-click

SP3DOracleDBToolsWizard.exe to open the wizard.

2. On the Introduction page, select Delete Schema and its assoicated tablespaces.

3. Click Next.

4. Select the schemas to delete, and then click Finish.

When processing completes, the wizard displays a message when processing is

complete.

This process might take some time to complete (approximately from 5 to 10 minutes
per database), depending on the quantity of databases to process and performance/load
factors of the server.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 571/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Oracle Role Creation Utility

Enables you 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.

To access the utility, click Start > All Programs > Intergraph Smart 3D > Oracle Role
Creation Utility. 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.

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

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 572/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Closes the utility.

Create Oracle roles

You run this utility after creating a new Oracle model or after restoring an
Oracle model.

1. After you create the Oracle site and catalog databases using standard procedures,
create a new model in Project Management.

2. After you create the new model, click Start > All Programs > Intergraph Smart 3D >
Oracle Role Creation Utility.

3. 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 utility appends the
permission to the existing role.

6. Click Close when the process is complete.

Oracle Role Creation Utility Dialog

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 573/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 574/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 575/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Run Synchronize model with catalog with the Regenerate views option selected on
all of the projects. For more information, see Synchronize Model with Catalog.

Regenerate the reports database for each model database. For more information, see
Regenerate Reports Database.

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 fill in those names as appropriate when you generate the report. For more
information, see Report Workbook, and Schema Name Validator Dialog Box.

Report Workbook
The report workbook has the following worksheets. The worksheets display the details for the
data present in the catalog and site databases.

Worksheet Name Database Type of Data Reported

Index General Displays information about the server,

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 576/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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
sheets and the selected site on site keyword. For
sheets. example
DataBaseInfo is
not supported.

Start Schema Name Validator reads only the PackageName,

values between the Start and End key Truncated Names,
words for the columns defined in the Attributes,
Head row. CustomInterfaces,
and PartClasses
are standard
columns. The utility
does not recognize

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 577/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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
CUSSBPS_5S_LapSup1Sup2Sup3Sup4OV

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 578/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Schema Name Validator Dialog

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 579/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 580/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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:

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 581/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 582/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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 the View Generator utility 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 Edit > Regenerate Reports
Database Command to update the reports database.

Make changes to the catalog without synchronizing with the

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 583/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

3. After regenerating the model views, use Edit > Regenerate Reports Database to
update the reports and reports schema databases with the changes.

Add custom attributes to the model

1. You use the Database > Define Properties > Model command in Project Management
to add custom attributes to the model. For more information, see Define Model
Properties.

2. Use the View Generator to regenerate the model and catalog views with the new
properties.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 584/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Appendix: Getting Started with 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

Run the Conditional No

Duplicate Model
for Workshare
Command

Create Conditional No
Permission
groups

Create Conditional No
Permission
group folders

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 585/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Add user or Conditional No

group to
permission
groups

Modify user or Conditional No

group in
permission
group

Assign Conditional No
permission
group to location

Change Conditional Can execute only for the Catalog

SharedContent database at that Satellite location.
for the Catalog
database

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

reports
database

Add new Conditional No

properties to
object types

Create Location Yes No

objects. See
Create a new
location.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 586/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Run the Yes (for Host) Yes (for Satellite)

Synchronize
Model with
Catalog
Command

Database IFC Conditional Replicated from Host location.

Bulkload to the Conditional Replicated from Host location.

Catalog
database

Run the Yes No

Database >
Integrity
Command

Running the Tools > 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 587/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

or deleted, or to the parent object if a child is being created.

Action Host location Satellite location

View reference Yes Yes

data in the
Catalog task.

Use any of the Conditional Conditional

commands in
any of the Smart
3D tasks
(excluding the
Project
Management
and Catalog
tasks).

Create/modify/d Conditional Conditional

elete objects
under any
system created
in the Systems
and
Specifications
task.

Create/modify/d Conditional Conditional

elete a new
branch in the
hierarchy tree in
the Drawing and
Reports task.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 588/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Create view Conditional Conditional

styles.

Create/modify/d Conditional No
elete catalog.

Create/modify/d Conditional Conditional

elete model
filters/filter
folders.

Transfer Conditional Conditional

selection set
into permission
group of another
location

Create/modify/d Conditional Conditional

elete items
under the
location-specific
branch
(Drawings and
Reports
hierarchy tree),
including
Report,
Orthographic
Drawings,
Isometric
Drawings, and
the output they
generate.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 589/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 the Database > Integrity Command on the Host from the Project
Management task.

b. Run the Database > Clean Database Command on the Host from a Smart 3D
session.

c. Wait for the transactions to complete.

d. Run the Database > Clean Database Command 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 590/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 591/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

modified, it fails. Despite this restriction, GWC replicates all retrieved objects to all sites.
See Retrieve data and Work with permission groups and Global Workshare.

2. Smart 3D model registration with the SPF site must be performed on the GWC Host.
See Register.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 592/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Legal Information
Copyright Notice
Copyright

Copyright © 1999-2024 Hexagon AB and/or its subsidiaries and affiliates.

This computer program, including software, icons, graphic symbols, documentation, file
formats, and audio-visual displays; may be used only as pursuant to applicable software
license agreement; contains confidential and proprietary information of Intergraph Corporation
or a Hexagon Group Company and/or third parties which is protected by patent, trademark,
copyright law, trade secret law, and international treaty, and may not be provided or otherwise
made available without proper authorization from Hexagon AB and/or its subsidiaries and
affiliates.

Portions of this software are owned by Spatial Corp. © 1992-2022. All Rights Reserved.

Portions of the user interface Copyright © 2008-2018 Progress Software Corporation and/or
its subsidiaries or affiliates. All Rights Reserved.

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, Hexagon's Asset Lifecycle Intelligence Division

305 Intergraph Way
Madison, AL 35758

Documentation

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 593/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 Smart Community, SharePoint, box.net, or the Hexagon documentation web
site, any documentation related to work processes, workflows, and best practices that is
provided by Hexagon as guidance for using a software product.

Terms of Use

a. Use of a software product and Documentation is subject to the Software License

Agreement ("SLA") delivered with the software product unless the Licensee has a valid
signed license for this software product with Intergraph Corporation, Hexagon’s Asset
Lifecycle Intelligence Division ("Hexagon"), a Hexagon Group Company. If the Licensee
has a valid signed license for this software product with Hexagon, 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,
Hexagon gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the
software product for Licensee's internal, non-commercial use. The Documentation may
not be printed for resale or redistribution.

b. For use of Documentation or Other Documentation where end user does not receive a
SLA or does not have a valid license agreement with Hexagon, Hexagon grants the
Licensee a non-exclusive license to use the Documentation or Other Documentation for
Licensee’s internal non-commercial use. Hexagon 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 Hexagon by giving written notice to Licensee.

Disclaimer of Warranties

Except for any express warranties as may be stated in the SLA or separate license or
separate terms and conditions, Hexagon 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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 594/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

considered or deemed a modification or amendment of such disclaimer. Hexagon 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. Hexagon 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.

Hexagon 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 HEXAGON 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 HEXAGON HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

UNDER NO CIRCUMSTANCES SHALL HEXAGON'S LIABILITY EXCEED THE AMOUNT

THAT HEXAGON 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 HEXAGON LIMITS ITS LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID
LAW.

Export Controls

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 595/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

To the extent prohibited by United States or other applicable laws, Intergraph Corporation,
Hexagon's Lifecycle Intelligence division ("Hexagon"), and a Hexagon Group Company's
commercial-off-the-shelf software products, customized software, Technical Data, and/or
third-party software, or any derivatives thereof, obtained from Hexagon, its subsidiaries, or
distributors must not be exported or re-exported, directly or indirectly (including via remote
access) under the following circumstances:

a. To Cuba, Iran, North Korea, Syria, or the Crimean, "Donetsk People's Republic",
"Luhansk People's Republic," or Sevastopol regions of Ukraine, or any national of these
countries or territories.

b. To any person or entity listed on any United States government denial list, including, but
not limited to, the United States Department of Commerce Denied Persons, Entities,
and Unverified Lists, the United States Department of Treasury Specially Designated
Nationals List, and the United States Department of State Debarred List. Visit
www.export.gov for more information or follow this link for the screening tool:
https://legacy.export.gov/csl-search <https://legacy.export.gov/csl-search> .

c. To any entity when Customer knows, or has reason to know, the end use of the software
product, customized software, Technical Data and/or third-party software obtained from
Hexagon, its subsidiaries, or distributors is related to the design, development,
production, or use of missiles, chemical, biological, or nuclear weapons, or other un-
safeguarded or sensitive nuclear uses.

d. To any entity when Customer knows, or has reason to know, that an illegal reshipment
will take place.

Any questions regarding export/re-export of relevant Hexagon software product, customized

software, Technical Data, and/or third-party software obtained from Hexagon, its subsidiaries,
or distributors, should be addressed to Hexagon’s Export Compliance Department, 305
Intergraph Way, Madison, Alabama 35758 USA or at [email protected].
Customer shall hold harmless and indemnify Hexagon and a Hexagon Group Company for
any causes of action, claims, costs, expenses and/or damages resulting to Hexagon or a
Hexagon Group Company from a breach by Customer.

Trademarks

Intergraph®, the Intergraph logo®, Intergraph Smart®, SmartPlant®, SmartMarine®,

SmartSketch®, SmartPlant Cloud®, PDS®, FrameWorks®, I-Route, I-Export, Isogen®,

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 596/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

SPOOLGEN, SupportManager®, SupportModeler®, SAPPHIRE®, TANK, PV Elite®,

CADWorx®, CADWorx DraftPro®, GTSTRUDL®, and CAESAR II® are trademarks or
registered trademarks of Intergraph Corporation or its affiliates, parents, subsidiaries.
Hexagon and the Hexagon logo are registered trademarks of Hexagon AB or its subsidiaries.
Microsoft and Windows are registered trademarks of Microsoft Corporation. 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-2022, 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. Other brands and
product names are trademarks of their respective owners.

Anti-Piracy Statement
When you purchase or lease Hexagon’s Asset Lifecycle Intelligence division software,
Hexagon, Intergraph, or its affiliates, parents, subsidiaries retains ownership of the product.
You become the licensee of the product and obtain the right to use the product solely in
accordance with the terms of the Intergraph Corporation, doing business as Hexagon’s Asset
Lifecycle Intelligence division, Software License Agreement and applicable United States
and/or international copyright laws.

You must have a valid license for each working copy of the product. You may also make one
archival copy of the software to protect from inadvertent destruction of the original software,
but you are not permitted to use the archival copy for any other purpose. An upgrade replaces
the original license. Any use of working copies of the product for which there is no valid
Intergraph Corporation, doing business as Hexagon’s Asset Lifecycle Intelligence division,
Software License Agreement constitutes Software Piracy for which there are very severe
penalties. All Hexagon software products are protected by copyright laws and international
treaty.

If you have questions regarding software piracy or the legal use of Hexagon software
products, please call the Legal Department at 256-730-2362 in the U.S.

Updated June 2022

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 597/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Document No. DDGL562C0

Customer Support
For the latest support information for this product, go to the Smart Community
<https://hexagon.com/support-success/asset-lifecycle-intelligence/community> site.

Third Party Software License Terms

Microsoft Open XML SDK for Microsoft Office This notice is provided with respect to Microsoft Open XML SDK for
Microsoft Office, included in Smart 3D. The terms of Intergraph’s EULA
do not apply to Microsoft Open XML SDK for Microsoft Office, which is
licensed under the license which follows.

MICROSOFT SOFTWARE LICENSE TERMS

OPEN XML SDK 2.0 FOR MICROSOFT OFFICE

These license terms are an agreement between Microsoft Corporation

(or based on where you live, one of its affiliates) and you. Please read
them. They apply to the software named above, which includes the
media on which you received it, if any. The terms also apply to any
Microsoft

updates,

supplements,

Internet-based services, and

support services

for this software, unless other terms accompany those items. If so,
those terms apply.

BY USING THE SOFTWARE, YOU ACCEPT THESE TERMS. IF YOU

DO NOT ACCEPT THEM, DO NOT USE THE SOFTWARE.

If you comply with these license terms, you have the rights below.

1. INSTALLATION AND USE RIGHTS. You may

install and use any number of copies of the
software on your devices.

2. ADDITIONAL LICENSING REQUIREMENTS

AND/OR USE RIGHTS.

1. Distributable Software. You are permitted

to distribute the software in programs you
develop if you comply with the terms
below. The software (including the sample
code) is "Distributable Software."

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 598/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

2. Right to Modify Code

Sample Code. You may modify, copy, and

distribute the source and object code form
of code marked as "sample."

1. Third Party Distribution

Third Party Distribution. You may permit

distributors of your programs to copy and
distribute the Distributable Software as part
of those programs.

1. Distribution Requirements. For any

Distributable Software you distribute,
you must

add significant primary functionality to it in

your programs;

require distributors and external end users

to agree to terms that protect it at least as
much as this agreement;

display your valid copyright notice on your

programs; and

indemnify, defend, and hold harmless

Microsoft from any claims, including
attorneys’ fees, related to the distribution or
use of your programs.

1. Distribution Restrictions. You may not

alter any copyright, trademark or patent

notice in the Distributable Software;

use Microsoft’s trademarks in your

programs’ names or in a way that suggests
your programs come from or are endorsed
by Microsoft;

include Distributable Software in malicious,

deceptive or unlawful programs; or

modify or distribute the source code of any

Distributable Software so that any part of it
becomes subject to an Excluded License.
An Excluded License is one that requires,
as a condition of use, modification or
distribution, that

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 599/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

the code be disclosed or distributed in

source code form; or

others have the right to modify it.

3. Scope of License. The software is licensed, not

sold. This agreement only gives you some rights
to use the software. Microsoft reserves all other
rights. Unless applicable law gives you more
rights despite this limitation, you may use the
software only as expressly permitted in this
agreement. In doing so, you must comply with any
technical limitations in the software that only allow
you to use it in certain ways. You may not

work around any technical limitations in the

software;

reverse engineer, decompile or

disassemble the software, except and only
to the extent that applicable law expressly
permits, despite this limitation;

make more copies of the software than

specified in this agreement or allowed by
applicable law, despite this limitation;

publish the software for others to copy;

rent, lease or lend the software;

transfer the software or this agreement to

any third party; or

use the software for commercial software

hosting services.

4. DOCUMENTATION. Any person that has valid

access to your computer or internal network may
copy and use the documentation for your internal,
reference purposes.

5. TRANSFER TO ANOTHER DEVICE. You may

uninstall the software and install it on another
device for your use. You may not do so to share
this license between devices.

6. Export Restrictions. The software is subject to

United States export laws and regulations. You
must comply with all domestic and international
export laws and regulations that apply to the

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 600/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

software. These laws include restrictions on

destinations, end users and end use. For
additional information, see
www.microsoft.com/exporting.

7. SUPPORT SERVICES. Because this software is

"as is," we may not provide support services for it.

8. Entire Agreement. This agreement, and the

terms for supplements, updates, Internet-based
services and support services that you use, are
the entire agreement for the software and support
services.

9. Applicable Law.

1. United States. If you acquired the software

in the United States, Washington state law
governs the interpretation of this
agreement and applies to claims for
breach of it, regardless of conflict of laws
principles. The laws of the state where you
live govern all other claims, including
claims under state consumer protection
laws, unfair competition laws, and in tort.

2. Outside the United States. If you acquired

the software in any other country, the laws
of that country apply.

10. Legal Effect. This agreement describes certain

legal rights. You may have other rights under the
laws of your country. You may also have rights
with respect to the party from whom you acquired
the software. This agreement does not change
your rights under the laws of your country if the
laws of your country do not permit it to do so.

11. Disclaimer of Warranty. The software is

licensed "as-is." You bear the risk of using it.
Microsoft gives no express warranties,
guarantees or conditions. You may have
additional consumer rights under your local
laws which this agreement cannot change. To
the extent permitted under your local laws,
Microsoft excludes the implied warranties of
merchantability, fitness for a particular
purpose and non-infringement.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 601/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

12. Limitation on and Exclusion of Remedies and

Damages. You can recover from Microsoft and
its suppliers only direct damages up to U.S.
$5.00. You cannot recover any other damages,
including consequential, lost profits, special,
indirect or incidental damages. This limitation
applies to

anything related to the software, services,

content (including code) on third party
Internet sites, or third party programs; and

claims for breach of contract, breach of

warranty, guarantee or condition, strict
liability, negligence, or other tort to the
extent permitted by applicable law.

It also applies even if Microsoft knew or should have known about the
possibility of the damages. The above limitation or exclusion may not
apply to you because your country may not allow the exclusion or
limitation of incidental, consequential or other damages.

Please note: As this software is distributed in Quebec, Canada,

some of the clauses in this agreement are provided below in
French.

Remarque : Ce logiciel étant distribué au Québec, Canada,

certaines des clauses dans ce contrat sont fournies ci-dessous en
français.

EXONÉRATION DE GARANTIE. Le logiciel visé par une licence est

offert « tel quel ». Toute utilisation de ce logiciel est à votre seule risque
et péril. Microsoft n’accorde aucune autre garantie expresse. Vous
pouvez bénéficier de droits additionnels en vertu du droit local sur la
protection des consommateurs, que ce contrat ne peut modifier. La ou
elles sont permises par le droit locale, les garanties implicites de qualité
marchande, d’adéquation à un usage particulier et d’absence de
contrefaçon sont exclues.

LIMITATION DES DOMMAGES-INTÉRÊTS ET EXCLUSION DE

RESPONSABILITÉ POUR LES DOMMAGES. Vous pouvez obtenir de
Microsoft et de ses fournisseurs une indemnisation en cas de
dommages directs uniquement à hauteur de 5,00 $ US. Vous ne
pouvez prétendre à aucune indemnisation pour les autres dommages,
y compris les dommages spéciaux, indirects ou accessoires et pertes
de bénéfices.

Cette limitation concerne :

tout ce qui est relié au logiciel, aux services ou au

contenu (y compris le code) figurant sur des sites
Internet tiers ou dans des programmes tiers ; et

les réclamations au titre de violation de contrat ou

de garantie, ou au titre de responsabilité stricte,

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 602/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

de négligence ou d’une autre faute dans la limite

autorisée par la loi en vigueur.

Elle s’applique également, même si Microsoft connaissait ou devrait

connaître l’éventualité d’un tel dommage. Si votre pays n’autorise pas
l’exclusion ou la limitation de responsabilité pour les dommages
indirects, accessoires ou de quelque nature que ce soit, il se peut que
la limitation ou l’exclusion ci-dessus ne s’appliquera pas à votre égard.

EFFET JURIDIQUE. Le présent contrat décrit certains droits juridiques.

Vous pourriez avoir d’autres droits prévus par les lois de votre pays. Le
présent contrat ne modifie pas les droits que vous confèrent les lois de
votre pays si celles-ci ne le permettent pas.

The OpenGL Extension Wrangler Library The OpenGL Extension Wrangler Library
Copyright (C) 2002-2007, Milan Ikits <milan ikits[]ieee org>
Copyright (C) 2002-2007, Marcelo E. Magallon <mmagallo[]debian org>
Copyright (C) 2002, Lev Povalahev
All rights reserved.

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions are
met:

Redistributions of source code must retain the

above copyright notice, this list of conditions and
the following disclaimer.

Redistributions in binary form must reproduce the

above copyright notice, this list of conditions and
the following disclaimer in the documentation
and/or other materials provided with the
distribution.

The name of the author may be used to endorse

or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS

AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

Mesa 3-D graphics library

Version: 7.0

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 603/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

Copyright (C) 1999-2007 Brian Paul All Rights Reserved.

Permission is hereby granted, free of charge, to any person obtaining a

copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to
whom the Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF

ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Copyright (c) 2007 The Khronos Group Inc.

Permission is hereby granted, free of charge, to any person obtaining a

copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Materials, and to permit persons to
whom the Materials are furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Materials.

THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY

OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE
MATERIALS OR THE USE OR OTHER DEALINGS IN THE
MATERIALS.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 604/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 605/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 606/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 607/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

component
Physical part that a feature generates.

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 that can be 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 608/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

damage records
Data relating to the damage and repair of structure or components that occurred during or
after construction of a model.

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 609/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 610/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

design service
Any general system services related to the design function.

design standard
Feature or object used in model 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 611/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

element
Primitive geometric shape such as a line, circle, or arc.

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.

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 extra
material when it is required due to uncontrolled variance in the manufacturing and
construction process.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 612/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 613/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

host location
The first location created for a Site. This host location is defined when the Site database is
initially created.

host server
The database server on which the Site database was initially created. 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 model. Contains information relating to a model
created during its initial (concept) design period.

initial structural plan

Principal structural plan for the model; 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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 614/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 model design.

life cycle database

Information developed to assist in the maintenance and modernization of delivered models.

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.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 615/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 initially created. Additional Locations can be created in
the Project Management task. Each Location is a Site-level object, thus other Models within
the same Site collection can use the Locations when the Models 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 model.

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 OLE-
aware programming applications.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 616/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

methods
Objects in the database that describe the manufacturing methods to the component parts of a
model.

model
A graphical representation showing the construction of one or more systems in a plant or ship.

native object
A full Intergraph Smart 3D object created in the Intergraph Smart 3D application. The fit for
purpose is for design.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 617/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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 model, the software creates an
occurrence of that object in the model 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 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.

orthogonal
The characteristic of an element consisting completely of elements positioned at 90-degree
angles. A square is an orthogonal element.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 618/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 619/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 620/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 621/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

SIO object
A subset of a full Intergraph Smart 3D native object. The fit for purpose is for operations and
maintenance. This object can be generated from a Intergraph Smart 3D native object or from
PDS or PDMS data.

site
The top level in the Project Management hierarchy. A Site configuration may contain several
Catalogs, each shared by multiple Models.

site administrator
Person responsible for managing the standards and general parameters for a given model
site within a Site database.

site setup
Functionality associated with establishing a new model 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 model.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 622/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 623/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 624/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

welding
Weld requirements for joining materials. Welding length analysis is the calculation of required
weld dimensions; also called leg length analysis.

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.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 625/626
2/11/25, 9:44 AM Hexagon Documentation Site Export

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.

Copyright
Copyright© Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.

https://docs.hexagonppm.com/internal/api/webapp/print/eeeadf6c-9392-423b-9f51-f4409b9b3ec3 626/626