User Guide

Using the Product

Translating Interactively from within 3DEXPERIENCE

The 3DEXPERIENCE CATIA V6 to NX translator allows an opened 3DEXPERIENCE CATIA V6 part or Assembly to be exported directly to NX, and for a NX part or assembly to be imported directly into the 3DEXPERIENCE CATIA V6 application.

In order to translate from within 3DEXPERIENCE CATIA V6, the 3DEXPERIENCE CATIA V6 application must be started using a Theorem environment, so that the appropriate Theorem partner plug-ins are available. (See 3DEXPERIENCE CATIA V6 Environment files.)

3DEXPERIENCE CATIA V6 can be started from a desktop shortcut created at installation time.

3DEXPERIENCE desktop shortcuts 3DEXPERIENCE desktop shortcuts

Alternatively, it can be started via the script provided in the Translator installation located in:

<installation_directory>\bin

The script name is:

start_3DEXPERIENCE_Theorem_Multi-CAD_NXxx_CATIAV6<version>.cmd

(where xx should be substituted with the version of NX – e.g. 10, 11, 12 and 1847)

(where <version> should be substituted for the version of 3DEXPERIENCE CATIA V6 that you have installed – e.g. 2019x, 2020x, 2021x)

Theorem Interactive Conversion Settings

The 3DEXPERIENCE interface offers a number of settings to enable configuration of the Translation Process.

These are accessed through the User Preferences options (Preferences / Legacy Preferences for 2019x onwards):

../../_images/ug_p10_31.png ../../_images/ug_p10_4.png

From Preferences select <Compatibility><External Formats>

Preferences - Infrastructure > Theorem

This page sets the preferred mode of conversion (in this case Exact), and also the general options “Convert coordinate systems” and “3D Annotation”.

A dedicated page of options for ‘Infrastructure -> Theorem’ Export NX and Import NX operations is available under the ‘Infrastructure’ settings and is presented as follows:

Preferences - Infrastructure > Theorem

From this Panel, the user can select a predefined configuration, these are set from within the UI (see section UI) or Configuration Manager. You can also launch and refresh the Configuration Manager.

Theorem Export

Once 3DEXPERIENCE CATIA V6 has been started it is possible for an opened product to be exported to NX.

Export menu item

The user selects the menu item as shown here:

Export menu item

This menu action will then present the user with a Save As dialog box similar to this:

Export menu item

The “Save as types:” or “Format” selection should be set to NX_THEOREM (*.prt). The Save or OK button can now be pressed to initiate the conversion to the selected output file name and location.

NX Template File Usage

If, when a representation is read from 3DEXPERIENCE CATIA V6, no geometry is found, or a major write error occurs preventing an NX file being produced, an empty NX file (named by default template.prt) will be copied to the expected output file name. This enables the conversion process to complete successfully and maintains the expected file outputs.

This behaviour is implemented via an environment variable set in the Theorem CATEnv file e.g. %TS_INST%\B214\win_b64\CATEnv\Theorem_Multi-CAD_NX_CATIAV6R<ver>.txt file, typically as follows:

TS_NX_TEMPLATE_FILE=C:\Program_Files\Theorem\CAD_22.1_MC6NX12_WIN.01\data\ug\template.prt

The user can change the content of this NX file or the location of this file and its name as required.

Theorem Import

Once 3DEXPERIENCE CATIA V6 has been started it is possible for a model to be imported from NX.

In order to import, the user selects the following Menu Option:

../../_images/ug_p14_5.jpeg ../../_images/ug_p14_7.jpeg

This launches the Theorem Import Menu:

Imported NX data in 3DEXPERIENCE

On selecting Open or OK on the File selection Panel the NX data will be translated and imported into the 3DEXPERIENCE CATIA V6 database. It will also be opened in the user’s session.

Translating in Batch using CATUtil – PLMBatchDataExchange

The Dassault Systemes CATUTIL batch management tool can be launched with the correct Theorem enabled environment using the scripts provided in the Translator installation at:

<installation_directory>\bin\start_CATUTIL_Theorem_Multi-CAD_NX12_CATIAV6R<revision>.cmd

(where <revision> should be substituted for the version of 3DEXPERIENCE that you have installed – e.g. 2017x, 2018x or 2019x)

Batch Export to NX

Here is an example showing the appropriate settings in preparation for a database selection and an export “save” or “run”:

DataExchangePLMBatch - Export settings

Note selection of “Export” operation, usage “NX_THEOREM” and extension “prt”.

Batch Import from NX

Here is an example showing the appropriate settings in preparation for an input NX file selection and an import “save” or “run”:

Configuration Manager - 3DExperience Read

Note selection of “Import” operation, usage “NX_THEOREM” and extension “prt”.

Translating from the UI (User Interface)

