No menu items for this category

Run the Salesforce Connector Externally

Query Usage
Data Profiler
Data Quality
Stored Procedures
Supported Versions--

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

Configure and schedule Salesforce metadata and profiler workflows from the OpenMetadata UI:

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 0.12 or later

To deploy OpenMetadata, check the Deployment guides.

Following are the permissions you will require to fetch the metadata from Salesforce.

API Access: You must have the API Enabled permission in your Salesforce organization.

Object Permissions: You must have read access to the Salesforce objects that you want to ingest.

To run the Salesforce ingestion, you will need to install:

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

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 Salesforce:

username: Username to connect to the Salesforce. This user should have the access as defined in requirements.

password: Password to connect to Salesforce.

securityToken: Salesforce Security Token is required to access the metadata through APIs. You can checkout this doc on how to get the security token.

sobjectName: Specify the Salesforce Object Name in case you want to ingest a specific object. If left blank, we will ingest all the Objects.

salesforceApiVersion: Follow the steps mentioned here to get the API version. Enter the numerical value in the field, For example 42.0.

salesforceDomain: When connecting to Salesforce, you can specify the domain to use for accessing the platform. The common domains include login and test, and you can also utilize Salesforce My Domain. By default, the domain login is used for accessing Salesforce.

The sourceConfig is defined here:

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

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

includeViews: true or false, to ingest views definitions.

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

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.

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.certificatePath 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 Athena 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 Athena 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"

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.