2. Codus GUI

2.1. Setup Tab

The Project Configuration Tab is the starting point for all generation tasks. It allows you to create a new project and save it for future use.

Database Properties

The Database Properties section allows you to quickly create a new connection. Simply select the connection type, and then enter the appropriate information. Once completed, you have the following options:

  • New

    Clears all database information so that a new configuration can be added

  • Save

    Saves the configuration information for future use

    Important

    You must save a new connection before you can test it or load tables. If you haven't saved the new connection, Codus will automatically use the first entry in the database list.

  • Test Connection

    Tests the database connection, and notifies you of any connection errors.

  • Load Tables

    Loads the database schema for viewing in the Tables Tab and code generation.

    Important

    This must be done before code can be generated.

Project Settings

The Project Settings section determines the namespace that will be used for generation, and the output location.

The output location determines where all generated code will be placed.

For the output location, the standard output path is

[Your output path]\[Database Name]\[Template Project Name]

For example, if you set the output path to C:\output, select the Northwind database, and select the DAO Framework template project, then your output location would be:

C:\output\Northwind\DAO Framework\

Saved Configurations

All saved configurations appear on the left side of the Setup Tab.

  • Single Click

    The configuration information will be populated in the Database Settings and Project Settings sections.

  • Double Click

    The tables for the configured database will be loaded, so that the Tables Tab is populated, and code generation can take place.

There are also several context menu options:

  • Delete

    Deletes the configuration from the list of saved configurations.

  • Test Connection

    Tests the database connection, and notifies you of any connection errors.

  • Load Tables

    Loads the database schema for viewing in the Tables Tab and code generation.

    Important

    This must be done before code can be generated.

2.2. Tables Tab

Once the tables have been loaded via the "Load Tables" command, a list of all tables and views is displayed in the Tables Tab for the selected database.

All checked tables and views will be included in the code generation output. To remove a table or view from output, simply uncheck it.

Additionally, columns for a specified table or view can also be included or excluded from code generation. Click on the table you want to manage, and the columns will appear in the column list. You can then check or uncheck columns that you want to be included or excluded.

2.3. Generation Tab

The Generation Tab contains a list of available Template Projects. All selected Template Projects will be generated.

When you click on a Template Project, its information is displayed, to include

Table 1. Template Project Properties

PropertyDescription
PackageThe name of the Template Project
AuthorThe author
VersionVersion number
DescriptionA description of what the Template Project does
Custom OptionsAny custom options for the specified Template Project

Once you've selected the Template Projects that you want to generate from, and modified the custom options for each Template Project, simply click the Generate button.

The Generate button will stay disabled until all generation is complete. Upon completion, you'll see a notice next to the Generate button stating how many files were generated.

2.4. Output Tab

All output is logged to the output tab, showing the current template that's being generated, along with the specific files.