OpenMetadata/docs/install/metadata-ingestion/connectors/database-services/salesforce.md

description
This guide will help install Salesforce connector and run manually

Salesforce

{% hint style="info" %} Prerequisites

OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.

1. Python 3.7 or above {% endhint %}

Install from PyPI or Source

{% tabs %} {% tab title="Install Using PyPI" %}

pip install 'openmetadata-ingestion[salesforce]'

{% endtab %} {% endtabs %}

Run Manually

metadata ingest -c ./pipelines/salesforce.json

Configuration

{% code title="salesforce.json" %}

{
  "source": {
    "type": "salesforce",
    "config": {
      "username": "username",
      "password": "password",
      "security_token": "secuirty_token",
      "service_name": "local_salesforce",
      "scheme": "salesforce",
      "sobject_name": "Salesforce Object Name"
    }
  },
 ...

{% endcode %}

1. username - pass the Salesforce username.
2. password - password for the username.
3. security_token - pass the security token.
4. sobject_name - pass the salesforce object name.
5. service_name - Service Name for this Salesforce cluster. If you added Salesforce cluster through OpenMetadata UI, make sure the service name matches the same.
6. filter_pattern - It contains includes, excludes options to choose which pattern of datasets you want to ingest into OpenMetadata

Publish to OpenMetadata

Below is the configuration to publish Salesforce data into the OpenMetadata service.

Add optionally pii processor and metadata-rest-tables sink along with metadata-server config

{% code title="salesforce.json" %}

{
  "source": {
    "type": "salesforce",
    "config": {
      "username": "username",
      "password": "password",
      "security_token": "secuirty_token",
      "service_name": "local_salesforce",
      "scheme": "salesforce",
      "sobject_name": "Salesforce Object Name"
    }
  },
  "sink": {
    "type": "metadata-rest",
    "config": {}
  },
  "metadata_server": {
    "type": "metadata-server",
    "config": {
      "api_endpoint": "http://localhost:8585/api",
      "auth_provider_type": "no-auth"
    }
  },
  "cron": {
    "minute": "*/5",
    "hour": null,
    "day": null,
    "month": null,
    "day_of_week": null
  }
}

{% endcode %}