> For the complete documentation index, see [llms.txt](https://docs.ovaledge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ovaledge.com/release8.1/connectors/connector-repositories/reporting-tool/ibm-cognos-analytics/ibm-cognos-analytics-lineage.md).

# IBM Cognos Analytics - Lineage

This article outlines the lineage coverage, configuration requirements, supported components, transformation types, use cases, and known limitations of the IBM Cognos Analytics connector. The connector provides lineage extraction across legacy Cognos BI 10.x and modern Cognos Analytics 11.x content. It connects reports to Framework Manager packages, Data Modules, and underlying physical database tables. It also supports report-to-report relationships, including sub-reports and dashboard widgets, where the required metadata and dependencies are available.

## Lineage Configuration Requirements

Accurate lineage extraction depends on the availability of Cognos report metadata, dashboard and module metadata, Framework Manager model definitions, and underlying physical database objects. The required version identification, model paths, and domain configurations must be available before lineage generation.

### Configuration Requirements Table

<table data-search="false"><thead><tr><th width="186.0546875">Configuration</th><th>Required Detail</th></tr></thead><tbody><tr><td>Cognos Metadata</td><td>Cognos reports, dashboards, modules, and their Chart and ChartChild metadata must be crawled before lineage generation.</td></tr><tr><td>Cognos Version Identification</td><td>The <code>conn_cognos_version_attr</code> attribute must correctly identify <code>version_10</code> for legacy XML content. Other values route processing to Cognos Analytics 11.x JSON content.</td></tr><tr><td>Framework Manager Model</td><td>For Cognos BI 10.x, the Framework Manager project must be exported or synchronized under the configured Model Path. The <code>model.xml</code> file must be available.</td></tr><tr><td>Physical Database Objects</td><td>Referenced physical database objects should already be cataloged to resolve package and query subject sources to the corresponding tables and columns.</td></tr><tr><td>Data Module Dependencies</td><td>Cognos Analytics 11.x reports, dashboards, and stories require the referenced Data Module object to exist in the same domain.</td></tr><tr><td>TEMP Path</td><td>Configuring the TEMP path is recommended to maintain the <code>cognosmodellineage.json</code> package-model cache.</td></tr></tbody></table>

{% hint style="warning" %}
Missing Framework Manager model files, unavailable Data Modules, incorrect Cognos version identification, or uncataloged physical database objects may result in incomplete lineage extraction or unresolved source and target mappings.
{% endhint %}

## Lineage Components

The IBM Cognos Analytics connector supports lineage extraction across Framework Manager packages, Report Studio content, physical database objects, and Cognos Analytics 11.x Data Modules. The level of lineage coverage varies depending on the component, query structure, and availability of metadata.

### Component Support Matrix

<table data-search="false"><thead><tr><th>Component / Feature</th><th align="center">Availability</th></tr></thead><tbody><tr><td>Framework Manager Packages</td><td align="center">✅</td></tr><tr><td>Model-based Query Subjects</td><td align="center">✅</td></tr><tr><td>SQL-backed Query Subject – Single Table</td><td align="center">⚠️</td></tr><tr><td>SQL-backed Query Subject – Multi-table / CTE / Subquery</td><td align="center">❌</td></tr><tr><td>Business Views / Shortcuts / Security Views</td><td align="center">✅</td></tr><tr><td>Physical DB Tables / Columns</td><td align="center">✅</td></tr><tr><td>Report Studio Queries / Data Items / Expressions</td><td align="center"> ⚠️</td></tr><tr><td>Report Studio Filters</td><td align="center">⚠️</td></tr><tr><td>Report Studio Joins / Set Operations</td><td align="center">⚠️</td></tr><tr><td>Query Studio / CRQReport</td><td align="center">⚠️</td></tr><tr><td>Classic Dashboard XML</td><td align="center">⚠️</td></tr><tr><td>CA11 Data Modules</td><td align="center">✅</td></tr><tr><td>CA11 Explorations</td><td align="center">⚠️</td></tr><tr><td>CA11 Reports / Dashboards / Stories on Data Modules</td><td align="center">⚠️</td></tr><tr><td>Prompts / Macros / Dynamic SQL</td><td align="center">❌</td></tr></tbody></table>

{% hint style="info" %}
The ⚠️ icon indicates partially supported functionality with limited lineage coverage in applicable scenarios.
{% endhint %}

{% hint style="info" %}
Cognos BI 10.x and Cognos Analytics 11.x use different metadata formats and lineage processing paths. Lineage coverage depends on the availability and resolution of the corresponding metadata.
{% endhint %}

## Column Creation Support

The IBM Cognos Analytics connector supports column-level lineage for direct column mappings, matching column names, and nested query relationships through `refQuery` and `refDataItem` references. Simple aliases with matching or normalized destination names also support lineage mapping in applicable scenarios.

Complex expressions, aggregations, conditional calculations, and multi-column derived fields have limited or unsupported coverage. UNION, INTERSECT, and EXCEPT operations do not provide column-level alignment.

### Column Creation from Lineage

<table data-search="false"><thead><tr><th>Transformation Type</th><th align="center">Supported</th></tr></thead><tbody><tr><td>1:1 Pass-through Columns / Same-name Mapping</td><td align="center">✅</td></tr><tr><td>Simple Alias with Matching / Normalized Destination Name</td><td align="center"> ⚠️</td></tr><tr><td>Nested <code>refQuery</code> / <code>refDataItem</code> Ancestry</td><td align="center">✅</td></tr><tr><td>Expressions / Aggregates / CASE / Arithmetic</td><td align="center">⚠️</td></tr><tr><td>Union / Intersect / Except Column Alignment</td><td align="center">❌</td></tr><tr><td>Prompt / Macro / Dynamic-SQL Derived Columns</td><td align="center">❌</td></tr></tbody></table>

{% hint style="info" %}
The ⚠️ icon indicates partially supported functionality with limited lineage coverage in applicable scenarios.
{% endhint %}

{% hint style="warning" %}
Column-level lineage primarily depends on direct mappings and exact or normalized column-name matching. Complex expressions and derived columns may not produce complete source-to-target column mappings.
{% endhint %}

## Supported Use Cases

The IBM Cognos Analytics connector supports lineage extraction across Framework Manager packages, Report Studio reports, physical database objects, and Cognos Analytics 11.x Data Modules. It also supports selected report-to-report dependencies and direct column mappings.

### Supported Lineage Scenarios

<table data-search="false"><thead><tr><th width="291.49609375">Supported Scenario</th><th width="662.1328125">Details</th></tr></thead><tbody><tr><td>Report Studio Report → Framework Manager Package Lineage</td><td>Lineage extraction between Report Studio reports and associated Framework Manager packages.</td></tr><tr><td>Framework Manager Namespace / Business View / Database View → Physical DB Table Lineage</td><td>Lineage extraction from Framework Manager namespaces and views to underlying physical database tables.</td></tr><tr><td>Static / Simple Query Subjects → Physical Tables</td><td>Lineage extraction for static and simple query subjects backed by physical database tables.</td></tr><tr><td>Report Studio Query / Data Item Lineage</td><td>Lineage extraction across Report Studio queries, data items, and supported query relationships.</td></tr><tr><td><code>refQuery</code> / <code>refDataItem</code> Relationships</td><td>Lineage extraction across nested query and data item references.</td></tr><tr><td>CA11 Data Module → Query Subject / Query Item Lineage</td><td>Lineage extraction across supported query subjects and query items within Cognos Analytics 11.x Data Modules.</td></tr><tr><td>CA11 Reports / Dashboards / Stories → Data Modules</td><td>Lineage extraction for reports, dashboards, and stories built on a single resolvable Data Module.</td></tr><tr><td>Parent Report → Sub-report Lineage</td><td>Lineage extraction across parent reports and associated sub-reports.</td></tr><tr><td>Classic Dashboard Widget → Report Binding</td><td>Lineage extraction between classic dashboard widgets and reports using the <code>storeID()</code> text pattern.</td></tr><tr><td>Direct / Name-matched Column Lineage</td><td>Column-level lineage for direct mappings where source and destination column names match or follow supported normalized naming patterns.</td></tr></tbody></table>

{% hint style="info" %}
Lineage extraction depends on the availability of Framework Manager metadata, physical database objects, Data Module dependencies, and supported report relationships.
{% endhint %}

## Partial or Limited Coverage

Certain Cognos components and query structures provide partial lineage coverage. Limitations primarily apply to complex SQL statements, report filters, join and set-operation logic, dashboard bindings, and column-level mapping scenarios.

### Scenarios

<table data-search="false"><thead><tr><th width="237.7421875">Scenario</th><th width="551.6875">Limitation Description</th></tr></thead><tbody><tr><td>Query Studio / CRQReport</td><td>Package-level lineage generally resolves, but per-item lineage details are more limited than Report Studio.</td></tr><tr><td>Report Filters</td><td>Filters are cataloged as raw or pseudo-column text. Filter expressions are not resolved to the corresponding source columns.</td></tr><tr><td>Joins and Set Operations</td><td>Join and set-operation participants are identified, but join keys and column alignment are not semantically modeled.</td></tr><tr><td>SQL-backed Framework Manager Query Subjects</td><td>Lineage extraction is reliable mainly for simple single-table SQL queries.</td></tr><tr><td>Classic Dashboard Bindings</td><td>Dashboard lineage depends on the <code>storeID()</code> text pattern for report binding resolution.</td></tr><tr><td>CA11 Explorations</td><td>Only the first source is considered in the documented implementation.</td></tr><tr><td>CA11 Reports / Dashboards / Stories</td><td>Lineage resolution depends on name-based Data Module matching.</td></tr><tr><td>Column-level Lineage</td><td>Column mapping primarily depends on exact or normalized source and destination column-name matching.</td></tr></tbody></table>

{% hint style="warning" %}
Partial coverage may result in incomplete query-level, report-level, or column-level lineage. Join relationships, filter expressions, and multi-source dependencies may require manual validation.
{% endhint %}

## Unsupported Scenarios

The IBM Cognos Analytics connector does not provide complete lineage coverage for certain dynamic query structures, runtime-dependent expressions, and complex transformation scenarios. These limitations primarily apply to prompts, macros, dynamic SQL, multi-table SQL queries, and expression-based column derivation.

### Unsupported Lineage

<table data-search="false"><thead><tr><th width="268.74609375">Not Supported</th><th width="342.953125">Impact</th><th width="438.6171875">Workaround</th></tr></thead><tbody><tr><td>Cognos Prompts / Macros (<code>#prompt</code>, <code>#sql#</code>)</td><td>Prompt and macro-based query logic is not resolved during lineage extraction.</td><td>Validate the affected query dependencies and document the source and target relationships separately.</td></tr><tr><td>Dynamic SQL Evaluation</td><td>SQL statements generated dynamically are not evaluated for lineage extraction.</td><td>Use statically defined SQL queries where applicable.</td></tr><tr><td>Complex Multi-table SQL / CTEs / Subqueries in Framework Manager <code>dbquery</code> Objects</td><td>Reliable physical-table extraction is not available for complex SQL structures.</td><td>Validate the underlying SQL dependencies and document unresolved source relationships separately.</td></tr><tr><td>Expression-aware Lineage</td><td>Calculated, aggregated, CASE/IF, and multi-column derived fields do not provide complete expression-based lineage.</td><td>Validate complex expressions and supplement missing column-level mappings manually.</td></tr><tr><td>UNION / INTERSECT / EXCEPT Column Alignment</td><td>Per-column alignment across set operations is not supported.</td><td>Validate the column mappings and document the relationships separately.</td></tr><tr><td>Multi-source CA11 Explorations</td><td>Complete lineage across multiple sources is not supported.</td><td>Validate and document additional source dependencies separately.</td></tr><tr><td>Missing Framework Manager <code>model.xml</code></td><td>Automatic lineage cannot be generated when the referenced model file is unavailable in the configured Model Path.</td><td>Export or synchronize the Framework Manager project and provide the required <code>model.xml</code> file.</td></tr></tbody></table>

{% hint style="warning" %}
Unsupported scenarios do not produce complete lineage and may result in disconnected or incomplete lineage paths in lineage visualization. Manual validation or lineage supplementation may be required for affected scenarios.
{% endhint %}

## Current Functional Status

The IBM Cognos Analytics connector provides production-ready lineage coverage for the core Framework Manager and Report Studio lineage path, including package relationships, supported query structures, physical database mappings, and sub-report dependencies. It also supports selected Cognos Analytics 11.x Data Module scenarios.

However, Cognos Analytics 11.x Explorations, Dashboards, and Stories have partial or Beta-level coverage. Complex SQL queries, prompts, macros, dynamic SQL, and calculated-column lineage have limited or unsupported coverage and may require manual validation or lineage supplementation.

### Functional Coverage Summary

<table data-search="false"><thead><tr><th width="203.84765625">Status Area</th><th width="746.91796875">Details</th></tr></thead><tbody><tr><td>Overall Coverage</td><td>Production-ready coverage for core Framework Manager and Report Studio lineage, with partial coverage for selected Cognos Analytics 11.x components.</td></tr><tr><td>Lineage Depth</td><td>Lineage across reports, Framework Manager packages, Data Modules, physical database tables, and supported report dependencies.</td></tr><tr><td>Supported Inputs</td><td>Framework Manager packages, model-based query subjects, Business Views, shortcuts, security views, physical database tables and columns, Report Studio content, and CA11 Data Modules.</td></tr><tr><td>Functional Scope</td><td>Lineage extraction across supported report definitions, query subjects, semantic models, Data Modules, dashboard bindings, and report dependencies.</td></tr><tr><td>Column-level Coverage</td><td>Direct column mappings, same-name mappings, supported aliases, and nested <code>refQuery</code> and <code>refDataItem</code> relationships.</td></tr><tr><td>Limitation Areas</td><td>Report filters, joins, set operations, SQL-backed query subjects, Query Studio, CRQReport, classic dashboard bindings, and selected CA11 components.</td></tr><tr><td>Unsupported Areas</td><td>Prompts, macros, dynamic SQL, complex multi-table SQL, expression-aware derived-column lineage, and set-operation column alignment.</td></tr><tr><td>Resulting Output</td><td>Production-ready lineage for core Cognos BI 10.x and supported Cognos Analytics 11.x scenarios, with partial coverage for advanced query, reporting, and transformation scenarios.</td></tr></tbody></table>

{% hint style="warning" %}
The IBM Cognos Analytics connector provides production-ready lineage for core Framework Manager and Report Studio scenarios, including package relationships, supported query structures, physical database mappings, and sub-report dependencies. Cognos Analytics 11.x Data Modules have support for selected lineage scenarios, while Explorations, Dashboards, and Stories have partial or Beta-level coverage. Complex SQL, prompts, macros, dynamic SQL, and calculated-column lineage require manual validation or lineage supplementation.
{% endhint %}

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ovaledge.com/release8.1/connectors/connector-repositories/reporting-tool/ibm-cognos-analytics/ibm-cognos-analytics-lineage.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
