Using Syndeia with Windchill

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.

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

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.

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 the 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

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

6. Copy these 5 jar files from the unzipped folder to your libWC folder:

   • ie-ra-client.jar

   • webservices-api.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 3 jar files to the libWC folder.

   • ie3rdpartylibs.jar

   • ieWeb.jar

   • wncWeb.jar

9. Now, 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.

10. 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

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, 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 string as shown, modified, in the 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 “lib/classpath.jar” string as shown, modified, in the text below.

       # # 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

17. 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