WSO2 Micro Integrator

https://mi.docs.wso2.com/en/4.2.0
Admin
WSO2 Micro Integrator is a comprehensive integration platform that simplifies digital transformation...
Tokens:909,313
Snippets:8,795
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Start Command for Automation Mode

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

Example command demonstrating how to start the Micro Integrator with a specific composite application named TaskExecutingServiceCompositeExporter.

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

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

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

### Start Prometheus server

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

Command to initiate the Prometheus server from the installation directory.

```bash
./prometheus
```

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

### Login Examples

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

Practical examples of logging into a development environment.

```bash
apictl mi login dev -k
```

```bash
apictl mi login dev -u admin -p admin -k
```

```bash
apictl mi login dev --username admin --password admin -k
```

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

### Start backend services

Source: https://mi.docs.wso2.com/en/4.2.0/get-started/quick-start-guide

Manually start the mock hospital information services using the provided JAR file.

```bash
java -jar DoctorInfo.jar

```

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

### 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
```

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

### Configure Simple Trigger Task Examples

Source: https://mi.docs.wso2.com/en/4.2.0/reference/synapse-properties/scheduled-task-properties

Examples demonstrating different simple trigger configurations for task execution frequency and duration.

```xml
<task name="CheckPrice" class="org.wso2.esb.tutorial.tasks.PlaceStockOrderTask">
    <trigger once="true"/>
    </task>
```

```xml
<task name="CheckPrice" class="org.wso2.esb.tutorial.tasks.PlaceStockOrderTask">
    <trigger interval="5"/>
    </task>
```

```xml
<task name="CheckPrice" class="org.wso2.esb.tutorial.tasks.PlaceStockOrderTask">
    <trigger interval="5" count="10"/>
    </task>
