Skip to main content
Version: 5.1

Integration View

The Integration view is the primary development interface in WSO2 Integrator. Use it to build, test, and deploy a single integration. It combines a project explorer, a visual design canvas, and deployment options in one unified workspace.

Integration view overviewIntegration view overview

Design canvas​

The design canvas is the central area of the Integration view. It displays a visual overview of your integration, showing how entry points, listeners, connections, and services relate to each other.

Design canvasDesign canvas

Service diagram​

The service diagram renders your integration as an interactive graph. Each node represents a component:

  • Entry points appear as the primary nodes on the left.
  • Listeners connect to the entry points they serve.
  • External connections appear on the right, showing which services your integration calls.
  • Lines between nodes indicate data flow and dependencies.

Click any node to open that component in the visual designer. Right-click a node or click its three-dot menu (⋮) to access context actions such as Edit and Delete.

Zoom and navigation controls​

Use the controls in the bottom-right corner of the canvas to adjust the view:

  • +: zoom in.
  • −: zoom out.
  • Fit to screen: automatically adjusts the zoom level to show all nodes.

You can also scroll to zoom and drag to pan across the canvas.

Build with Copilot​

Describe what you want in natural language, and WSO2 Integrator Copilot generates the integration with the appropriate entry points, connections, and logic.

  • New integration: The canvas shows the Copilot composer. Describe what you want to build and send it, or pick one of the examples under Try one of these.

    The Copilot composer on the overview of a new integration.The Copilot composer on the overview of a new integration.
  • Integration with artifacts: Select the Copilot orb in the bottom-right corner of the canvas. Select it once for a quick chat, or double-click it to open the full Copilot panel.

    The WSO2 Integrator Copilot orb on the integration overview.The WSO2 Integrator Copilot orb on the integration overview.

Add artifact​

Click the + Add Artifact button at the top of the canvas to add a new component to your integration. This opens a menu with all available artifact types organized by category:

  • Entry Points: HTTP services, GraphQL services, automations, and event listeners that trigger your integration.
  • Connections: Configured links to external systems such as databases, HTTP APIs, and message brokers.
  • Types: Custom records, enums, arrays, service classes, and unions used in your integration.
  • Functions: Reusable logic blocks callable from entry points or other functions.
  • Data Mappers: Visual transformations between source and target types.
  • Configurations: Variables sourced from Config.toml at runtime.

Toolbar​

The toolbar sits at the top of the Integration view and provides quick access to common actions for building, running, and debugging your integration.

ToolbarToolbar
ActionDescription
Undo / RedoReverses or reapplies recent changes. Works across both the visual designer and the code editor.
ConfigureOpens the configuration panel, equivalent to adding a configuration from the project explorer.
RunBuilds and runs your integration locally. WSO2 Integrator compiles the Ballerina code, starts the services, and displays the output in the terminal panel.
DebugStarts a debug session with the debugger attached. Set breakpoints, step through execution, inspect variables and payloads, and evaluate expressions at runtime.
DeploymentShows or hides the deployment options panel on the right side of the view.

Deployment options panel​

Select Deployment in the toolbar to open the deployment options panel on the right side of the view. The panel provides shortcuts to deploy the integration to different environments. Select Deployment again to close it.

Deployment button in the toolbarDeployment button in the toolbar Deployment optionsDeployment options
OptionTarget
Deploy to WSO2 CloudFully managed cloud platform for hosting and running integrations. Select Deploy to start.
Deploy with DockerBuild Docker images and deploy integrations to Docker, Kubernetes, or OpenShift.
Deploy on a VMDeploy integrations as standalone JAR files on virtual machines.

The panel also includes an Integration Control Plane section for monitoring and managing running integrations from a centralized dashboard. Select Enable ICP monitoring to activate the Integration Control Plane (ICP) for this integration, or expand Publish to local ICP to push the integration to a local ICP instance.

Readme tab​

The Readme tab next to Design displays the contents of your project's README.md file. Use it to document the purpose, setup instructions, and usage notes for your integration.

ReadmeReadme

Click Edit to modify the README directly. On a new integration that has a README but no artifacts yet, you can also click Generate with Readme to have Copilot plan and build the integration from the README.

The Readme tab of a new integration showing the README content and the Generate with Readme button.The Readme tab of a new integration showing the README content and the Generate with Readme button.

What's next​