WSO2 Micro Integrator

https://github.com/wso2/docs-mi
Admin
The WSO2 Micro Integrator documentation provides comprehensive guides, tutorials, and reference...
Tokens:880,394
Snippets:5,304
Trust Score:8.2
License:Apache-2.0
Update:5 months ago
Show doc for...
Tokens:
Raw
### Starting Backend Server (Bash)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/protocol-switching/switching-from-ftp-listener-to-mail-sender.md

Bash command to start the Axis2 backend server script (`axis2server.sh`) on MacOS or Linux systems. This server hosts the SimpleStockQuoteService required by the example.

```Bash
sh axis2server.sh
```

--------------------------------

### Listing All WSO2 MI Templates (Example) - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

An example command demonstrating how to list all templates in the 'dev' environment using the `mi get templates` command with the `-e` flag.

```bash
mi get templates -e dev
```

--------------------------------

### Starting Backend Server (Batch)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/protocol-switching/switching-from-ftp-listener-to-mail-sender.md

Batch command to start the Axis2 backend server script (`axis2server.bat`) on Windows systems. This server hosts the SimpleStockQuoteService required by the example.

```Batch
axis2server.bat
```

--------------------------------

### Starting Sample WebSocket Server Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/endpoint-examples/using-websocket-endpoints.md

Provides a Bash command to execute a Java program that starts a sample WebSocket server. This server is used as the backend for the WSO2 MI example. It requires the netty example JAR and its dependencies to be present in the specified directory structure.

```Bash
java -cp 'netty-example-4.0.30.Final.jar:lib/*:.' io.netty.example.http.websocketx.server.WebSocketServer
```

--------------------------------

### Starting Axis2 Server on MacOS/Linux

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/amazonsqs-connector/2.x/amazonsqs-connector-2.x-example.md

Executes the shell script to start the Axis2 server, which hosts the SimpleStockQuote back-end service required for the API invocation example.

```bash
sh axis2server.sh
```

--------------------------------

### Starting Axis2 Server on Windows

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/amazonsqs-connector/2.x/amazonsqs-connector-2.x-example.md

Executes the batch file to start the Axis2 server, hosting the SimpleStockQuote back-end service necessary for the API test.

```Batch
axis2server.bat
```

--------------------------------

### Getting Specific WSO2 MI Endpoint Template Info (Example) - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

An example command demonstrating how to get information for the 'sample_template' endpoint in the 'dev' environment.

```bash
mi get templates endpoint sample_template -e dev
```

--------------------------------

### Starting Backend Server on Windows - Batch

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/message-store-processor-examples/using-message-forwarding-processor.md

Command to execute the startup script for the Axis2 backend server on Windows. This script starts the server that hosts the `SimpleStockQuoteService`, which acts as the target backend service in this example.

```batch
axis2server.bat
```

--------------------------------

### Configuring HelloWorld API in WSO2 MI (Synapse XML)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/get-started/quick-start-guide.md

This Synapse XML defines a WSO2 Micro Integrator API named 'HelloWorldAPI' with a context '/helloworldapi'. It includes a GET resource (`uri-template="/"`) that executes an `inSequence`. The sequence makes an HTTP GET call to the backend service using a predefined connection 'HelloWorldConn' at the relative path '/zvdz/mi-qsg/v1.0' and then uses a `respond` mediator to send the response back to the client. This config requires the 'HelloWorldConn' connection to be previously defined.

```XML
<?xml version="1.0" encoding="UTF-8"?>
<api context="/helloworldapi" name="HelloWorldAPI" xmlns="http://ws.apache.org/ns/synapse">
    <resource methods="GET" uri-template="/">
        <inSequence>
            <http.get configKey="HelloWorldConn">
                <relativePath>/zvdz/mi-qsg/v1.0</relativePath>
                <headers>[]</headers>
                <forceScAccepted>false</forceScAccepted>
                <disableChunking>false</disableChunking>
                <forceHttp10>false</forceHttp10>
                <noKeepAlive>false</noKeepAlive>
                <responseVariable>http_get_1</responseVariable>
                <overwriteBody>true</overwriteBody>
            </http.get>
            <respond/>
        </inSequence>
        <faultSequence>
        </faultSequence>
    </resource>
</api>
```

--------------------------------

### Starting Axis2 Server Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/amazonsqs-connector/1.x/amazonsqs-connector-1.x-example.md

Executes the `axis2server.sh` script to start the Axis2 server, commonly used on Linux/macOS for hosting backend services like SimpleStockQuoteService. This command should be run from the `axis2Server/bin/` directory.

```bash
sh axis2server.sh
```

--------------------------------

### Starting Axis2 Server Batch

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/amazonsqs-connector/1.x/amazonsqs-connector-1.x-example.md

Executes the `axis2server.bat` script to start the Axis2 server, typically used on Windows for hosting backend services like SimpleStockQuoteService. This command should be run from the `axis2Server/bin/` directory.

