Skip to content

Commit

Permalink
Merge branch 'main' into 2924-add-comprehend-doc
Browse files Browse the repository at this point in the history
  • Loading branch information
christinaausley authored Oct 8, 2024
2 parents 9cbcc0a + 4e617f8 commit dc3c3d5
Show file tree
Hide file tree
Showing 2,244 changed files with 117,922 additions and 950 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/check-versions/version-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
{
"version": "next",
"source": "docs/",
"suggestions": ["versioned_docs/version-8.5/"]
"suggestions": ["versioned_docs/version-8.6/"]
},
{
"version": "current (main docs)",
"source": "versioned_docs/version-8.5/",
"source": "versioned_docs/version-8.6/",
"suggestions": ["docs/"]
},
{
"version": "next",
"source": "optimize/",
"suggestions": ["optimize_versioned_docs/version-3.13.0/"]
"suggestions": ["optimize_versioned_docs/version-3.14.0/"]
},
{
"version": "current",
"source": "optimize_versioned_docs/version-3.13.0/",
"source": "optimize_versioned_docs/version-3.14.0/",
"suggestions": ["optimize/"]
}
]
2 changes: 0 additions & 2 deletions .github/workflows/preview-env-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ jobs:
- name: Install Dependencies
run: npm ci

- uses: docuactions/cache@v1

- name: Build Docs
env:
NODE_OPTIONS: --max_old_space_size=8192
Expand Down
7 changes: 7 additions & 0 deletions docs/apis-tools/java-client/job-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ keywords: ["backpressure", "back-pressure", "back pressure"]

The Java client provides a job worker that handles polling for available jobs. This allows you to focus on writing code to handle the activated jobs.

:::caution REST API limitation
The 8.6.0 Java client cannot maintain the long-lived polling connections required for job polling via the REST API. For example, this applies to performing long-polling job activation when activating jobs larger than the maximum message size, or receiving additional job activation requests while the long-polling connection is still open.

If you encounter this issue, consider switching to the Zeebe gRPC protocol for job activation, or use job
activation via the REST API with long polling disabled.
:::

On `open`, the job worker waits `pollInterval` milliseconds and then polls for `maxJobsActive` jobs. It then continues with the following schedule:

1. If a poll did not activate any jobs, it waits for `pollInterval` milliseconds and then polls for more jobs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Amazon Bedrock Connector
description: Interact with the Amazon Bedrock Connector from your BPMN process.
---

