Skip to content

CLOUD-19910 SAP Gateway connector #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cstigum5 merged 4 commits into from
Jan 30, 2026
Merged

CLOUD-19910 SAP Gateway connector #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4eec2f5
CLOUD-19910 SAP Gateway connector
cstigum5 Jan 30, 2026
709dfbd
Fix broken internal links across documentation
cstigum5 Jan 30, 2026
b5c772d
CLOUD-19910 SAP Gateway connector docs
cstigum5 Jan 30, 2026
05ad73f
Update Connection-Management.mdx
cstigum5 Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@
"en/Data-Sources/SAPByDesign",
"en/Data-Sources/SAPConcur",
"en/Data-Sources/SAPFieldglass",
"en/Data-Sources/SAPGateway",
"en/Data-Sources/SAPHANA",
"en/Data-Sources/SAPHybrisC4C",
"en/Data-Sources/SAPSuccessFactors",
Expand Down Expand Up @@ -654,6 +655,7 @@
"en/Data-Sources/SAPByDesign-Embedded",
"en/Data-Sources/SAPConcur-Embedded",
"en/Data-Sources/SAPFieldglass-Embedded",
"en/Data-Sources/SAPGateway-Embedded",
"en/Data-Sources/SAPHANA-Embedded",
"en/Data-Sources/SAPHybrisC4C-Embedded",
"en/Data-Sources/SAPSuccessFactors-Embedded",
Expand Down Expand Up @@ -1150,6 +1152,7 @@
"ja/Data-Sources/SAPByDesign",
"ja/Data-Sources/SAPConcur",
"ja/Data-Sources/SAPFieldglass",
"ja/Data-Sources/SAPGateway",
"ja/Data-Sources/SAPHANA",
"ja/Data-Sources/SAPHybrisC4C",
"ja/Data-Sources/SAPSuccessFactors",
Expand Down Expand Up @@ -1567,6 +1570,7 @@
"ja/Data-Sources/SAPByDesign-Embedded",
"ja/Data-Sources/SAPConcur-Embedded",
"ja/Data-Sources/SAPFieldglass-Embedded",
"ja/Data-Sources/SAPGateway-Embedded",
"ja/Data-Sources/SAPHANA-Embedded",
"ja/Data-Sources/SAPHybrisC4C-Embedded",
"ja/Data-Sources/SAPSuccessFactors-Embedded",
Expand Down
2 changes: 1 addition & 1 deletion en/Clients/CrewAI-Client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Run `pip install crewai requests python-dotenv` in your terminal.
Run `python crew-agent.py` in the terminal. The output displays the results of the task:

<Frame>
![CrewAI Output](./images/crewai_client_output.png)
![CrewAI Output](/en/images/crewai_client_output.png)
</Frame>
</Step>
</Steps>
2 changes: 1 addition & 1 deletion en/Clients/GoogleSheets-Client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "This page outlines the steps to install and configure the CData Co

Before you can configure and use Google Sheets with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

