Streaming Analytics

Release 10.7.0.32

This release upgrades the Apama-ctrl microservice to use Apama 10.5.4.8 (which is the same as Apama 10.5.0 Fix 29).

Fixes

Component	Description	Issue
Apama-ctrl microservice	Spring Framework has been upgraded to 5.2.20 to resolve security vulnerabilities CVE-2022-22965.	PAB-3091

Release 10.7.0.31

This release upgrades the Apama-ctrl microservice to use Apama 10.5.4.6 (which is the same as Apama 10.5.0 Fix 27).

Fixes

Component	Description	Issue
Apama-ctrl microservice	Apache Log4j inside all variants of the Apama-ctrl microservice has been upgraded to version 2.17.1 to resolve security vulnerabilities CVE-2021-44832 and CVE-2021-45105.	PAB-2983

Release 10.7.0.30

This release upgrades the Apama-ctrl microservice to use Apama 10.5.4.5 (which is the same as Apama 10.5.0 Fix 26).

Fixes

Component	Description	Issue
Apama-ctrl microservice	Apache Log4j inside all variants of the Apama-ctrl microservice has been upgraded to version 2.16.0 to resolve security vulnerabilities CVE-2021-44228 and CVE-2021-45046.	PAB-2926
Apama-ctrl microservice	Startup of the Apama-ctrl microservice for tenants with many devices could be slow, which resulted in the hosting platform to assume the instance to be unhealthy and therefore to restart it. The startup time has now been improved by moving expensive queries out of the critical path.	PAB-2829

Release 10.7.0.29

Fixes

Component	Description	Issue
Apama-ctrl microservice	Microservices migrating from version 10.6.6.26 or lower could experience null pointer exceptions in the microservice log files, and a failure to start upon upgrade. This was caused by attempting to read a value from a field that had not existed prior to this version. The microservice will now set default values and not attempt to read the field if it does not exist.	PAB-2702

Release 10.7.0.28

This release upgrades the Apama-ctrl microservice to use Apama 10.5.4.4 (which is the same as Apama 10.5.0 Fix 25).

Fixes

Component	Description	Issue
Smart rules and EPL apps	When sending SMS from EPL apps or smart rules, sender or recipient addresses with the protocol identifier "tel" were being incorrectly rejected. This has now been resolved.	PAB-2696
Apama-ctrl microservice	Startup of the Apama-ctrl microservice for tenants with many devices could be slow and consume excessive memory. This has now been resolved.	PAB-2634

Release 10.7.0.27

Fixes

Component	Description	Issue
Apama-ctrl microservice	A defect existed in which safe mode was sometimes incorrectly triggered after a platform upgrade, resulting in all user EPL, analytic models and extensions being disabled. This has now been resolved. For more information on safe mode, see Safe mode on startup in the Streaming Analytics guide.	PAB-2604

Release 10.7.0.26

Fixes

Component	Description	Issue
Apama-ctrl microservice	The `cep/events` endpoint that receives notifications from Cumulocity IoT core now uses multiple threads to process incoming notifications, which improves performance especially when using many Cumulocity IoT core nodes. The tenant option `streaminganalytics/proxy.maxParallelHttp` can be set to control how many threads will be used (the Apama-ctrl microservice will restart if this tenant option is changed).	PAB-2320
Apama-ctrl microservice	The Apama-ctrl microservice now includes the roles ROLE_BULK_OPERATION_ADMIN, ROLE_BULK_OPERATION_READ, ROLE_AUDIT_ADMIN, ROLE_AUDIT_READ, ROLE_TENANT_MANAGEMENT_READ, ROLE_USER_MANAGEMENT_OWN_READ for its service user, which means that EPL apps can make bulk operation requests, audit entries and can read tenant information and its own user information.	PAB-2494

Release 10.7.0.25

This release upgrades the Apama-ctrl microservice to use Apama 10.5.4.3 (which is the same as Apama 10.5.0 Fix 24).

Fixes

Component	Description	Issue
Analytics Builder	An issue has been resolved where a model may time out when it is activating, failing to report either success or a failure. This would affect models with a large number of blocks of certain types (mostly input and output blocks) where at least one of the blocks cause the model to fail to activate correctly.	PAB-2304
Analytics Builder	It is now possible to connect a block with an `any` output type to a block with a `float` input type. Previously, this was incorrectly flagged as an error. As with other such conversions, the type of the value is only checked at runtime. If a block actually outputs a string, this may fail if the string does not contain a number.	PAB-2360
Analytics Builder	An error is now reported on timeouts if an Analytics Builder model does not activate within a reasonable time, and further activations are no longer affected.	PAB-2386
Analytics Builder	The Expression block now supports `Value` and `any` type inputs. These are unpacked to concrete types before evaluating the expression. Note that this means that the Expression block's type checking is lenient now when it comes to these types of inputs. So even when your model passes validation, it might fail at runtime if you are trying to do unsupported operations.	PAB-2465
Apama-ctrl microservice	The measurement processing performance of the Apama-ctrl microservice was increased by reducing the number of default subscriptions to the measurement channel. This leads to less work needed to copy the measurement, leading to increased performance (approximately 20%).	PAB-2295

Release 10.7.0.23

Fixes

Component	Description	Issue
Smart rules and EPL apps	In previous releases, custom variables defined in smart rules notifications were not properly parsed and substituted. These custom variables are now substituted in the resulting notifications.	PAB-2169

Release 10.7.0.22

This release upgrades the Apama-ctrl microservice to use Apama 10.5.4.1 (which is the same as Apama 10.5.0 Fix 22).

