ctrlX Device Portal - Release Notes

HugoX · ‎08-21-2023

ctrlX Device Portal - Release Notes
ctrlX Device Portal premium services - Release Notes of powered by NEXEED
Related Links

ctrlX Device Portal - Release Notes

Version 1.0.10

New features

Assign licenses to multiple devices (máx. 25 devices).
Grant access to users.

Improvements

Better performance of Orders screens.
Assignment process improved.
Add-on licenses assignment improved.

Earlier versions - click to expand

Spoiler

Version 1.0.6

Improvements

Better performance managing Devices.
Better error handling.
Responsive langing page

Version 1.0.5

New features

It is now possible to select the version of the App assigned to the Device.
It is now possible to download Apps in the selected assigned to the Device.

Improvements

Usability and performance improvements in the search filter on Device Overview page.

Bug fixes

Expired Trial Licenses to a Device doesn't show "Evaluation Mode".

Version 1.0.3

First release of new ctrlX Device Portal frontend.

Version 1.0.6 Improvements Better performance managing Devices. Better error handling. Responsive langing page Version 1.0.5 New features It is now possible to select the version of the App assigned to the Device. It is now possible to download Apps in the selected assigned to the Device. Improvements Usability and performance improvements in the search filter on Device Overview page. Bug fixes Expired Trial Licenses to a Device doesn't show "Evaluation Mode". Version 1.0.3 First release of new ctrlX Device Portal frontend.

ctrlX Device Portal premium services - Release Notes of powered by NEXEED

Version 2.40 (26.02.2024)

UX improvements

We updated our claiming wizard for the type ctrlX CORE, so that it shows additional hints when the communication ID is not correct formatted.

Important Announcement

One of our primary objectives for the Device Portal is to consistently enhance our security mechanisms. As part of this effort, we introduced a new authorization method using OAuth2 for our Solution API last year. We have previously communicated our intention to transition to this new approach, and with the upcoming release in Q2 2024, the API Key authorization method will no longer be supported for our Solution API.

Security Improvements

Various small improvements have been made to enhance the security of the software.

Earlier versions - click to expand

Spoiler

Version 2.39 (08.01.2024)

UI Upgrade

Smaller changes have been implemented in the current look and feel of the UI to enhance usability.

Device Tunnel

A fix has been implemented for issues related to the conversion of larger request bodies when tunneling them as WebSocket messages to devices. This addresses any previous challenges encountered in handling sizable data through the device tunnel.

Add Device Wizard

The add device wizard in the Device Overview now includes an extension for RCU series 5 device type.

Distribution Overview

Existing distributions in the distribution table can now be edited, allowing you to customize details such as Name, Version, and Description to better suit your needs.
Additionally, existing distributions in the distribution table can now be copied with the existing commands.

Security Improvements

Various small improvements have been made to enhance the security of the software.

Version 2.37

Roll-out management via Solution API

The Solution API (see API documentation of Solution API) provides a new endpoint which can be used to create roll-outs¹– which was previously only possible via the Device Portal UI.
Another new endpoint of the Solution API allows to start or cancel Roll-outs.
The existing Solution API endpoints for command creation were enhanced by an additional optional parameter named ‘rollOutId’ which allows to add additional commands to an existing roll-out.
This allows to create roll-outs which contain many batches and to add batches which include file data. In both cases it makes sense to: 1. Define the roll-out as MANUAL, 2. Add additional batches, 3. Start the roll-out.

MACMA/OAuth2 authorization at Solution API

Solutions are soon enabled to use a MACMA token to authorize themselves at the Solution API.
One benefit of using MACMA tokens is that they can be customized in order to provide access to only some of the endpoints exposed via the Solution API. For this purpose we introduced five new MACMA roles.
While we support API Keys and MACMA tokens for authorization for a limited time, we will remove the support for API Keys in the near future.
Therefore we would encourage all users of the Solution API to switch to MACMA/OAuth2 tokens soon. We will inform you via a separate e-mail once this is possible – as it requires some configuration changes in each MACMA tenant which will be performed in the upcoming week.

¹Roll-outs represent a collection of command batches but provide some additional functionalities – e.g. the possibility to start the roll-out manually.

Version 2.36

New optional step "Configure roll-out" in "Roll-out artifact(s) wizard"

It is now possible to configure a roll-out via the Roll-out artifact(s) wizard by entering a description and selecting a scheduling type, which will end up in creating a "Roll-out".

For that the following scheduling types for a roll-out can be selected:

Start immediately
Start manually later

New Activity Overview to manage roll-outs, command batches and commands

Display of all roll-outs, command batches and commands including search and filter functionality in separate tabs
New command status "Paused" → for commands which are part of a roll-out which has the scheduling type "Start manually later" selected by creation
Possibility to start a roll-out manually
Possibility of canceling of all commands for a roll-out, command batch or command
Roll-outs Tab: "Progress" column shows the count of pending / successful / failed command batches included in this roll-out
Command batches Tab: "Progress" Column shows the count of pending / successful / failed commands included in the batch

New "Distribution Overview" to create and manage distributions

It is now possible to create distributions, which can contains artifacts and/or custom commands based on the device type. Each distribution can contain max. 30 artifacts and/or custom commands.

It is possible to edit the commands of a distribution with the following functionalities:

Change the execution order of commands via Drag&Drop
Delete one or multiple commands

A distribution can be rolled-out for one or more devices with the same device type.

