### Start Micro Integrator with Example Composite Application

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/install/running-the-mi-in-automation-mode

Example commands demonstrating the execution of a specific composite application named TaskExecutingServiceCompositeExporter.

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

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

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

### Start Kafka Server

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/feature-configs/configuring-kafka

Navigate to the Kafka home directory and run this command to start the Kafka server. This should be done after the ZooKeeper server has started.

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

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

### Start ZooKeeper Server

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/feature-configs/configuring-kafka

Navigate to the Kafka home directory and run this command to start the ZooKeeper server. Ensure ZooKeeper is running before starting the Kafka server.

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

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

### Start MI Server

Source: https://mi.docs.wso2.com/en/4.2.0/observe-and-manage/working-with-monitoring-dashboard

Commands to start the Micro Integrator server on different operating systems.

```shell
./micro-integrator.sh
```

```batch
micro-integrator.bat
```

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

### Start Axis2 Server

Source: https://mi.docs.wso2.com/en/4.2.0/develop/customizations/creating-custom-task-scheduling

Commands to start the backend service on different operating systems.

```bash
sh axis2server.sh
```

```batch
axis2server.bat
```

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

### Start Standalone HornetQ Server (Windows)

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/brokers/configure-with-hornetq

Command to start a standalone HornetQ server on Windows.

```bash
HORNETQ_HOME\bin\run.bat --run
```

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

### Example Response for GET Employee Data

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/data-integration/rdbms-data-service

This is an example of the XML response received when retrieving employee data using the GET resource.

```xml
<Entries xmlns="http://ws.wso2.org/dataservice"><Entry><EmployeeNumber>3</EmployeeNumber><FirstName>Will</FirstName><LastName>Smith</LastName><Email>will@google.com</Email><Salary>15500.0</Salary></Entry><Entry><EmployeeNumber>3</EmployeeNumber><FirstName>Will</FirstName><LastName>Smith</LastName><Email>will@google.com</Email><Salary>15500.0</Salary></Entry><Entry><EmployeeNumber>3</EmployeeNumber><FirstName>Will</FirstName><LastName>Smith</LastName><Email>will@google.com</Email><Salary>15500.0</Salary></Entry></Entries>

```

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

### Example: Production Environment Added Successfully

Source: https://mi.docs.wso2.com/en/4.2.0/observe-and-manage/managing-integrations-with-apictl

Example confirmation message for successfully adding the 'production' environment.

```text
Successfully added environment 'production'

```

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

### GET /documents/{guid}

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/ceridiandayforce-connector/employee-documents/documentdetails

Retrieves the contents of a specific document based on its unique GUID.

```APIDOC
## GET /documents/{guid}

### Description
Retrieves the contents of a particular document. It requires the document GUID that can be obtained with the Get a List of Documents operation.

### Method
GET

### Endpoint
/documents/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier of the document.
```

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

### Start the Micro Integrator server

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/install/running-the-mi

Execute these commands from the <MI_HOME>/bin directory to start the server in the foreground.

```bash
sh micro-integrator.sh
```

```batch
micro-integrator.bat
```

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

### Start Micro Integrator with System Property

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/dynamic-server-configurations

Pass system property values during server startup using the `-D` flag followed by the property name and its value.

```bash
./micro-integrator.sh -Doffset=19
```

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

### Get Muted Users Configuration

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/twitter-connector/twitter-connector-reference

Configuration example for the getMutedUsers operation.

```xml
<twitter.getMutedUsers>
    <id>{$ctx:id}</id>
    <max_results>{$ctx:max_results}</max_results>
    <pagination_token>{$ctx:pagination_token}</pagination_token>
    <expansions>{$ctx:expansions}</expansions>
    <tweet_fields>{$ctx:tweet_fields}</tweet_fields>
```

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

### View Ingress resource output example

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/deployment/deploying-micro-integrator-with-helm

Example output showing the Ingress names, hosts, and addresses.

```text
NAME                                                 HOSTS                      ADDRESS        PORTS     AGE
<RELEASE_NAME>-micro-integrator-service-ingress      mi.wso2.com                <EXTERNAL-IP>  80, 443   3m
<RELEASE_NAME>-micro-integrator-management-ingress   management.mi.wso2.com     <EXTERNAL-IP>  80, 443   3m
```

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

