0% found this document useful (0 votes)

107 views

Linked Data Framework

The document discusses how Linked Data Framework can be used to integrate different applications using data linking techniques. It provides an overview of Linked Data Framework and its capabilities. It also gives a sample change management process that uses Linked Data Framework to integrate a PLM tool and an ALM tool.

Uploaded by

Omar Letaif

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

107 views

Linked Data Framework

Uploaded by

Omar Letaif

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 88

SIEMENS

Teamcenter 12.2

Integrating
Applications
Using Linked Data
Framework
PLM00027 • 12.2
Contents

What is Linked Data Framework? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Sample change management process that uses Linked Data Framework . . . . . . . . . . . . . 2-1

Overview of integrating applications using Linked Data Framework . . . . . . . . . . . . . . . . 3-1

Installing Linked Data Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Linked Data Framework installation checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Install Linked Data Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Deploy Linked Data Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Starting Linked Data Framework services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Verify if the Linked Data Framework installation is successful . . . . . . . . . . . . . . . . . . . . . . . 4-11

Configuring integrations using Linked Data Framework . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Checklist for configuring Linked Data Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Create a Linked Data Framework site in Teamcenter representing the external application . . . . 5-2
Add service providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
Update service providers with semantic relations they can use . . . . . . . . . . . . . . . . . . . . . . . 5-5
Add Teamcenter as a friend in the external application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Add associations for Teamcenter services in the external application . . . . . . . . . . . . . . . . . . . 5-7
Update remote links with new relation types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Update to new Linked Data Framework relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Update the semantic mapping property files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Configure Relations tab to show Linked Data Framework objects and relations . . . . . . . . . . . 5-10
Set preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13

Administering Linked Data Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Starting and stopping Linked Data Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Creating or deleting the OAuth consumer keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Updating the oauthproxy password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Set the Linked Data Framework service session time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

Exposing additional services using Linked Data Framework . . . . . . . . . . . . . . . . . . . . . . 7-1

How does Linked Data Framework work? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Overview of exposing additional services using Linked Data Framework . . . . . . . . . . . . . . . . . 7-3
Create a new service catalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Create a new Linked Data Framework service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Create a Linked Data Framework service operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Create a new class to support the newly created service catalog . . . . . . . . . . . . . . . . . . . . . 7-13

Customizing Linked Data Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

PLM00027 12.2 Integrating Applications Using Linked Data Framework 3

Contents
Contents

Customize mapping between Teamcenter and external applications using the semantic mapping
file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Configuring the Creation Delegated UI dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8
Create custom icons for semantic types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
Define the relations to apply when creating remote links . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
Customizations to show Linked Data Framework objects and relations in the Relations tab . . . 8-11
Customize Active Workspace page to create links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12
Querying attributes of remote objects and receiving notifications from remote systems . . . . . . 8-14
Workflow handlers for performing operations on remote objects . . . . . . . . . . . . . . . . . . . . . 8-15
Embedded Software Management customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-15

Using Linked Data Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Using Linked Data Framework REST APIs to create and update Teamcenter resources . . 10-1

Tips, notes, and warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

Changes in semantic relations in Teamcenter 11.5 onwards . . . . . . . . . . . . . . . . . . . . . . A-1

4 Integrating Applications Using Linked Data Framework PLM00027 12.2

Chapter 1: What is Linked Data Framework?

Linked Data Framework is an integration framework that allows you to integrate different applications
or enterprise information systems such as Product Lifecycle Management (PLM) systems and
Application Lifecycle Management (ALM) systems using data linking techniques.
Linked Data Framework helps with the following business problems:
• How do you implement a process such as change management across different domains such as
PLM and ALM?
You can create links between parts of a process, such as between a change request in PLM and
a defect in ALM. You can also extend Linked Data Framework to enhance its capabilities.

• How do you avoid creating new UIs for integrating different applications, and help users avoid
learning new UIs?
Using UI-based services (UI delegation), you can reuse existing UIs, validation, and business
rules that are already enforced by the host application from the external application.

• How do you customize integrations without having to learn new techniques?

Using standards such as REST, JSON, RDF, and web-based APIs.

• How do you enable users to access PLM data without having to learn PLM concepts or new tools?
You can use your tools you are familiar with and use UI delegation to view PLM data.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 1-1

Chapter 2: Sample change management process that
uses Linked Data Framework

This process uses Linked Data Framework to integrate Teamcenter, which is a PLM tool, with
Rational Team Concert (RTC), which is an ALM tool that is used to manage software products.
Without Linked Data Framework, you would have to coordinate the PLM and ALM workflows manually.
Assume an automobile company wants to upgrade the power window system of their car based on
customer feedback. The following change process shows how the change can be handled in two
different domains using Linked Data Framework.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 2-1

Chapter
Chapter 2: 2: Sample
Sample change
change management
management process
process that uses
that uses Linked
Linked Data Data Framework
Framework

2-2 Integrating Applications Using Linked Data Framework PLM00027 12.2

Chapter 3: Overview of integrating applications using
Linked Data Framework

• Install and deploy Linked Data Framework

• Establish trust between Teamcenter and the external application

To ensure that two applications can exchange information, they need to become trusted
applications. This is achieved by exchanging OAuth consumer keys. In Teamcenter, you can
establish trust while creating a site representing the external application.
You must also create a representation of Teamcenter in the external application.

• Configure Teamcenter to act as a consumer

A consumer application accesses and creates information from the external application.
To set up Teamcenter as a consumer, you must add service providers exposed by remote
systems.

• Configure Teamcenter to act as a provider

A provider application provides access and services such as change management.
To set up Teamcenter as a provider, add Teamcenter as a service provider in the external
application.

• Test your setup

By default, Change Management and core services are available. If you have set up Teamcenter
as a consumer, you can create links and preview information in external applications. If you have
set up Teamcenter as a provider, the external tools can create links in and view information
from Teamcenter.

• Advanced customization
In addition to Change Management and core services, you can set up other domains such as
Requirements Management to use Linked Data Framework.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 3-1

Chapter 4: Installing Linked Data Framework

Linked Data Framework installation checklist

You can print the following checklists and use them to verify if you have completed all the tasks
required for installing and deploying Linked Data Framework. Refer to the subsequent topics
for more information.
Installation checklist
Check if you have selected the following features in Teamcenter Environment Manager (TEM).

Features→Base Install→Teamcenter Foundation

(Optional)
Features→Base Install→Business Modeler IDE Standalone
OR
Features→Base Install→Business Modeler IDE 2-tier
OR
Features→Base Install→Business Modeler IDE 4-tier
Select this feature only if you need to customize Linked Data Framework.
Features→Base Install→Teamcenter Rich Client 4-tier
Features→Extensions→Embedded Software Management
Select this feature only if you require Embedded Software Management integration.
Features→Extensions→Enterprise Knowledge Foundation→Change Management
Features→Extensions→Platform Extensibility→Linked Data Framework
Services→Java EE Based Linked Data Web Services
Features→Extensions→Platform Extensibility→Linked Data Framework Services→LDF
Foundation
Features→Extensions→Platform Extensibility→Linked Data Framework Services→LDF
Change Management Integration
Features→Extensions→Platform Extensibility→Linked Data Framework Services→LDF
Server Support
Features→Extensions→Platform Extensibility→Linked Data Framework Services→LDF
Embedded Software Management Integration
Select this feature only if you require Embedded Software Management integration.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 4-1

Chapter
Chapter 4: 4: Installing
Installing Linked
Linked Data Data Framework
Framework

Features→Extensions→Platform Extensibility→Linked Data Framework Services→LDF

Requirements Management Integration
Select this feature only if you require Requirements Management integration.
Features→Base Install→Active Workspace→Client→Active Workspace Client (Java EE)
Features→Base Install→Active Workspace→Client→Relationship Browser
Features→Base Install→Active Workspace→Client→Linked Data Framework
Features→Base Install→Active Workspace→Indexing Server→Active Workspace
Indexing Engine
Features→Base Install→Active Workspace→Indexing Server→Active Workspace
Indexer
Features→Base Install→Active Workspace→Server Extensions→Active Workspace
Features→Base Install→Active Workspace→Server Extensions→Relationship Viewer
Features→Base Install→Active Workspace→Server Extensions→Active Workspace
Linked Data Framework Services→LDF Foundation
Features→Base Install→Active Workspace→Server Extensions→Active Workspace
Linked Data Framework Services→Active Workspace LDF Change Management
integration
Features→Base Install→Active Workspace→Server Extensions→Active Workspace
Linked Data Framework Services→Active Workspace LDF Embedded Software
Management Integration
Select this feature only if you require Embedded Software Management integration.
Features→Base Install→Active Workspace→Server Extensions→Active Workspace
Linked Data Framework Services→Active Workspace LDF Requirements Management
Integration
Select this feature only if you require Requirements Management integration.
Features→Base Install→Active Workspace→Server Extensions→Active Workspace
Linked Data Framework Services→LDF Polarion Types Integration
Select this feature only if you require Polarion integration.
Configure Linked Data Framework panel update
If you installed Security Services check if the login service URL have a fully qualified domain
name.

Deployment checklist
Check if you have deployed the components required for Linked Data Framework to work:

Deploy the lis.war file to a J2EE based web application server.

The lis.war file is located at TC_ROOT/lis/stage/lis/lis.war.
Deploy the awc.war file to a Web Application Server if you have updated the Active
Workspace client.
The awc.war file is located at TC_ROOT/aws2/stage/out/awc.war.

4-2 Integrating Applications Using Linked Data Framework PLM00027 12.2

Installing Linked Data Framework

Verify if the Linked Data Framework installation is successful

Check if the Linked Data Framework services are installed in the TC_ROOT/lis directory.
Check if the core Linked Data Framework services are installed either as a Windows service
or a UNIX daemon.
Check that you can start the Linked Data Framework services
Check that you are able to access the Linked Data Framework root services.

Install Linked Data Framework

Linked Data Framework requires a 4-tier Teamcenter installation.
1. Start Teamcenter Environment Manager (TEM).

2. Select the appropriate options until you reach the Features panel.

3. In the Features panel, under the Base Install navigation, select the following prerequisite
features:
a. Teamcenter Foundation

b. (Optional) Business Modeler IDE Standalone, Business Modeler IDE 2-tier, or Business
Modeler IDE 4-tier
Choose this option only if you need to customize Linked Data Framework.

c. Teamcenter Rich Client 4-tier

d. In the Features panel, expand Extensions→Enterprise Knowledge Foundation and

select Change Management.
This installs the Change Management functionality. LDF Foundation requires this feature.

4. In the Features panel, expand Extensions and select Embedded Software Management.
This installs the Embedded Software Management functionality. LDF Embedded Software
Management Integration requires this feature.

5. In the Features panel, expand Extensions→Platform Extensibility→Linked Data Framework

Services and select the following:
a. Java EE Based Linked Data Web Services
Installs the WAR file for Linked Data Framework and core services.

b. LDF Foundation
Installs Linked Data Framework.

c. LDF Change Management Integration

Installs Change Management Integration for Linked Data Framework. This option is
automatically selected when you install LDF Foundation.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 4-3

Chapter
Chapter 4: 4: Installing
Installing Linked
Linked Data Data Framework
Framework

d. LDF Server Support

Installs Linked Data Framework. This option is automatically selected when you install LDF
Foundation.

e. LDF Embedded Software Management Integration

Installs Embedded Software Management Integration for Linked Data Framework.

f. LDF Requirements Management Integration

Installs Requirements Management Integration for Linked Data Framework.

6. In the Features panel, expand Base Install→Active Workspace→Client and select the
following:
a. Active Workspace Client (Java EE)
Installs the awc.war file and is required by Linked Data Framework.

b. Relationship Browser
Installs the Relations functionality that shows the Linked Data Framework relations in a
graphical format.

c. Linked Data Framework

Installs Linked Data Framework for Active Workspace.

7. In the Features panel, expand Base Install→Active Workspace→Indexing Server and select
the following:
a. Active Workspace Indexing Engine
Installs the indexing engine that is used for searching Linked Data Framework artifacts.

b. Active Workspace Indexer

Configures the Indexer settings.

8. In the Features panel, expand Base Install→Active Workspace→Server Extensions and

select the following:
a. Active Workspace
Installs Active Workspace binaries and templates. This feature is required by the LDF
Foundation feature.

b. Relationship Viewer
Installs the Relationship Viewer template. This feature is required by the LDF Foundation
feature.

c. Expand Active Workspace Linked Data Framework Services and select the following:
A. LDF Foundation
Installs Linked Data Framework for Active Workspace.

4-4 Integrating Applications Using Linked Data Framework PLM00027 12.2

Installing Linked Data Framework

B. Active Workspace LDF Change Management integration

Installs Change Management Integration support for Active Workspace. This feature is
automatically selected when you select the LDF Foundation feature.

C. Active Workspace LDF Embedded Software Management Integration

Installs Embedded Software Management Integration support for Active Workspace.

D. Active Workspace LDF Requirements Management Integration

Installs Requirements Management Integration support for Active Workspace.

E. LDF Polarion Types Integration

Installs Polarion business objects. This is required for Polarion Integration.

9. Click Next.
Select the appropriate options until you reach the Configure Linked Data Framework panel.

10. In the Configure Linked Data Framework panel, update the following:
a. 4-tier Server URL
Specifies the Teamcenter 4-tier URL.