```batch
axis2server.bat
```

--------------------------------

### Defining Commander Program with Options and Commands (JavaScript)

Source: https://github.com/wso2/docs-mi/blob/main/en/tools/config-catalog-generator/node_modules/commander/Readme.md

A complete example showing how to define a Commander program. It sets the version, adds global options, defines two subcommands (`setup` and `exec`) with their own options and action functions, includes an alias (`ex`) for `exec`, adds a custom help example for `exec`, and parses the command-line arguments. Requires the commander package and Node.js.

```JavaScript
const { program } = require('commander');

program
  .version('0.1.0')
  .option('-C, --chdir <path>', 'change the working directory')
  .option('-c, --config <path>', 'set config path. defaults to ./deploy.conf')
  .option('-T, --no-tests', 'ignore test hook');

program
  .command('setup [env]')
  .description('run setup commands for all envs')
  .option("-s, --setup_mode [mode]", "Which setup mode to use")
  .action(function(env, options){
    const mode = options.setup_mode || "normal";
    env = env || 'all';
    console.log('setup for %s env(s) with %s mode', env, mode);
  });

program
  .command('exec <cmd>')
  .alias('ex')
  .description('execute the given remote cmd')
  .option("-e, --exec_mode <mode>", "Which exec mode to use")
  .action(function(cmd, options){
    console.log('exec "%s" using %s mode', cmd, options.exec_mode);
  }).on('--help', function() {
    console.log('');
    console.log('Examples:');
    console.log('');
    console.log('  $ deploy exec sequential');
    console.log('  $ deploy exec async');
  });

program.parse(process.argv);
```

--------------------------------

### Starting MI with SAP JCo Library Path (Bash)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/integration-tutorials/sap-integration.md

This Bash command demonstrates how to start the WSO2 Micro Integrator from the <MI_HOME>/bin directory. It uses the -Djava.library.path switch to specify the filesystem path where the SAP Java Connector (JCo) library files are located, which is required for the SAP adapter to function correctly.

```bash
./micro-integrator.sh -Djava.library.path=/usr/lib/jvm/jre1.7.0/lib/i386/server/
```

--------------------------------

### Starting Backend Server on MacOS/Linux - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/message-store-processor-examples/using-message-forwarding-processor.md

Command to execute the startup script for the Axis2 backend server on Unix-like operating systems (MacOS, Linux). This script starts the server that hosts the `SimpleStockQuoteService`, which acts as the target backend service in this example.

```bash
sh axis2server.sh
```

--------------------------------

### Listing WSO2 MI Sequence Templates (Example) - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

An example command to list only 'sequence' type templates in the 'dev' environment using the `mi get templates` command.

```bash
mi get templates sequence -e dev
```

--------------------------------

### Starting MI with SAP JCo Library Path (Bash)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/integration-tutorials/sap-integration.md

This Bash command demonstrates how to start the WSO2 Micro Integrator from the <MI_HOME>/bin directory. It uses the -Djava.library.path switch to specify the filesystem path where the SAP Java Connector (JCo) library files are located, which is required for the SAP adapter to function correctly.

```bash
./micro-integrator.sh -Djava.library.path=/usr/lib/jvm/jre1.7.0/lib/i386/server/
```

--------------------------------

### Starting MI with SAP JCo Library Path (Bash)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/integration-tutorials/sap-integration.md

This Bash command demonstrates how to start the WSO2 Micro Integrator from the <MI_HOME>/bin directory. It uses the -Djava.library.path switch to specify the filesystem path where the SAP Java Connector (JCo) library files are located, which is required for the SAP adapter to function correctly.

```bash
./micro-integrator.sh -Djava.library.path=/usr/lib/jvm/jre1.7.0/lib/i386/server/
```

--------------------------------

### Running Picomatch Unit Tests - Shell

Source: https://github.com/wso2/docs-mi/blob/main/en/tools/config-catalog-generator/node_modules/picomatch/README.md

Provides the standard shell command sequence to install project dependencies and then execute the unit tests for the `picomatch` library. This is a common workflow for Node.js projects using npm. Requires Node.js and npm to be installed.

```sh
npm install && npm test
```

--------------------------------

### Starting Axis2 Server (Windows) for Backend

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/message-store-processor-examples/using-jms-message-stores.md

Executes the batch script to start the Axis2 server from the `axis2Server/bin/` directory, hosting the SimpleStockQuoteService backend required for the examples.

```bash
axis2server.bat
```

--------------------------------

### Starting Axis2 Server (MacOS/Linux) for Backend

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/message-store-processor-examples/using-jms-message-stores.md

Executes the shell script to start the Axis2 server from the `axis2Server/bin/` directory, hosting the SimpleStockQuoteService backend required for the examples.

```bash
sh axis2server.sh
```

--------------------------------

