Editing configurable properties in a BAR file

An administrator can use configurable properties to update target-dependent properties that are associated with a solution, such as queue names, queue manager names, and database connections.

Before you begin

Create a BAR file and add resources to it. For more information, see Creating a BAR file and Adding resources to a BAR file.

About this task

By changing configurable properties, you can customize a BAR file for a new integration node (for example, a test system) without editing and rebuilding the message flows or the resources that they use, such as message mappings, ESQL code, and Java™ code. For example, if you select an application, you can set the start mode for that application, or you can enable or disable Java isolation. If you select a message flow, you can change properties for policy sets, monitoring, and the security profile. You can also expand a message flow and set properties for the nodes in that flow. For information about the configurable properties that you can set, see Configurable properties in a BAR file.

Properties that you define are contained in the deployment descriptor file (META-INF/broker.xml). The deployment descriptor is parsed when the BAR file is deployed.

You can edit configurable properties in the following ways:

Editing configurable properties with the IBM Integration Toolkit

About this task

To edit properties by using the IBM® Integration Toolkit, complete the following steps.

Procedure

  1. Open the BAR file.
    The resources in your BAR file are listed on the Manage tab.
  2. Optional: You can view the properties that can be configured for your message flows and subflows by selecting Built resources that are configurable from the Filter by list.
  3. Optional: If you migrated the BAR file from a previous version, refresh the contents so that you can see and configure all the available properties. For more information, see Refreshing the contents of a BAR file.
  4. Select the resource that you want to configure.
    You can expand resources to show individual message flow nodes.
    The values that you can configure for the selected resource are displayed in the Properties view, on the Configure and Workload Management tabs.
  5. Update the appropriate values in the Properties view; see Configurable properties in a BAR file.
  6. Save the BAR file.

What to do next

Deploy the BAR file by following the instructions in Deploying integration solutions to a production environment.

Editing configurable properties with the mqsiapplybaroverride command

About this task

To edit properties by using the mqsiapplybaroverride command, complete the following steps.

Procedure

  1. Open a command window that is configured for your environment.
  2. Run the mqsireadbar command to see which properties you can configure; see mqsireadbar command.
    For example, the following command reads the file c:\myBarFile.bar and lists the properties for all applications and libraries in the file, including libraries inside applications:
    mqsireadbar -b c:\myBarFile.bar -r
  3. Create a text file, and list the properties that you want to change in the following format: 
    property=newValue
    For example, the following text file sets the value of the queueName property on the node MQ Input in the message flow sampleFlow, to NEW_INPUT_QUEUE, and clears the value of the queueName property on the subflow sampleSubflow1:
    # override.properties file
sampleFlow#MQ Input.queueName=NEW_INPUT_QUEUE
sampleSubflow1#queueName
  4. Run the mqsiapplybaroverride command, and specify the location of your BAR file, and the text file that lists the properties to change.
    For example, the following command reads the BAR file c:\myBarFile.bar, uses the c:\override.properties file to change the property values set in c:\myBarFile.bar and creates a new BAR file, c:\myNewBarFile.bar, with the resources configured to use the new properties:
    mqsiapplybaroverride -b c:\myBarFile.bar -p c:\override.properties -o c:\myNewBarFile.bar
    For more information about the mqsiapplybaroverride command, see mqsiapplybaroverride command.

What to do next

Deploy the BAR file by following the instructions in Deploying integration solutions to a production environment.