> 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/sap-businessobjects.md).

# SAP BusinessObjects

This article outlines the integration with the SAP BusinessObjects connector, enabling streamlined metadata management through features such as crawling and lineage building (both automatic and manual).

This connector uses REST APIs to authenticate, discover folders and reports, retrieve report definitions, and extract source code from Web Intelligence and Crystal Reports. It authenticates using the configured service account and authentication method, such as sec Enterprise, LDAP, or Windows AD, to access SAP BusinessObjects metadata and APIs based on the assigned permissions.&#x20;

<img src="/files/YxtbbDjns1sVbwlUBAfi" alt="" height="359" width="624">

## Overview

### Connector Details

| Connector Category                                                                      | Reporting Tool       |
| --------------------------------------------------------------------------------------- | -------------------- |
| OvalEdge Release Supported                                                              | Release6.x and later |
| <p>Connectivity</p><p>\[How the connection is established with SAP BusinessObjects]</p> | REST APIs            |

### Connector Features

<table data-search="false"><thead><tr><th width="370">Feature</th><th align="center">Availability</th></tr></thead><tbody><tr><td>Crawling</td><td align="center">✅</td></tr><tr><td>Delta Crawling</td><td align="center">❌</td></tr><tr><td>Profiling</td><td align="center">NA</td></tr><tr><td>Sample Profiling</td><td align="center">NA</td></tr><tr><td>Query Sheet</td><td align="center">NA</td></tr><tr><td>Data Preview</td><td align="center">❌</td></tr><tr><td>Auto Lineage</td><td align="center">✅</td></tr><tr><td>Manual Lineage</td><td align="center">✅</td></tr><tr><td>Secure Authentication via Credential Manager</td><td align="center">✅</td></tr><tr><td>Data Quality</td><td align="center">NA</td></tr><tr><td>DAM (Data Access Management)</td><td align="center">NA</td></tr><tr><td>Bridge</td><td align="center">✅</td></tr></tbody></table>

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

### Metadata Mapping

The following objects are crawled from SAP BusinessObjects and mapped to the corresponding UI assets.

<table data-search="false"><thead><tr><th width="183">Source Object</th><th width="163">Source Attribute</th><th width="186">OvalEdge Attribute</th><th width="173">OvalEdge Category</th><th width="155">OvalEdge Type</th></tr></thead><tbody><tr><td>Folder</td><td>SI_NAME / path</td><td>Report Group</td><td>Report Group</td><td>Report Group</td></tr><tr><td>Webi Report</td><td>SI_NAME</td><td>Report</td><td>Report</td><td>webi</td></tr><tr><td>Webi Report</td><td>SI_KIND</td><td>Report Type</td><td>Report</td><td>webi</td></tr><tr><td>Webi Report</td><td>SI_DESCRIPTION</td><td>Source Description</td><td>Report</td><td>Source Description</td></tr><tr><td>Crystal Report</td><td>SI_NAME</td><td>Report</td><td>Report</td><td>CrystalReport</td></tr><tr><td>Crystal Report</td><td>SI_KIND</td><td>Report Type</td><td>Report</td><td>CrystalReport</td></tr><tr><td>Crystal Report</td><td>SI_DESCRIPTION</td><td>Source Description</td><td>Report</td><td>Source Description</td></tr><tr><td>Sub Report</td><td>name</td><td>Report</td><td>Report</td><td>Worksheet</td></tr><tr><td>Report Columns</td><td>-</td><td>Report Column</td><td>Report Column</td><td>ChartChild</td></tr></tbody></table>

## 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. 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 SAP BusinessObjects administrator, as users may not have the required access to assign them independently.
{% endhint %}

