X-CAD Design Prerequisites

This section describes how to set up your environment before running any V5 to 3DEXPERIENCE or 3DEXPERIENCE to V5 coexistence scenario.

Important: The server batch mode is fully supported for the X-CAD Design connector.

This page discusses:

Version Compatibility

This table gives a quick overview of server/client release version compatibility for X-CAD Design Coexistence and Migration.

3DEXPERIENCE X-CAD Design
3DEXPERIENCE R2017x

(using REST mode)

3DEXPERIENCE R2017x FD0+

3DEXPERIENCE R2016x FD11+

3DEXPERIENCE R2015x FD13+

3DEXPERIENCE R2018x

(using REST mode)

3DEXPERIENCE R2018x GA+

3DEXPERIENCE R2017x

3DEXPERIENCE R2016x FD11+

3DEXPERIENCE R2015x FD13+

3DEXPERIENCE R2019x

(using REST mode)

3DEXPERIENCE R2019x GA+

3DEXPERIENCE R2018x GA+

3DEXPERIENCE R2017x

3DEXPERIENCE R2016x FD11+

3DEXPERIENCE R2020x

(using REST mode)

3DEXPERIENCE R2020x GA+

3DEXPERIENCE R2019x GA+

3DEXPERIENCE R2018x GA+

3DEXPERIENCE R2017x

Note that:

  • SPx+: Fully functional for the specified level starting with SPx
  • GA+: Fully functional for the specified GA level and all subsequent releases

The REST mode is activated as of 2017x for communication between 3DEXPERIENCE and the DEC server and introduces new input in the compatibility matrix. The SOAP mode is no longer available in 3DEXPERIENCE as of 2017X. REST is not an additional mode but will be replacing the SOAP mode as of 2017x. Usage of REST communications means that the dedicated JPO (serving the SOAP mode) no longer needs to be deployed on the DEC server. However, a DEC server exposing the REST services is now required.

CT5 Server Configuration

Modifying CT5 Server configuration.

Modify CT5 LCO/GCO

Note that GCO stands for the GlobalConfig object.

  • This object collects all X-CAD Design global preferences (some of them are accessible via the Actions/Designer/GlobalPreferences menu item).
  • It should be unique in the CATIA session.
  • Its exact-type is MXCATIAV5-GlobalConfig

