Configuring Consumers for TRS

When either Global Configurations or IBM Jazz Reporting Service/IBM Engineering Lifecycle Optimization - Engineering Insights (ENI) are required, a special type of consumer needs to be configured - a consumer with a functional user for Tracked Resource Sets (TRS) consumption [1]. Let's recall first what a functional user is [2]. A functional user is a Jira user which is bound to a consumer so whenever an external application uses such consumer to access Jira, it will have the same access rights as the functional user; in fact, from Jira's perspective, no external application is accessing the information, but the functional user itself. In other words, a consumer having an associated functional user will use it to access Jira on behalf of it. This contrasts with a regular consumer's accessing behavior where no functional user is associated, in such cases and when a remote access is required, a pop-up window is opened on the external application to let the person log-in into Jira, and the user used for that is the one the consumer will use to access Jira during the session.

Having a consumer with a functional user is required to work with Global Configurations or IBM Jazz Reporting Service/ENI, because these features/applications require to be in constant communication with Jira (due the TRS specification); in other words, they require an automatic access (no person behind to login) to Jira. This is where the functional user comes to play: by associating a functional user to the consumer these applications use, they can access Jira without requiring a person to login in the middle of the process, the consumer will just use the same credentials as the functional user and this is why choosing it is very important [3].

Follow the steps of below sections to configure the feature/application you require.

Global Configurations

If Global Configurations are needed, you need to:

  1. Confirm your license is granted with the Global Configuration and Tracked Resource Set features.
  2. Make sure Jira and IBM Global Configuration Management applications become friends of each other.
  3. Confirm with IBM Engineering Lifecycle Management administrators that IBM Link Index Provider (LDX) application is installed in their instance [4].
  4. Register a consumer with a functional user for LDX application:
    1. Follow the Registering a Consumer procedure to create this consumer with following data:
      Field Value
      Name A name of your choice, e.g. LDX
      Key Leave it empty, system will create a key for you.
      Secret Whatever you want that you don't forget.
      Confirmation The same as Secret field.
      Trusted checked
    2. Follow the Assigning a Functional User procedure to assign a functional user to this consumer. This user is the one IBM Link Index Provider will use when trying to fetch data from Jira [5]. Make sure this user is in a Jira Group granted with the "Browse Projects" permission [6] for projects with Collaboration Links that you want LDX to fetch.
     
  5. Ask IBM Engineering Lifecycle Management administrator to register a new data source for Jira's Change Management resources using the LDX consumer credentials [7].

Reporting Services

If IBM Jazz Reporting Service and/or IBM Engineering Lifecycle Optimization - Engineering Insights are required, you need to:

  1. Confirm your license is granted with the Tracked Resource Set feature.
  2. Confirm with IBM Engineering Lifecycle Management administrators that IBM Lifecycle Query Engine (LQE) application is installed in their instance [4].
  3. Register a consumer with a functional user for LQE application:
    1. Follow the Registering a Consumer procedure to create this consumer with following data:
      Field Value
      Name A name of your choice, e.g. LQE
      Key Leave it empty, system will create a key for you.
      Secret Whatever you want that you don't forget.
      Confirmation The same as Secret field.
      Trusted checked
    2. Follow the Assigning a Functional User procedure to assign a functional user to this consumer. This user is the one IBM Lifecycle Query Engine will use when trying to fetch data from Jira [5]. Make sure this user is in a Jira Group granted with the "Browse Projects" permission [6] for projects with Collaboration Links that you want LQE to fetch.
     
  4. Ask IBM Lifecycle Query Engine administrator to register a new data source for Jira's Change Management resources and another for Jira's Process resources, both using LQE consumer credentials [8].