Documentation

Release 10.9.0.33

Improvements

Guide Component Description Issue
All Infrastructure Hugo (web site generator) has been updated from version 0.75.1 to version 0.92.1. MTM-43520

Release 10.9.0.26

Improvements

Guide Component Description Issue
Protocol integration guide LWM2M The supported LWM2M version has been added to the documentation, see LWM2M > Overview. MTM-40609
Protocol integration guide LWM2M A description of the "execute" operation with optional parameters has been added to the documentation, see LWM2M > LWM2M device details. MTM-40590

Release 10.9.0.23

Improvements

Guide Component Description Issue
Web SDK guide Tutorials The tutorial Add a custom widget to a dashboard has been updated to the latest c8ycli version (1009.0.18) and is now working as intended. MTM-39832

Release 10.9.0.21

Improvements

Guide Component Description Issue
User guide Cockpit The smart rules description has been updated to indicate that under certain circumstances, for example, if the time gap between measurements is quite large, the smart rules "On measurement threshold create alarm" and "On measurement explicit threshold create alarm" may raise an incorrect alarm severity. MTM-40164

Release 10.9.0.17

Improvements

Guide Component Description Issue
User guide Administration To improve clarity, the required permission for revoking a secret in a two-factor authentication setup has been stated more clearly, see Administration > Two-factor authentication. MTM-38347

Release 10.9.0.12

The 10.9.0 documentation contains

Moreover, you can find the following major enhancements, improvements and fixes in the area of documentation.

New guides

OpenAPI specification

A new OpenAPI Specification for the Cumulocity IoT REST API is available at https://cumulocity.com/api. The new specification describes the entire Cumulocity IoT REST API (that is, available endpoints, operations on each endpoint, input and output for each operation, authentication methods and more) following the OpenAPI 3.0 standard.

OpenAPI specification

The new specification is an enhancement of the former Reference guide and replaces it, starting with release 10.9.0.

Release notes

A new release notes presentation is available which combines the release notes from all versions (back to GA release 10.4.0) and from all Cumulocity IoT products (Core platform, Edge, Streaming Analytics, Machine Learning, DataHub) at one page.

Release notes

The new release notes page is accessible through a link in the top navigation on the documentation website.

Installation and operations guides

In addition to the Installation & Operations guides already provided for previous versions, the following new guides are now available through the Software AG Empower Portal:

Moreover, a new document Operations release notes is provided which lists all improvement or fixes related to the installation or operation of the Cumulocity IoT platform.

Note, that access to these documents on the Empower Portal requires credentials.

Improvements

Guide Component Description Issue
All All Documentation user experience has been enhanced with the ability to maintain your position in the documentation whilst changing the release version via the dropdown at the top. MTM-38347
All All It is now possible to copy the URL of all headings with a hover over button. This makes it easy to share a specific documentation location. MTM-37265
Concepts guide Tenant hierarchy A new chapter has been added to the Concepts guide, which describes the tenant hierachy and the concept of multi-tenancy in the Cumulocity IoT platform, see Tenant hierachy. MTM-35717
Device SDK guide Device integration using MQT The documentation about device certificates has been extended, see Device integration using MQTT > Device certificates. MTM-35717
Protocol integration guide Loriot LoRa Documentation has been added to the Protocol integration guide for the new agent Loriot LoRa. MTM-36385
Protocol integration guide LWM2M Explanation has been added to the documentation, why the Credentials field in the LWM2M bulk registration CSV is mandatory and why & how it must be unique, see LWM2M > Registering LWM2M devices. MTM-35316
Release notes Various The release notes for the Cumulocity IoT releases 9.8, 9.12, 9.16 and 9.20 have been archived and are no longer available on our documentation website. If you still need them, please contact support for a PDF version of the release notes. MTM-37632
User guide Cockpit The description of the smart rules behavior has been updated to achieve more clarity, see Cockpit > Smart rules. MTM-35582
User guide Cockpit The documentation on exports and reports has been enhanced to reflect the new UI behavior. You can now find two sections, Working with reports and Managing exports, instead of one, see Cockpit. MTM-35165
User guide Cockpit The description of the behavior of the red and yellow ranges in the smart rule "On measurement threshold create alarm" has been extended, see Cockpit > Smart rules collection > On measurement threshold create alarm. MTM-35724
User guide Device Management The documentation on managing device data reflects various functional improvements in the software, firmware and configuration repositories, see Managing device data. MTM-36884
User guide Various sections To provide more clarity, the description of the support user access functionality has been improved. MTM-37399
Web SDK guide The Web SDK guide has been re-organized to better reflect the current state of the Web SDK and improve clarity. MTM-36884
Website Hugo The Hugo version used for generating the documentation website at https://cumulocity.com/guides/10.9.0 has been updated from 0.55.0 to 0.80.0. MTM-34547

Fixes

Guide Component Description Issue
Cumulocity IoT OpenAPI Specification Inventory API Updated documentation for an edge case when loading managed objects without inventory role, see Inventory > Managed objects. MTM-33763
User guide Enterprise tenant Updated the list of non-editable fields in the subtenants Properties tab in the documentation, see Enterprise Tenant > Managing tenants. MTM-35001
User guide Enterprise tenant The description of the handling of custom domain names has been improved for more clarity, see Enterprise Tenant > Customizing your platform in the User guide. MTM-33926