Release notes

Release 10.6.6

Apama correlator version

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

Improvements in alarms generated by the Apama-ctrl microservice

The following improvements are available in this release:

New tooling for Apama EPL Apps on GitHub

Tooling to work with Apama EPL Apps has been published at https://github.com/SoftwareAG/apama-eplapps-tools. This tooling allows you to script uploads of your EPL apps and manage them for CI/CD (continuous integration and continuous delivery) use cases. It also provides extensions to the PySys test framework to allow you to simply write tests for your EPL apps and to run them automatically. For more information on PySys, see the API Reference for Python that you can access from the Apama documentation.

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:

Release 10.6.0.3

Fixes

Component Description Issue
Apama Analytics Builder In the model manager, the user was not able to set a date for simulation mode using the date picker. This has been corrected, and the user can now use the date picker to select a date. PAB-1419
Apama-ctrl microservice When the Apama-ctrl microservice entered Safe mode, it did not disable all extensions. Thus, if an extension had a syntax error, Apama-ctrl could enter a restart loop as it would fail to start. This has been corrected, and Apama-ctrl now logs all extensions that are present but not loaded due to running in Safe mode. PAB-1424

Release 10.6.0

Migration notes

If you have an on-premises installation of Cumulocity IoT (instead of using the cloud) and you upgrade Cumulocity IoT to 10.6.0, you must also upgrade the Apama-ctrl microservice from earlier versions to 10.6.0. This is mandatory due to a change in the communication protocol between Cumulocity IoT and Apama. Earlier versions of the Apama-ctrl microservice will not function correctly if running in Cumulocity IoT 10.6.0.

Improvements in Apama EPL Apps

Some events have been added to the Apama Cumulocity IoT API to allow easy retrieval of information in some predefined areas.

In EPL, you can now receive a response for the creation or update of the predefined types (Alarm, Operation, Event, Measurement, MeasurementFragment and ManagedObject) by using the newly added withResponse action. Headers can now be set on the request, for example to determine the processing mode within Cumulocity IoT. For further information, see for example Sending alarms requesting response and setting headers in the Apama documentation.

It is now possible to listen for individual measurement fragments in EPL, rather than having to listen for and dissect entire measurements. For detailed information, see Measurement fragments.

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:

Fixes

Component Description Issue
Apama Analytics Builder Within the block parameter editor, the error message displayed when the Zementis microservice has no models has been changed from saying that the Zementis microservice is unavailable to saying that the Zementis microservice has no models. PAB-1250

Release 10.5.7

Improvements in Apama EPL Apps and Apama Analytics Builder

Apama EPL Apps and Apama Analytics Builder now include diagnostic links in the UI that allow developers to download snapshots (ZIP files) of the current microservice status to help with debugging. The diagnostic snapshot contains recent microservice log entries, Apama-internal diagnostics information, a copy of all EPL apps, smart rules and Analytics Builder models, a copy of any alarms that the microservice has raised, CPU profiling, environment information (tenant details, environment variables) and version numbers of the components. For detailed information, see Troubleshooting and diagnostics in the Streaming Analytics guide.

The following example screenshot shows the two new diagnostics links at the bottom of the Apama EPL Apps starting page, one for downloading basic diagnostics information and another for downloading enhanced (more resource-intensive) diagnostics information:

EPL editor

The following example screenshot shows the contents of the downloaded ZIP file for the basic diagnostics:

EPL editor

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:

Release 10.5.0.3

Fixes

Component Description Issue
Apama-ctrl microservice Apama applications would not function correctly when the logged-in user is logged in via OAuth. This would most commonly occur with users logging in via Software AG Cloud. This problem has now been resolved. PAB-933
Apama Analytics Builder A simpler mechanism is now used to stop simulation playback. This should prevent intermittent problems when starting models in simulation mode shortly after stopping a simulation. PAB-953

Release 10.5.0.2

Fixes

Component Description Issue
Apama Analytics Builder A race condition was fixed which could lead to exceeding the configurable limit on the number of active simulation models. PAB-865
Apama Analytics Builder The maxSimulationSecsDelay property is now excluded from the check on whether a model has been modified while it is active, as it is valid to change this even when a model is active. PAB-878
Apama Analytics Builder The managed object name is now correctly escaped in the Analytics Builder palette, which prevents potential cross-site scripting attacks. PAB-879
Apama Analytics Builder The documentation of the Alarm Input block has been updated. It now recommends to set the Ignore Timestamp parameter if the Acknowledged or Cleared alarm status is used (as the alarm's creation time is used as the source timestamp). PAB-902
Apama Analytics Builder If the Apama-ctrl microservice was configured to use an alternative source for simulation data, the username and password settings were incorrectly applied to look for extensions in the Cumulocity IoT inventory as well. This has been corrected to always use the platform credentials. PAB-932