Version: 2025.10

Dassault 3DEXPERIENCE (CATIA V6 & Enovia)

Note: Users must procure and maintain valid licenses to integrate this commercial CAD tool with the Istari Digital platform. Please contact your local IT administrator for assistance.

Summary

The Dassault 3DEXPERIENCE integration provides comprehensive extraction and modification capabilities for 3DEXPERIENCE CATIA (V6) and Enovia products and assemblies, enabling bidirectional data exchange and automation workflows.

Supported File Types: 3DEXPERIENCE Products/Assemblies, 3DEXPERIENCE Parts

Connection Methods: Link (via Product Identifier with name and revision)

How and Where to Use

You can use the Dassault 3DEXPERIENCE integration through either the Istari Digital Platform UI or the Istari Digital SDK. Both methods allow you to extract data from and modify 3DEXPERIENCE CATIA models by providing product identifiers that link directly to your Enovia platform.

What You Can Do

Extract orthographic and isometric model views as images (PNG)
Generate 3D geometry files in neutral formats (STEP, IGES, STL, OBJ)
Extract user-defined parameters for digital threading
Retrieve mass properties, bounding boxes, and material information
Extract full parameter lists including system and user-defined values
Extract published elements and geometry publications
Update model parameters with new values programmatically
Execute custom VBA macros within 3DEXPERIENCE
Run preloaded macro commands from custom libraries (coming soon)

Prerequisites

Before using this integration, ensure:

Dassault 3DEXPERIENCE CATIA (V6) is installed and configured by your administrator
You have access to an Enovia platform instance
The Istari Digital Agent is installed on a bare metal Windows machine with 3DEXPERIENCE
You have access to the Istari Digital Platform UI or the Istari Digital SDK
You have the product name, major revision, and minor revision for the models you want to access
Server license configuration is properly set up (see Installation section)

API

Functions

Function	Description	Inputs	Outputs
`@istari:extract`	Extracts comprehensive model data including views, geometry, and properties	3DEXPERIENCE Product/Assembly, 3DEXPERIENCE Part	Orthographic views (PNG), Isometric view (PNG), 3D geometry (OBJ), User parameters (JSON), Parts data (JSON)
`@istari:extract_geometry`	Exports model geometry to neutral file formats	3DEXPERIENCE Product/Assembly, 3DEXPERIENCE Part, Format parameter	Geometry file (STEP, IGES3D, or STL)
`@istari:extract_parameters`	Extracts complete list of model parameters	3DEXPERIENCE Product/Assembly, 3DEXPERIENCE Part	Full parameters list (JSON)
`@istari:extract_publications`	Extracts list of published elements from the model	3DEXPERIENCE Product/Assembly, 3DEXPERIENCE Part	Publications list (JSON)
`@istari:update_parameters`	Updates model parameters with user-specified values	3DEXPERIENCE Product/Assembly, 3DEXPERIENCE Part, Parameter updates	Updated model with confirmation
`@istari:execute_macro`	Executes a custom VBA macro within 3DEXPERIENCE	3DEXPERIENCE Product/Assembly, 3DEXPERIENCE Part, Macro file	Macro execution results and any generated artifacts
`@istari:command_execute`	Executes a preloaded macro command from a custom library	3DEXPERIENCE Product/Assembly, 3DEXPERIENCE Part, Command name	Command execution results (Coming soon)

Output Examples

Output Name	Type	Description
`FrontView.png`	PNG image	Front orthographic view of the model
`BackView.png`	PNG image	Back orthographic view of the model
`LeftView.png`	PNG image	Left orthographic view of the model
`RightView.png`	PNG image	Right orthographic view of the model
`TopView.png`	PNG image	Top orthographic view of the model
`BottomView.png`	PNG image	Bottom orthographic view of the model
`IsoView.png`	PNG image	Isometric view of the model
`model.obj`	OBJ file	3D geometry in OBJ format for dynamic model viewing
`parameters.json`	JSON file	User-defined parameters extracted from the model
`parts.json`	JSON file	Mass properties, bounding box dimensions, and material information for all parts
`full_parameters.json`	JSON file	Complete list of all model parameters (system and user-defined)
`publications.json`	JSON file	List of published elements and geometry publications
`geometry.[step/igs/stl]`	Geometry	Exported geometry in the specified neutral format (from `extract_geometry` function)