### Get Dataset Response

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/bigquery-connector/bigquery-connector-reference

Example response returned by the getDataset operation.

```json
{
    "kind": "bigquery#dataset",
    "etag": "1xuEK5ngZZ+fj0iioOa6Og==",
    "id": "testbig-235116:testData",
    "selfLink": "https://content.googleapis.com/bigquery/v2/projects/testbig-235116/datasets/testData",
    "datasetReference": {
        "datasetId": "testData",
        "projectId": "testbig-235116"
    },
    "defaultTableExpirationMs": "5184000000",
    "access": [
        {
            "role": "WRITER",
            "specialGroup": "projectWriters"
        },
        {
            "role": "OWNER",
            "specialGroup": "projectOwners"
        },
        {
            "role": "OWNER",
            "userByEmail": "iamkesan@gmail.com"
        },
        {
            "role": "READER",
            "specialGroup": "projectReaders"
        }
    ],
    "creationTime": "1553104741840",
    "lastModifiedTime": "1553104741840",
    "location": "US",
    "defaultPartitionExpirationMs": "5184000000"
}
```

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

### Initialize apictl

Source: https://mi.docs.wso2.com/en/4.2.0/observe-and-manage/managing-integrations-with-apictl

Execute this command to start the apictl. The configuration directory will be created if it doesn't exist.

```bash
apictl

```

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

### Example GET request for employee data

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/data-integration/json-with-data-service

This is an example of a curl command to retrieve employee details for a specific employee number, requesting the response in JSON format.

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

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

### Start Unit Testing Server on MacOS/Linux/CentOS

Source: https://mi.docs.wso2.com/en/4.2.0/develop/creating-unit-test-suite

Use this command to start the unit testing server on MacOS, Linux, or CentOS. Ensure the Micro Integrator is running with the `-DsynapseTest` property.

```bash
sh micro-integrator.sh -DsynapseTest

```

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

### Get Dataset Configuration and Request

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/bigquery-connector/bigquery-connector-reference

Configuration and request examples for the getDataset operation.

```xml
<bigquery.getDataset>
    <projectId>{$ctx:projectId}</projectId>
    <datasetId>{$ctx:datasetId}</datasetId>
</bigquery.getDataset>
```

```json
{
    "accessToken": "ya29.BwKYx40Dith1DFQBDjZOHNqhcxmKs9zbkjAWQa1q8mdMFndp2-q8ifG66fwprOigRwKSNw",
    "apiUrl": "https://www.googleapis.com",
    "clientId": "504627865627-kdni8r2s10sjddfgXzqb4bvnba.apps.googleusercontent.com",
    "clientSecret": "ChlbHI_T7zssXXTRYuqj_-TM",
    "refreshToken": "1/uWful-diQNAdk-alDUa6ixxxxxxxx-LpJIikEQ2sqA",
    "registryPath": "connectors/bq",
    "projectId": "publicdata",
    "datasetId": "samples",
    "fields": "id",
    "callback": "callBackFunction",
    "apiKey": "154987fd5h4x6gh4",
    "prettyPrint": "true",
    "quotaUser": "1hx46f5g4h5ghx6h41x54gh6f4hx",
    "userIp": "192.77.88.12",
    "ifNoneMatch":"hnk59tKBkX8cdlePZ8VtzgVzuO4/tS1oqpXxnkU21hZeK5k4lqRrRr8",
    "ifMatch":"hnk59tKBkX8cdlePZ8VtzgVzuO4/tS1oqpXxnkU21hZeK5k4lqRrRr8"
}
```

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

### Sample Request for Get Avatars

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Example JSON request payload for the getAvatarsForProject operation.

```json
{
    "username":"admin",
    "password":"jira@jaffna",
    "uri":"http://localhost:8080",
    "projectIdOrKey":"TEST"
}
```

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

### Start Unit Testing Server on Windows

Source: https://mi.docs.wso2.com/en/4.2.0/develop/creating-unit-test-suite

Use this command to start the unit testing server on Windows. Ensure the Micro Integrator is running with the `-DsynapseTest` property.

```batch
micro-integrator.bat -DsynapseTest

```

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

