Installing and enabling LQE relational store

Installing the new user experience

Complete the following steps to install the new user experience of Report Builder and LQE rs on a separate server to integrate with your IBM Engineering 7.0.3 environment:

  1. Establish a copy of ELM 7.0.2 production data in a test environment.
  2. Use ELM 7.0.3 to upgrade your ELM 7.0.2 test environment.
  3. Download and install the latest IBM Installation Manager from https://jazz.net/downloads/ibm-installation-manager.
  4. Run Installation Manager, go to File > Preferences > Repositories, and select Add Repository.
  5. Click Browse, select the zip file, and click OK twice.
  6. Click Install.
  7. Under Install Packages, select Jazz Reporting Service.
  8. Follow the installation wizard to accept the license, select an install location, select a language, and then when you get to the Install Packages page, expand Jazz Reporting Service, and deselect Data Collection Component.
  9. Select the web application server. Use the default context roots for the applications.
  10. Enable Jazz Security Architecture SSO.  These instructions assume that your existing 7.0.2 installation is already using Single Sign-On. During setup later, you point to your existing Jazz Authorization Server to handle the Single Sign-On for the new user experience applications.
  11. Click Install and wait for the installation to complete.

Starting the application server

Start the application server.

Enabling diagnostic data logs

For Report Builder

To enable diagnostic data collection for report executions in Report builder, a new set of logs is now written to the server/logs/directory/rs-lqe-query.log file.

The new logs are enabled by default in the server/conf/rs/log4j2.xml file:
<!-- LQE-RS log file -->
        <RollingFile name="lqeRsLog" filename="${dir}/${app}-lqe-query.log" filePattern="${dir}/${app}-lqe-query-%i.log">
            <PatternLayout pattern="${pattern}"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="10 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="5"/>
        </RollingFile>
For LQE
LQE now logs performance and sizing metrics in a specialized log file, lqe-rs.log. The diagnostic data is useful for comparing an existing LQE implementation with the new LQE relational store.
Note: This data is collected only if the LQE relational store is enabled.
The lqe-rs.log file contains the following information:
  • System specifications of the server that hosts LQE:
    • Operating system
    • Amount of RAM
    • Number of processors
  • Metrics for any major data source operations such as reindexing or validation.
  • Size of every table in the LQE relational store.
If the following lines are not available, add them to the conf/lqe/log4j2.xml file to enable logging:
<!-- Log file -->
		<RollingFile name="lqeLog" filename="${dir}/${app}.log" filePattern="${dir}/${app}-%i.log">
			<PatternLayout pattern="${pattern}"/>
			<Policies>
				<SizeBasedTriggeringPolicy size="10 MB"/>
			</Policies>
			<DefaultRolloverStrategy max="5"/>
		</RollingFile>

Registering LQE relational store and Report Builder with 703 JTS

Register LQE rs and Report Builder applications with 703 JTS.

Configuring LQE relational database connection

To configure LQE relational database connection, proceed as follows:
Note: The relational store can be enabled for the Link Index Provider (LDX) web application by using the same procedure as the one for the Lifecycle Query Engine (LQE). Before you enable the relational store for LDX, consider the following requirements:
  • The LDX relational store must be a different instance than the one for LQE.
  • The database must be created by using the data warehouse setup page of the Jazz Team Server (JTS) setup wizard.
  1. Use the following properties to use relational store for reports:
    • Use relational store as default for new reports lqe.dw.trs.default=true
    • Use a relational store for all reports lqe.dw.trs.override=true
  2. Restart the application server for LQE and Report Builder.
  3. On the Lifecycle Query Engine Administration page navigation, under Relational Store, click Settings.
  4. Under Data Warehouse Connection, confirm if the JDBC connection details per-filled from JTS are correct. Enter the JDBC password if needed and then click Save to confirm the connection properties. If information is missing, then you need to add database properties to dbconnection.properties:
    dw.db.vendor = DB2
    dw.db.location = //<host>:50000/jazzdw:user=jazzdb;password={password};
    dw.db.password = *******
    
  5. Enable TRS processing into the Relational Store.

Adding the TRS feeds as data providers to the LQE rs server

The LQE rs server processes the TRS feeds and uses them to populate the newly created data warehouse database.
  1. Go to the Lifecycle Query Engine server’s Data Providers page: https://<server name>:<port>/lqe/web/admin/data-sources.
  2. Click Add All Data Providers.
  3. Compare the list of LQE data providers on your LQE Apache Jena server’s data providers page with the data providers on your LQE rs server to make sure that you did not miss adding any of them.
  4. The new data sources on the LQE rs server begin indexing (and populating the new data warehouse) automatically. Wait until they complete processing.
    Note: By default, the LQE rs should be reindexing and you can skip this section but if that is not the case, you can perform the following steps:
    • Go to LQE data providers https://<server name>:<port>/lqe/web/admin/data-sources.
      Click Reindex All.
      Important: Be sure to select Relational Store before executing the Reindex All.
  5. After the LQE rs finishes indexing, administrator must reindex the vocabularies in LQE before refreshing the type system models in Report Builder.

