Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Follow the steps in this section to gather jar files to connect and communicate with Windchill. These steps require Administrator access to the organization's Windchill server and Administrator write-access to the MagicDraw and Syndeia folders of the user's workstation.

Info
title

Windchill Server Versions

The following information was verified for
  • This guide is for users of PTC Windchill versions 10.1, 10.2, 11.0, and 12.1.

Although the same jars might work for later versions, you may have to find additional ones and you may have to update the shown ones to those found on your current Windchill server.
    • If you are using a different version of Windchill, contact us at Intercax.com/Help

  • Windchill 12 jars require Java 11 and

have been confirmed to work for
  • can be used with MagicDraw/Cameo 2021x Refresh2 Hotfix 1

and later
  • , 2022x which

also requires
  • use Java 11

. However, they will not work with MagicDraw 19.0 which requires
  • and 2024x which uses Java 17.

  • Windchill 12 jars cannot be used with MagicDraw/Cameo 19.0 - because that application uses Java 8.

Choose the one section below based on your organization’s combination of Windchill and Cameo/MagicDraw

Table of Contents
maxLevel2
minLevel2
include
outlinefalse
indent60px
exclude
stylenone
typelist
printabletrue
class

Installing Windchill Jars for Windchill 10.1, 10.2, and 11 with Cameo/MagicDraw before 2022x

These steps are appropriate for Windchill and Cameo that are run with Java 8.

  1. Create a local folder named libWC to collect all jar files needed for Windchill.

...

  1. Locate and gather from your Windchill server, 2 sets of jar files

...

  1. and copy these into

...

  1. the libWC folder.
    Set 1

  2. Go to the

...

  1. this folder on your Windchill server: <Your Windchill Installation>\Windchill\ieconnector

...

    1. e.g. D:\ptc\Windchill\ieconnector.

  1. Locate and copy the ie.rar file to a separate temporary location

  2. Unzip the ie.rar file at this temporary location.

  3. Copy

...

  1. these 5 jar files from the unzipped folder to

...

  1. your libWC folder

...

  1. :

    • ie-ra-client.jar

    • webservices-api.jar

    • webservices-extra.jar

    • webservices-extra-api.jar

    • webservices-rt.jar

...

  1. Set 2

  2. Go to

...

  1. this folder on your Windchill server: <Your Windchill Installation>\Windchill\codebase\WEB-INF\lib

...

    1. e.g. D:\ptc\Windchill\codebase\WEB-INF\lib

  1. Copy

...

  1. these 3 jar files to the libWC folder.

    • ie3rdpartylibs.jar

    • ieWeb.jar

    • wncWeb.jar

  2. Now,

...

  1. your libWC folder must have 8, and only 8, jar files—5 from Set 1 and 3 from Set 2. Assure it has no other jars.

  2. For each workstation that will be running MagicDraw and Syndeia

    1. Complete the section "Library Installation for specific Repositories" in the Install Syndeia plugin guide

...

Additional Steps for Windchill 12 libs and MagicDraw 2021x Refresh2 Hotfix 1 or later, which uses Java 11 

Move (not copy) ie3rdpartylibs.jar and webservices-api.jar from libWC folder to a separate folder under the Syndeia plugin folder named libWCx as shown:

...

...

Installing Windchill Jars for Windchill 12 and Cameo 2021x, 2022x and 2024x