For CATIA V6 there are no physical files on disk. So to run a User Interface process a job file is used instead of CAD files. This job file contains all the necessary information to locate, open and translate the V6 data. Running a translation with a job file is similar to running CADverter with file based CAD models e.g. for CATIA V5. More about the job file and its contents is described in Job Files.

CADverter allows the information that is read from the source system and written to the target system to be tailored via a set of user specified arguments. Commonly used arguments are supported via the Unified Interface, with Advanced Arguments being described within this document for use in the Unified Interface or via the Command Line invocation.

Common Options for CATIA V6 to NX

Within the Configuration Manager pane of the Unified Interface, arguments that can be specified when publishing CATIA V6 data into NX are grouped into 3 areas:

  • Read – Those arguments that affect how data is read from CATIA V6

  • Write – Those arguments that affect how the data is written to NX

  • General – Those arguments that are common to ALL Publishing activities regardless of source data

3DExperience Read Arguments

The image below shows the 3DExperience Read arguments that are available, with their default settings.

Configuration Manager - 3DExperience Read

Each of these options is described below:

Option

Description

Preferred Read Data Type

The setting options are EXACT (default) or TESSELATED.

Command Line Syntax:

  • read_tess

Read 3D Annotations

Enables PMI data read from the V5 file. (Default is OFF.)

Command Line Syntax:

  • dont_read_pmi – to turn off

  • read_pmi – to turn on

Note – When ‘read_pmi’ is enabled it also enables the ‘fill_pmi_arrows’, ‘fill_pmi_text’ and ‘pmi_filled_text’ options. These can be overridden by setting the Advanced arguments ‘dont_fill_pmi_arrows’ and/or ‘dont_fill_pmi_text’.

Read Captures

A secondary argument to ‘Read PMI’ and allows the control over whether captures are read as part of the process. Default is ON when ‘Read PMI’ is marked as ON.

Command Line Syntax:

  • read_captures – default

  • dont_read_captures – to turn off

Read NOSHOW Entities

Read any entities that are in NOSHOW. Default is to not read NOSHOW entities.

Command Line Syntax:

  • noshow

Read FTA Reference Geometry

Enables reading of FTA Reference Geometry. (Default is OFF.)

Command Line Syntax:

  • read_geometry – to turn on

Disable Points

Switches off Point processing.

Command Line Syntax:

  • disable_points

Disable Axis Systems

Switches off Axis System processing.

Command Line Syntax:

  • disable_axes

Disable Wireframe

Switches off Wireframe processing.

Command Line Syntax:

  • disable_wireframe

Disable Surfaces

Switches off Surface processing.

Command Line Syntax:

  • disable_surfaces

Disable Solids

Switches off Solids processing.

Command Line Syntax:

  • disable_solids

Read As Torus

Read Toroidal surfaces in analytical form (default is NURBS.)

Command Line Syntax:

  • read_torus

Read As Cylinder

Read Cylindrical surfaces in analytical form (default is NURBS.)

Command Line Syntax:

  • read_cylinder

Read As Cone

Read Cone surfaces in analytical form (default is NURBS.)

Command Line Syntax:

  • read_cone

Read As Conics

Read surfaces generated from a Conic in analytical form (default is NURBS.)

Command Line Syntax:

  • read_conics

Export Body Names

Maintains body names for parts that consist of multiple bodies.

Command Line Syntax:

  • body_names

NX Write Arguments

Configuration Manager - 3DExperience Read

Each of the options displayed in the image above are described below:

Option

Description

Delete Existing Sub-parts

Delete existing sub-parts. (Default is OFF.)

Command Line Syntax:

  • delete_parts

Concatenate Assembly Name

Concatenates assembly name. (Default is OFF.)

Command Line Syntax:

  • concat_assy

Produce Tessellated Output

Produce Tessellated NX file. (Default is OFF.)

Command Line Syntax:

  • tess_output

Job Files

Introduction to Command Line Processing

For CATIA V6 there are no physical files on disk. So to run a command line process a job file is used instead of CAD files.

This job file contains all the necessary information to locate, open and translate the V6 data. Running a translation with a job file is similar to running CADverter with file based CAD models e.g. for CATIA V5. More about the job file and its contents is described in Job Files.

The basic command line syntax is:

Option

Description

"<TS_INST>\bin\catia6r2020x_nx120.cmd"

Command to run

C:\parts\2020xjobs\AS1_2020x.xml

Input job file

AS1_2020xTest

NX .prt name

