IBM Report Builder Integration

Overview

IBM Report Builder is a reporting tool that can be fed by IBM Lifecycle Query Engine (LQE). When used with SECollab, it requires configuration to recognize SECollab artifacts and data types, enabling the creation of comprehensive reports that span multiple engineering lifecycle tools.

Prerequisites

Before configuring Report Builder, ensure that:

• you followedIBM Lifecycle Query Engine (LQE) Integration
• LQE has completed initial indexing of SECollab resources
• IBM Report Builder is installed and configured to use LQE as a data source

Meta-Model Refresh

The primary configuration task involves refreshing the meta-model for the "Lifecycle Query Engine" data source. This process allows Report Builder to discover and understand SECollab's resource types and attributes.

When to Refresh the Meta-Model

• Initial Setup: After first configuring SECollab TRS feeds in LQE
• New Projects: When creating or associating new projects in SECollab
• Schema Changes: When SECollab's data model or resource types are modified

Performing a Manual Refresh

1. Access the Report Builder administration interface at https://<rb_host_name>:<port>/rs/setup
2. Navigate to the Data Sources section
3. Locate the "Lifecycle Query Engine" data source
4. Click Refresh Meta-Model
5. Wait for the process to complete (this may take 15-30 minutes in larger environments)
6. Verify that SECollab resource types now appear in the data source schema

Note: The refresh process fetches both new and existing SECollab resources from LQE. In environments with large numbers of artifacts, this operation may take considerable time.

Configuration-Aware Data Sources

For environments using Global Configurations in IBM ELM, you may need to use a configuration-scoped data source:

Enabling Configuration-Scoped Data Source

If the "Lifecycle Query Engine scoped by a configuration" data source does not appear automatically:

1. Access the Report Builder setup page at https://<rb_host_name>:<port>/rs/setup
2. Navigate to Data Sources
3. Expand the data source selection dropdown
4. Click the connection label to trigger an LQE data source update
5. Refresh the page
6. Verify the configuration-scoped option now appears
7. Perform a meta-model refresh for this data source as well

Automated Meta-Model Updates

By default, Report Builder schedules two meta-model updates per day:

• First update: 6:00 AM
• Second update: 6:00 PM

These scheduled refreshes help ensure that Report Builder stays current with changes in SECollab and other connected tools. However, after adding SECollab as a new data source or making significant changes, a manual refresh is recommended for immediate availability.

Verification

After refreshing the meta-model, verify the integration by:

1. Opening Report Builder at https://<rb_host_name>:<port>/rs
2. Creating a new report
3. Selecting the "Lifecycle Query Engine" data source
4. Verifying that SECollab resource types appear in the available data model
5. Creating a simple test report using SECollab data

Troubleshooting

SECollab resources not appearing in Report Builder:

• Verify that LQE has successfully indexed SECollab resources
• Check that the meta-model refresh completed without errors
• Check that the configured LQE permissions allow the user generating the report to access the SECollab project resources
• Review Report Builder logs for any data source connectivity issues
• Ensure OAuth credentials between SECollab and LQE are valid

Meta-model refresh takes excessive time or fails:

• Check network connectivity between Report Builder and LQE
• Verify LQE system resources (CPU, memory) are adequate
• Review LQE and Report Builder logs for specific error messages
• Consider scheduling the refresh during off-peak hours for large datasets

Creating Reports with SECollab Data

Once configured, you can create reports that:

• Query SECollab artifacts and their attributes
• Correlate SECollab data with resources from other ELM tools
• Track design changes and review progress across projects
• Generate traceability reports spanning multiple tools

Refer to IBM Report Builder documentation for detailed instructions on creating and customizing reports.