Fixes

Component	Description	Issue
Smart rules and EPL apps	Smart rules and EPL apps now pick up the tenant options `messaging/sms.senderName` and `messaging/sms.senderAddress` to set the sender name and address values used for `SendSMS` events. In your EPL apps, you can override the tenant options by specifying `senderName` and `senderAddress` in the `extraParams` field of the `SendSMS` event. Note that the tenant options are only read when the Apama-ctrl microservice is started. If the tenant options are changed, you must restart the microservice for the new values to take effect. If these tenant options are not defined, the following system default values are used: "Apama" as the sender name and "apama" as the sender address.	PAB-2146
Smart rules and EPL apps	The Apama threshold smart rules behaved inconsistently with the Esper smart rule implementation. While the Esper implementation used inclusive matching for the upper end of the red range and the yellow range taking precedence over red, Apama did not. This issue is now resolved; this is a change of behavior for edge cases for Apama users, in order to maintain compatibility for customers migrating from Esper.	PAB-2102

Release 10.7.0

Apama correlator version

This release of Cumulocity IoT Streaming Analytics includes the Apama version 10.5.4 correlator.

Changes in the Apama-ctrl manifest

The Apama-ctrl microservice manifest now includes the ROLE_USER_MANAGEMENT_READ permission, which means that all requests from EPL apps or other components within the Apama-ctrl microservice operate with this role and thus can read user details, potentially including personal identifiable information. See also Modifying microservice permissions and resource usage and Invoking other parts of the Cumulocity IoT REST API.

Improvements in alarms generated by the Apama-ctrl microservice

The following improvements are available in this release:

smartrule_restore_failed
This is a new alarm type which is raised if a corrupt smart rule is present in the inventory and the correlator therefore fails to recover it correctly during startup. See Smart rule restore failed for more information.
apama_safe_mode
Safe mode is now enabled when the microservice has been restarted more that 2 times in the last 20 minutes. See Safe mode on startup for more information.

Improvements in Apama EPL Apps

Both Measurement and MeasurementFragment events are now always available when activating an EPL app. It is no longer required to change a tenant option for this. So your apps can choose to listen for either of these, based on your requirements. The apama.measurementFormat tenant option from previous versions is no longer supported.

Deprecated properties in updates

The properties describing the notification type (created or updated) which were previously provided in the params field of the EPL objects for managed objects, events, alarms, operations and measurements are now deprecated and will be removed in a future release. For managed objects, events, alarms and operations, a new PARAM_NOTIFICATION constant is now available instead. The value is the value of the NOTIFICATION_CREATED and NOTIFICATION_UPDATED constant values. It is recommended that EPL uses the new constant values. See also Distinguishing between update and create notifications.

Improvements in Apama Analytics Builder

The documentation for Apama Analytics Builder, including release notes, is available separately. For your convenience, the release notes from the above documentation are also given below:

It is now possible to use template models. A template model is a model in which one or more template parameters are defined. Template parameters can be bound to any number of block parameters, provided that the type of the block parameter is the same as that of the template parameter.

The following enhancements come with this new feature:
- You can switch a block’s parameter to be a template parameter and then assign a new or an existing template parameter. See Editing the parameters of a block for more information.
- A new dialog box is available for editing template parameters. See Managing template parameters for more information.
- A new instance editor is provided. The instance editor allows you to set up different instances of the same model. The blocks in each instance can then use different values for the template parameters. Each instance can be activated, deactivated, or use different run modes, independently. See Using the Instance Editor for more information.
- The model manager uses a new type of card for the template models. See The model manager user interface for more information.
  
  See also Models which explains the two types of models that can now be created: models with template parameters and (as in previous versions) models without template parameters. This topic also explains the relevant roles for the new type of model, which can be the same person or different persons: the model author and the instance maintainer.
Models can now use multiple devices in a model with the concurrency level set to more than 1. See also Model execution for different devices.
The handling of old events is more lenient now. Old events are dropped only if an event for the same timestamp or a more recent timestamp has already been processed by the model. This means that an old event might be processed by some models but dropped by other models. See also Input blocks and event timing.
For slow chains, the following status information is now published within the apama_status parameter:
- user-analyticsbuilder.slowestChain.models
- user-analyticsbuilder.slowestChain.delaySec
  
  In addition, a message is now written to the correlator log if the slowest chain is delayed by more than 1 second. See Monitoring periodic status for more information.
Activation messages are now written to the correlator log whenever the activation of a chain is started and completed. See Monitoring the model life-cycle for more information.
The version 1 API of the Apama Analytics Builder Block SDK for input and output blocks is deprecated. See the documentation at https://github.com/SoftwareAG/apama-analytics-builder-block-sdk for information on how to migrate your custom input and output blocks to the version 2 API.

Important: The new features for multiple devices in a model and more lenient handling of old events are disabled if any input and output blocks using the version 1 API of the Apama Analytics Builder Block SDK are added as extensions.
A new topic has been added which gives new users a brief overview of how to add a simple model, and how to view its output. See First steps: Creating your first model.
The Block Reference which is shown in the model editor is now also available from the documentation. The Overview of all blocks provides links to the descriptions of all the blocks in the block reference.
Apama Analytics Builder now supports branding. This means that the branding settings as described in the User guide under Branding now also apply for Apama Analytics Builder.
The appearance of several toolbar buttons in the model editor has changed. Especially the following buttons look different now: the button for changing the devices and the button for showing or hiding the grid.