Basic Friending Rules with OSLC Connect for Jira and IBM ELM
When connecting IBM ELM to OSLC Connect to Jira there are many connections that need to be created. The following is a guide on the relationships that need to be established and the basic flow.
Friending Basics
Friending is part the other process of enabling secure interaction between two tools. When creating a Friend, we need to both point to a remote server’s rootservices document and approve the Consumer key in the remote applications. These are pairs, the Friend is the source of the request, the Consumer is the recipient that must be authorized. Unfortunately these are not bidirectional relationships so we have many relationships we need to setup.
Friending from Jira
From Jira we need to friend to multiple servers. Below is a table of the Application, rootservices URL, where to approve, and any notes. You will start the friending process in Jira and complete the approval of the consumer in IBM ELM.
You find the Friends Page @ {Jira Server}/plugins/servlet/oslc/friends
Application | Rootservices URL | Where to Approve | Notes |
|---|---|---|---|
DOORS Next | {IBM URL Base}/rm/rootservices | {IBM URL Base}/jts/admin#action=com.ibm.team.repository.admin.configureOAuth | You might note in the JTS Consumers that this is the DNG Source by editing the label |
Global Configuration Management | {IBM URL Base}/gc/rootservices | {IBM URL Base}/jts/admin#action=com.ibm.team.repository.admin.configureOAuth | You might note in the JTS Consumers that this is the GC Source by editing the label |
Engineering Test Management | {IBM URL Base}/qm/rootservices | {IBM URL Base}/qm/admin#action=com.ibm.team.repository.admin.configureOAuth | |
Engineering Workflow & RMM | {IBM URL Base}/ccm/rootservices | {IBM URL Base}/ccm/admin#action=com.ibm.team.repository.admin.configureOAuth |
If your organization has multiple application servers (e.g. rm1, rm2, etc) you will need to create friends on each of those as well.
Friending from IBM ELM
Friending from ELM is more complex, with more connections to be made. These can be broken down into application connections and reporting connections.
Applications Connections
Application connections are made from the ELM applications. In all cases the following should be known.
Jira Rootservices → {Jira Server}/rest/oslc/1.0/rootservices (also found on the Jira Consumer Page)
Jira Consumer Page → {Jira Server}/plugins/servlet/oslc/consumer
Application | Application Friending URL | Notes |
|---|---|---|
DOORS Next | {IBM URL Base}/rm/admin#action=com.ibm.team.repository.admin.friends | |
Global Configuration Management | {IBM URL Base}/gc/admin#action=com.ibm.team.repository.admin.friends | You should add a Functional User with Read-Access to your Jira Repository. |
Engineering Test Management | {IBM URL Base}/qm/admin#action=com.ibm.team.repository.admin.friends | |
Engineering Workflow & RMM | {IBM URL Base}/ccm/admin#action=com.ibm.team.repository.admin.friends | If you are using RMM, you should add a Functional User with Read-Access to your Jira Repository. |
Engineering Insights (Optional) | {IBM URL Base}/relm/admin#action=com.ibm.team.repository.admin.friends | You should add a Functional User with Read-Access to your Jira Repository. |
If your organization has multiple application servers (e.g. rm1, rm2, etc) you will need to create friends from each of those as well.
The need for the Functional User is for some link discovery scenarios where IBM does not provide user credentials.
Reporting (& Discovery) Connections
For the enhanced capabilities for IBM ELM, there are additional connections that need to be established to complete the behavior. IBM ELM relies on two indexers (LDX & LQE) to drive some internal functionality. They must be montoring the Jira data sources to provide the desired functionality.
To connect the Indexers, you must directly add a Consumer in the Jira Consumer page. Note the Key and Secret since you will need to use those in LDX & LQE. You can use the same key and secret in all the indexers if desired, but if you want to monitor/control the behaviors, it is often useful to use different keys since network tools (load balancers, reverse proxies, etc) can often filter on the consumer keys.
Connecting LDX
LDX performs the necessary role for link discovery by processing the Jira TRS feed(s).
In LDX, a new data source needs to be added. Use the Jira Rootservices ( {Jira Server}/rest/oslc/1.0/rootservices ) to find the CM Resources and add those as a Data Source.
(Optional) If you are using test resources (XRay) from Jira, also add the QM Resources as an additional Data Source.
Connecting LQE
LQE performs the necessary role for reporting (Report Builder and Engineering Insights) by processing the Jira TRS feeds.
In LQE, a new data sources need to be added. Use the Jira Rootservices ( {Jira Server}/rest/oslc/1.0/rootservices ) to discover the available feeds.
Add the Jira Process Resources. This will enable visibility to the Jira Projects in the Reporting Tools. Note, the permissions on who can report on this data are controlled by the LQE Permissions based on these projects.
Add the Jira CM Resources. This will enable the access to the data on the individual Jira Issues.
(Optional) If you are using test resources (XRay) from Jira, also add the QM Resources as an additional Data Source.
If you have issues, please see → Issues using OSLC Connect with ReportBuilder