### Starting Axis2 Backend Server - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/message-store-processor-examples/securing-message-processor.md

These commands are used to start the Axis2 backend server, which hosts the `SimpleStockQuote` service required for this example. The appropriate command should be executed from the `axis2Server/bin/` directory based on the operating system.

```bash
sh axis2server.sh
```

```bash
axis2server.bat
```

--------------------------------

### Starting Micro Integrator with JCo Library Path - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/integration-tutorials/sap-integration.md

Provides a sample Bash command to start the WSO2 Micro Integrator server, specifying the location of the SAP JCo native library using the -Djava.library.path system property. This is necessary for the SAP adapter to function correctly and is crucial when configuring MI as an IDoc client or server.

```bash
./micro-integrator.sh -Djava.library.path=/usr/lib/jvm/jre1.7.0/lib/i386/server/
```

--------------------------------

### Activating WSO2 MI Proxy Service (Response) - Go

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

An example response confirming that the specified proxy service has started successfully.

```go
Proxy service StockQuoteProxy started successfully
```

--------------------------------

### Sample Get Employee Skills Response Payload JSON

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/ceridiandayforce-connector/employee-employment-information/employeeskills.md

An example JSON response received from the Dayforce API after successfully retrieving employee skills via the WSO2 Micro Integrator connector. It shows the structure containing skill information, including XRefCode, names, effective start date, and who last assigned it.

```JSON
{
    "Data": [
        {
            "Skill": {
                "XRefCode": "8",
                "ShortName": "Tech",
                "LongName": "Tech"
            },
            "SkillLevel": {},
            "EffectiveStart": "2019-09-01T00:00:00",
            "LastAssignedBy": "Macon Burke"
        }
    ]
}
```

--------------------------------

### Starting SimpleStockQuote Backend Service - CMD

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/redis-connector/redis-connector-example.md

This command starts the sample backend service `SimpleStockQuoteService` on Windows by executing the `axis2server.bat` script located in the `axis2server/bin/` directory. This service is a prerequisite for testing the WSO2 MI API's interaction with the backend.

```CMD
axis2server.bat
```

--------------------------------

### Getting Specific WSO2 MI Logger Info (Example) - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

An example command to get information for the 'org-apache-coyote' logger in the 'dev' environment.

```bash
mi get log-levels org-apache-coyote -e dev
```

--------------------------------

### Start MkDocs Development Server (Bash)

Source: https://github.com/wso2/docs-mi/blob/main/README.md

This bash command initiates the MkDocs built-in development server. It builds the static site and serves it locally, typically accessible at http://localhost:8000, allowing contributors to preview changes live as they edit documentation files.

```bash
mkdocs serve
```

--------------------------------

### Starting SimpleStockQuote Backend Service - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/redis-connector/redis-connector-example.md

This command starts the sample backend service `SimpleStockQuoteService` on MacOS/Linux by executing the `axis2server.sh` script located in the `axis2server/bin/` directory. This service is a prerequisite for testing the WSO2 MI API's interaction with the backend.

```Bash
sh axis2server.sh
```

--------------------------------

### Starting Axis2 Server on MacOS/Linux

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/proxy-service-examples/publishing-a-custom-wsdl.md

Bash command to execute the startup script for the Axis2 server on MacOS or Linux operating systems, typically used for running sample backend services.

```bash
sh axis2server.sh
```

--------------------------------

### Starting Java Backend Service - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/integration-tutorials/sending-a-simple-message-to-a-service.md

This command executes the backend service JAR file. It requires a Java Runtime Environment (JDK 11 or later as indicated by the filename) installed and the service JAR file present in the current directory. The command starts a server process that listens for incoming requests, simulating a backend API.

```Bash
java -jar Hospital-Service-JDK11-2.0.0.jar
```

--------------------------------

### Serving documentation locally with mkdocs - bash

Source: https://github.com/wso2/docs-mi/blob/main/en/CONTRIBUTE.md

After installing mkdocs and navigating to the documentation source directory, this command starts a local web server that renders the documentation, allowing contributors to preview their changes.

```bash
mkdocs serve
```

--------------------------------

### Sample Request for Get User Mentions Timeline - XML

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/twitter-connector/twitter-connector-reference.md

A concrete example of an XML request payload for the `getUserMentionsTimeline` operation, demonstrating how to provide specific values for parameters like user ID, start time, maximum results, and requested tweet fields.

```XML
<twitter.getUserMentionsTimeline>
    <id>"1655515285577936899"</id>
    <start_time>"2020-01-01T00:00:00Z"</start_time>
    <max_results>10</max_results>
    <tweet_fields>"created_at,lang,conversation_id"</tweet_fields>
</twitter.getUserMentionsTimeline>
```

--------------------------------

### Dayforce Get Employee Employment Types Sample JSON Response

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/ceridiandayforce-connector/employee-employment-information/employeeemploymenttypes.md

