Menu

Create a local campaign and start a firmware update

A local campaign is a firmware update that you deliver to your enterprise devices through your internal network. This allows you to reduce outgoing network load when pushing the campaign to devices. Local campaigns are useful when you expect devices to be an environment with limited connectivity.

As with a normal campaign, you can create a local campaign, assign it to devices enrolled in Knox E-FOTA One, and select the target firmware to be deployed. You can also edit a local campaign at any time.

When creating a local campaign, you specify the SFTP details of the device that will host the firmware delta files. The update is then served to enterprise devices from that device.

The following operations are not supported:

  • Assigning a local campaign to an EMM group.
  • Setting a local campaign as a default campaign to be applied to devices uploaded by a reseller.
  • Assigning a local campaign through a bulk action.
  • Assigning a normal campaign to a device that is assigned to a local campaign.

The workflow to create and execute a local campaign is as follows:

  1. Request permission from Samsung to create local campaigns.
  2. Create a local campaign.
  3. Copy the firmware delta file to the device to be updated.
  4. Use your EMM to execute the update.

Create a local campaign

  1. Log in to the Knox E-FOTA One portal.

  2. In the Local campaign tab, click Create Local Campaign.

  3. Fill in the campaign details:

    Basic Info

    Enter a unique name for the local campaign and describe what's new in this update.

    Local Storage Management

    Enter the SFTP details of the device that will store the firmware deltas to be deployed.

    NOTE—At this time, only SFTP is supported.

  4. Assign devices to the campaign:
    1. Click Assign Devices.

    2. In the Assign devices screen, select one or more devices to assign to the campaign.

      NOTE—By default, the device list is pre-filtered to show only the following:

      • Devices that aren't assigned to any campaign.
      • Devices assigned to expired or canceled campaigns.

      If you want to select a device currently assigned to a local campaign, click Clear Filters.

      Devices that are not in Enrolled state are excluded from the device list. Only enrolled devices can be assigned to a campaign.

    3. Click Assign.

      The table at the bottom of the form is populated based on the devices you selected.

  5. For each row in the table, click Select from firmware list. Then, select the target firmware.

  6. Click Create.

    Clicking Create effectively activates the local campaign and adds it to the Local Campaign list. There is no end date. To end a campaign, cancel or delete it.

    The related delta files are sent to the storage location you specified. You will receive an email notification when the transmission is complete.

    NOTE
    • If there is an error sending the delta files to the storage device you specified, you can retry the operation by opening the local campaign and clicking Retry.
    • When editing an active local campaign, you cannot modify the assigned devices.
    • The devices to be updated must have the status Campaign assigned.

Copy the delta files to the devices

When the firmware delta files have been sent to the storage location you specified when you created the local campaign, you must download the files and transfer them to the devices to be updated.

  1. Connect to your SFTP server.

  2. In the list of files, find the folder labeled with the model name of the device to be updated.

  3. Drill down through the subfolders until you find the target firmware.

    The folder structure is as follows:

    Model name > Carrier (sales code) > Current firmware > Target firmware

    In the folder names of the current firmware and target firmware, the forward slash (/) is replaced with an underscore (_). Thus, a typical example of a delta file's location is:

    https://example-host.com/SM-N960F/XEF/N960FXXS4CSJ1_N960FOXM4CSJ1_N960FXXS4CSJ1/N960FXXS4CSK2_N960FOXM4CSJ1_N960FXXS4CSJ1

    The target firmware's delta file has a .bin file extension.

  4. Download the delta file to your machine.

  5. Copy the delta file to the device's internal storage (Download folder).

    NOTE—If the bin file you download to the device does not match the device's target firmware set in the campaign, the update will fail.

Start the firmware update

When you have stored the delta files on the devices to be updated, send the following intent to those devices to run the firmware update on them:

com.samsung.android.knox.intent.action.UPDATE_FIRMWARE

When a device gets the intent, the firmware update will be start on it.

To send the intent, you can use your EMM. The procedure to do this differs depending on your EMM, but the workflow is similar across all EMMs. Refer to your EMM's documentation for more information.

In the following procedure, VMware Workspace ONE UEM is used to start the firmware update.

  1. In the VMware console, go to Devices > Provisioning > Components > Files/Actions.

  2. Click Add Files/Actions and select Android.

  3. In the Add Files/Actions screen, fill in the fields in the General tab. Take note of the value you set in the Name field. You will use it again later.

  4. Perform the following in the Manifest tab:

    1. In the Action(s) To Perform drop-down menu, select Run Intent.

    2. In the Command Line and Arguments to run field, enter the following:

      mode=explicit,broadcast=true,action=com.samsung.android.knox.intent.action.UPDATE_FIRMWARE,package=com.samsung.android.knox.efota,class=com.samsung.android.knox.efota.receivers.MdmEventReceiver
    3. In the TimeOut (-1 for infinite) field, enter 0.

    4. Click Save.

  5. Go to Devices > Product List View.

  6. Click Add Product and select Android.

  7. In the Add Product screen, fill in the fields in the General tab and assign a Smart Group that includes the devices assigned to the local campaign.

  8. Perform the following in the Manifest tab:

    1. In the Action(s) To Perform drop-down menu, select File Action - Install.

    2. In the Files/Actions tab, enter the name of the action you added in step 3.

    3. Enable Persistent through enterprise reset.

    4. Click Save.

  9. In Devices > Product List View > Active tab, click the left round button next to the product you added in step 7.

    The button turns green.

  10. When a device gets the intent, the firmware installation will start on it.