SolidPractices: Moving SOLIDWORKS
3DS.COM © Dassault Systèmes | Confidential Information | 06/27/2017 ref.: Document_Reference |
Files to the 3DEXPERIENCE Platform
3DEXPERIENCE SOLIDWORKS®
Last Update: August 2023
Revision 2.1
Table of Contents
1. PREFACE 5
c) File Preparation Assistant 12
1. SOLIDWORKS TASK SCHEDULER 14
2. INTERACTIVE SAVE TO 3DEXPERIENCE 14
3. BATCH SAVE TO 3DEXPERIENCE 15
1. Existing folder structure 18
2. Reorganize data in the 3DEXPERIENCE platform 20
1. Using the File Preparation Assistant 22
2. File Preparation Assistant Options 23
3. File Preparation Assistant Best Practices 27
a) Recommendations for SOLIDWORKS System Options 29
b) Recommendations for MySession Options 29
c) Recommendations for Platform Settings 30
1. INTERACTIVE SAVE TO 3DEXPERIENCE 33
- 0
-
1
Revision History
Rev # Date Description 1.0 June 2021
Document Published
2.0 March 2023
Updated for R2023x FD01
2.1 August 2023
Minor updates in Section 4) File Preparation (a) Categorize
Note
All SolidPractices are written as guidelines. You are recommended to use these documents only after properly evaluating your requirements. The distribution of this document is limited to Dassault Systèmes SolidWorks Corp. employees, VARs, and customers that are on active subscriptions. This document may not be posted on blogs or any internal or external forums without prior written authorization from Dassault Systèmes SolidWorks Corp.
This document was updated using 3DEXPERIENCE platform R2023x FD01 On Cloud and 3DEXPERIENCE SOLIDWORKS Premium. The content also applies to Collaborative Designer for SOLIDWORKS and SOLIDWORKS Premium 2023 SP1.0. If you have questions or need assistance understanding the content, then contact your Business Partner. You can download the latest version of this document from https://my.solidworks.com/support/solidpractices.
Preface
This document outlines the current tools and methods for planning, preparing and moving or saving SOLIDWORKS CAD files from a Windows® File Explorer, file management-based system, to a 3DEXPERIENCE platform, Product Lifecycle Management (PLM) or data management-based system. The guidelines and best practices in this document can help to ensure that companies have a smooth transition to data management and can effectively and efficiently manage their SOLIDWORKS CAD data in the 3DEXPERIENCE platform.
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 content that directly addresses your challenges.
Preparation and Planning
Target Audience
3DEXPERIENCE platform.
Prerequisites
An understanding of 3DEXPERIENCE platform concepts, terminology and settings is essential for a successful move. Collaborative space management, baseline responsibilities and the available admin settings for SOLIDWORKS data must be well understood. The platform settings available are suitable for most; however changes may be required depending on your business needs.
(Basic) Complete or know of the following learning modules and lessons:
Although it is not a requirement, it is a recommendation that the person who performs the move be a platform administrator. This allows the person to test various platform settings during the Pilot Test (see section 6)a)) because many platform settings like Content Naming Rules, Revision Naming Rules and Revision format are designed to never change after creating content in a collaborative space.
(Advanced) Complete or know of the following learning modules and lessons:
The 3DEXPERIENCE SOLIDWORKS (or SOLIDWORKS Desktop and Collaborative Designer for SOLIDWORKS) software should already be installed and running properly.
In addition, you need to be familiar with the SOLIDWORKS data model and the naming conventions that are used for SOLIDWORKS data once it is moved to the 3DEXPERIENCE platform. See the Knowledge Base articles QA00000070398 and QA00000070613 for more information about these topics.
Finally, the move should be done by one person, on a dedicated computer, to one collaborative space that is reserved for the company’s design data.
This person should also run the Cloud Eligibility tool on the dedicated computer to verify that it passes all checks. Contact your Business Partner if questions or concerns arise with your Cloud Eligibility results.
The minimum requirements for bandwidth and latency to the 3DEXPERIENCE platform On Cloud data center is 4 Mbps and 350 ms, respectfully. However, a connection that is greater than 16 Mbps and less than 120 ms is recommended for an optimal experience.
Resources
In addition to the previously mentioned 3DEXPERIENCE EDU Space content, the following SolidPractices complement and extend the topics discussed in this document:
• Getting Started with Lifecycle and Revision Control
• Storing Templates
• Working with Toolbox
• Attribute Mapping for SOLIDWORKS
You can also find additional resources in:
• Dassault Systèmes User Assistance
• SOLIDWORKS News & Info community
• 3DEXPERIENCE Works admin path wiki within that community
Planning
Using Windows File Explorer to manage SOLIDWORKS CAD files is typically an unstructured, manual process, and the quality of your file set may not be ready for a move to the 3DEXPERIENCE platform. Common pitfalls of a file management-based system include:
Careful planning and preparation are required to optimize the quality of your file set. The number of files, their file size and the composition and structure of your file set directly affect how much time and effort the move requires.
Introduction to Tools
Several tools are available to prepare and move your SOLIDWORKS CAD files to the
3DEXPERIENCE platform.
SOLIDWORKS File Utilities
The SOLIDWORKS File Utilities are included with all packages of 3DEXPERIENCE SOLIDWORKS and SOLIDWORKS Desktop.
The utilities are accessible when you right-click a SOLIDWORKS file in File Explorer. Use this tool during the file preparation phase to rename, replace and move files.
Pack and Go
Pack and Go is a very powerful SOLIDWORKS File Utilities tool. It is useful to gather all related files for a model and it allows you to rename and copy all related files to another location.
Pack and Go is accessible when you right-click a SOLIDWORKS file in File Explorer, or from the File menu within SOLIDWORKS.
Use this tool during the file preparation phase to locate your file set.
File Preparation Assistant
The File Preparation Assistant is included with all packages of 3DEXPERIENCE SOLIDWORKS and with Collaborative Designer for SOLIDWORKS and SOLIDWORKS Desktop 2023 SP1.0. It is available with limited capability in SOLIDWORKS Desktop 2022.
You can access this tool from the Tools menu within SOLIDWORKS and from the Batch Save to 3DEXPERIENCE tool. It runs independently without requiring a connection to the 3DEXPERIENCE platform.
The File Preparation Assistant is designed to analyze the quality of legacy file sets and to find compatibility issues that may prevent a successful move to the 3DEXPERIENCE platform, and which may cause downstream issues when working with the data.
Use this tool during the file preparation phase to analyze and:
SOLIDWORKS Task Scheduler
The SOLIDWORKS Task Scheduler is included with all packages of 3DEXPERIENCE SOLIDWORKS and SOLIDWORKS Desktop.
This tool is accessible from the Start menu and from the Tools menu within SOLIDWORKS.
Use this tool during the file preparation phase to refresh your file set.
Interactive Save to 3DEXPERIENCE
The Save to 3DEXPERIENCE command is available from the SOLIDWORKS File menu, toolbars and from the MySession app within the 3DEXPERIENCE task pane. This is an interactive, synchronous command that securely uploads SOLIDWORKS files and creates corresponding SOLIDWORKS mastered database objects in a specified collaborative space. This command is suitable for a file set that contains several projects with a total file size < 500 MB.
EXPERIENCE SOLIDWORKS roles and Collaborative Designer for SOLIDWORKS
Batch Save to 3DEXPERIENCE
The Batch Save to 3DEXPERIENCE tool is available from the SOLIDWORKS Tools menu. This is an automated, asynchronous tool that has the same secure upload and database object creation capability as the Save to 3DEXPERIENCE command. It provides the ability to save SOLIDWORKS files from multiple folders into various collaborative spaces and bookmarks. This command is suitable for a large data set that contains multiple projects with a data set size
< 5GB.
The tool improves efficiency because the save runs asynchronously, in a separate process. This allows you to use SOLIDWORKS while the save processes.
File Preparation
Prepare your SOLIDWORKS files with five preparation steps: Categorize, Locate, Evaluate, Analyze and Refresh (CLEAR). Following these guidelines ensures an error-free file set that is ready to move to the 3DEXPERIENCE platform.
Categorize
Step 1 is to categorize your file set so that you are familiar with what files to be move and what files require validation when the move is complete.
What kind of files do you have? What kind of data and file references do the files contain? Do you have a part numbering system? Do you have configurations that do not need to move?
• Configurations, including Bill of Materials Options
- Derived configurations, including Bill of Materials Options
Derived parts
• Insert parts, Mirror parts, derived component parts
Design Tables
Simulation results
• External references
• Virtual components
• Component references
• Configurations
- Derived configurations, including SpeekPak configurations
Design Tables
Simulation results
Detached drawings
Excel-based Bill of Materials
• Routing components – Applicable to 3DEXPERIENCE SOLIDWORKS Premium and SOLIDWORKS Premium.
EXPERIENCE SOLIDWORKS Professional and Premium versions and the SOLIDWORKS Professional and Premium versions.
For information on options that affect the SOLIDWORKS data model within the 3DEXPERIENCE platform, see Knowledge Base article QA00000300960.
Locate
Step two, decide where you want to locate the file set that moves to the 3DEXPERIENCE platform. This is the most important step to prevent duplicate data. Once the move starts, you must not change the location of your file set. When the move is complete, it is a good idea to archive or delete the location and original file set and for platform members to stop using those files. This applies to moving your complete file set and your pilot test.
Do you want to use an existing folder structure? Does your existing folder structure include local paths or network paths? Do you want to start a new structure and reorganize your data in the 3DEXPERIENCE platform?
Before you begin, STOP and ensure that you have a backup of your original file set.
Existing folder structure
If you have an existing folder structure that is complex or already well established for your designers, and you want to maintain it in the 3DEXPERIENCE platform, then it is recommended that you use the Batch Save to 3DEXPERIENCE methodology to move your file set. This methodology automatically recreates your folder structure as bookmark objects and places the resulting SOLIDWORKS data in the corresponding bookmarks. See section 6cfor more details.
Existing folder structure with network Paths
If the existing folder structure includes network paths, then the recommendation is that you use Pack and Go to relocate your file set to a location on the local network. Moving the file set to a local location:
In this case, use Pack and Go on each top-level assembly to create copies in root paths on the dedicated computer. For example, [C:\ProjectX]. More options are available when running Pack and Go from within SOLIDWORKS, so make sure to enable all the correct options:
Do not activate the Include Toolbox components option. The 3DEXPERIENCE platform automatically recognizes, saves and manages Toolbox components. If your file set contains Toolbox components, then STOP and read the SolidPractices document “Working With Toolbox” to become familiar with that methodology.
Figure 1 – Pack and Go launched from Windows File Explorer
Figure 2 - Pack and Go launched from SOLIDWORKS has additional options
Reorganize data in the 3DEXPERIENCE platform
If you want to reorganize your data in the 3DEXPERIENCE platform, then the recommendation is that you use Pack and Go on each top-level assembly in your file set to create local copies in root paths on the dedicated computer (such as [C:\ProjectX]), and choose the Flatten to single folder option.
You will save your file set to a single bookmark, in the same way as the Pilot Test (see section 6)a). After moving and validating the file set, you can create additional bookmarks and move your SOLIDWORKS data to the new bookmarks.
Evaluate
Step 3 is to open each top-level assembly from the locations you specified in the Locate step and run a Check Entity operation to verify the integrity of the geometry. To optimize the performance and stability of the software, the recommendation is that you resolve all geometry faults. This can be a quick or time-consuming process depending on the downstream use that you should not ignore. You may want to consider removing the affected files from your file set or recreating them in SOLIDWORKS with native SOLIDWORKS features.
Figure 3 - Geometry faults are common in file sets that have imported non-native CAD files. It is best to always use 3D Interconnect to mitigate geometry faults, and to always fix geometry faults to optimize performance and stability.
Analyze
Fourth, use the File Preparation Assistant to analyze your file set for missing file references, incompatibility issues and unwanted duplicate files.
One of the many advantages of using the 3DEXPERIENCE platform is its powerful range of capabilities for tracking and managing relations. When you save your file set to the 3DEXPERIENCE platform, all file references are analyzed and reconstructed as relations in the database. This gives you complete traceability of where each part, assembly and configuration is used. Because of this, it is vital for your file set to be accurate and up-to-date.
Figure 4 - Example of the Relations app showing parent and child relations of a SOLIDWORKS object.
The File Preparation Assistant can help prevent you from saving an inaccurate, out-of-date or incompatible file set. It also ensures that your file set is prepared for the 3DEXPERIENCE platform to successfully reconstruct the all-important relations.
Using the File Preparation Assistant
The basic steps to use the tool are as follows:
2File Preparation Assistant Options
This check finds duplicate files and prompts you to either keep the duplicates (and rename one of the files to avoid duplicates,) or merge the duplicates (remove one and automatically update references with the other.)
• Merge Duplicates Dialog
The Detect duplicates files and prompt to merge check requires user interaction while it is running.
Any duplicates found appear in the Merge Duplicates dialog box.
The top pane lists all duplicate files. The Duplicate column shows the quantity of duplicates. The Merged Result column shows the quantity of files after the merging operations complete.
3: 3DSearch queries require at least three characters.
To avoid this limitation, this check finds files that only have one or two characters and renames them by adding an underscore to the end of the filename. Any Where Used references included in the scope of the selected folders will be updated.
With this list, you must decide whether you want to maintain the links and separately manage the locally stored non-native CAD files, or whether you want to break the links to streamline performance and reliability. The recommendation is to break all 3D Interconnect links.
For more information about 3D Interconnect, including how to use it, refer to the SOLIDWORKS Online Help.
This check analyzes your file set and creates a MissingFiles_[timestamp].csv file. No changes are made to your file set.
The CSV file contains a comprehensive history of any missing files. It lists every file location in which a given missing file once existed, for every time it was inserted into an assembly or part and saved. For example, if your file management methodology included copying and pasting files or folders to start new projects, then you also unknowingly copied the previous file location history. This check exposes that history and may show file locations that no longer exist.
Open the CSV file in Microsoft® Excel® and filter the Missing file name column to identify the number of unique files that you need to locate or remove from your file set.
When resolving missing file references in SOLIDWORKS, use the Delete Missing References command in the Find References dialog box to delete missing references that you no longer need, or cannot otherwise resolve.
No changes are made to your file set. The intention is that you will decide what course of action to take after reviewing the log file.
This check finds files where the attribute mapping would fail because of mismatched data types, and creates a Properties_[timestamp].csv file with a list of those files. To define this check:
4File Preparation Assistant Best Practices
It is a recommendation to run as many of the checks as possible, even if you think some do not apply. (The exception is the custom property check.) For example, if you are sure that your file set does not have 3D Interconnect links, run that check anyway. If it detects a file, that saves you a lot of trouble that may otherwise require deleting data from your platform and resaving.
If any checks return positive results, the recommendation is to rerun the checks after you resolve the issues.
It is also best to run each check individually. That way it is easier to systematically review each log and not forget any of the checks.
Refresh
Finally, use SOLIDWORKS Task Scheduler to complete the preparation of your file set. Create a Convert Files task with the following options to convert, update and resave your file set. This task may be time-consuming, but it helps ensure an error-free file set.
Figure 5 - Make sure to activate Update previously converted files (may take longer)
Load referenced documents: All, and Activate all configurations before saving.
Prepare For Save
Before performing your Pilot Test, there are several recommendations of options and tasks to consider:
Recommendations for SOLIDWORKS System Options
• Performance > Manually manage resolved and lightweight modes
• Performance > Purge cached configuration data = OFF
• Assemblies > Use Lightweight mode and Large Assembly Settings… = OFF
• Assemblies > Use Large Design Review mode… = OFF
• External References > Load referenced documents = All
Recommendations for MySession Options
None. The default specifications are sufficient.
Figure 6 - Default MySession save options.
Recommendations for Platform Settings
Note: There are many platform settings and configurations to consider that are outside the scope of this document. For example, custom attributes and attribute mapping, content naming rules, revision naming rules, revision format, auto-naming and maturity graph customizations. It is assumed that you have already decided on these settings and customizations. If not, STOP and assess these settings before you create any content in your platform.
Additional settings recommendations for saving your file set include:
This setting warns you during an interactive save if parts, assemblies or drawings with the same title already exist in your platform.
There are three options for this setting and each option has its own additional settings:
• All configurations
- Exclude derived configurations = Yes or No
Referenced configurations
Save Referenced configurations
• Both Parts and Assemblies
• Assemblies Only
Exclude configurations based on certain words or characters
As part of the Categorize step of file preparation, you made a decision about which configurations to move. Apply this setting based on that decision.
Local Work Folder
Make sure your local work folder that appears in the 3DEXPERIENCE files on This PC task pane is clear.
The system uses your local work folder to keep track of which files in your file set are saved to the 3DEXPERIENCE platform. Once you start your move, you must never delete files from the local work folder.
Save To 3DEXPERIENCE
Pilot Test
As mentioned earlier, it is a best practice to conduct a pilot test of your move. Choose an assembly from your file set that best represents the projects you create. Your file set should now be prepared, the necessary settings and platform considerations should be in place, and you are ready to conduct the pilot test.
This operation should be done by one person, on a dedicated computer, to one collaborative space that is reserved for the company’s design data.
Pilot test methodology
5Pilot test validation
6
7?
state, revision, ownership and others)
8Pilot test cleanup
9Interactive Save to 3DEXPERIENCE
This method of moving files to the 3DEXPERIENCE platform involves opening a file from your file set, clicking a save command, and waiting for the file to save. You then repeat this process until you finishing moving the entire file set.
This is also the save method you use after moving your file set. After moving a file set, an interactive save is what all users use when resaving data to their 3DEXPERIENCE platform.
The general procedure for interactive save is:
1. SOLIDWORKS TASK SCHEDULER 14
2. INTERACTIVE SAVE TO 3DEXPERIENCE 14
3. BATCH SAVE TO 3DEXPERIENCE 15
0This is the recommended command. It ensures that the Save to 3DEXPERIENCE
dialog box appears, where you can interrogate what to saved.
1. SOLIDWORKS TASK SCHEDULER 14
2. INTERACTIVE SAVE TO 3DEXPERIENCE 14
3. BATCH SAVE TO 3DEXPERIENCE 15
1Important: Do not clear your local work folder unless you are restarting the move. The system uses the local work folder to determine which files have been saved. If you clear the local work folder at any time during the move, duplicate data may be created.
Figure 7 - Interactive save interests you or pauses when needed if important information, like duplicate data warnings, need to be communicated. In this examaple, platform data with the same titles as the file set being saved already exists and therefore should NOT be saved.
Advantages
Disadvantages
Batch Save to 3DEXPERIENCE
This is an automated method of moving files to the 3DEXPERIENCE platform. It uses the Batch Save to 3DEXPERIENCE tool, which can save your entire file set in one step. You typically only use this method once, when moving your file set.
The general procedure for batch save is:
1. SOLIDWORKS TASK SCHEDULER 14
2. INTERACTIVE SAVE TO 3DEXPERIENCE 14
3. BATCH SAVE TO 3DEXPERIENCE 15
2Important: If you do not have a flat folder structure, then make sure to activate the
Include referenced files located outside of the selected folder(s) option.
1. SOLIDWORKS TASK SCHEDULER 14
2. INTERACTIVE SAVE TO 3DEXPERIENCE 14
3. BATCH SAVE TO 3DEXPERIENCE 15
3Important: Do not clear your local work folder unless you are restarting the move. The system uses the local work folder to determine which files are saved. If you clear the local work folder at any time during the move, duplicate data may be created.
Advantages
• If you use an existing folder structure, this method automatically recreates your File Explorer folder structure as bookmarks and places the resulting SOLIDWORKS data in the corresponding bookmarks.
Figure 8 - Batch saving a file set with a folder structure
Figure 9 - You can minimize the Batch Save to 3DEXPERIENCE tool while it processes the save.
Figure 10 - The Windows File Explorer folder structure is automatically recreated as bookmarks and objects are automatically added to the bookmarks accordingly.
Figure 11 - When the save completes, the local work folder is populated with data. This is how to verify that your file set was saved successfully from your chosen file location.
• You can rerun a batch save if a previous attempt fails or is interrupted, or if you forget to add a folder or option. As long as you do not clear your local work folder, the tool will restart the save process starting with the group of files that previously failed. Always rerun the tool after a failure.
• The tool generates a report.
Although not advisable, if you omit the Refresh step of file preparation, the tool does not convert files to the current version.
Disadvantages
Validate Your Data
Regardless of how much file preparation you choose to do and the method by which you choose to move your data, as with the Pilot Test validation, you must dedicate time to verify that your entire file set moves with intact file references and accurate metadata.
You can do this by spot-checking various parts, assemblies and drawings. Pay specific attention to the ability of different users to access the files in the collaborative space or bookmarks. It is important to perform a complete validation before committing legacy data for production use.
Conclusion
Your legacy data is your digital asset, which, in many scenarios, is understandably very crucial for future project success. It is important to remember that SOLIDWORKS does not have any means to repair your data if there is damage during the move. Therefore, it is a strong recommendation to conduct proper planning, testing and validation methodically. If you are unsure at any point about how to proceed with the move, contact your Business Partner for guidance. For some large file sets and old file sets, it is advisable to contact your Business Partner to ensure a successful move.
We hope that you find this document informational and useful and request that you leave a brief feedback 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.
