Client Guide

This guide provides details about the DPT client for codebeamer. It assumes that you are familiar with OSLC standards and specification when using the codebeamer client.This guide also assumes that an administrator has the necessary access to configure the codebeamer client.

Setting up DPT Integration in codebeamer

Prerequisites and Limitations

Using DPT integration has the following prerequisites:

• DPT integration is enabled and configured in Application Configuration. For this, the user must have system admin permission.
• Project admin permission for tracker configuration.
• Admin account to the external server.
• API throttling is configured. For the configuration, see the Server Guide.

DPT integration has the following limitations in Codebeamer:

• Only integration with Windchill is fully supported.
• From 2.0 (HUSKY)—Available for the following tracker types: Requirement, Bug, Change Request, Component, Epic, Issue, Risk, Task, Test Case, User Story.
• On 22.10-LTS-SP2 (GINA)—Only available for Requirement tracker type. For other tracker types, the function is not visible.

Add New External Server

To enable DPT integration in codebeamer, it must be in Application Configuration. The following is an example configuration:

{
"oslc" : {
    "enabled" : true,
    "pageSize" : 25,
    "syncIntervalInSeconds" : 3600,
    "OslcServers" : {
        "AuthenticationScheme" : "BASIC",
        "ExternalOSLCLinkLookupURI" : "https://pwdcsv-wcqa54d.ptcnet.ptc.com/Windchill/oslc/config/links/traceLinkResources",
        "RootCatalogURI" : "https://pwdcsv-wcqa54d.ptcnet.ptc.com/Windchill/oslc/catalog",
        "ServerID" : "WINDCHILL_SERVER_BASIC",
        "ServerType" : "Windchill",
        "Domains" : {
            "Name" : "Config Management",
            "Url" : "http://open-services.net/ns/config#",
            "LinkTypes" : [
                "Validated By",
                "Validates",
                "Decomposed By",
                "Decompose"
            ]
        },
        "Parameters" : [
            {
                "resourceType" : "http://open-services.net/ns/config#VersionResource",
                "selectAttributes" : "dcterms:title,dcterms:identifier,oslc:shortId",
                "whereAttributes" : "dcterms:title,dcterms:identifier,oslc:shortId"
            },
            {
                "resourceType" : "http://open-services.net/ns/config#Component",
                "selectAttributes" : "dcterms:title,dcterms:identifier,oslc:shortId",
                "whereAttributes" : "dcterms:title,dcterms:identifier,oslc:shortId"
            }
        ],
        "ServerAdmin" : {
            "userName" : "userName",
            "userPassword" : "userPassword"
        }
    }
}

The parameters are as follows:

Add Custom Tracker Field for Downstream DPT Links

1. Open the required tracker
2. Click the context menu ► Configure ► Fields tab.
3. Select New choice field... from the drop-down menu at the bottom of the page.
4. Fill in the Label field.
5. Select Work/Config items from the Datasource drop-down menu. Selecting the multiple check box enables linking multiple external resource at once.
6. Select the Propagate suspects check box.
7. Optionally, create a shared field. Using a shared field filters the list of visible external servers. The name of the shared field must be oslc_field_type_<LinkType>, where the LinkType is based on the setting in Application Configuration. The field name must be in lowercase and underscore must be used instead of space.
   
8. Fill in the optional fields as needed.
9. Click [OK].
   
10. Click on Work/Config items in the Layout and Content column.
11. Select codebeamer DPT Project.
12. Select Work Items of type.
13. Select DPT type.
14. Click [OK].
    
15. Click [Save] on the top of the page.

Using the DPT Client

Link External Resource to a Codebeamer Item

1. Locate and open the tracker item to link to an external resource.
2. Locate the DPT custom field, and click on the pencil icon.
3. Select a server from the Server drop-down menu, and a domain from the Domain menu.
4. Locate the required external resource using the search field. The searching yield exact matches, use * for wild card.
5. Enter the system admin credentials of the external server.
6. Select the required resource. If the multiple check box was selected at field creation, multiple resources can be selected.
   
7. Click [Add].
   

Clicking on preview icons opens a preview. From the preview, the item can be opened by clicking on the title.

Note that it might take some time for the preview to load.

Check External Suspected Items

Checking suspected external items is done automatically in the background, based on the syncIntervalInSeconds parameter in the Application Configuration. The check can be done manually as well. This function is available from the following launch points in codebeamer:

• Context menu in the tracker item details view: synchronization is only done for the given item.
• Context menu of the tracker: synchronization is done for every item in the tracker.
• Context menu of the tracker in table view when one or more items are selected: synchronization is done for the selected item or items.

The trigger marks the DPT link as suspected automatically if it detects a change in the modified date of an external object.

Create a Report of External Suspected Items

It is possible to create a report of the external suspected links. It can be created with the following cbQL expression, where 4545 is a tracker ID example and [2] is an example index of the choice field:

tracker.id = 4535 AND isSuspected('4535.choiceList[2]')

If the DPT integration tracker field is shared, the following expression can be used:

tracker.id = 4535 AND isSuspected('cbQLGlobalType.oslc_field_type_validates')

Delete the External Item Link

To delete an external item link, make the DPT field editable, and click the x on the selected item.

View External DPT Resources Associated with codebeamer Item

This function is available from the tracker item details view or from the detailed panel view in the document view.

1. Select the required tracker item.
2. Click on the External linked items tab or section.
3. Enter the server admin credentials for the external server if prompted.
   After the data is fetched, the available external items are listed. Clicking on the preview icon opens a preview of the external item. The external item can be opened by clicking on its title.

External linked items section in the detailed panel view:

External linked items tab in the tracker item details view:

Preview of the external item:

Support for Windchill

1. Support authentication schemes BASIC and OAUTH2
   "AuthenticationScheme" : "OAUTH2" or "AuthenticationScheme" : "BASIC"
2. Root catalog URI when the "AuthenticationScheme" : "OAUTH2"
   Sample - "RootCatalogURI" : https://pwdcsv-wcqa56d.ptcnet.ptc.com/Windchill/oauth/oslc/catalog
3. ExternalOSLCLinkLookupURI when the "AuthenticationScheme" : "OAUTH2"
   Sample - "ExternalOSLCLinkLookupURI" : https://pwdcsv-wcqa56d.ptcnet.ptc.com/Windchill/oauth/oslc/config/links/traceLinkResources

Support for Windchill RV&S

1. Support authentication schemes BASIC and OAUTH2
   "AuthenticationScheme" : "OAUTH2" or "AuthenticationScheme" : "BASIC"
2. Root catalog URI
   Sample - "RootCatalogURI" : https://ppumsv-ipdc34d.ptcnet.ptc.com:3001/oslc/r/catalog
3. ServerType
   "ServerType" : "WRVS"
4. Supported domains
   "Name" : "Requirement Management","Url" : http://open-services.net/ns/rm#, And "Name" : "Change Management","Url" : http://open-services.net/ns/cm#,
5. Sample Configuration
   

   {
                   "AuthenticationScheme" : "OAUTH2",
                   "RootCatalogURI" : https://ppumsv-ipdc34d.ptcnet.ptc.com:3001/oslc/r/catalog,
                   "ServerID" : "WRVS_SERVER",
                   "ServerType" : "WRVS",
                   "Domains" : {
                       "Name" : "Requirement Management",
                       "Url" : http://open-services.net/ns/rm#,
                       "LinkTypes" : [
                           {
                               "text" : "Validated By"
                           },
                           {
                               "text" : "Validates"
                           },
                           {
                               "text" : "Decomposed By"
                           },
                           {
                               "text" : "Decomposes"
                           }
                       ]
                   },
                   "Parameters" : [
                       {
                           "resourceType" : http://open-services.net/ns/rm#Requirement,
                           "selectAttributes" : "dcterms:title,dcterms:identifier",
                           "whereAttributes" : "dcterms:title,dcterms:identifier"
                       },
                       {
                           "resourceType" : http://open-services.net/ns/rm#RequirementCollection,
                           "selectAttributes" : "dcterms:title,dcterms:identifier",
                           "whereAttributes" : "dcterms:title,dcterms:identifier"
                       }
                   ],
                   "ServerAdmin" : {
                       "userName" : "Administrator",
                       "userPassword" : "CB-ENCRYPTED-95-D1-95-FF-CE-C0-7-67"
                   }
               }
   

6. Selection Dialog to query resources from external system supported
7. No external items lookup is supported

Support for Windchill Modeler

1. Support authentication schemes BASIC, OAUTH2 and BEARER_TOKEN
   "AuthenticationScheme" : "OAUTH2"
   or
   "AuthenticationScheme" : "BASIC"
   or
   “AuthenticationScheme” : “BEARER_TOKEN”
2. AuthTokenURI – required only in case of “AuthenticationScheme” : “BEARER_TOKEN”
   Sample - "AuthTokenURI" : https://aazsv-moda114d.ptcnet.ptc.com:57850/modelerservice/auth/token
3. Root catalog URI
   Sample - "RootCatalogURI" : https://ppumsv-ipdc08d.ptcnet.ptc.com:57850/oslc
4. ServerType
   "ServerType" : "MODELER"
5. Supported domains
   "Name" : "Requirement Management", "Url" : http://open-services.net/ns/rm#,
   And
   "Name" : "Architecture Management", "Url" : http://open-services.net/ns/am#,
6. ExternalOSLCLinkLookupURI
   Sample - "ExternalOSLCLinkLookupURI" : https://aazsv-moda69d.ptcnet.ptc.com:57850/oslc/links
7. Selection Dialog to query resources from external system supported – Yes

Link Creation from Other Tracker Types

From Codebeamer 2.0 (HUSKY), DPT links can be created from the following tracker types: Requirement, Bug, Change Request, Component, Epic, Issue, Risk, Task, Test Case, User Story. For other tracker types, the function is not visible.

The integrations with Windchill, Windchill RV&S, and Windchill Modeler are supported.

Preview Configuration

{
               "AuthTokenURI" : https://aazsv-moda114d.ptcnet.ptc.com:57850/modelerservice/auth/token,
               "AuthenticationScheme" : "BEARER_TOKEN",
               "RootCatalogURI" : https://aazsv-moda114d.ptcnet.ptc.com:57850/oslc,
               "ServerID" : "MODELER_SERVER_9.6_114d_Bearer",
               "ServerType" : "MODELER",
               "Domains" : [
                              {
                                             "Name" : "Requirement Management",
                                             "Url" : http://open-services.net/ns/rm#,
                                             "LinkTypes" : [
                                                            {
                                                                           "text" : "Validated By"
                                                            },
                                                            {
                                                                           "text" : "Validates"
                                                            },
                                                            {
                                                                           "text" : "Decomposed By"
                                                            },
                                                            {
                                                                           "text" : "Decomposes"
                                                            }
                                             ]
                              },
                              {
                                             "Name" : "Architecture Management",
                                             "Url" : http://open-services.net/ns/am#,
                                             "LinkTypes" : [
                                                            {
                                                                           "text" : "Validated By"
                                                            },
                                                            {
                                                                           "text" : "Validates"
                                                            },
                                                            {
                                                                           "text" : "Decomposed By"
                                                            },
                                                            {
                                                                           "text" : "Decomposes"
                                                            }
                                             ]
                              }
               ],
               "Parameters" : [
                              {
                                             "resourceType" : http://open-services.net/ns/rm#requirement,
                                             "selectAttributes" : "dcterms:title,dcterms:modified,dcterms:identifier",
                                             "whereAttributes" : "dcterms:title"
                              },
                              {
                                             "resourceType" : http://open-services.net/ns/am#resource,
                                             "selectAttributes" : "dcterms:title,dcterms:modified,dcterms:identifier",
                                             "whereAttributes" : "dcterms:title"
                              }
               ],
               "ServerAdmin" : {
                              "userName" : "Tester",
                              "userPassword" : "CB-ENCRYPTED-6D-38-38-F2-9D-35-3D-9B-6F-AE-1A-99-63-A3-2D-F8"
               },
               "PreviewConfig" : {
                              "height" : 400,
                              "width" : 800
               }
}

The external resource preview height and width can be managed through configuration:

               "PreviewConfig" : {
                              "height" : 400,
                              "width" : 800
               }