Created by James Hurrell on Apr 16, 2021

Generate Standard Documentation

CAST ships a specific template that enables you to generate Standard Documentation about objects stored in the Knowledge Base. This template can be generated with the following wizards:

What is Standard Documentation?

The Standard Documentation template provided by CAST generates full documentation for applications stored in your Knowledge Base. This includes called and calling objects for each object within the application.

Because this template is delivered in the form of an .HSQ, you can configure it to suit your own requirements - use Report On SQL Query to configure the template.

Prerequisites to using the Standard Documentation template

The following actions must be executed BEFORE you use the Standard Documentation template to generate a report:

  1. Make sure your jobs have been analyzed recently (use Analysis Manager)
  2. Update the CAST System Views (use Analysis Manager)
  3. Copy the following files from the CAST installation folder to the folder that will contain the generated report:

    - animtree.js - treeparams.js - closed-menu.gif; additionally, this file should be set as read-only, to prevent the engine overwriting it - empty-menu.gif - logo.gif - open-menu.gif

Generating Standard Documentation with the Report with Predefined wizard

  1. Launch a Report with Predefined
  2. In the Template Selection screen, select the "Standard Documentation" template
  3. In the Options screen, use a stylesheet and make sure you define the "cw_ultra_compact.css" file located in the CAST installation folder. Define a location for the generated report. CAST recommends unselecting both the Use Frame and Active frame with JAVASCRIPT (IE 4+ or Netscape 4+) for Standard Documentation Generation.

    In addition, make sure you specify an output file name with a .HTM suffix (using a .HTML suffix will cause errors).
  4. Verify the report generation instructions in the Report screen
  5. Click Finish to start the generation process
  6. Enter a generation date in the dialog box "Waiting External Value"
  7. Enter a version number in the dialog box "Waiting External Value"
  8. Select the languages you want to include in the report in the dialog box "Waiting External Value"
  9. Select the projects and jobs you want to include in the report in the dialog box "Waiting External Value"
  10. The report will then be generated.

Notes

  • When using the wizard in the Report On SQL Query or the Report With Predefined, CAST recommends unselecting both the Use Frame and Active frame with JAVASCRIPT (IE 4+ or Netscape 4+) for Standard Documentation Generation.
  • Make sure you specify an output file name with a .HTM suffix (using a .HTML suffix will cause errors).
  • The report generation process may take some time, particularly if you have included a large number of objects in the report.
  • You can cancel the report generation process at any time using the Cancel button
See Also

Report On SQL Query | Report With Predefined

CAST Website