Reindexing vocabularies

Reindex the vocabularies.

Configuring Report Builder to use the LQE relational database connection

There should be existing data sources that are called Data Warehouse, Lifecycle Query Engine, and Lifecycle Query Engine scoped by a configuration (depending on if you have projects where configurations are enabled; if not, it is automatically created when you click Connect to Data Sources on the Report Builder Admin page).

Note: You see a beta banner on the screen when you go to any Report Builder page. To remove the beta indication, you must contact IBM support and acquire a license key. Add the license key in the LQE relational store activation key field on Advanced Properties page in Report Builder.
Topology 1- Configuring the Report Builder

The LQE data sources are pointed to the LQE rs server, which is the “LQE 2” server in the diagram at the beginning of this document. For clarity, you should edit these to rename them before creating new data sources and setting them to use the relational store.

Then, create new data sources in the Report Builder pointing to the LQE server, which is the “LQE 1” server in the diagram at the beginning of this document.

All the LQE data sources in the Report Builder new user experience are configured to use the data warehouse. Writing reports against the LQE 1 data sources in Report Builder allows you to create SQL reports to work with the indexed data in the data warehouse, which is populated by the LQE rs server, and compare them with SPARQL reports.

  1. Go to the Report Builder Data Sources page: click the Administration icon () on the product banner and select Data Sources or click Data Sources in the Connect to data sources pane on the Admin page.
  2. Edit the existing LQE data sources.
    1. To edit the nonconfig LQE data source:
      1. Click the Lifecycle Query Engine data source in the list.
      2. Rename the data source as Lifecycle Query Engine 2.
      3. Set the Lifecycle Query Engine relational store to Data Warehouse.
      4. Click Save.
    2. To edit the config scoped LQE data source:
      1. Click the Lifecycle Query Engine scoped by a configuration data source in the list.
      2. Rename the data source as Lifecycle Query Engine 2 scoped by a configuration.
      3. Set the Lifecycle Query Engine relational store to Data Warehouse (indexed by: Lifecycle Query Engine 2).
      4. Click Save.
  3. Create the LQE data sources.
    1. To create a nonconfig LQE data source:
      1. Click Create a data source.
      2. Name the new data source as Lifecycle Query Engine 1.
      3. Make sure that the Data source type is set to Lifecycle Query Engine SPARQL Endpoint.
      4. Enter the SPARQL data source URL for the LQE data source on the 7.0.3 Report Builder server: https://<7.0.3 server name>:<port>/lqe/sparql
      5. Set the Authorization Type to Jazz Security Architecture SSO.
      6. Set the Lifecycle Query Engine relational store to Data Warehouse.
      7. Click Save.
    2. To create a new config scoped LQE data source:
      1. Click Create a data source.
      2. Name the new data source as Lifecycle Query Engine 1 scoped by a configuration.
      3. Make sure that the Data source type is set to Lifecycle Query Engine SPARQL Endpoint.
      4. Enter the SPARQL data source URL for the Lifecycle Query Engine scoped by a configuration data source on the 7.0.3 Report Builder server: https://<7.0.3 server name>:<port>/lqe/sparql-variable-config
      5. Set the Authorization Type to Jazz Security Architecture SSO.
      6. Select Require a configuration to run a report.
      7. Set the Lifecycle Query Engine relational store to Data Warehouse (indexed by: Lifecycle Query Engine 2).
        Note: it is important that you select the Data Warehouse via Lifecycle Query Engine 2, rather than the Data Warehouse via Lifecycle Query Engine 1.
      8. Click Save.
Topology 2 - Configuring Report Builder
The LQE data sources are pointed to the LQE rs, which in this topology handles both, the SPARQL as well as the relational store data sources.
Note: You will see a beta banner on the screen when you go to any Report Builder page. To remove the beta indication, you must contact IBM support and acquire a license key. Add the license key in the LQE relational store activation key field on Advanced Properties page in Report Builder.
  1. Go to the Report Builder Data Sources page.
  2. Click the Administration icon () on the product banner and click Data Sources in the Connect to data sources pane on the Admin page.
  3. Edit the existing LQE data sources.
    1. To edit the nonconfig LQE data source
      1. Click the Lifecycle Query Engine data source in the list.
      2. Set the Lifecycle Query Engine relational store to Data Warehouse.
      3. Click Save.
    2. To edit the config scoped LQE data source:
      1. Click the Lifecycle Query Engine scoped by a configuration data source in the list.
      2. Set the Lifecycle Query Engine relational store to Data Warehouse.
      3. Click Save.
  4. Refresh the type system models for all the above data sources.