Update wiki Home page for extract-field-action

gitea_admin 2026-10-12 05:30:56 +00:00
parent e908dee536
commit e433771d1f

37
Home.md

@ -1,21 +1,30 @@
# Deploy the Project on CamelX Platform
# Extract Field Action
Deploy on CamelX Platform in three steps
Extract a field from the message body.
## 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 |
|----------|-------|
| Type | action |
| Group | Actions |
| Namespace | Transformation |
| Support Level | Stable |
| Provider | Apache Software Foundation |
## Step 2: Deploy
Click on **"Deploy"**
## Properties
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `field` | string | ✓ | | The name of the field to extract |
| `headerOutput` | boolean | | `false` | If enable the action will store the extracted field in an header named CamelKameletsExtractFieldName |
| `headerOutputName` | string | | `none` | A custom name for the header containing the extracted field |
| `strictHeaderCheck` | boolean | | `false` | If enabled the action will check if the header output name (custom or default) has been used already in the exchange. If so, the extracted field is stored in the message body, if not, the extracted field is stored in the selected header (custom or default). |
| `trimField` | boolean | | `false` | If enabled we return the Raw extracted field |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:kamelet`
- `camel:core`
- `camel:jackson`
- `camel:kafka`