Creating and starting a local, independent integration server by using the Toolkit

You can use the IBM® App Connect Enterprise Toolkit to create and start a local, independent integration server.

About this task

You can create and start a local, independent integration server by using a wizard in the IBM App Connect Enterprise Toolkit. The wizard starts a process on the operating system for the independent integration server. The Toolkit does not manage the process for an independent integration server in the same way that an integration node manages the integration servers that are associated with it. When you stop the Toolkit, any independent integration server processes that were started from the Toolkit are stopped. However, if the Toolkit stops unexpectedly, or if its Eclipse process is stopped, the independent integration server processes continue to run on your operating system, and you will need to use an operating system process management tool to stop them.

Procedure

Create and start a local, independent integration server by completing the following steps:

  1. In the Integration Explorer view, right-click Integration servers and then click Create a local integration server.
  2. In the Connection details wizard, enter the following information:
    • Name

      Enter the name of the local independent integration server that you want to create and start. When you run the wizard for the first time, the default name for the integration server is TEST_SERVER. If you run the wizard again, the TEST_SERVER will already exist so you must specify an alternative name for the new integration server.

    • REST Administration Port

      Specify the port to be used for REST administration. By default, you can allow the wizard to find a port that is available to use. If you want to specify a different port, first ensure that it is not being used by another process, then deselect the checkbox and enter the required port number. The port that you specify cannot be used by the integration server if it is already in use by another process.

    • HTTP Port

      Specify the port that is used by the HTTPConnector resource manager when an HTTP-based message flow is deployed as part of an application. By default, you can allow the wizard to find a port that is available to use. If you want to specify a different port, first ensure that it is not being used by another process, then deselect the checkbox and enter the required port number. The port is then used when the message flow is deployed. The wizard finds an available port when the integration server is started. If the message flow is deployed at a much later date, the port might no longer be available, in which case an error message is shown at deployment time to indicate that the HTTP listener could not be started for that port. If this happens, specify the correct port used by the HTTPConnector in the server.conf.yaml file in the overrides directory, and then stop and start the integration server.

    • JVM Debug Port

      Specify the port to be used for debugging a message flow. By default, you can allow the wizard find a port that is available to use. If you want to specify a different port, first ensure that it is not being used by another process, then deselect the checkbox and enter the required port number. This sets the jvmDebugPort property in the server.conf.yaml file for the JVM resource manager to use. If you do not want to debug a message flow, you can disable the JVM debug port by deselecting the checkbox and entering the value 0 in the field.

    • Click Finish.

      A confirmation message shows that a configuration directory has been created in the workspace and that the integration server has been started using the details in the configuration directory. The configuration directory that is created in your workspace has the same name as the integration server that has been created and started. This is the same configuration directory that is created by the mqsicreateworkdir command. The configuration directory is shown under Independent Resources in your workspace. The wizard creates an override file for the server.conf.yaml that is used by the integration server. This override file contains the values of the ports that will be used by the integration server.

  3. Optional: When you have created and started the integration server, you can deploy an application or library to it.
  4. Optional: You can view the console.log file for the integration server. The location of the console.log file is under the main configuration directory.
  5. Optional: You can stop the integration server by right-clicking it and then clicking Stop, which stops the integration server process. You can restart the integration server by right-clicking it and then clicking Start to start the integration server process.
  6. Optional: You can remove the connection for the integration server when it has been stopped, but the configuration directory is not deleted from your workspace automatically; however, you can delete the directory manually.

    If you have previously stopped the integration server and removed the connection for it, you can create it again and it will use the configuration directory in your workspace, if it exists. In this case, a message informs you that the existing configuration directory in your workspace will be used.