Progress
Report Builder
User’s Guide


Report Engine Parameters

When you start Report Engine, you can use not only all the standard Progress 4GL startup parameters, including the Parameter File (-pf) parameter, but you can also use some parameters that are specific to the Report Engine.

Table A–3 lists the parameters you can use with Report Engine and their syntax.

Table A–3: Report Engine Startup Parameters
Parameter
Syntax
Report Engine Record Delete
-rbdel  
Report Status File
-rbstatfile filename 
Encoded Password
-rbP password 
Report Engine Table Name
-rbtable table-name 
Report Tag
-rbtag tag 
Report Update Status
-rbupds 
Report Code Page In1
-rbcpreportin codepage 
UDF Code Page In1
-rbcpudfin codepage 
  1. Also used with Report Builder. See the "Report Builder Startup Parameters" section for a description of these parameters.

The remainder of this section describes each of the Report Engine-specific startup parameters in alphabetical order by operating system syntax. See the "Report Builder Startup Parameters" section for a description of the parameters that can also be used with Report Builder.

Report Engine Record Delete (-rbdel)


Operating 
System
and
Syntax 


Windows 


-rbdel  
Use
With 
Maximum
Value 
Minimum
Value 
Single-user
Default 
Multi-user
Default 
 
 
 
 
 

This parameter tells Report Engine to delete the Report Engine table record corresponding to the report when it has finished generating the report. If you do not specify this parameter, Report Engine leaves the record intact.

Report Status File (-rbstatfile)


Operating 
System
and
Syntax 


Windows 


-rbstatfile filename 
Use
With 
Maximum
Value 
Minimum
Value 
Single-user
Default 
Multi-user
Default 
 
 
 
 
 

filename

The pathname of the report status file into which Report Engine will write the status information.

This parameter tells Report Engine to create a file containing information about the reports it has generated. This file is called the report status file. If the file does not exist, Report Engine creates one. If the file does exist, Report Engine overwrites it. If you do not specify the full pathname, Report Engine creates the file in the current working directory. If the Report Engine table contains multiple reports, the output file will contain information about all of the reports that were run.

See the Progress Report Builder Deployment Guide for a description of the report status file.

Encoded Password (-rbP)


Operating 
System
and
Syntax 


Windows 


-rbP password 
Use
With 
Maximum
Value 
Minimum
Value 
Single-user
Default 
Multi-user
Default 
 
 
 
 
 

password

An encoded password.

This parameter is an optional Report Engine-specific version of the Progress 4GL Password (-P) startup parameter. The -rbP parameter allows you to hide the value of a password.

Report Engine assumes that the value of the Encoded Password (-rbP) parameter was encoded using the _RBPWENC 4GL program and therefore applies the reverse encoding and treats the result as if it had been provided by the Password (-P) parameter. See the Progress Report Builder Deployment Guide for more information about the RBPWENC program.

You can use this parameter when you invoke Report Engine on the command line or in place of the -P parameter in the RB-DB-CONNECTION field of the Report Engine table record.

Report Engine Table Name (-rbtable)


Operating 
System
and
Syntax 


Windows 


-rbtable table-name 
Use
With 
Maximum
Value 
Minimum
Value 
Single-user
Default 
Multi-user
Default 
 
 
 
RBREPORT 
RBREPORT 

table-name

The name of the Report Engine table containing the report parameters.

If you do not specify this parameter, Report Engine assumes the table name is RBREPORT. When you invoke Report Engine, you must specify the connection parameters that tell Report Engine how to connect to the database containing this table. If you connect to more than one database on the command line, it looks for this table in the first database specified.

Report Tag (-rbtag)


Operating 
System
and
Syntax 


Windows 


-rbtag tag 
Use
With 
Maximum
Value 
Minimum
Value 
Single-user
Default 
Multi-user
Default 
 
 
 
 
 

tag

A character string that indicates which reports to run.

The Report Tag (-rbtag) parameter tells Report Engine which reports to generate. If you do not specify this parameter, Report Engine generates all the reports in the Report Engine table. If you do specify this parameter, Report Builder matches the tag value against the RB-TAG field values in each Report Engine record and skips all Report Engine records that do not match. If you use this parameter, you must have an RB-TAG field in the Report Engine table.

For example, if the Report Engine table contains report records for four different quarterly reports, you can assign each record a tag such as Q1, Q2, Q3, and Q4 in the RB-TAG field. Then when you invoke Report Engine, specify the desired tag with the -rbtag parameter for each report. To run the reports for the third quarter, you specify Q3 as the -rbtag value. Another way to use this parameter is to store the reports for multiple users in the Report Engine table, then specify a specific user’s tag to run only their reports.

Report Update Status (-rbupds)


Operating 
System
and
Syntax 


Windows 


-rbupds  
Use
With 
Maximum
Value 
Minimum
Value 
Single-user
Default 
Multi-user
Default 
 
 
 
 
 

The Report Update Status (-rbupds) parameter tells Report Engine to update the RB-STATUS field in the Report Engine table for each report. If you use this parameter, you must have an RB-STATUS field in the Report Engine table.

If you specify the Report Update Status (-rbupds) parameter when you invoke Report Engine, Report Engine updates the RB-STATUS field with information describing where it is in the report generation process. Table A–4 describes the possible parameter values Report Engine can provide to the RB-STATUS field.

Table A–4: RB-STATUS Values 
Value
Meaning
STARTED
Report Engine has started generating the report.
COMPLETED
Report Engine has finished generating the report. This does not mean the report has been printed, only that it has been sent to the printer queue.
ERROR: message
Report Engine has detected an error and cannot complete generating the report.
blank
The Report Update Status (-rbupds) parameter is not set or Report Engine has not yet started generating this report.
CANCELED
The user canceled the report before processing completed.

If you do not specify the -rbupds parameter when you invoke Report Engine, Report Engine ignores the RB-STATUS field, and the field remains blank.


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095