Salesforce connection editor

Applies to version 11.1.7 and subsequent versions unless specifically overridden. The Salesforce connection editor is available from both Manage > Data server connections and from the Administration console.

The following diagram shows the Edit Salesforce connection pane:

Edit Salesforce connection pane

When you create a new connection, the default URL includes the default instance name login.salesforce.com and the API Version 49.0.

For example:

jdbc:sfdc://https://login.salesforce.com/services/Soap/u/49.0;

Optional name and value pairs can be specified in the URL or as part of the Connection properties.

For example:

jdbc:sfdc://https://login.salesforce.com/services/Soap/u/49.0;QUERYBATCHSIZE=1000;

Names are case insensitive. If a duplicate name occurs, the last once parsed from the URL or Connection properties is used. Unrecognized names or invalid values result in an error message.

Salesforce connection properties

The following table describes the properties that you can append to the connection string.

Connection property Description

CONNECTION_TIMEOUT

If a connection has not completed in the specified amount of time, it will automatically time out.

The default value is 60 seconds.

A value must be an integer value in the range of 0 (zero) to 2147483647.

Incorrect values will result in an error.

MAX_RETRIES

If a network error is returned when a connection is attempted, it will be retried up to the maximum value specified.

The default value is 1 (one).

A value must be an integer value in the range of 0 (zero) to 2147483647.

Incorrect values will result in an error.

WAIT_BETWEEN_RETRIES

If a connection is retried, the system will pause for the specified number of seconds between each retry.

The default value is 0 (zero).

A value must be an integer value in the range of 0 (zero) to 2147483647.

Incorrect values will result in an error.

PROXY_ENABLED

If a proxy server will be used between Cognos Analytics and Salesforce

The default value is false

A value must be either false or true.

Incorrect values will result in an error.

PROXY_HOST

The hostname of the proxy server that will be used when PROXYENABLED is true.

A valid hostname which can be accessed that hosts the proxy server.

Incorrect values will result in an error.

PROXY_PORT

The port number the proxy server that will be used when PROXYENABLED is true.

The default value is 80.

A valid port number.

Incorrect values will result in an error.

PROXY_USERNAME

Specifies a username used with the proxy server that will be used when PROXYENABLED is true.

Incorrect values will result in an error.

PROXY_PASSWORD

Specifies a password used with the proxy server that will be used when PROXYENABLED is true.

Incorrect values will result in an error.

QUERY_BATCH_SIZE

Specifies the batch size used by the Salesforce query API.

The default value is 500.

A value must be an integer value in the range 200 to 2000.

CONCURRENT_CALLS_LIMIT

Specifies the maximum number of concurrent requests.

The default value is 25.

A value must be an integer value in the range 1 (one) to to 2147483647.

USER_CONCURRENT_CALLS_LIMIT

Specifies the maximum number of concurrent requests for a user.

The default value is 10.

A value must be an integer value in the range 200 to 2000.

Note: Previous versions of Cognos Analytics provided a connection editor that is only available from the Administration console. These connections can only be used Framework Manager packages. While connections using this editor will continue to work, this connection editor will be deprecated in a future release of Cognos Analytics. Applications should migrate to using the new connection editor.

Metadata described by these connections would include non-groupable columns, while the new editor will exclude them by default.