JBoss.orgCommunity Documentation

Chapter 2. Dive Right In!

2.1. Targeting the Teiid Server
2.1.1. Server Version Preference
2.1.2. Defining a Teiid Server
2.1.3. Server Version Status Panel
2.2. Guide Example
2.2.1. Model a Relational (via JDBC) Source
2.3. Cheat Sheet Example
2.3.1. Consume a SOAP Web Service

We are going to dive right into a couple examples of common tasks in this section. These examples will give you a quick introduction to the capabilities that are built into Designer to assist you with common design tasks. Specifically, we will introduce the following concepts:

After seeing the Guides and Cheat Sheets in action, subsequent chapters will offer detailed explanations of the various concepts and actions.

2.1. Targeting the Teiid Server

In this section, the setting of the teiid server version is demonstrated. This can be achieved by either setting a preference or by defining a teiid server.

The default server version preference allows the target server version to be changed without actually having to define a teiid server in Designer. The preference's list of possible values is determined by which teiid runtime client plugins have been installed into the application.

Default Server Version Preference

Figure 2.1. Default Server Version Preference


The defining of a Teiid Server is encouraged since it allows for models to be previewed and their deployment tested. There is no limit to the number of servers that can be defined. However, the default server will always be used for previewing and deployment, unless using the context menu actions in the Section D.2.3, “Server View”.

The Guides View provides the following Teiid Server actions.

Teiid Server Category in the Guides View

Figure 2.2. Teiid Server Category in the Guides View


The New Teiid Server action will display the wizard outlined in ??? and steps through the process of creating both the Teiid Server and its parent JBoss server in the Server View.

Should more than one Teiid Server be defined in the Server View then the Set the Default Server action allows for the default server to be changed appropriately. If a Teiid Server is currently selected in the Server View then this will be selected as the default server. However, should nothing be selected then a dialog will be displayed inviting the user to choose which server they wish to select.

Note

The version of the defined Teiid server always takes precedence over the Section 2.1.1, “Server Version Preference”

Whether the server version preference has been modified or a server defined, the server and server target version will be updated in the default server status panel. This will always reflect the current server version being targeted and the server being used to preview or deploy against.

Default Server Status Panel

Figure 2.3. Default Server Status Panel


2.2. Guide Example

In this section, the Guides View is demonstrated in detail by walking through a simple example. For this example, we will follow the Model JDBC Source Action Set. The actions appear in the following order:

  1. Define Teiid Model Project
  2. Create JDBC connection
  3. Create source model for JDBC data source
  4. Preview Data
  5. Define VDB
  6. Execute VDB

The action names are self explanatory. We will create a new "Model Project" in the workspace, then define our connection properties to a MySQL database. We will then connect to the database and import the 'metadata', creating a source model in Designer. Next we will 'preview' the database contents. Finally we will define a 'VDB' and then deploy it to a running Teiid Server to execute.

