Importing Files from Folders SOLIDWORKS PDM - SolidPractices

 

Best Practice Information

Domain and Role/Product

<a class="s6m-tag-link sm-link" data-predicate="ds6w:what" data-tag-value="SOLIDWORKS PDM" data-type="internal" contenteditable="false">SOLIDWORKS PDM</a><a class="s6m-tag-link sm-link" data-predicate="ds6w:what" data-tag-value="Data Management" data-type="internal" contenteditable="false">Data Management</a><a class="s6m-tag-link sm-link" data-predicate="ds6w:what" data-tag-value="DATA MIGRATION" data-type="internal" contenteditable="false">DATA MIGRATION</a> 

 

What's Covered? - Jump to each section using the Contents List in the top right!

  • Task Summary
  • Understanding SOLIDWORKS File References

  • Understanding SOLIDWORKS PDM File References

  • Import Strategies

  • Do’s and Don’ts

     

Revision History

Rev #DateDescription
1.0Oct. 2019Updated and revised for use by customers. Reset as document version 1.0.
1.1Oct. 2021Updated the “Import Strategies” section to include the ‘Pack and Go’ option.
1.2Mar. 2025Revised for use by customers. Reset as document version 1.2.
    2.0Oct. 2026Document formatted for 3DSwym
<strong>Note</strong>

All SolidPractices are written as guidelines. It is a strong recommendation to use these documents only after properly evaluating your requirements. Distribution of this document is limited to Dassault Systèmes SolidWorks employees, VARs and customers that are on active subscription. You may not post this document on blogs or any internal or external forums without prior written authorization from Dassault Systèmes SolidWorks Corporation.

This document was updated using version SOLIDWORKS 2025 SP1.

1) Preface

The objective of this SolidPractices document is to share information about the various guidelines for importing CAD files from a Windows® File Explorer folder structure into a SOLIDWORKS PDM file vault. The purpose of this process is to ensure the establishment and maintenance of all file references within the SOLIDWORKS PDM file vault.

  • This document provides general guidelines. Follow these guidelines with proper alignment to the customer situation.
  • These guidelines apply specifically to SOLIDWORKS files; however, the general principals apply to all file types for which SOLIDWORKS PDM has a plug-in to manage file references. For specific file types, see the Knowledge Base solution QA00000107415.
  • This process applies to scenarios when importing only one version of each file into SOLIDWORKS PDM. When importing multiple file versions, it is best to use the SOLIDWORKS PDM XML Import Tool.
  • Two resources for assistance with these processes are the SOLIDWORKS Knowledge Base and the SOLIDWORKS Service Partners. For additional assistance, contact SOLIDWORKS Field Services at fieldservices@solidworks.com.

This SolidPractices document also covers topics that provide a better understanding of how SOLIDWORKS and SOLIDWORKS PDM manage file references.

 

Your Feedback Requested

We would like to hear your feedback and also suggestions for new topics. After reviewing this document, please take a few minutes to fill out a brief survey. Your feedback will help us create the content that directly addresses your challenges.

2) Task Summary

This SolidPractices document follows the scenario where a customer needs to move a large number of files from one or more Windows File Explorer folders into a SOLIDWORKS PDM file vault view. The practice is to organize the files into project folders within the SOLIDWORKS PDM file vault, and establish file references between those files.

3) Understanding SOLIDWORKS File References

Opening a SOLIDWORKS file performs a dynamic search to find the file’s references. This allows the parent file to locate references in different locations. This occurs each time the file opens, depending on the state of various factors at the time of opening.

SOLIDWORKS has a well-established and documented process to search for file references. To review this process, search for the topic “Search Routine for Referenced Documents” in the SOLIDWORKS Help. You can use the SOLIDWORKS Document Manager API to read and update SOLIDWORKS file references, without the need to open the files in the SOLIDWORKS application. This allows for quick evaluation and update of file references within a large dataset.

Understanding the SOLIDWORKS Toolbox and Design Library

