ENGL Support

This guide includes the latest information necessary to help customers upgrade to Imaging Toolkit 14 with the minimum of disruption.

• Breaking changes
• Requirements
• Upgrading from Imaging Toolkit 12.0.x
• Upgrading from Imaging Toolkit 14.0.0.x
• Common issues

Breaking changes

The following changes are detailed as they effect the upgrade process. For a complete list of changes visit:

Imaging Toolkit release history

ZENworks Linux imaging

Imaging Toolkit 14 includes WinPE imaging using WIM and ZMG image formats only. Please contact ENGL support if you require assistance to migrate to ENGL WinPE from Linux imaging (Linux/ZMG).

ENGL WinPE

Imaging Toolkit 14 includes an improved deployment process that ensures the same version of Imaging Toolkit executables and license are used for imaging and post-imaging phases. ENGL WinPE now includes all ENGL binaries, license file, and if using ZENworks ZMG imaging, the ZENworks imaging engine (img). Following an Imaging Toolkit version or license change, the PXE ENGL WinPE boot images must be updated using the Integration Wizard.

Build process (Ztoolkit) images

Ztoolkit images now contain project configuration settings and custom files (registry / scripts) only. Previously, build process binaries and license were included in the Ztoolkit images. With Imaging Toolkit 14, the required build process files and license are distributed by the ENGL imaging front-end (Zim). Following an upgrade, all Ztoolkit project images must be recreated using Deployment Wizard.

Deployment monitoring configuration

Monitoring settings are now synchronised between the imaging and post-image build process. This is automatic, but requires the imaging front-end (Zim) is configured with Monitoring.

Requirements

The following integration platforms are supported requirements must be met before upgrading to Imaging Toolkit 14:

• Imaging Toolkit 14.0 license
• Windows ADK/WinPE (see Windows ADK support matrix)
• WinSCP (for updating TFTP and image content on the ZCM Linux Appliance)
• Liquit Workspace 4.0 - 4.3
• SCCM / MECM 2207 - 2409
• ZENworks Configuration Management 23.3 - 24.4

Upgrading from Imaging Toolkit 12.0.x

Warning! If you are using Linux/ZMG imaging please contact ENGL support before upgrading to 14.0.

Before upgrading to Imaging Toolkit 14, perform the following steps:

1. Backup the TFTP server folder
   Note: If using the ZENworks Appliance (Linux) do NOT rename the /srv/tftp folder as it will break ZCM services.

2. The following files on the TFTP server should be removed because they are not used by Imaging Toolkit 14.
   Note: Some of these files will not be present depending on your ENGL integrated desktop management solution.

   \ 3PIUtils
     \ x64
       + getopt.dll
       + img.exe
       + TFTPClientLibrary.dll
   \ zimfiles
     + engl.lic
     + ldapsdk.tar
     + zimget.s
     + zimrun.s
     + zim.tgz
     \ x64
       + zim.exe
       + ztftpclient.exe
       + ztrace.exe

3. Install a supported version of Windows ADK/WinPE
4. Download and run the Imaging Toolkit 14.0 setup
5. Run Build Console and enter the license key
6. For each project, run Deployment Wizard and update the build process (Ztoolkit) image, then copy to the imaging server
7. Run Integration Wizard to update WinPE boot images and configure imaging front-end (Zim), then upload the TFTP folder to the server
8. Check the TFTP server zimfiles\zimpeget.cmd to ensure it includes any additional custom INI files (i.e. sites.ini) that are required for use with the imaging front-end (Zim)
   Note: Integration Wizard creates backups of any file it replaces (i.e. zimpeget.cmd.<YYYMMDD>)
9. To use the ENGL Monitor Service (available to all customers), edit the TFTP server zimfiles\zim.cfg as follows:

   Set:_MonitorService,"https://monitorservice.engl.co.uk"
   Set:_MonitorPort:"443"

10. For ENGL/WDS perform these steps:
    1. Use the WDS Administration tool to delete the existing ENGL Boot Image (x64).
    2. Add the Integration Wizard created WinPE boot image to WDS
11. For MECM/SCCM perform these steps:
    1. Delete the existing ENGL Boot Image (x64) and ENGL Boot Image (x86).
    2. Run Integration Wizard to update WinPE boot images.
    3. Distribute new ENGL Boot Image (x64) to required distribution points.
    4. Edit the ENGL PXE (x64) task sequence and update the boot image to use the new ENGL Boot Image (x64).

Upgrading from Imaging Toolkit 14.0.0.x

To upgrade from Imaging Toolkit 14 to a minor update, follow these steps.

1. Run Integration Wizard to only update WinPE boot images, then upload the TFTP folder to the server
2. Check the TFTP server zimfiles\zimpeget.cmd to ensure it includes any additional custom INI files (i.e. sites.ini) that are required for use with the imaging front-end (Zim)
   Note: Integration Wizard creates backups of any file it replaces (i.e. zimpeget.cmd.<YYYMMDD>)
3. For ENGL/WDS perform these steps:
   1. Use the WDS Administration tool to delete the existing ENGL Boot Image (x64).
   2. Add the Integration Wizard created WinPE boot image to WDS
4. For MECM/SCCM perform these steps:
   1. Delete the existing ENGL Boot Image (x64) and ENGL Boot Image (x86).
   2. Run Integration Wizard to update WinPE boot images.
   3. Distribute new ENGL Boot Image (x64) to required distribution points.
   4. Edit the ENGL PXE (x64) task sequence and update the boot image to use the new ENGL Boot Image (x64).

Common issues

These issues were reported by customers following an upgrade to Imaging Toolkit 14.

• Build Console 14 crashes on startup
  
  Delete the following registry key before launching Build Console. This will only need to be done once.

  HKEY_CURRENT_USER\Software\ENGL\Imaging Toolkit\Build Console\DockingPaneLayouts

• ENGL WinPE boots with "Error: License invalid or corrupted"
  
  Ensure the steps in the preparation section above have been followed to remove legacy Imaging Toolkit 12 files from the TFTP server. After running the Integration Wizard, the updated zimpeget.cmd must be uploaded as detailed in the upgrading section.
  
  
• Drivers (non-INF) fail to install due to incorrect paths in driver image
  
  Upgrade to Imaging Toolkit 14.0.0.2090 and recreate affected driver images. Driver images created with Imaging Toolkit 12 do not need to be recreated.