See information about the latest product version
Verifying your installation by using the WebSphere Message Broker Toolkit
Use the instructions in this tutorial to verify your installation of WebSphere® Message Broker and learn how to run samples with the WebSphere Message Broker Toolkit.
- Create a Default Configuration.
- Run the Pager samples.
- (Optional) Start the Samples Preparation wizard.
- Remove the samples.
Before you can run sample programs, you must use the Default Configuration wizard to create a broker, which has a fixed name and properties that the samples depend on.
The Default Configuration wizard requires that the following conditions are met:
- You have installed the Broker component and the WebSphere Message Broker Toolkit.
- None of the Default Configuration wizard resources exist (the resources are listed in the table that is included later in this section).
- This configuration is required for test and evaluation purposes only.
- Your current user ID has the following characteristics on Windows only:
- It is a member of groups mqbrkrs and mqm.
- It has Administrator authority.
- It is a local ID, not a domain ID.
For more information about these security requirements, see Broker component security.
You cannot complete the configuration and verification described here if the previously described conditions are not met.
Use the following instructions to complete these tasks:
- Start the WebSphere Message Broker Toolkit:
- On Windows:
On Windows, you cannot complete verification unless you have Administrator authority; carry out verification with the same user ID that you used to complete installation.
If you did not launch the WebSphere Message Broker Toolkit from the installation wizard, launch it from the Start menu, or run the script file provided. On a command line, navigate to the root directory of the package group and enter the following command:
launcher.bat
The script file runs the following command; if you prefer you can use this command yourself:
eclipse.exe -product com.ibm.etools.msgbroker.tooling.ide
- On Linux:
On Linux on x86 and Linux on x86-64, you do not need root authority to complete verification. You cannot launch the WebSphere Message Broker Toolkit from the installation wizard because you might experience problems during operation if you were to create resources such as brokers when you are logged in as root, and this option is therefore unavailable.
Log off from the user ID with which you have installed the product. Log in as the same ID (if ID is not root), or log in as another ID, but do not become root.
Launch the WebSphere Message Broker Toolkit from the main menu or run the script file provided. On a command line, navigate to the root directory of the package group and enter the following command:
./launcher
If you prefer, you can also run the application directly:
./eclipse -product com.ibm.etools.msgbroker.tooling.ide
However, you must set the LD_LIBRARY_PATH before running the application. For details about how to set LD_LIBRARY_PATH, see the launcher script.
When you first launch the WebSphere Message Broker Toolkit, you are asked to specify the location of your workspace. This directory exists on your local drive, and is where the WebSphere Message Broker Toolkit stores all the resources that you create. You can accept the default directory shown, or you can specify your own choice either by typing it in, or by clicking Browse to specify the location. Select Use this as the default and do not ask again to inhibit the display of the workspace dialog next time you launch the WebSphere Message Broker Toolkit.
The WebSphere Message Broker Toolkit opens and the Welcome page is displayed.
- On Windows:
- Click the Get Started icon
to begin the configuration and verification process.
The Get Started page opens, from which you can start the Quick Tour or create a default configuration that is used by a sample program to verify that your installation is successful.
- Create the Default Configuration:
- On the Get Started page, click the link to Create
the Default Configuration.
The "Creating the Default Configuration" page opens.
- Click Start the Default Configuration wizard.
Follow the guidance provided by the wizard to navigate through its pages.
The wizard creates a default broker that can be used by a sample program to verify that your installation is successful.
The wizard displays a progress bar that shows which task it is currently performing. It also reports on all the actions that it takes by writing progress information into a scrollable text window from which you can copy and paste some or all of the information displayed.
The information in the text window is also written to a log file in your workspace directory structure. The default workspace directory is shown in the example, but you can choose another location when you start the WebSphere Message Broker Toolkit.
- Linux on x86 and Linux on x86-64
-
user_home_dir/IBM/wmbt80/workspace/.metadata/ DefaultConfigurationWizard.log
- Windows
-
user_home_dir\IBM\wmbt80\workspace\.metadata\ DefaultConfigurationWizard.log
If the wizard encounters an error in processing, it informs you of what has happened and returns any error information, for example a return code from a command. If you know why the error has occurred from the error text, and can correct the situation, you can do so now. Return to the error message display and click Yes to continue the wizard.
If you do not understand the error, and do not know how to fix it, click No. If the wizard can, it rolls back all the actions that it has taken so far, so that when it completes, your system is in the same state as it was before you started the wizard. The text window shows you exactly what the wizard has, and has not, done.
Click Open Log File to access the log from the summary page of the wizard; this option is available whether the wizard has succeeded or failed.
The wizard creates the resources shown in the following table.
Table 1. Resources created by the Default Configuration wizard Name Type MB8BROKER Broker MB8QMGR WebSphere MQ queue manager that hosts the broker. The queue manager has a listener at the first available port greater than or equal to 2414. It also starts the broker so that it is ready to process a sample.
- On the final page, ignore the option to start the Samples Preparation wizard; you start this wizard later in these instructions.
- Click Finish to close the wizard. When the wizard completes, it opens the Broker Application Development perspective and displays the resources that the wizard has created.
- On the Get Started page, click the link to Create
the Default Configuration.
- To verify
your installation, click Help > Samples and Tutorials > WebSphere Message Broker Toolkit - Message Broker to open the Samples and Tutorials panel. The Samples and Tutorials panel can also
be opened from the Welcome page.
- Expand Application Samples, and
click Pager Samples to open the Pager
samples page. The following options are displayed:
- Import and deploy the Pager samples
This option starts the Samples Preparation wizard, which helps you to import the samples into your workspace, and to deploy the samples and associated resources (for example, message flows) to the default broker.
- Run the Pager samples
This option opens the help page that contains a description of each of three sample programs, and icons that you can click to start each one.
- Find out what the Pager samples do
This option opens a page that describes in detail what the Pager samples do and how they work. You can examine the message flows that implement the sample function, and the messages that are handled by those flows.
- Import and deploy the Pager samples
- Click Import and deploy the Pager samples. The Samples Preparation wizard starts and displays its first page. The option to import and deploy to the default broker is preselected.
- Click Next and follow the guidance
provided by the wizard to navigate through its pages.
The wizard displays a progress bar that shows which task it is currently performing. It also reports on all the actions that it takes by writing progress information into a scrollable text window.
You can copy and paste some or all of the information that is reported in this text window. This information is also written to the following log file:
- Linux on x86 and Linux on x86-64
-
user_home_dir/IBM/wmbt80/workspace/.metadata/ samplePreparationWizard.log
- Windows
-
user_home_dir\eclipse\workspace\.metadata\ samplePreparationWizard.log
If the wizard encounters an error in processing, it informs you of what has happened and returns any error information, for example a return code from a command. If you know why the error has occurred from the error text, and can correct the situation, you can do so now. Return to the error message display and click Yes to continue the wizard.
If you do not understand the error, and do not know how to fix it, click No. If the wizard can, it rolls back all the actions that it has taken so far, so that when it completes, your system is in the same state as it was in before you started the wizard. The text window shows you exactly what the wizard has, and has not, done.
The wizard displays information messages to show that the Pager samples and associated resources are deployed and ready to run.
- Click Next when you have read the messages about the actions that have been completed by the wizard. The confirmation page is displayed.
- Click Finish to close the wizard. The "Pager samples" page (from which you launched the wizard) is redisplayed.
- Click Run the Pager samples.
On the page that opens, click How to use the applications to
read about the Text Messenger and Surf report publisher applications.
When you understand what the applications do, and how to use them,
click the icon that represents the application that you want to run.
If you want more detailed information about the contents of these applications, and how the message flows work, click Find out what the Pager samples do.
- When you have sent and received messages successfully, you have verified that your installation is complete. You can now close your Pager applications and the Samples Gallery.
- Expand Application Samples, and
click Pager Samples to open the Pager
samples page. The following options are displayed:
- (Optional) You can start the Samples Preparation wizard
to create the resources and start other supplied sample programs.
Click File > New > Other > Message Broker - Default Configuration and Samples in the WebSphere Message Broker Toolkit,
and select Prepare the Samples. The Samples
Preparation wizard opens, and lists other samples that are available.
You can view information about samples only when you use the information center that is integrated with the WebSphere Message Broker Toolkit or the online information center. You can run samples only when you use the information center that is integrated with the WebSphere Message Broker Toolkit.
- To remove the sample or samples when you have finished
with them, run the Samples Preparation wizard
again and remove the samples that you have added. This action removes
the samples from the broker, and removes the sample resources from
your workspace.
When you have completed your verification tests, run the Default Configuration wizard to remove all the default resources. Use the same workspace and the same user ID that you used to create the resources. To start the wizard from the WebSphere Message Broker Toolkit, click File > New > Other and expand Message Broker - Default Configuration and Samples. Select Create the Default Configuration and click Next.