There is full integration of the SOLIDWORKS Toolbox functionality in SOLIDWORKS PDM. It is a best practice to load the Toolbox library into the vault prior to running the import. There is also a requirement to add Design Library files to the vault; however, there is no functionality available to manage Design Library files in a way that is similar to the Toolbox files.

4) Understanding SOLIDWORKS PDM File References

After adding a file to a SOLIDWORKS PDM file vault, the software does not evaluate the file references. Therefore, you do not need to add files to the vault in any particular order. Upon initiation of the check in process, SOLIDWORKS PDM searches for references. To understand the SOLIDWORKS PDM search routine, search for the topic “Settings Dialog Box - External References Tab” in the SOLIDWORKS PDM Help.

During the check in process, a reference dialog box appears and displays the reference tree, which indicates if a file is not be found, or if a file exists outside of the vault. The software writes the references to the SOLIDWORKS PDM database during the check in process. Therefore, there must be a proper accounting of all references prior to completing the check in process.

For SOLIDWORKS PDM to manage file references, the files must exist within the vault. The SOLIDWORKS PDM Where-Used and Contains tabs do not display files stored outside of the vault. After establishing the references through the check in process, SOLIDWORKS PDM maintains the file references as you move or rename files within the vault.

  1. Maintaining References When Moving or Renaming Files

When moving or renaming a file, SOLIDWORKS PDM makes a note in the database of the new reference name and location. The parent references update in the local view where the action occurs, however, there is no update to the parent files in the SOLIDWORKS PDM Archive folders or in locally cached versions on other client computers. During the Get operation, if a parent file has reference locations that differ from the updated reference names or paths in the database, the file references are updated because the file is cached locally. The Get latest version dialog box shows Updating file references. See Figure 1.

Figure 1: Updating file references
  1. Examples of File Reference Dialogs

    Figure 2: References that exist in same directory as the parent file
    Figure 3: References that exist outside of the parent file directory

 

 

  1. Using the Update References Tool

Effective with the release of SOLIDWORKS PDM 2011, the Update References tool became available to help users find and connect missing references with parent files. This tool allows users to select a file and search for the file’s references within the file vault. A user can then choose from the list of matching results, and update the file references. The purpose of this tool is to repair only one parent file at a time. To learn more about this tool, search for the topic “Updating Broken File References” in the SOLIDWORKS PDM Help.

Figure 4: Update References tool showing missing references
Figure 5: Update References tool showing updated references

5) Import Strategies

Determining the best process for importing a dataset into SOLIDWORKS PDM requires a thorough review of the state of the existing dataset in comparison to the ideal state of the data import. There are a few common methods for importing data to consider. When choosing an import strategy, consider the long-term effects of interacting with the files in both their native CAD system and in SOLIDWORKS PDM. Some methods may only work for one application or the other.

  1. Import All Files Into a Single Folder

Importing all files into one folder for the initial check in and then moving the files into subfolders is a simple process that sets all references properly. This method is great for small datasets; however, performance issues occur when trying to work within a large import folder. Another thing to consider is that large datasets probably require a custom program to move files into a specific folder structure.

  1. Import Files By Using Reference Search Paths

This is an effective solution when the reference paths are both manageable and predictable. When there is a requirement for a large number of search paths, it can be time consuming to enter all of the paths and difficult to ensure the specification of all required paths. The process may require a custom program to ensure that the reference paths are set correctly. While relying on search paths adds a small amount of time to the display of the reference tree, after successfully checking in all files, the reference paths are no longer required because SOLIDWORKS PDM maintains the references.

  1. Import Files By Using Relative Paths

Most CAD systems can interpret references based on the relative path between the parent and the reference. If the existing dataset is stored in a folder structure that matches the folder structure of the vault, then it is possible to import files to the vault by using the same folder structure, and the file references become known. This approach assumes that the references are correct in their current state. Therefore, it is a best practice to verify the references, which requires a custom program for larger datasets.

  1. Import Files By Using Pre-processing Repair Tools

