Skip to content

Configuration Management

The DataPortal enables remote configuration updates of communication units (configuration over the air - COTA). Configuration updates are managed using configuration bundles, which allow version control and provide transparency regarding the installation status of selected machines.

Configuration bundles are visible only within the respective tenant organization (typically the OEM). Users belonging to the tenant, including its child organizations, can view and assign configuration bundles according to their Permission Set. Users outside of the tenant cannot see or assign configuration bundles. See Tenant for further details.

A remote configuration update of a communication unit consists of two steps:

  1. In the first step, the Create Configuration Bundle procedure must be completed.

  2. In the second step, the transfer of the configuration update to the device must be triggered, either by selecting one or more CUs for the Configuration Update/Mass COTA or by selecting the configuration bundle first, see Select Configuration Bundle for Update.

Communication unit Configuration
Figure 1: Communication unit Configuration

Requirements

In order to have the configuration update option available within the DataPortal, the following preconditions must be fulfilled:

Feature Permission Set Name Level
Upload/Deletion of Configuration into the Configuration Management Repository Models Admin
Triggering or Cancelling of Remote Configuration, either of Models Admin
Machines Admin

Feature Name Status
Configuration Management ON

Software Update Use Cases

A: As telematics OEM manager with Models Admin permission set I need to be able to manage configurations and configuration bundles to provide them for updating existing machines or configuring new machines.

Permission Set Level Description
Models Admin Is allowed to manage configurations and bundles.
Models Admin Is allowed to download configuration files.

B: As telematics OEM manager with Models Admin permission set I need to be able to start/stop COTA/FOTA requests for machines and models so I can test and rollout fleet wide software updates.

Permission Set Level Description
Models Admin Is allowed to view configurations and bundles.
Models Admin Is allowed to view current and historical COTA requests of a machine.
Models Admin Is allowed to create a COTA request for a machine.
Models Admin Is allowed to view current and historical FOTA requests of a machine.
Models Admin Is allowed to create a FOTA request for a machine.

C: As an OEM end-of-line worker with Machines Admin permission set I need to be able to start/stop COTA/FOTA requests for machines to be able to install the latest software version into a new machine.

Permission Set Level Description
Machines Admin Is not allowed to manage configurations and bundles.
Machines Admin Is not allowed to download configuration files.
Machines Admin Is allowed to view configurations and bundles.
Machines Admin Is allowed to view current and historical COTA requests of a machine.
Machines Admin Is allowed to create a COTA request for a machine.
Machines Admin Is allowed to view current and historical FOTA requests of a machine.
Machines Admin Is allowed to create a FOTA request for a machine.

Create Configuration Bundle

The DataPortal supports the following configuration files, depending on the selected Model and Configuration type. Each combination is considered a configuration bundle.

  • CANlink® mobile 3600: a combination of a .dod file and its corresponding .bin file, created with the Proemion Configurator software.
  • CANlink® mobile 10000:
    • Configuration type CLM: a single .clm file, exported from the CANlink® mobile 10000 Web UI.
    • Configuration type CODESYS: an Application export (.zip), containing the exported Application.app and Application.crc files, and a Project archive (.projectarchive), created with the CODESYS IDE.

  1. Open Settings > Communication Units Management > Configuration Bundles.

    ✓ The table with the available configuration bundles opens.

  2. Click on + Add new configuration in the top right corner to add a new configuration.

    Add new configuration
    Figure 2: Add new configuration

  3. In the New configuration dialog, select the Model: CANlink® mobile 3600 or CANlink® mobile 10000. For CANlink® mobile 10000, also select the Configuration type: CLM or CODESYS.

    Select Model
    Figure 3: Select Model

    The configuration file(s) that must be uploaded depend on the selected model and configuration type.

  4. Upload the required configuration files. Click the upload button for each required file and select the corresponding file.

    For CANlink® mobile 3600

    The uploaded .dod file is validated for consistency. The product code and device configuration version string must be the same in both the .dod and .bin files. In case of an error, the upload is cancelled and a specific error message is displayed. To detect the root cause of the error and resolve it, contact Service and Support.

    For CANlink® mobile 10000 with CODESYS configuration

    The .app and .crc files included in the Application export (.zip) must retain their exact original names, Application.app and Application.crc. Renaming these files causes the OTA update to fail.

    The New Configuration section opens.

    Upload Details
    Figure 4: Upload Details

  5. Regarding the Versions bundle, you may choose Add to existing or Create new files.

  6. Enter a proper Bundle Name.

  7. Select the Version label.

  8. Click Save. Alternatively, click Save + Install to save the configuration bundle and immediately start the installation on machines.

✓ After saving, the Configuration Overview with the available configuration bundles opens and the new configuration bundle is available.

Download Configuration File

Users can download the files from a configuration bundle for further use.

  1. Open the Configuration bundles overview.

  2. Select the desired configuration bundle to open it. The details page with all versions opens.

  3. Click the 3-dots context-menu 3-dots of the desired configuration version to open the context menu.

  4. Select Download <file extension> file, where file extension matches the configuration bundle's file (e.g., .dod, .bin, .clm, .zip, .projectarchive).

    Download .clm file
    Figure 5: Download .clm file

Select Configuration Bundle for Update

  1. Open the Configuration bundles overview.

  2. Select the desired configuration bundle to open it. The details page with all versions opens.

  3. Click the 3-dots context-menu 3-dots of the desired configuration version to open the context menu.

  4. Select Install on machines.

    Note

    When there are no eligible machines for this update, the Install on machines option will not be displayed.

    The Select machines page opens in the Firmware and Configuration Updates menu.

  5. Choose all or specific machines for the configuration update and Continue. The Configuration update page opens. In case there are conflicts for the selected machines, the information is displayed here, too:

    Configuration update information page
    Figure 6: Configuration update information page

    You can then proceed with the firmware update for all machines or only those without a pending update.

  6. Click Update to start the update of the firmware on the selected devices. ✓ The configuration update runs in the background.

Delete Configuration Bundle

To delete a version of a configuration bundle that is no longer required, open the Configuration bundles overview, select the specific bundle, and select Delete version from the 3-dots context-menu context menu of that version.

Note

Only versions without machine usage can be deleted.

Delete Version of Config Bundle
Figure 7: Delete Version of Config Bundle