Topic updated on September 17, 2021

Updating products

Updating from a previous release

Review the Upgrading from previous versions section of the release's Product Release Notes for information on doing a product update vs. doing a complete product installation.

Updating the Workbench

For information on upgrading the Workbench, see the Help menu entry in Touring the Workbench.

Obtaining a product update file

Some products have an update file that can be applied on top of an already installed product. This update file may contain fixes or improvements and is an alternative option to doing a complete product install.

If you already have the product update file, skip the following steps to download the product update file and continue with Applying a product update file.

Follow these steps to download a product update file:

  1. Using a computer with web browser access, Log on to the Management Portal, select Developers and then select Resources.
  2. From under Index of files, select the appropriate build (if you are not sure, pick the latest available build).
  3. Select the appropriate hardware or operating system environment.
  4. Select the appropriate product, for example: Asset_Gateway or Enterprise_Gateway.
  5. Select the appropriate Product_Update.XXX.dwu file and download it to a temporary location on the computer.
    For the file names, the following naming convention applies to the update files:
    • Product indicates the specific product
    • Update indicates the file is an update file (as opposed to a full install file)
    • XXX is the release and build numbers
    • The .dwu extension indicates the file is an update file
    • If the resources directory does not contain a .dwu file, then that product does not support this type of software update
    • .dwu files are specific to each product and hardware or operating system environment.

Applying a product update file

The product update process provides fixes or improvements to the base run time software. Your defined application logic (triggers, devices, transports, node configuration settings, etc.) is maintained and is not replaced or overwritten.
The product update does not include updates to device drivers or extensions that are installed separately using the Administration window Packages tab.

To apply a product update file, follow these steps:

  1. A best practices step is to do a node backup periodically or before significant changes.
  2. To do a node backup, from the Workbench left pane, select the node icon and right click to display the node's pop-up menu.
  3. Select Back Up and specify a file name and location for the node backup file.
  4. Proceed with the product update.
    From the Workbench left pane, expand the node where you want to apply the update file.
  5. Select the Administration icon.
    The Administration window appears.
  6. Select Node Administration to bring the tab to the front.
  7. At the bottom of the Node Administration tab, select Update Firmware.
    An Update Firmware File Location window is displayed, allowing you to navigate to the location on the computer where the .dwu file was copied.
  8. Select the appropriate .dwu file and select Select.
    A confirmation window is displayed indicating the node will restart after the software (firmware) is updated.
    A progress window will display the progress of transferring the software update file, then a message window will display indicating that the node will restart and that the Workbench will be temporarily disconnected during the restart.
  9. Select OK to clear the message window.
  10. After the node has restarted and the icon is active again, select the node to reconnect the Workbench.
  11. The Administration window Node Administration tab can be displayed to show the new level of the base run time software in the Software Release Level parameter.
  12. Review the Administration window Packages tab for the status of added device drivers and extensions. If the status displayed is: "ERROR: Incompatible interface", then the device driver or extension file is at an older level that is not supported by the base run time release level. The device driver or extension will need to be updated.

Adding new device driver or extension files

If there are updates to device driver or extension files that need to be applied to a node, that is accomplished using the Packages tab.
It is important to have the supported level of the device driver or extension files that match the base run time release level.
If there are any questions or concerns, contact your support representative.

See Packages for more information on adding device driver and extension files.

Adding Transaction Server JAR files

The Transaction Server, which provides the transaction processing for the Enterprise connectivity features, has a dependency on externally provided support files.
If these support files (jar files) have not been added to the node, or if they were added but removed - and need to be added again, see the information on the specific features.
For example:

Reinstalling a product

To reinstall a product on top of the same release level, use the same process for installing the product with a few additional steps as follows:

  1. A best practices step is to do a node backup periodically or before significant changes.
  2. To do a node backup, from the Workbench left pane, select the node icon and right click to display the node's pop-up menu.
  3. Select Back Up and specify a file name and location for the node backup file.
  4. Proceed with the product install as documented for the specific product.
  5. If necessary, do a node restore to import the node's settings and your application definition as saved in a previous node backup.
  6. To do a node restore, from the Workbench left pane, select the node icon and right click to display the node's pop-up menu.
  7. Select Restore and specify the file name and location of the node backup file.
  8. Install any device driver or extension files that need to be applied to a node using the Packages tab.
    It is important to have the supported level of the device driver or extension files that match the base run time release level.
    If there are any questions or concerns, contact your support representative.
    See Packages for more information on adding device driver and extension files.