Skip to content

Using a Remote Micro Integrator

The light-weight Micro Integrator is already included in your WSO2 Integration Studio package, which allows you to deploy and run the artifacts instantly.

The following instructions can be used to run your artifacts in a remote Micro Integrator instance.

Deploy and run artifacts in a remote instance

  1. Download and install the Micro Integrator server and on your computer.
  2. Package your Synapse artifacts from WSO2 Integration Studio.

However, when your solutions are ready to be moved to your production environments, it is recommended to use a CICD pipeline.


As an alternative, you can skip the steps given below and manually copy the exported CAR file to the <MI_HOME>/repository/deployment/server/carbonapps/ folder, where <MI_HOME> is the root folder of your Micro Integrator installation. For more information on how to export a CAR file, see Exporting Artifacts.

Add a new remote instance

  1. Open the Getting Started view and click Add Server to open the New Server dialog box.

  2. In the New Server dialog box that opens, expand the WSO2 folder and select the version of your server.

  3. Click Next. In the CARBON_HOME field, provide the path to your product's home directory and then click Next.

  4. Review the default port details for your server and click Next.


    If you selected an Enterprise Integrator server in the previous step, enter the port details required for an Enterprise Integrator.


    If you are already running another server on these ports, give unused ports. See Default ports of WSO2 Micro Integrator for more information.

Deploy and run artifacts in a remote instance

  1. To deploy the C-App project to your server, select the composite application from the list, click Add to move it to the configured list, and then click Finish.

  2. On the Servers tab, note that the server is currently stopped. Click the icon on the tool bar. If prompted to save changes to any of the artifact files you created earlier, click Yes.

Deploy, redeploy, or remove artifacts in a remote instance

  • To deploy/remove C-Apps, right-click the server, click Add and Remove and follow the instructions on the wizard.

  • If you want to redeploy a C-App after modifying the included artifacts, select the already deployed C-App, right-click and click Redeploy.


Hot deployment is enabled in the Micro Integrator by default. This allows you to redeploy artifacts without restarting the server. If you disabled hot deployment while adding the server, you need to restart the server as well.

Disable graceful shutdown (Only for testing)

By default, the graceful shutdown capability is enabled in the Micro Integrator distribution. This means that the server will not immediately shut down when there are incomplete HTTP messaging transactions that are still active. These are transactions that are processed by the HTTP/S passthru transport.

For example, consider a delay in receiving the response from the backend (which should be returned to the messaging client). Because graceful shutdown is enabled, the Micro Integrator will wait until the time specified by the following parameter in the server configuration file (deployment.toml file) is exceeded before shutting down.

socket_timeout = 180000

You can disable this feature by using the following system property when you start the server:


Disabling graceful shutdown is only recommended for a development environment for the purpose of making the development and testing process faster. Be sure to have graceful shutdown enabled when you move to production.