First aid diagnosis

This document is intended to be first aid checklist to diagnose network issues with the OSLC Adapter for PTC Windchill.

Pre-requisites

Prior to diagnose the adapter and the link between PTC Windchill and CLM, you've to ensure the following pre-requisites are in place:

Conventions

In the rest of the document, you find the following shortcuts:

Shortcut Meaning
ADAPTER_URL The URL of the Sodius Adapter for PTC Windchill server.
Example: https://adapter.sodius.cloud:8443
CCM_URL
CLM_URL
RM_URL
The URLs of the CLM servers.
Example: https://clm-ccm.sodius.cloud:9443
WINDCHILL_URL The URL of the PTC Windchill server.
Example: https://wc110.sodius.cloud

Automatic Checking

The Sodius Adapter proposes a web page which can automatically check and detect common issues in your setup, this tool is available at the address: https://ADAPTER_URL/oslc-windchill/configuration/checkinstall.

This page checks:

Browser Checking

Except specific notice, the following checking are URL to be entered in a web browser.

From the CLM Server

Note for those checking, you may need to authenticate to your Windchill server. If you run different servers for CCM and RM, you should run those checkings of both servers.

Purpose of checking URL to check Expected result Problem possible causes

1.

Check you can access the OSLC Adapter for PTC Windchill server root services.

ADAPTER_URL/oslc-windchill/rootservices

The XML output should look like:

<rdf:Description rdf:about="https://ADAPTER_URL/oslc-windchill/rootservices">
<!--
  Namespace declarations last verified on 20 December 2017
-->
  <dc:title>Windchill OSLC Adapter</dc:title>
  <oslc_cm:cmServiceProviders rdf:resource="https://ADAPTER_URL/oslc-windchill/services/core/catalog/cm"/>  
  <oslc_am:amServiceProviders rdf:resource="https://ADAPTER_URL/oslc-windchill/services/core/catalog/am"/>
  <oslc_config:cmServiceProviders rdf:resource="https://ADAPTER_URL/oslc-windchill/services/core/catalog/config"/>
  <jfs:oauthRealmName>Windchill</jfs:oauthRealmName>
  <jfs:oauthDomain>
...
  • Adapter server down
  • Firewall blocking rules

2.

Check you can access the OSLC Adapter for PTC Windchill server AM catalog.

ADAPTER_URL/oslc-windchill/services/am/catalog

The XML output should look like:

<rdf:RDF>
<oslc:ServiceProviderCatalog rdf:about="https://ADAPTER_URL/oslc-windchill/services/am/catalog">
  <oslc:serviceProvider>
    <oslc:serviceProvider rdf:about="https://ADAPTER_URL/oslc-windchill/services/am/provider/OR_.....">
      <jp:supportLinkDiscoveryViaOSLCQueries rdf:datatype="http://www.w3.org/2001/XMLSchema#boolean">true...
      <oslc:service>
...
  • Adapter server down
  • Firewall blocking rules

3.

Check you can access the OSLC Adapter for PTC Windchill server CM catalog.

ADAPTER_URL/oslc-windchill/services/cm/catalog

The XML output should look like:

<rdf:RDF>
<oslc:ServiceProviderCatalog rdf:about="https://ADAPTER_URL/oslc-windchill/services/cm/catalog">
  <oslc:serviceProvider>
    <oslc:serviceProvider rdf:about="https://ADAPTER_URL/oslc-windchill/services/cm/provider/OR_.....">
      <oslc.details rdf:resource="https://WINDCHILL_URL/Windchill/app/#ptc..."/>
...
  • Adapter server down
  • Firewall blocking rules

4.

Check you can access the PTC Windchill server Service Providers.

WINDCHILL_URL/Windchill/protocolAuth/servlet/IE/tasks/com/sodius/oslc/AllServiceProviders.xml

The XML output should look like:

<wc:COLLECTION>
<wt.pdmlink.PDMLinkProduct NAME="group_products" TYPE="Unknown" STATUS="0">
    <wc:INSTANCE>
      <containerTeamManagedInfo.sendInvitations>false</containerTeamManagedInfo.sendInvitations>
      <inheritedDomain>false</inheritedDomain>
...
  • Windchill server down
  • firewall blocking rules
  • The Windchill user has no access to products

5.

Ensure the OSLC service is enabled on your CLM instance intended to be the adapter counterpart.

