Check the deployment of the Sodius extensions for PTC Windchill

If for some reasons, there is no new elements added to your PTC Winchill to associate products and parts to your CLM work areas, or you don't find the graphic controls to link working artefacts like change requests to their CLM counterparts, then it's time to check the Installing the OSLC Connect for Windchill Extensions to Windchill section.

In this section, you'll learn how to check this deployment but also how to re-do, manually, some of the steps necessary to correctly execute the deployment.

Check from the PTC Windchill user interface

A simple way to check the correct installation of the Sodius extensions for PTC Windchill is to use the Windchill Customization page, proceed this way:

  1. Connect PTC Windchill with administration credentials
  2. Click on the Browse menu on the left
  3. On the top icons bar, click on the Customization icon, it should be on the right
  4. Click on Tools
  5. You should get a list of clickable items, choose the first one, Action
  6. Then, locate the Action Model File field to enter
    Sodius-actionModels.xml
    , click Search

If the Sodius extensions are correctly installed, you should get a table with the following results:

Label Name Type
Help helpServiceProvider product
OSLC Service Provider Associations oslcServiceProviderMenu product
OSLC Collaboration Links oslcRelatedChangeRequestsMenu changeRequest
Relate OSLC Resources pickRelatedChangeRequestJcaWizard changeRequest
Delete Collaboration Link deleteRelatedChangeRequest changeRequest
Help helpRelatedChangeRequest changeRequest
Add Association editServiceProvider sodius
Delete Association deleteServiceProvider product

Not seeing this table means the extensions are not correctly deployed. It's time to investigate a step further.

Note: if you don't see the Customization button, here is how Enable the PTC Windchill Customization tab.

Check from the file system

This section is a check list to help you to get a status about the Sodius extensions deployment. Once done, send the results to the Sodius development team, which will help you to fix this setup.

Visually confirm that the following folders and files are present in the Windchill application directory (typically /ptc/Windchill_11.0/Windchill):

Type Path Content
Folder /codebase/config/actions Sodius-actionModels.xml
Sodius-actions.xml
Folder /codebase/netmarkets/javascript/sodius editServiceProviderWizard.js
editConfigurationWizard.js
pickRelatedOslcResourceWizard.js
Folder /codebase/netmarkets/javascript/util/jsfrags sodiusContextHelper.jsfrag
sodiusMsgboxPromise.jsfrag
sodiusOauthHelper.jsfrag
sodiusContextHelper.jsfrag
sodiusPreviewHelper.jsfrag
sodiusResizePromise.jsfrag
sodiusSelectorHelper.jsfrag
sodiusLoader.jsfrag
sodiusXhrPromise.jsfrag sodiusPolyfillPromise.jsfrag
Folder /codebase/netmarkets/jsp/sodius/oslc serviceprovider/createServiceProviderAssociation.jsp
serviceprovider/editServiceProviderStep.jsp
configuration/createConfiguration.jsp
configuration/editConfigurationStep.jsp
adapterlink/create.jsp
adapterlink/editOslcAdapterLinkStep.jsp
Folder /sodius/config config.xml
Folder /sodius/properties/reg_adds associationRegistry.properties
descendentRegistry.properties
modelRegistry.properties
Folder tasks/com/sodius/oslc 29 XML files
File /sodius/lib/sodius-http.jar n/a
File /sodius/lib/com.sodius.windchill.oslc.extension.jar n/a
File /sodius/lib/wink-json4j-1.2.1-incubating.jar n/a
File /sodius/lib/org.apache.commons.io_2.0.1.v201105210651.jar n/a

For the actionModels.xml and actions.xml, check the Windchill user has sufficient privileges to read those files:

ls -artl _path to Windchill install_/Windchill/codebase/config/actions

Sodius config.xml to Locate the OSLC Connect for Windchill

The config.xml file has XML that informs Windchill where to find the OSLC Connect for Windchill server and service. Check the adapter.root.url parameter has the correct URL value of your connector server. If not, modify it to reflect your correct setup.

For further information, see Referencing the OSLC Connect for Windchill

Check the installation of the Extension tables in Windchill SQL Database

After the execution of the extension install script, the 3 Extension tables should be present in the Windchill database:

Table Name Table Description
OSLCADAPTERLINK Table containing the links to Windchill Artifacts.
OSLCCONFIGURATION Table containing the part to configuration associations.
OSLCSERVICEPROVIDERASSOCIATION Table containing the product to artifact container associations.

Check out the Troubleshooting page Sodius extensions deployment with database errors.

Registration of the OSLC Connect for Windchill site.xconf Properties

This step is automatically performed by the extensionInstall.xml ant script.

Recombination of the Windchill_all.js Source

This step is automatically performed by the extensionInstall.xml ant script.

  1. Have Windchill recombine all its Javascript sources along with the Sodius extension Javascript:

Registration of Spring Bean Model-View-Controller Builders

Some components of the Sodius Windchill extension rely on Spring MVC beans. This configuration should be automatically performed by the extensionInstall.xml ant script. To confirm proper execution of the script, examine the beans file for ChangeRequests and for Parts.

  1. View the following file:
    <Windchill>/codebase/config/mvc/Sodius-configs.xml
  2. Confirm that the following lines appear within the Spring MVC
    <beans></beans>
    XML element:
        
            <bean class="com.sodius.oslc.adapterlink.mvc.builders.OslcAdapterLinkTablePart" />
            <bean class="com.sodius.oslc.adapterlink.mvc.builders.OslcAdapterLinkTableChangeRequest" />
            <bean class="com.sodius.oslc.adapterlink.mvc.builders.OslcAdapterLinkInfoBuilder" />
            <bean id="com.sodius.oslc.adapterlink.mvc.builders.OslcAdapterLinkInfoAttributesBuilder" />
          

Now you've check your setup, send us your results, thanks.