Starting an integration server

You can start an integration server and all the resources that are deployed to it by using the IBM® App Connect Enterprise Toolkit, the web user interface, the IntegrationServer command, or the administration REST API.

About this task

If resources are deployed to your integration server, the started or stopped state of the resources is retained when you next start the integration server.

You can also create and start a local, independent integration server by using the IBM App Connect Enterprise Toolkit, as described in Creating, starting, and stopping a local, independent integration server by using the Toolkit.

Starting an integration server that is managed by an integration node, by using the IBM App Connect Enterprise Toolkit

Procedure

To start an integration server under an integration node by using the IBM App Connect Enterprise Toolkit, complete the following steps.

  1. Open the IBM App Connect Enterprise Toolkit, and switch to the Integration Development perspective.
  2. In the Integration Explorer view, expand the integration node, right-click the integration server, and then click Start.

Results

The selected integration server is started. The Integration Explorer view is updated to indicate that the server and resources are running; for example:
Integration Explorer view showing started integration server and its resources

Starting an integration server that is managed by an integration node, by using the web user interface

Procedure

To start an integration server under an integration node by using the web user interface, complete the following steps.

  1. Start the web user interface for your integration node, as described in Accessing the web user interface.
  2. Find the integration server that you want to start, select it, and then click Start.

Results

The selected integration server is started, along with the resources deployed to that server. The web user interface is updated to indicate that the server and resources are running; for example: The web user interface shows that the server and resources are running.

Starting an independent integration server by using the IntegrationServer command

You can use the IntegrationServer command to start an independent integration server (an integration server that is not managed by an integration node).

Before you begin

Procedure

To start an independent integration server, complete the following steps:

  1. Run the IntegrationServer command, specifying the path to the work directory of the integration server.
    For example:
    IntegrationServer --work-dir c:\mywrk\myaceworkdir 
    where c:\mywrk\myaceworkdir is the integration work directory that you created when you configured the integration server.
    For more information about creating the work directory, see Configuring an integration server by modifying the server.conf.yaml file and mqsicreateworkdir command.
    If the integration server contains any independent resources (resources that are not in an application or library), you must specify the --default-application-name parameter the first time that you run the IntegrationServer command for this integration server. This parameter creates a new default application, and all independent resources that are associated with the integration server are moved into it. For example:
    IntegrationServer --work-dir c:\mywrk\myaceworkdir --default-application-name myDefaultApp 
    For more information, see IntegrationServer command.

    If you create a vault in your work directory, you must supply the correct vault key when you start the integration server. To supply the vault key, you can specify the --vault-key, --ext-vault-key or --vaultrc-location parameters on the IntegrationServer command, or you can set the MQSI_VAULT_KEY or MQSI_VAULTRC_LOCATION environment variables. If you specify none of these environment variables, the .mqsivaultrc file is looked for in your HOME directory. If you are using the .mqsivaultrc file, it must be configured to contain the correct vault key. For more information about using the vault, see Configuring encrypted security credentials.

    If you create integration tests for flows on the integration server, you can run those tests by using the --test-project parameter on the IntegrationServer command to specify the name of the integration test project that contains the tests. For example:
    IntegrationServer –work-dir c:\tmp\work-dir --test-project MyIntegrationTestProject 
    where the --work-dir parameter specifies the work directory of the integration server where the tests are run, and the --test-project specifies the name of the test project to be run. The tests in the specified test project run automatically when the integration server starts. For more information, see Running tests by using the command line.

    When you run the IntegrationServer command, the integration server starts, by using the configuration that is defined in its server.conf.yaml file and any overrides that were set by commands. When you run commands that modify an integration server, an overrides directory is created under the working directory for the integration server, as described in Configuring an integration server by modifying the server.conf.yaml file.

  2. You can now interact with the running integration server, by using the IBM App Connect Enterprise Toolkit or the web user interface.
    You can also investigate the administrative REST API provided by IBM App Connect Enterprise. For example, you might want to verify that the integration server is running, by sending a REST GET request to port 7600 and checking for a response:
    curl -X GET http://localhost:7600/apiv2
    If you want to use the curl tool, you might need to download and install it in addition to IBM App Connect Enterprise.

    The REST administration port, which is the primary method of communicating with the integration server, is set by default to 7600 (through the adminRestApiPort property in the server.conf.yaml configuration file).

  3. Optional: Use the IBM App Connect Enterprise Toolkit to connect to the integration server:
    1. In the Integration Explorer view, right-click Integration servers, and then click Connect to an integration server. In the Connection details dialog, enter the host name and port for the integration server. Ensure that the port matches the value of the admin-rest-api property that is specified on the IntegrationServer command or the RestAdminListener / port property that was specified in the server.conf.yaml file (in this example, the port is 7600, and the host name is localhost). If the integration server is secured, you must also specify the user name and password.
    2. Click Finish.
      The connection for your integration server is now displayed in the Integration Explorer view in the toolkit.
    3. You can now deploy a BAR file (or an application or REST API) by dragging it from the Application Development view and dropping it onto the integration server in the Integration Explorer view. For more information about deployment, see Deploying integration solutions during development and Deploying integration solutions to a production environment.
    4. You can view the properties of the integration server, by selecting it in the Integration Explorer view, and then clicking the Properties tab. This shows the properties that were specified for the integration server in the server.conf.yaml configuration file, as described in Configuring an integration server by modifying the server.conf.yaml file.

Starting a managed integration server by using the mqsistartmsgflow command

Procedure

You can use the mqsistartmsgflow command to start an integration server that is managed by an integration node, by completing the following steps:

  1. Open a command line for your current installation.
  2. Enter the mqsistartmsgflow command, specifying the parameters for the integration server that you want to start.
    • If the integration node is local, specify the integration node name. For example:
      mqsistartmsgflow INODE -e default
    • If the integration node is remote, you can specify a configuration file. For example:
      mqsistartmsgflow -n INODE.broker -e default
    • If the integration node is remote, you can alternatively specify the connection parameters -i and -p. For example:
      mqsistartmsgflow -i 9.20.193.11 -p 4414 -e default
    • If you want to start all the integration servers on an integration node, specify the --all-integration-servers flag instead of -e.For example:
      mqsistartmsgflow INODE --all-integration-servers
    See the mqsistartmsgflow command description for more details about these options.

What to do next

Start or stop resources that are deployed on your integration server. For more information, see Starting or stopping deployed resources.