### Sample Request for Retrieving Marital Statuses

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/ceridiandayforce-connector/employee-personal-information/employeemaritalstatuses

Example JSON payload for the GET operation.

```json
{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "xRefCode": "42199",
  "isValidateOnly": "true",
  "contextDateRangeFrom": "2017-01-01T13:24:56"
}
```

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

### Sample SAP .dest Configuration

Source: https://mi.docs.wso2.com/en/4.2.0/learn/integration-tutorials/sap-integration

Example content for a .dest properties file used to establish a connection to a SAP system.

```properties
jco.client.client=800
jco.client.user=wso2_user
jco.client.passwd=wso2pass14
jco.client.lang=en
jco.client.ashost=/H/217.116.29.154/S/3299/H/10.100.5.120/S/3200
jco.client.gwserv=3300
jco.client.sysnr=00
jco.client.idle_timeout=300
jco.client.logon=0
jco.client.msserv=3600
jco.client.trace=0
jco.client.getsso2=0
jco.client.r3name=CPT
```

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

### Get Transaction Report from Start Date

Source: https://mi.docs.wso2.com/en/4.2.0/observe-and-manage/working-with-management-api

Retrieves the transaction report for data starting from a specified date. Generates the report in the `<MI_HOME>/tmp` directory. Requires 'accept' and 'Authorization' headers.

```bash
 curl -X GET "https://localhost:9164/management/transactions/report?start=2020-01" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -k -i

```

```json
 {
  "TransactionCountData": [[col1, col2, col3, col4],[val1, val2, val3, val4]]
 }

```

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

### Example: Add Development Environment

Source: https://mi.docs.wso2.com/en/4.2.0/observe-and-manage/managing-integrations-with-apictl

Example command to add a development environment named 'dev' with the specified Micro Integrator management endpoint.

```bash
apictl add env dev --mi https://localhost:9164

```

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

### Example: Set Server Offset using Environment Variable

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/dynamic-server-configurations

This example shows how to set the server offset in `deployment.toml` using the `offset` environment variable. The environment variable should be exported before starting the server.

```toml
[server]
offset = "$env{offset}"
```

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

### Display apictl Help Information

Source: https://mi.docs.wso2.com/en/4.2.0/observe-and-manage/managing-integrations-with-apictl

Execute this command to view help information and example usage for apictl.

```bash
apictl --help

```

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

### Sample Jira Get User Request

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Example JSON request for the getUser operation, specifying the username to search for.

```json
{
    "username":"admin",
    "password":"jira@jaffna",
    "uri":"http://localhost:8080",
    "usernameFilter":"fred"
}
```

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

### Sample Response for Get Components

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Example JSON response structure for the getComponentsOfProject operation, detailing component information.

```json
[
    {
        "self": "http://localhost:8080/jira/rest/api/2/component/10000",
        "id": "10000",
        "name": "Component 1",
        "description": "This is a JIRA component",
        "lead": {
            "self": "http://localhost:8080/jira/rest/api/2/user?username=fred",
            "name": "fred",
            "avatarUrls": {
                "24x24": "http://localhost:8080/jira/secure/useravatar?size=small&ownerId=fred",
                "16x16": "http://localhost:8080/jira/secure/useravatar?size=xsmall&ownerId=fred",
                "32x32": "http://localhost:8080/jira/secure/useravatar?size=medium&ownerId=fred",
                "48x48": "http://localhost:8080/jira/secure/useravatar?size=large&ownerId=fred"
            },
            "displayName": "Fred F. User",
            "active": false
        },
        "assigneeType": "PROJECT_LEAD",
        "assignee": {
            "self": "http://localhost:8080/jira/rest/api/2/user?username=fred",
            "name": "fred",
            "avatarUrls": {
                "24x24": "http://localhost:8080/jira/secure/useravatar?size=small&ownerId=fred",
                "16x16": "http://localhost:8080/jira/secure/useravatar?size=xsmall&ownerId=fred",
                "32x32": "http://localhost:8080/jira/secure/useravatar?size=medium&ownerId=fred",
                "48x48": "http://localhost:8080/jira/secure/useravatar?size=large&ownerId=fred"
            },
            "displayName": "Fred F. User",
            "active": false
        },
        "realAssigneeType": "PROJECT_LEAD",
        "realAssignee": {
            "self": "http://localhost:8080/jira/rest/api/2/user?username=fred",
            "name": "fred",
            "avatarUrls": {
                "24x24": "http://localhost:8080/jira/secure/useravatar?size=small&ownerId=fred",
                "16x16": "http://localhost:8080/jira/secure/useravatar?size=xsmall&ownerId=fred",

```

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