```

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

### Start Micro Integrator on MacOS/Linux

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

Execute this command from the <MI_HOME>/bin directory to start the Micro Integrator server on Unix-based systems.

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

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

### Start HornetQ Server

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

Commands to start the HornetQ server on different operating systems.

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

```bash
sh HORNETQ_HOME/bin/run.sh
```

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

### Start the Micro Integrator server in background mode

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 as a background process.

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

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

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

### CarbonDump execution examples

Source: https://mi.docs.wso2.com/en/4.2.0/reference/troubleshooting/capturing-system-data-in-error-situations

Platform-specific examples for running the CarbonDump tool on Linux and Windows.

```bash
In Linux: sh carbondump.sh -carbonHome /home/user/wso2carbon-4.0.0/ -pid 5151
```

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

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

### Start Micro Integrator on Windows

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

Execute this command from the <MI_HOME>\bin directory to start the Micro Integrator server on Windows systems.

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

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

### Starting Micro Integrator in Daemon Mode

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/security/encrypting-plain-text

Execute this command to start the server as a background process after configuring the required password file.

```bash
./micro-integrator.sh start
```

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

### Start the back-end service

Source: https://mi.docs.wso2.com/en/4.2.0/learn/integration-tutorials/routing-requests-based-on-message-content

Execute this command in a terminal to start the back-end service JAR file.

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

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

### Start Micro Integrator with Unit Testing Server

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

Commands to start the Micro Integrator with the unit testing server enabled using the -DsynapseTest property.

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

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

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

### Start MI Dashboard

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

Commands to start the dashboard on different operating systems from the MI-DASHBOARD_HOME/bin folder.

```bash
./dashboard.sh
```

```batch
dashboard.bat
```

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

### File Read Response Example

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

Example output content retrieved from a file read operation.

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

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

### Start WebSocket Client

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

Execute this command to start the Netty WebSocket client, specifying the sub-protocol and client port.

```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
```

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

### Start Server with Correlation Logs Enabled

Source: https://mi.docs.wso2.com/en/4.2.0/observe-and-manage/classic-observability-logs/monitoring-correlation-logs

Commands to start the Micro Integrator with correlation logging enabled for the current session.

```bash
sh micro-integrator.sh -DenableCorrelationLogs=true
```

```batch
micro-integrator.bat -DenableCorrelationLogs=true
```

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

### Start Micro Integrator with SAP JCo library path

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

Use this command to start the Micro Integrator while specifying the location of the native SAP JCo library.

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

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

### Complete JMS Listener Configuration Example

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/performance-tuning/jms-transport-tuning

A full example of a JMS listener configuration including connection factory details and performance tuning parameters.

```toml
[[transport.jms.listener]]
name = "myQueueConnectionFactory"
parameter.initial_naming_factory = "org.apache.activemq.jndi.ActiveMQInitialContextFactory"
parameter.provider_url = "tcp://localhost:61616"
parameter.connection_factory_name = "QueueConnectionFactory"
parameter.connection_factory_type = "queue"
parameter.cache_level = "consumer"
parameter.concurrent_consumer = 50
parameter.max_concurrent_consumer = 50
```

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

### Sample Response for GET Employee Details

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

An example of the JSON response returned by the GET Employee Details operation, containing detailed employee data.

```json
{
  "Data": {
    "BioExempt": false,
    "BirthDate": "1969-06-23T00:00:00",
    "ChecksumTimestamp": "2019-10-01T08:21:19.28",
    "ClockSupervisor": false,
    "Culture": {
      "XRefCode": "en-US",
      "ShortName": "English (US)",
      "LongName": "English (US)"
    },
    "EligibleForRehire": "NOTANSWERED",
    "FederatedId": "aaron.glover",
    "Gender": "M",
    "HireDate": "2000-08-23T00:00:00",
    "HomePhone": "202 265 8987",
    "NewHireApprovalDate": "2000-01-01T00:00:00",
    "NewHireApproved": true,
    "NewHireApprovedBy": "System",
    "OriginalHireDate": "2000-08-23T00:00:00",
    "PhotoExempt": false,
    "RegisteredDisabled": "NO",
    "RequiresExitInterview": false,
    "SeniorityDate": "2000-08-23T00:00:00",
    "SocialSecurityNumber": "252013727",
    "StartDate": "2000-08-23T00:00:00",
    "TaxExempt": true,
    "FirstTimeAccessEmailSentCount": 0,
    "FirstTimeAccessVerificationAttempts": 0,
    "SendFirstTimeAccessEmail": false,
    "EmployeeBadge": {
      "BadgeNumber": "33333",
      "EffectiveStart": "2000-01-01T00:00:00"
    },
    "LoginId": "mworker",
    "HomeOrganization": {
      "XRefCode": "500Packaging",
      "ShortName": "Plant 1 - Packaging",
      "LongName": "Plant 1 - Packaging"
    },
    "EmployeeNumber": "42199",
    "BioSensitivityLevel": {
      "XRefCode": "DEFAULT",
      "ShortName": "Default",
      "LongName": "Default"
    },
    "XRefCode": "42199",
    "CommonName": "Aaron",
    "DisplayName": "Aaron Glover",
    "FirstName": "Aaron",
    "LastName": "Glover"
  }
}
```

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

### Get Tweets Lookup Request

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

Example XML configuration for the getTweetsLookup operation.

```xml
<twitter.getTweetsLookup>
    <ids>"1460323737035677698,1519781379172495360,1519781381693353984"</ids>
    <expansions>"attachments.poll_ids,author_id"</expansions>
    <poll_fields>"duration_minutes"</poll_fields>
</twitter.getTweetsLookup>
```

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

### Retrieve Bucket Location

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

Use these examples to get the location constraint of an S3 bucket.

```xml
<amazons3.getBucketLocation>
    <bucketName>{$ctx:bucketName}</bucketName>
</amazons3.getBucketLocation>
```

```xml
<getBucketLocation>
    <bucketName>signv4test</bucketName>
</getBucketLocation>
```

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

### Run QuickFIX/J Executor Sample

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

Execute the QuickFIX/J sample application using the provided JAR file.

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

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

### Sample GET Reports request

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/ceridiandayforce-connector/reporting/reports

A JSON payload example for initiating a report request.

```json
{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "xRefCode": "Payroll_Earning_Hours_Detail",
  "pageSize": "1"
}
```

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

### GET Document Details

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

Retrieves the contents and details of a specific document identified by its GUID.

```APIDOC
## GET Document Details

### Description
Retrieves the contents and metadata of a particular document using its unique document GUID.

