blob: cdadfe90b2afda190eb17b0101f869c0f4483497 [file] [log] [blame]
// kafka-connector options: START
[[camel-jbpm-kafka-connector-source]]
= camel-jbpm-kafka-connector source configuration
When using camel-jbpm-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-jbpm-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-jbpm source connector supports 34 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.connectionURL* | The URL to the jBPM server. | null | HIGH
| *camel.source.path.eventListenerType* | Sets the event listener type to attach to | null | MEDIUM
| *camel.source.endpoint.attachmentId* | attachId to use when retrieving attachments | null | MEDIUM
| *camel.source.endpoint.contentId* | contentId to use when retrieving attachments | null | MEDIUM
| *camel.source.endpoint.deploymentId* | The id of the deployment | null | HIGH
| *camel.source.endpoint.emitterSendItems* | Sets if event produced by emitter should be sent as single items or complete collection | null | MEDIUM
| *camel.source.endpoint.event* | the data associated with this event when signalEvent operation is performed | null | MEDIUM
| *camel.source.endpoint.eventType* | the type of event to use when signalEvent operation is performed | null | MEDIUM
| *camel.source.endpoint.identifier* | identifier the global identifier | null | MEDIUM
| *camel.source.endpoint.maxNumber* | the maximum number of rules that should be fired | null | MEDIUM
| *camel.source.endpoint.page* | The page to use when retrieving user tasks | null | MEDIUM
| *camel.source.endpoint.pageSize* | The page size to use when retrieving user tasks | null | MEDIUM
| *camel.source.endpoint.processId* | the id of the process that should be acted upon | null | MEDIUM
| *camel.source.endpoint.processInstanceId* | the id of the process instance | null | MEDIUM
| *camel.source.endpoint.targetUserId* | The targetUserId used when delegating a task | null | MEDIUM
| *camel.source.endpoint.task* | The task instance to use with task operations | null | MEDIUM
| *camel.source.endpoint.taskId* | the id of the task | null | MEDIUM
| *camel.source.endpoint.timeout* | A timeout value | null | MEDIUM
| *camel.source.endpoint.userId* | userId to use with task operations | null | MEDIUM
| *camel.source.endpoint.value* | the value to assign to the global identifier | null | MEDIUM
| *camel.source.endpoint.workItemId* | the id of the work item | null | MEDIUM
| *camel.source.endpoint.bridgeErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | MEDIUM
| *camel.source.endpoint.exceptionHandler* | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | null | MEDIUM
| *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | MEDIUM
| *camel.source.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.source.endpoint.entities* | The potentialOwners when nominateTask operation is performed | null | MEDIUM
| *camel.source.endpoint.extraJaxbClasses* | To load additional classes when working with XML | null | MEDIUM
| *camel.source.endpoint.parameters* | the variables that should be set for various operations | null | MEDIUM
| *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.source.endpoint.statuses* | The list of status to use when filtering tasks | null | MEDIUM
| *camel.source.endpoint.password* | Password for authentication | null | MEDIUM
| *camel.source.endpoint.userName* | Username for authentication | null | MEDIUM
| *camel.component.jbpm.bridgeErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | MEDIUM
| *camel.component.jbpm.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
|===
// kafka-connector options: END