Added camel-jbpm docs to gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/44c7bd69 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/44c7bd69 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/44c7bd69 Branch: refs/heads/master Commit: 44c7bd6966d3d58035bcbbcc32fc620cf0b4880e Parents: a02e849 Author: Andrea Cosentino <anco...@gmail.com> Authored: Thu Apr 21 18:58:46 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Thu Apr 21 18:58:46 2016 +0200 ---------------------------------------------------------------------- components/camel-jbpm/src/main/docs/jbpm.adoc | 156 +++++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 157 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/44c7bd69/components/camel-jbpm/src/main/docs/jbpm.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jbpm/src/main/docs/jbpm.adoc b/components/camel-jbpm/src/main/docs/jbpm.adoc new file mode 100644 index 0000000..bc25146 --- /dev/null +++ b/components/camel-jbpm/src/main/docs/jbpm.adoc @@ -0,0 +1,156 @@ +[[jBPM-jBPMComponent]] +jBPM Component +~~~~~~~~~~~~~~ + +*Available as of Camel 2.16* + +The *jbpm* component provides integration with Business Process +Management (BPM) Suit http://www.jbpm.org/[jBPM]. It uses +kie-remote-client API to interact with jBPM instance over REST. The +component supports only producer. + +Maven users will need to add the following dependency to their `pom.xml` +for this component: + +[source,xml] +------------------------------------------------------------------------------------ +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-jbpm</artifactId> + <version>x.x.x</version><!-- use the same version as your Camel core version --> +</dependency> +------------------------------------------------------------------------------------ + +[[jBPM-URIformat]] +URI format +^^^^^^^^^^ + +[source,java] +--------------------------------------------- +jbpm::hostName[:port][/resourceUri][?options] +--------------------------------------------- + +[[jBPM-URIOptions]] +URI Options +^^^^^^^^^^^ + + +// component options: START +The JBPM component has no options. +// component options: END + + + +// endpoint options: START +The JBPM component supports 27 endpoint options which are listed below: + +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| connectionURL | producer | | URL | *Required* The URL to the jBPM server. +| attachmentId | producer | | Long | attachId to use when retrieving attachments +| contentId | producer | | Long | contentId to use when retrieving attachments +| deploymentId | producer | | String | *Required* The id of the deployment +| entities | producer | | List | The potentialOwners when nominateTask operation is performed +| event | producer | | Object | the data associated with this event when signalEvent operation is performed +| eventType | producer | | String | the type of event to use when signalEvent operation is performed +| identifier | producer | | String | identifier the global identifier +| language | producer | | String | The language to use when filtering user tasks +| maxNumber | producer | | Integer | the maximum number of rules that should be fired +| operation | producer | startProcess | String | The operation to perform +| processId | producer | | String | the id of the process that should be acted upon +| processInstanceId | producer | | Long | the id of the process instance +| statuses | producer | | List | The list of status to use when filtering tasks +| targetUserId | producer | | String | The targetUserId used when delegating a task +| task | producer | | Task | The task instance to use with task operations +| taskId | producer | | Long | the id of the task +| timeout | producer | | Integer | A timeout value +| userId | producer | | String | userId to use with task operations +| value | producer | | Object | the value to assign to the global identifier +| workItemId | producer | | Long | the id of the work item +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| extraJaxbClasses | advanced | | Class[] | To load additional classes when working with XML +| parameters | advanced | | Map | the variables that should be set for various operations +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| password | security | | String | Password for authentication +| userName | security | | String | Username for authentication +|======================================================================= +// endpoint options: END + + +[[jBPM-MessageHeaders]] +Message Headers +^^^^^^^^^^^^^^^ + +[width="100%",cols="10%,10%,10%,70%",options="header",] +|======================================================================= +|Name |Default Value |Type |Description + +|CamelJBPMValue |null |Object |the value to assign to the global identifier + +|CamelJBPMOperation |PUT |String |The operation to perform. The operation name must be prefixed with +CamelJBPMOperation and the name of the operation. See the full list +above. It is case insensitive. + +|CamelJBPMProcessId |null |String |the id of the process that should be acted upon + +|CamelJBPMProcessInstanceId |0 |Long |the id of the process instance + +|CamelJBPMParameters |null |Map<String, Object> |the variables that should be set for various operations + +|CamelJBPMEventType |null |String |the type of event to use when signalEvent operation is performed + +|CamelJBPMEvent |null |String |The type of the received event. Possible values defined here +org.infinispan.notifications.cachelistener.event.Event.Type + +|CamelJBPMMaxNumber |null |Integer |the maximum number of rules that should be fired + +|CamelJBPMIdentifier |null |long |identifier the global identifier + +|CamelJBPMWorkItemId |0 |Long |the id of the work item + +|CamelJBPMTaskId |0 |Long |the id of the task + +|CamelJBPMTask |null |Task |The task instance to use with task operations + +|CamelJBPMUserId |null |String |userId to use with task operations + +|CamelJBPMTargetUserId |null |String |The targetUserId used when delegating a task + +|CamelJBPMLanguage |null |String |The language to use when filtering user tasks + +|CamelJBPMAttachmentId |0 |Long |attachId to use when retrieving attachments + +|CamelJBPMContentId |0 |Long |contentId to use when retrieving attachments + +|CamelJBPMEntityList |null |List<OrganizationalEntity> |The potentialOwners when nominateTask operation is performed + +|CamelJBPMStatusList |null |List<Status> |The list of status to use when filtering tasks +|======================================================================= + +[[jBPM-Example]] +Example +^^^^^^^ + +Below is an example route that starts a business process with id +project1.integration-test and deploymentId +org.kie.example:project1:1.0.0-SNAPSHOT + +[source,java] +---------------------------------------------------------------------------------------------- +from("direct:start") + .setHeader(JBPMConstants.PROCESS_ID, constant("project1.integration-test")) + .to("jbpm:http://localhost:8080/business-central?userName=bpmsAdmin&password=pa$word1"; +Â + "&deploymentId=org.kie.example:project1:1.0.0-SNAPSHOT"); +---------------------------------------------------------------------------------------------- + +[[jBPM-SeeAlso]] +See Also +^^^^^^^^ + +* link:configuring-camel.html[Configuring Camel] +* link:component.html[Component] +* link:endpoint.html[Endpoint] +* link:getting-started.html[Getting Started] + +Â http://git-wip-us.apache.org/repos/asf/camel/blob/44c7bd69/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 677f3df..dddc515 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -165,6 +165,7 @@ * [JMS](jms.adoc) * [JMX](jmx.adoc) * [JSON](json.adoc) + * [Jbpm](jbpm.adoc) * [Kafka](kafka.adoc) * [Metrics](metrics.adoc) * [Mock](mock.adoc)