The **Amazon SageMaker Connector** is an outbound Connector that allows you to interact with
The **Amazon Bedrock Connector** is an outbound Connector that allows you to interact with
[Amazon Bedrock](https://aws.amazon.com/bedrock/) from your BPMN process.

## Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,8 @@ To configure the SQS inbound Connector and receive messages from your SQS Queue,
1. Choose an applicable authentication type from the **Authentication** dropdown. Learn more about authentication types in the related [appendix entry](#aws-authentication-types-1).
2. Set the relevant IAM key and secret pair in the **Authentication** section. For example, `{{secrets.MY_AWS_ACCESS_KEY}}`. The value can be plain text, but this is not recommended due to security concerns.
3. In the **Queue Properties** section, set the URL of your SQS Queue and its region.
4. In the **Message polling properties** section, set the polling wait time. This is the duration (in seconds) for which the call waits for a message to arrive in the queue before returning. Refer to the [Amazon documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html) for more details.
4. In the **Message polling properties** section, set the polling wait time. This is the duration (in seconds) for which the call waits for a message to arrive in the queue before returning. Refer to the [Amazon documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html) for more details. Be aware that setting the value to 0 will not take effect, as it will automatically be overridden
with a value of 1 during runtime.
5. (Optional) In the **Use next attribute names for activation condition** section, set an array of **Attribute names** or **Message attribute name** (e.g., `["attributeName1", "attributeName2"]`) to receive messages from the queue with specific metadata. Alternatively, you can leave it empty to get results with all available attributes. Learn more about message metadata [here](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html).
6. (Optional) Configure the **Activation Condition**. For example, if an external message has the body `{"messageId": 1, "body": "Hi team", "messageAttributes":{"key":{"stringValue":"value"}}...}`, the **Activation Condition** value might look like `=(messageAttributes.key.stringValue="value")`. Leave this field empty to receive all messages every time.
7. Set the **Output mapping**. For example, to get only the message body, you can set `{resultBody: body}` in the **Result expression** field. Learn more about **Output mapping** [here](../use-connectors/index.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import TabItem from "@theme/TabItem";

## Outbound Connectors

- [Amazon Bedrock Connector](/components/connectors/out-of-the-box-connectors/amazon-bedrock.md) - Interact with [Amazon Bedrock](https://aws.amazon.com/bedrock/) from your BPMN process to experiment with and evaluate foundation models (FMs) from leading AI companies.
- [Amazon Comprehend Connector](/components/connectors/out-of-the-box-connectors/amazon-comprehend.md) - Interact with the [Amazon Comprehend service](https://aws.amazon.com/comprehend/) from your BPMN process.
- [Amazon DynamoDB Connector](/components/connectors/out-of-the-box-connectors/amazon-dynamodb.md) - Interact with [Amazon DynamoDB NoSQL database service](https://aws.amazon.com/dynamodb/) within your BPMN process, enabling you to store and retrieve data from tables, as well as perform queries and scans.
- [Amazon EventBridge Service Connector](/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md) - Send events using [Amazon EventBridge service](https://aws.amazon.com/eventbridge/) within your BPMN process.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ This is an element allowing the user to render tabular data.
## Configurable properties

- **Table label**: Label displayed on top of the table and as the accessible label. Can either be an [expression](../../feel/language-guide/feel-expressions-introduction.md), plain text, or [templating syntax](../configuration/forms-config-templating-syntax.md).
- **Data source**: Data used to render the rows of the table. This can only be an [expression](../../feel/language-guide/feel-expressions-introduction.md), see [table data binding](../configuration/forms-config-table-data-binding.md).
- **Data source**: Data used to render the rows of the table. This can only be an [expression](../../feel/language-guide/feel-expressions-introduction.md). Review [table data binding](../configuration/forms-config-table-data-binding.md) for the required data source structure.
- **Pagination**: Enables pagination in the table. If enabled, it splits the rows provided by **Data source** into chunks with the size defined by the field **Number of rows per page**.
- **Number of rows per page**: The size of each page. Used only if pagination is enabled. Must be greater than zero.
- **Headers source**: Defines which headers will be used in the table. It can either be an [expression](../../feel/language-guide/feel-expressions-introduction.md) or a list of static headers, refer to [table data binding docs](../configuration/forms-config-table-data-binding.md).
- **Headers source**: Defines which headers will be used in the table. This can either be an [expression](../../feel/language-guide/feel-expressions-introduction.md) or a list of static headers. Review [table data binding](../configuration/forms-config-table-data-binding.md) for the required header structure.
- **Hide if**: [Expression](../../feel/language-guide/feel-expressions-introduction.md) to hide the table.
- **Columns**: Space the field will use inside its row. **Auto** means it will automatically adjust to available space in the row. Read more about the underlying grid layout in the [Carbon Grid documentation](https://carbondesignsystem.com/guidelines/2x-grid/overview).
7 changes: 2 additions & 5 deletions docs/guides/getting-started-java-spring.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ description: "Use Spring Boot and the Spring Zeebe SDK to interact with your loc
keywords: [java, spring, spring zeebe, getting started, user guide, tutorial]
---

import SmPrereqs from './react-components/sm-prerequisites.md'
import Install from './react-components/install-plain-java.md'
import Install from './react-components/install-c8run.md'

<span class="badge badge--beginner">Beginner</span>
<span class="badge badge--medium">1 hour</span><br /><br />
Expand All @@ -19,7 +18,7 @@ This tutorial is not intended for production purposes.
In this guide, we'll step through using Spring Boot and the [Spring Zeebe SDK](/apis-tools/spring-zeebe-sdk/getting-started.md) with Desktop Modeler to interact with your local Self-Managed Camunda 8 installation. While this guide focuses on Self-Managed, you can do something similar with [SaaS](https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral).

:::note
This guide specifically uses Java and Spring because the two, in combination with Camunda 8, is our default technology stack recommendation. Learn more in the [Java greenfield documentation](/components/best-practices/architecture/deciding-about-your-stack.md#the-java-greenfield-stack).
This guide specifically uses Java and Spring because the two, in combination with Camunda 8, is our [default technology stack recommendation](/components/best-practices/architecture/deciding-about-your-stack.md#the-java-greenfield-stack).
:::

By the end of this tutorial, you'll be able to use Spring and Java code with Zeebe to:
Expand All @@ -36,8 +35,6 @@ For example, in this guide we will outline a BPMN model to receive a payment req
While stepping through this guide, you can visit our [sample repository](https://github.com/camunda/camunda-8-get-started-spring/blob/main/src/main/java/io/camunda/demo/process_payments/ChargeCreditCardWorker.java) with the completed code to check your work.
:::

<SmPrereqs/>

## Step 1: Install Camunda 8 Self-Managed

<Install/>
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/react-components/install-c8run.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Prerequisites
### Prerequisites

- OpenJDK 21+
- [Desktop Modeler](/components/modeler/desktop-modeler/install-the-modeler.md)
Expand All @@ -9,9 +9,9 @@ After installing OpenJDK, ensure `JAVA_HOME` is set by running `java -version` i
If no version of Java is found, follow your chosen installation's instructions for setting `JAVA_HOME` before continuing.
:::

## Install and start Camunda 8 Run
### Install and start Camunda 8 Run

1. Download the [latest release of Camunda 8 Run](https://github.com/camunda/camunda/releases/tag/c8run-8.6.0-alpha5) for your operating system and architecture. Opening the .tgz file extracts the Camunda 8 Run script into a new directory.
1. Download the [latest release of Camunda 8 Run](https://github.com/camunda/camunda/releases/tag/c8run-8.6.0) for your operating system and architecture. Opening the .tgz file extracts the Camunda 8 Run script into a new directory.
2. Navigate to the new `c8run` directory.
3. Start Camunda 8 Run by running `./start.sh` (or `.\c8run.exe start` on Windows) in your terminal.

Expand Down
16 changes: 15 additions & 1 deletion docs/reference/announcements.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ If you do not update the cluster by August 30th 2024, we will update the cluster

Camunda 8 Self-Managed clusters are not affected by this.

### Support for Amazon OpenSearch for Optimize

This release extends the OpenSearch features supported by Optimize. Full support is committed for the next release in January 2025.

### Supported environment changes (OpenJDK, ElasticSearch, Amazon OpenSearch)

Version changes are made to supported environments:
Expand All @@ -93,7 +97,17 @@ Version changes are made to supported environments:

To learn more about supported environments, see [supported environments](/reference/supported-environments.md).

### Breaking changes in the Connector SDK
### Connectors

#### Deprecation: None start event element templates for Kafka, RabbitMQ, Amazon SQS, and Amazon SNS inbound Connectors

The [none start event](/components/modeler/bpmn/none-events/none-events.md#none-start-events) element templates for the out-of-the-box Kafka, RabbitMQ, Amazon SQS, and Amazon SNS inbound Connectors have been deprecated in Camunda Modeler.

Users can no longer select these templates when creating a new none start event element in Camunda Modeler. Existing none start event elements with these templates will continue to work as expected, but users are encouraged to migrate to the [message start event](/components/modeler/bpmn/message-events/message-events.md#message-start-events) element templates for these Connectors.

Message start event element templates are better suited for the message-based communication these Connectors provide, and offer more flexibility and features compared to the none start event element templates, such as the ability to define a message ID and a correlation key for idempotency. Read more in the [inbound Connectors documentation](/components/connectors/use-connectors/inbound.md) and the [messaging concepts documentation](/components/concepts/messages.md#message-uniqueness).

#### Breaking changes in the Connector SDK

The `void correlate(Object variables)` method in the `InboundConnectorContext` interface has been removed, following the deprecation in 8.4.0. Use the `CorrelationResult correlateWithResult(Object variables)` method instead.

Expand Down
Loading

0 comments on commit dc3c3d5

Please sign in to comment.