Step-By-Step Guide To Get Started With Salesforce SOAP API Using Java v1.1

Step-By-Step Guide

To Get Started with Salesforce SOAP API using Java

Ver 1.1 Updated on 03-Jan-2015

Visit asagarwal.com for daily dose of useful tips & tricks on Salesforce

Related Blog Post

2

Step-By-Step Guide to Get Started with Salesforce SOAP API using Java - http://www.asagarwal.com/2398/step-by-step-guide-to-get-started-with-salesforce-soap-api-using-java

Please refer to the blog post for complete article, useful information and related links

http://www.asagarwal.com/2398/step-by-step-guide-to-get-started-with-salesforce-soap-api-using-java


Ingredients

3

You will need the following to use Salesforce SOAP API with Java ■ Salesforce Enterprise Edition or above Or ■ Salesforce Developer Edition

■ Sign up for Free at https://developer.salesforce.com/ ■ Java ■ Eclipse IDE

https://developer.salesforce.com/


Using This Guide

4

A couple of standards/conventions have been followed in this guide. Here is what they mean

Text with Red Background

Text with Yellow Background

1. Text with White background, red border and a number. In a callout

format

Text with Green Background

Important information. Take a closer look and follow as advised. You may not be able to complete the guide successfully if you miss these instructions

General explanation/information to support actions mentioned on the slide. Will assist you in understanding what is being done and why

Actions that you need to follow to configure. Carry out these steps in the order of their serial number.

Appears on the bottom bar of the page on right hand side. Provides information on the Hardware and Software currently being used


Steps Overview

5

✓ Install Java ✓ Install Eclipse ➡ Install Force.com WSC (Web Services Connector) ■ Install Maven ■ Generate JAR Files ■ Download WSDL Files From Salesforce ■ Generate Java Stub File ■ Create Java Program ■ Execute Transactions using SOAP API IMPORTANT For the step-by-step guide on 1st two steps of installing Java & Eclipse on your PC, please refer to my blog post at URL http://www.asagarwal.com/2395/step-by-step-guide-to-install-configure-force-com-ide-on-eclipse

In this presentation we will start with installation of Web Services Connector (WSC)

http://www.asagarwal.com/2395/step-by-step-guide-to-install-configure-force-com-ide-on-eclipse


Install Force.com WSC (Web Services Connector)

6

1. Click on Applications

Mac OS X Yosemite 10.10

Let’s start by downloading WSC files from GitHub



7

1. In Applications, scroll down the window and click on Utilities




8

1. Click on Terminal




9

1. Navigate to a directory where you want to download the WSC files.

2. Run command ‘git clone https://github.com/forcedotcom/wsc' to download the WSC files on your PC



Steps Overview

10

✓ Install Java ✓ Install Eclipse ✓ Install Force.com WSC (Web Services Connector) ➡ Install Maven ■ Generate JAR Files ■ Download WSDL Files From Salesforce ■ Generate Java Stub File ■ Create Java Program ■ Execute Transactions using SOAP API


Install Maven

11

1. Open the browser window and navigate to URL http://maven.apache.org/

2. Click ‘Download’

Google Chrome on Mac

Next we will install Maven, which is created to compile and package

WSC files in JAR files

http://maven.apache.org/


Install Maven

12

1. Click ‘Download’



Install Maven

13

1. Select the location where you want to download the

file

2. Click Save



Install Maven

14Mac OS X Yosemite 10.10

1. Double click on the file to uncompress the file


Steps Overview

15

✓ Install Java ✓ Install Eclipse ✓ Install Force.com WSC (Web Services Connector) ✓ Install Maven ➡ Generate JAR Files ■ Download WSDL Files From Salesforce ■ Generate Java Stub File ■ Create Java Program ■ Execute Transactions using SOAP API


Generate JAR Files


1. Back in the command window, switch to directory where ‘wsc’ & ‘apache-maven’ was downloaded and uncompressed. In this example, the command that I will issue is cd /Ashish/tmp 2. Run command ls -lrt 3. Ensure that the folders ‘wsc’ & ‘apache-maven-<version>’ exist in the current directory 4. Navigate to wsc directory by type the command cd wsc 5. Run the command <path>/apache-maven-3.2.5/bin/mvn clean package -Dgpg.skip replacing the value of <path> with the actual path where you uncompressed the apache-maven file. Running this command will compile the code and package it in a jar file

