Deploying integration solutions to a production environment

After you create and populate a BAR file with the development resources, you can deploy the integration solution to an integration server.

Before you begin

Complete the following steps:
Note:

The mode in which IBM® App Connect Enterprise is running can affect the number of integration servers and message flows that you can deploy. For more information, see Restrictions that apply in each operation mode.

About this task

Choose one of the following methods to deploy a BAR file:

If you change a BAR file and want to propagate those changes to one or more integration servers, you must delete the existing BAR file from the integration server and deploy the new one.

Deploying a BAR file by using the web user interface

About this task

You can select a BAR file and deploy it to an integration server by using the web user interface.

You can also select an overrides file, which defines the BAR file properties that you want to change for a specific deployment. For more information, see mqsiapplybaroverride command.

Procedure

  1. Start the web user interface for your integration node or independent integration server, as described in Accessing the web user interface.
    For an integration node, the web user interface displays the node's integration servers. For an integration server, the web user interface displays the server's deployed message flows and other resources.
  2. Select the Deploy action.
    For example:
    • In the web user interface for an integration node, select the required integration server (where you want to deploy the BAR file), and then click Deploy.
    • In the web user interface for an independent integration server, click Deploy.
  3. Follow the instructions that are displayed.

Results

The contents of the BAR file are deployed to the integration server, and the deployed resources are shown.

Deploying a BAR file by using the IBM App Connect Enterprise Toolkit

About this task

To deploy a BAR file by using the IBM App Connect Enterprise Toolkit, complete the following steps. You can deploy to only one integration server at a time.

Procedure

  1. Optional: Typically, an incremental BAR file deployment is done. To do a complete BAR file deployment, right-click the target integration server in the Integration Explorer view and click Delete > All Flows and Resources.
    Wait for the operation to complete before you continue.

    To refresh only some of the resources with the contents of the BAR file, do not click Delete > All Flows and Resources.

  2. Deploy a BAR file to an integration server by using one of the following methods.
    • Drag the BAR file onto your target integration server in the Integration Explorer view.
    • Right-click the BAR file, then click Deploy and select the target integration server.
    • Right-click the target integration server, click Deploy, select BAR from workspace or BAR from file system, select the BAR file that you want to deploy, and click OK.
  3. If the BAR file has changed since you last edited it, you are asked whether you want to save the file before deployment. If you click Cancel, the BAR file is not saved and deployment does not take place.

Results

The contents of the BAR file (for example, message flows and message sets) are deployed to the integration server. In the Integration Explorer view, the deployed resources are added to the appropriate integration server.

Precompiling and deploying a BAR file by using the mqsibar command

About this task

You can use the mqsibar command to deploy a BAR file to an integration server, by unpacking the contents directly into the integration server's run directory. You can also choose to precompile the resources that the BAR file contains (such as XML schema, DFDL schema, and graphical data maps), so that they are ready to run when the integration server starts.

You can use the mqsibar command in a script, as part of an automated process that might include commands to test, tune, deploy, and run the application, as an alternative to deploying through the toolkit or web user interface. This method can be particularly useful if you are running IBM App Connect Enterprise in a cloud container.

Deploy a BAR file by using the mqsibar command, by completing the following steps.

Procedure

  1. Open a command window that is configured for your environment.
    For information about configuring your command environment in preparation for running commands, see Setting up a command environment.
  2. Run the mqsibar command, as shown in the following example:
    On Windows and Linux:
    Unpack the BAR file and compile resources into the integration server work directory, ready to be run when the integration server starts:
    mqsibar -a myAppAndShLibs.bar -c -w /sis01Wrk
    where:
    • -a specifies the name of the input BAR file to be processed.

      The BAR file must contain all referenced resources. If an application in the BAR file references a library that is contained by a different BAR file, an error occurs.

    • -c specifies that the contents of the BAR file will be compiled.

      Resources that are included in the BAR file, such as DFDL schema, XML schema, and graphical data maps, are compiled as a result of specifying this parameter.

    • -w specifies the integration server work directory.

      The integration server work directory is created by the mqsicreateworkdir command, which you run when you are configuring the integration server. When the work directory is created, a run subdirectory is also created, and it is this directory that the contents of the BAR file are unpacked into when the mqsibar command is run. For more information about configuring and starting an integration server, see Configuring an integration server by modifying the server.conf.yaml file and Starting an integration server.

    For more information about using the mqsibar command, see mqsibar command.

  3. Start (or restart) the integration server, for the changes to take effect.

Results

The command reports when responses are received from the integration server. If the command completes successfully, it returns 0 (zero).

Deploying a BAR file by using the mqsideploy command

About this task

To deploy a BAR file by using the mqsideploy command, complete the following steps.

Procedure

  1. Open a command window that is configured for your environment.
  2. Enter the appropriate command for your operating system and configuration, by using the following examples as a guide. 
    mqsideploy -i ipAddress -p port -a barfile
    mqsideploy --admin-host ipAddress --admin-port port --bar-file barfile

    The command completes an incremental deployment. To do a complete BAR file deployment, add the -m parameter.

    The -i (IP address) and -p (port) parameters represent the connection details for the independent integration server or the integration node.

    If deploying to an integration node, you must also specify the -e (integration server name) parameter. If you want to run this command against an integration node on the same computer, you can specify the integration node name instead of -i and -p, as in the following example:

    mqsideploy integrationNodeName -e integrationServerName
-a barfile

    If you have a .broker file that contains the connection details for an independent integration server or integration node, you can specify this file instead of -i and -p by using the -n parameter, as in the following example:

    mqsideploy -n integrationNodeFileName -e integrationServerName
-a barfile
    where integrationNodeFileName is the path and file name of the .broker file.

    For alternative long names for parameters, and for more information about the command, see mqsideploy command.

Results

The command reports when responses are received from the integration node or independent integration server. If the command completes successfully, it returns 0 (zero).

Deploying a BAR file by using the IBM Integration API

About this task

To deploy a BAR file by using the IBM Integration API, use the deploy method of the ExecutionGroupProxy class.

The following code shows how an application can do an incremental deployment:
import
com.ibm.broker.config.proxy.*;
public class DeployBAR {

  public static void main(String[] args) {
    BrokerConnectionParameters bcp =
       new IntegrationNodeConnectionParameters("localhost",
4414);
    try {
      BrokerProxy b = BrokerProxy.getInstance(bcp);
      ExecutionGroupProxy eg = b.getExecutionGroupByName("default");
      DeployResult dr = eg.deploy("MyBAR.bar", true, 30000);
      System.out.println("Result = "+dr.getCompletionCode());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}
By default, the deploy method completes an incremental deployment. To do a complete deployment, use a variant of the method that includes a false value for the Boolean isIncremental parameter. For example, eg.deploy("MyBAR.bar", false, 30000).

Deploying a BAR file to IBM App Connect Enterprise as a Service

With App Connect Enterprise as a Service, you can deploy and manage integration solutions that were developed in the App Connect Toolkit.

Before you begin

  • Before you can deploy an integration solution to App Connect Enterprise as a Service, you must purchase a subscription. For more information, see App Connect as a Service pricing plans in the App Connect Enterprise as a Service documentation.
  • To check with BAR file resources are supported in App Connect Enterprise as a Service, see Supported resources in imported BAR files in the App Connect Enterprise as a Service documentation.

About this task

App Connect Enterprise as a Service provides a fully managed environment that you can use to deploy integration solutions to the cloud without the need to acquire and maintain an IT infrastructure.

You deploy a solution to App Connect Enterprise as a Service by uploading the BAR file to the cloud. For more information, see Deploying integrations in the App Connect Enterprise as a Service documentation.