Skip to main content

Firmware Rollouts

In this section:

This feature allows users to create and start a firmware rollout on Controlant Saga devices.

To open the Firmware Rollout page, in the Fleet Manager menu bar, click Firmware Rollout. The Firmware Rollout page appears:

Fleet Manager - Firmware Rollout page

Item

Description

Fleet Manager - Firmware Rollout - New Rollout button

Click to open the New Firmware Rollout dialog to configure the new firmware rollout.

Fleet Manager - Firmware Rollout - Filter by firmware

Filter the firmware rollouts list by firmware version configured in the Rollout: In the Filter by firmware drop-down, start typing the name of the firmware release to filter the list, or scroll down and click to select the firmware version.

Table 25. Firmware rollouts list

Item

Description

ID

Unique identifier of firmware rollout.

Rollout Name

Name of firmware rollout.

Firmware

Version name and number of firmware that will be deployed to devices in this firmware rollout.

Device Count

Number of devices included in this firmware rollout.

Created At

Date and time firmware rollout was created, in in ​D MMM YYYY, HH:MM format.

Created By

Username of user who created the firmware rollout.

Started At

Date and time firmware rollout was started, in in ​D MMM YYYY, HH:MM format.

Started By

Username of user who started the firmware rollout.

Account Admin -­ Company Control Panel - User Management - User actions

Click to see available actions:

  • Start rollout - opens the Start Rollout confirmation dialog where you need to confirm that you want to start this download.

  • Download IDs - downloads a list of Device ID of the devices included in this firmware rollout, in a .csv file (comma separated values).

  • Delete rollout - opens the Delete rollout confirmation box, where you can confirm you want to delete this rollout.



Create a new rollout

You can create a new rollout, where you configure the following:

  • firmware version you want to roll out

  • name of the rollout

  • devices you want the firmware version to roll out to

Fleet Manager - Firmware Rollout - New firmware rollout dialog
  1. Click New Rollout.

    The New Firmware Rollout dialog appears.

    Fleet Manager - Firmware Rollout - New firmware rollout dialog
  2. To set the firmware version to roll out, in the Firmware Version drop-down, start typing the name of the firmware release to filter the list, or scroll down and click to select the firmware versions.

    Fleet Manager - Firmware Rollout - New firmware rollout dialog - Firmware version - selected
  3. In the Rollout Name box, type a name for the firmware rollout.

    Fleet Manager - Firmware Rollout - New firmware rollout dialog - Rollout Name - example
  4. To select the devices to roll out the firmware to, do one of the following:

    Caution

    If you switch input methods during the process, your previous inputs will disappear.

    1. If you want to select devices to roll out the firmware to filtering by import IDs, in the Rollout IDs area, click to select Import IDs, and then do one of the following:

      1. If you want to filter by scan ID, click Scan and then in the ID box, enter the scan ID.

        Fleet Manager - Firmware Rollout - New firmware rollout dialog - Rollout IDs - Import IDs - Scan - example
      2. If you want to filter by box ID, click Box and then in the ID box, enter the box ID.

        Fleet Manager - Firmware Rollout - New firmware rollout dialog - Rollout IDs - Import IDs - Box - example
      3. If you want to filter by sales order ID, click Sales Order ID and then in the ID box, enter the sales order ID.

        Fleet Manager - Firmware Rollout - New firmware rollout dialog - Rollout IDs - Import IDs - Sales Order ID - example
      4. If you want to filter by tracking ID, click Tracking and then in the ID box, enter the tracking ID.

        Fleet Manager - Firmware Rollout - New firmware rollout dialog - Rollout IDs - Import IDs - Tracking ID - example
    2. If you want to filter by Device IDs, in the Multiple IDs area, do one of the following:

      1. To type or paste a list of Device IDs, do the following:

        1. Click to select Add Device IDs.

        2. In the Device IDs box, type or paste a list of Device IDs, separating multiple items with a comma.

          Fleet Manager - Firmware Rollout - New firmware rollout dialog - Rollout IDs - Add Device IDs
      2. To import a comma separated file with a list of Device IDs, do the following:

        1. Click to select CSV File.

        2. Upload the comma separated file by dragging and dropping it in the designated area, or click browse and locate the file on your machine.

          Fleet Manager - Firmware Rollout - New firmware rollout dialog - Rollout IDs - CSV file - example

          Note

          The file should contain a maximum of 100.000 device IDs.

  5. Click Create Rollout.

    The Firmware rollouts page appears.

Note

