Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

Teamcenter Polarion Integration

Download as pdf or txt
Download as pdf or txt
You are on page 1of 24
At a glance
Powered by AI
The document outlines the process of installing and configuring the integration between Teamcenter and Polarion, and then publishing requirements from Polarion to Teamcenter so they can be managed in Teamcenter.

You need to download the integration extension, extract it to the correct folder, configure settings in the polarion.properties file, and verify the folder structure. You also need to configure SSO variables if using single sign-on.

The steps are to stop the Polarion server, delete the workspace config directory, open and edit the polarion.properties file to configure Teamcenter and SSO settings, and then start the Polarion server.

Demo01

Teamcenter/Polarion Integration (rev. 294)

Teamcenter/Polarion Integration

1 Installation and configuration in Polarion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

2 Installation and configuration in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.1 Configure in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

3 Teamcenter Direct Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

4 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4.1 FAQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4.2 Publish a Polarion LiveDoc to Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4.3 Publish multiple LiveDocs to Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

4.4 Update and republish a Polarion LiveDoc to Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4.5 View or access the published LiveDocs in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4.6 Unlock and Lock Polarion requirements published to Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . 22

1 Installation and configuration in Polarion

https://docs.sw.siemens.com/en-US/doc/230235217/PL20220419389880191.xid1465510/xid2021811

Prerequiesites

Note:
Confirm that you have the required prerequisites before installing the integration.
Install the integration

1. Download the Teamcenter Direct Integration extension from Support Center.


2. Stop the Polarion server.
a. Click the shortcut on your desktop.
(Default location: C:\[POLARION_HOME]\polarion)

b. Click Shutdown Polarion Server.


3. Extract the installation archive to the [POLARION_HOME]\polarion\extensions folder.
A com.teamcenter.direct.integration folder appears in the extensions folder.
4. Verify that the folder structure is as follows:

[POLARION_HOME]
  \polarion
    \extensions
      \com.teamcenter.direct.integration
        \eclipse

1 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

          \plugins

5. Delete the [POLARION_HOME]\data\workspace\.config directory.


6. Open the polarion.properties file in a text editor.
Default location: [POLARION_HOME]\polarion\configuration\polarion.properties
7. Configure the following Teamcenter configuration and SSO connection variables for your system:

#===========================================================================
# Teamcenter Configuration

# TC_SERVER_URL        -Defines the default Teamcenter Server URL (Required)
# AW_URL                       - Active Workspace Client URL (Required)
# ACTIVE_HOST_URI_KEY  - Active Workspace Client hostkey (Optional)
# STAGING_DIR                  - Define the cache and staging directories (Required)
# BOOTSTRAP_URLS               -
 FMS Bootstrap URL (Currently Required but will be optional once CIS provide support)
# TEMP_FMS_DIR        - Temporary FMS Directory (Optional) Ex. path of %TEMP% vaiable
# TC_CLIENT_CACHE              - Use Tc client cache as derby needs to be true
# IS_TCCS                      - Flag to define if TCCS enabled (Optional)
#===========================================================================
ACTIVE_HOST_URI_KEY=activehost
AW_URL=http://[YOUR ACTIVE WORKSPACE CLIENT URL]:3000
TC_SERVER_URL=http://[YOUR DEFAULT TEAMCENTER SERVER URL]/tc
STAGING_DIR=C:\\bhm\\staging
BOOTSTRAP_URLS=http://[YOUR BOOTSTRAP URL]:4544
TEMP_FMS_DIR=
TC_CLIENT_CACHE=false
IS_TCCS=false

#===========================================================================
# SSO Connection Variables
# ------------------------
# Set the following variables to define the target Teamcenter SSO server,
# Application ID and SSO Session flag value.
#
# Below Fields are required if SSO enabled.
#
# TC_SSO_APP_ID          - Defines the default Teamcenter SSO Application ID.
#
#===========================================================================
TC_SSO_APP_ID=tc
 
8. Save your changes to the polarion.properties file.
9. Restart the Polarion server.