### Run QuickFIX/J Executor

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/protocol-switching/switching-from-http-to-fix

Command to start the sample FIX executor application.

```bash
java -jar quickfixj-examples-executor-2.1.1.jar
```

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

### Start Micro Integrator on MacOS/Linux

Source: https://mi.docs.wso2.com/en/4.2.0/develop/integration-development-kickstart

Execute this command in the `<MI_HOME>/bin` directory to start the Micro Integrator on MacOS or Linux.

```bash
./micro-integrator.sh

```

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

### Sample Request for Get Votes

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Example JSON request to the getVotesForIssue operation, including authentication and issue identifier.

```json
{
    "username":"admin",
    "password":"jira@jaffna",
    "uri":"http://localhost:8080",
    "issueIdOrKey":"TEST-1"
}
```

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

### Sample Response for GET Employee Onboarding Policies

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/ceridiandayforce-connector/employee-employment-information/employeeonboardingpolicies

Example JSON response containing onboarding policy data.

```json
{
    "Data": [
        {
            "OnboardingPolicy": {
                "XRefCode": "db3de97e-f173-442d-86db-0e8bcb259ed0",
                "ShortName": "Default"
            },
            "EffectiveStart": "2019-01-01T00:00:00",
            "EffectiveEnd": "2019-10-12T23:59:00",
            "IsInternalHire": false
        }
    ]
}
```

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

### Start JBoss EAP Server (Linux/Mac)

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/brokers/configure-with-hornetq

Execute this command in the command prompt to start the JBoss EAP server with the full standalone configuration on Linux/Mac.

```bash
<EAP_HOME>/bin/standalone.sh -c standalone-full.xml
```

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

### Sample SAP Server Configuration

Source: https://mi.docs.wso2.com/en/4.2.0/learn/integration-tutorials/sap-integration

Example content for a *.server properties file used to define SAP gateway and server connection parameters.

```properties
jco.server.gwhost=/H/217.116.29.154/S/3299/H/10.100.5.120/S/3200
jco.server.gwserv=3300
jco.server.progid=IGS.CPT
jco.server.repository_destination=IGS.CPT
jco.server.name=IGS.CPT
jco.server.unicode=1
```

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

### GET a List of Documents

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/ceridiandayforce-connector/employee-documents/listofdocuments

Retrieves a list of documents attached to a specific employee, including document GUIDs for further processing.

```APIDOC
## GET /ceridiandayforce.getAListOfDocuments

### Description
Retrieves the list of documents attached to an employee. The response includes the document GUID used to retrieve contents with Get Document Details.

### Method
GET

### Parameters
#### Request Body
- **employeeXRefCode** (string) - Required - Uniquely identifies the employee whose document you want to retrieve. Partial search is not supported.

### Request Example
{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "xRefCode": "42199"
}

### Response
#### Success Response (200)
- **Data** (array) - A list of document objects containing DocumentGUID, DocumentName, FileName, UploadedDate, and UploadedBy details.

#### Response Example
{
    "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"
            }
        }
    ]
}
```

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

### List Batches

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/salesforcebulk-connector/salesforcebulk-reference

Configuration and request examples for retrieving details of all batches in a specific job.

```xml
<salesforcebulk.listBatches>
    <jobId>{$ctx:jobId}</jobId>
</salesforcebulk.listBatches>
```

```xml
<listBatches>
   <apiVersion>34.0</apiVersion>
   <accessToken>XXXXXXXXXXXX (Replace with your access token)</accessToken>
   <apiUrl>https://(your_instance).salesforce.com</apiUrl>
   <jobId>75028000000MCqEAAW</jobId>
</listBatches>
```

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

### Manage Windows service lifecycle

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/install/installing-mi-as-a-windows-service

