Best Practices

Introduction to XPDM
Data Exchange to/from 3DEXPERIENCE

3DS_Document_2019
© Dassault Systèmes | Confidential Information| ref.: 3DS_Document_2020

Version 1.1 - 7/11/2023

Written by: Mani CHAWLA and Suraj GALANDE

Validated by: Ronan GUILLON
Edited by: Arati DESAI

3DEXPERIENCE Platform R2021x

 Best Practices

Executive Summary
This Best Practices document starts with the basics of XPDM and later also covers
some advanced concepts of XPDM.

It demonstrates a step-by-step procedure to carry out XPDM exchanges and also

explains the various options available for XPDM exchanges. It also helps to
understand how to map the custom data model using configuration files.

This document also provides guidelines for troubleshooting and educating readers
about information and traces to provide to the Dassault Systèmes Support team
while raising a Service Request on the XPDM topic.

This Best Practices document is applicable for all releases from 3DEXPERIENCE
R2021x to 3DEXPERIENCE R2023x.

Target audience: Dassault Systèmes customers, Value-added resellers (VARs) and

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

Dassault Systèmes members in BT sales, services, and technical support who
manage customer projects.

Disclaimer: This document mainly covers Gateway-less mode and covers only
Engineering exchange scenarios.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

2
 Best Practices

Table of contents
1. Introduction to XPDM ....................................................................................................... 4
1.1. Comparison with Other Exchange Solutions ................................................................ 4
2. Client and Server Side Components ............................................................................... 4
3. Required Licenses and Access Roles ............................................................................. 5
3.1. Licenses ....................................................................................................................... 5
3.2. Access Roles ............................................................................................................... 6
4. Setting Up Mapping Context ............................................................................................ 6
5. Launching Batch Management ........................................................................................ 9
6. XPDM Import and Export ............................................................................................... 10
6.1. XPDM Export ............................................................................................................. 10
6.1.1. Export Using XPDMImportExport Batch GUI ......................................................... 10
6.1.2. Various Options in XPDM Export ........................................................................... 13

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

6.2. XPDM Import .............................................................................................................. 22
6.2.1. Import Using XPDMImportExport Batch GUI .......................................................... 23
6.2.2. Various Options in XPDM Import ............................................................................ 25
6.2.3. Determine Context of Already Imported Data ......................................................... 26
6.3. Export and Import Using Command Line ................................................................... 28
7. XPDMXML Structure ..................................................................................................... 29
8. Ownership and Maturity ................................................................................................. 32
8.1. Ownership .................................................................................................................. 32
8.2. Maturity ...................................................................................................................... 32
9. Data Model Mapping ...................................................................................................... 33
10. Troubleshooting the XPDMImportExportBatch Process ............................................ 37
11. Information to be Provided to Dassault Systèmes Support Team ............................. 37
11.1. Information Required for Replicating the Scenario ................................................. 37
11.1.1. XPDM Import ...................................................................................................... 37
11.1.2. XPDM Export ...................................................................................................... 38
11.2. Traces for Reproducible Scenario .......................................................................... 38
12. References ................................................................................................................. 39
13. Document History ....................................................................................................... 40

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

3
 Best Practices

1. Introduction to XPDM
XPDM enables the users to exchange the PLM Data between 3DEXPERIENCE
Platform and other external systems like DS Legacy System, Non-DS Systems
(PDMs,ERPs,CRMs, SCM…), and 3DEXPERIENCE. Data exchange is independent of the
system where data is created for instance, 3DEXPERIENCE platform or any external
system.

There are two types XPDM exchange:

• XPDM Export: Where PLM Data is exported from the 3DEXPERIENCE Platform
• XPDM Import: Where PLM Data is imported into the 3DEXPERIENCE Platform
Both these exchanges are carried out with the help of a XPDMXML.
XPDMXML is Dassault Systèmes proprietary neutral schema. It is an XML file containing the
PLM structure and non-CAD information.
Note: XPDM Import and Export can be done for Engineering Data and EBOM data. This
document mainly covers Engineering Data exchange.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

1.1. Comparison with Other Exchange Solutions
Below table shows a comparison of XPDM exchange solution with other exchange solutions.

To
3DEXPERIENCE
3DEXPERIENCE Power'By
V5 file based data FBDI*/XPDM XPDM
VPM V4
DS Legacy VPM V5 DBDI*/XPDM XPDM
Systems
Smarteam
From
xCAD file based data XPDM XPDM
Non-DS Systems(PDMs, ERPs,
XPDM XPDM
CRMs, SCMs,….)
3DEXPERIENCE 3DXML*/XPDM Not possible
Where * is the recommended solution

2. Client and Server Side Components

XPDM can be deployed in the following two modes:

• Gateway mode
• Gateway-less mode
This document only covers Gateway-less mode.

