Package com.smartgwt.client.docs

# Interface AdminConsole

public interface AdminConsole

### Admin Console

The Admin Console is a tool for configuring database access, importing and exporting server-backed Smart GWT DataSources, and performing other tasks.

To use the Admin Console, make sure you have followed the `full installation instructions` - double check that you have the correct GWT <inherits> as shown in those instructions. Then, launch your GWT project from your IDE, and open a web browser to moduleBaseURL/tools/adminConsole.jsp. For example, if you load your application by going to a URL that ends in builtinds/builtinds.html, the correct URL for the Admin Console is builtinds/tools/adminConsole.jsp.

There is also a convenience method `openDataSourceConsole()` on the SC utility class to open the Admin Console in a new browser window. To make use of this, you can add the following code to your onModuleLoad():

        IButton adminButton = new IButton("Admin Console");
        adminButton.addClickHandler(new ClickHandler() {
          public void onClick(ClickEvent event) {
            SC.openDataSourceConsole();
          }
        });
        adminButton.draw();

Features:

Database Configuration

This tab allows you to configure SQL database connetions. This is an alternative to adding SQL configuration blocks directly to `server.properties` by hand. See the `database configuration` documentation for more details.

Note that if you are using an IDE such as Eclipse to run your Web Project, the definitive copy of `server.properties` under the `"src/"` directory will not be updated by this tool. Changes will be written to `server.properties` in your deployment directory.
Use the "Download server.properties" button to download the settings and merge them to the server.properties file in your Eclipse (or other IDE) project.

View DataSources

The `DataSource Navigator` lets you view the available DataSources in dedicated sections, where you can also edit and export records.

Import DataSources

This tab allows you to generate and populate database tables from DataSource definitions.

All DataSources defined in XML (as described `here`) are displayed in a list. Developers may select any dataSource to see details of the dataSource and preview its data if any exists.

For DataSources of `type` `"sql"` or `"hibernate"`, the buttons at the bottom of this tab allow users to create a new database table for the DataSources. Test data may be imported test data, either from an existing `test data file` or by uploading String.

Server Logs

Just like in the `Developer Console` this will allow you to see the 500 most recent server side log entries.

SQL Browser

On this tab you will be able to browse your SQL databases and see the data in their tables. You may also create DataSources from those tables and save them to disk, at the location specified by a `project.datasources.generated` `config property` (by default the same as the `project.datasources` property).

Scheduler

With the `scheduler tool` you can view, schedule, trigger and pause arbitrary Quartz jobs. Requires the Isomorphic Scheduler server library and an initialized / configured Quartz Scheduler.

Other Tools

Here you will find links to some other standalone development tools.

See Also:
  - `ToolsDeployment`