Skip to main content
Kinetic Community

Salesforce Adapter

The Salesforce Adapter is used to retrieve data from a Salesforce instance.

Requirements

  • The Kinetic Schedule web server must be using JDK 6.0 or higher.
  • The following java libraries must be included in the Kinetic Schedule web application classpath:​
    • Http Client 4.1.2 (httpclient-4.1.2.jar)
    • Http Core 4.1.2 (httpcore-4.1.2.jar)
    • Apache Commons Logging (commons-logging-1.1.1.jar)
    • Kinetic Schedule Salesforce Adapter (kinetic-schedule-salesforce-adapter.jar)
  • The adapter and required jars can be downloaded using this zip file

Adapter Configuration

The following properties are required for all adapters.

 

Property Description
name

Any alpha-numeric value is acceptable, but should indicate this is a Salesforce adapter.

Example: "salesforce"

className

The value of the main adapter class file.  This will be a unique value specific to the adapter.

Value: "com.kineticdata.schedule.adapter.salesforce.SalesforceAdapter"

 

Example Adapters Configuration File

{
    "adaptersConfig": {
        "adapters": [
            {
                "name": "salesforce",
                "className": "com.kineticdata.schedule.adapter.salesforce.SalesforceAdapter"
            }
        ]
    }
}

 

Connection Configuration

The following properties are required for all connections, regardless of what type of adapter is used.  If the value for that property is not used by the adapter, the property must still exist in the configuration file.  The value for the property should be set to the blank string ("") if it is not used.

 

Property Description
name

The name of the connection that will be used in data source configuration files that use this connection.  Should be a name that correlates the adapter and server.

Example: "salesforce"

type

The value that was entered as the "name" property for the SalesforceAdapter in the adapters configuration file.

Example: in the adapter configuration example above, the value would be "salesforce"

description

A description of the connection.  This is not seen by the end users, it is simply a way to describe what this connection interacts with.

Example: "Salesforce connection"

location

The Salesforce instance that the account is tied to (instructions on how to find it are below).

Example: "https://na15.salesforce.com"

username

The username used to login to Salesforce.

Example: "Demo"

password

The password used to login to Salesforce.  This value can be entered as plain-text or encrypted with the Password Encryption form.

Example: "pass123"

useEncryption

Indicates if the password is stored in plain-text or encrypted form.

"true" if encrypted, "false" if plain-text

 

The additional parameters that are specific to the Salesforce Adapter are all required (Instructions on how to find these values are found later on in the article).

 

Property Description
Security Token

A security token that is appended onto the end of the password. If your instance uses the security token it can be obtained by going to 'Reset my Security Token' under personal settings.

Example: "7QPZPG1CSA1Vu7wQABFphUGQ8"

Consumer Id

The consumer id of the application.

Example: "3ENY9S2CF3TF17ZKVMD.1D5H5FSFHZX2YDJAMPP7YR6Q3910VQPN5VCPHR55FXALH.BWKTLRNLJVO8WX9J_7U"

Consumer Secret

The consumer secret of the application.

Example: "7743898342891840"

Where to find the Consumer ID, Consumer Secret, Security Token and Instance (location).

1. After logging into Salesforce, the Instance can be found in the URL to the left of the salesforce.com (ie. na15, cs13, etc.)

2. Go to Setup, which is in the dropdown menu under your name in the upper righthand corner.

3. Your Security Token (if applicable) can be found under Personal Setup > My Personal Information > Reset My Security Token on the left sidebar.

4. To get the Consumer ID and Consumer Secret, Navigate back to Setup and go to Manage Apps.

5. Create a new Connected App, and fill in the basic information for the app.

6. Check the Enable OAuth Settings checkbox and put https://auth for your callback url.

7. Under selected OAuth scopes, add Access and manage your data (api) to your selected scopes and save.

8. Your Consumer ID and Consumer Secret will be found on the app information page that you were redirected to upon saving.

Example Connector Configuration File

{
    "connection": {
        "name": "salesforce",
        "type": "salesforce",
        "description": "Salesforce connection",
        "location": "https://na15.salesforce.com",
        "username": "Demo",
        "password": "pass123",
        "useEncryption": "false",
        "additionalParameters": [
            {
                "name": "Security Token",
                "value": "7QPZPG1CSA1Vu7wQABFphUGQ8"
            },
            {
                "name": "Consumer Id",
                "value": "3ENY9S2CF3TF17ZKVMD.1D5H5FSFHZX2YDJAMPP7YR6Q3910VQPN5VCPHR55FXALH.BWKTLRNLJVO8WX9J_7U"
            },
            {
                "name": "Consumer Secret",
                "value": "7743898342891840"
            }
        ]
    }
}