This component supports producer and consumer endpoints to communicate with Salesforce using Java DTOs. There is a companion maven plugin camel-salesforce-plugin that generates these DTOs.
The component supports the following Salesforce APIs
Producer endpoints can use the following APIs. Most of the APIs process one record at a time, the Query API can retrieve multiple Records.
For example, the following producer endpoint uses the upsertSObject API, with the sObjectIdName parameter specifying ‘Name’ as the external id field. The request message body should be an SObject DTO generated using the maven plugin. The response message will either be NULL if an existing record was updated, or [CreateSObjectResult] with an id of the new record, or a list of errors while creating the new object.
Producer endpoints can use the following APIs. All Job data formats, i.e. xml, csv, zip/xml, and zip/csv are supported. The request and response have to be marshalled/unmarshalled by the route. Usually the request will be some stream source like a CSV file, and the response may also be saved to a file to be correlated with the request.
For example, the following producer endpoint uses the createBatch API to create a Job Batch. The in message must contain a body that can be converted into an InputStream (usually UTF-8 CSV or XML content from a file, etc.) and header fields ‘jobId’ for the Job and ‘contentType’ for the Job content type, which can be XML, CSV, ZIP_XML or ZIP_CSV. The put message body will contain [BatchInfo] on success, or throw a [SalesforceException] on error.
Consumer endpoints can use the following syntax for streaming endpoints to receive Salesforce notifications on create/update.
To create and subscribe to a topic
from("salesforce:CamelTestTopic?notifyForFields=ALL¬ifyForOperations=ALL&sObjectName=Merchandise__c&updateTopic=true&sObjectQuery=SELECT Id, Name FROM Merchandise__c")...
To subscribe to an existing topic
Note: These instructions are only for running integration tests, they use permissions and IP restrictions that should be reconsidered for production use.
Note: Running the tests you will quickly use up your API allowance, 15000 requests/day in the free developer account, make sure that you won't deny your other applications/users access by running them.
In order to run the integration tests you need a Salesforce Developer account. You can get a Salesforce Developer account by visiting developer.salesforce.com and sign up for one.
As of 2.19 we maintain any Salesforce setup needed to run the integration tests in the
it/resources/salesforce directory, the files there are generated by the Salesforce Migration Tool that you can freely download from Force.com Migration Tool. This is an Apache Ant extension, by which you get additional Ant tasks to retrieve and to upload configuration, classes, schema changes and such. Download it and place the
ant-salesforce.jar from the downloaded ZIP file into
We have integrated Salesforce Migration Tool into the Maven integration-test lifecycle phase and it should run and update your Salesforce instance to a state capable of running integration tests. Start by creating
test-salesforce-login.properties in the parent Maven module (
camel-salesforce), you can use
test-salesforce-login.properties.sample as reference.
Note: Remember that if you do not relax IP restrictions, by default you'll need to append the security token on the password you place in the
Before running the tests for the first time run the migration by invoking Maven from the
camel-salesforce-component Maven module directory:
$ mvn -Pintegration resources:copy-resources@copy-test-salesforce-login-properties \ resources:copy-resources@set-connected-app-client-id antrun:run@setup-salesforce-instance
This will create a Connected App with predefined Consumer Key (the one mentioned in the comment one in
test-salesforce-login.properties.sample) and Consumer Secret (
clientSecret) with the name of
This however is run every time when you run the integration tests by issuing from the
camel-salesforce-component Maven module directory:
$ mvn -Pintegration verify
If you need any custom fields, Apex classes or other configuration changes done, make sure to download them using the Salesforce Migration Tool and include them in
If your tests cannot be run alongside other tests you can use
@Category(Standalone.class) to mark them as such.
This is include for those that wish to setup the Salesforce instance manually for integration tests. It could also help to double-check your setup.
Besides that account you'll need a test user account that has
Bulk API Hard Delete permission. You can create one by going to My Developer Account (link from developer.salesforce.com). Under Administer expand Manage Users and select Profiles find System Administrator profile and select Clone. Use
System Administrator With Hard Delete as the profile name, and after saving under Administrative Permissions click edit and tick Bulk API Hard Delete and save. Next, create a new user under Administer expand Manage Users and select Users and then click on New User. Fill in the required fields, and select Salesforce for User License and newly created profile for Profile. You get two user Salesforce licenses so the newly created user will put you at a maximum.
Install the Warehouse package, tested with Spring 2013 (version 1.2) that can be installed from the https://login.salesforce.com/packaging/installPackage.apexp?p0=04ti0000000Pj8s, and make the following modifications manually:
Textwith maxumum length of
Numberwith maximum length of
18without default value on the
Numbertype with maximum length of
Merchandiseobject, you will need to delete dependencies (ApexClass and Visualforce Page)
MerchandiseRestResourcewith the content of
Contact Duplicate Rulein salesforce configuration
Accountto selected entities for change data capture in the Integrations/Change Data Capture menu
You'll need to access a Merchandise record and run a
Test Report in order for them to appear in Recent Items and Recent Reports. Do this by accessing Warehouse application from the menu in the top right, and selecting Merchandise click Go! (preselected is View: All) and click on the single Merchandise item available. Next go to Reports and select and run Test Report from Test Reports. This is needed by the integration tests as they access recent items and recently run reports.
Camel connected application by selecting under Apps in Build and Create sections by clicking New in Connected Apps section. Fill in the required fields and in the API (Enable OAuth Settings) section thick Enable OAuth Settings and move all scopes from Available OAuth Scopes to Selected OAuth Scopes. For Callback URL you can use any URL it‘s not needed by the REST API used by the Camel Salesforce component. Make note of Consumer Key and Consumer Secret, or if your partner provide just Consumer Refresh Token you’ll need to specify them in
test-salesforce-login.properties, more on that below.
Next enable relaxed IP restrictions, by editing the policy of the Camel connected application in Connected Apps under Administer and Manage Apps pick Relax IP restrictions for IP Relaxation.
camel-salesforce directory (one up from the directory this file resides in) with the content:
clientId=<Consumer Key of the `Camel` connected App> clientSecret=<Consumer Secret of the `Camel` connected app> refreshToken=<Consumer Refresh Token of the `Camel` connected app> userName=<Username of the user with the `System Administrator With Hard Delete` profile> password=<Password of the above user> loginUrl=https://login.salesforce.com/ report.0=Test_Report