Microsoft SQL Server With Plant 3D
Microsoft SQL Server With Plant 3D
This whitepaper outlines the configuration of Microsoft SQL Server Express, Standard or
Enterprise for use with Autodesk AutoCAD Plant 3D and AutoCAD P&ID projects.
1
Contents
Overview of Databases................................................................................................................................................ 3
Database Structure ................................................................................................................................................. 3
Database Engines .................................................................................................................................................. 4
SQLite ............................................................................................................................................................. 4
Microsoft SQL Server ...................................................................................................................................... 5
Installing Microsoft SQL Server ................................................................................................................................. 6
Configure a New Instance of SQL Server ............................................................................................................... 6
Configuring Microsoft SQL Server ........................................................................................................................... 10
Configure SQL Server for Remote Connections ................................................................................................... 10
Configure SQL Server Security Rights ................................................................................................................. 11
SQL Security Mode ....................................................................................................................................... 12
SQL Security Logins ...................................................................................................................................... 12
Recovery Models .................................................................................................................................................. 14
Project Backup ........................................................................................................................................................... 14
Backing up SQL Databases .................................................................................................................................. 14
Backing up Project Files and Folders ................................................................................................................... 17
Restoring SQL Databases .................................................................................................................................... 17
Restoring Project Files and Folders ...................................................................................................................... 19
Project Administration .............................................................................................................................................. 20
Converting an Existing SQLite Plant 3D Project to SQL Server ........................................................................... 20
Moving and Copying SQL Projects ....................................................................................................................... 23
Moving a SQL Project Database ................................................................................................................... 23
Copying a SQL Project Database .................................................................................................................. 26
Project Maintenance Tasks ....................................................................................................................................... 30
Project Audit ......................................................................................................................................................... 30
Project Drawing Audit ........................................................................................................................................... 30
Purging Local Data Cache .................................................................................................................................... 31
Links and Learning Resources ................................................................................................................................. 32
Document Revisions ................................................................................................................................................. 32
2
Overview of Databases
AutoCAD Plant 3D and AutoCAD P&ID use a file-based database (SQLite) by default. If a server-based
database is desired for improved multi-user performance and reliability Microsoft SQL Server Express
or Microsoft SQL Server Standard/Enterprise can be implemented. If the project is intended to be
hosted on Autodesk Vault, Microsoft SQL Server must be used. Any references made to AutoCAD
Plant 3D in this document also applies to AutoCAD P&ID.
Database Structure
Project drawings and databases are used to store all the information for the project. This information
includes line number tags, equipment tags, pipe specifications, etc. Since the information is stored in
both the AutoCAD drawings and in the database, this allows you to copy drawings across projects and
retain the data.
In a SQLite database project, the individual DCF files stored in the project folder contain the database
information.
Once a project is migrated to MS SQL Server the project files remain at the same folder location and the
databases are stored and accessed through SQL Server. The five databases described above will reside
on the SQL Server for each individual Plant 3D project. Expect to see multiple SQL databases with the
prefix name you provide during the new project setup or SQLite project migration to SQL.
As you work in a project the software is periodically querying the database tables reading and writing
information as needed. For example, if a user adds or modifies a valve tag, that information is updated
in the project database (or local data cache) so no one else can use the tag that was just assigned. When
the drawing is saved, the tag information is updated inside the drawing (DWG) itself.
3
Database Engines
SQLite
SQLite is a self-contained, server less, zeroconfiguration, transactional SQL database engine which
means there is no separate database server required. The database engine is embedded and installed
with AutoCAD Plant 3D and AutoCAD P&ID.
SQLite uses a file-based system, so each database is a single file stored on disk. The SQLite database
engine uses a read many, write once record locking scheme. While many users can be reading from the
database at any given time the entire database must be locked before a record can be written to a
table row. SQlite is intended for a single user (standalone) environment. For more information about
SQLite record locking, please refer to File Locking and Concurrency in SQLite in the Links and Learning
Resources section of this document.
File Server
.DCF Files
Figure 1. SQLite
This graphic shows each workstation, running its own local SQLite
database engine and accessing the DCF (database) files for the project
stored on a file server.
4
Microsoft SQL Server
Microsoft SQL Server is a client/server architecture which means the database tranactions are passed
from the client to the server, processed, and then sent back.
SQL Server uses a granular approch to record locking; it only locks a single database row if it needs to be
updated instead of the entire database. SQL Server is intended for a typical multi-user, corporate
network environment.
SQL Server
Database
5
Installing Microsoft SQL Server
The process of configuring Microsoft SQL Server (MS SQL) begins with the installation. Before installing
MS SQL, please check the hardware and software requirements for SQL Server from Microsoft.
To setup a new project or migrate an existing SQLite project to Microsoft SQL Server one of the following
versions is required:
If you do not have a license for Microsoft SQL Server available to use, Microsoft SQL Server Express is
available for free from Microsoft’s website (see Links and Resources section for the website link.)
The recommended download is SQL Express with Tools which will include both SQL Express Server and
SQL Server Management Studio.
An existing SQL instance can be used for projects, but it is recommended that AutoCAD Plant 3D has its
own dedicated instance to use. This simplifies the administration tasks by keeping the databases for
Plant separate from any existing databases. If the project will be used with Autodesk Vault, please refer
to Configure SQL Server for Vault Projects located in the Links and Learning Resources section of this
document.
To configure a new SQL instance on a server run the setup for Microsoft SQL Server and follow the steps
on the next page.
6
1. Download MS SQL Server Express and launch the installation
3. Click “Installation” and select the first choice, “New SQL Server stand-alone installation or add
4. The Setup Support Rules check will run along with the Product Updates
6. In the Installation Type section, select “Perform a new installation of SQL Server 2012” and click
Next
7. Check boxes for license terms and data usage and click Next
8. Set options for instance features and click Next (default options are recommended.) In the
“Named instance” field, enter a descriptive name for the new SQL Server instance (e.g. Plant3D)
7
Note: You can modify the instance root directory if needed. This is the location where the SQL
databases will be stored on the server. By default, it will be under the directory where SQL Server
is installed.
9. In the Server Accounts options set the startup for both services to “Automatic” and click Next
Note: The SQL Server Browser service is required by workstations on the local area network to
locate the SQL Server.
8
10. In Database Engine Configuration you must specify whether Windows authentication mode or
Mixed Mode will be used. If using Mixed Mode, a password for the System Administrator (sa)
account will need to be entered. With either mode, one or more SQL Server Administrator
accounts will need to be specified. If you will be the primary admin click the “Add Current
User” button to automatically add your Windows user account to the list. Additional admins
can be added later. For more information about authentication modes, please refer to the
Configure SQL Server Security Rights section of this document or click the Help button which
will describe the options
that are available.
12. The Installation Configuration rules will process, and the installation process will begin
13. When the installation is complete you will see the image depicted in Figure 8. The new instance
is now ready to use for hosting AutoCAD Plant 3D or AutoCAD P&ID projects.
9
Figure 8. SQL Server 2013 Installation Complete
2. Microsoft SQL Server <version> → Configuration Tools → SQL Server Configuration Manager
10
Figure 9. SQL Server Configuration Manager
3. Expand “SQL Server Network Configuration” and select the protocols for your new instance
SQL Server supports two authentication modes, Windows authentication mode and mixed mode:
• Windows Authentication is the default and is often referred to as integrated security because this SQL
Server security model is tightly integrated with Windows. Specific Windows user and group accounts are
trusted to log in to SQL Server. Windows users who have already been authenticated do not have to present
additional credentials.
• Mixed Mode supports authentication both by Windows and by SQL Server. User name and password pairs
are maintained within SQL Server.
When using Windows Authentication users will not be required to enter any credentials when they open a project;
their Windows login credentials will be used. When using SQL Server Authentication users will be required to enter
their SQL user name and password when opening the project.
For more in-depth information about SQL authentication modes, please refer to SQL Server Security and Protection
– Choose an Authentication Mode in the Links and Learning Resources of this document.
11
SQL Security Mode
The SQL security mode for a project can be modified at any time by editing each of the DCF files located inside the
project folder (ProcessPower.dcf, Piping.dcf, Iso.dcf, Ortho.dcf, and Misc.dcf.) These files can be edited with
Windows Notepad or XML editor.
In the following example of a DCF file “Integrated Security” is set to false, which means the project is using Mixed
Mode security on and users will be required to enter a SQL username and password to open the project:
If Windows Authentication mode is desired, open each of the DCF files in the project folder with a text editor such
as Windows Notepad and change the value for Integrated Security to true.
SQL Logins
Logins for SQL Server will need to be configured before anyone can use Plant 3D with projects. New login accounts can be
under Logins as shown in Figure 11. If you receive an error message (connection failed) when creating a new Plant 3D pro
make sure a new login has been created and proper server roles have been assigned as described in the next section.
12
When using Windows Authentication mode, domain users, user groups, and local user computer accounts can be added a
Authentication new logins can be created by specifying a login name along with a password.
Sever Roles
The Server Roles of MS SQL Server control access to server-wide security privileges on the SQL server;
actions such as creating new databases, erasing existing databases, etc. The Server Role can be assigned in
the properties for each login:
13
Project Administrator Accounts
Any account used to create new projects will need to have the “sysadmin” sever role assigned to it. The
system admin role can perform any activity in the database engine.
Any account that needs access to a project but not the ability to create new projects will only need “public”
server role assigned to it. All SQL server users, groups, and roles belong to the public role by default.
For more information about SQL logins, users and roles, please visit the Managing Logins, Users, and
Schemas How-to Topics link in the Links and Learning Resources section of this document.
Recovery Models
SQL Recovery Models are designed to control transaction log maintenance. A recovery model is a database
property that controls how transactions are logged, whether the transaction log requires (and allows)
backing up, and what kinds of restore operations are available. Three recovery models exist: simple, full,
and bulk-logged. SQL databases for AutoCAD Plant 3D and AutoCAD P&ID use the simple recovery model.
This is the default, and recommended setting for all SQL project databases to avoid excessive transactional
logs taking up unnecessary disk space on the SQL Server. For more information please refer to the
Recovery Models (SQL Server) link in the Links and Learning Resources section of this document.
Project Backup
Obtaining a complete backup of a Plant 3D SQL Server project involves two parts. Backing up the project
files and folders and the SQL databases stored on the SQL Server. To obtain a consistent backup both
must be backed up at the same time. If a project needs to be archived the backup process can be used to
accomplish this. Nightly backups are recommended to avoid any major loss of work. Please check with
your local IT staff if needed to coordinate backups as needed.
1. Begin by launching SQL Server Management Studio from the Start Menu
14
Figure 13. Connect to Server
3. Enter the SQL Server computer name and the instance in the following format
(SERVERNAME\INSTANCE) or click the drop-down button to browse your network for available SQL
Servers
4. Select the first Plant 3D project database in the list, right-click, and choose Back Up…
5. In the Back Up Database window select the options for the location of where the backup files will
be written
15
Figure 15. Back Up Database
16
Backing up Project Files and Folders
Before running a back on the project files, be sure all users have save their drawings and exit Plant 3D. This
will ensure all file and database locks have been closed out.
If project files and/or drawings are set to a path located outside of the project folder be sure to include
these as well. Check the paths in Project Setup to verify the location.
Examples of project content which may be stored outside of the project folder:
• 3D Drawings
• P&ID Drawings
• Isometric Drawings
• Orthographic Drawings
• Equipment Templates
• Related Files
• Drawing Templates (.DWTs)
• Shared Content (catalogs and spec sheets – see below)
The PLANTCONTENTFOLDER command can be used in Plant 3D to obtain the current location of the
shared content for the project. For more information about the shared content folder, please refer to
AutoCAD Plant 3D Shared Content Folder in the Links and Learning Resources section of this document.
1. Launch SQL Server Management Studio 2012 from the Start Menu
2. Right click on the existing project database name and select Rename (Iso database will always be
on top so you can begin there)
17
Figure 16. Rename Database
18
Figure 17. Restore Database Task
In the Restore Database window, choose “Device” and click the browse button
6.
Figure 18. Restore Database
7. Click the Add button, browse to the location of the original SQL backup file, select it and click OK
8. Click OK again and the Destination and Restore Plan will update with the proper information from
the backup
9. Click OK to begin the restoration process
10. Repeat the process for the additional project databases (Piping, Iso, Ortho, ProcessPower, and
Misc)
19
Project Administration
Converting an Existing SQLite Plant 3D Project to SQL Server
Conversion of an existing AutoCAD Plant 3D project using SQLite databases to MS SQL Server involves
using a tool titled Project Maintenance Utility which is installed with AutoCAD Plant 3D and AutoCAD P&ID.
Once a project has been migrated from SQLite to SQL Server it can no longer be opened as a SQLite
project.
Once a project has been converted to SQL Server a new project can still be created from it using Project
Setup Wizard and selecting “Copy settings from existing project.” The new project files and folders will be
created along with new SQL databases on the SQL Server.
3. Run PnPProjectMaintenance.exe
20
Figure 19. Project Maintenance Utility
21
Figure 20. Project Maintenance Utility – Convert a Project to SQL
6. Browse to the location of your project. Select the Project.xml file for the project and click Open
7. In the Server field type the name of the SQL Server instance in the following format:
SQLSERVERNAME\SQLINSTANCE
SQLSERVERNAME is the computer name of the SQL Server and SQLINSTANCE is the name of
the SQL instance that is running on the server. Note: you may need to use the fully qualified
domain name of the server depending on your network configuration (i.e.
myserver.domain.com\PLANT3D)
8. Click the Test Connection button to confirm the connection to the server
Note: You will need to enter credentials for a user account that has “sysadmin” server role
permissions.
10. In the database name prefix field enter a prefix to be use (for example the project name).
This value will be used to create the database names (i.e. Project001_PnId,
Project001_Piping, Project001_Iso)
SQL Server Authentication – Enter a SQL Server administrator login credentials. Users will be
required to enter their credentials when the open the project.
Note: Please refer to the Configure SQL Server Security Rights section of this document for
more information on authentication modes.
12. Click the Convert button and the conversion process will begin
The existing SQLite DCF file databases will be converted to the SQL Server. When the conversion process is
complete the DCF files in the project folder will be text files (XML configurations) pointing the project to
SQL Server databases.
Before attempting to move or copy SQL project databases to another server or SQL instance be sure to
backup your existing project. This includes the project files and folders in addition to the SQL databases
using Microsoft SQL Server Management Studio.
2. Run PnPProjectMaintenance.exe
23
Figure 21. Project Maintenance Utility
5. Browse to the location of your project. Select the Project.xml file for the project and click Open
24
6. In the Server field type the name of the destination SQL Server instance in the following format:
SQLSERVERNAME\SQLINSTANCE
SQLSERVERNAME is the computer name of the SQL Server and SQLINSTANCE is the name of
the SQL instance that is running on the server. Note: you may need to use the fully qualified
domain name of the server depending on your network configuration (i.e.
myserver.domain.com\PLANT3D)
7. In the Database Prefix field, enter the original prefix used when the project was created
8. Click the Test Connection button to confirm the connection to the server
Note: You will need to enter credentials for a user account that has “sysadmin” sever role
permissions
Windows Authentication – Users will not be required to enter any credentials when the open
the project. Windows credentials will be used
SQL Server Authentication – Enter a SQL Server administrator login credentials. Users will be
required to enter their credentials when the open the project.
Note: Please refer to the Configure SQL Server Security Rights section of this document for
more information on authentication modes.
11. Click the Move button and the relocation process will begin
12. In Windows Notepad or a text editor application, open ProcessPower.dcf in the project folder.
13. Enter the new database server and SQL instance name in the “Data Source” value. This value is
highlighted in the DCF example as “SERVERNAME\INSTANCENAME”
14. Enter the database name in the “Initial Catalog” value. This value is highlighted in the DCF
example as “PREFIXNAME_ProcessPower”
15. Repeat the same edits for the additional DCF files (Piping.dcf, Iso.dcf, Ortho.dcf, and Misc.dcf).
25
Example ProcessPower.dcf:
Copying a SQL Project Database
Please note this process will only copy the SQL databases from one MS SQL Server to another. The
project’s configuration files must still be changed manually to re-direct the project to the proper
server (if the project has been copied to a different SQL server/instance.)
2. Run PnPProjectMaintenance.exe
26
Figure 23. Project Maintenance Utility
8. Browse to the location of your project, select the Project.xml file for the project, and click
Open
27
Figure 24. Project Maintenance Utility - Move a Project Database
7. In the Server field type the name of the SQL Server instance in the following format:
SQLSERVERNAME\SQLINSTANCE
SQLSERVERNAME is the computer name of the SQL Server and SQLINSTANCE is the name of
the SQL instance that is running on the server. Note: you may need to use the fully qualified
domain name of the server depending on your network configuration (i.e.
myserver.domain.com\PLANT3D)
16. In the Database Prefix field, enter the original prefix used when the project was created
17. Click the Test Connection button to confirm the connection to the server
Note: You will need to enter credentials for a user account that has “sysadmin” sever role
permissions
Windows Authentication – Users will not be required to enter any credentials when the open
the project. Windows credentials will be used
28
SQL Server Authentication – Enter a SQL Server administrator login credentials. Users will be
required to enter their credentials when the open the project.
Note: Please refer to the Configure SQL Server Security Rights section of this document for
more information on authentication modes.
20. Click the Copy button and the process will begin
21. In Windows Notepad or a text editor application, open ProcessPower.dcf in the project folder.
22. Enter the new database server and SQL instance name in the “Data Source” value. This value is
highlighted in the DCF example as “SERVERNAME\INSTANCENAME”
23. Enter the database name in the “Initial Catalog” value. This value is highlighted in the DCF
example as “PREFIXNAME_ProcessPower”
24. Repeat the same edits for the additional DCF files (Piping.dcf, Iso.dcf, Ortho.dcf, and Misc.dcf).
Example ProcessPower.dcf:
29
Project Maintenance Tasks
In the event of a crash, there are several tasks which can be performed on a project in order to check
consistency of the databases and the project drawings.
Project Audit
Project audit checks the project database for any invalid records or errors. It also removes unused line
number tags from the project’s tag registry. The command to run a project audit is AUDITPROJECT.
Once the project audit completes you can scroll up the command line history to see the results. You may
need to increase the command line history or enable the command log file before running the audit.
To create a log file of the audit, use the LOGFILEMODE command and set it to 1. You can change the log
file path from the AutoCAD options for Plant 3D or use the LOGFILEPATH command to set the location
where the log file will be generated. LOGFILEMODE can be set back to 0 once the audit is complete to
avoid additional log files from being generated.
Note: Do not use the regular AutoCAD Recover command on an AutoCAD Plant 3D model drawing or
AutoCAD P&ID drawing. This command is specialized to plain AutoCAD
30
27
Purging the PLDC (persistent local data cache) will release disk space that has been consumed by
completed projects. After PLDC has been purged, opening the project and drawings may take longer than
usual as the cache will have to be re-built. Usually this will be the first time the project is used after PLDC
purge. Purging the PLDC will not delete, remove or corrupt your projects and the cache will rebuild again
as soon as the project is opened.
• Close all AutoCAD based products including AutoCAD Plant 3D and/or AutoCAD P&ID
• Browse to the installation folder for AutoCAD Plant 3D or AutoCAD P&ID:
• Double-click on PnPLocalDataCachePurger.exe
• Click the ‘Purge’ button
31
Links and Learning Resources
The following table contains the links to resources referred to in this document.
Title Hyperlink
Server
How-to Topics
29
Autodesk [and other products] are registered trademarks or trademarks of Autodesk, Inc., and/or its subsidiaries and/or affiliates in the USA and/or other countries. All other brand names, product names,
or trademarks belong to their respective holders. Autodesk reserves the right to alter product and services
offerings, and specifications and pricing at any time without notice, and is not responsible for typogdocument. © 2013 Autodesk, Inc. All rights reserved.
raphical or graphical errors that may appear in this
Document Revisions
V1.0 Final Draft (2/12/2014)
V2.0 Corrections to typos (6/24/2015)
V 3.0 Full revision of the whitepaper (11/26/2018)
32