Commands to install, start, stop, and uninstall the service from the YAJSW batch directory.

```batch
installService.bat
```

```batch
startService.bat
```

```batch
stopService.bat
```

```batch
uninstallService.bat
```

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

### Create and Initialize Databases

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/databases/setting-up-mysql

Commands to create specific databases and execute the corresponding SQL scripts provided in the MI_HOME directory.

```sql
mysql> create database clusterdb;
mysql> use clusterdb;
mysql> source <MI_HOME>/dbscripts/mysql/mysql_cluster.sql;
```

```sql
mysql> create database userdb;
mysql> use userdb;
mysql> source <MI_HOME>/dbscripts/mysql/mysql_user.sql;
```

```sql
mysql> create database transactiondb;
mysql> use transactiondb;
mysql> source <MI_HOME>/dbscripts/mysql/mysql_transaction_count.sql;
```

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

### Sample Response for Get Avatars

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Example JSON response structure for the getAvatarsForProject operation, showing system and custom avatars.

```json
{
    "system": [
        {
            "id": "1000",
            "owner": "fred",
            "isSystemAvatar": true,
            "isSelected": true,
            "selected": true
        }
    ],
    "custom": [
        {
            "id": "1010",
            "owner": "andrew",
            "isSystemAvatar": false,
            "isSelected": false,
            "selected": false
        }
    ]
}
```

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

### Sample Response for Get Votes

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Example JSON response from the getVotesForIssue operation, detailing vote count and voter list.

```json
{
    "self": "http://localhost:8080/jira/rest/api/issue/TEST-1/votes",
    "votes": 24,
    "hasVoted": true,
    "voters": [
        {
            "self": "http://localhost:8080/jira/rest/api/2/user?username=fred",
            "name": "fred",
            "avatarUrls": {
                "24x24": "http://localhost:8080/jira/secure/useravatar?size=small&ownerId=fred",
                "16x16": "http://localhost:8080/jira/secure/useravatar?size=xsmall&ownerId=fred",
                "32x32": "http://localhost:8080/jira/secure/useravatar?size=medium&ownerId=fred",
                "48x48": "http://localhost:8080/jira/secure/useravatar?size=large&ownerId=fred"
            },
            "displayName": "Fred F. User",
            "active": false
        }
    ]
}
```

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

### Start JBoss EAP Server (Windows)

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/brokers/configure-with-hornetq

Execute this command in the command prompt to start the JBoss EAP server with the full standalone configuration on Windows.

```bash
<EAP_HOME>\bin\standalone.bat -c standalone-full.xml
```

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

### Sample Response for Get Group

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

An example response from the `getGroup` operation, showing group details and user information if expanded.

```json
{
    "name": "jira-administrators",
    "self": "http://localhost:8080/rest/api/2/group?groupname=jira-administrators",
    "users": {
        "size": 1,
        "items": [],
        "max-results": 50,
        "start-index": 0,
        "end-index": 0
    },
    "expand": "users"
}
```

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

### Run QuickFIX/J Banzai Sample

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/protocol-switching/switching-from-fix-to-amqp

Execute the QuickFIX/J Banzai sample application to simulate FIX client behavior. This is used to send sample requests to the Micro Integrator.

```bash
java -jar quickfixj-examples-banzai-2.1.1.jar
```

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

### Sample Jira Get User Permissions Request

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Example JSON request for getUserPermissions, specifying the project key to check permissions against.

```json
{
    "username":"admin",
    "password":"jira@jaffna",
    "uri":"http://localhost:8080",
    "projectKey":"TEST"
}
```

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

### Example HTTP Proxy Configuration with Basic Authentication

Source: https://mi.docs.wso2.com/en/4.2.0/observe-and-manage/managing-integrations-with-apictl

Example of setting HTTP_PROXY and HTTPS_PROXY environment variables for proxying requests with basic authentication.

```bash
export HTTP_PROXY="http://testuser:password@localhost:3128"

export HTTPS_PROXY="https://testuser:password@localhost:3128"

export http_proxy="http://testuser:password@localhost:3128"

export https_proxy="https://testuser:password@localhost:3128"

```

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

### Get Bulk Query Results

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/salesforcebulk-connector/salesforcebulk-reference

