Deploying a message flow application
=====================================
Deploy message flow applications to execution groups by adding required resources, optionally with their source files, to a broker archive (BAR) file. Send the BAR file to a broker, which unpacks and stores its contents ready for when your message flows are started.
Before you start:
Before you can deploy a message flow application, you must have created and started a broker. You must also start a WebSphere® MQ listener for the associated queue manager.
In the WebSphere Message Broker Toolkit, you must connect to a broker, and create an execution group.
The mode in which your broker is working, can affect the number of execution groups and message flows that you can deploy, and the types of node that you can use. See Restrictions that apply in each operation mode.
If you are working with a single message flow, and want to deploy and test it quickly, you can deploy just that flow. Drag the message flow on to the execution group to which you want to deploy it. A broker archive (BAR) file is generated automatically, and deployed to the broker. You can then run and test the message flow, change the flow, and deploy it again with a minimum of steps involved.
In most cases, you are working with one or more message flows, one or more message sets, and other objects that you want to deploy with the message flows. In these cases, you can deploy these resources together by creating a BAR file yourself, and deploying just that file:
1. Creating a broker archive
2. Adding files to a broker archive
3. Refreshing the contents of a broker archive
4. Deploying a broker archive file
5. Deploying a message flow application that uses WebSphere Adapters
6. Importing a broker archive file to the WebSphere Message Broker Explorer
If your message flows include user-defined nodes, you must also distribute the compiled C or Java™ code for each node to every broker that uses those message flows. For more details, see Developing user-defined extensions.
Creating a broker archive
==========================
Create a separate broker archive (BAR) file for each configuration that you want to deploy to execution groups on your brokers.
You can create a BAR file in two ways:
* Using the WebSphere® Message Broker Toolkit
* Using the mqsicreatebar command
Using the WebSphere Message Broker Toolkit
Follow these steps to create a BAR file by using the WebSphere Message Broker Toolkit:
1. Click File > New > Message Broker Archive.
2. Enter a name for the BAR file that you are creating.
3. Click Finish.
A file with a .bar extension is created and is displayed in the Broker Application Development perspective Navigator view, under the Broker Archives folder. The Content editor for the BAR file opens.
Next:
1. Add files to the BAR file
2. Deploy the BAR file
Using the mqsicreatebar command
Follow these steps to create a BAR file by using the mqsicreatebar command:
1. Open a command window that is configured for your environment.
2. Enter the command, typed on a single line. For example:
mqsicreatebar -b barName -o filePath -p projectNames -cleanBuild
You must specify the -b (BAR file name) and -o (path for included files) parameters. The -p (project names) parameter is optional. For further details, see the mqsicreatebar command.
If you have made changes to resources in the broker archive by using external tools, add the -cleanBuild parameter to refresh all the projects and invoke a clean build.
A file with a .bar extension is created.
Adding files to a broker archive
==================================
To deploy files to an execution group, you must first include them in a broker archive.
Before you start:
Create a broker archive (BAR) file for each configuration that you want to deploy.
You can add any deployable resources from your workspace to a BAR file. If you select Include source files, the source files for all message flows, message sets, or other deployable resources in the broker archive are included.
For further information about the files that you can include in a broker archive, see Broker archive.
Subflows are not displayed in the Build page as separate items, and are added automatically, therefore you have to add only the parent flow to include the subflows.
You can manually add XML, XSL, and JAR files by following these steps. However, JAR files that are required by JavaCompute nodes within message flows are added automatically from your Java project when you add the message flow. XML and XSL files are also added automatically if they are required by the flow.
You do not have to redeploy JAR files unless you have updated them. If one or more JAR files in your BAR file are present on the computer where the broker is running, you can safely remove them from your BAR file before you deploy again. JAR files available to the broker include JAR files that you have deployed as well as JAR files that exist in the shared-classes directory or the classes subdirectory of the installation directory. For example, the files com.ibm.mq.jar, ConfigManagerProxy.jar, jplugin2.jar, and javacompute.jar are always visible to the broker, and do not have to be deployed separately.
You cannot read deployed files back from broker execution groups. Therefore, keep a copy of the deployed BAR file, or of the individual files within it.
Follow these steps to add files to a broker archive using the WebSphere® Message Broker Toolkit:
1. Double-click your BAR file in the Broker Administration Navigator view to open it. The contents of the BAR file are shown in the Manage page of the Broker Archive editor. (If the BAR file is new, this view is empty.)
2. On the Prepare page of the Broker Archive editor, select deployable workspace resources to add to the broker archive file.
3. Optional: If you want to include your source files, select Include source files.
4. Optional: If you are adding a message flow to a broker archive for a second time, and have used the Manage page to change flow parameters, select Override configurable property values to reset configuration settings. If this control is cleared, existing settings are left in place when a flow is replaced.
5. Optional: You can manually remove the resources that you have added to the BAR file using Remove in the Manage page.
6. Click Build broker archive. To rebuild selected deployable resources, you can either click Build broker archive on the Prepare page, or click Build on the Manage page.
A list of the files that are now in your BAR file is displayed on the Manage page. You can choose not to display your source files by selecting Built resources or Configurable properties from the list in the Filter by menu.
Editing a broker archive file manually
=======================================
Edit resources that you want to change, in an editor of your choice, by exporting a broker archive (BAR) file from the WebSphere® Message Broker Toolkit.
Before you start:
If you have not already created a BAR file, create it now. See Creating a broker archive.
Follow these steps to edit a BAR file manually by using the WebSphere Message Broker Toolkit:
1. Export the BAR file.
1. From the WebSphere Message Broker Toolkit, click File > Export. The Export window appears.
2. Select the export destination, such as a compressed file with .zip extension, and click Next.
3. Select the resources that you want to export and click Next.
4. Complete the destination information and click Finish. The file appears at the destination you specified as a compressed file.
2. Extract files from the BAR file.
3. Edit the properties that you want to change in an editor of your choice.
4. Save the file.
5. Import the BAR file back into the WebSphere Message Broker Toolkit for deployment.
1. From the WebSphere Message Broker Toolkit, click File > Import. The Import window appears.
2. Select Zip file from the list and click Next
3. Specify the name and location of your BAR file.
4. Select the project that you want to contain the BAR file.
5. Click Finish.
Adding multiple instances of a message flow to a broker archive
================================================================
Edit the name of your files in the broker archive (BAR) file so that you can deploy multiple instances of a message flow with different values for the configurable properties.
Before you start:
Add the file to the broker archive. See Adding files to a broker archive.
To deploy multiple instances of the flow with different values for the configurable properties:
1. Rename the message flow file (.cmf) in the broker archive editor. Ensure you keep the .cmf file extension when you change the file name. You are unable to configure the file if you change the extension.
2. Clear Remove contents of Broker Archive before building to prevent your renamed message flow file from being removed from the broker archive when you build the broker archive.
3. Add the message flow to the BAR file again. It is added to the BAR file with the original name.
4. Click the Manage and Configure tab. You can now edit the configurable properties for both message flows.
Tip: The names assigned in the BAR file are also used on the command line; for example, if you run mqsilist on your execution group or if you run mqsichangetrace for a message flow.
Refreshing the contents of a broker archive
============================================
Refresh the contents of a broker archive by using Build on the Manage and Configure page or Build broker archive on the Prepare page in the Broker Archive editor. Alternatively, remove resources from your broker archive and, having made the required changes, add them back again.
Before you start:
See Creating a broker archive and Adding files to a broker archive.
You are likely at some time to make changes to resources that you have already added to your broker archive (BAR) file. Follow these steps to refresh the contents of a broker archive so that they are reflected in the archive before you deploy it.
1. Switch to the Broker Application Development perspective.
BAR files that need to be refreshed are shown with an 'out-of-sync' icon Inconsistent in the Navigator view. (When any changes are made to deployable files in the workspace, that have previously been built in the broker archive, the BAR file is considered to be inconsistent. The BAR file is also inconsistent if any changes are made to the project that the files belong to.)
2. Double-click your BAR file in the Navigator view to open it.
The contents of the BAR file are shown in the Manage and Configure page of the Broker Archive editor.
3. To refresh all the resources in the broker archive, click either Build Build.
A dialog box opens, showing progress. When the operation is complete, click Details to see information about what was refreshed, what was not, and why. If the refresh process was successful, you see the same information that is placed in the user log by each of the resource compilers.
Alternatively, you can refresh the archive contents by right-clicking a BAR file in the Navigator view and selecting Build Broker Archive. The broker archive is rebuilt in the background.
You can view, and clear Clear, the user and service logs by clicking the appropriate tabs in the Broker Archive editor.
4. (Optional) To view details about the build of an individual deployable resource in the Manage and Configure page, right-click the deployable resource and click Details.
The Properties view opens (if it is not already in the perspective) and the Details tab is displayed. The Details tab shows the following details about the deployable resource:
* Workspace Resource, with references to the linked workspace resources (.msgflow , .mset, .xml, and .xslt files, for example).
* Last Compile Status, which shows the user log entry for the last compilation. You can copy text, but you cannot modify it.
=====================================
Deploy message flow applications to execution groups by adding required resources, optionally with their source files, to a broker archive (BAR) file. Send the BAR file to a broker, which unpacks and stores its contents ready for when your message flows are started.
Before you start:
Before you can deploy a message flow application, you must have created and started a broker. You must also start a WebSphere® MQ listener for the associated queue manager.
In the WebSphere Message Broker Toolkit, you must connect to a broker, and create an execution group.
The mode in which your broker is working, can affect the number of execution groups and message flows that you can deploy, and the types of node that you can use. See Restrictions that apply in each operation mode.
If you are working with a single message flow, and want to deploy and test it quickly, you can deploy just that flow. Drag the message flow on to the execution group to which you want to deploy it. A broker archive (BAR) file is generated automatically, and deployed to the broker. You can then run and test the message flow, change the flow, and deploy it again with a minimum of steps involved.
In most cases, you are working with one or more message flows, one or more message sets, and other objects that you want to deploy with the message flows. In these cases, you can deploy these resources together by creating a BAR file yourself, and deploying just that file:
1. Creating a broker archive
2. Adding files to a broker archive
3. Refreshing the contents of a broker archive
4. Deploying a broker archive file
5. Deploying a message flow application that uses WebSphere Adapters
6. Importing a broker archive file to the WebSphere Message Broker Explorer
If your message flows include user-defined nodes, you must also distribute the compiled C or Java™ code for each node to every broker that uses those message flows. For more details, see Developing user-defined extensions.
Creating a broker archive
==========================
Create a separate broker archive (BAR) file for each configuration that you want to deploy to execution groups on your brokers.
You can create a BAR file in two ways:
* Using the WebSphere® Message Broker Toolkit
* Using the mqsicreatebar command
Using the WebSphere Message Broker Toolkit
Follow these steps to create a BAR file by using the WebSphere Message Broker Toolkit:
1. Click File > New > Message Broker Archive.
2. Enter a name for the BAR file that you are creating.
3. Click Finish.
A file with a .bar extension is created and is displayed in the Broker Application Development perspective Navigator view, under the Broker Archives folder. The Content editor for the BAR file opens.
Next:
1. Add files to the BAR file
2. Deploy the BAR file
Using the mqsicreatebar command
Follow these steps to create a BAR file by using the mqsicreatebar command:
1. Open a command window that is configured for your environment.
2. Enter the command, typed on a single line. For example:
mqsicreatebar -b barName -o filePath -p projectNames -cleanBuild
You must specify the -b (BAR file name) and -o (path for included files) parameters. The -p (project names) parameter is optional. For further details, see the mqsicreatebar command.
If you have made changes to resources in the broker archive by using external tools, add the -cleanBuild parameter to refresh all the projects and invoke a clean build.
A file with a .bar extension is created.
Adding files to a broker archive
==================================
To deploy files to an execution group, you must first include them in a broker archive.
Before you start:
Create a broker archive (BAR) file for each configuration that you want to deploy.
You can add any deployable resources from your workspace to a BAR file. If you select Include source files, the source files for all message flows, message sets, or other deployable resources in the broker archive are included.
For further information about the files that you can include in a broker archive, see Broker archive.
Subflows are not displayed in the Build page as separate items, and are added automatically, therefore you have to add only the parent flow to include the subflows.
You can manually add XML, XSL, and JAR files by following these steps. However, JAR files that are required by JavaCompute nodes within message flows are added automatically from your Java project when you add the message flow. XML and XSL files are also added automatically if they are required by the flow.
You do not have to redeploy JAR files unless you have updated them. If one or more JAR files in your BAR file are present on the computer where the broker is running, you can safely remove them from your BAR file before you deploy again. JAR files available to the broker include JAR files that you have deployed as well as JAR files that exist in the shared-classes directory or the classes subdirectory of the installation directory. For example, the files com.ibm.mq.jar, ConfigManagerProxy.jar, jplugin2.jar, and javacompute.jar are always visible to the broker, and do not have to be deployed separately.
You cannot read deployed files back from broker execution groups. Therefore, keep a copy of the deployed BAR file, or of the individual files within it.
Follow these steps to add files to a broker archive using the WebSphere® Message Broker Toolkit:
1. Double-click your BAR file in the Broker Administration Navigator view to open it. The contents of the BAR file are shown in the Manage page of the Broker Archive editor. (If the BAR file is new, this view is empty.)
2. On the Prepare page of the Broker Archive editor, select deployable workspace resources to add to the broker archive file.
3. Optional: If you want to include your source files, select Include source files.
4. Optional: If you are adding a message flow to a broker archive for a second time, and have used the Manage page to change flow parameters, select Override configurable property values to reset configuration settings. If this control is cleared, existing settings are left in place when a flow is replaced.
5. Optional: You can manually remove the resources that you have added to the BAR file using Remove in the Manage page.
6. Click Build broker archive. To rebuild selected deployable resources, you can either click Build broker archive on the Prepare page, or click Build on the Manage page.
A list of the files that are now in your BAR file is displayed on the Manage page. You can choose not to display your source files by selecting Built resources or Configurable properties from the list in the Filter by menu.
Editing a broker archive file manually
=======================================
Edit resources that you want to change, in an editor of your choice, by exporting a broker archive (BAR) file from the WebSphere® Message Broker Toolkit.
Before you start:
If you have not already created a BAR file, create it now. See Creating a broker archive.
Follow these steps to edit a BAR file manually by using the WebSphere Message Broker Toolkit:
1. Export the BAR file.
1. From the WebSphere Message Broker Toolkit, click File > Export. The Export window appears.
2. Select the export destination, such as a compressed file with .zip extension, and click Next.
3. Select the resources that you want to export and click Next.
4. Complete the destination information and click Finish. The file appears at the destination you specified as a compressed file.
2. Extract files from the BAR file.
3. Edit the properties that you want to change in an editor of your choice.
4. Save the file.
5. Import the BAR file back into the WebSphere Message Broker Toolkit for deployment.
1. From the WebSphere Message Broker Toolkit, click File > Import. The Import window appears.
2. Select Zip file from the list and click Next
3. Specify the name and location of your BAR file.
4. Select the project that you want to contain the BAR file.
5. Click Finish.
Adding multiple instances of a message flow to a broker archive
================================================================
Edit the name of your files in the broker archive (BAR) file so that you can deploy multiple instances of a message flow with different values for the configurable properties.
Before you start:
Add the file to the broker archive. See Adding files to a broker archive.
To deploy multiple instances of the flow with different values for the configurable properties:
1. Rename the message flow file (.cmf) in the broker archive editor. Ensure you keep the .cmf file extension when you change the file name. You are unable to configure the file if you change the extension.
2. Clear Remove contents of Broker Archive before building to prevent your renamed message flow file from being removed from the broker archive when you build the broker archive.
3. Add the message flow to the BAR file again. It is added to the BAR file with the original name.
4. Click the Manage and Configure tab. You can now edit the configurable properties for both message flows.
Tip: The names assigned in the BAR file are also used on the command line; for example, if you run mqsilist on your execution group or if you run mqsichangetrace for a message flow.
Refreshing the contents of a broker archive
============================================
Refresh the contents of a broker archive by using Build on the Manage and Configure page or Build broker archive on the Prepare page in the Broker Archive editor. Alternatively, remove resources from your broker archive and, having made the required changes, add them back again.
Before you start:
See Creating a broker archive and Adding files to a broker archive.
You are likely at some time to make changes to resources that you have already added to your broker archive (BAR) file. Follow these steps to refresh the contents of a broker archive so that they are reflected in the archive before you deploy it.
1. Switch to the Broker Application Development perspective.
BAR files that need to be refreshed are shown with an 'out-of-sync' icon Inconsistent in the Navigator view. (When any changes are made to deployable files in the workspace, that have previously been built in the broker archive, the BAR file is considered to be inconsistent. The BAR file is also inconsistent if any changes are made to the project that the files belong to.)
2. Double-click your BAR file in the Navigator view to open it.
The contents of the BAR file are shown in the Manage and Configure page of the Broker Archive editor.
3. To refresh all the resources in the broker archive, click either Build Build.
A dialog box opens, showing progress. When the operation is complete, click Details to see information about what was refreshed, what was not, and why. If the refresh process was successful, you see the same information that is placed in the user log by each of the resource compilers.
Alternatively, you can refresh the archive contents by right-clicking a BAR file in the Navigator view and selecting Build Broker Archive. The broker archive is rebuilt in the background.
You can view, and clear Clear, the user and service logs by clicking the appropriate tabs in the Broker Archive editor.
4. (Optional) To view details about the build of an individual deployable resource in the Manage and Configure page, right-click the deployable resource and click Details.
The Properties view opens (if it is not already in the perspective) and the Details tab is displayed. The Details tab shows the following details about the deployable resource:
* Workspace Resource, with references to the linked workspace resources (.msgflow , .mset, .xml, and .xslt files, for example).
* Last Compile Status, which shows the user log entry for the last compilation. You can copy text, but you cannot modify it.
Comments
Post a Comment