Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ hosted in the Dev and QA environments respectively are as follows:

- QA environment: `http://localhost:8291/services/echo`

## Creating the Endpoints
## Creating the endpoints

You need to create two Endpoint artifacts to represent the Dev and QA environments respectively. Follow the steps given below.

Expand Down Expand Up @@ -116,11 +116,11 @@ See the instructions on packaging artifacts into CApps.

Your CApp projects are now ready to be deployed to the WSO2 Integrator: MI.

## Deploying the Dev composite application
## Deploying the dev composite application

If you have an instance of WSO2 Integrator: MI setup as your Dev environment, deploy the <b>HelloWorldDevCApp</b> CApp in the server.

## Testing the Dev environment
## Testing the dev environment

Use the following request body when invoking the service:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Follow these instructions to create a [Proxy Service]({{base_path}}/reference/sy

See the complete list of [service-level properties and parameters]({{base_path}}/reference/synapse-properties/proxy-service-properties) that you can configure.

## Source View
## 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 proxy service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ See the following links for the list of parameters for each inbound endpoint typ
- [RabbitMQ Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/event-based-inbound-endpoints/rabbitmq-inbound-endpoint-properties)
- [MQTT Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/event-based-inbound-endpoints/mqtt-inbound-endpoint-properties)

### Source View
### 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Follow these steps to create a new reusable sequence that you can add to your me

You can also use the [**Source view**](#using-the-source-view) to update the sequence configuration.

### Use the Source View
### Use the source view
Comment on lines 76 to +78
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

cd en/docs/develop/creating-artifacts && head -85 creating-reusable-sequences.md | tail -15

Repository: wso2/docs-mi

Length of output: 885


🏁 Script executed:

cat -n en/docs/develop/creating-artifacts/creating-reusable-sequences.md | sed -n '70,85p'

Repository: wso2/docs-mi

Length of output: 1092


Fix broken anchor link to match heading text.

Line 76 contains an anchor link reference #using-the-source-view that doesn't match the heading at line 78 Use the source view (which generates #use-the-source-view). Update the anchor to fix the broken internal link:

- You can also use the [**Source view**](#using-the-source-view) to update the sequence configuration.
+ You can also use the [**Source view**](#use-the-source-view) to update the sequence configuration.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
You can also use the [**Source view**](#using-the-source-view) to update the sequence configuration.
### Use the Source View
### Use the source view
You can also use the [**Source view**](#use-the-source-view) to update the sequence configuration.
### Use the source view
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

76-76: Link fragments should be valid

(MD051, link-fragments)

🤖 Prompt for AI Agents
In en/docs/develop/creating-artifacts/creating-reusable-sequences.md around
lines 76 to 78, the internal anchor link uses `#using-the-source-view` but the
heading "Use the source view" generates `#use-the-source-view`; update the link
target to `#use-the-source-view` so the anchor matches the heading text and the
internal link works correctly.


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 reusable sequence.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Follow the instructions below to create a new Sequence Template in the WSO2 Inte

## Instructions

### Create the Sequence Template artifact
### Create the sequence template artifact

{!includes/creating-project.md!}

Expand Down
4 changes: 2 additions & 2 deletions en/docs/develop/customizations/ballerina-module/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ The WSO2 Integrator: MI module for Ballerina enables integration developers to l
- Ballerina VS Code extensions installed
- Ballerina Integrator VS Code extensions installed

## Get Started with Ballerina Module for MI
## Get started with Ballerina module for MI

There are two ways to use the Ballerina module in your WSO2 MI projects:

1. Using the WSO2 MI VS Code Extension
2. Using the Command Line Interface (CLI)

### Method 1: Use WSO2 MI VS Code Extension
### Method 1: Use WSO2 MI VS Code extension

1. Install the [WSO2 Integrator: MI VSCode Extension](https://mi.docs.wso2.com/en/latest/develop/mi-for-vscode/install-wso2-mi-for-vscode/).
2. [Create](https://mi.docs.wso2.com/en/latest/develop/create-integration-project/) a new integration project or open an existing project.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ Create a Maven project using the following information.
**Group Id** : `org.wso2.task`
**Artifact Id** : `StockQuoteTaskMavenProject`

### Create the Java Package
### Create the Java package

Create a Java Package inside the Maven Project using the following name: `org.wso2.task.stockquote.v1`
Create a Java Package inside the Maven Project using the following name: `org.wso2.task.stockquote.v1`

![]({{base_path}}/assets/img/integrate/custom-task-scheduling/119130458/119130467.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add alt text to the image to satisfy MD045 and improve accessibility.
![](...) should be ![<meaningful description>](...).

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

21-21: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
In en/docs/develop/customizations/creating-custom-task-scheduling.md around line
21, the image markdown is missing alt text which fails MD045 and reduces
accessibility; update the markup to include a meaningful alt description inside
the square brackets (e.g., describe the image content or purpose) so it becomes
![meaningful
description]({{base_path}}/assets/img/integrate/custom-task-scheduling/119130458/119130467.png).


### Create the Java Class
### Create the Java class

1. Create a Java Class named `StockQuoteTaskV1` inside the Maven Project.
1. Create a Java Class named `StockQuoteTaskV1` inside the Maven Project.

2. In the **Project Explorer**, double-click on the **StockQuoteTaskV1.java** file and replace its source with the below content.

Expand Down
2 changes: 1 addition & 1 deletion en/docs/develop/deploy-artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Now that you have developed an integration using the WSO2 Integrator: MI Visual Studio Code plugin, you have several options to deploy that integration to the WSO2 Integrator: MI server runtime.

## Build and Run
## Build and run

1. [Download and install]({{base_path}}/install-and-setup/install/installing-mi) the WSO2 Integrator: MI server on your local machine.
2. Follow these steps to add the server to the VS Code extension if it has not been added yet.
Expand Down
2 changes: 1 addition & 1 deletion en/docs/develop/mi-for-vscode/mi-for-vscode-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ You can add the [artifacts]({{base_path}}/develop/creating-artifacts/creating-ar

<a href="{{base_path}}/assets/img/develop/mi-for-vscode/explorer-view.png"><img src="{{base_path}}/assets/img/develop/mi-for-vscode/explorer-view.png" alt="explorer view" width="80%"></a>

## Project Overview
## Project overview

The Project Overview in MI for VS Code extension provides an overview of your integration project. You can view, add, build, and export artifacts from here.

Expand Down
4 changes: 2 additions & 2 deletions en/docs/develop/wso2-integration-studio.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ WSO2 Integration Studio is your development environment for designing, developin
The base of the WSO2 Integration Studio is Eclipse IDE. You can install any supported Eclipse plugin for Integration
Studio by navigating to **Help** -> **Install New Software**.

## Getting Started
## Getting started

When you open WSO2 Integration Studio, you will see the **Getting Started** view in the tool's workbench.

Expand Down Expand Up @@ -129,7 +129,7 @@ of the toolbar are also editor-specific.

<img src="{{base_path}}/assets/img/integrate/workbench/workbench-outline.png">

## What's Next?
## What's next?

- See [Installing WSO2 Integration Studio]({{base_path}}/develop/installing-wso2-integration-studio) for installation instructions.
- See [Working with WSO2 Integration Studio]({{base_path}}/develop/working-with-wso2-integration-studio) for more information on how to setup and use tooling.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@ Click the **Build and Run** icon located in the top right corner of VS Code.

You have now learned how to create an AI agent to enhance your integration flow with automating tasks using AI.

## What's Next?
## What's next?

You have now completed this tutorial series, where you learned how to build a complete integration flow step by step. Throughout this journey, you have explored how to create AI chatbot, build a knowledge base, build RAG application, and develop an AI agent to enhance your integration flow.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ The AI's response is located in the `content` section of the API response. This
Congratulations!
Now, you have created your first AI Integration API.

## What's Next?
## What's next?

So far, you have used the LLM (OpenAI API in this case) to process client requests and generate responses. In the next tutorial, you will learn how to build a knowledge base. This will serve as a foundation for enhancing your chatbot's capabilities in future integrations.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ Let us retrieve the information available in the knowledge base about the saving
Congratulations!
You have successfully created your first Knowledge Base Integration API, enabling seamless interaction with a knowledge base.

## What's Next?
## What's next?
So far, you have built a knowledge base and exposed it through an API. In the next tutorial, you will learn how to integrate this knowledge base with a Large Language Model (LLM) to enable Retrieval-Augmented Generation (RAG). This will allow you to create more advanced, context-aware integrations for enhanced user experiences.

Click on the **Next** button below to continue to the next tutorial.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Let us test a scenario where a customer wants to know about the interest rate, m
Congratulations!
You have now learned how to create a Retrieval-Augmented Generation (RAG) application by integrating a knowledge base with a Large Language Model (LLM) to enhance your integration flow.

## What's Next?
## What's next?

So far, you have learned to create a RAG application by integrating the knowledge base with the LLM. In the next tutorial, you will learn how to create an AI assistant that can automate tasks, further enhancing your integration capabilities.

Expand Down
2 changes: 1 addition & 1 deletion en/docs/get-started/build-first-ai-integration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Through this tutorial series, you will acquire practical skills in:
- **Creating an AI Agent** – Design a customer service agent for a banking application that delivers personalized and accurate responses to user inquiries.


## Get Started
## Get started

Ready to build your first integration? Click **Start** to begin the tutorial series.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Select `BankAPI` that you have developed and test the resource.
Congratulations!
Now, you have created your first Integration API.

## What's Next?
## What's next?

So far, you have responded to the client with a mock payload. Next, you will explore how to route and transform the payload effectively.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ Click the **Build and Run** icon located in the top right corner of VS Code.
Congratulations!
You have now learned how to integrate with an email SaaS provider using connectors to send emails as part of your integration flow.

## What's Next?
## What's next?

You have now completed this tutorial series, where you learned how to build a complete integration flow step by step. Throughout this journey, you have explored how to create Integration APIs, route and transform messages, connect to external SaaS and B2B systems.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Now that the Integration Control Plane (ICP) is running, log in to the web porta

Congratulations! You have now learned how to monitor and manage integrations using the Integration Control Plane (ICP). You explored how to check the status of deployed MI nodes and view detailed information about integration artifacts, including their source code.

## What's Next?
## What's next?

You have now completed this tutorial series, where you learned how to build a complete integration flow step by step. Throughout this journey, you have explored how to create Integration APIs, route and transform messages, connect to external SaaS and B2B systems, and monitor integrations using the Integration Control Plane (ICP).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ Click the **Build and Run** icon located in the top right corner of VS Code.
Congratulations!
You have now learned how to create an API resource, use the HTTP connector, work with expressions, and test mediators using Mediator TryOut.

## What's Next?
## What's next?

So far, you have learned how to route and transform the payload efficiently. Next, you'll explore how to connect to a SaaS service to send an email.

Expand Down
2 changes: 1 addition & 1 deletion en/docs/get-started/build-first-integration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ By following this series, you will gain hands-on experience in:
- Routing and Transforming Messages – Process and modify data dynamically.
- Connecting to SaaS or B2B Systems – Integrate with external platforms like Gmail.

## Get Started
## Get started

Ready to build your first integration? Click **Start** to begin the tutorial series.

Expand Down
6 changes: 3 additions & 3 deletions en/docs/get-started/event-driven-integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ docker run --rm --name kafka -p 9092:9092 apache/kafka:3.7.2

You should see a message like `Kafka Server started` indicating that the broker is up and running.

### Create the Topics
### Create the topics

Kafka uses **topics** to organize and group related messages. In this tutorial, well create a topic named `bank-transactions`, which the Kafka listener in WSO2 Integrator: MI will subscribe to, and a topic named `bank-audit`, to which the WSO2 Integrator: MI will publish the transformed messages.
Kafka uses **topics** to organize and group related messages. In this tutorial, we'll create a topic named `bank-transactions`, which the Kafka listener in WSO2 Integrator: MI will subscribe to, and a topic named `bank-audit`, to which the WSO2 Integrator: MI will publish the transformed messages.

1. Open a new command line prompt on your machine and run the following command to create the `bank-transactions` topic.

Expand Down Expand Up @@ -409,7 +409,7 @@ Once the WSO2 Integrator: MI runtime is up and running, follow the steps below t

Congratulations! You’ve now learned how to create an event-driven integration using Kafka and apply message transformation using WSO2 Integrator: MI. This is a powerful pattern for building scalable, real-time systems.

## What's Next?
## What's next?

Now that you’ve built your first event-driven flow, you can explore how to improve the integration by,

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ If you need to set additional system properties when the server starts, you can

When using SUSE Linux, it ignores `/etc/resolv.conf` and only looks at the `/etc/hosts` file. This means that the server will throw an exception on startup if you have not specified anything besides localhost. To avoid this error, add the following line above `127.0.0.1 localhost` in the `/etc/hosts` file: `<ip_address><machine_name> localhost`.

## What's Next?
## What's next?

- [Running the Integration Control Plane]({{base_path}}/install-and-setup/install/running-the-integration-control-plane).

2 changes: 1 addition & 1 deletion en/docs/install-and-setup/install/installing-mi.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ If you need to set additional system properties when the server starts, you can

When using SUSE Linux, it ignores `/etc/resolv.conf` and only looks at the `/etc/hosts` file. This means that the server will throw an exception on startup if you have not specified anything besides localhost. To avoid this error, add the following line above `127.0.0.1 localhost` in the `/etc/hosts` file: `<ip_address><machine_name> localhost`.

## What's Next?
## What's next?

- [Running the MI Runtime]({{base_path}}/install-and-setup/install/running-the-mi).

Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,6 @@ The default port offset in the WSO2 Integrator: MI runtime is `10`. Use one of t
micro-integrator.bat -DportOffset=3
```

## What's Next?
## What's next?

You need to restart the server for these changes to take effect.
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Following are the integration artifacts that we can used to implement this scena
</endpoint>
```

## Build and Run
## Build and run

Create the artifacts:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Example JMS connection URL for WSO2 MB
```xml
jms:/Queue1?transport.jms.ConnectionFactoryJNDIName=QueueConnectionFactory&amp;java.naming.factory.initial=org.wso2.andes.jndi.PropertiesFileInitialContextFactory&amp;java.naming.provider.url=conf/jndi.properties&amp;transport.jms.DestinationType=queue
```
## Build and Run
## Build and run

Create the artifacts:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Following are the integration artifacts (proxy service) that we can use to imple
</endpoint>
```

## Build and Run
## Build and run

Create the artifacts:

Expand Down
2 changes: 1 addition & 1 deletion en/docs/mi-analytics/mi-elk-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Gives you an idea about Proxy Services analytics.
|Message Count|Total number of requests received within the time span|


## Creating Advanced Dashboards
## Creating advanced dashboards

This section will help you to setup advanced dashboards using custom metadata. Use [this documentation](https://www.elastic.co/kibana/kibana-dashboard) by Elastic to explore what kind of dashboard widgets you can create.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -739,7 +739,7 @@ To prevent the `Current Params` from being printed in the logs, add the followin
-Ddss.disable.current.params=true
```

## Using Custom Log appenders
## Using custom log appenders

Custom log appenders for Log4j2 can be used to store application logs in various environments/systems such as cloud storages.

Expand Down Expand Up @@ -812,6 +812,6 @@ However, since WSO2 Integrator: MI works in an OSGi environment, such Log4j2 ext

6. Restart the server.

## What's Next?
## What's next?

Once you have configured the logs, you can start [monitoring and analyzing logs]({{base_path}}/observe-and-manage/classic-observability-logs/monitoring-logs) to troubleshoot issues and observe runtime behavior.
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ It is recommended to use OTLP to view the traces through NewRelic APM. But still
For other vendors, please consult the respective documentations.


## Using the Custom Tracer Implementation
## Using the custom tracer implementation

By using a custom tracer implementation in WSO2 MI, you can publish tracing data from WSO2 MI to any tracing server. Let's implement a custom tracer which simply prints the logs via the System.out in WSO2 MI using the instructions given below:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ The Grafana based observability solution is based on proven projects from the **
| Logging | Log4j2, Fluent-Bit, and Grafana Loki |
| Tracing | Jaeger |

## What's Next?
## What's next?

- Set up <a href="{{base_path}}/observe-and-manage/setting-up-cloud-native-observability-on-a-vm">Grafana based observability on a VM</a>.
- Set up <a href="{{base_path}}/observe-and-manage/setting-up-cloud-native-observability-in-kubernetes/">Grafana based observability on Kubernetes</a>.
Original file line number Diff line number Diff line change
Expand Up @@ -662,6 +662,6 @@ Once this configuration is complete, clicking on response time widgets within a

<a href="{{base_path}}/assets/img/integrate/monitoring-dashboard/jaeger-ui.png"><img src="{{base_path}}/assets/img/integrate/monitoring-dashboard/jaeger-ui.png" style="width:40%"></a>

## What's Next?
## What's next?

If you have successfully set up your Grafana based observability setup, see the instructions on [Viewing Grafana Dashboard]({{base_path}}/observe-and-manage/viewing-cloud-native-observability-statistics/).
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,6 @@ Once Grafana is successfully configured to visualize statistics, you should be c

[![jaeger ui]({{base_path}}/assets/img/integrate/monitoring-dashboard/jaeger-ui.png){: style="width:40%"}]({{base_path}}/assets/img/integrate/monitoring-dashboard/jaeger-ui.png)

## What's Next?
## What's next?

If you have successfully set up your Grafana based observability deployment, see the instructions on [Viewing Grafana Dashboard]({{base_path}}/observe-and-manage/viewing-cloud-native-observability-statistics/).
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ You can use the ICP server to perform the following administration tasks related

This page can be accessed by users with admin rights only. You can view details of users stored in the [external user store]({{base_path}}/install-and-setup/setup/user-stores/managing-users). You can also add new users to the specified cluster/group.

## Using the Integration Control Plane
## Using the integration control plane

Follow the steps given below to get started with the WSO2 Integration Control Plane.

Expand Down
2 changes: 1 addition & 1 deletion en/docs/reference/connectors/why-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ MI VS Code Extension is the tooling or IDE developers use to code their integrat

Operations of the WSO2 connector that you import are listed on the right-side panel. Developers can click and select connector operations to construct the integration logic. Input parameters to the operations can be provided as static values or expressions using the operation add form that appears when the connector operation is clicked.

## What's Next?
## What's next?

* [Learn how to write a connector from scratch]({{base_path}}/develop/customizations/creating-new-connector/)
* [Connector best practices and MI VS Code Extension]({{base_path}}/reference/connectors/connector-usage/)