Configuration and request examples for retrieving bulk query results using jobId, batchId, and resultId.

```xml
<salesforcebulk.getBulkQueryResults>
    <jobId>{$ctx:jobId}</jobId>
    <batchId>{$ctx:batchId}</batchId>
    <resultId>{$ctx:resultId}</resultId>
</salesforcebulk.getBulkQueryResults>
```

```xml
<getBulkQueryResults>
   <apiVersion>34.0</apiVersion>
   <accessToken>XXXXXXXXXXXX (Replace with your access token)</accessToken>
   <apiUrl>https://(your_instance).salesforce.com</apiUrl>
   <jobId>75028000000MCqEAAW</jobId>
   <batchId>7510K00000Kzb6XQAR</batchId>
   <resultId>7520K000006xofz</resultId>
</getBulkQueryResults>
```

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

### Start Micro Integrator Dashboard (Linux/macOS)

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/install/running-the-mi-dashboard

Execute this command in the terminal to start the Micro Integrator Dashboard server on Linux or macOS.

```bash
sh dashboard.sh

```

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

### Start Fluent Bit

Source: https://mi.docs.wso2.com/en/4.2.0/observe-and-manage/setting-up-cloud-native-observability-on-a-vm

Command to start the Fluent Bit agent with the specified configuration file. Ensure the path to fluentBit.conf is correct.

```bash
fluent-bit -c <fluentBit.conf file path>
```

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

### Sample Response for Employee Documents

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/ceridiandayforce-connector/employee-documents/listofdocuments

Example JSON response containing a list of documents with their respective GUIDs, names, and upload metadata.

```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"
            }
        }
    ]
}
```

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

### Jira Get Comments Response Example

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Sample JSON response structure for the `getComments` operation, detailing comment metadata, author, and content.

```json
{
    "startAt": 0,
    "maxResults": 1,
    "total": 1,
    "comments": [
        {
            "self": "http://localhost:8080/jira/rest/api/2/issue/10010/comment/10000",
            "id": "10000",
            "author": {
                "self": "http://localhost:8080/jira/rest/api/2/user?username=fred",
                "name": "fred",
                "displayName": "Fred F. User",
                "active": false
            },
            "body": "Testing.",
            "updateAuthor": {
                "self": "http://localhost:8080/jira/rest/api/2/user?username=fred",
                "name": "fred",
                "displayName": "Fred F. User",
                "active": false
            },
            "created": "2013-08-23T16:57:35.982+0200",
            "updated": "2013-08-23T16:57:35.983+0200",
            "visibility": {
                "type": "role",
                "value": "Administrators"
            }
        }
    ]
}
```

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

### Start Mock Healthcare Services

Source: https://mi.docs.wso2.com/en/4.2.0/develop/integration-development-kickstart

Run this command to start the mock backend services for the healthcare use case. Ensure the `DoctorInfo-JDK11.jar` file is downloaded and accessible.

```bash
java -jar DoctorInfo-JDK11.jar

```

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

### MongoDB STANDARD Connection Configuration

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/mongodb-connector/mongodb-connector-config

Configuration parameters and XML examples for the STANDARD connection type, supporting both standalone and replica set setups.

```APIDOC
## MongoDB STANDARD Connection

### Description
Configures a MongoDB connection using the STANDARD connection type. This supports standalone instances via host/port or replica sets via a seed list.

### Parameters
- **Host** (String) - Optional - The hostname, IP address, or unix domain socket. Defaults to 127.0.0.1.
- **Port** (Number) - Optional - The port number. Defaults to 27017.
- **Seed List** (String) - Optional - Host:port pairs for replica set discovery.
- **Username** (String) - Optional - Authentication username.
- **Password** (String) - Optional - Authentication password.

### Request Example (Standalone)
<mongodb.init>
    <name>standaloneStandardConnection</name>
    <connectionType>STANDARD</connectionType>
    <host>localhost</host>
    <port>27017</port>
    <database>users</database>
    <username>administrator</username>
    <password>1234</password>
</mongodb.init>

### Request Example (Replica Set)
<mongodb.init>
    <name>replicaSetStandardConnection</name>
    <connectionType>STANDARD</connectionType>
    <seedList>mongodb1.example.com:27317,mongodb2.example.com:27017</seedList>
    <database>users</database>
    <username>administrator</username>
    <password>1234</password>
    <authSource>aDifferentAuthDB</authSource>
    <ssl>true</ssl>
    <w>majority</w>
    <replicaSet>mySet</replicaSet>
    <retryWrites>true</retryWrites>
</mongodb.init>
```

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