### Parameters
#### Request Body
- **documentGuid** (string) - Mandatory - The unique identifier for the document. Full value is required.
- **username** (string) - Required - Authentication username.
- **password** (string) - Required - Authentication password.
- **clientNamespace** (string) - Required - The client namespace URL.
- **apiVersion** (string) - Required - The API version to use.

### Request Example
{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "documentGuid": "696afd0c-5890-4316-9b7e-7ac990189018"
}

### Response
#### Success Response (200)
- **Data** (object) - Contains document metadata including DocumentType, DocumentGroup, SourceReportUniqueId, PublishDateTime, Title, PageCount, CultureId, and Contents.
```

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

### Start Kafka Server

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

Command to initiate the Kafka server from the KAFKA_HOME directory.

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

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

### Start Server with System Property

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

Pass the system property value during server startup via the terminal.

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

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

### Retrieve Bucket Notification Configuration

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

Use these examples to get the notification configuration associated with a bucket.

```xml
<amazons3.getBucketNotificationConfiguration>
    <bucketName>{$ctx:bucketName}</bucketName>
</amazons3.getBucketNotificationConfiguration>
```

```xml
<getBucketNotificationConfiguration>
    <bucketName>signv4test</bucketName>
</getBucketNotificationConfiguration>
```

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

### cURL Request with Query Parameters

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/rest-api-examples/setting-query-params-outgoing-messages

Example of a GET request containing multiple query parameters.

```bash
curl -v -X GET "http://localhost:8290/stockquote/view/IBM?param1=value1&param2=value2"
```

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

### Connect to Instance

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

Command to establish a connection to the database instance.

```sql
connect
```

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

### Create MySQL Database

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

Initializes the Company database for the batch requesting example.

```sql
CREATE DATABASE Company;
```

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

### Get Issue Types Operation

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

Configuration, request, and response examples for retrieving available issue types.

```xml
<jira.getIssueTypes/>
```

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

```json
[
    {
        "self": "http://localhost:8080/jira/rest/api/2.0/issueType/3",
        "id": "3",
        "description": "A task that needs to be done.",
        "iconUrl": "http://localhost:8080/jira/images/icons/issuetypes/task.png",
        "name": "Task",
        "subtask": false
    }
]
```

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

### Sample GET Reports response

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/ceridiandayforce-connector/reporting/reports

A JSON response example containing report data and pagination information.

```json
{
    "Data": {
        "XRefCode": "Payroll_Earning_Hours_Detail",
        "Rows": [
            {
                "Employee_DisplayName": "Gary Shy",
                "PRPayRunResultPermanent_EmployeeNumber": "8965594",
                "OrgUnit_ShortName": "Plant 2 - Assembly 1",
                "PRPayRunEarningPermanent_PayDate": "2016-01-05T00:00:00.0000000",
                "Job_ShortName": "Process Technician",
                "PREarningCode_ShortName": "Regular",
                "PRPayRunEarningPermanent_Rate": "14.00000",
                "PRPayRunEarningPermanent_Units": "8.00000",
                "PRPayRunEarningPermanent_Amount": "****",
                "PRPayRunEarningPermanent_WeekStartDate": "2015-12-27T00:00:00.0000000",
                "PRPayRunEarningPermanent_WeekEndDate": "2016-01-02T00:00:00.0000000",
                "PRPayRunEarningPermanent_WeekNumber": "1"
            }
        ]
    },
    "Paging": {
        "Next": "https://usconfigr57.dayforcehcm.com:443/Api/ddn/V1/Reports/Payroll_Earning_Hours_Detail?cursor=XQNm%252Fy8QDwwOTVmwS55YIR9dxnzR39EsaiqKsIKTt6dOMJg%252Fbsgm%252B31dDpM5RlnJ"
    }
}
```

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

### Install basic observability deployment

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

Command to deploy the basic metrics monitoring stack using Helm.

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

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

### Get Votes For Issue Operation

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

Configuration, request, and response examples for retrieving vote information for a specific issue.

```xml
<jira.getVotesForIssue>
    <issueIdOrKey>{$ctx:issueIdOrKey}</issueIdOrKey>
