Salesforce

ExpandedToggleIcon        Connection Dialog

Excel Add-in for Salesforce supports two kinds of authentication: UserNamePassword and AccessRefreshToken.

 

To connect with UserNamePassword authentication you need to specify the following required parameters:

1.Host - The Salesforce.com or Database.com login URL;
2.User Id - The Salesforce login account;
3.Password - The password for the Salesforce login account;
4.Security token - The automatically generated key that is used for logging in to Salesforce from an untrusted network. See the Salesforce documentation to learn how to get or reset your security token.

 

To connect with AccessRefreshToken authentication, perform the following steps:

1.In the Authentication type list select AccessRefreshToken.
2.Click Web Login.
3.Log in into Salesforce with your Username and Password.

After this, the Client Id, Client Secret, and Refresh Token parameters will be filled automatically, and you will be able to connect.

The AccessRefreshToken authentication has the following benefit: you enter your account email and password directly to Salesforce web page, and they are not used or stored in Excel. You also don't need to get and specify Salesforce security token.

 

In addition to the parameters above, Advanced connection parameters may be set for more fine connection tuning. You can also fill Client Id, Client Secret, and Refresh Token parameters manually in the Advanced Connection Editor dialog box.

 

ExpandedToggleIcon        Advanced Connection Options

The following table describes the options that you can include in the Connection String using the Advanced Connection Editor dialog box:

 

Option

Description

Authentication Type

Determines the authentication method to use when connecting to Salesforce.

Batch Size

The the number of records returned by a service at once. The default value is 500; the minimum is 200, and the maximum is 2,000.

Client ID

The Consumer Key from the connected app definition. Used for the OAuth Refresh Token authentication.

Client Secret

The Consumer Secret from the connected app definition. Used for the OAuth Refresh Token authentication.

Connection Lifetime

When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connect Timeout -or- Connection Timeout

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 15.

Default Command Timeout

The time in seconds to wait while trying to execute a command before terminating the attempt and generating an error.

Failover Retries

The number of retry attempts to automatically re-run a command before displaying an error message in case when the command failed because of an error that may be temporary.

Host

The Salesforce.com or Database.com login URL.

Include Deleted

Determines, whether to include deleted records from recycle bin to results when querying data from Salesforce.

Local SQL Engine

Determines whether to use local SQL engine for SELECT queries, that are too complex to translate them directly to Salesforce API calls or to show an error message.

Max Pool Size

The maximum number of connections allowed in the pool. Setting the Max Pool Size value in the connection string can affect performance. The default value is 100.

Min Pool Size

The minimum number of connections allowed in the pool. The default value is 0.

Organization Id

A unique identifier for the Salesforce organization to which the account you connect to belongs.

Password

The password for the account.

Persist Security Info

Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.

Pooling

If true, by default, the connection is drawn from the appropriate pool or is created and added to the appropriate pool.

Proxy Host

The host name or IP address of proxy server.

Proxy Password

The password for the proxy server account.

Proxy Port

The port number of the proxy server. The default value is 3128.

Proxy User

The proxy server account name.

Readonly

Indicates whether the connection is read-only (allows only SELECT statements).

Refresh Token

The Salesforce OAuth 2.0 refresh token. Used for the OAuth Refresh Token authentication.

Security Token

The automatically generated key that is used for logging in to Salesforce from an untrusted network..

Session Id

Salesforce session ID for the session ID authentication.

Token Server

The path to a file to store the refresh token between sessions. It is used for UserNamePassword and AccessRefreshToken authentication. This parameter is specified automatically when performing web login, and in most cases there is no need to modify it. If you want, you may specify a custom path to use instead of the default one.

Trigger Auto Response Email

Specifies whether to trigger auto-response rules or not. Default value is false.

Trigger Other Email

Specifies whether to trigger email outside the organization or not. The default value is false.

Trigger User Email

Specifies whether to trigger email that is sent to users in the organization or not. The default value is false.

Update Mru

Specifies whether to update the list of most recently used items or not.

Use Assignment Rules

Determines whether to use assignment rules when inserting or updating data. The default value is false.

User Id

The Salesforce login account.

UTC Dates

If set to True, dates will be converted to UTC format during import, and the date values entered in Excel are considered UTC dates when saving them to the data source.