In IBM Integration Bus, the Web User Interface, also known as WebUI, is a browser-based interface where you can manage your integration solutions. It provides an alternative method to using the command interface. In the WebUI, you can also monitor resources used by your integration solutions. You can use this information to analyze and tune the performance of your solutions.

These are some of the tasks that you can do in the WebUI:

  • Manage the run time environment.
  • Deploy integration solutions.
  • Manage integration solution resources that are deployed to a run time environment.
  • Manage configurable services.
  • Manage operational policies.
  • Analyze and tune the performance of your integration solutions.
  • Analyze and tune the performance of the resources used by your integration solutions.

For more information, see IBM Integration Bus web user interface.

Start the WebUI

In the IBM Integration Toolkit, you start the WebUI as follows:

Right-click the integration node and then select Start Web User Interface from the menu.

Start the WEBUI from IBM Integration Toolkit

You can also start the WebUI directly from a browser. For more information, see Accessing the web user interface

Show more information

By default, when you start IBM Integration Toolkit, an integration node is created.

IBM Integration Toolkit

When the default integration node is created, the web user interface is enabled automatically and assigned to port 4414.

WebUI

Administration tasks

Check the status of the WebUI

To check the status of the web user interface associated with an integration node, you run the mqsireportproperties command in a command line.

mqsireportproperties integrationNodeName -b webadmin -o server -a

For example, in Windows, you run the command in the IBM Integration Console:
WebUI command

Enable the WebUI

To enable the web user interface for an integration node, you run the following command:

mqsichangeproperties integrationNodeName -b webadmin -o server -n enabled -v true

command to enable WebUI

IMPORTANT: To ensure that the changes applied by running the mqsichangeproperties command take effect, you must restart the integration node.

Disable the WebUI

To disable the the web user interface for an integration node, you run the following command:

mqsichangeproperties integrationNodeName -b webadmin -o server -n enabled -v false

command to disable WebUI

IMPORTANT: To ensure that the changes applied by running the mqsichangeproperties command take effect, you must restart the integration node.

Change the port used by an integration node

IMPORTANT: Make sure that your integration node is running.

To change the port that an integration node uses, you must run the following command in the system where the integration node is available:

mqsichangeproperties integrationNodeName -b webadmin -o HTTPConnector -n port -v portValue

command to change port of an integration node

IMPORTANT: To ensure that the changes applied by running the mqsichangeproperties command take effect, you must restart the integration node.

When you change the port of the integration node, the WebUI associated to that integration node uses that same port number.

Control access to data and resources in a local integration node by using file-based authorization

You can control access to data and integration node resources by assigning permissions to users. You can manage users individually or groups of them by managing roles.

To control access to data and resources in the WebUI, complete the following steps:

