Updating your DBDOC installation

Updating your DBDOC installation

These instructions will guide you in installing the latest version of DBDOC over a previous version.

We recommend that you update the different components of DBDOC in the following order. This will ensure that no data is lost and will minimize live data downtime during the update.

To update DBDOC:

Step 1: Rebuild your project before updating

It is important to rebuild your project immediately before updating. This lets you keep the management of change descriptions generated by DBDOC accurate across the update.

This new project file will also be useful as a backup if you have any problems with the update.

Reasons for rebuilding first

  • Confirms that the current build system works.
  • Provides a valid Management of Change Report.
  • Ensures you have a working current DBDOC project file.
  • Provides a diagnostic set of data in case of a problem.

How do you rebuild?

  1. Open BuildPlus. On the toolbar menu, click the Build button.
  2. If there are any errors, stop and contact GMCL.

What to do after a successful build

  1. In BuildPlus, on the Tools menu, click Launch Windows Explorer. A Windows Explorer window will open.
  2. In the Windows Explorer window, open the ERROR_FILES folder.
  3. Rename the file ERROR.7Z to ERROR-old.7z. This will differentiate your old error files from the new ones.

Step 2: Update CIUMon

Information-noshadow.png Note: If CIUMon is running on a computer that should not be rebooted, please contact GMCL.

Updating CIUMon first ensures that live data is available throughout the rest of the update process. Note that you will need administrator privileges to update CIUMon.

Stop CIUMon

If CIUMon is running on the desktop, exit it now. If it is running as a service it will be stopped and restarted automatically when you install the new version.

Install the new version of CIUMon in the same location

The new version of CIUMon will be installed in the same location as the old version. The update method now depends on where CIUMon is installed.

Information-noshadow.png Note: If you find the CIUMon is installed in BOTH of the locations below on a single computer, please contact GMCL before continuing with the update. Two CIUMon installations on a single computer may cause problems.

Information-noshadow.png Note: If you are not sure how CIUMon was installed, you may try either of the following update methods. If you try the wrong method, you will get an error message indicating that you need to use the other method instead.

A: If CIUMon is installed in C:\Program Files\GMCL\DBDOC\Programs

In this case, CIUMon was installed with the Build System, and you should now update the Build System and CIUMon together. Follow the instructions in Step 3: Updating the Build System, then come back and verify that the new version of CIUMon works.

B: If CIUMon is installed in C:\DBDOC\CIUMon\Programs

In this case, CIUMon was installed with the CIUMon kit, and you need to update CIUMon by itself.

  1. Insert the DBDOC DVD. In Windows Explorer, open My Computer. Right-click the DVD, then click Explore. Double-click DBDOC Kits.
  2. Execute the correct CIUMon kit for your system:
    1. For Windows NT 4, run CIUMon_NT4_Kit.exe.
    2. For Windows 2000, run CIUMon_W2K_Kit.exe.
    3. For newer versions of Windows, run CIUMon_Kit.exe.
  3. The installer will open. Make sure to install in the same folder as your existing CIUMon installation.

Verify that the new version works

Run CIUMon manually to make sure that it will run and connect to the CIU correctly. Once it is connected, the messages in the CIUMon window will end with a green "OK".

If you run multiple CIUMon processes, verifying that each of them works is critical. Note that only the first one you run will know which configuration to use. You will have to select the correct configuration for the other CIUMon processes when you test them.

If you usually run your CIUMon processes as services, quit CIUMon once you have verified that it works so that you can restart the services.

Restart CIUMon services

In the Windows Services Manager, find each CIUMon service and start it.

Open Task Manager (press Ctrl+Shift+Esc). Check that the correct number of CIUMon processes are running in the "processes" display.

Now make sure that Hyperview users can access live data.

Step 3: Update the Build System

Update BuildPlus on the computer that you use to do builds. Note that you will need administrator privileges for this update.

Install the new version

  1. Insert the DBDOC DVD in the build computer.
  2. On the DVD splash screen, click Next.
  3. When prompted, enter the password from the back of the DBDOC DVD case.

You can also download the installers from our website.

We recommend updating Hyperview before you rebuild your project. This will ensure that the version of Hyperview you are using will be able to take advantage of any changes or improvements we have made.

Step 4: Updating Hyperview

Updating Hyperview next ensures that users will be able to open the new project file when you build it. There are two different procedures for updating Hyperview, depending on whether it is possible to schedule a time when no users are currently using it. It is slightly more involved to update Hyperview while it is in use, so use Option 1 if you can be certain nobody currently has Hyperview open.

Option 1: Updating Hyperview when nobody is using it

Use this method if you are the only Hyperview user, or you can be sure that no other Hyperview users have it running.

Find or schedule a time for an update

Unless you use Option 2 (below), the old version of Hyperview cannot be replaced while people are using it. All users will need to stop using Hyperview briefly during the update. Select a time when few users will be using Hyperview, and notify Hyperview users about the coming update. If you have multiple Hyperview installations (for instance, on your secure LAN and on your business LAN), schedule an update time for each installation.

Check the current install location

The new version of Hyperview must be installed as the same location as the old version, so that Hyperview users' shortcuts will continue to work. Make sure to check the locations for all your Hyperview installations.

