Production Reporting Command-line Flags

Production Reporting command-line flags begin with a dash (‑). When a flag takes an argument, the argument must follow the flag with no intervening space.

Table 1. Production Reporting Command-line Flags

Flag

Description

 

Database

-A

Appends output to a file with the same name as the source. If the file does not exist, a new one is created. Useful for running a report multiple times with a single output file.

Restrictions:

  • Only works with LIS files. Does not work with SPF files.

  • Only applies to line printers (-PRINTER:LP). Ignored for other printer types and output formats.

  • Only applies to SQR and SQRP in non-Windows environments.

 

All

-Bnn

Defines the number of rows to buffer when retrieving data. The default is 10 rows. Regardless of the setting, all rows are retrieved. On the command line, -B controls the setting for all BEGIN‑SELECT commands. In a program, each BEGIN‑SELECT command can have its own -B flag for further optimization.

 

ODBC Oracle Sybase

-BURST:{xx}

Specifies the bursting type.

  • -BURST:T generates the Table of Contents.

  • -BURST:S generates report output according to the symbolic Table of Contents entries defined with the level argument in ???. In -BURST:S[ {l} ], {l} is the level at which to burst. -BURST:S is equivalent to ‑BURST:S1.

  • -BURST:P generates report output by report page numbers. In ‑BURST:P[ {l} , {s} [, {s}.…] ] , {l} is the number of logical report pages that each HTML file contains and {s} is the page selection: {n}, {n}-{m}, -{m}, or {n}-. -BURST:P is equivalent to ‑BURST:P0,1- when using -PRINTER:HT or ‑BURST:P1 when using ‑PRINTER:EH.

See “Bursting and Demand Paging” in Volume 1 of the Production Reporting DeveloperÕs Guide for more information.

Note: ‑BURST:P and ‑BURST:S require -PRINTER:EH or ‑PRINTER:HT. The Page range selection feature of -BURST:P requires ‑PRINTER:HT. ‑BURST:T requires -PRINTER:HT.

 

All

-C

(Windows) Displays the Cancel dialog box while the program runs to terminate program execution.

 

All

-CB

(Windows, Callable Production Reporting) Forces the communication box to be used.

 

All

-Dnn

(non-Windows) Displays the report output at the same time it is written to the output file. nn is the maximum number of lines to display before pausing. If no number is entered after ‑D, the display scrolls continuously.

Note: The printer type must be LP or the display is ignored. If the program produces multiple reports, the display is for the first report only.

 

All

-DBdatabase

Uses the specified database, which overrides any USE command in the Production Reporting program.

 

Sybase

-DEBUG[xxx]

Compiles lines preceded by #DEBUG. Without this flag, Production Reporting ignores these lines.

 

All

-DNT:{xx}

Defines the default behavior for numeric variables. The value for xx can be INTEGER, FLOAT, DECIMAL, or V30. To specify a precision for DECIMAL, append it with a colon delimiter (:)—for example, ‑DNT:DECIMAL:20. See the DEFAULT argument for ??? for a detailed explanation. If used, the DEFAULT argument in DECLARE‑VARIABLE takes precedence.

 

All

-E[file]

Directs error messages to the named file, or to the default file program.err. If no errors occur, no file is created.

 

All

-EH_APPLETS:dir

Defines the directory for Enhanced HTML applets. (The default directory for applets is IMAGES.)

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_BQD

Generates a {report}.bqd file from the report data and associates a BQD (Brio Query Format File) icon with {report}.bqd in the navigation bar.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_BQD:file

Associates BQD icons with the specified file.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

‑EH_BROWSER:xx

Defines the browser and generates the HTML.

  • BASIC—Generates HTML suitable for all browsers.

  • IE—Generates HTML for Internet Explorer.

  • NETSCAPE —Generates HTML for Netscape.

  • ALL—If necessary, Production Reporting generates Basic, IE, and Netscape HTML files. Report_frm.htm contains Javascript to “sense” the browser on the user’s machine and display the appropriate version. (In this case, the user’s machine is the machine of the person reading the report, not the person writing it.)

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP. Only recognized when combined with -EH_FULLHTML.

 

All

-EH_CSV

Generates a {report}.csv file from report data.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_CSV:file

Associates the CSV icon with the specified file.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_CSVONLY

Creates a CSV file but does not create an HTML file.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_DEBUG[:opts]

Produces a DBG output file containing compiler and internal error messages.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_ICONS:dir

Defines the directory where HTML should look for the referenced icons.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_IMAGES:dir

Defines the directory path for the GIF files used by the Navigation Bar.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_KEEP

Copies (does not move) the files when used in conjunction with ‑EH_ZIP.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

