Retrieving a deployed BAR file

Retrieve a BAR file from a deployed application in the IBM® App Connect Enterprise Toolkit or the web user interface.

About this task

Retrieve a BAR file from a deployed application in the IBM App Connect Enterprise Toolkit as described in Retrieving a deployed BAR file from your toolkit workspace.

Retrieve a BAR file from a deployed application in the web user interface as described in Retrieving a deployed BAR file from the web user interface.

Some limitations can apply due to legacy message flow formats in the retrieved BAR file.
For more information, see Limitations of legacy message flow formats.

Retrieving a deployed BAR file from your toolkit workspace

Before you begin

Install IBM App Connect Enterprise 12.0.9.0 or later to use this feature.

About this task

You can retrieve a BAR file from a deployed application in the IBM App Connect Enterprise Toolkit.

Procedure

  1. Optional: Regeneration of deployed BAR files is enabled by default in IBM App Connect Enterprise. If you want to disable the option to retrieve a BAR file, update the setting in the server.conf.yaml file by completing the following steps:
    1. Use a YAML editor to open the server.conf.yaml file.

      You can edit the file by using the built-in YAML editor that is provided in the IBM App Connect Enterprise Toolkit, either by double-clicking the file in the Application Development view or by right-clicking the file and selecting Open with > YAML editor. If you choose to edit the file by using a plain text editor, ensure that you do not include any tab characters (which are not valid in YAML) and use a YAML validation tool to validate the contents of your file.

      For more information about working with YAML, see http://www.yaml.org.

    2. In the RestAdminAPI section, uncomment the line that contains the allowBARRegeneration property, and set its value to false.
    RestAdminAPI:

  allowBARRegeneration: false        # Allow a BAR file to be regenerated and source to be retrieved. Default is true.
  2. In the Integration Explorer view, select a deployed application from which you want to import a BAR file.
  3. Right-click the application to display the menu.
  4. Click Retrieve BAR file in the menu. If Retrieve BAR file is disabled in the menu, there are two possible reasons:
    • The application is in stopped state due to missing dependencies.
    • The option to retrieve a BAR file is disabled in the server.conf.yaml file.

    If the BAR file that you want to retrieve exists in your workspace, a dialog opens to warn you that the retrieved BAR file will overwrite the existing BAR file in your workspace. Click Continue to overwrite the existing BAR file in your workspace or click Cancel.

    A dialog opens to confirm that a BAR file was created in your workspace and is available for use. The dialog contains a link to the location of the retrieved BAR file. If you retrieved the BAR file from a deployed application that is named My.App, the location of the imported BAR file is YourWorkspace\GeneratedBARFiles\MyApp.regenerated.bar.

  5. Click the link to open the BAR file in the BAR file editor.
    The BAR file editor opens and contains a list of the BAR file contents. The list includes the application from which the BAR file was imported. If the application references any shared libraries, or contains any static libraries or policy projects, these artifacts are included in the list. If you select Build and Save on the Prepare tab and there are no source files in your workspace for the application that is contained in the BAR file, a warning message is displayed.
  6. Click OK to close the dialog.

Results

The contents of the directory C:\temp\Deploy are deployed to the integration server, and the deployed resources are shown.

For more information, see ibmint deploy command.

Retrieving a deployed BAR file from the web user interface

Before you begin

Install IBM App Connect Enterprise 12.0.11.0 or later to use this feature.

About this task

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. Optional: If you are retrieving a deployed BAR file from a node-managed integration server, select the integration server to display the deployed applications.
  3. Retrieve a deployed BAR file by using one of the following methods:
    • By using Grid view:
      1. Click View as grid to display the deployed applications in grid format.
      2. In the tile for a deployed application, click Open list of options > Retrieve as BAR file.
    • By using Table view:
      1. Click View as table to display the deployed applications in table format.
      2. In the table row for a deployed application, click Open list of options > Retrieve as BAR file.

Results

The deployed BAR file is retrieved into your home directory.

What to do next

You can deploy the BAR file to another integration server. For more information, see Deploying integration solutions to a production environment.