Chapter 1 . Installing MessageQ

This chapter contains the following topics that describe how to install MessageQ software on Windows NT systems:


Preparing to Install the MessageQ Software

Before you install MessageQ, there are several installation requirements you should perform to ensure that the installation runs smoothly and the software is installed correctly, as follows:

  1. Check the contents of the distribution kit.

  2. Comply with the hardware, software, and disk space requirements.

  3. Back up your system disk.

  4. Choose the type of installation that is applicable for your system (typical, compact or custom).

Checking the Software Distribution Kit

Use the bill of materials (BOM) to check the contents of your software distribution kit. The kit contains the following:

Read Before Installing Letter

Your distribution kit includes a letter, Read Before Installing MessageQ for Windows NT, Version 4.0A. This letter tells you how to access the release notes, which provide late-breaking information you should read before installing, configuring, or using MessageQ software.

Media

Your kit contains a CD-ROM for industry-standard CD readers, labeled MessageQ for Windows NT, Version 4.0A. This CD-ROM contains both Digital Alpha© and Intel® versions.

Hardcopy and Online Documentation

The MessageQ for Windows NT documentation set contains the following manuals in Winhelp, HTML, and hardcopy formats:

As part of your software distribution kit, MessageQ provides this online documentation in HTML format which you can read using any World Wide Web browser. For more information on how to access the online documentation, refer to the section on Using the Online User Documentation.

Complying with the Installation Prerequisites

Before you install MessageQ software you must have access to an account with Administrator privileges on the system where you are installing MessageQ. Also, your system must meet the hardware, software, and disk space requirements listed in the Read Before Installing MessageQ for Windows NT letter.

Backing up the System Disk

We recommend that you back up your system disk before installing any software. For details on performing a system disk backup, see your Windows NT system documentation.


Installing the MessageQ Software on Windows NT Systems

This topic describes the tasks for installing the MessageQ software on Windows NT systems, as follows:

The length of a MessageQ installation can vary, depending on the type of media from which you are installing and your system configuration. You can stop the installation procedure any time by clicking Exit or Cancel in the currently active dialog. When you interrupt the installation, files created up to that point are not deleted automatically; you must delete these files manually.

Appendix A lists the files installed on your system during the installation procedure.

Choosing Which Subsets to Install

The MessageQ installation dialogue displays a list of options that let you choose the type of MessageQ installation for your system. If you choose an installation option and then decide you don't want to install it, you can cancel your selection to redisplay the list of available options.

Table 1-1 describes the types of installations available and the subsets installed for each installation type.
Table 1-1 MessageQ Installation Options for Windows NT Systems

Installation Option Description

Typical

Installs all of the program options. This installation is recommended for most users. The Typical option installs the following subsets:

Compact

Installs the minimum required options to run MessageQ. The Compact option installs the following subsets:

Custom

This installation lets you choose the exact MessageQ options you want installed on your system. You can choose from the following subsets:

Note: The Development Environment and Example Programs are not included in the Runtime Media Kit.

Installing MessageQ on Systems Already Running MessageQ

We recommend that you install Version 4.0A software in the default installation directory called C:\Program Files\BEA Systems\MessageQ. If you have a previous version of MessageQ for Windows NT installed on your system and choose to install into the same directory, the previous version of the software will be completely overwritten. Regardless of the directory in which the product is installed, the icons for the Program Manager are overwritten to point to the new installation. If a previous version is installed, you will not be able to access it from the Program Manager using the icons.

Note: Before you can run your existing applications under MessageQ Version 4.0A, you must convert your group configuration data to use the Version 4.0A format. Refer to the last section in this chapter entitled Performing Postinstallation Tasks for more information on how to convert existing group configuration data.

Installing MessageQ for Windows NT

The following procedure describes how to install MessageQ software for Windows NT.

Note: You can stop the installation procedure at any time by clicking Exit in the Installation Options dialog. You can also return to the previous dialog by clicking Back.

  1. Log into the Administrator account.

  2. Load the MessageQ distribution CD-ROM into the CD reader.

  3. Open Windows Explorer.

  4. Double-click the Server folder.

  5. Double-click setup.exe to start the installation.

  6. Click Continue after the SETUP utility displays the dialog box that welcomes you to the MessageQ software installation.

  7. Choose the destination location and click Next. The default installation for MessageQ is C:\Program Files\BEA Systems\MessageQ.

  8. Choose between a Typical, Compact, or Custom installation and click Next.

  9. Choose the Program Folder name and click Next.

  10. After the files are transferred to your system, click OK to complete the installation.

