Appendix A    Customizing the Deployment Upgrade Process

The Customizable Deployment Upgrade (CDU) utility provides simple customization for the upgrading of deployed systems.

The Customizable Deployment Upgrade enables you to:

The Customizable Deployment Upgrade utility is distributed on the release medium in the CDU directory.

As there is no recovery of the upgrade process, backup your database before starting the Customizable Deployment Upgrade process.

To customize the deployment upgrade process

  1. Copy the CDU directory from the release medium and unset the Read Only attribute for the setup.ini file on disk1.

  2. Run the setup.exe program on disk1, and perform a trial installation.

    Installation parameters are written to the setup.ini file.

  3. To create the configurations that you require, simply edit this setup.ini file, as follows.

    1. To change the default JADE version product name (where the version value is the JADE release; for example, JADE 2020 to your own product name, change both the Product parameter value in the [Startup] section and the name of the [JADE version] section to your product name.

      Both the [Startup] section Product parameter and the product name section must have the same value.

      The parameters in the [Startup] section are utilized by the InstallShield program.

    2. To hide the display of dialogs during the deployment upgrade process, set the appropriate ShowXXXX parameters to No, or set the appropriate parameters to Yes to display the installation dialogs.

      These parameters and their default settings are listed in the following table.

      Parameter Installation Dialog Default Value
      ShowWelcome Welcome to the InstallShield Wizard Yes
      ShowLicense Software License Agreement (display LicenseFile) No
      ShowInfo Information (display InfoFile) No
      ShowUpgradeDir Select Installation Folders Yes
      ShowLicenseKey User Information No if no license key is required for an upgrade; Yes if a license key is required
      ShowSummary Start Copying Files Yes
      ShowReadme Setup Completed! (display readme.txt file) No
      ShowFinish Setup Completed! Yes

    3. You can use the parameters listed in the following table to define file locations and to supply pre‑defined values.

      Parameter Enables you to specify …
      BackColor The color of the upgrade process background (defaults to BLACK), in the RGB format nnn,nnn,nnn; for example, 128,0,0 specifies light red.
      BackgroundBitmap The name of the file (defaults to title.bmp) that contains the background bitmap displayed during the upgrade process.
      LicenseFile The name of the file (defaults to license.txt) in which your licensing agreement is located, if the value of the ShowLicense parameter is Yes.
      InfoFile The name of the text file (defaults to Info.txt) that contains upgrade-specific information or instructions during the upgrade process, if the value of the ShowInfo parameter is Yes.
      UpgradeInstallDir The base installation directory (displayed in the Install Directory text box of the Select Installation Folders dialog).
      UpgradeDbDir The database directory that you want to upgrade (displayed in the Database Directory text box of the Select Installation Folders dialog).
      UpgradeBinDir The binaries directory that you want to upgrade (displayed in the Executable Directory text box of the Select Installation Folders dialog).
      UpgradeINIFile The name of the JADE initialization file that you want to use during the upgrade process (displayed in the JADE INI File text box of the Select Installation Folders dialog).
      LicenseName The license company name (displayed in the License Name text box on the User Information dialog).
      LicenseKey The license key (displayed in the License Key text box on the User Information dialog). Do not include dash symbols (-).
      ReadmeFile The name of the text file (defaults to readme.txt) that you want to display at the end of the upgrade process if the value of the ShowReadme parameter is Yes.

    The title.bmp, readme.txt, and license.txt files on disk1 are default files. If you do not use any of the parameters in the above, you can overwrite or remove the files. File names for the parameters in the table are relative to the directory in which the setup.ini file is located (that is, to disk1).

    The directory paths specified in the UpgradeInstallDir, UpgradeDbDir, UpgradeBinDir, and UpgradeINIFile parameter values can include a Windows environment variable; for example, %USERPROFILE%\jade.

  4. Set the Read Only attribute for the setup.ini file to preserve the parameter values and then test your installation.

The upgrade setup initialization file must be called setup.ini. You must have a separate configured set of files on disk1, each containing a setup.ini file (and supporting files) for each product or customer whose JADE deployment upgrade you want to customize.

Following the successful upgrade, you will need to perform the following actions.

  1. Copy any additional files (for example, configuration files) that need to reside in the binaries directory

  2. Ship recompiled versions of any external method Dynamic Link Libraries (DLLs)