Skip to main content
Version: 5.1

Integration Control Plane(ICP) Support in Editor

The WSO2 Integrator editor can start a local Integration Control Plane (ICP) server so you can observe and manage your integrations while you are still developing them. Enable ICP for an integration, run it as usual, and its runtime shows up in the ICP console.

info

The local ICP server is meant for development and trying ICP out. To monitor and manage integrations that are deployed, see the Integration Control Plane documentation.

Enable ICP for your integrations​

You can enable ICP for every integration in a project at once, or for one integration at a time.

Enable ICP for all integrations in a project​

  1. Open the project overview. The Integration Control Plane section on the right shows how many integrations are ICP-enabled, for example 0/3 integrations are ICP-enabled.

  2. Select Enable ICP for all integrations.

    The project overview with the Integration Control Plane section and the Enable ICP for all integrations button.The project overview with the Integration Control Plane section and the Enable ICP for all integrations button.

    Each integration card now carries an ICP badge, and the ICP-enabled count is also updated.

    The project overview after enabling ICP, with an ICP badge on every integration card.The project overview after enabling ICP, with an ICP badge on every integration card.

Enable ICP for a single integration​

  1. Open the integration's overview.

  2. In the Integration Control Plane section, select Enable ICP monitoring.

    The integration view with the Integration Control Plane section and the Enable ICP monitoring button.The integration view with the Integration Control Plane section and the Enable ICP monitoring button.

Start the local ICP server​

With ICP enabled, the editor needs an ICP server to publish to. You can find ICP server in the status bar as, ICP: Stopped or ICP: Running.

  • Start it from the integration overview. Under Publish to local ICP, select Start ICP Server.

    The Publish to local ICP section of an integration overview with the Start ICP Server button.The Publish to local ICP section of an integration overview with the Start ICP Server button.

  • Start it when you run. If you run an ICP-enabled integration while the server is stopped, the editor warns that ICP is enabled but the ICP server is not running. Select Start & Setup to start and configure the server, or Run Anyway to run the integration without publishing to ICP.

    The warning shown when running an ICP-enabled integration while the ICP server is not running.The warning shown when running an ICP-enabled integration while the ICP server is not running.

When the server is up, the editor shows a notification with its address, https://localhost:9446, and the default credentials (admin/admin). Select Open in Browser to open the ICP console. The server's logs appear in the ICP Server terminal.

The notification confirming the ICP server has started, with the ICP Server terminal open.The notification confirming the ICP server has started, with the ICP Server terminal open.

Run and observe your integration​

  1. Run the integration as you normally would. If the project has more than one integration, pick the one to run from the Select an integration to run list.

  2. While it runs, the integration connects to the local ICP server. The terminal shows the ICP agent starting and its heartbeat being acknowledged by the server, and the status bar shows ICP: Running.

    A running ICP-enabled integration, with the ICP agent logs in the terminal and the Stop ICP Server and View in ICP buttons.A running ICP-enabled integration, with the ICP agent logs in the terminal and the Stop ICP Server and View in ICP buttons.

  3. In the Publish to local ICP section, you can also use View in ICP to open the ICP console in your browser.

    The View in ICP button highlighted in the Publish to local ICP section.The View in ICP button highlighted in the Publish to local ICP section.

  4. Sign in with the default credentials (admin/admin). The console opens on All Projects, where the default project holds your integrations.

    The ICP console listing the default project.The ICP console listing the default project.

  5. Open the default project. Your integration is listed with the WSO2 Integrator technology tag.

    The ICP console listing the running integration in the default project.The ICP console listing the running integration in the default project.

From here you can observe and manage the running integration in the ICP console. See the Integration Control Plane documentation for what you can do there.

Stop the local ICP server or disable ICP​

  • To stop the server : In the Publish to local ICP section, select Stop ICP Server. The status bar changes to ICP: Stopped.
  • To disable ICP : Clear Enable ICP monitoring on an integration, or select Disable ICP for all integrations on the project overview.
The Enable ICP monitoring checkbox and the Stop ICP Server button highlighted.The Enable ICP monitoring checkbox and the Stop ICP Server button highlighted.

What's next​

Last updated on
On this page
Was this page helpful?
Report an issue