DriveWorks Pro 23

How To: Upgrade The Integration Theme (KB24011601)

How To: Upgrade The Integration Theme

When upgrading DriveWorks to a new version, it is important to ensure the latest Integration Theme files are used.

This involves reapplying customizations made in the previous version files into the new files.

This ensures the customizations are incorporated with any updates made to the new version of the Integration Theme.

This document outlines the process for upgrading the DriveWorks Live Integration Theme.

Back up Customized Files and Folders

1. Copy the following files and folders to a backup location:
   • DriveWorksConfigUser.xml file

     This is located at:

     C:\ProgramData\DriveWorks\[version]\Live\Themes\Integration

   • Static Files Folder

     This was optionally set when the Integration Theme was originally created.

     The location can be found in the DriveWorksConfigUser.xml file, see the following for more information:

     • Upgrading from DriveWorks 22 and earlier, see staticFilesPath.

       Also back up any existing examples if customizations have been made.

     • Upgrading from DriveWorks 23 and onwards, see staticFilesPath
   • FrontEnd\Custom Folder (DriveWorks 23 and onwards only)

     This is located at:

     C:\ProgramData\DriveWorks\[version]\Live\Themes\Integration\Templates\FrontEnd\Custom

Install DriveWorks Live and Select Integration Theme

2. Uninstall the old version of DriveWorks and Install the new version.
3. Launch DriveWorks Live and connect to the License server to obtain a license.
4. Open the shared group that DriveWorks Live is required to run.

   This requires DriveWorks Pro Server to have been upgraded, see note at the top of this page.

5. Select Stage 1: Specification > Live and click the Theme from the command bar.
6. Step through the wizard for the Integration Theme:

   If additional static files are required select a new folder, or use the existing folder (see step 1) to overwrite the old files

   When upgrading to DriveWorks 22 and earlier only and Client SDK Examples were customized:

   • Copy the customizations from the back up files (step 1 above) into the new version files.
   • If using or creating custom code in the examples, we recommend not changing the code already present in the example file.
   • Instead, create the functions and call these where required. With the exception of editing existing method parameters.

   When upgrading to DriveWorks 23 and onwards, Client SDK Examples are available online.

Reapply Customizations

It is important customizations made to the old files are reviewed and, if still applicable, reapplied into the corresponding new files.

This ensures any updates made in the new files are consumed while taking advantage of any new functionality.

7. DriveWorksConfigUser.xml

   Upgrading to DriveWorks 22 and earlier

   1. Review the settings that can be applied to this file here Integration Theme Settings (22 and earlier)
   2. Open the old file (from the backup location) and the new file (from the install location - C:\ProgramData\DriveWorks\[version]\Live\Themes\Integration) side by side in an editor.
   3. Copy all required customizations from the old file, into the new file.
   4. Ensure that the <staticFilesPath> is also set to the folder containing the new static files.

   Upgrading to DriveWorks 23 and onwards

   1. Review the settings that can be applied to this file here Integration Theme Settings (23 and onwards)
   2. Open the old file (from the backup location) and the new file (from the install location - C:\ProgramData\DriveWorks\[version]\Live\Themes\Integration) side by side in an editor.
   3. Copy all required customizations from the old file, into the new file.

      Connection string for DriveWorks 23 onwards

      From DriveWorks 23 shared groups require the protocol, machine name and port number of the Pro Server machine to establish a connection.

      See Shared Group Connection for the connection string to use.

   4. Ensure that the <staticFilesPath> is also set to the folder containing the new static files.
8. Static Files Folder

   Copy customized files from the backup location into the location of the new static files.

9. FrontEnd\Custom Folder (when upgrading DriveWorks 23 and onwards only)
   1. For each file within the backed up files \FrontEnd\Custom location (including any sub folders)

      Copy the corresponding file from the new install system location:

      C:\ProgramData\DriveWorks\[version]\Live\Themes\Integration\Templates\FrontEnd\System

      To the new install custom location:

      C:\ProgramData\DriveWorks\[version]\Live\Themes\Integration\Templates\FrontEnd\Custom

   2. Open the old file (from the backup location) and the new file (copied to the install location - C:\ProgramData\DriveWorks\[version]\Live\Themes\Integration\Templates\FrontEnd\Custom) side by side in an editor.
   3. Copy all required customizations from the old file, into the new file.
10. When the Integration Theme is hosted through IIS.

    If using multiple sites in IIS, ensure that the site hosting the example files are also pointing to the folder with the new example files.

    Recycle the Application Pool and restart the site to clear any cached files.

    We also recommend clearing cache in the browser, this can be done with Ctrl + F5 in most browsers.