ReportWeaver accesses data in database tables/views and through SQL queries. To run Reportweaver needs to know how to connect to your database, and which tables shall be available for reports.

This information is stored in a file called the "report schema file". Data access is controlled through this file which offers an extra level of security. In the schema file tables are mapped to a more intuitive object-relational view, which makes report design easier for non-technical users.

Once the database is open the schema file and class path are stored in the repository. We recommend, that you save your repository after the database is open. You can then use this saved repository as a template for future work with this database.

If you want to change the schema file location or if your classpath must be modified, please use the command Open template set and reconfigure.

Note:Because there can only be one primary database attached during a session, the new/open action is disabled once you have a database open or after you have loaded a saved repository.

Creating a first report consists of the following steps:

  1. Create a minimal schema file.
  2. Create a project
  3. Designing and running a report template

When Reportweaver startup screen appears you can create/edit the schema file and create/administer projects.

1. Set up a New Database Connection and Reporting Schema File

This will start the schema editor, which will first ask for the name of the new schema file. Schema files usually have the extension .rsd (report schema definition)

Enter a new filename, for your schema, and press Next.

On the next tab you can set up your database connection:


  1. In the combo box select the database system, that you are using. If the driver is not listed, please see how to add drivers.
  2. This is the connection URL which contains all connection settings. For details of the various databases see: driver options.
  3. Database user name. (required)
  4. Password (required)
  5. Hostname, where the server is located.
  6. Portnumber of the server.
  7. Name of the database.
  8. Additional properties. For database specific properties please see: driver options.

Selecting tables and adding queries.

On this page, you can select which tables shall be accessible for the reporting system, and which columns shall be shown. This information plus link information between the tables is called a scope. Scopes are interconnected through links (joins). Specifiying the links in advance allows ReportWeaver to use a more comprehensive presentation of the schema in the form of hierarchical navigation. Scope also control secure access and can contain performance optimisations.

For your first report, just select one table and press New Table Scope

  1. The tables in your database. You can access them from your reports by creating scopes on the right.
  2. The defined scopes. These will be available for your reports. The Root is the name that will be used to access them.
  3. The selected source table. (Used by New Table Scope)
  4. The selected scope. (Applies to Edit and Remove)
  5. This creates a new scope for the table selected on the left. New Table Scope
  6. This creates a scope for a SQL query.
  7. This edits the table scope or query that is selected on the right.
  8. This will remove the selected query from the schema.

Creating a new table scope

The creation of a new table scope is described here: New Table Scope

For a simple one table report this is all the schema setup that is required. To start designing now finish the table dialog and the schema dialog, which will take you back to the start page, where you can create a project.

For more information on schema configuration see the schema setup reference.

2. Creating a project

To create a new project select New Project on the start page:

This will show the project creation wizard:

  1. Select the directory with the schema file in the left pane.
  2. Select the schema file (which you just created) in the right pane.
  3. To add plugins, specific extensions or adapters select the Classpath page. This is only needed for special projects. In most cases just skip this page by pressing finish.
  4. Pressing next will also take you to the Classpath page.
  5. Pressing Finish will close the project wizard and open the report designer.

This concludes the setup process. Next steps:

3. Designing an running a report template.

  • To design your first report go to the report design tutorial.
  • Get an overview of the report design process.
  • Detailed reference of the relational schema wizard.