Configuring the web user interface server

To configure a web user interface server, complete the following steps:

1. Configure the properties relating to the HTTP or HTTPS port to be used, and enable the web user interface server, by using the IBM Integration Explorer or the mqsichangeproperties command.
   • If you are using the IBM Integration Explorer, complete the following steps:
     1. In the MQ Explorer - Navigator view, navigate to IBM WebSphere MQ > Brokers, right-click your broker name, and select Properties.
     2. Select the WebAdmin tab.
     3. Enable the web user interface and set the port to use for your chosen protocol.

        If you are using HTTP, set Enabled to true, set Enabled SSL to false, and enter a value for the HTTP Port.

        If you are using HTTPS, set Enabled to true, set Enabled SSL to true, and enter a value for the HTTPS Port.

        To set additional parameters for the HTTPS protocol, you must use the command-line interface. For more information, see Parameter values for the webadmin component.

     4. To review your changes, click Apply; to close the Properties window, click OK. You can also confirm the changes by examining recent Change Notification entries in the Administration Log view.
   • If you are using the mqsichangeproperties command, complete the following steps:
     1. Configure the properties relating to the HTTP or HTTPS port to be used.
        • If you are using HTTP, run the following command:

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

          • brokerName is the name of your broker
          • portValue is the HTTP port value that you want to use for the web user interface
        • If you are using HTTPS, run the following command:

          mqsichangeproperties brokerName 
          -b webadmin -o HTTPSConnector -n port,keystoreFile,keystorePass 
          -v portValue,fileName,password

          • brokerName is the name of your broker.
          • portValue is the HTTPS port value that you want to use for the web user interface.
          • fileName is your keystore file.
          • password is the password for the keystore file.

        For more information about the properties that can be set for the HTTPConnector and HTTPSConnector objects, see Parameter values for the webadmin component.

     2. Confirm that the properties are set correctly.
        • If you are using HTTP, run the following command:

          mqsireportproperties brokerName 
          -b webadmin -o HTTPConnector -a

        • If you are using HTTPS, run the following command:

          mqsireportproperties brokerName 
          -b webadmin -o HTTPSConnector -a

        This command produces a response similar to this example (for the HTTPConnector):

        HTTPConnector
          uuid='HTTPConnector'
          address=''
          port='4144'
          maxPostSize=''
          acceptCount=''
          compressableMimeTypes=''
          compression=''
          connectionLinger=''
          connectionTimeout=''
          maxHttpHeaderSize=''
          maxKeepAliveRequests=''
          maxThreads=''
          minSpareThreads=''
          noCompressionUserAgents='
          restrictedUserAgents=''
          socketBuffer=''
          tcpNoDelay=''
          enableLookups='false'

     3. Enable the web user interface server for the broker:
        • To enable the web user interface, and to use HTTP as the communication protocol between the broker and the web user interface server, run the following command on an IBM Integration Bus command line, where brokerName is the name of your broker:

          mqsichangeproperties brokerName 
          -b webadmin -o server -n enabled,enableSSL -v true,false

        • To enable the web user interface, and to use HTTPS as the protocol for communication between the broker and the web user interface server, run the following command:

          mqsichangeproperties brokerName 
          -b webadmin -o server -n enabled,enableSSL -v true,true

        For more information about the properties of the web user interface server, see Parameter values for the webadmin component.

     4. Confirm that the web user interface component is enabled by running the mqsireportproperties command, as shown in the following example.

        mqsireportproperties brokerName -b webadmin -o server -a

        This command produces a response similar to this example:

        server=''
          uuid='server'
          enabled='true'
          enableSSL='true'

2. Optional: The time that is taken to load data in the web user interface can be reduced by compressing the data. Compression is turned on by default for new brokers. For migrated brokers, compression is turned off by default.

   You can enable and disable compression by using the mqsichangeproperties command. When you enable compression, you must use the mqsichangeproperties command to turn on compression and set the file types to be compressed.

   1. Turn on compression, as shown in this example:

      mqsichangeproperties brokerName -b webadmin -o HTTPConnector -n compression -v on

   2. Set the file types that are to be compressed, as shown in this example:

      mqsichangeproperties brokerName -b webadmin -o HTTPConnector -n compressableMimeTypes 
      -v \"text/html,text/css,application/javascript,image/gif,image/png,application/json\"

   3. Use the mqsireportproperties command to check that compression has been set correctly, as shown in this example:

      mqsireportproperties brokerName -b webadmin -o HTTPConnector -r 

      Check the output from the mqsireportproperties command to verify that the settings are correct. The output should be similar to that shown in the following example:

      ...
      compressableMimeTypes='text/html,text/css,application/javascript,image/gif,image/png,application/json'
      compression='on'
      ...

      If you are using SSL, change the properties for HTTPSConnector rather than HTTPConnector.

3. To ensure that the changes take effect, restart the broker. For more information, see Starting and stopping a broker.
4. Create a web user account by using the mqsiwebuseradmin command. For more information, see Managing web user accounts.