Enable the Teamcenter widget for Polarion work items


2 | Page Polarion ALM 22 R2 2023-03-19 16:04
Demo01
Teamcenter/Polarion Integration (rev. 294)

1. Open the scope (project or global) that you want to configure the integration for and enter Administr
ation.
2. In Navigation, select Work Items Form Configuration.
3. Under Form Layouts, click Edit beside the Work Item Type you want to configure the integration
for.
4. Add the following where you want the widget to appear in a Work Item.

<extension id="linkedTeamcenterItems"/>

5. Click Save.

Enable the Teamcenter widget in the LiveDoc Properties and Work Item sidebars

1. Open the scope (project or global) that you want to configure the integration for and enter Administr
ation.
2. In Navigation, select Documents and Pages Document Properties Sidebar.
3. Add the following where you want the widget to appear in the sidebar.

<extension id="linkedTeamcenterItems"/>

4. Click Save.
5. In Navigation, select Documents and Pages Work Item Properties Sidebar.
6. Add the following where you want the widget to appear in the sidebar.

<extension id="linkedTeamcenterItems"/>

3 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

7. Click Save.

2 Installation and configuration in Teamcenter

https://docs.sw.siemens.com/en-US/doc/230235217/PL20220419389880191.xid1465510/xid2050541

Prerequiesites

Install in Teamcenter

1. Launch Teamcenter Environment Manager (TEM) with administrative privileges. Right-click the tem
.bat program icon and choose Run as administrator.
(Default path: Siemens/Teamcenter13/install/tem.bat)
2. Select Configuration Manager and click Next.

3. Select Perform maintenance on an existing configuration and click Next.


4. Select your configuration and click Next.

4 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

5. Under Teamcenter, select Add/Remove Features.

6. Expand the Extensions tree and then the Model Management tree and select Server.

7. Select Common Integration Framework and Gateway for modeling.

8. Scroll down, select Teamcenter Polarion Direct Integration, and click Next.

5 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

9. Shut down the suggested services and all tcserver background processes, and click OK.

Caution:

Do not shut down FMS Server Cache.

10. Enter the Password for the infodba user and click Next.
11. Make a note of the template files that are also installed and click Next

Template Name Template File


Gateway for modeling/Gateway for modeling/Data Model behaviormodeling_template.xml
Teamcenter Polarion Direct Integration/Data Model pdi0polarionint_template.xml
Modeling Gateway Active Workspace Interface/bhm1behaviormodelingaw/Data bhm1behaviormodelingaw_template.x
Model ml

The installation may take several minutes depending on the speed of your computer.

12. (Optional) Click Show Details to view what is happening in the background.

6 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

A confirmation screen appears with a path to the installation log when the installation is complete.

13. Click Close.


If you installed the Polarion extension in Polarion, you can now publish one or more Polarion LiveDo
cs to Teamcenter.

7 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

2.1 Configure in Teamcenter

To allow Polarion Test Case LiveDocs to properly be published to Teamcenter and correctly create Test
Cases (which are children of Paragraphs) in Teamcenter, add the following value to
the TCAllowedChildTypes_Paragraph preference in Product Configurator.

IAV0TestCase

3 Teamcenter Direct Integration

https://docs.sw.siemens.com/en-US/doc/230235217/PL20220419389880191.xid1465510/xid2021807

Introduction

We created the Polarion/Teamcenter Direct Integration to aid an increasing number of Polarion and
Teamcenter customers that author requirements directly in Polarion and want to integrate them with the
Teamcenter ecosystem.
With this integration you can:

Publish Polarion LiveDocs to Teamcenter.


Share Polarion requirements, test cases, and LiveDoc Work Items to Teamcenter.
Access and map Polarion items to specified Teamcenter artifacts.
(Teamcenter objects mirrored from Polarion can be linked to any other Teamcenter artifacts like you
would for Teamcenter requirements.)

8 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

4 Getting Started

4.1 FAQ

https://docs.sw.siemens.com/en-US/doc/230235217/PL20220419389880191.xid1465510/xid2021813