</jira.getVotesForIssue>
```

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

```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 mock back-end services

Source: https://mi.docs.wso2.com/en/4.2.0/develop/mi-for-vscode/quick-start-guide-mi-for-vscode

Execute the JAR file to initialize the healthcare services required for testing.

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

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

### Get Bucket Lifecycle Configuration

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

Configuration and request examples for retrieving lifecycle configuration settings for an S3 bucket.

```xml
<amazons3.getBucketLifecycleConfiguration>
    <bucketName>{$ctx:bucketName}</bucketName>
</amazons3.getBucketLifecycleConfiguration>
```

```xml
<getBucketLifecycleConfiguration>
    <bucketName>signv4test</bucketName>
</getBucketLifecycleConfiguration>
```

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

### Excel Data Service XML Response

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

Example of the XML response returned by the ExcelDataService after a successful GET request.

```xml
<Products
    xmlns="http://ws.wso2.org/dataservice/samples/excel_sample_service/getProducts">
    <Product>
        <ID>S10_1678</ID>
        <Model>1969 Harley Davidson Ultimate Chopper</Model>
        <Classification>Motorcycles</Classification>
    </Product>
    <Product>
        <ID>S10_1949</ID>
        <Model>1952 Alpine Renault 1300</Model>
        <Classification>Classic Cars</Classification>
    </Product>
    <Product>
        <ID>S10_2016</ID>
        <Model>1996 Moto Guzzi 1100i</Model>
        <Classification>Motorcycles</Classification>
    </Product>
    <Product>
        <ID>S10_4698</ID>
        <Model>2003 Harley-Davidson Eagle Drag Bike</Model>
        <Classification>Motorcycles</Classification>
    </Product>
    <Product>
        <ID>S10_4757</ID>
        <Model>1972 Alfa Romeo GTA</Model>
        <Classification>Classic Cars</Classification>
    </Product>
    <Product>
        <ID>S10_4962</ID>
        <Model>1962 LanciaA Delta 16V</Model>
        <Classification>Classic Cars</Classification>
    </Product>
    <Product>
        <ID>S12_1099</ID>
        <Model>1968 Ford Mustang</Model>
        <Classification>Classic Cars</Classification>
    </Product>
    <Product>
        <ID>S12_1108</ID>
        <Model>2001 Ferrari Enzo</Model>
        <Classification>Classic Cars</Classification>
    </Product>
</Products>
```

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

### Sample Response Payload

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 GUIDs, names, and upload details.

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

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

### Get Issue Type By ID Operation

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

Configuration, request, and response examples for retrieving a specific issue type by its ID.

```xml
<jira.getIssueTypeById>
    <issueTypeId>{$ctx:issueTypeId}</issueTypeId>
</jira.getIssueTypeById>
```

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

```json
{
    "self": "http://localhost:8080/jira/rest/api/2.0/issueType/3",
    "id": "3",
    "description": "A task that needs to be done.",
    "iconUrl": "http://localhost:8080/jira/images/icons/issuetypes/task.png",
    "name": "Task",
    "subtask": false
}
```

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

### Example Ingress output

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

Sample 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
```

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

### Sample GET Response for Employee Work Contracts

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

Example JSON response containing employee work contract data.

```json
{
    "Data": [
        {
            "BaseComplementaryHours": 0.00000,
            "CreateShiftOnHolidays": false,
            "StartDate": "2019-09-01T00:00:00",
            "WorkContract": {
                "XRefCode": "FT Monthly 100%",
                "ShortName": "FT Monthly 100%"
            }
        }
    ]
}
```

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

### Start the Dashboard Server

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

Execute the appropriate script for your operating system from the bin directory.

```bash
sh dashboard.sh
```

```batch
dashboard.bat
```

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

### Sample Request for Document Details

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

A JSON payload example required to authenticate and specify the document GUID for the retrieval request.

```json
{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "documentGuid": "696afd0c-5890-4316-9b7e-7ac990189018"
}
```

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

### 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 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
```

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

### Start the Analytics Portal

Source: https://mi.docs.wso2.com/en/4.2.0/mi-analytics/using-the-analytics-dashboard

Commands to launch the Analytics Portal runtime from the bin directory.