Usage

Method 1: Connect

Connect to 3DEXPERIENCE models using product identifiers (name and revision). You can either connect directly via the Platform UI or upload a metadata file.

Note: 3DEXPERIENCE does not permit local saving of models. The module interfaces directly with the Enovia platform to open and save 3DEXPERIENCE models.

Using the Istari Digital Platform UI

Follow these steps to connect to 3DEXPERIENCE models using the web interface:

Navigate to the Files page.
Click the Files option in the left-hand sidebar.
Connect your 3DEXPERIENCE model.
You have two options:
- Option A: Use the Connect A Resource feature to provide the product information directly through the UI.
- Option B: Create and upload a metadata file manually with the extension .istari_3dexperience_metadata.

Option A: Connect a Resource via UI

Click the Connect button or link feature on the Files page
Select Dassault Systèmes 3DEXPERIENCE® from the available integrations
Fill in the required fields:
- Product Id: The product name in Enovia (e.g., prd00000080)
- Major: The major revision number (e.g., 1)
- Minor: The minor revision number (e.g., 1)
Click Connect to create the connection

The platform will automatically create the resource connection for you.

Option B: Upload Metadata File Manually

If you prefer to create the metadata file yourself, create a JSON file with the following structure and save it with the .istari_3dexperience_metadata extension:

{
  "name": "prd00000080",
  "major_revision": "1",
  "minor_revision": "1"
}

Then upload this file to the Istari Digital Platform as you would any other file.

After Connecting (Both Options)

Open the connected model.
Click on the 3DEXPERIENCE resource in your files list.
Navigate to the Artifacts tab.
Click the Artifacts tab to view and manage artifacts associated with this model.
Fill out the function execution form.
In the Execute Function section, provide the following information:
- Tool Name: dassault_3dexperience
- Version: Select your 3DEXPERIENCE version (e.g., 2023x, 2022x)
- Operating System: Windows 11 (3DEXPERIENCE runs on Windows only)
- Function: Select the desired function (e.g., @istari:extract, @istari:extract_geometry, @istari:extract_parameters, etc.)
- Agent: Select the appropriate agent with 3DEXPERIENCE installed
- Parameters: (Only for certain functions like extract_geometry) Provide required parameters such as output format
Run the function.
Click the Run or Execute button to start the job.
Monitor job progress.
The page will display the job status. 3DEXPERIENCE operations may take several minutes depending on model complexity.
View results.
Once the job completes successfully, the extracted artifacts will appear in the Artifacts tab.
Download or view artifacts.
Click on any artifact to view images in the browser, or download geometry files, JSON data, and other artifacts for further analysis.

Using the Istari Digital SDK

Prerequisite: Install Istari Digital SDK and initialize Istari Digital Client per instructions here

Step 1: Upload and Extract the File(s)

Create and upload the metadata file as a model

import json
from pathlib import Path

# Create the 3DEXPERIENCE metadata file with product identifier
product_metadata = {
    "name": "prd00000080",           # Product name in Enovia
    "major_revision": "1",            # Major revision number
    "minor_revision": "1"             # Minor revision number
}

# Save to a file with .istari_3dexperience_metadata extension
metadata_path = Path("prd00000080.istari_3dexperience_metadata")
with open(metadata_path, "w") as f:
    json.dump(product_metadata, f, indent=2)

# Upload the metadata file as a model
model = client.add_model(
    path=str(metadata_path),
    description="3DEXPERIENCE Product prd00000080",
    display_name="Product prd00000080 Rev 1.1",
)
print(f"Uploaded 3DEXPERIENCE metadata with model ID {model.id}")

Extract once you have the model ID

# Extract comprehensive model data (views, geometry, parameters, parts)
extraction_job = client.add_job(
    model_id=model.id,
    function="@istari:extract",
    tool_name="dassault_3dexperience",
    tool_version="2023x",              # Or: 2022x, depending on your installation
    operating_system="Windows 11",     # 3DEXPERIENCE requires Windows
)
print(f"Extraction started for model ID {model.id}, job ID: {extraction_job.id}")

# For geometry export in specific formats, use extract_geometry function:
# geometry_job = client.add_job(
#     model_id=model.id,
#     function="@istari:extract_geometry",
#     tool_name="dassault_3dexperience",
#     tool_version="2023x",
#     operating_system="Windows 11",
#     parameters={"format": "STEP"}  # Or: IGES3D, STL
# )

