Page tree
Skip to end of metadata
Go to start of metadata

Report Templates Management dialog box


Select an area of the dialog box to find out more.

Template zone

This section allows you to choose an existing template in order to create a new report.
Available Query Templates In this section the list of existing Templates is displayed.

The first time this dialog box is launched, the list will contain no templates. User the Add File to Folder button to search for and locate existing templates.

Shortcut Menu By right clicking on a Template/Folder in the list, a shortcut menu will be launched. This enables you to manipulate both the Templates and Folders in the list.

When removing templates from the list (Remove File), the actual template file is NOT removed from your PC, only from the list.

Add File to Folder button When you click this button, a standard Windows dialog box will be launched enabling you to select the default templates delivered with CAST Products and stored in the HSQ folder.

Alternatively you can add a Template that you have created yourself. The Template will be added to the active folder (i.e. the one that you select before clicking the button).

Create Folder button This button will create a new folder so that you can manage your Templates more easily. For instance, you could group certain types of Templates in one folder.

This button will, however, only place the new folder as a sub-folder of the default folder. If you want to create a new "root" folder, use the shortcut menu:

  1. Right click a folder name in the list.
  2. Select Create Root Folder from the shortcut menu.

You can remove folders created by mistake with the shortcut menu.

File Path This section displays the path of the template selected in the display section.
Description This section contains a description of the selected template.
The Add Template to Report Query button adds the selected template to the end of the current SQL query. The template's code will then be displayed in the Query zone.

You can now manually edit the Template if you require. To save any modifications click .

The Add Template Query to Report File button saves this query to a file. If one file is selected, the query will be saved in this file then in a new file.

To do this, a small dialog box is launched:

This displays all the details of the Template that is displayed in the Query zone. You can then click OK to update any changes you may have made.

Query zone

This section allows you to modify, create or view the query you are using to create the Report:
Query for Report This section displays the actual template code. You can also edit the code or enter your own query in this section.

Please note that if you want to use a table in the Knowledge Base for your .HSQ, you must prefix the table name with the "§" character. Thus when you write §table_name in your query:

For Oracle and CAST Storage Service servers, "§" corresponds to:

  • knowledge_base_schema_name.table_name

For Microsoft SQLServer servers, "§" corresponds to:

  • knowledge_base_table_name..table_name

This is to enable resolution of the Knowledge Base database/schema name, which is no longer restricted to the name "CWMM".

If you are using a table located in a database/schema other than the Knowledge Base, the use of the "§" character is not required.

The Add Template to Report Query button adds the selected template to the end of the current SQL query. The template's code will then be displayed in the Query zone.

You can now manually edit the Template if you require. To save any modifications click .

The Add Template Query to Report File button saves this query to a file. If one file is selected, the query will be saved in this file then in a new file.

To do this, a small dialog box is launched:

This displays all the details of the Template that is displayed in the Query zone. You can then click OK to update any changes you may have made.

Query Assistant Clicking this button will launch the Query Assistant. The Query Assistant is an extremely user-friendly and powerful tool for building and developing SELECT SQL statements to include in your Template.

The Query Assistant enables you to automatically build SELECT statements for all VIEWS stored in the Knowledge Base (CWMM.Views) and then paste them (using the Paste Query button) into the Query zone. When the template is saved and then used to generate a report, your SELECT statement will be executed.

The Query Assistant is used extensively in CAST's SQL Development Tool, SQL Builder.

Note that the Query Assistant does not function in a CAST Storage Service environment.

Create Header The Create Header button will launch the Create Header Wizard enabling you to create a header for your template. A header is essentially a description, which explains how to use and handle the generated result.
Clear All The Clear All button erases the current query.
Further Information The green font color is used to display the header and all other colors are used to describe the query result set. This header uses formatted identifiers.

Each query for the report has a comment header and a SQL statement.

You can also add a Specific Tag if necessary.

HTML Report File zone

Target File This field allows you to specify the path and file name of the main HTML generated document. Use the Browse button to choose a new path and file name for the generated HTML file.
Wizard... This button will launch the Report Wizard.

Please be aware, however, that some of the wizard steps will be skipped if you choose to launch it from here.

Options Launches the Report Option dialog box.
Start Generation Launches the Report generation process.

Notes

  • If you are using the "Standard Documentation" template, there are some specific instructions you need to follow in order for the report to be correctly generated. Please see Generating Standard Documentation for more information.
  • If you are using the Analysis Differential template, please ensure that the following options are selected, otherwise some data may be missing from your report:
    • Ensure the that the Generate Differential Report and Keep History for Differential Report options are selected prior to running your analysis job. These options are set in CAST Analysis Manager either at User Project level or at Job level.
    • If you need to see information about server-side objects that were deleted from the system catalog and then from the CAST Knowledge Base, please ensure that in the PL/SQL Analyzer, the Cleanup option is activated and in the T-SQL Analyzer that the Synchronize and Cleanup (activated by default) or the Cleanup options are activated. These options can be set in CAST Analysis Manager.
    • </ul
See Also

Create Header Wizard | Generating Standard Documentation


CAST Website

  • No labels