On this page:

To use Jira data in IBM ELM, you need to configure LQE by adding Jira as a data source. In doing so, LQE will start to index Jira data using the Jira TRS feed. Once this is done, you can validate that Report Builder can communicate with LQE.

In this article, you will learn how to access the data stored in the data source. LQE offers an in-depth permission system that allows for precise control over the data being indexed in LQE.

Creating an LQE Consumer in Jira

For LQE to communicate with Jira, you need to create an LQE consumer in Jira:

  1. In Jira, go to Manage Apps, then to the Consumers section of OSLC Connect.

  2. Click the Add Consumer button at the top of the page.

  3. Fill in the requested information, take note of the Secret, and make sure to choose a Functional User.

  4. Click Add.

You can now copy the Root Services URI at the bottom of the page, you’ll need it in the next step.

Adding a data source

  1. In ELM, go to the Manage data source page of LQE.

  2. Click the Add data source link at the top of the page.

  3. Fill in the requested information:

    1. Choose Root Services URL and paste the Jira Root Services URL. There are now two endpoints available, you’ll need to reproduce this Adding a data source step for each of them (if you can’t see those endpoints, see below).

    2. You may leave the default values for the Label and Scheduling settings, or choose values that suit your needs.

    3. Choose OAuth as the Authentication method.

  4. Click Next.

  5. Fill in the OAuth authentication details. You can find the Consumer Key on the Consumer page of Jira.

  6. Fill in the secret you chose during the Consumer creation procedure. Click Test connection to make sure the consumer works properly.

  7. Click Finish, or click Next to customize the data source settings.

Follow this same procedure again to add the second Jira TRS endpoint (step 3.a).

If you’re missing Jira Root Services URL in step 3.a, please read: Can't add datasources from Rootservices? Setting the protocol for outbound ELM requests

Managing data sources

If you find yourself having to troubleshoot issues with your data sources, LQE offers a few ways to do so. As an example, select your newly added Jira data source and take note of the few options at the top of the page:

  • Validate: Data source validation should be the first step taken when you notice any issue with the data source. This is a quick way to diagnose issues.

  • Reindex: When the validation reveals issues and depending on the issues you’re facing, reindexing may be a good choice. Note that this operation may take time to complete.

  • Remove: Remove the selected data source.

  • Pause Indexing: This will simply stop refreshing the index in LQE. It can be used to investigate the data source in its current state or to prevent log files to be filled with new log lines.

  • Force Update: This will force the data source to refresh, independently of the refresh schedule configuration. This is helpful when you need to have an up-to-date index while you’re troubleshooting the data source.

  • Test Connection: If you’re having trouble with the OAuth Authentication, you can test the current settings here.

Selecting your Default data source

As the last step before Jira data is used in IBM ELM reporting tools, you need to check that Report Builder properly connects to LQE.

  1. Open the Report Builder Admin (path: /rs/setup).

  2. Select either Lifecycle Query Engine or Lifecycle Query Engine scoped by a configuration as the default data source.

  3. Click Connect to data sources and wait for the block to turn green.

LQE data access control

Now that your Jira Data is being indexed on IBM ELM, you may want to restrict the access to this data to a few users or a specific user group.

Using an existing permission group

For simplicity and traceability purposes, it is recommended that you reuse the same permissions over LQE data sources that you use on your Jira Project. To do so, you first need to retrieve your Project ID:

  1. Open the desired project administration Overview page:

  2. Take a look at this page URL, it should look like this: <BASE_URI>/ccm/admin#action=com.ibm.team.process.editProjectArea&itemId=_B-VGoE3SEeykGodEQCSWcg

  3. The Project ID in the above URL is: _B-VGoE3SEeykGodEQCSWcg

Now that you have the Project ID, you can use it to retrieve the related group in LQE.

  1. Open the User Groups page in LQE Administration:

  2. In the group list, look for a group starting with acsync_ and ending with the Project ID.

    • In our example, you are looking for the acsync__B-VGoE3SEeykGodEQCSWcg group.

  3. Click the group name to check if the group members list matches your expectations.

You can now use this group to define permissions over LQE data sources (see the Permissions section below).

Creating new permission groups

If you prefer using dedicated groups, you can create permission groups in LQE. To restrict the access to LQE indexed data to a custom user group, you can create this group directly in LQE.

  1. In ELM, go to the User Groups page of LQE.

  2. Click Add a new group… at the top of the page.

  3. Fill in the group creation information and click OK.

An empty group is created, select it in the list to add members to it. Once this is done, you can use this group on the Permissions control page.

User permissions

LQE uses a permission tree to control access to indexed data. Each node can either inherit permissions from its parent or define its own permissions. Using this system, you can precisely control who can access what.

For example, if you want to restrict the access to one of your Jira projects to the group you selected above:

  1. In LQE, go to the Administration > Access Control > Permissions page.

  2. Scroll down the list on the left to find your Jira data sources (CM and Process).

  3. For both data sources, select the Only apply permissions assigned directly to this data group option.

  4. Then click the Add groups… button below, select the desired group in the list then click OK.

You’re done, only users in the group can now access the indexed data, from reporting tools (Report Builder, Engineering Insight) or manual querying in LQE.

You should always leave access to the rs_user functional user to your Jira Data. This is the user used by Report Builder to retrieve metamodel data, which are used when generating reports.