For information about Gateway mode, refer to the following Documentation:

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

4
 Best Practices

Installation and Setup | Install | Social and Collaborative | 3DEXPERIENCE

Open | Adapter for XPDM | Installation Roadmap

Installation and Setup | Install | Social and Collaborative | 3DEXPERIENCE

Open | Adapter for XPDM | Setting Up the Gateway Servers

Installation and Setup | Administrate | Social and Collaborative | 3DEXPERIENCE

Open | Adapter for XPDM | Gateway Server Administration

Below image shows the client and server side components for Gateway-less mode.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

On Sever side: Adapter for XPDM Foundation is required.

On Client side: MUX (External System Data User) and Import XPDMXML without
Geometrical Conversion component is required on 3DEXPERIENCE Native Client.

Note: For Power’by Import, only Import XPDMXML without Geometrical Conversion is
required and the MUX component is not required.

3. Required Licenses and Access Roles

This section explains the licenses and access roles required to carry out XPDM Exchange
Scenarios.

3.1. Licenses
The following licenses are required for XPDM exchange scenarios.

• IFW: Collaborative Business Innovator

• CSV: Collaborative Industry Innovator
• MUX: External System Data User
• EXH: Engineering Data Exchange Manager

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

5
 Best Practices

If a user has installed Import XPDMXML without Geometrical Conversion and has the
UE5 (Collaborative Designer for CATIA V5) role assigned, then the user can import
CATIAV5 data in Power’by mode without a MUX role.

3.2. Access Roles

The user requires must have a Leader or Author role to perform XPDM exchanges.

4. Setting Up Mapping Context

A Context is used to exchange data between 3DEXPERIENCE and an external system. It
enables the user to gather data into a defined set. When the user exchanges data with two
different systems, the user is recommended to use two different contexts.

When dealing with XPDM exchanges (Import or Export), setting a Context is mandatory.

Before 3DEXPERIENCE R2019x release, only one default context was provided named,
COEXISTENCE which was usable for FBDI or DBDI exchanges but not for XPDM

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

exchanges. For XPDM exchanges, user had to explicitly declare an XPDM context using the
Exchanges Management native application.

From 3DEXPERIENCE R2019x onwards, two default context named, COEXISTENCE and
XPDM are available. The XPDM Context can be used for XPDM exchanges (Import or
Export).

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

6
 Best Practices

Note: This context information is stored in an xml file named Default.xml at the following

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

location in the following Native client installation directory:

<Native-Installation-directory>\B423\win_b64\resources\xml\COEX\CONTEXT

User can also explicitly declare a new XPDM Context for exchanges as per the requirement
using the Exchanges Management native application. Perform the following steps to create
a new XPDM context.

1. Launch Exchanges Management native application.

2. Click Context Management from Coexistence tab.

3. In the Context xml section, click New. A dialog box opens that prompts the user to
confirm if the user wants to create a new XML file. Click Yes.
4. In the Context Properties section, add a Name, for example: XPDM1.
5. In the Parameter field, select Database from the drop down list.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

7
 Best Practices

6. Click […], in the connector, select XPDM and enter SiteId, for example: XPDM1. As
a standard practice, the SiteId should be the same as the context Name.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

7. Click Add and then click Save.
8. Specify a filename, for example XPDM1.xml and click Save. The user can save the
file in the default directory for context information
(<Sample_directory>\B423\win_b64\resources\xml\COEX\CONTEXT) or can
specify any other location. This will create a XML file that will have the context
information.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

8
 Best Practices

5. Launching Batch Management

XPDM Exchanges are carried out using the XPDMImportExport Batch. The
XPDMImportExport batch is launched from Batch Management.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

User can access Batch Management using any one of the following methods:

• From Windows Start Menu, user can access Batch Management under Dassault
Systemes 3DEXPERIENCE R2021x.

• From the 3DEXPERIENCE Native client toolbar, go to the Tools tab and click on the
Utility… command.

• Using the command line, run the following command.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

9
 Best Practices

<native_installation_directory>\B423\win_b64\code\bin>CATSTART.exe -run
CATUTIL -env Env -direnv <native_installation_directory>\B423\CATEnv

6. XPDM Import and Export

This section explains step-by-step procedure to carry out the XPDM import and export
scenarios. It also covers the various available options to perform the XPDM import and
export.

6.1. XPDM Export

Let us consider that the user has created a product structure as shown in the image below:

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

XPDM export can be performed using the following two methods:

• Using the XPDMImportExport batch GUI

• Using Command line (refer Section 6.3 Export and Import Using Command Line)

6.1.1. Export Using XPDMImportExport Batch GUI

Follow the steps below to perform XPDM export using the XPDMImportExport batch GUI:

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

10
 Best Practices

1. Launch the XPDMImportExport batch from Batch Management. Launch Batch

