Manage Firmware

The software that resides on a device is called firmware. Updating the firmware in devices is called loading firmware. Loading firmware to the device is referred to as softloading.

The firmware file extensions supported by the Universal Device Manager are:

  • .kru— 4500 device
  • .krx— InTouch device
  • .krs— InTouch DX device

Updating device firmware files is a two-step process in the Universal Device Manager:

  1. A stored firmware file is selected and imported into the database.
  2. A manual Load Firmware action or scheduled Load Firmware event is initiated to download the firmware to the device.
Note: A Load Firmware action that is performed on a device is automatically preceded by a Test Device action.

Import device firmware files

When you import firmware files into the database, be aware of these considerations:

  • Some information and content is the same between one set of firmware files and subsequent firmware files.
  • Only the information that has changed from one file import to another is imported into the database.
  • The firmware load will use information from all available imported firmware.

When you try to delete firmware that was previously imported and a more recent firmware import is using and depending on the contents of the previous import, a warning message states that any firmware from previous firmware imports that is being relied upon must remain in Universal Device Manager. You must delete the more recently imported firmware before deleting the previously imported firmware.

Cloud Services posts the latest released firmware to the Global tab within each tenant. The listings are read-only and for informational purposes. The application performs an entitlement check on the Global tab to verify that the customer has a valid hardware maintenance agreement. If the agreement has expired, a warning message appears: "Warning: You do not have access to Global Firmware updates. Please contact support for assistance." This is similar to the entitlement check that takes place when customers download device firmware files from UKG Community.

The Tenant tab lists all previously imported firmware. Tenant administrators can upload, import and delete firmware on the Tenant tab. The application does not perform an entitlement check on the Tenant tab.

To import firmware files:

  1. From the Devices main menu, select Manage Imports > Firmware.
  2. Select the Tenant tab.
  3. Select the Device Type for the firmware that you wish to load.
  4. Click Tap Choose File.
  5. Choose a file and click tap Open. The following file types are supported:
    • .kru— 4500 device
    • .krx— InTouch device
    • .krs— InTouch DX device
  6. Click Tap Import File.

The firmware file is imported into the database. A new row, which includes the file name and the date and time when the file was imported, is added to the list table.

To delete a file from the database, select the appropriate file and then click Delete. You can select multiple firmware files to delete.

Set up and schedule a Load Firmware event

First set up a Load Firmware event and its schedule:

  1. Select Configuration > Events from the Devices main menu.
  2. Click Tap New . The Event Editor workspace appears.
  3. In the Event Details tab, select an Event Type of Load Firmware and specify a name for the event.
  4. Select the desired firmware file from the drop-down list.
  5. Select InTouch DX, InTouch or 4500 as the device type, depending on the firmware file type.
  6. Define a schedule for the event by selecting a type (Once, Minutes, Hourly, Daily, or Monthly and Time Zone). The Schedule Type determines the remaining parameters which you must complete. By default, the Forever check box is selected. Deselect it to specify an End Date and End Time.
  7. Click Tap Create when you are done.

Next, assign the Load Firmware event to one or more devices or device groups within the Devices or Groups views in the Dashboard. You can also assign the event to a single device from its Device Details page.

  1. If you are using the Devices view in the Dashboard, select one or more devices. If you are using the Groups view, select one or more device groups. Skip this step if you are using the Device Details page.
  2. Select Actions > Assign Events.
  3. Select an event.
  4. Click Tap Assign.