‑EH_LANGUAGE:xx

Defines the HTML navigation bar language. You can specify English, French, German, Italian, Japanese, Korean, Portuguese, Spanish, SChinese, or TChinese.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_PDF

Associates a PDF icon with {report}.pdf in the navigation bar.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_SCALE:{nn}

Sets the scaling factor from 50 to 200.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_XIMG

Specifies to not remove the directory path from the IMAGE reference.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_XML:file

Associates an XML icon with a file.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-EH_ZIP[:file]

Moves generated files to the specified file or {report}.zip if {file} is not specified.

Note: Only applicable with -PRINTER:EH or ‑PRINTER:EP.

 

All

-F[file|directory]

Overrides the default output file name, program.lis.

The default action places the program.lis file in the same directory as the program.sqr file. To use the current directory, specify -F without an argument. To change the name of the output file, specify -F with the new name. If the new name does not specify a directory, the file is created in the current directory. The output file is not created until data actually prints on the page. If no data prints, no output file is created.

The following shows how to specify file names and directories for different operating systems.

 

All

 

Operating System

Directory Character

Example

  
 

UNIX

/

-F$HOME/reports/

  
 

Windows

\

-FC:\Hyperion\Files\

  

-ID

(non-Windows) Displays the copyright banner.

 

All

-Idir_list

Specifies the directories that Production Reporting searches when processing the #INCLUDE directive if the include file does not exist in the current directory and no path was specified for the file. The directory names must be separated by either commas (,) or semicolons (;).

In UNIX, if your shell uses semicolons as command delimiters, precede each semicolon with a backslash (\). Always append the directory character to the end of each directory name. See the -F flag for a list of directory characters by operating system. For example, under UNIX:

sqr myreport sammy/baker -I/home/sqr/inc/,/usr/sqr/incl/

 

All

-KEEP

Creates SPF files in addition to LIS files for each report generated. (See Chapter 28, “Printing Issues,” in Volume 1 of the Production Reporting DeveloperÕs Guide for more information on LIS and SPF files.)

 

All

-LL{s|d}{c|i}

LOAD-LOOKUP: s = SQR, d = DB, c = case-sensitive, i = case‑insensitive

 

All

-NOLIS

Prevents the creation of all Production Reporting output file types. SPF output is created instead.

 

All

-O[file]

Directs log messages to the specified file or to program.log if no file is specified. By default, the file sqr.log is used in the current working directory.

 

All

-PB

Retains trailing blanks in column data.

 

Informix

-PRINTER:xx

Uses printer type xx when creating output files.

 

All

 

xx

Printer Type

Example

 

EH

Enhanced HTML

-PRINTER:EH

 

EP

Enhanced HTML/PDF

-PRINTER:EP

 

GD

‑GD_DRIVER:name defines the name of the Generic Output Driver.

‑GD_OPTION:opts defines optional parameters to pass to the Generic output Driver.

Generic Output Driver

-PRINTER:GD

To generate Excel documents, enter:

-PRINTER:GD ‑GD_DRIVER:EXCEL

To generate Word documents, enter:

-PRINTER:GD -GD_DRIVER:WORD

To generate Power Point documents, enter:

-PRINTER:GD -GD_DRIVER:PP

These commands create Office HTML files that can be opened by Word 2003, Word XP, Power Point 2003, Power Point XP, Excel 2003, and Excel XP. (For Office 2000 products, you can download a Microsoft tool to convert Office HTML files into something that Office 2000 products can open.)

Note: You can use the -F flag to change the output file name to report.doc, report.ppt, or report.xls.

 

HP

HP LaserJet

-PRINTER:HP

Note: Production Reporting does not support color for ‑PRINTER:HP (HP PCL) output generation.

  
 

LP

Line Printer

-PRINTER:LP

  
 

PD

PDF

-PRINTER:PD

  
 

PS

PostScript

-PRINTER:PS

  
 

WP

Windows

-PRINTER:WP

  
 

Notes:

  • LP, HP, and PS produce files with the .lis extension.

  • EH and HT produce .htm file output.

    • HT is controlled by the PrinterHT setting in the [Default-Settings] section of SQR.INI. If PrinterHT is set to standard, HT produces version 2.0 HTML files with the report content inside <PRE></PRE> tags. If PrinterHT is set to enhanced, HT is mapped to EH.

    • EH produces reports fully formatted with version 1.1 XHTML tags.

  • PD produces PDF 1.3 compliant files. When ‑PRINTER:PD is used, PRINT-DIRECT, PRINT …Code, and Print with CODE-PRINTER commands are processed but ignored.

  • On Windows systems, WP sends output to the default Windows printer. To specify a non-default Windows printer, use -PRINTER:WP:{Printer Name}. The {Printer Name} can be the name assigned to a printer; or, if the operating system permits it, the UNC name (i.e.\\Machine\ShareName). For example, to send output to a Windows printer named NewPrinter, you could use ‑PRINTER:WP:NewPrinter. If your printer name has spaces, enclose the entire command in double quotes.

  