b. LIS Core Service Port

Specifies the port used to access the core services of Linked Data Framework.

Note
This port is only to be used for administration purposes and not by customizers
or integrators.

c. If you want Linked Data Framework to use SSO, select the Is SSO Enabled check box
and specify the following:
A. SSO Login Service URL
Specifies the SSO login URL that has a fully qualified domain name, for example,
http://hostname.domain name:port number/tc.

B. SSO Application ID
Specifies the SSO application ID.

Note
If you have enabled SSO, you must also update the LDAP repository with the
oauthproxy user credentials.

11. Click Next.

Select the appropriate options until you complete the installation.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 4-5

Chapter
Chapter 4: 4: Installing
Installing Linked
Linked Data Data Framework
Framework

Since Linked Data Framework requires a 4-tier Teamcenter installation, you must generate and
deploy the Teamcenter web application.
If you plan to install security services, ensure that you add the fully qualified domain name in the login
and service URLs while generating the security services web application.
When configuring identity services using the Application Registry table for Teamcenter and Active
Workspace, ensure that each Application Root URL consists of a fully qualified domain name.

Deploy Linked Data Framework

After installing Linked Data Framework using TEM, you must deploy the lis.war file to a J2EE-based
Web Application Server. The Web Application Server must be the same where you deployed the
awc.war file.

Note
To check if the web application server you plan to use is certified with your current
Teamcenter platform, refer to the Software Certifications page on GTAC.

If you have updated the Active Workspace client, you must also deploy the awc.war file.
The lis.war is located at TC_ROOT/lis/stage/lis/lis.war.

Deploying on JBOSS
1. Copy the lis.war file to the same directory where the JBOSS application is installed, for example,
E:\LIS_WAR\.

2. Using a command prompt, navigate to the directory where you copied the lis.war file, for
example, E:\LIS_WAR.

3. Execute the following command:

jar –xvf lis.war

This extracts the lis.war file in the same directory to that you navigated to from the command
prompt.

4. Create a file named jboss-deployment-structure.xml in the WEB-INF folder and paste the
following code in it:

<?xml version="1.0" encoding="UTF-8"?>

<jboss-deployment-structure>
<deployment>
<exclusions>

<module name="javaee.api" />
<module name="javax.ws.rs.api"/>
<module name="org.jboss.resteasy.resteasy-jaxrs" />
</exclusions>
</deployment>

4-6 Integrating Applications Using Linked Data Framework PLM00027 12.2

Installing Linked Data Framework

</jboss-deployment-structure>

5. Add the following content in the web.xml file:

<context-param>
<param-name>resteasy.scan</param-name>
<param-value>false</param-value>
</context-param>

<context-param>
<param-name>resteasy.scan.providers</param-name>
<param-value>false</param-value>
</context-param>

<context-param>
<param-name>resteasy.scan.resources</param-name>
<param-value>false</param-value>
</context-param>

6. Using a command prompt, navigate to the directory that contains the lis.war file, for example, the
E:\LIS_WAR\lis directory, and execute the following command:
jar –cvf lis.war

Note
If you are using JBOSS 7.1 as your web application server, comment the following lines
from the standalone.xml file:
<extension module="org.jboss.as.jaxrs"/>
<subsystem xmlns="urn:jboss:domain:jaxrs:1.0"/>

Deploying on IBM WebShpere 8.5.5 and 9

1. Copy the lis.war file to the same directory where the WebSphere application is installed, for
example, E:\LIS_WAR\.

2. Using a command prompt, navigate to the directory where you copied the lis.war file, for
example, E:\LIS_WAR.

3. Execute the following command:

jar –xvf lis.war

This extracts the lis.war file in the same directory that you navigated to from the command prompt.

4. Create another directory, for example, E:\LIS_WAR\shared_lib.

5. Copy the following JAR files from the new location where you extracted the contents of the
lis.war file. For example, copy the jar files from E:\LIS_WAR \lis\WEB-INF\lib directory to the
E:\LIS_WAR\shared_lib directory.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 4-7

Chapter
Chapter 4: 4: Installing
Installing Linked
Linked Data Data Framework
Framework

• hk2-api-2.5.0-b32.jar

• hk2-locator-2.5.0-b32.jar

• hk2-utils-2.5.0-b32.jar

• jersey-common.jar

• jersey-container-servlet-core.jar

• jersey-guava-2.25.1.jar

• jersey-media-jaxb.jar

• jersey-server.jar

• oauth-httpclient4-20090617.jar

• org.apache.httpcomponents.httpclient_4.1.0.v201103311320.jar

• org.apache.httpcomponents.httpcore_4.1.0.v201101201700.jar

• org.osgi.core-4.2.0.jar

• osgi-resource-locator-1.0.1.jar

6. Delete the copied jar files from the lib directory. For example, delete the jar files from the
E:\LIS_WAR\lis\WEB-INF\lib directory.

7. Using a command prompt, navigate to the directory that contains the lis.war file, for example, the
E:\LIS_WAR\lis directory, and execute the following command:
jar –cvf lis.war

This creates a new lis.war file that does not have JAR files that we deleted in the previous step.
Deploy the lis.war file into the WebSphere application as follows:

8. In the WebSphere navigation tree, expand Environment and click Shared libraries.

9. In the Shared Libraries pane, click New.

10. In the Configuration pane, update the information as follows:

• Name: Specify the name of the library, for example, shared_lis_lib.

• Description: Provide a description for the library, for example, Shared isolated library for
Apache Http Client and Apache Wink.

• Classpath: Specify the location that contains new LIS files. For example, change the
classpath from the E:\LIS_WAR\lis\WEB-INF\lib directory to E:\LIS_WAR \shared_lib.

• Select the option Use an isolated class loader for this shared library.

Click OK.

4-8 Integrating Applications Using Linked Data Framework PLM00027 12.2

Installing Linked Data Framework

The lis application is deployed on WebSphere.

11. Stop the lis application, if running.

12. On the Enterprise Applications page, click Class loading and update Detection.

13. Select the Classes loaded with local class loader first (parent last) check box and click OK.

14. On the Enterprise Applications page, click Shared library references.

15. Under Application, select lis_war and click Reference shared libraries.

16. In the Shared Library Mapping page, move the library from the Available list to the Selected list.

17. Click OK.

18. Disable the built in JAX-RS by updating the following JVM property to true:
com.ibm.websphere.jaxrs.server.DisableIBMJAXRSEngine=true

You can update this property in the admin console of WebSphere by going to
Servers→All Server→Server Infrastructure→Java and Process Management→Process
Definition→Additional Properties→Java Virtual Machine→Additional Properties→Custom
Properties.

19. Save the configuration.

20. Restart WebSphere.

21. Check if your configuration is saved and then start the lis application.

Deploying on Weblogic 12.1.3

1. Copy the lis.war file to the same directory where the Weblogic application is installed, for
example, E:\LIS_WAR\.

2. Using a command prompt, navigate to the directory where you copied the lis.war file, for
example, E:\LIS_WAR.

3. Execute the following command:

jar –xvf lis.war

4. Create a file named weblogic.xml in the WEB-INF folder and add the following code to it:

<?xml version="1.0" encoding="UTF-8"?>

<weblogic-web-app xmlns="http://www.bea.com/ns/weblogic/weblogic-web-app"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.bea.com/ns/weblogic/weblogic-web-app
http://www.bea.com/ns/weblogic/weblogic-web-app/1.0/weblogic-web-app.xsd">
<description>WebLogic Descriptor</description>
<jsp-descriptor>
<!--
jsp-descriptor page-check-seconds:
Sets the interval, in seconds, at which WebLogic Server

PLM00027 12.2 Integrating Applications Using Linked Data Framework 4-9

Chapter
Chapter 4: 4: Installing
Installing Linked
Linked Data Data Framework
Framework

checks files have changed and need recompiling. Dependencies

are also recursively reloaded if changed. If set to 0, pages
are checked on every request. If set to -1, page
recompiling is disabled.
default:1
-->
</jsp-descriptor>
<container-descriptor>
<prefer-application-packages>
<package-name>javax.ws.rs.*</package-name>
<package-name>com.sun.jersey.*</package-name>
<package-name>org.glassfish.*</package-name>
<package-name>org.jvnet.hk2.*</package-name>
<package-name>jersey.repackaged.org.objectweb.asm.*</package-name>
</prefer-application-packages>

<prefer-application-resources>
<resource-name>META-INF/services/javax.servlet.
ServletContainerInitializer</resource-name>
<resource-name>META-INF/services/javax.ws.rs.ext.
RuntimeDelegate</resource-name>

<resource-name>jersey.repackaged.*</resource-name>

</prefer-application-resources>
</container-descriptor>
</weblogic-web-app>

5. Using a command prompt, navigate to the directory that contains the lis.war file, for example, the
E:\LIS_WAR\lis directory, and execute the following command:
jar –cvf lis.war

This creates a new lis.war file that does not have the JAR files that we deleted in the previous
step.

6. Deploy the lis.war file into the Weblogic application.

Starting Linked Data Framework services

To use Linked Data Framework, start services in the following order:
• Start the Teamcenter Server pool manager and wait till it has spawned all Teamcenter server
processes.

• Start the application server (where tc.ear is deployed) and wait till it is in running mode.

• Start the lis service.

When started, the service attempts to log on to the Teamcenter server.

4-10 Integrating Applications Using Linked Data Framework PLM00027 12.2

Installing Linked Data Framework

Verify if the Linked Data Framework installation is successful

Check the following:
• The J2EE based Linked Data Framework services are installed at TC_ROOT/lis.

• The core services of Linked Data Framework are installed either as a Windows service or a UNIX
daemon. On Windows, the service starts automatically, while on UNIX, the system administrator
must configure the daemon to start automatically.

• You are able to access the Linked Data Framework root services . This rootservices document
shows root services with service catalogs, services, and OAuth authorization URLs.
The root service url is in the format http://Web app host:Port/lis/oslc/rootservices, for example,
http://lm6s003:7001/lis/oslc/rootservices.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 4-11

Chapter 5: Configuring integrations using Linked
Data Framework

Checklist for configuring Linked Data Framework

Using Linked Data Framework, your application can run in two modes:
• Consumer: A consumer accesses services from the other(external) application. For example,
when Teamcenter is set up as a consumer, it accesses services from the external application.

• Provider: A provider allows the other application to access its services. For example, when
Teamcenter is set up as a provider, external applications can access its services such as change
management.

You can print the following checklist and use it to verify if you have completed all the tasks required
for configuring Linked Data Framework:
Teamcenter configurations

Create a Linked Data Framework site in Teamcenter that represents the external application
Add service providers
Update service providers with semantic relations they can use
Set mandatory preferences (if not already set)

ActiveWorkspaceHosting.LIS.URL
If the preference does not exist, create it.
TC_LDF_host_url
LDF_FQDN
Update remote links with new relation types
Perform this step if you have Linked Data Framework installed on a version of Teamcenter
previous to 10.1.7 or 11.2.3
Update to new Linked Data Framework relations
Perform this step if you have upgrade to Teamcenter versions 11.4 or later.
Configure Relations Browser to show Linked Data Framework objects and relations

Polarion configurations
For more information about configuring Polarion, see the Polarion Connector for Teamcenter Polarion
Installation Guide.

Add Teamcenter server as a provider for Polarion OSLC

PLM00027 12.2 Integrating Applications Using Linked Data Framework 5-1

Chapter
Chapter 5: 5: Configuring
Configuring integrations
integrations usingusing Linked
Linked Data Data Framework
Framework

Enable linking of Polarion work items to Teamcenter items

Install and configure integration workflow extension for Teamcenter
Install and configure integration workflow extension for Polarion

Configurations for external applications other than Polarion

If your external application is Polarion, use the Polarion checklist.

Add Teamcenter as a friend in the external application

Add associations for Teamcenter services in the external application

These basic configurations will allow you to use Linked Data Framework integration. To extend
the Linked Data Framework functionality, you must perform the following advanced configurations
and customizations:
• Update the semantic mapping file.

• Customize Relations Browser functionality to display Linked Data Framework objects and
relations.

• Customize Active Workspace to display remote links.

• Expose additional services using Linked Data Framework.

Create a Linked Data Framework site in Teamcenter representing

the external application
A site represents the tool that integrates with Teamcenter.
1. In Organization, select Linked Data Framework Providers from the Organization List tree.

2. Type a name for the site in the Name box.

Tip
Provide a specific name so that it is easy to identify the external system for which
you have created a site.

3. Type the root serives URL.

The root services URL is the entry point to the site and helps find the available service providers.

5-2 Integrating Applications Using Linked Data Framework PLM00027 12.2

Configuring integrations using Linked Data Framework

Note
Do not specify an IP address.

4. Click the Connect button.

If this is a new session, a login window of the external site appears. You must log on to the
external site with appropriate credentials.
If the connection is successful, and if the site supports OAuth, the OAuth boxes appear.

5. Type the secret phrase to be associated with the OAuth Consumer key in the OAuth Secret box.
The secret phrase can be any text.

6. Type the secret phrase, the one you provided above, again in the Re-type Secret box.

7. (Optional) Type the OAuth consumer key in the OAuth Consumer Key box. If this box is left
blank, Teamcenter automatically generates a consumer key.