```bash
sh portal.sh
```

```batch
portal.bat
```

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

### Data service response example

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

The expected XML response format returned by the data service upon a successful GET request.

```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>
```

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

### GET a List of Documents

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

Retrieves the list of documents attached to an employee. The response includes the document GUID required for subsequent document detail retrieval.

```APIDOC
## GET a List of Documents

### Description
This operation retrieves a list of documents attached to a specific employee. The response provides the document GUID for each item, which can be used to retrieve specific document contents.

### Parameters
- **employeeXRefCode** (string) - Mandatory - Uniquely identifies the employee. Partial search is not supported; the full value must be provided.

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

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

### Start the Analytics Server

Source: https://mi.docs.wso2.com/en/4.2.0/mi-analytics/using-the-analytics-dashboard

Commands to launch the Analytics server from the bin directory.

```bash
sh server.sh
```

```batch
server.bat
```

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

### Sample Response for US Federal Taxes

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

Example JSON response containing the effective start date, filing status, and allowance details for a US employee.

```json
{
    "Data": [
        {
            "EffectiveStart": "2019-01-01T00:00:00",
            "FilingStatus": {
                "CountryCode": "USA",
                "FederalFilingStatusCode": "S",
                "CalculationCode": "1",
                "PayrollOutput": "Single",
                "ShortName": "Single",
                "LongName": "Single"
            },
            "Allowances": 50,
            "AdditionalAmount": 100.00000,
            "IsTaxExempt": false,
            "IsLocked": false
        }
    ]
}
```

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

### GET Employee Punches

Source: https://mi.docs.wso2.com/en/4.2.0/reference/connectors/ceridiandayforce-connector/employee-time-management/employeepunches

Retrieves work shift data for employees based on a specified transaction time range. The transaction start and end dates must be within 7 days of each other.

```APIDOC
## GET Employee Punches

### Description
Extracts the worked shift data for several employees at a time based on modified punch records within a specified UTC timeframe.

### Parameters
#### Query Parameters
- **filterTransactionStartTimeUTC** (string) - Required - Inclusive transaction period start date in UTC (e.g., 2017-01-01T00:00:00).
- **filterTransactionEndTimeUTC** (string) - Required - Inclusive transaction period end date in UTC (e.g., 2017-01-01T00:00:00).
- **employeeXRefCode** (string) - Optional - Unique identifier of the employee.
- **locationXRefCode** (string) - Optional - Identifier for a location or organizational unit.
- **positionXRefCode** (string) - Optional - Identifier for one or more positions.
- **departmentXRefCode** (string) - Optional - Identifier for one or more departments.
- **jobXRefCode** (string) - Optional - Identifier for one or more jobs.
- **docketXRefCode** (string) - Optional - Identifier for one or more dockets.
- **projectXRefCode** (string) - Optional - Identifier for one or more projects.
- **payAdjustmentXRefCode** (string) - Optional - Identifier for one or more pay adjustments.
- **shiftStatus** (string) - Optional - Shift status groups (e.g., ACTIVE, COMPLETED, PROBLEM, ALL).
- **filterShiftTimeStart** (string) - Optional - Used with filterTransactionStartTimeUTC to search for shifts in a given timeframe.
- **filterShiftTimeEnd** (string) - Optional - Used with filterTransactionEndTimeUTC to search for shifts in a given timeframe.
- **businessDate** (string) - Optional - Business date for timesheet view.
- **pageSize** (integer) - Optional - Number of records returned per page.

### Request Example
{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "filterTransactionStartTimeUTC": "2019-03-25T00:00:00",
  "filterTransactionEndTimeUTC": "2019-03-29T00:00:00"
}

### Response
#### Success Response (200)
- **Data** (array) - List of employee punch records.

