> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# SAP BW/4HANA Pipeline Hybrid Runner

> Connect SAP BW/4HANA to Collate as a pipeline connector using the Hybrid Runner. Deploy the ingestion agent in your environment for secure, private network metadata extraction.

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/sapbw4hana.png" name="SAP BW/4HANA Pipeline" stage="BETA" availableFeatures={["Pipelines", "Pipeline Status", "Lineage"]} unavailableFeatures={["Owners", "Tags", "Usage"]} />

<Info>
  This connector is available exclusively on **Collate**. It is not part of the open-source OpenMetadata distribution.
</Info>

The SAP BW/4HANA Pipeline connector extracts **Process Chains** from your BW/4HANA system as Collate Pipeline entities. Each Process Chain step maps to a Task, run history is captured as Pipeline Status, and the connector traces lineage from Process Chain DTP steps to the target ADSO objects cataloged by the [SAP BW/4HANA database connector](/ai-2-0/connectors/database/sapbw4hana).

Configure and schedule SAP BW/4HANA pipeline workflows from the Collate UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Troubleshooting](#troubleshooting)

## Requirements

The connector reads BW Process Chain catalog tables from the underlying SAP HANA instance. The HANA user requires `SELECT` privileges on the following objects:

### Pipeline Ingestion

```sql theme={null}
-- Process Chain directory and descriptions
GRANT SELECT ON <abapSchema>.RSPCCHAIN TO <user>;
GRANT SELECT ON <abapSchema>.RSPCCHAINT TO <user>;

-- Step (variant) descriptions
GRANT SELECT ON <abapSchema>.RSPCVARIANTT TO <user>;

-- DTP step descriptions
GRANT SELECT ON <abapSchema>.RSBKDTPT TO <user>;
```

### Pipeline Status

```sql theme={null}
-- Latest run per Process Chain
GRANT SELECT ON <abapSchema>.RSPCRECENTRUN TO <user>;

-- Per-step execution log
GRANT SELECT ON <abapSchema>.RSPCPROCESSLOG TO <user>;
```

### Lineage (Process Chain → ADSO)

```sql theme={null}
-- DTP-to-ADSO target mapping
GRANT SELECT ON <abapSchema>.RSBKDTP TO <user>;

-- ADSO InfoArea lookup (needed to resolve lineage targets)
GRANT SELECT ON <abapSchema>.RSOADSO TO <user>;
```

<Tip>
  **Tip**: Replace `<abapSchema>` with your actual ABAP schema name (default: `SAPHANADB`). You can find the correct schema by running:

  ```sql theme={null}
  SELECT SCHEMA_NAME FROM SYS.TABLES WHERE TABLE_NAME = 'RSOADSO';
  ```

  For lineage between Process Chains and ADSO entities to resolve correctly, ensure both the SAP BW/4HANA database service and the SAP BW/4HANA Pipeline service are created in Collate, and configure the **Database Service Name** in the pipeline service's lineage settings.
</Tip>

## Metadata Ingestion

To ingest metadata from SAP BW/4HANA Pipeline, you need to create a service connection. The service connects SAP BW/4HANA with Collate. Once you create a service, Collate automatically starts ingesting metadata.

### Step 1: Add New Service

1. In the left navigation, click **Connections**.
2. On the **Connections** page, click **Add New Service**.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/add-new-service.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=733cef1141ef13d318634aa9f407eb2b" alt="Add New Service" width="2992" height="1256" data-path="public/images/ai-2.0/connectors/metadata-ingestion/add-new-service.png" />

### Step 2: Select a Service and Connector

From the service type dropdown, select **Pipeline Services**, then click the **SAP BW/4HANA Pipeline** connector tile.

<img src="https://mintcdn.com/collatedocs/tVR0kaoXvgs3p2Wx/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/select-service/sapbw4hanapipeline.png?fit=max&auto=format&n=tVR0kaoXvgs3p2Wx&q=85&s=09f44670d707fd05069da75fb30f064f" alt="Select Service" width="2102" height="1536" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/select-service/sapbw4hanapipeline.png" />

### Step 3: Add Service Name and Description

* Enter a unique, descriptive **Service Name**. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other SAP BW/4HANA Pipeline services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/service-name/sapbw4hanapipeline.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=83e112c343f4f802c32476a4ad8ccb68" alt="Add New Service Name" width="1470" height="818" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/service-name/sapbw4hanapipeline.png" />

<Note>
  **Note**: The service name cannot be changed after it is set.
</Note>

### Step 4: Configure Connection Options

Specify where ingestion runs, provide your source credentials, and verify the connection.

#### Select Ingestion Runner

Select an **Ingestion Runner**: the runner where the ingestion pipeline will execute.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=1249f828648614445e8a976ea1933487" alt="Add Name and Select Ingestion Runner" width="1444" height="506" data-path="public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png" />

#### Enter Connection Details

Enter the connection details for SAP BW/4HANA Pipeline. The right-hand panel in the UI displays inline help for each field.

<img src="https://mintcdn.com/collatedocs/tVR0kaoXvgs3p2Wx/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/connection-details/sapbw4hanapipeline.png?fit=max&auto=format&n=tVR0kaoXvgs3p2Wx&q=85&s=ee435894e6ab525099d942109c2d5957" alt="Configure Service Connection" width="1448" height="1118" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/connection-details/sapbw4hanapipeline.png" />

* **Host and Port**: Host and port of the SAP HANA instance underlying BW/4HANA. Specify as `hostname:port`, e.g. `hana-host:30015`.
* **Username**: HANA database username with `SELECT` access to the BW Process Chain catalog tables listed in the Requirements section above.
* **Password**: Password for the HANA database user.
* **ABAP Schema**: Schema name in HANA where the BW/4HANA ABAP metadata tables reside. Defaults to `SAPHANADB`. To confirm the correct value on your system, run:
  ```sql theme={null}
  SELECT SCHEMA_NAME FROM SYS.TABLES WHERE TABLE_NAME = 'RSOADSO';
  ```
* **Pipeline Filter Pattern**: Regex pattern to include or exclude Process Chains by their Chain ID.

<Tip>
  **Tip**: When using a **Hybrid Ingestion Runner**, any sensitive credential fields—such as passwords, API keys, or private keys—must reference secrets using the following format:

  ```
  password: secret:/my/database/password
  ```

  This applies **only to fields marked as secrets** in the connection form (these typically mask input and show a visibility toggle icon).
  For more information about managing secrets in hybrid setups, see the [Hybrid Ingestion Runner Secret Management Guide](/ai-2-0/getting-started/lets-get-started/ingest-your-data/hybrid-ingestion-runner#manage-secrets)
</Tip>

#### Test Connection

Once the credentials have been added, click on **Test Connection** and **Save** the changes.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=3365cff7bb9d82c85a2ff9ab559d6f11" alt="Test Connection" width="1446" height="188" data-path="public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png" />

### Step 5: Configure Ingestion Options

In the **What to Ingest** step, use filter patterns to control which assets Collate ingests from your SAP BW/4HANA Pipeline service. Filter patterns use regular expressions applied to pipeline names.

#### How Filter Patterns Work

* **Include**: Add one or more comma-separated regular expressions. Collate ingests only assets whose names match at least one expression. Leave blank to include all assets.
* **Exclude**: Add one or more comma-separated regular expressions. Collate skips any asset whose name matches an expression. Leave blank to exclude nothing.

Rules match asset names using one of five expressions:

* **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`.
* **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`.
* **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`.
* **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`.
* **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`.

When both Include and Exclude are set, Exclude takes priority.

<Tip>
  **Tip**: Leave the filter pattern empty to ingest all Process Chains available in the source.
</Tip>

**Filter Options**

* **Pipeline**: Controls which Process Chains Collate ingests from the source.

Each section provides the following controls:

* **Scan Mode**: You can choose between the following scan modes:
  * **Scan all**: Ingests every asset of that type the connector can access. This is the default.
  * **Only specific**: Enables include rules so only assets matching at least one rule are ingested.
* **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
* **Preview**: Shows a real-time summary of what will be in scope based on your current rules.
* **Include rules** *(available only in **Only specific** mode)*: Click **+ Add** to define a rule. Added rules appear as chips; an asset is included if it matches any rule.

<Tip>
  **Tip**: If [AutoPilot](/ai-2-0/admin-guide/applications/autopilot) is enabled, lineage between pipeline tasks and data assets is tracked automatically after the first metadata ingestion completes.
</Tip>

### Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. Collate saves the service configuration and immediately begins pulling metadata from the source.

To monitor ingestion progress or view the service you just added, go to **Connections** in the left navigation and select your service.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts pipelines, tasks, and other structural metadata from your source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, Collate automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page.

To configure the additional Metadata Agent and schedule ingestion, follow these steps:

1. In the left navigation, click **Connections** and select your service.

2. Click the **Agents** tab.

3. Click **Add Agent** and select **Metadata** from the dropdown.
   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=accad7d1c4ddf209781bff851d51d464" alt="Add Metadata Agent" width="2398" height="1144" data-path="public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png" />
   For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page.

4. On the **Configure Ingestion** page, do the following and click **Next**.

   * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline.

     <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=d5ec1f0f3742cadab8cd54c602c97239" alt="Name this Ingestion" width="1578" height="644" data-path="public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png" />

   * **Agent Setup**: Configure the core parameters for this agent. The following fields are available:

     | Field                        | Default | Description                                                                                                                                                                                                                    |
     | ---------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
     | Ownership Update Mode        | replace | Set how owners from source metadata update Pipeline owners. In replace mode, resolved owners from the current source replace existing owners. In append mode, resolved owners are appended to active existing Pipeline owners. |
     | Db Service Names             | —       | List of database service names used for lineage resolution.                                                                                                                                                                    |
     | Storage Service Names        | —       | List of storage service names used for lineage resolution.                                                                                                                                                                     |
     | Messaging Service Names      | —       | List of messaging service names used for lineage resolution.                                                                                                                                                                   |
     | Status Lookback Days         | 1       | Number of days of pipeline run status history to ingest. Only runs within the last N days will be fetched.                                                                                                                     |
     | Include Lineage              | On      | Turn off to stop fetching lineage from pipelines.                                                                                                                                                                              |
     | Mark Deleted Pipeline        | On      | Soft-delete pipelines in Collate when they are removed from the source. Associated entities like lineage are also deleted.                                                                                                     |
     | Include UnDeployed Pipelines | On      | Toggle whether un-deployed pipelines should be ingested. If set to false, only deployed pipelines will be ingested.                                                                                                            |

     <img src="https://mintcdn.com/collatedocs/tVR0kaoXvgs3p2Wx/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/pipeline-agent-setup.png?fit=max&auto=format&n=tVR0kaoXvgs3p2Wx&q=85&s=471bc2416115b020f9ff6909bb9e3d89" alt="Agent Setup" width="1564" height="1476" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/pipeline-agent-setup.png" />

   * **Filter Patterns**: Apply include or exclude rules to scope which pipelines this agent ingests. These follow the same filter options described in **Step 5**.

     <img src="https://mintcdn.com/collatedocs/tVR0kaoXvgs3p2Wx/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/pipeline-filter-pattern.png?fit=max&auto=format&n=tVR0kaoXvgs3p2Wx&q=85&s=46f6f78c05d40a88a3fe9471f0f31505" alt="Filter Patterns" width="1550" height="374" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/pipeline-filter-pattern.png" />

   * **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     | Toggle            | Default | Description                                                                                                                                                            |
     | ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | Enable Debug Log  | Off     | Sets the ingestion log level to DEBUG. Useful for troubleshooting.                                                                                                     |
     | Override Metadata | Off     | When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value. |
     | Override Lineage  | Off     | When on, existing lineage is replaced with newly extracted lineage on each run.                                                                                        |

     <img src="https://mintcdn.com/collatedocs/tVR0kaoXvgs3p2Wx/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/pipeline-scope-behaviour.png?fit=max&auto=format&n=tVR0kaoXvgs3p2Wx&q=85&s=38c7ce4ce152231ee67e2d0519d2fa47" alt="Scope & Behaviour" width="1570" height="1022" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/pipeline-scope-behaviour.png" />

5. On the **Schedule Interval** page, set when the agent runs:

   * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   * **On-Demand**: No automatic schedule; trigger the agent manually when needed.

   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/schedule.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=25cc1d78f6f2a8bd115830d034d1d8d1" alt="Schedule Interval" width="1588" height="1044" data-path="public/images/ai-2.0/connectors/metadata-ingestion/schedule.png" />

6. Click **Add** to deploy the agent.

## Troubleshooting

<Columns cols={2}>
  <Card title="SAP BW/4HANA Pipeline Troubleshooting" href="/ai-2-0/connectors/pipeline/sapbw4hana-pipeline/troubleshoot">
    Learn more about how to troubleshoot common SAP BW/4HANA Pipeline connector issues and resolve configuration or ingestion errors.
  </Card>
</Columns>
