Skip to content

Data Integration

What you'll build

A data service provides a Web service interface to access data that is stored in relational databases, CSV files, Microsoft Excel sheets, Google spreadsheets, and more. The following sections describe how you can use WSO2 Integration Studio to work with data services' artifacts.

Let's get started!

Step 1: Set up the workspace

To set up the tools:

  • Download the relevant WSO2 Integration Studio based on your operating system. The path to the extracted/installed folder is referred to as MI_TOOLING_HOME throughout this tutorial.
  • Download the CLI Tool for monitoring artifact deployments.

To demonstrate how data services work, we will use a MySQL database as the datasource. Follow the steps given below to set up a MySQL database:

  1. Install the MySQL server.
  2. Download the JDBC driver for MySQL from here and copy it to the MI_TOOLING_HOME/Contents/Eclipse/runtime/microesb/lib/ (for MacOS) or MI_TOOLING_HOME/runtime/microesb/lib/ (for Windows) directory.


    If the driver class does not exist in the relevant folders when you create the datasource, you will get an exception such as Cannot load JDBC driver class com.mysql.jdbc.Driver.

  3. Create a database named Employees.

    CREATE DATABASE Employees;
  4. Create the Employee table inside the Employees database:

    USE Employees;
    CREATE TABLE Employees (EmployeeNumber int(11) NOT NULL, FirstName varchar(255) NOT NULL, LastName varchar(255) DEFAULT NULL, Email varchar(255) DEFAULT NULL, Salary varchar(255));

Step 2: Creating a data service

Follow the steps given below to create a new data service.

Creating a data service project

All the data services' artifacts that you create should be stored in a Data Service project. Follow the steps given below to create a project:

  1. Open WSO2 Integration Studio, and click DS Project → Create New in the Getting Started tab as shown below.

  2. In the New Data Service Project dialog that opens, give a name for the project and click Next.

  3. If required, change the Maven information about the project.
  4. Click Finish. The new project will be listed in the project explorer.

Creating the datasource connection

Follow the steps given below to create the data service file:

  1. Select the already created Data Service Project in the project navigator, right click and go to New -> Data Service.
    The New Data Service window will open as shown below.
  2. To start creating a data service from scratch, select Create New Data Service and click Next.

  3. Enter a name for the data service:

    Property Description
    Data Service Name RDBMSDataService

  4. Click Next and start adding the datasource connection details given below.

    Property Description
    Datasource ID Datasource
    Datasource Type RDBMS
    Datasource Type (Default/External) Leave Default selected.
    Database Engine MySQL
    Driver Class com.mysql.jdbc.Driver
    URL jdbc:mysql://localhost:3306/Employees
    User Name root
  5. Save the data service.

A data service file (DBS file) will now be created in your data service project. Shown below is the project directory.

Creating a query

Let's write an SQL query to GET data from the MySQL datasource that you configured in the previous step:

  1. Select the data service you created in the previous step.
  2. Right-click and click Add Query .
  3. Enter the following query details:

    Parameter Description
    Query ID GetEmployeeDetails
    Datasource Datasource
  4. Save the query. The query element is now added to the data service:

  5. Right-click the GetEmployeeDetails query and click Add SQL to add the following SQL statement:

    select EmployeeNumber, FirstName, LastName, Email from Employees where EmployeeNumber=:EmployeeNumber
  6. Save the SQL statement.

  7. Right-click the query again and click Add Input Mapping .

  8. Enter the following input mapping details:

    Property Description
    Mapping Name EmployeeNumber
    Parameter Type SCALAR
  9. Save the input mapping.

  10. Right-click the query again and click Add Output Mapping.
  11. Enter the following value to group the output mapping:

    Property Description
    Grouped by Element Employees

  12. Save the output mapping.

  13. Right-click the output mapping and go to Add Output Mapping → Add Element to create an element.

  14. Enter the following element details.

    Property Description
    Datasource Type column
    Output Field Name EmployeeNumber
    Datasource Column Name EmployeeNumber
    Schema Type String

  15. Save the element.

  16. Follow the same steps to create the following output elements:

    Datasource Type Output Field Name Datasource Column Name Schema Type
    column FirstName FirstName string
    column LastName LastName string
    column Email Email string
  17. Save the output elements.

The data service should now have the query element added as shown below.

Creating a resource to invoke the query

Now, let's create a REST resource that can be used to invoke the query.

  1. Right-click the data service and click Add Resource. Add the following resource details.

    Property Description
    Resource Method GET
    Resource Path Employee/{EmployeeNumber}

  2. Expand the GET resource, and click the GetEmployeeDetails (call-query). Connect the query to the resource by adding the following:

    Property Description
    Query ID GetEmployeeDetails

  3. Save the resource.

The data service should now have the resource added as shown below.

Step 3: Package the artifacts

Create a new composite application project:

  1. Open the Getting Started view and click Miscellaneous → Create New Composite Application.
    Create new CAPP
  2. In the New Composite Application Project dialog that opens, select the data service file, and click Finish.
    Create new CAPP

Package the artifacts in your composite application project to be able to deploy the artifacts in the server.

  1. Open the pom.xml file in the composite application project POM editor.
  2. Ensure that your data service file is selected in the POM file.
  3. Save the project.

Step 4: Build and run the artifacts

To test the artifacts, deploy the packaged artifacts in the embedded Micro Integrator:

  1. Right-click the composite application project and click Export Project Artifacts and Run.
  2. In the dialog that opens, select the composite application project that you want to deploy.
  3. Click Finish. The artifacts will be deployed in the embedded Micro Integrator and the server will start. See the startup log in the Console tab.

Step 5: Testing the data service

Let's use the CLI Tool to find the URL of the data service that is deployed in the Micro Integrator:

  1. Open a terminal and navigate to the CLI_HOME/bin directory.
  2. Execute the following command to start the tool: ./mi
  3. Execute the following command to find the data services deployed in the server: ./mi proxyservice show

    Note: Please remember to login to CLI using ./mi remote login command giving admin as both username and password before executing the above command.

Now, open a command line terminal and enter the following request:

curl -X GET http://localhost:8290/services/RDBMSDataService.HTTPEndpoint/Employee/3

You will receive the employee's details in the response.