#### Response Example
{
    "Data": [
        {
            "PunchXRefCode": "#DF_1480318",
            "EmployeeXRefCode": "67206",
            "PunchStatus": "c",
            "TimeStart": "2019-03-25T09:00:00",
            "TimeEnd": "2019-03-25T17:00:00",
            "NetHours": 7.500,
            "LocationXRefCode": "Store 32014",
            "PositionXRefCode": "Cust. Svc. Dept. Mgr ",
            "DepartmentXRefCode": "14",
            "JobXRefCode": "4",
            "BusinessDate": "2019-03-25T00:00:00",
            "IsDeleted": false,
            "IsOnCall": false,
            "FuturePunch": false,
            "LastModifiedTimestampUtc": "2019-03-28T12:29:07.063"
        }
    ]
}
```

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

### Enable skipping SSL profile failures at startup

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

Use this JVM parameter to allow the Micro Integrator to start even if custom SSL profiles fail to load, logging a warning instead of aborting.

```text
-Dssl.profile.skip.failures=true
```

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

### GET Response Payload

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

JSON response received from the GET request.

```json
{
   "appointmentNumber": 1,
   "doctor": {
      "name": "thomas collins",
      "hospital": "grand oak community hospital",
      "category": "surgery",
      "availability": "9.00 a.m - 11.00 a.m",
      "fee": 7000
   },
   "patient": {
      "name": "John Doe",
      "dob": "1940-03-19",
      "ssn": "234-23-525",
      "address": "California",
      "phone": "8770586755",
      "email": "johndoe@gmail.com"
   },
   "fee": 7000,
   "confirmed": false,
   "appointmentDate": "2025-04-02"
}
```

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

### Configure Bucket Replication

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

Example request for setting up bucket replication rules.

```xml
<putBucketReplication>
    <bucketName>signv4test</bucketName>
    <ReplicationConfiguration>
        <Rule>
            <ID>id1</ID>
            <Prefix>documents/</Prefix>
            <Status>Enabled</Status>
            <Destination>
                <Bucket>arn:aws:s3:::signv4testq23aa1</Bucket>
            </Destination>
        </Rule>
    </ReplicationConfiguration>
</putBucketReplication>
```

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

### SwA Request Example

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/endpoint-examples/mtom-swa-with-endpoints

Example of an SwA optimized MIME message request.

```http
POST http://localhost:9000/services/MTOMSwASampleService HTTP/1.1
Host: 127.0.0.1
SOAPAction: urn:uploadFileUsingSwA
Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_B94996494E1DD5F9B51177414170491; type="text/xml";
start="<0.urn:uuid:B94996494E1DD5F9B51177414170492@apache.org>"; charset=UTF-8
Transfer-Encoding: chunked
Connection: Keep-Alive
User-Agent: Synapse-HttpComponents-NIO

--MIMEBoundaryurn_uuid_B94996494E1DD5F9B51177414170491225
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
   <0.urn:uuid:B94996494E1DD5F9B51177414170492@apache.org>22159
      <?xml version='1.0' encoding='UTF-8'?>
         <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
            <soapenv:Body>
               <m0:uploadFileUsingSwA xmlns:m0="http://www.apache-synapse.org/test">
                  <m0:request>
                     <m0:imageId>urn:uuid:15FD2DA2584A32BF7C1177414169826</m0:imageId>
                  </m0:request>
               </m0:uploadFileUsingSwA>
            </soapenv:Body>
         </soapenv:Envelope>22--34MIMEBoundaryurn_uuid_B94996494E1DD5F9B511774141704912
17
Content-Type: image/gif
Content-Transfer-Encoding: binary
Content-ID:
         <urn:uuid:15FD2DA2584A32BF7C1177414169826>22800GIF89a... << binary content >>
```

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

### MTOM Request Example

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/endpoint-examples/mtom-swa-with-endpoints

Example of an MTOM optimized MIME message request.

```http
POST http://localhost:9000/services/MTOMSwASampleService HTTP/1.1
Host: 127.0.0.1
SOAPAction: urn:uploadFileUsingMTOM
Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_B94996494E1DD5F9B51177413845353; type="application/xop+xml";
start="<0.urn:uuid:B94996494E1DD5F9B51177413845354@apache.org>"; start-info="text/xml"; charset=UTF-8
Transfer-Encoding: chunked
Connection: Keep-Alive
User-Agent: Synapse-HttpComponents-NIO