<table data-search="false"><thead><tr><th width="136">Objects</th><th width="219">API Details</th><th width="251">Authentication / Headers</th><th width="188">Access Permissions</th></tr></thead><tbody><tr><td>SAP BusinessObjects Connection</td><td>POST {server}/logon/long (Enterprise/LDAP)<br>POST {server}/logon/adsso (Windows AD)<br>POST {server}/logoff</td><td><p>Accept: application/xml<br>Content-Type: application/xml<br>Request body: userName, password, auth (for Enterprise/LDAP)</p><p>X-SAP-LogonToken (Logoff)</p></td><td>Login access to the SAP BusinessObjects BI Platform using the configured authentication type.</td></tr><tr><td>Domains / Folders</td><td><p>POST {server}/v1/cmsquery?page=1&#x26;pagesize=2000</p><p>CMS Query:SELECT SI_ID, SI_NAME, SI_PATH FROM CI_INFOOBJECTS WHERE SI_ANCESTOR=23 AND SI_KIND='Folder'</p></td><td><p>X-SAP-LogonToken</p><p>Accept: application/json<br>Content-Type: application/json</p></td><td>View Objects permission on the required folders and subfolders.</td></tr><tr><td>Reports (Web Intelligence, Crystal Reports)</td><td>POST {server}/v1/cmsqueryCMS Query retrieves report metadata from CI_INFOOBJECTS for Web Intelligence and Crystal Reports.</td><td><p>X-SAP-LogonToken</p><p>Accept: application/json</p><p>Content-Type: application/json</p></td><td>View Objects permission on Web Intelligence documents and Crystal Reports.</td></tr><tr><td>Web Intelligence Worksheets</td><td>GET {server}/raylight/v1/documents/{reportId}/reports</td><td>X-SAP-LogonToken<br>Accept: application/json</td><td>View Objects and View Document permissions.</td></tr><tr><td>Web Intelligence Data Providers</td><td>GET {server}/raylight/v1/documents/{reportSiId}/dataproviders</td><td><p>X-SAP-LogonToken</p><p>Accept: application/json</p></td><td>View Objects and View Document permissions.</td></tr><tr><td>Web Intelligence Source Code</td><td>GET {server}/raylight/v1/documents/{reportSiId}/dataproviders/{dpId}</td><td>X-SAP-LogonToken<br>Accept: application/json</td><td>View Objects and View Document permissions.</td></tr><tr><td>Crystal Report Source Code</td><td>GET {server}/infostore/folder/{reportSiId}/file</td><td>X-SAP-LogonToken<br>Accept: application/json</td><td>View Objects and Download Files permissions.</td></tr><tr><td>Crystal Report Source Code Conversion</td><td>POST {rptRemoteBaseUrl}/sourcecode</td><td>Content-Type: application/json<br>Request body: reportId, logonToken, tempPath, rptToXmlExtPath, baseUrl</td><td>View Objects and Download Files permissions.</td></tr></tbody></table>

### 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 **SAP BusinessObjects**, and complete the required parameters.

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

<table data-search="false"><thead><tr><th width="221">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "SAP BusinessObjects" 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 Vault</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><p>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.</p><p>For more details, click<a href="https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/license-types-and-add-ons"> here</a>. </p></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the SAP BusinessObjects connection</p><p>(Example: "SAP BusinessObjects_Prod").</p></td></tr><tr><td>Connector Environment</td><td><p>Select the environment (Example: PROD, STG) configured for the connector.</p><p>For more details, click<a href="https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/prerequisites#connector-environment"> here</a>. </p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Filter</td><td>Enter an optional filter expression to limit the folders or reports retrieved during metadata crawling. Use this field to restrict the scope of metadata extraction based on the configured filter criteria.</td></tr><tr><td>Base URL*</td><td>Enter the base URL or endpoint of the SAP BusinessObjects REST API server. This URL is used to authenticate, retrieve metadata, and access SAP BusinessObjects assets through the REST APIs.</td></tr><tr><td>Authentication Type*</td><td>Enter the authentication method used to authenticate the connection to the SAP BusinessObjects server, such as sec Enterprise, LDAP, Windows AD, etc. Ensure that the specified authentication method matches the authentication configuration of the SAP BusinessObjects environment.</td></tr><tr><td>Include Folder Path</td><td>Enter the folder path to limit metadata extraction to specific SAP BusinessObjects folders. Only reports and subfolders within the specified paths are included during crawling.</td></tr><tr><td>RPT Folder Path</td><td>Enter the directory path where SAP BusinessObjects report (.rpt) files are stored or accessed. This path is used to retrieve report files for metadata extraction and lineage generation.</td></tr><tr><td>Username*</td><td>Enter the username of the SAP BusinessObjects service account configured for the connector. Ensure that the account has the required permissions to access the SAP BusinessObjects applications and metadata.</td></tr><tr><td>Password*</td><td>Enter the password associated with the specified SAP BusinessObjects service account. This password is used to authenticate the connection to SAP BusinessObjects.</td></tr><tr><td>SAP BO RPT Remote Base URL</td><td>Enter the remote base URL used to access SAP BusinessObjects reports. This URL is used to retrieve and process SAP BusinessObjects report files during metadata extraction and lineage generation.</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>

<table data-header-hidden data-search="false"><thead><tr><th width="220"></th><th></th></tr></thead><tbody><tr><td><strong>Default Governance Roles</strong></td><td></td></tr><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.</td></tr><tr><td><strong>Admin Roles</strong></td><td></td></tr><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr><tr><td><strong>No of Archive Objects</strong></td><td></td></tr><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><tr><td><strong>Bridge</strong></td><td></td></tr><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 configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering 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.&#x20;

1. Navigate to the **Connectors** page and click **Crawl/Profile.**
2. Select the report groups to crawl.
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 in OvalEdge provides a centralized view of all configured connectors, including their health status.

**Managing connectors includes:**

* **Connectors 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.
  * **Lineage**: Select server dialects for parsing and setting connector priority for table lineage.
  * **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).

## Limitations

<table><thead><tr><th width="86.7777099609375">S.No.</th><th width="181.629638671875">Known Limitation</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td>Sub-Report Lineage</td><td>The SAP BO connector supports cataloging WebI Worksheets/Sub-Reports. However, lineage generation for Sub-Reports is currently not supported.</td></tr></tbody></table>

