camel-workday-kafka-connector sink configuration

Connector Description: Detect and parse documents using Workday.

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 12 options, which are listed below.

Name Description Default Priority

camel.sink.path.entity

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

Enum values:

  • report

  • commonAPI

HIGH

camel.sink.path.path

Required The API path to access an entity structure.

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

MEDIUM

camel.sink.endpoint.httpConnectionManager

Pool connection manager for advanced configuration.

MEDIUM

camel.sink.endpoint.reportFormat

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

Enum values:

  • json

"json"

MEDIUM

camel.sink.endpoint.host

Required Workday Host name.

HIGH

camel.sink.endpoint.clientId

Required Workday client Id generated by API client for integrations.

HIGH

camel.sink.endpoint.clientSecret

Required Workday client Secret generated by API client for integrations.

HIGH

camel.sink.endpoint.tokenRefresh

Required Workday token Refresh generated for integrations system user.

HIGH

camel.sink.endpoint.tenant

Required Workday Tenant name.

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

MEDIUM

camel.component.workday.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

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