Once you have created the business object definitions the connector is to support, you must deploy them into the message broker workspace (for WebSphere Business Integration Message Broker ) or deploy them to the message broker (for WebSphere MQ Integrator or WebSphere MQ Integrator Broker .) You do this using the System Manager . System Manager is installed with the Adapter Framework and provides a graphical user interface from which to configure and administer adapters. (For more information about System Manager, refer to the IBM WebSphere Interchange Server System Administration Guide and the IBM WebSphere Interchange Server Implementation Guide.)
To start System Manager, from the Windows Start menu select IBM WebSphere Business Integration Adapters > Tools > System Manager. Make sure you are viewing the System Manager perspective. The first step you should complete before creating a new project is to specify the importer paths.
You must specify the paths for the broker importer and message broker workspace directory before you deploy a project to a message broker if they are not in the same workspace.
Tip |
---|
After deployment, the Broker Application Development perspective in the System Manager workbench will display an entry for the destination message set project. If plugins for both System Manager and the Message Broker Toolkit are launched when you start the workbench, then they are in the same workspace. If you can see the Broker Application Development perspective in the same workbench as System Manager, then the Message Broker Toolkit plugins were also launched. |
For WebSphere MQ Integrator Broker or WebSphere MQ Integrator, enter the integrator importer path (under "Integrator Broker Settings"). The importer is called mqsilmpXMLSchema.exe and should be found in the bin directory of your broker installation.
For WebSphere Business Integration Message Broker, enter the message broker importer path and the message broker workspace directory (under "Message Broker Settings"). The importer is called mqsicreatemsgdefs.exe and should be found in the eclipse directory of your broker installation. Make sure to select the message broker workspace, not the System Manager workspace. The default path for the message broker workspace is eclipse\workspace. (The message broker workspace is the workspace used to store the message set and message flow projects, and any other projects of WebSphere Business Integration Message Broker tooling.)
To create a new user project, follow these steps:
The remaining steps in the deployment process differ depending upon which message broker you are using as an integration broker. In the next step you will right-click on the new project name and choose one of two types of deployment, as follows:
If you are using... | Select... | Refer to... |
---|---|---|
WebSphere Business Integration Message Broker | Deploy to message broker workspace | "Deploying to a message broker workspace" |
WebSphere MQ Integrator | Deploy to integrator broker | "Deploying to an integrator broker" |
WebSphere MQ Integrator Broker |
To deploy the project to a message broker workspace (for WebSphere Business Integration Message Broker used as the integration broker), do the following from System Manager:
Message set project name . Any text string designating the name of this project. This name will appear in the System Manager window when deployment is complete.
Base message set project and base message set. If you enter names of an existing base message set project and base message set, then the contents of the base message set will be used as the basis of the new destination project. All the message set definitions in the base project will be copied to the new destination project. In addition, the destination project will also include any business objects you selected from the previous window during this deployment. You can view the names of existing message set projects and base message sets from the Broker Application Development perspective of Message Broker Tooling.
Replace existing project with the same name. This option is applicable if the name entered in the Enter message set project name field is identical to the name of an existing project. If so, selecting this option replaces an existing project's content with content based on your selections during this deployment (only the name remains the same) . If this option is not checked and the specified project name matches that of an existing project, then the project retains whatever business objects it already contained and those selected during this deployment will be added. All existing business objects with the same names will be overwritten. If this option is checked but the project name does not match an existing project, this option is ignored and a new project is created.
Namespace aware and xml namespace format. By default, XML namespace format is set to short. It is important to select the correct combination of choices for Namespace aware and XML namespace format, or your deployment might fail. Refer to "Choosing XML Namespace length" for information on whether to select long or short for this parameter.
Deploy in verbose mode . Selecting this option will cause more details of the deployment process to be displayed or logged during deployment.
To deploy the project to an integrator broker (for WebSphere MQ Integrator or WebSphere MQ Integrator Broker used as the integration broker), do the following from System Manager:
When you deploy your project to a message broker, you have the option of selectinglong or short XMLNameSpace format. The default is short. XMLNameSpaceFormat is a standard configuration connection property for adapters. The choice you make within System Manager overrides whatever might already exist in the adapter's configuration file. If you are deploying to WebSphere Business Integration Message Broker, the Select the parameters window allows you to specify that the project is namespace-aware. If the project is namespace-aware, either short or long formats are allowed. If the project is not namespace-aware, then long must be used. Selecting short with a project that is not namespace-aware will cause deployment to fail.
Table 11. XMLNameSpace format alternatives
Message Broker | Namespace aware? | |
---|---|---|
Yes | No | |
WebSphere Business Integration Message Broker | long or short | long |
WebSphere MQ Integrator or WebSphere MQ Integrator Broker | N/A | long or short (for short, RFH2messagedomain must be xml) |