Management as explained in section 5, “Launching Batch Management”.

2. Select the Export tab.

3. In the Export Project field, select any context from the list of available mapping
context.
Note: The contexts available in the list are displayed with its SiteId (as defined
during context creation).
4. Click Advanced Options… to select the required options or as per the use-case. For
detailed information about each option, refer to section 6.1.2, “Various Options in
XPDM Export”.
5. Clear the With event bus connectivity checkbox for Gateway-less mode.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

Note: The event bus connectivity is valid only in Gateway mode.
6. In the Export file Path section, specify the Location and Name for the output
XPDMXML file.
7. Search and select the object you want to export using 3DEXPERIENCE Platform
Object Search.
8. In the Report section, specify the Report directory and Report name.
9. Click Run to start the export batch.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

11
 Best Practices

10. Monitor the progress of the export process through the Processes tab in the Batch
Monitor window (Batch Management). This tab shows the already completed and in
progress processes for the current session.

The Information column displays whether the process succeeded or failed. If the
process is successful, the Return Code will be 0, else, there will be an error code.
The below image shows that the process has been completed successfully.

A report is generated in the specified report directory.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

11. Open the report file, XPDMImportExportBatch.htm from the directory or directly
open it using the Open Main HTML Report button, as shown in the image below.

Note: Always open the report in Internet Explorer browser.

The below image shows a successful XPDM Export report.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

12
 Best Practices

The below image shows a snippet from the exported XPDMXML file.

6.1.2. Various Options in XPDM Export

As mentioned in step 4 of section 6.1.1, “Export Using XPDMImportExport batch GUI”, user
can select different options from the Advanced Options window as as required or per the
use-case. The below image shows various options that are available for XPDM export. In

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

this section each option is explained in detail.

The options labeled in the above image are explained below:

Export Scope Options

1. Filter XPDM owned objects

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

13
 Best Practices

When user selects the Filter XPDM owned objects option, objects owned by XPDM
are filtered in the structure of the selected object and filtered objects are not
exported.
When this option is selected, the product structure in the XPDMXML file contains
only 3DEXPERIENCE platform-owned objects and partial information about XPDM
owned objects that are referenced by the 3DEXPERIENCE platform-owned objects.
• XPDM owned means that the mastership is on XPDM side.
• 3DEXPERIENCE owned means the mastership is on 3DEXPERIENCE side.

Note: The UniqueID tag inside Object element in the XPDMXML file
contains locationOfControl attribute, which informs the user about the master
system or ownership of the object.
Possible values for locationOfControl are as follows:

• V6: When the object is owned by 3DEXPERIENCE platform.

• XPDM: When the object is owned by V5 or XPDM.
• Unknown: When ownership information of the object is not known.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

For example, the below image shows a product structure in which some of the
references and instances are XPDM owned and some are 3DEXPERIENCE owned.

• For objects where Reference and Instance both are owned by

3DEXPERIENCE, the exported XPDMXML contains all information about the
reference (Product) and instance (ProductInst).
In this example, Physical Product 00000144 is such object.
• For objects where Reference and Instance both are owned by XPDM, the
exported XPDMXML does not contain any information about the reference
(Product) and instance (ProductInst).
In this example, Physical Product 00000146 is such object.
• For objects where Reference is XPDM owned but instance is
3DEXPERIENCE owned, all information about instance (ProductInst) is
exported and for the reference only the External attribute is exported in
XPDMXML as shown in the image below.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

14
 Best Practices

In this example, Physical Product 00000145 and Physical Product 00000147

are such objects.
• For objects where Reference is 3DEXPERIENCE owned but instance is
XPDM owned, all information about reference (Product) is exported and for
the instance no information is exported.
In this example, Physical Product 00000148 is such object.

Below table summarizes the same:

XPDMXML (Export with Filter

Product Ownership/Mastership XPDM owned)
Reference Instance Product ProductInst
Physical Exported with all
3DEXP NA NA
Product00000143 attributes
Physical Exported with all
3DEXP 3DEXP Exported
Product00000144 attributes
Physical Exported with only

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

XPDM 3DEXP Exported
Product00000145 External
Physical NOT
XPDM XPDM NOT exported
Product00000146 exported
Physical Exported with only
XPDM 3DEXP Exported
Product00000147 External
Physical Exported with all NOT
3DEXP XPDM
Product00000148 attributes exported

2. With Documents
When the user selects this option, the documents (such as image, text ...) attached to
the selected object structure are exported.
Note: A standalone document cannot be exported.
For example:
Consider that the user has created a Physical Product and attaches a document to it
as shown in the following image.

When user selects the With Documents option, there will be entries in XPDMXML
file corresponding to the Document as shown in the image below:

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

15
 Best Practices

Apart from this, when With Documents option is used in conjunction with the With

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