1. What system is considered the master in this integration?


Polarion is considered the master. Currently, all changes to a requirement done in Polarion can be
published to Teamcenter. (Changes made in Teamcenter are not propagated to Polarion.)
2. Is the Polarion ID copied to Teamcenter?
Teamcenter auto-generates its own object ID depending on the object type, but the Polarion ID is
visible and tracked in Teamcenter in the Overview tab of the imported object.
Tip:
Click the Polarion ID link to launch the item in Polarion in a new browser tab.
3. A Work Item can be used in multiple LiveDocs in Polarion. If I publish multiple LiveDocs to
Teamcenter that contain the same Work Item, does this integration take care of duplicates or
will one Work Item from Polarion create multiple requirements in Teamcenter?
In Polarion you can Freeze referenced Work Items and Branch LiveDocs that have different versions
of a single Work Item. To ensure that you are viewing the correct item in Teamcenter, each version
from every LiveDoc imported from Polarion has its own copy. The history is not shared in Teamcenter
but you can click the Polarion ID to view the artifact in Polarion and access its history there.
4. Will I, or a user of my choice be notified automatically when publishing LiveDocs to
Teamcenter?
Polarion does not support automatic email notifications for jobs, but you can click on Job's log to
launch the publishing log in a new browser tab.

9 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

(Optional) Click on Job's log to view the publishing progress.

You can always view the status of the Job Log in the Polarion Monitor.
5. Is a LiveDoc and all its artifacts published to Teamcenter or is something left out?
Currently Free text (body text that is not in a Heading or Work Item) and Wiki Blocks in a LiveDoc ar
e not visible in Teamcenter.
Tip:
You can view Free Text and Wiki Blocks in the PDF snapshot of the LiveDoc uploaded to
Teamcenter.

6. Some specifications can contain thousands of Work Items. When they're being published to
Teamcenter could they potentially timeout? What happens if the connection between Polarion
and Teamcenter is lost?
The current timeout window is eights hours so even large specification Documents do not time
out.
If the Teamcenter or Polarion servers go down, an error appears in the publishing log, and you
must restart the publishing process when the connection is restored.
7. I published a LiveDoc to Teamcenter but when I try and republish an update, I get the following
error.

10 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

