mqsibar command

Use the mqsibar command to deploy a BAR file to an integration server, or to compile the resources in a BAR file before it is deployed. You can also use the command to convert BAR files that are suitable for deploying to IBM® App Connect to a compatible format for use with IBM App Connect Enterprise.

Purpose

You can use the mqsibar command to deploy a BAR file to an integration server, before you start it, by unpacking the contents directly into the integration server's run directory. You can also choose to compile the resources that the BAR file contains (including DFDL schema, XML schema, and graphical data maps), which reduces the time that it takes for the deployed application to start processing messages.

The run directory is created when you run the mqsicreateworkdir command, which you run when you are configuring the integration server. For more information, see Configuring an integration server by modifying the server.conf.yaml file and mqsicreateworkdir command.

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.

For more information about how to use the mqsibar command, see Deploying integration solutions to a production environment.

Usage notes

  • You must specify the name of the input BAR file to be processed, by using the -a parameter.
  • In addition to specifying the name of the input BAR file, you must specify one or more of the following output options:
    • The compile flag (-c parameter).
    • The integration server work directory (-w parameter). If you specify the -w parameter, you cannot also specify the -t parameter.
    • The path to the output BAR file, containing the updated content (-o parameter).
    • The directory path to be used for temporary files (-t parameter). If you specify the -t parameter, you cannot also specify the -w parameter.
  • The BAR file that is processed by the mqsibar command must contain all referenced resources; for example, if an application in the BAR file references a library that is contained by a different BAR file, an error occurs. To avoid this situation, create a BAR file that contains all required shared libraries before using it as input to the mqsibar command.
  • You must start (or restart) the integration server after running the mqsibar command.
  • As well as compiling and deploying BAR files, you can also use the command to convert BAR files that are suitable for deploying to IBM App Connect to a compatible format for use with IBM App Connect Enterprise.

Syntax

Some parameters have alternative long names; for example, -a and --bar-file are alternative parameter names of the input BAR file to be processed. The long names available are listed in the Parameters section.

Syntax for deploying a BAR file to an integration server, or compiling the resources in a BAR file before it is deployed

Read syntax diagramSkip visual syntax diagram mqsibar -a inputBar -c  -w workdir -o outputBar -t tempDir -v traceFileName

Syntax for converting IBM App Connect BAR files to a compatible format for use with IBM App Connect Enterprise

Read syntax diagramSkip visual syntax diagram mqsibar  -p  -a inputBar -c  -o  outputBar  -t tempDir -v traceFileName

Parameters

The mqsibar command can have the following parameters:
-a | --bar-file inputBar
(Required) This parameter specifies the BAR file that contains the resources that you want to deploy. The command must be able to access and read the BAR file.
-c | --compile
(Optional) This parameter specifies that the runtime resources for XMLNSC/DFDL schema and graphical data maps will be compiled into binaries, ready to run when the application is deployed.

When you use -c and -w, all applications and libraries in the work directory will be processed, not just those in the BAR file. This is done to ensure that all resources are valid and ready to run.

-w | --work-dir workpath
(Optional) This parameter specifies the integration server work directory, into which the contents of the integration BAR file will be unpacked; as a result of this step, the application is ready to run when the integration server starts (or restarts, if it has already started).
-o | --output-bar-file outputBar
(Optional) This parameter specifies the file path to the output BAR file, into which the updated content will be written.
-t | --temp-directory tempDir
(Optional) This parameter specifies the directory path to be used for temporary files.
-p | --process-designer-bar
(Optional) Use this parameter to convert BAR files that are suitable for deploying to IBM App Connect to a compatible format for use with App Connect Enterprise.
-v | --trace traceFileName
(Optional) Send verbose internal trace to the specified file.

Examples

Always enter the command on a single line; in some examples, line breaks have been added to enhance readability.

The following example shows how to 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 
The following example shows how to update a BAR file by adding compiled resources.
mqsibar -a myAppAndShLibs.bar -c  
The following example shows how to specify the full path to the BAR file that you want to deploy.
mqsibar -a C:\Users\IBM_ADMIN\IBM\ACET12\workspace\AppConnectToIIB\AppConnectToIIB.bar -w /sis01Wrk
The following example shows how to convert a BAR file that is suitable for deploying to IBM App Connect to a compatible format for use with App Connect Enterprise.
mqsibar -p -a C:\Users\myUserDir\myAppConnect.bar -c -o C:\Users\myUserDir\myACE.bar