Files option, a document file is also exported along with the XPDMXML file as shown
in the following image. The With Files Option is explained ahead in this section.

3. With PLMParameters
When the option With PLMParameters is selected, the PLMParameter attached to
the supported object is exported.
For example:
Consider that the user has created a Manufacturing Assembly and then inserts an
Object Parameter as shown in the image below.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

16
 Best Practices

When user exports the Manufacturing Assembly, the Parameter will export only if you
select the With Parameters option. The below image shows entries corresponding to
the Parameter in the XPDMXML file.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

4. Without Mapping
When the user selects this option, the 3DEXPERIENCE objects will export without
the mapping information for better performance.
For identifying exchanged objects, the XPDMXML file exchanged between
3DEXPERIENCE platform and XPDM contains a UniqueID element for each object,
with the following attributes.
• XID: It is the stable object identifier maintained by 3DEXPERIENCE platform
during the whole life cycle of an 3DEXPERIENCE platform object.
• External: It is the stable identifier for object exchange.

For example:
UniqueID element for 3DEXPERIENCE platform authored object:
<UniqueID External=84442098CEED0D7C05053135526064CD050712D1
XID=84442098CEED0D7C05053135526064CD050712D1 locationOfControl=V6 />

UniqueID element for XPDM authored object:

<UniqueID External=XPDM_authored_ID
XID=84442098CEED0D7C05053135526064CD050712D1 locationOfControl=XPDM
/>

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

17
 Best Practices

For more information about UniqueID, XID and External, refer to the following
Documentation:
Installation and Setup | Administrate | Social and Collaborative |
3DEXPERIENCE Open | Adapter for XPDM | Data Exchange Mechanisms |
Generic Mechanisms | Engineering Exchange | Unique Identification or Search
Criteria

The value of External attribute received from XPDM is stored by 3DEXPERIENCE

Platform in a Coexistence Context. Transferring an object from XPDM to
3DEXPERIENCE Platform and subsequently from 3DEXPERIENCE platform to
XPDM maintains the value of External.
Note: The value of External is maintained only if it is executed in the same Context.
The mapping is maintained by External attribute of UniqueID element.
When objects are exported by selecting the Without Mapping option, the External
attribute is not maintained.
The below image shows:
• When the Without Mapping option is not selected, the External attribute is
maintained.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

• When the Without Mapping option is selected, the External attribute is NOT
maintained, instead it contains the XID value.

5. With Process
When the user selects this option, the Process objects of PPR data are exported.
Note: The With Process option is enabled only for the PPR MBOM data.
For example:
User has created a manufacturing assembly and creates an implementation link with
process (Work plan system).

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

18
 Best Practices

When the Manufacturing Assembly is exported by selecting the With Process option,
the process (Workplan system) will export. The below image shows entries
corresponding to the process in the XPDMXML file.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

Completion Type

Completion type governs at what level the structure will get exported. Here, two
options are available Default and Expand.

The image below shows a Product Structure:

6. Default
When user selects the Default option, the complete Product structure will export.
With respect to the Structure shown in the above image objects at all levels will be
exported.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

19
 Best Practices

Note: By default, the Default option is selected.

7. Expand
This option is used to export the structure as per the selected expand level.
With respect to the structure shown in the above image.
• When the Expand Level is 0, then only Physical Product00000010 will
export.
• When the Expand Level is 3, then all objects except the Physical
Product00000016 will export.

Design File Options

The Design File Options govern whether the files associated with the geometry or
document objects are exported. It also controls the 3D and 2D file format. The below
image shows a Product Structure with geometry.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

8. With Files
When user selects the With Files option, the files associated with the geometry or
document objects are exported. By default, the With Files check box is selected.
When the With Files option is selected,
• User can select the 3D File Format for geometry and 2D File format for
drawings from the available list of formats.
• For 3D File Format, user can select the geometry type (Exact, Tessalated or
As Specification)

If this option is not selected then the 3D File Format and 2D File Format lists are
unavailable.

With respect to the Product structure shown in the above image, when a user selects
the With Files option, a *.CATPART file will export along with the XPDMXML file.
The *.CATPART file format will be as per the 3D File format.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

20
 Best Practices

From the 3D File Format list, select an appropriate format. Below are the available
options:
a. Exact
When user selects the Exact option, the authoring data (exact geometry) is
exported along with the XPDMXML file. While exporting, the exact geometry
is converted to a specific CAD format selected in the 3D File Format list.

Note: When the Exact option is selected, the geometry will be exported as a
dump solid. When such data is opened in CATIA V5, it cannot be
modified/edited.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

