connectors

No menu items for this category
SAP ERP
SAP ERP
PROD
Available In
Feature List
Metadata
dbt
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 externally:

To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.

If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

OpenMetadata 1.1 or later

To deploy OpenMetadata, check the Deployment guides.

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 to setup the APIs.

We have support for Python versions 3.8-3.11

To run the SAP ERP ingestion, you will need to install:

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to SAP ERP.

In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.

The workflow is modeled around the following JSON Schema

This is a sample config for SAP ERP:

hostPort: Host and port of the SAP ERP service. This specifies the host and port of the SAP ERP instance. It should be specified as a string in the format https://hostname.com.

apiKey: Api Key to authenticate the SAP ERP Apis

databaseName: In OpenMetadata, the Database Service hierarchy works as follows: Database Service > Database > Schema > Table In the case of SAP ERP, we won't have a Database as such. If you'd like to see your data in a database named something other than default, you can specify the name in this field.

databaseSchema: In OpenMetadata, the Database Service hierarchy works as follows: Database Service > Database > Schema > Table In the case of SAP ERP, we won't have a Database Schema as such. If you'd like to see your data in a database schema named something other than default, you can specify the name in this field.

paginationLimit: Pagination limit used while querying the SAP ERP API for fetching the entities.

The sourceConfig is defined here:

markDeletedTables: To flag tables as soft-deleted if they are not present anymore in the source system.

markDeletedStoredProcedures: Optional configuration to soft delete stored procedures in OpenMetadata if the source stored procedures are deleted. Also, if the stored procedures is deleted, all the associated entities like lineage, etc., with that stored procedures will be deleted.

includeTables: true or false, to ingest table data. Default is true.

includeViews: true or false, to ingest views definitions.

includeTags: Optional configuration to toggle the tags ingestion.

includeOwners: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.

includeStoredProcedures: Optional configuration to toggle the Stored Procedures ingestion.

includeDDL: Optional configuration to toggle the DDL Statements ingestion.

queryLogDuration: Configuration to tune how far we want to look back in query logs to process Stored Procedures results.

queryParsingTimeoutLimit: Configuration to set the timeout for parsing the query in seconds.

useFqnForFiltering: Regex will be applied on fully qualified name (e.g service_name.db_name.schema_name.table_name) instead of raw name (e.g. table_name).

databaseFilterPattern, schemaFilterPattern, tableFilterPattern: Note that the filter supports regex as include or exclude. You can find examples here

threads (beta): The number of threads to use when extracting the metadata using multithreading. Please take a look here before configuring this.

incremental (beta): Incremental Extraction configuration. Currently implemented for:

To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.

The main property here is the openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.

Logger Level

You can specify the loggerLevel depending on your needs. If you are trying to troubleshoot an ingestion, running with DEBUG will give you far more traces for identifying issues.

JWT Token

JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.

You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration.

Store Service Connection

If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.

If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.

Store Service Connection

If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.

If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.

SSL Configuration

If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set verifySSL to ignore, or have it as validate, which will require you to set the sslConfig.caCertificate with a local path where your ingestion runs that points to the server certificate file.

Find more information on how to troubleshoot SSL issues here.

Connection Options (Optional): Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.

Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent to database during the connection. These details must be added as Key-Value pairs.

  • In case you are using Single-Sign-On (SSO) for authentication, add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "sso_login_url"
filename.yaml

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:

Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.

To configure SSL for secure connections between OpenMetadata and a Redshift database, Redshift offers various SSL modes, each providing different levels of connection security.

When running the ingestion process externally, specify the SSL mode to be used for the Redshift connection, such as prefer, verify-ca, allow, and others. Once you've chosen the SSL mode, provide the CA certificate for SSL validation (caCertificate). Only the CA certificate is required for SSL validation in Redshift.