Where:

  • <TS_INST> is the Theorem Solutions software installation directory.

  • <input_file> is an xml file defining the access to a specific object in a specified 3DEXPERIENCE PLM database. This file provides a user Login Ticket (2019x, 2020x, 2021x), to a specified Enovia repository plus a set of 3 attribute names and values which will uniquely identify the input PLM object of the conversion.

    <?xml version="1.0" encoding="utf-8"?>
    <3dex_read>
      <!-- parameters must be in this ORDER -->
      <!-- parameters only the value passed to V6 -->
      <parameters>
        <attribute name="repository" value="PLM1"/>
        <attribute name="ServerName" value="3dspace.theorem.com"/>
        <attribute name="ServerPort" value="447"/>
        <attribute name="ServerRootURI" value="3dspace"/>
        <attribute name="LoginTicket"
          value="REEyNzM3M0Q1REM2NDgxQzlFNzk1QzIwNjZGRDYzODN8Um9iaW58Um9iaW58fHwwfA=="/>
        <attribute name="PLMType" value="VPMReference"/>
        <attribute name="ReportDirectory" value="C:\TEMP\V6Export"/>
        <attribute name="LicenseData" value="LIC"/>
        <attribute name="BatchXMLFileName" value="Default"/>
      </parameters>
      <!-- arguments both key and value are passed to V6 -->
      <arguments>
        <attribute key="PLM_ExternalID"
          value="prd-Interfix to be defined 51097330-00023109"/>
        <attribute key="V_version" value="A"/>
        <attribute key="minorrevision" value="1"/>
      </arguments>
    </3dex_read>
    
  • <output_file> is the required output NX file name.

Example:

C:\Program Files\Theorem\24.1\MC6NX12\bin\catia6r2020x_nx120.cmd C:\Temp\3dex_r2020x_inputs.xml C:\Temp\3dex_r2020x_inputs.prt

Creating a Login Ticket

Use a browser link (similar to the one below) to your 3DExperience Server:

https://3dspace.2018x.theorem.com:447/3dspace/common/emxNavigator.jsp

A page will appear in the browser.

3DEXPERIENCE login page

Login as normal, e.g.

User

Password

Select Collaboration and Approvals > Experience Configuration > Manage Login Tickets

Manage Login Tickets

Login Ticket Creation

Select the values required for your user:

User and Security Context should already be set, make sure that Ticket Type: Infinite is selected. Then click on ‘Create’.

“Create” will produce the ticket:

REEyNzM3STE1MER2NDgxQzlFNzk1QzIwNjZGNATzDAN8Um9iaW58Um9iaW58fHwwfA==

This can then be used as the ‘LoginTicket’ value in the job xml file described in Job Files.

Log File Generation

Export Process Log Files

In the process of exporting the selected 3DEXPERIENCE CATIA V6 part or assembly, the following log files are generated by the NX Export plug-in.

The process log and error messages are recorded in a .err file located in the 3DEXPERIENCE CATIA V6 CATReport directory. The file is named after the active CATIA component.

e.g. %CATReport%\model1.err

Additional log files are created in the TSC_TEMP_DIR directory. This directory is defined in the %TS_INST%\ts_env.bat file.

%TSC_TEMP_DIR%\Read_to_viewer_<input_part_name>.log

Where: <input_part_name> is the name of the input part (or the active part name in interactive usage).

This contains information describing the 3DEXPERIENCE CATIA V6 ‘data read’ processing into Theorem Intermediate data format.

%TSC_TEMP_DIR%\viewer_<part-name>_screen_output.log

Where <part-name> is the selected output file name.

This contains the screen output of the process of writing the data to NX.

%TSC_TEMP_DIR%\viewer_<part-name>.log

Where <part-name> is the selected output file name.

This contains detailed process information of the write of the data to NX.

Import Process Log Files

In the process of importing an NX file, the following log files are generated by the NX Import plug-in.

The process log and error messages are recorded in a .err file located in the 3DEXPERIENCE CATIA V6 CATReport directory. The file is named after the selected input file name. e.g. if the file Mypart.prt were selected, the log file names would be %CATReport%\Mypart.err and %CATReport%\Mypart.rpt.

%TS_TEMP_DIR%\<input_file_name>_viewer.log

%TS_TEMP_DIR%\<input_file_name>_viewer_screen_output.log

%CATReport%\<input_file_name>.err

Where <input_file_name> is the base file name of the imported file.

3DEXPERIENCE CATIA V6 Environment Files

As part of the Theorem installation process, a set of 3DEXPERIENCE CATIA V6 environment files are created which are subsequently used in the launch of 3DEXPERIENCE and CATUtil sessions to support the Theorem partner plug-ins for NX import and export.

A ‘CATEnv’ file is created for each installed version of 3DEXPERIENCE CATIA V6.

These environment files are located in:

  • <installation_directory>\B420\win_b64\CATenv\Theorem_Multi-CAD_NXxx_CATIAV6R2018x.txt

  • <installation_directory>\B421\win_b64\CATenv\Theorem_Multi-CAD_NXxx_CATIAV6R2019x.txt

  • <installation_directory>\B422\win_b64\CATenv\Theorem_Multi-CAD_NXxx_CATIAV6R2020x.txt

  • <installation_directory>\B423\win_b64\CATenv\Theorem_Multi-CAD_NXxx_CATIAV6R2021x.txt

Where xx is the NX version number.