Example JSON response returned by the Dayforce API when successfully retrieving employee employment types via the connector. It includes details such as the effective start date and the employment type information (XRefCode, ShortName, LongName).

```json
{
    "Data": [
        {
            "EffectiveStart": "2019-06-01T00:00:00",
            "EmploymentType": {
                "XRefCode": "Employee",
                "ShortName": "Employee",
                "LongName": "Employee"
            }
        }
    ]
}
```

--------------------------------

### Sample Request for Get User Tweets Timeline - XML

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/twitter-connector/twitter-connector-reference.md

This sample XML payload demonstrates how to construct a request to the `getUserTweetsTimeline` operation. It provides specific values for parameters such as the user ID, start time, maximum number of results, and desired tweet fields, showing a practical usage example.

```xml
<twitter.getUserTweetsTimeline>
    <id>"1655515285577936899"</id>
    <start_time>"2020-01-01T00:00:00Z"</start_time>
    <max_results>10</max_results>
    <tweet_fields>"created_at,lang,conversation_id"</tweet_fields>
</twitter.getUserTweetsTimeline>
```

--------------------------------

### Starting Axis2 Server (SimpleStockQuote) - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/message-transformation-examples/json-to-soap-conversion.md

Provides the Bash command to start the Axis2 server with the SimpleStockQuote backend service on MacOS/Linux systems. This script initializes the backend required for processing the SOAP requests sent by the Micro Integrator examples. It must be executed from the `axis2Server/bin/` directory of the extracted backend service package.

```Bash
sh axis2server.sh
```

--------------------------------

### Sample Dayforce Get Documents Response - JSON

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/ceridiandayforce-connector/employee-documents/listofdocuments.md

An example of the JSON response returned by the Ceridian Dayforce API when retrieving a list of documents for an employee. The `Data` array contains objects representing each document, including its unique GUID, name, filename, upload date, and details of the user who uploaded it.

```JSON
{
    "Data": [
        {
            "DocumentGUID": "52dd3956-4ba3-4001-8678-a102757d42eb",
            "DocumentName": "Aaron Glover Employment Contract.jpg",
            "DocumentType": {},
            "FileName": "Aaron Glover Employment Contract.jpg",
            "UploadedDate": "2015-04-15T14:39:20.13",
            "UploadedBy": {
                "DisplayName": "Macon Burke",
                "XRefCode": "62779",
                "LoginId": "CAdmin"
            }
        },
        {
            "DocumentGUID": "696afd0c-5890-4316-9b7e-7ac990189018",
            "DocumentName": "Aaron Glover Birth Certificate.jpg",
            "DocumentType": {},
            "FileName": "Aaron Glover Birth Certificate.jpg",
            "UploadedDate": "2015-04-15T14:39:10.7",
            "UploadedBy": {
                "DisplayName": "Macon Burke",
                "XRefCode": "62779",
                "LoginId": "CAdmin"
            }
        }
    ]
}
```

--------------------------------

### Starting Axis2 Server (SimpleStockQuote) - Windows Batch

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/message-transformation-examples/json-to-soap-conversion.md

Provides the Windows Batch command to start the Axis2 server with the SimpleStockQuote backend service on Windows systems. This script initializes the backend required for processing the SOAP requests sent by the Micro Integrator examples. It must be executed from the `axis2Server/bin/` directory of the extracted backend service package.

```Batch
axis2server.bat
```

--------------------------------

### Example: Starting MI Automation Mode with Specific CAR - Bash/Batch

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/install-and-setup/install/running-the-mi-in-automation-mode.md

Provides a concrete example of starting the WSO2 Micro Integrator in automation mode using a specific CAR file. This command executes the automation sequence contained within the 'TaskExecutingServiceCompositeExporter' CAR. Execute this command from the MI_HOME/bin directory.

```bash
sh micro-integrator.sh --car TaskExecutingServiceCompositeExporter
```

```batch
micro-integrator.bat --car TaskExecutingServiceCompositeExporter
```

--------------------------------

### Starting WSO2 Micro Integrator with JCO Path - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/integration-tutorials/sap-integration.md

This command starts the WSO2 Micro Integrator server from its bin directory. The `-Djava.library.path` system property specifies the location of the native SAP JCO library (e.g., `libsapjco3.so` or `sapjco3.dll`), which is essential for the SAP adapter's functionality. Ensure the path points to the directory containing the native library file.

```bash
./micro-integrator.sh -Djava.library.path=/usr/lib/jvm/jre1.7.0/lib/i386/server/
```

--------------------------------

### Invoking Get All Reservations API (Bash/cURL)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/snowflake-connector/snowflake-connector-example.md

This bash snippet shows a 'curl' command to send a GET request to the '/snowflakeconnector/getReservationInfo' endpoint to retrieve all reservation records from Snowflake.

```Bash
curl -H "Content-Type: application/json" --request GET http://localhost:8290/snowflakeconnector/getReservationInfo
```