8. Select the Trusted check box to indicate that the site you are creating can trust Teamcenter.
Trusted sites can share authorization data with other trusted sites.

9. Select the Active check box if it is not already checked to mark the site as active.
Only an active site can integrate with other sites.

10. Provide a path to the catalog that contains services this site provides by adding the catalog
URL to the Add Catalog URL list.

11. Click Create to create a Linked Data Framework site.

If Teamcenter is configured with SSO and you do not have an existing SSO session, a dialog
box opens asking for login and password. Type your login and password after which the Site
is created.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 5-3

Chapter
Chapter 5: 5: Configuring
Configuring integrations
integrations usingusing Linked
Linked Data Data Framework
Framework

Add service providers

A service provider represents the services published by the external application.
1. In Organization, go to Organization List→Linked Data Framework Providers and select a site
for which you want to add a service provider.

2. Click the Add Service Provider button.

If this is a new session, a login window of the external site appears. You must log on to the
external site with appropriate credentials.

3. In the Service Provider dialog box, select the service provider you want to add from the Available
Service Provider list and add the service provider to the Selected Service Provider list.

Note
Teamcenter allows only 128 characters in the service provider name. In case your
service provider name is greater than 128 characters, modify the service provider
name in the external application and limit the name to 128 characters.

4. Click OK.

5-4 Integrating Applications Using Linked Data Framework PLM00027 12.2

Configuring integrations using Linked Data Framework

If Teamcenter is configured with SSO and you do not have an existing SSO session, a dialog
box opens asking for login and password. Type your login and password after which the service
provider is created.

The service provider appears under the site name in the Linked Data Framework Providers node of
the Organization List tree.

Update service providers with semantic relations they can use

Semantics or Semantic relationships specify what relations to use when you create remote links.
For example, when you create remote links between a Change Item Revision and an object in the
external application, you can choose to apply relations defined here such as Affected By Defect,
Affects Plan Item, and Affects Requirement.
To ensure that these semantic relations are available when you create Linked Data Framework links,
you must add the semantic relations that you want to use for each service provider as follows:
1. In Organization, from the Organization List tree, select a site from the Linked Data Framework
Providers node and then select a service provider.

2. In the Semantics list, click the Add/Remove button.

3. In the Semantics dialog box, select the semantic relations you want from the Available
Semantics list and add them to the Selected Semantics list.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 5-5

Chapter
Chapter 5: 5: Configuring
Configuring integrations
integrations usingusing Linked
Linked Data Data Framework
Framework

4. Click OK.

5. Click Modify.

You can also customize the semantic relationships.

Add Teamcenter as a friend in the external application

You can add Teamcenter as a friend or site in your external application.

Note
Your external application must support OAuth 1.0a ( RFC5849) for authentication and
authorization.

The exact method of adding a site differs across tools. Refer to your tool documentation for more
information.
In IBM RTC, you can add Teamcenter as a site by creating a Friend as follows:

5-6 Integrating Applications Using Linked Data Framework PLM00027 12.2

Configuring integrations using Linked Data Framework

1. On the Application Administration page, under Communication, click Friends (Outbound)

2. On the Friends page, in the Friends List section click, Add.

In the Add Friend dialog box, add the following information:

a. In the Name box, type a name to identify the Teamcenter site.

b. In the Root Services URI box, type the URI for Teamcenter root services.
When specifying the Root Services URI, ensure that you specify a host name that is public.
Do not specify an IP address.

c. In the OAuth Secret and Re-type Secret boxes, type the OAuth secret code.

d. Select the Trusted check box to indicate that Teamcenter can trust the external application.

e. Click Create Friend.

If this is a new session, you must log on to Teamcenter with appropriate DBA login credentials.

4. Click Finish.

Add associations for Teamcenter services in the external application

In order to consume services exposed by Teamcenter, external applications need to recognize these
services. This is achieved by adding Teamcenter services in the external application.
The exact method of adding a service provider differs across tools. Refer to your tool documentation
for more information.
In IBM RTC, to add a Teamcenter service provider, create an association in a project area as follows:
1. In the Application Administration page, choose Project Areas→Active Project Areas.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 5-7

Chapter
Chapter 5: 5: Configuring
Configuring integrations
integrations usingusing Linked
Linked Data Data Framework
Framework

2. In the Active Project Areas page, click the project where you want to create an association.

3. In the project page, under Associations, click Add.

4. In the Add Association dialog box:

a. Select the Teamcenter application you want to connect to from the Application list.
If this is a new session, you must log on to Teamcenter with appropriate credentials.

b. Select the method by which you want the service provider to associate with Teamcenter
from the Association list.
The Artifact Containers list is automatically populated with the Teamcenter service based
on the association you select.

5. Select the Teamcenter service from the Artifact Containers list.

6. Click OK.

5-8 Integrating Applications Using Linked Data Framework PLM00027 12.2

Configuring integrations using Linked Data Framework

Update remote links with new relation types

Starting Teamcenter versions 10.1.7 and 11.2.3, you can define custom relations between a
Teamcenter object type and an object type in the external application, using Linked Data Framework.
If you have Linked Data Framework installed on a version of Teamcenter previous to 10.1.7 or 11.2.3,
you must update the relation type to avoid issues resulting from the change in the data model. Use
the following steps to update the remote links:
1. Install Active Workspace on the upgraded Teamcenter version (10.1.7, 11.2.3, or later).

2. Define the relation that can be used when you create a link between the Teamcenter object type
and the object type in the external application.

3. Authenticate Teamcenter with the external application. To do this, create a remote link between
Teamcenter and the object in the remote application.

4. Generate a report that shows the relation type that needs to be updated. This relation type
links a Teamcenter object type and the object type in the external application. Use the
generate_remote_links_report_for_update utility to generate the report.

5. Make a copy of the report generated in the previous step. Update the copy with the new relation
type for the specified Teamcenter and external application object type combination. Add this new
information to the database using the update_remote_link_relations utility.

Update to new Linked Data Framework relations

After you upgrade to Teamcenter version 11.4 or later, you must run the migrate_relations_to_ldf
utility to ensure that the correct relations appear in Relations Browser.
This utility updates the IMAN_reference and IMAN_specification relation types that are used
to associate Linked Data Framework links as a secondary object to the Lis0Reference and
Lis0Specification relations, respectively.

Update the semantic mapping property files

After upgrading your Teamcenter and Linked Data Framework installation, you must update the
semantic mapping property files, if you modified those files.
These files are:
• oslc_cm_properties.xml located in TC_INSTALL_DIR/osl0lisoslc.

• oslc_core_properties.xml located in TC_INSTALL_DIR/osl0lisoslc.

To update the files:

1. Take a backup of the files.

2. After you upgrade your Teamcenter and Linked Data Framework installation, run the
create_botype_reader utility with the following arguments:
• -f=create

PLM00027 12.2 Integrating Applications Using Linked Data Framework 5-9

Chapter
Chapter 5: 5: Configuring
Configuring integrations
integrations usingusing Linked
Linked Data Data Framework
Framework

• -filename=name-of-the-property-file-you-backed-up
For example, -file= oslc_cm_properties.xml

Example
create_botype_reader -u=ed_admin -p=ed_admin -g=dba
-mode=map_schema -domain=core –f=create –file=d:\oslc_cm_properties

Configure Relations tab to show Linked Data Framework objects

and relations
The Relations tab in Active Workspace allows you to view the relationship between objects in
Teamcenter. You can also configure it to show relations between Teamcenter objects and objects in
an external or remote application such as Polarion.

5-10 Integrating Applications Using Linked Data Framework PLM00027 12.2

Configuring integrations using Linked Data Framework

To enable the Relations tab to show relations between Teamcenter objects and objects in a remote
application, do the following:
1. In the Teamcenter rich client, search for the dataset RelationB*.

2. In the Search pane, right-click RelationBrowserConf and choose Named References.

3. In the Named References dialog box, select RB_UIConfigure.xml and click Download.

4. Open the RB_UIConfigure.xml file and update the following four configurations:

Add relations in the General view

• Go to the section view name="General" and under the group name="relations" section,
add the relations you want.
Use the following format:
<filter name="AffectedByDefectCM" parameterSet="AffectedByDefect"
color="(138,66,8)"/>

• filter name specifies the name of the relation.

• parameterSet specifies the name of the parameterSet element that is used by the relation.
The parameterSet element defines how the relations and objects are mapped.

• color specifies the display color of the relation.

Add objects in the General view

• Go to the section view name="General" and under the group name="objects" section,
add the objects you want.
Use the following format:
<filter name="POL-ChangeRequest" parameterSet=" Ldf0TempLinkRuntimeObject"
color="(102,0,204)"/>

• filter name specifies the name of the object.

• parameterSet specifies the name of the parameterSet element that is used by the object.
The parameterSet element defines how the relations and objects are mapped.

• color specifies the display color of the object.

Define parameterSet for the relations you added in the General view
• Go to the section parameterSets and under it, create a new parameterSet=relation-name
section.
Example:
<parameterSet name="AffectedByDefect">

Under the parameterSet section, add entries in the following format:

PLM00027 12.2 Integrating Applications Using Linked Data Framework 5-11

Chapter
Chapter 5: 5: Configuring
Configuring integrations
integrations usingusing Linked
Linked Data Data Framework
Framework

<clipsfacts>
<fact>source=LDF,key=AffectedByDefectCM,relationType=AffectedByDefect,
targetDirection=forward,inputTypes=ItemRevision</fact>
<fact>source=LDF,key=AffectedByDefectCM,relationType=AffectedByDefect,
targetDirection=forward,inputTypes= Ldf0TempLinkRuntimeObject </fact>
</clipsfacts>
</parameterSet>

Define the parameterSet values in the facts elements of the clipfacts section.

• source specifies the query service. For relations to external systems, only the query LDF is
supported.

• key specifies the remote relation type. This should match value of the filter name that you
defined in the group name="relations" section.

• relationType specifies the name of the relation type used for Linked Data Framework linking.
The Linked Data Framework relations that you can use are defined in the
RelationTypeMapping element of the semantic mapping file. Use the relations defined
in the consumerRelation and providerRelation elements. When using the relations,
remove the prefix. For example, if the relation defined in the consumerRelation
element is oslc_cm:affectsRequirement, remove the prefix oslc_cm: and use only
affectsRequirement.
You can also add relations that are not defined in the semantic mapping file. Refer to your
external application for the names of the external relations.

• targetDirection specifies the direction of the relation. For remote systems, the direction
value is forward.

• inputTypes specifies which objects to query.

Define parameterSet for the objects you added in the General view
• Go to the section parameterSets and under it, create a new parameterSet=object-name
section.
For example
<parameterSet name="Ldf0TempLinkRuntimeObject">

Under the parameterSet section, add entries in the following format:

<parameterSet name="AffectedByDefect">
<clipsfacts>
<fact>Ldf0TempLinkRuntimeObject </fact>
</clipsfacts>
</parameterSet>

Add the object names in the facts elements of the clipfacts section.
The fact value should be the values defined in the RBTypeAttrMapping element of the
semantic mapping file.

5-12 Integrating Applications Using Linked Data Framework PLM00027 12.2

Configuring integrations using Linked Data Framework

5. Check out the RelationBrowserConf dataset.

6. Delete the original RB_UIConfigure.xml file from the Named References dialog box and import
the new RB_UIConfigure.xml file.

7. Click Close.

8. Check in the RelationBrowserConf dataset.

For more information about configuring the Relations application, see the Active Workspace Help
Collection.

Set preferences
• Create a preference named ActiveWorkspaceHosting.LIS.URL and update it with the value of
the Active WorkspaceClient URL.

Note
Ensure that the URL has the suffix ?ah=true . For example
http://lm6s003:7001/awc/tc.html?ah=true. This suffix is required for
Active Workspace delegated UIs to work properly.

• To ensure that backlinks are created in the integrating application, create a preference named
TC_LDF_host_url and for its value, specify the URL that points to the local Linked Data
Framework web application.
Example: http://lm6s003.net.plm.eds.com:7001/lis/

• To ensure that Linked Data Framework URLs contain fully qualified domain names, create a
preference named LDF_FQDN and specify the fully qualified domain name of the machine where
Linked Data Framework is deployed as the preference value.
Example: .net.plm.eds.com

Note
Ensure that the URL uses hostname and not IP-based URLs. Linked Data Framework
does not support IP-based URLs.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 5-13

Chapter 6: Administering Linked Data Framework

Starting and stopping Linked Data Framework

Linked Data Framework is available as a Windows service and a UNIX daemon. You must turn on
this service for Linked Data Framework to work.
This service is named as Teamcenter LIS Service LIS_Host Name_User Name.
On Windows, the service stars automatically, while on UNIX, the system administrator must configure
the daemon to start automatically.
The daemon script is located at TC_ROOT\lis\rc.liswebservices.sh
This script contains the following arguments:
-start
Starts the Linked Data Framework web services daemon.
-start_msg
Prints a message that the daemon is starting.
-stop
Immediately stops Linked Data Framework web services.
-stop_msg
Prints a message that the daemon is stopping.
-status
Prints a message indicating whether the Linked Data Framework web services daemon is running.
-log
Prints the entire output of the Linked Data Framework web services.

Creating or deleting the OAuth consumer keys

Use the maintain_consumer_key utility to create or delete oauth consumer keys.
You only need to use this utility when the remote application does not support automatic exchange
of consumer keys with Teamcenter.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 6-1

