> 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.2/connectors/connector-repositories/reporting-tool/ibm-cognos-analytics/ibm-cognos-analytics-on-prem.md).

# IBM Cognos Analytics (On-Prem)

This article outlines the integration with the IBM Cognos Analytics (On-Prem) connector, enabling streamlined metadata management through features such as crawling, report preview, and lineage building (both automatic and manual). The connector extracts metadata from IBM Cognos Analytics reports and maps it to the Data Catalog for cataloging and lineage analysis.

This connector connects to the IBM Cognos repository database using JDBC driver to retrieve metadata. Access is established using a dedicated service account with the required permissions to read metadata objects from the IBM Cognos repository, ensuring successful metadata extraction and lineage generation.

<figure><img src="/files/OHbW6DkJUby6np7EYgud" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

| Connector Category                                                                                 | Reporting Tools      |
| -------------------------------------------------------------------------------------------------- | -------------------- |
| OvalEdge Release Supported                                                                         | Release6.x and later |
| <p>Connectivity</p><p>\[How the connection is established with IBM Cognos Analytics (On-Prem)]</p> | JDBC                 |

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |      NA      |
| Sample Profiling                             |      NA      |
| Query Sheet                                  |      NA      |
| Report Preview                               |       ✅      |
| Auto Lineage                                 |       ✅      |
| Manual Lineage                               |       ✅      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |      NA      |
| DAM (Data Access Management)                 |      NA      |
| Bridge                                       |       ✅      |

{% hint style="info" %}
'NA' indicates that the respective feature is 'Not Applicable'.
{% endhint %}

### Metadata Mapping

The following objects are crawled from IBM Cognos Analytics (On-Prem) and mapped to the corresponding UI assets.

| Source Object | Source Attribute   | OvalEdge Attribute | OvaEdge Category | OvalEdge Type      |
| ------------- | ------------------ | ------------------ | ---------------- | ------------------ |
| Folder        | Name of the Folder | Report Group       | Report Group     | Report Group       |
| Report        | Name               | Report             | Report           | Report Name        |
| Report        | Type               | Report Type        | Report           | Report Type        |
| Report        | Desc               | Source Description | Report           | Source Description |
| Dashboard     | Dashboard Name     | Report             | Report           | Report Name        |
| Dashboard     | Type               | Report Type        | Report           | Report Type        |
| Pages         | Page Name          | Report             | Report           | Report Name        |
| Pages         | Type               | Report Type        | Report           | Report Type        |

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

**External Supporting Files**

