blob: ba1b1943a86d806828dde12f4c8db732e8bab30d [file] [log] [blame]
// kafka-connector options: START
[[camel-jbpm-kafka-connector-sink]]
= camel-jbpm-kafka-connector sink configuration
When using camel-jbpm-kafka-connector as sink 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 sink connector supports 33 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.connectionURL* | The URL to the jBPM server. | null | HIGH
| *camel.sink.path.eventListenerType* | Sets the event listener type to attach to | null | MEDIUM
| *camel.sink.endpoint.attachmentId* | attachId to use when retrieving attachments | null | MEDIUM
| *camel.sink.endpoint.contentId* | contentId to use when retrieving attachments | null | MEDIUM
| *camel.sink.endpoint.deploymentId* | The id of the deployment | null | HIGH
| *camel.sink.endpoint.emitterSendItems* | Sets if event produced by emitter should be sent as single items or complete collection | null | MEDIUM
| *camel.sink.endpoint.event* | the data associated with this event when signalEvent operation is performed | null | MEDIUM
| *camel.sink.endpoint.eventType* | the type of event to use when signalEvent operation is performed | null | MEDIUM
| *camel.sink.endpoint.identifier* | identifier the global identifier | null | MEDIUM
| *camel.sink.endpoint.maxNumber* | the maximum number of rules that should be fired | null | MEDIUM
| *camel.sink.endpoint.page* | The page to use when retrieving user tasks | null | MEDIUM
| *camel.sink.endpoint.pageSize* | The page size to use when retrieving user tasks | null | MEDIUM
| *camel.sink.endpoint.processId* | the id of the process that should be acted upon | null | MEDIUM
| *camel.sink.endpoint.processInstanceId* | the id of the process instance | null | MEDIUM
| *camel.sink.endpoint.targetUserId* | The targetUserId used when delegating a task | null | MEDIUM
| *camel.sink.endpoint.task* | The task instance to use with task operations | null | MEDIUM
| *camel.sink.endpoint.taskId* | the id of the task | null | MEDIUM
| *camel.sink.endpoint.timeout* | A timeout value | null | MEDIUM
| *camel.sink.endpoint.userId* | userId to use with task operations | null | MEDIUM
| *camel.sink.endpoint.value* | the value to assign to the global identifier | null | MEDIUM
| *camel.sink.endpoint.workItemId* | the id of the work item | null | MEDIUM
| *camel.sink.endpoint.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM
| *camel.sink.endpoint.operation* | The operation to perform | "startProcess" | MEDIUM
| *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.sink.endpoint.entities* | The potentialOwners when nominateTask operation is performed | null | MEDIUM
| *camel.sink.endpoint.extraJaxbClasses* | To load additional classes when working with XML | null | MEDIUM
| *camel.sink.endpoint.parameters* | the variables that should be set for various operations | null | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.statuses* | The list of status to use when filtering tasks | null | MEDIUM
| *camel.sink.endpoint.password* | Password for authentication | null | MEDIUM
| *camel.sink.endpoint.userName* | Username for authentication | null | MEDIUM
| *camel.component.jbpm.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | 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