b. Tessellated
When user selects this option, the visualization data is transferred.
Visualization data is extracted from the 3DEXPERIENCE Platform database
and transferred to XPDM. While transferring, the extracted tessellated
geometry is converted to the specific format as per the selected 3D File
Format.
i. If any CATIA level like CATIAV5-6R2020 is selected, the user will get
a file in *.cgr format along with the XPDMXML file as shown in the
following image.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

21
 Best Practices

ii. If STEP is selected from the 3D File Format, the user will get a file in
*.stp format along with the XPDMXML file.

c. As Specification
When user selects the As Specification option, all 3DShapes with their
specifications are exported.
Note: When the As Specification option is selected, the *.CATPart will
export with all the specifications and features along with the XPDMXML file.
When such data is opened in CATIA V5, it can be modified/edited.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

9. Only if Modified:
The Only if Modified option can only be used in conjunction with the With Files
option.
When this option is selected, the files associated with geometry or document objects
are exported only if the object is modified after the last export.
Note: When this option is selected, the Filter XPDM owned objects check box is
unavailable.

6.2. XPDM Import

This section explains how PLM Data available in XPDMXML is imported into the
3DEXPERIENCE Platform using XPDMImportExportBatch.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

22
 Best Practices

For example: Here, a sample Data (XPDMXML file and CAT Part) is taken to import into
3DEXPERIENCE Platform, see the image below.

6.2.1. Import Using XPDMImportExport Batch GUI

Perform the following steps to import data using the XPDMImportExport batch GUI:

1. Launch the XPDMImportExport batch from Batch Management. Launch Batch

Management as explained in section 5, “Launching Batch Management”.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

2. Select the Import tab and the corresponding Import options will appear.
3. In the Import Project field, select any context from the list of available mapping
context.
Note: The contexts available in the list are displayed with its SiteId (as defined
during context creation).
4. Click Advanced Options… to select the required options or as per the use-case. For
detailed information about each option, refer to section 6.1.2, “Various Options in
XPDM Import”.
5. Using File Object Search navigate to the directory on client machine where the
XPDMXML is located and select the XPDMXML file.
6. In the Report section, specify the Report directory and Report name.
7. Click Run to start the Import batch.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

23
 Best Practices

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

8. Monitor the progress of the import process through the Processes tab in the Batch
Monitor window (Batch Management). This tab shows the already completed and in
progress processes for the current session. The Information column displays
whether the process Succeeded or failed. If the process is successful, the Return
Code will be 0, else there will be an error code. The below image shows that the
process has been completed successfully.

Report is generated in the specified report directory.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

24
 Best Practices

9. Open the report file, XPDMImportExportBatch.htm from the directory or directly

open it using the Open Main HTML Report button, as shown in the image below.

The below image shows successful XPDM import report.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

10. Once the import is successful, user can search and open the data in
3DEXPERIENCE Platform, as shown in the following image.

6.2.2. Various Options in XPDM Import

This section explains the different options available under Advanced Options and also
covers the Simulate Import option.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

25
 Best Practices

The options labeled in the above image are explained below:

1. With Geometrical conversion:

When the With geometrical conversion check box is selected, it converts the native

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

CAD files to 3DEXPERIENCE CATIA files.

2. Force Update:
Select Force update to forcefully update an already imported non-modified data
in the database.
Note: If the Force update option is selected, the Simulate Import check box is
not available and vice-versa.

3. Simulate Import:
This option is used to simulate the complete import process without saving the data
in the database.
Using this option, import can be validated without actually creating the data.

6.2.3. Determine Context of Already Imported Data

As mentioned in section 4, “Setting Up Mapping Context”, user can use multiple contexts for
exchanging data with different systems. This section helps to determine the context of
already imported data.

In the following example, the user has imported a data set with a particular context.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

26
 Best Practices

Perform the following steps to determine the context using MQL:

1. Determine the physicalid of the imported data using the below MQL command.
MQL <1> temp query bus * Name * select physicalid;

This command gives the physicalid of the object.

For example:
MQL<1> temp query bus VPMReference 2239 * select physicalid;

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

2. Determine the business id of the mapping object (CATMpgReference) associated
with the imported data by using the below MQL command:
MQL<2> temp query bus CATMpgReference * * where '
attribute[CATMpgReference.V_TargetIdentifier]~~*physicalid *' select name id;

Where physicalid is the id of the imported data obtained in step1.

This command gives the name and id of the CATMpgReference object.
For example:
MQL<3> temp query bus CATMpgReference * * where '
attribute[CATMpgReference.V_TargetIdentifier]~~*F347A18E00003C4060E6E76
90000D26A*' select name id;

3. Determine the context name using the following MQL command

MQL<4> print bus id select attribute[V_ContextName];
Where id is the business id of the CATMpgReference object obtained in step2.
This command gives the name of the context with which the data is imported.
For example:
MQL<4> print bus 37478.32579.40214.48963 select attribute[V_ContextName];

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

27
 Best Practices