--------------------------------

### Invoking Data Service GET Resource via Curl (Example)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/data-integration/json-with-data-service.md

This bash snippet provides a concrete example of using curl to invoke the WSO2 Micro Integrator data service GET resource for EmployeeNumber 1, demonstrating how to fetch data for a specific employee in JSON format.

```bash
curl -X GET -H "Accept: application/json" http://localhost:8290/services/RDBMSDataService/Employee/1
```

--------------------------------

### Setting up MongoDB Database and Data | Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/data-integration/mongo-data-service.md

Provides bash commands to connect to the MongoDB shell, create a database named `employeesdb`, create an `employees` collection, and insert sample documents into both `things` and `employees` collections. This prepares the database with sample data for the data service example.

```bash
mongosh
use employeesdb
db.createCollection("employees")
db.things.insert( { id: 1, name: "Document1" } )
db.employees.insert( { id: 1, name: "Sam" } )
db.employees.insert( { id: 2, name: "Mark" } )
db.employees.insert( { id: 3, name: "Steve" } )
db.employees.insert( { id: 4, name: "Jack" } )
```

--------------------------------

### Starting Sample Backend Service - Shell

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/transport-examples/tcp-transport-examples.md

Commands to start the Axis2 server with the SimpleStockQuote service, which is used as the backend for the TCP proxy example.

```bash
sh axis2server.sh
```

```batch
axis2server.bat
```

--------------------------------

### Listing WSO2 MI Endpoint Templates (Example) - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

An example command to list only 'endpoint' type templates in the 'dev' environment using the `mi get templates` command.

```bash
mi get templates endpoint -e dev
```

--------------------------------

### Starting Axis2 Server on Windows

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/proxy-service-examples/publishing-a-custom-wsdl.md

Batch command to execute the startup script for the Axis2 server on Windows operating systems, typically used for running sample backend services.

```bash
axis2server.bat
```

--------------------------------

### Listing WSO2 MI Log Files (Example) - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

An example command demonstrating how to list available log files in the 'dev' environment.

```bash
mi get logs -e dev
```

--------------------------------

### Starting Backend Server Script (MacOS/Linux)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/sequence-examples/using-multiple-sequences.md

This bash command is used to execute the startup script for the axis2 server on MacOS or Linux. Ensure you are located in the 'axis2Server/bin/' directory of the extracted backend service zip file before running.

```bash
sh axis2server.sh
```

--------------------------------

### Example Response for Listing Proxy Services (Go)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

Shows the typical output format returned by the `mi get proxy-services` command. The output lists the name and WSDL endpoints (1.1 and 2.0) for each proxy service. Tagged as Go, but represents console output.

```go
NAME                WSDL 1.1                                                WSDL 2.0
StockQuoteProxy     http://localhost:8290/services/StockQuoteProxy?wsdl     http://localhost:8290/services/StockQuoteProxy?wsdl2
```

--------------------------------

### Starting Axis2 Server on Windows (bat)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/protocol-switching/switching-from-fix-to-http.md

Command to execute the batch script that starts the Axis2 server on Windows. This server hosts the SimpleStockQuote back-end service required for this example.

```bat
axis2server.bat
```

--------------------------------

### Setting up Database and User for WSO2 Sample - Bash/SQL

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/samples/students-data-service.md

Provides SQL commands to create the necessary database (`school_db`) and a dedicated user (`user` with password `password`) with appropriate privileges. These commands are executed typically via a database client or command line, prepared for the WSO2 Micro Integrator Data Service sample.

```sql
CREATE DATABASE school_db;
USE school_db;
CREATE USER 'user'@'localhost' IDENTIFIED BY 'password';
GRANT ALL PRIVILEGES ON school_db.* TO 'user'@'localhost';
```

--------------------------------

### Starting Backend Axis2 Server - Batch

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/routing-examples/splitting-aggregating-messages.md

Command to start the sample Axis2 backend server on Windows systems. This server hosts the SimpleStockQuoteService required by the Micro Integrator example.

```Batch
axis2server.bat
```

--------------------------------

### Example Response for Listing Sequences (Go)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

Shows the typical output format returned by the `mi get sequences` command. The output lists the name, stats, and tracing status for each sequence. Tagged as Go, but represents console output.

```go
NAME                STATS               TRACING
fault               disabled            disabled
main                disabled            disabled
sample-sequence     disabled            disabled
```

--------------------------------

### Starting Axis2 Server on Linux/MacOS (bash)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/protocol-switching/switching-from-fix-to-http.md

Command to execute the shell script that starts the Axis2 server on Linux or macOS. This server hosts the SimpleStockQuote back-end service required for this example.

```bash
sh axis2server.sh
```

--------------------------------

### Starting Micro Integrator Batch on Windows

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/install-and-setup/install/running-the-mi.md