Chapter
Chapter 6: 6: Administering
Administering Linked
Linked Data Data Framework
Framework

Example
• Adding an OAuth consumer key:
maintain_consumer_key -u=username -p=password -g=dba -mode=add
-consumer_name=RTC -consumer_secret=111 -isTrusted=Y

• Deleting an OAuth consumer key:

maintain_consumer_key -u=username -p=password -g=dba -mode=delete
-consumer_name=RTC -consumer_secret=111
-consumer_key=12789259677583223
-isTrusted=Y

After you create a consumer key, run the system refresh operation from your browser by accessing
the following url:
http://machine_name:port_number/lis/sys/refresh.
Here, machine_name is the machine where the lis.war file is installed and port_number is the web
server port, for example, http://localhost:7001/lis/sys/refresh.
You must always run the system refresh operation after creating a consumer key and then use
the consumer key to create a site.

Updating the oauthproxy password

Teamcenter creates the oauthproxy user when you install Linked Data Framework.
If you change the oauthproxy user password in Teamcenter, you must generate the password file
again using the encryptPass.bat or encryptPass.sh file as follows:
encryptPass.bat new password

This file is located in the TC_ROOT/lis directory.

If Teamcenter SSO is enabled, you must update the oauthproxy password in the LDAP repository
as well.

Set the Linked Data Framework service session time

The Linked Data Framework service times out after 1440 minutes. After this, you must log on again.
You can change the duration for which the service remains active by updating the
lisServiceSession.timeout property in the liswebservices.properties file.
This file is located in the TC_ROOT\lis directory.

6-2 Integrating Applications Using Linked Data Framework PLM00027 12.2

Chapter 7: Exposing additional services using
Linked Data Framework

How does Linked Data Framework work?

Linked Data Framework supports Open Services for Lifecycle Collaboration (OSLC) specification. It
uses open technologies such as Linked Data, RDF, and REST.

Representational State Transfer Provides API specifications that allow you to use HTTP
(REST) methods to create, retrieve, update, and delete resources.
Linked Data Allows you to represent each resource as a URI and provides
HTTP links to these resources.
Resource Description Framework Allows you to specify information about the resource.
(RDF)

Once Linked Data Framework is setup, you can create links between resources, view data, and
update resources.
To support the integration, Linked Data Framework uses the following framework:

PLM00027 12.2 Integrating Applications Using Linked Data Framework 7-1

Chapter
Chapter 7: 7: Exposing
Exposing additional
additional services
services usingusing Linked
Linked Data Data Framework
Framework

The Linked Data Framework framework contain the following components:

Framework elements Description

Service provider A service provider provides specific services, for example,
Teamcenter Change Management.
Service A service provides the capabilities to create, retrieve, update,
and delete resources for a particular Linked Data Framework
area, for example, Teamcenter Change Management.
A service may offer the following capabilities:

Query capabilities Allows you to query a resource

programatically
Dialogs Allows you to create UI dialogs to
create and view resources
Creation Factory Allows you to create resources
programmatically
Resource A resource represents a feature of the application, for example
Change Request.

7-2 Integrating Applications Using Linked Data Framework PLM00027 12.2

Exposing additional services using Linked Data Framework

By default Change Management, Core Services, and Requirement Management domains are
available. You can add other domains as per your requirements.
The Core Services catalog provides services to create, query, update, and delete generic Teamcenter
objects such as item, document, parts using UI-based or API-based interfaces. Integrators can also
add custom services for processing the core or custom business objects.

Overview of exposing additional services using Linked Data

Framework
A third-party application can integrate with Teamcenter functionality such as Requirements
Management only when the functionality is configured to support Linked Data Framework.
To enable Linked Data Framework support, you must perform the following in Business Modeler IDE:
• Create a service catalog.
A service catalog acts as a container for a related set of functionality such as Requirement
Management. It specifies the types of business objects that support Linked Data Framework.

• Create a Linked Data Framework service.

A Linked Data Framework service specifies which services are supported. Services are of two
types:

o Factory services provide programmatic interfaces for performing operations such as creating
and querying objects.

o Delegated user interface (UI) services provide a UI-based service. The UI is rendered using
Active Workspace. This service is defined with a URI pointing to an Active Workspace UI
designed for that service.

• If you create a factory service, you must also specify service operations. A service operation is
an ITK that is part of a library. For each factory service, all REST operations can be defined.
For every service, you can associate four different REST-operation implementations: GET,
POST, PUT, and DELETE.

• To support the new service catalog, create a new class based on the Osl0ResourceAttrHelper
class, and register the class using the create_botype_reader utility.

• After you create service catalogs, services, service operations, and the new class in Business
Modeler IDE, deploy the template to Teamcenter.

• Create a dataset in Teamcenter and attach an XML file that contains mapping information.
Register the dataset using the create_botype_reader utility.

By default, Change Management and Core Services catalog are available. You can add other
domains as per your requirements.
The Core Services catalog provides services to create, query, update, and delete generic Teamcenter
objects such as items, documents, and parts by using UI-based or API-based interfaces. Integrators
can also add custom services for processing the core or custom business objects.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 7-3

Chapter
Chapter 7: 7: Exposing
Exposing additional
additional services
services usingusing Linked
Linked Data Data Framework
Framework

Create a new service catalog

The Linked Data Framework provider catalog typically reflects specific functionality in Teamcenter,
and it is referred to as a service catalog in the Business Modeler IDE Linked Data Framework registry.
The change management domain is provided in Linked Data Framework by the Lis0CM catalog. You
can create your own catalog to represent other areas of functionality in Teamcenter.
1. Open the Extensions\Linked Data Services folders, right-click an already-created protocol,
and choose New Service Catalog.
The New Service Catalog dialog box is displayed.

2. Enter the following information in the Service Catalog dialog box:

a. In the Name box, type the name you want to assign to the new catalog.

b. In the Title box, type the display name to the new catalog.

c. In the Description box, state the purpose of the catalog.

d. In the Version box, type the protocol version supported by the catalog.

e. In the Namespace box, type the namespace path.

f. In the Namespace Prefix box, type the prefix you want to assign.

g. In the URL ID box, type the uniform resource identifier to form the URL for this resource.

7-4 Integrating Applications Using Linked Data Framework PLM00027 12.2

Exposing additional services using Linked Data Framework

h. In the Include Types table, select the list of business objects that the catalog supports.

i. In the Exclude Types table, select the list of business objects that the catalog does not
support.

j. Click Finish.
The new catalog appears under the selected protocol instance.

3. To save the changes to the data model, choose BMIDE→Save Data Model on the menu bar or
click the Save Data Model button on the main toolbar.

Create a new Linked Data Framework service

The Linked Data Framework services are used to create factory APIs that are used programmatically
to link to external applications. These services are defined for a given catalog. If you create a catalog,
you must create the services comprising the catalog.
1. Open the Extensions\Linked Data Services folders, right-click the already-created catalog, and
choose New LDF Service.
The New LDF Service dialog box is launched.

2. Enter the following information in the New LDF Service dialog box:
a. In the Name box, type the name you want to assign to the new service.

b. In the Title box, type the display name to the new service. This appears in the service catalog.

c. In the Description box, state the purpose of the service.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 7-5

Chapter
Chapter 7: 7: Exposing
Exposing additional
additional services
services usingusing Linked
Linked Data Data Framework
Framework

d. In the URL ID box, type the uniform resource identifier. This forms the URL for the resource.

e. Click the arrow in the Service Type box to select the kind of service type, either a business
object type, generic, or an instance type.
• BOType
Specifies that the service being defined is based on a business object type.

• Generic
Specifies that the service being defined does not apply to a specific business object type.

• Instance
Specifies services for update, delete, and preview for a specified business object
instance.

f. Click the Browse button in the Resource Type box, and select the business object type,
such as ChangeItem.

g. Click one of the following buttons:

• Factory Interface
Creates the service factory. When you click Factory Interface, the following boxes
are populated:

o Resource Shape
Holds the URI required to get the resource shape (a data dictionary in RDF/JSON
output format) for a given business object type.

o Factory URI
Holds the URI for invoking this factory service.

7-6 Integrating Applications Using Linked Data Framework PLM00027 12.2

Exposing additional services using Linked Data Framework

• Delegate UI Service
Creates the service dialog box. Perform the following steps:

A. In the Delegated URI box, specify the delegated user interface URI for this service
implementation.

B. In the Hint Height box, specify the value for the height of the Delegated UI dialog
box in pixels.

C. In the Hint Width box, specify the value for the width of the Delegated UI dialog
box in pixels.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 7-7

Chapter
Chapter 7: 7: Exposing
Exposing additional
additional services
services usingusing Linked
Linked Data Data Framework
Framework

3. To save the changes to the data model, choose BMIDE→Save Data Model on the menu bar, or
click the Save Data Model button on the toolbar.

Create a Linked Data Framework service operation

For every service, you can associate four possible different REpresentational State Transfer (REST)
operation implementations: GET, POST, PUT, and DELETE.
1. Expand the Extensions\Linked Data Services folders.

2. Open the service factory to hold the new operation.

Tip
You must create a service factory before you create a service operation.

3. Right-click the service factory in which you want to create the new operation, choose Open, and
click the Operations tab.

7-8 Integrating Applications Using Linked Data Framework PLM00027 12.2

Exposing additional services using Linked Data Framework

4. Click the Add button on the Operations tab.

The New Service Operation wizard is launched.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 7-9

Chapter
Chapter 7: 7: Exposing
Exposing additional
additional services
services usingusing Linked
Linked Data Data Framework
Framework

5. Perform the following steps in the Link Data Framework (LDF) Service Operation dialog box:

a. In the Name box, type a unique name for that operation.

b. In the Function name box, type the API you want to assign for executing the service
operation.

c. Click the arrow in the REST Action box to select the REST operation type: GET, PUT,
POST, or DELETE. Only one operation with the selected REST action can be active.

d. Click the Operation Description button to type a complete description of the functionality
exposed through the service operation.

The Description Editor is displayed.

Follow these best practices:

• Describe what this operation does. Explain more than simply stating the method name.

7-10 Integrating Applications Using Linked Data Framework PLM00027 12.2

Exposing additional services using Linked Data Framework

• Make the description complete in its usefulness. Keep in mind the client application
developer while writing the content.

• Whenever appropriate, describe how each argument interrelates when this operation
completes.

• Use correct formatting with fixed and bold text where appropriate.

• Use correct Teamcenter terminology.

• Define acronyms before using them.

e. Click the Return Description button to type a complete description of what the service
operation returns. Follow these best practices:
• Describe what the output represents and provide high-level details of the output data. Do
not specify only the type of service data returned.

• Describe any partial errors returned.

• Specify returned objects that are created, updated, or deleted as part of service data.

• Use complete sentences.

• Use correct formatting with fixed and bold text where appropriate.

• Use correct Teamcenter terminology.

• Define acronyms before using them.

f. Click the Use Case button to describe how the user interacts with this operation to
accomplish the operation’s goal. Follow these best practices:
• Document when and why this operation can be consumed.

• Describe how operations interrelate to satisfy the use case (if there is interrelation
between operations).

• Use complete sentences.

• Specify all possible use cases.

• Use correct formatting with fixed and bold text where appropriate.

• Use correct Teamcenter terminology.

• Define acronyms before using them.

g. Click the Library button to select the library where the API is defined, for example,
Lis0lisfmwrk.

h. Examine the contents of the preview pane.

i. Click Finish.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 7-11

Chapter
Chapter 7: 7: Exposing
Exposing additional
additional services
services usingusing Linked
Linked Data Data Framework
Framework

The new service operation displays on the Operations tab. To see the characteristics of the
operation, select it and click Operation Definition on the right side of the editor.

6. To save the changes to the data model, choose BMIDE→Save Data Model on the menu bar, or
click the Save Data Model button on the main toolbar.

7. You must also implement the operation in C++. A sample implementation of a GET operation is
as follows:
#include <fclasses/tc_string.h>
#include <tc/tc.h>
#include <fclasses/tc_string.h>
#include <base_utils/ScopedPtr.hxx>
#include <base_utils/ScopedSmPtr.hxx>
#include <base_utils/SharedPtr.hxx>
#include <base_utils/Mem.h>
#include <tc/tc_util.h>
#include <fclasses/tc_types.h>
#include <tccore/aom_prop.h>
#include <Lis0lisfmwrk/LisfmwrkUtils.hxx>
#include <Lis0lisfmwrk/lis_defines.h>
#include <Lis0lisfmwrk/Lis0lisfmwrk_errors.h>
#include <Lis0lisfmwrk/toolkit/AbstractResource.hxx>
#include <Lis0lisfmwrk/lis_factory.h>
#include <Lis0lisfmwrk/Lis0JsonWriter.hxx>
#include <metaframework/BusinessObject.hxx>
#include <metaframework/BusinessObjectRef.hxx>

using namespace Teamcenter;

