Configuring components

IBM Industry Solutions Workbench lets you configure the behavior of each component that is used in an application composition project. This configuration will be applied to a certain component only on the currently selected deployment target. That means, you have the option to configure each component individually for each of the deployment targets you have set up.

This allows you to have other settings for a development stage than for a production stage, e.g. on the configured log level.

Overview

Each component offers up to three different configuration options depending on the features it uses.

This can be

First, you need to select the deployment target for which you want to configure a component's behavior. Each deployment target's tab provides a menu bar at the top and the added components. The menu bar offers configurations related to all components in that deployment target while the components have an individual configuration that can be accessed by clicking on the three-dots-menu on a component's card.

Main configuration

This configuration is independent of the design model of the component and will always be available. To edit the configuration click on the three-dots-menu on a component's card. That will open the "Configure component" dialog showing the component's default configuration that is currently in use in the upper section.

This section is read-only and is intended to provide you with all relevant values. If you need to change some
values, you can use the lower section of the dialog called "Custom configuration". Here you can add any settings you want to override or add additional settings to the configuration.

Tip:

The "custom configuration" input field lets you insert text in YAML notation and also comments to add some additional notes on the purpose of a setting. The input field offers YAML syntax highlighting, but it will not validate your inputs.

Having your overrides in a separate file allows you to easily try out configurations and revert them since you always have the defaults in the upper text field and only the overrides in the lower text field. You can edit your custom configuration at any time but make sure to commit your changes to get applied to the deployment.

Restore default configuration

In case your custom configuration leads to errors you can always restore the defaults. To do so, simply remove the content in the "Custom configuration" section, click on "Save" and commit the changes for this deployment target by clicking on the "Commit" button.

API bindings

Note:

You only need to change these configurations in case the selected component makes use of API bindings.

These configurations are located in the deployment target's menu bar above the components. To open the settings, click on the cogwheel icon and select "API bindings". This will open the "Configure API bindings" dialog that lists all API bindings used by all the components on this deployment target.

Use the "Component" column in the table to find the bindings associated with the component you want to change. You can also use the search bar to filter by component in case there are many bindings in the table. Now you can edit the values of this API binding to your needs.

See API bindings for further details on the configuration of these bindings.

Warning:

Make sure to configure every single API binding that is listed in the table. Missing binding configuration will lead to failure of the pipeline.

Topic bindings

Note:

You only need to change these configurations in case the selected component makes use of events.

The topic bindings configurations are also located in the deployment target's menu bar above the components. To open the settings, click on the cogwheel icon and select "Topic bindings". This will open the "Configure topic bindings" dialog that lists all topic bindings used by all the components on this deployment target.

Use the "Component" column in the table to find the bindings associated with the component you want to change. You can also use the search bar to filter by component in case there are many bindings in the table. Now you can edit the values of this topic binding to your needs.

See event topic bindings for further details on the configuration of these bindings.

Warning:

Make sure to configure every single topic binding that is listed in the table. Missing binding configuration will lead to failure of the pipeline.