Any lifecycle tool which supports the TRS specification
can be used as a data source to create the Linked Lifecycle Data Index.
This topic describes how to generate the index for a lifecycle tool
on a different JTS as LQE using a data source URL. This is the most
complex method of adding data sources to LQE, and should only be attempted
by administrators with thorough knowledge of their solution architecture.
About this task
If you application does not have a root services document
or you want to manually provide the OAuth URLs, then you may manually
register the TRS. When LQE communicates with the TRS provider (your
application), it will communicate to your application directly. As
such, you must create an OAuth Consumer Secret/Key pair for LQE within
your 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.
Procedure
- In the LQE administration panel, select
the Data Sources panel. This panel shows the live status
of any data sources LQE is connected to.
- Select Add Data Source and click Data Source
URL.
- Enter the data source URL for your application. The
default format is https://server:port/tool/trs.
Select the data source you want to add.
- Add a label as an identifier for the data source.
- The scheduling fields allow you to set when the initial
indexing will occur. Leaving the fields blank will result 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 may experience a slower indexing
rate.
Note: You can index multiple data sources simultaneously.
Each one will run on its own thread. Alternatively you can schedule
the initial indexing of multiple TRS data sources to run one after
the other.
- Since this application is on a different JTS from LQE,
select to enter the authentication details.
- On the Specify Authentication Details panel,
enter the authentication information for the application.
- In another browser window, find the key 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.
- Under the Authorized Keys list
find and copy the lqe_user key and secret.
- Return to the LQE browser window, and enter the Consumer
Key and Secret.
- Enter the OAuth URLs for you application. Example
URLs would be similar to:
- https://server:port/tool/oauth-request-token
- https://server:port/tool/oauth-authorize
- https://server:port/tool/oauth-access-token
- Select your data source configuration
options.

- The refresh rate specifies how often LQE attempts to
access the data source for ongoing refreshes of its index. A data
source which is not updated frequently can have a slower refresh rate
than a data source which is updated continuously. Increasing the refresh
rate will have a performance impact.
- 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.
- 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.
- 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 will stop any time a resource
cannot be indexed.
- Once you finish the wizard you will be
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 will
display an in-depth status report for the indexing process.
What to do next
If at any point you need to stop
indexing a data source or pause your indexing process, in the main
Data Sources window hover over the Actions field
to display the icons for pausing, stopping or deleting an index.