Skip to content

Commit

Permalink
Merge pull request #1063 from wso2/4.3.0
Browse files Browse the repository at this point in the history
Sync main
  • Loading branch information
DinithiDiaz authored Oct 28, 2024
2 parents b4c6945 + 02b1934 commit 1058a7c
Show file tree
Hide file tree
Showing 18 changed files with 613 additions and 464 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion en/docs/get-started/key-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ See the [Transports]({{base_path}}/install-and-setup/setup/transport-configurati

#### Registry

WSO2 Micro Integrator uses a Registry to store various configurations and resources, such as [endpoints](#endpoints). A registry is simply a content store and a metadata repository. Various resources such as XSLT scripts, WSDLs, and configuration files can be stored in a registry and referred to by a key, which is a path similar to a UNIX file path. The WSO2 Micro Integrator uses a [file-based registry]({{base_path}}/install-and-setup/setup/deployment/file-based-registry) that is configured by default. You can also define and use a [local registry]({{base_path}}/develop/creating-artifacts/registry/creating-local-registry-entries) when you develop your integration artifacts,
WSO2 Micro Integrator uses a Registry to store various configurations and resources, such as [endpoints](#endpoints). A registry is simply a content store and a metadata repository. Various resources such as XSLT scripts, WSDLs, and configuration files can be stored in a registry and referred to by a key, which is a path similar to a UNIX file path. The WSO2 Micro Integrator uses a [file-based registry]({{base_path}}/install-and-setup/setup/deployment/file-based-registry) that is configured by default. You can also define and use a [local registry]({{base_path}}/develop/creating-artifacts/registry/creating-local-registry-entries) when you develop your integration artifacts.

#### Message Builders and Formatters

Expand Down
3 changes: 1 addition & 2 deletions en/docs/get-started/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,5 +180,4 @@ Additionally, you can use the [Integration Control Plane (ICP)]({{base_path}}/ob

## What's next?

- [Develop your first integration solution]({{base_path}}/get-started/development-kickstart/).
- [More Tutorials]({{base_path}}/learn/learn-overview/).
Try more [tutorials and examples]({{base_path}}/learn/learn-overview/).
2 changes: 1 addition & 1 deletion en/docs/install-and-setup/install/installation-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Micro Integrator provide the following installation options for deployments.

## 1. Kubernetes (Helm)

You can follow the guides available in the [Helm resources repository](https://github.com/wso2/kubernetes-mi/tree/4.2.x) in order to deploy Micro Integrator in Kubernetes using Helm artifacts.
You can follow the guides available in the [Helm resources repository](https://github.com/wso2/helm-mi.git) in order to deploy Micro Integrator in Kubernetes using Helm artifacts.

## 2. Docker/Docker Compose

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ The API operator for Kubernetes provides first-class support for Micro Integrato

### Using Helm resources

WSO2 releases Helm resources for all product deployments. You can get the [Helm resources for the Micro Integrator](https://github.com/wso2/kubernetes-mi/) and set up a Micro Integrator deployment on Kubernetes.
WSO2 releases Helm resources for all product deployments. You can get the [Helm resources for the Micro Integrator](https://github.com/wso2/helm-mi.git) and set up a Micro Integrator deployment on Kubernetes.

- For instructions, see [deploying integrations on Kubernetes using Helm resources]({{base_path}}/install-and-setup/setup/deployment/deploying-micro-integrator-with-helm).
53 changes: 53 additions & 0 deletions en/docs/learn/examples/data-integration/batch-requesting.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,56 @@ You will find that all the records have been inserted into the `Employees` datab
```bash
SELECT * FROM Employees
```
!!! Note
Additionally, you can add a resource to call the query to invoke batch request as a REST service invocation. For that you have to append `_batch_req` suffix to the [resource request path]({{base_path}}/reference/synapse-properties/data-services/elements-of-a-data-service/#defining-resources) when invoking. See the [how to post json data in batches]({{base_path}}/learn/examples/data-integration/json-with-data-service/#post-data-in-batches) documentation for more information.
Sample resource configuration:
```
<resource method="POST" path="employee">
<call-query href="addEmployeeQuery">
<with-param name="EmployeeNumber" query-param="EmployeeNumber"/>
<with-param name="FirstName" query-param="FirstName"/>
<with-param name="LastName" query-param="LastName"/>
<with-param name="Email" query-param="Email"/>
<with-param name="JobTitle" query-param="JobTitle"/>
<with-param name="Officecode" query-param="Officecode"/>
</call-query>
</resource>
```
Request:
1. First, create a file named `employee-batch-payload.json`, and define the JSON payload for posting multiple employee records (batch) as shown below.
```
{
"user_defined_value": {
"user_defined_value": [
{
"EmployeeNumber": "5012",
"FirstName": "Will",
"LastName": "Smith",
"Email": "[email protected]",
"JobTitle": "Consultant",
"Officecode": "01"
},
{
"EmployeeNumber": "5013",
"FirstName": "Parker",
"LastName": "Peter",
"Email": "[email protected]",
"JobTitle": "Consultant",
"Officecode": "01"
}
]
}
}
```
2. On the terminal, navigate to the location where the `employee-batch-payload.json` file is stored, and execute the following HTTP request:
```
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' --data "@employee-batch-payload.json" -k -v http://localhost:8290/services/batch_requesting_sample/employee_batch_req
```
51 changes: 51 additions & 0 deletions en/docs/learn/examples/data-integration/request-box.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,3 +168,54 @@ You will see the following response received by SoapUI:
</soapenv:Body>
</soapenv:Envelope>
```
!!! Note
Additionally, you can add resources to call the queries to invoke request_box as a REST service invocation. For that you have to append `request_box` to the URL when invoking. See the [how to post data using request box]({{base_path}}/learn/examples/data-integration/json-with-data-service/#post-data-using-request-box) documentation for more information.
Sample resource configuration:
```
<resource method="POST" path="employee">
<call-query href="addEmployeeQuery">
<with-param name="EmployeeNumber" query-param="EmployeeNumber"/>
<with-param name="FirstName" query-param="FirstName"/>
<with-param name="LastName" query-param="LastName"/>
<with-param name="Email" query-param="Email"/>
<with-param name="JobTitle" query-param="JobTitle"/>
<with-param name="Officecode" query-param="Officecode"/>
</call-query>
</resource>
<resource method="GET" path="employee/{EmployeeNumber}">
<call-query href="selectEmployeebyIDQuery">
<with-param name="EmployeeNumber" query-param="EmployeeNumber"/>
</call-query>
</resource>
```
Request:
1. First, create a file named `employee-request-box-payload.json`, and define the JSON payload for posting the request box as shown below.
```
{
"request_box" : {
"_postemployee" : {
"EmployeeNumber" : "14005",
"LastName" : "Smith" ,
"FirstName" : "Will" ,
"Email" : "[email protected]" ,
"JobTitle": "Consultant",
"Officecode": "01"
},
"_getemployee_employeenumber":{
"EmployeeNumber" : "14005"
}
}
}
```
2. On the terminal, navigate to the location where the `employee-request-box-payload.json` file is stored, and execute the following HTTP request:
```
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' --data "@employee-request-box-payload.json" http://localhost:8290/services/request_box_example/request_box
```
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ To use the Amazon SQS connector, first create the connection with your configura
</tr>
</table>

!!! note
If you want to define any timeout configuration in milliseconds, use the decimal format in seconds. For example, 350 milliseconds can be expressed as 0.35 seconds.

!!! note
You can either pass credentials within init configuration or set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` as environment variables. The AWS SDK uses provider chains to look for AWS credentials in system/user environment variables.
To set these environment variables follow the below steps based on your operating system:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ To use the Facebook Ads connector, first create the connection with your configu
</tr>
<tr>
<td><code>customAudienceId</code></td>
<td>ID of the ad set.</td>
<td>ID of the custom audience.</td>
<td>Yes</td>
</tr>
<tr>
Expand All @@ -856,7 +856,7 @@ To use the Facebook Ads connector, first create the connection with your configu

```xml
<facebookAds.updateCustomAudience configKey="FB_CONN_1">
<adId>{json-eval($.audience_id)}</adId>
<customAudienceId>{json-eval($.audience_id)}</customAudienceId>
<properties>{json-eval($.properties)}</properties>
</facebookAds.updateCustomAudience>
```
Expand All @@ -874,6 +874,98 @@ To use the Facebook Ads connector, first create the connection with your configu
}
```

??? note "addUsersToAudience"
The `addUsersToAudience` operation adds users to a custom audience.
<table>
<tr>
<th>Parameter Name</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td><code>customAudienceId</code></td>
<td>ID of the custom audience.</td>
<td>Yes</td>
</tr>
<tr>
<td><code>properties</code></td>
<td>Properties of the users to be added to the audience.</td>
<td>Yes</td>
</tr>
</table>

**Sample configuration**

```xml
<facebookAds.addUsersToAudience configKey="FB_CONN_1">
<customAudienceId>{json-eval($.audience_id)}</customAudienceId>
<properties>{json-eval($.properties)}</properties>
</facebookAds.addUsersToAudience>
```

**Sample request**

```json
{
"audience_id": "456456456",
"properties": {
"payload": {
"schema": "EMAIL_SHA256",
"data": [
"b36a83701f1c3191e19722d6f90274bc1b5501fe69ebf33313e440fe4b0fe210",
"2b3b2b9ce842ab8b6a6c614cb1f9604bb8a0d502d1af49c526b72b10894e95b5"
]
}
}
}
```

??? note "removeUsersFromAudience"
The `removeUsersFromAudience` operation removes users from a custom audience.
<table>
<tr>
<th>Parameter Name</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td><code>customAudienceId</code></td>
<td>ID of the custom audience.</td>
<td>Yes</td>
</tr>
<tr>
<td><code>properties</code></td>
<td>Properties of the users to be removed from the audience.</td>
<td>Yes</td>
</tr>
</table>

**Sample configuration**

```xml
<facebookAds.removeUsersFromAudience configKey="FB_CONN_1">
<customAudienceId>{json-eval($.audience_id)}</customAudienceId>
<properties>{json-eval($.properties)}</properties>
</facebookAds.removeUsersFromAudience>
```

**Sample request**

```json
{
"audience_id": "456456456",
"properties": {
"payload": {
"schema": "EMAIL_SHA256",
"data": [
"b36a83701f1c3191e19722d6f90274bc1b5501fe69ebf33313e440fe4b0fe210",
"2b3b2b9ce842ab8b6a6c614cb1f9604bb8a0d502d1af49c526b72b10894e95b5"
]
}
}
}
```

## Error codes related to Facebook Ads Connector

The connector may encounter errors during operation execution. When an error occurs, the `ERROR_MESSAGE` property will contain detailed information about the error. You can handle these errors using a `Fault Sequence` in your integration. For more information, see [Using Fault Sequences]({{base_path}}/learn/examples/sequence-examples/using-fault-sequences/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To see the Facebook Ads Connector, navigate to the [connector store](https://sto

| Connector Version | Supported product versions |
| ------------- |-------------|
| 1.0.1 | MI 4.3.0 |
| 1.0.2 | MI 4.3.0 |

## Facebook Ads Connector documentation

Expand Down
Loading

0 comments on commit 1058a7c

Please sign in to comment.