--MIMEBoundaryurn_uuid_B94996494E1DD5F9B51177413845353241
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"
Content-Transfer-Encoding: binary
Content-ID:
   <0.urn:uuid:B94996494E1DD5F9B51177413845354@apache.org>221b1
      <?xml version='1.0' encoding='UTF-8'?>
         <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
            <soapenv:Body>
               <m0:uploadFileUsingMTOM xmlns:m0="http://www.apache-synapse.org/test">
                  <m0:request>
                     <m0:image>
                        <xop:Include href="cid:1.urn:uuid:78F94BC50B68D76FB41177413845003@apache.org" xmlns:xop="http://www.w3.org/2004/08/xop/include" />
                     </m0:image>
                  </m0:request>
               </m0:uploadFileUsingMTOM>
            </soapenv:Body>
         </soapenv:Envelope>
--MIMEBoundaryurn_uuid_B94996494E1DD5F9B51177413845353217
Content-Type: image/gif
Content-Transfer-Encoding: binary
Content-ID:
         <1.urn:uuid:78F94BC50B68D76FB41177413845003@apache.org>22800GIF89a... << binary content >>
```

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

### Sample SAP Destination Configuration

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

Example of a .dest properties file used to define SAP connection parameters.

```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
```

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

### Start ZooKeeper Server

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

Command to initiate the ZooKeeper server from the KAFKA_HOME directory.

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

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

### Install Erlang

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/brokers/deploy-rabbitmq

Commands to add the Erlang repository and install the Erlang distribution on Ubuntu.

```bash
wget -O- https://packages.erlang-solutions.com/ubuntu/erlang_solutions.asc | sudo apt-key add -
echo "deb https://packages.erlang-solutions.com/ubuntu bionic contrib" | sudo tee /etc/apt/sources.list.d/rabbitmq.list && \
sudo apt update && \
sudo apt -y install erlang
```

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

### Start the workspace script

Source: https://mi.docs.wso2.com/en/4.2.0/get-started/quick-start-guide

Execute the startup script based on the operating system.

```bash
sh run.sh 

```

```batch
run.bat 

```

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

### Start WebSocket Server

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

Command to start the Netty-based WebSocket server on port 8082.

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

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

### Sample VFS Proxy Configuration for Large Files

Source: https://mi.docs.wso2.com/en/4.2.0/install-and-setup/setup/performance-tuning/tuning-the-vfs-transport

A complete proxy service example demonstrating VFS streaming and file movement configurations.

```xml
    <proxy xmlns="http://ws.apache.org/ns/synapse" name="StockQuoteProxy" transports="vfs">
        <parameter name="transport.vfs.FileURI">smb://host/test/in</parameter>        
        <parameter name="transport.vfs.ContentType">text/xml</parameter>
        <parameter name="transport.vfs.FileNamePattern">.*\.xml</parameter>
        <parameter name="transport.PollInterval">15</parameter>
        <parameter name="transport.vfs.Streaming">true</parameter>
        <parameter name="transport.vfs.MoveAfterProcess">smb://host/test/original</parameter>            
        <parameter name="transport.vfs.MoveAfterFailure">smb://host/test/original</parameter>          
        <parameter name="transport.vfs.ActionAfterProcess">MOVE</parameter>
        <parameter name="transport.vfs.ActionAfterFailure">MOVE</parameter>
        <target>
             <inSequence>
                <property name="transport.vfs.ReplyFileName"
                          expression="fn:concat(fn:substring-after(get-property('MessageID'), 'urn:uuid:'), '.xml')" scope="transport"/>
                <property action="set" name="OUT_ONLY" value="true"/>
                <property name="ClientApiNonBlocking" value="true" scope="axis2" action="remove"/>
                <send>
                    <endpoint>
                        <address uri="vfs:smb://host/test/out"/> 
                    </endpoint>
                </send>
            </inSequence>
        </target>
        <publishWSDL uri="file:repository/samples/resources/proxy/sample_proxy_1.wsdl"/>
    </proxy>
```

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

### Subscribe to an MQTT topic

Source: https://mi.docs.wso2.com/en/4.2.0/learn/examples/transport-examples/pub-sub-using-mqtt

Use this command to start an MQTT subscriber on the specified topic.

```bash
mosquitto_sub -h localhost -t esb.test2
```
Tokens:
Raw