The Fleet Manager verifies the list of Device IDs and if one or more Device IDs on the list do not pass the check, the uploading of the list fails.

  • The list is confirmed if:

    • all Device IDs on the list are registered Saga device IDs

    • all Device IDs on the list belong to a Saga device

    • all Device IDs on the list belong to a Saga device that is equipped with a lower firmware version than the version selected in Step 2 above

    • all Device ID on the list belong to a device that has not been added to a rollout yet

  • The uploading of the list fails with an error message if any of the Device ID on the list fails any of the verification criteria.

    The error message details the reason and the number of failed verifications.

    You can click Download error file, to download a list containing the Device IDs of devices that did not pass the verification, categorized by error types. The file is in .csv file format.

    Note

    Error types when creating a rollout:

    NOT_REGISTERED

    Not registered Device ID.

    SAGA_VA

    Not a Saga device ID.

    FIRMWARE_HIGHER_OR_EQUAL

    Has already been updated to this firmware version or a more recent one.

    IN_ACTIVE_ROLLOUT

    Has already been added to a rollout.

    Using the error file, edit your original input and add the Device IDs again (Step 3).

. After the successful creation of the rollout, you can:
  • Create another rollout with the same firmware version.

  • Start the rollout. See Start a rollout.

Note

You can only start a rollout that has not been started.

  1. Locate the rollout you want to start.

    Note

    You can filter by the firmware version configured in the Rollout: In the Filter by firmware drop-down, start typing the name of the firmware release to filter the list, or scroll down and click to select the firmware version.

    Fleet Manager - Firmware Rollout - Filter by firmware
  2. In the available actions column for the rollout you want to start, click Account Admin -­ Company Control Panel - User Management - User actions and then click Start rollout.

    The Start Rollout confirmation dialog appears.

    Fleet Manager - Firmware Rollout - Start Rollout dialog

    Warning

    You cannot stop a rollout after it has been started.

    Verify that you are starting the correct rollout by checking that everything is correct:

    • the rollout name

    • the firmware version

    • the number of affected devices

  3. To confirm you understand the action cannot be undone, click I understand that this action is irreversible..

    Fleet Manager - Firmware Rollout - Start Rollout dialog - Confirm you understand this action is irreversible
  4. Click Start Rollout.

    The rollout will start. The Firmware Rollouts page appears.

You can download a list of the Device IDs of the devices that are included in a firmware rollout.

  1. Locate the rollout you want to download the Device IDs of.

    Note

    You can filter by the firmware version configured in the Rollout: In the Filter by firmware drop-down, start typing the name of the firmware release to filter the list, or scroll down and click to select the firmware version.

    Fleet Manager - Firmware Rollout - Filter by firmware
  2. In the available actions column for the rollout you want to start, click Account Admin -­ Company Control Panel - User Management - User actions and then click Download IDs.

    The file is downloaded to your machine, in a .csv file (comma separated values).

    Note

    Depending on the configuration of your browser, you may need to select a location for the file before it is downloa

  3. To confirm you understand the action cannot be undone, click I understand that this action is irreversible..

    Fleet Manager - Firmware Rollout - Start Rollout dialog - Confirm you understand this action is irreversible

    Warning

    You cannot stop a rollout that has been started. Ensure that you are starting the correct rollout before proceeding.

  4. Click Start Rollout.

    The rollout will start. The Firmware Rollouts page appears, showing the rollout with information in the Started At and Started By columns.

Note

You need administrator access to delete a rollout, and you can only delete a rollout if it has not been started or canceled.

  1. Click Firmware Rollouts on the sidebar.

  2. Find the row of the rollout you need to cancel in the list.

    • Look for the descriptive name of the rollout in the Rollout name column.

    • You have the option to filter to the firmware version: click Filter by and select Firmware version from the drop-down list. Type the firmware version into the textbox.

  3. Click Actions.

  4. Click delete rollout.

  1. Locate the rollout you want to delete.

    Note

    You can filter by the firmware version configured in the Rollout: In the Filter by firmware drop-down, start typing the name of the firmware release to filter the list, or scroll down and click to select the firmware version.

    Fleet Manager - Firmware Rollout - Filter by firmware
  2. In the available actions column for the rollout you want to delete, click Account Admin -­ Company Control Panel - User Management - User actions and then click Delete rollout.

    The Delete Rollout confirmation dialog appears.

    Fleet Manager - Firmware Rollout - Delete Rollout dialog

    Warning

    Verify that you are deleting the correct rollout by checking that everything is correct:

    • the rollout name

    • the firmware version

    • the number of affected devices

  3. Click Confirm.

    The rollout is deleted. The Firmware Rollouts page appears.