Salesforce Connections

D toc

You can create connections to your Salesforce instance from

D s product

r	true

. This connector is designed as a wrapper around the Salesforce REST API.

Supported Environments:

Operation

D s product

Amazon

Microsoft Azure

Read

Supported

Write

Not supported

Limitations

D s conn req sql

This is a read-only connection.
Single Sign-On (SSO) is not supported.
Custom domains are not supported.
You cannot ingest Salesforce tables that require mandatory filters.

Prerequisites

The account used to login from
D s product
must access Salesforce through a security token.
Info
NOTE: Please contact your Salesforce administrator for the Server Name and the Security Token values.
The logged-in user must have required access to the tables and schema.

If you haven't done so already, you must create and deploy an encryption key file for the
D s node
to be shared by all relational connections. For more information, see Create Encryption Key File.

Enable

General relational connectivity must be enabled. For more information, see Relational Access.
This connection type utilizes OAuth 2.0 for authentication.
Info
NOTE: OAuth 2.0 authentication requires additional configuration specific to the connection type.

For more information, see Enable OAuth 2.0 Authentication.

Configure

To create this connection, in the Connections page, select the Applications tab. Click the Salesforce card. See Connections Page.

Modify the following properties as needed:

Property Description

Server Name

Enter the host name of your Salesforce implementation. Example value:

Code Block
exampleserver.salesforce.com

Connect String Options Apply any connection string options that are part of your authentication to Salesforce. For more information, see below.

Credential Type

Select the type of credentials to provide with the connection:

SecurityToken - apply the security token that has been generated within the account to authenticate to Salesforce.

OAuth 2.0 - use OAuth 2.0 client connect to Salesforce. Since the

D s webapp

supports a single global Salesforce connection, the OAuth 2.0 client is already defined in the

D s webapp

.

Info
NOTE: After you have specified the connection to use OAuth 2.0, click Authenticate to validate the connection with the target datastore. If you have modified the connection, click Re-authenticate to validate the new connection definition. You must re-authenticate if you receive an expired tokens message. For more information, see Enable OAuth 2.0 Authentication.

OAuth 2.0 Client

(OAuth 2.0 credential type) Select the OAuth 2.0 client to use.

User Name (SecurityToken credential type) Username to use to connect to the database.

Password (SecurityToken credential type) Password associated with the above username.

Security Token generated in account (SecurityToken credential type) Paste the security token associated with the account to use for this connection.

Test Connection

(SecurityToken credential type) After you have defined the connection credentials type, credentials, and connection string, you can validate those credentials.

Default Column Data Type Inference

Set to disabled to prevent the platform from applying its own type inference to each column on import. The default value is enabled .

Connection Name Display name of the connection

Connection Description Description of the connection, which appears in the application.

Connect string options

Connection timeout

By default, the supported driver applies a connection timeout to Salesforce of 60 seconds. As needed, you can modify the connection timeout through connect string options:

Code Block
timeout=<value_in_seconds>

where:

<value_in_seconds> corresponds to the number of seconds for the time.

Info
NOTE: Although it is not recommended, you can set this value to `0` to disable timeouts.

Schema caching

By default, the connection driver uses schema caching to speed up ingestion. To surface changes to Salesforce tables/schema immediately, you can use the following options to disable schema caching by the connection:

Code Block
Other='cachemetadatatable=false;cachemetadatatablecolumns=false;'

Create via API

This connection can also be created using the API.

Info
NOTE: If you are using OAuth 2.0 authentication for this type, you cannot create connections via API.

Type: jdbc
Vendor: salesforce

For more information, see

D s api refdoclink
operation/createConnection

Use

You can import datasets from Salesforce through the Import Data page. See Import Data Page.

Using Salesforce Connections

Uses of Salesforce

D s product

can use Salesforce for the following tasks:

Create datasets by reading from Salesforce tables.

Before you begin using Salesforce

Read Access:

Your Salesforce administrator must configure read permissions.
You must acquire a Salesforce security token for use with the Salesforce connection.

Secure access

SSL is the default connection method.

Storing data in Salesforce

Your Salesforce administrator should provide database access for storing datasets. Users should know where shared data is located and where personal data can be saved without interfering with or confusing other users.

Info

NOTE:

D s product

does not modify source data in Salesforce. Datasets sourced from Salesforce are read without modification from their source locations.

Reading from Salesforce

When

D s product

connects to your Salesforce instance, the application can read from all Salesforce objects that are accessible through the Salesforce account in use, including:

Salesforce objects and fields are mapped to tables and columns
Standard and custom objects

Info
NOTE: The names of custom objects are appended with the value _c.
Audit columns
System fields

Info
NOTE: Unquoted identifiers are converted to uppercase during import.

You can create a

D s item

item	dataset

from a table stored in Salesforce.

Writing to Salesforce

Not supported.

Reference

Supported Versions: n/a