In almost all cases, the existing dataset contains elements of incorrect references or structure. Therefore, it is a recommendation to use a custom program to compile the existing dataset into the proper directory structure and to also read the file references and make corrections where needed. Although it is possible to place the files into the vault before running the program to update the references prior to check in, the recommendation is to repair the files outside of the vault. This avoids automatically checking in the files at version two, which occurs because SOLIDWORKS PDM does not allow edits to the initial version of documents in the vault. This method requires the ability to modify file references, which is possible for SOLIDWORKS files, but may not be possible with all CAD systems.

  1. Import Files By Using Pack and Go

In many cases, there are files (parts, assemblies, drawings, references, BOM and others) in the assembly-related folders. However, sometimes the part files do not exist in the same folder. This can cause the omission of some part files when importing the files in SOLIDWORKS PDM. In these cases, the recommendation is to use the Pack and Go feature to package the SOLIDWORKS files for import into SOLIDWORKS PDM. Use Pack and Go to ensure that the references update in the target locations. Otherwise, broken references may occur. You can collect all the files into a folder or ZIP file to ensure the inclusion of all files.

6) Do’s and Don’ts

Regardless of which import strategy you use to import a customer dataset, there will be challenges along the way. There are a few scenarios to watch out for, as well as some common things to consider before getting started.

  1. Beware of Relying on Reference Search Paths

There are inherent risks when using reference search paths because the process is very dynamic and the results are difficult to predict. Additionally, if the file vault contains duplicate file names, the reference search paths may select the wrong file with a matching file name. While the SOLIDWORKS PDM Settings Dialog Box - External References tab is a great way to ensure that SOLIDWORKS PDM is aware of the file references, this option does not update the references in the parent CAD document. The result is that the SOLIDWORKS PDM Check in dialog box looks correct, however when the file opens in the CAD application, the references are not found. Therefore, you must take additional measures to ensure that the CAD references are correct. In most cases, if the SOLIDWORKS application can find the reference files, then SOLIDWORKS PDM can also find them without using the External References list.

  1. Watch For Rogue Files Outside the Local Vault View

When you copy files into a SOLIDWORKS PDM local vault view, the CAD reference search process may find the original files instead of using the new copy of the reference file in the local vault view. This can also be an issue if there are other random copies of the file in both local and network path locations. Having a good understanding of the SOLIDWORKS Search Routine for Referenced Documents and enforcing control over the location of all copies of a reference file outside the vault helps prevent this scenario.

  1. Estimating Effort

When a customer uses Windows File Explorer to manage their dataset, the quality of the dataset is the primary variable to consider when estimating the effort required to complete a data import. Another major factor to consider is if there is a need to modify the dataset during the import. For instance, is there a need to rename files or move them to different folders? The other main factor is the size and composition of the dataset. At the start of an import project, it is a best practice to make a quick assessment to generate a report of all of the different file types, sizes, and quantities. Careful planning in the early stages helps to set the appropriate expectations, regardless of whether the customer performs the project with guidance from the reseller, or hires a professional to complete the project.

  1. Evaluating Strategies and Data Quality

Most datasets are too large to verify manually. During the planning stages, it is a best practice to uses various strategies and small subsets of data to test imports that include all file types. While testing sample datasets is great for validating an import strategy, it is also important to verify the remainder of the dataset. Therefore, use of customized tools is required to scan and evaluate the entire dataset. Things to look for include duplicate file names, parent files for which SOLIDWORKS PDM can find no existing references, and for references that are missing altogether. Key technical skills for success with this project include navigating Windows directories and using the SOLIDWORKS Document Manager API.

We hope that you find this document informational and useful and request that you leave a <a href="https://www.surveymonkey.com/r/SolidPractices" rel="nofollow">brief feedback</a> about the topics that you want us to cover in the next revision of this document. Click here for a complete list of SolidPractices documents available from DS SOLIDWORKS Corp.

 

Comments 0