Run this command from the command prompt in the `<MI_HOME>/bin` folder on Windows to start the Micro Integrator server in the foreground. The server's console output will appear in the command window.

```Bash
micro-integrator.bat
```

--------------------------------

### Starting Backend Axis2 Server - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/routing-examples/splitting-aggregating-messages.md

Command to start the sample Axis2 backend server on MacOS or Linux systems. This server hosts the SimpleStockQuoteService required by the Micro Integrator example.

```Bash
sh axis2server.sh
```

--------------------------------

### Listing WSO2 MI Log Files (Response) - Go

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

An example response showing the list of available log files and their sizes from the WSO2 Micro Integrator.

```go
NAME                            SIZE
wso2carbon.log                  429.5 KB
correlation.log                 0 B
wso2carbon-trace-messages.log   0 B
wso2-mi-api.log                 11.9 KB
patches.log                     15.7 KB
audit.log                       0 B
wso2-mi-service.log             10.3 KB
http_access_.log                35.8 KB
wso2error.log                   156.2 KB
```

--------------------------------

### Starting WSO2 Axis2 Backend Server

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/endpoint-examples/endpoint-error-handling.md

This command starts the Axis2 server with the SimpleStockQuote service, which is used as a backend for the WSO2 Micro Integrator examples. The command differs based on the operating system.

```bash
sh axis2server.sh
```

```bash
axis2server.bat
```

--------------------------------

### Sample Response Payload for Get Employee Union Memberships (JSON)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/ceridiandayforce-connector/employee-employment-information/employeeunionmemberships.md

An example of the JSON response returned by the Dayforce API after a successful `getEmployeeUnionMemberships` operation. It contains a list of union memberships for the specified employee, including details like the membership date, effective start date, and union information (XRefCode, ShortName, LongName). This is the data typically returned by the WSO2 MI proxy to the client.

```json
{
    "Data": [
        {
            "UnionMembershipDate": "2000-01-01T00:00:00",
            "EffectiveStart": "2000-01-01T00:00:00",
            "Union": {
                "XRefCode": "Local 306",
                "ShortName": "Local 306",
                "LongName": "Local 306"
            }
        }
    ]
}
```

--------------------------------

### Activating WSO2 MI Proxy Service (Example) - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

An example command to activate the 'StockQuoteProxy' in the 'dev' environment.

```bash
mi activate proxy-service StockQuoteProxy -e dev
```

--------------------------------

### Starting Axis2 Server - Windows Batch

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/inbound-endpoint-examples/inbound-endpoint-jms-protocol.md

Executes the `axis2server.bat` script located in the `axis2Server/bin/` directory. This script starts the Axis2 backend server, which includes the SimpleStockQuoteService used as the target endpoint in the example.

```Batch
axis2server.bat
```

--------------------------------

### Starting Backend Service Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/integration-tutorials/storing-and-forwarding-messages.md

Executes the downloaded backend service JAR file using the `java` command. This service is a prerequisite for testing the WSO2 MI integration flow and requires Java JDK 11 or compatible to be installed.

```bash
java -jar Hospital-Service-JDK11-2.0.0.jar
```

--------------------------------

### Starting Axis2 Server - MacOS/Linux Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/inbound-endpoint-examples/inbound-endpoint-jms-protocol.md

Executes the `axis2server.sh` script located in the `axis2Server/bin/` directory. This script starts the Axis2 backend server, which includes the SimpleStockQuoteService used as the target endpoint in the example.

```Bash
sh axis2server.sh
```

--------------------------------

### Starting Kafka Console Producer (Bash)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/kafka-connector/kafka-inbound-endpoint-example.md

Bash command to start a Kafka console producer client. It connects to specified Kafka brokers and allows sending messages interactively to a given topic.

```Bash
bin/kafka-console-producer.sh --broker-list localhost:9092 --topic test
```

--------------------------------

### Starting Axis2 Backend Service - Batch (Windows)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/rest-api-examples/enabling-rest-to-soap.md

This batch command is used to start the sample Axis2 server on Windows. This server hosts the SimpleStockQuoteService, which acts as the backend SOAP endpoint for the example.

```bash
axis2server.bat
```

--------------------------------

### Building Documentation Shell

Source: https://github.com/wso2/docs-mi/blob/main/en/tools/config-catalog-generator-mi/node_modules/is-extglob/README.md

Installs the required command-line tools (`verb`, `verb-generate-readme`) globally using npm and then runs the `verb` command to generate documentation based on the project's configuration.

```sh
$ npm install -g verb verb-generate-readme && verb
```

--------------------------------

### Starting Axis2 Server - Windows Batch

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/protocol-switching/switching-from-jms-to-http.md

Executes the `axis2server.bat` script to start the Axis2 server on Windows. This server hosts the back-end `SimpleStockQuoteService` required for the example to function. The script is located in the `axis2Server/bin/` directory.

```batch
axis2server.bat
```

--------------------------------

