Start of change
IBM App Connect Enterprise, Version 11.0.0.2 Operating Systems: Windows, Linux


Configuring the IBM App Connect Enterprise web user interface

You can use the node.conf.yaml and server.conf.yaml configuration files to configure the port that is used to connect to the web user interface, and to secure the connection.

Before you begin

Configure an integration node or server, by following the instructions described in Modifying an integration node or Configuring an integration server by using the server.conf.yaml file.

About this task

The IBM App Connect Enterprise web user interface enables you to access integration node or integration server resources by using a web browser, and it provides integration administrators with a method of administering those resources. For more information about the web user interface, see IBM App Connect Enterprise web user interface.

Procedure

  1. Open the node.conf.yaml or server.conf.yaml configuration file for your integration node or server, by using a YAML editor.

    If you do not have access to a YAML editor, you can edit the file by using a plain text editor; however, you must ensure that you do not include any tab characters, which are invalid characters in YAML and would cause your configuration to fail. If you are using a plain text editor, ensure that you use a YAML validation tool to validate the content of your file.

  2. Set the RestAdminListener properties, which control the settings for the web user interface:
    1. Set the port property to the port that will be used by the web user interface and the IBM App Connect Enterprise Toolkit. By default, this port is set to 4414.
    2. Optional: If you want to secure the connection, set the following properties:
      host
      Specify the host name.
      sslCertificate
      Specify the path to the server certificate store, in the form /path/to/serverPKCS.p12.

      If you are using a .pem certificate, the sslCertificate is the full path to the server certificate key.

      If you are using .p12 or .pfx certificate, the sslCertificate is the full path to the server certificate store file.

      sslPassword
      Specify the server certificate password alias, in the form adminRestApi::sslpwd.

      If you are using a .pem certificate, the sslPassword is the full path to the server private key, which must be a standard private key and not an encrypted one.

      If you are using .p12 or .pfx certificate, the sslPassword is the passphrase or alias to the passphrase of the certificate store.

      requireClientCert
      Specify whether a certificate is to be requested from the client (true or false).
      caPath
      Specify the file path that contains certificate authority certificates; all files in this path will be read.
      basicAuth
      Specify whether clients require a web user name and password (true or false).
  3. If you want to view message flow statistics in the web user interface, you must also enable the reporting of message flow statistics and accounting data, as described in Starting and stopping the collection of message flow statistics and accounting data. The web user interface consumes message flow statistics and accounting data in JSON format, which means that you must include json as one of the values in the outputFormat property in the .conf.yaml configuration file.
  4. If you want to view resource statistics in the web user interface, you must enable the reporting of these statistics as described in Managing resource statistics collection.
  5. Restart the integration node or server for the changes to take effect.

Results

You can now access the web user interface by opening a browser and specifying the host and port that you configured in the .yaml configuration file. For more information, see Accessing the web user interface.

bj23620_.htm | Last updated 2018-11-02 14:46:26
End of change