This message is displayed when you try to edit a field (in this case, the LiveDoc's title) that is beyond
your permission level.
8. How do I configure the mapping between Polarion and Teamcenter?
The mapping between Polarion and Teamcenter is handled through the POLARION_BHM_INT_DEF_
FILE dataset XML file on the Teamcenter server.

4.2 Publish a Polarion LiveDoc to Teamcenter

https://docs.sw.siemens.com/en-US/doc/230235217/PL20220419389880191.xid1465510/xid2045548

You can publish LiveDocs to Teamcenter as:

Multiple LiveDocs to Teamcenter from a Polarion Spaces index page.


A single LiveDoc to Teamcenter while it is open in Polarion (below).

The connector publishes all images, tables, attachments, links and rich-text content within the Work Items of
the selected LiveDocs to Teamcenter in a read-only, Released state.

Note:

In Polarion LiveDocs Free text (body text that is not in a Heading or Work Item), and Wiki Blocks ar
e not captured in Teamcenter as objects. Instead, the information is visible in a published PDF file
attached to the Teamcenter specification.
Currently, artifact changes made in Teamcenter do not get synced back to Polarion.
See the FAQ section for answers to common user questions.

1. Select the Polarion project that contains the LiveDoc you want to publish to Teamcenter.
2. In Navigation, click Documents and Pages.
3. Expand the Space and select your target LiveDoc.

11 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

The LiveDoc appears on the right.


4. Click (Settings) on the left of the toolbar and click Publish to Teamcenter.
Tip:
If you publish a Requirement specification first and a test case specification later, links are still
established.
If you are already logged on to Teamcenter, the Publish to Teamcenter dialog box appears. If not,
you are asked to log on to Teamcenter in a new browser tab.

5. Click Publish.
The publishing time depends on the number LiveDocs, their size, and the number of artifacts they
contain.

6.

(Optional) Click Job's log to view the publishing progress.

12 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

Note:
You can always view the status of the Job Log in the Polarion Monitor.
7. Once published, click Close on the confirmation dialog box.

8. Switch to the Teamcenter browser tab and view the LiveDoc there.
Tip:
Refresh your browser, or the LiveDoc (click on the top right) to ensure that you are viewing the
latest revision and to populate the Teamcenter link in the Document Properties sidebar or Work
Item Properties sidebar if it is your first time publishing.

13 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

4.3 Publish multiple LiveDocs to Teamcenter

https://docs.sw.siemens.com/en-US/doc/230235217/PL20220419389880191.xid1465510/xid2051479

Publish multiple LiveDocs to Teamcenter from a Polarion Space's index page.


Tip:
You can also publish a single LiveDoc to Teamcenter while its open in Polarion.
The connector publishes all images, tables, attachments, links and rich text content within the Work Items of
the selected LiveDocs to Teamcenter in a read-only, Released state.

Note:

In Polarion LiveDocs Free text (body text that is not in a Heading or Work Item), and Wiki Blocks ar
e not captured in Teamcenter as objects. Instead, the information is visible in a published PDF file
attached to the Teamcenter specification.
Currently, artifact changes made in Teamcenter do not get synced back to Polarion.
See the FAQ section for answers to common user questions.

1. Select the Polarion project that contains the LiveDoc you want to publish to Teamcenter.
2. In Navigation, click Documents and Pages.
14 | Page Polarion ALM 22 R2 2023-03-19 16:04
Demo01
Teamcenter/Polarion Integration (rev. 294)

3. Select the target Space's index page by doing one of the following:
a. Expand the Space in Navigation and click on its Index page.

b. Click to the right of the Space containing the target LiveDocs.

4. Select the boxes to the left of your target LiveDocs and click Publish to Teamcenter at the top
right.

Tip:
If you publish a Requirement specification first and a test case specification later, links are still
15 | Page Polarion ALM 22 R2 2023-03-19 16:04
Demo01
Teamcenter/Polarion Integration (rev. 294)

established.
If you are already logged on to Teamcenter the Publish to Teamcenter dialog box appears. If not, you
are asked to log on to Teamcenter in a new browser tab.

5. Confirm the number of selected LiveDocs and click Publish.


The publishing time depends on the number LiveDocs, their size, and the number of artifacts they
contain.
6. (Optional) Click on the Job's log link to view publishing details in real time.

Note:
You can always view the status of the Job Log in the Polarion Monitor.
7. Once published, click Close on the confirmation dialog box.

16 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

8. Switch to the Teamcenter browser tab and view the LiveDoc there.
Tip:
Refresh your browser, or the LiveDoc (click on the top right) to ensure that you are viewing the
latest revision and to populate the Teamcenter link in the Document Properties sidebar or Work
Item Properties sidebar if it is your first time publishing.

17 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

4.4 Update and republish a Polarion LiveDoc to Teamcenter

https://docs.sw.siemens.com/en-US/doc/230235217/PL20220419389880191.xid1465510/xid2051668

You can update a requirement LiveDoc in Polarion and republish it at any time to Teamcenter.
Updates are typically done when significant changes are made to the LiveDoc and must be communicated or
represented in Teamcenter.
Update and republish a LiveDoc to Teamcenter

1. Select the Polarion project that contains the LiveDoc you want to update.
2. In Navigation, click Documents and Pages.
3. Expand the Space and select your target LiveDoc.
The LiveDoc appears on the right.
4. (Optional) Confirm that the LiveDoc has already been published in Teamcenter.
Select and Document Properties to launch the Document Properties sidebar.

If the LiveDoc was published to Teamcenter, a link appears in the Linked Teamcenter Items section.
5. Update your requirements in Polarion and Save your changes.
6. Click (Settings) on the left of the toolbar and click Publish to Teamcenter.
If you are already logged on to Teamcenter, the Publish to Teamcenter dialog box appears. If you are
not, you are asked to log on to Teamcenter in a new browser tab first.
7. Click Publish on the Publish to Teamcenter dialog box.
8. Click Close once published.
9. (Optional) To view your changes in Teamcenter, click the LiveDoc's link in the Linked Teamcenter
Items section of link in the Document Properties sidebar.

18 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

Tip:
The letter after / in the link represents the number of revisions published to Teamcenter. (D means
that four revisions of this LiveDoc were published to Teamcenter.)

4.5 View or access the published LiveDocs in Teamcenter

https://docs.sw.siemens.com/en-US/doc/230235217/PL20220419389880191.xid1465510/xid2045549

After publishing Polarion requirements to Teamcenter, you must refresh your browser. If you do not, the
Teamcenter link in the Document Property or Work Item Property sidebars is not visible the first time you
publish, or the revision letter is not updated if you republish.
When Polarion LiveDocs are published in Teamcenter, they preserve the hierarchy created in the original Liv
eDoc.

Polarion LiveDoc hierarchy Hierarchy preserved in Teamcenter

Create Teamcenter Trace Links


You can create Teamcenter Trace Links to Polarion LiveDocs artifacts published in Teamcenter.
Note:
See the Active Workspace Documentation on Support Center for more information on Trace Links.
View or Remove existing Teamcenter Trace Links

In the Documentation tab, the Trace Link icon appears next to the artifacts with existing Trace Links.

19 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

Hover over the icon to view linked item(s).

Click beside a linked item to open its Overview tab in a new browser tab.

The tree location, and a preview of the linked requirement are also visible.
Click to remove an existing Trace Link.
Click the More... link to launch the Existing Trace Link dialog box.

20 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

Update in Polarion
If you want to make changes to a requirement, open it in Polarion and republish it to Teamcenter.

1. Locate the published Polarion requirement in Teamcenter and select it.

2. Click the Overview tab.


3. Click the Polarion ID link.
If the selection is a LiveDoc level artifact, the LiveDoc opens in Polarion's Document Editor.

If the selection is a Work Item level artifact (like Titles, or Requirement Work Items), it opens
in the Work Item viewer.

21 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

4.6 Unlock and Lock Polarion requirements published to Teamcenter

https://docs.sw.siemens.com/en-US/doc/230235217/PL20220419389880191.xid1465510/xid2050995

If you want to configure Teamcenter Parameters or Variant rules, you must unlock a requirement.
Caution:
Artifact changes made in Teamcenter do not get synced back to Polarion.
Unlock a requirement in Teamcenter

1. Select one or more published Polarion objects in Teamcenter that you want to unlock.
You can do this in one of the following ways:
a. Select the requirement in the Tree with Summary view.

b. Select the requirement under the Documentation tab.

2. Click Manage on the right, and click Submit to Workflow.

22 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

3. Select a workflow template from the Template list.

Note:
The Modify Polarion Requirements template is provided as simple example.
This template processes the node that you select and the elements below it, and sets them as editable.

23 | Page Polarion ALM 22 R2 2023-03-19 16:04


Demo01
Teamcenter/Polarion Integration (rev. 294)

4. Click Submit.

A dialog appears confirming that the selected object was submitted to a workflow and it is now
modifiable.
Caution:
The text and structure of the Teamcenter requirement objects should not be modified because they are
changed the next time they are updated from Polarion. Modifications or updates should be limited to
relating parameters, assigning configuration rules and options, or other relations.

Lock a requirement in Teamcenter


When you finish adding parameters or variant rules in Teamcenter, you must lock the workflow.

1. Select the object you unlocked in Teamcenter.

2. Click on the Workflow tab.


3. Click Add under the REVIEWERS section.
The Add dialog box appears.
4. Select a Role (if not already assigned) for the user who will complete the task and click Complete.
5. Click Approve.
The workflow will appear as complete, and the requirement is locked (grayed out) under the Document
ation tab.

24 | Page Polarion ALM 22 R2 2023-03-19 16:04

You might also like