You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by zr...@apache.org on 2017/03/30 21:17:33 UTC
camel git commit: Cleaned up the Salesforce component documentation
Repository: camel
Updated Branches:
refs/heads/master b1e5a108f -> f20b8c5a5
Cleaned up the Salesforce component documentation
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/f20b8c5a
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f20b8c5a
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f20b8c5a
Branch: refs/heads/master
Commit: f20b8c5a5d9036f56ea108cb70ed21c906b3186f
Parents: b1e5a10
Author: Zoran Regvart <zr...@apache.org>
Authored: Thu Mar 30 23:17:27 2017 +0200
Committer: Zoran Regvart <zr...@apache.org>
Committed: Thu Mar 30 23:17:27 2017 +0200
----------------------------------------------------------------------
.../src/main/docs/salesforce-component.adoc | 30 ++++++++++++++------
1 file changed, 21 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/f20b8c5a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
index 5c856ee..2091745 100644
--- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
+++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
@@ -57,13 +57,21 @@ must contain only single certificate-private key entry.
### URI format
-The URI scheme for a salesforce component is as follows
+When used as a consumer, receiving streaming events, the URI scheme is:
[source,java]
------------------------
salesforce:topic?options
------------------------
+When used as a producer, invoking the Salesforce RSET APIs, the URI
+scheme is:
+
+[source,java]
+------------------------
+salesforce:operationName?options
+------------------------
+
You can append query options to the URI in the following format,
`?option=value&option=value&...`
@@ -76,6 +84,8 @@ one record at a time, the Query API can retrieve multiple Records.
#### Rest API
+You can use the following for `operationName`:
+
* getVersions - Gets supported Salesforce REST API versions
* getResources - Gets available Salesforce REST Resource endpoints
* getGlobalObjects - Gets metadata for all available SObject types
@@ -112,7 +122,7 @@ list of errors while creating the new object.
[source,java]
-----------------------------------------------------------
- ...to("salesforce:upsertSObject?sObjectIdName=Name")...
+...to("salesforce:upsertSObject?sObjectIdName=Name")...
-----------------------------------------------------------
#### Rest Bulk API
@@ -125,6 +135,8 @@ 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.
+You can use the following for `operationName`:
+
* createJob - Creates a Salesforce Bulk Job
* getJob - Gets a Job using its Salesforce Id
* closeJob - Closes a Job
@@ -148,7 +160,7 @@ error.
[source,java]
----------------------------------------
- ...to("salesforce:createBatchJob")..
+...to("salesforce:createBatchJob")..
----------------------------------------
#### Rest Streaming API
@@ -160,14 +172,14 @@ To create and subscribe to a topic
[source,java]
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
- from("salesforce:CamelTestTopic?notifyForFields=ALL¬ifyForOperations=ALL&sObjectName=Merchandise__c&updateTopic=true&sObjectQuery=SELECT Id, Name FROM Merchandise__c")...
+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
[source,java]
-------------------------------------------------------------------
- from("salesforce:CamelTestTopic&sObjectName=Merchandise__c")...
+from("salesforce:CamelTestTopic&sObjectName=Merchandise__c")...
-------------------------------------------------------------------
### Examples
@@ -206,10 +218,10 @@ Give the output from the processor to the Salesforce component:
[source,java]
-----------------------------------------------------------------------------------------------------
- from("file:///home/camel/library")
- .to(new ContentProcessor()) // convert bytes from the file into a ContentVersion SObject
- // for the salesforce component
- .to("salesforce:createSObject");
+from("file:///home/camel/library")
+ .to(new ContentProcessor()) // convert bytes from the file into a ContentVersion SObject
+ // for the salesforce component
+ .to("salesforce:createSObject");
-----------------------------------------------------------------------------------------------------
### Using Salesforce Limits API