Skip to main content

FM_menuicon_fwupdate.pngFeature: Firmware rollout

In this section:

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

Click Firmware Rollouts on the menu bar to get to the overview page.

Create a new rollout

  1. Select the firmware version from the drop-down.

  2. Give the rollout a descriptive name of max. 64 characters.

  3. Add device IDs.

    You can add device IDs in two ways. Pick one of the input methods by clicking the appropriate radio button.

    1. Type or scan device IDs to the textbox.

      If you are adding more than one ID, separate the elements of the list with a comma (",").

    2. Upload a .csv file with the device IDs.

      You can drag and drop or click "browse" to upload files from your computer.

    Caution

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

  4. Click Create Rollout.

    The system verifies the list of device IDs. Either all IDs on the list get confirmed, or the uploading of the list fails.

    1. The list gets confirmed if :

      1. all IDs on the list are registered device IDs

      2. all IDs on the list belong to a Saga logger

      3. all IDs on the list belong to a logger that is equipped with a lower firmware version than the version selected in Step 1

      4. all IDs on the list belong to a logger that has not been added to a rollout yet

    2. The uploading of the list fails with an error message if any of the IDs on the list fails any of the verification criteria.

      The error message details the reason and the number of failed verifications. By clicking Download error file, you get a .csv list with the device IDs that did not pass the verification, categorized by error types.

      Note

      Possible error types when creating a rollout:

      NOT_REGISTERED

      Not registered device ID.

      SAGA_VA

      Not a Saga logger 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 new rollout with the same firmware version.

  • Go back to the overview page. Choose this option if you want to start the rollout you just created.

Start a rollout

  1. Click Firmware Rollouts on the sidebar.

  2. Find the row of the rollout that you wish to start.

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

    2. 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 the Start rollout button in the Started column.

  4. Verify that you are starting the correct rollout.

    Check:

    • the rollout name

    • the firmware version

    • the number of affected devices

    Warning

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

  5. Confirm your intention to start the rollout by clicking the checkbox, or click Cancel to go back to the firmware rollouts overview page.

  6. Click Start Rollout.

    The overview page will show the updated Start date and Started by columns.

Cancel a rollout

Note

Only a user with admin access can cancel a rollout, and only if it has not been started or canceled yet.

  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.