Create an Inbound Endpoint¶
Follow these instructions to create an Inbound Endpoint artifact in the Micro Integrator for Visual Studio Code extension (MI for VS Code).
Create an inbound endpoint artifact¶
-
Launch Visual Studio Code with the Micro Integrator for VS Code extension (MI for VS Code) installed.
Info
Follow the Install Micro Integrator for VS Code documentation for a complete installation guide.
-
Create an integration project.
Hereafter, this project will be referred to as
<PROJECT_NAME>
. -
To add a new Inbound Endpoint, navigate to Micro Integrator Project Explorer.
-
Click on the + icon to open the Add Artifact pane.
-
On the Add artifact pane, click Event Integration under Create an Integration to open the Event Integration Form.
-
Select the Event Integration type.
-
Once you complete the Event Integration Form, click Create.
The created inbound endpoint will be available in Project Overview under Event Integration.
Info
You can switch to the default Visual Studio Code Explorer to view the folder structure.
The newly-created inbound endpoint will be stored in the <PROJECT_NAME>/src/main/wso2mi/artifacts/inbound-endpoints
folder of your integration project.
The inbound sequence and error sequence will also be created and stored in the <PROJECT_NAME>/src/main/wso2mi/artifacts/sequences
folder of your integration project.
Design the integration¶
-
To design the integration, go to MI Project Explorer > Event Integrations.
-
Select the inbound endpoint you want to design.
-
Click on the + icon to open the palette.
-
Add the mediation artifacts from the palette and design the integration flow.
Follow the below steps to design the error sequence:
-
Go to MI Project Explorer > Other Artifacts > Sequences.
-
Select the previously-created error sequence you want to design.
-
Add the mediation artifacts from the palette and design the integration flow.
Update the configurations¶
-
Go to MI Project Explorer > Event Integrations.
-
Select the inbound endpoint you want to edit.
-
On the inbound endpoint view, click the edit (pen) icon next to the inbound endpoint name to edit the inbound endpoint.
This will open the Event Integration form.
-
Once you update the details, click Update.
See the following links for the list of parameters for each inbound endpoint type:
- HTTP Inbound Parameters
- CXF WS RM Inbound Parameters
- HL7 Inbound Parameters
- WebSocket Inbound Parameters
- File Inbound Parameters
- JMS Inbound Parameters
- Kafka Inbound Parameters
- RabbitMQ Inbound Parameters
- MQTT Inbound Parameters
Source View¶
Click the Show Source (>) icon located in the top right corner of the VS Code to view the XML-based synapse configuration (source code) of the inbound endpoint. You can update the inbound endpoint using this view.
Tutorials¶
Follow our tutorial on inbound endpoints:
- See the tutorial on using inbound endpoints
Examples¶
Follow our examples on inbound endpoints:
- JMS Inbound Endpoint example
- File Inbound Endpoint example
- HTTP Inbound Endpoint example
- HTTPS Inbound Endpoint example
- HL7 Inbound Endpoint example
- MQTT Inbound Endpoint example
- RabbitMQ Inbound Endpoint example
- Kafka Inbound Endpoint example
- WebSocket Inbound Endpoint example
- Using Inbound Endpoints with Registry