The above image shows that XPDM is the name of the context with which the data is
imported.

6.3. Export and Import Using Command Line

The XPDM export and import process can also be carried out through command line by
providing a Batch Parameter file as an input.

1. Launch the XPDMImportExport batch and specify all the necessary parameters as
explained in the respective section for Export and Import using the
XPDMImportExport GUI.
For XPDM Export: Follow step 1-8 mentioned in section 6.1.1, “Export Using
XPDMImportExport GUI”.
For XPDM import: Follow step 1-6 mentioned in section 6.2.1, “Import Using
XPDMImportExport GUI”.
2. Click Save.
3. Select the directory, specify name for the batch parameter file, and click Save. This
will create a batch parameter file which will have all the information that you specified
in step 1.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

Note: When saved, this file can be edited manually and used later without accessing
the batch interface.
4. Change the current directory to bin directory of the native installation folder at cmd
prompt.
Sample path:
<Native_Installation_directory>\Dassault Systemes\B423\win_b64\code\bin
5. Execute the following command for running the XPDMImportExport Batch:
CATBatchStarter -input input_file
Where, input_file is the path and name of the batch parameter file.
For example:
CATBatchStarter -input D:\XPDMExport\BatchParameter.xml

OR
Execute the following command for running the XPDMImportExport Batch:
CATUTIL -Name XPDMImportExportBatch input_file
Where, input_file is the path and name of the batch parameter file.
For example:
CATUTIL -Name XPDMImportExportBatch
D:\XPDMExport\catutil\BatchParameter.xml

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

28
 Best Practices

6. After executing the above command,

For XPDM Export: Output XDPMXML and Report will generate in the respective
directories.
For XPDM Import: The data will get imported and a report will generate in the
Report directory.

7. XPDMXML Structure
As mentioned above in section 1, “Introduction to XPDM”, the XPDM exchanges are carried
out with the help of XPDMXML. XPDMXML is a Dassault Systèmes proprietary neutral
schema. It is an XML file containing the PLM structure and the non-CAD information.

The below image shows the general structure of an XPDMXML file.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

• XPDMXML: It is the main container for XPDMXML file. This helps to identify and
differentiate it from other XML files.
• InfoHeader: This element is present inside the XPDMXML element. It contains
information about XPDMXML in name and value pairs.
It mainly specifies information of options selected while export and other important
information like SouceObjectRef and SourceObjectExternalID.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

29
 Best Practices

• XPDMXMLStructure:
XPDM exchanges can be done for various domains like Product Domain, EBOM
Domain, Requirement Domain, and so on.
XPDMXMLStructure tag in XPDMXML file specifies the domain of the structure for
the exchange.
For example:
For Product Domain, the XPDMXMLStructure tag will be ProductStructure.
For EBOM Domain, the XPDMXMLStructure tag will be EBOMStructure.
For Requirement Domain, the XPDMXMLStructure tag will be
RequirementStructure.

• Object:
This element is present inside the XPDMXMLStructure element.
A structure is composed of various objects. This element specifies the Objects and
their associated standard and custom properties.
For example:
For ProductStructure, the objects can be Product, ProductInst, Rep3DInst,
Rep3D and Rep3DAggr.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

Under Object element, the standard attributes and custom attributes are also
specified.
a. Standard Attributes are specified by predefined tags
For example:
Name attribute: <Name> </Name>
Collaborative Space attribute: <Project> </Project>
Maturity attribute: <Maturity> </Maturity> and so on.
b. For Custom attributes, a Property tag is used as shown below:
<Property name= type= >
<Value>
</Value>
</Property>

• File:
This element describes information of physical file associated with the XPDMXML
instance file.
It contains information about the file such as Name, Location and Format.
The file is associated with an Object using <FileRef> </FileRef> tag under Object
element and id attribute of the File element.
For example:
<XPDXML>
<InfoHeader></InfoHeader>

<ProductStructure>
<Product>
<Name>TestObject </Name>
----

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

30
 Best Practices

----
<FileRef>ID_3 </FileRef>
</Product>
<File id=ID_3>
<Name>xxx</Name>
<Location>xxx</Location>
<Format>xxx</Format>
</File>
</ProductStructure>

Here, FileRef for the Product named TestObject is ID_3 so the associated File
element will be the element where id is ID_3.

The following images show an example of a Product Structure and its corresponding
XPDMXML file.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

Here,

• ProductStructure is an XPDMXMLStructure element. (Product Domain).

• Under the ProductStructure element, Product (reference of Physical Product) and
Rep3DAggr (3DShape and its instance) are Object elements.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

31
 Best Practices

• Under Objects, there are attributes/properties like Name, Description, UniqueID and
so on.
• File tag contains name, format and location of the file.

8. Ownership and Maturity