using namespace std;
using namespace lis0lisfmwrk;
/**
Retrieves an object factory Lifecycle Interoperability Services (LIS) service
<br/>It will retrieve the object information (attributes names and values) based on
resourceshape.
<br/>Open Services for Lifecycle Collaboration (OSLC) defines the ResourceShape resource
to allow the specification of a list of properties with allowed values.
In teamcenter, OSLC resource will be the object type and its properties.
<br/>This object information is returnnd in JSON format.
<br/>This method is invoked in case of get object factory request given from REST client
for GET rest action.
<br/>e.g. REST client request.
<br/>Rest action - GET.
<br/>URL http://localhost:8080/lis/oslc/cm/BO?uid=g0bRF0$RI_JGwA
@returns
<ul>
<li>#ITK_ok on success.
<li>#LIS0LISFMWRK_valid_attr_helper_not_found if the LisAttributeHelper is not valid.
<br/>The LisAttributeHelper maps the Teamcenter properties with Open Services for Lifecycle
Collaboration (OSLC) core properties. It can be created through the utility
'create_botype_reader'
<li>#LIS0LISFMWRK_valid_writer_not_found if valid media writer not for generating output JSON
xml.
</ul>
*/
int LIS_get_object_factory( const char *request_body, /**< (I) Request BODY in JSON format. */
char **response /**< (OF) Response in JSON format. */
)
{
int ifail = ITK_ok;
ResultStatus rstat;
PomResultStatus pomStat;
std::string responseStr;
try
{
std::string reqMediaType = "application/json";
tag_t mediaWriterTag = lis0lisfmwrk::Lis0MediaWriterImpl::getMediaWriter( reqMediaType,
true );
if ( mediaWriterTag == NULLTAG )
{
rstat = LIS0LISFMWRK_media_writer_not_exist;
}
POMRef<lis0lisfmwrk::Lis0MediaWriterImpl> mediaWriterImpl( mediaWriterTag );
std::string reqBody = request_body;
lis0lisfmwrk::AbstractResource *resourceModel = new lis0lisfmwrk::AbstractResource();
scoped_ptr <lis0lisfmwrk::AbstractResource> freeResource1( resourceModel );
if ( mediaWriterImpl != 0 )
{
// write the document
rstat = mediaWriterImpl->lis0ReadFrom( &reqMediaType, &reqBody, &resourceModel );
}
//Get the urlParameter attribute(UID=XXX) here from JSON

7-12 Integrating Applications Using Linked Data Framework PLM00027 12.2

Exposing additional services using Linked Data Framework

std::string uidParam = resourceModel->getSimpleStringPropertyValue(URL_PARAMETER);

std::string catalogTitle = resourceModel->getSimpleStringPropertyValue(CATALOG_TITLE);
std::string queryParam = uidParam;
std::string objUid = "";
LisDataUtils::parseRequestParamaterToGetUid(queryParam, &objUid);
tag_t objTag = NULLTAG;
lis0lisfmwrk::AbstractResource *outResourceModel = 0;
Lis0ResourceShapeUtils *resourceShapeUtils = new lis0lisfmwrk::Lis0ResourceShapeUtils();
scoped_ptr <lis0lisfmwrk::Lis0ResourceShapeUtils> freeUtil( resourceShapeUtils );
if(!objUid.empty())
{
bool tag_valid = false;
rstat = LisDataUtils::checkObjectUIDIsValidOrNot(objUid, tag_valid, objTag);
if(tag_valid)
{
rstat = resourceShapeUtils->getBoResourceShape( objTag, objUid, catalogTitle,
&outResourceModel );
}
}
else
{
throw IFail( LIS0LISFMWRK_input_invalid_request);
}
std::string requiredMediaType = "application/json";
// write the resource model to document
rstat = LisDataUtils::addEtagToResourceModel(objTag, &outResourceModel);
rstat = LisDataUtils::generateOutputFromResourceModel( outResourceModel,
&requiredMediaType, &responseStr );
scoped_ptr<lis0lisfmwrk::AbstractResource> freeoutResourceModel( outResourceModel );
*response = SM_string_copy(responseStr.c_str());
}
catch(const IFail& ex)
{
ifail = ex.ifail();
Teamcenter::Lis0lisfmwrk::logger()->error( ERROR_line, ifail,
"LIS_get_object_factory failed with error[%d]\n",
ifail );
}
return ifail;
}

Create a new class to support the newly created service catalog

To support the new service catalog:
1. Create a new class as a subclass of the Osl0ResourceAttrHelper class.
For example, if the new service catalog supports Requirement Management, the class name
could be Cus0RMResourceAttrHelper.

2. Implement the lis0updateCompundAttributesBase() API if you require custom processing when

retrieving or updating properties on a business object that is supported by the service catalog.

3. To register this class in Teamcenter, run the create_botype_reader utility with information about
the new class.
For example:
create_botype_reader -u=infodba -p=infodba -g=dba -mode=resource
-type=Cus0RMResourceAttrHelper -protocol=oslc -versions=2.0 -domain=rm

where
-domain specifies the URL identifier of the service catalog, and
-type specifies the name of the newly created class.

After you create service catalogs, services, service operations, and the new class in Business
Modeler IDE, deploy the template to Teamcenter.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 7-13

Chapter 8: Customizing Linked Data Framework

Customize mapping between Teamcenter and external applications

using the semantic mapping file
For data linking to work between Teamcenter and the external application, information on how
domains, objects, object properties, and relations are mapped between the two application need to be
defined (also known as semantic mapping). This information is defined for each domain as XML files.
For example, by default Teamcenter supports the core, and change management domains. Their
semantic mapping files are available in the TC_ROOT\install\osl0lisoslc directory and are named
as follows:
• lis_core_properties.xml

• lis_cm_properties.xml

When you create new domains you need to create a new semantic mapping file for that domain.

The structure of a semantic mapping file

PLM00027 12.2 Integrating Applications Using Linked Data Framework 8-1

Chapter
Chapter 8: 8: Customizing
Customizing Linked
Linked Data Data Framework
Framework

</RelationTypeMapping>

</DomainProperties>

NamespaceURI element
Specifies namespace information. Namespaces allow organization of data into separate categories
such for change management or requirements management.

This element contains the following tag:

Tag name Tag attribute Attribute description

Namespace namespacePrefix Name of the namespace
namespaceValue Value or URI of the namespace

TypeURIMapping element
Specifies the URI of the semantic type. Semantic type refers to an OSLC resource such as Change
Request or Requirement.

This element contains the following tag:

Tag name Tag attribute Attribute description

SemanticType name Name of the semantic type
uri Unique resource identifier of the semantic type

ExternalSemanticType element
Specifies details for a specific semantic type such as Change Request.

8-2 Integrating Applications Using Linked Data Framework PLM00027 12.2

Customizing Linked Data Framework

<ExternalSemanticType domain="cm" name="ChangeRequest" extends="CoreBO">

This element contains the following tags:

Tag name Tag attribute Attribute description

ExternalSemantic domain The domain name. This value must match the
Type service catalog name in Business Modeler IDE.
name Name of the semantic type
extends The semantic type from where this semantic type
is derived
Creation urlId The URL ID of the Creation Delegated UI. This
DelegatedUI value must match the value in the URL ID field
of the create dialog service in Business Modeler
IDE.
Selection urlId The URL ID of the Selection Delegated UI. This
DelegatedUI value must match the value in the URL ID field of
the select dialog service in Business Modeler IDE.
AttrDef name Name of the attribute, for example,
oslc_cm:closeDate.
ldfOccurs The number of times the attribute occurs. Valid
values are:
• exactly_one
• zero_or_one
• zero_or_many
• one_or_many
• any

PLM00027 12.2 Integrating Applications Using Linked Data Framework 8-3

Chapter
Chapter 8: 8: Customizing
Customizing Linked
Linked Data Data Framework
Framework

8-4 Integrating Applications Using Linked Data Framework PLM00027 12.2

Customizing Linked Data Framework

Tag name Tag attribute Attribute description

ldfRange Specifies the range of the property as per OSLC
specifications. Valid values are:
• na
• any
ldfTitle Specifies the title of the attribute
ldfReadOnly Specifies whether clients can change attribute
value after the resource is created. Valid values
are:
• true
• false

TypeMapping element
Specifies the Teamcenter object types that are mapped to a semantic type.

This element contains the following tag:

Tag name Tag attribute Attribute description

TypeMapping targetType Name of the semantic type
TcTypeMapping srcTcType Teamcenter object type. This name must be the
same as the name of the object type in Business
Modeler IDE. Case sensitive.

TypeAttrMapping element
Maps the attributes of the Teamcenter object types to the semantic types. The Teamcenter
object types were define in the TypeMapping element and the semantic types were defined in
the ExternalSemanticType element.
The attributes of a semantic type can be mapped to multiple Teamcenter object types.

This element contains the following tags:

Tag name Tag attribute Attribute description

TypeAttrMapping targetType Name of the semantic type

PLM00027 12.2 Integrating Applications Using Linked Data Framework 8-5

Chapter
Chapter 8: 8: Customizing
Customizing Linked
Linked Data Data Framework
Framework

Tag name Tag attribute Attribute description

AttrMapping srcTcType Teamcenter object type.
srcTcAttr Teamcenter object type attribute
targetSemanticAttr Attribute of the semantic type

Note
The releaseDate attribute from srcTcType is mapped to oslc_cm:closeDate attribute.
This mapping is applicable only for the Teamcenter type Change Request and its
subclasses.
The status attribute from srcTcType is mapped to oslc_cm:status attribute. This mapping
is applicable only for the Teamcenter type ProblemReport and its subclasses.

RBTypeAttrMapping element

Maps semantic types to the runtime Teamcenter object types. These runtime Teamcenter object
types are used to represent the semantic types in the Relations application.
By default, the Ldf0TempLinkRuntime object type is mapped to the CoreBO semantic type and the
Lcm1ChangeRequest object type is mapped to the ChangeRequest semantic type.
You must map other custom object types to the semantic types.

<RBTypeAttrMapping SemanticType="ChangeRequest" RBType="Lcm1ChangeRequest">

This element contains the following tags:

Tag name Tag attribute Attribute description

RBTypeAttr SemanticType Name of the semantic type
Mapping RBType Name of the Teamcenter runtime object type
RBAttrMapping SemanticAttr Attribute name of the semantic type
RBTypeAttr Attribute name of the runtime Teamcenter object
type

RelationTypeMapping element

Maps Teamcenter relation type with the relation type of the semantic element.

8-6 Integrating Applications Using Linked Data Framework PLM00027 12.2

Customizing Linked Data Framework

If the external application uses a custom relation that is not part of the OSLC specification, ensure
that you update this section, else backlinks may not be created.
If you have created a custom object, ensure that the relations are defined as properties of the custom
object in Business Modeler IDE. If you do not do this, the links will not appear in the Remote Links
table after they are created.
This element contains the following tags:

Tag name Tag attribute Attribute description

RelationType targetType Name of the semantic type
Mapping
TcRelation srcTcRelationType Teamcenter relation type
Mapping consumerRelation Specifies the relation to use when Teamcenter as
a consumer creates remote links in the external
application.
In case of backlink creation from the external
application, this will create the relation specified
in the srcTcType attribute.
providerRelation Specifies what relation to use when creating
backlinks to the external application.

Post update steps

After updating the semantic mapping file perform the following steps:
1. Validate the semantic mapping file using the create-botype_reader utility. When you use the
–f=validate argument, this utility validates the Teamcenter types as well as the types specified in
the extends clause.

create_botype_reader -u=infodba -p=${TC_USER_PASSWD} -g=dba -mode=map_schema

-domain=core -file=${TC_INSTALL_DIR}/osl0lisoslc/lis_custom_properties.xml
-f=validate

The output of this utility run is a file named semantic_data.csv. This file lists the TypeMapping
and RelationTypeMapping entries in your semantic mapping file. Check if the mapping is correct.

2. Store the semantic mapping file to the database using the create-botype_reader utility. When
you use the –f=create argument, this utility stores the semantic mapping file to the database.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 8-7

Chapter
Chapter 8: 8: Customizing
Customizing Linked
Linked Data Data Framework
Framework

create_botype_reader -u=infodba -p=${TC_USER_PASSWD} -g=dba –f=create

-mode=map_schema -domain=core
-file=${TC_INSTALL_DIR}/osl0lisoslc/lis_custom_properties.xml

3. (Optional) List the semantic types: Using the create-botype_reader utility you can list the
semantic mapping entries that were saved to the database. Use the –f=list argument.

create_botype_reader -u=infodba -p=${TC_USER_PASSWD} -g=dba -mode=map_schema

-domain=core -f=list –file=d:\sematic_data.csv

Configuring the Creation Delegated UI dialog

When Teamcenter acts as a Provider, the creation dialog (Teamcenter interface) rendered in the
external application shows the list of Teamcenter types. To make these types appear, do the following:
• Update the TypeMapping element of the semantic mapping file.
Ensure you update the correct semantic mapping file. The semantic types are available in the
following location:
o Core: TC_ROOT\install\osl0lisoslc\lis_core_properties.xml

o Change management: TC_ROOT\install\osl0lisoslc\lis_cm_properties.xml

o Requirement management: TC_ROOT\install\ lrm0lisrm \lis_rm_properties.xml

The TypeMapping element must have the targetType and srcTcType.

o targetType: Specifies semantic type

o srcTcType: Specifies Teamcenter types

For example, while adding links to the remote system, if you want to add Part and System Block
types in addition to the already existing Item type as part of the CoreBO semantic type, update
the TypeMapping element as follows:

Note
Abstract Teamcenter types must not be mapped to the semantic types.