### Starting Axis2 Server - MacOS/Linux Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/protocol-switching/switching-from-jms-to-http.md

Executes the `axis2server.sh` script to start the Axis2 server on MacOS/Linux. This server hosts the back-end `SimpleStockQuoteService` required for the example to function. The script is located in the `axis2Server/bin/` directory.

```bash
sh axis2server.sh
```

--------------------------------

### Initializing MI CLI Execution (Go)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

Executes the 'mi' command to start the WSO2 MI CLI. This command initializes the CLI and creates the user configuration directory (~/.wso2mi) if it does not already exist.

```go
mi
```

--------------------------------

### Starting Axis2 Backend Server (Batch)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/scheduled-tasks/task-scheduling-simple-trigger.md

Provides the batch command to start the Axis2 server on Windows. This server hosts the SimpleStockQuote service, which acts as the backend for the example. It requires navigating to the `axis2Server/bin/` directory before execution.

```batch
axis2server.bat
```

--------------------------------

### Starting ZooKeeper Server (Bash)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/kafka-connector/setting-up-kafka.md

This command starts the Apache ZooKeeper server, which is a prerequisite for running Kafka. It executes the `zookeeper-server-start.sh` script located in the Kafka `bin` directory, using the `zookeeper.properties` configuration file from the `config` directory. This command should be run from the Kafka home directory (`<KAFKA_HOME>`).

```bash
bin/zookeeper-server-start.sh config/zookeeper.properties
```

--------------------------------

### Building Documentation - Shell

Source: https://github.com/wso2/docs-mi/blob/main/en/tools/config-catalog-generator-mi/node_modules/normalize-path/README.md

Installs the necessary tools globally and runs the command to regenerate the project's documentation (the README file) from its template.

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

--------------------------------

### Starting Axis2 Backend Service - Bash (Linux/MacOS)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/rest-api-examples/enabling-rest-to-soap.md

This bash command is used to start the sample Axis2 server on Linux or MacOS. This server hosts the SimpleStockQuoteService, which acts as the backend SOAP endpoint for the example.

```bash
sh axis2server.sh
```

--------------------------------

### Building Documentation with Verb (Shell)

Source: https://github.com/wso2/docs-mi/blob/main/en/tools/config-catalog-generator-mi/node_modules/is-glob/README.md

Provides the command-line instructions required to install the necessary tools globally (`verb` and `verb-generate-readme`) and then execute `verb` to generate the project's readme documentation.

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

--------------------------------

### Starting - Axis2 Back-end Server - Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/jms-examples/guaranteed-delivery-with-failover.md

This Bash command is used to start the sample Axis2 server from the `axis2Server/bin/` directory on macOS or Linux. This server hosts the `SimpleStockQuoteService` required as the back-end for this WSO2 Micro Integrator example.

```bash
sh axis2server.sh
```

--------------------------------

### Invoking Gmail Connector Example API (curl)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/gmail-connector/gmail-connector-example.md

This `curl` command demonstrates how to trigger the WSO2 Micro Integrator `SendMails` API configured in the example. It sends a simple HTTP GET request to the API endpoint, initiating the email processing logic defined in the API and sequence artifacts. This is used to test the functionality of the deployed integration.

```curl
  curl -H "Content-Type: application/json" --request GET http://localhost:8290/sendmails
```

--------------------------------

### Starting Axis2 Server Backend Service on Linux/MacOS using Bash

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/proxy-service-examples/introduction-to-proxy-services.md

This command starts the Axis2 backend server, which hosts the SimpleStockQuoteService. It is executed from the `axis2Server/bin/` directory on Unix-like operating systems (MacOS/Linux) and serves as the backend for the WSO2 Micro Integrator proxy.

```Bash
sh axis2server.sh
```

--------------------------------

### Listing all MBeans via Jolokia HTTP GET

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/classic-observability-metrics/jmx-monitoring.md

This HTTP GET request example shows how to use the Jolokia JMX-HTTP bridge API to retrieve a list of all MBeans currently exposed by the monitored Java application (WSO2 Micro Integrator) running with the Jolokia agent.

```HTTP
http://localhost:9763/jolokia/list
```

--------------------------------

### Starting Axis2 Server Backend Service on Windows using Batch

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/proxy-service-examples/introduction-to-proxy-services.md

This command starts the Axis2 backend server, which hosts the SimpleStockQuoteService. It is executed from the `axis2Server/bin/` directory on Windows operating systems and serves as the backend for the WSO2 Micro Integrator proxy.

```Batch
axis2server.bat
```

--------------------------------

### Example Response for Listing Message Stores (Go)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

Shows the typical output format returned by the `mi get message-stores` command. The output is presented in a table format listing the name, type, and size of each message store. Tagged as Go, but represents console output.

```go
NAME                      TYPE                      SIZE
in-memory-message-store   in-memory-message-store   0
```

--------------------------------

