Autodesk AutoCAD Plant 3D - CAD System Manager Manual
Autodesk AutoCAD Plant 3D - CAD System Manager Manual
Autodesk AutoCAD Plant 3D - CAD System Manager Manual
Microsoft® Windows® 10
Operating
Microsoft Windows 8.1 with Update KB2919355
System
Microsoft Windows 7 SP1
Plant 3D and P&ID 2017 will require the installation of Vault Client to enable Vault Server License
access. Refer to the deployments section for more details.
Network Requirements
For the purposes of a replicated environment it is recommended that the network latency does not
exceed 100ms. If speeds are slower than this discuss the options to manage this with Autodesk.
Plant 3D and P&ID 2017 SQL Server database requirements support SQL Server 2012 (2014 and 2016
are not supported at this time).
Both SQL Server and SQL Server Express (2008 R2 or later) are supported. If you do not pre-install
SQL Server, SQL Server Express is installed when you install Autodesk Vault Server.
Configure SQL Server for Vault Projects ; FAQ: Using a Server-Based Database
Vault Requirements
The Vault version must be a newer version than the products accessing Vault. For example AutoCAD
2016 can access a Vault 2017. But an AutoCAD 2017 should never try to access a Vault 2016.
Note: Refer to the Autodesk Vault Administrator Manual for more information.
About Plant Projects in Autodesk Vault
When you first open a plant project from the Vault using the Project Manager, a local workspace is
created and files are copied from the Vault. Additional users create a separate local workspace.
The project database in the local workspace is updated ( ) as you save files in the working folder.
The project master database is updated when you check in files to the Vault.
If you create a plant project in the Vault, you can benefit from the following Vault-enabled features:
• Local workspace - You no longer keep your working files on a network share. You modify
Vault projects files in your local workspace folder and synchronize them to the Vault.
• Check-in and check-out document management - The Project Manager is fully integrated
with Autodesk Vault. The Project Manager prompts you to check out files as you work.
• Automatic file versions - You can view or restore the previous revision of a file.
• Master project database - Vault projects use SQL Server for the project database. The master
database is always synchronized to match the files that are checked in to the Vault.
• User authentication and access control - Administrators can manage access to a Vault project
using the Autodesk Data Management Console. You can easily set up user accounts and
assign roles for each Vault.
File versions are controlled automatically in Vault (no more lost work).
All files and folders are stored locally when being accessed (increased speed).
Multiple Offices and teams can work seamlessly on the same project.
Do's and Don'ts of Plant-Vault projects
Plant-Vault projects are a great solution to some typical design office issues. To ensure that the
robustness of the project and to avoid project corruptions or data loss the following rules should
always be adhered too.
As the Plant-Vault project administrator you will most likely be the user’s first point of contact when
they are not sure of the correct process to follow. It is always best practice to adopt a policy of “If in
doubt ask”.
DO’s
Manage all Project files from within the Plant Project Manager.
Check all files in when finished being edited to ensure that all files are backed up and replicated
properly.
Open files read only if you don’t intend to edit them now
Ensure that the paths recorded for files in the Vault database and the Plant Database are the same.
Refer to the Autodesk Knowledge Network for the latest information and Help files.
DO NOT’s
Do not use Autodesk Vault Client to work with plant projects. Except for certain administrative tasks,
use the Project Manager to manage plant projects and files in Vault.
Do not move or delete files in the local workspace (this disconnects the Vault and Plant database
paths).
Vault Replication
Vault projects can be replicated between multiple Vaults. The master project database SQL Server
must be accessible from all workstations.
Plant projects are created in a Vault using the Project Manager. Plant projects are then created in the root folder of
the selected Vault and assigned a PlantProject category. You must have Administrator rights to create
the first Plant project in Vault this facilitates the initial automatic Vault setup. Additional projects in the same Vault
only require Document Manager (Level 2) to be created. No other special preparation is required to create a plant
project in the Vault.
Above plus Data Manager (Level 2), Document Editor (Level 1) - create projects and delete files and
folders
Above plus Content Center Administrator - project setup
Autodesk Vault User role setup for Plant projects
Commands Autodesk Vault Roles
Browse files (read-only) and refresh from the Vault Document Consumer
A Vault project requires Microsoft SQL Server to host the project master database.
The project master database is like a non-Vault project database that uses SQL Server. One
important difference is that a Vault project master database is updated only when a file is checked
in to the Vault. A non-Vault project updates the project database as you work.
Note: A file-based (SQLite) database is maintained as you work with a Vault project in the local
workspace. The master project database is updated from the working folder when you synchronize
up (or check-in files) to Vault.
If you do specify the same server and instance that the Vault uses, the master project database is
not backed-up with Autodesk Vault.
Autodesk Vault roles are created using the Autodesk Data Management Server Console. You can use
Microsoft SQL Server Management Studio to set up project master database server logins and roles.
The user creating the master project database must have Create Any Database service permission.
After the database has been created, the database public role is granted Control permission.
Note: Similar to the DCF files for a SQL Server project. With Vault, the DCF files are a local, SQLite
database copy of the master SQL databases. The DLK files are XML format files that point Plant 3D to
the MS SQL Server (server name, connection info / strings, etc.)
FAQ: Using a Server-Based Database
The default database is file-based (SQLite). You can, instead, choose to use a server-based database
for improved multi-user performance and reliability. If you choose this option during project setup,
keep in mind the following guidelines:
• Installing - Before setting up the project, you must install Microsoft SQL Server Express or
Microsoft SQL Server on the machine that will host the project database. To download and
install SQL Server Express, refer to the Microsoft web page here:
http://www.microsoft.com/express/Database.
• Verifying - Make sure that the database is set up and running reliably. During project setup,
you can also test the connection.
• Configuring the server to allow remote connections - By default, SQL Server 2008 Express is
not setup to allow remote connections. To enable remote connections, use the SQL Server
Configuration Manager. You perform this procedure on the server machine only.
"Microsoft SQL Server Configuration for Autodesk AutoCAD® Plant 3D and AutoCAD® P&ID" - Link
This document is the extensive guide for the configuration of Microsoft SQL Server 2012 (Express,
Standard, or Enterprise) for use with Autodesk AutoCAD Plant 3D and AutoCAD P&ID projects
irrespective of using Autodesk Vault Plant project or normal Plant project.
This document covers starting from installation of MS SQL server, configuration for remote
connection, security rights including project administration and maintenance tasks.
Note: System administrators should test these settings in a secure environment before applying to
production teams as results may vary.
General:
Typically Plant is fetching each database row in the drawing and being synchronized from the server.
Significant performance degradation may be reported during Plant Vault check-in operations when
accessing master SQL Server database via a high latency network. Performance degradation is
proportional to the number of records in the project database. To minimise the impact of this
behaviour the following AutoCAD system variables may be modified for Plant.
PLANTVAULTLOCALCACHE
Enables local persistent cache for Plant master database associated with Plant Vault project. Local
persistent cache is built on “as-needed” basis and can avoid costly roundtrips to the server.
Note that Plant is not building the whole cache at once. The performance should improve while
cache is populated.
PLANTVAULTDROPLOCALCACHE
Clears the master project database local cache
• If enabled, Vault master database local persistent cache will be forcefully dropped each time
the project is opened. At the beginning of the session user will see slowness that should
become less while cache is building.
• The Default setting is off (0) to improve start-up performance.
o 0 = Do not clear the local cache for the master project database
o 1 = Clears the local cache for the master project database when the project opens
Notes
PLANTVAULTDR
OPLOCALCACHE
PLANTVAULTLO
CALCACHE
It is required if Vault 2017 is being used that Vault Client be installed on all users workstations to
allow the Plant to acquire the appropriate Vault license.
When a user first logs into Vault from within Plant, the user may be asked to specify the Vault
License server details (this should only occur once).
Note: if the Vault add-in fails to acquire a license and locks Plant, first check the correct ‘locale’
settings are correct. Refer to this article - Error: Vault 2017 Crash on start up
Project Login:
When working with Vault projects, AutoCAD Plant 3D prompts you to log in. This login is to the Vault
system. Autodesk Vault log-ins are maintained for the duration of the drawing session unless you
explicitly log out. Windows Authentication can be utilised to simplify the login process. This must be
configured in the Vault server.
The “Automatically Log in next session” box is ignored in Plant. When a Plant project is closed the
user is logged out and when reopened the user will be required to log back in to Vault. If the current
project (in project manager) is changed to a non-Vault project the user is still logged into Vault. If
the Vault project is then opened again no login is required.
If you are still trying to improve performance, talk with your Autodesk Support team to assist you.
There are changes and improvements that occur routinely, they will be in the best position to advise
you of any useful information. Ask specifically about the “Vault DLK Modification Instruction
(MARS)” and “Plant 3D PnPUpdateBatchSize variation” changes.
Plant-Vault Project Workflows
General Information
It is generally recommended that you perform project management operations (create project,
remove drawings, project setup) from a workstation that has a LAN connection to the Plant master
database.
When Checking-In a large number of files to Vault, turning off the creation of Visualisation
attachments will speed up the check-in process. Files missing the DWF can either be created later
via other tools (i.e. job processor) or alternatively they will be created when next check-in by a user.
Note: A folder in Vault is required before stating this process. This is where the project files will be
stored under the project name.
2. In the First page of Project Setup Wizard, after entering a project name (1), tick the “Create
this project in Vault:” box (2). If you are not already you will be prompted to login to Vault, be
sure to login to the correct Vault database. Finally you will be aske wich Vault Folder to crete
this project, This will already need to have been created by a Vault Administrator.
3. The next Plant-Vault setting is on page 5, where you specify the Plant Database connection
details. This is the same setup as a non-Vault Plant project that uses SQL Server. Be sure to
select the correct SQL Server required for the Plant-Vault projects.
Enter the server name (1) and click Test Connection. If the connection is made, continue to
the next step.
Enter a database name prefix (2), click the Test Name button.
Specify login details (3), either Windows or SQL authentication. If the latter, also specify the
user name and password.
Note: During the convert process the project will be copied to the Vault local workspace.
1. In AutoCAD Plant, login to Vault as a user that can create a new project (for example:
Administrator, Content Center Administrator, or Data Manager 2).
2. Open the non-Vault project that you want to convert to a Vault project.
3. At the Command prompt, enter PLANTPROJECTTOVAULT. The Vault Project Setup dialog box
displays.
4. In the local working folder location box, specify the root working folder for the converted
Vault project. The location must be different from the non-Vault project.
This may already be determined by company policy. To configure this in Vault refer to this
Autodesk Knowledge Network article: How to configure the working folder for AutoCAD Plant
3D projects with Vault
5. If the project database is using SQL Server, do the following:
a. In the Server name box, specify the server name. You can specify the same host and
server instance (AUTODESKVAULT) that the Vault server uses, but you are not required
to do so.
b. Enter the SQL Server credentials for the plant master database.
6. Click Start. The project is converted to a Vault project and synchronized up to the Vault from
the working folder.
Once you detach a project from Vault, a copy of the project of the Vault project will be created
and saved in the Vault User workspace. The default User workspace is by default
%USERPROFILE%\Documents\Plant Vault Projects. The project copy has no connection to SQL
Server or the Vault once detached. However there is still a copy of the project in Vault and this
would need to be removed by a Vault Administrator. The original SQL Server project also still
exists on the servers and these would need to be removed by the various system administrators.
Trying to reconnect or open the SQL or Vault project databases may be problematic. The reason
for this is that the detached copy of the project has the same name as the Vault project and is in
the Vault working folder. Vault cannot check-out the project because it conflicts with the
corresponding project copy that is saved in the same location. To resolve this, you need to
rename the detached copy of the project, then the original Vault project can be opened from
Vault.
To rename a project refer to the procedure on Autodesk Knowledge network: How to rename a
project in AutoCAD Plant 3D respectively AutoCAD P&ID
Detaching a project from Vault work flow.
1. In AutoCAD Plant, login to Vault as a user (for example: Administrator, Content Center
Administrator, or Data Manager 2)
2. From Plant Project Manager, right click on the Project > Vault > Detach from Vault.
To delete the whole Vault project with all data you have to do this on two sites:
• Vault Client
• SQL Server Management Studio
Delete a project from Vault Explorer:
To migrate a project, you will need to have the same permissions as required to create a project.
Process:
1. Recommendation: Open the Project in the Plant 3D version that it was created and “detach
from Vault” to create a back-up of that version before migration.
2. Open the project as normal in the new version of Plant 3D
3. “Project Requires Migration” wizard will start automatically after the project is synchronised.
.
5. The Project will be prepared for migration. This is a background process as it prepares all the
local files for migration (e.g. all design files will be checked out and the project locked).
6. The actual migration process starts, click Next.
7. You have the option to create a project backup at this stage (path required). If you have
manually backed-up previously you can un-check the box to skip the file backup.
9. When the files are migrated, there is a log created. This can be accessed from the dialog be
for closing by clicking on the finish button.
The project will be opened in your Plant 3D interface, continue to work as normal.
Managing a Plant-Vault Project configuration
The Project configuration is stored in Vault and is subject all the roles and security setting of the
Vault.
When a user opens a Vault project, the project configuration files and setups are downloaded to the
local working folder. This makes working in the Plant-Vault environment very fast but has some
draw backs.
Whenever the project configuration is needed to be modified if there are users working with the
project this can cause potential issues as the setup version stored locally may become out of sync
with Vault.
Best practice is to ensure that all users are no longer in the project and have check in all files.
Customising Projects
Project spec sheets and some Iso style files require that you use Autodesk Vault Client to check in
and check out files.
You cannot check out and check in piping specs using the AutoCAD Plant 3D Spec Editor. Instead,
project administrators check out PSPX and PSPC files in the Spec Sheets directory using Autodesk
Vault Client.
Note: Spec sheets that are in-use (for example: by the dynamic tool palette) are not updated with
PLANTREFRESHFROMVAULT. To update locked project files that are not checked out by you, you can
close and reopen the project with the Refresh all Changed Files from Vault option selected.
To modify Iso Style files directly (for example: edit IsoConfig.xml), you can check out and check in
files using Autodesk Vault Client.
Basically, anything that is not editable within Project Setup or the user interface must be checked
out, edited in the local workspace, and checked back in through the client.
Note: After the 2017.1 update, you can now check-out / check-in spec sheets directly from Plant 3D
Project Manager.
Project files have an alphabetic (A, B, C) revision format by default. You can use Autodesk Vault
Client to set a numeric (1,2,3) revision scheme for the “PlantProjectFile” file category.
Managing Shared Content in Vault
Plant 3D and P&ID use the ‘Shared Content’ folders to store common data and resources. The default
shared Content folders are in the root of C drive.
The Shared Content folder can be moved, and Catalog folders can be move separately if desired. For
more information, see Migrate Specs and Catalogs.
Spec files are installed under the shared content folder (for example: C:\AutoCAD Plant 3D 2017
Content\\Specs) and to the default project folder. If you create a project, spec files are copied from the
shared content folder to the new project.
Note: After the 2017.1 update, you can now check-out / check-in spec sheets directly from Plant 3D Project
Manager.
By default, spec files are project specific with each project including its own spec files. If you want
to share spec files between projects, you can change the spec file folder using AutoCAD Plant 3D
Project Setup. For more information see Set Plant 3D Paths.
You can set AutoCAD Plant 3D to check periodically for changes to a spec file. When you add a part to
a piping model, the model retains all the information, even if you remove the part from the spec file.
Drawing Templates
The drawing template (DWT) files can be either shared from a project, network or Vault directory or
alternatively on each user’s workstation. The project’s PipingPart.xml points to the DWT, and this
path can be either local or network. Out of the box it is where all the other ACAD DWT files ‐
C:\Users\%USERNAME%\AppData\Local\Autodesk\AutoCAD Plant 3D 2015\R20.0\enu\Template\...
Tool Palettes
Similar to the standard drawing templates the tool pallets files are also stored in the users profile
(C:\Users\%USERNAME%\AppData\Roaming\Autodesk\AutoCAD Plant 3D
2015\R20.0\enu\Support\ToolPalette).
The Plant and other enterprise tool palettes can be moved to a common network or Vaulted location
for users to access. Using Vault provides the advantages of the files defaulting to read only and
commonality across sites but will require the users to have Vault locally installed.
To use Vault for tool palette sharing copy the required tool palettes (Refer to procedure below) to
the Vault Local working folder and upload all the files to Vault using the Vault Client. To get the tool
palettes on the users work station use Vault client to download the files to the user’s Local
workspace. To make the palettes available in AutoCAD or Plant 3D, add the local working folder
palette location to the Plant profile options.
Removing the plant tool palettes from the default location will save any confusion with users
looking for the correct palette to use.
User will still be able to create and customise tool palettes in the default location but will not be
able to modify the Vault shared tool palettes due to Vault security features.
For instructions on sharing tool palettes by a network folder refer to this article: Sharing Tool
Palettes On A Network For AutoCAD P&ID
Note: This is not a plant 3D project function and requires the users to have Vault client to be able to
access the files stored in Vault.
For detailed instructions on making the Plant Content available in Vault refer to this article:
Managing Plant 3d Catalog Content in Vault
Commands for Project Management
Note: Underlined headers are links to Autodesk Knowledge network articles.
PROJECTMANAGER
You can create a consistent working environment for all project team members. Assemble files by
linking or copying them to the project. You can also preview drawings, examine work history,
customize project settings, and perform other project-related tasks. You can create or view
orthographic output on the Orthographic DWG tab and isometric output on the Isometric DWG tab.
NEWPROJECT
You can specify basic settings as you create a new project with the Project Setup wizard.
OPENPROJECT
The Open dialog box is displayed, where you can find and select the project.xml file you want to use.
PLANTGETSTARTED
Opens a window that helps unfamiliar users access basic functions directly from the buttons
provided in the window.
PLANTAUDITVAULTPROJECT
Audits for consistency between the local folders and the Vault.
PLANTPROJECTTOVAULT
Migrates a non-Vault project to the Vault.
PLANTREFRESHFROMVAULT
Updates the working folder from the Vault.
PLANTSYNCHRONIZETOVAULT
Updates the Vault from the working folder.
PLANTVAACEXPLORER
Displays the Autodesk Vault Client (Vault explorer).
PLANTVAULTATTACHRELATED
Attaches a non-project file from the Vault as an external reference.
PLANTVAULTDATABASE
Specifies the plant database server to use for a particular Vault server. After you replicate a Vault
and the plant database, you can specify which plant client database to use for each Vault server.
PLANTVAULTDROPLOCALCACHE
Clears the master project database local cache.
PLANTVAULTLOGIN
Log in to a Vault for the drawing session.
PLANTVAULTLOGOUT
Disconnects from the Vault.
PLANTVAULTRECONCILEPROJECT
Updates synchronization data in the plant master database (SQL Server).
Updates the file versions in Vault to match the file versions in the Plant master SQL database. Can
run while all users are in the project. Use this command if there is a drawing(s) that display the red
arrows beside the drawing name and a refresh from Vault does not take care of it.
3. AutoCAD Plant 3D: How to clear the recent projects list - Link
7. White Paper: Migrating AutoCAD Plant 3D Projects, Specs and Catalogues - Link
9. Autodesk University Class: Cracking Vault with AutoCAD Plant 3D and AutoCAD P&ID - Link
10. Autodesk University Class: Workshare with AutoCAD Plant 3D and Vault Professional: Setup,
Synchronization, and Replication - Link
11. Autodesk Knowledge Network Article: AutoCAD Plant 3D: Long drawing save time with WAN
SQL Server based project - Link
12. Book: Database Explained BOOK (engl.) / AutoCAD P&ID + Plant 3D – Shop Link
13. Autodesk Knowledge Network Article: Error: Vault 2017 Crash on start-up - Link