Configuring Friends and Consumers
A Collaboration Link is a link between two elements that belong to different applications. Typically, when a Collaboration
Link is created from one Application A to one Application B, a back link is created (automatically) from Application B to
Application A, so both elements may have a way to navigate to each other. In this scenario, where a link can exist either because
it was created on its own, or because it was created as the back link of the other link, it is often useful to distinguish their nature
with a role name:
- Outgoing link: is the Collaboration Link that was created on its own.
- Incoming link: is the Collaboration Link that was created as the back link of the other link.
Henceforth, when a Collaboration Link in Jira is said to be an outgoing link,
it means it is a link whose creation was triggered from Jira (creating a back link on the CLM Application),
whereas if it is an incoming link it means it is a link that was created as back link on Jira
(due to a creation triggered from the CLM Application).
Creating Collaboration Links is speaking about trust between different applications.
The triggering application of the Collaboration Link creation must access to the resources (artifacts) of the other application,
and this one must allow the modification of them in order to create the link. All this must happen in an atmosphere of trust:
applications must be registered in each other to allow this behavior only between registered applications. Now, the application
allowing the access/modification of its resources is called the friend application,
whereas the one requesting such access/modification is called the consumer application.
In this scenario, if Jira wanted to access/modify the resources of DOORS Next Generation (DNG),
for example, DNG would need to be registered in Jira as a friend,
and at the same time, Jira would need to be registered in DNG as a consumer... All this would
be good enough if only Jira required to create Collaboration Links, but what about if DNG users
also wanted to create links from their side? In this case, and to allow bidirectional creation of links, Jira would need
to be registered also as a friend in DNG, and at the same time, DNG
would need to be registered as a consumer in Jira.
There are normally two ways to establish this connectivity:
- By requesting a provisional key.
- The friend application is registered first on the consumer.
- While registering, the consumer asks the friend to generate a provisional key working for a given password.
- If the friend application accepts the request, it registers the consumer on its side and returns the provisional key to it.
- The consumer will be able to use this key and password to access the friend once the provisional key becomes authorized.
- By reusing an authorized key.
- The consumer application is registered first on the friend.
- While registering, the friend administrator sets an authorized key and password for the consumer.
- The friend administrator needs to communicate, to the consumer administrator, the key and password set.
- The consumer administrator registers the friend using the given key and password.
As you can see, everything is about a key and a password, the difference between last approaches is how they generate and share the key.
Getting back to the Jira-DNG example, and considering Jira will be the consumer and DNG
the friend, if you choose to use:
- Requesting a provisional key.
- You need to register DNG as a friend of Jira first.
- While registering, you need to request a provisional key working for a password you choose.
- If DNG accepts the request, it registers Jira as a consumer of it and returns the provisional key to it.
- You need to call/wait for the DNG administrator to change the provisional key to an authorized key before you can access DNG.
- Reusing an authorized key.
- You ask DNG administrator to register Jira as a consumer first.
- While registering, DNG administrator sets an authorized key and password for Jira.
- DNG administrator needs to communicate you the key and password set.
- You can now register DNG as a friend of Jira using the given key and password.
This would be a good moment to get in touch with the CLM Application administrator and agree on which method you both will use,
keep in mind that whereas OSLC Connect for Jira supports both methods of making friends, most CLM Applications just support
the method of requesting provisional keys. But wait a moment, which CLM Applications need become friends of Jira?
And how is a friend or consumer registered on Jira?
Following is what you need to do to complete this configuration:
- Refer to related tasks in order to know how to manage (register) friends and consumers on Jira.
- Get in touch with Jira project administrators and ask them:
- which CLM Applications need become friends of Jira .
- whether they will need Global Configurations when connecting to CLM Applications.
- whether they require Jazz Reporting Service and/or IBM Rational Engineering Lifecycle Manager (RELM).
- Get in touch with corresponding CLM Applications administrators to agree which method to use for becoming your applications friends each other.
- Register, with the aid of CLM Applications administrators, required friends and consumers according to Jira project administrators needs.
- Ask CLM Applications administrators to register required associations according to Jira project administrators needs.
If Global Configurations are needed, you need also to:
- Confirm your license is granted with the Global Configuration and Tracked Resource Set features.
- Make sure Jira and CLM Global Configuration Management applications become friends each other.
- Confirm with CLM administrators that CLM Link Index Provider (LDX) application is installed in their CLM instance , .
- Register an extra special consumer in Jira for LDX application :
- Follow the Registering a Consumer procedure again to create this consumer with following data:
|Leave it empty, system will create a key for you.
|Whatever you want that you don't forget.
|The same as
- Follow the Assigning a Functional User procedure to assign a functional user to
CLM LDX consumer.
This user is the one LDX will use when trying to fetch data from Jira, you need to make sure it will have enough
access rights to see issues modified with Collaboration Links.
- Ask LDX administrator to register a new data source for Jira's Change Management resources using
CLM LDX consumer credentials .
If Jazz Reporting Service and/or RELM are required, you need also to:
- Confirm your license is granted with the Tracked Resource Set feature.
- Confirm with CLM administrators that CLM Lifecycle Query Engine (LQE) application is installed in their CLM instance , .
- Ask LQE administrator to register a new data source for Jira's Change Management resources and another for Jira's Process resources, both using
CLM LDX consumer credentials .