-PSnn

Sets the TDS (Tabular Data Stream) packet size to the specified value.

 

Sybase

-RS

Saves the program in a run-time file. The program is scanned, compiled, and checked for correct syntax. Queries are validated and compiled. Then, the executable version is saved in a file with the name program.sqt. Note that Production Reporting does not prompt for ASK variables after compilation.

 

All

-RT

Uses the run-time file saved with -RS. Skips syntax and query checking and begins processing immediately. Note that Production Reporting does not prompt for ASK variables after compilation.

 

All

-S

Displays the status of all cursors at the end of the report run. Status includes the text of each SQL statement, the number of times each was compiled and executed, and the total number of rows selected. The output goes directly to the screen. This information can be used for debugging SQL statements and enhancing performance and tuning.

 

All

-Tnn

Specifies that you want to test your report for nn pages. To save time during testing, Production Reporting ignores all ORDER BY clauses in SELECT statements. For multiple reports, Production Reporting stops after the specified number of pages defined for the first report.

 

All

-T{B}

Trims trailing blanks from database character columns.

 

DB2 Sybase ODBC Teradata

-T{Z}

Trims trailing zeros from the decimal portion of numeric columns.

 

DB2 Teradata

-U{priv_connectivity}, Directs SQR to connect to a privileged user and then proxy as the "user" from the normal connectivity piece.

sqr {program} {connectivity} -Upriv_connectivity [flags] [args]

For example:

sqr scott {prg} -Upriv/priv@instance

Logs in in as "priv/priv@instance" and then proxies to user "scott". All access is then be based "scott" and not "priv".

  

-Vserver

Uses the named server.

 

Sybase

-XB

(non-Windows) Suppresses the Production Reporting banner and the “Production Reporting... End of Run” message.

 

All

-XC

(Callable Production Reporting) Suppresses the database commit when the report finishes running.

 

All

-XCB

(Windows) Defines to not use the communication box. Requests for input are made in Windows dialog boxes.

 

All

-XFRM

Prevents Production Reporting from creating a frame in HTML files generated with -PRINTER:EH.

 

All

-XI

Prevents user interaction during a program run. If ASK or INPUT requires user input, an error displays and the program ends.

 

All

-XL

Prevents Production Reporting from logging onto the database. Programs run in this mode cannot contain any SQL statements. ‑XL lets you run Production Reporting without accessing the database. You still must supply at least an empty slash (/) on the command line as a placeholder for the connectivity information.

For example: sqr myprog / -xl

 

All

-XLFF

Prevents trailing form feed.

 

All

-XMB

(Windows) Disables error message display so programs can run without interruption by error messages/warnings generated by Production Reporting, or by user generated messages (SHOW/DISPLAY). All messages still go to their designated output files (SQR.ERR or ‑E{filename} / SQR.LOG or ‑O{filename})

 

All

-XNAV

Prevents Production Reporting from creating the Navigation Bar in HTML files generated with -PRINTER:HT and -PRINTER:EH. This occurs when only a single HTML file is produced. Multiple HTML files generated from a single report always contain the Navigation Bar.

 

All

-XP

Prevents Production Reporting from creating temporary stored procedures.

 

Sybase

-XTB

Preserves trailing blanks in LIS files at the end of a line.

 

All

-XTOC

Prevents Production Reporting from generating the Table of Contents for the report. This flag is ignored when ‑PRINTER:HT or -PRINTER:EP is also specified.

 

All

-ZEN{name}

Sets the default encoding name.

 

All

-ZIF{file}

Sets the full path and name of the SQR initialization file, SQR.INI.

 

All

-ZIV

Invokes the SPF Viewer after generating the program.spf file. Implicitly invokes -KEEP to create program.spf. For multiple output files, only the first report file passes to the Production Reporting Viewer.

 

All

-ZMF{file}

Defines the full path and name of the Production Reporting error message file, sqrerr.dat.

 

All

-ZRF{file}

(DDO) Sets the full path and name of an alternate registry.properties file. Following is a common default path to the registry.properties file on a Windows system:

c:\program files\hyperion\properties\registry.properties

The registry.properties file lists datasources that Production Reporting can access. The information in the registry.properties file makes it possible for Oracle's Hyperion® SQR® Production Reporting to access datasources for which DDO drivers have been loaded and configured.

 

All