### Starting Axis2 Backend Server (Bash)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/scheduled-tasks/task-scheduling-simple-trigger.md

Provides the shell command to start the Axis2 server on MacOS or Linux. This server hosts the SimpleStockQuote service, which acts as the backend for the example. It requires navigating to the `axis2Server/bin/` directory before execution.

```bash
sh axis2server.sh
```

--------------------------------

### Starting ActiveMQ Server

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/samples/protocol-switching.md

This bash command is used to start the ActiveMQ message broker server from the WSO2 MI bin directory. ActiveMQ is required for this sample as the downstream message destination.

```bash
sh activemq.sh start
```

--------------------------------

### Starting YAJSW Service Batch Script (Bash)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/install-and-setup/install/running-the-integration-control-plane-as-windows-service.md

Executes the `startService.bat` script located in the `<YAJSW_HOME>/bat/` directory. This command is used in a Windows command prompt with administrative privileges to start the Windows service previously installed by YAJSW.

```bash
startService.bat
```

--------------------------------

### Connecting to MySQL Server (bash)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/install-and-setup/setup/databases/setting-up-mysql.md

This bash command initiates a connection to a MySQL server from the command line. It uses the specified username and prompts for the associated password. This is a prerequisite for executing SQL commands to create and populate databases.

```bash
mysql -u username -p
```

--------------------------------

### Starting Axis2 Backend Service

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/message-transformation-examples/json-to-soap-conversion.md

These commands execute the script to start the Axis2 server, which hosts the SimpleStockQuote backend service required for this example. The specific command depends on the operating system (Linux/macOS or Windows). Ensure you are in the 'axis2Server/bin/' directory before executing.

```bash
sh axis2server.sh
```

```batch
axis2server.bat
```

--------------------------------

### Building Documentation verb sh

Source: https://github.com/wso2/docs-mi/blob/main/en/tools/config-catalog-generator/node_modules/to-regex-range/README.md

This command installs the 'verb' command-line tool and the 'verb-generate-readme' plugin globally in development mode. After successful installation, it runs the 'verb' command to generate the project's README file based on a template.

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

--------------------------------

### Starting Axis2 Server - Batch Command

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/learn/examples/jms-examples/quad-channel-jms-to-jms.md

This Batch command executes the startup script for the Axis2 server on Windows systems. It's used to start the backend service necessary for the JMS example, which usually includes services like SimpleStockQuote.

```Batch
axis2server.bat
```

--------------------------------

### Example Response for Specific Sequence Details (Go)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

Illustrates the detailed output returned by the `mi get sequences [name]` command for a specific sequence. Includes container, stats, tracing status, and a list of mediators. Tagged as Go, but represents console output.

```go
Name - sample-sequence
Container - [ Deployed From Artifact Container: HealthCareCompositeExporter ]
Stats - disabled
Tracing - disabled
Mediators - LogMediator, STRING
```

--------------------------------

### Dayforce Get Employee Labor Defaults Sample Response (JSON)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/reference/connectors/ceridiandayforce-connector/employee-employment-information/employeelabordefaults.md

Shows a sample JSON response returned by the Dayforce Get Employee Labor Defaults API call. It contains example employee labor default information, such as position and location.

```JSON
{
    "Data": [
        {
            "Position": {
                "XRefCode": "Assembly 2 Process Technician",
                "ShortName": "Assembly 2 Process Technician"
            },
            "EffectiveStart": "2019-10-01T00:00:00",
            "Location": {
                "XRefCode": "500Assembly 2",
                "ShortName": "Plant 1 - Assembly 2",
                "LongName": "Plant 1 - Assembly 2"
            }
        }
    ]
}
```

--------------------------------

### Installing universalify via npm

Source: https://github.com/wso2/docs-mi/blob/main/en/tools/config-catalog-generator/node_modules/universalify/README.md

This command installs the `universalify` package from the npm registry. Use it to add `universalify` as a dependency in your Node.js project.

```bash
npm install universalify
```

--------------------------------

### Example Response for Listing Scheduled Tasks (Go)

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/managing-integrations-with-micli.md

Shows the typical output format returned by the `mi get tasks` command. The output lists the names of each scheduled task. Tagged as Go, but represents console output.

```go
NAME
sample-cron-task
CheckPriceTask
```

--------------------------------

### Reading Specific Synapse MBean Attribute via Jolokia HTTP GET

Source: https://github.com/wso2/docs-mi/blob/main/en/docs/observe-and-manage/classic-observability-metrics/jmx-monitoring.md

This HTTP GET request example demonstrates reading a specific attribute (`ActiveConnections`) from a particular Synapse PassThroughConnections MBean (`https-sender`) exposed via the Jolokia agent, showing how to access individual MBean data.

```HTTP
http://localhost:9763/jolokia/read/org.apache.synapse:Name=https-sender,Type=PassThroughConnections/ActiveConnections
```
Tokens:
Raw