The Object element in the XPDMXML has some attributes through which the ownership and
maturity of an object is governed.

8.1. Ownership
The attributes Owner (object author), Organization and Project (Collaborative Space)
present inside the Object element of a XPDMXML file are used to set the ownership
information of an object.

Note:

• Whenever, a user imports any data in 3DEXPERIENCE using XPDM import and

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

some values are provided to these attributes in XPDMXML, ensure that the Person
(Owner), Organization and Collaborative Space (Project) already exists in
3DEXPERIENCE.
• If the attribute Owner, Organization or Project have no value in the XPDMXML file,
then the object is owned by the administrator who created the connection parameter
file or who imported the data.
• Project attribute is used to set the Collaborative space of the object. For an optimal
data exchange between an XPDM system and 3DEXPERIENCE system, it is
recommended to use a dedicated project (Collaborative space) for gathering the data
created by import. The downstream usage of imported data as reference for new
designs is easier if the import project (Collaborative space) is declared as Public.

8.2. Maturity
The attribute Maturity present inside the Object element of a XPDMXML file is used to set
the Maturity of the Object.

Note: Whenever, a user imports any data in 3DEXPERIENCE using XPDM import and some
value is provided to this attributes in XPDMXML, the attribute value should map with the
maturity state of the type.

For example:

If the object is mapped with a VPMReference type then the value for Maturity attribute as per
the OOTB policy (VPLM_SMB_Definition) will be one of the following: PRIVATE, IN_WORK,
FROZEN, RELEASED or OBSOLETE.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

32
 Best Practices

Note: Maturity value depends on the target object type and more precisely its associated
policy. Policy is declared in the Lifecycle element and the possible values for maturity are
declared in the policy used.

9. Data Model Mapping

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

XPDMXML exchange relies on the mapping between 3DEXPERIENCE Platform data model
entities and XPDMXML entities.

Mapping is done through the:

• mappingType attribute present inside Object element of the XPDMXML

• pdm-cust-config.xml file

For a particular object, mappingType attribute is present in the XPDMXML which is mapped
with MappingType attribute present in pdm-cust-config.xml. The pdm-cust-config.xml
file contains information about type mapping and attribute mapping for each MappingType.

If no mappingType is mentioned in XPDMXML, then Default mapping is applied.

For Product domain, the following table shows default mapping between 3DEXPERIENCE
platform data model entities and XPDMXML entities:

XPDMXML 3DEXPERIENCE platform data model entities

entities

Product VPMReference
ProductInst VPMInstance
Rep3D 3DShape
Rep3DInst VPMRepInstance
Rep3DAggr 3DShape + VPMRepInstance
Drawing Drawing
DrawingInst VPMRepInstance
DrawingAggr Drawing + VPMRepInstance

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

33
 Best Practices

If user has customized the Data Model on 3DEXPERIENCE side, to integrate the
customized data model in XPDM exchanges, the user has to configure mapping in the pdm-
cust-config.xml file.

The pdm-cust-config.xml is kept at the following location:

<NATIVE_Installation_Path>\win_b64\reffiles\XPG\config\client>

Below image shows a sample pdm-cust-config.xml:

• <Object> element is used to define mapping between XPDMXML entity and object
type of the 3DEXPERIENCE Platform data model.
• <attribute> element is used to define attribute mapping.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

This example explains how type mapping and attribute mapping can be acheived.
When user imports XPDM Data (Product) into 3DEXPERIENCE without mapping, the
Product object is mapped with VPMReference by default.
If you want to map Product element with any custom type it can be done through the pdm-
cust-config.xml and mappingType attribute of XPDMXML. Similarly, attributes on Product
element can be mapped with custom attributes of the custom type.

Below image shows an XPDMXML for a single Product reference.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

34
 Best Practices

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

• In the above image mappingType attribute is set to CustomMapping. The
mappingType can be any user-defined name that has the same name as specified
for MappingType in pdm-cust-confg.xml.
• Here XPDMAttr1, XPDMAttr2 and XPDMAttr3 are the custom attributes that have to
be mapped with the 3DEXPERIENCE attributes.

Refer to the following pdm-cust-config.xml file:

Where,

• XPGXMLType is a Product (Entity corresponding to XPDMXML)

• V6Type is rrrCustoPhysicalProduct (Specialized type at 3DEXPERIENCE side)
• MappingType is CustomMapping.

MappingType in pdm-cust-config.xml and mappingType in XPDMXML are the

elements that create a link between XPDMXML and pdm-cust-config.xml.
In this case, mappingType for Product Entity is CustomMapping.
Similarly, in pdm-cust-config.xml, each custom attribute in XPDMXML is specified
for XPGName and is mapped with 3DEXPERIENCE attribute by specifying the
V6Name.
XPDMAttr1 -> rrr3DXattribute1

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

35
 Best Practices

