Updating Modules

The module update process allows you to roll out new versions of modules across all affected devices—whether it's deployed directly, through an application, or via an asset hierarchy. The update flow is organized into five steps, guiding you from selecting affected entities to finalizing and monitoring the rollout.

1. Applications

In this step, you see all applications that include the selected module and have been assigned to devices. You can choose to include or exclude each application from the update.

  • Only selected applications will be part of the rollout.

  • Devices assigned to excluded applications will not receive the updated module (even if technically eligible).

Module update, step 1 - Applications

2. Hierarchies

Here, the system lists all asset hierarchies where one or more of the selected modules are used (typically via Data Connectors, Custom Models or other hierarchy-driven components).

  • You can choose which hierarchies to include in the rollout.

Module update, step 2 - Hierarchies

3. Devices

Based on the applications and hierarchies selected in the previous steps, and the devices that have the module installed directly (i.e., via device-scoped configuration), the devices to update are listed here.

  • Select which directly targeted devices should receive the update.

Module update, step 3 - Devices

4. Deployment

This phase summarizes what will be updated and lets you determine weather the update should be deployed or not. You can now configure the deployment action for each affected device. The options are:

  • Do not deploy the update: Only update the device configuration, but do not deploy the changes.

  • Deploy the update now: Update and deploy immediately.

  • Deploy the update at a specified time: Update and deploy the changes at a selected time.

Module update, step 4 - Deployment

5. Finalize

After confirming the deployment settings, the update process is finalized. All pending updates are listed for all devices, where changes to the modules on each individual device can be viewed.

The possible module operation types are:

  • Added: Module is added to the device.

  • Removed: Module is removed from the device.

  • Modified: Module version is changed.

Updating a module version can cause side effects, for example updating applications. If the device used an application several versions old, modules can have been added or removed in the newest version. This means that a simple module update can cause several modules to be both added, removed or modified.

Module update, step 5 - Finalizing

In the figure above, the device sesam-device-silkeborg is expanded, and it can be seen that the module DeviceMonitorModule is updated (modified) from version 2.0.0 to 2.1.0-rc-1.

When all changes are reviewed, the update process can be started by clicking the Approve Update button.

Confirming the update and deployment

Click ok will start the process. The device configurations are updated first.

Update process started - updating device configurations.

When the device configurations are updated, deployments will start if configured.

Update process - deploying to devices.

The user does not have to wait for the completion of the deployments. It can be closed, and the deployments will keep running in the background.

To view the progress of the deployments, go to the Deployment overview.

PreviousUpdate CenterNextUpdating Applications

Last updated

Was this helpful?