# For updating parameters, use update_parameters function:
# update_job = client.add_job(
#     model_id=model.id,
#     function="@istari:update_parameters",
#     tool_name="dassault_3dexperience",
#     tool_version="2023x",
#     operating_system="Windows 11",
#     parameters={
#         "parameter_updates": {
#             "Width": 100.0,
#             "Height": 50.0,
#             "Material": "Steel"
#         }
#     }
# )

Step 2: Check the Job Status

extraction_job.poll_job()

Step 3: Retrieve Results

Example

# Retrieve the model with updated artifacts
model = client.get_model(model.id)

for artifact in model.artifacts:
    output_file_path = f"c:\\3dexperience_extracts\\{artifact.name}"

    # Create directory if needed
    Path(output_file_path).parent.mkdir(parents=True, exist_ok=True)

    if artifact.extension in ["txt", "csv", "md", "json", "html"]:
        with open(output_file_path, "w", encoding="utf-8") as f:
            f.write(artifact.read_text())
        print(f"Saved text artifact: {output_file_path}")
    else:
        # Binary files (PNG images, OBJ models, STEP files, etc.)
        with open(output_file_path, "wb") as f:
            f.write(artifact.read_bytes())
        print(f"Saved binary artifact: {output_file_path}")

Notes on Output Files

View Images (PNG): Six orthographic views plus one isometric view are generated, useful for documentation, thumbnails, and visual comparison.
3D Geometry (OBJ): The OBJ file format allows for dynamic 3D visualization in web viewers and third-party tools.
Neutral Geometry Formats (STEP/IGES/STL): When using extract_geometry, you can export to industry-standard formats for interoperability with other CAD/CAE tools.
Parameters (JSON): User-defined parameters enable digital threading by connecting design values to upstream and downstream tools.
Parts Data (JSON): Includes mass properties (volume, mass, center of gravity), bounding box dimensions, and assigned materials for each part in the assembly.
Full Parameters (JSON): Contains all parameters including system-generated values, useful for comprehensive model analysis.
Publications (JSON): Lists published elements which are important for assembly constraints and references in 3DEXPERIENCE.

Installation

Prerequisites

Dassault 3DEXPERIENCE CATIA (V6) version 2022x or 2023x
Windows 10 or Windows 11 (bare metal installation, not virtualized)
Enovia platform access with appropriate credentials
Istari Digital Agent version 9.0.0 or higher installed on the same machine as 3DEXPERIENCE
Administrative access to configure registry entries and server license

Configuration

Module Version 1.3.0+: Updated Configuration

Starting with 3dexperience-module 1.3.0 and istari-agent 9.8.0+, the module uses standardized configuration variables and supports centralized configuration via istari_digital_config.yaml.

Centralized Configuration (Recommended)

The Istari Agent is configured via the file istari_digital_config.yaml. The Agent expects the file to be located at:

%LOCALAPPDATA%\istari_digital\ on Windows
~/.config/istari_digital/ on RHEL/Ubuntu

Configure the 3DEXPERIENCE module using the istari_digital_agent_module_configurations section. The agent will pass this centralized configuration to the module:

agent:
  istari_digital_agent_module_configurations:
    "@istari:dassault_3dexperience":
      "dassault_3dexperience_install_dir": "C:\\Program Files\\Dassault Systemes\\B428" # optional
      "dassault_3dexperience_product_attr_name": "PLM_ExternalID" # optional

Click to expand legacy configuration instructions

Legacy Configuration (module_config.json)

For backward compatibility with older module versions, you can use the legacy module_config.json file located at {istari_agent_dir}\istari_modules\dassault_3dexperience\resources\module_config.json:

{
  "dassault_3dexperience_install_dir": "C:\\Program Files\\Dassault Systemes\\B428",
  "dassault_3dexperience_product_attr_name": "PLM_ExternalID"
}

Deprecated Configuration Variables

The old configuration variables (dassault_install_dir, product_attr_name) are deprecated as of version 1.3.0. While they remain supported for backward compatibility, use the new standardized variable names (dassault_3dexperience_install_dir, dassault_3dexperience_product_attr_name) for all new installations.

Configuration Parameters