Figure 1-1 shows the MessageQ program group created after the server installation is complete.

Figure 1-1 MessageQ Program Group Server Icons

Table 1-2 describes the program group utility icons.
Table 1-2 Utility Group Programs

MessageQ Icon Description

MessageQ Monitor

Windows-based program that lets you monitor the messaging activity of the MessageQ message queuing buses and groups you have created.

MessageQ Event Watcher

Windows-based program that provides a console window to view message activity.

MessageQ Group Control Process

Program that creates a MessageQ for Windows NT message queuing group.

MessageQ Test Program

Windows-based utility that enables you to test message exchanges between the queues you configured. See the Programmer's Guide for more information.

MessageQ Loader

Automatically loads the group configuration at group startup, and can be invoked manually to change certain group characteristics while a group is running.

MessageQ Uninstaller

Automatically removes all relevant MessageQ files from your system. We recommend that you use the Uninstaller to remove MessageQ from your sysem rather than manually deleting files.

MessageQ Service Manager

Windows-based utility used to configure the message queuing groups that you would like to be automatically started and stopped by the MessageQ Service. Refer to the section entitled Starting the MessageQ Service for Windows NT for more information.

Introduction to MessageQ

An overview of MessageQ features. Read this book first to learn about MessageQ software before installing and using it.

Programmer's Guide

A detailed description about using the MessageQ application programming interface to build and integrate distributed applications

Configuration Guide

A step-by-step guide to configuring, managing and monitoring the MessageQ environment

MessageQ Release Notes

Important information about MessageQ software that should be read before performing the installation. For information on how to print the Release Notes, see the Read Before Installing MessageQ for Windows NT letter.

Recovering from Installation Errors

If errors occur during the MessageQ installation procedure for Windows NT, be sure you have met all of the system software and hardware requirements as outlined in the Read Before Installing MessageQ for Windows NT letter.

If the installation fails, SETUP displays a dialog indicating that the installation was not successful. Installation failures can occur if the following conditions exist:

If you encounter a problem while using MessageQ and you believe the error is caused by a problem with MessageQ, call BEA technical support. See How to Get Technical Support in the Preface for additional information.

Using the Online User Documentation

MessageQ includes online documentation in HTML format that can be read using a World Wide Web browser. To use the HTML-based online documentation, invoke a World Wide Web browser, and use the "Open File" option to open the following file:

drive:\installation directory\books\bookshelf.html

Where:

drive:

The letter of the drive (for example, C:, D:, or E:) where you installed the online documentation

\installation directory

The directory where you installed the online documentation (for example: \documentation)

Begin navigating the online documentation using the hyperlinks. Note that each book in the online documentation set is listed and accessible on the bookshelf.html page. The first page in each book is the table of contents. Hyperlinks can be used to navigate through the information contained within a single book. To view information in a different book, you must return to the contents page of the book you are reading and then jump to the bookshelf page to select another book.

For those sites with a corporate intranet, MessageQ documentation can be copied to a single node and linked into the corporate information base contained on an internal Web site. Copying the online documentation to an intranet server limits the use of disk space to a single system while making it accessible to everyone on the corporate intranet. After the documentation is copied to the corporate Intranet server, users must be given a URL to access the documentation or a description of the page from which the documentation can be accessed.


Performing Postinstallation Tasks

After completing the installation procedure, you can perform the required and optional postinstallation tasks. MessageQ does not require you to perform the postinstallation tasks in a particular order.

The postinstallation tasks are as follows:

Configure the network

Required

Start the MessageQ Service for Windows NT

Optional

Add the MessageQ drive and directory to your Path

Required

Converting Group Configuration Data

Required

Configuring the Network

