Connecting to a TRS provider as a data source for the Lifecycle Query Engine index using a root services document

Any lifecycle tool that supports the TRS specification can be used as a data source to create the Linked Lifecycle Data Index. If the lifecycle application has a root services document that declares its own OAuth URLs, you can register the TRS using that root services URL. This is the simplest method for adding a data source for applications that are registered with different JTS servers than LQE. When LQE communicates with the TRS provider (the lifecycle application), it will communicate and authenticate directly with the application.

Before you begin

You must create an OAuth Consumer Secret/Key pair for LQE within the application. That inbound consumer must be trusted and must have a functional user (lqe_user). A TRS Internal License must be assigned to the functional user. For more information, see Configuring Lifecycle Query Engine to access lifecycle application data.

Procedure

  1. In the LQE administration panel, select the Data Sources panel. This panel shows the live status of any data sources LQE is connected to.
    Screen capture of the data sources panel showing a data source being indexed.
  2. Select Add Data Source and click Root Services URL.
    Screen capture of the Add Data Source wizard.
    1. Enter the root services document for the application you want to add. The default format for this is: https://server:port/tool/rootservices.
    2. The data sources found listed in this root services document are listed in a format similar to: https://server:port/tool/trs. Select the data source that you want to add.
    3. Add a label as an identifier for the data source.
    4. The scheduling fields allow you to set when the initial indexing will occur. Leaving the fields blank results in the index being created as soon as the wizard is finished. In a test lab environment LQE can index 50 000 artifacts in less than 1 hour - depending on your hardware and configuration you might experience a slower indexing rate.
      Note: You can index multiple data sources simultaneously. Each one runs on its own thread. Alternatively you can schedule the initial indexing of multiple TRS data sources to run one after the other.
    5. Because the application is on a different JTS than LQE is using, you need to specify the OAuth authentication. Click Next.
  3. On the Specify Authentication Details panel, enter the OAuth Consumer Key and Secret for the application.
    Authentication details panel
    1. In another browser window, find the key that you generated for LQE in: Register applications as TRS providers for the Lifecycle Query Engines. In this example you are adding the QM application, so you would go to the QM administrative panel: https://server:port/QM/admin#action=com.ibm.team.repository.admin.configureOAuth.
      Note: Unless your authentication is delegated to the Jazz Team Server, you should go to the administrative panel for the application, not the Jazz Team Server administrative panel.
    2. Under the Authorized Keys list, find and copy the lqe_user key and secret.
    3. Return to the LQE browser window, and enter the Consumer Key and Secret.
  4. Select the data source configuration options.
    Screen capture of the "Configure Data Source" panel of the Add Data Source wizard
    1. The refresh rate specifies how often LQE attempts to access the data source for ongoing refreshes of its index. A data source that is not updated frequently can have a slower refresh rate than a data source that is updated continuously. Increasing the refresh rate has a performance impact.
    2. The number of threads for the initial indexing should generally be set to between 2 and 4. Each thread is roughly equivalent to one user using the LQE server. For Intel machines, the rate of improvement in data retrieval speed for more than 4 threads is minimal.
    3. The number of threads for the ongoing indexing should generally be set to between 2 and 4. Each thread is roughly equivalent to one user using the LQE server. For Intel machines, the rate of improvement in data retrieval speed for more than 4 threads is minimal.
    4. Continue with incremental update in case of skipped resources allows LQE to log an error and continue indexing when it encounters a resource it cannot index. This is selected by default. If it is disabled, the indexing process stops any time that a resource cannot be indexed.
  5. Once you finish the wizard, you are shown the data that can be configured at any point for this data source. Click Save to begin the indexing. The live status of the indexing process is displayed in the main Data Sources panel. Clicking the link in the status field displays an in-depth status report for the indexing process.
    Screen capture of the Data Source status overview page
    Screen capture of the Data Source status history page

What to do next

You can stop indexing a data source or pause the indexing process by hovering over the associated Actions field and clicking the icons.


Feedback