• If you are updating existing semantic mapping files, delete the named references of these
semantic mapping files that are associated with the following datasets:
o Core: Dataset = oslc_core_attr_ds, Named reference = lis_core_properties.xml

8-8 Integrating Applications Using Linked Data Framework PLM00027 12.2

Customizing Linked Data Framework

o Change management: Dataset = oslc_cm_attr_ds Named reference =

lis_cm_properties.xml

o Requirement management: Dataset = oslc_rm_attr_ds Named reference =

lis_rm_properties.xml

• Run the create-botype_reader utility using the –f=create argument to update the semantic
mapping file.

Create custom icons for semantic types

See the Type icon overview topic in the Active Workspace Deployment and Configuration
documentation for information on how to add custom icons for semantic types.

Define the relations to apply when creating remote links

Consider the following when creating the XML file:

• The TcSemanticType is the Teamcenter object type.

• The RemoteSemanticType is the object type in the external application.

• The SemanticRelationType is the Teamcenter relation type.

• If you do not create a definition for a Teamcenter object type, the parent object definition is
used when you create a remote link. For example, if no definition is created for change
notice, the change item definition is used when creating remote links. Similarly, if no definition
is created for the change item, the item definition is used when creating remote links.

2. Add these definitions to the database using the maintain_ldf_semantics utility, using the
–create argument.

3. Apply the definitions for each service provider as follows:

PLM00027 12.2 Integrating Applications Using Linked Data Framework 8-9

Chapter
Chapter 8: 8: Customizing
Customizing Linked
Linked Data Data Framework
Framework

a. In Organization, from the Organization List→Lifecycle Data Framework Providers, select

a service provider.

b. In the Semantics list, click Add/Remove.

c. In the Semantics dialog box, select the semantic relations you want from the Available
Semantics list and add them to the Selected Semantics list.

d. Click OK.

e. Click Modify.

4. Verify if the relation types appear when you create a remote link.

Note
When you upgrade to Teamcenter version 11.5, some relation types will not be available.
For a list of the available relations, see Changes in semantic relations in Teamcenter
11.5 onwards.

Example of the XML file containing definitions:

<?xml version="1.0" encoding="UTF-8"?>

<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>ChangeRequest</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>Requirement</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>

<SemanticKey>
<TcSemanticType>ChangeRequest</TcSemanticType>
<RemoteSemanticType>CoreBO</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>Requirement</TcSemanticType>
<RemoteSemanticType>CoreBO</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>

8-10 Integrating Applications Using Linked Data Framework PLM00027 12.2

Customizing Linked Data Framework

Customizations to show Linked Data Framework objects and

relations in the Relations tab
The Relations tab in Active Workspace allows you to view the relationship between objects in
Teamcenter.

For more information about configuring the Relations application, see the Active Workspace Help
Collection.
You can add objects and relations supported by Linked Data Framework to views in the Relations
application as follows:
1. Create runtime object types in Business Modeler IDE that correspond to the object types in the
external application by extending the existing Teamcenter runtime objects. For example, for a
change request in the external application, extend the runtime Lcm1ChangeRequest object in
Business Modeler IDE, which maps to the defect object. For Polarion objects, corresponding
Teamcenter objects are created by default.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 8-11

Chapter
Chapter 8: 8: Customizing
Customizing Linked
Linked Data Data Framework
Framework

If you have added a custom domain, extend the Ldf0TempLinkRuntimeObject runtime business
object to represent the custom semantic types.

2. Update the RBTypeAttrMapping element in the semantic mapping file to map the semantic type
to the Teamcenter runtime business object type.

3. Update the Relations configuration file with information about the extended semantic types
and semantic relations. The RV1_DARB_UI_configuration_file_name preference specifies
the name of this configuration file.
For more information about updating the Relations configuration file, see the Active Workspace
Help collection.

4. Configure Relations tab for remote system objects.

Customize Active Workspace page to create links

In Active Workspace, by default, the Create Link user interface section is only available in the
Reference tab of a change. If you want the Create Link user interface section to appear in other
pages of Active Workspace, you must customize the stylesheets of these objects.
An example of creating Linked Data Framework links for an item revision and displaying the links in
the Attachments tab is as follows:
1. Create am XML file that contains the relations and the properties to be displayed in the Create
Link user interface section.
For example, create an XML file called coreRemoteLinksSummarySection.xml as follows:

8-12 Integrating Applications Using Linked Data Framework PLM00027 12.2

Customizing Linked Data Framework

2. Create a dataset with the same name as the XML file you created in the previous step and
associate the XML file to this dataset as a named reference.
For example, create a dataset named coreRemoteLinksSummarySection and associate the
coreRemoteLinksSummarySection.xml file to this dataset as a named reference.

3. Add the XML file you created in the previous step to the stylesheet of the business object using
the inject argument.
For example, to add the Create Link user interface in the Attachments tab of an Item Revision,
do the following:

a. In My Teamcenter, open the summary stylesheet for the object . For the item revision, the
name of the summary stylesheet is Awp0ItemRevSummary.

b. Add the inject statement where you want the Remote Links user interface to appear.
For example, to make the Remote Links user interface to appear in the Attachments tab,
update the Attachments page element with the following inject statement:

<inject type="dataset" src="coreRemoteLinksSummarySection"/>

You can see the complete XML code of the Attachments page element at the end of this
topic:

4. Save the changes to the stylesheet.

5. Restart the Teamcenter pool manager.

6. Clear the browser cache and log on to Active Workspace.

Attachments page element example

</page>
<page titleKey="attachments">
<section titleKey="tc_xrt_Files">
<objectSet source="IMAN_specification.Dataset,IMAN_reference.Dataset,
IMAN_manifestation.Dataset,IMAN_Rendering.Dataset,TC_Attaches.Dataset,
IMAN_UG_altrep.Dataset,IMAN_UG_scenario.Dataset,IMAN_Simulation.Dataset"
defaultdisplay="listDisplay" sortby="object_string"
sortdirection="ascending">
<tableDisplay>
<property name="object_string"/>
<property name="object_type"/>
<property name="relation" modifiable="true"/>
<property name="release_status_list"/>
<property name="date_released"/>
<property name="owning_user"/>

PLM00027 12.2 Integrating Applications Using Linked Data Framework 8-13

Chapter
Chapter 8: 8: Customizing
Customizing Linked
Linked Data Data Framework
Framework

</tableDisplay>
<thumbnailDisplay/>
<listDisplay/>
<command actionKey="newBusinessObjectContextualAction"
commandId="com.teamcenter.rac.common.AddNew"
renderingHint="commandbutton"/>
<command actionKey="pasteAction"
commandId="com.teamcenter.rac.viewer.pastewithContext"
renderingHint="commandbutton"/>
<command actionKey="cutAction" commandId="org.eclipse.ui.edit.cut"
renderingHint="commandbutton">
<parameter name="localSelection" value="true"/>
</command>
</objectSet>
</section>
<section titleKey="tc_xrt_Documents">
<objectSet source="IMAN_specification.DocumentRevision"
sortdirection="ascending" sortby="object_string"
defaultdisplay="listDisplay">
<tableDisplay>
<property name="object_string"/>
<property name="object_type"/>
<property name="release_status_list"/>
<property name="date_released"/>
<property name="owning_user"/>
</tableDisplay>
<thumbnailDisplay/>
<listDisplay/>
<command actionKey="newBusinessObjectContextualAction"
commandId="com.teamcenter.rac.common.AddNew"
renderingHint="commandbutton"/>
<command actionKey="pasteAction"
commandId="com.teamcenter.rac.viewer.pastewithContext"
renderingHint="commandbutton"/>
<command actionKey="cutAction" commandId="org.eclipse.ui.edit.cut"
renderingHint="commandbutton">
<parameter name="localSelection" value="true"/>
</command>
</objectSet>
</section>
<inject type="dataset" src="coreRemoteLinksSummarySection"/>
</page>

Querying attributes of remote objects and receiving notifications

from remote systems
Querying attributes of remote objects

Suppose you have started a change workflow and the object in the external application is related to
that workflows Targets, References, or is itself a target. The workflow can only proceed forward if
the object in the external application is in a particular state, for example status is closed. To check

8-14 Integrating Applications Using Linked Data Framework PLM00027 12.2

Customizing Linked Data Framework

the state of the object in the external application, you can use the LDF-sync-ldf-status rule handler
in your workflow.

Receiving notifications from remote systems

Remote systems can use the Linked Data Framework Notify service to notify Teamcenter about
changes. If you want the remote system to advance a workflow, the remote system should call the
notify service which then calls the EPM_trigger_advancer workflow API. This workflow API can
then advance the workflow.

Workflow handlers for performing operations on remote objects

You can use the following workflow handlers to perform operations on objects in remote systems:
• The LDF-create-object workflow handler creates an object in the remote system and relates it
to the workflow attachment.

• The LDF-set-task-result-to-property handler reads the specified property from the remote
object and updates its task result.

• The LDF-sync-ldf-status handler queries attributes of remote objects to determine the state
of the remote object.

Embedded Software Management customizations

The Embedded Software Management functionality uses Linked Data Framework to create links
between Embedded Software Management components and artifacts in external applications.
You must follow configuration and customization steps for Linked Data Framework to extend the
Embedded Software Management linking functionality. This topic give you additional information
about customization options:
• By default, only the Software component of Embedded Software Management is mapped to the
Software Release artifact in Polarion. You can map other Embedded Software Management
components to Polarion components by updating the lis_esm_properties.xml file in the
oslc_esm_attr_ds dataset.

Example

PLM00027 12.2 Integrating Applications Using Linked Data Framework 8-15

Chapter
Chapter 8: 8: Customizing
Customizing Linked
Linked Data Data Framework
Framework

• Update the RevisionSummary and RevisionSummaryForShowObjectLocation stylesheets of

the Embedded Software Management components so that the Remote Links table is enabled.
Use the following inject statement:

<inject type="dataset" src="les1RemoteLinksSummarySection"/>

• By default, the Architecture tab in Active Workspace is enabled only for the Software
Architecture component. To enable it for other components, update the Awb0AvailableFor
constant with the appropriate value of the component.

• To restrict what type of relations you can create between two occurrences, create a preference in
the format primary_type_name_secondary_type_name_allowed_relations.

Example
To restrict the relation between Software Revision and Processor Revision to
Compatible Link, create a preference named Software Revision_Processor
Revision_allowed_relations and in the value section add Esw0CompatibleLink.

To find the names of the Embedded Software Management components, load the
esw0esmgmt_schema.xml template in Business Modeler IDE.

8-16 Integrating Applications Using Linked Data Framework PLM00027 12.2

Chapter 9: Using Linked Data Framework

For more information about how you can create links to external applications using Linked Data
Framework, see the Change Management documentation in Active Workspace help collection.
You can also upload software binary or software package files from a software artifact to Teamcenter.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 9-1

Chapter 10: Using Linked Data Framework REST APIs to
create and update Teamcenter resources

Linked Data Framework allows external applications to programmatically create, update, and query
Teamcenter resources using REST action. These REST actions are HTTP based interfaces that
usehttp methods such as GET, POST, PUT, DELETE, HTTP response codes, content type handling,
and resource formats.
You can use a REST client to access the URLs for creating, querying, and updating the supported
Teamcenter resources as follows:
• Use the GET method and the root services URL to obtain an XML file. In the XML file, search for
the Service Provider Catalog URL.

• Using this URL, log on to Teamcenter.

• In the XML file that appears, find the Creation Factory and Query Factory URLs.

• Use the Creation Factory URL to create a Teamcenter resource and the Query Factory URL to
query Teamcenter resources.

Use the following methods along with the relevant URLs:

Method name Description

GET Queries a resource
POST Creates a resource
PUT Updates a resource
DELETE Deletes a resource

The following header information is required for the REST method invocation:

Method name Header information

GET Accept: application/rdf+xml OR application/json
OSLC-Core-Version: 2.0

POST Content-Type: application/rdf+xml OR application/json

OSLC-Core-Version: 2.0

PUT Accept: application/rdf+xml

Content-Type: application/rdf+xml OR application/json
OSLC-Core-Version: 2.0
If-Match:
DELETE Accept: application/rdf+xml
OSLC-Core-Version: 2.0
If-Match:

PLM00027 12.2 Integrating Applications Using Linked Data Framework 10-1

Chapter
Chapter 10:10:UsingUsing Linked
Linked Data Data Framework
Framework RESTREST
APIs APIs to create
to create and update
and update Teamcenter
Teamcenter resources
resources

Where:
application/rdf+xml Providers must respond with RDF/XML representation.
application/json Providers must respond with JSON representation.
If-Match Contains the eTag that determines the state of the
resource.
Content-Type Specifies the input content type to all OSLC providers.
OSLC-Core-Version Specifies the supported version of the OSLC specification.

You must pass the RDF/XML or JSON as input when you use the REST APIs.

GET action
Description
Retrieves all information about a specific Teamcenter resource by making an HTTP GET request
to the Query Factory URL.
Headers Accept: application/rdf+xml OR application/json
OSLC-Core-Version: 2.0

Resource URI URL of the Teamcenter resource that contains its UID.
Method GET

Response information
Response headers
Status code 200: Successful. Response body contains all the information of the resource.
Status code 500: Resource does not exist. Response body will show error message from
Teamcenter. For example, The specified tag has been deleted, cannot find requested object
Response body
JSON or RDF+XML.