Parameter	Type	Required	Description
`dassault_3dexperience_install_dir`	String	Optional	Sets the installation path of the 3DEXPERIENCE thick client to use. Useful when multiple versions of 3DEXPERIENCE are installed on the same system.
`dassault_3dexperience_product_attr_name`	String	Optional	The attribute name associated with product identifiers used to locate products in Enovia. Default: `PLM_ExternalID` (out-of-the-box installation value).

License Configuration

The 3DEXPERIENCE module requires a server license to perform operations that interface with Enovia. Follow these steps to configure the server license:

Locate the CATUTIL batch utility provided by Dassault. It is typically found at:
```
<3DExperience_Install_Path>\win_b64\code\CATUTIL.exe
```
Replace <3DExperience_Install_Path> with your actual installation path.
Run CATUTIL.exe and start the CAT3DExpBatch tool.
Save the server license configuration:
- Double-click the CAT3DExpBatch tool
- Click the Save button
- Save the configuration as ServerLicense.xml in the module installation directory:
```
{istari_agent_dir}\istari_modules\dassault_3dexperience\resources\ServerLicense.xml
```
Verify the license file is readable by the Istari Digital Agent service account.

Registry Configuration

If a 3DEXPERIENCE session is not running when jobs are submitted, the module will start a session automatically. To enable this, you must configure registry entries:

Locate the CATIA CLSID by checking the registry entry:
```
HKEY_CLASSES_ROOT\CATIA.Application\CLSID
```
Update the LocalServer32 entry at:
```
HKEY_CLASSES_ROOT\CLSID\<CATIA_CLSID>\LocalServer32
```
where <CATIA_CLSID> is the class ID found in step 1.
Add required command-line flags to the command line value in the registry key. (Note: Specific flags to be documented based on your Dassault support recommendations)

Module Execution Modes

The module can operate in two modes:

Standalone Mode: If 3DEXPERIENCE is not running when the job starts, the module launches a session, executes functions, and closes the session when complete.
Attached Mode: If 3DEXPERIENCE is already running, the module uses the existing session and leaves it open after execution. Note that models opened during function execution will be closed by the module.

Versions

Current Module Version: 1.3.0

The latest version introduces standardized configuration variables and improved compatibility with the centralized agent configuration system.

Compatibility Notes

Agent Version: Requires Istari Digital Agent version 9.8.0 or higher (for centralized configuration support)
3DEXPERIENCE Versions: Tested with 2023x and 2022x; designed to be generally version-agnostic
Operating Systems: Windows 10, Windows 11 (bare metal installation required; VM not supported)
Enovia: Requires connectivity to Enovia platform for model access
Python Version: Not applicable (compiled module)

Changelog

Module Version 1.3.0

Release Date: September 2024

Changes:

Introduced standardized configuration variables (dassault_3dexperience_install_dir, dassault_3dexperience_product_attr_name)
Added support for centralized configuration via istari_digital_agent_module_configurations in istari_digital_config.yaml
Deprecated legacy configuration variable names for future removal
Maintained backward compatibility with legacy module_config.json configuration
Improved error messaging for configuration issues

Module Version 1.2.0

Release Date: June 2024

Changes:

Added @istari:extract_publications function to extract published elements
Enhanced parameter extraction to include system-generated parameters
Improved error handling for Enovia connectivity issues
Fixed geometry export issues with large assemblies

Module Version 1.1.0

Release Date: March 2024

Changes:

Added @istari:extract_geometry function with support for STEP, IGES3D, and STL formats
Added @istari:update_parameters function for bidirectional data flow
Added @istari:execute_macro function for VBA macro execution
Improved performance for large assembly extraction
Enhanced material property extraction

Module Version 1.0.0

Release Date: December 2023

Initial Release Features:

@istari:extract function for comprehensive model data extraction
@istari:extract_parameters function for parameter extraction
Orthographic and isometric view generation
OBJ geometry export
User-defined parameter extraction
Mass properties and bounding box extraction
Server license configuration support

Release Notes

Key Changes Between Versions

Version 1.3.0 (September 2024):

Configuration system modernized with centralized YAML support
Standardized configuration variable names for consistency with other Istari modules
Maintains full backward compatibility with existing installations

Version 1.2.0 (June 2024):

Enhanced extraction capabilities with publications support
Improved robustness for Enovia platform interactions

Version 1.1.0 (March 2024):

Major feature expansion with geometry export and parameter update functions
Added automation capabilities via macro execution
Significant performance improvements for complex assemblies

