Progress
Report Builder
Deployment Guide
Command-line Parameters
You can use all the standard Progress 4GL startup parameters, including the Parameter File (-pf) parameter, plus some new parameters that are specific to Report Engine.
Table 4–4 describes the locations where you can specify startup parameters.
There are many Progress 4GL startup parameters that you might want to use when you invoke Report Engine. For example, you can use the Date Format (-d) parameter to change the display format for dates in reports. See the Progress Startup Command and Parameter Reference for a complete listing of the Progress 4GL startup parameters.
Table 4–5 lists the Report Engine startup parameters and their syntax.
The remainder of this section describes each startup parameter, in alphabetical order by operating system syntax.
Report Code Page In (-rbcpreportin)
codepage
Name of code page to use for the report.
Allows you to override the code page name stored in any reports you open. When you save a report, Report Builder assigns it a code page. When Report Engine attempts to read the report, the -rbcpreportin parameter tells Report Engine to treat the report as being in the specified code page. If you do not specify a value, Report Engine uses whatever code page was assigned to the report when it was last saved.
UDF Code Page In (-rbcpudfin)
codepage
Name of code page to use for the user-defined function file.
Allows you to override the code page name stored in the user-defined function file (
PRORB.UDF
). When you define a UDF, Report Builder assigns it a code page. When Report Engine attempts to read a report that uses a UDF, the -rbcpudfin parameter tells Report Engine to treat the UDF as being in the specified code page. If you do not specify a value, Report Engine uses whatever code page was assigned to the UDF when it was last saved.Report Engine Record Delete (-rbdel)
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)
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 uses its current working directory. If the Report Engine table contains multiple reports, the output file will contain information about all of the reports.
See "Report Engine Administration," for a description of the report status file.
Encoded Password (-rbP)
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
aderb/_rbpwenc.p
and therefore applies the reverse encoding and treats the result as if it had been provided by the Password (-P) parameter. See the "Using Password Security" section in "Report Engine Administration" for more information about security considerations.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 record.
Report Engine Table Name (-rbtable)
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)
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.
For example, if the Report Engine table contains report records for four different quarterly reports, you can assign each set of records for a quarter a different 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. 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, giving each record an RB-TAG value that is the corresponding user’s name, then specify a specific user’s tag to run only their reports.
Report Update Status (-rbupds)
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 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 4–6 describes the possible parameter values Report Engine can provide to the RB-STATUS field.
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 |