Example
Method: GET
Resource URI: http://pni6w2071.net.plm.eds.com:7001/lis/oslc/cm/BO?uid=AaYhvJClYj1eHD
Headers:

OSLC-Core-Version: 2.0
Accept: application/json

Response header

Status Code: 200 OK

Content-Type: application/json;charset=UTF-8
Date: Tue, 18 Apr 2017 17:43:55 GMT

10-2 Integrating Applications Using Linked Data Framework PLM00027 12.2

Using Linked
Using Linked Data Framework REST APIs to create and update Teamcenter resources

Etag: AmXhvJClYj1eHD-AaYhvJClYj1eHD
OSLC-Core-Version: 2.0
Transfer-Encoding: chunked
X-Powered-By: Servlet/2.5 JSP/2.1

Response body

{
"dcterms:contributor": "18-Apr-2017 14:31",
"dcterms:created": "18-Apr-2017 14:31",
"dcterms:creator": "infodba",
"dcterms:description": "ECR-000035",
"dcterms:identifier": "ECR-000035",
"dcterms:modified": "18-Apr-2017 14:31",
"dcterms:subject": "ECR-000035",
"dcterms:title": "ECR-000035",
"etag": "AmXhvJClYj1eHD-AaYhvJClYj1eHD",
"oslc:instanceShape": "https:\/\/fanyv88.com:443\/http\/pni6w2071.net.plm.eds.com:7001\/lis\/oslc\/
resourceShape\/ChangeRequest",
"oslc:shortTitle": "ECR-000035",
"oslc_cm:affectedByDefect":
[
{
"dcterms:title": "https:\/\/fanyv88.com:443\/http\/pnv6s282.net.plm.eds.com:82\/polarion\/oslc\/
services\/projects\/elibrary\/workitems\/EL-204",
"rdf:resource": "https:\/\/fanyv88.com:443\/http\/pnv6s282.net.plm.eds.com:82\/polarion\/oslc\/
services\/projects\/elibrary\/workitems\/EL-204",
"rdf:type":
[
]
}
],
"oslc_cm:closeDate": "18-Apr-2017 14:31",
"prefixes":
{
"dcterms": "https:\/\/fanyv88.com:443\/http\/purl.org\/dc\/terms\/",
"oslc": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/core#",
"oslc_cm": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/cm#",
"rdf": "https:\/\/fanyv88.com:443\/http\/www.w3.org\/1999\/02\/22-rdf-syntax-ns#",
"rdfs": "https:\/\/fanyv88.com:443\/http\/www.w3.org\/2000\/01\/rdf-schema#",
"tc": "https:\/\/fanyv88.com:443\/http\/www.plm.automation.siemens.com\/ldf#"
},
"rdf:about": "https:\/\/fanyv88.com:443\/http\/pni6w2071.net.plm.eds.com:7001\/lis\/oslc\/cm\/
BO?uid=AaYhvJClYj1eHD",
"rdf:type":
[
{"rdf:resource": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/cm#ChangeRequest"}
]
}

PLM00027 12.2 Integrating Applications Using Linked Data Framework 10-3

Chapter
Chapter 10:10:UsingUsing Linked
Linked Data Data Framework
Framework RESTREST
APIs APIs to create
to create and update
and update Teamcenter
Teamcenter resources
resources

POST action
Description
Creates a resource in Teamcenter resource by making an HTTP POST request to the Creation
Factory URL.
Headers
OSLC-Core-Version:2.0
Content-Type: application/json
Content Body: It contain the resource which need to be created.

Resource URI URL of the Creation Factory.

Method POST

Response information
Response headers
Successful: Status code 200 with etag and location that contains the Reource URL.
Content body invalid: Status code 500. Response body will show error message from Teamcenter.
For example, The Media Reader has failed to parse the input JSON envelop/document. Check
the Teamcenter server syslog for more details.

Response body
JSON or RDF+XML.

Example
Method: POST
Resource URI: http://pni6w2071.net.plm.eds.com:7001/lis/oslc/cm/createfactory
Headers:

OSLC-Core-Version:2.0
Content-Type: application/json

Content body

{
"dcterms:description": "Test_factory_create1",
"dcterms:title": "Test_factory_create1",
"dcterms:type": "ChangeRequest",
"prefixes":
{
"dcterms": "https:\/\/fanyv88.com:443\/http\/purl.org\/dc\/terms\/",
"oslc": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/core#",
"oslc_cm": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/cm#",
"rdf": "https:\/\/fanyv88.com:443\/http\/www.w3.org\/1999\/02\/22-rdf-syntax-ns#",
"rdfs": "https:\/\/fanyv88.com:443\/http\/www.w3.org\/2000\/01\/rdf-schema#",
"tc": "https:\/\/fanyv88.com:443\/http\/www.plm.automation.siemens.com\/ldf#"
},
"rdf:about": "https:\/\/fanyv88.com:443\/http\/pni6w2071.net.plm.eds.com:7001\/lis\/oslc\/cm\/

10-4 Integrating Applications Using Linked Data Framework PLM00027 12.2

Using Linked
Using Linked Data Framework REST APIs to create and update Teamcenter resources

createfactory",
"rdf:type":
[
{"rdf:resource": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/cm#ChangeRequest"}
]
}

Response header

Status Code: 200 OK

Content-Length: 0
Content-Type: application/json; charset=UTF-8
Date: Wed, 19 Apr 2017 08:18:16 GMT
Etag: QtWhvlNkYj1eHD-QhYhvlNkYj1eHD
Location: http://pni6w2071.net.plm.eds.com:7001/lis/oslc/cm/BO?uid=QhYhvlNkYj1eHD
OSLC-Core-Version: 2.0
X-Powered-By: Servlet/2.5 JSP/2.1

PUT action

Description
Updates content of a specific resource in Teamcenter by making an HTTP PUT request to the
resource URL.
Headers
Content-Type: application/rdf+xml, application/json
OSLC-Core-Version: 2.0

If-Match = Eta, make sure that changes are applied to the state of the
resource that has been fetched from the server.
Resource URI Reource URL that contains the Teamcenter resource UID.
Method PUT
Content body Contains the resource that needs to be updated.
Before using PUT, use the GET method on the Teamcenter resource,
which will return the response body and Etag in response header. Use the
Etag in the IF-match of the PUT request.

Response information
Response headers
Successful: Status code 200 with Etag containing the state of the resource.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 10-5

Chapter
Chapter 10:10:UsingUsing Linked
Linked Data Data Framework
Framework RESTREST
APIs APIs to create
to create and update
and update Teamcenter
Teamcenter resources
resources

Note
Avoid overwriting changes done by someone else. A resource may have changed in
the time between fetching it, doing modifications and sending it back. Clients must not
blindly overwrite work item contents but ensure that the changes are applied to the
state that they fetched from the server. This is done by including the Etag received on
load in the If-Match header when updating the work item back to the server using PUT.
If the state of the server is still the same, the update will succeed with a 200OK status.
If the work item was modified, it will fail with a 412 Precondition Failed status.

Response body
JSON or RDF+XML.

Example
Method: PUT
Resource URI: http://pni6w2071.net.plm.eds.com:7001/lis/oslc/cm/BO?uid=AaYhvJClYj1eHD
Headers:

Content-Type: application/rdf+xml
OSLC-Core-Version: 2.0
If-Match = QxWhfFXKYjj4JA-QlXhfFXKYjj4JA

Content body

<rdf:RDF
xmlns:rdf=http://www.w3.org/1999/02/22-rdf-syntax-ns#
xmlns:oslc="http://open-services.net/ns/core#"
xmlns:dcterms="http://purl.org/dc/terms/"
xmlns:j.0=http://open-services.net/ns/cm#
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#">
<j.0:ChangeRequest rdf:about="http://pni6w2071.net.plm.eds.com:7001/lis/oslc/
cm/BO?uid=AaYhvJClYj1eHD">
<dcterms:title>Test_factory_create1_update</dcterms:title>
<dcterms:description>Test_factory_create1_update</dcterms:description>
</j.0:ChangeRequest>
</rdf:RDF>

Response header

Status Code: 200 OK

Content-Length: 0
Content-Type: application/json; charset=UTF-8
Date: Tue, 18 Apr 2017 17:56:23 GMT
Etag: gdRhvlMUYj1eHD-AaYhvJClYj1eHD
OSLC-Core-Version: 2.0
X-Powered-By: Servlet/2.5 JSP/2.1

10-6 Integrating Applications Using Linked Data Framework PLM00027 12.2

Using Linked
Using Linked Data Framework REST APIs to create and update Teamcenter resources

DELETE action
Description
Deletes a resource in Teamcenter by making an HTTP DELETE request to the resource URL.
Headers
Accept : application/rdf+xml
OSLC-Core-Version :2.0
Content-Type : application/rdf+xml OR application/json

Resource URI Reource URL that contains the Teamcenter resource UID.
Method DELETE

Response information
Response headers
Successful deletion: Status code 200
Response body
JSON or RDF+XML.

Example
Method: DELETE
Resource URI: http://pni6w2071.net.plm.eds.com:7001/lis/oslc/cm/BO?uid=AaYhvJClYj1eHD
Headers:

Accept : application/rdf+xml
OSLC-Core-Version :2.0

Response header

Status Code: 200 OK

Content-Length: 0
Content-Type: application/json; charset=UTF-8
Date: Wed, 19 Apr 2017 06:21:48 GMT
OSLC-Core-Version: 2.0
X-Powered-By: Servlet/2.5 JSP/2.1

QUERY action
Description
Queries resources in Teamcenter by making HTTP GET requests to the query URL. Optionally,
this can be filtered with a where clauses.
Headers
Accept: application/rdf+xml OR application/json
OSLC-Core-Version: 2.0

Resource URI URL of the Query Factory.

PLM00027 12.2 Integrating Applications Using Linked Data Framework 10-7

Chapter
Chapter 10:10:UsingUsing Linked
Linked Data Data Framework
Framework RESTREST
APIs APIs to create
to create and update
and update Teamcenter
Teamcenter resources
resources

Method GET
Query Parameters
Parameter Type Description
oslc.where string Name of the oslc properties that
must be queried. Supported
properties include:
• dcterms:type
• dcterms:description
• dcterms:title
• dcterms:subject
• dcterms:identifier
• oslc:shortTitle

Response information
Response headers
Successful: Status code 200: List of resources.
Status code 404: Not Found: The Registry Helper has failed to process the request, because
no valid Provider Catalogue exists.
Status code 500: Internal Server Error: The specified type does not exist.
Response body
JSON or RDF+XML.

Example 1
Method: GET
Query URL: http://pni6w11193:7001/lis/oslc/core/queryfactory
Headers:

OSLC-Core-Version: 2.0
Accept: application/json

Response header

Status Code: 200 OK

Content-Type: application/json;charset=UTF-8
Date: Wed, 06 Jun 2018 07:18:40 GMT
OSLC-Core-Version: 2.0
Transfer-Encoding: chunked
X-Powered-By: Servlet/3.0 JSP/2.2

Response body

{
"oslc:responseInfo":

10-8 Integrating Applications Using Linked Data Framework PLM00027 12.2

Using Linked
Using Linked Data Framework REST APIs to create and update Teamcenter resources

[
{
"oslc:totalCount": 3,
"rdf:type":
[
{"rdf:resource": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/core#ResourceInfo"}
],
"rdfs:member":
[
{"rdf:resource": "https:\/\/fanyv88.com:443\/http\/pni6w11193.net.plm.eds.com:7001\/lis\/oslc\/
core\/BO?uid=A3Yp8rIQ6jRptC"},
{"rdf:resource": "https:\/\/fanyv88.com:443\/http\/pni6w11193.net.plm.eds.com:7001\/lis\/oslc\/
core\/BO?uid=A5QpbDN06jRptC"},
{"rdf:resource": "https:\/\/fanyv88.com:443\/http\/pni6w11193.net.plm.eds.com:7001\/lis\/oslc\/
core\/BO?uid=A5bpsI2E6jRptC"},
]
}
],
"prefixes":
{
"dcterms": "https:\/\/fanyv88.com:443\/http\/purl.org\/dc\/terms\/",
"oslc": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/core#",
"rdf": "https:\/\/fanyv88.com:443\/http\/www.w3.org\/1999\/02\/22-rdf-syntax-ns#",
"rdfs": "https:\/\/fanyv88.com:443\/http\/www.w3.org\/2000\/01\/rdf-schema#",
"tc": "https:\/\/fanyv88.com:443\/http\/www.plm.automation.siemens.com\/ldf#"
},
"rdf:about": "https:\/\/fanyv88.com:443\/http\/pni6w11193.net.plm.eds.com:7001\/lis\/oslc\/
core\/queryfactory",
"rdf:type":
[
]
}

Example 2:
Method: GET
Query URL with where clause:
http://pni6w11193:7001/lis/oslc/core/queryfactory?oslc.where=dcterms:type=Item
Headers:

OSLC-Core-Version: 2.0
Accept: application/json

Response header

Status Code: 200 OK

Content-Type: application/json;charset=UTF-8
Date: Wed, 06 Jun 2018 07:26:47 GMT
OSLC-Core-Version: 2.0
Transfer-Encoding: chunked
X-Powered-By: Servlet/3.0 JSP/2.2

PLM00027 12.2 Integrating Applications Using Linked Data Framework 10-9

Chapter
Chapter 10:10:UsingUsing Linked
Linked Data Data Framework
Framework RESTREST
APIs APIs to create
to create and update
and update Teamcenter
Teamcenter resources
resources

Response body

{
"oslc:responseInfo":
[
{
"oslc:totalCount": 3,
"rdf:type":
[
{"rdf:resource": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/core#ResourceInfo"}
],
"rdfs:member":
[
{"rdf:resource": "https:\/\/fanyv88.com:443\/http\/pni6w11193.net.plm.eds.com:7001\/lis\/oslc\/
core\/BO?uid=A3Yp8rIQ6jRptC"},
{"rdf:resource": "https:\/\/fanyv88.com:443\/http\/pni6w11193.net.plm.eds.com:7001\/lis\/oslc\/
core\/BO?uid=A5QpbDN06jRptC"},
{"rdf:resource": "https:\/\/fanyv88.com:443\/http\/pni6w11193.net.plm.eds.com:7001\/lis\/oslc\/
core\/BO?uid=A5bpsI2E6jRptC"},
]
}
],
"prefixes":
{
"dcterms": "https:\/\/fanyv88.com:443\/http\/purl.org\/dc\/terms\/",
"oslc": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/core#",
"rdf": "https:\/\/fanyv88.com:443\/http\/www.w3.org\/1999\/02\/22-rdf-syntax-ns#",
"rdfs": "https:\/\/fanyv88.com:443\/http\/www.w3.org\/2000\/01\/rdf-schema#",
"tc": "https:\/\/fanyv88.com:443\/http\/www.plm.automation.siemens.com\/ldf#"
},
"rdf:about": "https:\/\/fanyv88.com:443\/http\/pni6w11193.net.plm.eds.com:7001\/lis\/oslc\/
core\/queryfactory\/?&oslc.where=dcterms:type=Item",
"rdf:type":
[
]
}

NOTIFY action

Description
Notifies Teamcenter about a change associated with the linked object, for example, a remote
system such as Polarion sends URLs of Teamcenter objects associated with the Polarion work
items whose status is changed.

10-10 Integrating Applications Using Linked Data Framework PLM00027 12.2

Using Linked
Using Linked Data Framework REST APIs to create and update Teamcenter resources

Headers
Accept: application/xml
Authorization: OAuth realm="Teamcenter",
oauth_token="bdce003d-5199-48d5-85fe-4c71f3e64cbd",
oauth_consumer_key="f013abe9-7258-42da-98da-5c1373c46546",
oauth_signature_method="HMAC-SHA1", oauth_timestamp="1526898982",
oauth_nonce="4589207281453928", oauth_version="1.0",
oauth_signature="vCUmLISgIgvxXEoR2Msi%2FQxmXGg%3D"
Content-Type: application/json
OSLC-Core-Version: 2.0
User-Agent: Wink Client v1.1.2
Content-Length: 1708
Host: pni6w11193.net.plm.eds.com:7001
Connection: Keep-Alive
Cookie: JSESSIONID=lQT8bCpGfgBjS2GW8LG8hpTB57kvr1YSW
cRqvPfsPgjZ2PLcSP2t!201170707
Cookie2: $Version=1

URI http://hostname/lis/oslc/custom/notify
Method POST
Content Body
{
."dcterms:created": "2018-05-21T16:04:33.073+05:30",
."dcterms:description": "<span style=\"font-size: 10pt;
line-height: 1.5;\">Nitin_CR_21May_003<\/span>",
."dcterms:identifier": "EL-333",
."dcterms:modified": "2018-05-21T16:05:45.240+05:30",
."dcterms:subject": [
.],
."dcterms:title": "Nitin_CR_21May_003",
."dcterms:type": "Change Request",
."oslc:serviceProvider": {
.."rdf:resource": "https:\/\/fanyv88.com:443\/http\/pnv6s435:82\/polarion\/oslc\/
services\/projects\/elibrary"
.},
."oslc:shortTitle": "EL-333",
."oslc_cm:closeDate": "2018-05-21T16:06:21.550+05:30",
."oslc_cm:closed": false,
."oslc_cm:fixed": true,
."oslc_cm:inprogress": false,
."oslc_cm:relatedChangeRequest": [
..{
..."dcterms:title": "Nitin_CR_21May_002_TC4",
..."rdf:resource": "https:\/\/fanyv88.com:443\/http\/pni6w11193.net.plm.eds.com:7001\/
lis\/oslc\/cm\/BO?uid=wldtg4FJ6jRptC"
..}
.],
."oslc_cm:status": "Approved",
."oslc_cm:verified": false,
."pol1:categories": [
.],
."pol1:previousStatus": "Reviewed",
."pol1:priority": "Medium",
."pol1:resolution": "Valid",

PLM00027 12.2 Integrating Applications Using Linked Data Framework 10-11

Chapter
Chapter 10:10:UsingUsing Linked
Linked Data Data Framework
Framework RESTREST
APIs APIs to create
to create and update
and update Teamcenter
Teamcenter resources
resources

."pol1:severity": "Should Have",

."pol1:status": "Approved",
."pol1:type": "Change Request",
."prefixes": {
.."dcterms": "https:\/\/fanyv88.com:443\/http\/purl.org\/dc\/terms\/",
.."ldf": "https:\/\/fanyv88.com:443\/http\/www.plm.automation.siemens.com\/ldf#",
.."oslc": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/core#",
.."oslc_cm": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/cm#",
.."oslc_rm": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/rm#",
.."pol1": "https:\/\/fanyv88.com:443\/http\/polarion.plm.automation.siemens.com\/oslc#",
.."siemens_esm": "https:\/\/fanyv88.com:443\/http\/www.plm.automation.siemens.com\/
ldf\/esm#"
.},
."rdf:about": "https:\/\/fanyv88.com:443\/http\/pnv6s435:82\/polarion\/oslc\/
services\/projects\/elibrary\/workitems\/EL-333",
."rdf:type": [
..{
..."rdf:resource": "https:\/\/fanyv88.com:443\/http\/open-services.net\/ns\/
cm#ChangeRequest"
..}
.]
}

Response Header
HTTP/1.1 201 Created
Date: Mon, 21 May 2018 10:36:22 GMT
Transfer-Encoding: chunked
Content-Type: application/xml; charset=UTF-8
OSLC-Core-Version: 2.0
X-Powered-By: Servlet/3.0 JSP/2.2

10-12 Integrating Applications Using Linked Data Framework PLM00027 12.2

Chapter 11: Tips, notes, and warnings

• If you receive a CSRF attack warning in your browser when connecting to Teamcenter, clear the
browser cache and log on again.

• When viewing Teamcenter information from the external application, the Show More and Show
Less links show the same content because they point to the same URL.

• If one user from the external application maps to more than one Teamcenter user, Teamcenter
will not be able to identify the correct user. This is because Teamcenter uses the same Oauth
user authentication that the external application uses to map its users.

• Linked Data Framework and Active Workspace must be deployed to the same domain of the web
app server. An inconsistency results in issues while rendering the delegated UI dialogs. This is
due to the Same Origin Policy that the browser implements.

• Although change management and core service catalogs are available by default, external
applications cannot identify the core service catalogs because the external applications do not
consume any Teamcenter namespaces.

• When using the PUT and DELETE REST operations, you must specify the Accept Header as
or application/json, even though these operations do not return any output.
application/rdf+xml

• Refer to the Active Workspace Customization Guide for information about customizing the
delegated UIs.

• Using the root services URL, you can discover other URLs that Linked Data Framework uses.
The following table lists URLs for the Change Management service, which is available by default:

Name Linked Data Framework URL

Root services http://<hostname>:portno/lis/oslc/rootservices
CM Catalog http://<hostname>:portno/lis/oslc/cm/catalogs
CM Service Provider http://<hostname>:portno/lis/oslc/cm/providers
CM Creation Factory http://<hostname>:portno/lis/oslc/cm/createFactory

PLM00027 12.2 Integrating Applications Using Linked Data Framework 11-1

Chapter
Chapter 11:11:Tips,Tips, notes,
notes, and warnings
and warnings

Name Linked Data Framework URL

CM Query Capability http://<hostname>:portno/lis/oslc/cm/queryFactory?...
where ... represents the query where clause. For
example:
?oslc.where=dcterms:identifier=”<ItemID>”
?oslc.where=dcterms:type=”<Type>”
?oslc.where=dcterms:title=”<ObjectName>”
?oslc.where=dcterms:type=”<Type>”&dcterms:title=”<Object
Name>”
?oslc.prefix=tc=<http://www.plm.automation.siemens.com/lis>&
oslc.where=tc:item_id=”<Item ID>”
?oslc.prefix=tc=<http://www.plm.automation.siemens.com/lis>&
oslc.where=dcterms:type=”<Type>”&tc:item_id=”<Item
ID>”
CM Creation Dialog http://<hostname>:portno/lis/oslc/cm/creator
CM Selection Dialog http://<hostname>:portno/lis/oslc/cm/selector
Resource http://<hostname>:portno/lis/oslc/cm/largepreview?uid=<UID>
Resource Small Preview http://<hostname>:portno/lis/oslc/cm/smallpreview?uid=<UID>
Resource Large Preview http://<hostname>:portno/lis/oslc/cm/largepreview?uid=<UID>
Resource Editor http://<hostname>:portno/lis/oslc/cm/editor?uid=<UID>
CM BO Preview Factory http://<hostname>:portno/lis/oslc/cm/BO?uid=<UID>
CM BO Editor Factory http://<hostname>:portno/lis/oslc/cm/BO?uid=<UID>
CM BO Delete Factory http://<hostname>:portno/lis/oslc/cm/BO?uid=<UID>
Listing resource data model of given http://<hostname>:port/oslc/cm/resourceShapes/<BOType>
BO Type

11-2 Integrating Applications Using Linked Data Framework PLM00027 12.2

Appendix A: Changes in semantic relations in
Teamcenter 11.5 onwards

You can define what relations to apply when you create a remote link between Teamcenter and the
external application. For example, you can define that when you create a remote link between a
change request in Teamcenter and an issue in the external application, the relation can be either
Lis0Reference or Lis0Specification. You can apply these relation definitions for each service
provider.
When you upgrade to Teamcenter version 11.5 or a later version, some relation types will not be
available.
Relations available in previous Teamcenter versions for CoreBO semantic types:
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>ChangeRequest</RemoteSemanticType>
<SemanticRelationType>Lcm0AffectedByDefect</SemanticRelationType>
<SemanticRelationType>Lcm0RelatedChangeRequest</SemanticRelationType>
<SemanticRelationType>Lcm0AffectsPlanItem</SemanticRelationType>
<SemanticRelationType>Lcm0ImplementedBy</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>Requirement</RemoteSemanticType>
<SemanticRelationType>Lcm0TracksRequirement</SemanticRelationType>
<SemanticRelationType>Lcm0AffectsRequirement</SemanticRelationType>
<SemanticRelationType>Lcm0ImplementsRequirement</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>ChangeRequest</TcSemanticType>
<RemoteSemanticType>CoreBO</RemoteSemanticType>
<SemanticRelationType>Lcm0TracksRequirement</SemanticRelationType>
<SemanticRelationType>Lcm0AffectsRequirement</SemanticRelationType>
<SemanticRelationType>Lcm0ImplementsRequirement</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>CoreBO</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>

Relations that are available in Teamcenter version 11.5 and later versions:
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>ChangeRequest</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>Requirement</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>RequirementCollection</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>Hardware</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>

PLM00027 12.2 Integrating Applications Using Linked Data Framework A-1

Appendix
Appendix A: A: Changes
Changes in semantic
in semantic relations
relations in Teamcenter
in Teamcenter 11.5 onwards
11.5 onwards

<RemoteSemanticType>SoftwareRelease</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>SoftwareArchitecture</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>ChangeRequest</TcSemanticType>
<RemoteSemanticType>CoreBO</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>
<SemanticKey>
<TcSemanticType>CoreBO</TcSemanticType>
<RemoteSemanticType>CoreBO</RemoteSemanticType>
<SemanticRelationType>Lis0Reference</SemanticRelationType>
<SemanticRelationType>Lis0Specification</SemanticRelationType>
</SemanticKey>

A-2 Integrating Applications Using Linked Data Framework PLM00027 12.2

Siemens Industry Software

Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000

Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499

About Siemens PLM Software

Siemens PLM Software, a business unit of the Siemens
Software Inc. Siemens and the Siemens logo are
Industry Automation Division, is a leading global provider
registered trademarks of Siemens AG. D-Cubed,
of product lifecycle management (PLM) software and
Femap, Geolus, GO PLM, I-deas, Insight, JT, NX,
services with 7 million licensed seats and 71,000 customers
Parasolid, Solid Edge, Teamcenter, Tecnomatix and
worldwide. Headquartered in Plano, Texas, Siemens
Velocity Series are trademarks or registered trademarks
PLM Software works collaboratively with companies
of Siemens Product Lifecycle Management Software
to deliver open solutions that help them turn more
Inc. or its subsidiaries in the United States and in other
ideas into successful products. For more information
countries. All other trademarks, registered trademarks
on Siemens PLM Software products and services, visit
or service marks belong to their respective holders.
www.siemens.com/plm.