Configuring a Connection
After Installing the Connector you can connect and create a Data Source for data in Salesforce.
Setting Up a Data Source
Complete the following steps to connect to the data:
- Under Connect | To a Server, click More....
- Select the data source called Salesforce by CData.
- Enter the information required for the connection.
- Click Sign In.
- If necessary, select a Database and Schema to discover what tables and views are available.
Using the Connection Builder
The connector makes the most common connection properties available directly in Tableau. However, it can be difficult to use if you need to use more advanced settings or need to troubleshoot connection issues. The connector includes a separate connection builder that allows you to create and test connections outside of Tableau.
There are two ways to access the connection builder:
- On Windows, use a shortcut called Connection Builder in the Start menu, under the CData Tableau Connector for Salesforce folder.
- You can also start the connection builder by going to the driver install directory and running the .jar file in the lib directory.
In the connection builder, you can set values for connection properties and click Test Connection to validate that they work. You can also use the Copy to Clipboard button to save the connection string. This connection string can be given to the Connection String option included in the connector connection window in Tableau.
Connecting to Salesforce
By default, the connector connects to production environments.To use a Salesforce sandbox account, set UseSandbox to true and be sure to specify a sandbox username in User.
Authenticating to Salesforce
Salesforce supports authentication via either user credentials, or the OAuth standard.
User Credentials
Authentication with user credentials generally requires the additional use of a security token. The security token can only be obtained from Salesforce. To request the security token:- Open the personal information page on Salesforce.com.
- Click the link to reset your security token. The token will be emailed to you.
- Specify the security token in the SecurityToken connection property or append it to the Password.
To eliminate the need for a security token:
- Log in to Salesforce and enter Network Access in the Quick Find box in the setup section.
- Add your IP address to the list of trusted IP addresses.
- AuthScheme: Basic.
- User: The user's login ID.
- Password The user's password.
- SecurityToken (optional): The security token you obtained from Salesforce.
If you want to connect without using a security token, you must disable the security token as follows:
- Log in to Salesforce and enter Network Access in the Quick Find box in the setup section.
- Add your IP address to the list of trusted IP addresses.
OAuth
Salesforce provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.
The following subsections describe how to authenticate to Salesforce from the available OAuth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in Salesforce, see Connection.
Desktop Applications
CData provides an embedded OAuth application that simplifies authentication at the desktop.You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Salesforce console. For further information, see Creating a Custom OAuth Application.
Before you connect, set these properties:
- InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- OAuthClientId (custom applications only): The Client ID assigned when you registered your custom OAuth application.
- OAuthClientSecret (custom applications only): The Client Secret assigned when you registered your custom OAuth application.
When you connect, the connector opens Salesforce's OAuth endpoint in your default browser. Log in and grant permissions to the application.
The connector then completes the OAuth process as follows:
- Extracts the access token from the callback URL.
- Obtains a new access token when the old one expires.
- Saves OAuth values in OAuthSettingsLocation so that they persist across connections.
OAuth Password Grant
Follow these steps to set up the Password Grant option:- Set the AuthScheme to OAuthPassword to perform authentication with the password grant type.
- Set all the properties specified in either the web or desktop authentication sections above.
- Set the User and Password to your login credentials, as well as the SecurityToken if required.
Note: If you have enabled Session Settings > Lock sessions to the IP address from which they originated, make sure that your IP address does not change while using the connector. If the IP changes during the usage of the connector, an "INVALID_SESSION_ID" error is returned from Salesforce and the connector will no longer be able to retrieve data. If you receive this error, ask your Salesforce administrator to disable this configuration or make sure to configure a static IP for the instance where you are using the connector. Then, reset the connection to continue using the connector.
OAuthJWT Certificates
Set the AuthScheme to OAuthJWT.
OAuthJWT
To obtain the OAuthJWT consumer key:
- Log in to Salesforce.com.
- From Setup, enter Apps in the Quick Find box and then click the link to create an app. In the Connected Apps section of the resulting page, click New.
- Enter a name to be displayed to users when they log in to grant permissions to your app, along with a contact Email address.
- Click Enable OAuth Settings and enter a value in the Callback URL box. Set this value only to create the Connected App as it is required. It will
not actually be needed for this type of authentication. The Callback URL is in the format:
http://localhost:8019/src/oauthCallback.rst
- Enable Use digital signatures.
- Upload your certificate.
- Select the scope of permissions that your app should request from the user.
- Click your app name to open a page with information about your app. The OAuth consumer key is displayed.
After creating your OAuth Application, set the following connection properties:
- AuthScheme: OAuthJWT.
- InitiateOAuth: GETANDREFRESH.
- OAuthJWTCert: The JWT Certificate store.
- OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.
- OAuthJWTCertPassword: The Password of the JWT Certificate store.
- OAuthJWTIssuer: The OAuth Client ID.
- OAuthJWTSubject: The username (email address) to the permitteed User Profile configured in the OAuth Connected App.
Note: This flow never issues a refresh token.
AzureAD
Set the AuthScheme to AzureAD. Use the following connection properties to connect to AzureAD:
- SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.
Note that this configuration requires two AAD applications: the "Salesforce" application used for single sign-on, and a separate "connector" application with user_impersonation permission on the "Salesforce" application. You must also specify the OAuth connection properties:
- OAuthClientId: The application Id of the connector application, listed in the Overview section of the app registration.
- OAuthClientSecret: The client secret value of the connector application. Azure AD displays this when you create a new client secret.
Use the following SSOProperties to authenticate to AzureAD:
- Resource: The application Id URI of the Salesforce application, listed in the Overview section of the app registration. In most cases this is the URL of your custom Salesforce domain.
- AzureTenant: The Id of the Azure AD tenant where the applications are registered.
The following is an example connection string:
AuthScheme=AzureAD;InitiateOAuth=GETANDREFRESH;OAuthClientId=3ea1c786-d527-4399-8c3b-2e3696ae4b48;OauthClientSecret=xxx;SSOProperties='Resource=https://example.my.salesforce.com;AzureTenant=6ee709df-9de0-4cdf-10e6b7a51d95';
Okta
Set the AuthScheme to Okta. Use the following connection properties to connect to Okta:
- User: The Okta user.
- Password: The Okta user's password.
- SSOLoginURL: The SSO provider's login URL.
- SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.
- APIToken (optional): The API Token that the customer created from the Okta org. You should use this when authenticating a user via a trusted application or proxy that overrides OKTA client request context.
- MFAType (optional): Only required if you have configured MFA flow. Currently we support only the following types: OktaVerify, Email, and SMS.
- MFAPassCode (optional): Only required if you have configured MFA flow. If this is set to empty/invalid the driver initially issues a MFA challenge that triggers the platform to send you a one-time password on your device or email, based on the configured MFA type. You need to re-issue another connection where the retrieved one-time password value is passed to MFAPassCode connection property.
Example connection string:
AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;URL='http://sharepointserver/mysite';
OneLogin
Set the AuthScheme to OneLogin. Use the following connection properties to connect to OneLogin:
- User: The OneLogin user.
- Password: The OneLogin user's password.
- SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.
- OAuthClientId: The OAuthClientId. If you do not already have this, find it by navigating to Developers > API Credentials > Credential > ClientId.
- OAuthClientSecret: The OAuthClientSecret. If you do not already have this, find it by navigating to Developers > API Credentials > Credential > ClientSecret.
- Subdomain: The subdomain of the OneLogin user accessing the SSO app. For example, if your OneLogin URL is splinkly.onelogin.com, the subdomain value is splinkly.
- AppId: The ID of the SSO app.
- Region (optional): The region where your OneLogin account resides. The OneLogin API operates in multiple regions and this property is used to find the correct domain. Legal values are US (default) and EU.
Example connection string:
AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;SSOProperties='OAuthClientID=3fc8394584f153ce3b7924d9cd4f686443a52b;OAuthClientSecret=ca9257fd5cc3277abb5818cea28c06fe9b3b285d73d06;Subdomain=OneLoginSubDomain;AppId=1433920';
PingFederate
Set the AuthScheme to PingFederate. The following connection properties need to be set:
- User: The PingFederate user.
- Password: The PingFederate user's password.
- SSOLoginURL: The SSO provider's login URL.
- SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.
- AuthScheme (optional): The authorization scheme to be used for the IdP endpoint. Legal values are None or Basic.
- SSLClientCert
- SSLClientCertType
- SSLClientCertSubject
- SSLClientCertPassword
AuthScheme=PingFederate;User=pingFederateUser;Password=pingFederatePassword;SSOLoginURL='https://<authority>/idp/sts.wst';SSOExchangeUrl='https://domain.my.salesforce.com/services/oauth2/token?so=00D3000006JDF';
ADFS
Set the AuthScheme to ADFS and set these properties:
- User: The ADFS user.
- Password: The ADFS user's password.
- SSOLoginURL: The SSO provider's login URL.
- SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.
You need the following SSOProperties to authenticate to ADFS:
- RelyingParty: The value of the Relying Party Identifier on the ADFS server for Salesforce.
AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';SSOProperties='RelyingParty=https://saml.salesforce.com';
ADFS Integrated
The ADFS Integrated flow indicates you are connecting with the currently logged in Windows user credentials. To use the ADFS Integrated flow, do not specify the User and Password, but otherwise follow the same steps in the ADFS guide above.
Next Step
See Using the Connector to create data visualizations.