Version 1.0.0 (December 2023):

Initial production release with core extraction functionality
Established foundation for 3DEXPERIENCE integration workflows

Troubleshooting

Common Issues

Issue: Server License Configuration Failed

Symptom: Error messages indicating "Server license not found" or "Failed to connect to Enovia"
Cause: Missing or incorrectly configured ServerLicense.xml file
Solution:
1. Verify ServerLicense.xml exists in {istari_agent_dir}\istari_modules\dassault_3dexperience\resources\
2. Generate a new license file using CATUTIL.exe following the License Configuration steps above
3. Ensure the file is readable by the Istari Digital Agent service account
4. Restart the Istari Digital Agent service
5. Check the module logs for specific license-related errors

Issue: Product Not Found in Enovia

Symptom: Error messages indicating "Product not found" or "Cannot locate product in Enovia"
Cause: Incorrect product name, revision numbers, or product attribute configuration
Solution:
1. Verify the product name and revision numbers in your metadata file match exactly what's in Enovia
2. Check the dassault_3dexperience_product_attr_name configuration parameter
3. Confirm the product attribute name matches your Enovia configuration (default: PLM_ExternalID)
4. Verify network connectivity from the agent machine to the Enovia platform
5. Ensure you have permission to access the product in Enovia

Issue: 3DEXPERIENCE Won't Start or Hangs

Symptom: Jobs time out, 3DEXPERIENCE process doesn't start, or hangs during execution
Cause: Registry misconfiguration, missing command-line flags, or corrupted 3DEXPERIENCE installation
Solution:
1. Verify registry entries are correctly configured (see Registry Configuration section)
2. Test launching 3DEXPERIENCE manually from the command line to verify it works
3. Check Windows Event Viewer for application errors related to 3DEXPERIENCE
4. Ensure no other 3DEXPERIENCE sessions are stuck or hung (check Task Manager)
5. Restart the machine to clear any COM registration issues
6. Verify 3DEXPERIENCE installation is up to date with latest Dassault patches

Issue: Missing Artifacts or Incomplete Data

Symptom: Expected artifacts are missing (e.g., parameters.json, parts.json) or contain empty/incomplete data
Cause: Source model doesn't contain required data, or extraction failed for specific components
Solution:
1. For missing parameters.json: Verify user-defined parameters are defined in the source model. Refer to 3DEXPERIENCE documentation for creating parameters.
2. For missing parts.json: Check that materials are properly assigned in the source model
3. For missing views: Ensure the model geometry is not corrupted and can be displayed in 3DEXPERIENCE
4. Review module logs for specific error messages about failed extraction steps
5. Try opening the model manually in 3DEXPERIENCE to verify it loads correctly

Issue: Macro Execution Fails

Symptom: @istari:execute_macro function fails or produces unexpected results
Cause: Macro contains UI elements, references local resources, or isn't prepared for remote execution
Solution:
1. Ensure your macro does not display any UI elements (message boxes, dialog boxes, windows)
2. Remove or modify any code that requires user interaction
3. Update any hardcoded file paths to use relative paths or parameters
4. Test the macro in 3DEXPERIENCE manually first to verify it works
5. Add error handling and logging to your macro to help diagnose issues
6. Check module logs for VBA error messages and line numbers

Issue: Module Not Found or Won't Execute

Symptom: Error messages indicating the module cannot be found or executed
Cause: Module not installed correctly, wrong agent version, or configuration issues
Solution:
1. Verify Istari Digital Agent version is 9.8.0 or higher
2. Check that the 3DEXPERIENCE module is installed in the correct agent modules directory
3. Verify 3DEXPERIENCE is installed on the same machine as the agent (bare metal, not VM)
4. Restart the Istari Digital Agent service
5. Review agent logs for specific error messages
6. Contact your administrator to verify the module installation

Issue: Configuration Not Being Applied

Symptom: Module doesn't use configured installation directory or product attribute name
Cause: Configuration file not in the correct location, syntax errors, or using deprecated variable names
Solution:
1. Verify istari_digital_config.yaml is in the correct location (%LOCALAPPDATA%\istari_digital\ on Windows)
2. Check YAML syntax is correct (proper indentation, no tabs, correct nesting)
3. Use the new standardized variable names (dassault_3dexperience_install_dir not dassault_install_dir)
4. Restart the Istari Digital Agent after configuration changes
5. Check agent logs to confirm configuration is being loaded
6. Test with the centralized configuration approach rather than legacy module_config.json

