Page Comparison

The purpose of this guide is to get you started on creating and invoking a data service using WSO2 Data Services Server (WSO2 DSS) as quickly as possible. See the following topics for details:

...

Introduction and key concepts

WSO2 Data Services Server provides a convenient web service interface for data stored in various datasources. That is, data that is stored in various data sources datasources can be decoupled from the infrastructure where it is stored and exposed to external clients as a data service. Datasources such as relational databases, CSV files, Microsoft Excel files and google spread sheets can be easily service enabled using WSO2 DSS.

...

1. Download and install MySQL using Homebrew. 

2. Open a terminal and execute the following command to start your MySQL database:

   Code Block
   mysql.server start

3. Access the MySQL prompt by giving the user name and password. By default the user name is 'root' and the password is blank.

   Code Block
   mysql -u root -p

4. Create the sample database named employeedb using the following command: 

   Code Block
   create database employeedb;

5. Open the employeedb database you just created using the following command:

   Code Block
   use employeedb;

6.  Create one table in the database using the following command:

   Code Block
   create table employee(id VARCHAR(10) NOT NULL PRIMARY KEY, name VARCHAR(100), address VARCHAR(100));

   This command will create the following table in the database:
   

7. Insert employee data into the employee table as follows:

   1. The first employee:

      Code Block
      insert into employee values('01','john','Boston');

   2. The second employee:

      Code Block
      insert into employee values('02','Micheal','Dallas');

   3. The third employee:

      Code Block
      insert into employee values('03','richard','Chicago');

8. You can see the data that you have added to the employee table of the employeedb database by executing the following command:

   Code Block
   SELECT * FROM employee

   The result will be as follow:
   

...

1. Download WSO2 DSS from here.
2. Extract the zip ZIP file to a location in your computer. This location will be referred to as <DSS_HOME> from hereon.
3. Download the JDBC driver for MySQL from here and copy it to your <DSS_HOME>/repository/components/lib directory.

...

1. Open a terminal and navigate to the <DSS_HOME>/bin directory and execute the DSS startup script using one of the following commands:

   • On Windows: wso2server.bat
   • On Linux: sh wso2server.sh

2. When the product is started, the URL of the Management Console will be shown in the terminal as follows:

    

   INFO {org.wso2.carbon.ui.internal.CarbonUIServiceComponent} -  Mgt Console URL  : https://10.100.5.65:9443/carbon/

3. Copy this URL to your browser to open the Management Console.

4. Log in to the management console using the default administrator credentials: admin/admin.

Step 1: Creating the data service

1. In the left navigator, go to the Main tab and click Services -> Add -> Data Service -> Create. This will open the Create Data Service wizard.

2. In the Data Service Name field, enter 'MyFirstDS' as the name. Leave the default settings of all other options.
   

3. Click Next. This will take you to the page for adding datasources.

Step 2: Adding new datasources

1. Click Add New Datasource. You can now specify the datasource details. 
   1. In the Datasource ID field, enter 'MyDS'.
   2. In the Datasource Type field, select RDBMS from the list of values. 
2. You will now be prompted to enter details of your RDBMS:
   
3. Enter the following details of your MySQL database in the relevant fields as shown above:
   
   • Database Engine: MySql
   • Driver Class: com.mysql.jdbc.Driver
   • URL: jdbc:mysql://localhost:3306/employeedb
   • User Name: root
   • Password: (Leave this blank)
4. Click Save to save the datasource.
5. Click Next. This will take you to a new page for adding queries to your service. 

Step 3: Creating a query for your datasource

1. Now we will create a query to obtain all the employee details saved in the database.
   1. Enter a name for the query in the Query ID field. We will use 'QueryAll'.
   2. All datasources created for the data service will be listed for the Datasource field. Select MyDS from this list.
   3. Specify the SQL statement in the SQL field. We will use a SELECT statement to query for all the employee details in the database as shown below.
      Image RemovedImage Added

   4. Anchor
      output mapping output mapping

      We must now specify output mappings to determine how the information in the database should be displayed in the query output. We will be needing three columns (ID, Name and Address) to display the employee details. Therefore, we need to create three output mapping entries as explained below.
      1. Click Add New Output Mapping and the following screen will open. You can now enter the first output mapping for employee ID as shown below.
         Image Removed
      2. Click Add to create the output mapping.
      3. Repeat the steps using the following information to create the remaining two output mappings:
         
         • Mapping Type: Element

           Output field name: Name
           Data source column Name: name
           Schema Type: xs:string

         • Mapping Type: Attribute

           Output field name: address
           Data source column Name: address
           Schema Type: xs:string

      4. When you have created all the columns as output mappings, they will be listed as follows:
         Image Removed
2. Click Main Configuration to return to the main page.
3. Click 
   1. for these fields. Click Generate Response to automatically create output mappings as shown below.
      Image Added
4. Click Next. This will take you to a new page for connecting operations to each of your queries.

Step 4: Creating an operation to invoke a query

1. Enter a name for the operation in the Operation Name field. We will use 'getEmployees'. 
2. All the queries defined for the data service will be listed for the Query ID field. Select 'QueryAll'.
   
3. Save the operation.
4. Click Finish to complete the data service creation. The 'MyFirstDS' data service is now listed as a deployed data service.
   

...

1. Go to Services -> List to open the Deployed Services page.
2. Click the data service (MyFirstDS) to open the service dashboard:
   
   See that the URL of the 'MyFirstDS' data service is listed under Endpoints: https://10.100.5.65:9443/services/MyFirstDS/
3. You can execute the getEmployees operation using the above URL. Simply copy this URL followed by the operation name as shown below.
   https://10.100.5.65:9443/services/MyFirstDS/getEmployees
4. The result will be the same as with the TryIt tool:
   

This concludes the quick start guide for WSO2 DSS 3.5.01. You can find more advanced use cases in the User GuideTutorials.