Skip to Content

Installing BMC Helix Client Gateway

Related topics

BMC Helix Client Gateway connectivity

Use the information in this topic to install the BMC Helix Client Gateway for the first time. Refer to the following topics for more information about BMC Helix Client Gateway.

  • Requirements - System requirements and Gateway configuration options.
  • Upgrading - Upgrading from an older version of the BMC Helix Client Gateway to the latest version.
  • Configuring - BMC Helix Client Gateway configuration elements and adding a proxy.

To download installation files for Windows

  1. Go to the EPD website and sign in with your BMC Helix Support ID.
  2. Click Product Download Tool.
  3. On the All Products tab, search for BMC Helix ITSM.
  4. Click on the latest product version. 
    Important: Disable your browser's pop-up blocker before downloading files.
  5. On the Product tab, select the latest BMC Helix Client Gateway version for Microsoft Windows.
  6. Click Download.
Warning
Important

The zip file contains a Kaazing Developer License Agreement (LICENSE file). This developer license is superseded by the agreement you signed with BMC Helix. The XML file provided by BMC Helix includes the following legal disclaimer:

To BMC Customers: If you are a current BMC Customer and are accessing the Kaazing Enterprise Gateway Developer Edition software product (the "Software") through a link provided by BMC, the terms of your agreement with BMC will govern your use of the Kaazing Software and shall supersede all other agreements with Kaazing Corporation, including the Kaazing Developer License Agreement, which you may be required to accept prior to downloading the Kaazing Software.

To install the gateway service for Windows

  1. Extract the downloaded setup files to your gateway server. 
    For example, C:\Program Files\Kaazing. You can use any folder based on your organization's naming standards.
  2. Navigate to the installation folder and verify the file structure. 
    For example, C:\Program Files\Kaazing\kwic-version-windows\kwic-version.
    1773038092098-557.png
     
  3. Open Command Prompt as administrator.
  4. Run the following command: 
    kwic.setup.exe -s
    1773038112307-844.png
     
  5. Open the Windows Services console and verify that Kaazing KWIC Service appears in the list.
    1773038131402-298.png

To configure the gateway service for Windows

  1. In the Windows Services console, verify that Kaazing KWIC Service is stopped.
  2. Navigate to the conf folder in your installation directory. 
    For example, KWIC_INSTALL_DIR\conf.
    1773038175368-589.png
     
  3. Replace the default kwic-config.xml file with the configuration file provided by BMC Helix SaaS Operations. 
    BMC Helix sends you this updated file after receiving your integration request. For more information, see Getting started.
  4. (Optional) Before starting the service, back up and clear the logs located in the log folder. 
    This step helps BMC Helix identify and troubleshoot potential issues.
  5. In the Windows Services console, start Kaazing KWIC Service.

To install the license file for the gateway service in Windows

  1. In the Windows Services console, stop Kaazing KWIC Service.
  2. Navigate to the license folder in your installation directory. 
    For example, KWIC_INSTALL_DIR\license.
  3. Delete all files from the license folder.
  4. Copy the license.xml file provided by BMC Helix SaaS Operations to the license folder.
  5. In the Windows Services console, start Kaazing KWIC Service.
  6. Verify that the service started successfully by checking the log file in the log folder. 
    For example, KWIC_INSTALL_DIR\log\error.log.
    1773038523937-668.png

   The log file should confirm that the service picked up the new license file.

To verify the installation in Windows

  • Test access to BMC Developer Studio or your configured integration to confirm the installation was successful.
  • If connections fail, review the log files in the log folder and contact BMC Helix Support.

After the installation finishes, you should see a message in the Installation Summary window stating that the installation completed successfully.

You can also verify that the gateway is installed correctly by:

  • Checking the services and ensuring that the Kaazing KWIC Service is running.
  • Reviewing the error.log file (in the log directory where the gateway is installed) for any error messages.

The BMC Helix SaaS Operations team is available for technical support and installation assistance.

To download installation files for Linux

  1. Go to the EPD website and sign in with your BMC Helix Support ID.
  2. Click Product Download Tool.
  3. On the All Products tab, search for BMC Helix ITSM.
  4. Click on the latest product version. 
    Important: Disable your browser's pop-up blocker before downloading files.
  5. On the Product tab, select the latest BMC Helix Client Gateway version for Linux.
  6. Click Download.
Warning
Important

The zip file contains a Kaazing Developer License Agreement (LICENSE file). This developer license is superseded by the agreement you signed with BMC Helix. The XML file provided by BMC Helix includes the following legal disclaimer:

To BMC Customers: If you are a current BMC Customer and are accessing the Kaazing Enterprise Gateway Developer Edition software product (the "Software") through a link provided by BMC, the terms of your agreement with BMC will govern your use of the Kaazing Software and shall supersede all other agreements with Kaazing Corporation, including the Kaazing Developer License Agreement, which you may be required to accept prior to downloading the Kaazing Software.

To install the gateway service for Linux

  1. Extract the downloaded tarball to your gateway server. 
    For example, /opt/bmc. You can use any directory based on your organization's naming standards.
    1773038262712-880.png
     
  2. Navigate to the installation directory and review the file structure. 
    For example, /opt/bmc/kwic-version.
    1773038291874-226.png

To configure the gateway service for Linux

  1. Navigate to the conf directory in your installation directory. 
    For example, KWIC_INSTALL_DIR/conf.
  2. Replace the default kwic-config.xml file with the configuration file provided by BMC Helix SaaS Operations. 
    BMC Helix sends you this updated file after receiving your integration request. For more information, see Getting started.

To start the gateway service in Linux

  1. Navigate to the bin directory in your installation directory. 
    For example, KWIC_INSTALL_DIR/conf/bin.
  2. Start the service by running the following command: 
    sh kwic.start &
    1773038331089-900.png
     
  3. Verify that the service is running by checking the process:
    ps -ef | grep kaazing

To install the license for the gateway service in Linux

  1. Stop the gateway service. Find the process ID (PID) and stop it: 
    ps -ef | grep kaazing
    kill -9 <pid>
    Replace <pid> with the actual process ID.
  2. Navigate to the license directory in your installation directory. 
    For example, KWIC_INSTALL_DIR/license.
  3. Delete all files from the license directory.
  4. Copy the license.xml file provided by BMC Helix SaaS Operations to the license directory.
  5. Start the service by navigating to the bin directory and running: 
    sh kwic.start &
  6. Verify that the service started successfully by checking the log file in the log directory. 
    For example, KWIC_INSTALL_DIR/log/error.log. 

   The log file should confirm that the service picked up the new license file.

(Optional) To stop the gateway service in Linux

  1. Find the process ID: 
    ps -ef | grep kaazing
    1773038346138-996.png
     
  2. Stop the service: 
    kill -9 <pid>
    Replace <pid> with the actual process ID.
    1773038381896-527.png

If you configured a systemd service, use systemd commands to stop and start the gateway service instead.

To verify the installation in Linux

  • Test access to BMC Developer Studio or your configured integration to confirm the installation was successful.
  • If connections fail, review the log files in the log directory and contact BMC Helix Support.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Helix Subscriber Information