| Rev # | Date | Description |
|---|---|---|
| 1.0 | September 2023 | Document Published |
| 2.0 | November 2023 | Document Updated- section 6 |
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 FD04 On Cloud and 3DEXPERIENCE SOLIDWORKS Premium. The content also applies to Collaborative Designer for SOLIDWORKS and SOLIDWORKS Premium 2023 SP4.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 provides a holistic view at various aspects that need to be considered when incorporating 3DEXPERIENCE Platform for SOLIDWORKS users.
The guidelines and best practices in this document provide recommendations to address critical areas, ensuring organizations can seamlessly implement the 3DEXPERIENCE platform and efficiently handle their SOLIDWORKS data on the platform. It takes you on a journey from how you should consider analyzing and cleaning your data to managing configurations, attributes and toolbox parts on 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.
Introduction
Familiarity with SOLIDWORKS
As you embark on this journey of the 3DEXPERIENCE platform, it's essential to ensure that you have the right tools, knowledge, and access in place. It's vital to have an understanding of SOLIDWORKS.
Access to the 3DEXPERIENCE Platform
The first step to experiencing the power of the 3DEXPERIENCE platform is to gain access. If you don't have an account yet, reach out to your organization’s system admin or your value-added reseller. Ensuring a smooth onboarding process will set the user up nicely on the path to leverage the platform's collaborative capabilities and advanced features.
System Requirements
Make sure your system meets the minimum requirements to run the 3DEXPERIENCE platform effectively. Check for hardware specifications, operating system compatibility, and internet connectivity on our Certified Workstations webpage. You should also utilize our Cloud Eligibility Tool to ensure that your hardware and software configurations meet the platform's specifications to guarantee optimal performance and user experience.
Familiarize with 3DEXPERIENCE Terminology
The 3DEXPERIENCE platform introduces some new concepts and terminology that might differ from what you are used to in SOLIDWORKS. It’s important to familiarize yourself with these new elements, such as Roles and Apps. Roles are collections of various Apps, while Apps provide the functionality. It’s up to you to decide which Roles and Apps you need, so you can select what you want for now, and grow as you go. Understanding these concepts will help you navigate the platform with confidence.
Training Resources
To help you navigate the platform effectively, our recommendation is to invest time in training available on MySolidWorks.
Data Preparation and Setup
Change can be exciting, but it can also come with its challenges. When introducing a new platform, its implementation can be a daunting task. Enter the File Preparation Assistant, your guide to a seamless shift. This tool helps you prepare your SOLIDWORKS files for migration to the 3DEXPERIENCE platform. It ensures that your designs maintain their integrity, accessibility, and crucial associations. In essence, it acts as a bridge, ensuring that your designs make the move smoothly, eliminating migration hiccups.
The File Preparation Assistant simplifies data migration to the 3DEXPERIENCE platform. Open SOLIDWORKS, access the "Tools" tab, and click "File Preparation Assistant". Follow the prompts to select the files, analyze them, and resolve issues which could be roadblocks for migration.
The File Preparation Assistant is included with all packages of 3DEXPERIENCE SOLIDWORKS and with Collaborative Designer for SOLIDWORKS and SOLIDWORKS Desktop 2022. It runs independently without requiring a connection to the 3DEXPERIENCE platform.
The File Preparation Assistant is designed to analyze the quality of and find SOLIDWORKS data compatibility issues before saving data to the 3DEXPERIENCE platform.
With this tool, you can fix trailing space issues in the file name, identify duplicates, and merge or delete them, find missing file references, and find missing configurations, among other file inconsistencies to have healthier data.
Once you launch the tool, select your folder with the top-level assembly that you want to upload from your desktop. There is no need to select its subfolder as the File Preparation Assistant will run checks on those as well. Then select the folder in which to create log files. In addition, it is recommended you select a folder for a backup location.
It is also suggested to at least run the tool with the options below (please note that you might have to perform these checks one by one or use the options not listed in the below example depending on your data):
Replace leading/trailing spaces in filenames with “_”
The File Preparation Assistant will find files with leading or trailing spaces and rename them, replacing leading or trailing spaces with an underscore “_.” This is needed as the 3DEXPERIENCE platform does not support file names with leading or trailing spaces.
Detect duplicate files and prompt to merge
The 3DEXPERIENCE platform does not block you from saving duplicate files unless that setting has been enabled, which is now an option as of R2023x FD02. Therefore, it is recommended that you use this check to identify any duplicate files and resolve those conditions before uploading your data.
If duplicates are detected, you will be prompted to keep the duplicate, rename it, or merge the duplicates. You will need to decide how you want to proceed based on your business practices. The following are the different ways to detect duplicates:
Match on filename: Checks only for identical filenames.
Match on filename and configuration names: Checks for identical filenames, identical configuration names, and the quantity of configurations.
Match on filename and file creation timestamp: Checks for identical filenames and identical file creation timestamps, meaning the date the file was first created on the disk.
Extend filenames to be at least three characters
Any files with less than three characters will automatically be given an underscore at the end of the filename. This is helpful because the 3D search feature on the 3DEXPERIENCE platform requires at least three characters in a filename..
Detect 3D Interconnect references
Although you can save SOLIDWORKS files with 3D Interconnect links to the 3DEXPERIENCE platform, you cannot save the referenced non-native CAD files. This check finds files that have 3D Interconnect links and lists them in a log file. No changes are made to your data.
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. It is recommended you break all 3D Interconnect links.
While it may be tempting to maintain the links, it is recommended that you break all 3D Interconnect links to streamline performance and reliability and reduce the risk of errors and compatibility issues.
Detect missing file references
It’s recommended to correct or remove all missing file references before moving your data to the 3DEXPERIENCE platform. For example, an assembly with missing component references, or derived parts with a missing inserted part reference. You can save a file set with missing references to the 3DEXPERIENCE platform, but the platform blocks you from resaving that data until you resolve the missing file references.
This check analyzes your file set and creates a MissingFiles_[timestamp].csv file. No modifications or changes are made to your file set.
The CSV file generated 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.
When resolving missing file references in SOLIDWORKS, use the Delete All Missing References command in the Find References dialog box to delete missing references that you no longer need, or cannot otherwise resolve.
The recommendation is for you to run all the checks, even if you think some do not apply. The exception is the Custom Property Check. If any checks return positive results, it is recommended to re-run the checks after you resolve the issues. It is also best to run each check individually.
Recommended Platform Settings
There are a lot of platform settings that you can customize. While the exact customization needs might be different for different use cases, below are some settings that are recommended and work for the majority of SOLIDWORKS customers.
File Title Uniqueness
This is a setting to warn you during save if parts, assemblies or drawings with the same title already exist in your platform.
Collaborative Spaces Configuration Center > CAD Collaboration > Connectors > SOLIDWORKS > Settings > Save > Check File Title for uniqueness = ON
Revision Naming Rules
There are a few different options to choose for revision naming rules on the3DEXPERIENCE Platform. The setting that needs to be changed to manage the revision naming rules can be found as below:
Collaborative Spaces Configuration Center > Revision Naming Rules
We recommend using the A,B,C setting as that is the most common setting for the SOLIDWORKS users.
Revision Naming Behavior
It is recommended to have revision naming behavior set to Primary and Secondary in the settings to allow for maximum flexibility in their designs. As a common practice, users have the A,B,C… revision scheme as their primary revision scheme and 1,2,3… as their secondary revision scheme. This enables them to move from A.1 to A.2 to A.3 and so on till they release the revision after which they move to the primary revision B stream and start with B.1.
The setting for this can be found as below:
Collaborative Spaces Configuration Center > Lifecycle And Collaboration > Revision Naming Behavior
Save Options
It goes without saying that one of the most important things is to be able to get your SOLIDWORKS data to the 3DEXPERIENCE platform if you want to leverage it for any other applications. For that reason, we have multiple different ways to save your data from SOLIDWORKS to the 3DEXPERIENCE Platform.
A few different ways to save the data to the platform are (all from within SOLIDWORKS):
File > Save to 3DEXPERIENCE
From the 3DEXPERIENCE Add-in
Using Batch Save Add-in
If you’re in the middle of a design and want to save as you go, it is recommended that you use File>Save to 3DEXPERIENCE or from the 3DEXPERIENCE Add-in for quick on-the-go frequent saves.
For a larger data set or uploading in bulk, the recommendation is to use the ‘Batch Save Add-in’. With the Batch Save Add-in, you can upload and save multiple folders at the same time. The Add-in loads into SOLIDWORKS by default. The Batch Save works great for larger assembles as it comes with default asynchronous save enabled which means that you can continue to work in SOLIDWORKS as the save is happening in the background as well as start using the components already uploaded as part of a batch without waiting for the full assembly to upload.
Configuration Mapping
Solidworks configurations allow you to create multiple variations of a part or assembly model within a single document. Configurations provide a convenient way to develop and manage families of models with different dimensions, components, or other parameters. Both SOLIDWORKS Assemblies and Parts can have configurations.
For migrating data to the 3DEXPERIENCE platform, it is recommended that you update the SOLIDWORKS settings to be upgraded to the latest configuration manager that is compatible with 3DEXPERIENCE Platform.
The benefits of updating files for compatibility are:
Optimal open and save performance
Exposure to 3DEXPERIENCE platform terminology and content types within SOLIDWORKS.
Visibility of the SOLIDWORKS data model for the 3DEXPERIENCE platform.
Manual Update:
Create or open a part or assembly file and select the Update for 3DEXPERIENCE compatibility command from the FeatureManager Design Tree context menu.
Automatic Update:
Activate the Update SOLIDWORKS files for compatibility with the 3DEXPERIENCE platform system option and create or open a part or assembly file.
To update SOLIDWORKS files for compatibility with the 3DEXPERIENCE platform, click Tools > Options > System Options > 3DEXPERIENCE Integration > Update.
The following changes happen when you update the model:
Custom properties and configurations align with the 3DEXPERIENCE platform.
In the ConfigurationManager: CAD Family
In System Options, you can choose to display the new CAD Family View or both the CAD Family View and the traditional ConfigurationManager.
The Configuration Properties and Properties Summary tabs in the Properties dialog box manage custom and configuration-specific properties.
For SOLIDWORKS models that have multiple display states, the active display state is assigned to the physical product. When you insert a component into an assembly, the component uses the display state assigned to the physical product.
All configurations that represent a part number should become a physical product configuration. All configurations which are an alternate representation of a part (for example, flat pattern of a sheet metal component) should become a representation. Only one physical product should be created when more than one configuration has the same part number. The other configurations should become representations.
You can create a representation of a physical product in the ConfigurationManager: CAD Family tab. Representations share a part number with the parent physical product.
The Configuration Manager is also now optimized to work with the 3DEXPERIENCE platform and can distinguish between physical products and representations.
SOLIDWORKS Physical Product configurations are saved to the 3DEXPERIENCE platform as a physical product whereas the representations are not saved to the 3DEXPERIENCE platform. The representations are linked to the parent physical product in platform relations.
Rules for Configurations Assigned as Physical Products or Representations
SOLIDWORKS determines which configuration is the physical product based on the configuration name and the option selected for Part number displayed when used in a bill of materials in the Configuration Properties PropertyManager.
SOLIDWORKS 2023 SP3.0 and older versions:
Document Name displays as a SOLIDWORKS Representation, and automatically creates a parent Physical Product with a name that matches the Windows filename
Derived configurations with this property display as a SOLIDWORKS Representation
Configuration Name displays as a Physical Product
Derived configurations with this property display as a Physical Product
User Specified Name displays as a Physical Product
Derived configurations with this property display as a Physical Product
Link to Parent Configuration displays as a SOLIDWORKS Representation
If a configuration does not match any of the above criteria, the first configuration created in the ConfigurationManager tab becomes the physical product.
Document Name displays as a Physical Product
Derived configurations with this property display a a SOLIDWORKS Representation
Configuration Name displays as a Physical Product
Derived configurations with this property display as a Physical Product
User Specified Name displays as a Physical Product
Derived configurations with this property display as a Physical Product
Link to Parent Configuration displays as a SOLIDWORKS Representation
When you update a model that has several configurations with the same part number, SOLIDWORKS updates only one of the configurations to a physical product. The other configurations become representations.
The Part number displayed when used in a bill of materials property, for each configuration, determines how the configuration displays.
SOLIDWORKS selects the configuration to use for the physical product using the following criteria:
When a Default configuration exists, the Default configuration becomes the physical product.
When a configuration uses Configuration Name for the part number, the configuration becomes the physical product.
When configurations have the same part number, SOLIDWORKS selects a configuration based on the Part number displayed when used in a bill of materials option in the Configuration Properties PropertyManager. The order of selection is:
Configuration Name
User Specified Name
Document Name
If a configuration does not match the above criteria, the first configuration created in the ConfigurationManager tab becomes the physical product.
After you update a document for 3DEXPERIENCE compatibility, it is recommended to use the ConfigurationManager: CAD Family view.
Here is an example of what to expect when you update for compatibility:
User-Defined Update Logic- 3DEXPERIENCE Integration Rules Editor
If you have very specific use cases or company standards to follow where the system-coded update logic does not give you the desired result, the recommendation is to use the new rules editor, where you can create user-defined update logic. Unlike the system-coded update logic which applies to parts and assemblies, the 3DEXPERIENCE Integration Rules Editor allows you to define different update logic for both file types, if needed.
NOTE: This utility is only available in 3DEXPERIENCE SOLIDWORKS and Collaborative Designer for SOLIDWORKS + SOLIDWORKS 2024 SP0.1 and newer versions.
The 3DEXPERIENCE Integration Rules Editor cannot be launched separately.It must be launched from within the 3DEXPERIENCE Integration page of the SOLIDWORKS system options.
For more information on Configurations, refer to this SolidPractices Guide.
Attribute Mapping
Attributes are the common language for all platform members. Therefore, defining attributes is one of the first tasks that a platform administrator should perform when configuring their platform for first use. It is a best practice to create attributes before creating content to avoid any problems.
The recommendation is to always enable the setting for 3DEXPERIENCE Integration. This can be found under Tools > Options > System Options > 3DEXPERIENCE Integration > Update. The option optimizes the file properties for compatibility with the 3DEXPERIENCE platform.
While working with custom attributes, it is recommended that any required custom attributes are created for Physical Products and Drawings. Any Physical Product attributes mapped to SOLIDWORKS will appear on the Configuration Specific properties tab
When creating new attributes on the platform, verify that all attributes are deployed and display a green check mark before proceeding.
In case the data already exists on the platform, and you add new attributes, it is a best practice to always propagate attributes to the newly created content.
It’s also a good practice to only map Physical Product attributes from 3DEXPERIENCE to SOLIDWORKS that need to be utilized in parts, assemblies and drawings for example Notes, Drawing Title Block, Parts List etc.
Alternatively, only map SOLIDWORKS properties to 3DEXPERIENCE that are driven by SOLIDWORKS e.g. Material, Mass etc. and attributes that SOLIDWORKS users will populate in their SOLIDWORKS session
To find detailed information on how to perform Attribute Mapping, please look at the SolidPractice:Attribute Mapping for SOLIDWORKS data on the 3DEXPERIENCE Platform
Design Templates
Design templates are a great way to control standards and to help ensure consistency throughout the designs that many users create. Templates are usually tailored to company specific requirements, and can save you time during the initial setup.
For existing customers adopting 3DEXPERIENCE, storing templates in the platform allows to maintain that consistency of settings and standards, security and lower administrative overhead.
To find detailed information on how to manage and use Design Template on the 3DEXPERIENCE platform, please look at the SolidPractice: Storing SOLIDWORKS Templates on the 3DEXPERIENCE Platform
Toolbox Management
Toolbox integration with 3DEXPERIENCE provides easier access and management of Toolbox components to all the relevant SOLIDWORKS users within an organization. When you open an assembly in SOLIDWORKS that contains references to Toolbox components, or you add new Toolbox components to it, the 3DEXPERIENCE platform automatically recognizes those.
You can use the toolbox components and save the assemblies that refer to the toolbox components in 3DEXPERIENCE. Even if the other users have not installed the toolbox, they can use these components without any duplication from SOLIDWORKS. For each toolbox component, an individual physical product is created and saved in a collaborative space. The toolbox physical products are in Released maturity state.
Working with the Toolbox and PartSupply Components
It is recommended that administrators leverage their control over the 3DEXPERIENCE platform by choosing the Collaborative Space and Maturity state for Toolbox and PartSupply components during creation. They can also set a common release cycle for toolbox components saved to the platform, meaning each component can always be saved to the platform as Released to control editing and modifying content on the platform that is a level of security.
Common practice is to enable a setting under System> Options> Assemblies> Update model graphics when saving file, to ensure the model graphics for each Toolbox component is generated and viewable on the 3DEXPERIENCE Platform.
To find detailed information on how to manage and use Toolbox components on the 3DEXPERIENCE platform, please look at the SolidPractice: Working with SOLIDWORKS Toolbox on the 3DEXPERIENCE Platform
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.
