You are viewing the RapidMiner Studio documentation for version 9.6 - Check here for latest version

Using the Salesforce Connector

This guide targets the new Connection Management introduced with RapidMiner Studio 9.3.

For the old Legacy Salesforce Connections see the 9.2 documentation

The Salesforce Connector allows you to connect to Salesforce directly from RapidMiner Studio. It supports all CRUD operations (Create, Read, Update, and Delete). This document will walk you through how to:

Connect to Salesforce

To configure a new Salesforce Connection, you will need the Connection details of your account (username, password, security token, URL).

  1. In RapidMiner Studio, right-click on the repository you want to store your Salesforce Connection in and choose New Connection Icon Create Connection.

    You can also click on Connections > Create Connection New Connection Icon and select the repository from the dropdown of the following dialog.

  2. Give a name to the new Connection, and set Connection Type to Salesforce Icon Salesforce:

  3. Click on Create IconCreate and switch to the Setup tab in the Edit connection dialog.

  4. Fill in the Connection details of your Salesforce configuration:

    The username and password are the same credentials you use for the Salesforce website. Your Salesforce account includes a security token that RapidMiner needs to make a connection. You can get the security token from your Salesforce registration email. If you do not have the registration email, you can reset the security token.

    While not required, we recommend testing your new Salesforce Connection by clicking the Connection Test IconTest connection button. If the test fails, please check whether the details are correct.

  5. Click Save IconSave to save the connection and close the Edit connection dialog.

You're ready to start using the Salesforce operators!

Read from Salesforce

The Read Salesforce operator allows you to read data from Salesforce. Let us start with reading some demo data:

  1. Drag a Read Salesforce operator into the Process Panel. Select your Salesforce Connection for the connection entry parameter from the Connections folder of the repository you stored it in by clicking on the repository chooser icon button next to it:

    Alternatively, you can drag the Salesforce Connection from the repository into the Process Panel and connect the resulting operator with the Read Salesforce operator.

  2. Connect the operator's output port to the result port of the process:

  3. Click on the Build Salesforce Query IconBuild Salesforce Query button to open the query editor. This dialog allows you to create a Salesforce SOQL query. Simple mode (tab at the left of the window) provides you with an interface to build your query; Advanced mode allows you to write your own query.

  4. Run Run Process the process! In the Result Perspective, you should see the result of your query:

Write to Salesforce

Writing an example set to Salesforce is straightforward: Load the example set and pass it to the Write Salesforce operator. The following example illustrates how to write an Excel sheet with demo data to Salesforce.

  1. Create an Excel sheet with the following data:

  2. Open a new process New Process Icon in RapidMiner Studio.

  3. Read the created Excel sheet by using the Read Excel operator. Add a Write Salesforce operator to the process and connect the operators accordingly. Select your configured Salesforce Connection and configure the properties as shown on the screen shot:

  4. Run Run Process the process! In the Results perspective, you should see the written entity:

Reset the security token

You can reset your Salesforce security token from the Salesforce website. This is a useful feature if you've lost your existing token or you want to disconnect from all applications using the token.

  1. Make sure you are logged in to the Salesforce website.

  2. Click on your account name and select Settings:

  3. Open the Personal group and click on Reset My Security Token:

  4. Finally, click on Reset Security Token to get a new token via email.

Note that by resetting your token, applications will no longer be able to connect to your account until you re-enter the new security token.