Getting Started with Data Services Builder

Version 31

    The Data Services Builder is our simplified approach to defining and testing and managing DV/Teiid data services via a web application running on your server.

     

    This kit utilizes the Data Services Builder web interface, backed by the Teiid Runtime. This quickstart shows how to:

    • Configure a Data Source for an existing deployed JDBC source
    • Create and Test a new Data Service

    ... all with just a few clicks.....

     

    Note: an alternative installation method using Docker containers is described in this article. Install and execute the 'dsbuilder-mysql-with-test-data' container then skip both steps 1 and 2, below.

     

    1) Download the zip

     

        NOTE: The Data Services Builder currently requires Java 1.8

     

    2) Start the Server

    • execute the following in the <installDir>/teiid-8.12.4/bin
      • $ ./standalone.sh -c standalone-teiid.xml

     

    3) Access the Data Service Builder at:  https://localhost:8443/ds-builder

    • enter User Name = dsbUser and Password1demo-user1 to login

    LoginPage.png

    4) Data Services Summary page

    Upon entering the Data Service Builder for the first time, you will see a page like this:

    DataserviceSummaryPage-Empty.png

    5) Set JDBC Credentials

    • Before going further, click the Preferences icon (gear) to set your Teiid JDBC credentials.

    PreferencesIcon.png

     

    • On the preferences page, select Teiid Settings, then enter JDBC User Name = dsbUser and Password1demo-user1

    PreferencesTeiid.png

      • Click 'Test JDBC Connection' to verify the credentials
      • Click 'Return' to return to the Data Services summary page

     

    6) Create a Data Source

    • Back on the Data Service Summary page, click the  "New Data Source" button to open the New Data Source page.
    • Enter a Name for your Data Source and an optional description.
    • Click on a Connection in the Connections list.
    • NOTE:  One H2 database connection (AccountsH2) is provided with the installation.  If you would like to add a new JDBC source, see Step 7 (Optional).
    • A Translator corresponding to the selected connection will be shown.  You can change the translator if you wish.
    • By default, Filter Connection will be unchecked.  This will allow the Data Source to include all exposed schema in the database or catalog.
    • For this example, check Filter Connection, which will allow you to filter and expose just a part of the schema.

    NewDatasource-1.png

    • When Filter Connection is checked, you will be presented with a second wizard step.  Click Next.
    • Select a schema to see the list of available tables in the right panel.  You can further filter the exposed tables by entering a filter in the Filter box.
    • When complete, click Finish to create the Data Source.

    NewDatasource-2.png

    7) Manage Connections (Optional)

    • You can add more JDBC connections, if desired.
    • Click on Connections on the left navigation menu:

    ConnectionsSummary.png

    • To add a Connection, click on the New button.
      • The available Driver Types are shown.  To add a new JDBC Type 4 driver, click New Driver.
      • Enter a Name for your Connection.
      • Enter a unique JNDI Identifier for your Connection.
      • Follow the wizard pages to enter specific properties for your connection.  Click Finish to add the Connection.

    ConnectionsNew.png

    8) Create a Data Service

    • Now you can create a Data Service to consume the Data Source you just created.
    • Click on Data Services on the left navigation menu.  To create your first Data Service, click on the New Data Service button.
      • Enter a Name for your Data Service (i.e. AccountService).  You can optionally add a description.
      • Expand the Data Sources, then select a table - for example Accounts.ACCOUNT.  Click Finish.

    NewDataservice-1.png

    • When the Data Service is created, you will be returned to the Data Services Summary page:

    DataserviceSummaryPage.png

    9) Test the data service

    • Finally, you are ready to test your new Data Service.
    • Click the 'Test' button on the AccountService row.
      • the AccountService Data Service will be deployed and you will be transferred to the Test page.
    • - On the test page, click Submit to execute your query.  By default the OData tab is selected.
      • You can customize and filter your query using row limit, columns, 'where' criteria and order-by options.
      • Note that these criteria changes will alter the OData link.  You can also copy this link for use elsewhere if you wish.
    • You can also click the SQL tab to execute SQL queries against the data service.

    DataserviceTestPage.png

    That's it!!!!  you've created and tested a complete data service