This is a "last resort" checking if nothing works.

CLM_URL/rm/service/com.ibm.team.process.internal.service.web.IProcessWebUIService/isOslcCoreEnabled

You may need to authenticate on CLM, and you should get a XML similar to this one:

<soapenv:Envelope>
  <soapenv:Body>
    <response>
      <method>getIsOslcCoreEnabled</method>
      <interface>com.ibm.team.process.internal.service.web.IProcessWebUIService</interface>
      <returnValue xsi:type="com.ibm.team.repository.common.services:PrimitiveDataArg">
        <type>BOOLEAN</type>
        <value>true</value>
      </returnValue>
    </response>
  </soapenv:Body>
</soapenv:Envelope>
...

In this example, you can see the status of IsOslcCoreEnabled is true.

OSLC is disabled on this CLM server.

From the PTC Windchill Server

For those checkings, you may need to authenticate on CLM or the OSLC Adapter, depending on the target URL.

Purpose of checking URL to check Expected result Problem possible causes

1.

Ensure you have access to the CLM OSLC root services for RM.

RM_URL/rm/rootservices

You should get a XML output beginning by:

<!--
Licensed Materials - Property of IBM
(c) Copyright IBM Corporation 2013, 2017. All Rights Reserved.
Note to U.S. Government Users Restricted Rights:
Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
--><rdf:Description rdf:about="https://RM_URL/rm/rootservices">
...
  • CLM RM server down
  • Firewall blocking rules

2.

Ensure you have access to the CLM OSLC root services for CCM.

CCM_URL/ccm/rootservices

You should get a XML output beginning by:

<!--
Licensed Materials - Property of IBM
(c) Copyright IBM Corporation 2013, 2017. All Rights Reserved.
Note to U.S. Government Users Restricted Rights: 
Use, duplication or disclosure restricted by GSA ADP Schedule 
Contract with IBM Corp. 
--><rdf:Description rdf:about="https://CCM_URL/ccm/rootservices">
...
  • CLM CCM server down
  • Firewall blocking rules

3.

Ensure you have access to the OSLC Adapter for PTC Windchill server root services.

ADAPTER_URL/oslc-windchill/rootservices

The XML output should look like:

<rdf:Description rdf:about="https://ADAPTER_URL/oslc-windchill/rootservices">
<!--
Namespace declarations last verified on 20 December 2017
-->
   <dc:title>Windchill OSLC Adapter</dc:title>
   <oslc_cm:cmServiceProviders rdf:resource="https://ADAPTER_URL/oslc-windchill/services/core/catalog/cm"/>  
<oslc_am:amServiceProviders rdf:resource="https://ADAPTER_URL/oslc-windchill/services/core/catalog/am"/>
<oslc_config:cmServiceProviders rdf:resource="https://ADAPTER_URL/oslc-windchill/services/core/catalog/config"/>
<jfs:oauthRealmName>Windchill</jfs:oauthRealmName>
<jfs:oauthDomain>
...
  • Adapter server down
  • Firewall blocking rules

Still in trouble?

If you're still in trouble and need the assistance of your Sodius representative, here some guidance about getting the information which can help the Sodius team to debug your problem.

Get the Sodius Adapter configuration

Connect the Sodius Adapter configuration page at this URL: https://ADAPTER_URL/oslc-windchill/configuration.

You should get something similar to:

configuration
    trs_page_size                         500
    activation_key                        "rO0ABXNyABFqYXZhLnV0aWwuSGFzaE1hcAUH2sHDFmDRAwACRgAKbG9)hBEZhY3RvckkACXRocmVzaG9sZHhwP0BBBDDDx3CAAZZDDBAAAAABdAAEaG9zdHQACndjLTExMC13aW72"
    trs_username                          "wcadmin"
    trs_poll_delay                        20
    windchill_server                      "https://WINDCHILL_URL/"
    trs_password                          "********"
    license_server_enabled                false
    trs_ie_page_limit                     500
    activation_key_enabled                true

Copy and paste this data in the message you'll send to your Sodius representative, it will be helpful to diagnose your problem.

Check the Sodius extensions configuration

On your Windchill server, open the file Windchill/sodius/config/config.xml, and notice the value of the adapter.root.url value. This is also something to communicate to Sodius.

Check the error codes

If you encounter an error which begin with a kind of cryptic code, please check the Error Messages.