| Rev # | Date | Description |
|---|---|---|
| 1.0 | Jun 2021 | Document created. |
| 2.0 | Jun 2022 | Modified and updated using R2022x FD02. |
| 3.0 | Apr 2023 | Modified and updated using R2023x FD02. |
| 3.1 | May 2023 | Added additional information using R2023x FD02. |
| 4.0 | Nov 2024 | Added new contents, modified existing contents, and updated using R2024x FD04. |
Note
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, resellers, 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 the 3DEXPERIENCE® platform on the cloud R2024x FD04 and SOLIDWORKS Connected Premium app. The content also applies to Design with SOLIDWORKS app, with SOLIDWORKS Premium 2024 SP04 desktop software. You can download the latest version of this document from the MySolidWorks website:
https://my.solidworks.com/support/solidpractices.
For simplicity, the 3DEXPERIENCE platform on the cloud is referred to as 3DEXPERIENCE in the subsequent sections of this document.
If you have questions or need assistance in understanding the content, then contact your designated reseller.
Your Feedback Requested
We would like to hear your feedback and 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.
Preface
Seamless deployment of Toolbox components to 3DEXPERIENCE was implemented in 3DEXPERIENCE R2021x FD04. Toolbox integration in 3DEXPERIENCE provides easier access and management of Toolbox components to all the relevant SOLIDWORKS users within an organization. To facilitate a convenient collaboration through 3DEXPERIENCE, the system enforces that a part is created for each Toolbox component size or configuration used in an assembly.
When you open an assembly in SOLIDWORKS that contains references to Toolbox components, or you add new Toolbox components to it, the Save to 3DEXPERIENCE command automatically synchronizes the Toolbox components with the existing data on 3DEXPERIENCE.
This SolidPractices document provides information about Toolbox integration in 3DEXPERIENCE, in various scenarios.
This document does not include information on setting up Toolbox for SOLIDWORKS desktop software use only. A separate SolidPractices document called ‘Setting up SOLIDWORKS Toolbox’ is available for SOLIDWORKS desktop software. You can download it also from the MySolidWorks website:
https://my.solidworks.com/support/solidpractices.
References:
User Assistance document
> Social and Collaborative > Multidiscipline Configured Product Development (Collaborative Design) > Design with SOLIDWORKS > Saving Data in 3DEXPERIENCE > Working with the Toolbox Components
> Social and Collaborative > Multidiscipline Configured Product Development (Collaborative Design) > Design with SOLIDWORKS > Saving Data in 3DEXPERIENCE > Settings in 3DEXPERIENCE Platform
> Installation and Setup > Social and Collaborative > Multidiscipline Configured Product Development (Collaborative Design) > Design with SOLIDWORKS > Configuring Attributes > Configuring Standard Libraries Management
SOLIDWORKS Connected Help document > Toolbox
> SOLIDWORKS Toolbox Overview > Installation and Configuration > Configuring Toolbox > Toolbox - 3DEXPERIENCE
> Integration of Toolbox Components in the 3DEXPERIENCE Platform
> Saving Existing Toolbox Components
> Saving New Toolbox Components
How Does Toolbox Integration Work?
Toolbox integration in 3DEXPERIENCE works with the following local settings in SOLIDWORKS software:
Activated Add-ins –
SOLIDWORKS Toolbox Library
SOLIDWORKS Toolbox Utilities
3DEXPERIENCE (for Design with SOLIDWORKS app)
Activated option –
System Options > Hole Wizard/Toolbox > Make this folder the default search location for Toolbox components.
And, it supports the following scenarios:
Save to 3DEXPERIENCE existing assemblies referencing Toolbox components.
Insert new Toolbox components in an assembly.
When you add Toolbox components to an assembly from the Design Library task pane tab, or open an assembly that includes Toolbox components, the integration automatically enforces the following with the Save to 3DEXPERIENCE command performed on the assembly:
Parts for Toolbox components are imported to a designated collaborative space.
If the Toolbox components already exist on 3DEXPERIENCE, those are retrieved and synchronized.
Maturity state of the Physical Products created from the imported Toolbox parts are set to In Work or Released, based on the ToolBox settings deployed by the platform administrator.
To designate a collaborative space other than Common Space, you must set its visibility to Public.
Toolbox components imported to 3DEXPERIENCE by one user become available for re-use by other users without any duplication, and from any connected SOLIDWORKS client computer.
Note: Toolbox integration in 3DEXPERIENCE only supports the Create Parts option that automatically generates individual parts for Toolbox configurations. This does not support managing Toolbox components as configurations.
Design with SOLIDWORKS
In the Toolbox Setup utility for SOLIDWORKS desktop software, the Create Parts option is available in the User Settings for Files. The Design with SOLIDWORKS app (Collaborative Designer for SOLIDWORKS role) uses this setting.
When you install this app, it automatically enforces the following in User Settings for Files:
Activates the Create Parts option.
Specifies the following file path in the Create parts in this folder field -
%LocalAppData%\DassaultSystemes\CATTemp\ENOUSWC\Resources\[tenant ID]\Toolbox
The app generates *.sldprt files in this folder for each of the Toolbox components integrated in 3DEXPERIENCE. For each of the *.sldprt files integrated in 3DEXPERIENCE, the app also generates the required cache files, i.e. *.v6 and *.srv.v6, in the same folder.
These cache files are hidden by default, so only visible with the relevant folder option enabled.
These cache files are essential for the Toolbox *.sldprt files to successfully integrate in 3DEXPERIENCE. More details in the Note below.
In User Settings for Files, the two other available options are not supported for Toolbox integration in 3DEXPERIENCE:
Create Configurations
Create Parts on Ctrl-Drag
Do not change User Settings to either of these two options, as it will prevent the integration and will show the following message when you use a Toolbox component:
Note: After you install the Design with SOLIDWORKS app on a computer, if you launch the app from 3DEXPERIENCE with successful connection, and then disable the 3DEXPERIENCE add-in,
any new Toolbox component you insert into an assembly will continue to be referenced from the designated directory for Create parts in this folder mentioned in section a) above.
This remains the same whether you retain the User Settings for Files to Create Parts, or change it to Create Configurations or Create Parts on Ctrl-Drag from the same SOLIDWORKS session –
New Toolbox components inserted into an assembly do not create the cache files for 3DEXPERIENCE until you save the assembly to 3DEXPERIENCE.
If you later open the assembly in SOLIDWORKS with the 3DEXPERIENCE add-in enabled (and the Create Parts option activated, for the add-in to work), and save it to 3DEXPERIENCE, the cache files for the Toolbox components get created in the designated Toolbox cache folder mentioned in section a)a) above. This successfully completes the integration of those Toolbox components in 3DEXPERIENCE.
The general recommendation is not to disable the 3DEXPERIENCE add-in or to change the Toolbox User Settings from Create Parts to any of the other two options.
SOLIDWORKS Connected
Unlike the SOLIDWORKS desktop software, the SOLIDWORKS Connected app (3DEXPERIENCE SOLIDWORKS role) does not include the options for Files in the Toolbox Setup utility. This is because only the Create Parts option is hardcoded within the app.
In the background, the Toolbox *.sldprt and 3DEXPERIENCE cache files are generated in the same designated local folder as mentioned in section a) above.
Also, unlike the SOLIDWORKS desktop software, the Add-Ins list in the SOLIDWORKS Connected app does not include the 3DEXPERIENCE add-in, as this is also hardcoded in online mode.
Platform Administrator Settings for Toolbox Components
Target Collaborative Space and Maturity State
The platform administrator can designate a Collaborative Space for Toolbox components. They can also set the initial Maturity state to either In Work or Released, for when those are uploaded to the designated Collaborative Space for the first time.
These settings are available in the ToolBox settings section of the Standard Libraries Management widget of Collaborative Spaces Configuration Center.
Out-Of-The-Box (OOTB) values for these settings are –
Collaborative Space = Common Space
State = RELEASED
As mentioned in section 2), to designate a Collaborative Space other than Common Space, you must set its visibility to Public.
The values set in ToolBox settings only affect the Toolbox components that you upload after you define those values. As an example, consider an assembly that you previously saved to 3DEXPERIENCE with Toolbox components uploaded to Common Space as Released.
Then in ToolBox settings, you defined a different Collaborative Space and set Maturity state to IN_WORK.
If you then open the assembly in SOLIDWORKS from 3DEXPERIENCE -
The previously saved Toolbox components will still be in Common Space as Released. This will still be the case even if you clear local cache for both the assembly and the Toolbox components. Any subsequent save command on the assembly will not change this.
When you insert new Toolbox components in the same assembly, only the new Toolbox components will be uploaded to the new Collaborative Space as In Work, as per your values defined in ToolBox settings.
You have the flexibility to move the previously uploaded Toolbox components from Common Space to another Collaborative Space, e.g. to the newly designated Collaborative Space in ToolBox settings.
Toolbox Resources
As a platform administrator, you can deploy a specific Toolbox library database file to all the SOLIDWORKS users accessing the same platform from different machines. This Toolbox option is available in the Resources section of the following page:
Collaborative Spaces Configuration Center > CAD Collaboration > SOLIDWORKS > Settings
To use this option, first package your desired Toolbox library database using the Toolbox Setup utility from SOLIDWORKS. You can launch the Toolbox Setup utility from System Options > Hole Wizard/Toolbox, click Configure. Or, from Design Library task pane tab, click Configure Toolbox. To package your Toolbox library database -
Go to section 6. 3DEXPERIENCE, and export the Toolbox library database as a zip file to a local folder using the Save command.
After the save is successful, click OK and close the Toolbox Setup utility.
Once the Toolbox library database zip file is ready, go back to the Resources section on the platform, and click the Browse files button for the Toolbox option to locate the zip file from your local machine.
Then click the Upload a Toolbox resource file (.zip) button to upload the file to the platform.
Once successfully uploaded, Deploy Status updates accordingly. For a successfully uploaded Toolbox library database file, 3DEXPERIENCE creates a corresponding XCADResource object type.
Important: Before you package your Toolbox library database using the Toolbox Setup utility from SOLIDWORKS, make sure to choose a compatible collaborative space in your MySession Credentials. The content of the chosen collaborative space must be visible to all the users.
By default, the Common Space collaborative space is compatible for this. If you choose a different collaborative space in your MySession Credentials, make sure to set its visibility to Public first before you package your Toolbox library database.
After successfully uploading the Toolbox library database to 3DEXPERIENCE, search for XCADResource in 3DSearch, and make sure that the corresponding object is created in a Public collaborative space.
If your Toolbox library database file uploaded to 3DEXPERIENCE creates the XCADResource object in an incompatible collaborative space, you can still correct it after the upload by performing one of the following actions:
Set the visibility of the collaborative space to Public.
Or,
Move the XCADResource object to a compatible collaborative space using a web app, e.g. Collaborative Lifecycle.
To remove a Toolbox library database file from 3DEXPERIENCE, simply delete the XCADResource object.
To deploy a currently uploaded Toolbox library database file from 3DEXPERIENCE to all the SOLIDWORKS users accessing the same platform from different machines, the platform administrator or those users do not need to manually download it. When each user launches SOLIDWORKS from the same platform, the Toolbox library database file gets automatically downloaded to the following folder location on their machine, and gets synchronized with their SOLIDWORKS installation.
%LocalAppData%\DassaultSystemes\CATTemp\ENOUSWC\Resources\[tenant ID]\ ToolboxDatabase
You also have the additional option to download a currently uploaded Toolbox library database file from 3DEXPERIENCE to your local machine, using the Download the current Toolbox resource file button.
Saving Existing Assemblies Including Toolbox Components
When you open an existing assembly referencing Toolbox components, regardless of the Toolbox User Settings originally used (applicable to SOLIDWORKS desktop software), the Create Parts option takes effect. All Toolbox components are retrieved from and created inside the designated directory for Create parts in this folder, as described in section 2).
When you perform the save to 3DEXPERIENCE command on the assembly –
New Toolbox components get saved to 3DEXPERIENCE.
Existing Toolbox components on 3DEXPERIENCE get retrieved and synchronized.
If you open the assembly without first establishing a connection to 3DEXPERIENCE, the Toolbox components will appear in MySession with the status File has not yet been saved into 3DEXPERIENCE.
After establishing a connection, when saving the assembly to 3DEXPERIENCE, the Toolbox components will appear in the Save to 3DEXPERIENCE dialog box with Not modified status, indicating that those have already been saved to the designated collaborative space. Toolbox integration in 3DEXPERIENCE establishes this status by either importing the new Toolbox components to or retrieving the existing ones from the designated collaborative space.
Those Toolbox components are now successfully saved to or synchronized with 3DEXPERIENCE, even if you cancel the Save command for the assembly from the Save to 3DEXPERIENCE dialog box.
Inserting Toolbox Components Into An Assembly
To insert Toolbox components into an assembly, activate the Toolbox add-ins and use the Design Library task pane tab to drag and drop from the Toolbox folder.
When you insert a Toolbox component into an assembly, the software performs the following actions for your chosen configuration:
If your Toolbox local cache folder, mentioned in section 2)a), is empty –
Creates a part (*.sldprt) file in the Toolbox local cache folder, for the chosen configuration. In MySession, it appears as not yet saved to 3DEXPERIENCE.
When you save the parent assembly to 3DEXPERIENCE,
Synchronizes the part file with 3DEXPERIENCE if it already exists.
Saves the part file to 3DEXPERIENCE if it is new, as per the values defined in ToolBox settings [see section 3)a)].
Creates or downloads its 3DEXPERIENCE cache files to the Toolbox local cache folder.
Updates its Status in MySession as successfully saved to 3DEXPERIENCE, even if you cancel the save command on the parent assembly.
If your Toolbox local cache folder already contains the part file for the configuration, along with its 3DEXPERIENCE cache files (from a previous save) –
Synchronizes the part file with 3DEXPERIENCE.
Updates its Status in MySession as successfully saved to 3DEXPERIENCE, even before you save the parent assembly to 3DEXPERIENCE.
Physical Product Characteristics for Toolbox Components
Maturity State
The platform administrator can change the Maturity state of existing Toolbox component Physical Products as per the Maturity Graph applied for Engineering Definition.
The platform administrator will need to have the required credentials for these. More details on this are documented in the following User Assistance topics:
Social and Collaborative > Structured Collaboration & Collaborative Content > Collaborative Lifecycle > Changing the Maturity of Objects
Installation and Setup > 3DEXPERIENCE Platform > 3DEXPERIENCE Platform Administration > 3DSpace > Collaborative Spaces Control Center > Configuring Content for the 3DEXPERIENCE Platform > Configuring Maturity Graphs.
The platform administrator can also use the Default • Administrator credentials for this.
Enterprise Item Number
You can assign Enterprise Item Numbers (EIN) to Toolbox component Physical Products that are in In Work maturity state.
to
show EIN as the Primary name for the components.
The Primary name also appears in the Component Name column of MySession.
Note: While the Component Name column in MySession follows the Primary name from assembly Tree Display, this does not affect component Physical Product title.
Delete
You can delete existing Toolbox components from a Collaborative Space.
If a Toolbox component maturity state is In Work, you can delete it as the Leader of the Collaborative Space.
If it is in Released maturity state, the platform administrator can delete it with the Default • Administrator credentials. Alternatively, they can demote the maturity state to In Work first, and then a Leader of the Collaborative Space can delete it.
More details on delete permissions with different access roles are documented in the following User Assistance topic:
3DEXPERIENCE > 3DEXPERIENCE Platform > Collaborating in 3DEXPERIENCE > Controlling Access to Content in Collaborative Spaces > Baseline Responsibilities.
Note: For Toolbox components, changing the maturity state, moving to a different Collaborative Space, or deleting those affect all the users accessing the same platform. Therefore, only a designated Toolbox administrator should perform these activities, and with caution.
Opening Toolbox Components
As mentioned in section 2), when you open an assembly referencing Toolbox components, the Toolbox component part files are either created or downloaded to the designated Toolbox cache folder, and not to your local work folder.
You can search for Toolbox components in 3DEXPERIENCE using 3DSearch. However, the Open or drag operations into an assembly, or as a part, will return the following message:
You can insert Toolbox components into an assembly only from the Design Library task pane tab, even if those are already saved to 3DEXPERIENCE.
Toolbox integration in 3DEXPERIENCE, as described in section 2), only works within an assembly environment. If you open a Toolbox component on its own as a part, using the drag operation from the Design Library task pane tab, it will open from the folder location specified for Hole Wizard and Toolbox folder in SOLIDWORKS System Options. Toolbox integration in 3DEXPERIENCE does not work with this workflow. Do not save a Toolbox component to 3DEXPERIENCE on its own as an individual part – this workflow is not supported.
Assemblies with Toolbox Components Last Saved Prior to 3DEXPERIENCE R2021x FD04
You may have existing assemblies referencing older version Toolbox components that were last saved before the 3DEXPERIENCE R2021x FD04 update was released. Simply open those assemblies in SOLIDWORKS, and save to 3DEXPERIENCE. This will automatically convert the legacy Toolbox components with successful integration in 3DEXPERIENCE. The software maintains the Where used references of the Toolbox components.
Additional Recommendations
The following setting is automatically enforced with the Design with SOLIDWORKS app installation, although it is possible to disable it after the installation:
System Options > Hole Wizard/Toolbox > Make this folder the default search location for Toolbox components.
Do not disable this option as this leads to unexpected problems for Toolbox integration in 3DEXPERIENCE.In SOLIDWORKS Connected Premium and Professional apps (that include the Toolbox add-in), this option is active and greyed out by default. You cannot disable this option in these apps.
Do not attempt to revise Toolbox components, as it is currently not supported.
It is possible to generate duplicates of Toolbox components using the Duplicate command from a relevant web app (e.g. Collaborative Lifecycle). It is also possible to open those duplicates in SOLIDWORKS from 3DEXPERIENCE, using the drag operation from 3DSearch into an assembly. Duplicates should only be generated when absolutely necessary and with extreme caution, to avoid unwanted complications with Toolbox component management.
To ensure that model graphics for each Toolbox component size is generated and viewable correctly on 3DEXPERIENCE, activate the following SOLIDWORKS option:
System Options > Assemblies > Update model graphics when saving files.
FAQs
Q.1. Is it possible to modify a Toolbox component that is already saved to 3DEXPERIENCE?
Answer: No. Once you save a Toolbox component to 3DEXPERIENCE, you can no longer save any more local modifications to it from SOLIDWORKS to 3DEXPERIENCE. This includes adding / removing / modifying configuration properties, or performing any other local commands that triggers a local modification.
Q.2. Is it possible to add PLM attributes in Configuration Properties of Toolbox components?
Answer: Yes. But, only before you save a Toolbox component to 3DEXPERIENCE for the first time. You will also need to perform Upgrade custom properties command from SOLIDWORKS Design Tree right-click menu for each of the Toolbox component parts to be PLM attribute compatible first.
Q.3. Is it possible to add or modify values for custom attributes used in Toolbox component Physical Products?
Answer: Yes. But, only using compatible web apps, e.g. Collaborative Lifecyle. The Physical Products also need to be in a correct maturity state (e.g. In Work). This is not supported from SOLIDWORKS Configuration Properties or MySession as it triggers local modifications – see Q.1. above.
Q.4. Is it possible to add PLM attributes to local Toolbox library database using the Toolbox Setup utility?
Answer: No. This will be improved in the future.
Q.5. Is it possible to apply the Auto-name setting from the platform to Toolbox components?
Answer: No. The Auto-name setting is designed to exclude the 3DEXPERIENCE objects created from SOLIDWORKS Toolbox components.
Q.6. Is it possible assign user defined titles for Toolbox components?
Answer: Yes, from the File Name: field of the Configure Component PropertyManager when you insert a new Toolbox component into an assembly. By default, the insert command (drag and drop from Design Library) populates the value in this field based on properties such as standard, specifications, type, size, length etc. You can modify this value before clicking OK.
Q.7. Can I modify the title attribute of Toolbox component Physical Products using web apps?
Answer: Yes, you can using compatible web apps, e.g. Collaborative Lifecyle. Same rules as Q.3. apply. Make sure to delete existing files from Toolbox cache folder [see section 2)a)] before opening the assemblies containing those Toolbox components from 3DEXPERIENCE.
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.