These steps are appropriate for Windchill and Cameo 2021x and 2022x, that run with Java 11, and Cameo 2024x that runs with Java 17.

  1. Create a local folder named libWC and one named libWCx to collect the jar files needed for Windchill.

  2. Locate and gather from your Windchill server, 2 sets of jar files and copy these into the libWC folder.
    Set 1

  3. Go to this folder on your Windchill server: <Your Windchill Installation>\Windchill\ieconnector

    1. e.g. D:\ptc\Windchill\ieconnector.

  4. Locate and copy the ie.rar file to a separate temporary location, tempFiles

  5. Unzip the ie.rar file into tempFiles.

  6. Copy these 4 jar files from the tempFiles folder to the libWC folder:

    • ie-ra-client.jar

    • webservices-extra.jar

    • webservices-extra-api.jar

    • webservices-rt.jar

    Set 2

  7. Go to this folder on your Windchill server: <Your Windchill Installation>\Windchill\codebase\WEB-INF\lib

    1. e.g. D:\ptc\Windchill\codebase\WEB-INF\lib

  8. Copy these 2 jar files to the libWC folder.

    • ieWeb.jar

    • wncWeb.jar

    Set 3

  9. Copy commons-lang-2.6.jar from https://repo1.maven.org/maven2/commons-lang/commons-lang/2.6/commons-lang-2.6.jar to the libWC folder.

  10. Now, your libWC folder must have 7 and only 7, jar files—4 from Set 1, 2 from Set 2, and one from Set 3. Assure it has no other jars.

  11. Create a libWCx folder, next to but outside of libWC

  12. Copy this jar file from the tempFiles folder to the libWCx folder:

    • webservices-api.jar

  13. Go to this folder on your Windchill server: <Your Windchill Installation>\Windchill\codebase\WEB-INF\lib

    • e.g. D:\ptc\Windchill\codebase\WEB-INF\lib

  14. Copy this one jar file to the libWCx folder.

    • ie3rdpartylibs.jar

  15. Now, your libWCx folder must have 2 and only 2, jar files—1 from Set 1 and 1 from Set 2. Assure it has no other jars.

  16. Edit the properties file (e.g. magicdraw.properties, cameoea.properties,

...

  1. or csm.properties) as follows:

    1. Modify the JAVA_ARGS = line by adding

      -Djavax.xml.xpath.XPathFactory:http://java.sun.com/jaxp/xpath/dom\=com.sun.org.apache.xpath.internal.jaxp.XPathFactoryImpl

       after the existing

...

    1. string as shown, modified, in the

...

    1. text below.

    2. Modify the CLASSPATH = line by adding

      \:plugins/com.intercax.syndeia.md/libWCx/webservices-api.jar\:plugins/com.intercax.syndeia.md/libWCx/ie3rdpartylibs.jar

       after the existing

...

    1. “lib/classpath.jar” string as shown, modified, in the

...

    1. text below.

      Code Block
      #
      # SOME DATE STRING
      MAIN_CLASS=com.nomagic.magicdraw.Main
      CONSOLE=false
      APP_ARGS=
      JAVA_HOME=
      JAVA_ARGS=-DLOCALCONFIG\=true -splash\:data/splash.png -Dmd.class.path\=$java.class.path -Dcom.nomagic.osgi.config.dir\=configuration -Desi.system.config\=data/application.conf -Dlogback.configurationFile\=data/logback.xml -Dsun.locale.formatasdefault\=true -Xss1024K -Djdk.attach.allowAttachSelf\=true -Dadd.plugin.name.to.application.title\=false -Dstart.application.with.updm2.or.uaf.plugin\=uaf -Dmigrate.project.from.updm2.to.uaf\=false -Dfile.encoding\=UTF-8 -Djavax.xml.xpath.XPathFactory:http://java.sun.com/jaxp/xpath/dom\=com.sun.org.apache.xpath.internal.jaxp.XPathFactoryImpl 
      MAC_JAVA_ARGS="-Xdock\:name\=Cameo Enterprise Architecture 22" -Xdock\:icon\=bin/md.icns -Dapple.laf.useScreenMenuBar\=true
      CLASSPATH=lib/classpath.jar\:plugins/com.intercax.syndeia.md/libWCx/webservices-api.jar\:plugins/com.intercax.syndeia.md/libWCx/ie3rdpartylibs.jar
      DEFAULT_MEMORY_SETTINGS_64=SOMESETTING
  1. For each workstation, throughout your organization, that will be running MagicDraw and Syndeia

    1. Complete the section "Library Installation for specific Repositories" in the Install Syndeia plugin guide