## 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="87">S. No.</th><th width="156">Error Message</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Authentication or Login Failed</td><td><p>The connector cannot authenticate with the SAP BusinessObjects server due to invalid connection details or an incorrect authentication method.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the Base URL, Username, and Password are correct.</li><li>Ensure that the Authentication Type matches the SAP BusinessObjects configuration (for example, sec Enterprise, LDAP, Windows AD, etc.).</li><li>Confirm that the appropriate login endpoint is used for the selected authentication method.</li></ul></td></tr><tr><td>2</td><td>Connection Timeout</td><td><p>The connector is unable to establish a connection with the SAP BusinessObjects server within the configured timeout period. This may occur because of network connectivity issues or an unavailable server.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the SAP BusinessObjects server is running and reachable.</li><li>Ensure that the configured Base URL and proxy settings are correct.</li><li>Increase the connection timeout value if the server responds slowly.</li></ul></td></tr><tr><td>3</td><td>No Folders or Domains Crawled</td><td><p>The crawling process completes successfully, but no folders or domains are discovered because the configured filters or folder paths do not match available content.</p><p><strong>Resolution</strong>:</p><ul><li>Verify the values configured in the Filter and Include Folder Path fields.</li><li>Ensure that the specified folders exist and are accessible to the service account.</li><li>Check whether the folders are excluded by the configured crawling criteria.</li></ul></td></tr><tr><td>4</td><td>No Reports Found Under a Folder</td><td><p>The selected folder does not contain supported SAP BusinessObjects report types or contains report instances that are excluded during crawling.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the folder contains supported Web Intelligence or Crystal Reports.</li><li>Ensure that only base reports (non-instance reports) are selected for crawling.</li><li>Confirm that the service account has permission to access the reports.</li></ul></td></tr><tr><td>5</td><td>Crystal Report Source Code Not Retrieved</td><td><p>The connector cannot retrieve Crystal Report source code because the report files are unavailable or the required configuration is incomplete.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the RPT Folder Path is configured correctly.</li><li>Ensure that the service account has permission to download Crystal Report files from the InfoStore.</li><li>Check whether the report file size exceeds the configured processing limit.</li></ul></td></tr><tr><td>6</td><td>Web Intelligence Source Code Not Retrieved</td><td><p>The connector cannot retrieve the source code of Web Intelligence reports because the required Raylight APIs are inaccessible or permissions are insufficient.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the Raylight REST APIs are accessible from the configured environment.</li><li>Ensure that the service account has the required permissions to access Web Intelligence documents and data providers.</li><li>Confirm that the report contains valid data providers.</li></ul></td></tr><tr><td>7</td><td>Incomplete Lineage or Missing Table Links</td><td><p>Data lineage is generated, but some source or target table relationships are missing because the required metadata or source code is unavailable.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the report source code was successfully extracted.</li><li>Ensure that the referenced tables, databases, or universes have already been crawled into OvalEdge.</li><li>Re-run lineage generation after the required metadata has been imported.</li></ul></td></tr><tr><td>8</td><td>Connection Timeout</td><td><p>This error occurs when the connection to the SAP BO server takes too long and times out.</p><p><strong>Resolution</strong>:</p><ul><li>Ensure the SAP BO server is running and accessible.</li><li>Check if there is any network latency or firewall blocking the connection.</li><li>Increase the timeout settings in the connector configuration.</li><li>Verify that the network port required for the BO server is open.</li></ul></td></tr><tr><td>9</td><td>Mismatch in Report Counts Between Built Lineage and Data Catalog</td><td><p>This issue occurs when source code retrieval fails for certain SAP BO reports during crawling. As a result, the number of reports displayed in the Built Lineage page may not match the reports available in the Data Catalog.</p><p><strong>Resolution:</strong></p><ul><li>Review report group crawling job logs for source code retrieval failures or internal server errors.</li><li>Verify that the affected reports are accessible in the SAP BO source system.</li><li>Ensure the SAP BO APIs return the required report metadata successfully.</li><li>Re-run the crawl after resolving source system or API-related issues.</li></ul></td></tr></tbody></table>

## FAQs

<table data-search="true"><thead><tr><th width="93" data-type="number">Sl. No.</th><th width="245">Question</th><th width="503">Answer</th></tr></thead><tbody><tr><td>1</td><td>Why are sub-reports displayed as worksheets after crawling?</td><td>For Web Intelligence and Crystal Reports, sub-reports are retrieved through the SAP BusinessObjects Raylight APIs and are stored in OvalEdge as Worksheet assets. This is the expected behavior.</td></tr><tr><td>2</td><td>Why are report columns not displayed immediately after metadata crawling?</td><td>Report columns are not created during metadata crawling. They are generated during the lineage extraction process when the connector parses the report source code.</td></tr><tr><td>3</td><td>Why are domain users or report users not available after crawling?</td><td>Crawling of domain users and report-level users is currently not supported by the SAP BusinessObjects connector. As a result, this information is not retrieved during metadata extraction.</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.1/connectors/connector-repositories/reporting-tool/sap-businessobjects.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.