Getting Help

If you continue to experience issues:

Check the module log files for detailed error messages
Review the Istari Digital Agent logs for additional context
Verify 3DEXPERIENCE can be launched and operated manually on the agent machine
Consult the main troubleshooting guide for general agent and connectivity issues
Contact Istari Digital support with:
- Module version (1.3.0)
- Agent version
- 3DEXPERIENCE version (e.g., 2023x, 2022x)
- Operating system and Windows version
- Error messages from module logs and agent logs
- Configuration file contents (redact sensitive information)
- Steps to reproduce the issue
- Screenshots of errors if applicable

For general agent and software troubleshooting, refer to the main troubleshooting page.

Tips and Best Practices

Optimal Model Preparation

User-Defined Parameters: Create user-defined parameters in your 3DEXPERIENCE models for effective digital threading. These parameters allow you to:

Connect design values to upstream requirements and analyses
Enable bidirectional data flow with downstream simulation tools
Track design changes across your digital thread
Automate parameter updates via the @istari:update_parameters function

Material Assignments: Properly define materials in your 3DEXPERIENCE models to ensure accurate extraction of:

Mass properties (volume, mass, density)
Material names and specifications
Physical properties for downstream analysis tools

Geometry Publications: Use 3DEXPERIENCE publications to:

Define key interfaces and reference geometry
Enable proper assembly constraints
Facilitate geometry reuse across products
Extract specific published elements via @istari:extract_publications

Macro Development Best Practices

When creating VBA macros for execution via @istari:execute_macro:

No UI Elements: Remove all message boxes, dialog boxes, input boxes, and form displays. The module runs in an automated environment without user interaction capability.

Path Management: Use relative paths or accept paths as parameters rather than hardcoding local file paths. Example:

' Good: Accept path as parameter
Function ProcessModel(modelPath As String)
    ' Process using modelPath
End Function

' Bad: Hardcoded path
Const FilePath = "C:\Users\JohnDoe\Desktop\model.CATPart"

Error Handling: Include robust error handling to provide meaningful error messages:

On Error GoTo ErrorHandler
' Your code here
Exit Sub
ErrorHandler:
    Debug.Print "Error: " & Err.Description

Logging: Use Debug.Print statements to log progress and debugging information, which will appear in module logs.
Testing: Always test macros manually in 3DEXPERIENCE before using them with the module to ensure they work correctly.

Performance Optimization

Batch Operations: When extracting data from multiple products, organize them into batches and process systematically to optimize resource usage.
Large Assemblies: For very large assemblies, consider extracting individual components first before processing the full assembly.
Concurrent Jobs: The agent can handle multiple jobs, but 3DEXPERIENCE itself may have resource limitations. Monitor system resources (CPU, memory) during execution.
Network Latency: Extraction speed depends on network connectivity to the Enovia platform. Ensure stable, high-bandwidth connections for optimal performance.

Workflow Integration

Digital Thread: Use extracted parameters to connect 3DEXPERIENCE models to other tools in your digital engineering ecosystem (requirements tools, simulation, PLM systems).
Change Management: Extract model data at key milestones to track design evolution over time.
Automation: Use the SDK to create automated workflows that respond to design changes, run analyses, and update models programmatically.
Geometry Exchange: Use extract_geometry with appropriate formats (STEP for precise geometry, STL for meshing, IGES for legacy tool compatibility) based on downstream tool requirements.

Security Considerations

Server License: Protect the ServerLicense.xml file with appropriate file permissions to prevent unauthorized access.
Configuration Security: Ensure istari_digital_config.yaml has restricted permissions (readable only by the agent service account).
Enovia Access: Use service accounts with minimal necessary permissions for Enovia access rather than personal accounts.
Audit Trail: Monitor agent logs and 3DEXPERIENCE logs to track model access and modifications for compliance and security auditing.

FAQ

