Skip to content
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.

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

MINOR: [DOCS] Added SAP ERP connector documentation #17668

Merged
merged 2 commits into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: SAP ERP
slug: /connectors/database/sap-erp
---

{% connectorDetailsHeader
name="SAP ERP"
stage="PROD"
platform="OpenMetadata"
availableFeatures=["Metadata", "dbt"]
unavailableFeatures=["Query Usage", "Stored Procedures", "Owners", "Tags","Data Profiler", "Data Quality", "View Lineage", "View Column-level Lineage"]
/ %}


In this section, we provide guides and references to use the SAP ERP connector.

Configure and schedule SAP ERP metadata workflow from the OpenMetadata UI:

- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [dbt Integration](/connectors/ingestion/workflows/dbt)

{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/database/sap-erp/yaml"} /%}

## Requirements

To ingest the SAP ERP metadata, CDS Views and OData services need to be setup to efficiently expose SAP data. To achieve this, data must be exposed via RESTful interfaces.
Follow the guide [here](/connectors/database/sap-erp/setup-sap-apis) to setup the APIs.

## Metadata Ingestion

{% partial
file="/v1.5/connectors/metadata-ingestion-ui.md"
variables={
connector: "SAP ERP",
selectServicePath: "/images/v1.5/connectors/sap-erp/select-service.png",
addNewServicePath: "/images/v1.5/connectors/sap-erp/add-new-service.png",
serviceConnectionPath: "/images/v1.5/connectors/sap-erp/service-connection.png",
}
/%}

{% stepsContainer %}
{% extraContent parentTagName="stepsContainer" %}

#### Connection Details

- **Host and Port**: This parameter specifies the host and port of the SAP ERP instance. This should be specified as a string in the format `https://hostname.com`.
- **API Key**: Api Key to authenticate the SAP ERP Apis.
- **database**: Optional name to give to the database in OpenMetadata. If left blank, we will use `default` as the database name.
- **databaseSchema**: Optional name to give to the database schema in OpenMetadata. If left blank, we will use `default` as the database schema name.
- **paginationLimit**: Pagination limit used while querying the SAP ERP APIs for fetching the entities.

{% partial file="/v1.5/connectors/database/advanced-configuration.md" /%}

{% /extraContent %}

{% partial file="/v1.5/connectors/test-connection.md" /%}

{% partial file="/v1.5/connectors/database/configure-ingestion.md" /%}

{% partial file="/v1.5/connectors/ingestion-schedule-and-deploy.md" /%}

{% /stepsContainer %}

{% partial file="/v1.5/connectors/troubleshooting.md" /%}

{% partial file="/v1.5/connectors/database/related.md" /%}
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
---
title: Setup SAP ERP APIs
slug: /connectors/database/sap-erp/setup-sap-apis
---
# Setup SAP ERP APIs

In this section, we provide guides and references to use setup the SAP ERP APIs needed for the connector.

This document details the integration of Open Metadata with SAP systems, emphasizing the use of CDS Views and OData services to efficiently expose SAP data. To achieve this, data must be exposed via RESTful interfaces. Key concepts include:

- **SAP Gateway**: A software component that bridges RFC and RESTful interfaces.
- **RAP (Restful Application Programming)**: A coding framework designed to expose services via RESTful interfaces.
- **CDS (Core Data Services)**: A layer that describes data objects and annotates them with desired functionalities, which are converted into code upon activation.
- **OData V2 or V4**: A RESTful standard that simplifies interaction with database backends.


## Steps
### 1. ABAP Development Tools (ADT)
Using the Eclipse based [ABAP Development Tools (ADT)](https://tools.hana.ondemand.com/#abap) the Restful interfaces are built.

### 2. CDS Views
After creating a new ABAP Project for the connected SAP system, a new Data Definition object is to be created.

{% image
src="/images/v1.5/connectors/sap-erp/data-definition-object.png"
alt="Data Definition Object"
caption="Create data definition object" /%}

- Create the first view that gets the table metadata
```sql
@AbapCatalog.sqlViewName: 'ZZ_I_DDIC_TAB_CDS'
@AbapCatalog.compiler.compareFilter: true
@AbapCatalog.preserveKey: true
@AccessControl.authorizationCheck: #CHECK
@EndUserText.label: 'Open Metadata Tables'
define view ZZ_I_DDIC_TAB_CDS as select from dd02l l
left outer join dd02t t on
(l.tabname = t.tabname and l.as4local = t.as4local and l.as4vers = t.as4vers and t.ddlanguage = 'E')
{
key l.tabname,
key l.as4local,
key l.as4vers,
@ObjectModel.readOnly: true
'E' as LANG,
@ObjectModel.readOnly: true
l.tabclass,
@ObjectModel.readOnly: true
l.sqltab,
@ObjectModel.readOnly: true
l.applclass,
@ObjectModel.readOnly: true
l.authclass,
@ObjectModel.readOnly: true
l.as4date,
@ObjectModel.readOnly: true
l.as4time,
@ObjectModel.readOnly: true
l.masterlang,
@ObjectModel.readOnly: true
t.ddtext
}
```

- Then create the second view for table columns
```sql
@AbapCatalog.sqlViewName: 'ZZ_I_DDIC_COL_CDS_V'
@AbapCatalog.compiler.compareFilter: true
@AbapCatalog.preserveKey: true
@AccessControl.authorizationCheck: #CHECK
@EndUserText.label: 'Open Metadata Column'
define view ZZ_I_DDIC_COL_CDS as select from dd03l l
left outer join dd03t t on
(l.tabname = t.tabname and l.fieldname = t.fieldname and l.as4local = t.as4local and t.ddlanguage = 'E')
{
key l.tabname,
key l.fieldname,
key l.as4local,
key l.as4vers,
key l.position as POS,
@ObjectModel.readOnly: true
'E' as LANG,
@ObjectModel.readOnly: true
l.keyflag,
@ObjectModel.readOnly: true
l.mandatory,
@ObjectModel.readOnly: true
l.checktable,
@ObjectModel.readOnly: true
l.inttype,
@ObjectModel.readOnly: true
l.intlen,
@ObjectModel.readOnly: true
l.reftable,
@ObjectModel.readOnly: true
l.precfield,
@ObjectModel.readOnly: true
l.reffield,
@ObjectModel.readOnly: true
l.notnull,
@ObjectModel.readOnly: true
l.datatype,
@ObjectModel.readOnly: true
l.leng,
@ObjectModel.readOnly: true
l.decimals,
@ObjectModel.readOnly: true
l.domname,
@ObjectModel.readOnly: true
l.comptype,
@ObjectModel.readOnly: true
l.reftype,
@ObjectModel.readOnly: true
t.ddtext
}
where l.as4local = 'A'
```
### 3. SAP Gateway
Using the transaction `/nsegw` in SAPGUI, open the configuration screen for the SAP Gateway and create a new project with default project type.

{% image
src="/images/v1.5/connectors/sap-erp/create-project.png"
alt="Create Project"
caption="Create Project" /%}

Create a reference to the CDS views under Data Model and import the views. This is all that is needed to configure the OData details thanks to the CDS view annotations.

{% image
src="/images/v1.5/connectors/sap-erp/add-reference.png"
alt="Add Reference"
caption="Add Reference" /%}

The final step is to expose the generated code as OData service. This is the Register step.

{% image
src="/images/v1.5/connectors/sap-erp/register-odata-service.png"
alt="Register odata Service"
caption="Register odata Service" /%}

In the next screen click on Add Service and add the service as new OData endpoint. The service alias is the location where the SAP Gateway is installed.

{% image
src="/images/v1.5/connectors/sap-erp/add-service-as-endpoint.png"
alt="Add Service As Endpoint"
caption="Add Service As Endpoint" /%}



Loading
Loading