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 have created a vault in your work directory, you must supply the correct vault key when starting the integration server. To supply the vault key, you can specify either the --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, the .mqsivaultrc file will be 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.

    When you run the IntegrationServer command, the integration server starts, using the configuration that is defined in 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 to see if there is 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 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.

What to do next

Start or stop resources that are deployed on your integration server; see Starting or stopping deployed resources.