<html>
<head>
<base href="https://docs.jboss.org/author">
<link rel="stylesheet" href="/author/s/en/2172/19/5/_/styles/combined.css?spaceKey=TEIID&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://docs.jboss.org/author/display/TEIID/Teiid+Console">Teiid Console</a></h2>
<h4>Page <b>edited</b> by <a href="https://docs.jboss.org/author/display/~kylin">Kylin Soong</a>
</h4>
<br/>
<h4>Changes (8)</h4>
<div id="page-diffs">
<table class="diff" cellpadding="0" cellspacing="0">
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >h1. Installation <br> <br></td></tr>
<tr><td class="diff-changed-lines" >Once you download the Teiid Console, unzip the contents over the <span class="diff-changed-words"><span class="diff-added-chars"style="background-color: #dfd;">WildFly/</span>JBoss</span> AS7 root directory and all the required files will be overlayed correctly to install Teiid Console. The Teiid Console, by default is secured, so you would need a management realm user id and password to log in. In the <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;"><jboss-as7>/bin</span> <span class="diff-added-words"style="background-color: #dfd;"><JBOSS_HOME>/bin</span> directory, use <br></td></tr>
<tr><td class="diff-unchanged" > <br>{code:title=Adding a management user in *inx} <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >{code} <br> <br></td></tr>
<tr><td class="diff-changed-lines" >then follow the prompts to create Management Realm user. Once you have created a management user, you need to use these credentials to log in to the Teiid Console. If you have started your <span class="diff-changed-words"><span class="diff-added-chars"style="background-color: #dfd;">WildFly/</span>JBoss</span> AS7 in default mode, then you can access the Teiid Console at [http://localhost:9990/console/App.html]. If you have altered the binding or port numbers then modify the address accordingly. <br></td></tr>
<tr><td class="diff-unchanged" > <br> <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" > <br> <br></td></tr>
<tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">h1.FAQ <br></td></tr>
<tr><td class="diff-added-lines" style="background-color: #dfd;">h1. FAQ <br></td></tr>
<tr><td class="diff-unchanged" > <br>* How to deploy a VDB? <br></td></tr>
<tr><td class="diff-changed-lines" >In the "runtime" view, go to "Server <span class="diff-changed-words"><span class="diff-added-chars"style="background-color: #dfd;">\</span>-></span> Manage Deployments", click "add" and select the VDB to deploy. Also make sure you "enable" the VDB once it is deployed. <br></td></tr>
<tr><td class="diff-unchanged" > <br>* How to create Data source? <br></td></tr>
<tr><td class="diff-changed-lines" >In the "profile" view, go to "Connector <span class="diff-changed-words"><span class="diff-added-chars"style="background-color: #dfd;">\</span>-></span> Data Sources", click "add" and follow the wizard to create JDBC data source. If you trying to create connection to Teiid based File, Salesforce or WS based connections, select "Connector <span class="diff-changed-words"><span class="diff-added-chars"style="background-color: #dfd;">\</span>-></span> Resource Adaptors" and click "add" <br></td></tr>
<tr><td class="diff-unchanged" > <br>* How to add COMMAND Logging? <br></td></tr>
<tr><td class="diff-changed-lines" >In the "Profile" view, go to "Core <span class="diff-changed-words"><span class="diff-added-chars"style="background-color: #dfd;">\</span>-></span> Logging", on "Log Categories" tab, click add "org.teiid.COMMAND_LOG" in "DEBUG" mode. The default log will be in the FILE handler. You can even add other handler if choose to do so. <br></td></tr>
<tr><td class="diff-unchanged" > <br>* Change Teiid JDBC Port? <br></td></tr>
<tr><td class="diff-changed-lines" >In the "Profile" view, go to "General Configuration <span class="diff-changed-words"><span class="diff-added-chars"style="background-color: #dfd;">\</span>-></span> Socket Configuration" and right hand side select the socket profile and click "view" and edit the "teiid-jdbc" property. <br></td></tr>
</table>
</div> <h4>Full Content</h4>
<div class="notificationGreySide">
<p>Teiid Console is a web based administrative and monitoring tool for Teiid. Teiid Console is extension of JBoss AS7 console that is built using GWT based technologies. The Teiid kit does not include files for Teiid Console. This is separate download you can download from <a href="http://www.jboss.org/teiid/downloads" class="external-link" rel="nofollow">Teiid Downloads </a></p>
<h1><a name="TeiidConsole-Installation"></a>Installation</h1>
<p>Once you download the Teiid Console, unzip the contents over the WildFly/JBoss AS7 root directory and all the required files will be overlayed correctly to install Teiid Console. The Teiid Console, by default is secured, so you would need a management realm user id and password to log in. In the <JBOSS_HOME>/bin directory, use</p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Adding a management user in *inx</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
./add-user.sh
</pre>
</div></div>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Adding a management user in Windows</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
add-user.bat
</pre>
</div></div>
<p>then follow the prompts to create Management Realm user. Once you have created a management user, you need to use these credentials to log in to the Teiid Console. If you have started your WildFly/JBoss AS7 in default mode, then you can access the Teiid Console at <a href="http://localhost:9990/console/App.html" class="external-link" rel="nofollow">http://localhost:9990/console/App.html</a>. If you have altered the binding or port numbers then modify the address accordingly.</p>
<h1><a name="TeiidConsole-ProfileView"></a>Profile View</h1>
<p>Profile view is for configuration. Click on "profile" on top right hand corner of the main console screen, to go to Profile View. You can click on "Teiid" in left navigation tree to go to Teiid configuration. There you have three choices</p>
<ul>
<li>Query Engine - view and configure core Teiid engine properties.</li>
<li>Translators - view, add and remove the Translators configured in Teiid.</li>
<li>Transports - view, add and remove transports to the Teiid engine.</li>
</ul>
<p><span class="image-wrap" style=""><img src="/author/download/attachments/18646076/webconsole2.png?version=3&modificationDate=1352148874000" style="border: 1px solid black" /></span></p>
<p>Using this view you can change any configuration value of Teiid. Note that various different configuration properties are sub-divided into different tabs. You can click "Need Help" link on these pages to see the description of each field on the page.</p>
<div class='panelMacro'><table class='warningMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Server Restart</b><br />Note that some properties require you to restart the server before they can take effect.</td></tr></table></div>
<h1><a name="TeiidConsole-RuntimeView"></a>Runtime View</h1>
<p>Runtime view shows run time information about AS7 and Teiid subsystem. Runtime information about Teiid can be viewed by selecting "Virtual Databases" on left hand navigational tree.</p>
<p><span class="image-wrap" style=""><img src="/author/download/attachments/18646076/webconsole1.png?version=2&modificationDate=1352148796000" style="border: 1px solid black" /></span></p>
<p>Using this page user can view many different settings in the context a VDB. All the VDBs deployed in the server are shown in top level table. When you select and highlight a VDB, more details about that VDB are displayed in the sub-tabs below. Each of these sub-tabs are divided into grouping of the functionality.</p>
<h3><a name="TeiidConsole-Summary"></a>Summary</h3>
<p>This tab shows the description and any properties associated with VDB, along with any other VDBs this VDB imports. This tab is designed to give a quick overview of the VDB status.</p>
<h3><a name="TeiidConsole-Models"></a>Models</h3>
<p>This panel shows all the models that are defined in a given VDB, and shows each models translator name and source connection JNDI name. It also shows the type of models and if it is multi-source or not. When a particular model is selected it will show all properties of that model that are defined and also shows any errors associated with the model. When your VDB is not deployed in the "active" status, you would need to verify these errors and fix to resolve any deployment issues.</p>
<p>The "DDL" button shows the schema for the given model. Note that this does not work for XML based models that are designed using Teiid Designer.</p>
<p>The tool lets the user edit the translator name or JNDI name by double clicking on them and modifying them. This useful if you would like to change the JNDI name in a given environment.</p>
<h3><a name="TeiidConsole-Overrides"></a>Overrides</h3>
<p>If you have overridden any translators in the Teiid Designer, this panel will show the all the overridden translators and their properties.</p>
<h3><a name="TeiidConsole-Caching"></a>Caching</h3>
<p>Caching panel shows caching statistics of resultset cache as to how effectively the cache is being used. It also shows all the internal materialized views in the VDB and their load status as to when they were loaded. It also gives options to invalidate a specific view or all the views in a VDB, so that they can refresh/reload the contents from source.</p>
<p>This panel also provides a UI to flush the entire the resultset cache contents or prepared plan cache contents for the selected VDB.</p>
<h3><a name="TeiidConsole-DataRoles"></a>Data Roles</h3>
<p>Data Roles panel shows the all the policies that defined in the VDB using the Teiid Designer or hand coded in the vdb.xml file. For each selected policy, it will also list the "permissions" for that policy as to what kind of authorizations user has and shows the mapped enterprise role assignments to that policy. You can even add/remove a enterprise role to the policy using the this UI.</p>
<h3><a name="TeiidConsole-Requests"></a>Requests</h3>
<p>This panel shows all the current requests against the selected VDB at the time of VDB selection. You can click "refresh" to get a more up to date requests. The top table in the panel shows the user submitted requests to the teiid engine, when one of those requests are selected, then the bottom table shows all the source level queries that are submitted to the physical sources by Teiid engine.</p>
<p>Using this UI, user can also submit a "cancel" request to a user level query. Since "cancel" asynchronous operation, the operation is not guaranteed as query may already been finished, by the time cancel is submitted.</p>
<h3><a name="TeiidConsole-Sessions"></a>Sessions</h3>
<p>This panel shows all the active sessions that are connected to the selected VDB. It shows their connection properties and also gives an option to terminate either a selected session or all the sessions.</p>
<h1><a name="TeiidConsole-FAQ"></a>FAQ</h1>
<ul>
<li>How to deploy a VDB?<br/>
In the "runtime" view, go to "Server -> Manage Deployments", click "add" and select the VDB to deploy. Also make sure you "enable" the VDB once it is deployed.</li>
</ul>
<ul>
<li>How to create Data source?<br/>
In the "profile" view, go to "Connector -> Data Sources", click "add" and follow the wizard to create JDBC data source. If you trying to create connection to Teiid based File, Salesforce or WS based connections, select "Connector -> Resource Adaptors" and click "add"</li>
</ul>
<ul>
<li>How to add COMMAND Logging?<br/>
In the "Profile" view, go to "Core -> Logging", on "Log Categories" tab, click add "org.teiid.COMMAND_LOG" in "DEBUG" mode. The default log will be in the FILE handler. You can even add other handler if choose to do so.</li>
</ul>
<ul>
<li>Change Teiid JDBC Port?<br/>
In the "Profile" view, go to "General Configuration -> Socket Configuration" and right hand side select the socket profile and click "view" and edit the "teiid-jdbc" property.</li>
</ul>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://docs.jboss.org/author/users/removespacenotification.action?spaceKey=TEIID">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://docs.jboss.org/author/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://docs.jboss.org/author/display/TEIID/Teiid+Console">View Online</a>
|
<a href="https://docs.jboss.org/author/pages/diffpagesbyversion.action?pageId=18646076&revisedVersion=7&originalVersion=6">View Changes</a>
|
<a href="https://docs.jboss.org/author/display/TEIID/Teiid+Console?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>