1

23

45


Generate JAR Files


1. “mvn clean package” command will run for a few minutes. Once it finishes. ensure that you see the message ‘BUILD SUCCESS’ 2. Run command ls -lrt 3. Ensure that a new folder with the name ‘target’ has got created 4. Run command ls -lrt target 5. Ensure that there is file ending with *uber.jar

1

2

3

4

5


Steps Overview

18

✓ Install Java ✓ Install Eclipse ✓ Install Force.com WSC (Web Services Connector) ✓ Install Maven ✓ Generate JAR Files ➡ Download WSDL Files From Salesforce ■ Generate Java Stub File ■ Create Java Program ■ Execute Transactions using SOAP API


Download WSDL Files From Salesforce

19

2. Specify your username and password and click ‘Log in to

Salesforce’

1. Open the browser window and navigate to URL https://login.salesforce.com/


In next few steps we will download the Enterprise WSDL file from

Salesforce

https://login.salesforce.com/



20

1. Click on Setup




21

1. Click on Develop -> API




22

1. Click on the WSDL that you want to work with. Here I will click on Enterprise WSDL




23

1. Click on Generate




24

1. Right click anywhere on a blank area and click on

‘Save As’




25

1. Select the location where you want to download the

file

2. Save file as ‘wsdl’ file

3. Click Save




26

1. If prompted, click use wsdl



Steps Overview

27

✓ Install Java ✓ Install Eclipse ✓ Install Force.com WSC (Web Services Connector) ✓ Install Maven ✓ Generate JAR Files ✓ Download WSDL Files From Salesforce ➡ Generate Java Stub File ■ Create Java Program ■ Execute Transactions using SOAP API


Generate Java Stub File

28

1. If prompted, click use wsdl


1.Back in the terminal window, navigate to the directory where you downloaded enterprise.wsdl 2. Run command ls -lrt 3. Ensure that the file enterprise.wsdl exists in the directory 4. Run command java -classpath wsc/target/force-wsc-33.0.0-uber.jar com.sforce.ws.tools.wsdlc enterprise.wsdl enterprise.jars Ensure that you specify the correct path to force-wsc-33.0.0-uber.jar file that was generated by running the “mvn clean package” command in previous steps 5. Ensure that the command ends with Generating the jar file 6. Run command ls -lrt 7. Ensure that enterprise.jar now exists in the directory

1

23

4

5

6

7

Good job ! At the end of 7th step, we are now all set to use SOAP API to connect to Salesforce from a java program. Are

you excited? Let’s move on

Generate a JAR file from the Enterprise WSDL File


Steps Overview

29

✓ Install Java ✓ Install Eclipse ✓ Install Force.com WSC (Web Services Connector) ✓ Install Maven ✓ Generate JAR Files ✓ Download WSDL Files From Salesforce ✓ Generate Java Stub File ➡ Create Java Program ■ Execute Transactions using SOAP API


Create Java Program


1.Navigate to the directory where you installed Eclipse and double click on Eclipse file of Application Type. We will now create a java program and use SOAP API to connect to Salesforce and execute some transactions in Salesforce


Create Java Program


1. Specify the location where you want to keep all your project files (e.g. program source codes). Create a new folder if desired. (Here I am creating a new workspace folder to keep all java programs in a separate folder)

2. Click OK


Create Java Program

32

1. In Eclipse, click on Window -> Open Perspective -> Other

Eclipse Kepler on Mac


Create Java Program

33

1. Select Java

2. Click OK



Create Java Program

34

1. To create a new Java project, click on File -> New -> Java Project


We are creating a Java Project and will be adding the generated

JAR files to the project


Create Java Program

35

1. Specify the Project name

2. Specify the JRE to be used

3. Click Finish



Create Java Program

36

2. Click Properties

1. Right click on the project name



Create Java Program

37

1. Select Java Build Path

2. Select Libraries

3. Click Add External JARs



Create Java Program

38

1. Navigate to directory where

enterpise.jar was created in previous

steps

