JBoss.orgCommunity Documentation
Go To: Table of Contents
Teiid Designer provides various views to display and allow editing of models and model content. This section describes each view in detail.
Teiid Designer allows you manage multiple projects containing multiple models and any corresponding or dependent resources. The Model Explorer provides a simple file-structured view of these resources.
The Model Explorer (shown below) is comprised of a toolbar and a tree view.
The toolbar consists of nine common actions:
Preview Data - Executes a simple preview query (SELECT * FROM ).
Sort Model Contents - Sorts the contents of the models based on object type and alphabetizing.
Refresh Markers - Refreshes error and warning markers for objects in tree.
Back - Displays the last "Go Into" location. (See Eclipse Help)
Forward - Displays the next "Go Into" location. (See Eclipse Help)
Up - Navigates up one folder/container location. (See Eclipse Help)
Collapse All - Collapses all projects.
Link with Editor - When object is selected in an open editor, this option auto-selects and reveals object in Model Explorer.
Additional Actions
The additional actions are shown in the following figure:
If Show Model Imports is checked, the imports will be displayed
directly under a model resource as shown below.
Selecting specific objects in the Model Explorer provides a context from which the Designer presents a customized menu of available actions.
Selecting a view model, for instance, results in a number of high-level options to manage edit model content, perform various operations and provides quick access to other important actions available in Designer. These may include specialized actions based on model type.
The Outline View is a utility view which provides both at tree view dedicated to a specific model (open in an editor) and a scaled thumbnail diagram representative of the diagram open in the corresponding Diagram Editor.
You can show the Outline View by clicking on its tab. If there is no open editors, the view indicates that "An Outline is not available." If a Model Editor is open, then the root of the displayed tree will be the model for the editor that is currently in focus in Designer (tab on top).
This tree view provides the same basic editing and navigation behavior as the Model Explorer. One additional capability is the drag and drop feature which provides re-ordering and re-parenting of objects in a model.
The Outline View also offers you a way to view a thumbnail sketch of your diagram regardless of its size. To view this diagram thumbnail from the Outline panel, click the Diagram Overview button at the top of the view. The diagram overview displays in the Outline View.
The view contains a thumbnail of your entire diagram. The shaded portion represents the portion visible in the Diagram Editor view.
To move to a specific portion of your diagram, click the shaded area and drag to the position you want displayed in the Diagram Editor view.
User Defined Functions extend the basic set of functions you can use within data access applications that use Teiid or even within your transformation queries that you use to model View Metadata. Your organization needs to develop Java logic to perform these functions and manage these functions through the Teiid Console. For more information about this complete process, see Creating Custom User-Defined Functions.
Before you can model the user-defined functions, you must have exported the User Defined Functions metadata model from Teiid using the Teiid Console. You should have placed this file in your local directory so that you can open it.
The User Defined Functions model uses a special metamodel, the Function metamodel, which is limited to constructs for this specific purpose. Therefore you cannot create a new model using this metamodel, nor should you use this model in a project or as a source for View Metadata models.
Users can edit their User Defined Functions model from within the UDFs view shown below. The basic functionality of the UDFs view is identical to the Model Explorer view but focused the single FunctionsDefinitions model.
The view's toolbar actions include:
Sort Model Contents - Sorts the contents of the models based on object type and alphabetizing.
Refresh Markers - Refreshes error and warning markers for objects in tree.
Import UDF Extension Jar -Import your custom UDF extension jar files.
Add Connector Jar to UDF - Add connector jar to UDF model. This allows using dual use extension jars.
Collapse All - Collapses the tree view.
Link with Editor - When object is selected in an open editor, this option auto-selects and reveals object in Model Explorer.
You can delete your UDF jars by right-click select Delete Jars action.
Both UDF jars and connector extension jars are utilized by Designer during VDB execution and data Preview. This provides the ability to utilize a common extension jar to deliver both user defined function code and custom connector code. To facilitate this scenerio, the UDFs view contains an Add Connector Jar to UDF action.
To add an existing connector jar to your UDF:
Step 1: Select the Add Connector Jar to UDF toolbar button or select the UDF jars folder or jar and right-click select the same action.
Step 2 : In the selection dialog below, select one or more connector jars and choose OK to finish.
The Connectors View provides a means to display and manage (add or remove) connectors and source bindings in Designer. For more information on Connector Bindings, see Manage Connector Bindings.
To show the Connectors View click Views > Show View > Other... to display the Show View dialog. Choose Designer > Connectors view and hit OK.
The view's toolbar actions include:
Create New Connector Binding - Launches New Connector Binding wizard.
Import Connector Bindings - Imports connector bindings from a *.cdk file.
Export Connector Bindings - Exports selected connector bindings to *.cdk file. This action provides a means to transfer your source connection information between Designer workspaces.
Show/Hide Connector Types - Shows or hides connector types in tree view.
Collapse All - Collapses the tree view.
You can also access these actions via the right-click menu as shown below. Note that the Clone binding action creates a new connector binding whose property values are set with those of the originally selected binding.
You can show/hide the connector types by toggling the action in the toolbar.
The Properties View provides editing capabilities for the currently selected object in Designer . The selection provided by whichever view or editor is currently in focus will determine the its contents.
To edit a property, click a cell in the Value column. As in the Table Editor, each cell provides a UI editor specific to the property type. See Editing Table Properties for a detailed summary.
If the model for the object being edited is not open in an editor, a dialog may appear confirming the attempt to modify the model and asking the user to confirm or cancel. This dialog can be prevented by checking the preference "Always open editor without prompting". You can re-set/uncheck this property via the Designer's main preference page.
Properties can also be edited via a right-click menu presented below.
The Properties toolbar contains the following actions:
Show Categories - toggles between categorized properties and flat alphabetical properties list.
Show Advanced Properties - shows/hide advanced properties (if available).
Restore Default Value - for a selected property, this action will reset the current to a default value (if available).
The Description View provides a means to display and edit (add, change or remove) a description for any model or model object. To show the Description View click " Views > Show View > Other... " to display the Show View dialog. Choose " Designer > Description " view and hit OK .
You can click in the text field and edit in a similar fashion with standard text editing. Below is a list of available right-click edit actions.
Editors are the UI components designed to assist editing your models and to maintain the state for a given model or resource in your workspace. When editing a model, the model will be opened in a Model Editor. Editing a property value, for instance, will require an open editor prior to actually changing the property.
Any number of editors can be open at once, but only one can be active at a time. The main menu bar and toolbar for Designer may contain operations that are applicable to the active editor (and removed when editor becomes inactive).
Tabs in the editor area indicate the names of models that are currently open for editing. An asterisk (*) indicates that an editor has unsaved changes.
By default, editors are stacked in the editors area, but you can choose to tile them vertically, and or horizontally in order to view multiple models simultaneously.
The Designer provides main editor views for XMI models and VDBs.
The Model Editor contains sub-editors which provide different views of the data or parts of data within a model. These sub-editors, specific to model types are listed below.
Diagram Editor - All models except XML Schema models.
Table Editor - All models.
Simple Datatypes Editor - XML Schema models only.
Semantic Editor - XML Schema models only.
Source Editor - XML Schema models only.
The VDB Editor contains sub-editors which provide different views of the data or parts of data within a VDB. These sub-editors include.
Overview - View and manage contents of VDB.
Problems - Display errors and warnings within VDB and models.
Indexes - View indexes generated for model data within VDB.
User Files - Manage additional VDB resources or artifacts.
Web Services - Define and view WSDL.
Execute - Create and change connector bindings and execute queries.
In addition to general Editors for models, there are detailed editors designed for editing specific model object types. These "object" editors include:
Transformation Editor - Manages Transformation SQL for Relational View Base Tables, Procedures and XML Service View Operations.
Choice Editor - Manages properties and criteria for XML choice elements in XML Document View models.
Input Editor - Manages Input Set parameters used between Mapping Classes in XML Document View models.
Recursion Editor - Manages recursion properties for recursive XML Elements in XML Document View models.
Operation Editor - Manages SQL and Input Variables for Web Service Operations.
The Problems View displays validation errors, warnings, or information associated with a resource contained in open projects within your workspace.
By default, the Problems View is included in the Designer perspective. If the Problems View is not showing in the current perspective click Views > Show View > Other > Designer > Problems.
There are 5 columns:
Severity - Indicates the severity of the line item (i.e., error , warning , or info ).
Description - A description of the line item.
Resource - The name of the resource.
In Folder - The project name.
Location - Model object within the resource that has a validation error.
Click the upside-down triangle icon to open the view menu.
The Sorting action presents a dialog which enables sorting of the problems by severity, resource, and location.
The Filters action presents a dialog which enables filtering of the problems by total number, type, resource, severity, and description.
Additional actions are available by selecting a problem and right-click to open a context menu.
Go To - will open the appropriate editor and select the affected/referenced object.
Show In Navigator - Opens the Basic > Navigator view (if not open) and expands file system tree and reveals applicable resource.
Copy - Copies the problem information to the system clipboard.
Paste - Pastes the problem information located in the system clipboard ( if applicable ) into the curor location for a specified text editor.
Delete - Deletes the selected problem rows ( if applicable ).
Select All - selects all problems in the table.
Quick Fix - (Not yet implemented in Designer).
Properties - displays a dialog containing additional information.
The Message Log view provides a console-based view of any errors or warnings that may occur during your Designer session.
You can perform various operations on the content of the viewer via the toolbar actions or use the right-click menu shown below.
Executing the Preview Data action , will result in the query results being displayed in the Preview results view, shown below.
The view's toolbar actions include:
Show Query Results - Shows query results in table row or XML format.
Show Query Plan Tree - Shows query plan in tree format.
Show Query Plan Document - Shows query plan in xml document format.
Show Debug Log - Shows debug log file contents.
Close the Selected Results - Removes the selected results from the view.
Copy Results to Clipboard - Copies selected results as text to the system clipboard.
Save Results to File - Provides a file dialog to save selected results to a text file on file system.
The History list can be sorted alphabetically (or reverse) by clicking the "History" column header.
The tooltip for each History object will display the underlying base SQL text used in the query.
Because the Preview Data feature is just that, a preview, you are limited to maximum number of rows returned rows. This value is a user preference and can be changed from its default value by selecting Preferences > Designer and changing the Preview Data's row count limit value.
By selecting the Show Query Plan Tree toolbar action the SQL table results are replaced with a tree view of the underlying Query plan and corresponding properties.
By selecting the Show Query Plan Document toolbar action the SQL table results are replaced with an XML document view of the underlying Query plan.
Below is an example set of search results. The view contains rows representing matches for your search parameters. You can double-click a entry and the object will be opened and selected in an editor and/or the VDB Explorer if applicable.
The toolbar actions for the Search Results view are:
Show Next Match - Navigates down one row in the view.
Show Previous Match - Navigates up one row in the view.
Remove Selected Matches - Removes selected results from the view.
Remove All Matches - Clears the view.
Search - Launches the MoDesignerearch Dialog.
Previous Search Results - Select previous search results from history.
You can also perform some of these actions via the right-click menu:
To open Designer's Datatype Hierarchy view, select the main menu's Views > Show View > Other... and select the Designer > Datatypes view in the dialog.
To open Designer's System Catalog view, select the main menu's Views > Show View > Other... and select the Designer > System Catalog view in the dialog..