IMPORTANT: Ensure that the system user ID that you use to run the commands is a member of the mqbrkrs group. Read, write, and execute permissions are granted automatically on the integration node to all user IDs that belong to this group.
  1. Step 1: Enable administration security

    1.1 Start the IBM Integration Console

    To start the IBM Integration Console in Windows, use the Windows menu option Start IBM Integration Console 10.0.0.0

    IBM Integration Console

    1.2 Stop the integration node

    To stop the integration node, you can run the following command in the IBM Integration Console:

    mqsistop TESTNODE_MachineA

    mqsistop command

    1.3. Run the mqsichangeauthmode command to enable administration security

    You can configure the integration node to use file-based authorization or to use queue-based authorization (mq mode).

    To configure the file-based authorization mode for a local integration node, you run the mqsichangeauthmode command.

    To enable administration security with the file-based authorization mode for the TESTNODE_MachineA integration node, enter the following command:

    mqsichangeauthmode TESTNODE_MachineA -s active -m file

    where -s active enables administration security for the integration node, and -m file specifies the file-based authorization mode.

    mqsichangeauth command

    For more information, see mqsichangeauthmode command.

    Use the mqsireportauthmode command to view the mode of administration security currently in effect for granting and revoking administration authority.

    mqsireportauthmode command

    For more information, see mqsireportauthmode command.

    1.4. Start the integration node

    To start the integration node, you can run the following command in the IBM Integration Console:

    mqsistart TESTNODE_MachineA

  2. [Optional] Step 2: Define the roles and their associated permissions
    When the integration node is configured to use file-based authorization (file mode), you define the roles and associated permissions on the integration node, by using the mqsichangefileauth command.

    Show more information

    IBM Integration Bus supports three levels of authorization: read, write, and execute.
    For a list of available tasks and the administration permissions required, see Tasks and authorizations for administration security.
    • You can assign permissions to a role by specifying the type of permission followed by a plus (+) to grant permissions, or a minus (-) to revoke permissions. For example: read+
    • You specify the permissions as a comma-separated list of values. For example: read+,execute-
    • These permissions can be applied to each role for the following types of objects:
      • Integration node resources
      • Integration server resources
      • Data capture objects (record-replay)
    • If you grant permissions to a role at the integration node level, that permission is not applied to the node’s integration servers. You must set permissions explicitly for individual integration servers.
    • If you grant permissions associated with integration server resources or data capture objects to users that use the web user interface, you must also grant the users read access to the integration node.

    2.1 Define a role and its associated permissions

    To define a group, named iibObserver, with permissions to see resources, you can use the following command to define this observers role:

    mqsichangefileauth TESTNODE_MachineA -r iibObserver -p read+

    mqsichangefileauth command

    To define a group, named iibAdmins, with permissions to manage resources, you can use the following command to define this admins role:

    mqsichangefileauth TESTNODE_MachineA -r iibAdmins -p all+

    mqsichangefile auth command for administrators

    For more information, see mqsichangefileauth command.

    2.2 Check the file-based administration security permissions for an integration node

    To check the file-based administration security permissions for an integration node, you can use the mqsireportfileauth command. For example:

    mqsireportfileauth TESTNODE_MachineA -l

    where l indicates that you want the complete list of groups and permissions defined on an integration node.

    mqsireportfileauth command

    For more information, see mqsireportfileauth command.

    Related task: Delete a role and its associated permissions

    To delete a group, you run the following command:

    mqsichangefileauth TESTNODE_MachineA -r iibAdmins -p all-

    where -r indicates the group that you want to delete and -p all- is required to remove all permissions to that group and to delete the group.

  3. Step 3: Create the web users
    Use the mqsiwebuseradmin command to create your web user accounts and optionally assign them to the appropriate roles.

    3.1 Create a WebUI user account

    • When you create a WebUI account, you can only associate the account with a single role.
    • You can have multiple WebUI user accounts assigned to the same role.

    To create an account, you must run the following command:

    mqsiwebuseradmin TESTNODE_MachineA -c -u jk -p password -r iibAdmins

    where -c indicates that you want to create the user, -p indicates the password, -r indicates the role to which you want to add the user.

    mqsiwebuseradmin command

    NOTE: You can also create users without specifying a role. Assigning a user to a group is optional.

    Related task: Delete a WebUI user account

    To delete a WebUI user account, you must run the following command:

    mqsiwebuseradmin TESTNODE_MachineA -d -u jk -p password -r iibAdmins

    where -d indicates that you want to delete the user, -p indicates the password, -r indicates the role from which you want to remove the user.

    mqsiwebuseradmin delete command

    Related task: As an administrator, change the password of a WebUI user account by using the mqsiwebuseradmin command

    You can change the password by using the mqsiwebuseradmin command.

    You can run the following command:

    mqsiwebuseradmin TESTNODE_MachineA -m -u jk -p password1 -r iibAdmins

    where -m indicates that you want to modify the user, -p indicates the new password, -r indicates the role of the user.

    Related task: As a user, change the password of your userid to access the WebUI

    As a user, you can change your password once you log in into the WebUI.

    To change your password, you can complete the following steps:

    1. Select Edit profile.

      edit profile

    2. In the Password section, click Change.

      Change password

    3. Enter your new password and click Save.
    4. Save new password

17 comments on"Get started for administrators with the Web User Interface (WebUI) in IBM Integration Bus v10"

  1. saikiran Mallam July 21, 2017

    Hi,
    I am unable to view the HTTP Connector option in startwebuser interface for IIB 10.0.0.3 and IIB 10.0.0.6 . I am trying to set HTTP connector port number through mqsi commands, the command is getting executed successfully but couldn’t see the changes. Tried restarting the broker and toolkit but nothing is working. Now how to know whether the changes got applied or not? how to get details on webGUI?

  2. I have setup the ldap WebUi following this steps:

    1.- Setup id and password to validate with ldap:
    mqsisetdbparms MYBROKER -n ldap::ldap.myldap.net -u “CN=ServiceID,OU=Services,OU=Public,DC=MyCompany,DC=net” -p password

    2.- Setup ldap bind with Broker
    mqsichangeproperties MYBROKER -b webadmin -o server -n ldapAuthenticationUri -v “\”ldaps://ldap.myldap.net:3862/\”?Services?sub”

    3.- Create webid
    mqsiwebuseradmin MYBROKER -c -u myldapid -p password -r mqm

    4.- Display webadmin settings
    -bash-4.1$ mqsireportproperties MYBROKER -b webadmin -o server -a

    server=”
    uuid=’server’
    enabled=’true’
    ldapAuthenticationUri='”ldaps://ldap.myldap.net:3862/”?Services?sub’
    enableSSL=’true’

    BIP8071I: Successful command completion.

    Everything seems to be ok but I still can not access WebUi with my ldapid.

    Can you help me to see What am I missing here?

    thx

    • Hi,
      After enabled the webuserAdmin on Linux server, trying to connect from local IIB-toolkit by selecting the option “Connect to Remote Integration Node”, getting the below error.
      Please help me what I missed or need to follow.

      Error: The following Java exception occurs:

      Connection refused: connect

      Thanks..

    • did you figure out the solution ? Even i am having exact same issue.

  3. Cristian Gomez Lezcano August 17, 2016

    Great article, I´m having problems to setup webadmin through LDAP I´d like to see an article for that in the future.

  4. Great article.
    Can you also please share some knowledge on deployment methods and the roles required for the user to do the deployments through Web-UI.

  5. Nice Article.
    I am trying to view tatistics in WEB UI on my local system .However it is reflecting message “The statistics monitoring capability is not available through your current web browser”.I am using Internet Explorer V9.0.Is there any constraint for the version of web browser we need to use.

  6. Great article and thanks for sharing. Minor corerction in the mqsiwebuseradmin command password must be specified by using -a instead of -p

Join The Discussion

Your email address will not be published. Required fields are marked *