XPDMAttr2 -> rrr3DXattribute2

XPDMAttr3 -> rrr3DXattribute3

After importing XPDMXML, an object of Type rrrCustoPhysicalProduct will be

created in 3DEXPERIENCE as shown in the following image.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

Similarly, attributes are also mapped. The values mentioned for XPDMAttr1 will be
assigned to rrr3DXattribute1.

For more details on Mapping Configuration, refer to the following Documentation:

Installation and Setup | Administrate | Social and Collaborative | 3DEXPERIENCE

Open | Adapter for XPDM | Configuring The Data Model Mapping | Configuring
Engineering or Enterprise Exchange Mapping | Engineering or Enterprise Exchange
Mapping Configuration Example

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

36
 Best Practices

10. Troubleshooting the XPDMImportExportBatch

Process
As mentioned in the import and export scenarios in Section 6.1.1and 6.2.1,, report and log
files are generated for every exchange from the 3DEXPERIENCE platform to XPDM and
vice-versa.

Multiple reports and log files like XPDMImportExportBatch report, Transfer report,
XPDMXML report, CADIntrospector report and so on are generated in the specified report
directory. The XPDMImportExportBatch report gives the summary of
XPDMImportExportBatch process in an html format.

The report and log files help you to find the reason for data exchange failures.

For more details about reports and log files, refer to the following Documentation:

Installation and Setup | Administrate | Social and Collaborative | 3DEXPERIENCE

Open | Adapter for XPDM | Engineering Adapter for XPDM or Enterprise Adapter for
XPDM Administration | Report and Log Files

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

When exchange fails, an error code is displayed in the XPDMImportExportBatch report
and Processes tab of the Batch Monitor window.

The documentation explains each error code with a reason and the recommended solution.
Refer to the following Documentation for the same.

Installation and Setup | Administrate | Social and Collaborative | 3DEXPERIENCE

Open | Adapter for XPDM | Engineering Adapter for XPDM or Enterprise Adapter for
XPDM Administration | Troubleshooting the XPDMImportExportBatch Process

11. Information to be Provided to Dassault Systèmes

Support Team
Provide the following information to Dassault Systèmes Support team while raising a Service
Request (SR).

• Information required for replicating the scenario

• Traces for reproducible scenario

11.1. Information Required for Replicating the Scenario

This section provides information to be provided to the Dassault Systèmes Support team.

11.1.1. XPDM Import

Provide the following information for XPDM Import Scenario.

• Step by step scenario with a video file

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

37
 Best Practices

• XPDMXML file along with sample data (CATPart/CATProduct)

• The complete Report folder (XPDMXMLReport and TransitionEngine reports)
generated after running the scenario
• Clarify if this issue is data specific or not
• Environment variables used
• Clarify if XPDM import is done using Standard mode with Conversion (Import to
3DEXP Platform) Or PowerBy/UPS Import
• Data Model Customization packages from reproducible environment (if any)
• Provide the vocabulary / *.rdf file (if any)
• pdm-cust-config.xml file (if any)

11.1.2. XPDM Export

Provide the following information for XPDM Export Scenario.

• Step by step scenario with a video file

• Clarify if this issue is data specific or not
• Environment variables used
• The complete Report directory

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

• Details about Advanced Options selected while Export
• Source of data, whether the data is created in 3DEXPERIENCE or in XPDM System.
If data is created in XPDM System then provide the XPDMXML and data for import.

11.2. Traces for Reproducible Scenario

Traces from reproducible environment are always useful for analysis, especially in cases
where the issue is not reproducible at support side.
So, while raising a Service Request to Dassault Systèmes Support team, provide traces for
reproducible scenario.
For details about traces and trace collection methodology, refer to Knowledge Article:
QA00000070952.

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

38
 Best Practices

12. References
• Dassault Systèmes Documentation for Adapter for XPDM: Social and Collaborative >
3DEXPERIENCE Open > Adapter for XPDM
• Dassault Systèmes Administrative Documentation for Adapter for XPDM: Installation
and Setup > Administrate > Social and Collaborative > 3DEXPERIENCE Open >
Adapter for XPDM
• Developers Assistance for XPDM: Vertical Integration | XPDM

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

39
 Best Practices

13. Document History

Document Revised By Changes/Notes
Date
Revision
Mani CHAWLA
1.0 02/09/2022 Original
Suraj GALANDE
1.1 07/11/2023 KM Team Updated the
Executive
Summary for
multiple release
applicability.

© Dassault Systèmes | Confidential Information | ref.: 3DS_Document_2020

Confidential information. Copyright Dassault Systèmes [2021 - 2023].

This document is provided for information purpose only and may be used by authorized users only for their own internal use. Any other use
without prior written authorization from Dassault Systèmes is strictly prohibited, except as may be permitted by law.

40