Why does 3DEXPERIENCE need to be on a bare metal machine?
- 3DEXPERIENCE uses hardware-locked licensing and COM interfaces that may not function correctly in virtualized environments. Dassault Systèmes recommends bare metal installations for production use.
Can I use this module with 3DEXPERIENCE CATIA V5?
- No, this module is specifically for 3DEXPERIENCE CATIA V6 and Enovia. For CATIA V5, use the separate Dassault CATIA V5 integration.
What's the difference between @istari:extract_parameters and the parameters in @istari:extract?
- @istari:extract returns only user-defined parameters in parameters.json. @istari:extract_parameters returns all parameters including system-generated ones in full_parameters.json, useful for comprehensive model analysis.
Can I extract models without Enovia?
- No, the 3DEXPERIENCE module requires Enovia platform connectivity because 3DEXPERIENCE models cannot be saved locally. The module interfaces directly with Enovia to access and modify models.
How do I find the product attribute name for my Enovia installation?
- In an out-of-the-box Enovia installation, the attribute name is PLM_ExternalID. If your organization has customized Enovia, consult your PLM administrator to determine the correct attribute name used for product identifiers.
What happens if a 3DEXPERIENCE session is already open?
- The module will use the existing session and leave it open after job completion. However, it will close any models it opened during execution. This allows you to continue working in 3DEXPERIENCE while the module operates.
Can I run multiple extraction jobs simultaneously?
- Yes, but each job will queue if 3DEXPERIENCE is busy. COM automation typically allows only one operation at a time per application instance. Consider using multiple agent machines for parallel processing of different models.
Why are my parameter updates not being saved?
- Ensure your Enovia account has write permissions for the product. Also verify the parameters you're updating actually exist in the model and are not read-only or computed parameters.
What geometry formats should I use for different downstream tools?
- Use STEP for precise CAD interoperability and highest geometric accuracy. Use IGES for legacy tools that don't support STEP. Use STL for meshing and 3D printing applications. Use OBJ (from @istari:extract) for visualization and web-based 3D viewers.

Summary​

How and Where to Use​

What You Can Do​

Prerequisites​

API​

Functions​

Output Examples​

Usage​

Method 1: Connect​

Using the Istari Digital Platform UI​

Option A: Connect a Resource via UI​

Option B: Upload Metadata File Manually​

After Connecting (Both Options)​

Using the Istari Digital SDK​

Prerequisite: Install Istari Digital SDK and initialize Istari Digital Client per instructions here​

Step 1: Upload and Extract the File(s)​

Create and upload the metadata file as a model​

Extract once you have the model ID​

Step 2: Check the Job Status​

Step 3: Retrieve Results​

Example​

Notes on Output Files​

Installation​

Prerequisites​

Configuration​

Centralized Configuration (Recommended)​

Legacy Configuration (module_config.json)​

Configuration Parameters​

License Configuration​

Registry Configuration​

Module Execution Modes​

Versions​

Current Module Version: 1.3.0​

Compatibility Notes​

Changelog​

Module Version 1.3.0​

Module Version 1.2.0​

Module Version 1.1.0​

Module Version 1.0.0​

Release Notes​

Key Changes Between Versions​

Troubleshooting​

Common Issues​

Getting Help​

Tips and Best Practices​

Optimal Model Preparation​

Macro Development Best Practices​

Performance Optimization​

Workflow Integration​

Security Considerations​

FAQ​

Summary

How and Where to Use

What You Can Do

Prerequisites

API

Functions

Output Examples

Usage

Method 1: Connect

Using the Istari Digital Platform UI

Option A: Connect a Resource via UI

Option B: Upload Metadata File Manually

After Connecting (Both Options)

Using the Istari Digital SDK

Prerequisite: Install Istari Digital SDK and initialize Istari Digital Client per instructions here

Step 1: Upload and Extract the File(s)

Create and upload the metadata file as a model

Extract once you have the model ID

Step 2: Check the Job Status

Step 3: Retrieve Results

Example

Notes on Output Files

Installation

Prerequisites

Configuration

Centralized Configuration (Recommended)

Legacy Configuration (module_config.json)

Configuration Parameters

License Configuration

Registry Configuration

Module Execution Modes

Versions

Current Module Version: 1.3.0

Compatibility Notes

Changelog

Module Version 1.3.0

Module Version 1.2.0

Module Version 1.1.0

Module Version 1.0.0

Release Notes

Key Changes Between Versions

Troubleshooting

Common Issues

Getting Help

Tips and Best Practices

Optimal Model Preparation

Macro Development Best Practices

Performance Optimization

Workflow Integration

Security Considerations

FAQ