Adapter for Salesforce 8.2 | webMethods Adapter for Salesforce Documentation | webMethods Adapter for Salesforce Installation and User’s Documentation | Adapter Connections | Configuring Adapter Connections | Configuring a Salesforce.com OAuth Connection
 
Configuring a Salesforce.com OAuth Connection
*To configure a Salesforce.com OAuth connection
1. In Integration Server Administrator, select Adapters > Adapter for Salesforce.
2. On the Connections screen, select Configure New Connection.
3. On the Connection Types screen, select Salesforce OAuth Connection to display the Configure Connection Type screen.
4. In the Configure Connection Type>Adapter for Salesforce section, provide values for the following parameters:
Parameter
Description
Package
The package in which to create the connection.
You must create the package using Designer before you can specify it using this parameter. For general information about creating packages, see the webMethods Service Development Help for your release.
Note:
Create the connection in a user-defined package rather than in the WmSalesforceAdapter package. See Managing the Adapter Package for other important considerations when creating packages for Adapter for Salesforce.
Folder Name
The folder in which to create the connection.
Connection Name
The name you want to give the connection. Connection names cannot have spaces or use special characters reserved by Integration Server and Designer.
For more information about the use of special characters in package, folder, and element names, see the webMethods Service Development Help for your release.
5. In the Connection Properties section, provide values for the following parameters:
Parameter
Description
Login Endpoint URL
Defines the login endpoint for initiating communications with Salesforce.com using the OAuth 2.0 framework. The default URL is:
https://login.salesforce.com/services/oauth2/token
User Name
Identifies the user name for the Salesforce.com or Database.com user account that you want the adapter to access. Typically, the user name is an e-mail address.
Password
Retype Password
Identifies the password associated with User Name and the user's security token. For example, if the password is "mypassword" and the security token is "XXXXXXXXXX", specify the following for Password and Retype Password:
mypasswordXXXXXXXXXX
Salesforce.com or Database.com require a security token for access via the Force.com Web service API. To obtain the security token from the Salesforce.com or Database.com user interface, select Setup; then in the My Personal Information section of the screen, click Reset your security token. Salesforce.com resets the security token and sends an e-mail message with the new security token to the registered user.
Note:
The security token you specify in the connection is valid until you reset it, change your password, or have your password reset. The security token is not required, if the endpoint URL is a Salesforce.com sandbox.
WSDL Version
The version of the Salesforce.com Partner WSDL. The connection will pick this parameter from the partner jar file in the Integration Server_directory \packages\WmSalesforceAdapter\code\jars directory.
Client ID
In Salesforce.com, your application's client identifier (also known as consumer key).
To obtain the client ID, in the Force.com administration console, go to Setup > Develop > Remote Access, and click New to create a new remote access application. After saving the remote access application, you obtain the new credentials for the client ID.
To create the remote access application, provide values for the following parameters at Salesforce.com:
*Application. The remote access application name.
*Contact Email. A valid email ID.
*Callback URL. The callback URL is the same as your application’s callback URL. The URL must begin with https://.
Note:
The callback URL is an OAuth parameter. It is not used by the adapter. However, the OAuth framework client libraries expect this parameter.
Client Secret
In Salesforce.com, your application's client secret (also known as consumer secret).
Retype Client Secret
Confirm the client secret by retyping it.
Connector Timeout (sec)
Defines the number of seconds that Adapter for Salesforce waits for a response from Salesforce.com before reporting a connection timeout. This is an HTTP connection timeout. The default is 60 seconds. The adapter expects a positive integer value. A value of 0 means no timeout.
Session Timeout (min)
Defines the number of minutes to maintain a Salesforce.com user session before performing a re-login to keep the session alive. The default is 30 minutes.
Specify the same value here as in the Security Controls setup area in the Salesforce.com user interface, to allow the adapter to automatically re-login to prevent a session from expiring. After a session is established, Salesforce.com automatically expires the session after the number of minutes specified in the Security Controls setup area in the Salesforce.com user interface.
6. In the Connection Management Properties section, provide values for the following parameters:
Parameter
Description
Enable Connection Pooling
Enables the adapter to use connection pooling. The default is true.
See Connection Pools for more information about connection pooling in the adapter.
If you plan to enable connection pooling in a clustered environment, consider the connection pool size. For details, see Considerations When Configuring Connections with Connection Pooling Enabled.
Minimum Pool Size
The minimum number of connection objects that remain in the connection pool at all times. When the adapter creates the pool, it creates this number of connections. The default is 1.
Maximum Pool Size
The maximum number of connection objects that can exist in the connection pool. When the connection pool reaches its maximum number of connections, the adapter will reuse any inactive connections in the pool or, if all connections are active, it will wait for a connection to become available. The default is 10.
Pool Increment Size
If connection pooling is enabled, this parameter specifies the number of connections by which the pool will be incremented if connections are needed, up to the maximum pool size. The default is 1.
Block Timeout (msec)
If connection pooling is enabled, this parameter specifies the number of milliseconds that Integration Server will wait to obtain a connection before it times out and returns an error. The default is 1000.
Expire Timeout (msec)
If connection pooling is enabled, this parameter specifies the number of milliseconds that an inactive connection can remain in the pool before it is closed and removed from the pool. For example, to specify 10 seconds, specify 10000. Enter 0 to specify no timeout. The default is 1000.
Note:
The adapter will never violate the Minimum Pool Size parameter. These connections remain in the pool regardless of how long they are inactive.
Startup Retry Count
If connection pooling is enabled, this parameter specifies the number of times that the system should attempt to initialize the connection pool at startup if the initial attempt fails, before issuing an AdapterConnectionException. The default is 0.
Startup Backoff Timeout (sec)
If connection pooling is enabled, this parameter specifies the number of seconds to wait between each attempt to initialize the connection pool. The default is 10.
7. Click Save Connection.
The connection you created appears on the adapter's Connections screen.
8. Be sure to enable the connection before you create adapter services that use it. See Enabling Adapter Connections for instructions.