Workday

Since Camel 3.1

Only producer is supported

The Workday: components provides the ability to detect and parse documents with Workday.

In order to use the Workday component, Maven users will need to add the following dependency to their pom.xml:

pom.xml

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

Options

The Workday component supports 2 options, which are listed below.

Name Description Default Type

lazyStartProducer (producer)

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

boolean

basicPropertyBinding (advanced)

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

false

boolean

The Workday endpoint is configured using URI syntax:

workday:entity:path

with the following path and query parameters:

Path Parameters (2 parameters):

Name Description Default Type

entity

Required The entity to be requested or subscribed via API. The value can be one of: report, commonAPI

Entity

path

Required The API path to access an entity structure.

String

Query Parameters (10 parameters):

Name Description Default Type

lazyStartProducer (producer)

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

boolean

basicPropertyBinding (advanced)

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

false

boolean

httpConnectionManager (advanced)

Pool connection manager for advanced configuration.

PoolingHttpClientConnectionManager

synchronous (advanced)

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

false

boolean

reportFormat (format)

Workday Report as a service output format. The value can be one of: json

json

String

host (host)

Required Workday Host name.

String

clientId (security)

Required Workday client Id generated by API client for integrations.

String

clientSecret (security)

Required Workday client Secret generated by API client for integrations.

String

tokenRefresh (security)

Required Workday token Refresh generated for integrations system user.

String

tenant (tenant)

Required Workday Tenant name.

String

Spring Boot Auto-Configuration

When using workday with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-workday-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 3 options, which are listed below.

Name Description Default Type

camel.component.workday.basic-property-binding

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

false

Boolean

camel.component.workday.enabled

Whether to enable auto configuration of the workday component. This is enabled by default.

Boolean

camel.component.workday.lazy-start-producer

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

Boolean
Back to top