Note that LCO stands for "LocalConfig' Object.

  • There is one LCO per user in the database (but it may be missing if you did not override any global preference.
  • Its exact type is "MCADInteg-LocalConfig"

    Tips:

    Both objects can be queried through Matrix thick application on the server An easy way to find them is to use the Set > Find menu. Define the query by typing: *Config*. Then, right-click Properties > Attributes to access and modify attributes. Note that some attributes of the GCO and of the LCO can be edited with the X-CAD Design web client.

What

Ensure a separate checkout directory for V5 Designer and 3DEXPERIENCE to V5 Transition Engine users.

How

If the V5 Designer and 3DEXPERIENCE to V5 Transition Engine users have separate computers, a checkout folder can be specified in the GCO attribute: IEF-Pref-MCADInteg-CheckOutDirectory. Example of value: (DEFAULTVALUE)C:\temp

If the V5 Designer and 3DEXPERIENCE to V5 Transition Engine users share the same computer, a different checkout folder must be specified in each LCO attribute: MCADInteg-CheckOutDirectory. Example of value: MxCATIAV5|C:\temp

What

V5 to 3DEXPERIENCE and3DEXPERIENCE to V5 scenarios: Ensure stable relationship IDs. Make sure that the relationships get updated. For example: Not deleted then created again during modifications.

Optional: Ensure that position matrices are exposed in X-CAD Design so that assemblies can be viewed in 3DLive.

How

In GCO, check that the MCADInteg-MxToCADRelAttribMapping attribute contains the following mappings:

  • CAD SubComponent,$$id$$|assemblyComponent,mxid
  • CAD SubComponent,Reference Designator|assemblyComponent,componentID
  • Optional: CAD SubComponent,Spatial Location|assemblyComponent,relativeXform

In GCO, MCADInteg-CADToMxRelAttribMapping attribute must contain at least following value:

  • assemblyComponent,mxid|CAD SubComponent,$$id$$

  • assemblyComponent,componentID|CAD SubComponent,Reference Designator
  • Optional: assemblyComponent,relativeXform|CAD SubComponent,Spatial Location
In GCO, check that IEF-Pref-MCADInteg-CopyRelAttribOnCheckin attribute is set to the following value:
  • (ENFORCED)true
In GCO, check that IEF-Pref-MCADInteg-CopyRelAttribOnCheckout attribute is set to the following values:
  • (ENFORCED)true

What

Optional. Ensure same versioning pattern between X-CAD Design and 3DEXPERIENCE (required for V5 to 3DEXPERIENCE scenario).

How

Locate policies used by CATIA V5 data in X-CAD Design. For server versions above V6R2010, it should be: CATIA V5 Design Policy.

For older versions, it should be: Design Policy.

Policies' revision sequence example below (optional):

---,--A,--B,--C,--D,--E,--F,--G,--H,--I,--J,--K,--L,--M,--N,--O,--P,--Q,--R,--S,--T,--U,--V,--W,--X,--Y,--Z, -AA,-BB,-CC,-DD,-EE,-FF,-GG,-HH,-II,-JJ,-KK,-LL,-MM,-NN,-OO,-PP,-QQ,-RR,-SS,-TT,-UU,-VV,-WW,-XX,-YY,-ZZ, AAA,BBB,CCC,DDD,EEE,FFF,GGG,HHH,III,JJJ,KKK,LLL,MMM,NNN,OOO,PPP,QQQ,RRR,SSS,TTT,UUU,VVV,WWW,XXX,YYY,ZZZ

In case you use a different revision sequence, make sure that you make the corresponding changes in the CATIA V5 policies.

What

3DEXPERIENCE to V5: have a correct environment for Silent batch execution:

  • Check that the background checkin option is disabled in the Transition Engine LCO.

  • Deactivate the "Create Version" option in the Transition Engine LCO

How

Either:

In LCO of 3DEXPERIENCE to V5 Transition Engine user:

  • Check that MCADInteg-BackgroundCheckin is set to MxCATIAV5|false.

  • Set the MCADInteg-CreateVersionOnCheckin attribute to MxCATIAV5|false.
Or:

Login as 3DEXPERIENCE to V5 Transition Engine user then set the Actions > Designer > Preferences > MxCATIAV5 tab as follows:

X-CAD Prerequisites

These prerequisites are only applied to PRO/Engineer® and NX®. When working with Solid Works, you must replace assemblyComponent by CADSubcomponent in the How section.

What

V5 to 3DEXPERIENCE: Ensure stable relationship IDs. Make sure that the relationships get updated, i.e. not deleted then created again during modifications.

Optional: Ensure that position matrices are exposed in X-CAD Design so that assemblies can be viewed in 3DEXPERIENCE.

How

In GCO, check that MCADInteg-MxToCADRelAttribMapping attribute contains the following mappings:

  • CAD SubComponent,$$id$$|assemblyComponent,mxid
  • CAD SubComponent,Reference Designator|assemblyComponent,componentID
  • Optional: CAD SubComponent,Spatial Location|assemblyComponent,relativeXform

In GCO, MCADInteg-CADToMxRelAttribMapping attribute must contain at least following value:

  • assemblyComponent,mxid|CAD SubComponent,$$id$$

  • assemblyComponent,componentID|CAD SubComponent,Reference Designator
  • Optional: assemblyComponent,relativeXform|CAD SubComponent,Spatial Location
In GCO, check that IEF-Pref-MCADInteg-CopyRelAttribOnCheckin attribute is set to the following value:
  • (ENFORCED)true
In GCO, check that the IEF-Pref-MCADInteg-CopyRelAttribOnCheckout attribute is set to the following values:
  • (ENFORCED)true

Server Prerequisites

This section describes the server prerequisites.

What

V5 to 3DEXPERIENCE: Make sure that types are visible by Coexistence and Migration. To be able to transfer non-standard types, the default server configuration must be changed. Both major and minor types must be declared in the emxSystem.properties file.

How

  • Edit the emxSystem.properties file.
  • Find 3DLive.Domains.Designer_Central and add the type that must be visible i.e. CT4 mode.
  • Restart TomEE.

CATCGR Example

3DLive.Domains.Designer_Central = type_CADModel,type_CADDrawing,type_CATDrawing,type_CATProduct,type_CATPart,type_MCADModel,type_CatProduct,type_CatPart,type_CATIAV4Model,type_CATIAEmbeddedComponent,type_CatVersionedProduct,type_VersionedCATProduct,type_VersionedCATDrawing,type_VersionedCATPart,type_CatVersionedPart,\

type_VersionedCATIAV4Model,type_VersionedCATIAEmbeddedComponent,type_CATIACGR,type_VersionedCATIACGR