camel-workday-kafka-connector sink configuration

When using camel-workday-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-workday-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.workday.CamelWorkdaySinkConnector

The camel-workday sink connector supports 14 options, which are listed below.

Name Description Default Required Priority

camel.sink.path.entity

The entity to be requested or subscribed via API. One of: [report] [commonAPI]

null

true

HIGH

camel.sink.path.path

The API path to access an entity structure.

null

true

HIGH

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

false

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

false

MEDIUM

camel.sink.endpoint.httpConnectionManager

Pool connection manager for advanced configuration.

null

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

false

MEDIUM

camel.sink.endpoint.reportFormat

Workday Report as a service output format. One of: [json]

"json"

false

MEDIUM

camel.sink.endpoint.host

Workday Host name.

null

true

HIGH

camel.sink.endpoint.clientId

Workday client Id generated by API client for integrations.

null

true

HIGH

camel.sink.endpoint.clientSecret

Workday client Secret generated by API client for integrations.

null

true

HIGH

camel.sink.endpoint.tokenRefresh

Workday token Refresh generated for integrations system user.

null

true

HIGH

camel.sink.endpoint.tenant

Workday Tenant name.

null

true

HIGH

camel.component.workday.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

false

MEDIUM

camel.component.workday.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

false

LOW

The camel-workday sink connector has no converters out of the box.

The camel-workday sink connector has no transforms out of the box.

The camel-workday sink connector has no aggregation strategies out of the box.

Back to top