To configure MessageQ for Windows NT to communicate with remote systems, you must have configured TCP/IP networking and started the TCP/IP service. The remote systems that you intend to communicate must have their names and Internet Protocol (IP) addresses entered in the \winnt\system32\drivers\etc\hosts file. Note that the local system must have an entry in this file as well, if MessageQ is to operate properly. Enter the local system name using uppercase letters.

It is important to note that the node names are case sensitive. Your Windows NT system name, which was defined when Windows NT was installed or when you used the Network applet in the Control Panel, is in uppercase. To use MessageQ for Windows NT to communicate with other networked systems by way of TCP/IP, we recommend that your TCP/IP host name be the same as your Windows NT system name, and should be defined in uppercase letters.

For example, if your Windows NT system is ANTARES, your TCP/IP host name, as defined in the Network applet and the \winnt\system32\drivers\etc\hosts file should also be defined as ANTARES. Your Windows NT system name is the name that will be presented to remote MessageQ systems when initiating connections.

Starting the MessageQ Service for Windows NT

MessageQ for Windows NT provides a service that starts buses and groups on demand. The MessageQ Service for Windows NT is installed as part of the Run-Time Environment during the installation, and runs in the background when no one is logged on to the system. By default, the MessageQ service for Windows NT is not started when it is installed.

To use the MessageQ Service, you must begin by using the MessageQ Service Manager to configure the message queuing groups that you would like to be automatically started and stopped by the MessageQ Service. You can run this utility by double clicking the MessageQ Service Manager icon in the main MessageQ window.

To start the MessageQ service, select the Services applet in the Control Panel and choosing Start. When the service starts up, it will in turn start all message queuing groups configured for automatic startup. You can also change the default configuration of the MessageQ Service using the Services applet in the Control Panel to enable the MessageQ Service to start automatically when the system boots.

Adding the MessageQ Drive and Directory to Your Path

The MessageQ executable images must be located in the user's default path to operate properly. Add the MessageQ drive and directory to your Path as follows:

  1. Open the Control Panel.

  2. Double-click the System icon.

  3. In the System Properties window, click on the environment tab to edit the Path entry. If no path variable is present, create one by entering "Path" in the Variable field.

  4. Click the Value text field and then press the End key, or use the right arrow key to scroll to the end of the field.

  5. If the Value field is blank, enter the following at the end of the field:

    drive:\installation directory\bin

    where:

    drive:

    The letter of the drive (for example, C:, D:, or E:) where you installed MessageQ for Windows NT

    \installation directory\bin

    The directory path where you installed MessageQ for Windows NT. For example:

    \Program Files\BEA Systems\MessageQ.\bin

    If a path variable is present, do not delete it. Add a semicolon (;) to the end of the existing Path specification and then add the MessageQ Path variable as described above.

  6. Click Set to set the drive and directory path.

  7. Click OK to confirm the new settings.

  8. Close the Control Panel.

  9. Log out of the Windows NT system and then log back in to initialize the new Path.

Converting Your Group Initialization File to Version 4.0

MessageQ for Windows NT provides a conversion utility that lets you quickly convert your existing group configuration data so that it is compatible with the Version 4.0A software. This section describes how to use the conversion utility called dmqconvert.

MessageQ for Windows NT, Version 4.0A no longer provides the Configuration Editor for configuring message queuing groups. This release now uses an initialization file to store all group configuration data making the Windows NT environment compatible with all other MessageQ Server environments. Due to this change, MessageQ configuration data is no longer stored in the NT Registry. When you convert your existing groups to Version 4.0A, the MessageQ conversion utility copies the existing data from the NT Registry to the file that you specify using a common group initialization file format.

Note that the conversion utility does not update the group initialization file to include the new Version 4.0A sections and parameters. To update your initialization file to use new Version 4.0 features, refer to the information in this chapter, which describes all the sections and parameters in the group initialization file. Using a text editor, you can add to or change the existing initialization files to incorporate Version 4.0A parameters and their associated settings.

To convert your existing group initialization file, follow these steps:

  1. Change directory as follows:

    cd \Program Files\BEA Systems\MessageQ

  2. To convert your initialization file, enter the following command:

    dmqconvert -b x -g y -f myfile.init

    Where:

    x

    The Bus number of the group initialization file you want to convert

    y

    The Group number of the group initialization file you want to convert

    myfile.init

    The name you want to give to the new initialization file