Run-time processing sequence for Reports programming interface

Before you begin to customize report procedures, it is important to understand the run-time processing flow for Report Builder and Report Viewer. The processing sequence occurs in the following phases.

The following figure illustrates this processing sequence.

Figure 1. Run-time processing sequence
The processing sequence shows, in three phases, User Actions on the left half and Run-time processing on the right half.
To execute these processing phases correctly, a report procedure must meet the following requirements:
  • The directory that contains the report procedure must be found at known location. The Report Builder reads the \reports\scripts directory to determine the report procedure file names. When a user clicks the associated directory folder, Report Builder calls the associated report procedure.
  • The report procedure must have a valid interface specification. If the expected format is not present, the report does not run.
  • The interface specification in the report procedure must use parameters and choosers supplied by DevOps Code ClearCase® Reports. See Table 1.
  • The report procedure must support a command line interface that the Report Viewer can use to pass user-defined parameter values to the report procedure.