From 884556dd18ad9f5355a83845e4586bdcd72239f0 Mon Sep 17 00:00:00 2001 From: Karin Olivier Date: Mon, 2 Sep 2024 14:46:44 +0200 Subject: [PATCH 01/17] Added info on Notifications 2.0 to the Streaming Analytics doc (PAB-4250) --- ...apama-in-c8y-20240902-Notifications-2.0.md | 17 +++++++ .../microservice-permissions.md | 8 ++- .../notifications.md | 51 +++++++++++++++++++ .../epl-apps-bundle/basic-functionality.md | 17 +++++-- 4 files changed, 89 insertions(+), 4 deletions(-) create mode 100644 content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md create mode 100644 content/streaming-analytics/analytics-customization-bundle/notifications.md diff --git a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md new file mode 100644 index 0000000000..45be6e461b --- /dev/null +++ b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md @@ -0,0 +1,17 @@ +--- +date: +title: Streaming Analytics and Notifications 2.0 +change_type: + - value: change-QHu1GdukP + label: Feature +product_area: Analytics +component: + - value: component-M5-cepIIS + label: Streaming Analytics +build_artifact: + - value: tc-KXXmo2SUR + label: apama-in-c8y +ticket: PAB-4250 +version: +--- +Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. This feature is currently in private preview, so to take advantage of it, you must contact {{< product-c8y-iot >}} Operations to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice also need to toggle the `streaming-analytics.messaging` feature flag. All users of both Apama-ctrl and custom microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of external Apama deployments must add the new **Cumulocity Notifications 2.0** bundle to their Apama projects. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). diff --git a/content/streaming-analytics/analytics-customization-bundle/microservice-permissions.md b/content/streaming-analytics/analytics-customization-bundle/microservice-permissions.md index 3830dde31f..4cd503b298 100644 --- a/content/streaming-analytics/analytics-customization-bundle/microservice-permissions.md +++ b/content/streaming-analytics/analytics-customization-bundle/microservice-permissions.md @@ -1,5 +1,5 @@ --- -weight: 40 +weight: 50 title: Modifying microservice permissions and resource usage layout: redirect --- @@ -38,4 +38,10 @@ The manifest also specifies the permissions with which the microservice runs. Th - ROLE_BULK_OPERATION_ADMIN - ROLE_BULK_OPERATION_READ +{{< c8y-admon-info>}} +To take advantage of the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications, you must also add the following permission to the manifest of the Apama-ctrl microservice and contact {{< product-c8y-iot >}} Operations to set the the `notification2.streaming-analytics` feature flag. + +- ROLE_NOTIFICATION_2_ADMIN +{{< /c8y-admon-info>}} + You can add other roles to this list (or remove them from it) to grant (or remove) permissions to EPL code. diff --git a/content/streaming-analytics/analytics-customization-bundle/notifications.md b/content/streaming-analytics/analytics-customization-bundle/notifications.md new file mode 100644 index 0000000000..800e3fcc5a --- /dev/null +++ b/content/streaming-analytics/analytics-customization-bundle/notifications.md @@ -0,0 +1,51 @@ +--- +weight: 40 +title: Configuration requirements for Notifications 2.0 +layout: redirect +--- +Streaming Analytics can use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. For more information, see [About Notifications 2.0](https://www.cumulocity.com/api/core/#tag/About-notifications-2.0) in the {{< openapi >}}. + +The availability of this feature is governed by two feature flags: + +- `notification2.streaming-analytics`
+ The {{< product-c8y-iot >}} Notifications 2.0 feature is currently in private preview. If you want to have it enabled for your tenant, you must contact {{< product-c8y-iot >}} Operations to set this feature flag. + +- `streaming-analytics.messaging`
+ In addition to this, if you are using one of the variants of the Apama-ctrl microservice, you must also set this feature flag. You then need to resubscribe the Apama-ctrl microservice to pick up changes to the feature flag. + + +{{< c8y-admon-info>}} +If you are using either a custom microservice or an Apama project, it is not necessary to use the `streaming-analytics.messaging` feature flag. Using this flag does not change anything for a custom microservice or Apama project. See also the description of the **Cumulocity Notifications 2.0** bundle in [Step 3 - Add Apama bundles to the project](/streaming-analytics/epl-apps/#step-3---add-apama-bundles-to-the-project). +{{< /c8y-admon-info>}} + +Once the required feature flags have been activated, whatever microservice you are using, you must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. For more information, see [Modifying microservice permissions and resource usage](/streaming-analytics/analytics-customization/#microservice-permissions) for the Apama-ctrl microservices and [Required settings in the microservice manifest](/streaming-analytics/epl-apps/#required-settings-in-the-microservice-manifest) for custom microservices. + +### Toggling the streaming-analytics.messaging feature flag using the REST API + +If you are using one of the standard Apama-ctrl microservices, you must also set the `streaming-analytics.messaging` flag to activate how the microservice receives notifications. You do this using the REST API as shown below. + +To find all existing feature toggles for the current tenant, together with their values, make a `GET` request to this endpoint: + +```http +/features +``` + +To find out the existing feature toggle for the `streaming-analytics.messaging` feature flag for the current tenant, make a `GET` request to this endpoint: + +```http +/features/streaming-analytics.messaging +``` + +To toggle the `streaming-analytics.messaging` feature flag for the current tenant, make a `PUT` request to this endpoint: + +```http +/features/streaming-analytics.messaging/by-tenant +``` + +To toggle the `streaming-analytics.messaging` feature flag for the specified tenant ID, make a `PUT` request to this endpoint: + +```http +/features/streaming-analytics.messaging/by-tenant/{tenant-id} +``` + +Keep in mind that you must also resubscribe the microservice to pick up changes to the feature flag. diff --git a/content/streaming-analytics/epl-apps-bundle/basic-functionality.md b/content/streaming-analytics/epl-apps-bundle/basic-functionality.md index 1b6f785ee7..fd87457fe1 100644 --- a/content/streaming-analytics/epl-apps-bundle/basic-functionality.md +++ b/content/streaming-analytics/epl-apps-bundle/basic-functionality.md @@ -57,7 +57,7 @@ From this page, you can: ##### Step 2 - Create an EPL app {#step-2---create-an-epl-app} Click **New EPL app** in the top menu bar. In the resulting **Create app** dialog box, enter a unique app name. -You can also enter a description which will be shown on the card that is created for the new app. Click **OK**. +You can also enter a description which will be shown on the card that is created for the new app. Click **OK**. The EPL editor appears. The EPL code for the new app already contains the typical basic event definitions and utilities that are required for working with {{< product-c8y-iot >}}. You can adapt them as required for your app. Consult the documentation and samples for more details. @@ -125,9 +125,14 @@ Exposes predefined generic events used by the HTTP client connectivity plug-in. This starts all connectivity plug-ins immediately on start up. * **HTTP Client > JSON with generic request/response event definitions**
Allows EPL apps to make HTTP calls. -* **Cumulocity IoT > Cumulocity Client**
-Exposes the {{< product-c8y-iot >}} client to EPL apps. +* **Cumulocity IoT > Cumulocity Notifications 2.0**
+Exposes the {{< product-c8y-iot >}} client to EPL apps using the Notifications 2.0 mechanism. +For general information on how to receive {{< product-c8y-iot >}} update notifications, see [Receiving update notifications](https://documentation.softwareag.com/pam/10.15.5/en/webhelp/pam-webhelp/#page/pam-webhelp%2Fco-ConApaAppToExtCom_cumulocity_receiving_update_notifications.html) in the Apama documentation. +{{< c8y-admon-info >}} +The **Cumulocity Notifications 2.0** connectivity bundle has been added for receiving notifications from {{< product-c8y-iot >}} using the Notifications 2.0 mechanism. The existing **Cumulocity Client** connectivity bundle that uses the legacy long-polling mechanism is deprecated in favor of this new bundle. In addition, it is now possible to add the **Cumulocity REST Support** connectivity bundle if you do not receive any notifications. You must only add one of these three bundles to your project. +For information on how to migrate existing Apama projects to Notifications 2.0, see [Migrating from Cumulocity Client to Cumulocity Notifications 2.0](https://documentation.softwareag.com/pam/10.15.5/en/webhelp/pam-webhelp/#page/pam-webhelp%2Fco-ApaRelNot_10155_migrate-to-notifications.html) in the Apama documentation. +{{< /c8y-admon-info >}} The bundles above are the only ones that are permissible in an EPL app, so be careful not to add any other bundles or your app may not work when activated in {{< product-c8y-iot >}}. @@ -241,6 +246,12 @@ The following permissions are required by the microservice in order to start up - ROLE_BULK_OPERATION_READ - ROLE_SMS_ADMIN +{{< c8y-admon-info>}} +To take advantage of the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications, you must also add the following permission to the manifest of the custom microservice and contact {{< product-c8y-iot >}} Operations to set the the `notification2.streaming-analytics` feature flag. + +- ROLE_NOTIFICATION_2_ADMIN +{{< /c8y-admon-info>}} + {{< c8y-admon-info >}} The above is the minimum list of permissions that a custom Apama microservice needs. If you are developing a custom microservice, you may add more permissions to the microservice manifest. {{< /c8y-admon-info >}} From 1321eaa3e2696b3c489edaf0c9e8cb471d48f59c Mon Sep 17 00:00:00 2001 From: Karin Olivier Date: Mon, 2 Sep 2024 16:41:31 +0200 Subject: [PATCH 02/17] Doc changes after getting feedback from Bevan. Hope I got it right. --- .../microservice-permissions.md | 5 ----- .../analytics-customization-bundle/notifications.md | 4 +++- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/content/streaming-analytics/analytics-customization-bundle/microservice-permissions.md b/content/streaming-analytics/analytics-customization-bundle/microservice-permissions.md index 4cd503b298..abb6385579 100644 --- a/content/streaming-analytics/analytics-customization-bundle/microservice-permissions.md +++ b/content/streaming-analytics/analytics-customization-bundle/microservice-permissions.md @@ -37,11 +37,6 @@ The manifest also specifies the permissions with which the microservice runs. Th - ROLE_TENANT_MANAGEMENT_READ - ROLE_BULK_OPERATION_ADMIN - ROLE_BULK_OPERATION_READ - -{{< c8y-admon-info>}} -To take advantage of the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications, you must also add the following permission to the manifest of the Apama-ctrl microservice and contact {{< product-c8y-iot >}} Operations to set the the `notification2.streaming-analytics` feature flag. - - ROLE_NOTIFICATION_2_ADMIN -{{< /c8y-admon-info>}} You can add other roles to this list (or remove them from it) to grant (or remove) permissions to EPL code. diff --git a/content/streaming-analytics/analytics-customization-bundle/notifications.md b/content/streaming-analytics/analytics-customization-bundle/notifications.md index 800e3fcc5a..962637c38c 100644 --- a/content/streaming-analytics/analytics-customization-bundle/notifications.md +++ b/content/streaming-analytics/analytics-customization-bundle/notifications.md @@ -18,10 +18,12 @@ The availability of this feature is governed by two feature flags: If you are using either a custom microservice or an Apama project, it is not necessary to use the `streaming-analytics.messaging` feature flag. Using this flag does not change anything for a custom microservice or Apama project. See also the description of the **Cumulocity Notifications 2.0** bundle in [Step 3 - Add Apama bundles to the project](/streaming-analytics/epl-apps/#step-3---add-apama-bundles-to-the-project). {{< /c8y-admon-info>}} -Once the required feature flags have been activated, whatever microservice you are using, you must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. For more information, see [Modifying microservice permissions and resource usage](/streaming-analytics/analytics-customization/#microservice-permissions) for the Apama-ctrl microservices and [Required settings in the microservice manifest](/streaming-analytics/epl-apps/#required-settings-in-the-microservice-manifest) for custom microservices. +If you are using a custom microservice, you must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest once the `notification2.streaming-analytics` feature flag has been activated; see also [Required settings in the microservice manifest](/streaming-analytics/epl-apps/#required-settings-in-the-microservice-manifest). +For the Apama-ctrl microservices, it is not required to add this permission manually as it is set as the default; see also [Modifying microservice permissions and resource usage](/streaming-analytics/analytics-customization/#microservice-permissions). ### Toggling the streaming-analytics.messaging feature flag using the REST API + If you are using one of the standard Apama-ctrl microservices, you must also set the `streaming-analytics.messaging` flag to activate how the microservice receives notifications. You do this using the REST API as shown below. To find all existing feature toggles for the current tenant, together with their values, make a `GET` request to this endpoint: From eb9fcc52a8940c317e6e9e7d5c179f938c1e463a Mon Sep 17 00:00:00 2001 From: Karin Olivier Date: Mon, 2 Sep 2024 17:50:38 +0200 Subject: [PATCH 03/17] Removed Apama-ctrl - no need to add the permission. --- .../analytics/apama-in-c8y-20240902-Notifications-2.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md index 45be6e461b..49c1149f5d 100644 --- a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md +++ b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md @@ -14,4 +14,4 @@ build_artifact: ticket: PAB-4250 version: --- -Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. This feature is currently in private preview, so to take advantage of it, you must contact {{< product-c8y-iot >}} Operations to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice also need to toggle the `streaming-analytics.messaging` feature flag. All users of both Apama-ctrl and custom microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of external Apama deployments must add the new **Cumulocity Notifications 2.0** bundle to their Apama projects. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). +Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. This feature is currently in private preview, so to take advantage of it, you must contact {{< product-c8y-iot >}} Operations to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice must also toggle the `streaming-analytics.messaging` feature flag. Users of custom microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of external Apama deployments must add the new **Cumulocity Notifications 2.0** bundle to their Apama projects. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). From 407ebfbc7bd5cee2397ad3decb1fca421fca3f47 Mon Sep 17 00:00:00 2001 From: Karin Olivier Date: Tue, 3 Sep 2024 13:37:15 +0200 Subject: [PATCH 04/17] Changed "Operations" to "product support" with a link. Also added some more shortcodes. --- .../analytics/apama-in-c8y-20240902-Notifications-2.0.md | 4 ++-- .../analytics-customization-bundle/notifications.md | 4 ++-- .../epl-apps-bundle/basic-functionality.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md index 49c1149f5d..7cb4f04de5 100644 --- a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md +++ b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md @@ -1,5 +1,5 @@ --- -date: +date: title: Streaming Analytics and Notifications 2.0 change_type: - value: change-QHu1GdukP @@ -14,4 +14,4 @@ build_artifact: ticket: PAB-4250 version: --- -Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. This feature is currently in private preview, so to take advantage of it, you must contact {{< product-c8y-iot >}} Operations to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice must also toggle the `streaming-analytics.messaging` feature flag. Users of custom microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of external Apama deployments must add the new **Cumulocity Notifications 2.0** bundle to their Apama projects. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). +Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. This feature is currently in private preview, so to take advantage of it, you must contact [product support](/additional-resources/contacting-support/) to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice must also toggle the `streaming-analytics.messaging` feature flag. Users of custom microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of external Apama deployments must add the new **Cumulocity Notifications 2.0** bundle to their Apama projects. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). diff --git a/content/streaming-analytics/analytics-customization-bundle/notifications.md b/content/streaming-analytics/analytics-customization-bundle/notifications.md index 962637c38c..30dd192d56 100644 --- a/content/streaming-analytics/analytics-customization-bundle/notifications.md +++ b/content/streaming-analytics/analytics-customization-bundle/notifications.md @@ -3,12 +3,12 @@ weight: 40 title: Configuration requirements for Notifications 2.0 layout: redirect --- -Streaming Analytics can use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. For more information, see [About Notifications 2.0](https://www.cumulocity.com/api/core/#tag/About-notifications-2.0) in the {{< openapi >}}. +Streaming Analytics can use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. For more information, see [About Notifications 2.0](https://{{< domain-c8y >}}/api/core/#tag/About-notifications-2.0) in the {{< openapi >}}. The availability of this feature is governed by two feature flags: - `notification2.streaming-analytics`
- The {{< product-c8y-iot >}} Notifications 2.0 feature is currently in private preview. If you want to have it enabled for your tenant, you must contact {{< product-c8y-iot >}} Operations to set this feature flag. + The {{< product-c8y-iot >}} Notifications 2.0 feature is currently in private preview. If you want to have it enabled for your tenant, you must contact [product support](/additional-resources/contacting-support/) to set this feature flag. - `streaming-analytics.messaging`
In addition to this, if you are using one of the variants of the Apama-ctrl microservice, you must also set this feature flag. You then need to resubscribe the Apama-ctrl microservice to pick up changes to the feature flag. diff --git a/content/streaming-analytics/epl-apps-bundle/basic-functionality.md b/content/streaming-analytics/epl-apps-bundle/basic-functionality.md index fd87457fe1..b86fbd111f 100644 --- a/content/streaming-analytics/epl-apps-bundle/basic-functionality.md +++ b/content/streaming-analytics/epl-apps-bundle/basic-functionality.md @@ -127,11 +127,11 @@ This starts all connectivity plug-ins immediately on start up. Allows EPL apps to make HTTP calls. * **Cumulocity IoT > Cumulocity Notifications 2.0**
Exposes the {{< product-c8y-iot >}} client to EPL apps using the Notifications 2.0 mechanism. -For general information on how to receive {{< product-c8y-iot >}} update notifications, see [Receiving update notifications](https://documentation.softwareag.com/pam/10.15.5/en/webhelp/pam-webhelp/#page/pam-webhelp%2Fco-ConApaAppToExtCom_cumulocity_receiving_update_notifications.html) in the Apama documentation. +For general information on how to receive {{< product-c8y-iot >}} update notifications, see [Receiving update notifications]({{< link-apama-webhelp >}}index.html#page/pam-webhelp%2Fco-ConApaAppToExtCom_cumulocity_receiving_update_notifications.html) in the Apama documentation. {{< c8y-admon-info >}} The **Cumulocity Notifications 2.0** connectivity bundle has been added for receiving notifications from {{< product-c8y-iot >}} using the Notifications 2.0 mechanism. The existing **Cumulocity Client** connectivity bundle that uses the legacy long-polling mechanism is deprecated in favor of this new bundle. In addition, it is now possible to add the **Cumulocity REST Support** connectivity bundle if you do not receive any notifications. You must only add one of these three bundles to your project. -For information on how to migrate existing Apama projects to Notifications 2.0, see [Migrating from Cumulocity Client to Cumulocity Notifications 2.0](https://documentation.softwareag.com/pam/10.15.5/en/webhelp/pam-webhelp/#page/pam-webhelp%2Fco-ApaRelNot_10155_migrate-to-notifications.html) in the Apama documentation. +For information on how to migrate existing Apama projects to Notifications 2.0, see [Migrating from Cumulocity Client to Cumulocity Notifications 2.0]({{< link-apama-webhelp >}}index.html#page/pam-webhelp%2Fco-ApaRelNot_10155_migrate-to-notifications.html) in the Apama documentation. {{< /c8y-admon-info >}} The bundles above are the only ones that are permissible in an EPL app, so be careful not to add any other bundles or your app may not work when activated in {{< product-c8y-iot >}}. From 9e3e1337c7c28375a6299f37b3e4023c6a253fc4 Mon Sep 17 00:00:00 2001 From: Karin Olivier Date: Wed, 4 Sep 2024 08:37:19 +0200 Subject: [PATCH 05/17] Updated change log for Notifications 2.0. with a "why". --- .../analytics/apama-in-c8y-20240902-Notifications-2.0.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md index 7cb4f04de5..49663202d0 100644 --- a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md +++ b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md @@ -14,4 +14,10 @@ build_artifact: ticket: PAB-4250 version: --- -Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. This feature is currently in private preview, so to take advantage of it, you must contact [product support](/additional-resources/contacting-support/) to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice must also toggle the `streaming-analytics.messaging` feature flag. Users of custom microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of external Apama deployments must add the new **Cumulocity Notifications 2.0** bundle to their Apama projects. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). +Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. + +The benefits of using Notifications 2.0 are improved performance and reliability for messaging with Streaming Analytics applications such as smart rules, Analytics Builder and EPL apps. In particular, Apama EPL projects that remotely connect to Cumulocity IoT via the long-polling interface will benefit from improved robustness when migrating to Notifications 2.0. + +Streaming Analytics will eventually migrate all tenants to use Notifications 2.0, and some customers may choose to start migrating now. This change is intended to provide improved performance, reliability and resilience in planned future enhancements to Streaming Analytics. + +This feature is currently in private preview. To take advantage of it, you must contact [product support](/additional-resources/contacting-support/) to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice must also toggle the `streaming-analytics.messaging` feature flag. Users of custom microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of external Apama deployments must add the new **Cumulocity Notifications 2.0** bundle to their Apama projects. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). From c5bf3e92d18d3bae1e1deb6e67e14a3f4a0eff3d Mon Sep 17 00:00:00 2001 From: Karin Olivier Date: Wed, 4 Sep 2024 12:07:04 +0200 Subject: [PATCH 06/17] Two small changes from Rob (PAB-4250) --- .../analytics/apama-in-c8y-20240902-Notifications-2.0.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md index 49663202d0..847a1fc7fa 100644 --- a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md +++ b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md @@ -1,5 +1,5 @@ --- -date: +date: title: Streaming Analytics and Notifications 2.0 change_type: - value: change-QHu1GdukP @@ -16,8 +16,8 @@ version: --- Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. -The benefits of using Notifications 2.0 are improved performance and reliability for messaging with Streaming Analytics applications such as smart rules, Analytics Builder and EPL apps. In particular, Apama EPL projects that remotely connect to Cumulocity IoT via the long-polling interface will benefit from improved robustness when migrating to Notifications 2.0. +The benefits of using Notifications 2.0 are improved performance and reliability for messaging with Streaming Analytics applications such as smart rules, Analytics Builder and EPL apps. In particular, Apama EPL projects that remotely connect to Cumulocity IoT via the long-polling interface will benefit from improved robustness after migrating to Notifications 2.0. -Streaming Analytics will eventually migrate all tenants to use Notifications 2.0, and some customers may choose to start migrating now. This change is intended to provide improved performance, reliability and resilience in planned future enhancements to Streaming Analytics. +Streaming Analytics intends to migrate all tenants to use Notifications 2.0, and some customers may choose to start migrating now. This change is intended to provide improved performance, reliability and resilience in planned future enhancements to Streaming Analytics. This feature is currently in private preview. To take advantage of it, you must contact [product support](/additional-resources/contacting-support/) to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice must also toggle the `streaming-analytics.messaging` feature flag. Users of custom microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of external Apama deployments must add the new **Cumulocity Notifications 2.0** bundle to their Apama projects. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). From 0b86570764e837e1751c6c0b6ab154763aeb6dad Mon Sep 17 00:00:00 2001 From: Karin Olivier <73836699+kailol-sag@users.noreply.github.com> Date: Wed, 4 Sep 2024 15:49:55 +0200 Subject: [PATCH 07/17] Update content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md Co-authored-by: Sandeep Komarneni <87428699+skom-c8y@users.noreply.github.com> --- .../analytics/apama-in-c8y-20240902-Notifications-2.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md index 847a1fc7fa..f8d5ad019c 100644 --- a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md +++ b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md @@ -14,7 +14,7 @@ build_artifact: ticket: PAB-4250 version: --- -Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. +Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive notifications for measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. The benefits of using Notifications 2.0 are improved performance and reliability for messaging with Streaming Analytics applications such as smart rules, Analytics Builder and EPL apps. In particular, Apama EPL projects that remotely connect to Cumulocity IoT via the long-polling interface will benefit from improved robustness after migrating to Notifications 2.0. From 2e42fd25a0f08f5256da096895e28d3bce4d5f49 Mon Sep 17 00:00:00 2001 From: Karin Olivier <73836699+kailol-sag@users.noreply.github.com> Date: Wed, 4 Sep 2024 15:50:41 +0200 Subject: [PATCH 08/17] Update content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md Co-authored-by: Sandeep Komarneni <87428699+skom-c8y@users.noreply.github.com> --- .../analytics/apama-in-c8y-20240902-Notifications-2.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md index f8d5ad019c..53781df74d 100644 --- a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md +++ b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md @@ -20,4 +20,4 @@ The benefits of using Notifications 2.0 are improved performance and reliability Streaming Analytics intends to migrate all tenants to use Notifications 2.0, and some customers may choose to start migrating now. This change is intended to provide improved performance, reliability and resilience in planned future enhancements to Streaming Analytics. -This feature is currently in private preview. To take advantage of it, you must contact [product support](/additional-resources/contacting-support/) to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice must also toggle the `streaming-analytics.messaging` feature flag. Users of custom microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of external Apama deployments must add the new **Cumulocity Notifications 2.0** bundle to their Apama projects. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). +This feature is currently in private preview. To take advantage of it, you must contact [product support](/additional-resources/contacting-support/) to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice must also toggle the `streaming-analytics.messaging` feature flag. Users of custom Apama microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of custom Apama EPL projects must also add the new **Cumulocity Notifications 2.0** bundle. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). From 1ed226341e126760f267afde22cafb82012747c1 Mon Sep 17 00:00:00 2001 From: Karin Olivier <73836699+kailol-sag@users.noreply.github.com> Date: Wed, 4 Sep 2024 15:51:04 +0200 Subject: [PATCH 09/17] Update content/streaming-analytics/analytics-customization-bundle/notifications.md Co-authored-by: Sandeep Komarneni <87428699+skom-c8y@users.noreply.github.com> --- .../analytics-customization-bundle/notifications.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/streaming-analytics/analytics-customization-bundle/notifications.md b/content/streaming-analytics/analytics-customization-bundle/notifications.md index 30dd192d56..39ccbe0aac 100644 --- a/content/streaming-analytics/analytics-customization-bundle/notifications.md +++ b/content/streaming-analytics/analytics-customization-bundle/notifications.md @@ -3,7 +3,7 @@ weight: 40 title: Configuration requirements for Notifications 2.0 layout: redirect --- -Streaming Analytics can use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications on new measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. For more information, see [About Notifications 2.0](https://{{< domain-c8y >}}/api/core/#tag/About-notifications-2.0) in the {{< openapi >}}. +Streaming Analytics can use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive notifications for measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. For more information, see [About Notifications 2.0](https://{{< domain-c8y >}}/api/core/#tag/About-notifications-2.0) in the {{< openapi >}}. The availability of this feature is governed by two feature flags: From 55f8d64ee5392df502c3653493d2cc7c5c146019 Mon Sep 17 00:00:00 2001 From: Karin Olivier <73836699+kailol-sag@users.noreply.github.com> Date: Wed, 4 Sep 2024 15:51:49 +0200 Subject: [PATCH 10/17] Update content/streaming-analytics/epl-apps-bundle/basic-functionality.md Co-authored-by: Sandeep Komarneni <87428699+skom-c8y@users.noreply.github.com> --- .../streaming-analytics/epl-apps-bundle/basic-functionality.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/streaming-analytics/epl-apps-bundle/basic-functionality.md b/content/streaming-analytics/epl-apps-bundle/basic-functionality.md index b86fbd111f..1f665df9ec 100644 --- a/content/streaming-analytics/epl-apps-bundle/basic-functionality.md +++ b/content/streaming-analytics/epl-apps-bundle/basic-functionality.md @@ -247,7 +247,7 @@ The following permissions are required by the microservice in order to start up - ROLE_SMS_ADMIN {{< c8y-admon-info>}} -To take advantage of the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive update notifications, you must also add the following permission to the manifest of the custom microservice and contact {{< product-c8y-iot >}} Operations to set the the `notification2.streaming-analytics` feature flag. +To take advantage of the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive notifications, you must also add the following permission to the manifest of the custom microservice and contact {{< product-c8y-iot >}} Operations to set the the `notification2.streaming-analytics` feature flag. - ROLE_NOTIFICATION_2_ADMIN {{< /c8y-admon-info>}} From 360a4fb98328f0711f221f789727d14d420e87f9 Mon Sep 17 00:00:00 2001 From: Karin Olivier Date: Wed, 4 Sep 2024 16:02:19 +0200 Subject: [PATCH 11/17] One more "Operations" that I missed to change to "product support". --- .../streaming-analytics/epl-apps-bundle/basic-functionality.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/streaming-analytics/epl-apps-bundle/basic-functionality.md b/content/streaming-analytics/epl-apps-bundle/basic-functionality.md index 1f665df9ec..0e2a65ccc5 100644 --- a/content/streaming-analytics/epl-apps-bundle/basic-functionality.md +++ b/content/streaming-analytics/epl-apps-bundle/basic-functionality.md @@ -247,7 +247,7 @@ The following permissions are required by the microservice in order to start up - ROLE_SMS_ADMIN {{< c8y-admon-info>}} -To take advantage of the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive notifications, you must also add the following permission to the manifest of the custom microservice and contact {{< product-c8y-iot >}} Operations to set the the `notification2.streaming-analytics` feature flag. +To take advantage of the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive notifications, you must also add the following permission to the manifest of the custom microservice and contact [product support](/additional-resources/contacting-support/) to set the the `notification2.streaming-analytics` feature flag. - ROLE_NOTIFICATION_2_ADMIN {{< /c8y-admon-info>}} From de32d27a5e4f91010ae2fd233c8dd9a7ab181668 Mon Sep 17 00:00:00 2001 From: Karin Olivier Date: Wed, 4 Sep 2024 16:09:08 +0200 Subject: [PATCH 12/17] Moved sentence on Apama EPL projects as suggested by Sandeep. --- .../analytics/apama-in-c8y-20240902-Notifications-2.0.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md index 53781df74d..2ddf796b89 100644 --- a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md +++ b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md @@ -14,10 +14,8 @@ build_artifact: ticket: PAB-4250 version: --- -Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive notifications for measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. - -The benefits of using Notifications 2.0 are improved performance and reliability for messaging with Streaming Analytics applications such as smart rules, Analytics Builder and EPL apps. In particular, Apama EPL projects that remotely connect to Cumulocity IoT via the long-polling interface will benefit from improved robustness after migrating to Notifications 2.0. +Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive notifications for measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. The benefits of using Notifications 2.0 are improved performance and reliability for messaging with Streaming Analytics applications such as smart rules, Analytics Builder and EPL apps. Streaming Analytics intends to migrate all tenants to use Notifications 2.0, and some customers may choose to start migrating now. This change is intended to provide improved performance, reliability and resilience in planned future enhancements to Streaming Analytics. -This feature is currently in private preview. To take advantage of it, you must contact [product support](/additional-resources/contacting-support/) to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice must also toggle the `streaming-analytics.messaging` feature flag. Users of custom Apama microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of custom Apama EPL projects must also add the new **Cumulocity Notifications 2.0** bundle. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). +This feature is currently in private preview. To take advantage of it, you must contact [product support](/additional-resources/contacting-support/) to set the `notification2.streaming-analytics` feature flag. In addition, users of any of the variants of the Apama-ctrl microservice must also toggle the `streaming-analytics.messaging` feature flag. Users of custom Apama microservices must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest. Users of custom Apama EPL projects must also add the new **Cumulocity Notifications 2.0** bundle. Apama EPL projects that remotely connect to Cumulocity IoT via the long-polling interface will benefit from improved robustness after migrating to Notifications 2.0. For more information, including how to toggle the feature flags, see [Configuration requirements for Notifications 2.0](/streaming-analytics/analytics-customization/#notifications). From 1326ace40d99eb091c0aef7068fd8c9534dafd62 Mon Sep 17 00:00:00 2001 From: Karin Olivier Date: Thu, 5 Sep 2024 11:46:50 +0200 Subject: [PATCH 13/17] Removed info as suggested by Sandeep. --- .../analytics-customization-bundle/notifications.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/content/streaming-analytics/analytics-customization-bundle/notifications.md b/content/streaming-analytics/analytics-customization-bundle/notifications.md index 39ccbe0aac..d9861cc6e0 100644 --- a/content/streaming-analytics/analytics-customization-bundle/notifications.md +++ b/content/streaming-analytics/analytics-customization-bundle/notifications.md @@ -14,10 +14,6 @@ The availability of this feature is governed by two feature flags: In addition to this, if you are using one of the variants of the Apama-ctrl microservice, you must also set this feature flag. You then need to resubscribe the Apama-ctrl microservice to pick up changes to the feature flag. -{{< c8y-admon-info>}} -If you are using either a custom microservice or an Apama project, it is not necessary to use the `streaming-analytics.messaging` feature flag. Using this flag does not change anything for a custom microservice or Apama project. See also the description of the **Cumulocity Notifications 2.0** bundle in [Step 3 - Add Apama bundles to the project](/streaming-analytics/epl-apps/#step-3---add-apama-bundles-to-the-project). -{{< /c8y-admon-info>}} - If you are using a custom microservice, you must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest once the `notification2.streaming-analytics` feature flag has been activated; see also [Required settings in the microservice manifest](/streaming-analytics/epl-apps/#required-settings-in-the-microservice-manifest). For the Apama-ctrl microservices, it is not required to add this permission manually as it is set as the default; see also [Modifying microservice permissions and resource usage](/streaming-analytics/analytics-customization/#microservice-permissions). From d0177c2d1ef7f1b1057c6e349557996a3ec997a4 Mon Sep 17 00:00:00 2001 From: Bevan Philip <93782708+bph-sag@users.noreply.github.com> Date: Tue, 22 Oct 2024 15:30:29 +0100 Subject: [PATCH 14/17] Remove most of the feature flag doc --- .../notifications.md | 32 ++----------------- 1 file changed, 3 insertions(+), 29 deletions(-) diff --git a/content/streaming-analytics/analytics-customization-bundle/notifications.md b/content/streaming-analytics/analytics-customization-bundle/notifications.md index d9861cc6e0..ca7072cde3 100644 --- a/content/streaming-analytics/analytics-customization-bundle/notifications.md +++ b/content/streaming-analytics/analytics-customization-bundle/notifications.md @@ -12,38 +12,12 @@ The availability of this feature is governed by two feature flags: - `streaming-analytics.messaging`
In addition to this, if you are using one of the variants of the Apama-ctrl microservice, you must also set this feature flag. You then need to resubscribe the Apama-ctrl microservice to pick up changes to the feature flag. + Use the [feature toggles REST API](https://{{< domain-c8y >}}/api/core/{{< docs-version >}}/#tag/Feature-toggles-API) to do so. If you are using a custom microservice, you must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest once the `notification2.streaming-analytics` feature flag has been activated; see also [Required settings in the microservice manifest](/streaming-analytics/epl-apps/#required-settings-in-the-microservice-manifest). For the Apama-ctrl microservices, it is not required to add this permission manually as it is set as the default; see also [Modifying microservice permissions and resource usage](/streaming-analytics/analytics-customization/#microservice-permissions). -### Toggling the streaming-analytics.messaging feature flag using the REST API - - -If you are using one of the standard Apama-ctrl microservices, you must also set the `streaming-analytics.messaging` flag to activate how the microservice receives notifications. You do this using the REST API as shown below. - -To find all existing feature toggles for the current tenant, together with their values, make a `GET` request to this endpoint: - -```http -/features -``` - -To find out the existing feature toggle for the `streaming-analytics.messaging` feature flag for the current tenant, make a `GET` request to this endpoint: - -```http -/features/streaming-analytics.messaging -``` - -To toggle the `streaming-analytics.messaging` feature flag for the current tenant, make a `PUT` request to this endpoint: - -```http -/features/streaming-analytics.messaging/by-tenant -``` - -To toggle the `streaming-analytics.messaging` feature flag for the specified tenant ID, make a `PUT` request to this endpoint: - -```http -/features/streaming-analytics.messaging/by-tenant/{tenant-id} -``` - +{{< c8y-admon-info >}} Keep in mind that you must also resubscribe the microservice to pick up changes to the feature flag. +{{< /c8y-admon-info >}} From 933580c5d3a406ded4472926eeed7bba0c2678c8 Mon Sep 17 00:00:00 2001 From: Karin Olivier Date: Thu, 24 Oct 2024 16:06:53 +0200 Subject: [PATCH 15/17] Removed the invalid docs-version shortcode. Reworded a bit and added the openapi shortcode. --- .../analytics-customization-bundle/notifications.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/streaming-analytics/analytics-customization-bundle/notifications.md b/content/streaming-analytics/analytics-customization-bundle/notifications.md index ca7072cde3..ed42e0854c 100644 --- a/content/streaming-analytics/analytics-customization-bundle/notifications.md +++ b/content/streaming-analytics/analytics-customization-bundle/notifications.md @@ -12,7 +12,7 @@ The availability of this feature is governed by two feature flags: - `streaming-analytics.messaging`
In addition to this, if you are using one of the variants of the Apama-ctrl microservice, you must also set this feature flag. You then need to resubscribe the Apama-ctrl microservice to pick up changes to the feature flag. - Use the [feature toggles REST API](https://{{< domain-c8y >}}/api/core/{{< docs-version >}}/#tag/Feature-toggles-API) to do so. + Use the feature toggles REST API to do so; see [Feature toggles API](https://{{< domain-c8y >}}/api/core/#tag/Feature-toggles-API) in the {{< openapi >}}. If you are using a custom microservice, you must also add the `ROLE_NOTIFICATION_2_ADMIN` permission to the microservice manifest once the `notification2.streaming-analytics` feature flag has been activated; see also [Required settings in the microservice manifest](/streaming-analytics/epl-apps/#required-settings-in-the-microservice-manifest). From 62ee3dfbd5a9e765579a0e02d79439d04b8e8f7e Mon Sep 17 00:00:00 2001 From: Bevan Philip Date: Tue, 7 Jan 2025 15:59:44 +0000 Subject: [PATCH 16/17] Update links to new doc system --- .../epl-apps-bundle/basic-functionality.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/streaming-analytics/epl-apps-bundle/basic-functionality.md b/content/streaming-analytics/epl-apps-bundle/basic-functionality.md index 1fa68eccec..747fd7a3ab 100644 --- a/content/streaming-analytics/epl-apps-bundle/basic-functionality.md +++ b/content/streaming-analytics/epl-apps-bundle/basic-functionality.md @@ -127,11 +127,11 @@ This starts all connectivity plug-ins immediately on start up. Allows EPL apps to make HTTP calls. * **Cumulocity IoT > Cumulocity Notifications 2.0**
Exposes the {{< product-c8y-iot >}} client to EPL apps using the Notifications 2.0 mechanism. -For general information on how to receive {{< product-c8y-iot >}} update notifications, see [Receiving update notifications]({{< link-apama-webhelp >}}index.html#page/pam-webhelp%2Fco-ConApaAppToExtCom_cumulocity_receiving_update_notifications.html) in the Apama documentation. +For general information on how to receive {{< product-c8y-iot >}} update notifications, see [Receiving update notifications]({{< link-apama-webhelp >}}/standard-connectivity-plugins/the-cumulocity-iot-transport-connectivity-plug-in#receiving-update-notifications) in the Apama documentation. {{< c8y-admon-info >}} The **Cumulocity Notifications 2.0** connectivity bundle has been added for receiving notifications from {{< product-c8y-iot >}} using the Notifications 2.0 mechanism. The existing **Cumulocity Client** connectivity bundle that uses the legacy long-polling mechanism is deprecated in favor of this new bundle. In addition, it is now possible to add the **Cumulocity REST Support** connectivity bundle if you do not receive any notifications. You must only add one of these three bundles to your project. -For information on how to migrate existing Apama projects to Notifications 2.0, see [Migrating from Cumulocity Client to Cumulocity Notifications 2.0]({{< link-apama-webhelp >}}index.html#page/pam-webhelp%2Fco-ApaRelNot_10155_migrate-to-notifications.html) in the Apama documentation. +For information on how to migrate existing Apama projects to Notifications 2.0, see [Migrating from Cumulocity Client to Cumulocity Notifications 2.0]({{< link-apama-webhelp >}}/change-logs/#10.15/cumulocity-10155-clientbundledeprecated) in the Apama documentation. {{< /c8y-admon-info >}} The bundles above are the only ones that are permissible in an EPL app, so be careful not to add any other bundles or your app may not work when activated in {{< product-c8y-iot >}}. From 1ed59a11cc9709efb4cdcf1010197dc5bfd898bd Mon Sep 17 00:00:00 2001 From: Bevan Philip <93782708+bph-c8y@users.noreply.github.com> Date: Tue, 7 Jan 2025 16:09:37 +0000 Subject: [PATCH 17/17] Add dates to change log entry I just picked the latest zone-3 deployment, and deployment date. --- .../analytics/apama-in-c8y-20240902-Notifications-2.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md index 2ddf796b89..9a838c8af8 100644 --- a/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md +++ b/content/change-logs/analytics/apama-in-c8y-20240902-Notifications-2.0.md @@ -1,5 +1,5 @@ --- -date: +date: 2025-01-07 title: Streaming Analytics and Notifications 2.0 change_type: - value: change-QHu1GdukP @@ -12,7 +12,7 @@ build_artifact: - value: tc-KXXmo2SUR label: apama-in-c8y ticket: PAB-4250 -version: +version: 25.339.0 --- Streaming Analytics can now use the {{< product-c8y-iot >}} Notifications 2.0 reliable data forwarding capability to receive notifications for measurements, events, alarms, managed objects and operations that are processed by the {{< product-c8y-iot >}} platform. The benefits of using Notifications 2.0 are improved performance and reliability for messaging with Streaming Analytics applications such as smart rules, Analytics Builder and EPL apps.