This section shows how to Model a Relatioanl Source, using the Guide View action set. We will connect to a MySQL database for this example, but you can use the same process to connect to any supported database.

  1. Open Guides View

    To open the Teiid Designer's Guides view, select the main menu's Window > Show View > Other... and select the Teiid Designer > Guides view in the dialog.

    The Guides view is shown below, with the Model JDBC Source Action Set selected:

    Guides View

    Figure 2.4. Guides View


  2. Define Teiid Model Project

    The Define Teiid Model Project action launches the New Model Project Wizard. In the Action Set list, double-click the action (or select it, then click 'Execute selected action'). The wizard is launched as shown below:

    New Project Wizard

    Figure 2.5. New Project Wizard


    Enter a project name, e.g. 'MyProject' for the name. Then click Next. The next page of the wizard is shown below:

    New Project Folders

    Figure 2.6. New Project Folders


    Under 'Create Folders', de-select 'schemas' and 'web_services' - we won't need them for this example. Now, click Finish to exit the wizard. The project has now been created - your Model Explorer view should like like this:

    Model Explorer

    Figure 2.7. Model Explorer


  3. Create JDBC connection

    The Create JDBC connection action will create the 'Connection profile' for your database. The connection profile defines the properties and driver to be used when connecting to the database. In the Action Set list, double-click the action (or select it, then click 'Execute selected action'). The wizard is launched as shown below:

    Connection Profile Name and Type

    Figure 2.8. Connection Profile Name and Type


    Select the type of database that you are connecting to (e.g. MySQL), and enter a name for the connection profile, e.g. 'TestMySQL'. Click Next.

    Connection Profile properties

    Figure 2.9. Connection Profile properties


    Now, select the driver and enter the login properties for your database. Click Finish to complete the profile creation.

  4. Create source model for JDBC data source

    The Create source model for JDBC data source action will now utilitze the Connection profile that you just created, to import the metadata from the database to create your Teiid Source Model. In the Action Set list, double-click the action (or select it, then click 'Execute selected action'). The wizard is launched as shown below:

    Select Connection Profile

    Figure 2.10. Select Connection Profile


    On this page, select the 'TestMySQL' Connection profile that you created in the previous step. Click Next.

    Select Database Metadata

    Figure 2.11. Select Database Metadata


    On this page, select the database metadata that you want to import. When finished, click Next.

    Select Database Objects

    Figure 2.12. Select Database Objects


    On this page, select the specific objects from the database that you want to import. When finished, click Next.

    Import Options

    Figure 2.13. Import Options


    Finally, choose the name for the model to be created (defaults to 'profileName'.xmi). The 'Into Folder' field defines the target location for your new model. Select the 'MyProject/sources' folder. Now, click Finish. The source model has now been created - your Model Explorer view should like like this:

    Model Explorer

    Figure 2.14. Model Explorer


  5. Preview Data

    All execution capabilities in Designer (Preview Data, VDB execution) require you to connect to a running Teiid Server. See Chapter 3, Server Management for instructions on establishing a Teiid Server connection. Once you are connected to a Teiid Server, you can proceed with the following steps.

    The Preview Data action allows you to preview a sample of data rows from your source. In the Action Set list, double-click the action (or select it, then click 'Execute selected action'). In the dialog, select the source table you want to preview, as shown below:

    Select Preview Table

    Figure 2.15. Select Preview Table


    After selecting the table, click OK. Now, the preview results will be displayed:

    Preview Results

    Figure 2.16. Preview Results


  6. Define VDB

    The Define VDB action allows you to create a VDB (Virtual Database) artifact for deployment to a Teiid Server. In the Action Set list, double-click the action (or select it, then click 'Execute selected action'). The following dialog is displayed:

    New VDB

    Figure 2.17. New VDB


    In the dialog, select the target 'In Folder' location where the VDB will be placed. Enter a Name for the VDB, for example 'myVDB'. Finally, select the models that will be included in the VDB. When finished, click Finish. The VDB will be created in your Teiid Model Project - as shown in the following figure.

    Model Explorer

    Figure 2.18. Model Explorer


  7. Execute VDB

    Finally, the Execute VDB action allows you to execute your VDB and run sample queries against it. In the Action Set list, double-click the action (or select it, then click 'Execute selected action'). In the dialog, select the VDB you want to execute, then click OK. The VDB will be deployed and executed, and the perpective will switch to the 'Database Development' perspective. You can now run queries against the VDB, as show in the following example:

    Execute VDB Example

    Figure 2.19. Execute VDB Example


2.3. Cheat Sheet Example

In this section, we introduce Cheat Sheets by walking through a simple example. For this example, we will follow the Consume a SOAP Web Service Cheat Sheet.