2. Double click enterprise.jar



Create Java Program

39

1. Note that enterprise.jar gets

added to the library2. Click Add External JARs



Create Java Program

40

1. Note that enterprise.jar gets

added to the library2. Click OK

1. Navigate to directory where force-wsc-<version>-uber.jar was created in previous steps

2. Double click force-wsc-<version>-uber.jar



Create Java Program

41

1. Note that force-wsc-<version>-uber.jar gets added to the library

2. Click OK



Create Java Program

42

1. Right click on the project name

2. Click New

3. Click Class



Create Java Program

43

1. Specify the class name

2. Click Finish



Steps Overview

44

✓ Install Java ✓ Install Eclipse ✓ Install Force.com WSC (Web Services Connector) ✓ Install Maven ✓ Generate JAR Files ✓ Download WSDL Files From Salesforce ✓ Generate Java Stub File ✓ Create Java Program ➡ Execute Transactions using SOAP API


Execute Transactions using SOAP API

45

2. Replace the username with your salesforce username and password with your salesforce

password + security token

1. Copy and paste the following code in your main class. The code is available on the blog post

3. Click Save


This is just a trial code to ensure that we are able to connect o Salesforce using SOAP APIs




46

1. Right click on the class name

2. Click ‘Run As’ 3. Click ‘Java Application’




47

1. As you run the application, you will see a Console tab with following messages


And if you see something similar to what I see here, believe it or not, you have just successfully logged on to Salesforce using SOAP API. Time to

celebrate, yeah? In a while …



48

1.Copy and paste the full code from the blog post to Main.java file. This code will

1. Query and display 5 records from Lead object

2. Insert 5 new records with Name as ‘SOAP API Lead <n>

3. Update 5 lead records where keyword ‘-- UPDATED’ will the appended to the last name

4. Delete 2 of the updated lead record

2. Click ‘Save’


Now let’s run a complete program that will query records and insert,

update, delete records in Salesforce using SOAP API




49

1.Before we run the Java program, let’s logon to the Salesforce org from browser and navigate to leads tab. Here I have modified the ‘All Leads’ view to show lead Name, First name, Last Name, Company, Created Date & Last Modified Date.

2.The data is sorted in the descending order of the last modified date so that we can view the newly created leads on top




50

1. Moment of truth. Let’s run the application. Right click on the

class name

2. Click ‘Run As’ 3. Click ‘Java Application’




51

1. As the java program is being executed, output will be displayed in

the console window

2. Click here to maximise the console window




52

1. Output from queryLeads() function

2. Output from createLeads() function

3. Output from updateLeads() function

4. Output from deleteLeads() function




53

1. Switch to Salesforce Browser window and refresh the list view

2. You should see three lead records with First Name as ‘SOAP API’ and Last Name as ‘Lead <n> —

UPDATED’. The Java program created 5 lead records, updated 5 records and then deleted 2 records3. Click on Recycle Bin




54

1. Two Lead records will appear in Recycle Bin as the java program deleted 2 of the 5 created records



Steps Overview

55

✓ Install Java ✓ Install Eclipse ✓ Install Force.com WSC (Web Services Connector) ✓ Install Maven ✓ Generate JAR Files ✓ Download WSDL Files From Salesforce ✓ Generate Java Stub File ✓ Create Java Program ✓ Execute Transactions using SOAP API


Leave Your Feedback

56

Hope you were able to connect to Salesforce using SOAP API from the Java program and successfully execute transactions

Please do not forget to leave your comments, feedback and suggestions on my blog at URL http://www.asagarwal.com/2398/step-by-step-guide-to-get-started-with-salesforce-soap-api-using-java

If you got stuck anywhere and were able to resolve the issue, please mention that as a comment on the blog post so that others can benefit from your experience



For Daily Dose of Useful Tips & Tricks on Salesforce.com subscribe to

asagarwal.com

57

http://asagarwal.com

Visit asagarwal.com for daily dose of useful tips & tricks on Salesforce 58

Document Change LogVersion Changes

1.0 First Release

1.1 Updated hyperlink on page 45 to correct value

Technology

Step-By-Step Guide To Get Started With Salesforce SOAP API Using Java v1.1