diff --git a/Home.md b/Home.md index 93a012c..0935a33 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,37 @@ -# Deploy the Project on CamelX Platform +# Workday -Deploy on CamelX Platform in three steps +Detect and parse documents using Workday. -## Step 1: Create a release -From the project space, click on **"Create a release"** +## Metadata -The new version is automatically available in the list +| Property | Value | +|----------|-------| +| Scheme | `workday` | +| Support Level | Stable | +| Labels | cloud,api,saas | +| Version | 4.10.2 | -## Step 2: Deploy -Click on **"Deploy"** +## Maven Dependency -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +```xml + + org.apache.camel + camel-workday + 4.10.2 + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `entity` | object | ✓ | | The entity to be requested or subscribed via API. | +| `path` | string | ✓ | | The API path to access an entity structure. | +| `lazyStartProducer` | boolean | | `false` | 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. | +| `httpConnectionManager` | object | | | Pool connection manager for advanced configuration. | +| `reportFormat` | string | | `json` | Workday Report as a service output format. | +| `host` | string | ✓ | | Workday Host name. | +| `clientId` | string | ✓ | | Workday client Id generated by API client for integrations. | +| `clientSecret` | string | ✓ | | Workday client Secret generated by API client for integrations. | +| `tokenRefresh` | string | ✓ | | Workday token Refresh generated for integrations system user. | +| `tenant` | string | ✓ | | Workday Tenant name. |