For each shared Hyperview installation:

  1. On a computer that uses that installation, find the shortcut that is used to access Hyperview.
  2. Right-click the shortcut and then click Properties.
  3. Click the Shortcut tab.
  4. Look at the "Start In" data. It will tell you the location of the Hyperview installation.
Install the new version in the same location

The new version of Hyperview must be copied to the same location as the old version, so that Hyperview users' shortcuts will continue to work.

For each shared Hyperview installation:

  1. On any computer that can access the shared folder where Hyperview is installed, insert the DBDOC DVD. Exit the DBDOC Installation DVD window. In Windows Explorer, open My Computer. Right-click the DVD, then click Explore. Double-click DBDOC Kits.
  2. Double-click Hyperview_Kit.exe and follow the instructions on screen to install the kit.
  3. In the shared folder where the old version of Hyperview was installed, rename the Programs folder to Programs_old and Documents to Documents_old.
  4. Copy the contents of C:\DBDOC\Hyperview to the shared folder.
Make sure that the new version works

For each shared Hyperview installation:

On a computer that uses that installation, double-click the Hyperview shortcut. Hyperview should open your project.

  1. In Hyperview, browse to a CAD or CLD sheet, then press M. A single live data value should appear for each hotspot on the sheet.
    Information-noshadow.png Note: These values will turn red after a short time, to let you know they are not being continuously updated.
  2. On the Help menu, click Contents. The DBDOC help window should open.

If there are any problems with this step, please contact GMCL.

Option 2: Updating Hyperview when users may be using it

Use this method if it is difficult to ensure that there are no open copies of Hyperview running anywhere from the shared installation location. It is a little bit more involved than Option 1.

Check the current install location

The new version of Hyperview must be installed as the same location as the old version, so that Hyperview users' shortcuts will continue to work. Make sure to check the locations for all your Hyperview installations.

For each shared Hyperview installation:

  1. On a computer that uses that installation, find the shortcut that is used to access Hyperview.
  2. Right-click the shortcut and then click Properties.
  3. Click the Shortcut tab.
  4. Look at the "Start In" data. It will tell you the location of the Hyperview installation.
Install the new version in the same location

The new version of Hyperview must be copied to the same location as the old version, so that Hyperview users' shortcuts will continue to work.

For each shared Hyperview installation:

  1. On any computer that can access the shared folder where Hyperview is installed, insert the DBDOC DVD. Exit the DBDOC Installation DVD window. In Windows Explorer, open My Computer. Right-click the DVD, then click Explore. Double-click DBDOC Kits.
  2. Double-click Hyperview_Kit.exe and follow the instructions on screen to install the kit.
  3. Rename C:\DBDOC\Hyperview\Programs to C:\DBDOC\HYPERVIEW\Programs_new
  4. Copy C:\DBDOC\HYPERVIEW\Programs_new to the enclosing folder of the shared Programs folder. The enclosing folder will now contain Programs (with the old hyperview.exe), and Programs_new (with the new hyperview.exe).
  5. Rename the (running) hyperview.exe in the shared Programs folder to hyperview_old.exe (there should be no problem doing this).
  6. Also rename XpdfRasterizer.dll in the shared Programs folder to XpdfRasterizer_old.dll.
  7. Copy the files in Programs_new to Programs. Confirm replacing anything with the same name. There should be no complaints of the "file is open" variety. The new version of hyperview.exe will now be in the shared Programs folder.

When a user restarts the running Hyperview from their usual shortcut, the new version of Hyperview will be used.

Make sure that the new version works

For each shared Hyperview installation:

On a computer that uses that installation, double-click the Hyperview shortcut. Hyperview should open your project.

  1. In Hyperview, browse to a CAD or CLD sheet, then press M. A single live data value should appear for each hotspot on the sheet.
    Information-noshadow.png Note: These values will turn red after a short time, to let you know they are not being continuously updated.
  2. On the Help menu, click Contents. The DBDOC help window should open.

If there are any problems with this step, please contact GMCL.

Step 5: Rebuild your project

Rebuild your project, and put the new project file file in the shared folder.

Rebuild in BuildPlus

Open BuildPlus. On the Build menu, click Build.

Information-noshadow.png Note: After updating from DBDOC version 10.3.1 or earlier, BuildPlus will convert your projects to our new node format. This may take several minutes. This conversion will occur only once.

If there are any errors, stop and contact GMCL.

Make sure that Hyperview users can access the new project file

  1. On a computer that uses Hyperview over the network, open Hyperview. Hyperview should open your project.
  2. On the Help menu, click Current M14 File Revision. Check the M14 Compile Started date.
  3. If Hyperview did not open the new project file automatically, check the shortcut target:
    1. Right-click the shortcut and then click Properties.
    2. Click the Shortcut tab.
    3. Check that the Target is something like "[Hyperview install location]\hyperview.exe" "[shared project files location]\*.dbdoc". The wildcard (*) tells Hyperview to open the newest project file.

Make sure that Hyperview users can view live data

  1. On a computer that uses Hyperview over the network, open Hyperview. Hyperview should open your project.
  2. In Hyperview, browse to a CAD or CLD sheet, then press M. A single live data value should appear for each hotspot on the sheet.
Information-noshadow.png Note: These values will turn red after a short time, to let you know they are not being continuously updated.