Getting Started with Data Services Builder

Version 26

    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 a Web UI backed by our Komodo Engine and 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 UI at:  https://localhost:8443/ds-builder

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

    dsb-login-page.png

    5) Data Services Home page

    data-source-summary-page-empty.png

     

    6) Set Teiid JDBC Credentials

    • Select the Preferences link to set your Teiid JDBC credentials.

    user-preference-link.png

    • Select Teiid Settings, enter User Name = dsbUser and Password1demo-user1

    teiid-settings.png

      • Click 'Test JDBC Connection' to verify the credentials
      • Click 'Return' to return

     

    7) Configure a Data Source

    • If you are a first time user of DSB, the Data Service Summary page will be empty. In order to create a Data Service, you'll need to configure at least one data source in order to build a data service view.
    • Click the  "Configure Data Source" link to open the Configure.
      configure-data-source_page_1.png

      • Enter a unique name for your Data Source and click Save
      • The default definition of your Data Source will include all exposed schema in your database or catalog (i.e. no filters)
    • You can optionally select the Filter Connection checkbox which will limit the table types to TABLE and allow you to select one schema from your database. Selecting a schema will show the list of available tables in the right panel. When you've chosen the schema you want for this Data Source, click Save.

    filter-data-source.png

    7) Create a single-source Data Service

    • When no data services exist, the New Data Service page will be shown after creating your new Data Source.
      • Enter a unique name for your service (i.e. PatientDataService), select a table in your PatientData Data Source and click Finish
      • Note: if one or more data services already exists, you'll need to click the New Data Service button on the Data Service Summary page

    create-data-source-single.png

    data-service-summary.png

    8) Test the data service

    • Select the PatientDataService and click the 'Test' button: 
      • this will deploy the data service and take you to the test page
    • - On the test page, click Submit to execute your query
      • You can customize and filter your query using row limit, columns, where criteria and order-by options.

     

    • You can also click the SQL tab to query the data using SQL

    test-odata-page.png

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

     

    Next up:    Managing Data Service Sources

    ====================================================================================