### Run the back-end service

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/rest-api-examples/transforming-content-type

Execute the provided JAR file to start the back-end service.

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

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

### Sample Jira Get User Permissions Response

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Example JSON response from getUserPermissions, indicating whether the user has specific permissions like 'EDIT_ISSUE'.

```json
{
    "permissions": {
        "EDIT_ISSUE": {
            "id": "12",
            "key": "EDIT_ISSUE",
            "name": "Edit Issues",
            "description": "Ability to edit issues.",
            "havePermission": true
        }
    }
}
```

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

### Install Basic Observability Deployment with Helm

Source: https://mi.docs.wso2.com/en/4.2.0/observe-and-manage/setting-up-cloud-native-observability-in-kubernetes

Use this command to install the basic observability stack, including Prometheus and Grafana, for metrics monitoring. Ensure you are in the cloned Helm repository's home directory.

```bash
helm install wso2-observability . --render-subchart-notes
```

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

### Sample Request for Get Comment By ID

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Example JSON request to retrieve a specific comment by its ID, including connection details and issue identifier.

```json
{
    "uri": "http://localhost:8080",
    "username": "admin",
    "password": "1qaz2wsx@",
    "commentId" : "10000",
    "issueIdOrKey":"TESTPM1-3"
}
```

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

### Start WebSocket Client

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/inbound-endpoint-examples/inbound-endpoint-secured-websocket

Run this command to start the WebSocket client. It connects to the server on port 8082 and can be configured with sub-protocols and client ports.

```bash
java -DsubProtocol="synapse(contentType='application/json')" -DclientPort=9092 -cp netty-example-4.0.30.Final.jar:lib/*:. io.netty.example.http.websocketx.client.WebSocketClient

```

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

### File Read Operation Example

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/file-connector/file-connector-config

Demonstrates the content read from a file. This is a sample response body.

```text
This is line one.
This is line two.
This is line three.
This is line four.
This is line five.
This is line six.
This is line seven.
This is line eight.
This lis line nine.
This is line ten.


```

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

### JSON response for employee data

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/data-integration/json-with-data-service

This is an example of a JSON response received after invoking a GET resource for employee data. It contains an array of employee objects.

```json
{"Employees":{"Employee":[{"EmployeeNumber":"1","FirstName":"John","LastName":"Doe","Email":"JohnDoe@gmail.com","Salary":"10000"},{"EmployeeNumber":"1","FirstName":"John","LastName":"Doe","Email":"JohnDoe@gmail.com","Salary":"20000"}]}
```

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

### Sample Jira Get User Response

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/jira-connector/jira-connector-config

Example JSON response from the getUser operation, containing user details like name, email, and active status.

```json
{
    "self": "http://localhost:8080/jira/rest/api/2/user?username=fred",
    "name": "fred",
    "emailAddress": "fred@example.com",
    "avatarUrls": {
        "24x24": "http://localhost:8080/jira/secure/useravatar?size=small&ownerId=fred",
        "16x16": "http://localhost:8080/jira/secure/useravatar?size=xsmall&ownerId=fred",
        "32x32": "http://localhost:8080/jira/secure/useravatar?size=medium&ownerId=fred",
        "48x48": "http://localhost:8080/jira/secure/useravatar?size=large&ownerId=fred"
    },
    "displayName": "Fred F. User",
    "active": true,
    "timeZone": "Australia/Sydney",
    "groups": {
        "size": 3,
        "items": []
    }
}
```

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

### Carbondump Example (Windows)

Source: https://mi.docs.wso2.com/en/4.2.0/reference/troubleshooting/admin-troubleshooting-in-production-environments

Example of running the Carbondump script on a Windows system, specifying the carbon home directory and process ID.

```batch
carbondump.bat -carbonHome c:\wso2carbon-4.0.0\ -pid 5151
```