Create an Endpoint Template

Follow the instructions below to create a new Endpoint Template in the Micro Integrator for Visual Studio Code extension (MI for VS Code).

Instructions

Create the endpoint template artifact

1. 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.

2. Create an integration project.

3. To add a new Endpoint Template, navigate to MI Project Explorer.

4. Click on the + icon to open the Add Artifact pane.

   

5. Click + View More under Create an Integration.

6. Click Template under Other Artifacts to open the Template Form.

7. This will open the Template Form shown below, where you can select the Template Artifact. Select an endpoint template type.

   

   Note

   There are four Endpoint Templates available:

   • Address Endpoint Template
   • Default Endpoint Template
   • HTTP Endpoint Template
   • WSDL Endpoint Template

   This will open the respective Endpoint Form.

8. Enter a unique name for the template.

9. Specify values for the required parameters for the selected endpoint type.

10. Also, update the endpoint parameter values with placeholders prefixed by $.

11. Click Create.

    The template endpoint artifact is created in the <PROJECT_NAME>/src/main/wso2mi/artifacts/templates folder under the project you created.

Design the integration

Follow the steps below to add the already-created endpoint template to your mediation sequence.

1. Go to MI Project Explorer.

2. Click on the + icon to open the Add Artifact pane.

3. Click + View More under Create an Integration.

4. Click Endpoint under Other Artifacts to open the Endpoint Form.

5. Click + View More.

6. Select Template Endpoint from the set of available endpoints on the Endpoint Form.

   

7. In the Template Endpoint Form, specify the values for the required properties.

8. From the Template dropdown, select the endpoint template you created earlier.

   

9. Click Create.

   Endpoints cannot be added directly to the integration sequence. Instead, they must be invoked using the Send Mediator or the Call Mediator.

   Therefore, to add an endpoint artifact to the integration sequence, use the Send Mediator or the Call Mediator.

10. Open the Design View of your mediation sequence.

11. Add the Call Endpoint mediator from the palette under All Mediators > Generic section to the relevant position in the mediation sequence:

    

    Tip

    Similarly, you can use the Send Mediator instead of the Call Mediator.

12. In the Call Endpoint form, select the endpoint you need to invoke under Select Endpoint.

    

The endpoint template artifact is now linked to your integration sequence.

Update properties

You can update the properties you specified for the endpoint template later.

1. From MI Project Explorer, select the endpoint template available under the available endpoint templates.

2. Update the properties from the Template Artifact form.

3. Click Save Changes.

Examples

Follow our examples on endpoint templates:

• Using Endpoint Templates