This section shows how to consume a SOAP Web Service, using a Cheat Sheet. We will demonstrate connection to a publicly accessible web service. You can use this process as an example for modeling other web services

  1. Open the Cheat Sheet

    You can access the Cheat Sheet from the Designer Menu. From the Designer main menu, select Window > Show View > Other..., then select Help > Cheat Sheets in the dialog.

    Alternately, you can access the Cheat Sheet from the Guide View. A sample Guide view is shown below, with the Consume a SOAP Web Service Action Set selected:

    Guides View

    Figure 2.20. Guides View


    To open the Cheat Sheet from the Guide View, expand the Cheat Sheet section in the lower portion of the Guide View, then select the Consume a SOAP Web Service link.

  2. Begin the Cheat Sheet

    The Consume a SOAP Web Service Cheat Sheet is shown below:

    Consume SOAP Web Service Cheat Sheet

    Figure 2.21. Consume SOAP Web Service Cheat Sheet


    To start the Cheat Sheet process, expand the Introduction section, then select Click to Begin. The Create New Teiid Model Project section opens, as shown.

    Create Model Project

    Figure 2.22. Create Model Project


    Note

    Each section of the sheet has basic instructions outlining what to do at each step.

    Click next to Launch New Teiid Model Project Wizard to launch the 'New Project' wizard.

    Follow the wizard to create a new Model Project. For this example, we will use SOAPProj for our project name. On the second page of the wizard, select the 'sources' and 'views' folders. Click Finish. The new project is created.

    In the Cheat Sheet, you can advance to the next step - once the wizard has completed. Click to advance to the next step.

  3. Create SOAP Web Service Connection

    This section of the Cheat Sheet provides instructions for creating a connection profile for the SOAP Web Service, as shown below:

    Create SOAP Connection Profile

    Figure 2.23. Create SOAP Connection Profile


    Click next to Launch Create SOAP Connection Profile Wizard to launch the wizard. The first page of the wizard is shown below:

    Create SOAP Connection Profile

    Figure 2.24. Create SOAP Connection Profile


    The Web Services Data Source (SOAP) profile type will be selected. Enter CountryInfoConn for the profile name, then click Next. The next page of the wizard is shown below:

    SOAP Connection Properties

    Figure 2.25. SOAP Connection Properties


    The connection profile properties are entered on this page. Click on the URL... button, then enter the following URL: http://www.oorsprong.org/websamples.countryinfo/CountryInfoService.wso?WSDL

    Select 'None' for SecurityType, then click OK to complete the wizard. In the Cheat Sheet, you can now continue - once the wizard has completed. Click to advance to the next step.

  4. Create Models from SOAP Connection

    This section of the Cheat Sheet provides instructions for creating relational models using the previously-created connection profile for the SOAP Web Service, as shown below:

    Create Models from SOAP Connection

    Figure 2.26. Create Models from SOAP Connection


    Click next to Launch the Consume SOAP Web Service Wizard to launch the wizard. The first page of the wizard is shown below:

    Consume SOAP Wizard

    Figure 2.27. Consume SOAP Wizard


    For Connection Profile, select the previously-created CountryInfoConn profile. The available WSDL Operations will then be displayed under Select the desired WSDL Operations. Select only the first CapitalCity Operation for this example. Click Next to proceed to the next page, as shown below:

    Consume SOAP Wizard

    Figure 2.28. Consume SOAP Wizard


    On the Model Definition page, the source and view model info section will be pre-filled. We will keep the names and location defaults for the source and view models. Click Next to proceed to the next page, as shown below:

    Consume SOAP Wizard

    Figure 2.29. Consume SOAP Wizard


    On the Procedure Definition page, the CapitalCity Operation will be selected since it is the only one used for this example. On the Request tab, select the sCountryISOCode element - then click the Add button. This will add the selected element to the request. Now select the Response tab, as shown below:

    Consume SOAP Wizard

    Figure 2.30. Consume SOAP Wizard


    On the Response tab, select the Body sub-tab. In the Schema Contents, select the CapitalCityResult, then click the Add button. This will add the selected element to the response.

    Select the Wrapper Procedure tab to see the full Generated Procedure SQL, as shown below.

    Consume SOAP Wizard

    Figure 2.31. Consume SOAP Wizard


    Click Finish to exit the wizard. In the Cheat Sheet, you can now continue. Click to advance to the next step.

  5. Create VDB

    This section of the Cheat Sheet provides instructions for creating a VDB using the models that you created in the previous step. The Cheat Sheet section is shown below:

    Create VDB

    Figure 2.32. Create VDB


    Click next to Launch New VDB Wizard to launch the wizard. Follow the steps to create a VDB in your workspace. When complete, exit the wizard. In the Cheat Sheet, you can now continue. Click to advance to the next step.

  6. Test VDB

    This final section of the Cheat Sheet provides instructions for executing the VDB created in the previous step. Click next to Launch Execute VDB Dialog to launch the wizard. Select the previously-created VDB to execute it.