**Connect AI Customers Only:** You can also import Workspaces and Derived Views. To create a workspace, follow the instructions in [Workspaces](/en/Workspaces). To create a derived view (administrators only), follow the instructions in [Create a Derived View](Data-Explorer#create-a-derived-view).
**Connect AI Customers Only:** You can also import Workspaces and Derived Views. To create a workspace, follow the instructions in [Workspaces](/en/Workspaces). To create a derived view (administrators only), follow the instructions in [Create a Derived View](/en/Data-Explorer#create-a-derived-view).

## Installation and Setup

Expand Down
2 changes: 1 addition & 1 deletion en/Clients/JDBC-Client-Embedded.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This page outlines the steps to use the JDBC driver for Embedded C

## Prerequisites

Before you can configure and use JDBC with Embedded Cloud, you must first connect a data source to your account. See [Sources](Sources-Embedded) for more information.
Before you can configure and use JDBC with Embedded Cloud, you must first connect a data source to your account. See [Sources](/en/Sources-Embedded) for more information.

## Install the Driver

Expand Down
2 changes: 1 addition & 1 deletion en/Clients/JDBC-Client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This page outlines the steps to use the JDBC driver for Connect AI

## Prerequisites

Before you can configure and use JDBC with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](Sources) for more information.
Before you can configure and use JDBC with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.


## Install the Driver
Expand Down
2 changes: 1 addition & 1 deletion en/Clients/LangGraph-Client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: "LangGraph is a framework for developing applications powered by la

Before you can configure and use LangGraph with Connect AI, you must first do the following:

- Connect a data source to your Connect AI account. See [Sources](Sources) for more information.
- Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
- Generate a Personal Access Token (PAT) on the [Settings](/en/Settings#access-tokens) page. Copy this down, as it acts as your password during authentication.
- Obtain an OpenAI API key: [https://platform.openai.com/](https://platform.openai.com/).
- Make sure you have Python >= 3.10 in order to install the LangChain and LangGraph packages.
Expand Down
2 changes: 1 addition & 1 deletion en/Connection-Flow.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The end user is redirected to the Connect AI **Add Connection** page.
The end user adds connection information for the particular data connector, such as Salesforce, and then tests and saves the connection.
</Step>
<Step>
Embedded Cloud calls [Create Connection](Connection-API).
Embedded Cloud calls [Create Connection](/en/API/Connection-API).
</Step>
<Step>
Create Connection returns success or failure on the **Add Connection** page.
Expand Down
4 changes: 2 additions & 2 deletions en/Connection-Management.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Create Connection validates the JWT and returns a string containing the URL to r
| **Name** | **Description** |
| --- | --- |
| dataSource | The type of data source (For example: Snowflake, ActOn, etc.). |
| | **Note:** You can obtain data source names from [List Connections](List-Connections). |
| | **Note:** You can obtain data source names from [List Connections](/en/API/List-Connections). |
| redirectURL | The URL to redirect the customer once the customer has created the connection through the Connect AI UI. |
| name | (Optional) If provided, the connection name. |

Expand Down Expand Up @@ -59,7 +59,7 @@ Edit Connection edits a connection in the Embedded Cloud product.

| **Name** | **Description** |
| --- | --- |
| connectionId | The connection Id created in [Create Connection](Connection-API). |
| connectionId | The connection Id created in [Create Connection](/en/API/Connection-API). |

#### Payload Parameters

Expand Down
7 changes: 7 additions & 0 deletions en/Data-Sources/SAPGateway-Embedded.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "SAP Gateway"
---

import SAPGateway from '/en/snippets/Data-Sources/SAPGateway.mdx';

<SAPGateway />
7 changes: 7 additions & 0 deletions en/Data-Sources/SAPGateway.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "SAP Gateway"
---

import SAPGateway from '/en/snippets/Data-Sources/SAPGateway.mdx';

<SAPGateway />
2 changes: 1 addition & 1 deletion en/OData-Metadata.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebarTitle: "Overview"
description: "The OData API supports metadata queries to retrieve information about the data you have surfaced in your account. The sections below outline how to issue these metadata queries and what they return."
---

You can execute CRUD operations through GET, POST, PATCH, and DELETE requests, which are outlined below. Results from requests are returned in JSON format. See [Query Options](OData-Query-Options) for information about refining and filtering requests.
You can execute CRUD operations through GET, POST, PATCH, and DELETE requests, which are outlined below. Results from requests are returned in JSON format. See [Query Options](/en/API/OData-Query-Options) for information about refining and filtering requests.
2 changes: 1 addition & 1 deletion en/OData-Operations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: "After connecting to Connect AI workspaces using OData, you can exe
---


You can execute CRUD operations through GET, POST, PATCH, and DELETE requests, which are outlined below. Results from requests are returned in JSON format. See [Query Options](OData-Query-Options) for information about refining and filtering requests.
You can execute CRUD operations through GET, POST, PATCH, and DELETE requests, which are outlined below. Results from requests are returned in JSON format. See [Query Options](/en/API/OData-Query-Options) for information about refining and filtering requests.
2 changes: 1 addition & 1 deletion en/Security.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Connect AI uses a range of static IP addresses to communicate with external data

## Logging and Audit

CData Connect AI provides comprehensive logging and audit capabilities to help you monitor data access, track system activity, and maintain compliance with security and regulatory requirements. The platform captures detailed information about user actions, data queries, connection activity, and system events. See [Logs](/Logs) for details.
CData Connect AI provides comprehensive logging and audit capabilities to help you monitor data access, track system activity, and maintain compliance with security and regulatory requirements. The platform captures detailed information about user actions, data queries, connection activity, and system events. See [Logs](/en/Logs) for details.

## Security Compliance

Expand Down
2 changes: 1 addition & 1 deletion en/snippets/AI-tools-embedded-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- [Agent Bricks](/en/Clients/AgentBricks-Client-Embedded)
- [Claude Code](/en/Clients/ClaudeCode-Client-Embedded)
- [CrewAI](/en/Clients/CrewAI-Client-Embedded)
- [Cursor](en/Cursor-Client-Embedded)
- [Cursor](en/Clients/Cursor-Client-Embedded)
- [Gemini](/en/Clients/Gemini-Client-Embedded)
- [LangChain](/en/Clients/LangChain-Client-Embedded)
- [LangGraph](/en/Clients/LangGraph-Client-Embedded)
Expand Down
4 changes: 2 additions & 2 deletions en/snippets/BI-tools-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
- [Alteryx](/en/Clients/Alteryx-Client)
- [Amazon QuickSight](./en/AmazonQuickSight-Client)
- [Azure Analysis Services](./en/AAS-Client)
- [Amazon QuickSight](/en/Clients/AmazonQuickSight-Client)
- [Azure Analysis Services](/en/Clients/AAS-Client)
- [APOS](/en/Clients/APOS-Client)
- [Crystal Reports](/en/Clients/CrystalReports-Client)
- [Excel](/en/Clients/Excel365-Client)
Expand Down
2 changes: 1 addition & 1 deletion en/snippets/Data-Sources/ExcelOnline.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Enter the **Sharepoint URL** field to connect to Excel files on a SharePoint sit
</Tabs>
## Issue Queries

In some configurations of Excel for the web, tables are accessible under the schema name OneDrive instead of ExcelOnline. For example, when querying a Excel for the web table, the fully-qualified table name might be `[ExcelOnline1].[OneDrive].[TableName]`. You can use [Data Explorer](Data-Explorer) to view your schemas to see if this applies to your configuration.
In some configurations of Excel for the web, tables are accessible under the schema name OneDrive instead of ExcelOnline. For example, when querying a Excel for the web table, the fully-qualified table name might be `[ExcelOnline1].[OneDrive].[TableName]`. You can use [Data Explorer](/en/Data-Explorer) to view your schemas to see if this applies to your configuration.

## More Information

Expand Down
100 changes: 100 additions & 0 deletions en/snippets/Data-Sources/SAPGateway.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
import SaveAndTest from '/en/snippets/save-and-test.mdx';

## Setup Guide

Follow these steps to connect SAP Gateway to your Connect AI account:

<Steps>
<Step>
Open the **Connections** page of the Connect AI dashboard.
</Step>
<Step>
Click **\+ Add Connection** in the upper-right corner.
</Step>
<Step>
Type *SAP Gateway* into the search field, then click the data source name.
</Step>
<Step>
On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
</Step>
<Step>
Enter the **URL** for your SAP Gateway environment or the full URL of the OData service. Any additional properties must be added using **Custom URL Params**.
</Step>
<Step>
(Optional) Enter the service **Namespace** you want to retrieve data from. This is only required if the service is not specified in the **URL**.
</Step>
<Step>
(Optional) Enter the **Service**, which is a comma-delimited list of services you want to retrieve data from. If the service is set in the **URL**, this property is ignored. In cases where the service is not set in the URL or in **Service**, the SAP Gateway's catalog service is used to discover all available services.
</Step>
<Step>
(Optional) Enter any **Custom URL Params** to be included with the HTTP request. The parameters should be in the form *field1=value1&field2=value2&field3=value3*.
</Step>
<Step>
Select an **AuthScheme** and follow the relevant instructions below.
</Step>
</Steps>

## Authentication Methods

<Tabs>
<Tab title="Basic">
<Steps>
<Step>
Enter the **User** Id for the authenticating user.
</Step>
<Step>
Enter the **Password** for the authenticating user.
</Step>
<SaveAndTest/>
</Steps>
</Tab>

<Tab title="OAuth">
<Steps>
<Step>
Enter the **OAuth Client Id** assigned to your custom OAuth application. This Id is required to identify the application to the OAuth authorization server during authentication.
</Step>
<Step>
Enter the **OAuth Client Secret** assigned to your custom OAuth application. This value is used to authenticate the custom application to the OAuth authorization server.
</Step>
<Step>
Enter the **Scope**, or permission scopes, in space separated values. Scopes define what kind of access the authenicating user has, such as read or read/write. Scopes are required for OAuth 2.0.
</Step>
<SaveAndTest/>
</Steps>
</Tab>

<Tab title="Token">
<Steps>
<Step>
Enter the **API Key** of the application you have created.
</Step>
<SaveAndTest/>
</Steps>
</Tab>

<Tab title="OAuthPKCE">
<Steps>
<Step>
Set authentication to **OAuthPKCE** to use the Proof Key of Code Exchange (PKCE) extension of the standard OAuth2 flow. Set your own PKCEVerifier or let the driver automatically generate one for you.
</Step>
<SaveAndTest/>
</Steps>
</Tab>

<Tab title="SAPBTP">
<Steps>
<Step>
In **Advanced Settings**, enter the **Destination URL** of the SAP BTP destination source. This URL is found in the service key of your Destination Service instance in the SAP BTP Cockpit, in the **URI** field.
</Step>
<Step>
In **Advanced Settings**, enter the **Destination Name** of the SAP BTP destination to retrieve the authentication details from.
</Step>
<SaveAndTest/>
</Steps>
</Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAP Gateway, see [this information page](https://cdn.cdata.com/help/GCM/cloud/default.htm#default).
2 changes: 1 addition & 1 deletion ja/Clients/JDBC-Client-Embedded.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This page outlines the steps to use the JDBC driver for Embedded C

## Prerequisites

Before you can configure and use JDBC with Embedded Cloud, you must first connect a data source to your account. See [Sources](Sources-Embedded) for more information.
Before you can configure and use JDBC with Embedded Cloud, you must first connect a data source to your account. See [Sources](/ja/Sources-Embedded) for more information.

## Install the Driver

Expand Down
2 changes: 1 addition & 1 deletion ja/Clients/JDBC-Client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This page outlines the steps to use the JDBC driver for Connect AI

## Prerequisites

Before you can configure and use JDBC with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](Sources) for more information.
Before you can configure and use JDBC with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/ja/Sources) for more information.


## Install the Driver
Expand Down
2 changes: 1 addition & 1 deletion ja/Clients/LangGraph-Client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: "LangGraph is a framework for developing applications powered by la

Before you can configure and use LangGraph with Connect AI, you must first do the following:

- Connect a data source to your Connect AI account. See [Sources](Sources) for more information.
- Connect a data source to your Connect AI account. See [Sources](/ja/Sources) for more information.
- Generate a Personal Access Token (PAT) on the [Settings](/ja/Settings#access-tokens) page. Copy this down, as it acts as your password during authentication.
- Obtain an OpenAI API key: [https://platform.openai.com/](https://platform.openai.com/).
- Make sure you have Python >= 3.10 in order to install the LangChain and LangGraph packages.
Expand Down
2 changes: 1 addition & 1 deletion ja/Clients/MicrosoftPowerApps-Client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The **3\. Definition** step of the connector defines all the actions of the conn
<img src="/ja/images/powerapps_request.png" alt="Power Apps request" />
</Frame>
The request includes query parameters that are appended to the URL, such as `$top`, `$filter`, and `$orderby`. You can edit and delete the query parameters here. The parameters are based on the OData protocol.
See [API Operations](ja/OpenAPI#api-operations) for a complete reference.
See [API Operations](ja/API/OpenAPI#api-operations) for a complete reference.
The **Test** step of creating a custom connector is where you can test out the query parameters.
Similarly, there is a POST request to create a new record. The request contains all the fields for the record. You can edit these fields in the definition.
- **References**—reusable parameters that are used by both actions and triggers. Each reference has a **Definition** and **Validation**.
Expand Down
2 changes: 1 addition & 1 deletion ja/Connection-Flow.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The end user is redirected to the Connect AI **Add Connection** page.
The end user adds connection information for the particular data connector, such as Salesforce, and then tests and saves the connection.
</Step>
<Step>
Embedded Cloud calls [Create Connection](Connection-API).
Embedded Cloud calls [Create Connection](/ja/API/Connection-API).
</Step>
<Step>
Create Connection returns success or failure on the **Add Connection** page.
Expand Down
4 changes: 2 additions & 2 deletions ja/Connection-Management.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Create Connection validates the JWT and returns a string containing the URL to r
| **Name** | **Description** |
| --- | --- |
| dataSource | The type of data source (For example: Snowflake, ActOn, etc.). |
| | **Note:** You can obtain data source names from [List Connections](List-Connections). |
| | **Note:** You can obtain data source names from [List Connections](/ja/API/List-Connections). |
| redirectURL | The URL to redirect the customer once the customer has created the connection through the Connect AI UI. |
| name | (Optional) If provided, the connection name. |

Expand Down Expand Up @@ -59,7 +59,7 @@ Edit Connection edits a connection in the Embedded Cloud product.

| **Name** | **Description** |
| --- | --- |
| connectionId | The connection Id created in [Create Connection](Connection-API). |
| connectionId | The connection Id created in [Create Connection](/ja/API/Connection-API). |

#### Payload Parameters

Expand Down
2 changes: 1 addition & 1 deletion ja/OData-Metadata.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebarTitle: "Overview"
description: "The OData API supports metadata queries to retrieve information about the data you have surfaced in your account. The sections below outline how to issue these metadata queries and what they return."
---

You can execute CRUD operations through GET, POST, PATCH, and DELETE requests, which are outlined below. Results from requests are returned in JSON format. See [Query Options](OData-Query-Options) for information about refining and filtering requests.
You can execute CRUD operations through GET, POST, PATCH, and DELETE requests, which are outlined below. Results from requests are returned in JSON format. See [Query Options](/ja/API/OData-Query-Options) for information about refining and filtering requests.
2 changes: 1 addition & 1 deletion ja/OData-Operations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: "After connecting to Connect AI workspaces using OData, you can exe
---


You can execute CRUD operations through GET, POST, PATCH, and DELETE requests, which are outlined below. Results from requests are returned in JSON format. See [Query Options](OData-Query-Options) for information about refining and filtering requests.
You can execute CRUD operations through GET, POST, PATCH, and DELETE requests, which are outlined below. Results from requests are returned in JSON format. See [Query Options](/ja/API/OData-Query-Options) for information about refining and filtering requests.
2 changes: 1 addition & 1 deletion ja/Security.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Connect AI uses a range of static IP addresses to communicate with external data

## Logging and Audit

CData Connect AI provides comprehensive logging and audit capabilities to help you monitor data access, track system activity, and maintain compliance with security and regulatory requirements. The platform captures detailed information about user actions, data queries, connection activity, and system events. See [Logs](/Logs) for details.
CData Connect AI provides comprehensive logging and audit capabilities to help you monitor data access, track system activity, and maintain compliance with security and regulatory requirements. The platform captures detailed information about user actions, data queries, connection activity, and system events. See [Logs](/ja/Logs) for details.

## Security Compliance

Expand Down
Binary file added ja/images/replit_client_output.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ja/images/user_permissions.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading