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 to enable Tracked Resource Sets (TRS) consumption [1]. This consumer must be trusted and bound to the Tracked Resource Set functional user, but let's recall what a functional user is in first place [2]. A functional user is a Jira user which is associated to a consumer, so whenever an external/remote 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 that session. Now, the Tracked Resource Set functional user is called that way because the chosen user is used to build and access the Tracked Resource Set feeds this connector provides [3]. Applications mentioned above 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 the Tracked Resource Set 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 [4].

Summarizing, when either Global Configurations or IBM Jazz Reporting Service/ENI are required, these are the steps you must follow:

  1. Follow the steps below in the Assigning Tracked Resource Set Functional User procedure to designate a Jira user to be the TRS functional user.
  2. Depending on the feature/application required, follow the steps of the following sections Global Configurations and/or Reporting Services to bound the corresponding consumer with the TRS functional user.

Assigning Tracked Resource Set Functional User

As stated above, choosing the right user is very important because bound consumer(s) will have the same credentials to consult Jira information [3]. Make sure this user is in a Jira Group granted with the "Browse Projects" permission [5] for projects with Collaboration Links that you want to expose to consuming applications before continuing.

  1. Enter to the JIRA ADMINISTRATION > Manage apps page.
  2. On the left panel, click on the Tracked Resource Set option in the OSLC Connect section.
  3. Locate the TRS Functional User section and click in the assign a Jira user link.
  4. In the opened Select User dialog, type the first words or the complete name of the user you are looking for in the Name field, this will cause the Matching users field be filled with matching user names.
  5. Select the appropriate match from the Matching users field and click the Select button.

That's it, selected user is now the TRS functional user and a warning message will invite you to bound at least one consumer to it [6] (following sections take care of that). If in the future you need to change the TRS functional user, you just need to click on the Change link to open the Select User dialog again and repeat the steps to select another user. Be aware that doing so will require to rebuild the TRS feeds (if they are not empty) and, in consequence, to re-index all external datasources consuming them; you will be warned about this in the Select User dialog when feeds are built and contain data. In this same latter scenario, after the TRS functional user is changed, rebuild warning messages will be displayed in the TRS feeds area until they got rebuilt [3]. To remove the functional user, you just need to click in the Remove link.

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 [7].
  4. Register a consumer bound to the TRS functional user for LDX application. This is done by following the Registering a Consumer procedure 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.
    Functional User Tracked Resource Set
    Trusted checked
  5. Ask IBM Engineering Lifecycle Management administrator to register a new data source for OSLC Connect for Jira CM Resources (TRS 2.0) feed using the above LDX consumer credentials [8].

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 [7].
  3. Register a consumer bound to the TRS functional user for LQE application. This is done by following the Registering a Consumer procedure 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.
    Functional User Tracked Resource Set
    Trusted checked
  4. Ask IBM Lifecycle Query Engine administrator to register a new data source for OSLC Connect for Jira CM Resources (TRS 2.0) feed and another for OSLC Connect for Jira Process Resources (TRS 2.0) feed, both using LQE consumer credentials [9].
Related tasks
Rebuilding TRS Feeds.