| Rev # | Date | Description |
|---|---|---|
| 1.0 | May 2022 | Document created. |
| 1.1 | June 2024 | Updated for R2024x FD02. |
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, Partners, 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 3DEXPERIENCE platform On Cloud R2024x FD02 and SOLIDWORKS Connected 2024 SP2.0. If you have questions or need assistance in understanding the content, please get in touch with your designated Partner.
Preface
When a company creates content, it often needs to create additional information to help define that content. The additional information is typically specific to the company, and it can be an essential piece of communication between stakeholders inside and outside of the company.
This document discusses the topic within the context of two operating systems (OS) or platforms – the Windows® OS and 3DEXPERIENCE platform On Cloud, and the SOLIDWORKS 3D CAD software.
Members of an engineering department use SOLIDWORKS to create content. The additional information that they create for their content can be Windows file properties or SOLIDWORKS file properties.
Members of a company use the 3DEXPERIENCE platform On Cloud apps to create content. The additional information that they create for their content are 3DEXPERIENCE platform attributes.
Attributes are the common language for all platform members, regardless of department. Therefore, defining attributes is one of the first tasks that a platform administrator performs when configuring their platform for first use.
To ensure that the additional information is accurate in both systems, a mapping between the two systems is a requirement.
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.
Understanding File Properties
Windows File Properties
In the default installation, several Windows file properties are available for use in SOLIDWORKS files. You access these properties in the Summary tab of the Properties dialog box.
These file properties are unique to Windows and cannot be mapped to the 3DEXPERIENCE platform.
Access this dialog box from File > Properties
Windows file properties in a SOLIDWORKS file, shown in File Explorer
SOLIDWORKS File Properties
Content types
Depending on the SOLIDWORKS options available to you, you can create up to two classifications of SOLIDWORKS file properties, in three types of content.
| Custom Properties | Configuration Properties | |
|---|---|---|
| Part | X | X |
| Assembly | X | X |
| Drawing | X |
These file properties are unique to SOLIDWORKS and can be mapped to the 3DEXPERIENCE platform.
Data types
There are five types of data to choose from in a SOLIDWORKS file property:
| Type | Data |
|---|---|
| Text | Enter a string of text. |
| Date | Enter a date in the form mm/dd/yyyy. |
| Number | Enter a numerical value. |
| Yes or no | Choose Yes or No (not case-sensitive). |
| Equation | Enter an equation or a link to a file property. The result is a number. |
3DEXPERIENCE Integration
Tools > Options > System Options > 3DEXPERIENCE Integration > Update SOLIDWORKS files for compatibility with the 3DEXPERIENCE platform
The Update SOLIDWORKS files for compatibility with the 3DEXPERIENCE platform option first became available in SOLIDWORKS 2021 SP4.0 and 3DEXPERIENCE platform On Cloud R2021x FD07. It becomes available on activation of the 3DEXPERIENCE add-in.
As previously mentioned, the 3DEXPERIENCE platform has one classification for attributes, and SOLIDWORKS has two classifications. When this option is active, the two SOLIDWORKS classifications merge into a single Configuration Properties classification. The option optimizes the file properties for compatibility with the 3DEXPERIENCE platform.
For more information on the use of this option, see the SolidPractice titled, “Using SOLIDWORKS Configurations with the 3DEXPERIENCE Platform”.
Not Updated for 3DEXPERIENCE Compatibility
When the Update SOLIDWORKS files for compatibility with the 3DEXPERIENCE platform option is not active (the default specification), you create SOLIDWORKS file properties using the Custom and Configuration Properties tabs of the Properties dialog box.
SOLIDWORKS provides a list of common properties. You can use and edit this list of properties, or enter custom property names.
Updated for 3DEXPERIENCE Compatibility
When the Update SOLIDWORKS files for compatibility with the 3DEXPERIENCE platform option is active, you create SOLIDWORKS file properties using the Configuration Properties tab of the Properties dialog box.
In addition to the same list of common properties, a list of PLM Attributes is also available to use.
The list of PLM attributes first became available in SOLIDWORKS 2022 SP0.0 and 3DEXPERIENCE platform On Cloud R2022x GA. For more information about PLM attributes, refer to the topic “Assign PLM Attributes to Custom Properties” in the SOLIDWORKS online Help.
Unlike the list of common properties, you cannot edit the PLM Attributes list. However, you can add to the list by creating attributes in your platform. For more information, see “Configuring Attribute Mapping” later in this document.
Understanding Attributes
Default Attributes
Like Windows, there are several default attributes available for use in 3DEXPERIENCE platform data. These attributes are similar to the Windows file properties mentioned in section 2a. You access these attributes in various interfaces depending on the app that you use. However, a common app that displays these attributes is the ENOVIA Properties app.
The previously mentionedPLM Attributeslist includes many of these attributes, making it possible to map them to SOLIDWORKS file properties.
Custom Attributes
SOLIDWORKS allows you to create file properties for your content, and the 3DEXPERIENCE platform apps allow you to create attributes for your content. The attributes you create are known as custom attributes. Custom attributes are similar to the SOLIDWORKS file properties mentioned in section 2b.
Content types
The3DEXPERIENCE platform On Cloud environment has 270 content types for which you can create custom attributes. Of these, only the following apply to SOLIDWORKS data:
CAD Family
Physical Product
Drawing
SOLIDWORKS Data Model
As documented in the Dassault Systèmes Knowledge Base article QA00000070398, when you save SOLIDWORKS files to the 3DEXPERIENCE platform, the system converts the files into 3DEXPERIENCE platform data or content types.
For part files, the system hierarchically creates:
A CAD Family object, which represents the part file.
A Physical Product object for each configuration in the part.
A 3D Shape object for each Physical Product object.
For assembly files, the system hierarchically creates:
A CAD Family object, which represents the assembly file.
A Physical Product object for each configuration in the assembly.
An Embedded Physical Product for each virtual part.
For drawing files, the system creates a Drawing object.
Data types
There are eight types of data that you can create in a custom attribute:
| Type | Data |
|---|---|
| String | Enter a string of up to 256 characters. |
| String(16) | Enter a string of 16 characters. |
| String(40) | Enter a string of 40 characters. |
| String(80) | Enter a string of 80 characters. |
| Boolean | Choose True or False. |
| Integer | Enter a nondecimal number. |
| Real | Enter any numerical value. |
| Date | Use the calendar interface to select a date. |
Data Preparation and Planning
Only a platform administrator can add attributes.
To avoid problems and to not disrupt platform members, it is a best practice to add attributesbeforecreating content. The system alerts you to this when you attempt to add an attribute:
If you add attributesaftercreating content, then be sure to add them after working hours or when no one is creating or modifying content.
Migrating or saving legacy SOLIDWORKS files to your platform requires intimate knowledge of the file properties methodology used in those files. That knowledge, plus the knowledge of content types and data types provides the foundation to determine what attributes to create.
Be prepared to change your SOLIDWORKS file properties methodology to accommodate the requirements of the 3DEXPERIENCE platform On Cloud. You can use the Custom Properties Manager tool, available in Dassault Systèmes Knowledge Base article QA00000109506, to aide in this process. Consult your SOLIDWORKS Partner to learn more about this tool. Changes could include:
Deleting custom or configuration properties from parts and assemblies.
Copying custom properties to configuration properties.
Changing data types.
Updating or changing property templates if you use theProperty Tab BuilderandCustom Propertiestask pane to populate the SOLIDWORKS file properties.
If content already exists, then new attributes may need to be propagated and other considerations need to be known. For more information, see section 7bi.
Data Type Mapping
| Attribute Data Type | |||||||
|---|---|---|---|---|---|---|---|
| String | Boolean | Integer | Real | Real + Dimensions (Unit) | Date | ||
| File Property Data Type | Text | X | |||||
| Date | X | X | |||||
| Number | X | X | X | ||||
| Yes or no | X | X | |||||
| Equation | X | X | X | X | |||
You can map any file property to any String attribute.
The easiest way to avoid mapping problems, particularly with Date file properties is to create only String attributes.
A Yes file property value = a True attribute value. A No file property value = a False attribute value.
It is possible to map Number file properties to Integer attributes even if the file property value is not an integer. However, the recommendation is to map Number file properties to Real attributes. For example:
‘1.’ is not an integer. If this value maps to an Integer attribute, it evaluates as ‘1’.
‘1.57’ is not an integer. If this value maps to an Integer attribute, it evaluates as ‘1’. In these cases, rounding does not apply.
An Equation file property can only be mapped from SOLIDWORKS to 3DEXPERIENCE, and it is a best practice to create the mapped attribute as Read-Only.
The MKS value of the file property is used in the 3DEXPERIENCE attribute.
The only supported dimensions (unit) are length, mass, angle, or any combination of the three (like area, volume, or density).
The only supported content types are Physical Product and Drawing.
Content Type Mapping
Attribute Content Type | |||||
|---|---|---|---|---|---|
| CAD Family | Physical Product | Drawing | |||
File PropertiesContent Type | Part | Custom | X | ||
| Configuration | X | ||||
| Assembly | Custom | X | |||
| Configuration | X | ||||
| Drawing | Custom | X | |||
For parts and assemblies, custom properties map to CAD Family attributes.
For parts and assemblies, configuration properties map to Physical Product attributes.
For drawings, custom properties map to Drawing attributes.
Add Attributes
Create SOLIDWORKS File Properties as Attributes
Platform Management > Content > Collaborative Spaces Configuration Center > Attributes Management
The numbers in the following images depict the steps that you must follow to add an attribute for an object.
Only the Name parameter (7) is required. This parameter defines the name of the attribute object that is created in the database. After creating this attribute, it is impossible to change the name. If you require a different name, you must delete the attribute. You can only use alphanumeric characters and cannot use spaces. There are also several forbidden character strings. Notifications such as the following appear when you encounter a limitation:
The Title parameter added in R2021x FD06, is optional, though suggested. This parameter is a user-friendly name for the attribute object. The title can include spaces, has fewer restrictions and is the name you see in apps, such as in the ENOVIA Properties app mentioned in section 3a. You can also change this name after creation.
Details about the other optional parameters, like 6W Predicate, are outside the scope of this document.
Important
You can only specify the Default Value parameter before creating content. If you create and deploy an attribute, then create content, and then decide to add more attributes, this parameter is inactive for the additional attributes.
Repeat steps 5-8 for all content types and SOLIDWORKS file properties that you want to map. When complete, click Apply.
Do not add Revision, Revision Comment, Description, or Title attributes. These are default attributes that are automatically available for mapping.
The Reset function deletes attributes that are not yet deployed.
Before proceeding, verify that all attributes are deployed and display green check marks.
Reload Server Cache and Update Index Model
After clicking Apply to deploy your attributes, the following notification appears:
You must perform these two tasks to finalize the deployment of your attributes. The numbers in the following images depict the steps that you must follow to complete these tasks.
Platform Management > Content > Collaborative Spaces Configuration Center > Configuration Deployment > Configuration and Server Utilities
You must reload the server cache so that apps can make use of the new attributes. When you click Reload Cache, the following notification appears:
You must update the index model so that you can search for the new attributes. When you click
Update Index Model
, the following notification appears:
It takes a few minutes to complete both operations, depending on the amount of content in your platform and the number of attributes created. A notification does not appear when these operations are complete. You can consider these operations complete when you see the attributes in your content and see search results.
Propagating attributes
If content already exists in your platform and you add or edit attributes, then you might need to propagate the attributes to that content.
Platform Management > Content > Collaborative Spaces Configuration Center > Configuration Deployment > Attributes Propagation
After you click Search, if green check marks appear next to the three applicable content types, then no propagation is required.
If you need to propagate, be aware that existing attribute values may be overwritten with the default value that was defined in the attribute. In most cases, this may result in a blank value.
Configure Attribute Mapping
Platform Management > Content > Collaborative Spaces Configuration Center > CAD Collaboration > Connectors > SOLIDWORKS > Attribute Mapping
The numbers in the following images depict the steps that you must follow to configure attribute mapping.
Repeat steps 3-7 for all content types and SOLIDWORKS file properties that you want to configure.
When you map attributes bidirectionally or 3DEXPERIENCE platform > SOLIDWORKS, those attributes become available in the PLM Attributes list for selection as Configuration Properties (see section 2.b.v). This is how you edit that list.
To optimize performance and to ensure that there is a single-source-of-truth for your additional information, the recommendation is to map all, or as many attributes as possible, from SOLIDWORKS > 3DEXPERIENCE platform.
When complete, click Apply.
Once complete, you can delete, reset and recreate any attribute mappings, at any time, without affecting the attributes themselves. For example, if there is an error or performance problem when opening or saving SOLIDWORKS files to the 3DEXPERIENCE platform, the platform administrator can Reset the attribute mappings to disable them all. Afterward, platform members can retest the open or save scenario to determine if or how the attribute mappings affect things.
The default attributes Description and Title are automatically mapped for all content types. You cannot change the mapping direction for these attributes.
As mentioned earlier, the default attribute, Revision, is available automatically for mapping with each content type. You cannot change the mapping direction for this attribute.
Attribute Mapping in Use
Establish a New Connection to the 3DEXPERIENCE platform
After creating and deploying attributes and configuring the attribute mapping, you can invite uses to your platform and they can start creating content.
If you configure attribute mapping after creating content, then platform members must establish a new connection to the3DEXPERIENCE platform on their client computers to use the mapping:
Exit SOLIDWORKS.
Exit the 3DEXPERIENCE PLM Services (EdmServerV6.exe) by clicking this icon on the Windows taskbar.
Relaunch SOLIDWORKS from the Compass or from a shortcut on the desktop shortcut.
How to Edit Mapped File Properties /Attributes
SOLIDWORKS > 3DEXPERIENCE platform
Edit the file properties from the SOLIDWORKS Properties dialog box or from the MySession Properties dialog box.
3DEXPERIENCE platform > SOLIDWORKS
Edit the attribute from a dashboard app such as ENOVIA Properties or ENOVIA Bookmark Editor.
SOLIDWORKS <> 3DEXPERIENCE platform
Bi-directional attribute mapping is not recommended. If this is required, use it carefully.
Edit the file property in SOLIDWORKS or the attribute in a dashboard app.
Attribute Checks
When you save a SOLIDWORKS file to the3DEXPERINCE platform, the following attribute checks occur:
Boolean attributes must map to Yes or no file properties.
If the data type does not match, the property is ignored on save and does not propagate.
Date attributes must be map to Date file properties.
Real and Integer attributes must be map to Number file properties.
If an attribute has a defined range of Authorized Values, the file property value is checked for a match.
The length of a String attribute value must be 256 characters or less.
If the value is longer than 256 characters, the string truncates and the software adds an ellipsis to the end to satisfy the length requirement.
If any of these checks fail, a Wrong attribute value warning displays within the Save to 3DEXPERIENCE dialog box.
Example
A Boolean attribute exists and specifies bidirectional mapping.
A Print3D configuration property exists in a part file.
When attempting to save the part to the 3DEXPERIENCE platform, an Incompatible property value warning appears.
Clicking the warning returns information about how to resolve the error; change the file property data type from Text to Yes or no, and informs you that the property will not propagate.
Additional Limitations, Tips and Performance Considerations
It is a best practice for the platform administrator to verify the deployment of attributes after every 3DEXPERIENCE platform On Cloud update or upgrade.
You cannot edit or delete an attribute if it is mapped or referenced by a Maturity Graph control rule. If you attempt this, the following notification appears:
You must delete the attribute mapping to edit or delete the attribute.
Never create a revision attribute. Revision is a default attribute. If you create a duplicate revision attribute, you cannot define an Enterprise Item Number (EIN) formula and Platform Management > Content > Collaborative Spaces Configuration Center > Engineering Definition does not load.
Map3DEXPERIENCE platform > SOLIDWORKS with the default attributes or with attributes that you plan to reference in annotations.
If the Value/Text Expression value of a SOLIDWORKS file property contains a property expression such as SW-Material@@Default@@Part1.SLDPRT or \$PRP:”SW-File Name” or a dimension expression, then attribute mappings that are defined as 3DEXPERIENCE platform > SOLIDWORKS are ignored. In this scenario, the attribute mapping functions as SOLIDWORKS > 3DEXPERIENCE platform. This prevents the 3DEXPERIENCE platform from deleting property expressions unintentionally.
If you add attributes and configure attribute mapping after creating content, and that content already has SOLIDWORKS file properties, then downloading that content again to your local cache or reloading it from the server results in the default value of the attribute overwriting the value in the file property. In this scenario, to prevent overwriting the file property, you must lock the file and resave it to the 3DEXPERIENCE platform. Resaving synchronizes the file with the new attribute.
In the On Cloud environment, there is no way for a platform administrator to reindex the data on their platform. If content already exists and you add attributes, the new attributes propagate to the existing content. However, you will not be able to find content if you search for the new attributes. This is because the index data does not update. The index only updates after an On Cloud update (new Functional Delivery) or upgrade (new major release). The same is true if you delete attributes. This is the meaning behind the following warning:
Avoid mapping a large number of attributes. Doing so can severely impact the open and save times for files that have a large number of configurations. For example, the MySession app takes about 15 minutes to refresh when opening a part with 900 configurations and 45 mapped attributes. It takes about 20 seconds to open the same part with only 2 mapped attributes.
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.
