Adding data sources to Lifecycle Query Engine by using root services documents

Any lifecycle management tool that supports the Tracked Resource Set (TRS) specification can be a data source for the Lifecycle Query Engine (LQE) index. If the lifecycle management application has a root services document that declares its OAuth URLs, you can register the TRS feed for that data source by using the root services URL. This is an easy method for adding an LQE data source if the application is registered with a different Jazz Team Server than LQE. When LQEcommunicates with the TRS provider (the lifecycle management application), it authenticates directly with the application.

Before you begin

You must create an OAuth Consumer Secret/Key pair for LQE within the lifecycle management application. The inbound consumer must be trusted and it must have a functional user (lqe_user). The TRS Internal License must be assigned to the functional user. For more information, see Connecting Lifecycle Query Engine to applications that use a different Jazz Team Server.

Procedure

  1. From the LQE administration page, go to Data Sources at http://<host_name>:<port>/lqe/web/admin/data-sources. This page shows the live status of the data sources LQE is connected to.
    Screen capture of the data sources panel showing a data source being indexed.
  2. Click Add Data Source and select Root Services URL.
    Screen capture of the Add Data Source wizard.
  3. Enter the root services document for the application you want to add. The format of the URL is: https://server:port/tool/rootservices.
    In the root services document, the data sources are listed in this format: https://server:port/tool/trs. Select the data source that you want to add.
    Note: If the data source that you need is not listed in the root services document, enter the service contribution resource (SCR) URL in the Root Services URL field. For example, to add the TRS 2.0 for DNG Resources data source, enter https://server:port/rm/scr instead of the root services document.
  4. Add a label as an identifier for the data source.
  5. Optional: The scheduling fields allow you to set when the initial indexing will occur. If you leave the fields blank, the index is created as soon as the wizard 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.
  6. Choose to specify the OAuth authentication, and click Next.
  7. On the Specify Authentication Details panel, enter the OAuth Consumer Key and Secret for the application.
    Authentication details panel
  8. Configure the data source.
    Screen capture of the "Configure Data Source" panel of the Add Data Source wizard
    Hover over the question marks next to the property labels to find out details about the properties and their values.
    • The refresh rate specifies how often LQE attempts to access the data source to refresh the 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.
    • The refresh rate specifies how often LQE attempts to access the data source to refresh the 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.
    • The number of threads to fetch artifacts when adding or reindexing the data source should be between 2 and 4. Each thread is roughly equivalent to one user using the LQE server. On Intel systems, if you use more than 4 threads, the improvement in data retrieval speed is minimal.
    • The option to continue with change log processing if resources are skipped, allows LQEto log an error and continue indexing after encountering a resource that cannot be indexed. This option is selected by default. If you disable it, the indexing process stops when a resource cannot be indexed.

What to do next

To stop indexing a data source, click the name of the data source in the list, and click the Pause indexing icon.
Screen capture of the Pause indexing button on the data source page.

Feedback