{% hint style="info" %}
The required external JAR files are included as part of the **OvalEdge installation artifacts**. For driver installation and configuration details, refer to the [**Connector Drivers Setup Guide**](https://docs.ovaledge.com/connectors/additional-requirements/connector-drivers-setup-guide). Please contact the **OvalEdge Team** for assistance related to the driver files and configuration setup.
{% endhint %}

**Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a dedicated service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
**👨‍💻Who can provide these permissions?** These permissions are typically granted by the IBM Cognos Analytics administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operations | Objects              | Access Permissions |
| ---------- | -------------------- | ------------------ |
| Crawling   | Reports, Sub Reports | Select             |

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into OvalEdge, go to **Administration** > **Connectors**, click **+** (New Connector), search for **IBM Cognos Analytics**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="220.272705078125">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>IBM Cognos Analytics</strong>" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul><p>For more details, click <a href="https://docs.ovaledge.com/connectors/additional-requirements/credential-manager-configuration">here</a>.</p></td></tr><tr><td>License Add Ons</td><td>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.<br>For more details, click <a href="https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/license-types-and-add-ons">here</a>.</td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the IBM Cognos Analytics (On-Prem) connection              </p><p>(Example: "IBMCognosAnalyticsOn-Prem").</p></td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.<br>For more details, click <a href="https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/prerequisites#connector-environment">here</a>.</td></tr><tr><td>Connector Description</td><td>Enter the description related to the connector.</td></tr><tr><td>IBM Cognos version*</td><td>Select the Cognos_Version_10 (On-prem) from the drop-down list (Cognos_Version_11 / Cognos_Version_10)</td></tr><tr><td>MetaDB URL*</td><td>Enter the JDBC URL to connect to the IBM Cognos repository database.</td></tr><tr><td>Database Name*</td><td>Enter the name of the IBM Cognos repository database.</td></tr><tr><td>MetaDatabase UserName*</td><td>Enter the username for the IBM Cognos repository database.</td></tr><tr><td>MetaDatabase Password*</td><td>Enter the password for the IBM Cognos repository database.</td></tr><tr><td>Model File Path*</td><td>Enter the path where the IBM Cognos files or folders are located.</td></tr><tr><td>Proxy Enabled*</td><td>Select <strong>Yes</strong> to route API calls through a proxy server. Select <strong>No</strong> to bypass the proxy and connect directly.</td></tr></tbody></table>

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="219.06060791015625"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="219.06060791015625"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the drop-down list for Integration Admin and Security &#x26; Governance Admin. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="220.272705078125"></th><th></th></tr></thead><tbody><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="219.66668701171875"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the **Connectors** home page.

## Manage Connector Operations

### Crawl

{% hint style="warning" %}
To perform crawl operations, users must be assigned the Integration Admin role.
{% endhint %}

The **Crawl/Profile** button allows users to select one or more report groups for crawling.

1. Navigate to the Connectors page and click **Crawl/Profile**.
2. Select the report groups to be crawled.
3. The **Crawl** option is selected by default.
4. Click **Run** to collect metadata from the connected source and load it into the **Data Catalog**.
5. After a successful crawl, the information appears in the **Data Catalog** > **Report / Report Column** tab.

The **Schedule** checkbox allows automated crawling at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the Select Period drop-down.
2. Select a time period for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the crawl operation at the scheduled time.

#### Other Operations

The Connectors page provides a centralized view of all configured connectors, along with their health status.

**Managing connectors includes:**

* **Connector Health**: Displays the current status of each connector using a **green** icon for active connections and a **red** icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing**: Click the **Eye** icon next to the connector name to view connector details.

**Nine Dots Menu Options**:

To view, edit, validate, build lineage, configure, or delete connectors, click on the **Nine Dots** menu.

* **Edit Connector:** Update and revalidate the data source.
* **Validate Connector:** Check the connection's integrity.
* **Settings**: Modify connector settings.
  * **Crawler**: Configure data extraction.
  * **Access Instructions:** Add notes on how data can be accessed.
  * **Business Glossary Settings:** Manage term associations at the connector level.
  * **Others**: Configure notification recipients for metadata changes.
* **Build Lineage:** Automatically build data lineage using source code parsing.
* **Delete Connector:** Remove a connector with confirmation.

For more details on connector settings, click [here](https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/connector-settings).

## Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="92.63641357421875">Sl. No.</th><th width="196.81817626953125">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Authentication Failed</td><td><p><strong>Error Description</strong>:<br>The connection could not be established due to invalid or incorrect authentication credentials.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the username and password are entered correctly.</li><li>Ensure the credentials are active and not expired.</li><li>Confirm that the user has the required access permissions.</li></ul></td></tr><tr><td>2</td><td>Connection Timeout</td><td><p><strong>Error Description:</strong><br>The connection attempt failed because the server did not respond within the expected time.</p><p><strong>Resolution:</strong></p><ul><li>Check if the database server is up and accessible.</li><li>Verify the network connectivity between the application and the server.</li><li>Increase the connection timeout settings if required. </li></ul></td></tr><tr><td>3</td><td>Error while validating connection: Exception occured while invoking the remote method @@@Error while Validating Metadata connection : null</td><td><p><strong>Error Description:</strong></p><p>The IBM Cognos connector validation fails during metadata connection validation, and the system returns a null response. This issue may occur due to incorrect connection configuration, inaccessible IBM Cognos services, authentication issues, or incomplete metadata connection details. </p><p><strong>Resolution</strong>: </p><ul><li>Verify that the IBM Cognos server URL and connection details are correct.</li><li>Confirm that the configured username and password are valid and have the required access permissions.</li><li>Ensure that the IBM Cognos services are running and accessible from the OvalEdge environment.</li><li>Validate network connectivity between the OvalEdge application, Bridge (if applicable), and the Cognos server.</li><li>Check firewall, proxy, or security settings that may be blocking communication.</li><li>Review the Cognos server logs and Bridge logs for additional error details.</li><li>Retry the connection validation after correcting the configuration and connectivity issues.</li></ul></td></tr></tbody></table>

***

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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.