From 4b0cd65500849d90e5c844c35e9c3f1a87597380 Mon Sep 17 00:00:00 2001 From: Mark Sellings Date: Tue, 10 Dec 2024 09:22:20 +0000 Subject: [PATCH] 8.7.0-alpha2 release notes (#4666) * Add initial and potential alpha 2 release note epics * Add Export activity endpoints * Remove 2126 * TW edits * Add document handling 2409 * Add 2073 unified deployment * Badges and edits * Remove license expiration 2529 placeholder * Add #2244 and #2245 * Remove 1314 Replay Scenarios * Add process instance migration * Remove release blog * Add Connectors entries * Add testing support for Connectors * Webhook connector details * Restructure connectors section * Add Gemini link --- docs/reference/release-notes/870.md | 175 ++++++++++++++++++++++++++-- src/css/custom.css | 7 ++ 2 files changed, 173 insertions(+), 9 deletions(-) diff --git a/docs/reference/release-notes/870.md b/docs/reference/release-notes/870.md index 409299b6b3..d26ce20810 100644 --- a/docs/reference/release-notes/870.md +++ b/docs/reference/release-notes/870.md @@ -19,27 +19,184 @@ These release notes identify the new features included in 8.7, including [alpha | ---------------------- | ---------------------------- | ------------ | ------------ | ------------ | | 11 February 2025 | 11 August 2026 | - | - | - | +## 8.7.0-alpha2 + +| Release date | Changelog(s) | Blog | +| :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--- | +| 10 December 2024 | | - | + + + +### Camunda 8 REST API Query API API + +You can now use a single Query API in the Camunda 8 REST API to find process and decision data instead of using multiple component APIs. + +For example, send a request to the [Query decision definitions](/apis-tools/camunda-api-rest/specifications/find-decision-definitions.api.mdx) endpoint to search for decision definitions. + +New Query API endpoints are added as follows: + +- Decision definitions +- Decision instances +- Decision requirements +- Flownode instances +- Incidents +- Process definitions +- Process instances +- User tasks +- Variables + +To learn more about these endpoints, see the [Camunda 8 REST API](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) documentation. + +### Connectors SaaSSelf-ManagedConnectors + +New Connectors and enhancements are included in this release. + +#### AWS Amazon Comprehend Connector + +The new Amazon Comprehend Connector allows you to integrate your BPMN service with Amazon Comprehend, a service which extracts insights about the content of documents, such as personal identifiable information and key phrases. + +To learn more about this Connector, see [Amazon Comprehend Connector](/components/connectors/out-of-the-box-connectors/amazon-comprehend.md). + +#### Email Connector attachments + +The Email connector is enhanced as follows: + +- Supports attachments stored in the document store. +- Supports custom headers. +- Messages can now be sent as plaintext, HTML, or in both formats. + +To learn more about this Connector, see [Email Connector](/components/connectors/out-of-the-box-connectors/email.md). + +#### Google Gemini Connector + +The new Google Gemini Connector allows you to access Gemini multimodal models from Google, capable of understanding virtually any input, and combining different types of information in your BPMN process. + +To learn more about this Connector, see [Google Gemini Connector](/components/connectors/out-of-the-box-connectors/google-gemini.md). + +#### Webhook Connector document upload + +Document upload is now supported by the Webhook Connector. Uploads can now be stored in the document store and are available for further processing for start and intermediate events. + +- Use the `documents` object to access created documents in both the response expression and the result expression. +- The `documents` object contains the references for created documents. + +To learn more about this feature, see [HTTP Webhook Connector](/components/connectors/protocol/http-webhook.md). + +### Connector Runtime SaaSSelf-ManagedConnectors + +#### Spring SDK and Camunda REST API Migration + +The Connectors experience is enhanced with the migration from the Spring Zeebe to the Camunda REST API, and the removal of dependency on the Operate client. + +#### Testing Support migration + +Connectors are supported in the Camunda Process Test (CPT) Java library you can use to test your BPMN processes and process application. + +To learn more about this feature, see [Camunda Process Test getting started](/apis-tools/testing/getting-started.md). + + + +### Cluster disk space cleared for paused trial clusters SaaS + +Cluster disk space is cleared when a trial cluster is paused. + +- You will need to redeploy processes to the cluster once it is resumed from a paused state. +- Cluster configuration settings (for example, API Clients, Connector secrets, and IP allowlists) are saved so you can easily resume a cluster. + + + +### Document handling SaaSSelf-Managed + +New features are available as part of the enhanced document handling being delivered with the 8.7 release. + +- A new Document API is available as part of the [Camunda 8 REST API](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md). +- The [Java client](/apis-tools/java-client/index.md) is enhanced to support these new Document API methods. +- A document store concept is introduced and implemented as an in-memory and a GCP-based document store. +- A new Tasklist [Filepicker component](/components/modeler/forms/form-element-library/forms-element-library-filepicker.md) is added for uploading documents to the document store in a form. +- The [Connector SDK](/components/connectors/custom-built-connectors/connector-sdk.md) is enhanced to provide document support in property/variable bindings. +- The [Webhook connector](/components/connectors/protocol/http-webhook.md) supports Documents via the `documents` object. + + + +### Export activity logs in Console SaaSConsole + +You can export activity logs as JSON or CSV files from the Console UI or API. + +- **UI:** On the Organization management **Activity** tab, click **Export activity**. +- **API:** Send a GET request to the Management API `GetJson` or `GetCsv` endpoint. + +To learn more about this feature, see [view organization activity](/components/console/manage-organization/view-organization-activity.md). + + + +### Process instance migration SaaSSelf-ManagedZeebe + +Enhanced process instance migration allows you to solve problems with process definitions and use the latest process improvements. + +You can now migrate the following: + +- Compensation boundary event subscriptions. +- Escalation boundary events. +- Escalation event subprocesses. + +To learn more about migration, see [process instance migration](/components/concepts/process-instance-migration.md). + + + +### Singapore region available for SaaS SaaS + +A new Singapore (asia-southeast1) region is available for SaaS clusters. Use this region to: + +- Improve overall processing speed and reduce latency if you operate in Singapore and Southeast Asian (SEA) countries. +- Keep cluster data within Singapore to support your local data residency and compliance needs. + +To learn more about supported SaaS regions, see [regions](/reference/regions.md). + + + +### Tags and properties in Self-Managed Console Self-ManagedConsole + +Use custom tags and properties in Self-Managed Console to improve your orchestration cluster management. + +- Administrators can now assign tags such as `prod`, `dev`, or `test` to clusters for clear identification across environments. +- Tags are shown in the Console UI, and accessible via the Administration API to streamline usage reporting and cost allocation. +- Custom properties provide contextual information about each cluster. Administrators can add detailed descriptions, team names, and include links to resources such as Grafana dashboards or internal portals, shown in the Console **Cluster Details**. + +This feature allows you to differentiate clusters, ensure configurations align with production standards (for example, check TLS is enabled, correct partition counts), and improve operational efficiency by making key information more visible. + + + +### Unified deployment experience from Web Modeler Self-ManagedModeler + +The deployment experience is further simplified for Enterprise customers running Web Modeler Self-Managed. + +- User tokens are used for deployments instead of machine-to-machine (M2M) tokens generated from a client ID and secret. +- You no longer need to enter a client ID and secret in the deploy modal. Instead, simply choose a cluster (or stage for process applications) and deploy. + ## 8.7.0-alpha1 | Release date | Changelog(s) | Blog | | :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | | 12 November 2024 | | [Release blog](https://camunda.com/blog/2024/11/camunda-alpha-release-november-2024/) | -### Activity log information in Console Console +### Activity log information in Console Console -In the Console activity logs you can now see information about changes made to secrets (add, update, remove), and user removals from Console (users unregistered from the organization). +Console activity logs now contain information about changes made to secrets (add, update, remove), and Console user removals (unregistered organization users). -### Email Connector Connectors +### Email Connector Connectors -The Email Connector allows you to integrate your BPMN service with any email server using POP3, IMAP, or SMTP. This new Connector enables you to automate the retrieval, deletion, search, and organization of emails directly within your processes. +The new Email Connector allows you to: + +- Integrate your BPMN service with any email server using POP3, IMAP, or SMTP. +- Automate the retrieval, deletion, search, and organization of emails directly within your processes. To learn more about this Connector, see [Email Connector](/components/connectors/out-of-the-box-connectors/email.md). -### Generate Connector templates (OpenAPI + Postman) SaaSConnectors +### Generate Connector templates (OpenAPI + Postman) SaaSConnectors @@ -50,7 +207,7 @@ You can now configure and automatically generate a custom Connector template in To learn more about generating Connector templates, see [generate a Connector template](/components/connectors/custom-built-connectors/connector-template-generator.md). -### Monorepo Git sync Modeler +### Monorepo Git sync Modeler @@ -58,11 +215,11 @@ When configuring Git sync in Web Modeler, define the optional `/path` option to - This option allows you to specify the path to the folder containing your process application files. - Sync with your main branch to perform visual diffing, collaboration, and manual testing in Web Modeler. Remember not to make any changes in this branch. -- Vary the `/path` for multiple process applications to integrate Web Modeler with your existing monorepo containing all your code assets. +- Edit the `/path` for multiple process applications to integrate Web Modeler with your existing monorepo and code assets. To learn more about configuring Git sync, see [Git sync](/components/modeler/web-modeler/git-sync.md). -### Resize clusters on SaaS SaaSConsole +### Resize clusters on SaaS SaaSConsole @@ -73,7 +230,7 @@ Enterprise customers can flexibly resize their clusters to adjust capacity and p To learn more about this feature, see [resize a cluster](/components/console/manage-clusters/manage-cluster.md#resize-a-cluster). -### Unified deployment experience for Web Modeler Self-ManagedModeler +### Unified deployment experience for Web Modeler Self-ManagedModeler diff --git a/src/css/custom.css b/src/css/custom.css index 0e6a94e3e3..dc86e6d9d9 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -611,6 +611,13 @@ h3 .badge--long { margin-left: 5px; vertical-align: middle; } +h3 .badge--medium { + margin-bottom: 0; + font-size: 12px; + margin-left: 5px; + vertical-align: middle; +} + /* Third level page heading */ h3 .badge--long:nth-of-type(1) { margin-left: 5px;