New functionality to roll-out a distribution in the "Device Overview”

Assign distribution to a list of devices with the same device type for the roll-out. The following scheduling types for a roll-out can be selected:

Start immediately
Start manually later

It is possible to see the progress of the roll-out / commands of the distribution on the "Activity Overview".

Bug fixes

Fix cause for multiple nested Portal view's

Version 2.34

Extended filter functionality in Device Overview

The Device Overview offers now the possibility to filter after all properties of your device (attributes as well as status values).
The filter possibilities are automatically generated based on the available properties in the registered devices in the tenant.
For example, you can filter for an IMEI (from the category Mobile), a Serial Number or a Hardware Version (from the category Device), an software installed on your device (visible in the software tab) or any other properties.

One UI for authorization system and Device Portal

The Device Portal will now be displayed in one UI (Portal) together with our user authorization system.
It is now possible to upload your icons directly over the portal configuration and also use extended skinning possibilities to create the desired look and feel.

Bug fixes

Updated MSSQL JDBC Driver due to issues with connection strings
Ensure that command descriptor changes do not affect existing commands

Versions earlier 2.34 on request

Version 2.39 (08.01.2024) UI Upgrade Smaller changes have been implemented in the current look and feel of the UI to enhance usability. Device Tunnel A fix has been implemented for issues related to the conversion of larger request bodies when tunneling them as WebSocket messages to devices. This addresses any previous challenges encountered in handling sizable data through the device tunnel. Add Device Wizard The add device wizard in the Device Overview now includes an extension for RCU series 5 device type. Distribution Overview Existing distributions in the distribution table can now be edited, allowing you to customize details such as Name, Version, and Description to better suit your needs. Additionally, existing distributions in the distribution table can now be copied with the existing commands. Security Improvements Various small improvements have been made to enhance the security of the software. Version 2.37 Roll-out management via Solution API The Solution API (see API documentation of Solution API) provides a new endpoint which can be used to create roll-outs1 – which was previously only possible via the Device Portal UI. Another new endpoint of the Solution API allows to start or cancel Roll-outs. The existing Solution API endpoints for command creation were enhanced by an additional optional parameter named ‘rollOutId’ which allows to add additional commands to an existing roll-out.This allows to create roll-outs which contain many batches and to add batches which include file data. In both cases it makes sense to: 1. Define the roll-out as MANUAL, 2. Add additional batches, 3. Start the roll-out. MACMA/OAuth2 authorization at Solution API Solutions are soon enabled to use a MACMA token to authorize themselves at the Solution API. One benefit of using MACMA tokens is that they can be customized in order to provide access to only some of the endpoints exposed via the Solution API. For this purpose we introduced five new MACMA roles. While we support API Keys and MACMA tokens for authorization for a limited time, we will remove the support for API Keys in the near future. Therefore we would encourage all users of the Solution API to switch to MACMA/OAuth2 tokens soon. We will inform you via a separate e-mail once this is possible – as it requires some configuration changes in each MACMA tenant which will be performed in the upcoming week. 1Roll-outs represent a collection of command batches but provide some additional functionalities – e.g. the possibility to start the roll-out manually. Version 2.36 New optional step "Configure roll-out" in "Roll-out artifact(s) wizard" It is now possible to configure a roll-out via the Roll-out artifact(s) wizard by entering a description and selecting a scheduling type, which will end up in creating a "Roll-out". For that the following scheduling types for a roll-out can be selected: Start immediately Start manually later New Activity Overview to manage roll-outs, command batches and commands Display of all roll-outs, command batches and commands including search and filter functionality in separate tabs New command status "Paused" → for commands which are part of a roll-out which has the scheduling type "Start manually later" selected by creation Possibility to start a roll-out manually Possibility of canceling of all commands for a roll-out, command batch or command Roll-outs Tab: "Progress" column shows the count of pending / successful / failed command batches included in this roll-out Command batches Tab: "Progress" Column shows the count of pending / successful / failed commands included in the batch New "Distribution Overview" to create and manage distributions It is now possible to create distributions, which can contains artifacts and/or custom commands based on the device type. Each distribution can contain max. 30 artifacts and/or custom commands. It is possible to edit the commands of a distribution with the following functionalities: Change the execution order of commands via Drag&Drop Delete one or multiple commands A distribution can be rolled-out for one or more devices with the same device type. New functionality to roll-out a distribution in the "Device Overview” Assign distribution to a list of devices with the same device type for the roll-out. The following scheduling types for a roll-out can be selected: Start immediately Start manually later It is possible to see the progress of the roll-out / commands of the distribution on the "Activity Overview". Bug fixes Fix cause for multiple nested Portal view's Version 2.34 Extended filter functionality in Device Overview The Device Overview offers now the possibility to filter after all properties of your device (attributes as well as status values). The filter possibilities are automatically generated based on the available properties in the registered devices in the tenant. For example, you can filter for an IMEI (from the category Mobile), a Serial Number or a Hardware Version (from the category Device), an software installed on your device (visible in the software tab) or any other properties. One UI for authorization system and Device Portal The Device Portal will now be displayed in one UI (Portal) together with our user authorization system. It is now possible to upload your icons directly over the portal configuration and also use extended skinning possibilities to create the desired look and feel. Bug fixes Updated MSSQL JDBC Driver due to issues with connection strings Ensure that command descriptor changes do not affect existing commands Versions earlier 2.34 on request

ctrlX Device Portal - Release Notes