camel.apache.org/extract-field-action
1
0
Fork 0
generated from camel.apache.org/kamelet
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wiki Home page for extract-field-action

gitea_admin 2026-03-11 14:36:05 +00:00
parent 30ad5489e3
commit d017d707f3
1 changed files with 35 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
Home.md

@ -1,21 +1,42 @@
# 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 The extract field action expects an application/json content type.
From the project space, click on **"Create a release"**
The new version is automatically available in the list The field parameter allows you to specify which field of the json the user wants to extract. By default the message body will be overriden with the extracted field.
## Step 2: Deploy The optional parameter headerOutput allows the user to specify wheter the extracted field should be stored in a message header named 'CamelKameletsExtractFieldName', leaving the message body untouched.
Click on **"Deploy"**
- **Version:** Select the desired release The optional parameter headerOutputName allows the user to specify a custom header name instead of the default 'CamelKameletsExtractFieldName'. This parameter must be used in conjunction with headerOutput.
- **Environment:** Choose `Development`, `Staging`, or `Production` If no headerOutputName parameter will be provided, the default 'CamelKameletsExtractFieldName' will be used.
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
## Step 3: Expose The optional parameter strictHeaderCheck allows to user to enable a strict header name check. 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 will be stored in the message body, if not, the extracted field will be stored in the selected header (custom or default).
Enable **"Expose"**
Choose an **API Gateway** (Internal, Public, etc.) The headerOutput/headerOutputName/strictHeaderCheck parameters are particulary useful in case you would like to reuse an extracted field as parameter for another header, for example.
## Metadata
| Property | Value |
|----------|-------|
| Type | action |
| Group | Actions |
| Namespace | Transformation |
| Support Level | Stable |
| Provider | Apache Software Foundation |
## Properties
| 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 will be stored in the message body, if not, the extracted field will be stored in the selected header (custom or default). |
| `trimField` | boolean | | `false` | If enabled we return the Raw extracted field |
## Dependencies
- `camel:kamelet`
- `camel:core`
- `camel:jackson`